ncurses 5.9 - patch 20130831
[ncurses.git] / include / curses.h.in
index b86b9ffda85d23542540122ead50a0a80744cc5d..ddd73751909b323497aea2d52ded85583391583a 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2011,2012 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2012,2013 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            *
@@ -32,7 +32,7 @@
  *     and: Thomas E. Dickey                        1996-on                 *
  ****************************************************************************/
 
-/* $Id: curses.h.in,v 1.228 2012/02/18 21:34:30 tom Exp $ */
+/* $Id: curses.h.in,v 1.235 2013/08/31 13:13:05 tom Exp $ */
 
 #ifndef __NCURSES_H
 #define __NCURSES_H
@@ -244,6 +244,10 @@ extern "C" {
 #define WA_TOP         A_TOP
 #define WA_VERTICAL    A_VERTICAL
 
+#if @NCURSES_EXT_FUNCS@
+#define WA_ITALIC      A_ITALIC        /* ncurses extension */
+#endif
+
 /* colors */
 #define COLOR_BLACK    0
 #define COLOR_RED      1
@@ -263,7 +267,7 @@ NCURSES_WRAPPED_VAR(chtype*, acs_map);
 extern NCURSES_EXPORT_VAR(chtype) acs_map[];
 #endif
 
-#define NCURSES_ACS(c) (acs_map[NCURSES_CAST(unsigned char,c)])
+#define NCURSES_ACS(c) (acs_map[NCURSES_CAST(unsigned char,(c))])
 
 /* VT100 symbols begin here */
 #define ACS_ULCORNER   NCURSES_ACS('l') /* upper left corner */
@@ -770,6 +774,7 @@ extern NCURSES_EXPORT(int) typeahead (int);                         /* implemented */
 extern NCURSES_EXPORT(int) ungetch (int);                              /* implemented */
 extern NCURSES_EXPORT(int) untouchwin (WINDOW *);                      /* generated */
 extern NCURSES_EXPORT(void) use_env (bool);                            /* implemented */
+extern NCURSES_EXPORT(void) use_tioctl (bool);                         /* implemented */
 extern NCURSES_EXPORT(int) vidattr (chtype);                           /* implemented */
 extern NCURSES_EXPORT(int) vidputs (chtype, NCURSES_OUTC);             /* implemented */
 extern NCURSES_EXPORT(int) vline (chtype, int);                                /* generated */
@@ -1007,6 +1012,7 @@ extern NCURSES_EXPORT(char *) NCURSES_SP_NAME(termname) (SCREEN*); /* implemente
 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(typeahead) (SCREEN*, int); /* implemented:SP_FUNC */
 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(ungetch) (SCREEN*, int); /* implemented:SP_FUNC */
 extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_env) (SCREEN*, bool); /* implemented:SP_FUNC */
+extern NCURSES_EXPORT(void) NCURSES_SP_NAME(use_tioctl) (SCREEN*, bool); /* implemented:SP_FUNC */
 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidattr) (SCREEN*, chtype); /* implemented:SP_FUNC */
 extern NCURSES_EXPORT(int) NCURSES_SP_NAME(vidputs) (SCREEN*, chtype, NCURSES_SP_OUTC); /* implemented:SP_FUNC */
 #if @NCURSES_EXT_FUNCS@
@@ -1035,7 +1041,7 @@ extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int);     /*
 /* attributes */
 
 #define NCURSES_ATTR_SHIFT       8
-#define NCURSES_BITS(mask,shift) ((mask) << ((shift) + NCURSES_ATTR_SHIFT))
+#define NCURSES_BITS(mask,shift) (NCURSES_CAST(chtype,(mask)) << ((shift) + NCURSES_ATTR_SHIFT))
 
 #define A_NORMAL       (@cf_cv_1UL@ - @cf_cv_1UL@)
 #define A_ATTRIBUTES   NCURSES_BITS(~(@cf_cv_1UL@ - @cf_cv_1UL@),0)
@@ -1057,6 +1063,10 @@ extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int);    /*
 #define A_TOP          NCURSES_BITS(@cf_cv_1UL@,21)
 #define A_VERTICAL     NCURSES_BITS(@cf_cv_1UL@,22)
 
+#if @NCURSES_EXT_FUNCS@
+#define A_ITALIC       NCURSES_BITS(@cf_cv_1UL@,23)    /* ncurses extension */
+#endif
+
 /*
  * Most of the pseudo functions are macros that either provide compatibility
  * with older versions of curses, or provide inline functionality to improve
@@ -1097,7 +1107,7 @@ extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int);     /*
  */
 
 #define wgetstr(w, s)          wgetnstr(w, s, -1)
-#define getnstr(s, n)          wgetnstr(stdscr, s, n)
+#define getnstr(s, n)          wgetnstr(stdscr, s, (n))
 
 #define setterm(term)          setupterm(term, 1, (int *)0)
 
@@ -1150,8 +1160,8 @@ extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int);     /*
 
 #define box(win, v, h)         wborder(win, v, v, h, h, 0, 0, 0, 0)
 #define border(ls, rs, ts, bs, tl, tr, bl, br) wborder(stdscr, ls, rs, ts, bs, tl, tr, bl, br)
-#define hline(ch, n)           whline(stdscr, ch, n)
-#define vline(ch, n)           wvline(stdscr, ch, n)
+#define hline(ch, n)           whline(stdscr, ch, (n))
+#define vline(ch, n)           wvline(stdscr, ch, (n))
 
 #define winstr(w, s)           winnstr(w, s, -1)
 #define winchstr(w, s)         winchnstr(w, s, -1)
@@ -1167,55 +1177,55 @@ extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int);   /*
 /*
  * These apply to the first 256 color pairs.
  */
-#define COLOR_PAIR(n)  NCURSES_BITS(n, 0)
-#define PAIR_NUMBER(a) (NCURSES_CAST(int,((NCURSES_CAST(unsigned long,a) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
+#define COLOR_PAIR(n)  NCURSES_BITS((n), 0)
+#define PAIR_NUMBER(a) (NCURSES_CAST(int,((NCURSES_CAST(unsigned long,(a)) & A_COLOR) >> NCURSES_ATTR_SHIFT)))
 
 /*
  * pseudo functions for standard screen
  */
 
-#define addch(ch)              waddch(stdscr,ch)
-#define addchnstr(str,n)       waddchnstr(stdscr,str,n)
-#define addchstr(str)          waddchstr(stdscr,str)
-#define addnstr(str,n)         waddnstr(stdscr,str,n)
-#define addstr(str)            waddnstr(stdscr,str,-1)
-#define attroff(at)            wattroff(stdscr,at)
-#define attron(at)             wattron(stdscr,at)
-#define attrset(at)            wattrset(stdscr,at)
-#define attr_get(ap,cp,o)      wattr_get(stdscr,ap,cp,o)
-#define attr_off(a,o)          wattr_off(stdscr,a,o)
-#define attr_on(a,o)           wattr_on(stdscr,a,o)
-#define attr_set(a,c,o)                wattr_set(stdscr,a,c,o)
-#define bkgd(ch)               wbkgd(stdscr,ch)
-#define bkgdset(ch)            wbkgdset(stdscr,ch)
-#define chgat(n,a,c,o)         wchgat(stdscr,n,a,c,o)
+#define addch(ch)              waddch(stdscr,(ch))
+#define addchnstr(str,n)       waddchnstr(stdscr,(str),(n))
+#define addchstr(str)          waddchstr(stdscr,(str))
+#define addnstr(str,n)         waddnstr(stdscr,(str),(n))
+#define addstr(str)            waddnstr(stdscr,(str),-1)
+#define attroff(at)            wattroff(stdscr,(at))
+#define attron(at)             wattron(stdscr,(at))
+#define attrset(at)            wattrset(stdscr,(at))
+#define attr_get(ap,cp,o)      wattr_get(stdscr,(ap),(cp),(o))
+#define attr_off(a,o)          wattr_off(stdscr,(a),(o))
+#define attr_on(a,o)           wattr_on(stdscr,(a),(o))
+#define attr_set(a,c,o)                wattr_set(stdscr,(a),(c),(o))
+#define bkgd(ch)               wbkgd(stdscr,(ch))
+#define bkgdset(ch)            wbkgdset(stdscr,(ch))
+#define chgat(n,a,c,o)         wchgat(stdscr,(n),(a),(c),(o))
 #define clear()                        wclear(stdscr)
 #define clrtobot()             wclrtobot(stdscr)
 #define clrtoeol()             wclrtoeol(stdscr)
-#define color_set(c,o)         wcolor_set(stdscr,c,o)
+#define color_set(c,o)         wcolor_set(stdscr,(c),(o))
 #define delch()                        wdelch(stdscr)
 #define deleteln()             winsdelln(stdscr,-1)
-#define echochar(c)            wechochar(stdscr,c)
+#define echochar(c)            wechochar(stdscr,(c))
 #define erase()                        werase(stdscr)
 #define getch()                        wgetch(stdscr)
-#define getstr(str)            wgetstr(stdscr,str)
+#define getstr(str)            wgetstr(stdscr,(str))
 #define inch()                 winch(stdscr)
-#define inchnstr(s,n)          winchnstr(stdscr,s,n)
-#define inchstr(s)             winchstr(stdscr,s)
-#define innstr(s,n)            winnstr(stdscr,s,n)
-#define insch(c)               winsch(stdscr,c)
-#define insdelln(n)            winsdelln(stdscr,n)
+#define inchnstr(s,n)          winchnstr(stdscr,(s),(n))
+#define inchstr(s)             winchstr(stdscr,(s))
+#define innstr(s,n)            winnstr(stdscr,(s),(n))
+#define insch(c)               winsch(stdscr,(c))
+#define insdelln(n)            winsdelln(stdscr,(n))
 #define insertln()             winsdelln(stdscr,1)
-#define insnstr(s,n)           winsnstr(stdscr,s,n)
-#define insstr(s)              winsstr(stdscr,s)
-#define instr(s)               winstr(stdscr,s)
-#define move(y,x)              wmove(stdscr,y,x)
+#define insnstr(s,n)           winsnstr(stdscr,(s),(n))
+#define insstr(s)              winsstr(stdscr,(s))
+#define instr(s)               winstr(stdscr,(s))
+#define move(y,x)              wmove(stdscr,(y),(x))
 #define refresh()              wrefresh(stdscr)
-#define scrl(n)                        wscrl(stdscr,n)
-#define setscrreg(t,b)         wsetscrreg(stdscr,t,b)
+#define scrl(n)                        wscrl(stdscr,(n))
+#define setscrreg(t,b)         wsetscrreg(stdscr,(t),(b))
 #define standend()             wstandend(stdscr)
 #define standout()             wstandout(stdscr)
-#define timeout(delay)         wtimeout(stdscr,delay)
+#define timeout(delay)         wtimeout(stdscr,(delay))
 #define wdeleteln(win)         winsdelln(win,-1)
 #define winsertln(win)         winsdelln(win,1)
 
@@ -1223,47 +1233,47 @@ extern NCURSES_EXPORT(int) NCURSES_SP_NAME(use_legacy_coding) (SCREEN*, int);   /*
  * mv functions
  */
 
-#define mvwaddch(win,y,x,ch)           (wmove(win,y,x) == ERR ? ERR : waddch(win,ch))
-#define mvwaddchnstr(win,y,x,str,n)    (wmove(win,y,x) == ERR ? ERR : waddchnstr(win,str,n))
-#define mvwaddchstr(win,y,x,str)       (wmove(win,y,x) == ERR ? ERR : waddchnstr(win,str,-1))
-#define mvwaddnstr(win,y,x,str,n)      (wmove(win,y,x) == ERR ? ERR : waddnstr(win,str,n))
-#define mvwaddstr(win,y,x,str)         (wmove(win,y,x) == ERR ? ERR : waddnstr(win,str,-1))
-#define mvwdelch(win,y,x)              (wmove(win,y,x) == ERR ? ERR : wdelch(win))
-#define mvwchgat(win,y,x,n,a,c,o)      (wmove(win,y,x) == ERR ? ERR : wchgat(win,n,a,c,o))
-#define mvwgetch(win,y,x)              (wmove(win,y,x) == ERR ? ERR : wgetch(win))
-#define mvwgetnstr(win,y,x,str,n)      (wmove(win,y,x) == ERR ? ERR : wgetnstr(win,str,n))
-#define mvwgetstr(win,y,x,str)         (wmove(win,y,x) == ERR ? ERR : wgetstr(win,str))
-#define mvwhline(win,y,x,c,n)          (wmove(win,y,x) == ERR ? ERR : whline(win,c,n))
-#define mvwinch(win,y,x)               (wmove(win,y,x) == ERR ? NCURSES_CAST(chtype, ERR) : winch(win))
-#define mvwinchnstr(win,y,x,s,n)       (wmove(win,y,x) == ERR ? ERR : winchnstr(win,s,n))
-#define mvwinchstr(win,y,x,s)          (wmove(win,y,x) == ERR ? ERR : winchstr(win,s))
-#define mvwinnstr(win,y,x,s,n)         (wmove(win,y,x) == ERR ? ERR : winnstr(win,s,n))
-#define mvwinsch(win,y,x,c)            (wmove(win,y,x) == ERR ? ERR : winsch(win,c))
-#define mvwinsnstr(win,y,x,s,n)                (wmove(win,y,x) == ERR ? ERR : winsnstr(win,s,n))
-#define mvwinsstr(win,y,x,s)           (wmove(win,y,x) == ERR ? ERR : winsstr(win,s))
-#define mvwinstr(win,y,x,s)            (wmove(win,y,x) == ERR ? ERR : winstr(win,s))
-#define mvwvline(win,y,x,c,n)          (wmove(win,y,x) == ERR ? ERR : wvline(win,c,n))
-
-#define mvaddch(y,x,ch)                        mvwaddch(stdscr,y,x,ch)
-#define mvaddchnstr(y,x,str,n)         mvwaddchnstr(stdscr,y,x,str,n)
-#define mvaddchstr(y,x,str)            mvwaddchstr(stdscr,y,x,str)
-#define mvaddnstr(y,x,str,n)           mvwaddnstr(stdscr,y,x,str,n)
-#define mvaddstr(y,x,str)              mvwaddstr(stdscr,y,x,str)
-#define mvchgat(y,x,n,a,c,o)           mvwchgat(stdscr,y,x,n,a,c,o)
-#define mvdelch(y,x)                   mvwdelch(stdscr,y,x)
-#define mvgetch(y,x)                   mvwgetch(stdscr,y,x)
-#define mvgetnstr(y,x,str,n)           mvwgetnstr(stdscr,y,x,str,n)
-#define mvgetstr(y,x,str)              mvwgetstr(stdscr,y,x,str)
-#define mvhline(y,x,c,n)               mvwhline(stdscr,y,x,c,n)
-#define mvinch(y,x)                    mvwinch(stdscr,y,x)
-#define mvinchnstr(y,x,s,n)            mvwinchnstr(stdscr,y,x,s,n)
-#define mvinchstr(y,x,s)               mvwinchstr(stdscr,y,x,s)
-#define mvinnstr(y,x,s,n)              mvwinnstr(stdscr,y,x,s,n)
-#define mvinsch(y,x,c)                 mvwinsch(stdscr,y,x,c)
-#define mvinsnstr(y,x,s,n)             mvwinsnstr(stdscr,y,x,s,n)
-#define mvinsstr(y,x,s)                        mvwinsstr(stdscr,y,x,s)
-#define mvinstr(y,x,s)                 mvwinstr(stdscr,y,x,s)
-#define mvvline(y,x,c,n)               mvwvline(stdscr,y,x,c,n)
+#define mvwaddch(win,y,x,ch)           (wmove((win),(y),(x)) == ERR ? ERR : waddch((win),(ch)))
+#define mvwaddchnstr(win,y,x,str,n)    (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),(n)))
+#define mvwaddchstr(win,y,x,str)       (wmove((win),(y),(x)) == ERR ? ERR : waddchnstr((win),(str),-1))
+#define mvwaddnstr(win,y,x,str,n)      (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),(n)))
+#define mvwaddstr(win,y,x,str)         (wmove((win),(y),(x)) == ERR ? ERR : waddnstr((win),(str),-1))
+#define mvwdelch(win,y,x)              (wmove((win),(y),(x)) == ERR ? ERR : wdelch(win))
+#define mvwchgat(win,y,x,n,a,c,o)      (wmove((win),(y),(x)) == ERR ? ERR : wchgat((win),(n),(a),(c),(o)))
+#define mvwgetch(win,y,x)              (wmove((win),(y),(x)) == ERR ? ERR : wgetch(win))
+#define mvwgetnstr(win,y,x,str,n)      (wmove((win),(y),(x)) == ERR ? ERR : wgetnstr((win),(str),(n)))
+#define mvwgetstr(win,y,x,str)         (wmove((win),(y),(x)) == ERR ? ERR : wgetstr((win),(str)))
+#define mvwhline(win,y,x,c,n)          (wmove((win),(y),(x)) == ERR ? ERR : whline((win),(c),(n)))
+#define mvwinch(win,y,x)               (wmove((win),(y),(x)) == ERR ? NCURSES_CAST(chtype, ERR) : winch(win))
+#define mvwinchnstr(win,y,x,s,n)       (wmove((win),(y),(x)) == ERR ? ERR : winchnstr((win),(s),(n)))
+#define mvwinchstr(win,y,x,s)          (wmove((win),(y),(x)) == ERR ? ERR : winchstr((win),(s)))
+#define mvwinnstr(win,y,x,s,n)         (wmove((win),(y),(x)) == ERR ? ERR : winnstr((win),(s),(n)))
+#define mvwinsch(win,y,x,c)            (wmove((win),(y),(x)) == ERR ? ERR : winsch((win),(c)))
+#define mvwinsnstr(win,y,x,s,n)                (wmove((win),(y),(x)) == ERR ? ERR : winsnstr((win),(s),(n)))
+#define mvwinsstr(win,y,x,s)           (wmove((win),(y),(x)) == ERR ? ERR : winsstr((win),(s)))
+#define mvwinstr(win,y,x,s)            (wmove((win),(y),(x)) == ERR ? ERR : winstr((win),(s)))
+#define mvwvline(win,y,x,c,n)          (wmove((win),(y),(x)) == ERR ? ERR : wvline((win),(c),(n)))
+
+#define mvaddch(y,x,ch)                        mvwaddch(stdscr,(y),(x),(ch))
+#define mvaddchnstr(y,x,str,n)         mvwaddchnstr(stdscr,(y),(x),(str),(n))
+#define mvaddchstr(y,x,str)            mvwaddchstr(stdscr,(y),(x),(str))
+#define mvaddnstr(y,x,str,n)           mvwaddnstr(stdscr,(y),(x),(str),(n))
+#define mvaddstr(y,x,str)              mvwaddstr(stdscr,(y),(x),(str))
+#define mvchgat(y,x,n,a,c,o)           mvwchgat(stdscr,(y),(x),(n),(a),(c),(o))
+#define mvdelch(y,x)                   mvwdelch(stdscr,(y),(x))
+#define mvgetch(y,x)                   mvwgetch(stdscr,(y),(x))
+#define mvgetnstr(y,x,str,n)           mvwgetnstr(stdscr,(y),(x),(str),(n))
+#define mvgetstr(y,x,str)              mvwgetstr(stdscr,(y),(x),(str))
+#define mvhline(y,x,c,n)               mvwhline(stdscr,(y),(x),(c),(n))
+#define mvinch(y,x)                    mvwinch(stdscr,(y),(x))
+#define mvinchnstr(y,x,s,n)            mvwinchnstr(stdscr,(y),(x),(s),(n))
+#define mvinchstr(y,x,s)               mvwinchstr(stdscr,(y),(x),(s))
+#define mvinnstr(y,x,s,n)              mvwinnstr(stdscr,(y),(x),(s),(n))
+#define mvinsch(y,x,c)                 mvwinsch(stdscr,(y),(x),(c))
+#define mvinsnstr(y,x,s,n)             mvwinsnstr(stdscr,(y),(x),(s),(n))
+#define mvinsstr(y,x,s)                        mvwinsstr(stdscr,(y),(x),(s))
+#define mvinstr(y,x,s)                 mvwinstr(stdscr,(y),(x),(s))
+#define mvvline(y,x,c,n)               mvwvline(stdscr,(y),(x),(c),(n))
 
 /*
  * Some wide-character functions can be implemented without the extensions.