Commit | Line | Data |
---|---|---|
5cd06d5e | 1 | /* Copyright (C) 2001 Free Software Foundation, Inc. |
7e516288 MV |
2 | * |
3 | * This program is free software; you can redistribute it and/or modify | |
4 | * it under the terms of the GNU General Public License as published by | |
5 | * the Free Software Foundation; either version 2, or (at your option) | |
6 | * any later version. | |
7 | * | |
8 | * This program 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 | |
11 | * GNU General Public License for more details. | |
12 | * | |
13 | * You should have received a copy of the GNU General Public License | |
14 | * along with this software; see the file COPYING. If not, write to | |
15 | * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, | |
16 | * Boston, MA 02111-1307 USA | |
17 | * | |
18 | * As a special exception, the Free Software Foundation gives permission | |
19 | * for additional uses of the text contained in its release of GUILE. | |
20 | * | |
21 | * The exception is that, if you link the GUILE library with other files | |
22 | * to produce an executable, this does not by itself cause the | |
23 | * resulting executable to be covered by the GNU General Public License. | |
24 | * Your use of that executable is in no way restricted on account of | |
25 | * linking the GUILE library code into it. | |
26 | * | |
27 | * This exception does not however invalidate any other reasons why | |
28 | * the executable file might be covered by the GNU General Public License. | |
29 | * | |
30 | * This exception applies only to the code released by the | |
31 | * Free Software Foundation under the name GUILE. If you copy | |
32 | * code from other Free Software Foundation releases into a copy of | |
33 | * GUILE, as the General Public License permits, the exception does | |
34 | * not apply to the code that you add in this way. To avoid misleading | |
35 | * anyone as to the status of such modified files, you must delete | |
36 | * this exception notice from them. | |
37 | * | |
38 | * If you write modifications of your own for GUILE, it is your choice | |
39 | * whether to permit this exception to apply to your modifications. | |
40 | * If you do not wish that, delete this exception notice. */ | |
41 | ||
42 | \f | |
43 | ||
44 | #include <stdio.h> | |
fbbdb121 | 45 | #include <string.h> |
7e516288 MV |
46 | |
47 | #include "libguile/_scm.h" | |
48 | ||
49 | #include "libguile/deprecation.h" | |
50 | #include "libguile/hashtab.h" | |
51 | #include "libguile/strings.h" | |
52 | #include "libguile/ports.h" | |
53 | ||
54 | \f | |
55 | ||
8c494e99 | 56 | #if (SCM_ENABLE_DEPRECATED == 1) |
7e516288 MV |
57 | |
58 | /* This is either a boolean (when a summary should be printed) or a | |
8c494e99 | 59 | hashtab (when detailed warnings should be printed). |
7e516288 MV |
60 | */ |
61 | SCM issued_msgs; | |
62 | ||
63 | void | |
64 | scm_c_issue_deprecation_warning (const char *msg) | |
65 | { | |
66 | if (SCM_BOOLP (issued_msgs)) | |
67 | issued_msgs = SCM_BOOL_T; | |
68 | else | |
1afff620 | 69 | scm_issue_deprecation_warning (scm_list_1 (scm_makfrom0str (msg))); |
7e516288 MV |
70 | } |
71 | ||
72 | SCM_DEFINE(scm_issue_deprecation_warning, | |
73 | "issue-deprecation-warning", 0, 0, 1, | |
74 | (SCM msgs), | |
75 | "Output @var{msgs} to @code{(current-error-port)} when this " | |
76 | "is the first call to @code{issue-deprecation-warning} with " | |
77 | "this specific @var{msg}. Do nothing otherwise. " | |
78 | "The argument @var{msgs} should be a list of strings; " | |
79 | "they are printed in turn, each one followed by a newline.") | |
80 | #define FUNC_NAME s_scm_issue_deprecation_warning | |
81 | { | |
82 | if (SCM_BOOLP (issued_msgs)) | |
83 | issued_msgs = SCM_BOOL_T; | |
84 | else | |
85 | { | |
86 | SCM handle = scm_hash_create_handle_x (issued_msgs, msgs, SCM_BOOL_F); | |
87 | if (SCM_CDR (handle) == SCM_BOOL_F) | |
88 | { | |
89 | while (SCM_CONSP (msgs)) | |
90 | { | |
91 | scm_display (SCM_CAR (msgs), scm_current_error_port ()); | |
92 | scm_newline (scm_current_error_port ()); | |
93 | msgs = SCM_CDR (msgs); | |
94 | } | |
95 | SCM_SETCDR (handle, SCM_BOOL_T); | |
96 | } | |
97 | } | |
98 | return SCM_UNSPECIFIED; | |
99 | } | |
100 | #undef FUNC_NAME | |
101 | ||
102 | static void | |
103 | print_deprecation_summary (void) | |
104 | { | |
105 | if (issued_msgs == SCM_BOOL_T) | |
106 | { | |
107 | fputs ("\n" | |
108 | "Some deprecated features have been used. Set the environment\n" | |
109 | "variable GUILE_WARN_DEPRECATED to \"detailed\" and rerun the\n" | |
110 | "program to get more information. Set it to \"no\" to suppress\n" | |
111 | "this message.\n", stderr); | |
112 | } | |
113 | } | |
114 | ||
115 | #endif | |
116 | ||
117 | SCM_DEFINE(scm_include_deprecated_features, | |
118 | "include-deprecated-features", 0, 0, 0, | |
119 | (), | |
7bad99fd MV |
120 | "Return @code{#t} iff deprecated features should be included " |
121 | "in public interfaces.") | |
7e516288 MV |
122 | #define FUNC_NAME s_scm_include_deprecated_features |
123 | { | |
8c494e99 | 124 | return SCM_BOOL (SCM_ENABLE_DEPRECATED == 1); |
7e516288 MV |
125 | } |
126 | #undef FUNC_NAME | |
127 | ||
128 | ||
129 | \f | |
130 | ||
131 | void | |
132 | scm_init_deprecation () | |
133 | { | |
8c494e99 | 134 | #if (SCM_ENABLE_DEPRECATED == 1) |
7e516288 MV |
135 | const char *level = getenv ("GUILE_WARN_DEPRECATED"); |
136 | if (level == NULL) | |
887dfa7d | 137 | level = SCM_WARN_DEPRECATED_DEFAULT; |
7e516288 MV |
138 | if (!strcmp (level, "detailed")) |
139 | issued_msgs = scm_permanent_object (scm_c_make_hash_table (17)); | |
140 | else if (!strcmp (level, "no")) | |
141 | issued_msgs = SCM_BOOL_F; | |
142 | else | |
143 | { | |
144 | issued_msgs = SCM_BOOL_F; | |
145 | atexit (print_deprecation_summary); | |
146 | } | |
147 | #endif | |
148 | #ifndef SCM_MAGIC_SNARFER | |
149 | #include "libguile/deprecation.x" | |
150 | #endif | |
151 | } | |
152 | ||
153 | /* | |
154 | Local Variables: | |
155 | c-file-style: "gnu" | |
156 | End: */ |