File size: 4,710 Bytes
3dcad1f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
/* Copyright 2001,2005-2006,2009-2012,2016,2018-2019
Free Software Foundation, Inc.
This file is part of Guile.
Guile is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Guile is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser General Public
License along with Guile. If not, see
<https://www.gnu.org/licenses/>. */
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdio.h>
#include <string.h>
#include <stdarg.h>
#include "gsubr.h"
#include "list.h"
#include "pairs.h"
#include "ports.h"
#include "private-options.h"
#include "strings.h"
#include "threads.h"
#include "deprecation.h"
struct issued_warning {
struct issued_warning *prev;
const char *message;
};
static scm_i_pthread_mutex_t warn_lock = SCM_I_PTHREAD_MUTEX_INITIALIZER;
static struct issued_warning *issued_warnings;
static int print_summary = 0;
void
scm_c_issue_deprecation_warning (const char *msg)
{
if (!SCM_WARN_DEPRECATED)
print_summary = 1;
else
{
struct issued_warning *iw;
scm_i_pthread_mutex_lock (&warn_lock);
for (iw = issued_warnings; iw; iw = iw->prev)
if (!strcmp (iw->message, msg))
{
msg = NULL;
break;
}
if (msg)
{
msg = strdup (msg);
iw = malloc (sizeof (struct issued_warning));
if (msg == NULL || iw == NULL)
/* Nothing sensible to do if you can't allocate this small
amount of memory. */
abort ();
iw->message = msg;
iw->prev = issued_warnings;
issued_warnings = iw;
}
scm_i_pthread_mutex_unlock (&warn_lock);
/* All this dance is to avoid printing to a port inside a mutex,
which could recurse and deadlock. */
if (msg)
{
scm_puts (msg, scm_current_warning_port ());
scm_newline (scm_current_warning_port ());
}
}
}
void
scm_c_issue_deprecation_warning_fmt (const char *msg, ...)
{
va_list ap;
char buf[512];
va_start (ap, msg);
vsnprintf (buf, 511, msg, ap);
va_end (ap);
buf[511] = '\0';
scm_c_issue_deprecation_warning (buf);
}
SCM_DEFINE(scm_issue_deprecation_warning,
"issue-deprecation-warning", 0, 0, 1,
(SCM msgs),
"Output @var{msgs} to @code{(current-error-port)} when this "
"is the first call to @code{issue-deprecation-warning} with "
"this specific @var{msgs}. Do nothing otherwise. "
"The argument @var{msgs} should be a list of strings; "
"they are printed in turn, each one followed by a newline.")
#define FUNC_NAME s_scm_issue_deprecation_warning
{
if (!SCM_WARN_DEPRECATED)
print_summary = 1;
else
{
SCM nl = scm_from_utf8_string ("\n");
SCM msgs_nl = SCM_EOL;
char *c_msgs;
while (scm_is_pair (msgs))
{
if (!scm_is_null (msgs_nl))
msgs_nl = scm_cons (nl, msgs_nl);
msgs_nl = scm_cons (SCM_CAR (msgs), msgs_nl);
msgs = SCM_CDR (msgs);
}
msgs_nl = scm_string_append (scm_reverse_x (msgs_nl, SCM_EOL));
c_msgs = scm_to_locale_string (msgs_nl);
scm_c_issue_deprecation_warning (c_msgs);
free (c_msgs);
}
return SCM_UNSPECIFIED;
}
#undef FUNC_NAME
static void
print_deprecation_summary (void)
{
if (print_summary)
{
fputs ("\n"
"Some deprecated features have been used. Set the environment\n"
"variable GUILE_WARN_DEPRECATED to \"detailed\" and rerun the\n"
"program to get more information. Set it to \"no\" to suppress\n"
"this message.\n", stderr);
}
}
SCM_DEFINE(scm_include_deprecated_features,
"include-deprecated-features", 0, 0, 0,
(),
"Return @code{#t} iff deprecated features should be included "
"in public interfaces.")
#define FUNC_NAME s_scm_include_deprecated_features
{
return scm_from_bool (SCM_ENABLE_DEPRECATED == 1);
}
#undef FUNC_NAME
void
scm_init_deprecation ()
{
const char *level = getenv ("GUILE_WARN_DEPRECATED");
if (level == NULL)
level = SCM_WARN_DEPRECATED_DEFAULT;
if (!strcmp (level, "detailed"))
SCM_WARN_DEPRECATED = 1;
else if (!strcmp (level, "no"))
SCM_WARN_DEPRECATED = 0;
else
{
SCM_WARN_DEPRECATED = 0;
atexit (print_deprecation_summary);
}
#include "deprecation.x"
}
|