lib_data.c revision 178866 
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
44MODULE_ID("$Id: lib_data.c,v 1.43 2008/03/29 21:16:49 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
51NCURSES_EXPORT(WINDOW *)
52NCURSES_PUBLIC_VAR(stdscr) (void)
53{
54    return SP ? SP->_stdscr : 0;
55}
56NCURSES_EXPORT(WINDOW *)
57NCURSES_PUBLIC_VAR(curscr) (void)
58{
59    return SP ? SP->_curscr : 0;
60}
61NCURSES_EXPORT(WINDOW *)
62NCURSES_PUBLIC_VAR(newscr) (void)
63{
64    return SP ? SP->_newscr : 0;
65}
66#else
67NCURSES_EXPORT_VAR(WINDOW *) stdscr = 0;
68NCURSES_EXPORT_VAR(WINDOW *) curscr = 0;
69NCURSES_EXPORT_VAR(WINDOW *) newscr = 0;
70#endif
71
72NCURSES_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
85static SCREEN *my_screen;
86
87NCURSES_EXPORT(SCREEN *)
88_nc_screen(void)
89{
90    return my_screen;
91}
92
93NCURSES_EXPORT(int)
94_nc_alloc_screen(void)
95{
96    return ((my_screen = typeCalloc(SCREEN, 1)) != 0);
97}
98
99NCURSES_EXPORT(void)
100_nc_set_screen(SCREEN *sp)
101{
102    my_screen = sp;
103}
104
105#else
106NCURSES_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
114NCURSES_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    CHARS_0s,			/* tracemse_buf */
172
173    NULL,			/* tracetry_buf */
174    0,				/* tracetry_used */
175
176    { CHARS_0s, CHARS_0s },	/* traceatr_color_buf */
177    0,				/* traceatr_color_sel */
178    -1,				/* traceatr_color_last */
179
180#endif /* TRACE */
181#ifdef USE_PTHREADS
182    PTHREAD_MUTEX_INITIALIZER,	/* mutex_set_SP */
183    PTHREAD_MUTEX_INITIALIZER,	/* mutex_use_screen */
184    PTHREAD_MUTEX_INITIALIZER,	/* mutex_use_window */
185    PTHREAD_MUTEX_INITIALIZER,	/* mutex_windowlist */
186    PTHREAD_MUTEX_INITIALIZER,	/* mutex_tst_tracef */
187    PTHREAD_MUTEX_INITIALIZER,	/* mutex_tracef */
188    0,				/* nested_tracef */
189#endif
190};
191
192#define STACK_FRAME_0	{ { 0 }, 0 }
193#define STACK_FRAME_0s	{ STACK_FRAME_0 }
194#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 }
195
196#define RIPOFF_0	{ 0,0,0 }
197#define RIPOFF_0s	{ RIPOFF_0 }
198
199NCURSES_EXPORT_VAR(NCURSES_PRESCREEN) _nc_prescreen = {
200    TRUE,			/* use_env */
201    FALSE,			/* filter_mode */
202    A_NORMAL,			/* previous_attr */
203    RIPOFF_0s,			/* ripoff */
204    NULL,			/* rsp */
205    {				/* tparm_state */
206#ifdef TRACE
207	NULL,			/* tname */
208#endif
209	NULL,			/* tparam_base */
210
211	STACK_FRAME_0s,		/* stack */
212	0,			/* stack_ptr */
213
214	NULL,			/* out_buff */
215	0,			/* out_size */
216	0,			/* out_used */
217
218	NULL,			/* fmt_buff */
219	0,			/* fmt_size */
220
221	NUM_VARS_0s,		/* dynamic_var */
222	NUM_VARS_0s,		/* static_vars */
223    },
224    NULL,			/* saved_tty */
225#if BROKEN_LINKER || USE_REENTRANT
226    NULL,			/* real_acs_map */
227    0,				/* LINES */
228    0,				/* COLS */
229#ifdef TRACE
230    0L,				/* _outchars */
231    NULL,			/* _tputs_trace */
232#endif
233#endif
234};
235/* *INDENT-ON* */
236
237/******************************************************************************/
238#ifdef USE_PTHREADS
239static void
240init_global_mutexes(void)
241{
242    static bool initialized = FALSE;
243
244    if (!initialized) {
245	initialized = TRUE;
246	_nc_mutex_init(&_nc_globals.mutex_set_SP);
247	_nc_mutex_init(&_nc_globals.mutex_use_screen);
248	_nc_mutex_init(&_nc_globals.mutex_use_window);
249	_nc_mutex_init(&_nc_globals.mutex_windowlist);
250	_nc_mutex_init(&_nc_globals.mutex_tst_tracef);
251	_nc_mutex_init(&_nc_globals.mutex_tracef);
252    }
253}
254
255/*
256 * Use recursive mutexes if we have them - they're part of Unix98.
257 * For the cases where we do not, _nc_mutex_trylock() is used to avoid a
258 * deadlock, at the expense of memory leaks and unexpected failures that
259 * may not be handled by typical clients.
260 *
261 * FIXME - need configure check for PTHREAD_MUTEX_RECURSIVE, define it to
262 * PTHREAD_MUTEX_NORMAL if not supported.
263 */
264NCURSES_EXPORT(void)
265_nc_mutex_init(pthread_mutex_t * obj)
266{
267    pthread_mutexattr_t recattr;
268
269    memset(&recattr, 0, sizeof(recattr));
270    pthread_mutexattr_settype(&recattr, PTHREAD_MUTEX_RECURSIVE);
271    pthread_mutex_init(obj, &recattr);
272}
273
274NCURSES_EXPORT(int)
275_nc_mutex_lock(pthread_mutex_t * obj)
276{
277    init_global_mutexes();
278    return pthread_mutex_lock(obj);
279}
280
281NCURSES_EXPORT(int)
282_nc_mutex_trylock(pthread_mutex_t * obj)
283{
284    init_global_mutexes();
285    return pthread_mutex_trylock(obj);
286}
287
288NCURSES_EXPORT(int)
289_nc_mutex_unlock(pthread_mutex_t * obj)
290{
291    init_global_mutexes();
292    return pthread_mutex_unlock(obj);
293}
294#endif /* USE_PTHREADS */
295