* threads.c: Doc fix.
[bpt/guile.git] / libguile / threads.c
1 /* Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
2 *
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
6 * any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
17 *
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
20 *
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
26 *
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
29 *
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
37 *
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
41 \f
42
43 /* This file does some pretty hairy #inclusion. It probably seemed
44 like a good idea at the time, but it doesn't now. Here's the
45 structure, edited for relevance (!), last I checked:
46
47 threads.c:
48 threads.h
49 coop-defs.h
50 iselect.h
51 mit-pthreads.c
52 coop-threads.c
53 coop-threads.h
54 coop-defs.h*
55 ../qt/qt.h
56 coop.c
57 <qt.h>
58
59 * second #inclusion
60 */
61
62 #include <stdio.h>
63 #include "_scm.h"
64 #include "dynwind.h"
65 #include "smob.h"
66
67 #include "threads.h"
68
69 \f
70
71 long scm_tc16_thread;
72
73 long scm_tc16_mutex;
74
75 long scm_tc16_condvar;
76
77 \f
78 /* Scheme-visible thread functions. */
79
80 #ifdef USE_COOP_THREADS
81 SCM_PROC(s_single_thread_p, "single-active-thread?", 0, 0, 0, scm_single_thread_p);
82 #endif
83 SCM_PROC(s_yield, "yield", 0, 0, 0, scm_yield);
84 SCM_PROC(s_call_with_new_thread, "call-with-new-thread", 0, 0, 1, scm_call_with_new_thread);
85 SCM_PROC(s_join_thread, "join-thread", 1, 0, 0, scm_join_thread);
86 SCM_PROC(s_make_mutex, "make-mutex", 0, 0, 0, scm_make_mutex);
87 SCM_PROC(s_lock_mutex, "lock-mutex", 1, 0, 0, scm_lock_mutex);
88 SCM_PROC(s_unlock_mutex, "unlock-mutex", 1, 0, 0, scm_unlock_mutex);
89 SCM_PROC(s_make_condition_variable, "make-condition-variable", 0, 0, 0, scm_make_condition_variable);
90 SCM_PROC(s_wait_condition_variable, "wait-condition-variable", 2, 0, 0, scm_wait_condition_variable);
91 SCM_PROC(s_signal_condition_variable, "signal-condition-variable", 1, 0, 0, scm_signal_condition_variable);
92
93 \f
94
95 #ifdef USE_MIT_PTHREADS
96 #include "mit-pthreads.c"
97 #endif
98
99 #ifdef USE_COOP_THREADS
100 #include "coop-threads.c"
101 #endif
102
103 static int
104 print_thread (exp, port, pstate)
105 SCM exp;
106 SCM port;
107 scm_print_state *pstate;
108 {
109 scm_puts ("#<thread ", port);
110 scm_intprint (SCM_CDR (exp), 16, port);
111 scm_putc ('>', port);
112 return 1;
113 }
114
115 static scm_smobfuns thread_smob =
116 {
117 0,
118 scm_threads_free_thread,
119 print_thread,
120 0
121 };
122
123 static int
124 print_mutex (exp, port, pstate)
125 SCM exp;
126 SCM port;
127 scm_print_state *pstate;
128 {
129 scm_puts ("#<mutex ", port);
130 scm_intprint (SCM_CDR (exp), 16, port);
131 scm_putc ('>', port);
132 return 1;
133 }
134
135 static scm_smobfuns mutex_smob =
136 {
137 0,
138 scm_threads_free_mutex,
139 print_mutex,
140 0
141 };
142
143 static int
144 print_condvar (exp, port, pstate)
145 SCM exp;
146 SCM port;
147 scm_print_state *pstate;
148 {
149 scm_puts ("#<condition-variable ", port);
150 scm_intprint (SCM_CDR (exp), 16, port);
151 scm_putc ('>', port);
152 return 1;
153 }
154
155 static scm_smobfuns condvar_smob =
156 {
157 0,
158 scm_threads_free_condvar,
159 print_condvar,
160 0
161 };
162
163 \f
164
165 #ifdef __STDC__
166 void
167 scm_init_threads (SCM_STACKITEM *i)
168 #else
169 void
170 scm_init_threads (i)
171 SCM_STACKITEM *i;
172 #endif
173 {
174 scm_tc16_thread = scm_newsmob (&thread_smob);
175 scm_tc16_mutex = scm_newsmob (&mutex_smob);
176 scm_tc16_condvar = scm_newsmob (&condvar_smob);
177 #include "threads.x"
178 /* Initialize implementation specific details of the threads support */
179 scm_threads_init (i);
180 }