annotate modules/README @ 5882:bbe4146603db

Reduce regexp usage, now CL-oriented non-regexp code available, core Lisp lisp/ChangeLog addition: 2015-04-01 Aidan Kehoe <kehoea@parhasard.net> When calling #'string-match with a REGEXP without regular expression special characters, call #'search, #'mismatch, #'find, etc. instead, making our code less likely to side-effect other functions' match data and a little faster. * apropos.el (apropos-command): * apropos.el (apropos): Call (position ?\n ...) rather than (string-match "\n" ...) here. * buff-menu.el: * buff-menu.el (buffers-menu-omit-invisible-buffers): Don't fire up the regexp engine just to check if a string starts with a space. * buff-menu.el (select-buffers-tab-buffers-by-mode): Don't fire up the regexp engine just to compare mode basenames. * buff-menu.el (format-buffers-tab-line): * buff-menu.el (build-buffers-tab-internal): Moved to being a label within the following. * buff-menu.el (buffers-tab-items): Use the label. * bytecomp.el (byte-compile-log-1): Don't fire up the regexp engine just to look for a newline. * cus-edit.el (get): Ditto. * cus-edit.el (custom-variable-value-create): Ditto, but for a colon. * descr-text.el (describe-text-sexp): Ditto. * descr-text.el (describe-char-unicode-data): Use #'split-string-by-char given that we're just looking for a semicolon. * descr-text.el (describe-char): Don't fire up the regexp engine just to look for a newline. * disass.el (disassemble-internal): Ditto. * files.el (file-name-sans-extension): Implement this using #'position. * files.el (file-name-extension): Correct this function's docstring, implement it in terms of #'position. * files.el (insert-directory): Don't fire up the regexp engine to split a string by space; don't reverse the list of switches, this is actually a longstand bug as far as I can see. * gnuserv.el (gnuserv-process-filter): Use #'position here, instead of consing inside #'split-string needlessly. * gtk-file-dialog.el (gtk-file-dialog-update-dropdown): Use #'split-string-by-char here, don't fire up #'split-string for directory-sep-char. * gtk-font-menu.el (hack-font-truename): Implement this more cheaply in terms of #'find, #'split-string-by-char, #'equal, rather than #'string-match, #'split-string, #'string-equal. * hyper-apropos.el (hyper-apropos-grok-functions): * hyper-apropos.el (hyper-apropos-grok-variables): Look for a newline using #'position rather than #'string-match in these functions. * info.el (Info-insert-dir): * info.el (Info-insert-file-contents): * info.el (Info-follow-reference): * info.el (Info-extract-menu-node-name): * info.el (Info-menu): Look for fixed strings using #'position or #'search as appropriate in this file. * ldap.el (ldap-decode-string): * ldap.el (ldap-encode-string): #'encode-coding-string, #'decode-coding-string are always available, don't check if they're fboundp. * ldap.el (ldap-decode-address): * ldap.el (ldap-encode-address): Use #'split-string-by-char in these functions. * lisp-mnt.el (lm-creation-date): * lisp-mnt.el (lm-last-modified-date): Don't fire up the regexp engine just to look for spaces in this file. * menubar-items.el (default-menubar): Use (not (mismatch ...)) rather than #'string-match here, for simple regexp. Use (search "beta" ...) rather than (string-match "beta" ...) * menubar-items.el (sort-buffers-menu-alphabetically): * menubar-items.el (sort-buffers-menu-by-mode-then-alphabetically): * menubar-items.el (group-buffers-menu-by-mode-then-alphabetically): Don't fire up the regexp engine to check if a string starts with a space or an asterisk. Use the more fine-grained results of #'compare-strings; compare case-insensitively for the buffer menu. * menubar-items.el (list-all-buffers): * menubar-items.el (tutorials-menu-filter): Use #'equal rather than #'string-equal, which, in this context, has the drawback of not having a bytecode, and no redeeming features. * minibuf.el: * minibuf.el (un-substitute-in-file-name): Use #'count, rather than counting the occurences of $ using the regexp engine. * minibuf.el (read-file-name-internal-1): Don't fire up the regexp engine to search for ?=. * mouse.el (mouse-eval-sexp): Check for newline with #'find. * msw-font-menu.el (mswindows-reset-device-font-menus): Split a string by newline with #'split-string-by-char. * mule/japanese.el: * mule/japanese.el ("Japanese"): Use #'search rather than #'string-match; canoncase before comparing; fix a bug I had introduced where I had been making case insensitive comparisons where the case mattered. * mule/korea-util.el (default-korean-keyboard): Look for ?3 using #'find, not #'string-march. * mule/korea-util.el (quail-hangul-switch-hanja): Search for a fixed string using #'search. * mule/mule-cmds.el (set-locale-for-language-environment): #'position, #'substitute rather than #'string-match, #'replace-in-string. * newcomment.el (comment-make-extra-lines): Use #'search rather than #'string-match for a simple string. * package-get.el (package-get-remote-filename): Use #'position when looking for ?@ * process.el (setenv): * process.el (read-envvar-name): Use #'position when looking for ?=. * replace.el (map-query-replace-regexp): Use #'split-string-by-char instead of using an inline implementation of it. * select.el (select-convert-from-cf-text): * select.el (select-convert-from-cf-unicodetext): Use #'position rather than #'string-match in these functions. * setup-paths.el (paths-emacs-data-root-p): Use #'search when looking for simple string. * sound.el (load-sound-file): Use #'split-string-by-char rather than an inline reimplementation of same. * startup.el (splash-screen-window-body): * startup.el (splash-screen-tty-body): Search for simple strings using #'search. * version.el (emacs-version): Ditto. * x-font-menu.el (hack-font-truename): Implement this more cheaply in terms of #'find, #'split-string-by-char, #'equal, rather than #'string-match, #'split-string, #'string-equal. * x-font-menu.el (x-reset-device-font-menus-core): Use #'split-string-by-char here. * x-init.el (x-initialize-keyboard): Search for a simple string using #'search.
author Aidan Kehoe <kehoea@parhasard.net>
date Wed, 01 Apr 2015 14:28:20 +0100
parents da1365dd3f07
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5436
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
1 This file is part of XEmacs.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
2
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
3 XEmacs is free software: you can redistribute it and/or modify it
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
4 under the terms of the GNU General Public License as published by the
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
5 Free Software Foundation, either version 3 of the License, or (at your
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
6 option) any later version.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
7
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
8 XEmacs is distributed in the hope that it will be useful, but WITHOUT
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
9 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
10 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
11 for more details.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
12
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
13 You should have received a copy of the GNU General Public License
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
14 along with XEmacs. If not, see <http://www.gnu.org/licenses/>.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
15
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
16
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
17 This directory contains a number of XEmacs dynamic modules. These
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
18 modules can be loaded directly with the command 'M-x load-module'.
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
19 However, the preferred method of loading a module is to issue a
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
20 "(require 'module-name)" command to the Lisp interpreter. This will
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
21 store information so that a later "(unload-feature 'module-name)" can
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
22 succeed.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
23
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
24 To compile one of these modules, simply enter the desired directory,
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
25 type 'configure', and then 'make'. If you are building the module for
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
26 an installed XEmacs, then 'make install' will place the module in the
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
27 appropriate directory for XEmacs to find it later (assuming you have
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
28 permission to write to that directory). A subsequent 'load-module' or
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
29 'require' will then load the module, as described above.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
30
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
31 Each of these demonstrates different features and limitations of the
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
32 XEmacs module loading technology. For a complete discussion on XEmacs
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
33 dynamic modules, please consult the XEmacs Module Writers Guide, which
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
34 can be found in the ../info directory.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
35
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
36 For those wanting to get started with module writing, please see the
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
37 'sample' directory. It contains two subdirectories: internal and
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
38 external. The 'internal' subdirectory contains the framework needed to
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
39 migrate some core piece of XEmacs functionality into code that can
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
40 either be compiled into the core or built as a separate module. The
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
41 'external' subdirectory contains the somewhat simpler framework needed
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
42 to build a module separately from XEmacs. These should be considered
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
43 starting places for module writing.