1 /* Copyright (C) 2001 Free Software Foundation, Inc.
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)
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.
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
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
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.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
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.
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. */
47 #include "libguile/_scm.h"
49 #include "libguile/deprecation.h"
50 #include "libguile/hashtab.h"
51 #include "libguile/strings.h"
52 #include "libguile/ports.h"
56 #if (SCM_DEBUG_DEPRECATED == 0)
58 /* This is either a boolean (when a summary should be printed) or a
59 hashtab (when detailed warnings shouold be printed).
64 scm_c_issue_deprecation_warning (const char *msg
)
66 if (SCM_BOOLP (issued_msgs
))
67 issued_msgs
= SCM_BOOL_T
;
69 scm_issue_deprecation_warning (scm_list_1 (scm_makfrom0str (msg
)));
72 SCM_DEFINE(scm_issue_deprecation_warning
,
73 "issue-deprecation-warning", 0, 0, 1,
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
82 if (SCM_BOOLP (issued_msgs
))
83 issued_msgs
= SCM_BOOL_T
;
86 SCM handle
= scm_hash_create_handle_x (issued_msgs
, msgs
, SCM_BOOL_F
);
87 if (SCM_CDR (handle
) == SCM_BOOL_F
)
89 while (SCM_CONSP (msgs
))
91 scm_display (SCM_CAR (msgs
), scm_current_error_port ());
92 scm_newline (scm_current_error_port ());
93 msgs
= SCM_CDR (msgs
);
95 SCM_SETCDR (handle
, SCM_BOOL_T
);
98 return SCM_UNSPECIFIED
;
103 print_deprecation_summary (void)
105 if (issued_msgs
== SCM_BOOL_T
)
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
);
117 SCM_DEFINE(scm_include_deprecated_features
,
118 "include-deprecated-features", 0, 0, 0,
120 "Return @code{#t} iff deprecated features should be included "
121 "in public interfaces.")
122 #define FUNC_NAME s_scm_include_deprecated_features
124 #if SCM_DEBUG_DEPRECATED == 0
136 scm_init_deprecation ()
138 #if SCM_DEBUG_DEPRECATED == 0
139 const char *level
= getenv ("GUILE_WARN_DEPRECATED");
141 level
= SCM_WARN_DEPRECATED_DEFAULT
;
142 if (!strcmp (level
, "detailed"))
143 issued_msgs
= scm_permanent_object (scm_c_make_hash_table (17));
144 else if (!strcmp (level
, "no"))
145 issued_msgs
= SCM_BOOL_F
;
148 issued_msgs
= SCM_BOOL_F
;
149 atexit (print_deprecation_summary
);
152 #ifndef SCM_MAGIC_SNARFER
153 #include "libguile/deprecation.x"