ncurses 6.0 - patch 20170617
[ncurses.git] / ncurses / tinfo / lib_data.c
1 /****************************************************************************
2  * Copyright (c) 1998-2016,2017 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.72 2017/04/10 08:34:31 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     my_screen = _nc_alloc_screen_sp();
98     T(("_nc_alloc_screen_sp %p", my_screen));
99     return (my_screen != 0);
100 }
101
102 NCURSES_EXPORT(void)
103 _nc_set_screen(SCREEN *sp)
104 {
105     my_screen = sp;
106 }
107
108 #else
109
110 NCURSES_EXPORT_VAR(SCREEN *) SP = NULL; /* Some linkers require initialized data... */
111 #endif
112 /* *INDENT-OFF* */
113 #define CHARS_0s { '\0' }
114
115 #define TGETENT_0 { 0L, FALSE, NULL, NULL, NULL }
116 #define TGETENT_0s { TGETENT_0, TGETENT_0, TGETENT_0, TGETENT_0 }
117
118 NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals = {
119     0,                          /* have_sigtstp */
120     0,                          /* have_sigwinch */
121     0,                          /* cleanup_nested */
122
123     FALSE,                      /* init_signals */
124     FALSE,                      /* init_screen */
125
126     NULL,                       /* comp_sourcename */
127     NULL,                       /* comp_termtype */
128
129     FALSE,                      /* have_tic_directory */
130     FALSE,                      /* keep_tic_directory */
131     0,                          /* tic_directory */
132
133     NULL,                       /* dbi_list */
134     0,                          /* dbi_size */
135
136     NULL,                       /* first_name */
137     NULL,                       /* keyname_table */
138     0,                          /* init_keyname */
139
140     0,                          /* slk_format */
141
142     NULL,                       /* safeprint_buf */
143     0,                          /* safeprint_used */
144
145     TGETENT_0s,                 /* tgetent_cache */
146     0,                          /* tgetent_index */
147     0,                          /* tgetent_sequence */
148
149     0,                          /* dbd_blob */
150     0,                          /* dbd_list */
151     0,                          /* dbd_size */
152     0,                          /* dbd_time */
153     { { 0, 0 } },               /* dbd_vars */
154
155 #ifndef USE_SP_WINDOWLIST
156     0,                          /* _nc_windowlist */
157 #endif
158
159 #if USE_HOME_TERMINFO
160     NULL,                       /* home_terminfo */
161 #endif
162
163 #if !USE_SAFE_SPRINTF
164     0,                          /* safeprint_cols */
165     0,                          /* safeprint_rows */
166 #endif
167
168 #ifdef USE_TERM_DRIVER
169     0,                          /* term_driver */
170 #endif
171
172 #ifdef TRACE
173     FALSE,                      /* trace_opened */
174     CHARS_0s,                   /* trace_fname */
175     0,                          /* trace_level */
176     NULL,                       /* trace_fp */
177     -1,                         /* trace_fd */
178
179     NULL,                       /* tracearg_buf */
180     0,                          /* tracearg_used */
181
182     NULL,                       /* tracebuf_ptr */
183     0,                          /* tracebuf_used */
184
185     CHARS_0s,                   /* tracechr_buf */
186
187     NULL,                       /* tracedmp_buf */
188     0,                          /* tracedmp_used */
189
190     NULL,                       /* tracetry_buf */
191     0,                          /* tracetry_used */
192
193     { CHARS_0s, CHARS_0s },     /* traceatr_color_buf */
194     0,                          /* traceatr_color_sel */
195     -1,                         /* traceatr_color_last */
196 #if !defined(USE_PTHREADS) && USE_REENTRANT
197     0,                          /* nested_tracef */
198 #endif
199 #endif /* TRACE */
200 #ifdef USE_PTHREADS
201     PTHREAD_MUTEX_INITIALIZER,  /* mutex_curses */
202     PTHREAD_MUTEX_INITIALIZER,  /* mutex_tst_tracef */
203     PTHREAD_MUTEX_INITIALIZER,  /* mutex_tracef */
204     0,                          /* nested_tracef */
205     0,                          /* use_pthreads */
206 #endif
207 #if USE_PTHREADS_EINTR
208     0,                          /* read_thread */
209 #endif
210 #if USE_WIDEC_SUPPORT
211     CHARS_0s,                   /* key_name */
212 #endif
213 };
214
215 #define STACK_FRAME_0   { { 0 }, 0 }
216 #define STACK_FRAME_0s  { STACK_FRAME_0 }
217 #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 }
218
219 #define RIPOFF_0        { 0,0,0 }
220 #define RIPOFF_0s       { RIPOFF_0 }
221
222 NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen = {
223     NULL,                       /* allocated */
224     TRUE,                       /* use_env */
225     FALSE,                      /* filter_mode */
226     A_NORMAL,                   /* previous_attr */
227 #ifndef USE_SP_RIPOFF
228     RIPOFF_0s,                  /* ripoff */
229     NULL,                       /* rsp */
230 #endif
231     {                           /* tparm_state */
232 #ifdef TRACE
233         NULL,                   /* tname */
234 #endif
235         NULL,                   /* tparam_base */
236
237         STACK_FRAME_0s,         /* stack */
238         0,                      /* stack_ptr */
239
240         NULL,                   /* out_buff */
241         0,                      /* out_size */
242         0,                      /* out_used */
243
244         NULL,                   /* fmt_buff */
245         0,                      /* fmt_size */
246
247         NUM_VARS_0s,            /* dynamic_var */
248         NUM_VARS_0s,            /* static_vars */
249     },
250     NULL,                       /* saved_tty */
251 #if NCURSES_NO_PADDING
252     FALSE,                      /* flag to set if padding disabled  */
253 #endif
254     0,                          /* _outch */
255 #if BROKEN_LINKER || USE_REENTRANT
256     NULL,                       /* real_acs_map */
257     0,                          /* LINES */
258     0,                          /* COLS */
259     8,                          /* TABSIZE */
260     1000,                       /* ESCDELAY */
261     0,                          /* cur_term */
262 #ifdef TRACE
263     0L,                         /* _outchars */
264     NULL,                       /* _tputs_trace */
265 #endif
266 #endif
267     FALSE,                      /* use_tioctl */
268 };
269 /* *INDENT-ON* */
270
271 /*
272  * wgetch() and other functions with a WINDOW* parameter may use a SCREEN*
273  * internally, and it is useful to allow those to be invoked without switching
274  * SCREEN's, e.g., for multi-threaded applications.
275  */
276 NCURSES_EXPORT(SCREEN *)
277 _nc_screen_of(WINDOW *win)
278 {
279     SCREEN *sp = 0;
280
281     if (win != 0) {
282         sp = WINDOW_EXT(win, screen);
283     }
284     return (sp);
285 }
286
287 /******************************************************************************/
288 #ifdef USE_PTHREADS
289 static void
290 init_global_mutexes(void)
291 {
292     static bool initialized = FALSE;
293
294     if (!initialized) {
295         initialized = TRUE;
296         _nc_mutex_init(&_nc_globals.mutex_curses);
297         _nc_mutex_init(&_nc_globals.mutex_tst_tracef);
298         _nc_mutex_init(&_nc_globals.mutex_tracef);
299     }
300 }
301
302 NCURSES_EXPORT(void)
303 _nc_init_pthreads(void)
304 {
305     if (_nc_use_pthreads)
306         return;
307 # if USE_WEAK_SYMBOLS
308     if ((pthread_mutex_init) == 0)
309         return;
310     if ((pthread_mutex_lock) == 0)
311         return;
312     if ((pthread_mutex_unlock) == 0)
313         return;
314     if ((pthread_mutex_trylock) == 0)
315         return;
316     if ((pthread_mutexattr_settype) == 0)
317         return;
318 # endif
319     _nc_use_pthreads = 1;
320     init_global_mutexes();
321 }
322
323 /*
324  * Use recursive mutexes if we have them - they're part of Unix98.
325  * For the cases where we do not, _nc_mutex_trylock() is used to avoid a
326  * deadlock, at the expense of memory leaks and unexpected failures that
327  * may not be handled by typical clients.
328  *
329  * FIXME - need configure check for PTHREAD_MUTEX_RECURSIVE, define it to
330  * PTHREAD_MUTEX_NORMAL if not supported.
331  */
332 NCURSES_EXPORT(void)
333 _nc_mutex_init(pthread_mutex_t * obj)
334 {
335     pthread_mutexattr_t recattr;
336
337     if (_nc_use_pthreads) {
338         pthread_mutexattr_init(&recattr);
339         pthread_mutexattr_settype(&recattr, PTHREAD_MUTEX_RECURSIVE);
340         pthread_mutex_init(obj, &recattr);
341     }
342 }
343
344 NCURSES_EXPORT(int)
345 _nc_mutex_lock(pthread_mutex_t * obj)
346 {
347     if (_nc_use_pthreads == 0)
348         return 0;
349     return pthread_mutex_lock(obj);
350 }
351
352 NCURSES_EXPORT(int)
353 _nc_mutex_trylock(pthread_mutex_t * obj)
354 {
355     if (_nc_use_pthreads == 0)
356         return 0;
357     return pthread_mutex_trylock(obj);
358 }
359
360 NCURSES_EXPORT(int)
361 _nc_mutex_unlock(pthread_mutex_t * obj)
362 {
363     if (_nc_use_pthreads == 0)
364         return 0;
365     return pthread_mutex_unlock(obj);
366 }
367 #endif /* USE_PTHREADS */
368
369 #if defined(USE_PTHREADS) || USE_PTHREADS_EINTR
370 #if USE_WEAK_SYMBOLS
371 /*
372  * NB: sigprocmask(2) is global but pthread_sigmask(3p)
373  * only for the calling thread.
374  */
375 NCURSES_EXPORT(int)
376 _nc_sigprocmask(int how, const sigset_t * newmask, sigset_t * oldmask)
377 {
378     if ((pthread_sigmask))
379         return pthread_sigmask(how, newmask, oldmask);
380     else
381         return (sigprocmask) (how, newmask, oldmask);
382 }
383 #endif
384 #endif /* USE_PTHREADS */