usr/src/usr.bin/tn3270/ctlr/screen.h

/*-
 * Copyright (c) 1988 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      @(#)screen.h    4.3 (Berkeley) 4/26/91
 */

#define INCLUDED_SCREEN

/* defines and defines to describe how to deal with the screen */

#if     !defined(MSDOS)
#define MAXNUMBERLINES          43              /* 3278-4 */
#define MAXNUMBERCOLUMNS        132             /* 3278-5 */
#define MAXSCREENSIZE           3564            /* (27*132) 3278-5 */
#else   /* !defined(MSDOS) */   /* MSDOS has memory constraints */
#define MAXNUMBERLINES          25              /* XXX */
#define MAXNUMBERCOLUMNS        80
#define MAXSCREENSIZE           (MAXNUMBERLINES*MAXNUMBERCOLUMNS)
#endif  /* !defined(MSDOS) */   /* MSDOS has memory constraints */
#define LowestScreen()  0
#define HighestScreen() (ScreenSize-1)

#define ScreenLineOffset(x)     ((x)%NumberColumns)
#define ScreenLine(x)   ((int)((x)/NumberColumns))
#define ScreenInc(x)    (((x)==HighestScreen())? LowestScreen():x+1)
#define ScreenDec(x)    (((x)==LowestScreen())? HighestScreen():x-1)
#define ScreenUp(x)     (((x)+(ScreenSize-NumberColumns))%ScreenSize)
#define ScreenDown(x)   (((x)+NumberColumns)%ScreenSize)
#define IsOrder(x)      (Orders[x])
#define BAIC(x)         ((x)&0x3f)
#define CIAB(x)         (CIABuffer[(x)&0x3f])
#define BufferTo3270_0(x)       (CIABuffer[(int)((x)/0x40)])
#define BufferTo3270_1(x)       (CIABuffer[(x)&0x3f])
#define Addr3270(x,y)   (BAIC(x)*64+BAIC(y))
#define SetBufferAddress(x,y)   ((x)*NumberColumns+(y))
\f
/* These know how fields are implemented... */

#define WhereAttrByte(p)        (IsStartField(p)? p: FieldDec(p))
#define WhereHighByte(p)        ScreenDec(FieldInc(p))
#define WhereLowByte(p)         ScreenInc(WhereAttrByte(p))
#define FieldAttributes(x)      (IsStartField(x)? GetHost(x) : \
                                    GetHost(WhereAttrByte(x)))
#define FieldAttributesPointer(p)       (IsStartFieldPointer(p)? \
                                    GetHostPointer(p): \
                                    GetHost(WhereAttrByte((p)-&Host[0])))

/*
 * The MDT functions need to protect against the case where the screen
 * is unformatted (sigh).
 */

/* Turn off the Modified Data Tag */
#define TurnOffMdt(x) \
    if (HasMdt(WhereAttrByte(x))) { \
        ModifyMdt(x, 0); \
    }

/* Turn on the Modified Data Tag */
#define TurnOnMdt(x) \
    if (!HasMdt(WhereAttrByte(x))) { \
        ModifyMdt(x, 1); \
    }

/* If this location has the MDT bit turned on (implies start of field) ... */
#define HasMdt(x) \
    ((GetHost(x)&(ATTR_MDT|ATTR_MASK)) == (ATTR_MDT|ATTR_MASK))

        /*
         * Is the screen formatted?  Some algorithms change depending
         * on whether there are any attribute bytes lying around.
         */
#define FormattedScreen() \
            ((WhereAttrByte(0) != 0) || ((GetHost(0)&ATTR_MASK) == ATTR_MASK))

                                            /* field starts here */
#define IsStartField(x) ((GetHost(x)&ATTR_MASK) == ATTR_MASK)
#define IsStartFieldPointer(p)  ((GetHostPointer(p)&ATTR_MASK) == ATTR_MASK)

#define NewField(p,a)   SetHost(p, (a)|ATTR_MASK)
#define DeleteField(p)  SetHost(p, 0)
#define DeleteAllFields()
\f
/* The following are independent of the implementation of fields */
#define IsProtectedAttr(p,a)    (IsStartField(p) || ((a)&ATTR_PROT))
#define IsProtected(p)  IsProtectedAttr(p,FieldAttributes(p))

#define IsUnProtected(x)        (!IsProtected(x))

#define IsAutoSkip(x)   (FieldAttributes(x)&ATTR_AUTO_SKIP)

#define IsNonDisplayAttr(c)     (((c)&ATTR_DSPD_MASK) == ATTR_DSPD_NONDISPLAY)
#define IsNonDisplay(p) IsNonDisplayAttr(FieldAttributes(p))

#define IsHighlightedAttr(c) \
                (((c)&ATTR_DSPD_MASK) == ATTR_DSPD_HIGH)
#define IsHighlighted(p) \
                (IsHighlightedAttr(FieldAttributes(p)) && !IsStartField(p))

typedef unsigned char ScreenImage;

extern int
        FieldFind();

extern char
        CIABuffer[];

#define GetGeneric(i,h)         (h)[i]
#define GetGenericPointer(p)    (*(p))
#define SetGeneric(i,c,h)       ((h)[i] = (c))
#define ModifyGeneric(i,what,h) {(h)[i] what;}

#define GetHost(i)              GetGeneric(i,Host)
#define GetHostPointer(p)       GetGenericPointer(p)
#define SetHost(i,c)            SetGeneric(i,c,Host)
#define ModifyHost(i,what)      ModifyGeneric(i,what,Host)