Mercurial > hg > xemacs-beta
annotate lisp/gutter.el @ 5157:1fae11d56ad2
redo memory-usage mechanism, add way of dynamically initializing Lisp objects
-------------------- ChangeLog entries follow: --------------------
lisp/ChangeLog addition:
2010-03-18 Ben Wing <ben@xemacs.org>
* diagnose.el (show-memory-usage):
Rewrite to take into account API changes in memory-usage functions.
src/ChangeLog addition:
2010-03-18 Ben Wing <ben@xemacs.org>
* alloc.c:
* alloc.c (disksave_object_finalization_1):
* alloc.c (lisp_object_storage_size):
* alloc.c (listu):
* alloc.c (listn):
* alloc.c (Fobject_memory_usage_stats):
* alloc.c (compute_memusage_stats_length):
* alloc.c (Fobject_memory_usage):
* alloc.c (Ftotal_object_memory_usage):
* alloc.c (malloced_storage_size):
* alloc.c (common_init_alloc_early):
* alloc.c (reinit_alloc_objects_early):
* alloc.c (reinit_alloc_early):
* alloc.c (init_alloc_once_early):
* alloc.c (syms_of_alloc):
* alloc.c (reinit_vars_of_alloc):
* buffer.c:
* buffer.c (struct buffer_stats):
* buffer.c (compute_buffer_text_usage):
* buffer.c (compute_buffer_usage):
* buffer.c (buffer_memory_usage):
* buffer.c (buffer_objects_create):
* buffer.c (syms_of_buffer):
* buffer.c (vars_of_buffer):
* console-impl.h (struct console_methods):
* dynarr.c (Dynarr_memory_usage):
* emacs.c (main_1):
* events.c (clear_event_resource):
* extents.c:
* extents.c (compute_buffer_extent_usage):
* extents.c (extent_objects_create):
* extents.h:
* faces.c:
* faces.c (compute_face_cachel_usage):
* faces.c (face_objects_create):
* faces.h:
* general-slots.h:
* glyphs.c:
* glyphs.c (compute_glyph_cachel_usage):
* glyphs.c (glyph_objects_create):
* glyphs.h:
* lisp.h:
* lisp.h (struct usage_stats):
* lrecord.h:
* lrecord.h (enum lrecord_type):
* lrecord.h (struct lrecord_implementation):
* lrecord.h (MC_ALLOC_CALL_FINALIZER_FOR_DISKSAVE):
* lrecord.h (DEFINE_DUMPABLE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_DUMPABLE_FROB_BLOCK_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_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_FROB_BLOCK_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_SIZABLE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_MODULE_LISP_OBJECT):
* lrecord.h (DEFINE_NODUMP_MODULE_SIZABLE_LISP_OBJECT):
* lrecord.h (MAKE_MODULE_LISP_OBJECT):
* lrecord.h (INIT_LISP_OBJECT):
* lrecord.h (INIT_MODULE_LISP_OBJECT):
* lrecord.h (UNDEF_LISP_OBJECT):
* lrecord.h (UNDEF_MODULE_LISP_OBJECT):
* lrecord.h (DECLARE_LISP_OBJECT):
* lrecord.h (DECLARE_MODULE_API_LISP_OBJECT):
* lrecord.h (DECLARE_MODULE_LISP_OBJECT):
* lstream.c:
* lstream.c (syms_of_lstream):
* lstream.c (vars_of_lstream):
* marker.c:
* marker.c (compute_buffer_marker_usage):
* mc-alloc.c (mc_alloced_storage_size):
* mc-alloc.h:
* mule-charset.c:
* mule-charset.c (struct charset_stats):
* mule-charset.c (compute_charset_usage):
* mule-charset.c (charset_memory_usage):
* mule-charset.c (mule_charset_objects_create):
* mule-charset.c (syms_of_mule_charset):
* mule-charset.c (vars_of_mule_charset):
* redisplay.c:
* redisplay.c (compute_rune_dynarr_usage):
* redisplay.c (compute_display_block_dynarr_usage):
* redisplay.c (compute_glyph_block_dynarr_usage):
* redisplay.c (compute_display_line_dynarr_usage):
* redisplay.c (compute_line_start_cache_dynarr_usage):
* redisplay.h:
* scrollbar-gtk.c (gtk_compute_scrollbar_instance_usage):
* scrollbar-msw.c (mswindows_compute_scrollbar_instance_usage):
* scrollbar-x.c (x_compute_scrollbar_instance_usage):
* scrollbar.c (compute_scrollbar_instance_usage):
* scrollbar.h:
* symbols.c:
* symbols.c (reinit_symbol_objects_early):
* symbols.c (init_symbols_once_early):
* symbols.c (reinit_symbols_early):
* symbols.c (defsymbol_massage_name_1):
* symsinit.h:
* ui-gtk.c:
* ui-gtk.c (emacs_gtk_object_getprop):
* ui-gtk.c (emacs_gtk_object_putprop):
* ui-gtk.c (ui_gtk_objects_create):
* unicode.c (compute_from_unicode_table_size_1):
* unicode.c (compute_to_unicode_table_size_1):
* unicode.c (compute_from_unicode_table_size):
* unicode.c (compute_to_unicode_table_size):
* window.c:
* window.c (struct window_stats):
* window.c (compute_window_mirror_usage):
* window.c (compute_window_usage):
* window.c (window_memory_usage):
* window.c (window_objects_create):
* window.c (syms_of_window):
* window.c (vars_of_window):
* window.h:
Redo memory-usage mechanism, make it general; add way of dynamically
initializing Lisp object types -- OBJECT_HAS_METHOD(), similar to
CONSOLE_HAS_METHOD().
(1) Create OBJECT_HAS_METHOD(), OBJECT_HAS_PROPERTY() etc. for
specifying that a Lisp object type has a particular method or
property. Call such methods with OBJECT_METH, MAYBE_OBJECT_METH,
OBJECT_METH_OR_GIVEN; retrieve properties with OBJECT_PROPERTY.
Methods that formerly required a DEFINE_*GENERAL_LISP_OBJECT() to
specify them (getprop, putprop, remprop, plist, disksave) now
instead use the dynamic-method mechanism. The main benefit of
this is that new methods or properties can be added without
requiring that the declaration statements of all existing methods
be modified. We have to make the `struct lrecord_implementation'
non-const, but I don't think this should have any effect on speed --
the only possible method that's really speed-critical is the
mark method, and we already extract those out into a separate
(non-const) array for increased cache locality.
Object methods need to be reinitialized after pdump, so we put
them in separate functions such as face_objects_create(),
extent_objects_create() and call them appropriately from emacs.c
The only current object property (`memusage_stats_list') that
objects can specify is a Lisp object and gets staticpro()ed so it
only needs to be set during dump time, but because it references
symbols that might not exist in a syms_of_() function, we
initialize it in vars_of_(). There is also an object property
(`num_extra_memusage_stats') that is automatically initialized based
on `memusage_stats_list'; we do that in reinit_vars_of_alloc(),
which is called after all vars_of_() functions are called.
`disksaver' method was renamed `disksave' to correspond with the
name normally given to the function (e.g. disksave_lstream()).
(2) Generalize the memory-usage mechanism in `buffer-memory-usage',
`window-memory-usage', `charset-memory-usage' into an object-type-
specific mechanism called by a single function
`object-memory-usage'. (Former function `object-memory-usage'
renamed to `total-object-memory-usage'). Generalize the mechanism
of different "slices" so that we can have different "classes" of
memory described and different "slices" onto each class; `t'
separates classes, `nil' separates slices. Currently we have
three classes defined: the memory of an object itself,
non-Lisp-object memory associated with the object (e.g. arrays or
dynarrs stored as fields in the object), and Lisp-object memory
associated with the object (other internal Lisp objects stored in
the object). This isn't completely finished yet and we might need
to further separate the "other internal Lisp objects" class into
two classes.
The memory-usage mechanism uses a `struct usage_stats' (renamed
from `struct overhead_stats') to describe a malloc-view onto a set
of allocated memory (listing how much was requested and various
types of overhead) and a more general `struct generic_usage_stats'
(with a `struct usage_stats' in it) to hold all statistics about
object memory. `struct generic_usage_stats' contains an array of
32 Bytecounts, which are statistics of unspecified semantics. The
intention is that individual types declare a corresponding struct
(e.g. `struct window_stats') with the same structure but with
specific fields in place of the array, corresponding to specific
statistics. The number of such statistics is an object property
computed from the list of tags (Lisp symbols describing the
statistics) stored in `memusage_stats_list'. The idea here is to
allow particular object types to customize the number and
semantics of the statistics where completely avoiding consing.
This doesn't matter so much yet, but the intention is to have the
memory usage of all objects computed at the end of GC, at the same
time as other statistics are currently computed. The values for
all statistics for a single type would be added up to compute
aggregate values for all objects of a specific type. To make this
efficient, we can't allow any memory allocation at all.
(3) Create some additional functions for creating lists that
specify the elements directly as args rather than indirectly through
an array: listn() (number of args given), listu() (list terminated
by Qunbound).
(4) Delete a bit of remaining unused C window_config stuff, also
unused lrecord_type_popup_data.
| author | Ben Wing <ben@xemacs.org> |
|---|---|
| date | Thu, 18 Mar 2010 10:50:06 -0500 |
| parents | 54fa1a5c2d12 |
| children | cd167465bf69 308d34e9f07d |
| rev | line source |
|---|---|
| 442 | 1 ;;; gutter.el --- Gutter manipulation for XEmacs. |
| 2 | |
| 3 ;; Copyright (C) 1999 Free Software Foundation, Inc. | |
| 4 ;; Copyright (C) 1999, 2000 Andy Piper. | |
| 5 | |
| 6 ;; Maintainer: XEmacs Development Team | |
| 7 ;; Keywords: frames, gui, internal, dumped | |
| 8 | |
| 9 ;; This file is part of XEmacs. | |
| 10 | |
| 11 ;; XEmacs is free software; you can redistribute it and/or modify it | |
| 12 ;; under the terms of the GNU General Public License as published by | |
| 13 ;; the Free Software Foundation; either version 2, or (at your option) | |
| 14 ;; any later version. | |
| 15 | |
| 16 ;; XEmacs is distributed in the hope that it will be useful, but | |
| 17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 19 ;; General Public License for more details. | |
| 20 | |
| 21 ;; You should have received a copy of the GNU General Public License | |
| 22 ;; along with Xmacs; see the file COPYING. If not, write to the | |
| 23 ;; Free Software Foundation, 59 Temple Place - Suite 330, | |
| 24 ;; Boston, MA 02111-1307, USA. | |
| 25 | |
| 26 ;; Some of this is taken from the buffer-menu stuff in menubar-items.el | |
| 27 ;; and the custom specs in toolbar.el. | |
| 28 | |
| 29 (defgroup gutter nil | |
| 30 "Input from the gutters." | |
| 31 :group 'environment) | |
| 32 | |
| 33 ;; Although these customizations appear bogus, they are necessary in | |
| 34 ;; order to be able to save options through the options menu. | |
| 35 (defcustom default-gutter-position | |
| 36 (default-gutter-position) | |
| 37 "The location of the default gutter. It can be 'top, 'bottom, 'left or | |
| 38 'right. This option should be customized through the options menu. | |
| 39 To set the gutter position explicitly use `set-default-gutter-position'" | |
| 40 :group 'gutter | |
| 41 :type '(choice (const :tag "top" top) | |
| 42 (const :tag "bottom" bottom) | |
| 43 (const :tag "left" left) | |
| 44 (const :tag "right" right)) | |
| 45 :set #'(lambda (var val) | |
| 46 (set-default-gutter-position val) | |
| 47 (setq default-gutter-position val))) | |
| 48 | |
| 49 ;;; Gutter helper functions | |
| 50 | |
| 51 ;; called by Fset_default_gutter_position() | |
| 52 (defvar default-gutter-position-changed-hook nil | |
| 53 "Function or functions to be called when the gutter position is changed. | |
| 54 The value of this variable may be buffer-local.") | |
| 55 | |
| 56 ;; called by set-gutter-element-visible-p | |
| 57 (defvar gutter-element-visibility-changed-hook nil | |
| 58 "Function or functions to be called when the visibility of an | |
| 59 element in the gutter changes. The value of this variable may be | |
| 60 buffer-local. The gutter element symbol is passed as an argument to | |
| 61 the hook, as is the visibility flag.") | |
| 62 | |
| 444 | 63 (defun set-gutter-element (gutter-specifier prop value &optional locale tag-set) |
| 64 "Set GUTTER-SPECIFIER gutter element PROP to VALUE in optional LOCALE. | |
| 442 | 65 This is a convenience function for setting gutter elements. |
| 444 | 66 VALUE in general must be a string. If VALUE is a glyph then a string |
| 67 will be created to put the glyph into." | |
| 68 (let ((spec value)) | |
| 69 (when (glyphp value) | |
| 442 | 70 (setq spec (copy-sequence "\n")) |
| 444 | 71 (set-extent-begin-glyph (make-extent 0 1 spec) value)) |
| 442 | 72 (map-extents #'(lambda (extent arg) |
| 73 (set-extent-property extent 'duplicable t)) spec) | |
| 74 (modify-specifier-instances gutter-specifier #'plist-put (list prop spec) | |
| 75 'force nil locale tag-set))) | |
| 76 | |
| 77 (defun remove-gutter-element (gutter-specifier prop &optional locale tag-set) | |
| 78 "Remove gutter element PROP from GUTTER-SPECIFIER in optional LOCALE. | |
| 79 This is a convenience function for removing gutter elements." | |
| 80 (modify-specifier-instances gutter-specifier #'plist-remprop (list prop) | |
| 81 'force nil locale tag-set)) | |
| 82 | |
| 83 (defun set-gutter-element-visible-p (gutter-visible-specifier-p | |
| 84 prop &optional visible-p | |
| 85 locale tag-set) | |
| 86 "Change the visibility of gutter elements. | |
| 87 Set the visibility of element PROP to VISIBLE-P for | |
| 88 GUTTER-SPECIFIER-VISIBLE-P in optional LOCALE. | |
| 89 This is a convenience function for hiding and showing gutter elements." | |
| 90 (modify-specifier-instances | |
| 91 gutter-visible-specifier-p #'(lambda (spec prop visible-p) | |
| 92 (if (consp spec) | |
| 93 (if visible-p | |
| 94 (if (memq prop spec) spec | |
| 95 (cons prop spec)) | |
| 96 (delq prop spec)) | |
| 97 (if visible-p (list prop)))) | |
| 98 (list prop visible-p) | |
| 99 'force nil locale tag-set) | |
| 100 (run-hook-with-args 'gutter-element-visibility-changed-hook prop visible-p)) | |
| 101 | |
| 102 (defun gutter-element-visible-p (gutter-visible-specifier-p | |
| 103 prop &optional domain) | |
| 104 "Determine whether a gutter element is visible. | |
| 105 Given GUTTER-VISIBLE-SPECIFIER-P and gutter element PROP, return | |
| 106 non-nil if it is visible in optional DOMAIN." | |
| 107 (let ((spec (specifier-instance gutter-visible-specifier-p domain))) | |
| 108 (or (and (listp spec) (memq 'buffers-tab spec)) | |
| 109 spec))) | |
| 110 | |
| 458 | 111 (defun set-gutter-dirty-p (gutter-or-location) |
| 112 "Make GUTTER-OR-LOCATION dirty to force redisplay updates." | |
| 113 ;; set-glyph-image will not make the gutter dirty | |
| 114 (when (or (gutter-specifier-p gutter-or-location) | |
| 115 (eq gutter-or-location 'top) | |
| 116 (eq gutter-or-location 'bottom) | |
| 117 (eq gutter-or-location 'left) | |
| 118 (eq gutter-or-location 'right)) | |
| 119 (or (gutter-specifier-p gutter-or-location) | |
| 120 (setq gutter-or-location | |
| 121 (eval (intern (concat | |
| 122 (symbol-name gutter-or-location) | |
| 123 "-gutter"))))) | |
| 124 (set-specifier-dirty-flag gutter-or-location))) | |
| 125 | |
| 442 | 126 (defun make-gutter-specifier (spec-list) |
| 127 "Return a new `gutter' specifier object with the given specification list. | |
| 128 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
| 129 locale and a list of instantiators), a single instantiator, or a list | |
| 130 of instantiators. See `make-specifier' for more information about | |
| 131 specifiers. | |
| 132 | |
| 133 Gutter specifiers are used to specify the format of a gutter. | |
| 134 The values of the variables `default-gutter', `top-gutter', | |
| 135 `left-gutter', `right-gutter', and `bottom-gutter' are always | |
| 136 gutter specifiers. | |
| 137 | |
| 138 Valid gutter instantiators are called \"gutter descriptors\" and are | |
| 139 either strings or property-lists of strings. See `default-gutter' for | |
| 140 a description of the exact format." | |
| 141 (make-specifier-and-init 'gutter spec-list)) | |
| 142 | |
| 143 (defun make-gutter-size-specifier (spec-list) | |
| 144 "Return a new `gutter-size' specifier object with the given spec list. | |
| 145 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
| 146 locale and a list of instantiators), a single instantiator, or a list | |
| 147 of instantiators. See `make-specifier' for more information about | |
| 148 specifiers. | |
| 149 | |
| 150 Gutter-size specifiers are used to specify the size of a gutter. The | |
| 151 values of the variables `default-gutter-size', `top-gutter-size', | |
| 152 `left-gutter-size', `right-gutter-size', and `bottom-gutter-size' are | |
| 153 always gutter-size specifiers. | |
| 154 | |
| 155 Valid gutter-size instantiators are either integers or the special | |
| 156 symbol 'autodetect. If a gutter-size is set to 'autodetect them the | |
| 157 size of the gutter will be adjusted to just accommodate the gutters | |
| 158 contents. 'autodetect only works for top and bottom gutters." | |
| 159 (make-specifier-and-init 'gutter-size spec-list)) | |
| 160 | |
| 161 (defun make-gutter-visible-specifier (spec-list) | |
| 162 "Return a new `gutter-visible' specifier object with the given spec list. | |
| 163 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
| 164 locale and a list of instantiators), a single instantiator, or a list | |
| 165 of instantiators. See `make-specifier' for more information about | |
| 166 specifiers. | |
| 167 | |
| 168 Gutter-visible specifiers are used to specify the visibility of a | |
| 169 gutter. The values of the variables `default-gutter-visible-p', | |
| 170 `top-gutter-visible-p', `left-gutter-visible-p', | |
| 171 `right-gutter-visible-p', and `bottom-gutter-visible-p' are always | |
| 172 gutter-visible specifiers. | |
| 173 | |
| 174 Valid gutter-visible instantiators are t, nil or a list of symbols. | |
| 175 If a gutter-visible instantiator is set to a list of symbols, and the | |
| 176 corresponding gutter specification is a property-list strings, then | |
| 177 elements of the gutter specification will only be visible if the | |
| 178 corresponding symbol occurs in the gutter-visible instantiator." | |
| 179 (make-specifier-and-init 'gutter-visible spec-list)) | |
| 180 | |
| 181 ;;; gutter.el ends here. | |
| 182 | |
| 183 |