[xemacs-hg @ 2002-07-31 07:23:39 by michaels] 2002-07-17 Marcus Crestani <crestani@informatik.uni-tuebingen.de> Markus Kaltenbach <makalten@informatik.uni-tuebingen.de> Mike Sperber <mike@xemacs.org> configure flag to turn these changes on: --use-kkcc First we added a dumpable flag to lrecord_implementation. It shows, if the object is dumpable and should be processed by the dumper. * lrecord.h (struct lrecord_implementation): added dumpable flag (MAKE_LRECORD_IMPLEMENTATION): fitted the different makro definitions to the new lrecord_implementation and their calls. Then we changed mark_object, that it no longer needs a mark method for those types that have pdump descritions. * alloc.c: (mark_object): If the object has a description, the new mark algorithm is called, and the object is marked according to its description. Otherwise it uses the mark method like before. These procedures mark objects according to their descriptions. They are modeled on the corresponding pdumper procedures. (mark_with_description): (get_indirect_count): (structure_size): (mark_struct_contents): These procedures still call mark_object, this is needed while there are Lisp_Objects without descriptions left. We added pdump descriptions for many Lisp_Objects: * extents.c: extent_auxiliary_description * database.c: database_description * gui.c: gui_item_description * scrollbar.c: scrollbar_instance_description * toolbar.c: toolbar_button_description * event-stream.c: command_builder_description * mule-charset.c: charset_description * device-msw.c: devmode_description * dialog-msw.c: mswindows_dialog_id_description * eldap.c: ldap_description * postgresql.c: pgconn_description pgresult_description * tooltalk.c: tooltalk_message_description tooltalk_pattern_description * ui-gtk.c: emacs_ffi_description emacs_gtk_object_description * events.c: * events.h: * event-stream.c: * event-Xt.c: * event-gtk.c: * event-tty.c: To write a pdump description for Lisp_Event, we converted every struct in the union event to a Lisp_Object. So we created nine new Lisp_Objects: Lisp_Key_Data, Lisp_Button_Data, Lisp_Motion_Data, Lisp_Process_Data, Lisp_Timeout_Data, Lisp_Eval_Data, Lisp_Misc_User_Data, Lisp_Magic_Data, Lisp_Magic_Eval_Data. We also wrote makro selectors and mutators for the fields of the new designed Lisp_Event and added everywhere these new abstractions. We implemented XD_UNION support in (mark_with_description), so we can describe exspecially console/device specific data with XD_UNION. To describe with XD_UNION, we added a field to these objects, which holds the variant type of the object. This field is initialized in the appendant constructor. The variant is an integer, it has also to be described in an description, if XD_UNION is used. XD_UNION is used in following descriptions: * console.c: console_description (get_console_variant): returns the variant (create_console): added variant initialization * console.h (console_variant): the different console types * console-impl.h (struct console): added enum console_variant contype * device.c: device_description (Fmake_device): added variant initialization * device-impl.h (struct device): added enum console_variant devtype * objects.c: image_instance_description font_instance_description (Fmake_color_instance): added variant initialization (Fmake_font_instance): added variant initialization * objects-impl.h (struct Lisp_Color_Instance): added color_instance_type * objects-impl.h (struct Lisp_Font_Instance): added font_instance_type * process.c: process_description (make_process_internal): added variant initialization * process.h (process_variant): the different process types

@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