ncurses 5.7 - patch 20090418
[ncurses.git] / ncurses / tinfo / lib_data.c
1 /****************************************************************************
2  * Copyright (c) 1998-2007,2008 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  ****************************************************************************/
34
35 /*
36 **      lib_data.c
37 **
38 **      Common data that may/may not be allocated, but is referenced globally
39 **
40 */
41
42 #include <curses.priv.h>
43
44 MODULE_ID("$Id: lib_data.c,v 1.52 2008/08/23 22:16:15 tom Exp $")
45
46 /*
47  * OS/2's native linker complains if we don't initialize public data when
48  * constructing a dll (reported by J.J.G.Ripoll).
49  */
50 #if USE_REENTRANT
51 NCURSES_EXPORT(WINDOW *)
52 NCURSES_PUBLIC_VAR(stdscr) (void)
53 {
54     return SP ? SP->_stdscr : 0;
55 }
56 NCURSES_EXPORT(WINDOW *)
57 NCURSES_PUBLIC_VAR(curscr) (void)
58 {
59     return SP ? SP->_curscr : 0;
60 }
61 NCURSES_EXPORT(WINDOW *)
62 NCURSES_PUBLIC_VAR(newscr) (void)
63 {
64     return SP ? SP->_newscr : 0;
65 }
66 #else
67 NCURSES_EXPORT_VAR(WINDOW *) stdscr = 0;
68 NCURSES_EXPORT_VAR(WINDOW *) curscr = 0;
69 NCURSES_EXPORT_VAR(WINDOW *) newscr = 0;
70 #endif
71
72 NCURSES_EXPORT_VAR(SCREEN *) _nc_screen_chain = 0;
73
74 /*
75  * The variable 'SP' will be defined as a function on systems that cannot link
76  * data-only modules, since it is used in a lot of places within ncurses and we
77  * cannot guarantee that any application will use any particular function.  We
78  * put the WINDOW variables in this module, because it appears that any
79  * application that uses them will also use 'SP'.
80  *
81  * This module intentionally does not reference other ncurses modules, to avoid
82  * module coupling that increases the size of the executable.
83  */
84 #if BROKEN_LINKER
85 static SCREEN *my_screen;
86
87 NCURSES_EXPORT(SCREEN *)
88 _nc_screen(void)
89 {
90     return my_screen;
91 }
92
93 NCURSES_EXPORT(int)
94 _nc_alloc_screen(void)
95 {
96     return ((my_screen = typeCalloc(SCREEN, 1)) != 0);
97 }
98
99 NCURSES_EXPORT(void)
100 _nc_set_screen(SCREEN *sp)
101 {
102     my_screen = sp;
103 }
104
105 #else
106 NCURSES_EXPORT_VAR(SCREEN *) SP = NULL; /* Some linkers require initialized data... */
107 #endif
108 /* *INDENT-OFF* */
109 #define CHARS_0s { '\0' }
110
111 #define TGETENT_0 { 0L, FALSE, NULL, NULL, NULL }
112 #define TGETENT_0s { TGETENT_0, TGETENT_0, TGETENT_0, TGETENT_0 }
113
114 NCURSES_EXPORT_VAR(NCURSES_GLOBALS) _nc_globals = {
115     0,                          /* have_sigwinch */
116     0,                          /* cleanup_nested */
117
118     FALSE,                      /* init_signals */
119     FALSE,                      /* init_screen */
120
121     NULL,                       /* comp_sourcename */
122     NULL,                       /* comp_termtype */
123
124     FALSE,                      /* have_tic_directory */
125     FALSE,                      /* keep_tic_directory */
126     TERMINFO,                   /* tic_directory */
127
128     NULL,                       /* dbi_list */
129     0,                          /* dbi_size */
130
131     NULL,                       /* first_name */
132     NULL,                       /* keyname_table */
133
134     0,                          /* slk_format */
135
136     NULL,                       /* safeprint_buf */
137     0,                          /* safeprint_used */
138
139     TGETENT_0s,                 /* tgetent_cache */
140     0,                          /* tgetent_index */
141     0,                          /* tgetent_sequence */
142
143     0,                          /* _nc_windowlist */
144
145 #if USE_HOME_TERMINFO
146     NULL,                       /* home_terminfo */
147 #endif
148
149 #if !USE_SAFE_SPRINTF
150     0,                          /* safeprint_cols */
151     0,                          /* safeprint_rows */
152 #endif
153
154 #ifdef TRACE
155     FALSE,                      /* init_trace */
156     CHARS_0s,                   /* trace_fname */
157     0,                          /* trace_level */
158     NULL,                       /* trace_fp */
159
160     NULL,                       /* tracearg_buf */
161     0,                          /* tracearg_used */
162
163     NULL,                       /* tracebuf_ptr */
164     0,                          /* tracebuf_used */
165
166     CHARS_0s,                   /* tracechr_buf */
167
168     NULL,                       /* tracedmp_buf */
169     0,                          /* tracedmp_used */
170
171     NULL,                       /* tracetry_buf */
172     0,                          /* tracetry_used */
173
174     { CHARS_0s, CHARS_0s },     /* traceatr_color_buf */
175     0,                          /* traceatr_color_sel */
176     -1,                         /* traceatr_color_last */
177
178 #endif /* TRACE */
179 #ifdef USE_PTHREADS
180     PTHREAD_MUTEX_INITIALIZER,  /* mutex_curses */
181     PTHREAD_MUTEX_INITIALIZER,  /* mutex_tst_tracef */
182     PTHREAD_MUTEX_INITIALIZER,  /* mutex_tracef */
183     0,                          /* nested_tracef */
184     0,                          /* use_pthreads */
185 #endif
186 };
187
188 #define STACK_FRAME_0   { { 0 }, 0 }
189 #define STACK_FRAME_0s  { STACK_FRAME_0 }
190 #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 }
191
192 #define RIPOFF_0        { 0,0,0 }
193 #define RIPOFF_0s       { RIPOFF_0 }
194
195 NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen = {
196     TRUE,                       /* use_env */
197     FALSE,                      /* filter_mode */
198     A_NORMAL,                   /* previous_attr */
199     RIPOFF_0s,                  /* ripoff */
200     NULL,                       /* rsp */
201     {                           /* tparm_state */
202 #ifdef TRACE
203         NULL,                   /* tname */
204 #endif
205         NULL,                   /* tparam_base */
206
207         STACK_FRAME_0s,         /* stack */
208         0,                      /* stack_ptr */
209
210         NULL,                   /* out_buff */
211         0,                      /* out_size */
212         0,                      /* out_used */
213
214         NULL,                   /* fmt_buff */
215         0,                      /* fmt_size */
216
217         NUM_VARS_0s,            /* dynamic_var */
218         NUM_VARS_0s,            /* static_vars */
219     },
220     NULL,                       /* saved_tty */
221 #if NCURSES_NO_PADDING
222     FALSE,                      /* flag to set if padding disabled  */
223 #endif
224 #if BROKEN_LINKER || USE_REENTRANT
225     NULL,                       /* real_acs_map */
226     0,                          /* LINES */
227     0,                          /* COLS */
228     0,                          /* cur_term */
229 #ifdef TRACE
230     0L,                         /* _outchars */
231     NULL,                       /* _tputs_trace */
232 #endif
233 #endif
234 };
235 /* *INDENT-ON* */
236
237 /******************************************************************************/
238 #ifdef USE_PTHREADS
239 static void
240 init_global_mutexes(void)
241 {
242     static bool initialized = FALSE;
243
244     if (!initialized) {
245         initialized = TRUE;
246         _nc_mutex_init(&_nc_globals.mutex_curses);
247         _nc_mutex_init(&_nc_globals.mutex_tst_tracef);
248         _nc_mutex_init(&_nc_globals.mutex_tracef);
249     }
250 }
251
252 NCURSES_EXPORT(void)
253 _nc_init_pthreads(void)
254 {
255     if (_nc_use_pthreads)
256         return;
257 # if USE_WEAK_SYMBOLS
258     if ((pthread_mutex_init) == 0)
259         return;
260     if ((pthread_mutex_lock) == 0)
261         return;
262     if ((pthread_mutex_unlock) == 0)
263         return;
264     if ((pthread_mutex_trylock) == 0)
265         return;
266     if ((pthread_mutexattr_settype) == 0)
267         return;
268 # endif
269     _nc_use_pthreads = 1;
270     init_global_mutexes();
271 }
272
273 /*
274  * Use recursive mutexes if we have them - they're part of Unix98.
275  * For the cases where we do not, _nc_mutex_trylock() is used to avoid a
276  * deadlock, at the expense of memory leaks and unexpected failures that
277  * may not be handled by typical clients.
278  *
279  * FIXME - need configure check for PTHREAD_MUTEX_RECURSIVE, define it to
280  * PTHREAD_MUTEX_NORMAL if not supported.
281  */
282 NCURSES_EXPORT(void)
283 _nc_mutex_init(pthread_mutex_t * obj)
284 {
285     pthread_mutexattr_t recattr;
286
287     if (_nc_use_pthreads) {
288         pthread_mutexattr_init(&recattr);
289         pthread_mutexattr_settype(&recattr, PTHREAD_MUTEX_RECURSIVE);
290         pthread_mutex_init(obj, &recattr);
291     }
292 }
293
294 NCURSES_EXPORT(int)
295 _nc_mutex_lock(pthread_mutex_t * obj)
296 {
297     if (_nc_use_pthreads == 0)
298         return 0;
299     return pthread_mutex_lock(obj);
300 }
301
302 NCURSES_EXPORT(int)
303 _nc_mutex_trylock(pthread_mutex_t * obj)
304 {
305     if (_nc_use_pthreads == 0)
306         return 0;
307     return pthread_mutex_trylock(obj);
308 }
309
310 NCURSES_EXPORT(int)
311 _nc_mutex_unlock(pthread_mutex_t * obj)
312 {
313     if (_nc_use_pthreads == 0)
314         return 0;
315     return pthread_mutex_unlock(obj);
316 }
317
318 #if USE_WEAK_SYMBOLS
319 /*
320  * NB: sigprocmask(2) is global but pthread_sigmask(3p)
321  * only for the calling thread.
322  */
323 NCURSES_EXPORT(int)
324 _nc_sigprocmask(int how, const sigset_t * newmask, sigset_t * oldmask)
325 {
326     if ((pthread_sigmask))
327         return pthread_sigmask(how, newmask, oldmask);
328     else
329         return sigprocmask(how, newmask, oldmask);
330 }
331 #endif
332 #endif /* USE_PTHREADS */