Commit | Line | Data |
---|---|---|
5cd06d5e | 1 | /* Copyright (C) 2001 Free Software Foundation, Inc. |
7e516288 | 2 | * |
73be1d9e MV |
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. | |
7e516288 | 7 | * |
73be1d9e MV |
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. | |
7e516288 | 12 | * |
73be1d9e MV |
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 | */ | |
7e516288 MV |
17 | |
18 | \f | |
19 | ||
5f0bcfd5 RB |
20 | #if HAVE_CONFIG_H |
21 | # include <config.h> | |
22 | #endif | |
23 | ||
7e516288 | 24 | #include <stdio.h> |
fbbdb121 | 25 | #include <string.h> |
d013f095 | 26 | #include <stdarg.h> |
7e516288 MV |
27 | |
28 | #include "libguile/_scm.h" | |
29 | ||
30 | #include "libguile/deprecation.h" | |
7e516288 MV |
31 | #include "libguile/strings.h" |
32 | #include "libguile/ports.h" | |
33 | ||
edb810bb SJ |
34 | /* Windows defines. */ |
35 | #ifdef __MINGW32__ | |
36 | #define vsnprintf _vsnprintf | |
37 | #endif | |
38 | ||
7e516288 MV |
39 | \f |
40 | ||
8c494e99 | 41 | #if (SCM_ENABLE_DEPRECATED == 1) |
7e516288 | 42 | |
d013f095 MV |
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; | |
7e516288 MV |
50 | |
51 | void | |
52 | scm_c_issue_deprecation_warning (const char *msg) | |
53 | { | |
d013f095 MV |
54 | if (mode != detailed) |
55 | mode = summary_print; | |
7e516288 | 56 | else |
d013f095 MV |
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); | |
67329a9e | 70 | iw = scm_malloc (sizeof (struct issued_warning)); |
d013f095 MV |
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); | |
11c47357 | 87 | va_end (ap); |
d013f095 MV |
88 | buf[511] = '\0'; |
89 | scm_c_issue_deprecation_warning (buf); | |
7e516288 MV |
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 " | |
d013f095 | 97 | "this specific @var{msgs}. Do nothing otherwise. " |
7e516288 MV |
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 | { | |
d013f095 MV |
102 | if (mode != detailed) |
103 | mode = summary_print; | |
7e516288 MV |
104 | else |
105 | { | |
d013f095 MV |
106 | SCM nl = scm_str2string ("\n"); |
107 | SCM msgs_nl = SCM_EOL; | |
7f9994d9 | 108 | char *c_msgs; |
d013f095 | 109 | while (SCM_CONSP (msgs)) |
7e516288 | 110 | { |
d013f095 MV |
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); | |
7e516288 | 115 | } |
d013f095 | 116 | msgs_nl = scm_string_append (scm_reverse_x (msgs_nl, SCM_EOL)); |
7f9994d9 MV |
117 | c_msgs = scm_to_locale_string (msgs_nl); |
118 | scm_c_issue_deprecation_warning (c_msgs); | |
119 | free (c_msgs); | |
7e516288 MV |
120 | } |
121 | return SCM_UNSPECIFIED; | |
122 | } | |
123 | #undef FUNC_NAME | |
124 | ||
125 | static void | |
126 | print_deprecation_summary (void) | |
127 | { | |
d013f095 | 128 | if (mode == summary_print) |
7e516288 MV |
129 | { |
130 | fputs ("\n" | |
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); | |
135 | } | |
136 | } | |
137 | ||
138 | #endif | |
139 | ||
140 | SCM_DEFINE(scm_include_deprecated_features, | |
141 | "include-deprecated-features", 0, 0, 0, | |
142 | (), | |
7bad99fd MV |
143 | "Return @code{#t} iff deprecated features should be included " |
144 | "in public interfaces.") | |
7e516288 MV |
145 | #define FUNC_NAME s_scm_include_deprecated_features |
146 | { | |
7888309b | 147 | return scm_from_bool (SCM_ENABLE_DEPRECATED == 1); |
7e516288 MV |
148 | } |
149 | #undef FUNC_NAME | |
150 | ||
151 | ||
152 | \f | |
153 | ||
154 | void | |
155 | scm_init_deprecation () | |
156 | { | |
8c494e99 | 157 | #if (SCM_ENABLE_DEPRECATED == 1) |
7e516288 MV |
158 | const char *level = getenv ("GUILE_WARN_DEPRECATED"); |
159 | if (level == NULL) | |
887dfa7d | 160 | level = SCM_WARN_DEPRECATED_DEFAULT; |
7e516288 | 161 | if (!strcmp (level, "detailed")) |
d013f095 | 162 | mode = detailed; |
7e516288 | 163 | else if (!strcmp (level, "no")) |
d013f095 | 164 | mode = summary; |
7e516288 MV |
165 | else |
166 | { | |
d013f095 | 167 | mode = summary; |
7e516288 MV |
168 | atexit (print_deprecation_summary); |
169 | } | |
170 | #endif | |
7e516288 | 171 | #include "libguile/deprecation.x" |
7e516288 MV |
172 | } |
173 | ||
174 | /* | |
175 | Local Variables: | |
176 | c-file-style: "gnu" | |
177 | End: */ |