REPL Server: Don't establish a SIGINT handler.
[bpt/guile.git] / libguile / options.c
index ade12e2..0e08314 100644 (file)
@@ -1,52 +1,31 @@
-/*     Copyright (C) 1995,1996 Mikael Djurfeldt
+/* Copyright (C) 1995,1996,1998,2000,2001, 2006, 2008, 2009, 2010 Free Software Foundation
  * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
- *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
- *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.
- *
- * The author can be reached at djurfeldt@nada.kth.se
- * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
  */
+
 \f
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
 
-#include <stdio.h>
-#include "_scm.h"
+#include "libguile/_scm.h"
+#include "libguile/mallocs.h"
+#include "libguile/strings.h"
 
-#include "options.h"
+#include "libguile/options.h"
 \f
 
 /* {Run-time options}
 SCM_SYMBOL (scm_yes_sym, "yes");
 SCM_SYMBOL (scm_no_sym, "no");
 
+static SCM protected_objects = SCM_EOL;
 
-SCM
-scm_options (new_mode, options, n, s)
-     SCM new_mode;
-     scm_option options[];
-     int n;
-     char *s;
+/* Return a list of the current option setting.  The format of an
+ * option setting is described in the above documentation.  */
+static SCM
+get_option_setting (const scm_t_option options[])
 {
-  int i, docp = (!SCM_UNBNDP (new_mode)
-                && (SCM_IMP (new_mode) || SCM_NCONSP (new_mode)));
-  SCM ans = SCM_EOL, ls;
-  for (i = 0; i < n; ++i)
+  unsigned int i;
+  SCM ls = SCM_EOL;
+  for (i = 0; options[i].name; ++i)
     {
-      ls = docp ? scm_cons ((SCM) options[i].doc, SCM_EOL) : ans;
       switch (options[i].type)
        {
        case SCM_OPTION_BOOLEAN:
-         if (docp)
-           ls = scm_cons ((int) options[i].val
-                          ? scm_yes_sym
-                          : scm_no_sym,
-                          ls);
+         if (options[i].val)
+           ls = scm_cons (SCM_PACK (options[i].name), ls);
          break;
        case SCM_OPTION_INTEGER:
-         ls = scm_cons (SCM_MAKINUM ((int) options[i].val), ls);
+         ls = scm_cons (scm_from_unsigned_integer (options[i].val), ls);
+         ls = scm_cons (SCM_PACK (options[i].name), ls);
          break;
        case SCM_OPTION_SCM:
-         ls = scm_cons ((SCM) options[i].val, ls);
+         ls = scm_cons (SCM_PACK (options[i].val), ls);
+         ls = scm_cons (SCM_PACK (options[i].name), ls);
        }
-      if (!((options[i].type == SCM_OPTION_BOOLEAN)
-           && !docp
-           && ! (int) options[i].val))
-       ls = scm_cons ((SCM) options[i].name, ls);
-      ans = docp ? scm_cons (ls, ans) : ls;
     }
-  if (!(SCM_UNBNDP (new_mode) || docp))
+  return ls;
+}
+
+
+/* Return a list of sublists, where each sublist contains option name, value
+ * and documentation string.  */
+static SCM
+get_documented_option_setting (const scm_t_option options[])
+{
+  SCM ans = SCM_EOL;
+  unsigned int i;
+
+  for (i = 0; options[i].name; ++i)
+    {
+      SCM ls = scm_cons (scm_from_locale_string (options[i].doc), SCM_EOL);
+      switch (options[i].type)
+       {
+       case SCM_OPTION_BOOLEAN:
+         ls = scm_cons (options[i].val ? scm_yes_sym : scm_no_sym, ls);
+         break;
+       case SCM_OPTION_INTEGER:
+         ls = scm_cons (scm_from_unsigned_integer (options[i].val), ls);
+         break;
+       case SCM_OPTION_SCM:
+         ls = scm_cons (SCM_PACK (options[i].val), ls);
+       }
+      ls = scm_cons (SCM_PACK (options[i].name), ls);
+      ans = scm_cons (ls, ans);
+    }
+  return scm_reverse_x (ans, SCM_UNDEFINED);
+}
+
+
+static int
+options_length (scm_t_option options[])
+{
+  unsigned int i = 0;
+  for (; options[i].name != NULL; ++i)
+    ;
+
+  return i;
+}
+
+/* Alters options according to the given option setting 'args'.  The value of
+ * args is known to be a list, but it is not known whether the list is a well
+ * formed option setting, i. e. if for every non-boolean option a value is
+ * given.  For this reason, the function applies all changes to a copy of the
+ * original setting in memory.  Only if 'args' was successfully processed,
+ * the new setting will overwrite the old one.
+ *
+ * If DRY_RUN is set, don't change anything. This is useful for trying out an option
+ * before entering a critical section.
+ */
+static void
+change_option_setting (SCM args, scm_t_option options[], const char *s,
+                      int dry_run)
+{
+  unsigned int i;
+  SCM locally_protected_args = args;
+  SCM malloc_obj = scm_malloc_obj (options_length (options) * sizeof (scm_t_bits));
+  scm_t_bits *flags = (scm_t_bits *) SCM_MALLOCDATA (malloc_obj);
+
+  for (i = 0; options[i].name; ++i)
+    {
+      if (options[i].type == SCM_OPTION_BOOLEAN)
+       flags[i] = 0;
+      else
+       flags[i] = options[i].val;
+    }
+
+  while (!SCM_NULL_OR_NIL_P (args))
     {
-      unsigned long *flags;
-      flags = (unsigned long *) scm_must_malloc (n * sizeof (unsigned long),
-                                                "mode buffer");
-      for (i = 0; i < n; ++i)
-       if (options[i].type == SCM_OPTION_BOOLEAN)
-         flags[i] = 0;
-       else
-         flags[i] = (unsigned long) options[i].val;
-      while (SCM_NNULLP (new_mode))
+      SCM name = SCM_CAR (args);
+      int found = 0;
+
+      for (i = 0; options[i].name && !found; ++i)
        {
-         SCM_ASSERT (SCM_NIMP (new_mode) && SCM_CONSP (new_mode),
-                     new_mode,
-                     SCM_ARG1,
-                     s);
-         for (i = 0; i < n; ++i)
-           if (SCM_CAR (new_mode) == (SCM) options[i].name)
+         if (scm_is_eq (name, SCM_PACK (options[i].name)))
+           {
              switch (options[i].type)
                {
                case SCM_OPTION_BOOLEAN:
                  flags[i] = 1;
-                 goto cont;
+                 break;
                case SCM_OPTION_INTEGER:
-                 new_mode = SCM_CDR (new_mode);
-                 SCM_ASSERT (SCM_NIMP (new_mode)
-                             && SCM_CONSP (new_mode)
-                             && SCM_INUMP (SCM_CAR (new_mode)),
-                             new_mode,
-                             SCM_ARG1,
-                             s);
-                 flags[i] = (unsigned long) SCM_INUM (SCM_CAR (new_mode));
-                 goto cont;
+                 args = SCM_CDR (args);
+                 flags[i] = scm_to_size_t (scm_car (args));
+                 break;
                case SCM_OPTION_SCM:
-                 new_mode = SCM_CDR (new_mode);
-                 flags[i] = SCM_CAR (new_mode);
-                 goto cont;
+                 args = SCM_CDR (args);
+                 flags[i] = SCM_UNPACK (scm_car (args));
+                 break;
                }
-#ifndef RECKLESS
-         scm_must_free ((char *) flags);
-         scm_wta (SCM_CAR (new_mode), "Unknown mode flag", s);
-#endif
-       cont:
-         new_mode = SCM_CDR (new_mode);
+             found = 1;
+           }
        }
-      for (i = 0; i < n; ++i) options[i].val = flags[i];
-      scm_must_free ((char *) flags);
+
+      if (!found)
+       scm_misc_error (s, "Unknown option name: ~S", scm_list_1 (name));
+
+      args = SCM_CDR (args);
+    }
+
+  if (dry_run)
+    return;
+  
+  for (i = 0; options[i].name; ++i)
+    {
+      if (options[i].type == SCM_OPTION_SCM)
+       {
+         SCM old = SCM_PACK (options[i].val);
+         SCM new = SCM_PACK (flags[i]);
+         if (!SCM_IMP (old))
+           protected_objects = scm_delq1_x (old, protected_objects);
+         if (!SCM_IMP (new))
+           protected_objects = scm_cons (new, protected_objects);
+       }
+      options[i].val = flags[i];
+    }
+
+  scm_remember_upto_here_2 (locally_protected_args, malloc_obj);
+}
+
+
+SCM
+scm_options (SCM args, scm_t_option options[], const char *s)
+{
+  return scm_options_try (args, options, s, 0);
+}
+       
+SCM
+scm_options_try (SCM args, scm_t_option options[], const char *s,
+                int dry_run)
+{
+  if (SCM_UNBNDP (args))
+    return get_option_setting (options);
+  else if (!SCM_NULL_OR_NIL_P (args) && !scm_is_pair (args))
+    /* Dirk:FIXME:: This criterion should be improved.  IMO it is better to
+     * demand that args is #t if documentation should be shown than to say
+     * that every argument except a list will print out documentation.  */
+    return get_documented_option_setting (options);
+  else
+    {
+      SCM old_setting;
+      SCM_ASSERT (scm_is_true (scm_list_p (args)), args, 1, s);
+      old_setting = get_option_setting (options);
+      change_option_setting (args, options, s, dry_run);
+      return old_setting;
     }
-  return ans;
 }
 
 
 void
-scm_init_opts (func, options, n)
-     SCM (*func) (SCM);
-     scm_option options[];
-     int n;
+scm_init_opts (SCM (*func) (SCM), scm_t_option options[])
 {
-  int i;
+  unsigned int i;
 
-  for (i = 0; i < n; ++i)
+  for (i = 0; options[i].name; ++i)
     {
-      options[i].name =        (char *) SCM_CAR (scm_sysintern (options[i].name,
-                                                        SCM_UNDEFINED));
-      options[i].doc = (char *) scm_permanent_object (scm_take0str
-                                                     (options[i].doc));
+      SCM name = scm_from_locale_symbol (options[i].name);
+      options[i].name =        (char *) SCM_UNPACK (name);
     }
   func (SCM_UNDEFINED);
 }
@@ -223,5 +288,13 @@ scm_init_opts (func, options, n)
 void
 scm_init_options ()
 {
-#include "options.x"
+  scm_gc_register_root (&protected_objects);
+
+#include "libguile/options.x"
 }
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/