Commit | Line | Data |
---|---|---|
9482a297 MV |
1 | /* classes: h_files */ |
2 | ||
dee01b01 DH |
3 | #ifndef SCM_FLUIDS_H |
4 | #define SCM_FLUIDS_H | |
9482a297 | 5 | |
aafb4ed7 | 6 | /* Copyright (C) 1996,2000,2001, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. |
dee01b01 | 7 | * |
73be1d9e | 8 | * This library is free software; you can redistribute it and/or |
53befeb7 NJ |
9 | * modify it under the terms of the GNU Lesser General Public License |
10 | * as published by the Free Software Foundation; either version 3 of | |
11 | * the License, or (at your option) any later version. | |
dee01b01 | 12 | * |
53befeb7 NJ |
13 | * This library is distributed in the hope that it will be useful, but |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
73be1d9e MV |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 | * Lesser General Public License for more details. | |
dee01b01 | 17 | * |
73be1d9e MV |
18 | * You should have received a copy of the GNU Lesser General Public |
19 | * License along with this library; if not, write to the Free Software | |
53befeb7 NJ |
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
21 | * 02110-1301 USA | |
73be1d9e | 22 | */ |
9482a297 | 23 | |
dee01b01 | 24 | \f |
d3a6bc94 | 25 | |
9482a297 MV |
26 | #include "libguile/__scm.h" |
27 | #include "libguile/root.h" | |
28 | #include "libguile/vectors.h" | |
29 | ||
bb0229b5 AW |
30 | /* These "with-fluids" objects live on the dynamic stack, and record previous |
31 | values of fluids. Guile uses shallow binding, so the current fluid values are | |
32 | always in the same place for a given thread, in the dynamic-state vector. | |
33 | */ | |
34 | ||
35 | #define SCM_WITH_FLUIDS_P(x) (!SCM_IMP (x) && SCM_TYP7(x) == scm_tc7_with_fluids) | |
36 | #define SCM_WITH_FLUIDS_LEN(x) (SCM_CELL_WORD ((x), 0) >> 8) | |
37 | #define SCM_WITH_FLUIDS_NTH_FLUID(x,n) (SCM_CELL_OBJECT ((x), 1 + (n)*2)) | |
38 | #define SCM_WITH_FLUIDS_NTH_VAL(x,n) (SCM_CELL_OBJECT ((x), 2 + (n)*2)) | |
39 | #define SCM_WITH_FLUIDS_SET_NTH_VAL(x,n,v) (SCM_SET_CELL_OBJECT ((x), 2 + (n)*2, (v))) | |
40 | ||
41 | ||
9482a297 MV |
42 | /* Fluids. |
43 | ||
9ea31741 AW |
44 | Fluids are objects of a certain type that can hold one SCM value per |
45 | dynamic state. That is, modifications to this value are only visible | |
46 | to code that executes with the same dynamic state as the modifying | |
47 | code. When a new dynamic state is constructed, it inherits the | |
48 | values from its parent. Because each thread executes with its own | |
49 | dynamic state, you can use fluids for thread local storage. | |
50 | ||
51 | Each fluid is identified by a small integer. This integer is used to | |
52 | index a vector that holds the values of all fluids. A dynamic state | |
53 | consists of this vector, wrapped in an object so that the vector can | |
54 | grow. | |
9de87eea | 55 | */ |
9482a297 | 56 | |
6f8d7b12 AW |
57 | #define SCM_FLUID_P(x) (!SCM_IMP (x) && SCM_TYP7 (x) == scm_tc7_fluid) |
58 | #ifdef BUILDING_LIBGUILE | |
aafb4ed7 AW |
59 | #define SCM_I_FLUID_NUM(x) ((size_t)(SCM_CELL_WORD_0 (x) >> 8)) |
60 | #define SCM_I_FLUID_DEFAULT(x) (SCM_CELL_OBJECT_1 (x)) | |
6f8d7b12 | 61 | #endif |
9482a297 | 62 | |
33b001fd | 63 | SCM_API SCM scm_make_fluid (void); |
aafb4ed7 | 64 | SCM_API SCM scm_make_fluid_with_default (SCM dflt); |
e01163b5 | 65 | SCM_API SCM scm_make_unbound_fluid (void); |
9de87eea | 66 | SCM_API int scm_is_fluid (SCM obj); |
33b001fd MV |
67 | SCM_API SCM scm_fluid_p (SCM fl); |
68 | SCM_API SCM scm_fluid_ref (SCM fluid); | |
69 | SCM_API SCM scm_fluid_set_x (SCM fluid, SCM value); | |
ef94624e BT |
70 | SCM_API SCM scm_fluid_unset_x (SCM fluid); |
71 | SCM_API SCM scm_fluid_bound_p (SCM fluid); | |
9482a297 | 72 | |
bb0229b5 AW |
73 | SCM_INTERNAL SCM scm_i_make_with_fluids (size_t n, SCM *fluids, SCM *vals); |
74 | SCM_INTERNAL void scm_i_swap_with_fluids (SCM with_fluids, SCM dynamic_state); | |
75 | ||
33b001fd MV |
76 | SCM_API SCM scm_c_with_fluids (SCM fluids, SCM vals, |
77 | SCM (*cproc)(void *), void *cdata); | |
78 | SCM_API SCM scm_c_with_fluid (SCM fluid, SCM val, | |
79 | SCM (*cproc)(void *), void *cdata); | |
80 | SCM_API SCM scm_with_fluids (SCM fluids, SCM vals, SCM thunk); | |
bebd3fba | 81 | SCM_API SCM scm_with_fluid (SCM fluid, SCM val, SCM thunk); |
b3460a50 | 82 | |
661ae7ab | 83 | SCM_API void scm_dynwind_fluid (SCM fluid, SCM value); |
ef20bf70 | 84 | |
6f8d7b12 | 85 | #ifdef BUILDING_LIBGUILE |
5ef71027 AW |
86 | #define SCM_I_DYNAMIC_STATE_P(x) (!SCM_IMP (x) && SCM_TYP7 (x) == scm_tc7_dynamic_state) |
87 | #define SCM_I_DYNAMIC_STATE_FLUIDS(x) SCM_PACK (SCM_CELL_WORD_1 (x)) | |
6f8d7b12 | 88 | #endif |
5ef71027 | 89 | |
9de87eea MV |
90 | SCM_API SCM scm_make_dynamic_state (SCM parent); |
91 | SCM_API SCM scm_dynamic_state_p (SCM obj); | |
92 | SCM_API int scm_is_dynamic_state (SCM obj); | |
93 | SCM_API SCM scm_current_dynamic_state (void); | |
94 | SCM_API SCM scm_set_current_dynamic_state (SCM state); | |
661ae7ab | 95 | SCM_API void scm_dynwind_current_dynamic_state (SCM state); |
9de87eea MV |
96 | SCM_API void *scm_c_with_dynamic_state (SCM state, |
97 | void *(*func)(void *), void *data); | |
98 | SCM_API SCM scm_with_dynamic_state (SCM state, SCM proc); | |
99 | ||
102dbb6f | 100 | SCM_INTERNAL SCM scm_i_make_initial_dynamic_state (void); |
9482a297 | 101 | |
9ea31741 | 102 | SCM_INTERNAL void scm_i_fluid_print (SCM exp, SCM port, scm_print_state *pstate); |
45cf2428 | 103 | SCM_INTERNAL void scm_i_dynamic_state_print (SCM exp, SCM port, scm_print_state *pstate); |
bbb2ecd1 | 104 | SCM_INTERNAL void scm_i_with_fluids_print (SCM exp, SCM port, scm_print_state *pstate); |
102dbb6f | 105 | SCM_INTERNAL void scm_init_fluids (void); |
9482a297 | 106 | |
dee01b01 | 107 | #endif /* SCM_FLUIDS_H */ |
89e00824 ML |
108 | |
109 | /* | |
110 | Local Variables: | |
111 | c-file-style: "gnu" | |
112 | End: | |
113 | */ |