view man/lispref/databases.texi @ 5327:d1b17a33450b

Move the heavy lifting from cl-seq.el to C. src/ChangeLog addition: 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> Move the heavy lifting from cl-seq.el to C, finally making those functions first-class XEmacs citizens, with circularity checking, built-in support for tests other than #'eql, and as much compatibility with current Common Lisp as Paul Dietz' tests require. * fns.c (check_eq_nokey, check_eq_key, check_eql_nokey) (check_eql_key, check_equal_nokey, check_equal_key) (check_equalp_nokey, check_equalp_key, check_string_match_nokey) (check_string_match_key, check_other_nokey, check_other_key) (check_if_nokey, check_if_key, check_match_eq_key) (check_match_eql_key, check_match_equal_key) (check_match_equalp_key, check_match_other_key): New. These are basically to provide function pointers to be used by Lisp functions that take TEST, TEST-NOT and KEY arguments. (get_check_match_function_1, get_check_test_function) (get_check_match_function): These functions work out which of the previous list of functions to use, given the keywords supplied by the user. (count_with_tail): New. This is the bones of #'count. (list_count_from_end, string_count_from_end): Utility functions for #'count. (Fcount): New, moved from cl-seq.el. (list_position_cons_before): New. The implementation of #'member*, and important in implementing various other functions. (FmemberX, Fadjoin, FassocX, FrassocX, Fposition, Ffind) (FdeleteX, FremoveX, Fdelete_duplicates, Fremove_duplicates) (Fnsubstitute, Fsubstitute, Fsublis, Fnsublis, Fsubst, Fnsubst) (Ftree_equal, Fmismatch, Fsearch, Fintersection, Fnintersection) (Fsubsetp, Fset_difference, Fnset_difference, Fnunion, Funion) (Fset_exclusive_or, Fnset_exclusive_or): New, moved here from cl-seq.el. (position): New. The implementation of #'find and #'position. (list_delete_duplicates_from_end, subst, sublis, nsublis) (tree_equal, mismatch_from_end, mismatch_list_list) (mismatch_list_string, mismatch_list_array) (mismatch_string_array, mismatch_string_string) (mismatch_array_array, get_mismatch_func): Helper C functions for the Lisp-visible functions. (venn, nvenn): New. The implementation of the main Lisp functions that treat lists as sets. lisp/ChangeLog addition: 2010-12-30 Aidan Kehoe <kehoea@parhasard.net> * cl-seq.el: Move the heavy lifting from this file to C. Dump the cl-parsing-keywords macro, but don't use defun* for the functions we define that do take keywords, dynamic scope lossage makes that not practical. * subr.el (sort, fillarray): Move these aliases here. (map-plist): #'nsublis is now built-in, but at this point #'eql isn't necessarily available as a test; use #'eq. * obsolete.el (cl-delete-duplicates): Make this available for old compiler macros and old code. (memql): Document that this is equivalent to #'member*, and worse. * cl.el (adjoin, subst): Removed. These are in C.
author Aidan Kehoe <kehoea@parhasard.net>
date Thu, 30 Dec 2010 01:59:52 +0000
parents 576fb035e263
children 9fae6227ede5
line wrap: on
line source

@c -*-texinfo-*-
@c This is part of the XEmacs Lisp Reference Manual.
@c Copyright (C) 1996 Ben Wing.
@c See the file lispref.texi for copying conditions.
@setfilename ../../info/databases.info
@node Databases, Processes, Range Tables, top
@chapter Databases
@cindex database

@defun databasep object
This function returns non-@code{nil} if @var{object} is a database.
@end defun

@menu
* Connecting to a Database::
* Working With a Database::
* Other Database Functions::
@end menu

@node Connecting to a Database
@section Connecting to a Database

@defun open-database file &optional type subtype access mode
This function opens database @var{file}, using database method
@var{type} and @var{subtype}, with access rights @var{access} and
permissions @var{mode}.  @var{access} can be any combination of @code{r}
@code{w} and @code{+}, for read, write, and creation flags.

@var{type} can have the value @code{'dbm} or @code{'berkeley-db} to
select the type of database file to use.  (Note:  XEmacs may not
support both of these types.)

For a @var{type} of @code{'dbm}, there are no subtypes, so
@var{subtype} should be @code{nil}.

For a @var{type} of @code{'berkeley-db}, the following subtypes are
available:  @code{'hash}, @code{'btree}, and @code{'recno}.  See the
manpages for the Berkeley DB functions for more information about these
types.
@end defun

@defun close-database database
This function closes database @var{database}.
@end defun

@defun database-live-p object
This function returns @code{t} if @var{object} is an active database, else
@code{nil}.
@end defun

@node Working With a Database
@section Working With a Database

@defun get-database key database &optional default
This function finds the value for @var{key} in @var{database}.  If there is no
corresponding value, @var{default} is returned (@code{nil} if @var{default} is
omitted).
@end defun

@defun map-database function database
This function maps @var{function} over entries in @var{database},
calling it with two args, each key and value in the database.
@end defun

@defun put-database key value database &optional replace
This function stores @var{key} and @var{value} in @var{database}.
If optional fourth arg @var{replace} is non-@code{nil}, replace any
existing entry in the database.
@end defun

@defun remove-database key database
This function removes @var{key} from @var{database}.
@end defun

@node Other Database Functions
@section Other Database Functions

@defun database-file-name database
This function returns the filename associated with @var{database}.
@end defun

@defun database-last-error &optional database
This function returns the last error associated with @var{database}.
@end defun

@defun database-subtype database
This function returns the subtype of @var{database}, if any.
@end defun

@defun database-type database
This function returns the type of @var{database}.
@end defun