1 /* This file contains definitions for deprecated features. When you
2 deprecate something, move it here when that is feasible.
5 /* Copyright (C) 2003, 2004, 2006, 2008 Free Software Foundation, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #include "libguile/_scm.h"
27 #include "libguile/async.h"
28 #include "libguile/deprecated.h"
29 #include "libguile/discouraged.h"
30 #include "libguile/deprecation.h"
31 #include "libguile/snarf.h"
32 #include "libguile/validate.h"
33 #include "libguile/strings.h"
34 #include "libguile/srfi-13.h"
35 #include "libguile/modules.h"
36 #include "libguile/eval.h"
37 #include "libguile/smob.h"
38 #include "libguile/procprop.h"
39 #include "libguile/vectors.h"
40 #include "libguile/hashtab.h"
41 #include "libguile/struct.h"
42 #include "libguile/variable.h"
43 #include "libguile/fluids.h"
44 #include "libguile/ports.h"
45 #include "libguile/eq.h"
46 #include "libguile/read.h"
47 #include "libguile/strports.h"
48 #include "libguile/smob.h"
49 #include "libguile/alist.h"
50 #include "libguile/keywords.h"
51 #include "libguile/feature.h"
56 #if (SCM_ENABLE_DEPRECATED == 1)
58 /* From print.c: Internal symbol names of isyms. Deprecated in guile 1.7.0 on
60 char *scm_isymnames[] =
66 /* From eval.c: Error messages of the evaluator. These were deprecated in
67 * guile 1.7.0 on 2003-06-02. */
68 const char scm_s_expression[] = "missing or extra expression";
69 const char scm_s_test[] = "bad test";
70 const char scm_s_body[] = "bad body";
71 const char scm_s_bindings[] = "bad bindings";
72 const char scm_s_variable[] = "bad variable";
73 const char scm_s_clauses[] = "bad or missing clauses";
74 const char scm_s_formals[] = "bad formals";
77 SCM_REGISTER_PROC(s_substring_move_left_x, "substring-move-left!", 5, 0, 0, scm_substring_move_x);
79 SCM_REGISTER_PROC(s_substring_move_right_x, "substring-move-right!", 5, 0, 0, scm_substring_move_x);
82 scm_wta (SCM arg, const char *pos, const char *s_subr)
84 if (!s_subr || !*s_subr)
86 if ((~0x1fL) & (long) pos)
88 /* error string supplied. */
89 scm_misc_error (s_subr, pos, scm_list_1 (arg));
93 /* numerical error code. */
94 scm_t_bits error = (scm_t_bits) pos;
99 scm_wrong_type_arg (s_subr, 0, arg);
101 scm_wrong_type_arg (s_subr, 1, arg);
103 scm_wrong_type_arg (s_subr, 2, arg);
105 scm_wrong_type_arg (s_subr, 3, arg);
107 scm_wrong_type_arg (s_subr, 4, arg);
109 scm_wrong_type_arg (s_subr, 5, arg);
111 scm_wrong_type_arg (s_subr, 6, arg);
113 scm_wrong_type_arg (s_subr, 7, arg);
115 scm_wrong_num_args (arg);
117 scm_out_of_range (s_subr, arg);
119 scm_memory_error (s_subr);
121 /* this shouldn't happen. */
122 scm_misc_error (s_subr, "Unknown error", SCM_EOL);
125 return SCM_UNSPECIFIED;
131 /* We can't use SCM objects here. One should be able to call
132 SCM_REGISTER_MODULE from a C++ constructor for a static
133 object. This happens before main and thus before libguile is
137 struct moddata *link;
142 static struct moddata *registered_mods = NULL;
145 scm_register_module_xxx (char *module_name, void *init_func)
149 scm_c_issue_deprecation_warning
150 ("`scm_register_module_xxx' is deprecated. Use extensions instead.");
152 /* XXX - should we (and can we) DEFER_INTS here? */
154 for (md = registered_mods; md; md = md->link)
155 if (!strcmp (md->module_name, module_name))
157 md->init_func = init_func;
161 md = (struct moddata *) malloc (sizeof (struct moddata));
165 "guile: can't register module (%s): not enough memory",
170 md->module_name = module_name;
171 md->init_func = init_func;
172 md->link = registered_mods;
173 registered_mods = md;
176 SCM_DEFINE (scm_registered_modules, "c-registered-modules", 0, 0, 0,
178 "Return a list of the object code modules that have been imported into\n"
179 "the current Guile process. Each element of the list is a pair whose\n"
180 "car is the name of the module, and whose cdr is the function handle\n"
181 "for that module's initializer function. The name is the string that\n"
182 "has been passed to scm_register_module_xxx.")
183 #define FUNC_NAME s_scm_registered_modules
189 for (md = registered_mods; md; md = md->link)
190 res = scm_cons (scm_cons (scm_from_locale_string (md->module_name),
191 scm_from_ulong ((unsigned long) md->init_func)),
197 SCM_DEFINE (scm_clear_registered_modules, "c-clear-registered-modules", 0, 0, 0,
199 "Destroy the list of modules registered with the current Guile process.\n"
200 "The return value is unspecified. @strong{Warning:} this function does\n"
201 "not actually unlink or deallocate these modules, but only destroys the\n"
202 "records of which modules have been loaded. It should therefore be used\n"
203 "only by module bookkeeping operations.")
204 #define FUNC_NAME s_scm_clear_registered_modules
206 struct moddata *md1, *md2;
208 SCM_CRITICAL_SECTION_START;
210 for (md1 = registered_mods; md1; md1 = md2)
215 registered_mods = NULL;
217 SCM_CRITICAL_SECTION_END;
218 return SCM_UNSPECIFIED;
223 scm_remember (SCM *ptr)
225 scm_c_issue_deprecation_warning ("`scm_remember' is deprecated. "
226 "Use the `scm_remember_upto_here*' family of functions instead.");
230 scm_protect_object (SCM obj)
232 scm_c_issue_deprecation_warning ("`scm_protect_object' is deprecated. "
233 "Use `scm_gc_protect_object' instead.");
234 return scm_gc_protect_object (obj);
238 scm_unprotect_object (SCM obj)
240 scm_c_issue_deprecation_warning ("`scm_unprotect_object' is deprecated. "
241 "Use `scm_gc_unprotect_object' instead.");
242 return scm_gc_unprotect_object (obj);
245 SCM_SYMBOL (scm_sym_app, "app");
246 SCM_SYMBOL (scm_sym_modules, "modules");
247 static SCM module_prefix = SCM_BOOL_F;
248 static SCM make_modules_in_var;
249 static SCM beautify_user_module_x_var;
250 static SCM try_module_autoload_var;
255 #define PERM(x) scm_permanent_object(x)
257 if (module_prefix == SCM_BOOL_F)
259 module_prefix = PERM (scm_list_2 (scm_sym_app, scm_sym_modules));
260 make_modules_in_var = PERM (scm_c_lookup ("make-modules-in"));
261 beautify_user_module_x_var =
262 PERM (scm_c_lookup ("beautify-user-module!"));
263 try_module_autoload_var = PERM (scm_c_lookup ("try-module-autoload"));
268 scm_the_root_module ()
270 init_module_stuff ();
271 scm_c_issue_deprecation_warning ("`scm_the_root_module' is deprecated. "
272 "Use `scm_c_resolve_module (\"guile\")' "
275 return scm_c_resolve_module ("guile");
279 scm_module_full_name (SCM name)
281 init_module_stuff ();
282 if (scm_is_eq (SCM_CAR (name), scm_sym_app))
285 return scm_append (scm_list_2 (module_prefix, name));
289 scm_make_module (SCM name)
291 init_module_stuff ();
292 scm_c_issue_deprecation_warning ("`scm_make_module' is deprecated. "
293 "Use `scm_c_define_module instead.");
295 return scm_call_2 (SCM_VARIABLE_REF (make_modules_in_var),
296 scm_the_root_module (),
297 scm_module_full_name (name));
301 scm_ensure_user_module (SCM module)
303 init_module_stuff ();
304 scm_c_issue_deprecation_warning ("`scm_ensure_user_module' is deprecated. "
305 "Use `scm_c_define_module instead.");
307 scm_call_1 (SCM_VARIABLE_REF (beautify_user_module_x_var), module);
308 return SCM_UNSPECIFIED;
312 scm_load_scheme_module (SCM name)
314 init_module_stuff ();
315 scm_c_issue_deprecation_warning ("`scm_load_scheme_module' is deprecated. "
316 "Use `scm_c_resolve_module instead.");
318 return scm_call_1 (SCM_VARIABLE_REF (try_module_autoload_var), name);
321 /* This is implemented in C solely for SCM_COERCE_OUTPORT ... */
324 maybe_close_port (void *data, SCM port)
326 SCM except_set = (SCM) data;
328 while (!scm_is_null (except_set))
330 SCM p = SCM_COERCE_OUTPORT (SCM_CAR (except_set));
331 if (scm_is_eq (p, port))
333 except_set = SCM_CDR (except_set);
336 scm_close_port (port);
339 SCM_DEFINE (scm_close_all_ports_except, "close-all-ports-except", 0, 0, 1,
341 "[DEPRECATED] Close all open file ports used by the interpreter\n"
342 "except for those supplied as arguments. This procedure\n"
343 "was intended to be used before an exec call to close file descriptors\n"
344 "which are not needed in the new process. However it has the\n"
345 "undesirable side effect of flushing buffers, so it's deprecated.\n"
346 "Use port-for-each instead.")
347 #define FUNC_NAME s_scm_close_all_ports_except
350 SCM_VALIDATE_REST_ARGUMENT (ports);
352 for (p = ports; !scm_is_null (p); p = SCM_CDR (p))
353 SCM_VALIDATE_OPPORT (SCM_ARG1, SCM_COERCE_OUTPORT (SCM_CAR (p)));
355 scm_c_port_for_each (maybe_close_port, ports);
357 return SCM_UNSPECIFIED;
361 SCM_DEFINE (scm_variable_set_name_hint, "variable-set-name-hint!", 2, 0, 0,
363 "Do not use this function.")
364 #define FUNC_NAME s_scm_variable_set_name_hint
366 SCM_VALIDATE_VARIABLE (1, var);
367 SCM_VALIDATE_SYMBOL (2, hint);
368 scm_c_issue_deprecation_warning
369 ("'variable-set-name-hint!' is deprecated. Do not use it.");
370 return SCM_UNSPECIFIED;
374 SCM_DEFINE (scm_builtin_variable, "builtin-variable", 1, 0, 0,
376 "Do not use this function.")
377 #define FUNC_NAME s_scm_builtin_variable
379 SCM_VALIDATE_SYMBOL (1,name);
380 scm_c_issue_deprecation_warning ("`builtin-variable' is deprecated. "
381 "Use module system operations instead.");
382 return scm_sym2var (name, SCM_BOOL_F, SCM_BOOL_T);
387 scm_makstr (size_t len, int dummy)
389 scm_c_issue_deprecation_warning
390 ("'scm_makstr' is deprecated. Use 'scm_c_make_string' instead.");
391 return scm_c_make_string (len, SCM_UNDEFINED);
395 scm_makfromstr (const char *src, size_t len, int dummy SCM_UNUSED)
397 scm_c_issue_deprecation_warning ("`scm_makfromstr' is deprecated. "
398 "Use `scm_from_locale_stringn' instead.");
400 return scm_from_locale_stringn (src, len);
404 scm_internal_with_fluids (SCM fluids, SCM values, SCM (*cproc) (), void *cdata)
406 scm_c_issue_deprecation_warning ("`scm_internal_with_fluids' is deprecated. "
407 "Use `scm_c_with_fluids' instead.");
409 return scm_c_with_fluids (fluids, values, cproc, cdata);
413 scm_make_gsubr (const char *name, int req, int opt, int rst, SCM (*fcn)())
415 scm_c_issue_deprecation_warning
416 ("`scm_make_gsubr' is deprecated. Use `scm_c_define_gsubr' instead.");
418 return scm_c_define_gsubr (name, req, opt, rst, fcn);
422 scm_make_gsubr_with_generic (const char *name,
423 int req, int opt, int rst,
424 SCM (*fcn)(), SCM *gf)
426 scm_c_issue_deprecation_warning
427 ("`scm_make_gsubr_with_generic' is deprecated. "
428 "Use `scm_c_define_gsubr_with_generic' instead.");
430 return scm_c_define_gsubr_with_generic (name, req, opt, rst, fcn, gf);
434 scm_create_hook (const char *name, int n_args)
436 scm_c_issue_deprecation_warning
437 ("'scm_create_hook' is deprecated. "
438 "Use 'scm_make_hook' and 'scm_c_define' instead.");
440 SCM hook = scm_make_hook (scm_from_int (n_args));
441 scm_c_define (name, hook);
442 return scm_permanent_object (hook);
446 SCM_DEFINE (scm_sloppy_memq, "sloppy-memq", 2, 0, 0,
448 "This procedure behaves like @code{memq}, but does no type or error checking.\n"
449 "Its use is recommended only in writing Guile internals,\n"
450 "not for high-level Scheme programs.")
451 #define FUNC_NAME s_scm_sloppy_memq
453 scm_c_issue_deprecation_warning
454 ("'sloppy-memq' is deprecated. Use 'memq' instead.");
456 for(; scm_is_pair (lst); lst = SCM_CDR(lst))
458 if (scm_is_eq (SCM_CAR (lst), x))
466 SCM_DEFINE (scm_sloppy_memv, "sloppy-memv", 2, 0, 0,
468 "This procedure behaves like @code{memv}, but does no type or error checking.\n"
469 "Its use is recommended only in writing Guile internals,\n"
470 "not for high-level Scheme programs.")
471 #define FUNC_NAME s_scm_sloppy_memv
473 scm_c_issue_deprecation_warning
474 ("'sloppy-memv' is deprecated. Use 'memv' instead.");
476 for(; scm_is_pair (lst); lst = SCM_CDR(lst))
478 if (! scm_is_false (scm_eqv_p (SCM_CAR (lst), x)))
486 SCM_DEFINE (scm_sloppy_member, "sloppy-member", 2, 0, 0,
488 "This procedure behaves like @code{member}, but does no type or error checking.\n"
489 "Its use is recommended only in writing Guile internals,\n"
490 "not for high-level Scheme programs.")
491 #define FUNC_NAME s_scm_sloppy_member
493 scm_c_issue_deprecation_warning
494 ("'sloppy-member' is deprecated. Use 'member' instead.");
496 for(; scm_is_pair (lst); lst = SCM_CDR(lst))
498 if (! scm_is_false (scm_equal_p (SCM_CAR (lst), x)))
505 SCM_SYMBOL (scm_end_of_file_key, "end-of-file");
507 SCM_DEFINE (scm_read_and_eval_x, "read-and-eval!", 0, 1, 0,
509 "Read a form from @var{port} (standard input by default), and evaluate it\n"
510 "(memoizing it in the process) in the top-level environment. If no data\n"
511 "is left to be read from @var{port}, an @code{end-of-file} error is\n"
513 #define FUNC_NAME s_scm_read_and_eval_x
517 scm_c_issue_deprecation_warning
518 ("'read-and-eval!' is deprecated. Use 'read' and 'eval' instead.");
520 form = scm_read (port);
521 if (SCM_EOF_OBJECT_P (form))
522 scm_ithrow (scm_end_of_file_key, SCM_EOL, 1);
523 return scm_eval_x (form, scm_current_module ());
528 scm_make_subr_opt (const char *name, int type, SCM (*fcn) (), int set)
530 scm_c_issue_deprecation_warning
531 ("`scm_make_subr_opt' is deprecated. Use `scm_c_make_subr' or "
532 "`scm_c_define_subr' instead.");
535 return scm_c_define_subr (name, type, fcn);
537 return scm_c_make_subr (name, type, fcn);
541 scm_make_subr (const char *name, int type, SCM (*fcn) ())
543 scm_c_issue_deprecation_warning
544 ("`scm_make_subr' is deprecated. Use `scm_c_define_subr' instead.");
546 return scm_c_define_subr (name, type, fcn);
550 scm_make_subr_with_generic (const char *name, int type, SCM (*fcn) (), SCM *gf)
552 scm_c_issue_deprecation_warning
553 ("`scm_make_subr_with_generic' is deprecated. Use "
554 "`scm_c_define_subr_with_generic' instead.");
556 return scm_c_define_subr_with_generic (name, type, fcn, gf);
559 /* Call thunk(closure) underneath a top-level error handler.
560 * If an error occurs, pass the exitval through err_filter and return it.
561 * If no error occurs, return the value of thunk.
565 typedef int setjmp_type;
567 typedef long setjmp_type;
570 struct cce_handler_data {
571 SCM (*err_filter) ();
576 invoke_err_filter (void *d, SCM tag, SCM args)
578 struct cce_handler_data *data = (struct cce_handler_data *)d;
579 return data->err_filter (SCM_BOOL_F, data->closure);
583 scm_call_catching_errors (SCM (*thunk)(), SCM (*err_filter)(), void *closure)
585 scm_c_issue_deprecation_warning
586 ("'scm_call_catching_errors' is deprecated. "
587 "Use 'scm_internal_catch' instead.");
590 struct cce_handler_data data;
591 data.err_filter = err_filter;
592 data.closure = closure;
593 return scm_internal_catch (SCM_BOOL_T,
594 (scm_t_catch_body)thunk, closure,
595 (scm_t_catch_handler)invoke_err_filter, &data);
600 scm_make_smob_type_mfpe (char *name, size_t size,
602 size_t (*free) (SCM),
603 int (*print) (SCM, SCM, scm_print_state *),
604 SCM (*equalp) (SCM, SCM))
606 scm_c_issue_deprecation_warning
607 ("'scm_make_smob_type_mfpe' is deprecated. "
608 "Use 'scm_make_smob_type' plus 'scm_set_smob_*' instead.");
611 long answer = scm_make_smob_type (name, size);
612 scm_set_smob_mfpe (answer, mark, free, print, equalp);
618 scm_set_smob_mfpe (long tc,
620 size_t (*free) (SCM),
621 int (*print) (SCM, SCM, scm_print_state *),
622 SCM (*equalp) (SCM, SCM))
624 scm_c_issue_deprecation_warning
625 ("'scm_set_smob_mfpe' is deprecated. "
626 "Use 'scm_set_smob_mark' instead, for example.");
628 if (mark) scm_set_smob_mark (tc, mark);
629 if (free) scm_set_smob_free (tc, free);
630 if (print) scm_set_smob_print (tc, print);
631 if (equalp) scm_set_smob_equalp (tc, equalp);
635 scm_read_0str (char *expr)
637 scm_c_issue_deprecation_warning
638 ("scm_read_0str is deprecated. Use scm_c_read_string instead.");
640 return scm_c_read_string (expr);
644 scm_eval_0str (const char *expr)
646 scm_c_issue_deprecation_warning
647 ("scm_eval_0str is deprecated. Use scm_c_eval_string instead.");
649 return scm_c_eval_string (expr);
653 scm_strprint_obj (SCM obj)
655 scm_c_issue_deprecation_warning
656 ("scm_strprint_obj is deprecated. Use scm_object_to_string instead.");
657 return scm_object_to_string (obj, SCM_UNDEFINED);
661 scm_i_object_chars (SCM obj)
663 scm_c_issue_deprecation_warning
664 ("SCM_CHARS is deprecated. See the manual for alternatives.");
665 if (SCM_STRINGP (obj))
666 return SCM_STRING_CHARS (obj);
667 if (SCM_SYMBOLP (obj))
668 return SCM_SYMBOL_CHARS (obj);
673 scm_i_object_length (SCM obj)
675 scm_c_issue_deprecation_warning
676 ("SCM_LENGTH is deprecated. "
677 "Use scm_c_string_length instead, for example, or see the manual.");
678 if (SCM_STRINGP (obj))
679 return SCM_STRING_LENGTH (obj);
680 if (SCM_SYMBOLP (obj))
681 return SCM_SYMBOL_LENGTH (obj);
682 if (SCM_VECTORP (obj))
683 return SCM_VECTOR_LENGTH (obj);
688 scm_sym2ovcell_soft (SCM sym, SCM obarray)
691 size_t hash = scm_i_symbol_hash (sym) % SCM_VECTOR_LENGTH (obarray);
693 scm_c_issue_deprecation_warning ("`scm_sym2ovcell_soft' is deprecated. "
694 "Use hashtables instead.");
696 SCM_CRITICAL_SECTION_START;
697 for (lsym = SCM_VECTOR_REF (obarray, hash);
699 lsym = SCM_CDR (lsym))
702 if (scm_is_eq (SCM_CAR (z), sym))
704 SCM_CRITICAL_SECTION_END;
708 SCM_CRITICAL_SECTION_END;
714 scm_sym2ovcell (SCM sym, SCM obarray)
715 #define FUNC_NAME "scm_sym2ovcell"
719 scm_c_issue_deprecation_warning ("`scm_sym2ovcell' is deprecated. "
720 "Use hashtables instead.");
722 answer = scm_sym2ovcell_soft (sym, obarray);
723 if (scm_is_true (answer))
725 SCM_MISC_ERROR ("uninterned symbol: ~S", scm_list_1 (sym));
726 return SCM_UNSPECIFIED; /* not reached */
731 /* Intern a symbol whose name is the LEN characters at NAME in OBARRAY.
733 OBARRAY should be a vector of lists, indexed by the name's hash
734 value, modulo OBARRAY's length. Each list has the form
735 ((SYMBOL . VALUE) ...), where SYMBOL is a symbol, and VALUE is the
736 value associated with that symbol (in the current module? in the
739 To "intern" a symbol means: if OBARRAY already contains a symbol by
740 that name, return its (SYMBOL . VALUE) pair; otherwise, create a
741 new symbol, add the pair (SYMBOL . SCM_UNDEFINED) to the
742 appropriate list of the OBARRAY, and return the pair.
744 If softness is non-zero, don't create a symbol if it isn't already
745 in OBARRAY; instead, just return #f.
747 If OBARRAY is SCM_BOOL_F, create a symbol listed in no obarray and
748 return (SYMBOL . SCM_UNDEFINED). */
752 scm_intern_obarray_soft (const char *name,size_t len,SCM obarray,unsigned int softness)
754 SCM symbol = scm_from_locale_symboln (name, len);
755 size_t raw_hash = scm_i_symbol_hash (symbol);
759 scm_c_issue_deprecation_warning ("`scm_intern_obarray_soft' is deprecated. "
760 "Use hashtables instead.");
762 if (scm_is_false (obarray))
767 return scm_cons (symbol, SCM_UNDEFINED);
770 hash = raw_hash % SCM_VECTOR_LENGTH (obarray);
772 for (lsym = SCM_VECTOR_REF(obarray, hash);
773 SCM_NIMP (lsym); lsym = SCM_CDR (lsym))
775 SCM a = SCM_CAR (lsym);
777 if (scm_is_eq (z, symbol))
787 SCM cell = scm_cons (symbol, SCM_UNDEFINED);
788 SCM slot = SCM_VECTOR_REF (obarray, hash);
790 SCM_VECTOR_SET (obarray, hash, scm_cons (cell, slot));
798 scm_intern_obarray (const char *name,size_t len,SCM obarray)
800 scm_c_issue_deprecation_warning ("`scm_intern_obarray' is deprecated. "
801 "Use hashtables instead.");
803 return scm_intern_obarray_soft (name, len, obarray, 0);
806 /* Lookup the value of the symbol named by the nul-terminated string
807 NAME in the current module. */
809 scm_symbol_value0 (const char *name)
811 scm_c_issue_deprecation_warning ("`scm_symbol_value0' is deprecated. "
812 "Use `scm_lookup' instead.");
814 return scm_variable_ref (scm_c_lookup (name));
817 SCM_DEFINE (scm_string_to_obarray_symbol, "string->obarray-symbol", 2, 1, 0,
818 (SCM o, SCM s, SCM softp),
819 "Intern a new symbol in @var{obarray}, a symbol table, with name\n"
821 "If @var{obarray} is @code{#f}, use the default system symbol table. If\n"
822 "@var{obarray} is @code{#t}, the symbol should not be interned in any\n"
823 "symbol table; merely return the pair (@var{symbol}\n"
824 ". @var{#<undefined>}).\n\n"
825 "The @var{soft?} argument determines whether new symbol table entries\n"
826 "should be created when the specified symbol is not already present in\n"
827 "@var{obarray}. If @var{soft?} is specified and is a true value, then\n"
828 "new entries should not be added for symbols not already present in the\n"
829 "table; instead, simply return @code{#f}.")
830 #define FUNC_NAME s_scm_string_to_obarray_symbol
836 SCM_VALIDATE_STRING (2, s);
837 SCM_ASSERT (scm_is_bool (o) || SCM_VECTORP (o), o, SCM_ARG1, FUNC_NAME);
839 scm_c_issue_deprecation_warning ("`string->obarray-symbol' is deprecated. "
840 "Use hashtables instead.");
842 softness = (!SCM_UNBNDP (softp) && scm_is_true(softp));
843 /* iron out some screwy calling conventions */
844 if (scm_is_false (o))
846 /* nothing interesting to do here. */
847 return scm_string_to_symbol (s);
849 else if (scm_is_eq (o, SCM_BOOL_T))
852 vcell = scm_intern_obarray_soft (scm_i_string_chars (s),
853 scm_i_string_length (s),
856 if (scm_is_false (vcell))
858 answer = SCM_CAR (vcell);
863 SCM_DEFINE (scm_intern_symbol, "intern-symbol", 2, 0, 0,
865 "Add a new symbol to @var{obarray} with name @var{string}, bound to an\n"
866 "unspecified initial value. The symbol table is not modified if a symbol\n"
867 "with this name is already present.")
868 #define FUNC_NAME s_scm_intern_symbol
871 SCM_VALIDATE_SYMBOL (2,s);
872 if (scm_is_false (o))
873 return SCM_UNSPECIFIED;
875 scm_c_issue_deprecation_warning ("`intern-symbol' is deprecated. "
876 "Use hashtables instead.");
878 SCM_VALIDATE_VECTOR (1,o);
879 hval = scm_i_symbol_hash (s) % SCM_VECTOR_LENGTH (o);
880 /* If the symbol is already interned, simply return. */
881 SCM_CRITICAL_SECTION_START;
885 for (lsym = SCM_VECTOR_REF (o, hval);
887 lsym = SCM_CDR (lsym))
889 sym = SCM_CAR (lsym);
890 if (scm_is_eq (SCM_CAR (sym), s))
892 SCM_CRITICAL_SECTION_END;
893 return SCM_UNSPECIFIED;
896 SCM_VECTOR_SET (o, hval,
897 scm_acons (s, SCM_UNDEFINED,
898 SCM_VECTOR_REF (o, hval)));
900 SCM_CRITICAL_SECTION_END;
901 return SCM_UNSPECIFIED;
905 SCM_DEFINE (scm_unintern_symbol, "unintern-symbol", 2, 0, 0,
907 "Remove the symbol with name @var{string} from @var{obarray}. This\n"
908 "function returns @code{#t} if the symbol was present and @code{#f}\n"
910 #define FUNC_NAME s_scm_unintern_symbol
914 scm_c_issue_deprecation_warning ("`unintern-symbol' is deprecated. "
915 "Use hashtables instead.");
917 SCM_VALIDATE_SYMBOL (2,s);
918 if (scm_is_false (o))
920 SCM_VALIDATE_VECTOR (1,o);
921 hval = scm_i_symbol_hash (s) % SCM_VECTOR_LENGTH (o);
922 SCM_CRITICAL_SECTION_START;
927 for (lsym = SCM_VECTOR_REF (o, hval), lsym_follow = SCM_BOOL_F;
929 lsym_follow = lsym, lsym = SCM_CDR (lsym))
931 sym = SCM_CAR (lsym);
932 if (scm_is_eq (SCM_CAR (sym), s))
934 /* Found the symbol to unintern. */
935 if (scm_is_false (lsym_follow))
936 SCM_VECTOR_SET (o, hval, lsym);
938 SCM_SETCDR (lsym_follow, SCM_CDR(lsym));
939 SCM_CRITICAL_SECTION_END;
944 SCM_CRITICAL_SECTION_END;
949 SCM_DEFINE (scm_symbol_binding, "symbol-binding", 2, 0, 0,
951 "Look up in @var{obarray} the symbol whose name is @var{string}, and\n"
952 "return the value to which it is bound. If @var{obarray} is @code{#f},\n"
953 "use the global symbol table. If @var{string} is not interned in\n"
954 "@var{obarray}, an error is signalled.")
955 #define FUNC_NAME s_scm_symbol_binding
959 scm_c_issue_deprecation_warning ("`symbol-binding' is deprecated. "
960 "Use hashtables instead.");
962 SCM_VALIDATE_SYMBOL (2,s);
963 if (scm_is_false (o))
964 return scm_variable_ref (scm_lookup (s));
965 SCM_VALIDATE_VECTOR (1,o);
966 vcell = scm_sym2ovcell (s, o);
967 return SCM_CDR(vcell);
972 SCM_DEFINE (scm_symbol_interned_p, "symbol-interned?", 2, 0, 0,
974 "Return @code{#t} if @var{obarray} contains a symbol with name\n"
975 "@var{string}, and @code{#f} otherwise.")
976 #define FUNC_NAME s_scm_symbol_interned_p
980 scm_c_issue_deprecation_warning ("`symbol-interned?' is deprecated. "
981 "Use hashtables instead.");
983 SCM_VALIDATE_SYMBOL (2,s);
984 if (scm_is_false (o))
986 SCM var = scm_sym2var (s, SCM_BOOL_F, SCM_BOOL_F);
987 if (var != SCM_BOOL_F)
991 SCM_VALIDATE_VECTOR (1,o);
992 vcell = scm_sym2ovcell_soft (s, o);
993 return (SCM_NIMP(vcell)
1000 SCM_DEFINE (scm_symbol_bound_p, "symbol-bound?", 2, 0, 0,
1002 "Return @code{#t} if @var{obarray} contains a symbol with name\n"
1003 "@var{string} bound to a defined value. This differs from\n"
1004 "@var{symbol-interned?} in that the mere mention of a symbol\n"
1005 "usually causes it to be interned; @code{symbol-bound?}\n"
1006 "determines whether a symbol has been given any meaningful\n"
1008 #define FUNC_NAME s_scm_symbol_bound_p
1012 scm_c_issue_deprecation_warning ("`symbol-bound?' is deprecated. "
1013 "Use hashtables instead.");
1015 SCM_VALIDATE_SYMBOL (2,s);
1016 if (scm_is_false (o))
1018 SCM var = scm_sym2var (s, SCM_BOOL_F, SCM_BOOL_F);
1019 if (SCM_VARIABLEP(var) && !SCM_UNBNDP(SCM_VARIABLE_REF(var)))
1023 SCM_VALIDATE_VECTOR (1,o);
1024 vcell = scm_sym2ovcell_soft (s, o);
1025 return scm_from_bool (SCM_NIMP (vcell) && !SCM_UNBNDP (SCM_CDR (vcell)));
1030 SCM_DEFINE (scm_symbol_set_x, "symbol-set!", 3, 0, 0,
1031 (SCM o, SCM s, SCM v),
1032 "Find the symbol in @var{obarray} whose name is @var{string}, and rebind\n"
1033 "it to @var{value}. An error is signalled if @var{string} is not present\n"
1034 "in @var{obarray}.")
1035 #define FUNC_NAME s_scm_symbol_set_x
1039 scm_c_issue_deprecation_warning ("`symbol-set!' is deprecated. "
1040 "Use the module system instead.");
1042 SCM_VALIDATE_SYMBOL (2,s);
1043 if (scm_is_false (o))
1046 return SCM_UNSPECIFIED;
1048 SCM_VALIDATE_VECTOR (1,o);
1049 vcell = scm_sym2ovcell (s, o);
1050 SCM_SETCDR (vcell, v);
1051 return SCM_UNSPECIFIED;
1055 #define MAX_PREFIX_LENGTH 30
1057 static int gentemp_counter;
1059 SCM_DEFINE (scm_gentemp, "gentemp", 0, 2, 0,
1060 (SCM prefix, SCM obarray),
1061 "Create a new symbol with a name unique in an obarray.\n"
1062 "The name is constructed from an optional string @var{prefix}\n"
1063 "and a counter value. The default prefix is @code{t}. The\n"
1064 "@var{obarray} is specified as a second optional argument.\n"
1065 "Default is the system obarray where all normal symbols are\n"
1066 "interned. The counter is increased by 1 at each\n"
1067 "call. There is no provision for resetting the counter.")
1068 #define FUNC_NAME s_scm_gentemp
1070 char buf[MAX_PREFIX_LENGTH + SCM_INTBUFLEN];
1074 scm_c_issue_deprecation_warning ("`gentemp' is deprecated. "
1075 "Use `gensym' instead.");
1077 if (SCM_UNBNDP (prefix))
1084 SCM_VALIDATE_STRING (1, prefix);
1085 len = scm_i_string_length (prefix);
1086 if (len > MAX_PREFIX_LENGTH)
1087 name = SCM_MUST_MALLOC (MAX_PREFIX_LENGTH + SCM_INTBUFLEN);
1088 strncpy (name, scm_i_string_chars (prefix), len);
1091 if (SCM_UNBNDP (obarray))
1092 return scm_gensym (prefix);
1094 SCM_ASSERT ((scm_is_vector (obarray) || SCM_I_WVECTP (obarray)),
1099 n_digits = scm_iint2str (gentemp_counter++, 10, &name[len]);
1100 while (scm_is_true (scm_intern_obarray_soft (name,
1105 SCM vcell = scm_intern_obarray_soft (name,
1110 scm_must_free (name);
1111 return SCM_CAR (vcell);
1117 scm_i_makinum (scm_t_signed_bits val)
1119 scm_c_issue_deprecation_warning
1120 ("SCM_MAKINUM is deprecated. Use scm_from_int or similar instead.");
1121 return SCM_I_MAKINUM (val);
1125 scm_i_inump (SCM obj)
1127 scm_c_issue_deprecation_warning
1128 ("SCM_INUMP is deprecated. Use scm_is_integer or similar instead.");
1129 return SCM_I_INUMP (obj);
1133 scm_i_inum (SCM obj)
1135 scm_c_issue_deprecation_warning
1136 ("SCM_INUM is deprecated. Use scm_to_int or similar instead.");
1137 return scm_to_intmax (obj);
1141 scm_c_string2str (SCM obj, char *str, size_t *lenp)
1143 scm_c_issue_deprecation_warning
1144 ("scm_c_string2str is deprecated. Use scm_to_locale_stringbuf or similar instead.");
1148 char *result = scm_to_locale_string (obj);
1150 *lenp = scm_i_string_length (obj);
1155 /* Pray that STR is large enough.
1157 size_t len = scm_to_locale_stringbuf (obj, str, SCM_I_SIZE_MAX);
1166 scm_c_substring2str (SCM obj, char *str, size_t start, size_t len)
1168 scm_c_issue_deprecation_warning
1169 ("scm_c_substring2str is deprecated. Use scm_substring plus scm_to_locale_stringbuf instead.");
1172 obj = scm_substring (obj, scm_from_size_t (start), SCM_UNDEFINED);
1174 scm_to_locale_stringbuf (obj, str, len);
1178 /* Converts the given Scheme symbol OBJ into a C string, containing a copy
1179 of OBJ's content with a trailing null byte. If LENP is non-NULL, set
1180 *LENP to the string's length.
1182 When STR is non-NULL it receives the copy and is returned by the function,
1183 otherwise new memory is allocated and the caller is responsible for
1184 freeing it via free(). If out of memory, NULL is returned.
1186 Note that Scheme symbols may contain arbitrary data, including null
1187 characters. This means that null termination is not a reliable way to
1188 determine the length of the returned value. However, the function always
1189 copies the complete contents of OBJ, and sets *LENP to the length of the
1190 scheme symbol (if LENP is non-null). */
1192 scm_c_symbol2str (SCM obj, char *str, size_t *lenp)
1194 return scm_c_string2str (scm_symbol_to_string (obj), str, lenp);
1198 scm_truncate (double x)
1200 scm_c_issue_deprecation_warning
1201 ("scm_truncate is deprecated. Use scm_c_truncate instead.");
1202 return scm_c_truncate (x);
1206 scm_round (double x)
1208 scm_c_issue_deprecation_warning
1209 ("scm_round is deprecated. Use scm_c_round instead.");
1210 return scm_c_round (x);
1214 scm_i_deprecated_symbol_chars (SCM sym)
1216 scm_c_issue_deprecation_warning
1217 ("SCM_SYMBOL_CHARS is deprecated. Use scm_symbol_to_string.");
1219 return (char *)scm_i_symbol_chars (sym);
1223 scm_i_deprecated_symbol_length (SCM sym)
1225 scm_c_issue_deprecation_warning
1226 ("SCM_SYMBOL_LENGTH is deprecated. Use scm_symbol_to_string.");
1227 return scm_i_symbol_length (sym);
1231 scm_i_keywordp (SCM obj)
1233 scm_c_issue_deprecation_warning
1234 ("SCM_KEYWORDP is deprecated. Use scm_is_keyword instead.");
1235 return scm_is_keyword (obj);
1239 scm_i_keywordsym (SCM keyword)
1241 scm_c_issue_deprecation_warning
1242 ("SCM_KEYWORDSYM is deprecated. See scm_keyword_to_symbol instead.");
1243 return scm_keyword_dash_symbol (keyword);
1247 scm_i_vectorp (SCM x)
1249 scm_c_issue_deprecation_warning
1250 ("SCM_VECTORP is deprecated. Use scm_is_vector instead.");
1251 return SCM_I_IS_VECTOR (x);
1255 scm_i_vector_length (SCM x)
1257 scm_c_issue_deprecation_warning
1258 ("SCM_VECTOR_LENGTH is deprecated. Use scm_c_vector_length instead.");
1259 return SCM_I_VECTOR_LENGTH (x);
1265 scm_c_issue_deprecation_warning
1266 ("SCM_VELTS is deprecated. Use scm_vector_elements instead.");
1267 return SCM_I_VECTOR_ELTS (x);
1271 scm_i_writable_velts (SCM x)
1273 scm_c_issue_deprecation_warning
1274 ("SCM_WRITABLE_VELTS is deprecated. "
1275 "Use scm_vector_writable_elements instead.");
1276 return SCM_I_VECTOR_WELTS (x);
1280 scm_i_vector_ref (SCM x, size_t idx)
1282 scm_c_issue_deprecation_warning
1283 ("SCM_VECTOR_REF is deprecated. "
1284 "Use scm_c_vector_ref or scm_vector_elements instead.");
1285 return scm_c_vector_ref (x, idx);
1289 scm_i_vector_set (SCM x, size_t idx, SCM val)
1291 scm_c_issue_deprecation_warning
1292 ("SCM_VECTOR_SET is deprecated. "
1293 "Use scm_c_vector_set_x or scm_vector_writable_elements instead.");
1294 scm_c_vector_set_x (x, idx, val);
1298 scm_vector_equal_p (SCM x, SCM y)
1300 scm_c_issue_deprecation_warning
1301 ("scm_vector_euqal_p is deprecated. "
1302 "Use scm_equal_p instead.");
1303 return scm_equal_p (x, y);
1307 scm_i_arrayp (SCM a)
1309 scm_c_issue_deprecation_warning
1310 ("SCM_ARRAYP is deprecated. Use scm_is_array instead.");
1311 return SCM_I_ARRAYP(a) || SCM_I_ENCLOSED_ARRAYP(a);
1315 scm_i_array_ndim (SCM a)
1317 scm_c_issue_deprecation_warning
1318 ("SCM_ARRAY_NDIM is deprecated. "
1319 "Use scm_c_array_rank or scm_array_handle_rank instead.");
1320 return scm_c_array_rank (a);
1324 scm_i_array_contp (SCM a)
1326 scm_c_issue_deprecation_warning
1327 ("SCM_ARRAY_CONTP is deprecated. Do not use it.");
1328 return SCM_I_ARRAY_CONTP (a);
1332 scm_i_array_mem (SCM a)
1334 scm_c_issue_deprecation_warning
1335 ("SCM_ARRAY_MEM is deprecated. Do not use it.");
1336 return (scm_t_array *)SCM_I_ARRAY_MEM (a);
1340 scm_i_array_v (SCM a)
1342 /* We could use scm_shared_array_root here, but it is better to move
1343 them away from expecting vectors as the basic storage for arrays.
1345 scm_c_issue_deprecation_warning
1346 ("SCM_ARRAY_V is deprecated. Do not use it.");
1347 return SCM_I_ARRAY_V (a);
1351 scm_i_array_base (SCM a)
1353 scm_c_issue_deprecation_warning
1354 ("SCM_ARRAY_BASE is deprecated. Do not use it.");
1355 return SCM_I_ARRAY_BASE (a);
1359 scm_i_array_dims (SCM a)
1361 scm_c_issue_deprecation_warning
1362 ("SCM_ARRAY_DIMS is deprecated. Use scm_array_handle_dims instead.");
1363 return SCM_I_ARRAY_DIMS (a);
1367 scm_i_cur_inp (void)
1369 scm_c_issue_deprecation_warning
1370 ("scm_cur_inp is deprecated. Use scm_current_input_port instead.");
1371 return scm_current_input_port ();
1375 scm_i_cur_outp (void)
1377 scm_c_issue_deprecation_warning
1378 ("scm_cur_outp is deprecated. Use scm_current_output_port instead.");
1379 return scm_current_output_port ();
1383 scm_i_cur_errp (void)
1385 scm_c_issue_deprecation_warning
1386 ("scm_cur_errp is deprecated. Use scm_current_error_port instead.");
1387 return scm_current_error_port ();
1391 scm_i_cur_loadp (void)
1393 scm_c_issue_deprecation_warning
1394 ("scm_cur_loadp is deprecated. Use scm_current_load_port instead.");
1395 return scm_current_load_port ();
1399 scm_i_progargs (void)
1401 scm_c_issue_deprecation_warning
1402 ("scm_progargs is deprecated. Use scm_program_arguments instead.");
1403 return scm_program_arguments ();
1407 scm_i_deprecated_dynwinds (void)
1409 scm_c_issue_deprecation_warning
1410 ("scm_dynwinds is deprecated. Do not use it.");
1411 return scm_i_dynwinds ();
1415 scm_i_deprecated_last_debug_frame (void)
1417 scm_c_issue_deprecation_warning
1418 ("scm_last_debug_frame is deprecated. Do not use it.");
1419 return scm_i_last_debug_frame ();
1423 scm_i_stack_base (void)
1425 scm_c_issue_deprecation_warning
1426 ("scm_stack_base is deprecated. Do not use it.");
1427 return SCM_I_CURRENT_THREAD->base;
1431 scm_i_fluidp (SCM x)
1433 scm_c_issue_deprecation_warning
1434 ("SCM_FLUIDP is deprecated. Use scm_is_fluid instead.");
1435 return scm_is_fluid (x);
1439 scm_i_defer_ints_etc ()
1441 scm_c_issue_deprecation_warning
1442 ("SCM_DEFER_INTS etc are deprecated. "
1443 "Use a mutex instead if appropriate.");
1447 scm_guard (SCM guardian, SCM obj, int throw_p)
1449 scm_c_issue_deprecation_warning
1450 ("scm_guard is deprecated. Use scm_call_1 instead.");
1452 return scm_call_1 (guardian, obj);
1456 scm_get_one_zombie (SCM guardian)
1458 scm_c_issue_deprecation_warning
1459 ("scm_guard is deprecated. Use scm_call_0 instead.");
1461 return scm_call_0 (guardian);
1464 SCM_DEFINE (scm_guardian_destroyed_p, "guardian-destroyed?", 1, 0, 0,
1466 "Return @code{#t} if @var{guardian} has been destroyed, otherwise @code{#f}.")
1467 #define FUNC_NAME s_scm_guardian_destroyed_p
1469 scm_c_issue_deprecation_warning
1470 ("'guardian-destroyed?' is deprecated.");
1475 SCM_DEFINE (scm_guardian_greedy_p, "guardian-greedy?", 1, 0, 0,
1477 "Return @code{#t} if @var{guardian} is a greedy guardian, otherwise @code{#f}.")
1478 #define FUNC_NAME s_scm_guardian_greedy_p
1480 scm_c_issue_deprecation_warning
1481 ("'guardian-greedy?' is deprecated.");
1486 SCM_DEFINE (scm_destroy_guardian_x, "destroy-guardian!", 1, 0, 0,
1488 "Destroys @var{guardian}, by making it impossible to put any more\n"
1489 "objects in it or get any objects from it. It also unguards any\n"
1490 "objects guarded by @var{guardian}.")
1491 #define FUNC_NAME s_scm_destroy_guardian_x
1493 scm_c_issue_deprecation_warning
1494 ("'destroy-guardian!' is deprecated and ineffective.");
1495 return SCM_UNSPECIFIED;
1500 scm_i_init_deprecated ()
1502 #include "libguile/deprecated.x"