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

comparison lisp/bytecomp-runtime.el @ 502:7039e6323819

[xemacs-hg @ 2001-05-04 22:41:46 by ben] ----------------------- byte-comp warning fixes ----------------- New functions for cleanly eliminating byte-compiler warnings. Their definitions require no changes at all in bytecomp.el, meaning that any package that wants to use them and be compatible with older versions of XEmacs need only copy the code and rename the functions (i.e. prefix them with the package name). Eliminate byte-compiler warnings using the new functions in bytecomp-runtime.el. Move coding-system-put,get,category, since they're not Mule-specific and are used in prefer-coding-system. font.el was incredibly ugly. Clean it up. Avoid using defsubst for any exported functions, to avoid possible compatibility problems if we later change the internal interface. (It happened before, with face accessors, between 19.8 and 19.9). Fix tons of warnings. Clean up (new function gpm-is-supported-p eliminates duplicate code in gpm-create/delete-device-hook) and eliminate warnings. ---------- make byte-recompile-directory work in the --------- core `lisp' dir, even in the absence of a Mule XEmacs (i.e. make it skip the Mule files rather than trying to compile them). now you should be able to do `touch *.el' in the `lisp' dir, then M-x byte-recompile-directory, and get no warnings. Avoid trying to compile Mule files in byte-recompile-directory when we're not in a Mule XEmacs, since we're highly likely to get syntax errors. Add a coding-system cookie to all Mule files so that byte-recompile-directory ignores them. Magic cookie function moved to files.el from code-files.el (for use by bytecomp even in a non-coding-system XEmacs), and changed names and semantics for use by bytecomp. NOTE: IMO this is an internal function that we can change as we like (and there is absolutely no code anywhere else using the function). ---------------- GUI improvements: menus, help ------------------- Rearrange order of keymap declarations to be alphabetical. Improve help on help to include all bindings, and group by category. Add bindings for new Info commands. Remove warnings. Use command-hyper-apropos in place of command-apropos. Add a function to do the equivalent of command-apropos. Evals its help-text argument so you can put expressions there. Used now by help-for-help. Add binding to continue text searches. Expand index searches to work over multiple info documents. Add commands to search text/index in User and Lispref. Add new entry, "Uncomment Region" (parallels "Comment Out Region"). Redo Help menu; add bindings for new Info commands to search the index or text of the User and Lispref manuals. Add command for mark-paragraph, activate-region. Make Edit->R accelerator be rectangle, not register (more commonly used), and put rectangle first. Fix the Edit Init File entry to never load the .elc file. Simplify the default-popup-menu. Add Cmds->Tabs menu. Use kp-left not kp_left, etc. ---------------- Miscellaneous bug fixes/cleanup ------------------- byte-compiler-options: Correct doc string. easy-menu-do-define: fix extra quote. fill-paragraph-or-region:Rewrite to be more correct -- use call-interactively so that we always get exactly the same behavior as if the functions were called directly. No need to fiddle with zmacs-region-stays, now that bogus clearing of it (2001-04-28 src/ChangeLog) is removed. Put dialog titles back in -- this time correctly. Fix various other problems with leaks and such. key-sequence-list-description: Clean up fun to always correctly canonicalize. Clean up Kinsoku comments, synch comment-region with FSF 20.7. * simple.el (region-exists-p): * simple.el (region-active-p): Add comment about which one is correct to use in menu specs. * sound.el (load-sound-file): Minor code clean up. * startup.el: * startup.el (command-line-early): * startup.el (initial-scratch-message): Comment changes. Add info about sample.init.el to splash screen. Improve initial-scratch-message and clarify purpose of Scratch buffer. Fix byte-compile warning. ------------------------ Added features ------------------------- Add new variable to control whether etags checks all parent directories for tag files. (On by default.) * hash-table.el: New file, useful utility functions. * dumped-lisp.el (preloaded-file-list): Dump hash-table.el. ------------ notable bug fix: Windows event code -------------- Get critical quit working. ------------ notable bug fix and new feature: regex code -------------- Shy groups were implemented in a horrible, half-assed way that would cause them to screw up regex searching in most cases. Fixed to work correctly. Also extended back-reference syntax past 9. Only is recognized as such if there are at least that many non-shy groups; and optionally will warn about such uses, to catch old code that might be using them differently. (Added variable to control this in search.c -- `warn-about-possibly-incompatible-back- references', on by default for the moment. Declared in lisp.h. ---------------- process/SIGIO improvements ------------------- define USE_GETADDRINFO to replace more complex conditional, and use it. the code conditionalized on this in unix_open_network_stream had *serious* problems handling errors. it's now fixed, and major amounts of duplicate code between the two versions were combined. don't disable SIGIO and other interrupts unless CONNECT_NEEDS_SLOWED_INTERRUPTS is defined -- don't penalize OS's without bugs. similarly for a freebsd bug that was affecting all OS's. * s\ultrix.h: define CONNECT_NEEDS_SLOWED_INTERRUPTS, since that's the OS mentioned as having a kernel bug. * sysdep.c (request_sigio_on_device): * sysdep.c (unrequest_sigio_on_device): fix SIGIO problems on Linux. add check for O_ASYNC in case it's defined and FASYNC isn't. add comment about other ways to do SIGIO on Linux. * callproc.c (Fold_call_process_internal): * process.c (Fstart_process_internal): Deal with the possibility that `default-directory' doesn't have terminating slash. Correct comments about vfork. ---------------- Miscellaneous bug fixes/cleanup ------------------- * callint.c (Finteractive): Add lots of documentation -- exactly what the Lisp equivalents of all the interactive specs are. * console.h (struct console): change type of quit_char to Emchar. * event-msw.c (lstream_type_create_mswindows_selectable): spacing change. Eliminate events-mod.h and combine into events.h. * emacs.c: * emacs.c (make_arg_list_1): * emacs.c (main_1): A couple of char->Extbyte changes, add a comment. * glyphs-msw.c: Correct indentation of function defns to not exceed 80 cols. Try (sort of) to fix some code that sets the colors of the progress gauge. (Commented out) * keymap.c (syms_of_keymap): use DEFSYMBOL. * process.c (read_process_output): No need to fiddle with zmacs_region_stays, now that bogus clearing of it (see below) is removed. * search.c (Freplace_match): warning fix.

author	ben
date	Fri, 04 May 2001 22:42:35 +0000
parents	3ecd8885ac67
children	943eaba38521

comparison

equal deleted inserted replaced

-:0a255b32b157
+:7039e6323819
 `(let ((bodythunk #'(lambda () ,@body)))
 (if (featurep ',(car feature))
 	   (funcall bodythunk)
 	 (setq after-load-alist (cons '(,file . (list 'lambda '() bodythunk))
 				      after-load-alist))))))
+;;; Functions to cleanly eliminate warnings about undefined functions
+;;; or variables when the code knows what it's doing.  These macros DO
+;;; NOT rely on any byte-compiler changes, and thus can be copied into
+;;; a package and used within it.
+;; NOTE: As a result of the above requirement, the macros rely on
+;; "tricks" to get the warnings suppressed.  A cleaner way, of course,
+;; would be to extend the byte compiler to provide a proper interface.
+;; #### Should we require an unquoted symbol rather than a quoted one,
+;; as we currently do?  The quoting gets no generality, as `eval' is
+;; called at compile time.  But most functions and macros want quoted
+;; arguments, and I find it extremely confusing to deal with cases
+;; such as `throw' requiring a quoted argument but `block' an unquoted
+;; one.
+(put 'with-boundp 'lisp-indent-function 1)
+(defmacro with-boundp (symbols &rest body)
+"Evaluate BODY, but do not issue bytecomp warnings about SYMBOLS undefined.
+SYMBOLS can be a symbol or a list of symbols and must be quoted.  When
+compiling this file, the warning `reference to free variable SYMBOL'
+will not occur.  This is a clean way to avoid such warnings.  See also
+`declare-boundp' and `if-boundp'."
+(setq symbols (eval symbols))
+(unless (consp symbols)
+(setq symbols (list symbols)))
+`(progn
+(declare (special ,@symbols))
+,@body))
+(put 'if-boundp 'lisp-indent-function 2)
+(defmacro if-boundp (symbol then &rest else)
+"Equivalent to (if (boundp SYMBOL) THEN ELSE) but handles bytecomp warnings.
+When compiling this file, the warning `reference to free variable SYMBOL'
+will not occur.  This is a clean way to avoid such warnings.  See also
+`with-boundp' and `declare-boundp'."
+`(with-boundp ,symbol
+(if (boundp ,symbol) ,then ,@else)))
+(defmacro declare-boundp (symbol)
+"Evaluate SYMBOL without bytecomp warnings about the symbol.
+Sample usage is
+(declare-boundp gpm-minor-mode)
+which is equivalent to
+(with-fboundp 'gpm-minor-mode
+gpm-minor-mode)"
+`(with-boundp ',symbol ,symbol))
+(defmacro globally-declare-boundp (symbol)
+"Declare that all free uses of SYMBOL in this file are valid.
+SYMBOL can also be a list of symbols.  SYMBOL must be quoted.
+When compiling this file, the warning `reference to free variable
+SYMBOL' will not occur regardless of where calls to SYMBOL occur in
+the file.
+In general, you should *NOT* use this; use `declare-boundp',
+`if-boundp', or `with-boundp' to wrap individual uses, as necessary.
+That way, you're more likely to remember to put in the explicit checks
+for the variable's existence that are usually necessary.  However,
+`globally-declare-boundp' is better in some circumstances, such as
+when writing an ELisp package that makes integral use of
+optionally-compiled-in functionality (typically, an interface onto a
+system library) and checks for the existence of the functionality at
+some entry point to the package.  See `globally-declare-fboundp' for
+more information."
+(setq symbol (eval symbol))
+(if (not (consp symbol))
+(setq symbol (list symbol)))
+`(progn
+;; (defvar FOO) has no side effects.
+,@(mapcar #'(lambda (sym) `(defvar ,sym)) symbol)))
+(defun byte-compile-with-fboundp (form)
+(byte-compile-form (cons 'progn (cdr (cdr form))))
+;; Unfortunately, byte-compile-unresolved-functions is used not only
+;; for unresolved-function warnings, but also in connection with the
+;; following warnings:
+;; "defsubst %s was used before it was defined"
+;; "%s being defined to take %s%s, but was previously called with %s"
+;; By hacking byte-compile-unresolved-functions like this, we
+;; effectively disable these warnings.  But code should not be using
+;; `with-fboundp' with a function defined later on in the same
+;; file, so this is not a big deal.
+(let ((symbols (eval (car (cdr form)))))
+(unless (consp symbols)
+(setq symbols (list symbols)))
+(setq symbols (mapcar #'(lambda (sym) (cons sym nil)) symbols))
+(setq byte-compile-unresolved-functions
+	  (set-difference byte-compile-unresolved-functions symbols
+			  :key #'car))
+))
+;; EEEEEEEEVIL hack.  We need to create our own byte-compilation
+;; method so that the proper variables are bound while compilation
+;; takes place (which is when the warnings get noticed and batched
+;; up).  What we really want to do is make `with-fboundp' a macro
+;; that simply `progn's its BODY; but GOD DAMN IT, macros can't have
+;; their own byte-compilation methods!  So we make `with-fboundp' a
+;; macro calling `with-fboundp-1', which is cleverly aliased to
+;; progn.  This way we can put a byte-compilation method on
+;; `with-fboundp-1', and when interpreting, progn will duly skip
+;; the first, quoted argument, i.e. the symbol name. (We could make
+;; `with-fboundp-1' a regular function, but then we'd have to thunk
+;; BODY and eval it at runtime.  We could probably just do this using
+;; (apply 'progn BODY), but the existing method is more obviously
+;; guaranteed to work.)
+;;
+;; In defense, cl-macs.el does a very similar thing with
+;; `cl-block-wrapper'.
+(put 'with-fboundp-1 'byte-compile 'byte-compile-with-fboundp)
+(defalias 'with-fboundp-1 'progn)
+(put 'with-fboundp 'lisp-indent-function 1)
+(defmacro with-fboundp (symbol &rest body)
+"Evaluate BODY, but do not issue bytecomp warnings about SYMBOL.
+SYMBOL must be quoted.  When compiling this file, the warning `the
+function SYMBOL is not known to be defined' will not occur.  This is a
+clean way to avoid such warnings.  See also `declare-fboundp',
+`if-fboundp', and `globally-declare-fboundp'."
+`(with-fboundp-1 ,symbol ,@body))
+(put 'if-fboundp 'lisp-indent-function 2)
+(defmacro if-fboundp (symbol then &rest else)
+"Equivalent to (if (fboundp SYMBOL) THEN ELSE) but handles bytecomp warnings.
+When compiling this file, the warning `the function SYMBOL is not
+known to be defined' will not occur.  This is a clean way to avoid
+such warnings.  See also `declare-fboundp', `with-fboundp', and
+`globally-declare-fboundp'."
+`(with-fboundp ,symbol
+(if (fboundp ,symbol) ,then ,@else)))
+(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))"
+`(with-fboundp ',(car form) ,form))
+(defmacro globally-declare-fboundp (symbol)
+"Declare that all calls to function SYMBOL in this file are valid.
+SYMBOL can also be a list of symbols.  SYMBOL must be quoted.
+When compiling this file, the warning `the function SYMBOL is not
+known to be defined' will not occur regardless of where calls to
+SYMBOL occur in the file.
+In general, you should *NOT* use this; use `declare-fboundp',
+`if-fboundp', or `with-fboundp' to wrap individual uses, as necessary.
+That way, you're more likely to remember to put in the explicit checks
+for the function's existence that are usually necessary.  However,
+`globally-declare-fboundp' is better in some circumstances, such as
+when writing an ELisp package that makes integral use of
+optionally-compiled-in functionality (typically, an interface onto a
+system library) and checks for the existence of the functionality at
+some entry point to the package.  The file `ldap.el' is a good
+example: It provides a layer on top of the optional LDAP ELisp
+primitives, makes calls to them throughout its code, and verifies the
+presence of LDAP support at load time.  Putting calls to
+`declare-fboundp' throughout the code would be a major annoyance."
+(when (cl-compiling-file)
+(setq symbol (eval symbol))
+(if (not (consp symbol))
+	(setq symbol (list symbol)))
+;; Another hack.  This works because the autoload environment is
+;; currently used ONLY to suppress warnings, and the actual
+;; autoload definition is not used. (NOTE: With this definition,
+;; we will get spurious "multiple autoloads for %s" warnings if we
+;; have an autoload later in the file for any functions in SYMBOL.
+;; This is not something that code should ever do, though.)
+(setq byte-compile-autoload-environment
+	  (append (mapcar #'(lambda (sym) (cons sym nil)) symbol)
+		  byte-compile-autoload-environment)))
+nil)
+(defun byte-compile-with-byte-compiler-warnings-suppressed (form)
+(let ((byte-compile-warnings byte-compile-warnings)
+	(types (car (cdr form))))
+(unless (consp types)
+(setq types (list types)))
+(if (eq byte-compile-warnings t)
+	(setq byte-compile-warnings byte-compile-default-warnings))
+(setq byte-compile-warnings (set-difference byte-compile-warnings types))
+(byte-compile-form (cons 'progn (cdr (cdr form))))))
+;; Same hack here as with `with-fboundp'.
+(put 'with-byte-compiler-warnings-suppressed-1 'byte-compile
+'byte-compile-with-byte-compiler-warnings-suppressed)
+(defalias 'with-byte-compiler-warnings-suppressed-1 'progn)
+(put 'with-byte-compiler-warnings-suppressed 'lisp-indent-function 1)
+(defmacro with-byte-compiler-warnings-suppressed (type &rest body)
+"Evaluate BODY, but do not issue bytecomp warnings TYPE.
+TYPE should be one of `redefine', `callargs', `subr-callargs',
+`free-vars', `unresolved', `unused-vars', `obsolete', or `pedantic',
+or a list of one or more of these symbols. (See `byte-compile-warnings'.)
+TYPE must be quoted.
+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 `with-fboundp', `declare-fboundp', `if-fboundp', or
+`globally-declare-fboundp' to avoid warnings about undefined
+functions when you know the function actually exists.
+-- use `with-boundp', `declare-boundp', or `if-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))
+;; #### These should be more clever.  You could (e.g.) try fletting
+;; `byte-compile-obsolete' or temporarily removing the obsolete info
+;; from the symbol and putting it back with an unwind-protect. (Or
+;; better, modify the byte-compiler to provide a proper solution, and
+;; fix these macros to use it if available, or fall back on the way
+;; below.  Remember, these definitions need to work with an unchanged
+;; byte compiler so that they can be copied and used in packages.)
+(put 'with-obsolete-variable 'lisp-indent-function 1)
+(defmacro with-obsolete-variable (symbol &rest body)
+"Evaluate BODY but do not warn about usage of obsolete variable SYMBOL.
+SYMBOL must be quoted.  See also `with-obsolete-function'."
+`(with-byte-compiler-warnings-suppressed 'obsolete ,@body))
+(put 'with-obsolete-function 'lisp-indent-function 1)
+(defmacro with-obsolete-function (symbol &rest body)
+"Evaluate BODY but do not warn about usage of obsolete function SYMBOL.
+SYMBOL must be quoted.  See also `with-obsolete-variable'."
+`(with-byte-compiler-warnings-suppressed 'obsolete ,@body))
 ;;; Interface to file-local byte-compiler parameters.
 ;;; Redefined in bytecomp.el.
 free-vars	references to variables not in the current lexical scope.
 unused-vars	references to non-global variables bound but not referenced.
 unresolved	calls to unknown functions.
 callargs	lambda calls with args that don't match the definition.
+subr-callargs	calls to subrs with args that don't match the definition.
 redefine	function cell redefined from a macro to a lambda or vice
 		versa, or redefined to take a different number of arguments.
+obsolete	use of an obsolete function or variable.
+pedantic	warn of use of compatible symbols.
 If the first element if the list is `+' or `-' then the specified elements
 are added to or removed from the current set of warnings, instead of the
 entire set of warnings being overwritten.

Mercurial > hg > xemacs-beta

comparison lisp/bytecomp-runtime.el @ 502:7039e6323819