Home | History | Annotate | Line # | Download | only in libcurses
curses_private.h revision 1.2
      1 /*	$NetBSD: curses_private.h,v 1.2 2000/04/12 21:46:27 jdc Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1998-2000 Brett Lymn
      5  *                         (blymn (at) baea.com.au, brett_lymn (at) yahoo.com.au)
      6  * All rights reserved.
      7  *
      8  * This code has been donated to The NetBSD Foundation by the Author.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. The name of the author may not be used to endorse or promote products
     16  *    derived from this software withough specific prior written permission
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28  *
     29  *
     30  */
     31 
     32 /* Private structure definitions for curses. */
     33 /*
     34  * A window an array of __LINE structures pointed to by the 'lines' pointer.
     35  * A line is an array of __LDATA structures pointed to by the 'line' pointer.
     36  *
     37  * IMPORTANT: the __LDATA structure must NOT induce any padding, so if new
     38  * fields are added -- padding fields with *constant values* should ensure
     39  * that the compiler will not generate any padding when storing an array of
     40  *  __LDATA structures.  This is to enable consistent use of memcmp, and memcpy
     41  * for comparing and copying arrays.
     42  */
     43 
     44 struct __ldata {
     45 	wchar_t	ch;			/* Character */
     46 	attr_t	attr;			/* Attributes */
     47 };
     48 
     49 #define __LDATASIZE	(sizeof(__LDATA))
     50 
     51 struct __line {
     52 #define	__ISDIRTY	0x01		/* Line is dirty. */
     53 #define __ISPASTEOL	0x02		/* Cursor is past end of line */
     54 #define __FORCEPAINT	0x04		/* Force a repaint of the line */
     55 	unsigned int flags;
     56 	unsigned int hash;		/* Hash value for the line. */
     57 	int *firstchp, *lastchp;	/* First and last chngd columns ptrs */
     58 	int firstch, lastch;		/* First and last changed columns. */
     59 	__LDATA *line;			/* Pointer to the line text. */
     60 };
     61 
     62 struct __window {		/* Window structure. */
     63 	struct __window	*nextp, *orig;	/* Subwindows list and parent. */
     64 	int begy, begx;			/* Window home. */
     65 	int cury, curx;			/* Current x, y coordinates. */
     66 	int maxy, maxx;			/* Maximum values for curx, cury. */
     67 	short ch_off;			/* x offset for firstch/lastch. */
     68 	__LINE **lines;			/* Array of pointers to the lines */
     69 	__LINE  *lspace;		/* line space (for cleanup) */
     70 	__LDATA *wspace;		/* window space (for cleanup) */
     71 
     72 #define	__ENDLINE	0x00000001	/* End of screen. */
     73 #define	__FLUSH		0x00000002	/* Fflush(stdout) after refresh. */
     74 #define	__FULLWIN	0x00000004	/* Window is a screen. */
     75 #define	__IDLINE	0x00000008	/* Insert/delete sequences. */
     76 #define	__SCROLLWIN	0x00000010	/* Last char will scroll window. */
     77 #define	__SCROLLOK	0x00000020	/* Scrolling ok. */
     78 #define	__CLEAROK	0x00000040	/* Clear on next refresh. */
     79 #define	__LEAVEOK	0x00000100	/* If cursor left */
     80 #define	__KEYPAD	0x00010000	/* If interpreting keypad codes */
     81 #define	__NOTIMEOUT	0x00020000	/* Wait indefinitely for func keys */
     82 	unsigned int flags;
     83 	int	delay;			/* delay for getch() */
     84 	attr_t	wattr;			/* Character attributes */
     85 	wchar_t	bchar;			/* Background character */
     86 	attr_t	battr;			/* Background attributes */
     87 };
     88 
     89 /* Private functions. */
     90 #ifdef DEBUG
     91 void	 __CTRACE __P((const char *, ...));
     92 #endif
     93 int	 __delay __P((void));
     94 unsigned int __hash __P((char *, int));
     95 void	 __id_subwins __P((WINDOW *));
     96 void	 __init_getch __P((char *));
     97 void	 __init_acs __P((void));
     98 char	*__longname __P((char *, char *));	/* Original BSD version */
     99 int	 __mvcur __P((int, int, int, int, int));
    100 int	 __nodelay __P((void));
    101 int	 __notimeout __P((void));
    102 char	*__parse_cap __P((const char *, ...));
    103 void	 __restartwin __P((void));
    104 void	 __restore_colors __P((void));
    105 void	 __restore_termios __P((void));
    106 void	 __restore_stophandler __P((void));
    107 void	 __save_termios __P((void));
    108 void	 __set_color __P((attr_t));
    109 void	 __set_stophandler __P((void));
    110 void	 __set_subwin __P((WINDOW *, WINDOW *));
    111 void	 __startwin __P((void));
    112 void	 __stop_signal_handler __P((int));
    113 int	 __stopwin __P((void));
    114 void	 __swflags __P((WINDOW *));
    115 int	 __timeout __P((int));
    116 int	 __touchline __P((WINDOW *, int, int, int, int));
    117 int	 __touchwin __P((WINDOW *));
    118 char	*__tscroll __P((const char *, int, int));
    119 int	 __waddch __P((WINDOW *, __LDATA *));
    120 
    121 /* Private #defines. */
    122 #define	min(a,b)	(a < b ? a : b)
    123 #define	max(a,b)	(a > b ? a : b)
    124 
    125 /* Private externs. */
    126 extern int	 __echoit;
    127 extern int	 __endwin;
    128 extern int	 __pfast;
    129 extern int	 __rawmode;
    130 extern int	 __noqch;
    131 extern attr_t	 __nca;
    132