]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - ncurses/curses.priv.h
ncurses 5.2
[ncurses.git] / ncurses / curses.priv.h
index 30ce3fbfbca1cb4561e0ccd2efbea2e4760b5fb9..d82e3aad752a2efa26e9b7ebda40a1699308ed1c 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998 Free Software Foundation, Inc.                        *
+ * Copyright (c) 1998,1999,2000 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
@@ -33,7 +33,7 @@
 
 
 /*
- * $Id: curses.priv.h,v 1.101 1998/02/11 12:13:57 tom Exp $
+ * $Id: curses.priv.h,v 1.168 2000/10/08 01:24:59 tom Exp $
  *
  *     curses.priv.h
  *
@@ -97,8 +97,13 @@ extern int errno;
 #include <nc_panel.h>
 
 /* Some systems have a broken 'select()', but workable 'poll()'.  Use that */
-#if HAVE_POLL && HAVE_SYS_STROPTS_H && HAVE_POLL_H
+#if HAVE_WORKING_POLL
 #define USE_FUNC_POLL 1
+#if HAVE_POLL_H
+#include <poll.h>
+#else
+#include <sys/poll.h>
+#endif
 #else
 #define USE_FUNC_POLL 0
 #endif
@@ -117,6 +122,11 @@ extern int errno;
 #define USE_QNX_MOUSE 0
 #endif
 
+/* EMX mouse support */
+#ifdef __EMX__
+#define USE_EMX_MOUSE
+#endif
+
 #define DEFAULT_MAXCLICK 166
 #define EV_MAX         8       /* size of mouse circular event queue */
 
@@ -124,7 +134,7 @@ extern int errno;
  * If we don't have signals to support it, don't add a sigwinch handler.
  * In any case, resizing is an extended feature.  Use it if we've got it.
  */
-#ifndef NCURSES_EXT_FUNCS
+#if !NCURSES_EXT_FUNCS
 #undef HAVE_SIZECHANGE
 #endif
 
@@ -135,10 +145,32 @@ extern int errno;
 #endif
 
 /*
- * As currently coded, hashmap relies on the scroll-hints logic.
+ * If desired, one can configure this, disabling environment variables that
+ * point to custom terminfo/termcap locations.
+ */
+#ifdef USE_ROOT_ENVIRON
+#define use_terminfo_vars() 1
+#else
+#define use_terminfo_vars() _nc_env_access()
+extern int _nc_env_access(void);
+#endif
+
+/*
+ * Not all platforms have memmove; some have an equivalent bcopy.  (Some may
+ * have neither).
+ */
+#if USE_OK_BCOPY
+#define memmove(d,s,n) bcopy(s,d,n)
+#elif USE_MY_MEMMOVE
+#define memmove(d,s,n) _nc_memmove(d,s,n)
+extern void * _nc_memmove(void *, const void *, size_t);
+#endif
+
+/*
+ * Scroll hints are useless when hashmap is used
  */
 #if !USE_SCROLL_HINTS
-#if USE_HASHMAP
+#if !USE_HASHMAP
 #define USE_SCROLL_HINTS 1
 #else
 #define USE_SCROLL_HINTS 0
@@ -174,6 +206,13 @@ struct tries {
 
 #define PAIR_OF(fg, bg) ((((fg) & C_MASK) << C_SHIFT) | ((bg) & C_MASK))
 
+/*
+ * Common/troublesome character definitions
+ */
+#define L_BRACE '{'
+#define R_BRACE '}'
+#define S_QUOTE '\''
+
 /*
  * Structure for palette tables
  */
@@ -223,6 +262,7 @@ struct screen {
        int             _ifd;           /* input file ptr for screen        */
        FILE            *_ofp;          /* output file ptr for screen       */
        char            *_setbuf;       /* buffered I/O for output          */
+       int             _buffered;      /* setvbuf uses _setbuf data        */
        int             _checkfd;       /* filedesc for typeahead check     */
        struct term     *_term;         /* terminal type information        */
        short           _lines;         /* screen lines                     */
@@ -257,8 +297,11 @@ struct screen {
        int             _echo;          /* True if echo on                  */
        int             _use_meta;      /* use the meta key?                */
        SLK             *_slk;          /* ptr to soft key struct / NULL    */
-
+        int             slk_format;     /* selected format for this screen  */
        /* cursor movement costs; units are 10ths of milliseconds */
+#if NCURSES_NO_PADDING
+       int             _no_padding;    /* flag to set if padding disabled  */
+#endif
        int             _char_padding;  /* cost of character put            */
        int             _cr_cost;       /* cost of (carriage_return)        */
        int             _cup_cost;      /* cost of (cursor_address)         */
@@ -278,7 +321,7 @@ struct screen {
        int             _cuu_cost;      /* cost of (parm_cursor_up)         */
        int             _hpa_cost;      /* cost of (column_address)         */
        int             _vpa_cost;      /* cost of (row_address)            */
-       /* used in lib_doupdate.c, must be chars */
+       /* used in tty_update.c, must be chars */
        int             _ed_cost;       /* cost of (clr_eos)                */
        int             _el_cost;       /* cost of (clr_eol)                */
        int             _el1_cost;      /* cost of (clr_bol)                */
@@ -290,11 +333,14 @@ struct screen {
        int             _rep_cost;      /* cost of (repeat_char)            */
        int             _hpa_ch_cost;   /* cost of (column_address)         */
        int             _cup_ch_cost;   /* cost of (cursor_address)         */
+       int             _cuf_ch_cost;   /* cost of (parm_cursor_right)      */
+       int             _inline_cost;   /* cost of inline-move              */
+       int             _smir_cost;     /* cost of (enter_insert_mode)      */
+       int             _rmir_cost;     /* cost of (exit_insert_mode)       */
+       int             _ip_cost;       /* cost of (insert_padding)         */
        /* used in lib_mvcur.c */
        char *          _address_cursor;
-       int             _carriage_return_length;
-       int             _cursor_home_length;
-       int             _cursor_to_ll_length;
+       /* used in tty_update.c */
        int             _scrolling;     /* 1 if terminal's smart enough to  */
 
        /* used in lib_color.c */
@@ -302,11 +348,20 @@ struct screen {
        int             _color_count;   /* count of colors in palette        */
        unsigned short  *_color_pairs;  /* screen's color pair list          */
        int             _pair_count;    /* count of color pairs              */
-       int             _default_color; /* use default colors                */
+#if NCURSES_EXT_FUNCS
+       bool            _default_color; /* use default colors                */
+       bool            _has_sgr_39_49; /* has ECMA default color support    */
+       int             _default_fg;    /* assumed default foreground        */
+       int             _default_bg;    /* assumed default background        */
+#endif
        chtype          _xmc_suppress;  /* attributes to suppress if xmc     */
        chtype          _xmc_triggers;  /* attributes to process if xmc      */
        chtype          _acs_map[ACS_LEN];
 
+       /* used in lib_vidattr.c */
+       bool            _use_rmso;      /* true if we may use 'rmso'         */
+       bool            _use_rmul;      /* true if we may use 'rmul'         */
+
        /*
         * These data correspond to the state of the idcok() and idlok()
         * functions.  A caveat is in order here:  the XSI and SVr4
@@ -351,11 +406,17 @@ struct screen {
 
        bool            _sig_winch;
        SCREEN          *_next_screen;
+
+       /* hashes for old and new lines */
+       unsigned long   *oldhash, *newhash;
+
+       bool            _cleanup;       /* cleanup after int/quit signal */
+       int             (*_outch)(int); /* output handler if not putc */
 };
 
 extern SCREEN *_nc_screen_chain;
 
-#ifdef NCURSES_NOMACROS
+#if NCURSES_NOMACROS
 #include <nomacros.h>
 #endif
 
@@ -382,6 +443,10 @@ typedef    struct {
 #endif
 
 /* usually in <unistd.h> */
+#ifndef STDIN_FILENO
+#define STDIN_FILENO 0
+#endif
+
 #ifndef STDOUT_FILENO
 #define STDOUT_FILENO 1
 #endif
@@ -411,6 +476,14 @@ typedef    struct {
 #define        F_OK    0               /* Test for existence.  */
 #endif
 
+#if HAVE_FCNTL_H
+#include <fcntl.h>             /* may define O_BINARY  */
+#endif
+
+#ifndef O_BINARY
+#define O_BINARY 0
+#endif
+
 #define TextOf(c)    ((c) & (chtype)A_CHARTEXT)
 #define AttrOf(c)    ((c) & (chtype)A_ATTRIBUTES)
 
@@ -418,9 +491,35 @@ typedef    struct {
 
 #define CHANGED     -1
 
+#define CHANGED_CELL(line,col) \
+       if (line->firstchar == _NOCHANGE) \
+               line->firstchar = line->lastchar = col; \
+       else if ((col) < line->firstchar) \
+               line->firstchar = col; \
+       else if ((col) > line->lastchar) \
+               line->lastchar = col
+
+#define CHANGED_RANGE(line,start,end) \
+       if (line->firstchar == _NOCHANGE \
+        || line->firstchar > (start)) \
+               line->firstchar = start; \
+       if (line->lastchar == _NOCHANGE \
+        || line->lastchar < (end)) \
+               line->lastchar = end
+
+#define CHANGED_TO_EOL(line,start,end) \
+       if (line->firstchar == _NOCHANGE \
+        || line->firstchar > (start)) \
+               line->firstchar = start; \
+       line->lastchar = end
+
 #define SIZEOF(v) (sizeof(v)/sizeof(v[0]))
-#define typeCalloc(type,elts) (type *)calloc(elts,sizeof(type))
-#define FreeIfNeeded(p)  if(p != 0) free(p)
+
+#define FreeIfNeeded(p)  if ((p) != 0) free(p)
+
+/* FreeAndNull() is not a comma-separated expression because some compilers
+ * do not accept a mixture of void with values.
+ */
 #define FreeAndNull(p)   free(p); p = 0
 
 #include <nc_alloc.h>
@@ -440,17 +539,16 @@ typedef   struct {
 #define TPUTS_TRACE(s) _nc_tputs_trace = s;
 #define TRACE_RETURN(value,type) return _nc_retrace_##type(value)
 #define returnAttr(code) TRACE_RETURN(code,attr_t)
+#define returnChar(code) TRACE_RETURN(code,chtype)
 #define returnCode(code) TRACE_RETURN(code,int)
 #define returnPtr(code)  TRACE_RETURN(code,ptr)
 #define returnVoid       T((T_RETURN(""))); return
 #define returnWin(code)  TRACE_RETURN(code,win)
-extern unsigned _nc_tracing;
 extern WINDOW * _nc_retrace_win(WINDOW *);
 extern attr_t _nc_retrace_attr_t(attr_t);
+extern attr_t _nc_retrace_chtype(chtype);
 extern char *_nc_retrace_ptr(char *);
 extern const char *_nc_tputs_trace;
-extern const char *_nc_visbuf(const char *);
-extern const char *_nc_visbuf2(int, const char *);
 extern int _nc_retrace_int(int);
 extern long _nc_outchars;
 extern void _nc_fifo_dump(void);
@@ -459,12 +557,16 @@ extern void _nc_fifo_dump(void);
 #define TR(n, a)
 #define TPUTS_TRACE(s)
 #define returnAttr(code) return code
+#define returnChar(code) return code
 #define returnCode(code) return code
 #define returnPtr(code)  return code
 #define returnVoid       return
 #define returnWin(code)  return code
 #endif
 
+extern unsigned _nc_tracing;
+extern const char *_nc_visbuf2(int, const char *);
+
 #define _trace_key(ch) ((ch > KEY_MIN) ? keyname(ch) : _tracechar((unsigned char)ch))
 
 #define ALL_BUT_COLOR ((chtype)~(A_COLOR))
@@ -473,15 +575,15 @@ extern void _nc_fifo_dump(void);
 #define XMC_CHANGES(c) ((c) & SP->_xmc_suppress)
 
 
-#define toggle_attr_on(S,at) \
+#define toggle_attr_on(S,at) {\
    if (PAIR_NUMBER(at) > 0)\
       (S) = ((S) & ALL_BUT_COLOR) | (at);\
    else\
       (S) |= (at);\
-   T(("new attribute is %s", _traceattr((S))))
+   TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
 
 
-#define toggle_attr_off(S,at) \
+#define toggle_attr_off(S,at) {\
    if (IGNORE_COLOR_OFF == TRUE) {\
       if (PAIR_NUMBER(at) == 0xff) /* turn off color */\
         (S) &= ~(at);\
@@ -493,7 +595,7 @@ extern void _nc_fifo_dump(void);
       else /* leave color alone */\
         (S) &= ~(at);\
    }\
-   T(("new attribute is %s", _traceattr((S))));
+   TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}
 
 #define DelCharCost(count) \
                ((parm_dch != 0) \
@@ -505,9 +607,11 @@ extern void _nc_fifo_dump(void);
 #define InsCharCost(count) \
                ((parm_ich != 0) \
                ? SP->_ich_cost \
-               : ((insert_character != 0) \
-                       ? (SP->_ich1_cost * count) \
-                       : INFINITY))
+               : ((enter_insert_mode && exit_insert_mode) \
+                 ? SP->_smir_cost + SP->_rmir_cost + (SP->_ip_cost * count) \
+                 : ((insert_character != 0) \
+                   ? (SP->_ich1_cost * count) \
+                   : INFINITY)))
 
 #if USE_XMC_SUPPORT
 #define UpdateAttrs(c) if (SP->_current_attr != AttrOf(c)) { \
@@ -515,7 +619,8 @@ extern void _nc_fifo_dump(void);
                                vidattr(AttrOf(c)); \
                                if (magic_cookie_glitch > 0 \
                                 && XMC_CHANGES((chg ^ SP->_current_attr))) { \
-                                       T(("%s @%d before glitch %d,%d", \
+                                       TR(TRACE_ATTRS, \
+                                               ("%s @%d before glitch %d,%d", \
                                                __FILE__, __LINE__, \
                                                SP->_cursrow, \
                                                SP->_curscol)); \
@@ -524,19 +629,10 @@ extern void _nc_fifo_dump(void);
                        }
 #else
 #define UpdateAttrs(c) if (SP->_current_attr != AttrOf(c)) \
-                               vidattr(AttrOf(c));
+                               vidattr(AttrOf(c))
 #endif
 
-/*
- * Check whether the given character can be output by clearing commands.  This
- * includes test for being a space and not including any 'bad' attributes, such
- * as A_REVERSE.  All attribute flags which don't affect appearance of a space
- * or can be output by clearing (A_COLOR in case of bce-terminal) are excluded.
- */
-#define can_clear_with(ch) \
-       ((ch & ~(NONBLANK_ATTR|(back_color_erase ? A_COLOR:0))) == BLANK)
-
-#ifdef NCURSES_EXPANDED
+#if NCURSES_EXPANDED && NCURSES_EXT_FUNCS
 
 #undef  toggle_attr_on
 #define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
@@ -546,10 +642,6 @@ extern void _nc_toggle_attr_on(attr_t *, attr_t);
 #define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
 extern void _nc_toggle_attr_off(attr_t *, attr_t);
 
-#undef  can_clear_with
-#define can_clear_with(ch) _nc_can_clear_with(ch)
-extern int _nc_can_clear_with(chtype);
-
 #undef  DelCharCost
 #define DelCharCost(count) _nc_DelCharCost(count)
 extern int _nc_DelCharCost(int);
@@ -568,23 +660,22 @@ extern void _nc_expanded(void);
 
 #endif
 
+#if !HAVE_GETCWD
+#define getcwd(buf,len) getwd(buf)
+#endif
+
 /* doupdate.c */
 #if USE_XMC_SUPPORT
 extern void _nc_do_xmc_glitch(attr_t);
 #endif
 
 /* hardscroll.c */
-#if defined(TRACE) || defined(SCROLLDEBUG)
-extern void _nc_linedump(void);
-#endif
-
-/* hardscroll.c */
-#if defined(TRACE) || defined(SCROLLDEBUG)
+#if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
 extern void _nc_linedump(void);
 #endif
 
 /* lib_acs.c */
-extern void init_acs(void);    /* no prefix, this name is traditional */
+extern void _nc_init_acs(void);        /* corresponds to traditional 'init_acs()' */
 extern int _nc_msec_cost(const char *const, int);  /* used by 'tack' program */
 
 /* lib_mvcur.c */
@@ -603,52 +694,101 @@ extern void _nc_screen_wrap(void);
 /* lib_mouse.c */
 extern int _nc_has_mouse(void);
 
+/* lib_mvcur.c */
+#define INFINITY       1000000 /* cost: too high to use */
+
+typedef struct {
+    char *s_head;
+    char *s_tail;
+    size_t s_size;
+} string_desc;
+
+/* strings.c */
+extern string_desc *_nc_str_init(string_desc * dst, char *src, size_t len);
+extern string_desc *_nc_str_null(string_desc * dst, size_t len);
+extern string_desc *_nc_str_copy(string_desc * dst, string_desc * src);
+extern bool _nc_safe_strcat(string_desc * dst, const char *src);
+extern bool _nc_safe_strcpy(string_desc * dst, const char *src);
+
+extern void _nc_mvcur_init(void);
+extern void _nc_mvcur_resume(void);
+extern void _nc_mvcur_wrap(void);
+
+extern int _nc_scrolln(int, int, int, int);
+
+extern void _nc_screen_init(void);
+extern void _nc_screen_resume(void);
+extern void _nc_screen_wrap(void);
+
+#if !HAVE_STRSTR
+#define strstr _nc_strstr
+extern char *_nc_strstr(const char *, const char *);
+#endif
+
 /* safe_sprintf.c */
 extern char * _nc_printf_string(const char *fmt, va_list ap);
 
-/* softscroll.c */
-extern void _nc_setup_scroll(void);
-extern void _nc_perform_scroll(void);
-
 /* tries.c */
-extern void _nc_add_to_try(struct tries **tree, char *str, unsigned short code);
-extern char *_nc_expand_try(struct tries *tree, unsigned short code, size_t len);
+extern void _nc_add_to_try(struct tries **tree, const char *str, unsigned short code);
+extern char *_nc_expand_try(struct tries *tree, unsigned short code, int *count, size_t len);
 extern int _nc_remove_key(struct tries **tree, unsigned short code);
+extern int _nc_remove_string(struct tries **tree, char *string);
 
 /* elsewhere ... */
 extern WINDOW *_nc_makenew(int, int, int, int, int);
+extern char *_nc_home_terminfo(void);
 extern char *_nc_trace_buf(int, size_t);
 extern chtype _nc_background(WINDOW *);
 extern chtype _nc_render(WINDOW *, chtype);
+extern int _nc_access(const char *, int);
+extern int _nc_baudrate(int);
+extern int _nc_getenv_num(const char *);
 extern int _nc_keypad(bool);
+extern int _nc_ospeed(int);
 extern int _nc_outch(int);
 extern int _nc_setupscreen(short, short const, FILE *);
 extern int _nc_timed_wait(int, int, int *);
 extern int _nc_waddch_nosync(WINDOW *, const chtype);
-extern void _nc_do_color(int, bool, int (*)(int));
-extern void _nc_free_and_exit(int);
+extern void _nc_do_color(int, int, bool, int (*)(int));
 extern void _nc_freeall(void);
 extern void _nc_freewin(WINDOW *win);
 extern void _nc_hash_map(void);
+extern void _nc_init_keytry(void);
+extern void _nc_keep_tic_dir(const char *);
+extern void _nc_make_oldhash(int i);
+extern void _nc_flush(void);
 extern void _nc_outstr(const char *str);
+extern void _nc_scroll_oldhash(int n, int top, int bot);
 extern void _nc_scroll_optimize(void);
 extern void _nc_scroll_window(WINDOW *, int const, short const, short const, chtype);
-extern void _nc_set_buffer(FILE *ofp, bool buffered);
+extern void _nc_set_buffer(FILE *, bool);
 extern void _nc_signal_handler(bool);
 extern void _nc_synchook(WINDOW *win);
+extern void _nc_trace_tries(struct tries *tree);
 
 #if USE_SIZECHANGE
 extern void _nc_update_screensize(void);
 #endif
 
+#if USE_WIDEC_SUPPORT
+extern int _nc_utf8_outch(int);
+#endif
+
+/* scroll indices */
+extern int *_nc_oldnums;
+
+#define USE_SETBUF_0 0
+
+#define NC_BUFFERED(flag) \
+       if ((SP->_buffered != 0) != flag) \
+               _nc_set_buffer(SP->_ofp, flag)
+
+#define NC_OUTPUT ((SP != 0) ? SP->_ofp : stdout)
+
 /*
  * On systems with a broken linker, define 'SP' as a function to force the
  * linker to pull in the data-only module with 'SP'.
  */
-#ifndef BROKEN_LINKER
-#define BROKEN_LINKER 0
-#endif
-
 #if BROKEN_LINKER
 #define SP _nc_screen()
 extern SCREEN *_nc_screen(void);
@@ -673,21 +813,21 @@ extern SCREEN *SP;
 extern int _nc_slk_format;  /* != 0 if slk_init() called */
 extern int _nc_slk_initialize(WINDOW *, int);
 
-/* 
- * Some constants related to SLK's 
+/*
+ * Some constants related to SLK's
  */
 #define MAX_SKEY_OLD      8    /* count of soft keys */
 #define MAX_SKEY_LEN_OLD   8   /* max length of soft key text */
 #define MAX_SKEY_PC       12    /* This is what most PC's have */
 #define MAX_SKEY_LEN_PC    5
 
-#define MAX_SKEY          (SLK_STDFMT ? MAX_SKEY_OLD : MAX_SKEY_PC)
-#define MAX_SKEY_LEN      (SLK_STDFMT ? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
-
 /* Macro to check whether or not we use a standard format */
-#define SLK_STDFMT (_nc_slk_format < 3)
+#define SLK_STDFMT(fmt) (fmt < 3)
 /* Macro to determine height of label window */
-#define SLK_LINES  (SLK_STDFMT ? 1 : (_nc_slk_format - 2))
+#define SLK_LINES(fmt)  (SLK_STDFMT(fmt) ? 1 : ((fmt) - 2))
+
+#define MAX_SKEY(fmt)     (SLK_STDFMT(fmt)? MAX_SKEY_OLD : MAX_SKEY_PC)
+#define MAX_SKEY_LEN(fmt) (SLK_STDFMT(fmt)? MAX_SKEY_LEN_OLD : MAX_SKEY_LEN_PC)
 
 extern int _nc_ripoffline(int line, int (*init)(WINDOW *,int));