1 /* Copyright (C) 2001, 2006, 2010, 2011 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 License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * 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
29 #include "libguile/_scm.h"
31 #include "libguile/deprecation.h"
32 #include "libguile/strings.h"
33 #include "libguile/ports.h"
35 #include "libguile/private-options.h"
38 /* Windows defines. */
40 #define vsnprintf _vsnprintf
45 struct issued_warning
{
46 struct issued_warning
*prev
;
50 static scm_i_pthread_mutex_t warn_lock
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
51 static struct issued_warning
*issued_warnings
;
52 static int print_summary
= 0;
55 scm_c_issue_deprecation_warning (const char *msg
)
57 if (!SCM_WARN_DEPRECATED
)
61 struct issued_warning
*iw
;
63 scm_i_pthread_mutex_lock (&warn_lock
);
64 for (iw
= issued_warnings
; iw
; iw
= iw
->prev
)
65 if (!strcmp (iw
->message
, msg
))
73 iw
= malloc (sizeof (struct issued_warning
));
74 if (msg
== NULL
|| iw
== NULL
)
75 /* Nothing sensible to do if you can't allocate this small
79 iw
->prev
= issued_warnings
;
82 scm_i_pthread_mutex_unlock (&warn_lock
);
84 /* All this dance is to avoid printing to a port inside a mutex,
85 which could recurse and deadlock. */
89 fprintf (stderr
, "%s\n", msg
);
92 scm_puts (msg
, scm_current_warning_port ());
93 scm_newline (scm_current_warning_port ());
100 scm_c_issue_deprecation_warning_fmt (const char *msg
, ...)
106 vsnprintf (buf
, 511, msg
, ap
);
109 scm_c_issue_deprecation_warning (buf
);
112 SCM_DEFINE(scm_issue_deprecation_warning
,
113 "issue-deprecation-warning", 0, 0, 1,
115 "Output @var{msgs} to @code{(current-error-port)} when this "
116 "is the first call to @code{issue-deprecation-warning} with "
117 "this specific @var{msgs}. Do nothing otherwise. "
118 "The argument @var{msgs} should be a list of strings; "
119 "they are printed in turn, each one followed by a newline.")
120 #define FUNC_NAME s_scm_issue_deprecation_warning
122 if (!SCM_WARN_DEPRECATED
)
126 SCM nl
= scm_from_locale_string ("\n");
127 SCM msgs_nl
= SCM_EOL
;
129 while (scm_is_pair (msgs
))
131 if (!scm_is_null (msgs_nl
))
132 msgs_nl
= scm_cons (nl
, msgs_nl
);
133 msgs_nl
= scm_cons (SCM_CAR (msgs
), msgs_nl
);
134 msgs
= SCM_CDR (msgs
);
136 msgs_nl
= scm_string_append (scm_reverse_x (msgs_nl
, SCM_EOL
));
137 c_msgs
= scm_to_locale_string (msgs_nl
);
138 scm_c_issue_deprecation_warning (c_msgs
);
141 return SCM_UNSPECIFIED
;
146 print_deprecation_summary (void)
151 "Some deprecated features have been used. Set the environment\n"
152 "variable GUILE_WARN_DEPRECATED to \"detailed\" and rerun the\n"
153 "program to get more information. Set it to \"no\" to suppress\n"
154 "this message.\n", stderr
);
158 SCM_DEFINE(scm_include_deprecated_features
,
159 "include-deprecated-features", 0, 0, 0,
161 "Return @code{#t} iff deprecated features should be included "
162 "in public interfaces.")
163 #define FUNC_NAME s_scm_include_deprecated_features
165 return scm_from_bool (SCM_ENABLE_DEPRECATED
== 1);
173 scm_init_deprecation ()
175 const char *level
= getenv ("GUILE_WARN_DEPRECATED");
177 level
= SCM_WARN_DEPRECATED_DEFAULT
;
178 if (!strcmp (level
, "detailed"))
179 SCM_WARN_DEPRECATED
= 1;
180 else if (!strcmp (level
, "no"))
181 SCM_WARN_DEPRECATED
= 0;
184 SCM_WARN_DEPRECATED
= 0;
185 atexit (print_deprecation_summary
);
187 #include "libguile/deprecation.x"