home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 7 / 07.iso / c / c005 / 1.ddi / BWINDOW.H < prev    next >
Encoding:
C/C++ Source or Header  |  1986-08-05  |  14.9 KB  |  408 lines
  1. /**
  2. *
  3. *  BWINDOW.H   Header file for C TOOLS PLUS Window Functions
  4. *
  5. *  Version 3.0    (C)Copyright Blaise Computing Inc.  1986
  6. *
  7. **/
  8.  
  9. #ifndef DEF_BWINDOW              /* Prevent redefinition.          */
  10.  
  11. #include <bscreen.h>              /* C TOOLS PLUS Screen functions*/
  12.  
  13. #define  WN_EXT_ERROR    0          /* 1 if wnerror() is external,  */
  14.                       /* 0 if it's a macro.           */
  15.  
  16.     /* Definitions of data types                      */
  17.  
  18. typedef struct                  /* LOC structure:           */
  19. {                      /* row and column relative to a */
  20.     int row,col;              /* rectangular region.          */
  21. } LOC;
  22.  
  23. typedef struct                  /* REGION structure:          */
  24. {                      /*   rectangular region on a    */
  25.                       /*   screen.              */
  26.     LOC ul;                  /* Upper left  corner          */
  27.     LOC lr;                  /* Lower right corner          */
  28. } REGION;
  29.  
  30.                       /* Height of a REGION          */
  31. #define REGION_H(region) ((region).lr.row - (region).ul.row + 1)
  32.  
  33.                       /* Width of a REGION          */
  34. #define REGION_W(region) ((region).lr.col - (region).ul.col + 1)
  35.  
  36. typedef struct                  /* CELL structure:          */
  37. {                      /* character and attribute byte */
  38.     char ch,attr;              /* on a PC screen.          */
  39. } CELL;
  40.  
  41. typedef struct                  /* DIM structure:           */
  42. {                      /*   height and width of a      */
  43.     int h,w;                  /*   rectangular region.          */
  44. } DIM;
  45.  
  46. typedef struct                  /* IMAGE structure:          */
  47. {                      /*   a copy of a rectangular    */
  48.                       /*   portion of a screen's data.*/
  49.     DIM  dim;                  /* Dimensions of the rectangle. */
  50.     CELL *pdata;              /* Pointer to array of cells    */
  51.                       /*   containing the data, row   */
  52.                       /*   by row.              */
  53. } IMAGE;
  54.  
  55. typedef struct                  /* WHERE structure:          */
  56. {                      /* device, page, and location   */
  57.                       /* where a window may be shown. */
  58.                       /*                  */
  59.     int  dev;                  /* Device where shown:  COLOR,  */
  60.                       /* MONO, or ABSENT if not shown.*/
  61.                       /*                  */
  62.     int  page;                  /* Video page number:  0 to 7   */
  63.                       /*                  */
  64.     LOC  corner;              /* Upper left corner of region  */
  65.                       /* where window data is shown   */
  66.                       /* (does not include border).   */
  67. } WHERE;
  68.  
  69. typedef struct                  /* BORDER structure:          */
  70. {                      /* description of a window's    */
  71.                       /* border               */
  72.                       /*                  */
  73.     int  type;                  /* Border type:              */
  74.                       /*   -1 = literal character     */
  75.                       /*    0 = no border          */
  76.                       /*  1 to 16 = border type as    */
  77.                       /*      defined by SCBOX,       */
  78.                       /*      increased by 1.          */
  79.                       /*                  */
  80.     int  attr;                  /* Attribute (color).          */
  81.                       /*                  */
  82.     char ch;                  /* Border character if type = -1*/
  83.                       /*                  */
  84.     char _dummy;              /* Dummy to force size of       */
  85.                       /* structure to be even in all  */
  86.                       /* cases.               */
  87. } BORDER;
  88.  
  89. #define BWIN_SIGN "BCI Window 3.00"   /* Signature to identify        */
  90.                       /* genuine BWINDOW structure.   */
  91.  
  92. typedef struct                  /* BWINDOW structure:          */
  93. {                      /* everything needed to control */
  94.                       /* an individual window.          */
  95.                       /*                  */
  96.     char   signature[16];          /* Identifying signature.       */
  97.                       /*                  */
  98.     LOC    cur_loc;              /* Location of window's own     */
  99.                       /* cursor relative to window's  */
  100.                       /* data area.              */
  101.                       /*                  */
  102.     CUR_TYPE cur_type;              /* Cursor type.              */
  103.                       /*                  */
  104.     IMAGE  img;               /* Contents of data area.       */
  105.                       /*                  */
  106.     WHERE  where_shown;           /* Where window is currently    */
  107.                       /* shown.               */
  108.                       /*                  */
  109.     IMAGE  prev;              /* Previous contents of screen  */
  110.                       /* (before window was shown),   */
  111.                       /* including data under border. */
  112.                       /*                  */
  113.     WHERE  where_prev;              /* Region occupied by window    */
  114.                       /* (including border).          */
  115.                       /*                  */
  116.     struct bwin_node *pnode;          /* Pointer to window node       */
  117.                       /* among all windows on a video */
  118.                       /* display page.              */
  119.                       /*                  */
  120.     BORDER bord;              /* Border description.          */
  121.                       /*                  */
  122.     int    attr;              /* Default attributes for data  */
  123.                       /* area.                  */
  124.  
  125.     struct                  /* "options" substructure:      */
  126.     {                      /* items set by user request.   */
  127.                       /*                  */
  128.     unsigned delayed   : 1;       /* Output postponed until next  */
  129.                       /* update.              */
  130.                       /*                  */
  131.     unsigned cur_off   : 1;       /* Cursor invisible.          */
  132.                       /*                  */
  133.     unsigned removable : 1;       /* Removable (hence previous    */
  134.                       /* contents of screen must be   */
  135.                       /* preserved).              */
  136.                       /*                  */
  137.     unsigned hidden    : 1;       /* Invisible, yet attached to a */
  138.                       /* location on a display page.  */
  139.                       /*                  */
  140.     unsigned _dummy    :12;       /* Pad to word boundary          */
  141.     } options;
  142.  
  143.     struct                  /* "internals" substructure:    */
  144.     {                      /* not directly set by user.    */
  145.                       /*                  */
  146.     unsigned frozen       : 1;/* Updates postponed          */
  147.                       /* involuntarily.           */
  148.                       /*                  */
  149.     unsigned dirty          : 1;/* Output request(s) are          */
  150.                       /* awaiting update.          */
  151.                       /*                  */
  152.     unsigned any_data_covered : 1;/* Some portion of data area is */
  153.                       /* covered by another window.   */
  154.                       /*                  */
  155.     unsigned cur_frozen      : 1;/* Not selected for visible     */
  156.                       /* cursor.              */
  157.                       /*                  */
  158.     unsigned temp_hid      : 1;/* Temporarily hidden by          */
  159.                       /* internal operations.          */
  160.                       /*                  */
  161.     unsigned _dummy       :11;/* Pad to word boundary          */
  162.     } internals;
  163. } BWINDOW;
  164.  
  165. #define BNODE_SIGN "BCI W_Node 3.00"  /* Signature to identify        */
  166.                       /* genuine WIN_NODE structure.  */
  167.  
  168. struct bwin_node              /* WIN_NODE structure:          */
  169. {                      /* node in the linked lists     */
  170.                       /* which govern the hierarchy   */
  171.                       /* of windows on each display   */
  172.                       /* page.                  */
  173.                       /*                  */
  174.     char         signature[16];   /* Identifying signature.       */
  175.                       /*                  */
  176.     struct bwin_node *above;          /* Window above this one (or    */
  177.                       /* NIL if this is top window).  */
  178.                       /*                  */
  179.     struct bwin_node *below;          /* Window below this one (or    */
  180.                       /* NIL if this is bottom window)*/
  181.                       /*                  */
  182.     BWINDOW         *pwin;          /* BWINDOW structure belonging  */
  183.                       /* to this node.              */
  184. };
  185. #define WIN_NODE    struct bwin_node
  186.  
  187.     /* Error codes                              */
  188.  
  189. #define WN_NO_ERROR        0
  190. #define WN_NO_MEMORY        1
  191. #define WN_ILL_DIM        2
  192. #define WN_NULL_PTR        3
  193. #define WN_BAD_WIN        4
  194. #define WN_BAD_DEV        5
  195. #define WN_BAD_PAGE        6
  196. #define WN_BAD_NODE        7
  197. #define WN_ALREADY_SHOWN    8
  198. #define WN_NOT_SHOWN        9
  199. #define WN_CANT_HIDE       10
  200. #define WN_COVERED       11
  201. #define WN_BAD_OPT       12
  202. #define WN_HARD        13
  203. #define WN_ILL_VALUE       14
  204.  
  205.     /* Window control items & status items for WNGETOPT & WNSETOPT.   */
  206.     /* Negative item codes require the window to be currently          */
  207.     /* displayed (although it may be hidden).                  */
  208.  
  209. #define WN_DEVICE         1          /* Where the window is          */
  210. #define WN_PAGE        (-2)       /* displayed              */
  211. #define WN_ROW_CORNER       (-3)       /*                  */
  212. #define WN_COL_CORNER       (-4)       /*                  */
  213.                       /*                  */
  214. #define WN_HIDDEN       (-5)       /* Whether it's hidden.         */
  215.                       /*                  */
  216. #define WN_CUR_OFF         6          /* Cursor on/off state          */
  217. #define WN_CUR_HIGH         7          /* Cursor scan lines          */
  218. #define WN_CUR_LOW         8          /*                  */
  219.  
  220.                       /* User-controllable options    */
  221. #define WN_DELAYED         9          /*                  */
  222. #define WN_REMOVABLE        10          /*                  */
  223.  
  224. #define WN_FROZEN        11          /* Internal effects of          */
  225. #define WN_DIRTY        12          /*   displaying windows          */
  226. #define WN_ANY_DATA_COVERED 13          /*                  */
  227.  
  228. #define WN_ROWS         14          /* Dimensions of data area      */
  229. #define WN_COLS         15          /*                  */
  230.                       /*                  */
  231. #define WN_ROW_REL        16          /* Cursor location relative to  */
  232. #define WN_COL_REL        17          /* data area              */
  233.                       /*                  */
  234. #define WN_ROW_ABS      (-18)       /* Absolute cursor location on  */
  235. #define WN_COL_ABS      (-19)       /* screen               */
  236.  
  237. #define WN_ROW_OVERALL      (-27)       /* Location of window with      */
  238. #define WN_COL_OVERALL      (-28)       /* border.              */
  239. #define WN_HT_OVERALL      (-29)       /* Dimensions of window with    */
  240. #define WN_WID_OVERALL      (-30)       /* existing border.          */
  241.                       /*                  */
  242. #define WN_ATTR         20          /* Default attributes for data  */
  243.                       /* area                  */
  244.                       /*                  */
  245. #define WN_BOR_TYPE        22          /* Border type              */
  246. #define WN_BOR_CHAR        23          /* Border character          */
  247. #define WN_BOR_ATTR        24          /* Border attribute          */
  248.                       /*                  */
  249. #define WN_IS_CURRENT        25          /* Whether this is the current  */
  250.                       /* window               */
  251.                       /*                  */
  252. #define WN_ACTIVE_CUR      (-26)       /* Whether this window (among   */
  253.                       /* all the windows displayed on */
  254.                       /* its page) is the one whose   */
  255.                       /* cursor is active.          */
  256.  
  257.     /* Global variables                           */
  258.  
  259. extern int    b_wnerr;          /* Most recent error          */
  260.                       /* (WN_NO_ERROR if none).       */
  261.  
  262. extern BWINDOW *b_pcurwin;          /* Window selected for I/O      */
  263.                       /* (NIL if none).           */
  264.  
  265.     /* Global variables for internal use only                  */
  266.  
  267.                       /* List of windows displayed on */
  268.                       /* each page (NIL if none).     */
  269. extern WIN_NODE *(b_wnlist[MAX_DEVICES][MAX_PAGES]);
  270.  
  271.                       /* The window (on each page)    */
  272.                       /* selected to have a visible   */
  273.                       /* cursor (NIL if none).          */
  274. extern WIN_NODE *(b_pactnode[MAX_DEVICES][MAX_PAGES]);
  275.  
  276.  
  277.     /* Function declarations by category                  */
  278.  
  279.     /* Window creation and destruction                      */
  280.  
  281. BWINDOW  *wncreate(int,int,int);      /* Allocate & create BWINDOW    */
  282.                       /* structure.              */
  283.                       /*                  */
  284. int      wndstroy(BWINDOW *);          /* Detach from screen & discard */
  285.                       /* memory structures (don't     */
  286.                       /* alter screen).           */
  287.  
  288.     /* Controlling/retrieving window options & status              */
  289.  
  290. BWINDOW  *wnsetopt(BWINDOW *,int,     /* Set option.              */
  291.          int);
  292. BWINDOW  *wngetopt(BWINDOW *,int,     /* Retrieve option or status.   */
  293.          int *);
  294.  
  295.     /* Error reporting                              */
  296.  
  297. #if WN_EXT_ERROR
  298.                       /* External version:          */
  299. int      wnerror(int);           /* Set or clear error code and  */
  300.                       /* return it.              */
  301. #else
  302.                       /* Macro version:           */
  303. #define   wnerror(ercode)   (b_wnerr = (ercode))
  304.  
  305. #endif
  306.  
  307.     /* Displaying/removing windows                      */
  308.  
  309.                       /* Display window with border.  */
  310. BWINDOW  *wndsplay(BWINDOW *,WHERE *,BORDER *);
  311.                       /*                  */
  312. BWINDOW  *wnremove(BWINDOW *);          /* Remove window from display   */
  313.                       /* page.                  */
  314.                       /*                  */
  315. BWINDOW  *wnforget(BWINDOW *);          /* Detach window from display   */
  316.                       /* page without altering screen.*/
  317.                       /*                  */
  318. BWINDOW  *wnhide(BWINDOW *);          /* Conceal window but leave     */
  319.                       /* attached to location on      */
  320.                       /* display page.              */
  321.                       /*                  */
  322. BWINDOW  *wnunhide(BWINDOW *);          /* Redisplay hidden window.     */
  323.                       /*                  */
  324. BWINDOW  *wnupdate(BWINDOW *);          /* Satisfy pending output       */
  325.                       /* requests.              */
  326.                       /*                  */
  327. int      wnredraw(int,int);          /* Redisplay all windows on     */
  328.                       /* a display page and restore   */
  329.                       /* cursor.              */
  330.  
  331.     /* Window I/O                              */
  332.  
  333. BWINDOW  *wnselect(BWINDOW *);          /* Select window for I/O          */
  334.                       /* (deselect all other windows) */
  335.                       /* making this the "current"    */
  336.                       /* window.              */
  337.                       /*                  */
  338. BWINDOW  *wncursor(BWINDOW *);          /* Select for visible cursor    */
  339.                       /* (deselect other windows      */
  340.                       /* shown on this display page.) */
  341.                       /*                  */
  342. BWINDOW  *wncurmov(int,int);          /* Move current window's cursor */
  343.                       /* relative to the window's     */
  344.                       /* data area.              */
  345.                       /*                  */
  346. BWINDOW  *wncurpos(int *,int *);      /* Return current window's      */
  347.                       /* cursor position relative to  */
  348.                       /* the window's data area.      */
  349.                       /*                  */
  350. void      wnwrtty(char,int,int);      /* Write a character to current */
  351.                       /* window TTY-style.          */
  352.                       /*                  */
  353. void      wnwrap(int,char *,          /* Write a string TTY-style     */
  354.             int,int,int);     /* with word wrap.          */
  355.                       /*                  */
  356. int      wnrdbuf(int,int,int,          /* Read a buffer.           */
  357.              char *,int);     /*                  */
  358.                       /*                  */
  359. int      wnwrbuf(int,int,int,char *, /* Write a buffer.          */
  360.             int,int,int);     /*                  */
  361.                       /*                  */
  362. char      wnquery(char *,int,int *);  /* Return input from operator.  */
  363.                       /*                  */
  364. BWINDOW  *wnscroll(int,int,int,int);  /* Vertically scroll window.    */
  365.                       /*                  */
  366. BWINDOW  *wnhoriz(int,int,int,int);   /* Horizontally scroll window.  */
  367.                       /*                  */
  368. BWINDOW  *wnattr(int,int);          /* Change attributes on window  */
  369.                       /* (but don't change default).  */
  370.  
  371.     /* Internal functions by category                      */
  372.  
  373.     /* Device & page switching                          */
  374.  
  375. int      wnseldev(WHERE *,DIM *,int *);
  376.  
  377.     /* Error detection                              */
  378.  
  379. BWINDOW  *wnvalwin(BWINDOW *);
  380. WIN_NODE *wnvalnod(WIN_NODE *);
  381.  
  382.     /* Handling IMAGE structures                      */
  383.  
  384. IMAGE     *wnmkimg(IMAGE *);
  385. IMAGE     *wnputimg(IMAGE *,WHERE *);
  386. IMAGE     *wngetimg(IMAGE *,WHERE *);
  387.  
  388.     /* Manipulating chains of WIN_NODEs                   */
  389.  
  390. WIN_NODE *wnpgadd(BWINDOW *,int,int);
  391. BWINDOW  *wnpgrem(BWINDOW *);
  392.  
  393.     /* Building borders                           */
  394.  
  395. int      wnputbor(DIM *,BORDER *,WHERE *);
  396.  
  397.     /* Handling inter-window effects:  displaying, overlapping,       */
  398.     /* removing                               */
  399.  
  400. WIN_NODE *wncover(WIN_NODE *,LOC *,DIM *);
  401. int      wnovrlap(LOC *,DIM *,LOC *,DIM *);
  402.  
  403.  
  404. #define DEF_BWINDOW  1              /* Prevent second reading of    */
  405.                       /* these definitions.          */
  406.  
  407. #endif                      /* Ends "#ifndef DEF_BWINDOW"   */
  408.