| 1 | /* Copyright (C) 2001 Free Software Foundation, Inc. |
| 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> |
| 45 | |
| 46 | #include "libguile/_scm.h" |
| 47 | |
| 48 | #include "libguile/deprecation.h" |
| 49 | #include "libguile/hashtab.h" |
| 50 | #include "libguile/strings.h" |
| 51 | #include "libguile/ports.h" |
| 52 | |
| 53 | \f |
| 54 | |
| 55 | #if SCM_DEBUG_DEPRECATED == 0 |
| 56 | |
| 57 | /* This is either a boolean (when a summary should be printed) or a |
| 58 | hashtab (when detailed warnings shouold be printed). |
| 59 | */ |
| 60 | SCM issued_msgs; |
| 61 | |
| 62 | void |
| 63 | scm_c_issue_deprecation_warning (const char *msg) |
| 64 | { |
| 65 | if (SCM_BOOLP (issued_msgs)) |
| 66 | issued_msgs = SCM_BOOL_T; |
| 67 | else |
| 68 | scm_issue_deprecation_warning (SCM_LIST1 (scm_makfrom0str (msg))); |
| 69 | } |
| 70 | |
| 71 | SCM_DEFINE(scm_issue_deprecation_warning, |
| 72 | "issue-deprecation-warning", 0, 0, 1, |
| 73 | (SCM msgs), |
| 74 | "Output @var{msgs} to @code{(current-error-port)} when this " |
| 75 | "is the first call to @code{issue-deprecation-warning} with " |
| 76 | "this specific @var{msg}. Do nothing otherwise. " |
| 77 | "The argument @var{msgs} should be a list of strings; " |
| 78 | "they are printed in turn, each one followed by a newline.") |
| 79 | #define FUNC_NAME s_scm_issue_deprecation_warning |
| 80 | { |
| 81 | if (SCM_BOOLP (issued_msgs)) |
| 82 | issued_msgs = SCM_BOOL_T; |
| 83 | else |
| 84 | { |
| 85 | SCM handle = scm_hash_create_handle_x (issued_msgs, msgs, SCM_BOOL_F); |
| 86 | if (SCM_CDR (handle) == SCM_BOOL_F) |
| 87 | { |
| 88 | while (SCM_CONSP (msgs)) |
| 89 | { |
| 90 | scm_display (SCM_CAR (msgs), scm_current_error_port ()); |
| 91 | scm_newline (scm_current_error_port ()); |
| 92 | msgs = SCM_CDR (msgs); |
| 93 | } |
| 94 | SCM_SETCDR (handle, SCM_BOOL_T); |
| 95 | } |
| 96 | } |
| 97 | return SCM_UNSPECIFIED; |
| 98 | } |
| 99 | #undef FUNC_NAME |
| 100 | |
| 101 | static void |
| 102 | print_deprecation_summary (void) |
| 103 | { |
| 104 | if (issued_msgs == SCM_BOOL_T) |
| 105 | { |
| 106 | fputs ("\n" |
| 107 | "Some deprecated features have been used. Set the environment\n" |
| 108 | "variable GUILE_WARN_DEPRECATED to \"detailed\" and rerun the\n" |
| 109 | "program to get more information. Set it to \"no\" to suppress\n" |
| 110 | "this message.\n", stderr); |
| 111 | } |
| 112 | } |
| 113 | |
| 114 | #endif |
| 115 | |
| 116 | SCM_DEFINE(scm_include_deprecated_features, |
| 117 | "include-deprecated-features", 0, 0, 0, |
| 118 | (), |
| 119 | "Return @code{#t} iff deprecated features should be included |
| 120 | in public interfaces.") |
| 121 | #define FUNC_NAME s_scm_include_deprecated_features |
| 122 | { |
| 123 | #if SCM_DEBUG_DEPRECATED == 0 |
| 124 | return SCM_BOOL_T; |
| 125 | #else |
| 126 | return SCM_BOOL_F; |
| 127 | #endif |
| 128 | } |
| 129 | #undef FUNC_NAME |
| 130 | |
| 131 | |
| 132 | \f |
| 133 | |
| 134 | void |
| 135 | scm_init_deprecation () |
| 136 | { |
| 137 | #if SCM_DEBUG_DEPRECATED == 0 |
| 138 | const char *level = getenv ("GUILE_WARN_DEPRECATED"); |
| 139 | if (level == NULL) |
| 140 | level = SCM_WARN_DEPRECATED_DEFAULT; |
| 141 | if (!strcmp (level, "detailed")) |
| 142 | issued_msgs = scm_permanent_object (scm_c_make_hash_table (17)); |
| 143 | else if (!strcmp (level, "no")) |
| 144 | issued_msgs = SCM_BOOL_F; |
| 145 | else |
| 146 | { |
| 147 | issued_msgs = SCM_BOOL_F; |
| 148 | atexit (print_deprecation_summary); |
| 149 | } |
| 150 | #endif |
| 151 | #ifndef SCM_MAGIC_SNARFER |
| 152 | #include "libguile/deprecation.x" |
| 153 | #endif |
| 154 | } |
| 155 | |
| 156 | /* |
| 157 | Local Variables: |
| 158 | c-file-style: "gnu" |
| 159 | End: */ |