libguile/deprecation.c

   1 /* Copyright (C) 2001 Free Software Foundation, Inc.
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2.1 of the License, or (at your option) any later version.
   7  *
   8  * This library 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 GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16  */
  17
  18 \f
  19
  20 #if HAVE_CONFIG_H
  21 #  include <config.h>
  22 #endif
  23
  24 #include <stdio.h>
  25 #include <string.h>
  26 #include <stdarg.h>
  27
  28 #include "libguile/_scm.h"
  29
  30 #include "libguile/deprecation.h"
  31 #include "libguile/strings.h"
  32 #include "libguile/ports.h"
  33
  34 /* Windows defines. */
  35 #ifdef __MINGW32__
  36 #define vsnprintf _vsnprintf
  37 #endif
  38
  39 \f
  40
  41 #if (SCM_ENABLE_DEPRECATED == 1)
  42
  43 struct issued_warning {
  44   struct issued_warning *prev;
  45   const char *message;
  46 };
  47
  48 static struct issued_warning *issued_warnings;
  49 static enum { detailed, summary, summary_print } mode;
  50
  51 void
  52 scm_c_issue_deprecation_warning (const char *msg)
  53 {
  54   if (mode != detailed)
  55     mode = summary_print;
  56   else
  57     {
  58       struct issued_warning *iw;
  59       for (iw = issued_warnings; iw; iw = iw->prev)
  60         if (!strcmp (iw->message, msg))
  61           return;
  62       if (scm_gc_running_p)
  63         fprintf (stderr, "%s\n", msg);
  64       else
  65         {
  66           scm_puts (msg, scm_current_error_port ());
  67           scm_newline (scm_current_error_port ());
  68         }
  69       msg = strdup (msg);
  70       iw = scm_malloc (sizeof (struct issued_warning));
  71       if (msg == NULL || iw == NULL)
  72         return;
  73       iw->message = msg;
  74       iw->prev = issued_warnings;
  75       issued_warnings = iw;
  76     }
  77 }
  78
  79 void
  80 scm_c_issue_deprecation_warning_fmt (const char *msg, ...)
  81 {
  82   va_list ap;
  83   char buf[512];
  84
  85   va_start (ap, msg);
  86   vsnprintf (buf, 511, msg, ap);
  87   va_end (ap);
  88   buf[511] = '\0';
  89   scm_c_issue_deprecation_warning (buf);
  90 }
  91
  92 SCM_DEFINE(scm_issue_deprecation_warning,
  93            "issue-deprecation-warning", 0, 0, 1,
  94            (SCM msgs),
  95            "Output @var{msgs} to @code{(current-error-port)} when this "
  96            "is the first call to @code{issue-deprecation-warning} with "
  97            "this specific @var{msgs}.  Do nothing otherwise. "
  98            "The argument @var{msgs} should be a list of strings; "
  99            "they are printed in turn, each one followed by a newline.")
 100 #define FUNC_NAME s_scm_issue_deprecation_warning
 101 {
 102   if (mode != detailed)
 103     mode = summary_print;
 104   else
 105     {
 106       SCM nl = scm_str2string ("\n");
 107       SCM msgs_nl = SCM_EOL;
 108       while (SCM_CONSP (msgs))
 109         {
 110           if (msgs_nl != SCM_EOL)
 111             msgs_nl = scm_cons (nl, msgs_nl);
 112           msgs_nl = scm_cons (SCM_CAR (msgs), msgs_nl);
 113           msgs = SCM_CDR (msgs);
 114         }
 115       msgs_nl = scm_string_append (scm_reverse_x (msgs_nl, SCM_EOL));
 116       scm_c_issue_deprecation_warning (SCM_STRING_CHARS (msgs_nl));
 117       scm_remember_upto_here_1 (msgs_nl);
 118     }
 119   return SCM_UNSPECIFIED;
 120 }
 121 #undef FUNC_NAME
 122
 123 static void
 124 print_deprecation_summary (void)
 125 {
 126   if (mode == summary_print)
 127     {
 128       fputs ("\n"
 129              "Some deprecated features have been used.  Set the environment\n"
 130              "variable GUILE_WARN_DEPRECATED to \"detailed\" and rerun the\n"
 131              "program to get more information.  Set it to \"no\" to suppress\n"
 132              "this message.\n", stderr);
 133     }
 134 }
 135
 136 #endif
 137
 138 SCM_DEFINE(scm_include_deprecated_features,
 139            "include-deprecated-features", 0, 0, 0,
 140            (),
 141            "Return @code{#t} iff deprecated features should be included "
 142            "in public interfaces.")
 143 #define FUNC_NAME s_scm_include_deprecated_features
 144 {
 145   return SCM_BOOL (SCM_ENABLE_DEPRECATED == 1);
 146 }
 147 #undef FUNC_NAME
 148
 149
 150 \f
 151
 152 void
 153 scm_init_deprecation ()
 154 {
 155 #if (SCM_ENABLE_DEPRECATED == 1)
 156   const char *level = getenv ("GUILE_WARN_DEPRECATED");
 157   if (level == NULL)
 158     level = SCM_WARN_DEPRECATED_DEFAULT;
 159   if (!strcmp (level, "detailed"))
 160     mode = detailed;
 161   else if (!strcmp (level, "no"))
 162     mode = summary;
 163   else
 164     {
 165       mode = summary;
 166       atexit (print_deprecation_summary);
 167     }
 168 #endif
 169 #include "libguile/deprecation.x"
 170 }
 171
 172 /*
 173   Local Variables:
 174   c-file-style: "gnu"
 175   End: */