| 1 | /* Copyright (C) 1995, 1996, 1998 Free Software Foundation |
| 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 | * |
| 42 | * The author can be reached at djurfeldt@nada.kth.se |
| 43 | * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */ |
| 44 | |
| 45 | /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999, |
| 46 | gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */ |
| 47 | |
| 48 | \f |
| 49 | |
| 50 | #include <stdio.h> |
| 51 | #include "_scm.h" |
| 52 | |
| 53 | #include "options.h" |
| 54 | \f |
| 55 | |
| 56 | /* {Run-time options} |
| 57 | * |
| 58 | * This is the basic interface for low-level configuration of the |
| 59 | * Guile library. It is used for configuring the reader, evaluator, |
| 60 | * printer and debugger. |
| 61 | * |
| 62 | * Motivation: |
| 63 | * |
| 64 | * 1. Altering option settings can have side effects. |
| 65 | * 2. Option values can be stored in native format. |
| 66 | * (Important for efficiency in, e. g., the evaluator.) |
| 67 | * 3. Doesn't use up name space. |
| 68 | * 4. Options can be naturally grouped => ease of use. |
| 69 | */ |
| 70 | |
| 71 | /* scm_options is the core of all options interface procedures. |
| 72 | * |
| 73 | * Some definitions: |
| 74 | * |
| 75 | * Run time options in Guile are arranged in groups. Each group |
| 76 | * affects a certain aspect of the behaviour of the library. |
| 77 | * |
| 78 | * An "options interface procedure" manages one group of options. It |
| 79 | * can be used to check or set options, or to get documentation for |
| 80 | * all options of a group. The options interface procedure is not |
| 81 | * intended to be called directly by the user. The user should |
| 82 | * instead call |
| 83 | * |
| 84 | * (<group>-options) |
| 85 | * (<group>-options 'help) |
| 86 | * (<group>-options 'full) |
| 87 | * |
| 88 | * to display current option settings (The second version also |
| 89 | * displays documentation. The third version also displays |
| 90 | * information about programmer's options.), and |
| 91 | * |
| 92 | * (<group>-enable '<option-symbol>) |
| 93 | * (<group>-disable '<option-symbol>) |
| 94 | * (<group>-set! <option-symbol> <value>) |
| 95 | * (<group>-options <option setting>) |
| 96 | * |
| 97 | * to alter the state of an option (The last version sets all |
| 98 | * options according to <option setting>.) where <group> is the name |
| 99 | * of the option group. |
| 100 | * |
| 101 | * An "option setting" represents the state of all low-level options |
| 102 | * managed by one options interface procedure. It is a list of |
| 103 | * single symbols and symbols followed by a value. |
| 104 | * |
| 105 | * For boolean options, the presence of the symbol of that option in |
| 106 | * the option setting indicates a true value. If the symbol isn't a |
| 107 | * member of the option setting this represents a false value. |
| 108 | * |
| 109 | * Other options are represented by a symbol followed by the value. |
| 110 | * |
| 111 | * If scm_options is called without arguments, the current option |
| 112 | * setting is returned. If the argument is an option setting, options |
| 113 | * are altered and the old setting is returned. If the argument isn't |
| 114 | * a list, a list of sublists is returned, where each sublist contains |
| 115 | * option name, value and documentation string. |
| 116 | */ |
| 117 | |
| 118 | SCM_SYMBOL (scm_yes_sym, "yes"); |
| 119 | SCM_SYMBOL (scm_no_sym, "no"); |
| 120 | |
| 121 | static SCM protected_objects; |
| 122 | |
| 123 | SCM |
| 124 | scm_options (SCM arg, scm_option options[], int n, const char *s) |
| 125 | { |
| 126 | int i, docp = (!SCM_UNBNDP (arg) |
| 127 | && !SCM_NULLP (arg) |
| 128 | && (SCM_IMP (arg) || SCM_NCONSP (arg))); |
| 129 | /* Let `arg' GC protect the arguments */ |
| 130 | SCM new_mode = arg, ans = SCM_EOL, ls; |
| 131 | for (i = 0; i < n; ++i) |
| 132 | { |
| 133 | ls = docp ? scm_cons ((SCM) options[i].doc, SCM_EOL) : ans; |
| 134 | switch (options[i].type) |
| 135 | { |
| 136 | case SCM_OPTION_BOOLEAN: |
| 137 | if (docp) |
| 138 | ls = scm_cons ((int) options[i].val |
| 139 | ? scm_yes_sym |
| 140 | : scm_no_sym, |
| 141 | ls); |
| 142 | break; |
| 143 | case SCM_OPTION_INTEGER: |
| 144 | ls = scm_cons (SCM_MAKINUM ((int) options[i].val), ls); |
| 145 | break; |
| 146 | case SCM_OPTION_SCM: |
| 147 | ls = scm_cons ((SCM) options[i].val, ls); |
| 148 | } |
| 149 | if (!((options[i].type == SCM_OPTION_BOOLEAN) |
| 150 | && !docp |
| 151 | && ! (int) options[i].val)) |
| 152 | ls = scm_cons ((SCM) options[i].name, ls); |
| 153 | ans = docp ? scm_cons (ls, ans) : ls; |
| 154 | } |
| 155 | if (!(SCM_UNBNDP (new_mode) || docp)) |
| 156 | { |
| 157 | unsigned long *flags; |
| 158 | flags = (unsigned long *) scm_must_malloc (n * sizeof (unsigned long), |
| 159 | "mode buffer"); |
| 160 | for (i = 0; i < n; ++i) |
| 161 | if (options[i].type == SCM_OPTION_BOOLEAN) |
| 162 | flags[i] = 0; |
| 163 | else |
| 164 | flags[i] = (unsigned long) options[i].val; |
| 165 | while (SCM_NNULLP (new_mode)) |
| 166 | { |
| 167 | SCM_ASSERT (SCM_CONSP (new_mode), |
| 168 | new_mode, |
| 169 | SCM_ARG1, |
| 170 | s); |
| 171 | for (i = 0; i < n; ++i) |
| 172 | if (SCM_CAR (new_mode) == (SCM) options[i].name) |
| 173 | switch (options[i].type) |
| 174 | { |
| 175 | case SCM_OPTION_BOOLEAN: |
| 176 | flags[i] = 1; |
| 177 | goto cont; |
| 178 | case SCM_OPTION_INTEGER: |
| 179 | new_mode = SCM_CDR (new_mode); |
| 180 | SCM_ASSERT ( SCM_CONSP (new_mode) |
| 181 | && SCM_INUMP (SCM_CAR (new_mode)), |
| 182 | new_mode, |
| 183 | SCM_ARG1, |
| 184 | s); |
| 185 | flags[i] = (unsigned long) SCM_INUM (SCM_CAR (new_mode)); |
| 186 | goto cont; |
| 187 | case SCM_OPTION_SCM: |
| 188 | new_mode = SCM_CDR (new_mode); |
| 189 | flags[i] = SCM_UNPACK_CAR (new_mode); |
| 190 | goto cont; |
| 191 | } |
| 192 | #ifndef SCM_RECKLESS |
| 193 | scm_must_free ((char *) flags); |
| 194 | scm_wta (SCM_CAR (new_mode), "Unknown mode flag", s); |
| 195 | #endif |
| 196 | cont: |
| 197 | new_mode = SCM_CDR (new_mode); |
| 198 | } |
| 199 | for (i = 0; i < n; ++i) |
| 200 | { |
| 201 | // scm_option doesn't know if its a long or an SCM |
| 202 | if (options[i].type == SCM_OPTION_SCM) |
| 203 | SCM_SETCDR (protected_objects, |
| 204 | scm_cons (SCM_PACK(flags[i]), |
| 205 | scm_delq1_x (SCM_PACK(options[i].val), |
| 206 | SCM_CDR (protected_objects)))); |
| 207 | options[i].val = flags[i]; |
| 208 | } |
| 209 | scm_must_free ((char *) flags); |
| 210 | } |
| 211 | return ans; |
| 212 | } |
| 213 | |
| 214 | |
| 215 | void |
| 216 | scm_init_opts (SCM (*func) (SCM), scm_option options[], int n) |
| 217 | { |
| 218 | int i; |
| 219 | |
| 220 | for (i = 0; i < n; ++i) |
| 221 | { |
| 222 | options[i].name = (char *) SCM_CAR (scm_sysintern0 (options[i].name)); |
| 223 | options[i].doc = (char *) scm_permanent_object (scm_take0str |
| 224 | (options[i].doc)); |
| 225 | if (options[i].type == SCM_OPTION_SCM) |
| 226 | SCM_SETCDR (protected_objects, |
| 227 | scm_cons (SCM_PACK(options[i].val), SCM_CDR (protected_objects))); |
| 228 | } |
| 229 | func (SCM_UNDEFINED); |
| 230 | } |
| 231 | |
| 232 | |
| 233 | void |
| 234 | scm_init_options () |
| 235 | { |
| 236 | protected_objects = scm_permanent_object (scm_cons (SCM_UNDEFINED, SCM_EOL)); |
| 237 | #include "options.x" |
| 238 | } |