1 /* Copyright (C) 1995, 1996, 1998, 2000 Free Software Foundation
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)
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.
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
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
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.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
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.
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.
42 * The author can be reached at djurfeldt@nada.kth.se
43 * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
45 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
46 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
51 #include "libguile/_scm.h"
52 #include "libguile/strings.h"
54 #include "libguile/options.h"
59 * This is the basic interface for low-level configuration of the
60 * Guile library. It is used for configuring the reader, evaluator,
61 * printer and debugger.
65 * 1. Altering option settings can have side effects.
66 * 2. Option values can be stored in native format.
67 * (Important for efficiency in, e. g., the evaluator.)
68 * 3. Doesn't use up name space.
69 * 4. Options can be naturally grouped => ease of use.
72 /* scm_options is the core of all options interface procedures.
76 * Run time options in Guile are arranged in groups. Each group
77 * affects a certain aspect of the behaviour of the library.
79 * An "options interface procedure" manages one group of options. It
80 * can be used to check or set options, or to get documentation for
81 * all options of a group. The options interface procedure is not
82 * intended to be called directly by the user. The user should
86 * (<group>-options 'help)
87 * (<group>-options 'full)
89 * to display current option settings (The second version also
90 * displays documentation. The third version also displays
91 * information about programmer's options.), and
93 * (<group>-enable '<option-symbol>)
94 * (<group>-disable '<option-symbol>)
95 * (<group>-set! <option-symbol> <value>)
96 * (<group>-options <option setting>)
98 * to alter the state of an option (The last version sets all
99 * options according to <option setting>.) where <group> is the name
100 * of the option group.
102 * An "option setting" represents the state of all low-level options
103 * managed by one options interface procedure. It is a list of
104 * single symbols and symbols followed by a value.
106 * For boolean options, the presence of the symbol of that option in
107 * the option setting indicates a true value. If the symbol isn't a
108 * member of the option setting this represents a false value.
110 * Other options are represented by a symbol followed by the value.
112 * If scm_options is called without arguments, the current option
113 * setting is returned. If the argument is an option setting, options
114 * are altered and the old setting is returned. If the argument isn't
115 * a list, a list of sublists is returned, where each sublist contains
116 * option name, value and documentation string.
119 SCM_SYMBOL (scm_yes_sym
, "yes");
120 SCM_SYMBOL (scm_no_sym
, "no");
122 static SCM protected_objects
;
125 scm_options (SCM arg
, scm_option options
[], int n
, const char *s
)
127 int i
, docp
= (!SCM_UNBNDP (arg
) && !SCM_NULLP (arg
) && !SCM_CONSP (arg
));
128 /* Let `arg' GC protect the arguments */
129 SCM new_mode
= arg
, ans
= SCM_EOL
, ls
;
130 for (i
= 0; i
< n
; ++i
)
132 ls
= docp
? scm_cons ((SCM
) options
[i
].doc
, SCM_EOL
) : ans
;
133 switch (options
[i
].type
)
135 case SCM_OPTION_BOOLEAN
:
137 ls
= scm_cons ((int) options
[i
].val
142 case SCM_OPTION_INTEGER
:
143 ls
= scm_cons (SCM_MAKINUM ((int) options
[i
].val
), ls
);
146 ls
= scm_cons ((SCM
) options
[i
].val
, ls
);
148 if (!((options
[i
].type
== SCM_OPTION_BOOLEAN
)
150 && ! (int) options
[i
].val
))
151 ls
= scm_cons ((SCM
) options
[i
].name
, ls
);
152 ans
= docp
? scm_cons (ls
, ans
) : ls
;
154 if (!(SCM_UNBNDP (new_mode
) || docp
))
156 unsigned long *flags
;
157 flags
= (unsigned long *) scm_must_malloc (n
* sizeof (unsigned long),
159 for (i
= 0; i
< n
; ++i
)
160 if (options
[i
].type
== SCM_OPTION_BOOLEAN
)
163 flags
[i
] = (unsigned long) options
[i
].val
;
164 while (SCM_NNULLP (new_mode
))
166 SCM_ASSERT (SCM_CONSP (new_mode
),
170 for (i
= 0; i
< n
; ++i
)
171 if (SCM_CAR (new_mode
) == (SCM
) options
[i
].name
)
172 switch (options
[i
].type
)
174 case SCM_OPTION_BOOLEAN
:
177 case SCM_OPTION_INTEGER
:
178 new_mode
= SCM_CDR (new_mode
);
179 SCM_ASSERT ( SCM_CONSP (new_mode
)
180 && SCM_INUMP (SCM_CAR (new_mode
)),
184 flags
[i
] = (unsigned long) SCM_INUM (SCM_CAR (new_mode
));
187 new_mode
= SCM_CDR (new_mode
);
188 flags
[i
] = SCM_UNPACK (SCM_CAR (new_mode
));
192 scm_must_free ((char *) flags
);
193 scm_wta (SCM_CAR (new_mode
), "Unknown mode flag", s
);
196 new_mode
= SCM_CDR (new_mode
);
198 for (i
= 0; i
< n
; ++i
)
200 /* scm_option doesn't know if its a long or an SCM */
201 if (options
[i
].type
== SCM_OPTION_SCM
)
202 SCM_SETCDR (protected_objects
,
203 scm_cons (SCM_PACK(flags
[i
]),
204 scm_delq1_x (SCM_PACK(options
[i
].val
),
205 SCM_CDR (protected_objects
))));
206 options
[i
].val
= flags
[i
];
208 scm_must_free ((char *) flags
);
215 scm_init_opts (SCM (*func
) (SCM
), scm_option options
[], int n
)
219 for (i
= 0; i
< n
; ++i
)
224 name
= scm_str2symbol (options
[i
].name
);
225 options
[i
].name
= (char *) name
;
226 scm_permanent_object (name
);
227 doc
= scm_take0str (options
[i
].doc
);
228 options
[i
].doc
= (char *) doc
;
229 scm_permanent_object (doc
);
230 if (options
[i
].type
== SCM_OPTION_SCM
)
231 SCM_SETCDR (protected_objects
,
232 scm_cons (SCM_PACK(options
[i
].val
), SCM_CDR (protected_objects
)));
234 func (SCM_UNDEFINED
);
241 protected_objects
= scm_permanent_object (scm_cons (SCM_UNDEFINED
, SCM_EOL
));
242 #ifndef SCM_MAGIC_SNARFER
243 #include "libguile/options.x"