Logo Search packages:      
Sourcecode: ncurses version File versions

curses.priv.h

/****************************************************************************
 * Copyright (c) 1998-2003,2004 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            *
 * "Software"), to deal in the Software without restriction, including      *
 * without limitation the rights to use, copy, modify, merge, publish,      *
 * distribute, distribute with modifications, sublicense, and/or sell       *
 * copies of the Software, and to permit persons to whom the Software is    *
 * furnished to do so, subject to the following conditions:                 *
 *                                                                          *
 * The above copyright notice and this permission notice shall be included  *
 * in all copies or substantial portions of the Software.                   *
 *                                                                          *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
 *                                                                          *
 * Except as contained in this notice, the name(s) of the above copyright   *
 * holders shall not be used in advertising or otherwise to promote the     *
 * sale, use or other dealings in this Software without prior written       *
 * authorization.                                                           *
 ****************************************************************************/

/****************************************************************************
 *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
 *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
 *     and: Thomas E. Dickey 1996-2002                                      *
 ****************************************************************************/


/*
 * $Id: curses.priv.h,v 1.255 2004/02/01 01:05:58 Stanislav.Ievlev Exp $
 *
 *    curses.priv.h
 *
 *    Header file for curses library objects which are private to
 *    the library.
 *
 */

#ifndef CURSES_PRIV_H
#define CURSES_PRIV_H 1

#include <ncurses_dll.h>

#ifdef __cplusplus
extern "C" {
#endif

#include <ncurses_cfg.h>

#if USE_RCS_IDS
#define MODULE_ID(id) static const char Ident[] = id;
#else
#define MODULE_ID(id) /*nothing*/
#endif

#include <stdlib.h>
#include <string.h>
#include <sys/types.h>

#if HAVE_UNISTD_H
#include <unistd.h>
#endif

#if HAVE_SYS_BSDTYPES_H
#include <sys/bsdtypes.h>     /* needed for ISC */
#endif

#if HAVE_LIMITS_H
# include <limits.h>
#elif HAVE_SYS_PARAM_H
# include <sys/param.h>
#endif

#ifndef PATH_MAX
# if defined(_POSIX_PATH_MAX)
#  define PATH_MAX _POSIX_PATH_MAX
# elif defined(MAXPATHLEN)
#  define PATH_MAX MAXPATHLEN
# else
#  define PATH_MAX 255  /* the Posix minimum path-size */
# endif
#endif

#include <assert.h>
#include <stdio.h>

#include <errno.h>

#if DECL_ERRNO
extern int errno;
#endif

#include <nc_panel.h>

/* Some systems have a broken 'select()', but workable 'poll()'.  Use that */
#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

/* include signal.h before curses.h to work-around defect in glibc 2.1.3 */
#include <signal.h>

/* Alessandro Rubini's GPM (general-purpose mouse) */
#if HAVE_LIBGPM && HAVE_GPM_H
#define USE_GPM_SUPPORT 1
#else
#define USE_GPM_SUPPORT 0
#endif

/* QNX mouse support */
#if defined(__QNX__) && !defined(__QNXNTO__)
#define USE_QNX_MOUSE 1
#else
#define USE_QNX_MOUSE 0
#endif

/* EMX mouse support */
#ifdef __EMX__
#define USE_EMX_MOUSE 1
#else
#define USE_EMX_MOUSE 0
#endif

#define DEFAULT_MAXCLICK 166
#define EV_MAX          8     /* size of mouse circular event queue */

/*
 * 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.
 */
#if !NCURSES_EXT_FUNCS
#undef HAVE_SIZECHANGE
#define HAVE_SIZECHANGE 0
#endif

#if HAVE_SIZECHANGE && defined(SIGWINCH)
#define USE_SIZECHANGE 1
#else
#define USE_SIZECHANGE 0
#undef USE_SIGWINCH
#define USE_SIGWINCH 0
#endif

/*
 * 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 NCURSES_EXPORT(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 NCURSES_EXPORT(void *) _nc_memmove (void *, const void *, size_t);
#endif

/*
 * Scroll hints are useless when hashmap is used
 */
#if !USE_SCROLL_HINTS
#if !USE_HASHMAP
#define USE_SCROLL_HINTS 1
#else
#define USE_SCROLL_HINTS 0
#endif
#endif

#if USE_SCROLL_HINTS
#define if_USE_SCROLL_HINTS(stmt) stmt
#else
#define if_USE_SCROLL_HINTS(stmt) /*nothing*/
#endif

/*
 * Note:  ht/cbt expansion flakes out randomly under Linux 1.1.47, but only
 * when we're throwing control codes at the screen at high volume.  To see
 * this, re-enable USE_HARD_TABS and run worm for a while.  Other systems
 * probably don't want to define this either due to uncertainties about tab
 * delays and expansion in raw mode.
 */

struct tries {
      struct tries    *child;     /* ptr to child.  NULL if none          */
      struct tries    *sibling;   /* ptr to sibling.  NULL if none        */
      unsigned char    ch;        /* character at this node               */
      unsigned short   value;     /* code of string so far.  0 if none.   */
};

/*
 * Definitions for color pairs
 */
#define C_SHIFT 8       /* we need more bits than there are colors */
#define C_MASK  ((1 << C_SHIFT) - 1)

#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 '\''
#define D_QUOTE '"'

#define VT_ACSC "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~"

/*
 * Structure for palette tables
 */

typedef struct
{
    short red, green, blue;   /* what color_content() returns */
    short r, g, b;            /* params to init_color() */
    int init;                 /* true if we called init_color() */
}
color_t;

#define MAXCOLUMNS    135
#define MAXLINES      66
#define FIFO_SIZE     MAXCOLUMNS+2  /* for nocbreak mode input */

#define ACS_LEN       128

#define WINDOWLIST struct _win_list

#if USE_WIDEC_SUPPORT
#define _nc_bkgd    _bkgrnd
#else
#undef _XOPEN_SOURCE_EXTENDED
#define _nc_bkgd    _bkgd
#define wgetbkgrnd(win, wch)  *wch = win->_bkgd
#define wbkgrnd       wbkgd
#endif

#include <curses.h>     /* we'll use -Ipath directive to get the right one! */
#include <term.h>

struct ldat
{
      NCURSES_CH_T      *text;            /* text of the line */
      NCURSES_SIZE_T    firstchar;  /* first changed character in the line */
      NCURSES_SIZE_T    lastchar;   /* last changed character in the line */
      NCURSES_SIZE_T    oldindex;   /* index of the line at last update */
};

typedef enum {
      M_XTERM     = -1        /* use xterm's mouse tracking? */
      ,M_NONE = 0       /* no mouse device */
#if USE_GPM_SUPPORT
      ,M_GPM                  /* use GPM */
#endif
#if USE_SYSMOUSE
      ,M_SYSMOUSE       /* FreeBSD sysmouse on console */
#endif
} MouseType;

/*
 * Structure for soft labels.
 */

typedef struct
{
      char *ent_text;         /* text for the label */
      char *form_text;        /* formatted text (left/center/...) */
      int ent_x;              /* x coordinate of this field */
      char dirty;             /* this label has changed */
      char visible;           /* field is visible */
} slk_ent;

typedef struct {
      char dirty;             /* all labels have changed */
      char hidden;            /* soft labels are hidden */
      WINDOW *win;
      slk_ent *ent;
      short  maxlab;          /* number of available labels */
      short  labcnt;          /* number of allocated labels */
      short  maxlen;          /* length of labels */
      chtype attr;            /* soft label attribute */
} SLK;

typedef struct {
      unsigned long hashval;
      int oldcount, newcount;
      int oldindex, newindex;
} HASHMAP;

typedef     struct {
      int   line;           /* lines to take, < 0 => from bottom*/
      int   (*hook)(WINDOW *, int); /* callback for user        */
      WINDOW *w;              /* maybe we need this for cleanup   */
} ripoff_t;

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     */
      TERMINAL        *_term;         /* terminal type information        */
      short           _lines;         /* screen lines                     */
      short           _columns;       /* screen columns                   */

      short           _lines_avail;   /* lines available for stdscr       */
      short           _topstolen;     /* lines stolen from top            */
      ripoff_t    _rippedoff[5];    /* list of lines stolen           */
      int         _rip_count; /* ...and total lines stolen      */

      WINDOW          *_curscr;       /* current screen                   */
      WINDOW          *_newscr;       /* virtual screen to be updated to  */
      WINDOW          *_stdscr;       /* screen's full-window context     */

      struct tries    *_keytry;       /* "Try" for use with keypad mode   */
      struct tries    *_key_ok;       /* Disabled keys via keyok(,FALSE)  */
      bool            _tried;         /* keypad mode was initialized      */
      bool            _keypad_on;     /* keypad mode is currently on      */

      bool        _called_wgetch;   /* check for recursion in wgetch()  */
      int                 _fifo[FIFO_SIZE];       /* input push-back buffer   */
      short           _fifohead,      /* head of fifo queue               */
                      _fifotail,      /* tail of fifo queue               */
                      _fifopeek,      /* where to peek for next char      */
                      _fifohold;      /* set if breakout marked           */

      int             _endwin;        /* are we out of window mode?       */
      attr_t          _current_attr;  /* terminal attribute current set   */
      int             _coloron;       /* is color enabled?                */
      int         _color_defs;      /* are colors modified            */
      int             _cursor;        /* visibility of the cursor         */
      int             _cursrow;       /* physical cursor row              */
      int             _curscol;       /* physical cursor column           */
      bool        _notty;           /* true if we cannot switch non-tty */
      int             _nl;            /* True if NL -> CR/NL is on        */
      int             _raw;           /* True if in raw mode              */
      int             _cbreak;        /* 1 if in cbreak mode              */
                                      /* > 1 if in halfdelay mode         */
      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)         */
      int             _home_cost;     /* cost of (cursor_home)            */
      int             _ll_cost;       /* cost of (cursor_to_ll)           */
#if USE_HARD_TABS
      int             _ht_cost;       /* cost of (tab)                    */
      int             _cbt_cost;      /* cost of (backtab)                */
#endif /* USE_HARD_TABS */
      int             _cub1_cost;     /* cost of (cursor_left)            */
      int             _cuf1_cost;     /* cost of (cursor_right)           */
      int             _cud1_cost;     /* cost of (cursor_down)            */
      int             _cuu1_cost;     /* cost of (cursor_up)              */
      int             _cub_cost;      /* cost of (parm_cursor_left)       */
      int             _cuf_cost;      /* cost of (parm_cursor_right)      */
      int             _cud_cost;      /* cost of (parm_cursor_down)       */
      int             _cuu_cost;      /* cost of (parm_cursor_up)         */
      int             _hpa_cost;      /* cost of (column_address)         */
      int             _vpa_cost;      /* cost of (row_address)            */
      /* 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)                */
      int             _dch1_cost;     /* cost of (delete_character)       */
      int             _ich1_cost;     /* cost of (insert_character)       */
      int             _dch_cost;      /* cost of (parm_dch)               */
      int             _ich_cost;      /* cost of (parm_ich)               */
      int             _ech_cost;      /* cost of (erase_chars)            */
      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;
      /* used in tty_update.c */
      int             _scrolling;     /* 1 if terminal's smart enough to  */

      /* used in lib_color.c */
      color_t         *_color_table;  /* screen's color palette            */
      int             _color_count;   /* count of colors in palette        */
      unsigned short  *_color_pairs;  /* screen's color pair list          */
      int             _pair_count;    /* count of color pairs              */
#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]; /* the real alternate-charset map */

      /* 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
       * documentation specify that these functions apply to the window which
       * is given as an argument.  However, ncurses implements this logic
       * only for the newscr/curscr update process, _not_ per-window.
       */
      bool            _nc_sp_idlok;
      bool            _nc_sp_idcok;
#define _nc_idlok SP->_nc_sp_idlok
#define _nc_idcok SP->_nc_sp_idcok

      /*
       * These are the data that support the mouse interface.
       */
      MouseType   _mouse_type;
      int             _maxclick;
      bool            (*_mouse_event) (SCREEN *);
      bool            (*_mouse_inline)(SCREEN *);
      bool            (*_mouse_parse) (int);
      void            (*_mouse_resume)(SCREEN *);
      void            (*_mouse_wrap)  (SCREEN *);
      int             _mouse_fd;      /* file-descriptor, if any */
      NCURSES_CONST char *_mouse_xtermcap; /* string to enable/disable mouse */
#if USE_SYSMOUSE
      MEVENT            _sysmouse_fifo[FIFO_SIZE];
      int         _sysmouse_head;
      int         _sysmouse_tail;
      int         _sysmouse_char_width;   /* character width */
      int         _sysmouse_char_height;  /* character height */
      int         _sysmouse_old_buttons;
      int         _sysmouse_new_buttons;
#endif

      /*
       * This supports automatic resizing
       */
#if USE_SIZECHANGE
      int         (*_resize)(int,int);
#endif

        /*
       * These are data that support the proper handling of the panel stack on an
       * per screen basis.
       */
        struct panelhook _panelHook;
      /*
       * Linked-list of all windows, to support '_nc_resizeall()' and
       * '_nc_freeall()'
       */
      WINDOWLIST      *_nc_sp_windows;
#define _nc_windows SP->_nc_sp_windows

      bool            _sig_winch;
      SCREEN          *_next_screen;

      /* hashes for old and new lines */
      unsigned long     *oldhash, *newhash;
      HASHMAP     *hashtab;
      int         hashtab_len;

      bool            _cleanup;     /* cleanup after int/quit signal */
      int             (*_outch)(int);     /* output handler if not putc */

      /* recent versions of 'screen' have partially-working support for
       * UTF-8, but do not permit ACS at the same time (see tty_update.c).
       */
#if USE_WIDEC_SUPPORT
      bool        _posix_locale;
      bool        _screen_acs_fix;
#endif
};

extern NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain;

#if NCURSES_NOMACROS
#include <nomacros.h>
#endif

      WINDOWLIST {
      WINDOW      win;  /* first, so WINDOW_EXT() works */
      WINDOWLIST *next;
#ifdef _XOPEN_SOURCE_EXTENDED
      char addch_work[(MB_LEN_MAX * 9) + 1];
      int addch_used;
      int addch_x;
      int addch_y;
#endif
};

#define WINDOW_EXT(win,field) (((WINDOWLIST *)(win))->field)

/* The terminfo source is assumed to be 7-bit ASCII */
#define is7bits(c)      ((unsigned)(c) < 128)

#ifndef min
#define min(a,b)  ((a) > (b)  ?  (b)  :  (a))
#endif

#ifndef max
#define max(a,b)  ((a) < (b)  ?  (b)  :  (a))
#endif

/* usually in <unistd.h> */
#ifndef STDIN_FILENO
#define STDIN_FILENO 0
#endif

#ifndef STDOUT_FILENO
#define STDOUT_FILENO 1
#endif

#ifndef STDERR_FILENO
#define STDERR_FILENO 2
#endif

#ifndef EXIT_SUCCESS
#define EXIT_SUCCESS 0
#endif

#ifndef EXIT_FAILURE
#define EXIT_FAILURE 1
#endif

#ifndef R_OK
#define     R_OK  4           /* Test for read permission.  */
#endif
#ifndef W_OK
#define     W_OK  2           /* Test for write permission.  */
#endif
#ifndef X_OK
#define     X_OK  1           /* Test for execute permission.  */
#endif
#ifndef F_OK
#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

#ifdef TRACE
#define TRACE_OUTCHARS(n) _nc_outchars += (n);
#else
#define TRACE_OUTCHARS(n) /* nothing */
#endif

#define UChar(c)  ((unsigned char)(c))
#define ChCharOf(c)     ((c) & (chtype)A_CHARTEXT)
#define ChAttrOf(c)     ((c) & (chtype)A_ATTRIBUTES)

#ifndef MB_LEN_MAX
#define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
#endif

#if USE_WIDEC_SUPPORT /* { */
#define NulChar         0,0,0,0     /* FIXME: see CCHARW_MAX */
#define CharOf(c) ((c).chars[0])
#define AttrOf(c) ((c).attr)
#define AddAttr(c,a)    (c).attr |= a
#define RemAttr(c,a)    (c).attr &= ~(a)
#define SetAttr(c,a)    (c).attr = a
#define NewChar(ch)     { ChAttrOf(ch), { ChCharOf(ch), NulChar } }
#define NewChar2(c,a)   { a, { c, NulChar } }
#define CharEq(a,b)     (!memcmp(&a, &b, sizeof(a)))
#define SetChar(ch,c,a) do {                                          \
                      NCURSES_CH_T *_cp = &ch;                        \
                      memset(_cp,0,sizeof(ch)); _cp->chars[0] = c; _cp->attr = a; \
                  } while (0)
#define CHREF(wch)      (&wch)
#define CHDEREF(wch)    (*wch)
#define ARG_CH_T  NCURSES_CH_T *
#define CARG_CH_T const NCURSES_CH_T *
#define PUTC_DATA char PUTC_buf[MB_LEN_MAX]; int PUTC_i, PUTC_n; \
                  mbstate_t PUT_st; wchar_t PUTC_ch
#define PUTC_INIT memset (&PUT_st, '\0', sizeof (PUT_st));            \
                  PUTC_i = 0
#define PUTC(ch,b)      do { if(!isnac(ch)) {                               \
                  if (Charable(ch)) {                                 \
                      fputc(CharOf(ch), b);                           \
                      TRACE_OUTCHARS(1);                              \
                  } else {                                      \
                      PUTC_INIT;                                      \
                      do {                                      \
                        PUTC_ch = PUTC_i < CCHARW_MAX ?                     \
                                  (ch).chars[PUTC_i] : L'\0';               \
                        PUTC_n = wcrtomb(PUTC_buf,                    \
                                     (ch).chars[PUTC_i], &PUT_st);          \
                        if (PUTC_ch == L'\0')                         \
                            --PUTC_n;                                 \
                        if (PUTC_n <= 0)                        \
                            break;                              \
                        fwrite(PUTC_buf, (unsigned) PUTC_n, 1, b);          \
                        ++PUTC_i;                               \
                      } while (PUTC_ch != L'\0');                           \
                      TRACE_OUTCHARS(PUTC_i);                         \
                  } } } while (0)

#define BLANK           { WA_NORMAL, ' ' }
#define ISBLANK(ch)     ((ch).chars[0] == L' ' && (ch).chars[1] == L'\0')

#define WA_NAC          1
#define isnac(ch) (AttrOf(ch) & WA_NAC)
#define if_WIDEC(code)  code
#define Charable(ch)    ((SP != 0 && SP->_posix_locale)                 \
                   || (!isnac(ch) &&                        \
                       (ch).chars[1] == L'\0' &&                  \
                             _nc_is_charable(CharOf(ch))))

#define L(ch)           L ## ch
#else /* }{ */
#define CharOf(c) ChCharOf(c)
#define AttrOf(c) ChAttrOf(c)
#define AddAttr(c,a)    c |= a
#define RemAttr(c,a)    c &= ~(a & A_ATTRIBUTES)
#define SetAttr(c,a)    c = (c & ~A_ATTRIBUTES) | a
#define NewChar(ch)     (ch)
#define NewChar2(c,a)   (c | a)
#define CharEq(a,b)     (a == b)
#define SetChar(ch,c,a) ch = c | a
#define CHREF(wch)      wch
#define CHDEREF(wch)    wch
#define ARG_CH_T  NCURSES_CH_T
#define CARG_CH_T NCURSES_CH_T
#define PUTC_DATA int data = 0
#define PUTC(a,b) do { data = CharOf(ch); putc(data,b); } while (0)

#define BLANK           (' '|A_NORMAL)
#define ISBLANK(ch)     (CharOf(ch) == ' ')

#define isnac(ch) (0)
#define if_WIDEC(code) /* nothing */

#define L(ch)           ch
#endif /* } */

#define AttrOfD(ch)     AttrOf(CHDEREF(ch))
#define CharOfD(ch)     CharOf(CHDEREF(ch))
#define SetChar2(wch,ch)    SetChar(wch,ChCharOf(ch),ChAttrOf(ch))

#define BLANK_ATTR      A_NORMAL
#define BLANK_TEXT      L(' ')

#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 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>

/*
 * Prefixes for call/return points of library function traces.  We use these to
 * instrument the public functions so that the traces can be easily transformed
 * into regression scripts.
 */
#define T_CALLED(fmt) "called {" fmt
#define T_CREATE(fmt) "create :" fmt
#define T_RETURN(fmt) "return }" fmt

#ifdef TRACE

#define START_TRACE() \
      if ((_nc_tracing & TRACE_MAXIMUM) == 0) { \
          int t = _nc_getenv_num("NCURSES_TRACE"); \
          if (t >= 0) \
            trace((unsigned) t); \
      }

#define TR(n, a)  if (_nc_tracing & (n)) _tracef a
#define T(a)            TR(TRACE_CALLS, a)
#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 returnBool(code) TRACE_RETURN(code,bool)
#define returnBits(code) TRACE_RETURN(code,unsigned)
#define returnCode(code) TRACE_RETURN(code,int)
#define returnPtr(code)  TRACE_RETURN(code,ptr)
#define returnSP(code)   TRACE_RETURN(code,sp)
#define returnVoid       T((T_RETURN(""))); return
#define returnWin(code)  TRACE_RETURN(code,win)

extern NCURSES_EXPORT(NCURSES_BOOL)     _nc_retrace_bool (NCURSES_BOOL);
extern NCURSES_EXPORT(SCREEN *)         _nc_retrace_sp (SCREEN *);
extern NCURSES_EXPORT(WINDOW *)         _nc_retrace_win (WINDOW *);
extern NCURSES_EXPORT(attr_t)           _nc_retrace_attr_t (attr_t);
extern NCURSES_EXPORT(char *)           _nc_retrace_ptr (char *);
extern NCURSES_EXPORT(char *)           _nc_trace_ttymode(TTY *tty);
extern NCURSES_EXPORT(char *)           _nc_varargs (const char *, va_list);
extern NCURSES_EXPORT(chtype)           _nc_retrace_chtype (chtype);
extern NCURSES_EXPORT(const char *)     _nc_altcharset_name(attr_t, chtype);
extern NCURSES_EXPORT(int)              _nc_retrace_int (int);
extern NCURSES_EXPORT(unsigned)         _nc_retrace_unsigned (unsigned);
extern NCURSES_EXPORT(void)             _nc_fifo_dump (void);
extern NCURSES_EXPORT_VAR(const char *) _nc_tputs_trace;
extern NCURSES_EXPORT_VAR(long)         _nc_outchars;
extern NCURSES_EXPORT_VAR(unsigned)     _nc_tracing;

#if USE_WIDEC_SUPPORT
extern NCURSES_EXPORT(const char *) _nc_viswbuf2 (int, const wchar_t *);
extern NCURSES_EXPORT(const char *) _nc_viswbufn (const wchar_t *, int);
extern NCURSES_EXPORT(const char *) _nc_viscbuf2 (int, const cchar_t *, int);
extern NCURSES_EXPORT(const char *) _nc_viscbuf (const cchar_t *, int);
#endif

#else /* !TRACE */

#define START_TRACE() /* nothing */

#define T(a)
#define TR(n, a)
#define TPUTS_TRACE(s)

#define returnAttr(code) return code
#define returnBits(code) return code
#define returnBool(code) return code
#define returnChar(code) return code
#define returnCode(code) return code
#define returnPtr(code)  return code
#define returnSP(code)   return code
#define returnVoid       return
#define returnWin(code)  return code

#endif /* TRACE/!TRACE */

extern NCURSES_EXPORT(const char *) _nc_visbuf2 (int, const char *);
extern NCURSES_EXPORT(const char *) _nc_visbufn (const char *, int);

#define empty_module(name) \
extern      NCURSES_EXPORT(void) name (void); \
      NCURSES_EXPORT(void) name (void) { }

#define ALL_BUT_COLOR ((chtype)~(A_COLOR))
#define IGNORE_COLOR_OFF FALSE
#define NONBLANK_ATTR (A_NORMAL|A_BOLD|A_DIM|A_BLINK)
#define XMC_CHANGES(c) ((c) & SP->_xmc_suppress)

#define toggle_attr_on(S,at) {\
   if (PAIR_NUMBER(at) > 0)\
      (S) = ((S) & ALL_BUT_COLOR) | (at);\
   else\
      (S) |= (at);\
   TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}


#define toggle_attr_off(S,at) {\
   if (IGNORE_COLOR_OFF == TRUE) {\
      if (PAIR_NUMBER(at) == 0xff) /* turn off color */\
       (S) &= ~(at);\
      else /* leave color alone */\
       (S) &= ~((at)&ALL_BUT_COLOR);\
   } else {\
      if (PAIR_NUMBER(at) > 0x00) /* turn off color */\
       (S) &= ~(at|A_COLOR);\
      else /* leave color alone */\
       (S) &= ~(at);\
   }\
   TR(TRACE_ATTRS, ("new attribute is %s", _traceattr((S))));}

#define DelCharCost(count) \
            ((parm_dch != 0) \
            ? SP->_dch_cost \
            : ((delete_character != 0) \
                  ? (SP->_dch1_cost * count) \
                  : INFINITY))

#define InsCharCost(count) \
            ((parm_ich != 0) \
            ? SP->_ich_cost \
            : ((enter_insert_mode && exit_insert_mode) \
              ? SP->_smir_cost + SP->_rmir_cost + (SP->_ip_cost * count) \
              : ((insert_character != 0) \
                ? ((SP->_ich1_cost + SP->_ip_cost) * count) \
                : INFINITY)))

#if USE_XMC_SUPPORT
#define UpdateAttrs(a)  if (SP->_current_attr != (a)) { \
                        attr_t chg = SP->_current_attr; \
                        vidattr((a)); \
                        if (magic_cookie_glitch > 0 \
                         && XMC_CHANGES((chg ^ SP->_current_attr))) { \
                              T(("%s @%d before glitch %d,%d", \
                                    __FILE__, __LINE__, \
                                    SP->_cursrow, \
                                    SP->_curscol)); \
                              _nc_do_xmc_glitch(chg); \
                        } \
                  }
#else
#define UpdateAttrs(a)  if (SP->_current_attr != (a)) \
                        vidattr((a));
#endif

/*
 * Macros to make additional parameter to implement wgetch_events()
 */
#ifdef NCURSES_WGETCH_EVENTS
#define EVENTLIST_0th(param) param
#define EVENTLIST_1st(param) param
#define EVENTLIST_2nd(param) , param
#else
#define EVENTLIST_0th(param) void
#define EVENTLIST_1st(param) /* nothing */
#define EVENTLIST_2nd(param) /* nothing */
#endif

#if NCURSES_EXPANDED && NCURSES_EXT_FUNCS

#undef  toggle_attr_on
#define toggle_attr_on(S,at) _nc_toggle_attr_on(&(S), at)
extern NCURSES_EXPORT(void) _nc_toggle_attr_on (attr_t *, attr_t);

#undef  toggle_attr_off
#define toggle_attr_off(S,at) _nc_toggle_attr_off(&(S), at)
extern NCURSES_EXPORT(void) _nc_toggle_attr_off (attr_t *, attr_t);

#undef  DelCharCost
#define DelCharCost(count) _nc_DelCharCost(count)
extern NCURSES_EXPORT(int) _nc_DelCharCost (int);

#undef  InsCharCost
#define InsCharCost(count) _nc_InsCharCost(count)
extern NCURSES_EXPORT(int) _nc_InsCharCost (int);

#undef  UpdateAttrs
#define UpdateAttrs(c) _nc_UpdateAttrs(c)
extern NCURSES_EXPORT(void) _nc_UpdateAttrs (chtype);

#else

extern NCURSES_EXPORT(void) _nc_expanded (void);

#endif

#if !HAVE_GETCWD
#define getcwd(buf,len) getwd(buf)
#endif

/* charable.c */
#if USE_WIDEC_SUPPORT
extern NCURSES_EXPORT(bool) _nc_is_charable(wchar_t);
extern NCURSES_EXPORT(int) _nc_to_char(wint_t);
extern NCURSES_EXPORT(wint_t) _nc_to_widechar(int);
#endif

/* doupdate.c */
#if USE_XMC_SUPPORT
extern NCURSES_EXPORT(void) _nc_do_xmc_glitch (attr_t);
#endif

/* hardscroll.c */
#if defined(TRACE) || defined(SCROLLDEBUG) || defined(HASHDEBUG)
extern NCURSES_EXPORT(void) _nc_linedump (void);
#endif

/* lib_acs.c */
extern NCURSES_EXPORT(void) _nc_init_acs (void);      /* corresponds to traditional 'init_acs()' */
extern NCURSES_EXPORT(int) _nc_msec_cost (const char *const, int);  /* used by 'tack' program */

/* lib_addstr.c */
#if USE_WIDEC_SUPPORT
extern NCURSES_EXPORT(int) _nc_wchstrlen(const cchar_t *);
#endif

/* lib_color.c */
extern NCURSES_EXPORT(bool) _nc_reset_colors(void);

/* lib_getch.c */
extern NCURSES_EXPORT(int) _nc_wgetch(WINDOW *, unsigned long *, int EVENTLIST_2nd(_nc_eventlist *));

/* lib_insch.c */
extern NCURSES_EXPORT(void) _nc_insert_ch(WINDOW *, chtype);

/* lib_mvcur.c */
#define INFINITY  1000000     /* cost: too high to use */

extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);

extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);

extern NCURSES_EXPORT(void) _nc_screen_init (void);
extern NCURSES_EXPORT(void) _nc_screen_resume (void);
extern NCURSES_EXPORT(void) _nc_screen_wrap (void);

/* lib_mouse.c */
extern NCURSES_EXPORT(int) _nc_has_mouse (void);

/* lib_mvcur.c */
#define INFINITY  1000000     /* cost: too high to use */
#define BAUDBYTE  9     /* 9 = 7 bits + 1 parity + 1 stop */

/* lib_setup.c */
extern NCURSES_EXPORT(char *) _nc_get_locale(void);
extern NCURSES_EXPORT(int) _nc_unicode_locale(void);
extern NCURSES_EXPORT(int) _nc_locale_breaks_acs(void);

/* lib_wacs.c */
#if USE_WIDEC_SUPPORT
extern NCURSES_EXPORT(void) _nc_init_wacs(void);
#endif

typedef struct {
    char *s_head; /* beginning of the string (may be null) */
    char *s_tail; /* end of the string (may be null) */
    size_t s_size;      /* current remaining size available */
    size_t s_init;      /* total size available */
} string_desc;

/* strings.c */
extern NCURSES_EXPORT(string_desc *) _nc_str_init (string_desc *, char *, size_t);
extern NCURSES_EXPORT(string_desc *) _nc_str_null (string_desc *, size_t);
extern NCURSES_EXPORT(string_desc *) _nc_str_copy (string_desc *, string_desc *);
extern NCURSES_EXPORT(bool) _nc_safe_strcat (string_desc *, const char *);
extern NCURSES_EXPORT(bool) _nc_safe_strcpy (string_desc *, const char *);

extern NCURSES_EXPORT(void) _nc_mvcur_init (void);
extern NCURSES_EXPORT(void) _nc_mvcur_resume (void);
extern NCURSES_EXPORT(void) _nc_mvcur_wrap (void);

extern NCURSES_EXPORT(int) _nc_scrolln (int, int, int, int);

extern NCURSES_EXPORT(void) _nc_screen_init (void);
extern NCURSES_EXPORT(void) _nc_screen_resume (void);
extern NCURSES_EXPORT(void) _nc_screen_wrap (void);

#if !HAVE_STRSTR
#define strstr _nc_strstr
extern NCURSES_EXPORT(char *) _nc_strstr (const char *, const char *);
#endif

/* safe_sprintf.c */
extern NCURSES_EXPORT(char *) _nc_printf_string (const char *, va_list);

/* tries.c */
extern NCURSES_EXPORT(void) _nc_add_to_try (struct tries **, const char *, unsigned short);
extern NCURSES_EXPORT(char *) _nc_expand_try (struct tries *, unsigned short, int *, size_t);
extern NCURSES_EXPORT(int) _nc_remove_key (struct tries **, unsigned short);
extern NCURSES_EXPORT(int) _nc_remove_string (struct tries **, const char *);

/* elsewhere ... */
extern NCURSES_EXPORT(NCURSES_CH_T) _nc_render (WINDOW *, NCURSES_CH_T);
extern NCURSES_EXPORT(WINDOW *) _nc_makenew (int, int, int, int, int);
extern NCURSES_EXPORT(char *) _nc_home_terminfo (void);
extern NCURSES_EXPORT(char *) _nc_trace_buf (int, size_t);
extern NCURSES_EXPORT(char *) _nc_trace_bufcat (int, const char *);
extern NCURSES_EXPORT(int) _nc_access (const char *, int);
extern NCURSES_EXPORT(int) _nc_baudrate (int);
extern NCURSES_EXPORT(int) _nc_freewin (WINDOW *);
extern NCURSES_EXPORT(int) _nc_getenv_num (const char *);
extern NCURSES_EXPORT(int) _nc_keypad (bool);
extern NCURSES_EXPORT(int) _nc_ospeed (int);
extern NCURSES_EXPORT(int) _nc_outch (int);
extern NCURSES_EXPORT(int) _nc_setupscreen (short, short const, FILE *);
extern NCURSES_EXPORT(int) _nc_timed_wait(int, int, int * EVENTLIST_2nd(_nc_eventlist *));
extern NCURSES_EXPORT(int) _nc_waddch_nosync (WINDOW *, const NCURSES_CH_T);
extern NCURSES_EXPORT(void) _nc_do_color (int, int, bool, int (*)(int));
extern NCURSES_EXPORT(void) _nc_flush (void);
extern NCURSES_EXPORT(void) _nc_freeall (void);
extern NCURSES_EXPORT(void) _nc_hash_map (void);
extern NCURSES_EXPORT(void) _nc_init_keytry (void);
extern NCURSES_EXPORT(void) _nc_keep_tic_dir (const char *);
extern NCURSES_EXPORT(void) _nc_make_oldhash (int i);
extern NCURSES_EXPORT(void) _nc_scroll_oldhash (int n, int top, int bot);
extern NCURSES_EXPORT(void) _nc_scroll_optimize (void);
extern NCURSES_EXPORT(void) _nc_scroll_window (WINDOW *, int const, short const, short const, NCURSES_CH_T);
extern NCURSES_EXPORT(void) _nc_set_buffer (FILE *, bool);
extern NCURSES_EXPORT(void) _nc_signal_handler (bool);
extern NCURSES_EXPORT(void) _nc_synchook (WINDOW *);
extern NCURSES_EXPORT(void) _nc_trace_tries (struct tries *);

#if USE_SIZECHANGE
extern NCURSES_EXPORT(void) _nc_update_screensize (void);
#endif

#if HAVE_RESIZETERM
extern NCURSES_EXPORT(void) _nc_resize_margins (WINDOW *);
#else
#define _nc_resize_margins(wp) /* nothing */
#endif

#ifdef NCURSES_WGETCH_EVENTS
extern NCURSES_EXPORT(int) _nc_eventlist_timeout(_nc_eventlist *);
#else
#define wgetch_events(win, evl) wgetch(win)
#define wgetnstr_events(win, str, maxlen, evl) wgetnstr(win, str, maxlen)
#endif

/*
 * Not everyone has vsscanf(), but we'd like to use it for scanw().
 */
#if !HAVE_VSSCANF
extern int vsscanf(const char *str, const char *format, va_list __arg);
#endif

/* scroll indices */
extern NCURSES_EXPORT_VAR(int *) _nc_oldnums;

#define USE_SETBUF_0 0

#define NC_BUFFERED(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'.
 */
#if BROKEN_LINKER
#define SP _nc_screen()
extern NCURSES_EXPORT(SCREEN *) _nc_screen (void);
extern NCURSES_EXPORT(int) _nc_alloc_screen (void);
extern NCURSES_EXPORT(void) _nc_set_screen (SCREEN *);
#else
/* current screen is private data; avoid possible linking conflicts too */
extern NCURSES_EXPORT_VAR(SCREEN *) SP;
#define _nc_alloc_screen() ((SP = typeCalloc(SCREEN, 1)) != 0)
#define _nc_set_screen(sp) SP = sp
#endif

/*
 * We don't want to use the lines or columns capabilities internally, because
 * if the application is running multiple screens under X, it's quite possible
 * they could all have type xterm but have different sizes!  So...
 */
#define screen_lines    SP->_lines
#define screen_columns  SP->_columns

extern NCURSES_EXPORT_VAR(int) _nc_slk_format;  /* != 0 if slk_init() called */
extern NCURSES_EXPORT(int) _nc_slk_initialize (WINDOW *, int);

/*
 * 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

/* Macro to check whether or not we use a standard format */
#define SLK_STDFMT(fmt) (fmt < 3)
/* Macro to determine height of label window */
#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 NCURSES_EXPORT(int) _nc_ripoffline (int line, int (*init)(WINDOW *,int));

/*
 * Common error messages
 */
#define MSG_NO_MEMORY "Out of memory"
#define MSG_NO_INPUTS "Premature EOF"

#ifdef __cplusplus
}
#endif

#endif /* CURSES_PRIV_H */

Generated by  Doxygen 1.6.0   Back to index