Mercurial > hg > xemacs-beta
annotate lisp/lib-complete.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 | 37bdd24225ef |
| children | 308d34e9f07d |
| rev | line source |
|---|---|
| 428 | 1 ;;; lib-complete.el --- Completion on the lisp search path |
| 2 | |
| 3 ;; Copyright (C) 1997 Free Software Foundation, Inc. | |
| 1123 | 4 ;; Copyright (C) 1991 Mike Williams <mike-w@cs.aukuni.ac.nz>. |
| 5 ;; Copyright (C) 2002 Ben Wing. | |
| 428 | 6 |
| 7 ;; Author: Mike Williams <mike-w@cs.aukuni.ac.nz> | |
| 8 ;; Maintainer: XEmacs Development Team | |
| 9 ;; Keywords: lisp, extensions, dumped | |
| 10 ;; Created: Sat Apr 20 17:47:21 1991 | |
| 11 | |
| 12 ;; This file is part of XEmacs. | |
| 13 | |
| 14 ;; XEmacs is free software; you can redistribute it and/or modify it | |
| 15 ;; under the terms of the GNU General Public License as published by | |
| 16 ;; the Free Software Foundation; either version 2, or (at your option) | |
| 17 ;; any later version. | |
| 18 | |
| 19 ;; XEmacs is distributed in the hope that it will be useful, but | |
| 20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 22 ;; General Public License for more details. | |
| 23 | |
| 24 ;; You should have received a copy of the GNU General Public License | |
| 25 ;; along with XEmacs; see the file COPYING. If not, write to the | |
| 26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 27 ;; Boston, MA 02111-1307, USA. | |
| 28 | |
| 29 ;;; Synched up with: Not in FSF. | |
| 30 | |
| 31 ;;; Commentary: | |
| 32 | |
| 33 ;; This file is dumped with XEmacs. | |
| 34 | |
| 35 ;; Many thanks to Hallvard Furuseth <hallvard@ifi.uio.no> for his | |
| 36 ;; helpful suggestions. | |
| 37 | |
| 38 ;;; ChangeLog: | |
| 39 | |
| 40 ;; 4/26/97: sb Mule-ize. | |
| 41 ;; 6/24/1999 much rewriting from Bob Weiner | |
| 42 | |
| 43 ;;; Code: | |
| 44 | |
| 45 ;;=== Determine completions for filename in search path =================== | |
| 46 | |
| 47 (defun library-all-completions (FILE SEARCH-PATH &optional FULL FAST) | |
| 48 "Return all completions for FILE in any directory on SEARCH-PATH. | |
| 49 If optional third argument FULL is non-nil, returned pathnames should be | |
| 50 absolute rather than relative to some directory on the SEARCH-PATH. | |
| 51 If optional fourth argument FAST is non-nil, don't sort the completions, | |
| 52 or remove duplicates." | |
| 53 (setq FILE (or FILE "")) | |
| 54 (if (file-name-absolute-p FILE) | |
| 55 ;; It's an absolute file name, so don't need SEARCH-PATH | |
| 56 (progn | |
| 57 (setq FILE (expand-file-name FILE)) | |
| 58 (file-name-all-completions | |
| 59 (file-name-nondirectory FILE) (file-name-directory FILE))) | |
| 60 (let ((subdir (file-name-directory FILE)) | |
| 61 (file (file-name-nondirectory FILE)) | |
| 62 all-completions) | |
| 63 ;; Make list of completions in each directory on SEARCH-PATH | |
| 64 (while SEARCH-PATH | |
| 65 (let* ((dir (concat (file-name-as-directory | |
| 66 (expand-file-name (car SEARCH-PATH))) | |
| 67 subdir)) | |
| 68 (dir-prefix (if FULL dir subdir))) | |
| 69 (if (file-directory-p dir) | |
| 70 (let ((subdir-completions | |
| 71 (file-name-all-completions file dir))) | |
| 72 (while subdir-completions | |
| 73 (setq all-completions | |
| 74 (cons (concat dir-prefix (car subdir-completions)) | |
| 75 all-completions)) | |
| 76 (setq subdir-completions (cdr subdir-completions)))))) | |
| 77 (setq SEARCH-PATH (cdr SEARCH-PATH))) | |
| 78 (if FAST all-completions | |
| 79 (let ((sorted (nreverse (sort all-completions 'string<))) | |
| 80 compressed) | |
| 81 (while sorted | |
| 82 (if (equal (car sorted) (car compressed)) nil | |
| 83 (setq compressed (cons (car sorted) compressed))) | |
| 84 (setq sorted (cdr sorted))) | |
| 85 compressed))))) | |
| 86 | |
| 87 ;;=== Utilities =========================================================== | |
| 88 | |
| 89 (defmacro progn-with-message (message &rest forms) | |
| 90 "(progn-with-message MESSAGE FORMS ...) | |
| 91 Display MESSAGE and evaluate FORMS, returning value of the last one." | |
| 92 ;; based on Hallvard Furuseth's funcall-with-message | |
| 93 `(if (eq (selected-window) (minibuffer-window)) | |
| 94 (save-excursion | |
| 95 (goto-char (point-max)) | |
| 96 (let ((orig-pmax (point-max))) | |
| 97 (unwind-protect | |
| 98 (progn | |
| 99 (insert " " ,message) (goto-char orig-pmax) | |
| 100 (sit-for 0) ; Redisplay | |
| 101 ,@forms) | |
| 102 (delete-region orig-pmax (point-max))))) | |
| 103 (prog2 | |
| 104 (message "%s" ,message) | |
| 105 (progn ,@forms) | |
| 106 (message "")))) | |
| 107 | |
| 108 (put 'progn-with-message 'lisp-indent-hook 1) | |
| 109 | |
| 110 ;;=== Completion caching ================================================== | |
| 111 | |
| 112 (defconst lib-complete:cache nil | |
| 444 | 113 "Used within `read-library' and `read-library-internal' to prevent |
| 114 costly repeated calls to `library-all-completions'. | |
| 428 | 115 Format is a list of lists of the form |
| 116 | |
| 117 ([<path> <subdir>] <cache-record> <cache-record> ...) | |
| 118 | |
| 119 where each <cache-record> has the form | |
| 120 | |
| 121 (<root> <modtimes> <completion-table>)") | |
| 122 | |
| 123 (defun lib-complete:better-root (ROOT1 ROOT2) | |
| 124 "Return non-nil if ROOT1 is a superset of ROOT2." | |
| 125 (and (equal (file-name-directory ROOT1) (file-name-directory ROOT2)) | |
| 126 (string-match | |
| 127 (concat "^" (regexp-quote (file-name-nondirectory ROOT1))) | |
| 128 ROOT2))) | |
| 129 | |
| 130 (defun lib-complete:get-completion-table (FILE PATH FILTER) | |
| 131 (let* ((subdir (file-name-directory FILE)) | |
| 132 (root (file-name-nondirectory FILE)) | |
| 133 (PATH | |
| 134 (mapcar | |
| 135 (function (lambda (dir) (file-name-as-directory | |
| 136 (expand-file-name (or dir ""))))) | |
| 137 PATH)) | |
| 138 (key (vector PATH subdir FILTER)) | |
| 139 (real-dirs | |
| 140 (if subdir | |
| 141 (mapcar (function (lambda (dir) (concat dir subdir))) PATH) | |
| 142 PATH)) | |
| 143 (path-modtimes | |
| 144 (mapcar | |
| 145 (function (lambda (fn) (if fn (nth 5 (file-attributes fn))))) | |
| 146 real-dirs)) | |
| 147 (cache-entry (assoc key lib-complete:cache)) | |
| 148 (cache-records (cdr cache-entry))) | |
| 149 ;; Look for cached entry | |
| 150 (catch 'table | |
| 151 (while cache-records | |
| 152 (if (and | |
| 153 (lib-complete:better-root (nth 0 (car cache-records)) root) | |
| 154 (equal (nth 1 (car cache-records)) path-modtimes)) | |
| 155 (throw 'table (nth 2 (car cache-records)))) | |
| 156 (setq cache-records (cdr cache-records))) | |
| 157 ;; Otherwise build completions | |
| 158 (let ((completion-list | |
| 159 (progn-with-message "(building completion table...)" | |
| 160 (library-all-completions FILE PATH nil 'fast))) | |
| 161 (completion-table (make-vector 127 0))) | |
| 162 (while completion-list | |
| 163 (let ((completion | |
| 164 (if (or (not FILTER) | |
| 165 (file-directory-p (car completion-list))) | |
| 166 (car completion-list) | |
| 167 (funcall FILTER (car completion-list))))) | |
| 168 (if completion | |
| 169 (intern completion completion-table))) | |
| 170 (setq completion-list (cdr completion-list))) | |
| 171 ;; Cache the completions | |
| 172 (lib-complete:cache-completions key root | |
| 173 path-modtimes completion-table) | |
| 174 completion-table)))) | |
| 175 | |
| 176 (defvar lib-complete:max-cache-size 40 | |
| 177 "*Maximum number of search paths which are cached.") | |
| 178 | |
| 179 (defun lib-complete:cache-completions (key root modtimes table) | |
| 180 (let* ((cache-entry (assoc key lib-complete:cache)) | |
| 181 (cache-records (cdr cache-entry)) | |
| 182 (new-cache-records (list (list root modtimes table)))) | |
| 183 (if (not cache-entry) nil | |
| 184 ;; Remove old cache entry | |
| 185 (setq lib-complete:cache (delq cache-entry lib-complete:cache)) | |
| 186 ;; Copy non-redundant entries from old cache entry | |
| 187 (while cache-records | |
| 188 (if (or (equal root (nth 0 (car cache-records))) | |
| 189 (lib-complete:better-root root (nth 0 (car cache-records)))) | |
| 190 nil | |
| 191 (setq new-cache-records | |
| 192 (cons (car cache-records) new-cache-records))) | |
| 193 (setq cache-records (cdr cache-records)))) | |
| 194 ;; Add entry to front of cache | |
| 195 (setq lib-complete:cache | |
| 196 (cons (cons key (nreverse new-cache-records)) lib-complete:cache)) | |
| 197 ;; Trim cache | |
| 198 (let ((tail (nthcdr lib-complete:max-cache-size lib-complete:cache))) | |
| 199 (if tail (setcdr tail nil))))) | |
| 200 | |
| 201 ;;=== Read a filename, with completion in a search path =================== | |
| 202 | |
| 203 (defun read-library-internal (FILE FILTER FLAG) | |
| 204 "Don't call this." | |
| 205 ;; Relies on read-library-internal-search-path being let-bound | |
| 502 | 206 (declare (special read-library-internal-search-path)) |
| 428 | 207 (let ((completion-table |
| 208 (lib-complete:get-completion-table | |
| 209 FILE read-library-internal-search-path FILTER))) | |
| 210 (cond | |
| 211 ((not completion-table) nil) | |
| 212 ;; Completion table is filtered before use, so the PREDICATE | |
| 213 ;; argument is redundant. | |
| 214 ((eq FLAG nil) (try-completion FILE completion-table nil)) | |
| 215 ((eq FLAG t) (all-completions FILE completion-table nil)) | |
| 216 ((eq FLAG 'lambda) (and (intern-soft FILE completion-table) t)) | |
| 217 ))) | |
| 218 | |
| 219 (defun read-library (PROMPT SEARCH-PATH &optional DEFAULT MUST-MATCH | |
| 220 FULL FILTER) | |
| 221 "Read library name, prompting with PROMPT and completing in directories | |
| 222 from SEARCH-PATH. A nil in the search path represents the current | |
| 223 directory. Completions for a given search-path are cached, with the | |
| 224 cache being invalidated whenever one of the directories on the path changes. | |
| 225 Default to DEFAULT if user enters a null string. | |
| 226 Optional fourth arg MUST-MATCH non-nil means require existing file's name. | |
| 227 Non-nil and non-t means also require confirmation after completion. | |
| 228 Optional fifth argument FULL non-nil causes a full pathname, rather than a | |
| 229 relative pathname, to be returned. Note that FULL implies MUST-MATCH. | |
| 230 Optional sixth argument FILTER can be used to provide a function to | |
| 231 filter the completions. This function is passed the filename, and should | |
| 232 return a transformed filename (possibly a null transformation) or nil, | |
| 233 indicating that the filename should not be included in the completions." | |
| 502 | 234 (declare (special read-library-internal-search-path)) |
| 428 | 235 (let* ((read-library-internal-search-path SEARCH-PATH) |
| 236 (library (completing-read PROMPT 'read-library-internal | |
| 237 FILTER (or MUST-MATCH FULL) nil))) | |
| 238 (cond | |
| 239 ((equal library "") DEFAULT) | |
| 240 (FULL (locate-file library read-library-internal-search-path | |
| 241 '(".el" ".el.gz" ".elc"))) | |
| 242 (t library)))) | |
| 243 | |
| 244 (defun read-library-name (prompt) | |
| 502 | 245 "PROMPTs for and returns an existing Elisp library name (without any suffix) |
| 246 or the empty string." | |
| 428 | 247 (interactive) |
| 502 | 248 (declare (special read-library-internal-search-path)) |
| 428 | 249 (let ((read-library-internal-search-path load-path)) |
| 250 (completing-read prompt | |
| 251 'read-library-internal | |
| 252 (lambda (fn) | |
| 253 (cond | |
| 254 ((string-match "\\.el\\(\\.gz\\|\\.Z\\)?$" fn) | |
| 255 (substring fn 0 (match-beginning 0))))) | |
| 256 t nil))) | |
| 257 | |
| 258 ;; NOTE: as a special case, read-library may be used to read a filename | |
| 259 ;; relative to the current directory, returning a *relative* pathname | |
| 260 ;; (read-file-name returns a full pathname). | |
| 261 ;; | |
| 262 ;; eg. (read-library "Local header: " '(nil) nil) | |
| 263 | |
| 264 ;;=== Replacement for load-library with completion ======================== | |
| 265 | |
| 266 (defun load-library (library) | |
| 267 "Load the library named LIBRARY. | |
| 268 This is an interface to the function `load'." | |
| 269 (interactive | |
| 270 (list (read-library "Load library: " load-path nil nil nil | |
| 271 (function (lambda (fn) | |
| 272 (cond | |
| 273 ((string-match "\\.elc?$" fn) | |
| 274 (substring fn 0 (match-beginning 0)))))) | |
| 275 ))) | |
| 276 (load library)) | |
| 277 | |
| 278 ;;=== find-library with completion (Author: Bob Weiner) =================== | |
| 279 | |
| 1123 | 280 ;; should be called find-lisp-source-path! |
| 531 | 281 (defcustom find-library-source-path nil |
| 282 "The default list of directories where find-library searches. | |
| 283 | |
| 284 If this variable is `nil' then find-library searches `load-path' by | |
| 285 default. | |
| 286 | |
| 1123 | 287 If this is set to a function, it will be called the first time this value |
| 288 is needed, to compute the actual list, which will then be substituted into | |
| 289 the variable. | |
| 290 | |
| 531 | 291 A good way to set this variable is like this: |
| 292 | |
| 293 \(setq find-library-source-path | |
| 1123 | 294 #'(lambda () |
| 295 (paths-find-recursive-load-path | |
| 296 (list lisp-directory \"/src/xemacs/xemacs-packages-src/\")))) | |
| 531 | 297 " |
| 298 :type '(repeat directory) | |
| 299 :group 'find-function) | |
| 300 | |
| 428 | 301 (defun find-library (library &optional codesys display-function) |
| 302 "Find and display in the current window the source for the Elisp LIBRARY. | |
| 303 LIBRARY should be a name without any path information and may include or omit | |
| 304 the \".el\" suffix. Under XEmacs/Mule, the optional second argument CODESYS | |
| 305 specifies the coding system to use when decoding the file. Interactively, | |
| 306 with a prefix argument, this prompts for the coding system. Optional third | |
| 307 argument DISPLAY-FUNCTION must take two arguments, the filename to display | |
| 531 | 308 and CODESYS. The default for DISPLAY-FUNCTION is `find-file'. |
| 309 | |
| 310 This function searches `find-library-source-path' to find the library; | |
| 311 if this is nil (the default), then `load-path' is searched." | |
| 428 | 312 (interactive |
| 313 (list (read-library-name "Find library: ") | |
| 314 (if current-prefix-arg | |
| 315 (read-coding-system "Coding System: ")))) | |
| 316 (let ((path (if (or (null library) (equal library "")) | |
| 317 nil | |
| 1123 | 318 (when (functionp find-library-source-path) |
| 319 (message "Computing find-library-source-path...") | |
| 320 (setq find-library-source-path | |
| 321 (funcall find-library-source-path)) | |
| 322 (message "Computing find-library-source-path... done.")) | |
| 531 | 323 (locate-file library (or find-library-source-path load-path) |
| 953 | 324 ":.el:.el.gz:.el.Z:.elc")))) |
| 428 | 325 (if path (funcall (if (fboundp display-function) |
| 326 display-function 'find-file) | |
| 327 path codesys) | |
| 328 (error "(find-library): Cannot locate library `%s'" library)))) | |
| 329 | |
| 330 (defun find-library-other-window (library &optional codesys) | |
| 331 "Find and display in another window the source for the Elisp LIBRARY. | |
| 332 LIBRARY should be a name without any path information and may include or omit | |
| 333 the \".el\" suffix. Under XEmacs/Mule, the optional second argument CODESYS | |
| 334 specifies the coding system to use when decoding the file. Interactively, | |
| 335 with a prefix argument, this prompts for the coding system." | |
| 336 (interactive | |
| 337 (list (read-library-name "Find library in other window: ") | |
| 338 (if current-prefix-arg | |
| 339 (read-coding-system "Coding System: ")))) | |
| 340 (find-library library codesys 'find-file-other-window)) | |
| 341 | |
| 342 (defun find-library-other-frame (library &optional codesys) | |
| 343 "Find and display in another frame the source for the Elisp LIBRARY. | |
| 344 LIBRARY should be a name without any path information and may include or omit | |
| 345 the \".el\" suffix. Under XEmacs/Mule, the optional second argument CODESYS | |
| 346 specifies the coding system to use when decoding the file. Interactively, | |
| 347 with a prefix argument, this prompts for the coding system." | |
| 348 (interactive | |
| 349 (list (read-library-name "Find library in other frame: ") | |
| 350 (if current-prefix-arg | |
| 351 (read-coding-system "Coding System: ")))) | |
| 352 (find-library library codesys 'find-file-other-frame)) | |
| 353 | |
| 354 ;; This conflicts with an existing binding. | |
| 355 ;;(define-key global-map "\C-xl" 'find-library) | |
| 356 (define-key global-map "\C-x4l" 'find-library-other-window) | |
| 357 (define-key global-map "\C-x5l" 'find-library-other-frame) | |
| 358 | |
| 359 (provide 'lib-complete) | |
| 360 | |
| 361 ;;; lib-complete.el ends here |