Mercurial > hg > xemacs-beta
annotate lisp/objects.el @ 5127:a9c41067dd88 ben-lisp-object
more cleanups, terminology clarification, lots of doc work
-------------------- ChangeLog entries follow: --------------------
man/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* internals/internals.texi (Introduction to Allocation):
* internals/internals.texi (Integers and Characters):
* internals/internals.texi (Allocation from Frob Blocks):
* internals/internals.texi (lrecords):
* internals/internals.texi (Low-level allocation):
Rewrite section on allocation of Lisp objects to reflect the new
reality. Remove references to nonexistent XSETINT and XSETCHAR.
modules/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* postgresql/postgresql.c (allocate_pgconn):
* postgresql/postgresql.c (allocate_pgresult):
* postgresql/postgresql.h (struct Lisp_PGconn):
* postgresql/postgresql.h (struct Lisp_PGresult):
* ldap/eldap.c (allocate_ldap):
* ldap/eldap.h (struct Lisp_LDAP):
Same changes as in src/ dir. See large log there in ChangeLog,
but basically:
ALLOC_LISP_OBJECT -> ALLOC_NORMAL_LISP_OBJECT
LISP_OBJECT_HEADER -> NORMAL_LISP_OBJECT_HEADER
../hlo/src/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* alloc.c:
* alloc.c (old_alloc_sized_lcrecord):
* alloc.c (very_old_free_lcrecord):
* alloc.c (copy_lisp_object):
* alloc.c (zero_sized_lisp_object):
* alloc.c (zero_nonsized_lisp_object):
* alloc.c (lisp_object_storage_size):
* alloc.c (free_normal_lisp_object):
* alloc.c (FREE_FIXED_TYPE_WHEN_NOT_IN_GC):
* alloc.c (ALLOC_FROB_BLOCK_LISP_OBJECT):
* alloc.c (Fcons):
* alloc.c (noseeum_cons):
* alloc.c (make_float):
* alloc.c (make_bignum):
* alloc.c (make_bignum_bg):
* alloc.c (make_ratio):
* alloc.c (make_ratio_bg):
* alloc.c (make_ratio_rt):
* alloc.c (make_bigfloat):
* alloc.c (make_bigfloat_bf):
* alloc.c (size_vector):
* alloc.c (make_compiled_function):
* alloc.c (Fmake_symbol):
* alloc.c (allocate_extent):
* alloc.c (allocate_event):
* alloc.c (make_key_data):
* alloc.c (make_button_data):
* alloc.c (make_motion_data):
* alloc.c (make_process_data):
* alloc.c (make_timeout_data):
* alloc.c (make_magic_data):
* alloc.c (make_magic_eval_data):
* alloc.c (make_eval_data):
* alloc.c (make_misc_user_data):
* alloc.c (Fmake_marker):
* alloc.c (noseeum_make_marker):
* alloc.c (size_string_direct_data):
* alloc.c (make_uninit_string):
* alloc.c (make_string_nocopy):
* alloc.c (mark_lcrecord_list):
* alloc.c (alloc_managed_lcrecord):
* alloc.c (free_managed_lcrecord):
* alloc.c (sweep_lcrecords_1):
* alloc.c (malloced_storage_size):
* buffer.c (allocate_buffer):
* buffer.c (compute_buffer_usage):
* buffer.c (DEFVAR_BUFFER_LOCAL_1):
* buffer.c (nuke_all_buffer_slots):
* buffer.c (common_init_complex_vars_of_buffer):
* buffer.h (struct buffer_text):
* buffer.h (struct buffer):
* bytecode.c:
* bytecode.c (make_compiled_function_args):
* bytecode.c (size_compiled_function_args):
* bytecode.h (struct compiled_function_args):
* casetab.c (allocate_case_table):
* casetab.h (struct Lisp_Case_Table):
* charset.h (struct Lisp_Charset):
* chartab.c (fill_char_table):
* chartab.c (Fmake_char_table):
* chartab.c (make_char_table_entry):
* chartab.c (copy_char_table_entry):
* chartab.c (Fcopy_char_table):
* chartab.c (put_char_table):
* chartab.h (struct Lisp_Char_Table_Entry):
* chartab.h (struct Lisp_Char_Table):
* console-gtk-impl.h (struct gtk_device):
* console-gtk-impl.h (struct gtk_frame):
* console-impl.h (struct console):
* console-msw-impl.h (struct Lisp_Devmode):
* console-msw-impl.h (struct mswindows_device):
* console-msw-impl.h (struct msprinter_device):
* console-msw-impl.h (struct mswindows_frame):
* console-msw-impl.h (struct mswindows_dialog_id):
* console-stream-impl.h (struct stream_console):
* console-stream.c (stream_init_console):
* console-tty-impl.h (struct tty_console):
* console-tty-impl.h (struct tty_device):
* console-tty.c (allocate_tty_console_struct):
* console-x-impl.h (struct x_device):
* console-x-impl.h (struct x_frame):
* console.c (allocate_console):
* console.c (nuke_all_console_slots):
* console.c (DEFVAR_CONSOLE_LOCAL_1):
* console.c (common_init_complex_vars_of_console):
* data.c (make_weak_list):
* data.c (make_weak_box):
* data.c (make_ephemeron):
* database.c:
* database.c (struct Lisp_Database):
* database.c (allocate_database):
* database.c (finalize_database):
* device-gtk.c (allocate_gtk_device_struct):
* device-impl.h (struct device):
* device-msw.c:
* device-msw.c (mswindows_init_device):
* device-msw.c (msprinter_init_device):
* device-msw.c (finalize_devmode):
* device-msw.c (allocate_devmode):
* device-tty.c (allocate_tty_device_struct):
* device-x.c (allocate_x_device_struct):
* device.c:
* device.c (nuke_all_device_slots):
* device.c (allocate_device):
* dialog-msw.c (handle_question_dialog_box):
* elhash.c:
* elhash.c (struct Lisp_Hash_Table):
* elhash.c (finalize_hash_table):
* elhash.c (make_general_lisp_hash_table):
* elhash.c (Fcopy_hash_table):
* elhash.h (htentry):
* emacs.c (main_1):
* eval.c:
* eval.c (size_multiple_value):
* event-stream.c (finalize_command_builder):
* event-stream.c (allocate_command_builder):
* event-stream.c (free_command_builder):
* event-stream.c (event_stream_generate_wakeup):
* event-stream.c (event_stream_resignal_wakeup):
* event-stream.c (event_stream_disable_wakeup):
* event-stream.c (event_stream_wakeup_pending_p):
* events.h (struct Lisp_Timeout):
* events.h (struct command_builder):
* extents-impl.h:
* extents-impl.h (struct extent_auxiliary):
* extents-impl.h (struct extent_info):
* extents-impl.h (set_extent_no_chase_aux_field):
* extents-impl.h (set_extent_no_chase_normal_field):
* extents.c:
* extents.c (gap_array_marker):
* extents.c (gap_array):
* extents.c (extent_list_marker):
* extents.c (extent_list):
* extents.c (stack_of_extents):
* extents.c (gap_array_make_marker):
* extents.c (extent_list_make_marker):
* extents.c (allocate_extent_list):
* extents.c (SLOT):
* extents.c (mark_extent_auxiliary):
* extents.c (allocate_extent_auxiliary):
* extents.c (attach_extent_auxiliary):
* extents.c (size_gap_array):
* extents.c (finalize_extent_info):
* extents.c (allocate_extent_info):
* extents.c (uninit_buffer_extents):
* extents.c (allocate_soe):
* extents.c (copy_extent):
* extents.c (vars_of_extents):
* extents.h:
* faces.c (allocate_face):
* faces.h (struct Lisp_Face):
* faces.h (struct face_cachel):
* file-coding.c:
* file-coding.c (finalize_coding_system):
* file-coding.c (sizeof_coding_system):
* file-coding.c (Fcopy_coding_system):
* file-coding.h (struct Lisp_Coding_System):
* file-coding.h (MARKED_SLOT):
* fns.c (size_bit_vector):
* font-mgr.c:
* font-mgr.c (finalize_fc_pattern):
* font-mgr.c (print_fc_pattern):
* font-mgr.c (Ffc_pattern_p):
* font-mgr.c (Ffc_pattern_create):
* font-mgr.c (Ffc_name_parse):
* font-mgr.c (Ffc_name_unparse):
* font-mgr.c (Ffc_pattern_duplicate):
* font-mgr.c (Ffc_pattern_add):
* font-mgr.c (Ffc_pattern_del):
* font-mgr.c (Ffc_pattern_get):
* font-mgr.c (fc_config_create_using):
* font-mgr.c (fc_strlist_to_lisp_using):
* font-mgr.c (fontset_to_list):
* font-mgr.c (Ffc_config_p):
* font-mgr.c (Ffc_config_up_to_date):
* font-mgr.c (Ffc_config_build_fonts):
* font-mgr.c (Ffc_config_get_cache):
* font-mgr.c (Ffc_config_get_fonts):
* font-mgr.c (Ffc_config_set_current):
* font-mgr.c (Ffc_config_get_blanks):
* font-mgr.c (Ffc_config_get_rescan_interval):
* font-mgr.c (Ffc_config_set_rescan_interval):
* font-mgr.c (Ffc_config_app_font_add_file):
* font-mgr.c (Ffc_config_app_font_add_dir):
* font-mgr.c (Ffc_config_app_font_clear):
* font-mgr.c (size):
* font-mgr.c (Ffc_config_substitute):
* font-mgr.c (Ffc_font_render_prepare):
* font-mgr.c (Ffc_font_match):
* font-mgr.c (Ffc_font_sort):
* font-mgr.c (finalize_fc_config):
* font-mgr.c (print_fc_config):
* font-mgr.h:
* font-mgr.h (struct fc_pattern):
* font-mgr.h (XFC_PATTERN):
* font-mgr.h (struct fc_config):
* font-mgr.h (XFC_CONFIG):
* frame-gtk.c (allocate_gtk_frame_struct):
* frame-impl.h (struct frame):
* frame-msw.c (mswindows_init_frame_1):
* frame-x.c (allocate_x_frame_struct):
* frame.c (nuke_all_frame_slots):
* frame.c (allocate_frame_core):
* gc.c:
* gc.c (GC_CHECK_NOT_FREE):
* glyphs.c (finalize_image_instance):
* glyphs.c (allocate_image_instance):
* glyphs.c (Fcolorize_image_instance):
* glyphs.c (allocate_glyph):
* glyphs.c (unmap_subwindow_instance_cache_mapper):
* glyphs.c (register_ignored_expose):
* glyphs.h (struct Lisp_Image_Instance):
* glyphs.h (struct Lisp_Glyph):
* glyphs.h (struct glyph_cachel):
* glyphs.h (struct expose_ignore):
* gui.c (allocate_gui_item):
* gui.h (struct Lisp_Gui_Item):
* keymap.c (struct Lisp_Keymap):
* keymap.c (make_keymap):
* lisp.h:
* lisp.h (struct Lisp_String_Direct_Data):
* lisp.h (struct Lisp_String_Indirect_Data):
* lisp.h (struct Lisp_Vector):
* lisp.h (struct Lisp_Bit_Vector):
* lisp.h (DECLARE_INLINE_LISP_BIT_VECTOR):
* lisp.h (struct weak_box):
* lisp.h (struct ephemeron):
* lisp.h (struct weak_list):
* lrecord.h:
* lrecord.h (struct lrecord_implementation):
* lrecord.h (MC_ALLOC_CALL_FINALIZER):
* lrecord.h (struct lcrecord_list):
* lstream.c (finalize_lstream):
* lstream.c (sizeof_lstream):
* lstream.c (Lstream_new):
* lstream.c (Lstream_delete):
* lstream.h (struct lstream):
* marker.c:
* marker.c (finalize_marker):
* marker.c (compute_buffer_marker_usage):
* mule-charset.c:
* mule-charset.c (make_charset):
* mule-charset.c (compute_charset_usage):
* objects-impl.h (struct Lisp_Color_Instance):
* objects-impl.h (struct Lisp_Font_Instance):
* objects-tty-impl.h (struct tty_color_instance_data):
* objects-tty-impl.h (struct tty_font_instance_data):
* objects-tty.c (tty_initialize_color_instance):
* objects-tty.c (tty_initialize_font_instance):
* objects.c (finalize_color_instance):
* objects.c (Fmake_color_instance):
* objects.c (finalize_font_instance):
* objects.c (Fmake_font_instance):
* objects.c (reinit_vars_of_objects):
* opaque.c:
* opaque.c (sizeof_opaque):
* opaque.c (make_opaque_ptr):
* opaque.c (free_opaque_ptr):
* opaque.h:
* opaque.h (Lisp_Opaque):
* opaque.h (Lisp_Opaque_Ptr):
* print.c (printing_unreadable_lcrecord):
* print.c (external_object_printer):
* print.c (debug_p4):
* process.c (finalize_process):
* process.c (make_process_internal):
* procimpl.h (struct Lisp_Process):
* rangetab.c (Fmake_range_table):
* rangetab.c (Fcopy_range_table):
* rangetab.h (struct Lisp_Range_Table):
* scrollbar.c:
* scrollbar.c (create_scrollbar_instance):
* scrollbar.c (compute_scrollbar_instance_usage):
* scrollbar.h (struct scrollbar_instance):
* specifier.c (finalize_specifier):
* specifier.c (sizeof_specifier):
* specifier.c (set_specifier_caching):
* specifier.h (struct Lisp_Specifier):
* specifier.h (struct specifier_caching):
* symeval.h:
* symeval.h (SYMBOL_VALUE_MAGIC_P):
* symeval.h (DEFVAR_SYMVAL_FWD):
* symsinit.h:
* syntax.c (init_buffer_syntax_cache):
* syntax.h (struct syntax_cache):
* toolbar.c:
* toolbar.c (allocate_toolbar_button):
* toolbar.c (update_toolbar_button):
* toolbar.h (struct toolbar_button):
* tooltalk.c (struct Lisp_Tooltalk_Message):
* tooltalk.c (make_tooltalk_message):
* tooltalk.c (struct Lisp_Tooltalk_Pattern):
* tooltalk.c (make_tooltalk_pattern):
* ui-gtk.c:
* ui-gtk.c (allocate_ffi_data):
* ui-gtk.c (emacs_gtk_object_finalizer):
* ui-gtk.c (allocate_emacs_gtk_object_data):
* ui-gtk.c (allocate_emacs_gtk_boxed_data):
* ui-gtk.h:
* window-impl.h (struct window):
* window-impl.h (struct window_mirror):
* window.c (finalize_window):
* window.c (allocate_window):
* window.c (new_window_mirror):
* window.c (mark_window_as_deleted):
* window.c (make_dummy_parent):
* window.c (compute_window_mirror_usage):
* window.c (compute_window_usage):
Overall point of this change and previous ones in this repository:
(1) Introduce new, clearer terminology: everything other than int
or char is a "record" object, which comes in two types: "normal
objects" and "frob-block objects". Fix up all places that
referred to frob-block objects as "simple", "basic", etc.
(2) Provide an advertised interface for doing operations on Lisp
objects, including creating new types, that is clean and
consistent in its naming, uses the above-referenced terms and
avoids referencing "lrecords", "old lcrecords", etc., which should
hide under the surface.
(3) Make the size_in_bytes and finalizer methods take a
Lisp_Object rather than a void * for consistency with other methods.
(4) Separate finalizer method into finalizer and disksaver, so
that normal finalize methods don't have to worry about disksaving.
Other specifics:
(1) Renaming:
LISP_OBJECT_HEADER -> NORMAL_LISP_OBJECT_HEADER
ALLOC_LISP_OBJECT -> ALLOC_NORMAL_LISP_OBJECT
implementation->basic_p -> implementation->frob_block_p
ALLOCATE_FIXED_TYPE_AND_SET_IMPL -> ALLOC_FROB_BLOCK_LISP_OBJECT
*FCCONFIG*, wrap_fcconfig -> *FC_CONFIG*, wrap_fc_config
*FCPATTERN*, wrap_fcpattern -> *FC_PATTERN*, wrap_fc_pattern
(the last two changes make the naming of these macros consistent
with the naming of all other macros, since the objects are named
fc-config and fc-pattern with a hyphen)
(2) Lots of documentation fixes in lrecord.h.
(3) Eliminate macros for copying, freeing, zeroing objects, getting
their storage size. Instead, new functions:
zero_sized_lisp_object()
zero_nonsized_lisp_object()
lisp_object_storage_size()
free_normal_lisp_object()
(copy_lisp_object() already exists)
LISP_OBJECT_FROB_BLOCK_P() (actually a macro)
Eliminated:
free_lrecord()
zero_lrecord()
copy_lrecord()
copy_sized_lrecord()
old_copy_lcrecord()
old_copy_sized_lcrecord()
old_zero_lcrecord()
old_zero_sized_lcrecord()
LISP_OBJECT_STORAGE_SIZE()
COPY_SIZED_LISP_OBJECT()
COPY_SIZED_LCRECORD()
COPY_LISP_OBJECT()
ZERO_LISP_OBJECT()
FREE_LISP_OBJECT()
(4) Catch the remaining places where lrecord stuff was used directly
and use the advertised interface, e.g. alloc_sized_lrecord() ->
ALLOC_SIZED_LISP_OBJECT().
(5) Make certain statically-declared pseudo-objects
(buffer_local_flags, console_local_flags) have their lheader
initialized correctly, so things like copy_lisp_object() can work
on them. Make extent_auxiliary_defaults a proper heap object
Vextent_auxiliary_defaults, and make extent auxiliaries dumpable
so that this object can be dumped. allocate_extent_auxiliary()
now just creates the object, and attach_extent_auxiliary()
creates an extent auxiliary and attaches to an extent, like the
old allocate_extent_auxiliary().
(6) Create EXTENT_AUXILIARY_SLOTS macro, similar to the foo-slots.h
files but in a macro instead of a file. The purpose is to avoid
duplication when iterating over all the slots in an extent auxiliary.
Use it.
(7) In lstream.c, don't zero out object after allocation because
allocation routines take care of this.
(8) In marker.c, fix a mistake in computing marker overhead.
(9) In print.c, clean up printing_unreadable_lcrecord(),
external_object_printer() to avoid lots of ifdef NEW_GC's.
(10) Separate toolbar-button allocation into a separate
allocate_toolbar_button() function for use in the example code
in lrecord.h.
| author | Ben Wing <ben@xemacs.org> |
|---|---|
| date | Fri, 05 Mar 2010 04:08:17 -0600 |
| parents | 6e9bd19ec103 |
| children | 5502045ec510 |
| rev | line source |
|---|---|
| 428 | 1 ;;; objects.el --- Lisp interface to C window-system objects |
| 2 | |
| 3 ;; Copyright (C) 1994, 1997 Free Software Foundation, Inc. | |
| 4 ;; Copyright (C) 1995 Ben Wing | |
| 5 | |
| 6 ;; Author: Chuck Thompson <cthomp@xemacs.org> | |
| 7 ;; Author: Ben Wing <ben@xemacs.org> | |
| 8 ;; Maintainer: XEmacs Development Team | |
| 9 ;; Keywords: faces, internal, dumped | |
| 10 | |
| 11 ;; This file is part of XEmacs. | |
| 12 | |
| 13 ;; XEmacs is free software; you can redistribute it and/or modify it | |
| 14 ;; under the terms of the GNU General Public License as published by | |
| 15 ;; the Free Software Foundation; either version 2, or (at your option) | |
| 16 ;; any later version. | |
| 17 | |
| 18 ;; XEmacs is distributed in the hope that it will be useful, but | |
| 19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 21 ;; General Public License for more details. | |
| 22 | |
| 23 ;; You should have received a copy of the GNU General Public License | |
| 24 ;; along with XEmacs; see the file COPYING. If not, write to the | |
| 25 ;; Free Software Foundation, 59 Temple Place - Suite 330, | |
| 26 ;; Boston, MA 02111-1307, USA. | |
| 27 | |
| 28 ;;; Synched up with: Not in FSF. | |
| 29 | |
| 30 ;;; Commentary: | |
| 31 | |
| 32 ;; This file is dumped with XEmacs. | |
| 33 | |
| 34 ;;; Code: | |
| 35 | |
| 36 (defun ws-object-property-1 (function object domain &optional matchspec) | |
| 37 (let ((instance (if matchspec | |
| 38 (specifier-matching-instance object matchspec domain) | |
| 39 (specifier-instance object domain)))) | |
| 40 (and instance (funcall function instance)))) | |
| 41 | |
| 42 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; font specifiers | |
| 43 | |
| 44 (defun make-font-specifier (spec-list) | |
| 45 "Return a new `font' specifier object with the given specification list. | |
| 46 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
| 47 locale and a list of instantiators), a single instantiator, or a list | |
| 48 of instantiators. See `make-specifier' for more information about | |
| 442 | 49 specifiers. |
| 50 | |
| 51 Valid instantiators for font specifiers are: | |
| 52 | |
| 3111 | 53 -- a string naming a font; syntax is platform dependent. Some examples for |
| 54 a 14-point upright medium-weight Courier font: | |
| 55 X11 (and GTK1): \"-*-courier-medium-r-*-*-*-140-*-*-*-*-iso8859-*\" | |
| 56 Xft (and GTK2): \"Courier-14\" | |
| 57 MS-Windows: \"Courier:14:Western\" | |
| 442 | 58 -- a font instance (use that instance directly if the device matches, |
| 59 or use the string that generated it) | |
| 60 -- a vector of no elements (only on TTY's; this means to set no font | |
| 61 at all, thus using the \"natural\" font of the terminal's text) | |
| 62 -- a vector of one element (a face to inherit from) | |
| 63 " | |
| 428 | 64 (make-specifier-and-init 'font spec-list)) |
| 65 | |
| 66 (defun font-name (font &optional domain charset) | |
| 67 "Return the name of the FONT in the specified DOMAIN, if any. | |
| 68 FONT should be a font specifier object and DOMAIN is normally a window | |
| 69 and defaults to the selected window if omitted. This is equivalent | |
| 70 to using `specifier-instance' and applying `font-instance-name' to | |
| 71 the result. See `make-specifier' for more information about specifiers." | |
| 72 (ws-object-property-1 'font-instance-name font domain charset)) | |
| 73 | |
| 74 (defun font-ascent (font &optional domain charset) | |
| 75 "Return the ascent of the FONT in the specified DOMAIN, if any. | |
| 76 FONT should be a font specifier object and DOMAIN is normally a window | |
| 77 and defaults to the selected window if omitted. This is equivalent | |
| 78 to using `specifier-instance' and applying `font-instance-ascent' to | |
| 79 the result. See `make-specifier' for more information about specifiers." | |
| 80 (ws-object-property-1 'font-instance-ascent font domain charset)) | |
| 81 | |
| 82 (defun font-descent (font &optional domain charset) | |
| 83 "Return the descent of the FONT in the specified DOMAIN, if any. | |
| 84 FONT should be a font specifier object and DOMAIN is normally a window | |
| 85 and defaults to the selected window if omitted. This is equivalent | |
| 86 to using `specifier-instance' and applying `font-instance-descent' to | |
| 87 the result. See `make-specifier' for more information about specifiers." | |
| 88 (ws-object-property-1 'font-instance-descent font domain charset)) | |
| 89 | |
| 90 (defun font-width (font &optional domain charset) | |
| 91 "Return the width of the FONT in the specified DOMAIN, if any. | |
| 92 FONT should be a font specifier object and DOMAIN is normally a window | |
| 93 and defaults to the selected window if omitted. This is equivalent | |
| 94 to using `specifier-instance' and applying `font-instance-width' to | |
| 95 the result. See `make-specifier' for more information about specifiers." | |
| 96 (ws-object-property-1 'font-instance-width font domain charset)) | |
| 97 | |
| 98 (defun font-height (font &optional domain charset) | |
| 99 "Return the height of the FONT in the specified DOMAIN, if any. | |
| 100 FONT should be a font specifier object and DOMAIN is normally a window | |
| 101 and defaults to the selected window if omitted. This is equivalent | |
| 102 to using `specifier-instance' and applying `font-instance-height' to | |
| 103 the result. See `make-specifier' for more information about specifiers." | |
| 104 (ws-object-property-1 'font-instance-height font domain charset)) | |
| 105 | |
| 106 (defun font-proportional-p (font &optional domain charset) | |
| 107 "Return whether FONT is proportional in the specified DOMAIN, if known. | |
| 108 FONT should be a font specifier object and DOMAIN is normally a window | |
| 109 and defaults to the selected window if omitted. This is equivalent | |
| 110 to using `specifier-instance' and applying `font-instance-proportional-p' to | |
| 111 the result. See `make-specifier' for more information about specifiers." | |
| 112 (ws-object-property-1 'font-instance-proportional-p font domain charset)) | |
| 113 | |
| 114 (defun font-properties (font &optional domain charset) | |
| 115 "Return the properties of the FONT in the specified DOMAIN, if any. | |
| 116 FONT should be a font specifier object and DOMAIN is normally a window | |
| 117 and defaults to the selected window if omitted. This is equivalent | |
| 118 to using `specifier-instance' and applying `font-instance-properties' | |
| 119 to the result. See `make-specifier' for more information about specifiers." | |
| 120 (ws-object-property-1 'font-instance-properties font domain charset)) | |
| 121 | |
| 122 (defun font-truename (font &optional domain charset) | |
| 123 "Return the truename of the FONT in the specified DOMAIN, if any. | |
| 124 FONT should be a font specifier object and DOMAIN is normally a window | |
| 125 and defaults to the selected window if omitted. This is equivalent | |
| 126 to using `specifier-instance' and applying `font-instance-truename' | |
| 127 to the result. See `make-specifier' for more information about specifiers." | |
| 128 (ws-object-property-1 'font-instance-truename font domain charset)) | |
| 129 | |
| 130 (defun font-instance-height (font-instance) | |
| 131 "Return the height in pixels of FONT-INSTANCE. | |
| 132 The returned value is the maximum height for all characters in the font,\n\ | |
| 133 and is equivalent to the sum of the font instance's ascent and descent." | |
| 134 (+ (font-instance-ascent font-instance) | |
| 135 (font-instance-descent font-instance))) | |
| 136 | |
| 137 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; color specifiers | |
| 138 | |
| 139 (defun make-color-specifier (spec-list) | |
| 140 "Return a new `color' specifier object with the given specification list. | |
| 141 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
| 142 locale and a list of instantiators), a single instantiator, or a list | |
| 143 of instantiators. See `make-specifier' for a detailed description of | |
| 442 | 144 how specifiers work. |
| 145 | |
| 146 Valid instantiators for color specifiers are: | |
| 147 | |
| 148 -- a string naming a color (e.g. under X this might be \"lightseagreen2\" | |
| 149 or \"#F534B2\") | |
| 150 -- a color instance (use that instance directly if the device matches, | |
| 151 or use the string that generated it) | |
| 152 -- a vector of no elements (only on TTY's; this means to set no color | |
| 153 at all, thus using the \"natural\" color of the terminal's text) | |
| 154 -- a vector of one or two elements: a face to inherit from, and | |
| 155 optionally a symbol naming which property of that face to inherit, | |
| 156 either `foreground' or `background' (if omitted, defaults to the same | |
| 157 property that this color specifier is used for; if this specifier is | |
| 158 not part of a face, the instantiator would not be valid)." | |
| 428 | 159 (make-specifier-and-init 'color spec-list)) |
| 160 | |
| 161 (defun color-name (color &optional domain) | |
| 162 "Return the name of the COLOR in the specified DOMAIN, if any. | |
| 163 COLOR should be a color specifier object and DOMAIN is normally a window | |
| 164 and defaults to the selected window if omitted. This is equivalent | |
| 165 to using `specifier-instance' and applying `color-instance-name' to | |
| 166 the result. See `make-specifier' for more information about specifiers." | |
| 167 (ws-object-property-1 'color-instance-name color domain)) | |
| 168 | |
| 169 (defun color-rgb-components (color &optional domain) | |
| 170 "Return the RGB components of the COLOR in the specified DOMAIN, if any. | |
| 171 COLOR should be a color specifier object and DOMAIN is normally a window | |
| 172 and defaults to the selected window if omitted. This is equivalent | |
| 173 to using `specifier-instance' and applying `color-instance-rgb-components' | |
| 174 to the result. See `make-specifier' for more information about specifiers." | |
| 175 (ws-object-property-1 'color-instance-rgb-components color domain)) | |
| 176 | |
| 442 | 177 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; face-boolean specifiers |
| 178 | |
| 179 (defun make-face-boolean-specifier (spec-list) | |
| 180 "Return a new `face-boolean' specifier object with the given spec list. | |
| 181 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
| 182 locale and a list of instantiators), a single instantiator, or a list | |
| 183 of instantiators. See `make-specifier' for a detailed description of | |
| 184 how specifiers work. | |
| 185 | |
| 186 Valid instantiators for face-boolean specifiers are | |
| 187 | |
| 188 -- t or nil | |
| 4201 | 189 -- a vector of one, two or three elements: a face to inherit from, |
| 442 | 190 optionally a symbol naming the property of that face to inherit from |
| 191 (if omitted, defaults to the same property that this face-boolean | |
| 192 specifier is used for; if this specifier is not part of a face, | |
| 193 the instantiator would not be valid), and optionally a value which, | |
| 194 if non-nil, means to invert the sense of the inherited property." | |
| 4201 | 195 (make-specifier-and-init 'face-boolean spec-list)) |
| 442 | 196 |
| 428 | 197 ;;; objects.el ends here. |