Mercurial > hg > xemacs-beta
annotate modules/sample/internal/sample.c @ 5124:623d57b7fbe8 ben-lisp-object
separate regular and disksave finalization, print method fixes.
Create separate disksave method and make the finalize method only be for
actual object finalization, not disksave finalization.
Fix places where 0 was given in place of a printer -- print methods are
mandatory, and internal objects formerly without a print method now must
explicitly specify internal_object_printer().
Change the defn of CONSOLE_LIVE_P to avoid problems in some weird situations.
-------------------- ChangeLog entries follow: --------------------
src/ChangeLog addition:
2010-01-20 Ben Wing <ben@xemacs.org>
* alloc.c:
* alloc.c (very_old_free_lcrecord):
* alloc.c (disksave_object_finalization_1):
* alloc.c (make_lcrecord_list):
* alloc.c (alloc_managed_lcrecord):
* alloc.c (free_managed_lcrecord):
* alloc.c (sweep_lcrecords_1):
* buffer.c:
* bytecode.c:
* bytecode.c (Fcompiled_function_p):
* chartab.c:
* console-impl.h:
* console-impl.h (CONSOLE_TYPE_P):
* console.c:
* console.c (set_quit_events):
* data.c:
* data.c (Fmake_ephemeron):
* database.c:
* database.c (finalize_database):
* database.c (Fclose_database):
* device-msw.c:
* device-msw.c (finalize_devmode):
* device-msw.c (allocate_devmode):
* device.c:
* elhash.c:
* elhash.c (finalize_hash_table):
* eval.c:
* eval.c (bind_multiple_value_limits):
* event-stream.c:
* event-stream.c (finalize_command_builder):
* events.c:
* events.c (mark_event):
* extents.c:
* extents.c (finalize_extent_info):
* extents.c (uninit_buffer_extents):
* faces.c:
* file-coding.c:
* file-coding.c (finalize_coding_system):
* file-coding.h:
* file-coding.h (struct coding_system_methods):
* file-coding.h (struct detector):
* floatfns.c:
* floatfns.c (extract_float):
* fns.c:
* fns.c (Fidentity):
* font-mgr.c (finalize_fc_pattern):
* font-mgr.c (finalize_fc_config):
* frame.c:
* glyphs.c:
* glyphs.c (finalize_image_instance):
* glyphs.c (unmap_subwindow_instance_cache_mapper):
* gui.c:
* gui.c (gui_error):
* keymap.c:
* lisp.h (struct Lisp_Symbol):
* lrecord.h:
* lrecord.h (struct lrecord_implementation):
* lrecord.h (MC_ALLOC_CALL_FINALIZER):
* lrecord.h (MC_ALLOC_CALL_FINALIZER_FOR_DISKSAVE):
* lrecord.h (DEFINE_DUMPABLE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_GENERAL_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_SIZABLE_GENERAL_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_FROB_BLOCK_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_FROB_BLOCK_GENERAL_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_FROB_BLOCK_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_INTERNAL_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_SIZABLE_INTERNAL_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_GENERAL_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_SIZABLE_GENERAL_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_FROB_BLOCK_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_FROB_BLOCK_GENERAL_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_FROB_BLOCK_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_INTERNAL_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_SIZABLE_INTERNAL_LISP_OBJECT):
* lrecord.h (MAKE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_MODULE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_MODULE_GENERAL_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_MODULE_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_MODULE_SIZABLE_GENERAL_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_MODULE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_MODULE_GENERAL_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_MODULE_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_MODULE_SIZABLE_GENERAL_LISP_OBJECT):
* lrecord.h (MAKE_MODULE_LISP_OBJECT):
* lstream.c:
* lstream.c (finalize_lstream):
* lstream.c (disksave_lstream):
* marker.c:
* marker.c (finalize_marker):
* mule-charset.c (make_charset):
* number.c:
* objects.c:
* objects.c (finalize_color_instance):
* objects.c (finalize_font_instance):
* opaque.c:
* opaque.c (make_opaque_ptr):
* process-nt.c:
* process-nt.c (nt_finalize_process_data):
* process-nt.c (nt_deactivate_process):
* process.c:
* process.c (finalize_process):
* procimpl.h (struct process_methods):
* scrollbar.c:
* scrollbar.c (free_scrollbar_instance):
* specifier.c (finalize_specifier):
* symbols.c:
* toolbar.c:
* toolbar.c (Ftoolbar_button_p):
* tooltalk.c:
* ui-gtk.c:
* ui-gtk.c (emacs_gtk_object_finalizer):
* ui-gtk.c (allocate_emacs_gtk_boxed_data):
* window.c:
* window.c (finalize_window):
* window.c (mark_window_as_deleted):
Separate out regular and disksave finalization. Instead of a
FOR_DISKSAVE argument to the finalizer, create a separate object
method `disksaver'. Make `finalizer' have only one argument.
Go through and separate out all finalize methods into finalize
and disksave. Delete lots of thereby redundant disksave checking.
Delete places that signal an error if we attempt to disksave --
all of these objects are non-dumpable and we will get an error
from pdump anyway if we attempt to dump them. After this is done,
only one object remains that has a disksave method -- lstream.
Change DEFINE_*_LISP_OBJECT_WITH_PROPS to DEFINE_*_GENERAL_LISP_OBJECT,
which is used for specifying either property methods or disksave
methods (or in the future, any other less-used methods).
Remove the for_disksave argument to finalize_process_data. Don't
provide a disksaver for processes because no one currently needs
it.
Clean up various places where objects didn't provide a print method.
It was made mandatory in previous changes, and all methods now
either provide their own print method or use internal_object_printer
or external_object_printer.
Change the definition of CONSOLE_LIVE_P to use the contype enum
rather than looking into the conmeths structure -- in some weird
situations with dead objects, the conmeths structure is NULL,
and printing such objects from debug_print() will crash if we try
to look into the conmeths structure.
| author | Ben Wing <ben@xemacs.org> |
|---|---|
| date | Wed, 20 Jan 2010 07:05:57 -0600 |
| parents | dce479915b74 |
| children | dd9541c73e70 |
| rev | line source |
|---|---|
| 996 | 1 /* |
| 2 * Very simple sample module. Illustrates most of the salient features | |
| 3 * of Emacs dynamic modules. | |
| 4 * (C) Copyright 1998, 1999 J. Kean Johnston. All rights reserved. | |
| 5 * (C) Copyright 2002 Jerry James. | |
|
4737
dce479915b74
Clarify the GPL status of several sample module files. J. Kean Johnston
Jerry James <james@xemacs.org>
parents:
996
diff
changeset
|
6 * |
|
dce479915b74
Clarify the GPL status of several sample module files. J. Kean Johnston
Jerry James <james@xemacs.org>
parents:
996
diff
changeset
|
7 * This sample module code is free software; you can redistribute it and/or |
|
dce479915b74
Clarify the GPL status of several sample module files. J. Kean Johnston
Jerry James <james@xemacs.org>
parents:
996
diff
changeset
|
8 * modify it under the terms of the GNU General Public License as published |
|
dce479915b74
Clarify the GPL status of several sample module files. J. Kean Johnston
Jerry James <james@xemacs.org>
parents:
996
diff
changeset
|
9 * by the Free Software Foundation; either version 2, or (at your option) |
|
dce479915b74
Clarify the GPL status of several sample module files. J. Kean Johnston
Jerry James <james@xemacs.org>
parents:
996
diff
changeset
|
10 * any later version. |
| 996 | 11 */ |
| 12 | |
| 13 #include <config.h> | |
| 14 #include "lisp.h" | |
| 15 | |
| 16 /* | |
| 17 * This sample introduces three new Lisp objects to the Lisp reader. | |
| 18 * The first, a simple boolean value, and the second a string. The | |
| 19 * Third is a sample function that simply prints a message. | |
| 20 */ | |
| 21 int sample_bool; | |
| 22 Lisp_Object Vsample_string; | |
| 23 | |
| 24 DEFUN ("sample-function", Fsample_function, 0, 0, "", /* | |
| 25 This is a sample function loaded dynamically. | |
| 26 | |
| 27 You will notice in the source code for this module that the | |
| 28 declaration is identical to internal Emacs functions. This | |
| 29 makes it possible to use the exact same code in a dumped | |
| 30 version of Emacs. | |
| 31 */ | |
| 32 ()) | |
| 33 { | |
| 34 message ("Eureka! It worked"); | |
| 35 return Qt; | |
| 36 } | |
| 37 | |
| 38 /* | |
| 39 * Each dynamically loaded Emacs module is given a name at compile | |
| 40 * time. This is a short name, and must be a valid part of a C | |
| 41 * identifier. This name is used to construct the name of several | |
| 42 * functions which must appear in the module source code. | |
| 43 * The first such function, modules_of_XXXX, should load in any dependent | |
| 44 * modules. This function is optional, and the module will still load if | |
| 45 * it is not present in the module. | |
| 46 * | |
| 47 * The second function, which is NOT optional, is syms_of_XXXX, in which | |
| 48 * all functions that the module will be provided are declared. This | |
| 49 * function will contain calls to DEFSUBR(). | |
| 50 * | |
| 51 * The third function, which is also NOT optional, is vars_of_XXXX, in | |
| 52 * which you declare all variables that the module provides. This | |
| 53 * function will contain calls to DEFVAR_LISP(), DEFVAR_BOOL() etc. | |
| 54 * | |
| 55 * When declaring functions and variables in the syms_of_XXXX and | |
| 56 * vars_of_XXXX functions, you use the exact same syntax that you | |
| 57 * would as if this module were being compiled into the pure Emacs. | |
| 58 * | |
| 59 * The fourth function, which is optional, is unload_XXXX, in which actions | |
| 60 * that must be taken to unload the module are listed. XEmacs will unbind | |
| 61 * functions and variables for you. Anything else that must be done should | |
| 62 * appear in this function. | |
| 63 * | |
| 64 * All four of these functions are declared as void functions, | |
| 65 * taking no parameters. Since this sample module is called 'sample', | |
| 66 * the functions will be named 'modules_of_sample', 'syms_of_sample', | |
| 67 * 'vars_of_sample', and 'unload_sample'. | |
| 68 */ | |
| 69 | |
| 70 void | |
| 71 modules_of_sample() | |
| 72 { | |
| 73 /* | |
| 74 * This function isn't actually required as we will not be loading | |
| 75 * in any dependent modules, but if we were, we would do something like: | |
| 76 * emodules_load ("dependent.ell", "sample2", "1.0.0"); | |
| 77 */ | |
| 78 } | |
| 79 | |
| 80 void | |
| 81 syms_of_sample() | |
| 82 { | |
| 83 DEFSUBR(Fsample_function); | |
| 84 } | |
| 85 | |
| 86 void | |
| 87 vars_of_sample() | |
| 88 { | |
| 89 DEFVAR_LISP ("sample-string", &Vsample_string /* | |
| 90 This is a sample string, declared in a dynamic module. | |
| 91 | |
| 92 The syntax and conventions used for all normal Emacs variables | |
| 93 apply equally to modules, using an identical syntax. | |
| 94 */ ); | |
| 95 | |
| 96 DEFVAR_BOOL ("sample-boolean", &sample_bool /* | |
| 97 *Sample boolean value, in a dynamic module. | |
| 98 | |
| 99 This is a user-settable variable, as indicated by the * | |
| 100 as the first character of the description. Declared in | |
| 101 a module exactly as it would be internally in Emacs. | |
| 102 */ ); | |
| 103 } | |
| 104 | |
| 105 #ifdef HAVE_SHLIB | |
| 106 void | |
| 107 unload_sample() | |
| 108 { | |
| 109 /* We don't need to do anything here in the sample case. However, if you | |
| 110 create any new types with INIT_LRECORD_IMPLEMENTATION (sample_type), then | |
| 111 UNDEF_LRECORD_IMPLEMENTATION (sample_type) must appear here. Also, any | |
| 112 symbols declared with DEFSYMBOL (Qsample_var), or one of its variants, | |
| 113 must have a corresponding unstaticpro_nodump (&Qsample_var) here. */ | |
| 114 } | |
| 115 #endif |