X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_threads.3x;h=cb2da61a55df8501fe5f39ece22978a410b19509;hp=17dabdb7b40a560971884e8bc1c45c7c6301d498;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=396a05943b7da5039dd15d79c4385c7d2a75d6d4 diff --git a/man/curs_threads.3x b/man/curs_threads.3x index 17dabdb7..cb2da61a 100644 --- a/man/curs_threads.3x +++ b/man/curs_threads.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2008 Free Software Foundation, Inc. * +.\" Copyright 2020 Thomas E. Dickey * +.\" Copyright 2008-2015,2017 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 * @@ -26,28 +27,34 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_threads.3x,v 1.12 2008/04/12 18:22:51 tom Exp $ +.\" $Id: curs_threads.3x,v 1.27 2020/12/30 18:28:51 tom Exp $ .TH curs_threads 3X "" +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .na .hy 0 .SH NAME -\fBuse_screen\fR, -\fBuse_window\fR - \fBcurses\fR thread support +\fBcurs_threads\fR \- \fBcurses\fR thread support .ad .hy .SH SYNOPSIS \fB#include \fR .sp \fBtypedef int (*NCURSES_WINDOW_CB)(WINDOW *, void *);\fR -\fBtypedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *);\fR .br -\fBint set_escdelay(int size);\fR +\fBtypedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *);\fR +.sp +\fBint get_escdelay(void);\fR .br -\fBint set_tabsize(int size);\fR +\fBint set_escdelay(int \fP\fIms\fP\fB);\fR .br -\fBint use_screen(SCREEN *scr, NCURSES_WINDOW_CB func, void *data);\fR +\fBint set_tabsize(int \fP\fIcols\fP\fB);\fR +.sp +\fBint use_screen(SCREEN *\fP\fIscr\fP\fB, NCURSES_SCREEN_CB \fP\fIfunc\fP\fB, void *\fP\fIdata\fP\fB);\fR .br -\fBint use_window(WINDOW *win, NCURSES_SCREEN_CB func, void *data);\fR +\fBint use_window(WINDOW *\fP\fIwin\fP\fB, NCURSES_WINDOW_CB \fP\fIfunc\fP\fB, void *\fP\fIdata\fP\fB);\fR .br .SH DESCRIPTION This implementation can be configured to provide rudimentary support @@ -61,7 +68,7 @@ configuration which hide the mutex's needed to prevent concurrent use of the global variables when configured for threading. .PP In addition to forcing access to members of the \fBWINDOW\fP structure -to be via functions (see \fBcurs_opaque\fP(3x)), +to be via functions (see \fBcurs_opaque\fP(3X)), it makes functions of the common global variables, e.g., COLORS, @@ -89,6 +96,8 @@ To modify them in any configuration, use the \fBset_escdelay\fP or \fBset_tabsize\fP functions. Other global variables are not modifiable. .PP +The \fBget_escdelay\fP function returns the value for ESCDELAY. +.PP The \fBuse_window\fP and \fBuse_screen\fP functions provide coarse granularity mutexes for their respective \fBWINDOW\fP and \fBSCREEN\fP parameters, and call a user-supplied function, @@ -100,26 +109,21 @@ All of the ncurses library functions assume that the locale is not altered during operation. In addition, they use data which is maintained within a hierarchy of scopes. -.RS -.TP 3 -- +.RS 3 +.bP global data, e.g., used in the low-level terminfo or termcap interfaces. -.TP 3 -- +.bP terminal data, e.g., associated with a call to \fIset_curterm\fP. The terminal data are initialized when screens are created. -.TP 3 -- +.bP screen data, e.g., associated with a call to \fInewterm\fP or \fIinitscr\fP. -.TP 3 -- +.bP window data, e.g., associated with a call to \fInewwin\fP or \fIsubwin\fP. Windows are associated with screens. Pads are not necessarily associated with a particular screen. .IP Most curses applications operate on one or more windows within a single screen. -.TP 3 -- +.bP reentrant, i.e., it uses only the data passed as parameters. .RE .PP @@ -537,6 +541,7 @@ wget_wch/screen (input-operation) wget_wstr/screen (input-operation) wgetbkgrnd/window wgetch/screen (input-operation) +wgetdelay/window wgetn_wstr/screen (input-operation) wgetnstr/screen (input-operation) wgetparent/window @@ -584,7 +589,7 @@ wvline_set/window .TE .\" *************************************************************************** .SH RETURN VALUE -These functions all return TRUE or FALSE, except as noted. +These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted. .SH NOTES Both a macro and a function are provided for each name. .SH PORTABILITY @@ -594,10 +599,5 @@ It is recommended that any code depending on ncurses extensions be conditioned using NCURSES_VERSION. .SH SEE ALSO \fBcurses\fR(3X), -\fBcurs_opaque\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurs_opaque\fR(3X), +\fBcurs_variables\fR(3X).