Mercurial > hg > xemacs-beta
annotate modules/sample/internal/sample.c @ 5366:f00192e1cd49
Examining the result of #'length: `eql', not `=', it's better style & cheaper
2011-03-08 Aidan Kehoe <kehoea@parhasard.net>
* buff-menu.el (list-buffers-noselect):
* byte-optimize.el (byte-optimize-identity):
* byte-optimize.el (byte-optimize-if):
* byte-optimize.el (byte-optimize-nth):
* byte-optimize.el (byte-optimize-nthcdr):
* bytecomp.el (byte-compile-warn-wrong-args):
* bytecomp.el (byte-compile-two-args-19->20):
* bytecomp.el (byte-compile-list):
* bytecomp.el (byte-compile-beginning-of-line):
* bytecomp.el (byte-compile-set):
* bytecomp.el (byte-compile-set-default):
* bytecomp.el (byte-compile-values):
* bytecomp.el (byte-compile-values-list):
* bytecomp.el (byte-compile-integerp):
* bytecomp.el (byte-compile-multiple-value-list-internal):
* bytecomp.el (byte-compile-throw):
* cl-macs.el (cl-do-arglist):
* cl-macs.el (cl-parse-loop-clause):
* cl-macs.el (multiple-value-bind):
* cl-macs.el (multiple-value-setq):
* cl-macs.el (get-setf-method):
* cmdloop.el (command-error):
* cmdloop.el (y-or-n-p-minibuf):
* cmdloop.el (yes-or-no-p-minibuf):
* coding.el (unencodable-char-position):
* cus-edit.el (custom-face-prompt):
* cus-edit.el (custom-buffer-create-internal):
* cus-edit.el (widget-face-action):
* cus-edit.el (custom-group-value-create):
* descr-text.el (describe-char-unicode-data):
* dialog-gtk.el (popup-builtin-question-dialog):
* dragdrop.el (experimental-dragdrop-drop-log-function):
* dragdrop.el (experimental-dragdrop-drop-mime-default):
* easymenu.el (easy-menu-add):
* easymenu.el (easy-menu-remove):
* faces.el (read-face-name):
* faces.el (set-face-stipple):
* files.el (file-name-non-special):
* font.el (font-combine-fonts):
* font.el (font-set-face-font):
* font.el (font-parse-rgb-components):
* font.el (font-rgb-color-p):
* font.el (font-color-rgb-components):
* gnuserv.el (gnuserv-edit-files):
* help.el (key-or-menu-binding):
* help.el (function-documentation-1):
* help.el (function-documentation):
* info.el (info):
* isearch-mode.el (isearch-exit):
* isearch-mode.el (isearch-edit-string):
* isearch-mode.el (isearch-*-char):
* isearch-mode.el (isearch-complete1):
* ldap.el (ldap-encode-country-string):
* ldap.el (ldap-decode-string):
* minibuf.el (read-file-name-internal-1):
* minibuf.el (read-non-nil-coding-system):
* minibuf.el (get-user-response):
* mouse.el (drag-window-divider):
* mule/ccl.el:
* mule/ccl.el (ccl-compile-if):
* mule/ccl.el (ccl-compile-break):
* mule/ccl.el (ccl-compile-repeat):
* mule/ccl.el (ccl-compile-write-repeat):
* mule/ccl.el (ccl-compile-call):
* mule/ccl.el (ccl-compile-end):
* mule/ccl.el (ccl-compile-read-multibyte-character):
* mule/ccl.el (ccl-compile-write-multibyte-character):
* mule/ccl.el (ccl-compile-translate-character):
* mule/ccl.el (ccl-compile-mule-to-unicode):
* mule/ccl.el (ccl-compile-unicode-to-mule):
* mule/ccl.el (ccl-compile-lookup-integer):
* mule/ccl.el (ccl-compile-lookup-character):
* mule/ccl.el (ccl-compile-map-multiple):
* mule/ccl.el (ccl-compile-map-single):
* mule/devan-util.el (devanagari-compose-to-one-glyph):
* mule/devan-util.el (devanagari-composition-component):
* mule/mule-cmds.el (finish-set-language-environment):
* mule/viet-util.el:
* mule/viet-util.el (viet-encode-viscii-char):
* multicast.el (open-multicast-group):
* newcomment.el (comment-quote-nested):
* newcomment.el (comment-region):
* newcomment.el (comment-dwim):
* regexp-opt.el (regexp-opt-group):
* replace.el (map-query-replace-regexp):
* specifier.el (derive-device-type-from-tag-set):
* subr.el (skip-chars-quote):
* test-harness.el (test-harness-from-buffer):
* test-harness.el (batch-test-emacs):
* wid-edit.el (widget-choice-action):
* wid-edit.el (widget-symbol-prompt-internal):
* wid-edit.el (widget-color-action):
* window-xemacs.el (push-window-configuration):
* window-xemacs.el (pop-window-configuration):
* window.el (quit-window):
* x-compose.el (electric-diacritic):
It's better style, and cheaper (often one assembler instruction
vs. a C funcall in the byte code), to use `eql' instead of `='
when it's clear what numerical type a given result will be. Change
much of our code to do this, with the help of a byte-compiler
change (not comitted) that looked for calls to #'length (which
always returns an integer) in its args.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Tue, 08 Mar 2011 23:41:52 +0000 |
| 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 |