ncurses/tinfo/lib_data.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2011,2012 Free Software Foundation, Inc.              *
   3  *                                                                          *
   4  * Permission is hereby granted, free of charge, to any person obtaining a  *
   5  * copy of this software and associated documentation files (the            *
   6  * "Software"), to deal in the Software without restriction, including      *
   7  * without limitation the rights to use, copy, modify, merge, publish,      *
   8  * distribute, distribute with modifications, sublicense, and/or sell       *
   9  * copies of the Software, and to permit persons to whom the Software is    *
  10  * furnished to do so, subject to the following conditions:                 *
  11  *                                                                          *
  12  * The above copyright notice and this permission notice shall be included  *
  13  * in all copies or substantial portions of the Software.                   *
  14  *                                                                          *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22  *                                                                          *
  23  * Except as contained in this notice, the name(s) of the above copyright   *
  24  * holders shall not be used in advertising or otherwise to promote the     *
  25  * sale, use or other dealings in this Software without prior written       *
  26  * authorization.                                                           *
  27  ****************************************************************************/
  28
  29 /****************************************************************************
  30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  32  *     and: Thomas E. Dickey                        1996-on                 *
  33  *     and: Juergen Pfeifer                                                 *
  34  ****************************************************************************/
  35
  36 /*
  37 **      lib_data.c
  38 **
  39 **      Common data that may/may not be allocated, but is referenced globally
  40 **
  41 */
  42
  43 #include <curses.priv.h>
  44
  45 MODULE_ID("$Id: lib_data.c,v 1.65 2012/08/25 18:38:43 tom Exp $")
  46
  47 /*
  48  * OS/2's native linker complains if we don't initialize public data when
  49  * constructing a dll (reported by J.J.G.Ripoll).
  50  */
  51 #if USE_REENTRANT
  52 NCURSES_EXPORT(WINDOW *)
  53 NCURSES_PUBLIC_VAR(stdscr) (void)
  54 {
  55     return CURRENT_SCREEN ? StdScreen(CURRENT_SCREEN) : 0;
  56 }
  57 NCURSES_EXPORT(WINDOW *)
  58 NCURSES_PUBLIC_VAR(curscr) (void)
  59 {
  60     return CURRENT_SCREEN ? CurScreen(CURRENT_SCREEN) : 0;
  61 }
  62 NCURSES_EXPORT(WINDOW *)
  63 NCURSES_PUBLIC_VAR(newscr) (void)
  64 {
  65     return CURRENT_SCREEN ? NewScreen(CURRENT_SCREEN) : 0;
  66 }
  67 #else
  68 NCURSES_EXPORT_VAR(WINDOW *) stdscr = 0;
  69 NCURSES_EXPORT_VAR(WINDOW *) curscr = 0;
  70 NCURSES_EXPORT_VAR(WINDOW *) newscr = 0;
  71 #endif
  72
  73 NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain = 0;
  74
  75 /*
  76  * The variable 'SP' will be defined as a function on systems that cannot link
  77  * data-only modules, since it is used in a lot of places within ncurses and we
  78  * cannot guarantee that any application will use any particular function.  We
  79  * put the WINDOW variables in this module, because it appears that any
  80  * application that uses them will also use 'SP'.
  81  *
  82  * This module intentionally does not reference other ncurses modules, to avoid
  83  * module coupling that increases the size of the executable.
  84  */
  85 #if BROKEN_LINKER
  86 static SCREEN *my_screen;
  87
  88 NCURSES_EXPORT(SCREEN *)
  89 _nc_screen(void)
  90 {
  91     return my_screen;
  92 }
  93
  94 NCURSES_EXPORT(int)
  95 _nc_alloc_screen(void)
  96 {
  97     return ((my_screen = _nc_alloc_screen_sp()) != 0);
  98 }
  99
 100 NCURSES_EXPORT(void)
 101 _nc_set_screen(SCREEN *sp)
 102 {
 103     my_screen = sp;
 104 }
 105
 106 #else
 107
 108 NCURSES_EXPORT_VAR(SCREEN *) SP = NULL; /* Some linkers require initialized data... */
 109 #endif
 110 /* *INDENT-OFF* */
 111 #define CHARS_0s { '\0' }
 112
 113 #define TGETENT_0 { 0L, FALSE, NULL, NULL, NULL }
 114 #define TGETENT_0s { TGETENT_0, TGETENT_0, TGETENT_0, TGETENT_0 }
 115
 116 NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals = {
 117     0,                          /* have_sigtstp */
 118     0,                          /* have_sigwinch */
 119     0,                          /* cleanup_nested */
 120
 121     FALSE,                      /* init_signals */
 122     FALSE,                      /* init_screen */
 123
 124     NULL,                       /* comp_sourcename */
 125     NULL,                       /* comp_termtype */
 126
 127     FALSE,                      /* have_tic_directory */
 128     FALSE,                      /* keep_tic_directory */
 129     0,                          /* tic_directory */
 130
 131     NULL,                       /* dbi_list */
 132     0,                          /* dbi_size */
 133
 134     NULL,                       /* first_name */
 135     NULL,                       /* keyname_table */
 136
 137     0,                          /* slk_format */
 138
 139     NULL,                       /* safeprint_buf */
 140     0,                          /* safeprint_used */
 141
 142     TGETENT_0s,                 /* tgetent_cache */
 143     0,                          /* tgetent_index */
 144     0,                          /* tgetent_sequence */
 145
 146     0,                          /* dbd_blob */
 147     0,                          /* dbd_list */
 148     0,                          /* dbd_size */
 149     0,                          /* dbd_time */
 150     { { 0, 0 } },               /* dbd_vars */
 151
 152 #ifndef USE_SP_WINDOWLIST
 153     0,                          /* _nc_windowlist */
 154 #endif
 155
 156 #if USE_HOME_TERMINFO
 157     NULL,                       /* home_terminfo */
 158 #endif
 159
 160 #if !USE_SAFE_SPRINTF
 161     0,                          /* safeprint_cols */
 162     0,                          /* safeprint_rows */
 163 #endif
 164
 165 #ifdef USE_TERM_DRIVER
 166     0,                          /* term_driver */
 167 #endif
 168
 169 #ifdef TRACE
 170     FALSE,                      /* init_trace */
 171     CHARS_0s,                   /* trace_fname */
 172     0,                          /* trace_level */
 173     NULL,                       /* trace_fp */
 174
 175     NULL,                       /* tracearg_buf */
 176     0,                          /* tracearg_used */
 177
 178     NULL,                       /* tracebuf_ptr */
 179     0,                          /* tracebuf_used */
 180
 181     CHARS_0s,                   /* tracechr_buf */
 182
 183     NULL,                       /* tracedmp_buf */
 184     0,                          /* tracedmp_used */
 185
 186     NULL,                       /* tracetry_buf */
 187     0,                          /* tracetry_used */
 188
 189     { CHARS_0s, CHARS_0s },     /* traceatr_color_buf */
 190     0,                          /* traceatr_color_sel */
 191     -1,                         /* traceatr_color_last */
 192 #if !defined(USE_PTHREADS) && USE_REENTRANT
 193     0,                          /* nested_tracef */
 194 #endif
 195 #endif /* TRACE */
 196 #ifdef USE_PTHREADS
 197     PTHREAD_MUTEX_INITIALIZER,  /* mutex_curses */
 198     PTHREAD_MUTEX_INITIALIZER,  /* mutex_tst_tracef */
 199     PTHREAD_MUTEX_INITIALIZER,  /* mutex_tracef */
 200     0,                          /* nested_tracef */
 201     0,                          /* use_pthreads */
 202 #endif
 203 #if USE_PTHREADS_EINTR
 204     0,                          /* read_thread */
 205 #endif
 206 };
 207
 208 #define STACK_FRAME_0   { { 0 }, 0 }
 209 #define STACK_FRAME_0s  { STACK_FRAME_0 }
 210 #define NUM_VARS_0s     { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 }
 211
 212 #define RIPOFF_0        { 0,0,0 }
 213 #define RIPOFF_0s       { RIPOFF_0 }
 214
 215 NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen = {
 216     TRUE,                       /* use_env */
 217     FALSE,                      /* filter_mode */
 218     A_NORMAL,                   /* previous_attr */
 219 #ifndef USE_SP_RIPOFF
 220     RIPOFF_0s,                  /* ripoff */
 221     NULL,                       /* rsp */
 222 #endif
 223     {                           /* tparm_state */
 224 #ifdef TRACE
 225         NULL,                   /* tname */
 226 #endif
 227         NULL,                   /* tparam_base */
 228
 229         STACK_FRAME_0s,         /* stack */
 230         0,                      /* stack_ptr */
 231
 232         NULL,                   /* out_buff */
 233         0,                      /* out_size */
 234         0,                      /* out_used */
 235
 236         NULL,                   /* fmt_buff */
 237         0,                      /* fmt_size */
 238
 239         NUM_VARS_0s,            /* dynamic_var */
 240         NUM_VARS_0s,            /* static_vars */
 241     },
 242     NULL,                       /* saved_tty */
 243 #if NCURSES_NO_PADDING
 244     FALSE,                      /* flag to set if padding disabled  */
 245 #endif
 246     0,                          /* _outch */
 247 #if BROKEN_LINKER || USE_REENTRANT
 248     NULL,                       /* real_acs_map */
 249     0,                          /* LINES */
 250     0,                          /* COLS */
 251     8,                          /* TABSIZE */
 252     1000,                       /* ESCDELAY */
 253     0,                          /* cur_term */
 254 #ifdef TRACE
 255     0L,                         /* _outchars */
 256     NULL,                       /* _tputs_trace */
 257 #endif
 258 #endif
 259     FALSE,                      /* use_tioctl */
 260 };
 261 /* *INDENT-ON* */
 262
 263 /*
 264  * wgetch() and other functions with a WINDOW* parameter may use a SCREEN*
 265  * internally, and it is useful to allow those to be invoked without switching
 266  * SCREEN's, e.g., for multi-threaded applications.
 267  */
 268 NCURSES_EXPORT(SCREEN *)
 269 _nc_screen_of(WINDOW *win)
 270 {
 271     SCREEN *sp = 0;
 272
 273     if (win != 0) {
 274         sp = WINDOW_EXT(win, screen);
 275     }
 276     return (sp);
 277 }
 278
 279 /******************************************************************************/
 280 #ifdef USE_PTHREADS
 281 static void
 282 init_global_mutexes(void)
 283 {
 284     static bool initialized = FALSE;
 285
 286     if (!initialized) {
 287         initialized = TRUE;
 288         _nc_mutex_init(&_nc_globals.mutex_curses);
 289         _nc_mutex_init(&_nc_globals.mutex_tst_tracef);
 290         _nc_mutex_init(&_nc_globals.mutex_tracef);
 291     }
 292 }
 293
 294 NCURSES_EXPORT(void)
 295 _nc_init_pthreads(void)
 296 {
 297     if (_nc_use_pthreads)
 298         return;
 299 # if USE_WEAK_SYMBOLS
 300     if ((pthread_mutex_init) == 0)
 301         return;
 302     if ((pthread_mutex_lock) == 0)
 303         return;
 304     if ((pthread_mutex_unlock) == 0)
 305         return;
 306     if ((pthread_mutex_trylock) == 0)
 307         return;
 308     if ((pthread_mutexattr_settype) == 0)
 309         return;
 310 # endif
 311     _nc_use_pthreads = 1;
 312     init_global_mutexes();
 313 }
 314
 315 /*
 316  * Use recursive mutexes if we have them - they're part of Unix98.
 317  * For the cases where we do not, _nc_mutex_trylock() is used to avoid a
 318  * deadlock, at the expense of memory leaks and unexpected failures that
 319  * may not be handled by typical clients.
 320  *
 321  * FIXME - need configure check for PTHREAD_MUTEX_RECURSIVE, define it to
 322  * PTHREAD_MUTEX_NORMAL if not supported.
 323  */
 324 NCURSES_EXPORT(void)
 325 _nc_mutex_init(pthread_mutex_t * obj)
 326 {
 327     pthread_mutexattr_t recattr;
 328
 329     if (_nc_use_pthreads) {
 330         pthread_mutexattr_init(&recattr);
 331         pthread_mutexattr_settype(&recattr, PTHREAD_MUTEX_RECURSIVE);
 332         pthread_mutex_init(obj, &recattr);
 333     }
 334 }
 335
 336 NCURSES_EXPORT(int)
 337 _nc_mutex_lock(pthread_mutex_t * obj)
 338 {
 339     if (_nc_use_pthreads == 0)
 340         return 0;
 341     return pthread_mutex_lock(obj);
 342 }
 343
 344 NCURSES_EXPORT(int)
 345 _nc_mutex_trylock(pthread_mutex_t * obj)
 346 {
 347     if (_nc_use_pthreads == 0)
 348         return 0;
 349     return pthread_mutex_trylock(obj);
 350 }
 351
 352 NCURSES_EXPORT(int)
 353 _nc_mutex_unlock(pthread_mutex_t * obj)
 354 {
 355     if (_nc_use_pthreads == 0)
 356         return 0;
 357     return pthread_mutex_unlock(obj);
 358 }
 359 #endif /* USE_PTHREADS */
 360
 361 #if defined(USE_PTHREADS) || USE_PTHREADS_EINTR
 362 #if USE_WEAK_SYMBOLS
 363 /*
 364  * NB: sigprocmask(2) is global but pthread_sigmask(3p)
 365  * only for the calling thread.
 366  */
 367 NCURSES_EXPORT(int)
 368 _nc_sigprocmask(int how, const sigset_t * newmask, sigset_t * oldmask)
 369 {
 370     if ((pthread_sigmask))
 371         return pthread_sigmask(how, newmask, oldmask);
 372     else
 373         return sigprocmask(how, newmask, oldmask);
 374 }
 375 #endif
 376 #endif /* USE_PTHREADS */