1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-29 22:40:34 +02:00
guile/doc
Michael Livshin 1be6b49ccb * validate.h
(SCM_NUM2{SIZE,PTRDIFF,SHORT,USHORT,BITS,UBITS,INT,UINT}[_DEF]):
new macros.

* unif.h: type renaming:
scm_array -> scm_array_t
scm_array_dim -> scm_array_dim_t
the old names are deprecated, all in-Guile uses changed.

* tags.h (scm_ubits_t): new typedef, representing unsigned
scm_bits_t.

* stacks.h: type renaming:
scm_info_frame -> scm_info_frame_t
scm_stack -> scm_stack_t
the old names are deprecated, all in-Guile uses changed.

* srcprop.h: type renaming:
scm_srcprops -> scm_srcprops_t
scm_srcprops_chunk -> scm_srcprops_chunk_t
the old names are deprecated, all in-Guile uses changed.

* gsubr.c, procs.c, print.c, ports.c, read.c, rdelim.c, ramap.c,
rw.c, smob.c, sort.c, srcprop.c, stacks.c, strings.c, strop.c,
strorder.c, strports.c, struct.c, symbols.c, unif.c, values.c,
vectors.c, vports.c, weaks.c:
various int/size_t -> size_t/scm_bits_t changes.

* random.h: type renaming:
scm_rstate -> scm_rstate_t
scm_rng -> scm_rng_t
scm_i_rstate -> scm_i_rstate_t
the old names are deprecated, all in-Guile uses changed.

* procs.h: type renaming:
scm_subr_entry -> scm_subr_entry_t
the old name is deprecated, all in-Guile uses changed.

* options.h (scm_option_t.val): unsigned long -> scm_bits_t.
type renaming:
scm_option -> scm_option_t
the old name is deprecated, all in-Guile uses changed.

* objects.c: various long -> scm_bits_t changes.
(scm_i_make_class_object): flags: unsigned long -> scm_ubits_t

* numbers.h (SCM_FIXNUM_BIT): deprecated, renamed to
SCM_I_FIXNUM_BIT.

* num2integral.i.c: new file, multiply included by numbers.c, used
to "templatize" the various integral <-> num conversion routines.

* numbers.c (scm_mkbig, scm_big2num, scm_adjbig, scm_normbig,
scm_copybig, scm_2ulong2big, scm_dbl2big, scm_big2dbl):
deprecated.
(scm_i_mkbig, scm_i_big2inum, scm_i_adjbig, scm_i_normbig,
scm_i_copybig, scm_i_short2big, scm_i_ushort2big, scm_i_int2big,
scm_i_uint2big, scm_i_long2big, scm_i_ulong2big, scm_i_bits2big,
scm_i_ubits2big, scm_i_size2big, scm_i_ptrdiff2big,
scm_i_long_long2big, scm_i_ulong_long2big, scm_i_dbl2big,
scm_i_big2dbl, scm_short2num, scm_ushort2num, scm_int2num,
scm_uint2num, scm_bits2num, scm_ubits2num, scm_size2num,
scm_ptrdiff2num, scm_num2short, scm_num2ushort, scm_num2int,
scm_num2uint, scm_num2bits, scm_num2ubits, scm_num2ptrdiff,
scm_num2size): new functions.

* modules.c (scm_module_reverse_lookup): i, n: int -> scm_bits_t.x

* load.c: change int -> size_t in various places (where the
variable is used to store a string length).
(search-path): call scm_done_free, not scm_done_malloc.

* list.c (scm_ilength): return a scm_bits_t, not long.
some other {int,long} -> scm_bits_t changes.

* hashtab.c: various [u]int -> scm_bits_t changes.
scm_ihashx_closure -> scm_ihashx_closure_t (and made a typedef).
(scm_ihashx): n: uint -> scm_bits_t
use scm_bits2num instead of scm_ulong2num.

* gsubr.c: various int -> scm_bits_t changes.

* gh_data.c (gh_scm2double): no loss of precision any more.

* gh.h (gh_str2scm): len: int -> size_t
(gh_{get,set}_substr): start: int -> scm_bits_t,
len: int -> size_t
(gh_<num>2scm): n: int -> scm_bits_t
(gh_*vector_length): return scm_[u]size_t, not unsigned long.
(gh_length): return scm_bits_t, not unsigned long.

* fports.h: type renaming:
scm_fport -> scm_fport_t
the old name is deprecated, all in-Guile uses changed.

* fports.c (fport_fill_input): count: int -> scm_bits_t
(fport_flush): init_size, remaining, count: int -> scm_bits_t

* debug.h (scm_lookup_cstr, scm_lookup_soft, scm_evstr): removed
those prototypes, as the functions they prototype don't exist.

* fports.c (default_buffer_size): int -> size_t
(scm_fport_buffer_add): read_size, write_size: int -> scm_bits_t
default_size: int -> size_t
(scm_setvbuf): csize: int -> scm_bits_t

* fluids.c (n_fluids): int -> scm_bits_t
(grow_fluids): old_length, i: int -> scm_bits_t
(next_fluid_num, scm_fluid_ref, scm_fluid_set_x): n: int ->
scm_bits_t
(scm_c_with_fluids): flen, vlen: int -> scm_bits_t

* filesys.c (s_scm_open_fdes): changed calls to SCM_NUM2LONG to
the new and shiny SCM_NUM2INT.

* extensions.c: extension -> extension_t (and made a typedef).

* eval.h (SCM_IFRAME): cast to scm_bits_t, not int.  just so
there are no nasty surprises if/when the various deeply magic tag
bits move somewhere else.

* eval.c: changed the locals used to store results of SCM_IFRAME,
scm_ilength and such to be of type scm_bits_t (and not int/long).
(iqq): depth, edepth: int -> scm_bits_t
(scm_eval_stack): int -> scm_bits_t
(SCM_CEVAL): various vars are not scm_bits_t instead of int.
(check_map_args, scm_map, scm_for_each): len: long -> scm_bits_t
i: int -> scm_bits_t

* environments.c: changed the many calls to scm_ulong2num to
scm_ubits2num.
(import_environment_fold): proc_as_ul: ulong -> scm_ubits_t

* dynwind.c (scm_dowinds): delta: long -> scm_bits_t

* debug.h: type renaming:
scm_debug_info -> scm_debug_info_t
scm_debug_frame -> scm_debug_frame_t
the old names are deprecated, all in-Guile uses changed.
(scm_debug_eframe_size): int -> scm_bits_t

* debug.c (scm_init_debug): use scm_c_define instead of the
deprecated scm_define.

* continuations.h: type renaming:
scm_contregs -> scm_contregs_t
the old name is deprecated, all in-Guile uses changed.
(scm_contregs_t.num_stack_items): size_t -> scm_bits_t
(scm_contregs_t.num_stack_items): ulong -> scm_ubits_t

* continuations.c (scm_make_continuation): change the type of
stack_size form long to scm_bits_t.

* ports.h: type renaming:
scm_port_rw_active -> scm_port_rw_active_t (and made a typedef)
scm_port -> scm_port_t
scm_ptob_descriptor -> scm_ptob_descriptor_t
the old names are deprecated, all in-Guile uses changed.
(scm_port_t.entry): int -> scm_bits_t.
(scm_port_t.line_number): int -> long.
(scm_port_t.putback_buf_size): int -> size_t.

* __scm.h (long_long, ulong_long): deprecated (they pollute the
global namespace and have little value besides that).
(SCM_BITS_LENGTH): new, is the bit size of scm_bits_t (i.e. of an
SCM handle).
(ifdef spaghetti): include sys/types.h and sys/stdtypes.h, if they
exist (for size_t & ptrdiff_t)
(scm_sizet): deprecated.

* Makefile.am (noinst_HEADERS): add num2integral.i.c
2001-05-24 00:50:51 +00:00
..
example-smob * Update SMOB example and associated documentation. 2001-04-26 18:26:28 +00:00
maint * eval.c (scm_promise_p), list.c (scm_append_x, scm_reverse_x), 2001-05-04 21:54:00 +00:00
sources Move doc files into guile-core distribution (3) 2001-03-09 08:42:37 +00:00
.cvsignore *** empty log message *** 2001-05-09 16:38:45 +00:00
api.txt * Fix typo. 2001-04-10 18:41:09 +00:00
appendices.texi * Change R4RS references to R5RS. 2001-04-22 14:56:52 +00:00
AUTHORS * Add Martin to AUTHORS for reference manual. 2001-05-05 13:49:14 +00:00
BUGS Move doc files into guile-core distribution (6) 2001-03-09 09:20:46 +00:00
ChangeLog * guile.texi: Commented out menu entry and inclusion of Tcl/Tk 2001-05-23 17:24:50 +00:00
ChangeLog-guile-doc Move doc files into guile-core distribution (6) 2001-03-09 09:20:46 +00:00
ChangeLog-guile-doc-ref Move doc files into guile-core distribution (2) 2001-03-09 08:28:57 +00:00
ChangeLog-guile-doc-tutorial * Add two files that I seem to have omitted in the move from guile-doc to guile-core. 2001-03-23 15:24:38 +00:00
COPYING Added in preparation for release. 1998-10-19 15:29:00 +00:00
data-rep.texi * Fix uses of @itemize without a format specifier. 2001-05-16 19:30:57 +00:00
deprecated.texi * Doc updates for removal of previously deprecated features. 2001-04-29 23:01:07 +00:00
env.texi * Change R4RS references to R5RS. 2001-04-22 14:56:52 +00:00
expect.texi * scripts.texi (Invoking Guile): Added docs for --use-srfi. 2001-05-16 18:08:12 +00:00
extend.texi Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
format.texi * Change R4RS references to R5RS. 2001-04-22 14:56:52 +00:00
gh.texi * Change R4RS references to R5RS. 2001-04-22 14:56:52 +00:00
goops-tutorial.texi * goops.texi (VERSION): Bumped to version 0.3. 2001-03-10 03:08:28 +00:00
goops.texi * Consolidate authorship information in AUTHORS file. 2001-04-28 23:38:52 +00:00
guile-tut.texi * Consolidate authorship information in AUTHORS file. 2001-04-28 23:38:52 +00:00
guile.1 * guile.1: New file, from Robert Merkel and Rob Browning. 2001-04-24 23:23:05 +00:00
guile.texi * guile.texi: Commented out menu entry and inclusion of Tcl/Tk 2001-05-23 17:24:50 +00:00
hacks.el * hacks.el: Some handy helper functions for working on the manual. 1998-10-15 21:48:23 +00:00
hierarchy.eps Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
hierarchy.txt Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
indices.texi * guile.texi: Commented out menu entry and inclusion of Tcl/Tk 2001-05-23 17:24:50 +00:00
intro.texi * guile.texi: Commented out menu entry and inclusion of Tcl/Tk 2001-05-23 17:24:50 +00:00
Makefile.am * srfi-13-14.texi: Removed. 2001-05-14 21:37:51 +00:00
mbapi.texi Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
mltext.texi Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
mop.text * mop.text: Preliminary documentation of the GOOPS meta object 2000-10-25 16:05:11 +00:00
new-docstrings.texi * eval.c (scm_promise_p), list.c (scm_append_x, scm_reverse_x), 2001-05-04 21:54:00 +00:00
NEWS Move doc files into guile-core distribution (6) 2001-03-09 09:20:46 +00:00
oldfmt.c * oldfmt.c: New file: Used by application writers to adapt to 2000-01-12 01:54:16 +00:00
posix.texi * Doc updates for lazy-catch and IP address conversion 2001-05-19 11:13:47 +00:00
preface.texi (iff): Use proper texi markup. 2001-05-04 21:01:35 +00:00
r5rs.texi Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
README * Remove r4rs from distribution. 2001-04-22 13:22:51 +00:00
recipe-guidelines.txt * Added recipe-guidelines.txt. 2001-04-20 11:20:06 +00:00
repl-modules.texi * scripts.texi (Invoking Guile): Added docs for --use-srfi. 2001-05-16 18:08:12 +00:00
scheme-binding.texi * scripts.texi (Invoking Guile): Added docs for --use-srfi. 2001-05-16 18:08:12 +00:00
scheme-control.texi * Doc updates for lazy-catch and IP address conversion 2001-05-19 11:13:47 +00:00
scheme-data.texi * validate.h 2001-05-24 00:50:51 +00:00
scheme-debug.texi * eval.c (scm_promise_p), list.c (scm_append_x, scm_reverse_x), 2001-05-04 21:54:00 +00:00
scheme-evaluation.texi * guile.texi: Commented out menu entry and inclusion of Tcl/Tk 2001-05-23 17:24:50 +00:00
scheme-ideas.texi * guile.texi: Commented out menu entry and inclusion of Tcl/Tk 2001-05-23 17:24:50 +00:00
scheme-indices.texi 2001-04-09 Martin Grabmueller <mgrabmue@cs.tu-berlin.de> 2001-04-09 16:16:09 +00:00
scheme-intro.texi Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
scheme-io.texi * Fix uses of @itemize without a format specifier. 2001-05-16 19:30:57 +00:00
scheme-memory.texi * eval.c (scm_promise_p), list.c (scm_append_x, scm_reverse_x), 2001-05-04 21:54:00 +00:00
scheme-modules.texi * guile.texi: Commented out menu entry and inclusion of Tcl/Tk 2001-05-23 17:24:50 +00:00
scheme-options.texi * scheme-options.texi (Install Config): fixed minor-version docs 2001-05-17 04:53:58 +00:00
scheme-procedures.texi * guile.texi: Commented out menu entry and inclusion of Tcl/Tk 2001-05-23 17:24:50 +00:00
scheme-reading.texi * scheme-reading.texi (Further Reading): Add bullets to further 2001-03-30 22:16:20 +00:00
scheme-scheduling.texi * scheme-scheduling.texi (Arbiters): New explanatory text. 2001-04-11 16:41:46 +00:00
scheme-translation.texi * Remove obsolete `@c docstring' comments. 2001-04-09 18:36:40 +00:00
scheme-utility.texi * scripts.texi (Invoking Guile): Added docs for --use-srfi. 2001-05-16 18:08:12 +00:00
scm.texi * Apply improved Texinfo markup patch from Dale P. Smith. 2001-04-10 19:49:29 +00:00
script-getopt.texi * scheme-reading.texi (Further Reading): Add bullets to further 2001-03-30 22:16:20 +00:00
scripts.texi * scripts.texi (Invoking Guile): Added docs for --use-srfi. 2001-05-16 18:08:12 +00:00
scsh.texi Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
slib.texi Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
srfi-modules.texi * guile.texi: Commented out menu entry and inclusion of Tcl/Tk 2001-05-23 17:24:50 +00:00
tcltk.texi Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
texinfo.tex Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
THANKS * Consolidate authorship information in AUTHORS file. 2001-04-28 23:38:52 +00:00

This directory contains documentation on the Guile core.         -*-text-*-

The documentation consists of the following manuals.

- The Guile Tutorial (guile-tut.texi) contains a tutorial introduction
  to using Guile.

- The Guile Reference Manual (guile.texi) contains (or is intended to
  contain) reference documentation on all aspects of Guile.

- The GOOPS Manual (goops.texi) contains both tutorial-style and
  reference documentation for using GOOPS, Guile's Object Oriented
  Programming System.

- The Revised^5 Report on the Algorithmic Language Scheme (r5rs.texi).

Please be aware that this is all very much work in progress (apart
from the Revised^5 Report).  Bug reports and contributions are
welcome!

The file `oldfmt.c' contains a function which can be used by
application writers to support both old-style and new-style error
format strings.

The `sources' directory includes some stuff relevant to the Guile
reference manual, and which may eventually be folded in to it.  It's
not immediately relevant, however, which is why it's not in this
directory.

The Revised^4 Report (r4rs.texi) is no longer in this distribution, as
it is completely superseded by the Revised^5 Report.  If you need to
consult R4RS, it is still widely available, for example at
http://www-swiss.ai.mit.edu/projects/info/SchemeDocs/r4rs/.