1 /* Copyright (C) 2001, 2006, 2009 Free Software Foundation, Inc.
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.
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.
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
28 #include "libguile/_scm.h"
30 #include "libguile/deprecation.h"
31 #include "libguile/strings.h"
32 #include "libguile/ports.h"
34 /* Windows defines. */
36 # define vsnprintf _vsnprintf
37 #elif !HAVE_DECL_VSNPRINTF
38 extern int vsnprintf (char *, size_t, const char *, va_list);
43 struct issued_warning {
44 struct issued_warning *prev;
48 static struct issued_warning *issued_warnings;
49 static int print_summary = 0;
52 scm_c_issue_deprecation_warning (const char *msg)
54 if (!SCM_WARN_DEPRECATED)
58 struct issued_warning *iw;
59 for (iw = issued_warnings; iw; iw = iw->prev)
60 if (!strcmp (iw->message, msg))
63 fprintf (stderr, "%s\n", msg);
66 scm_puts (msg, scm_current_error_port ());
67 scm_newline (scm_current_error_port ());
70 iw = malloc (sizeof (struct issued_warning));
71 if (msg == NULL || iw == NULL)
74 iw->prev = issued_warnings;
80 scm_c_issue_deprecation_warning_fmt (const char *msg, ...)
86 vsnprintf (buf, 511, msg, ap);
89 scm_c_issue_deprecation_warning (buf);
92 SCM_DEFINE(scm_issue_deprecation_warning,
93 "issue-deprecation-warning", 0, 0, 1,
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
102 if (!SCM_WARN_DEPRECATED)
106 SCM nl = scm_from_locale_string ("\n");
107 SCM msgs_nl = SCM_EOL;
109 while (scm_is_pair (msgs))
111 if (msgs_nl != SCM_EOL)
112 msgs_nl = scm_cons (nl, msgs_nl);
113 msgs_nl = scm_cons (SCM_CAR (msgs), msgs_nl);
114 msgs = SCM_CDR (msgs);
116 msgs_nl = scm_string_append (scm_reverse_x (msgs_nl, SCM_EOL));
117 c_msgs = scm_to_locale_string (msgs_nl);
118 scm_c_issue_deprecation_warning (c_msgs);
121 return SCM_UNSPECIFIED;
126 print_deprecation_summary (void)
131 "Some deprecated features have been used. Set the environment\n"
132 "variable GUILE_WARN_DEPRECATED to \"detailed\" and rerun the\n"
133 "program to get more information. Set it to \"no\" to suppress\n"
134 "this message.\n", stderr);
138 SCM_DEFINE(scm_include_deprecated_features,
139 "include-deprecated-features", 0, 0, 0,
141 "Return @code{#t} iff deprecated features should be included "
142 "in public interfaces.")
143 #define FUNC_NAME s_scm_include_deprecated_features
145 return scm_from_bool (SCM_ENABLE_DEPRECATED == 1);
153 scm_init_deprecation ()
155 const char *level = getenv ("GUILE_WARN_DEPRECATED");
157 level = SCM_WARN_DEPRECATED_DEFAULT;
158 if (!strcmp (level, "detailed"))
159 SCM_WARN_DEPRECATED = 1;
160 else if (!strcmp (level, "no"))
161 SCM_WARN_DEPRECATED = 0;
164 SCM_WARN_DEPRECATED = 0;
165 atexit (print_deprecation_summary);
167 #include "libguile/deprecation.x"