xemacs-beta: lisp/bytecomp-runtime.el comparison

comparison lisp/bytecomp-runtime.el @ 776:79940b592197

[xemacs-hg @ 2002-03-15 07:43:14 by ben] .cvsignore: ignore .tmp files that are getting auto-created by VC. Makefile.in.in: Use -no-packages to avoid problems with package files shadowing core files (e.g. unicode.el in mule-ucs). alloc.c, emacs.c, lisp.h: add new -no-packages. make sure list of args for sorting is actually correct. clean up arg parsing code. xemacs.mak: Use -no-packages to avoid problems with package files shadowing core files (e.g. unicode.el in mule-ucs). Makefile: Use -no-packages to avoid problems with package files shadowing core files (e.g. unicode.el in mule-ucs). mule\chinese.el, mule\japan-util.el: fix warnings. behavior-defs.el: fix errors with require. bytecomp-runtime.el: add new funs {when,and}-{f}boundp, clean up docs. cus-edit.el: pretty-print values. dump-paths.el, find-paths.el, startup.el, setup-paths.el: fix problems/inconsistencies parsing options. support new -no-packages option. merge code duplication in dump-paths and startup. lisp-mode.el: indent macrolet and labels correctly. update comments about lisp-indent-function. flet already handled in cl. apropos.el, auto-save.el, buff-menu.el, cl-extra.el, dragdrop.el, faces.el, files.el, fill.el, font-lock.el, font.el, gtk-faces.el, gui.el, help.el, hyper-apropos.el, info.el, isearch-mode.el, keymap.el, lisp-mnt.el, mouse.el, package-admin.el, package-get.el, printer.el, process.el, resize-minibuffer.el, simple.el, toolbar-items.el, wid-edit.el, win32-native.el: fix warnings. very-early-lisp.el: update docs. mule\chinese.el, mule\japan-util.el: fix warnings. mule\chinese.el, mule\japan-util.el: fix warnings. behavior-defs.el: fix errors with require. bytecomp-runtime.el: add new funs {when,and}-{f}boundp, clean up docs. cus-edit.el: pretty-print values. dump-paths.el, find-paths.el, startup.el, setup-paths.el: fix problems/inconsistencies parsing options. support new -no-packages option. merge code duplication in dump-paths and startup. lisp-mode.el: indent macrolet and labels correctly. update comments about lisp-indent-function. flet already handled in cl. apropos.el, auto-save.el, buff-menu.el, cl-extra.el, dragdrop.el, faces.el, files.el, fill.el, font-lock.el, font.el, gtk-faces.el, gui.el, help.el, hyper-apropos.el, info.el, isearch-mode.el, keymap.el, lisp-mnt.el, mouse.el, package-admin.el, package-get.el, printer.el, process.el, resize-minibuffer.el, simple.el, toolbar-items.el, wid-edit.el, win32-native.el: fix warnings. very-early-lisp.el: update docs. mule\chinese.el, mule\japan-util.el: fix warnings. Makefile.in.in: Use -no-packages to avoid problems with package files shadowing core files (e.g. unicode.el in mule-ucs). Makefile.in.in: Use -no-packages to avoid problems with package files shadowing core files (e.g. unicode.el in mule-ucs).

author	ben
date	Fri, 15 Mar 2002 07:43:43 +0000
parents	943eaba38521
children	6728e641994e

comparison

equal deleted inserted replaced

-:7d972c3de90a
+:79940b592197
 "Evaluate BODY, but do not issue bytecomp warnings about VARIABLES undefined.
 VARIABLES can be a symbol or a list of symbols and must be quoted.  When
 compiling this file, the warnings `reference to free variable VARIABLE' and
 `assignment to free variable VARIABLE' will not occur anywhere in BODY, for
 any of the listed variables.  This is a clean way to avoid such warnings.
-See also `declare-boundp', `if-boundp', `when-boundp', and
-`globally-declare-boundp'."
+See also `if-boundp', `when-boundp', and `and-boundp' (ways to
+conditionalize on a variable being bound and avoid warnings),
+`declare-boundp' (issue a variable call without warnings), and
+`globally-declare-boundp' (avoid warnings throughout a file about a
+variable)."
 (setq variables (eval variables))
 (unless (consp variables)
 (setq variables (list variables)))
 `(progn
 (declare (special ,@variables))
 (defmacro if-boundp (variable then &rest else)
 "Equivalent to (if (boundp VARIABLE) THEN ELSE) but handles bytecomp warnings.
 VARIABLE should be a quoted symbol.  When compiling this file, the warnings
 `reference to free variable VARIABLE' and `assignment to free variable
 VARIABLE' will not occur anywhere in the if-statement.  This is a clean way
-to avoid such warnings.  See also `when-boundp', `declare-boundp',
+to avoid such warnings.  See also `with-boundp' and friends."
-`with-boundp' and `globally-declare-boundp'."
 `(with-boundp ,variable
 (if (boundp ,variable) ,then ,@else)))
 (put 'when-boundp 'lisp-indent-function 1)
 (defmacro when-boundp (variable &rest body)
 "Equivalent to (when (boundp VARIABLE) BODY) but handles bytecomp warnings.
 VARIABLE should be a quoted symbol.  When compiling this file, the warnings
 `reference to free variable VARIABLE' and `assignment to free variable
 VARIABLE' will not occur anywhere in the when-statement.  This is a clean
-way to avoid such warnings.  See also `if-boundp', `declare-boundp',
+way to avoid such warnings.  See also `with-boundp' and friends."
-`with-boundp' and `globally-declare-boundp'."
 `(with-boundp ,variable
 (when (boundp ,variable) ,@body)))
+(put 'and-boundp 'lisp-indent-function 1)
+(defmacro and-boundp (variable &rest args)
+"Equivalent to (and (boundp VARIABLE) ARGS) but handles bytecomp warnings.
+VARIABLE should be a quoted symbol.  When compiling this file, the warnings
+`reference to free variable VARIABLE' and `assignment to free variable
+VARIABLE' will not occur anywhere in the and-statement.  This is a clean
+way to avoid such warnings.  See also `with-boundp' and friends."
+`(with-boundp ,variable
+(and (boundp ,variable) ,@args)))
 (defmacro declare-boundp (variable)
 "Evaluate VARIABLE without bytecomp warnings about the symbol.
 Sample usage is
 (declare-boundp gpm-minor-mode)
 which is equivalent to
 (with-boundp 'gpm-minor-mode
-gpm-minor-mode)"
+gpm-minor-mode)
+See also `with-boundp' and friends."
 `(with-boundp ',variable ,variable))
 (defmacro globally-declare-boundp (variables)
 "Declare that all free uses of VARIABLES in this file are valid.
 VARIABLES can be a symbol or a list of symbols and must be quoted.
 When compiling this file, the warnings `reference to free variable
 VARIABLE' and `assignment to free variable VARIABLE' will not occur
 regardless of where references to VARIABLE occur in the file.
-In general, you should *NOT* use this; use `declare-boundp', `if-boundp',
+In general, you should *NOT* use this; use `with-boundp' or its friends to
-`when-boundp', or `with-boundp' to wrap individual uses, as necessary.
+wrap individual uses, as necessary.  That way, you're more likely to
-That way, you're more likely to remember to put in the explicit checks for
+remember to put in the explicit checks for the variable's existence that
-the variable's existence that are usually necessary.  However,
+are usually necessary.  However, `globally-declare-boundp' is better in
-`globally-declare-boundp' is better in some circumstances, such as when
+some circumstances, such as when writing an ELisp package that makes
-writing an ELisp package that makes integral use of optionally-compiled-in
+integral use of optionally-compiled-in functionality (typically, an
-functionality (typically, an interface onto a system library) and checks
+interface onto a system library) and checks for the existence of the
-for the existence of the functionality at some entry point to the package.
+functionality at some entry point to the package.  See
-See `globally-declare-fboundp' for more information."
+`globally-declare-fboundp' for more information."
 (setq variables (eval variables))
 (if (not (consp variables))
 (setq variables (list variables)))
 `(progn
 ;; (defvar FOO) has no side effects.
 (defmacro with-fboundp (functions &rest body)
 "Evaluate BODY, but do not issue bytecomp warnings about FUNCTIONS undefined.
 FUNCTIONS can be a symbol or a list of symbols and must be quoted.  When
 compiling this file, the warning `the function FUNCTION is not known to be
 defined' will not occur anywhere in BODY, for any of the listed functions.
-This is a clean way to avoid such warnings.  See also `declare-fboundp',
+This is a clean way to avoid such warnings.
-`if-fboundp', `when-fboundp', and `globally-declare-fboundp'."
+See also `if-fboundp', `when-fboundp', and `and-fboundp' (ways to
+conditionalize on a function being bound and avoid warnings),
+`declare-fboundp' (issue a function call without warnings), and
+`globally-declare-fboundp' (avoid warnings throughout a file about a
+function)."
 `(with-fboundp-1 ,functions ,@body))
 (put 'if-fboundp 'lisp-indent-function 2)
 (defmacro if-fboundp (function then &rest else)
 "Equivalent to (if (fboundp FUNCTION) THEN ELSE) but handles bytecomp warnings.
 FUNCTION should be a quoted symbol.  When compiling this file, the warning
 `the function FUNCTION is not known to be defined' will not occur anywhere
 in the if-statement.  This is a clean way to avoid such warnings.  See also
-`when-fboundp', `declare-fboundp', `with-fboundp', and
+`with-fboundp' and friends."
-`globally-declare-fboundp'."
 `(with-fboundp ,function
 (if (fboundp ,function) ,then ,@else)))
 (put 'when-fboundp 'lisp-indent-function 1)
 (defmacro when-fboundp (function &rest body)
 "Equivalent to (when (fboundp FUNCTION) BODY) but handles bytecomp warnings.
 FUNCTION should be a quoted symbol.  When compiling this file, the warning
 `the function FUNCTION is not known to be defined' will not occur anywhere
-in the when-statement.  This is a clean way to avoid such warnings.  See
+in the when-statement.  This is a clean way to avoid such warnings.  See also
-also `if-fboundp', `declare-fboundp', `with-fboundp', and
+`with-fboundp' and friends."
-`globally-declare-fboundp'."
 `(with-fboundp ,function
 (when (fboundp ,function) ,@body)))
+(put 'and-fboundp 'lisp-indent-function 1)
+(defmacro and-fboundp (function &rest args)
+"Equivalent to (and (fboundp FUNCTION) ARGS) but handles bytecomp warnings.
+FUNCTION should be a quoted symbol.  When compiling this file, the warning
+`the function FUNCTION is not known to be defined' will not occur anywhere
+in the and-statement.  This is a clean way to avoid such warnings.  See also
+`with-fboundp' and friends."
+`(with-fboundp ,function
+(and (fboundp ,function) ,@args)))
 (defmacro declare-fboundp (form)
 "Execute FORM (a function call) without bytecomp warnings about the call.
 Sample usage is
 (declare-fboundp (x-keysym-on-keyboard-sans-modifiers-p 'backspace))
 which is equivalent to
 (with-fboundp 'x-keysym-on-keyboard-sans-modifiers-p
-(x-keysym-on-keyboard-sans-modifiers-p 'backspace))"
+(x-keysym-on-keyboard-sans-modifiers-p 'backspace))
+See also `with-fboundp' and friends."
 `(with-fboundp ',(car form) ,form))
 (defmacro globally-declare-fboundp (functions)
 "Declare that all calls to function FUNCTIONS in this file are valid.
 FUNCTIONS can be a symbol or a list of symbols and must be quoted.
 When compiling this file, the warning `the function FUNCTION is not known
 to be defined' will not occur regardless of where calls to FUNCTION occur
 in the file.
-In general, you should *NOT* use this; use `declare-fboundp', `if-fboundp',
+In general, you should *NOT* use this; use `with-fboundp' or its friends to
-`when-fboundp', or `with-fboundp' to wrap individual uses, as necessary.
+wrap individual uses, as necessary.  That way, you're more likely to
-That way, you're more likely to remember to put in the explicit checks for
+remember to put in the explicit checks for the function's existence that
-the function's existence that are usually necessary.  However,
+are usually necessary.  However, `globally-declare-fboundp' is better in
-`globally-declare-fboundp' is better in some circumstances, such as when
+some circumstances, such as when writing an ELisp package that makes
-writing an ELisp package that makes integral use of optionally-compiled-in
+integral use of optionally-compiled-in functionality (typically, an
-functionality (typically, an interface onto a system library) and checks
+interface onto a system library) and checks for the existence of the
-for the existence of the functionality at some entry point to the package.
+functionality at some entry point to the package.  The file `ldap.el' is a
-The file `ldap.el' is a good example: It provides a layer on top of the
+good example: It provides a layer on top of the optional LDAP ELisp
-optional LDAP ELisp primitives, makes calls to them throughout its code,
+primitives, makes calls to them throughout its code, and verifies the
-and verifies the presence of LDAP support at load time.  Putting calls to
+presence of LDAP support at load time.  Putting calls to `declare-fboundp'
-`declare-fboundp' throughout the code would be a major annoyance."
+throughout the code would be a major annoyance."
 (when (cl-compiling-file)
 (setq functions (eval functions))
 (if (not (consp functions))
 	(setq functions (list functions)))
 ;; Another hack.  This works because the autoload environment is
 NOTE: You should *NOT* under normal circumstances be using this!
 There are better ways of avoiding most of these warnings.  In particular:
 -- use (declare (special ...)) if you are making use of
 dynamically-scoped variables.
--- use `if-fboundp', `when-fboundp', `declare-fboundp', `with-fboundp', or
+-- use `with-fboundp' and friends to avoid warnings about undefined functions
-`globally-declare-fboundp' to avoid warnings about undefined functions
 when you know the function actually exists.
--- use `if-boundp', `when-boundp', `declare-boundp', `with-boundp', or
+-- use `with-boundp' and friends to avoid warnings about undefined variables
-`globally-declare-boundp' to avoid warnings about undefined variables
 when you know the variable actually exists.
 -- use `with-obsolete-variable' or `with-obsolete-function' if you
 are purposely using such a variable or function."
 `(with-byte-compiler-warnings-suppressed-1 ,type ,@body))

Mercurial > hg > xemacs-beta

comparison lisp/bytecomp-runtime.el @ 776:79940b592197