1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-03 05:20:16 +02:00
Commit graph

26 commits

Author SHA1 Message Date
Martin Grabmüller
04e3da4f22 * scheme-data.texi (Hook Reference): Removed documentation for
`make-hook-with-name', which does note exist.  Added note about
	unspecified return values to all procedure documentation
2001-07-04 06:11:19 +00:00
Martin Grabmüller
e9566a8e4c * preface.texi (Manual Conventions): Added description of
@result{} and @print{}.

	* scheme-data.texi (Hash Table Examples): New subsubsection.
2001-06-30 13:45:22 +00:00
Martin Grabmüller
78c51768a7 * scheme-data.texi (Hash Tables): Added docs for
`make-hash-table'.
2001-06-30 06:58:04 +00:00
Martin Grabmüller
39e30745c8 2001-06-18 Martin Grabmueller <mgrabmue@cs.tu-berlin.de>
* srfi-modules.texi (SRFI-1): Completed procedure documentation.

	* scheme-data.texi (List Constructors): Added make-list.
	Added type index entries for all data types.

2001-06-15  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>

	* srfi-modules.texi (SRFI-1): New section documenting the SRFI-1
	module.
2001-06-18 19:08:31 +00:00
Martin Grabmüller
fec1807cdb *** empty log message *** 2001-05-30 20:54:17 +00:00
Martin Grabmüller
cee2ed4f73 * General: A lot of typo, texinfo markup and layout corrections.
* scheme-data.texi (Arithmetic): Clarified docs for - and /.
	(String Modification): Removed docs for C functions
	(scm_substring_move_right_x etc.)
	(Keyword Procedures): New section documenting the keyword
	procedures from boot-9.scm.
	(Vectors): Moved the section before the non-standard data types.

	* data-rep.texi (Defining New Types (Smobs)): Adapted description
	of smobs and proocedure creation to new terminology.
	(Describing a New Type): Removed mentioning of
	scm_make_smob_type_mfpe from smob function list and added
	deprecation notice for this function.
	(Creating Instances): Added description and macro docs for smobs
	with 2 or 3 data cells.
	(Garbage Collecting Smobs): Removed old docs for SCM_GCTYP16.
	(Garbage Collecting Simple Smobs): Added some clarification about
	usage and usefulness.
	(Non-immediate Datatypes): Changed R4RS reference to R5RS.
	(Vector Data): Document type-specific accessors.
2001-05-30 20:32:05 +00:00
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
Martin Grabmüller
92905faf2c * guile.texi: Commented out menu entry and inclusion of Tcl/Tk
stuff.

	* indices.texi: Users are advised to look under C and Scheme
	names, xref to transformation rules added.

	* intro.texi, scheme-modules.texi, scheme-ideas.texi,
	scheme-evaluation.texi, scheme-data.texi, scheme-procedures.texi:
	Fixed most REFFIXMEs.

	* srfi-modules.texi (About SRFI Usage): New node.
	(SRFI-0): Extended.
	Fixed all REFFIXMEs.
2001-05-23 17:24:50 +00:00
Martin Grabmüller
fb02eb66f6 * scripts.texi (Invoking Guile): Added docs for --use-srfi.
* expect.texi, repl-modules.texi: Start the chapters with a new
	page.

	* srfi-modules.texi (SRFI-0): Added note about supported feature
	identifiers and an example.  Start the chapter with a new page.

	* srfi-modules.texi, scheme-data.texi, scheme-control.texi,
	scheme-binding.texi, repl-modules.texi, posix.texi, intro.texi,
	scheme-utility.texi: Change `--' to `-' throughout.
2001-05-16 18:08:12 +00:00
Neil Jerram
725fd9806a * New material on macros. 2001-05-05 13:40:18 +00:00
Neil Jerram
7a095584a9 * eval.c (scm_promise_p), list.c (scm_append_x, scm_reverse_x),
symbols.c (scm_symbol_to_string), vports.c (scm_make_soft_port):
	Change R4RS references to R5RS.

	* guile-snarf.awk.in: Fixes so that (i) blank lines in the
	docstring source are correctly reproduced in the output (ii)
	we don't anymore get occasional trailing quotes.  Also reorganized
	and commented the code a little.

	* scmsigs.c (scm_raise), throw.c (scm_throw): Docstring format
	fixes.

	* new-docstrings.texi, posix.texi, scheme-control.texi,
	scheme-data.texi, scheme-debug.texi, scheme-evaluation.texi,
	scheme-io.texi, scheme-memory.texi, scheme-procedures.texi:
	Automatic docstring updates (mostly argument name updates and
	blank lines).

	* scheme-modules.texi: Change double hyphens to single.

	* scheme-control.texi (Lazy Catch): Completed.

	* posix.texi (Network Databases and Address Conversion): New
	subsubsection `IPv6 Address Conversion'.
2001-05-04 21:54:00 +00:00
Martin Grabmüller
76f944c3ca * scheme-io.texi (Block Reading and Writing): Moved the
documentation for read-string!/partial from the node `Reading'.

	* scheme-data.texi (List/String Conversion): Added docstring for
	`string-split'.
2001-05-04 04:57:39 +00:00
Neil Jerram
8c34cf5b14 * Change R4RS references to R5RS. 2001-04-22 14:56:52 +00:00
Martin Grabmüller
da54ce854a * scheme-control.texi (Multiple Values): Documented concept of
multiple values, added docs for `receive'.
	(begin): Documented `begin'.
	(if cond case): Documented `if', `cond' and `case'.
	(and or): Documented `and' and `or'.
	(while do): Documented `do' and `while'.

	* scheme-procedures.texi (Optional Arguments): Split the node,
	added introductory text, added menu for subsections.
	(let-optional Reference, let-keywords Reference),
	(lambda* Reference, define* Reference): Added syntax documentation
	for all exported procedures from (ice-9 optargs).
2001-04-17 19:29:52 +00:00
Martin Grabmüller
239d2912a2 * scheme-utility.texi (General Conversion): New node, added
`object->string'.
	(Equality): Added definition and explanation of `sameness'.

	* posix.texi (System Identification): Added `gethostname' and
	`sethostname'.
	(Processes): Added `setpriority' and `getpriority'.
	(User Information): Added `cuserid' and `getlogin'.
	(Ports and File Descriptors): Added `flock'.
	(Processes): Added `chroot'.
	(File System): Added `mkstemp!'.
	(Encryption): New node, added `crypt' and `getpass'.

	* new-docstrings.texi: Moved several docstrings over to the
	reference manual (see above which).

	* scheme-data.texi (Data Types), (Numerical Tower): Add explicit
	@bullet to @itemize to satisfy older `makeinfo'.
2001-04-17 15:34:33 +00:00
Martin Grabmüller
f4f2b29a5f * scheme-procedures.texi (Lambda): Documented the lambda form.
(Procedure Properties): Concept and usage explanation added.
	(Procedures with Setters): Explain by example, introduce
	definitions.

	* scheme-data.texi (Symbols and Variables): Split and reorganized
	this section.
	(Symbols): New introductory text.
	(Characters): Added char-ci* procedures to rn index.
2001-04-11 14:56:30 +00:00
Neil Jerram
89d04205b4 * Clean up doc and docstring for shared substrings and read only strings. 2001-04-09 21:44:06 +00:00
Neil Jerram
5411d88250 * Remove obsolete `@c docstring' comments. 2001-04-09 18:36:40 +00:00
Martin Grabmüller
5c4b24e10f 2001-04-09 Martin Grabmueller <mgrabmue@cs.tu-berlin.de>
* scheme-data.texi (Pairs): New data type and procedure
	description.
	(Lists): Added new subsections for grouping the list procedures.
	(Hooks): Added new nodes for hook subsections.
	(String Syntax): New node, factoring out read syntax.
	(Strings): Some blurb about allowed characters, zero-termination
	etc.
	(Keywords): Added menu descriptions.

2001-04-08  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>

	* scheme-indices.texi (R5RS Index): Print index `rn', not `r5'.

	* guile.texi: The index formerly known as `r5' is now called `rn'.

	* scheme-utility.texi, scheme-procedures.texi, scheme-io.texi,
	scheme-evaluation.texi, scheme-control.texi, scheme-data.texi:
	Changed all @r5index entries to @rnindex.

2001-04-06  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>

	* scheme-data.texi (Hooks): Added hook description and
	constraints.

2001-04-04  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>

	* scheme-data.texi (Alphabetic Case Mapping),
	(String Comparison): Rearranged function order.
	(Vectors): Reorganized, new introductory text, docs about read
	syntax.
2001-04-09 16:16:09 +00:00
Martin Grabmüller
2954ad93a0 * scheme-data.texi (Alphabetic Case Mapping),
(String Comparison): Rearranged function order.
	(Vectors): Reorganized, new introductory text, docs about read
	syntax.
2001-04-04 15:20:03 +00:00
Martin Grabmüller
ae9f3a1582 * scheme-options.texi, scheme-procedures.texi,
scheme-modules.texi, scheme-memory.texi, scheme-control.texi,
	scheme-utility.texi, scheme-io.texi, scheme-evaluation.texi,
	scheme-data.texi: Removed a lot of ARGFIXME's after tweaking
	docstrings and C source.

	* new-docstrings.texi, scheme-io.texi, scheme-data.texi,
	posix.texi, scheme-control.texi, scheme-evaluation.texi,
	scheme-memory.texi, scheme-procedures.texi, scheme-modules.texi,
	scheme-scheduling.texi: Automated docstring merging.
2001-04-03 13:11:14 +00:00
Martin Grabmüller
b576faf1c0 * scheme-data.texi (Strings): Reorganized the whole `Strings'
section and wrote introductory material for each new subsection.
2001-03-27 15:42:12 +00:00
Neil Jerram
8d009ee4a2 * Fix typos. 2001-03-23 16:16:15 +00:00
Neil Jerram
780ee65e3b * Automatic docstring updates.
* Commit utilities and tracking files for automatic docstring updates.
2001-03-23 15:05:40 +00:00
Martin Grabmüller
fcaedf9936 * scheme-data.texi (Arithmetic): Documented the arithmetic
procedures.
	(Integer Operations): Added documentation.
	(Comparison): Added documentation.
	(Complex): Added documentation.
	(Symbols and Variables): Comment out `builtin-bindings', which is
	removed according to NEWS.
	(Pairs): Added documentation.
	* scheme-io.texi: Added R5RS index entries for all R5RS
	procedures.
	(File Ports): New docs for `call-with-input-file',
	`call-with-output-file', `with-input-from-file',
	`with-output-to-file', `with-error-to-file'.
	* scheme-control.texi, scheme-utility.texi,
	* scheme-procedures.texi: Added R5RS index entries for all R5RS
	procedures.
	* scheme-evaluation.texi (Fly Evaluation): Added documentation for
	`apply'.  Added R5RS index entries for all R5RS procedures.
	* scheme-data.texi: Added R5RS index entries for all R5RS
	procedures.  Removed R5RS index entries for `ass{q,v,occ}-set!'.
	Removed explicit entries into the function entries.  They are
	automagic.
	(Vectors): Added documentation for `make-vector', `vector-ref' and
	`vector-set!'.
2001-03-16 17:00:21 +00:00
Neil Jerram
38a93523eb Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00