Merge branch 'g-clear-pointer-no-side-effects' into 'master'
[glib.git] / docs / reference / glib / glib-overrides.txt
blob991fcf2d0a87ed0aed949d9fc1453f95370f4435
1 # This file makes most of the thread related macros look like
2 # functions, which they really were, if possible easy.
4 <MACRO>
5 <NAME>GLIB_DISABLE_DEPRECATION_WARNINGS</NAME>
6 #ifdef GLIB_DISABLE_DEPRECATION_WARNINGS
7 </MACRO>
9 <MACRO>
10 <NAME>G_ATOMIC_LOCK_FREE</NAME>
11 #define G_ATOMIC_LOCK_FREE
12 </MACRO>
14 # default thread implementation
16 <MACRO>
17 <NAME>G_THREADS_IMPL_POSIX</NAME>
18 #define G_THREADS_IMPL_POSIX
19 </MACRO>
21 <MACRO>
22 <NAME>G_THREADS_IMPL_WIN32</NAME>
23 #define G_THREADS_IMPL_NONE
24 </MACRO>
26 # threads supported?
28 <FUNCTION>
29 <NAME>g_thread_supported</NAME>
30 <RETURNS>gboolean</RETURNS>
31 </FUNCTION>
33 # GMutex
35 <FUNCTION>
36 <NAME>g_mutex_new</NAME>
37 <RETURNS>GMutex *</RETURNS>
38 </FUNCTION>
40 <FUNCTION>
41 <NAME>g_mutex_lock</NAME>
42 <RETURNS>void</RETURNS>
43 GMutex *mutex
44 </FUNCTION>
46 <FUNCTION>
47 <NAME>g_mutex_trylock</NAME>
48 <RETURNS>gboolean</RETURNS>
49 GMutex *mutex
50 </FUNCTION>
52 <FUNCTION>
53 <NAME>g_mutex_unlock</NAME>
54 <RETURNS>void</RETURNS>
55 GMutex *mutex
56 </FUNCTION>
58 <FUNCTION>
59 <NAME>g_mutex_free</NAME>
60 <RETURNS>void</RETURNS>
61 GMutex *mutex
62 </FUNCTION>
64 # GStaticMutex
66 <STRUCT>
67 <NAME>GStaticMutex</NAME>
68 </STRUCT>
70 <MACRO>
71 <NAME>G_STATIC_MUTEX_INIT</NAME>
72 #define G_STATIC_MUTEX_INIT
73 </MACRO>
75 <FUNCTION>
76 <NAME>g_static_mutex_lock</NAME>
77 <RETURNS>void</RETURNS>
78 GStaticMutex* mutex
79 </FUNCTION>
81 <FUNCTION>
82 <NAME>g_static_mutex_trylock</NAME>
83 <RETURNS>gboolean</RETURNS>
84 GStaticMutex* mutex
85 </FUNCTION>
87 <FUNCTION>
88 <NAME>g_static_mutex_unlock</NAME>
89 <RETURNS>void</RETURNS>
90 GStaticMutex* mutex
91 </FUNCTION>
93 <FUNCTION>
94 <NAME>g_static_mutex_get_mutex</NAME>
95 <RETURNS>GMutex *</RETURNS>
96 GStaticMutex* mutex
97 </FUNCTION>
99 # GThread
101 <FUNCTION>
102 <NAME>g_thread_yield</NAME>
103 <RETURNS>void</RETURNS>
104 </FUNCTION>
106 <FUNCTION>
107 <NAME>g_thread_create</NAME>
108 <RETURNS>GThread *</RETURNS>
109 GThreadFunc func
110 gpointer data,
111 gboolean joinable,
112 GError **error
113 </FUNCTION>
115 # G_LOCK_* macros
117 <MACRO>
118 <NAME>G_LOCK_DEFINE</NAME>
119 #define G_LOCK_DEFINE(name)    
120 </MACRO>
122 <MACRO>
123 <NAME>G_LOCK_DEFINE_STATIC</NAME>
124 #define G_LOCK_DEFINE_STATIC(name)
125 </MACRO>
127 <MACRO>
128 <NAME>G_LOCK_EXTERN</NAME>
129 #define G_LOCK_EXTERN(name)    
130 </MACRO>
132 <MACRO>
133 <NAME>G_LOCK</NAME>
134 #define G_LOCK(name)
135 </MACRO>
137 <MACRO>
138 <NAME>G_UNLOCK</NAME>
139 #define G_UNLOCK(name)
140 </MACRO>
142 <MACRO>
143 <NAME>G_TRYLOCK</NAME>
144 #define G_TRYLOCK(name)
145 </MACRO>
147 # GCond
149 <FUNCTION>
150 <NAME>g_cond_new</NAME>
151 <RETURNS>GCond*</RETURNS>
152 </FUNCTION>
154 <FUNCTION>
155 <NAME>g_cond_signal</NAME>
156 <RETURNS>void</RETURNS>
157 GCond *cond
158 </FUNCTION>
160 <FUNCTION>
161 <NAME>g_cond_broadcast</NAME>
162 <RETURNS>void</RETURNS>
163 GCond *cond
164 </FUNCTION>
166 <FUNCTION>
167 <NAME>g_cond_wait</NAME>
168 <RETURNS>void</RETURNS>
169 GCond *cond, GMutex *mutex
170 </FUNCTION>
172 <FUNCTION>
173 <NAME>g_cond_timed_wait</NAME>
174 <RETURNS>gboolean</RETURNS>
175 GCond *cond, GMutex *mutex, GTimeVal *abs_time
176 </FUNCTION>
178 <FUNCTION>
179 <NAME>g_cond_free</NAME>
180 <RETURNS>void</RETURNS>
181 GCond *cond
182 </FUNCTION>
184 # GPrivate
185 <MACRO>
186 <NAME>G_PRIVATE_INIT</NAME>
187 #define G_PRIVATE_INIT(notify)
188 </MACRO>
190 # GStaticPrivate
192 <MACRO>
193 <NAME>G_STATIC_PRIVATE_INIT</NAME>
194 #define G_STATIC_PRIVATE_INIT 
195 </MACRO>
197 # Definitions for different operating systems
199 <MACRO>
200 <NAME>G_OS_UNIX</NAME>
201 #define G_OS_UNIX
202 </MACRO>
204 <MACRO>
205 <NAME>G_OS_WIN32</NAME>
206 #define G_OS_WIN32
207 </MACRO>
209 # g_ascii_isxxx
211 <FUNCTION>
212 <NAME>g_ascii_isalnum</NAME>
213 <RETURNS>gboolean</RETURNS>
214 gchar c
215 </FUNCTION>
217 <FUNCTION>
218 <NAME>g_ascii_isalpha</NAME>
219 <RETURNS>gboolean</RETURNS>
220 gchar c
221 </FUNCTION>
223 <FUNCTION>
224 <NAME>g_ascii_iscntrl</NAME>
225 <RETURNS>gboolean</RETURNS>
226 gchar c
227 </FUNCTION>
229 <FUNCTION>
230 <NAME>g_ascii_isdigit</NAME>
231 <RETURNS>gboolean</RETURNS>
232 gchar c
233 </FUNCTION>
235 <FUNCTION>
236 <NAME>g_ascii_isgraph</NAME>
237 <RETURNS>gboolean</RETURNS>
238 gchar c
239 </FUNCTION>
241 <FUNCTION>
242 <NAME>g_ascii_islower</NAME>
243 <RETURNS>gboolean</RETURNS>
244 gchar c
245 </FUNCTION>
247 <FUNCTION>
248 <NAME>g_ascii_isprint</NAME>
249 <RETURNS>gboolean</RETURNS>
250 gchar c
251 </FUNCTION>
253 <FUNCTION>
254 <NAME>g_ascii_ispunct</NAME>
255 <RETURNS>gboolean</RETURNS>
256 gchar c
257 </FUNCTION>
259 <FUNCTION>
260 <NAME>g_ascii_isspace</NAME>
261 <RETURNS>gboolean</RETURNS>
262 gchar c
263 </FUNCTION>
265 <FUNCTION>
266 <NAME>g_ascii_isupper</NAME>
267 <RETURNS>gboolean</RETURNS>
268 gchar c
269 </FUNCTION>
271 <FUNCTION>
272 <NAME>g_ascii_isxdigit</NAME>
273 <RETURNS>gboolean</RETURNS>
274 gchar c
275 </FUNCTION>
277 # g_atomic
279 <FUNCTION>
280 <NAME>g_atomic_int_inc</NAME>
281 <RETURNS>void</RETURNS>
282 gint *atomic
283 </FUNCTION>
285 <FUNCTION>
286 <NAME>g_atomic_int_dec_and_test</NAME>
287 <RETURNS>gboolean</RETURNS>
288 gint *atomic
289 </FUNCTION>
291 <MACRO>
292 <NAME>G_VA_COPY</NAME>
293 #define G_VA_COPY(ap1,ap2)    
294 </MACRO>