libguile/deprecation.c

   1 /* Copyright (C) 2001, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 #include "libguile/private-options.h"
  35
  36
  37 /* Windows defines. */
  38 #ifdef __MINGW32__
  39 #define vsnprintf _vsnprintf
  40 #endif
  41
  42 \f
  43
  44 #if (SCM_ENABLE_DEPRECATED == 1)
  45
  46 struct issued_warning {
  47   struct issued_warning *prev;
  48   const char *message;
  49 };
  50
  51 static struct issued_warning *issued_warnings;
  52 static int print_summary = 0;
  53
  54 void
  55 scm_c_issue_deprecation_warning (const char *msg)
  56 {
  57   if (!SCM_WARN_DEPRECATED)
  58     print_summary = 1;
  59   else
  60     {
  61       struct issued_warning *iw;
  62       for (iw = issued_warnings; iw; iw = iw->prev)
  63         if (!strcmp (iw->message, msg))
  64           return;
  65       if (scm_gc_running_p)
  66         fprintf (stderr, "%s\n", msg);
  67       else
  68         {
  69           scm_puts (msg, scm_current_error_port ());
  70           scm_newline (scm_current_error_port ());
  71         }
  72       msg = strdup (msg);
  73       iw = malloc (sizeof (struct issued_warning));
  74       if (msg == NULL || iw == NULL)
  75         return;
  76       iw->message = msg;
  77       iw->prev = issued_warnings;
  78       issued_warnings = iw;
  79     }
  80 }
  81
  82 void
  83 scm_c_issue_deprecation_warning_fmt (const char *msg, ...)
  84 {
  85   va_list ap;
  86   char buf[512];
  87
  88   va_start (ap, msg);
  89   vsnprintf (buf, 511, msg, ap);
  90   va_end (ap);
  91   buf[511] = '\0';
  92   scm_c_issue_deprecation_warning (buf);
  93 }
  94
  95 SCM_DEFINE(scm_issue_deprecation_warning,
  96            "issue-deprecation-warning", 0, 0, 1,
  97            (SCM msgs),
  98            "Output @var{msgs} to @code{(current-error-port)} when this "
  99            "is the first call to @code{issue-deprecation-warning} with "
 100            "this specific @var{msgs}.  Do nothing otherwise. "
 101            "The argument @var{msgs} should be a list of strings; "
 102            "they are printed in turn, each one followed by a newline.")
 103 #define FUNC_NAME s_scm_issue_deprecation_warning
 104 {
 105   if (!SCM_WARN_DEPRECATED)
 106     print_summary = 1;
 107   else
 108     {
 109       SCM nl = scm_from_locale_string ("\n");
 110       SCM msgs_nl = SCM_EOL;
 111       char *c_msgs;
 112       while (scm_is_pair (msgs))
 113         {
 114           if (msgs_nl != SCM_EOL)
 115             msgs_nl = scm_cons (nl, msgs_nl);
 116           msgs_nl = scm_cons (SCM_CAR (msgs), msgs_nl);
 117           msgs = SCM_CDR (msgs);
 118         }
 119       msgs_nl = scm_string_append (scm_reverse_x (msgs_nl, SCM_EOL));
 120       c_msgs = scm_to_locale_string (msgs_nl);
 121       scm_c_issue_deprecation_warning (c_msgs);
 122       free (c_msgs);
 123     }
 124   return SCM_UNSPECIFIED;
 125 }
 126 #undef FUNC_NAME
 127
 128 static void
 129 print_deprecation_summary (void)
 130 {
 131   if (print_summary)
 132     {
 133       fputs ("\n"
 134              "Some deprecated features have been used.  Set the environment\n"
 135              "variable GUILE_WARN_DEPRECATED to \"detailed\" and rerun the\n"
 136              "program to get more information.  Set it to \"no\" to suppress\n"
 137              "this message.\n", stderr);
 138     }
 139 }
 140
 141 #endif /* SCM_ENABLE_DEPRECATED == 1 */
 142
 143 SCM_DEFINE(scm_include_deprecated_features,
 144            "include-deprecated-features", 0, 0, 0,
 145            (),
 146            "Return @code{#t} iff deprecated features should be included "
 147            "in public interfaces.")
 148 #define FUNC_NAME s_scm_include_deprecated_features
 149 {
 150   return scm_from_bool (SCM_ENABLE_DEPRECATED == 1);
 151 }
 152 #undef FUNC_NAME
 153
 154
 155 \f
 156
 157 void
 158 scm_init_deprecation ()
 159 {
 160 #if (SCM_ENABLE_DEPRECATED == 1)
 161   const char *level = getenv ("GUILE_WARN_DEPRECATED");
 162   if (level == NULL)
 163     level = SCM_WARN_DEPRECATED_DEFAULT;
 164   if (!strcmp (level, "detailed"))
 165     SCM_WARN_DEPRECATED = 1;
 166   else if (!strcmp (level, "no"))
 167     SCM_WARN_DEPRECATED = 0;
 168   else
 169     {
 170       SCM_WARN_DEPRECATED = 0;
 171       atexit (print_deprecation_summary);
 172     }
 173 #endif
 174 #include "libguile/deprecation.x"
 175 }
 176
 177 /*
 178   Local Variables:
 179   c-file-style: "gnu"
 180   End: */