* Update earlier posted hideif.el enhancements
@ 2013-11-08 1:59 Luke Lee
2013-11-08 2:54 ` Stefan Monnier
0 siblings, 1 reply; 11+ messages in thread
From: Luke Lee @ 2013-11-08 1:59 UTC (permalink / raw)
To: emacs-devel
[-- Attachment #1.1: Type: text/plain, Size: 282 bytes --]
Hi,
A few days ago I posted my enhanced hideif.el. Here is a updated version
that fix a problem that stop it from finding more #defines if an empty
define is found (i.e.
#define EMPTY_MACRO
).
If you found any other bug, please also notify me. Thanks!
--
Best regards,
Luke Lee
[-- Attachment #1.2: Type: text/html, Size: 431 bytes --]
[-- Attachment #2: hideif.el --]
[-- Type: application/octet-stream, Size: 71900 bytes --]
;;; hideif.el --- hides selected code within ifdef
;; Copyright (C) 1988, 1994, 2001-2012, 2013 Free Software Foundation, Inc.
;; Author: Brian Marick
;; Daniel LaLiberte <liberte@holonexus.org>
;; Maintainer: FSF
;; Keywords: c, outlines
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; To initialize, toggle the hide-ifdef minor mode with
;;
;; M-x hide-ifdef-mode
;;
;; This will set up key bindings and call hide-ifdef-mode-hook if it
;; has a value. To explicitly hide ifdefs using a buffer-local
;; define list (default empty), type
;;
;; M-x hide-ifdefs or C-c @ h
;;
;; Hide-ifdef suppresses the display of code that the preprocessor wouldn't
;; pass through. The support of constant expressions in #if lines is
;; limited to identifiers, parens, and the operators: &&, ||, !, and
;; "defined". Please extend this.
;;
;; The hidden code is marked by ellipses (...). Be
;; cautious when editing near ellipses, since the hidden text is
;; still in the buffer, and you can move the point into it and modify
;; text unawares.
;; You can make your buffer read-only while hide-ifdef-hiding by setting
;; hide-ifdef-read-only to a non-nil value. You can toggle this
;; variable with hide-ifdef-toggle-read-only (C-c @ C-q).
;;
;; You can undo the effect of hide-ifdefs by typing
;;
;; M-x show-ifdefs or C-c @ s
;;
;; Use M-x hide-ifdef-define (C-c @ d) to define a symbol.
;; Use M-x hide-ifdef-undef (C-c @ u) to undefine a symbol.
;;
;; If you define or undefine a symbol while hide-ifdef-mode is in effect,
;; the display will be updated. Only the define list for the current
;; buffer will be affected. You can save changes to the local define
;; list with hide-ifdef-set-define-alist. This adds entries
;; to hide-ifdef-define-alist.
;;
;; If you have defined a hide-ifdef-mode-hook, you can set
;; up a list of symbols that may be used by hide-ifdefs as in the
;; following example:
;;
;; (add-hook 'hide-ifdef-mode-hook
;; (lambda ()
;; (unless hide-ifdef-define-alist
;; (setq hide-ifdef-define-alist
;; '((list1 ONE TWO)
;; (list2 TWO THREE))))
;; (hide-ifdef-use-define-alist 'list2))) ; use list2 by default
;;
;; You can call hide-ifdef-use-define-alist (C-c @ U) at any time to specify
;; another list to use.
;;
;; To cause ifdefs to be hidden as soon as hide-ifdef-mode is called,
;; set hide-ifdef-initially to non-nil.
;;
;; If you set hide-ifdef-lines to t, hide-ifdefs hides all the #ifdef lines.
;; In the absence of highlighting, that might be a bad idea. If you set
;; hide-ifdef-lines to nil (the default), the surrounding preprocessor
;; lines will be displayed. That can be confusing in its own
;; right. Other variations on display are possible, but not much
;; better.
;;
;; You can explicitly hide or show individual ifdef blocks irrespective
;; of the define list by using hide-ifdef-block and show-ifdef-block.
;;
;; You can move the point between ifdefs with forward-ifdef, backward-ifdef,
;; up-ifdef, down-ifdef, next-ifdef, and previous-ifdef.
;;
;; If you have minor-mode-alist in your mode line (the default) two labels
;; may appear. "Ifdef" will appear when hide-ifdef-mode is active. "Hiding"
;; will appear when text may be hidden ("hide-ifdef-hiding" is non-nil).
;;
;; Written by Brian Marick, at Gould, Computer Systems Division, Urbana IL.
;; Extensively modified by Daniel LaLiberte (while at Gould).
;;
;; Extensively modified by Luke Lee in 2013.
;;; Code:
(eval-when-compile (require 'cl))
(defgroup hide-ifdef nil
"Hide selected code within `ifdef'."
:group 'c)
(defcustom hide-ifdef-initially nil
"Non-nil means call `hide-ifdefs' when Hide-Ifdef mode is first activated."
:type 'boolean
:group 'hide-ifdef)
(defcustom hide-ifdef-read-only nil
"Set to non-nil if you want buffer to be read-only while hiding text."
:type 'boolean
:group 'hide-ifdef)
(defcustom hide-ifdef-lines nil
"Non-nil means hide the #ifX, #else, and #endif lines."
:type 'boolean
:group 'hide-ifdef)
(defcustom hide-ifdef-shadow nil
"Non-nil means shadow text instead of hiding it."
:type 'boolean
:group 'hide-ifdef
:version "23.1")
(defcustom hide-ifdef-exclude-define-regexp-pattern nil
"Ignore #define name if that name match this exclusion pattern."
:group 'hide-ifdef)
(defface hide-ifdef-shadow '((t (:inherit shadow)))
"Face for shadowing ifdef blocks."
:group 'hide-ifdef
:version "23.1")
(defvar hide-ifdef-mode-submap
;; Set up the submap that goes after the prefix key.
(let ((map (make-sparse-keymap)))
(define-key map "d" 'hide-ifdef-define)
(define-key map "u" 'hide-ifdef-undef)
(define-key map "D" 'hide-ifdef-set-define-alist)
(define-key map "U" 'hide-ifdef-use-define-alist)
(define-key map "h" 'hide-ifdefs)
(define-key map "s" 'show-ifdefs)
(define-key map "\C-d" 'hide-ifdef-block)
(define-key map "\C-s" 'show-ifdef-block)
(define-key map "e" 'hif-evaluate-macro)
(define-key map "\C-q" 'hide-ifdef-toggle-read-only)
(define-key map "\C-w" 'hide-ifdef-toggle-shadowing)
(substitute-key-definition
'toggle-read-only 'hide-ifdef-toggle-outside-read-only map)
map)
"Keymap used by `hide-ifdef-mode' under `hide-ifdef-mode-prefix-key'.")
(defconst hide-ifdef-mode-prefix-key "\C-c@"
"Prefix key for all Hide-Ifdef mode commands.")
(defvar hide-ifdef-mode-map
;; Set up the mode's main map, which leads via the prefix key to the submap.
(let ((map (make-sparse-keymap)))
(define-key map hide-ifdef-mode-prefix-key hide-ifdef-mode-submap)
map)
"Keymap used with `hide-ifdef-mode'.")
(easy-menu-define hide-ifdef-mode-menu hide-ifdef-mode-map
"Menu for `hide-ifdef-mode'."
'("Hide-Ifdef"
["Hide some ifdefs" hide-ifdefs
:help "Hide the contents of some #ifdefs"]
["Show all ifdefs" show-ifdefs
:help "Cancel the effects of `hide-ifdef': show the contents of all #ifdefs"]
["Hide ifdef block" hide-ifdef-block
:help "Hide the ifdef block (true or false part) enclosing or before the cursor"]
["Show ifdef block" show-ifdef-block
:help "Show the ifdef block (true or false part) enclosing or before the cursor"]
["Define a variable..." hide-ifdef-define
:help "Define a VAR so that #ifdef VAR would be included"]
["Undefine a variable..." hide-ifdef-undef
:help "Undefine a VAR so that #ifdef VAR would not be included"]
["Define an alist..." hide-ifdef-set-define-alist
:help "Set the association for NAME to `hide-ifdef-env'"]
["Use an alist..." hide-ifdef-use-define-alist
:help "Set `hide-ifdef-env' to the define list specified by NAME"]
["Toggle read only" hide-ifdef-toggle-read-only
:style toggle :selected hide-ifdef-read-only
:help "Buffer should be read-only while hiding text"]
["Toggle shadowing" hide-ifdef-toggle-shadowing
:style toggle :selected hide-ifdef-shadow
:help "Text should be shadowed instead of hidden"]))
(defvar hide-ifdef-hiding nil
"Non-nil when text may be hidden.")
(or (assq 'hide-ifdef-hiding minor-mode-alist)
(setq minor-mode-alist
(cons '(hide-ifdef-hiding " Hiding")
minor-mode-alist)))
;; fix c-mode syntax table so we can recognize whole symbols.
(defvar hide-ifdef-syntax-table
(let ((st (copy-syntax-table c-mode-syntax-table)))
(modify-syntax-entry ?_ "w" st)
(modify-syntax-entry ?& "." st)
(modify-syntax-entry ?\| "." st)
st)
"Syntax table used for tokenizing #if expressions.")
(defvar hide-ifdef-env nil
"An alist of defined symbols and their values.")
(defvar hif-outside-read-only nil
"Internal variable. Saves the value of `buffer-read-only' while hiding.")
;;;###autoload
(define-minor-mode hide-ifdef-mode
"Toggle features to hide/show #ifdef blocks (Hide-Ifdef mode).
With a prefix argument ARG, enable Hide-Ifdef mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
Hide-Ifdef mode is a buffer-local minor mode for use with C and
C-like major modes. When enabled, code within #ifdef constructs
that the C preprocessor would eliminate may be hidden from view.
Several variables affect how the hiding is done:
`hide-ifdef-env'
An association list of defined and undefined symbols for the
current buffer. Initially, the global value of `hide-ifdef-env'
is used.
`hide-ifdef-define-alist'
An association list of defined symbol lists.
Use `hide-ifdef-set-define-alist' to save the current `hide-ifdef-env'
and `hide-ifdef-use-define-alist' to set the current `hide-ifdef-env'
from one of the lists in `hide-ifdef-define-alist'.
`hide-ifdef-lines'
Set to non-nil to not show #if, #ifdef, #ifndef, #else, and
#endif lines when hiding.
`hide-ifdef-initially'
Indicates whether `hide-ifdefs' should be called when Hide-Ifdef mode
is activated.
`hide-ifdef-read-only'
Set to non-nil if you want to make buffers read only while hiding.
After `show-ifdefs', read-only status is restored to previous value.
\\{hide-ifdef-mode-map}"
:group 'hide-ifdef :lighter " Ifdef"
(if hide-ifdef-mode
(progn
;; inherit global values
;; (set (make-local-variable 'hide-ifdef-env) ;; [2012-09-27 11:05:26 +0800] Luke rem 2 ins 2
;; (default-value 'hide-ifdef-env))
(set 'hide-ifdef-env (default-value 'hide-ifdef-env))
(set (make-local-variable 'hide-ifdef-hiding)
(default-value 'hide-ifdef-hiding))
(set (make-local-variable 'hif-outside-read-only) buffer-read-only)
(set (make-local-variable 'line-move-ignore-invisible) t)
(add-hook 'change-major-mode-hook
(lambda () (hide-ifdef-mode -1)) nil t)
(add-to-invisibility-spec '(hide-ifdef . t))
(if hide-ifdef-initially
(hide-ifdefs)
(show-ifdefs)))
;; else end hide-ifdef-mode
(kill-local-variable 'line-move-ignore-invisible)
(remove-from-invisibility-spec '(hide-ifdef . t))
(when hide-ifdef-hiding
(show-ifdefs))))
(defun hif-show-all ()
"Show all of the text in the current buffer."
(interactive)
(hif-show-ifdef-region (point-min) (point-max)))
;; By putting this on after-revert-hook, we arrange that it only
;; does anything when revert-buffer avoids turning off the mode.
;; (That can happen in VC.)
(defun hif-after-revert-function ()
(and hide-ifdef-mode hide-ifdef-hiding
(hide-ifdefs t)))
(add-hook 'after-revert-hook 'hif-after-revert-function)
(defun hif-end-of-line ()
(end-of-line)
(while (= (logand 1 (skip-chars-backward "\\\\")) 1)
(end-of-line 2)))
(defun merge-ifdef-region (start end)
;; Genernally there is no need to call itself recursively since there should originally
;; exists no un-merged regions; however, if a part of the file is hidden with 'hide-ifdef-lines'
;; as nil while another part with 't, this case happens.
;; TODO: should we merge? or just create a container overlay? -- this can prevent hideif-show-ifdef
;; expand too many since there is only a big overlay exists there without any smaller overlays.
"Merge nearby ifdef regions to form a bigger overlay. This will decrease the
total number of overlays created."
(save-restriction
(widen) ;; otherwise (point-min) and (point-max) will be
;; restricted and thus fail to find neighbor overlays
(let ((begovrs (overlays-in
(max (- start 2) (point-min))
(max (- start 1) (point-min))))
(endovrs (overlays-in
(min (+ end 1) (point-max))
(min (+ end 2) (point-max))))
(ob nil)
(oe nil)
b e)
;; merge overlays before 'start'
(dolist (o begovrs)
(when (overlay-get o 'hide-ifdef)
(setq b (min start (overlay-start o))
e (max end (overlay-end o)))
(move-overlay o b e)
(merge-ifdef-region b e)
(setq ob o)))
;; merge overlays after 'end'
(dolist (o endovrs)
(when (overlay-get o 'hide-ifdef)
(setq b (min start (overlay-start o))
e (max end (overlay-end o)))
(move-overlay o b e)
(merge-ifdef-region b e)
(setf oe o)))
;; if both 'start' 'end' merging happens, merge into bigger one
(when (and ob oe)
(let ((b (min (overlay-start ob) (overlay-start oe)))
(e (max (overlay-end ob) (overlay-end oe))))
(delete-overlay oe)
(move-overlay ob b e)
(merge-ifdef-region b e)))
(or ob oe))))
(defun hide-ifdef-region-internal (start end)
(unless (merge-ifdef-region start end)
(let ((o (make-overlay start end)))
(overlay-put o 'hide-ifdef t)
(if hide-ifdef-shadow
(overlay-put o 'face 'hide-ifdef-shadow)
(overlay-put o 'invisible 'hide-ifdef)))))
(defun hide-ifdef-region (start end)
"START is the start of a #if, #elif, or #else form. END is the ending part.
Everything including these lines is made invisible."
(save-excursion
(goto-char start) (hif-end-of-line) (setq start (point))
(goto-char end) (hif-end-of-line) (setq end (point))
(hide-ifdef-region-internal start end)))
(defun hif-show-ifdef-region (start end)
"Everything between START and END is made visible."
(let ((onum (length (overlays-in start end))))
(remove-overlays start end 'hide-ifdef t)
(/= onum (length (overlays-in start end)))))
;;===%%SF%% evaluation (Start) ===
;; It is not useful to set this to anything but `eval'.
;; In fact, the variable might as well be eliminated.
(defvar hide-ifdef-evaluator 'eval
"The function to use to evaluate a form.
The evaluator is given a canonical form and returns t if text under
that form should be displayed.")
(defvar hif-undefined-symbol nil
"...is by default considered to be false.")
(defun hif-set-var (var value)
"Prepend (var value) pair to hide-ifdef-env."
(setq hide-ifdef-env (cons (cons var value) hide-ifdef-env)))
(defun hif-table-lookup (var table)
(let* ((sa (assoc var table))
(val (cdr sa)))
(if (null sa)
hif-undefined-symbol
val)))
(defun hif-lookup (var)
;; (message "hif-lookup %s" var)
(hif-table-lookup var hide-ifdef-env))
(defun hif-defined (var)
(if (assoc var hide-ifdef-env) 1 0))
;;===%%SF%% evaluation (End) ===
;;===%%SF%% parsing (Start) ===
;;; The code that understands what ifs and ifdef in files look like.
(defconst hif-cpp-prefix "\\(^\\|\r\\)[ \t]*#[ \t]*")
(defconst hif-ifxdef-regexp (concat hif-cpp-prefix "if\\(n\\)?def"))
(defconst hif-ifndef-regexp (concat hif-cpp-prefix "ifndef"))
(defconst hif-ifx-regexp (concat hif-cpp-prefix "if\\(n?def\\)?[ \t]+"))
(defconst hif-elif-regexp (concat hif-cpp-prefix "elif"))
(defconst hif-else-regexp (concat hif-cpp-prefix "else"))
(defconst hif-endif-regexp (concat hif-cpp-prefix "endif"))
(defconst hif-ifx-else-endif-regexp
(concat hif-ifx-regexp "\\|" hif-elif-regexp "\\|" hif-else-regexp "\\|" hif-endif-regexp))
(defconst hif-macro-expr-prefix-regexp (concat hif-cpp-prefix "\\(if\\(n?def\\)?\\|elif\\|define\\)[ \t]+"))
(defconst hif-white "[ \t]*")
(defconst hif-define (concat hif-cpp-prefix "\\(define\\|undef\\)"))
(defconst hif-id (concat "[A-Za-z_][0-9A-Za-z_]*"))
(defconst hif-macroname (concat hif-white "\\(" hif-id "\\)" hif-white
"\\("
"(" hif-white
"\\(" hif-id "\\)?" hif-white
"\\(" "," hif-white hif-id hif-white "\\)*"
"\\(\\.\\.\\.\\)?" hif-white
")"
"\\)?" ))
;; Used to store the current token and the whole token list during parsing.
;; Only bound dynamically.
(defvar hif-token)
(defvar hif-token-list)
(defconst hif-token-alist
'(("||" . hif-or)
("&&" . hif-and)
("|" . hif-logior)
("^" . hif-logxor)
("&" . hif-logand)
("<<" . hif-shiftleft)
(">>" . hif-shiftright)
("==" . hif-equal)
("=" . hif-assign)
("!=" . hif-notequal)
("##" . hif-token-concat)
("!" . hif-not)
("~" . hif-lognot)
("(" . hif-lparen)
(")" . hif-rparen)
(">" . hif-greater)
("<" . hif-less)
(">=" . hif-greater-equal)
("<=" . hif-less-equal)
("+" . hif-plus)
("-" . hif-minus)
("*" . hif-multiply)
("/" . hif-divide)
("%" . hif-modulo)
("?" . hif-conditional)
(":" . hif-colon)
("," . hif-comma)
("#" . hif-stringify)
("..." . hif-etc)))
(defconst hif-valid-token-list (mapcar 'cdr hif-token-alist))
(defconst hif-token-regexp
(concat (regexp-opt (mapcar 'car hif-token-alist))
"\\|0x[0-9a-fA-F]+\\.?[0-9a-fA-F]*" ;; Luke added
"\\|[0-9]+\\.?[0-9]*" ;; Luke added, decimal/octal
"\\|\\w+"))
(defconst hif-string-literal-regexp
(concat hif-white "\\(\"[^\"]*\"\\)"))
(defvar hif-simple-token-only nil)
(defun hif-tokenize (start end)
"Separate string between START and END into a list of tokens."
(let ((token-list nil))
(setq hif-simple-token-only t)
(with-syntax-table hide-ifdef-syntax-table
(save-excursion
(goto-char start)
(while (progn (forward-comment (point-max)) (< (point) end))
;; (message "expr-start = %d" expr-start) (sit-for 1)
(cond
((looking-at "\\\\\n")
(forward-char 2))
((looking-at hif-string-literal-regexp)
(push (substring-no-properties (match-string 1)) token-list)
(goto-char (match-end 0)))
((looking-at hif-token-regexp)
(let ((token (buffer-substring-no-properties (point) (match-end 0))))
(goto-char (match-end 0))
;; (message "token: %s" token) (sit-for 1)
(push (or (cdr (assoc token hif-token-alist))
(if (string-equal token "defined") 'hif-defined)
(if (string-match "0x\\([a-fA-F0-9]+\\)" token)
(string-to-number (match-string 1 token) 16)) ;; hexadecimal
(if (string-match "\\`0[0-9]*\\(\\.[0-9]+\\)?\\'" token)
(string-to-number token 8)) ;; octal
(if (string-match "\\`[1-9][0-9]*\\(\\.[0-9]+\\)?\\'" token)
(string-to-number token)) ;; decimal
(prog1 (intern token)
(setq hif-simple-token-only nil)))
token-list)))
((looking-at "\r")
(forward-char 1))
(t (error "Bad #if expression: %s" (buffer-string)))))))
(nreverse token-list)))
;;;-----------------------------------------------------------------
;;; Translate C preprocessor #if expressions using recursive descent.
;;; This parser is limited to the operators &&, ||, !, and "defined".
;;; Added ==, !=, +, and -. Gary Oberbrunner, garyo@avs.com, 8/9/94
;;;
;;; Implement the C language operator precedence table. Add all those
;;; missing operators that could be used in macros. Luke Lee 2013-09-04
;;; | Operator Type | Operator | Associativity |
;;; +----------------------+---------------------------------------------+---------------+
;;; | Primary Expression | () [] . -> expr++ expr-- | left-to-right |
;;; | Unary Operators | * & + - ! ~ ++expr --expr (typecast) sizeof | right-to-left |
;;; | Binary Operators | * / % | left-to-right |
;;; | | + - | |
;;; | | >> << | |
;;; | | < > <= >= | |
;;; | | == != | |
;;; | | & | |
;;; | | ^ | |
;;; | | | | |
;;; | | && | |
;;; | | || | |
;;; | Ternary Operator | ?: | right-to-left |
;;; x| Assignment Operators | = += -= *= /= %= >>= <<= &= ^= = | right-to-left |
;;; | Comma | , | left-to-right |
(defsubst hif-nexttoken ()
"Pop the next token from token-list into the let variable \"hif-token\"."
(setq hif-token (pop hif-token-list)))
(defsubst if-valid-identifier (id)
(not (or (numberp id)
(stringp id))))
(defun hif-define-operator (tokens)
"`Upgrade' hif-define xxx to '(hif-define xxx)' so that it won't be subsitituted"
(let ((result nil)
(tok nil))
(while tokens
(setq tok (car tokens)
tokens (cdr tokens))
(setq result
(append
result
(list
(if (eq tok 'hif-defined)
(progn
(setq tok (cadr tokens))
(if (eq (car tokens) 'hif-lparen)
(if (and (if-valid-identifier tok)
(eq (caddr tokens) 'hif-rparen))
(setq tokens (cdddr tokens))
(error "operator \"defined\" requires an identifier"))
(setq tok (car tokens)
tokens (cdr tokens))
(unless (if-valid-identifier tok)
(error "operator \"defined\" requires an identifier")))
(list 'hif-defined 'hif-lparen tok 'hif-rparen))
tok)))))
result))
(defun hif-expand-token-list (tokens &optional macroname reflist) ;; reference list to prevent self-referencing
"Perform expansion till everything expanded. No self-reference expansion."
(catch 'self-referencing
(let ((expanded nil)
(remains (hif-define-operator
(hif-token-concatenation (hif-token-stringification tokens))))
tok rep)
(if macroname
(setq reflist (cons macroname reflist)))
;; Expanding all tokens till list exhausted
(while remains
(setq tok (car remains)
remains (cdr remains))
(if (memq tok reflist) ;; for self-referencing tokens, don't expand it
(throw 'self-referencing tokens))
(setq expanded
(append
expanded
(cond
((or (memq tok hif-valid-token-list)
(numberp tok)
(stringp tok))
(list tok))
((setq rep (hif-lookup tok))
(if (and (listp rep)
(eq (car rep) 'hif-define-macro)) ;; a defined macro
;; recursively expand it
(if (cadr rep) ;; arglist is not nil
(if (eq (car remains) 'hif-lparen)
;; Argumented macro, get arguments and invoke it
(let* ((hif-token-list (cdr remains)) ;; dynamic binding for hif-macro-supply-arguments
(hif-token nil) ;; dynamic binding for hif-macro-supply-arguments
(parmlist (mapcar 'hif-expand-token-list
(hif-get-argument-list tok)))
(result (hif-expand-token-list (hif-macro-supply-arguments tok parmlist)
tok reflist)))
(setq remains (cons hif-token hif-token-list))
result)
;; no argument supplied, no invocation for this macro
(list tok))
;; arglist is nil, direct expansion
(setq rep (hif-expand-token-list (caddr rep) ;; macro's token list
tok reflist))
(setq remains (substitute tok rep remains)) ;; replace all remaining references immediately
(list rep))
;; lookup tok returns an atom
(list rep)))
;;[2013-10-22 16:06:12 +0800] Must keep the token, removeing this token might results in a incomplete expression which cannot be parsed.
;;((= 1 (hif-defined tok)) ;; defined (hif-defined tok)=1, but empty (hif-lookup tok)=nil, thus remove this token
;; (setq remains (delete tok remains))
;; nil)
(t ;; usual IDs
(list tok))))))
(flatten expanded))))
(defun hif-parse-if-exp (token-list &optional macroname)
"Parse the TOKEN-LIST. Return translated list in prefix form."
(let ((hif-token-list (hif-expand-token-list token-list macroname)))
(hif-nexttoken)
(prog1
(and hif-token
(hif-exprlist))
(if hif-token ; is there still a token?
(error "Error: unexpected token: %s" hif-token)))))
;;;
;;;To manually test these functions, try the following in scratch buffer:
;;;
;;;(hif-find-define (point)) ;; find only one #define
;;;(hif-add-new-defines) ;; find all #defines
;;;
;;;#define macro ( arg1 , arg2 , arg3 ... ) arg1 + arg2 * arg3
;;;
;;;(assoc 'macro hide-ifdef-env)
;;;
;;;(hif-canonicalize-tokens hif-ifx-regexp)
;;;(hif-expand-token-list (hif-canonicalize-tokens hif-ifx-regexp))
;;;(hif-canonicalize hif-ifx-regexp)
;;;
;;;#if macro( (a,2,3), b<<1, (c&7,d) )
;;;
(defun hif-exprlist ()
"Parse an exprlist: expr { ',' expr}"
(let ((result (hif-expr))
comma)
(while (eq hif-token 'hif-comma)
(unless comma
(setq result (list result)))
(setq comma t)
(hif-nexttoken)
(setq result (append result (list (hif-expr)))))
(if comma
(append (list 'hif-comma) result)
result)))
(defun hif-expr ()
"Parse an expression as found in #if.
expr : or-expr | or-expr '?' expr ':' expr."
(let ((result (hif-or-expr))
middle)
(while (eq hif-token 'hif-conditional)
(hif-nexttoken)
(setq middle (hif-expr))
(if (eq hif-token 'hif-colon)
(progn
(hif-nexttoken)
(setq result (list 'hif-conditional result middle (hif-expr))))
(error "Error: unexpected token: %s" hif-token)))
result))
(defun hif-or-expr ()
"Parse an or-expr : and-expr | or-expr '||' and-expr."
(let ((result (hif-and-expr)))
(while (eq hif-token 'hif-or)
(hif-nexttoken)
(setq result (list 'hif-or result (hif-and-expr))))
result))
(defun hif-and-expr ()
"Parse an and-expr : logior-expr | and-expr '&&' logior-expr."
(let ((result (hif-logior-expr)))
(while (eq hif-token 'hif-and)
(hif-nexttoken)
(setq result (list 'hif-and result (hif-logior-expr))))
result))
(defun hif-logior-expr ()
"Parse a logor-expr : logxor-expr | logor-expr '|' logxor-expr."
(let ((result (hif-logxor-expr)))
(while (eq hif-token 'hif-logior)
(hif-nexttoken)
(setq result (list 'hif-logior result (hif-logxor-expr))))
result))
(defun hif-logxor-expr ()
"Parse a logxor-expr : logand-expr | logxor-expr '^' logand-expr."
(let ((result (hif-logand-expr)))
(while (eq hif-token 'hif-logxor)
(hif-nexttoken)
(setq result (list 'hif-logxor result (hif-logand-expr))))
result))
(defun hif-logand-expr ()
"Parse a logand-expr : eq-expr | logand-expr '&' eq-expr."
(let ((result (hif-eq-expr)))
(while (eq hif-token 'hif-logand)
(hif-nexttoken)
(setq result (list 'hif-logand result (hif-eq-expr))))
result))
(defun hif-eq-expr ()
"Parse an eq-expr : comp | eq-expr `=='|`!=' comp."
(let ((result (hif-comp-expr))
(eq-token nil))
(while (memq hif-token '(hif-equal hif-notequal))
(setq eq-token hif-token)
(hif-nexttoken)
(setq result (list eq-token result (hif-comp-expr))))
result))
(defun hif-comp-expr ()
"Parse a comp-expr : logshift | comp-expr `<'|`>'|`>='|`<=' logshift."
(let ((result (hif-logshift-expr))
(comp-token nil))
(while (memq hif-token '(hif-greater hif-less hif-greater-equal hif-less-equal))
(setq comp-token hif-token)
(hif-nexttoken)
(setq result (list comp-token result (hif-logshift-expr))))
result))
(defun hif-logshift-expr ()
"Parse a logshift : math | logshift `<<'|`>>' math."
(let ((result (hif-math))
(shift-token nil))
(while (memq hif-token '(hif-shiftleft hif-shiftright))
(setq shift-token hif-token)
(hif-nexttoken)
(setq result (list shift-token result (hif-math))))
result))
(defun hif-math ()
"Parse an expression with + or -.
math : muldiv | math '+|-' muldiv."
(let ((result (hif-muldiv-expr))
(math-op nil))
(while (memq hif-token '(hif-plus hif-minus))
(setq math-op hif-token)
(hif-nexttoken)
(setq result (list math-op result (hif-muldiv-expr))))
result))
(defun hif-muldiv-expr ()
"Parse an expression with *,/,%.
muldiv : factor | muldiv '*|/|%' factor."
(let ((result (hif-factor))
(math-op nil))
(while (memq hif-token '(hif-multiply hif-divide hif-modulo))
(setq math-op hif-token)
(hif-nexttoken)
(setq result (list math-op result (hif-factor))))
result))
(defun hif-factor ()
"Parse a factor: '!' factor | '~' factor | '(' expr ')' | 'defined(' id ')' | 'id(parmlist)' | strings | id."
(cond
((eq hif-token 'hif-not)
(hif-nexttoken)
(list 'hif-not (hif-factor)))
((eq hif-token 'hif-lognot)
(hif-nexttoken)
(list 'hif-lognot (hif-factor)))
((eq hif-token 'hif-lparen)
(hif-nexttoken)
(let ((result (hif-exprlist)))
(if (not (eq hif-token 'hif-rparen))
(error "Bad token in parenthesized expression: %s" hif-token)
(hif-nexttoken)
result)))
((eq hif-token 'hif-defined)
(hif-nexttoken)
(let ((paren (when (eq hif-token 'hif-lparen) (hif-nexttoken) t))
(ident hif-token))
(if (memq hif-token '(or and not hif-defined hif-lparen hif-rparen))
(error "Error: unexpected token: %s" hif-token))
(when paren
(hif-nexttoken)
(unless (eq hif-token 'hif-rparen)
(error "Error: expected \")\" after identifier")))
(hif-nexttoken)
`(hif-defined (quote ,ident))))
((numberp hif-token)
(prog1 hif-token (hif-nexttoken)))
((stringp hif-token)
(hif-string-concatenation))
;; Unary plus/minus.
((memq hif-token '(hif-minus hif-plus))
(list (prog1 hif-token (hif-nexttoken)) 0 (hif-factor)))
(t ; identifier
(let ((ident hif-token))
(hif-nexttoken)
(if (eq hif-token 'hif-lparen)
(hif-place-macro-invocation ident)
`(hif-lookup (quote ,ident)))))))
(defun hif-get-argument-list (ident)
(let ((nest 0)
(parmlist nil) ;; a "token" list of parameters, will later be parsed
(parm nil))
(while (or (not (eq (hif-nexttoken) 'hif-rparen))
(/= nest 0))
(if (eq (car parm) 'hif-comma)
(setq parm nil))
(cond
((eq hif-token 'hif-lparen)
(setq nest (1+ nest)))
((eq hif-token 'hif-rparen)
(setq nest (1- nest))
(if (< nest 0)
(error "Unbalanced parenthesis when invoking macro %S" ident)))
((and (eq hif-token 'hif-comma)
(= nest 0))
(setq parmlist (append parmlist (list parm))
parm nil)))
(setq parm (append parm (list hif-token))))
(setq parmlist (append parmlist (list parm))) ; okay even if parm is nil
(hif-nexttoken) ; drop the hif-rparen, get next token
parmlist))
(defun hif-place-macro-invocation (ident)
(let ((parmlist (hif-get-argument-list ident)))
`(hif-invoke (quote ,ident) (quote ,parmlist))))
(defun hif-string-concatenation ()
"Parse concatenated strings: string | strings string"
(let ((result (substring-no-properties hif-token)))
(while (stringp (hif-nexttoken))
(setq result (concat
(substring result 0 -1) ; remove trailing '"'
(substring hif-token 1)))) ; remove leading '"'
result))
(defun hif-define-macro (parmlist token-body)
"A marker for defined macro with arguments, cannot be evaluated alone with no parameters inputed."
;; TODO: input parameters at run time, use minibuffer to query all parameters
(error "Argumented macro cannot be evaluated without passing any parameter."))
(defun hif-stringify (a)
"Stringify a number, string or symbol"
(cond
((numberp a)
(number-to-string a))
((atom a)
(symbol-name a))
((stringp a)
(concat "\"" a "\""))
(t
(error "Invalid token to stringify"))))
(defun intern-safe (str)
(if (stringp str)
(intern str)))
(defun hif-merge-operator-token (a b)
"Support weird (but valid) use of token concatenation. Here we take care only those that can be evaluated during
preprocessing time. For those computable syntax that can only be evaluated during C runtime (like '++','--','+='...),
we ignore them all here."
(cond
((and (eq a 'hif-logior) (eq b 'hif-logior)) ;; '|''|' -> '||'
'hif-or)
((and (eq a 'hif-logand) (eq b 'hif-logand)) ;; '&''&' -> '&&'
'hif-and)
((and (eq a 'hif-assign) (eq b 'hif-assign)) ;; '=''=' -> '=='
'hif-equal)
((and (eq a 'hif-not) (eq b 'hif-assign)) ;; '!''=' -> '!='
'hif-notequal)
((eq a 'hif-less)
(if (eq b 'hif-less) ;; '<''<' -> '<<'
'hif-shiftleft
(if (eq b 'hif-assign) ;; '<''=' -> '<='
'hif-less-equal)))
((eq a 'hif-greater)
(if (eq b 'hif-greater) ;; '>''>' -> '>>'
'hif-shiftleft
(if (eq b 'hif-assign) ;; '>''=' -> '>='
'hif-greater-equal)))))
(defun hif-token-concat (a b)
"Concatenation two symbol name into a longer symbol, currently support only simple symbol concatenation."
(if (or (memq a hif-valid-token-list)
(memq b hif-valid-token-list))
(let ((result (hif-merge-operator-token a b)))
(or result
;;(error "Invalid token to concatenate")
(error "pasting \"%s\" and \"%s\" does not give a valid preprocessing token"
(if (memq a hif-valid-token-list) (car (rassoc a hif-token-alist)) (symbol-name a))
(if (memq b hif-valid-token-list) (car (rassoc b hif-token-alist)) (symbol-name b)))))
(intern-safe (concat (hif-stringify a)
(hif-stringify b)))))
(defun hif-mathify (val)
"Treat VAL as a number: if it's t or nil, use 1 or 0."
(cond ((eq val t) 1)
((null val) 0)
(t val)))
(defun hif-conditional (a b c)
(if (not (zerop (hif-mathify a))) (hif-mathify b) (hif-mathify c)))
(defun hif-and (a b)
(and (not (zerop (hif-mathify a))) (not (zerop (hif-mathify b)))))
(defun hif-or (a b)
(or (not (zerop (hif-mathify a))) (not (zerop (hif-mathify b)))))
(defun hif-not (a)
(zerop (hif-mathify a)))
(defun hif-lognot (a)
(lognot a))
(defmacro hif-mathify-binop (fun)
`(lambda (a b)
,(format "Like `%s' but treat t and nil as 1 and 0." fun)
(,fun (hif-mathify a) (hif-mathify b))))
(defun shiftleft (a b)
(if (< a 0)
(ash a b)
(lsh a b)))
(defun shiftright (a b)
(if (< a 0)
(ash a (- 0 b))
(lsh a (- 0 b))))
(defalias 'hif-multiply (hif-mathify-binop *))
(defalias 'hif-divide (hif-mathify-binop /))
(defalias 'hif-modulo (hif-mathify-binop %))
(defalias 'hif-plus (hif-mathify-binop +))
(defalias 'hif-minus (hif-mathify-binop -))
(defalias 'hif-equal (hif-mathify-binop =))
(defalias 'hif-notequal (hif-mathify-binop /=))
(defalias 'hif-greater (hif-mathify-binop >))
(defalias 'hif-less (hif-mathify-binop <))
(defalias 'hif-greater-equal (hif-mathify-binop >=))
(defalias 'hif-less-equal (hif-mathify-binop <=))
(defalias 'hif-logior (hif-mathify-binop logior))
(defalias 'hif-logxor (hif-mathify-binop logxor))
(defalias 'hif-logand (hif-mathify-binop logand))
(defalias 'hif-shiftleft (hif-mathify-binop shiftleft))
(defalias 'hif-shiftright (hif-mathify-binop shiftright))
(defun hif-comma (&rest expr)
"Evaluate a list of expr, return the result of the last item"
(let ((result nil))
(dolist (e expr)
(ignore-errors
(setq result (funcall hide-ifdef-evaluator e))))
result))
(defun hif-token-stringification (l)
"Scan token list for 'hif-stringify' ('#') token and stringify the next token"
(let (result)
(while l
(setq result
(append result
(list
(if (eq (car l) 'hif-stringify)
(prog1
(if (cadr l)
(hif-stringify (cadr l))
(error "No token to stringify"))
(setq l (cdr l)))
(car l)))))
(setq l (cdr l)))
result))
(defun hif-token-concatenation (l)
"Scan token list for 'hif-token-concat' ('##') token and concatenate two tokens"
(let ((prev nil)
result)
(while l
(while (eq (car l) 'hif-token-concat)
(unless prev
(error "No token before ## to concatenate"))
(unless (cdr l)
(error "No token after ## to concatenate"))
(setq prev (hif-token-concat prev (cadr l)))
(setq l (cddr l)))
(if prev
(setq result (append result (list prev))))
(setq prev (car l)
l (cdr l)))
(if prev
(append result (list prev))
result)))
(defun flatten (l)
"Flatten a tree"
(if (and l (atom l))
(list l)
(if (consp l)
(nconc (flatten (car l)) (flatten (cdr l))))))
(defun delimit (l a)
"Delmit a list 'l' with delimiter atom 'd'"
(nconc (mapcan (lambda (l)
(list l a)) (butlast l))
(last l)))
;; Perform token replacement:
(defun hif-macro-supply-arguments (macro-name actual-parms)
"Expand a macro function, replace 'actual-parms' to the function body."
(let* ((SA (assoc macro-name hide-ifdef-env))
(macro (and SA
(cdr SA)
(eq (cadr SA) 'hif-define-macro)
(cddr SA)))
(formal-parms (and macro (car macro)))
(macro-body (and macro (cadr macro)))
(hide-ifdef-local-env nil) ;; dynamic binding local table
actual-count
formal-count
actual
formal
etc)
(when (and actual-parms formal-parms macro-body)
;; For each actual parameter, evaluate each one and associate it
;; with the associated actual parameter, put it into local table and finally
;; evaluate the macro body.
(if (setq etc (eq (car formal-parms) 'hif-etc)) ;; Take care of 'hif-etc first. Prefix 'hif-comma back if needed.
(setq formal-parms (cdr formal-parms)))
(setq formal-count (length formal-parms)
actual-count (length actual-parms))
(if (> formal-count actual-count)
(error "Too few parmameter for macro %S" macro-name)
(if (< formal-count actual-count)
(or etc
(error "Too many parameters for macro %S" macro-name))))
;; Perform token replacement on the macro-body on the parameters
(while (setq formal (car formal-parms))
(setq formal-parms (cdr formal-parms))
;; Prevent repettative substitutation, thus cannot use 'subst'
;; for example:
;; #define mac(a,b) (a+b)
;; #define testmac mac(b,y)
;; testmac should expand to (b+y): replace of argument a and b occurs simultaneously
;; not sequentially. If this occurs sequentially according to the argument order,
;; it will become: 1. formal parm #1 'a' replaced by actual parm 'b', thus (a+b) becomes (b+b)
;; 2. formal parm #2 'b' replaced by actual parm 'y', thus (b+b) becomes (y+y).
(setq macro-body
;; Unlike 'subst', 'substitute' replace only the top level instead of the whole tree,
;; more importantly, it's not destructive.
(if (and etc (null formal-parms))
(substitute (delimit actual-parms 'hif-comma) formal macro-body)
(substitute (car actual-parms) formal macro-body)))
(setq actual-parms (cdr actual-parms)))
;; Replacement completed, flattern the whole token list,
(setq macro-body (flatten macro-body))
;; Stringification and token concatenation happens here
(hif-token-concatenation (hif-token-stringification macro-body)))))
(defun hif-invoke (macro-name actual-parms)
"Invoke a macro by first expanding it, then reparse the macro-body, finally invoke the macro."
;; Reparse the macro body and evaluate it
(funcall hide-ifdef-evaluator
(hif-parse-if-exp
(hif-macro-supply-arguments macro-name actual-parms)
macro-name)))
;;;----------- end of parser -----------------------
(defun hif-canonicalize-tokens (regexp) ;; for debugging
"Return the expanded result of the scanned tokens."
(save-excursion
(re-search-forward regexp)
(let* ((curr-regexp (match-string 0))
(defined (string-match hif-ifxdef-regexp curr-regexp))
(negate (and defined
(string= (match-string 2 curr-regexp) "n"))))
(let* ((tokens (hif-tokenize (point)
(progn (hif-end-of-line) (point)))))
(if defined
(setq tokens (list 'hif-defined tokens)))
(if negate
(setq tokens (list 'hif-not tokens)))
tokens))))
(defun hif-canonicalize (regexp)
"When at beginning of `regexp' (i.e. #ifX), return a Lisp expression for its condition."
(let ((case-fold-search nil))
(save-excursion
(re-search-forward regexp)
(let* ((curr-regexp (match-string 0))
(defined (string-match hif-ifxdef-regexp curr-regexp))
(negate (and defined
(string= (match-string 2 curr-regexp) "n")))
(tokens (hif-tokenize (point)
(progn (hif-end-of-line) (point)))))
(if defined
(setq tokens (list 'hif-defined tokens)))
(if negate
(setq tokens (list 'hif-not tokens)))
(hif-parse-if-exp tokens)))))
(defun hif-find-any-ifX ()
"Move to next #if..., or #ifndef, at point or after."
;; (message "find ifX at %d" (point))
(prog1
(re-search-forward hif-ifx-regexp (point-max) t)
(beginning-of-line)))
(defun hif-find-next-relevant ()
"Move to next #if..., #elif..., #else, or #endif, after the current line."
;; (message "hif-find-next-relevant at %d" (point))
(end-of-line)
;; avoid infinite recursion by only going to beginning of line if match found
(if (re-search-forward hif-ifx-else-endif-regexp (point-max) t)
(beginning-of-line)))
(defun hif-find-previous-relevant ()
"Move to previous #if..., #else, or #endif, before the current line."
;; (message "hif-find-previous-relevant at %d" (point))
(beginning-of-line)
;; avoid infinite recursion by only going to beginning of line if match found
(if (re-search-backward hif-ifx-else-endif-regexp (point-min) t)
(beginning-of-line)))
(defun hif-looking-at-ifX () ;; Should eventually see #if
(looking-at hif-ifx-regexp))
(defun hif-looking-at-endif ()
(looking-at hif-endif-regexp))
(defun hif-looking-at-else ()
(looking-at hif-else-regexp))
(defun hif-looking-at-elif ()
(looking-at hif-elif-regexp))
(defun hif-ifdef-to-endif ()
"If positioned at #ifX, #elif, or #else form, skip to corresponding #endif."
;; (message "hif-ifdef-to-endif at %d" (point)) (sit-for 1)
(hif-find-next-relevant)
(cond ((hif-looking-at-ifX)
(hif-ifdef-to-endif) ; find endif of nested if
(hif-ifdef-to-endif)) ; find outer endif or else
((hif-looking-at-elif)
(hif-ifdef-to-endif))
((hif-looking-at-else)
(hif-ifdef-to-endif)) ; find endif following else
((hif-looking-at-endif)
'done)
(t
(error "Mismatched #ifdef #endif pair"))))
(defun hif-endif-to-ifdef ()
"If positioned at #endif form, skip backward to corresponding #ifX."
;; (message "hif-endif-to-ifdef at %d" (point))
(let ((start (point)))
(hif-find-previous-relevant)
(if (= start (point))
(error "Mismatched #ifdef #endif pair")))
(cond ((hif-looking-at-endif)
(hif-endif-to-ifdef) ; find beginning of nested if
(hif-endif-to-ifdef)) ; find beginning of outer if or else
((hif-looking-at-elif)
(hif-endif-to-ifdef))
((hif-looking-at-else)
(hif-endif-to-ifdef))
((hif-looking-at-ifX)
'done)
(t
(error "Mismatched #endif")))) ; never gets here
(defun forward-ifdef (&optional arg)
"Move point to beginning of line of the next ifdef-endif.
With argument, do this that many times."
(interactive "p")
(or arg (setq arg 1))
(if (< arg 0) (backward-ifdef (- arg))
(while (< 0 arg)
(setq arg (- arg))
(let ((start (point)))
(unless (hif-looking-at-ifX)
(hif-find-next-relevant))
(if (hif-looking-at-ifX)
(hif-ifdef-to-endif)
(goto-char start)
(error "No following #ifdef"))))))
(defun backward-ifdef (&optional arg)
"Move point to beginning of the previous ifdef-endif.
With argument, do this that many times."
(interactive "p")
(or arg (setq arg 1))
(if (< arg 0) (forward-ifdef (- arg))
(while (< 0 arg)
(setq arg (1- arg))
(beginning-of-line)
(let ((start (point)))
(unless (hif-looking-at-endif)
(hif-find-previous-relevant))
(if (hif-looking-at-endif)
(hif-endif-to-ifdef)
(goto-char start)
(error "No previous #ifdef"))))))
(defun down-ifdef ()
"Move point to beginning of nested ifdef or else-part."
(interactive)
(let ((start (point)))
(hif-find-next-relevant)
(if (or (hif-looking-at-ifX) (hif-looking-at-else))
()
(goto-char start)
(error "No following #ifdef"))))
(defun up-ifdef ()
"Move point to beginning of enclosing ifdef or else-part."
(interactive)
(beginning-of-line)
(let ((start (point)))
(unless (hif-looking-at-endif)
(hif-find-previous-relevant))
(if (hif-looking-at-endif)
(hif-endif-to-ifdef))
(if (= start (point))
(error "No previous #ifdef"))))
(defun next-ifdef (&optional arg)
"Move to the beginning of the next #ifX, #else, or #endif.
With argument, do this that many times."
(interactive "p")
(or arg (setq arg 1))
(if (< arg 0) (previous-ifdef (- arg))
(while (< 0 arg)
(setq arg (1- arg))
(hif-find-next-relevant)
(when (eolp)
(beginning-of-line)
(error "No following #ifdefs, #elses, or #endifs")))))
(defun previous-ifdef (&optional arg)
"Move to the beginning of the previous #ifX, #else, or #endif.
With argument, do this that many times."
(interactive "p")
(or arg (setq arg 1))
(if (< arg 0) (next-ifdef (- arg))
(while (< 0 arg)
(setq arg (1- arg))
(let ((start (point)))
(hif-find-previous-relevant)
(if (= start (point))
(error "No previous #ifdefs, #elses, or #endifs"))))))
;;===%%SF%% parsing (End) ===
;;===%%SF%% hide-ifdef-hiding (Start) ===
;;; A range is a structure with four components:
;;; START The start of the range. (beginning of line)
;;; ELSE The else marker (beginning of line)
;;; END The end of the range. (beginning of line)
;;; ELIF A sequence of #elif markers (beginning of line)
(defsubst hif-make-range (start end &optional else elif)
(list start else end elif))
(defsubst hif-range-start (range) (elt range 0))
(defsubst hif-range-else (range) (elt range 1))
(defsubst hif-range-end (range) (elt range 2))
(defsubst hif-range-elif (range) (elt range 3))
;;; Find-Range
;;; The workhorse, it delimits the #if region. Reasonably simple:
;;; Skip until an #else or #endif is found, remembering positions. If
;;; an #else was found, skip some more, looking for the true #endif.
(defun hif-find-range ()
"Return a Range structure describing the current #if region.
Point is left unchanged."
;; (message "hif-find-range at %d" (point))
(save-excursion
(beginning-of-line)
(let ((start (point))
(elif nil)
(else nil)
(end nil))
;; Part one. Look for either #elif, #else or #endif.
;; This loop-and-a-half dedicated to E. Dijkstra.
(while (and (not else) (not end))
(while (progn
(hif-find-next-relevant)
(hif-looking-at-ifX)) ; Skip nested ifdef
(hif-ifdef-to-endif))
;; Found either a #else, #elif, or an #endif.
(cond ((hif-looking-at-elif)
(setq elif (nconc elif (list (point)))))
((hif-looking-at-else)
(setq else (point)))
(t
(setq end (point)))))
;; If found #else, look for #endif.
(when else
(while (progn
(hif-find-next-relevant)
(hif-looking-at-ifX)) ; Skip nested ifdef
(hif-ifdef-to-endif))
(if (hif-looking-at-else)
(error "Found two elses in a row? Broken!"))
(setq end (point))) ; (line-end-position)
(hif-make-range start end else elif))))
;;; A bit slimy.
(defun hif-hide-line (point)
"Hide the line containing point. Does nothing if `hide-ifdef-lines' is nil."
(when hide-ifdef-lines
(save-excursion
(goto-char point)
(hide-ifdef-region-internal
(line-beginning-position) (progn (hif-end-of-line) (point))))))
;;; Hif-Possibly-Hide
;;; There are four cases. The #ifX expression is "taken" if it
;;; the hide-ifdef-evaluator returns T. Presumably, this means the code
;;; inside the #ifdef would be included when the program was
;;; compiled.
;;;
;;; Case 1: #ifX taken, and there's an #else.
;;; The #else part must be hidden. The #if (then) part must be
;;; processed for nested #ifX's.
;;; Case 2: #ifX taken, and there's no #else.
;;; The #if part must be processed for nested #ifX's.
;;; Case 3: #ifX not taken, and there's an #elif
;;; The #if part must be hidden, and then evaluate
;;; the #elif condition like a new #ifX.
;;; Case 4: #ifX not taken, and there's just an #else.
;;; The #if part must be hidden. The #else part must be processed
;;; for nested #ifs.
;;; Case 5: #ifX not taken, and there's no #else.
;;; The #ifX part must be hidden.
;;;
;;; Further processing is done by narrowing to the relevant region
;;; and just recursively calling hide-ifdef-guts.
;;;
;;; When hif-possibly-hide returns, point is at the end of the
;;; possibly-hidden range.
(defun hif-recurse-on (start end &optional dont-go-eol)
"Call `hide-ifdef-guts' after narrowing to end of START line and END line."
(save-excursion
(save-restriction
(goto-char start)
(unless dont-go-eol
(end-of-line))
(narrow-to-region (point) end)
(hide-ifdef-guts))))
(defun hif-possibly-hide ()
"Called at #ifX expression, this hides those parts that should be hidden.
It uses the judgment of `hide-ifdef-evaluator'."
;; (message "hif-possibly-hide") (sit-for 1)
(let* ((case-fold-search nil)
(test (hif-canonicalize hif-ifx-regexp))
(range (hif-find-range))
(elifs (hif-range-elif range))
(complete nil))
;; (message "test = %s" test) (sit-for 1)
(hif-hide-line (hif-range-end range))
(while (not complete)
(if (hif-not (funcall hide-ifdef-evaluator test))
;; ifX/elif is FALSE
(if elifs
;; Case 3 - Hide the #ifX and eval #elif
(let ((newstart (car elifs)))
(hif-hide-line (hif-range-start range))
(hide-ifdef-region (hif-range-start range)
(1- newstart))
(setcar range newstart)
(goto-char newstart)
(setq elifs (cdr elifs))
(setq test (hif-canonicalize hif-elif-regexp)))
;; Check for #else
(cond ((hif-range-else range)
;; Case 4 - #else block visible
(hif-hide-line (hif-range-else range))
(hide-ifdef-region (hif-range-start range)
(1- (hif-range-else range)))
(hif-recurse-on (hif-range-else range)
(hif-range-end range)))
(t
;; Case 5 - No #else block, hide #ifX
(hide-ifdef-region (point)
(1- (hif-range-end range)))))
(setq complete t))
;; ifX/elif is TRUE
(cond (elifs
;; Luke fix: distinguish from #elif..#elif to #elif..#else [2013-08-30 14:10:40 +0800]
(let ((elif (car elifs)))
;; hide all elifs
(hif-hide-line elif)
(hide-ifdef-region elif (1- (hif-range-end range)))
(hif-recurse-on (hif-range-start range)
elif)))
((hif-range-else range)
;; Case 1 - Hide #elif and #else blocks, recurse #ifX
(hif-hide-line (hif-range-else range))
(hide-ifdef-region (hif-range-else range)
(1- (hif-range-end range)))
(hif-recurse-on (hif-range-start range)
(hif-range-else range)))
(t
;; Case 2 - No #else, just recurse #ifX
(hif-recurse-on (hif-range-start range)
(hif-range-end range))))
(setq complete t)))
;; complete = t
(hif-hide-line (hif-range-start range)) ; Always hide start.
(goto-char (hif-range-end range))
(end-of-line)))
(defun hif-evaluate-region (start end)
(let* ((tokens (ignore-errors ;; prevent C statement things like 'do { ... } while (0)'
(hif-tokenize start end)))
(expr (and tokens
(condition-case nil
(hif-parse-if-exp tokens)
(error
tokens))))
(result (funcall hide-ifdef-evaluator expr)))
result))
(defun hif-evaluate-macro (rstart rend)
"Evaluate the macro expansion result for a region. If no region active,
find the current #ifdefs and evaluate the result. Currently it support only
math calculation, no string or argumented macros can be expanded."
(interactive "r")
(let ((case-fold-search nil))
(save-excursion
(unless mark-active
(setq rstart nil rend nil)
(beginning-of-line)
(when (and (re-search-forward hif-macro-expr-prefix-regexp nil t)
(string= "define" (match-string 2)))
(re-search-forward hif-macroname nil t)))
(let* ((start (or rstart (point)))
(end (or rend (progn (hif-end-of-line) (point))))
(defined nil)
(simple 't)
(tokens (ignore-errors ;; prevent C statement things like 'do { ... } while (0)'
(hif-tokenize start end)))
(expr (or (and (<= (length tokens) 1) ;; simple token
(setq defined (assoc (car tokens) hide-ifdef-env))
(setq simple (atom (hif-lookup (car tokens))))
(hif-lookup (car tokens)))
(and tokens
(condition-case nil
(hif-parse-if-exp tokens)
(error
nil)))))
(result (funcall hide-ifdef-evaluator expr))
(exprstring (replace-regexp-in-string
"^[ \t]*\\([^ \t]+\\)[ \t]*" "\\1" ;; trim off leading/trailing whites
(replace-regexp-in-string
"\\(//.*\\)" "" ;; trim off end-of-line comments
(buffer-substring-no-properties start end)))))
(cond
((and (<= (length tokens) 1) simple) ;; simple token
(if defined
(message "%S <= `%s'" result exprstring)
(message "`%s' is not defined" exprstring)))
((integerp result)
(if (or (= 0 result) (= 1 result))
(message "%S <= `%s'" result exprstring)
(message "%S (0x%x) <= `%s'" result result exprstring)))
((null result) (message "%S <= `%s'" 'false exprstring))
((eq t result) (message "%S <= `%s'" 'true exprstring))
(t (message "%S <= `%s'" result exprstring)))
result))))
(defun hif-parse-macro-arglist (str)
"Parse argument list formatted as '( arg1 [ , argn] [...] )', includeing the '...'
Return a list of the arguments, if '...' exists the first arg will be hif-etc."
(let ((tokenlist (cdr (hif-tokenize (- (point) (length str)) (point)))) ; remove hif-lparen
result token)
(while (not (eq (setq token (car tokenlist)) 'hif-rparen))
(setq tokenlist (cdr tokenlist))
(cond
((eq token 'hif-etc)
(setq result (cons 'hif-etc result)))
((eq token 'hif-comma)
t)
(t
(setq result (append result (cons token nil))))))
result))
(defun hif-find-define (&optional min max)
(interactive)
(and min (goto-char min))
(and (re-search-forward hif-define max t)
(or
(let* ((defining (string= "define" (match-string 2)))
(name (and (re-search-forward hif-macroname max t)
(match-string 1)))
(parsed nil)
(parmlist (and (match-string 3) ;; first arg id found
(hif-parse-macro-arglist (match-string 2)))))
(if defining
;; ignore name (still need to return 't), or define the name
(or (and hide-ifdef-exclude-define-regexp-pattern
(string-match hide-ifdef-exclude-define-regexp-pattern name))
(let* ((start (point))
(end (progn (hif-end-of-line) (point)))
(tokens (and name
(condition-case nil ;; prevent C statement things like 'do { ... } while (0)'
(hif-tokenize start end)
(error ;; we can't just return nil since this will stop searching for the remaining #defines.
(setq hif-simple-token-only t)
(buffer-substring-no-properties start end)))))
;; For simple token we save only the parsed result;
;; or we save the tokens, parse it after parameter replacement
(expr (and tokens
(or (and hif-simple-token-only
(listp tokens)
(= (length tokens) 1)
(hif-parse-if-exp tokens))
`(hif-define-macro ,parmlist ,tokens))))
(SA (and name
(assoc (intern name) hide-ifdef-env))))
(and name
(if SA
(or (setcdr SA expr) t) ;; Lazy evaluation, eval only if hif-lookup find it
;; define it anyway, even if nil it's still in list and therefore considerred defined
(push (cons (intern name) expr) hide-ifdef-env)))))
;; #undef
(and name
(hif-undefine-symbol (intern name))))))
t))
(defun hif-add-new-defines (&optional min max)
"Scan and add all #define macros between min .. max"
(interactive)
(while (hif-find-define min max)
(setf min (point)))
(if max (goto-char max)
(goto-char (point-max))))
;;(defun mark-region (min max)
;; (set-mark (or max (point-max)))
;; (goto-char min))
(defun hide-ifdef-guts ()
"Does most of the work of `hide-ifdefs'.
It does not do the work that's pointless to redo on a recursive entry."
;; (message "hide-ifdef-guts")
(save-excursion
(let ((case-fold-search nil)
min max)
(goto-char (point-min))
(setf min (point))
(loop do
(setf max (hif-find-any-ifX))
(save-excursion
(save-restriction
;; (mark-region min max) ;; for debugging
(hif-add-new-defines min max)))
(if max
(hif-possibly-hide))
(setf min (point))
while max))))
;;===%%SF%% hide-ifdef-hiding (End) ===
;;===%%SF%% exports (Start) ===
(defun hide-ifdef-toggle-read-only ()
"Toggle `hide-ifdef-read-only'."
(interactive)
(setq hide-ifdef-read-only (not hide-ifdef-read-only))
(message "Hide-Read-Only %s"
(if hide-ifdef-read-only "ON" "OFF"))
(if hide-ifdef-hiding
(setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only)))
(force-mode-line-update))
(defun hide-ifdef-toggle-outside-read-only ()
"Replacement for `toggle-read-only' within Hide-Ifdef mode."
(interactive)
(setq hif-outside-read-only (not hif-outside-read-only))
(message "Read only %s"
(if hif-outside-read-only "ON" "OFF"))
(setq buffer-read-only
(or (and hide-ifdef-hiding hide-ifdef-read-only)
hif-outside-read-only))
(force-mode-line-update))
(defun hide-ifdef-toggle-shadowing ()
"Toggle shadowing."
(interactive)
(set (make-local-variable 'hide-ifdef-shadow) (not hide-ifdef-shadow))
(message "Shadowing %s" (if hide-ifdef-shadow "ON" "OFF"))
(save-restriction
(widen)
(dolist (overlay (overlays-in (point-min) (point-max)))
(when (overlay-get overlay 'hide-ifdef)
(if hide-ifdef-shadow
(progn
(overlay-put overlay 'invisible nil)
(overlay-put overlay 'face 'hide-ifdef-shadow))
(overlay-put overlay 'face nil)
(overlay-put overlay 'invisible 'hide-ifdef))))))
(defun hide-ifdef-define (var val)
"Define a VAR, optionally to a specific value, so that #ifdef VAR
would be included."
(interactive
(let* ((default (save-excursion
(beginning-of-line)
(cond ((looking-at hif-ifx-else-endif-regexp)
(forward-word 2)
(current-word 'strict))
(t
nil))))
(var (read-minibuffer "Define what? " default))
(val (read-from-minibuffer (format "Set %s to? (default 1): " var)
nil nil t nil "1")))
(list var val)))
(hif-set-var var (or val 1))
(message "%s set to %s" var (or val 1))
(sleep-for 1)
(if hide-ifdef-hiding (hide-ifdefs)))
(defun hif-undefine-symbol (var)
(setq hide-ifdef-env
(delete (assoc var hide-ifdef-env) hide-ifdef-env)))
;;(defun hide-ifdef-undef (var)
;; "Undefine a VAR so that #ifdef VAR would not be included."
;; (interactive "SUndefine what? ")
;; ;;(hif-set-var var nil);;Luke fixed: set it nil is still considered defined so #ifdef VAR is still true.
;; (hif-undefine-symbol var)
;; (if hide-ifdef-hiding (hide-ifdefs)))
(defun hide-ifdef-undef (start end)
"Undefine a VAR so that #ifdef VAR would not be included."
(interactive "r")
(let* ((symstr
(or (and mark-active
(buffer-substring-no-properties start end))
(read-string "Undefine what? " (current-word))))
(sym (and symstr
(intern symstr))))
(if (zerop (hif-defined sym))
(message "`%s' not defined, no need to undefine it" symstr)
(hif-undefine-symbol sym)
(if hide-ifdef-hiding (hide-ifdefs))
(message "`%S' undefined" sym))))
(defun hide-ifdefs (&optional nomsg)
"Hide the contents of some #ifdefs.
Assume that defined symbols have been added to `hide-ifdef-env'.
The text hidden is the text that would not be included by the C
preprocessor if it were given the file with those symbols defined.
If this command is prefixed, hide also the #ifdefs themselves.
Turn off hiding by calling `show-ifdefs'."
(interactive)
(let ((hide-ifdef-lines current-prefix-arg))
(or nomsg
(message "Hiding..."))
(setq hif-outside-read-only buffer-read-only)
(unless hide-ifdef-mode (hide-ifdef-mode 1)) ; turn on hide-ifdef-mode
(if hide-ifdef-hiding
(show-ifdefs)) ; Otherwise, deep confusion.
(setq hide-ifdef-hiding t)
(hide-ifdef-guts)
(setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only))
(or nomsg
(message "Hiding done"))))
(defun show-ifdefs ()
"Cancel the effects of `hide-ifdef': show the contents of all #ifdefs."
(interactive)
(setq buffer-read-only hif-outside-read-only)
(hif-show-all)
(setq hide-ifdef-hiding nil))
(defun hif-find-ifdef-block ()
"Utility for hide and show `ifdef-block'.
Return as (TOP . BOTTOM) the extent of ifdef block."
(if (and (fboundp 'c-backward-conditional-with-else)
(fboundp 'c-forward-conditional-with-else))
;;Use my modified functions in cc-mode.
(save-excursion
(cons
(progn
(if (= (line-number-at-pos)
(save-excursion
(beginning-of-line)
(re-search-forward hif-ifx-else-endif-regexp)
(line-number-at-pos)))
(beginning-of-line)
(c-backward-conditional-with-else 1))
(point))
(progn (c-forward-conditional-with-else 1) (1- (point)))))
;; original implementation in hideif.el
(let (max-bottom)
(cons (save-excursion
(beginning-of-line)
(unless (or (hif-looking-at-else) (hif-looking-at-ifX))
(up-ifdef))
(prog1 (point)
(hif-ifdef-to-endif)
(setq max-bottom (1- (point)))))
(save-excursion
(beginning-of-line)
(unless (hif-looking-at-endif)
(hif-find-next-relevant))
(while (hif-looking-at-ifX)
(hif-ifdef-to-endif)
(hif-find-next-relevant))
(min max-bottom (1- (point))))))))
(defun hide-ifdef-block (&optional start end)
"Hide the ifdef block (true or false part) enclosing or before the cursor.
If prefixed, it will also hide #ifdefs themselves."
(interactive "r")
(let ((hide-ifdef-lines current-prefix-arg))
(if mark-active
(progn
(hif-recurse-on start end t)
(setq mark-active nil))
(unless hide-ifdef-mode (hide-ifdef-mode 1))
(let ((top-bottom (hif-find-ifdef-block)))
(hide-ifdef-region (car top-bottom) (cdr top-bottom))
(when hide-ifdef-lines
(hif-hide-line (car top-bottom))
(hif-hide-line (1+ (cdr top-bottom))))
(setq hide-ifdef-hiding t))
(setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only)))))
(defun show-ifdef-block (&optional start end)
"Show the ifdef block (true or false part) enclosing or before the cursor."
(interactive "r")
(if mark-active
(progn
(dolist (o (overlays-in start end))
(if (overlay-get o 'hide-ifdef)
(delete-overlay o)))
(setq mark-active nil))
(let ((top-bottom (condition-case nil
(hif-find-ifdef-block)
(error
nil)))
(ovrs (overlays-in (max (point-min) (1- (point)))
(min (point-max) (1+ (point)))))
(del nil))
(if top-bottom
(if hide-ifdef-lines
(hif-show-ifdef-region
(save-excursion
(goto-char (car top-bottom)) (line-beginning-position))
(save-excursion
(goto-char (1+ (cdr top-bottom)))
(hif-end-of-line) (point)))
(setf del (hif-show-ifdef-region (1- (car top-bottom)) (cdr top-bottom)))))
(if (not (and top-bottom
del))
(dolist (o ovrs)
;;(dolist (o (overlays-in (1- (point)) (1+ (point))))
;; (if (overlay-get o 'hide-ifdef) (message "%S" o)))
(if (overlay-get o 'hide-ifdef)
(delete-overlay o)))))))
;;; definition alist support
(defvar hide-ifdef-define-alist nil
"A global assoc list of pre-defined symbol lists.")
(defun hif-compress-define-list (env)
"Compress the define list ENV into a list of defined symbols only."
(let ((new-defs nil))
(dolist (def env new-defs)
(if (hif-lookup (car def)) (push (car def) new-defs)))))
(defun hide-ifdef-set-define-alist (name)
"Set the association for NAME to `hide-ifdef-env'."
(interactive "SSet define list: ")
(push (cons name (hif-compress-define-list hide-ifdef-env))
hide-ifdef-define-alist))
(defun hide-ifdef-use-define-alist (name)
"Set `hide-ifdef-env' to the define list specified by NAME."
(interactive
(list (completing-read "Use define list: "
(mapcar (lambda (x) (symbol-name (car x)))
hide-ifdef-define-alist)
nil t)))
(if (stringp name) (setq name (intern name)))
(let ((define-list (assoc name hide-ifdef-define-alist)))
(if define-list
(setq hide-ifdef-env
(mapcar (lambda (arg) (cons arg t))
(cdr define-list)))
(error "No define list for %s" name))
(if hide-ifdef-hiding (hide-ifdefs))))
(provide 'hideif)
;; Local variables:
;; byte-compile-warnings: (not cl-functions)
;; End:
;;; hideif.el ends here
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Update earlier posted hideif.el enhancements
2013-11-08 1:59 Update earlier posted hideif.el enhancements Luke Lee
@ 2013-11-08 2:54 ` Stefan Monnier
2013-11-08 4:07 ` Luke Lee
0 siblings, 1 reply; 11+ messages in thread
From: Stefan Monnier @ 2013-11-08 2:54 UTC (permalink / raw)
To: Luke Lee; +Cc: emacs-devel
> A few days ago I posted my enhanced hideif.el. Here is a updated version
> that fix a problem that stop it from finding more #defines if an empty
> define is found (i.e.
> #define EMPTY_MACRO
> ).
Could you send a patch instead of the whole file?
Stefan
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Update earlier posted hideif.el enhancements
2013-11-08 2:54 ` Stefan Monnier
@ 2013-11-08 4:07 ` Luke Lee
2013-11-24 17:50 ` Stefan Monnier
0 siblings, 1 reply; 11+ messages in thread
From: Luke Lee @ 2013-11-08 4:07 UTC (permalink / raw)
To: Stefan Monnier; +Cc: emacs-devel
[-- Attachment #1: Type: text/plain, Size: 2032 bytes --]
Sure, my fault. I just thought that it will be easier for people that
didn't have my earlier version yet.
Here is the patch, thanks.
---
diff --git a/elisp/hideif.el b/elisp/hideif.el
index 2e35fcd..a85e28e 100755
--- a/elisp/hideif.el
+++ b/elisp/hideif.el
@@ -1574,6 +1574,7 @@ Return a list of the arguments, if '...' exists the
first arg will be hif-etc."
;; or we save the tokens, parse it after
parameter replacement
(expr (and tokens
(or (and hif-simple-token-only
+ (listp tokens)
(= (length tokens) 1)
(hif-parse-if-exp tokens))
`(hif-define-macro ,parmlist
,tokens))))
@@ -1581,9 +1582,10 @@ Return a list of the arguments, if '...' exists the
first arg will be hif-etc."
(assoc (intern name) hide-ifdef-env))))
(and name
(if SA
- (setcdr SA expr) ;; Lazy evaluation, eval
only if hif-lookup find it
+ (or (setcdr SA expr) t) ;; Lazy evaluation,
eval only if hif-lookup find it
;; define it anyway, even if nil it's still in
list and therefore considerred defined
(push (cons (intern name) expr)
hide-ifdef-env)))))
+ ;; #undef
(and name
(hif-undefine-symbol (intern name))))))
t))
@@ -1835,7 +1837,7 @@ If prefixed, it will also hide #ifdefs themselves."
"Compress the define list ENV into a list of defined symbols only."
(let ((new-defs nil))
(dolist (def env new-defs)
- (if (hif-lookup (car def)) (push (car env) new-defs)))))
+ (if (hif-lookup (car def)) (push (car def) new-defs)))))
(defun hide-ifdef-set-define-alist (name)
"Set the association for NAME to `hide-ifdef-env'."
[-- Attachment #2: Type: text/html, Size: 2534 bytes --]
^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: Update earlier posted hideif.el enhancements
2013-11-08 4:07 ` Luke Lee
@ 2013-11-24 17:50 ` Stefan Monnier
[not found] ` <CAA=xLROospEnRM_Es0bBkQUpC_RmrS-vQDxprD2it+fVDbVKog@mail.gmail.com>
0 siblings, 1 reply; 11+ messages in thread
From: Stefan Monnier @ 2013-11-24 17:50 UTC (permalink / raw)
To: Luke Lee; +Cc: emacs-devel
> Sure, my fault. I just thought that it will be easier for people that
> didn't have my earlier version yet.
Hmm... looks like I was confused, indeed. I don't have your earlier
hideif.el.
> Here is the patch, thanks.
And your patch was mangled (lines too long that got wrapped during
transport). I unmangled it but the code it patches is indeed not in
Emacs's hideif.el.
Could you post a patch relative to Emacs's hideif.el?
Stefan
^ permalink raw reply [flat|nested] 11+ messages in thread
* Fwd: Update earlier posted hideif.el enhancements
[not found] ` <CAA=xLROospEnRM_Es0bBkQUpC_RmrS-vQDxprD2it+fVDbVKog@mail.gmail.com>
@ 2013-11-25 6:35 ` Luke Lee
2013-11-29 21:59 ` Stefan Monnier
0 siblings, 1 reply; 11+ messages in thread
From: Luke Lee @ 2013-11-25 6:35 UTC (permalink / raw)
To: Stefan Monnier; +Cc: emacs-devel
[-- Attachment #1.1: Type: text/plain, Size: 1378 bytes --]
>And your patch was mangled (lines too long that got wrapped during
>transport). I unmangled it but the code it patches is indeed not in
>Emacs's hideif.el.
I think I should use attachments instead of putting them in email.
>Could you post a patch relative to Emacs's hideif.el?
Sure, no problem. Attached is the patch against Emacs trunk. I'm using
git://git.savannah.gnu.org/emacs.git as my Emacs remote source. I've
checked the trunk, master and emacs-24 and they seems to have the
identical hideif.el version so I think it should be okay to patch it.
I also add an custom option to prevent hiding the top level ifdefs for
*.h files since they usually contain some re-inclusion protection and
therefore it always got everything hidden when you tried to hide it
twice. It was a bit annoying.
Hope this helps.
--
Best regards,
Luke Lee
2013/11/25 Stefan Monnier <monnier@iro.umontreal.ca>
> > Sure, my fault. I just thought that it will be easier for people that
> > didn't have my earlier version yet.
>
> Hmm... looks like I was confused, indeed. I don't have your earlier
> hideif.el.
>
> > Here is the patch, thanks.
>
> And your patch was mangled (lines too long that got wrapped during
> transport). I unmangled it but the code it patches is indeed not in
> Emacs's hideif.el.
>
> Could you post a patch relative to Emacs's hideif.el?
>
>
> Stefan
>
[-- Attachment #1.2: Type: text/html, Size: 2953 bytes --]
[-- Attachment #2: hideif.patch --]
[-- Type: application/octet-stream, Size: 76449 bytes --]
diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el
index e264682..b89d42f 100644
--- a/lisp/progmodes/hideif.el
+++ b/lisp/progmodes/hideif.el
@@ -1,9 +1,9 @@
;;; hideif.el --- hides selected code within ifdef
-;; Copyright (C) 1988, 1994, 2001-2013 Free Software Foundation, Inc.
+;; Copyright (C) 1988, 1994, 2001-2013 Free Software Foundation, Inc.
;; Author: Brian Marick
-;; Daniel LaLiberte <liberte@holonexus.org>
+;; Daniel LaLiberte <liberte@holonexus.org>
;; Maintainer: FSF
;; Keywords: c, outlines
@@ -35,9 +35,9 @@
;; M-x hide-ifdefs or C-c @ h
;;
;; Hide-ifdef suppresses the display of code that the preprocessor wouldn't
-;; pass through. The support of constant expressions in #if lines is
-;; limited to identifiers, parens, and the operators: &&, ||, !, and
-;; "defined". Please extend this.
+;; pass through. Support complete C/C++ expression and precedence.
+;; It will automatically scans for new #define symbols and macros on the way
+;; parsing.
;;
;; The hidden code is marked by ellipses (...). Be
;; cautious when editing near ellipses, since the hidden text is
@@ -66,11 +66,11 @@
;;
;; (add-hook 'hide-ifdef-mode-hook
;; (lambda ()
-;; (unless hide-ifdef-define-alist
-;; (setq hide-ifdef-define-alist
-;; '((list1 ONE TWO)
-;; (list2 TWO THREE))))
-;; (hide-ifdef-use-define-alist 'list2))) ; use list2 by default
+;; (unless hide-ifdef-define-alist
+;; (setq hide-ifdef-define-alist
+;; '((list1 ONE TWO)
+;; (list2 TWO THREE))))
+;; (hide-ifdef-use-define-alist 'list2))) ; use list2 by default
;;
;; You can call hide-ifdef-use-define-alist (C-c @ U) at any time to specify
;; another list to use.
@@ -97,10 +97,14 @@
;;
;; Written by Brian Marick, at Gould, Computer Systems Division, Urbana IL.
;; Extensively modified by Daniel LaLiberte (while at Gould).
+;;
+;; Extensively modified by Luke Lee in 2013 to support complete C expression
+;; evaluation and argumented macro expansion.
;;; Code:
(require 'cc-mode)
+(eval-when-compile (require 'cl))
(defgroup hide-ifdef nil
"Hide selected code within `ifdef'."
@@ -125,12 +129,34 @@
"Non-nil means shadow text instead of hiding it."
:type 'boolean
:group 'hide-ifdef
- :version "23.1")
+ :version "24.5")
(defface hide-ifdef-shadow '((t (:inherit shadow)))
"Face for shadowing ifdef blocks."
:group 'hide-ifdef
- :version "23.1")
+ :version "24.5")
+
+(defcustom hide-ifdef-exclude-define-regexp-pattern nil
+ "Ignore #define name if that name match this exclusion pattern."
+ :type 'string
+ :group 'hide-ifdef)
+
+(defcustom hide-ifdef-expand-re-inclusion-protection t
+ "When hiding header files, always expand the re-inclusion protecting ifdefs.
+Most header files are wrapped with ifdefs to prevent re-inclusion:
+ #ifdef _XXX_HEADER_FILE_INCLUDED_
+ #define _XXX_HEADER_FILE_INCLUDED_
+ ...
+ #endif
+hence if we try to hide ifdefs, it will hide everything when we tried
+the second time since _XXX_HEADER_FILE_INCLUDED_ already defined."
+ :type 'boolean
+ :group 'hide-ifdef)
+
+(defcustom hide-ifdef-header-regexp-pattern "^.*\\.[hH]\\([hH]\\|[xX][xX]\\|[pP][pP]\\)?"
+ "C/C++ header file name patterns. Effective only if 'hide-ifdef-expand-re-inclusion-protection' is t."
+ :type 'string
+ :group 'hide-ifdef)
(defvar hide-ifdef-mode-submap
@@ -146,6 +172,8 @@
(define-key map "\C-d" 'hide-ifdef-block)
(define-key map "\C-s" 'show-ifdef-block)
+ (define-key map "e" 'hif-evaluate-macro)
+
(define-key map "\C-q" 'hide-ifdef-toggle-read-only)
(define-key map "\C-w" 'hide-ifdef-toggle-shadowing)
(substitute-key-definition
@@ -225,35 +253,36 @@ that the C preprocessor would eliminate may be hidden from view.
Several variables affect how the hiding is done:
`hide-ifdef-env'
- An association list of defined and undefined symbols for the
- current buffer. Initially, the global value of `hide-ifdef-env'
- is used.
+ An association list of defined and undefined symbols for the
+ current buffer. Initially, the global value of `hide-ifdef-env'
+ is used.
`hide-ifdef-define-alist'
- An association list of defined symbol lists.
+ An association list of defined symbol lists.
Use `hide-ifdef-set-define-alist' to save the current `hide-ifdef-env'
and `hide-ifdef-use-define-alist' to set the current `hide-ifdef-env'
from one of the lists in `hide-ifdef-define-alist'.
`hide-ifdef-lines'
- Set to non-nil to not show #if, #ifdef, #ifndef, #else, and
- #endif lines when hiding.
+ Set to non-nil to not show #if, #ifdef, #ifndef, #else, and
+ #endif lines when hiding.
`hide-ifdef-initially'
- Indicates whether `hide-ifdefs' should be called when Hide-Ifdef mode
- is activated.
+ Indicates whether `hide-ifdefs' should be called when Hide-Ifdef mode
+ is activated.
`hide-ifdef-read-only'
- Set to non-nil if you want to make buffers read only while hiding.
- After `show-ifdefs', read-only status is restored to previous value.
+ Set to non-nil if you want to make buffers read only while hiding.
+ After `show-ifdefs', read-only status is restored to previous value.
\\{hide-ifdef-mode-map}"
:group 'hide-ifdef :lighter " Ifdef"
(if hide-ifdef-mode
(progn
;; inherit global values
- (set (make-local-variable 'hide-ifdef-env)
- (default-value 'hide-ifdef-env))
+;; (set (make-local-variable 'hide-ifdef-env) ;; [2012-09-27 11:05:26 +0800] Luke rem 2 ins 2
+;; (default-value 'hide-ifdef-env))
+ (set 'hide-ifdef-env (default-value 'hide-ifdef-env))
(set (make-local-variable 'hide-ifdef-hiding)
(default-value 'hide-ifdef-hiding))
(set (make-local-variable 'hif-outside-read-only) buffer-read-only)
@@ -291,16 +320,61 @@ Several variables affect how the hiding is done:
(while (= (logand 1 (skip-chars-backward "\\\\")) 1)
(end-of-line 2)))
+(defun merge-ifdef-region (start end)
+ ;; Genernally there is no need to call itself recursively since there should originally
+ ;; exists no un-merged regions; however, if a part of the file is hidden with 'hide-ifdef-lines'
+ ;; as nil while another part with 't, this case happens.
+ ;; TODO: should we merge? or just create a container overlay? -- this can prevent hideif-show-ifdef
+ ;; expand too many since there is only a big overlay exists there without any smaller overlays.
+ "Merge nearby ifdef regions to form a bigger overlay. This will decrease the
+total number of overlays created."
+ (save-restriction
+ (widen) ;; otherwise (point-min) and (point-max) will be
+ ;; restricted and thus fail to find neighbor overlays
+ (let ((begovrs (overlays-in
+ (max (- start 2) (point-min))
+ (max (- start 1) (point-min))))
+ (endovrs (overlays-in
+ (min (+ end 1) (point-max))
+ (min (+ end 2) (point-max))))
+ (ob nil)
+ (oe nil)
+ b e)
+ ;; merge overlays before 'start'
+ (dolist (o begovrs)
+ (when (overlay-get o 'hide-ifdef)
+ (setq b (min start (overlay-start o))
+ e (max end (overlay-end o)))
+ (move-overlay o b e)
+ (merge-ifdef-region b e)
+ (setq ob o)))
+ ;; merge overlays after 'end'
+ (dolist (o endovrs)
+ (when (overlay-get o 'hide-ifdef)
+ (setq b (min start (overlay-start o))
+ e (max end (overlay-end o)))
+ (move-overlay o b e)
+ (merge-ifdef-region b e)
+ (setf oe o)))
+ ;; if both 'start' 'end' merging happens, merge into bigger one
+ (when (and ob oe)
+ (let ((b (min (overlay-start ob) (overlay-start oe)))
+ (e (max (overlay-end ob) (overlay-end oe))))
+ (delete-overlay oe)
+ (move-overlay ob b e)
+ (merge-ifdef-region b e)))
+ (or ob oe))))
+
(defun hide-ifdef-region-internal (start end)
- (remove-overlays start end 'hide-ifdef t)
- (let ((o (make-overlay start end)))
- (overlay-put o 'hide-ifdef t)
- (if hide-ifdef-shadow
- (overlay-put o 'face 'hide-ifdef-shadow)
- (overlay-put o 'invisible 'hide-ifdef))))
+ (unless (merge-ifdef-region start end)
+ (let ((o (make-overlay start end)))
+ (overlay-put o 'hide-ifdef t)
+ (if hide-ifdef-shadow
+ (overlay-put o 'face 'hide-ifdef-shadow)
+ (overlay-put o 'invisible 'hide-ifdef)))))
(defun hide-ifdef-region (start end)
- "START is the start of a #if or #else form. END is the ending part.
+ "START is the start of a #if, #elif, or #else form. END is the ending part.
Everything including these lines is made invisible."
(save-excursion
(goto-char start) (hif-end-of-line) (setq start (point))
@@ -309,8 +383,9 @@ Everything including these lines is made invisible."
(defun hif-show-ifdef-region (start end)
"Everything between START and END is made visible."
- (remove-overlays start end 'hide-ifdef t))
-
+ (let ((onum (length (overlays-in start end))))
+ (remove-overlays start end 'hide-ifdef t)
+ (/= onum (length (overlays-in start end)))))
;;===%%SF%% evaluation (Start) ===
@@ -354,13 +429,29 @@ that form should be displayed.")
;;===%%SF%% parsing (Start) ===
;;; The code that understands what ifs and ifdef in files look like.
-(defconst hif-cpp-prefix "\\(^\\|\r\\)[ \t]*#[ \t]*")
+(defconst hif-cpp-prefix "\\(^\\|\r\\)[ \t]*#[ \t]*")
+(defconst hif-ifxdef-regexp (concat hif-cpp-prefix "if\\(n\\)?def"))
(defconst hif-ifndef-regexp (concat hif-cpp-prefix "ifndef"))
-(defconst hif-ifx-regexp (concat hif-cpp-prefix "if\\(n?def\\)?[ \t]+"))
-(defconst hif-else-regexp (concat hif-cpp-prefix "else"))
-(defconst hif-endif-regexp (concat hif-cpp-prefix "endif"))
+(defconst hif-ifx-regexp (concat hif-cpp-prefix "if\\(n?def\\)?[ \t]+"))
+(defconst hif-elif-regexp (concat hif-cpp-prefix "elif"))
+(defconst hif-else-regexp (concat hif-cpp-prefix "else"))
+(defconst hif-endif-regexp (concat hif-cpp-prefix "endif"))
(defconst hif-ifx-else-endif-regexp
- (concat hif-ifx-regexp "\\|" hif-else-regexp "\\|" hif-endif-regexp))
+ (concat hif-ifx-regexp "\\|" hif-elif-regexp "\\|" hif-else-regexp "\\|" hif-endif-regexp))
+(defconst hif-macro-expr-prefix-regexp (concat hif-cpp-prefix "\\(if\\(n?def\\)?\\|elif\\|define\\)[ \t]+"))
+
+(defconst hif-white "[ \t]*")
+(defconst hif-define (concat hif-cpp-prefix "\\(define\\|undef\\)"))
+(defconst hif-id (concat "[A-Za-z_][0-9A-Za-z_]*"))
+(defconst hif-macroname (concat hif-white "\\(" hif-id "\\)" hif-white
+ "\\("
+ "(" hif-white
+ "\\(" hif-id "\\)?" hif-white
+ "\\(" "," hif-white hif-id hif-white "\\)*"
+ "\\(\\.\\.\\.\\)?" hif-white
+ ")"
+ "\\)?" ))
+;;(defconst hif-header-regexp "^.*\\.[hH]\\([hH]\\|[xX][xX]\\|[pP][pP]\\)?")
;; Used to store the current token and the whole token list during parsing.
;; Only bound dynamically.
@@ -368,211 +459,708 @@ that form should be displayed.")
(defvar hif-token-list)
(defconst hif-token-alist
- '(("||" . or)
- ("&&" . and)
- ("|" . hif-logior)
- ("&" . hif-logand)
- ("==" . equal)
- ("!=" . hif-notequal)
- ("!" . not)
- ("(" . lparen)
- (")" . rparen)
- (">" . hif-greater)
- ("<" . hif-less)
- (">=" . hif-greater-equal)
- ("<=" . hif-less-equal)
- ("+" . hif-plus)
- ("-" . hif-minus)
- ("?" . hif-conditional)
- (":" . hif-colon)))
+ '(("||" . hif-or)
+ ("&&" . hif-and)
+ ("|" . hif-logior)
+ ("^" . hif-logxor)
+ ("&" . hif-logand)
+ ("<<" . hif-shiftleft)
+ (">>" . hif-shiftright)
+ ("==" . hif-equal)
+ ("=" . hif-assign)
+ ("!=" . hif-notequal)
+ ("##" . hif-token-concat)
+ ("!" . hif-not)
+ ("~" . hif-lognot)
+ ("(" . hif-lparen)
+ (")" . hif-rparen)
+ (">" . hif-greater)
+ ("<" . hif-less)
+ (">=" . hif-greater-equal)
+ ("<=" . hif-less-equal)
+ ("+" . hif-plus)
+ ("-" . hif-minus)
+ ("*" . hif-multiply)
+ ("/" . hif-divide)
+ ("%" . hif-modulo)
+ ("?" . hif-conditional)
+ (":" . hif-colon)
+ ("," . hif-comma)
+ ("#" . hif-stringify)
+ ("..." . hif-etc)))
+
+(defconst hif-valid-token-list (mapcar 'cdr hif-token-alist))
(defconst hif-token-regexp
- (concat (regexp-opt (mapcar 'car hif-token-alist)) "\\|\\w+"))
+ (concat (regexp-opt (mapcar 'car hif-token-alist))
+ "\\|0x[0-9a-fA-F]+\\.?[0-9a-fA-F]*" ;; Luke added
+ "\\|[0-9]+\\.?[0-9]*" ;; Luke added, decimal/octal
+ "\\|\\w+"))
+
+(defconst hif-string-literal-regexp
+ (concat hif-white "\\(\"[^\"]*\"\\)"))
+
+(defvar hif-simple-token-only nil)
(defun hif-tokenize (start end)
"Separate string between START and END into a list of tokens."
(let ((token-list nil))
+ (setq hif-simple-token-only t)
(with-syntax-table hide-ifdef-syntax-table
(save-excursion
- (goto-char start)
- (while (progn (forward-comment (point-max)) (< (point) end))
- ;; (message "expr-start = %d" expr-start) (sit-for 1)
- (cond
- ((looking-at "\\\\\n")
- (forward-char 2))
-
- ((looking-at hif-token-regexp)
- (let ((token (buffer-substring (point) (match-end 0))))
- (goto-char (match-end 0))
- ;; (message "token: %s" token) (sit-for 1)
- (push (or (cdr (assoc token hif-token-alist))
+ (goto-char start)
+ (while (progn (forward-comment (point-max)) (< (point) end))
+ ;; (message "expr-start = %d" expr-start) (sit-for 1)
+ (cond
+ ((looking-at "\\\\\n")
+ (forward-char 2))
+
+ ((looking-at hif-string-literal-regexp)
+ (push (substring-no-properties (match-string 1)) token-list)
+ (goto-char (match-end 0)))
+
+ ((looking-at hif-token-regexp)
+ (let ((token (buffer-substring-no-properties (point) (match-end 0))))
+ (goto-char (match-end 0))
+ ;; (message "token: %s" token) (sit-for 1)
+ (push (or (cdr (assoc token hif-token-alist))
(if (string-equal token "defined") 'hif-defined)
- (if (string-match "\\`[0-9]*\\'" token)
- (string-to-number token))
- (intern token))
- token-list)))
- (t (error "Bad #if expression: %s" (buffer-string)))))))
+ (if (string-match "0x\\([a-fA-F0-9]+\\)" token)
+ (string-to-number (match-string 1 token) 16)) ;; hexadecimal
+ (if (string-match "\\`0[0-9]*\\(\\.[0-9]+\\)?\\'" token)
+ (string-to-number token 8)) ;; octal
+ (if (string-match "\\`[1-9][0-9]*\\(\\.[0-9]+\\)?\\'" token)
+ (string-to-number token)) ;; decimal
+ (prog1 (intern token)
+ (setq hif-simple-token-only nil)))
+ token-list)))
+
+ ((looking-at "\r")
+ (forward-char 1))
+
+ (t (error "Bad #if expression: %s" (buffer-string)))))))
(nreverse token-list)))
;;;-----------------------------------------------------------------
;;; Translate C preprocessor #if expressions using recursive descent.
;;; This parser is limited to the operators &&, ||, !, and "defined".
;;; Added ==, !=, +, and -. Gary Oberbrunner, garyo@avs.com, 8/9/94
+;;;
+;;; Implement the C language operator precedence table. Add all those
+;;; missing operators that could be used in macros. Luke Lee 2013-09-04
+
+;;; | Operator Type | Operator | Associativity |
+;;; +----------------------+---------------------------------------------+---------------+
+;;; | Primary Expression | () [] . -> expr++ expr-- | left-to-right |
+;;; | Unary Operators | * & + - ! ~ ++expr --expr (typecast) sizeof | right-to-left |
+;;; | Binary Operators | * / % | left-to-right |
+;;; | | + - | |
+;;; | | >> << | |
+;;; | | < > <= >= | |
+;;; | | == != | |
+;;; | | & | |
+;;; | | ^ | |
+;;; | | | | |
+;;; | | && | |
+;;; | | || | |
+;;; | Ternary Operator | ?: | right-to-left |
+;;; x| Assignment Operators | = += -= *= /= %= >>= <<= &= ^= = | right-to-left |
+;;; | Comma | , | left-to-right |
(defsubst hif-nexttoken ()
"Pop the next token from token-list into the let variable \"hif-token\"."
(setq hif-token (pop hif-token-list)))
-(defun hif-parse-if-exp (token-list)
+(defsubst if-valid-identifier (id)
+ (not (or (numberp id)
+ (stringp id))))
+
+(defun hif-define-operator (tokens)
+ "`Upgrade' hif-define xxx to '(hif-define xxx)' so that it won't be subsitituted"
+ (let ((result nil)
+ (tok nil))
+ (while tokens
+ (setq tok (car tokens)
+ tokens (cdr tokens))
+ (setq result
+ (append
+ result
+ (list
+ (if (eq tok 'hif-defined)
+ (progn
+ (setq tok (cadr tokens))
+ (if (eq (car tokens) 'hif-lparen)
+ (if (and (if-valid-identifier tok)
+ (eq (caddr tokens) 'hif-rparen))
+ (setq tokens (cdddr tokens))
+ (error "operator \"defined\" requires an identifier"))
+ (setq tok (car tokens)
+ tokens (cdr tokens))
+ (unless (if-valid-identifier tok)
+ (error "operator \"defined\" requires an identifier")))
+ (list 'hif-defined 'hif-lparen tok 'hif-rparen))
+ tok)))))
+ result))
+
+(defun hif-expand-token-list (tokens &optional macroname reflist) ;; reference list to prevent self-referencing
+ "Perform expansion till everything expanded. No self-reference expansion."
+ (catch 'self-referencing
+ (let ((expanded nil)
+ (remains (hif-define-operator
+ (hif-token-concatenation (hif-token-stringification tokens))))
+ tok rep)
+ (if macroname
+ (setq reflist (cons macroname reflist)))
+ ;; Expanding all tokens till list exhausted
+ (while remains
+ (setq tok (car remains)
+ remains (cdr remains))
+ (if (memq tok reflist) ;; for self-referencing tokens, don't expand it
+ (throw 'self-referencing tokens))
+ (setq expanded
+ (append
+ expanded
+ (cond
+ ((or (memq tok hif-valid-token-list)
+ (numberp tok)
+ (stringp tok))
+ (list tok))
+
+ ((setq rep (hif-lookup tok))
+ (if (and (listp rep)
+ (eq (car rep) 'hif-define-macro)) ;; a defined macro
+ ;; recursively expand it
+ (if (cadr rep) ;; arglist is not nil
+ (if (eq (car remains) 'hif-lparen)
+ ;; Argumented macro, get arguments and invoke it
+ (let* ((hif-token-list (cdr remains)) ;; dynamic binding for hif-macro-supply-arguments
+ (hif-token nil) ;; dynamic binding for hif-macro-supply-arguments
+ (parmlist (mapcar 'hif-expand-token-list
+ (hif-get-argument-list tok)))
+ (result (hif-expand-token-list (hif-macro-supply-arguments tok parmlist)
+ tok reflist)))
+ (setq remains (cons hif-token hif-token-list))
+ result)
+ ;; no argument supplied, no invocation for this macro
+ (list tok))
+ ;; arglist is nil, direct expansion
+ (setq rep (hif-expand-token-list (caddr rep) ;; macro's token list
+ tok reflist))
+ (setq remains (substitute tok rep remains)) ;; replace all remaining references immediately
+ (list rep))
+ ;; lookup tok returns an atom
+ (list rep)))
+
+ ;;[2013-10-22 16:06:12 +0800] Must keep the token, removeing this token might results in a incomplete expression which cannot be parsed.
+ ;;((= 1 (hif-defined tok)) ;; defined (hif-defined tok)=1, but empty (hif-lookup tok)=nil, thus remove this token
+ ;; (setq remains (delete tok remains))
+ ;; nil)
+
+ (t ;; usual IDs
+ (list tok))))))
+ (flatten expanded))))
+
+(defun hif-parse-if-exp (token-list &optional macroname)
"Parse the TOKEN-LIST. Return translated list in prefix form."
- (let ((hif-token-list token-list))
+ (let ((hif-token-list (hif-expand-token-list token-list macroname)))
(hif-nexttoken)
(prog1
- (hif-expr)
+ (and hif-token
+ (hif-exprlist))
(if hif-token ; is there still a token?
(error "Error: unexpected token: %s" hif-token)))))
+;;;
+;;;To manually test these functions, try the following in scratch buffer:
+;;;
+;;;(hif-find-define (point)) ;; find only one #define
+;;;(hif-add-new-defines) ;; find all #defines
+;;;
+;;;#define macro ( arg1 , arg2 , arg3 ... ) arg1 + arg2 * arg3
+;;;
+;;;(assoc 'macro hide-ifdef-env)
+;;;
+;;;(hif-canonicalize-tokens hif-ifx-regexp)
+;;;(hif-expand-token-list (hif-canonicalize-tokens hif-ifx-regexp))
+;;;(hif-canonicalize hif-ifx-regexp)
+;;;
+;;;#if macro( (a,2,3), b<<1, (c&7,d) )
+;;;
+
+(defun hif-exprlist ()
+ "Parse an exprlist: expr { ',' expr}"
+ (let ((result (hif-expr))
+ comma)
+ (while (eq hif-token 'hif-comma)
+ (unless comma
+ (setq result (list result)))
+ (setq comma t)
+ (hif-nexttoken)
+ (setq result (append result (list (hif-expr)))))
+ (if comma
+ (append (list 'hif-comma) result)
+ result)))
+
(defun hif-expr ()
"Parse an expression as found in #if.
expr : or-expr | or-expr '?' expr ':' expr."
(let ((result (hif-or-expr))
- middle)
+ middle)
(while (eq hif-token 'hif-conditional)
(hif-nexttoken)
(setq middle (hif-expr))
(if (eq hif-token 'hif-colon)
- (progn
- (hif-nexttoken)
- (setq result (list 'hif-conditional result middle (hif-expr))))
- (error "Error: unexpected token: %s" hif-token)))
+ (progn
+ (hif-nexttoken)
+ (setq result (list 'hif-conditional result middle (hif-expr))))
+ (error "Error: unexpected token: %s" hif-token)))
result))
(defun hif-or-expr ()
- "Parse n or-expr : and-expr | or-expr '||' and-expr."
+ "Parse an or-expr : and-expr | or-expr '||' and-expr."
(let ((result (hif-and-expr)))
- (while (eq hif-token 'or)
+ (while (eq hif-token 'hif-or)
(hif-nexttoken)
(setq result (list 'hif-or result (hif-and-expr))))
result))
(defun hif-and-expr ()
- "Parse an and-expr : eq-expr | and-expr '&&' eq-expr."
+ "Parse an and-expr : logior-expr | and-expr '&&' logior-expr."
+ (let ((result (hif-logior-expr)))
+ (while (eq hif-token 'hif-and)
+ (hif-nexttoken)
+ (setq result (list 'hif-and result (hif-logior-expr))))
+ result))
+
+(defun hif-logior-expr ()
+ "Parse a logor-expr : logxor-expr | logor-expr '|' logxor-expr."
+ (let ((result (hif-logxor-expr)))
+ (while (eq hif-token 'hif-logior)
+ (hif-nexttoken)
+ (setq result (list 'hif-logior result (hif-logxor-expr))))
+ result))
+
+(defun hif-logxor-expr ()
+ "Parse a logxor-expr : logand-expr | logxor-expr '^' logand-expr."
+ (let ((result (hif-logand-expr)))
+ (while (eq hif-token 'hif-logxor)
+ (hif-nexttoken)
+ (setq result (list 'hif-logxor result (hif-logand-expr))))
+ result))
+
+(defun hif-logand-expr ()
+ "Parse a logand-expr : eq-expr | logand-expr '&' eq-expr."
(let ((result (hif-eq-expr)))
- (while (eq hif-token 'and)
+ (while (eq hif-token 'hif-logand)
(hif-nexttoken)
- (setq result (list 'hif-and result (hif-eq-expr))))
+ (setq result (list 'hif-logand result (hif-eq-expr))))
result))
(defun hif-eq-expr ()
- "Parse an eq-expr : math | eq-expr `=='|`!='|`<'|`>'|`>='|`<=' math."
- (let ((result (hif-math))
- (eq-token nil))
- (while (memq hif-token '(equal hif-notequal hif-greater hif-less
- hif-greater-equal hif-less-equal))
+ "Parse an eq-expr : comp | eq-expr `=='|`!=' comp."
+ (let ((result (hif-comp-expr))
+ (eq-token nil))
+ (while (memq hif-token '(hif-equal hif-notequal))
(setq eq-token hif-token)
(hif-nexttoken)
- (setq result (list eq-token result (hif-math))))
+ (setq result (list eq-token result (hif-comp-expr))))
+ result))
+
+(defun hif-comp-expr ()
+ "Parse a comp-expr : logshift | comp-expr `<'|`>'|`>='|`<=' logshift."
+ (let ((result (hif-logshift-expr))
+ (comp-token nil))
+ (while (memq hif-token '(hif-greater hif-less hif-greater-equal hif-less-equal))
+ (setq comp-token hif-token)
+ (hif-nexttoken)
+ (setq result (list comp-token result (hif-logshift-expr))))
+ result))
+
+(defun hif-logshift-expr ()
+ "Parse a logshift : math | logshift `<<'|`>>' math."
+ (let ((result (hif-math))
+ (shift-token nil))
+ (while (memq hif-token '(hif-shiftleft hif-shiftright))
+ (setq shift-token hif-token)
+ (hif-nexttoken)
+ (setq result (list shift-token result (hif-math))))
result))
(defun hif-math ()
- "Parse an expression with + or - and simpler things.
- math : factor | math '+|-' factor."
+ "Parse an expression with + or -.
+ math : muldiv | math '+|-' muldiv."
+ (let ((result (hif-muldiv-expr))
+ (math-op nil))
+ (while (memq hif-token '(hif-plus hif-minus))
+ (setq math-op hif-token)
+ (hif-nexttoken)
+ (setq result (list math-op result (hif-muldiv-expr))))
+ result))
+
+(defun hif-muldiv-expr ()
+ "Parse an expression with *,/,%.
+ muldiv : factor | muldiv '*|/|%' factor."
(let ((result (hif-factor))
- (math-op nil))
- (while (memq hif-token '(hif-plus hif-minus hif-logior hif-logand))
+ (math-op nil))
+ (while (memq hif-token '(hif-multiply hif-divide hif-modulo))
(setq math-op hif-token)
(hif-nexttoken)
(setq result (list math-op result (hif-factor))))
- result))
+ result))
(defun hif-factor ()
- "Parse a factor: '!' factor | '(' expr ')' | 'defined(' id ')' | id."
+ "Parse a factor: '!' factor | '~' factor | '(' expr ')' | 'defined(' id ')' | 'id(parmlist)' | strings | id."
(cond
- ((eq hif-token 'not)
+ ((eq hif-token 'hif-not)
(hif-nexttoken)
(list 'hif-not (hif-factor)))
- ((eq hif-token 'lparen)
+ ((eq hif-token 'hif-lognot)
+ (hif-nexttoken)
+ (list 'hif-lognot (hif-factor)))
+
+ ((eq hif-token 'hif-lparen)
(hif-nexttoken)
- (let ((result (hif-expr)))
- (if (not (eq hif-token 'rparen))
- (error "Bad token in parenthesized expression: %s" hif-token)
- (hif-nexttoken)
- result)))
+ (let ((result (hif-exprlist)))
+ (if (not (eq hif-token 'hif-rparen))
+ (error "Bad token in parenthesized expression: %s" hif-token)
+ (hif-nexttoken)
+ result)))
((eq hif-token 'hif-defined)
(hif-nexttoken)
- (let ((paren (when (eq hif-token 'lparen) (hif-nexttoken) t))
- (ident hif-token))
- (if (memq hif-token '(or and not hif-defined lparen rparen))
- (error "Error: unexpected token: %s" hif-token))
+ (let ((paren (when (eq hif-token 'hif-lparen) (hif-nexttoken) t))
+ (ident hif-token))
+ (if (memq hif-token '(or and not hif-defined hif-lparen hif-rparen))
+ (error "Error: unexpected token: %s" hif-token))
(when paren
- (hif-nexttoken)
- (unless (eq hif-token 'rparen)
- (error "Error: expected \")\" after identifier")))
+ (hif-nexttoken)
+ (unless (eq hif-token 'hif-rparen)
+ (error "Error: expected \")\" after identifier")))
(hif-nexttoken)
`(hif-defined (quote ,ident))))
((numberp hif-token)
(prog1 hif-token (hif-nexttoken)))
+ ((stringp hif-token)
+ (hif-string-concatenation))
+
;; Unary plus/minus.
((memq hif-token '(hif-minus hif-plus))
(list (prog1 hif-token (hif-nexttoken)) 0 (hif-factor)))
- (t ; identifier
+ (t ; identifier
(let ((ident hif-token))
- (if (memq ident '(or and))
- (error "Error: missing identifier"))
(hif-nexttoken)
- `(hif-lookup (quote ,ident))))))
+ (if (eq hif-token 'hif-lparen)
+ (hif-place-macro-invocation ident)
+ `(hif-lookup (quote ,ident)))))))
+
+(defun hif-get-argument-list (ident)
+ (let ((nest 0)
+ (parmlist nil) ;; a "token" list of parameters, will later be parsed
+ (parm nil))
+ (while (or (not (eq (hif-nexttoken) 'hif-rparen))
+ (/= nest 0))
+ (if (eq (car parm) 'hif-comma)
+ (setq parm nil))
+ (cond
+ ((eq hif-token 'hif-lparen)
+ (setq nest (1+ nest)))
+ ((eq hif-token 'hif-rparen)
+ (setq nest (1- nest))
+ (if (< nest 0)
+ (error "Unbalanced parenthesis when invoking macro %S" ident)))
+ ((and (eq hif-token 'hif-comma)
+ (= nest 0))
+ (setq parmlist (append parmlist (list parm))
+ parm nil)))
+ (setq parm (append parm (list hif-token))))
+ (setq parmlist (append parmlist (list parm))) ; okay even if parm is nil
+ (hif-nexttoken) ; drop the hif-rparen, get next token
+ parmlist))
+
+(defun hif-place-macro-invocation (ident)
+ (let ((parmlist (hif-get-argument-list ident)))
+ `(hif-invoke (quote ,ident) (quote ,parmlist))))
+
+(defun hif-string-concatenation ()
+ "Parse concatenated strings: string | strings string"
+ (let ((result (substring-no-properties hif-token)))
+ (while (stringp (hif-nexttoken))
+ (setq result (concat
+ (substring result 0 -1) ; remove trailing '"'
+ (substring hif-token 1)))) ; remove leading '"'
+ result))
+
+(defun hif-define-macro (parmlist token-body)
+ "A marker for defined macro with arguments, cannot be evaluated alone with no parameters inputed."
+ ;; TODO: input parameters at run time, use minibuffer to query all parameters
+ (error "Argumented macro cannot be evaluated without passing any parameter."))
+
+(defun hif-stringify (a)
+ "Stringify a number, string or symbol"
+ (cond
+ ((numberp a)
+ (number-to-string a))
+ ((atom a)
+ (symbol-name a))
+ ((stringp a)
+ (concat "\"" a "\""))
+ (t
+ (error "Invalid token to stringify"))))
+
+(defun intern-safe (str)
+ (if (stringp str)
+ (intern str)))
+
+(defun hif-merge-operator-token (a b)
+ "Support weird (but valid) use of token concatenation. Here we take care only those that can be evaluated during
+preprocessing time. For those computable syntax that can only be evaluated during C runtime (like '++','--','+='...),
+we ignore them all here."
+ (cond
+ ((and (eq a 'hif-logior) (eq b 'hif-logior)) ;; '|''|' -> '||'
+ 'hif-or)
+ ((and (eq a 'hif-logand) (eq b 'hif-logand)) ;; '&''&' -> '&&'
+ 'hif-and)
+ ((and (eq a 'hif-assign) (eq b 'hif-assign)) ;; '=''=' -> '=='
+ 'hif-equal)
+ ((and (eq a 'hif-not) (eq b 'hif-assign)) ;; '!''=' -> '!='
+ 'hif-notequal)
+ ((eq a 'hif-less)
+ (if (eq b 'hif-less) ;; '<''<' -> '<<'
+ 'hif-shiftleft
+ (if (eq b 'hif-assign) ;; '<''=' -> '<='
+ 'hif-less-equal)))
+ ((eq a 'hif-greater)
+ (if (eq b 'hif-greater) ;; '>''>' -> '>>'
+ 'hif-shiftleft
+ (if (eq b 'hif-assign) ;; '>''=' -> '>='
+ 'hif-greater-equal)))))
+
+(defun hif-token-concat (a b)
+ "Concatenation two symbol name into a longer symbol, currently support only simple symbol concatenation."
+ (if (or (memq a hif-valid-token-list)
+ (memq b hif-valid-token-list))
+ (let ((result (hif-merge-operator-token a b)))
+ (or result
+ ;;(error "Invalid token to concatenate")
+ (error "pasting \"%s\" and \"%s\" does not give a valid preprocessing token"
+ (if (memq a hif-valid-token-list) (car (rassoc a hif-token-alist)) (symbol-name a))
+ (if (memq b hif-valid-token-list) (car (rassoc b hif-token-alist)) (symbol-name b)))))
+ (intern-safe (concat (hif-stringify a)
+ (hif-stringify b)))))
(defun hif-mathify (val)
"Treat VAL as a number: if it's t or nil, use 1 or 0."
(cond ((eq val t) 1)
- ((null val) 0)
- (t val)))
+ ((null val) 0)
+ (t val)))
(defun hif-conditional (a b c)
(if (not (zerop (hif-mathify a))) (hif-mathify b) (hif-mathify c)))
+
(defun hif-and (a b)
(and (not (zerop (hif-mathify a))) (not (zerop (hif-mathify b)))))
(defun hif-or (a b)
(or (not (zerop (hif-mathify a))) (not (zerop (hif-mathify b)))))
(defun hif-not (a)
(zerop (hif-mathify a)))
+(defun hif-lognot (a)
+ (lognot a))
(defmacro hif-mathify-binop (fun)
`(lambda (a b)
,(format "Like `%s' but treat t and nil as 1 and 0." fun)
(,fun (hif-mathify a) (hif-mathify b))))
+(defun shiftleft (a b)
+ (if (< a 0)
+ (ash a b)
+ (lsh a b)))
+
+(defun shiftright (a b)
+ (if (< a 0)
+ (ash a (- 0 b))
+ (lsh a (- 0 b))))
+
+
+(defalias 'hif-multiply (hif-mathify-binop *))
+(defalias 'hif-divide (hif-mathify-binop /))
+(defalias 'hif-modulo (hif-mathify-binop %))
(defalias 'hif-plus (hif-mathify-binop +))
(defalias 'hif-minus (hif-mathify-binop -))
+(defalias 'hif-equal (hif-mathify-binop =))
(defalias 'hif-notequal (hif-mathify-binop /=))
(defalias 'hif-greater (hif-mathify-binop >))
(defalias 'hif-less (hif-mathify-binop <))
(defalias 'hif-greater-equal (hif-mathify-binop >=))
(defalias 'hif-less-equal (hif-mathify-binop <=))
(defalias 'hif-logior (hif-mathify-binop logior))
+(defalias 'hif-logxor (hif-mathify-binop logxor))
(defalias 'hif-logand (hif-mathify-binop logand))
+(defalias 'hif-shiftleft (hif-mathify-binop shiftleft))
+(defalias 'hif-shiftright (hif-mathify-binop shiftright))
-;;;----------- end of parser -----------------------
+(defun hif-comma (&rest expr)
+ "Evaluate a list of expr, return the result of the last item"
+ (let ((result nil))
+ (dolist (e expr)
+ (ignore-errors
+ (setq result (funcall hide-ifdef-evaluator e))))
+ result))
+
+(defun hif-token-stringification (l)
+ "Scan token list for 'hif-stringify' ('#') token and stringify the next token"
+ (let (result)
+ (while l
+ (setq result
+ (append result
+ (list
+ (if (eq (car l) 'hif-stringify)
+ (prog1
+ (if (cadr l)
+ (hif-stringify (cadr l))
+ (error "No token to stringify"))
+ (setq l (cdr l)))
+ (car l)))))
+ (setq l (cdr l)))
+ result))
+
+(defun hif-token-concatenation (l)
+ "Scan token list for 'hif-token-concat' ('##') token and concatenate two tokens"
+ (let ((prev nil)
+ result)
+ (while l
+ (while (eq (car l) 'hif-token-concat)
+ (unless prev
+ (error "No token before ## to concatenate"))
+ (unless (cdr l)
+ (error "No token after ## to concatenate"))
+ (setq prev (hif-token-concat prev (cadr l)))
+ (setq l (cddr l)))
+ (if prev
+ (setq result (append result (list prev))))
+ (setq prev (car l)
+ l (cdr l)))
+ (if prev
+ (append result (list prev))
+ result)))
+
+(defun flatten (l)
+ "Flatten a tree"
+ (if (and l (atom l))
+ (list l)
+ (if (consp l)
+ (nconc (flatten (car l)) (flatten (cdr l))))))
+
+(defun delimit (l a)
+ "Delmit a list 'l' with delimiter atom 'd'"
+ (nconc (mapcan (lambda (l)
+ (list l a)) (butlast l))
+ (last l)))
+
+;; Perform token replacement:
+(defun hif-macro-supply-arguments (macro-name actual-parms)
+ "Expand a macro function, replace 'actual-parms' to the function body."
+ (let* ((SA (assoc macro-name hide-ifdef-env))
+ (macro (and SA
+ (cdr SA)
+ (eq (cadr SA) 'hif-define-macro)
+ (cddr SA)))
+ (formal-parms (and macro (car macro)))
+ (macro-body (and macro (cadr macro)))
+ (hide-ifdef-local-env nil) ;; dynamic binding local table
+ actual-count
+ formal-count
+ actual
+ formal
+ etc)
+
+ (when (and actual-parms formal-parms macro-body)
+ ;; For each actual parameter, evaluate each one and associate it
+ ;; with the associated actual parameter, put it into local table and finally
+ ;; evaluate the macro body.
+ (if (setq etc (eq (car formal-parms) 'hif-etc)) ;; Take care of 'hif-etc first. Prefix 'hif-comma back if needed.
+ (setq formal-parms (cdr formal-parms)))
+ (setq formal-count (length formal-parms)
+ actual-count (length actual-parms))
+
+ (if (> formal-count actual-count)
+ (error "Too few parmameter for macro %S" macro-name)
+ (if (< formal-count actual-count)
+ (or etc
+ (error "Too many parameters for macro %S" macro-name))))
+
+ ;; Perform token replacement on the macro-body on the parameters
+ (while (setq formal (car formal-parms))
+ (setq formal-parms (cdr formal-parms))
+ ;; Prevent repettative substitutation, thus cannot use 'subst'
+ ;; for example:
+ ;; #define mac(a,b) (a+b)
+ ;; #define testmac mac(b,y)
+ ;; testmac should expand to (b+y): replace of argument a and b occurs simultaneously
+ ;; not sequentially. If this occurs sequentially according to the argument order,
+ ;; it will become: 1. formal parm #1 'a' replaced by actual parm 'b', thus (a+b) becomes (b+b)
+ ;; 2. formal parm #2 'b' replaced by actual parm 'y', thus (b+b) becomes (y+y).
+ (setq macro-body
+ ;; Unlike 'subst', 'substitute' replace only the top level instead of the whole tree,
+ ;; more importantly, it's not destructive.
+ (if (and etc (null formal-parms))
+ (substitute (delimit actual-parms 'hif-comma) formal macro-body)
+ (substitute (car actual-parms) formal macro-body)))
+ (setq actual-parms (cdr actual-parms)))
+
+ ;; Replacement completed, flatten the whole token list,
+ (setq macro-body (flatten macro-body))
+
+ ;; Stringification and token concatenation happens here
+ (hif-token-concatenation (hif-token-stringification macro-body)))))
+
+(defun hif-invoke (macro-name actual-parms)
+ "Invoke a macro by first expanding it, then reparse the macro-body, finally invoke the macro."
+ ;; Reparse the macro body and evaluate it
+ (funcall hide-ifdef-evaluator
+ (hif-parse-if-exp
+ (hif-macro-supply-arguments macro-name actual-parms)
+ macro-name)))
+
+;;;----------- end of parser -----------------------
-(defun hif-canonicalize ()
- "When at beginning of #ifX, return a Lisp expression for its condition."
+(defun hif-canonicalize-tokens (regexp) ;; for debugging
+ "Return the expanded result of the scanned tokens."
(save-excursion
- (let ((negate (looking-at hif-ifndef-regexp)))
- (re-search-forward hif-ifx-regexp)
+ (re-search-forward regexp)
+ (let* ((curr-regexp (match-string 0))
+ (defined (string-match hif-ifxdef-regexp curr-regexp))
+ (negate (and defined
+ (string= (match-string 2 curr-regexp) "n"))))
(let* ((tokens (hif-tokenize (point)
- (progn (hif-end-of-line) (point))))
- (expr (hif-parse-if-exp tokens)))
- ;; (message "hif-canonicalized: %s" expr)
- (if negate
- (list 'hif-not expr)
- expr)))))
-
+ (progn (hif-end-of-line) (point)))))
+ (if defined
+ (setq tokens (list 'hif-defined tokens)))
+ (if negate
+ (setq tokens (list 'hif-not tokens)))
+ tokens))))
+
+(defun hif-canonicalize (regexp)
+ "When at beginning of `regexp' (i.e. #ifX), return a Lisp expression for its condition."
+ (let ((case-fold-search nil))
+ (save-excursion
+ (re-search-forward regexp)
+ (let* ((curr-regexp (match-string 0))
+ (defined (string-match hif-ifxdef-regexp curr-regexp))
+ (negate (and defined
+ (string= (match-string 2 curr-regexp) "n")))
+ (tokens (hif-tokenize (point)
+ (progn (hif-end-of-line) (point)))))
+ (if defined
+ (setq tokens (list 'hif-defined tokens)))
+ (if negate
+ (setq tokens (list 'hif-not tokens)))
+ (hif-parse-if-exp tokens)))))
(defun hif-find-any-ifX ()
"Move to next #if..., or #ifndef, at point or after."
@@ -581,9 +1169,8 @@ that form should be displayed.")
(re-search-forward hif-ifx-regexp (point-max) t)
(beginning-of-line)))
-
(defun hif-find-next-relevant ()
- "Move to next #if..., #else, or #endif, after the current line."
+ "Move to next #if..., #elif..., #else, or #endif, after the current line."
;; (message "hif-find-next-relevant at %d" (point))
(end-of-line)
;; avoid infinite recursion by only going to beginning of line if match found
@@ -599,28 +1186,31 @@ that form should be displayed.")
(beginning-of-line)))
-(defun hif-looking-at-ifX () ;; Should eventually see #if
+(defun hif-looking-at-ifX () ;; Should eventually see #if
(looking-at hif-ifx-regexp))
(defun hif-looking-at-endif ()
(looking-at hif-endif-regexp))
(defun hif-looking-at-else ()
(looking-at hif-else-regexp))
-
+(defun hif-looking-at-elif ()
+ (looking-at hif-elif-regexp))
(defun hif-ifdef-to-endif ()
- "If positioned at #ifX or #else form, skip to corresponding #endif."
+ "If positioned at #ifX, #elif, or #else form, skip to corresponding #endif."
;; (message "hif-ifdef-to-endif at %d" (point)) (sit-for 1)
(hif-find-next-relevant)
(cond ((hif-looking-at-ifX)
- (hif-ifdef-to-endif) ; find endif of nested if
- (hif-ifdef-to-endif)) ; find outer endif or else
- ((hif-looking-at-else)
- (hif-ifdef-to-endif)) ; find endif following else
- ((hif-looking-at-endif)
- 'done)
- (t
- (error "Mismatched #ifdef #endif pair"))))
+ (hif-ifdef-to-endif) ; find endif of nested if
+ (hif-ifdef-to-endif)) ; find outer endif or else
+ ((hif-looking-at-elif)
+ (hif-ifdef-to-endif))
+ ((hif-looking-at-else)
+ (hif-ifdef-to-endif)) ; find endif following else
+ ((hif-looking-at-endif)
+ 'done)
+ (t
+ (error "Mismatched #ifdef #endif pair"))))
(defun hif-endif-to-ifdef ()
@@ -629,15 +1219,18 @@ that form should be displayed.")
(let ((start (point)))
(hif-find-previous-relevant)
(if (= start (point))
- (error "Mismatched #ifdef #endif pair")))
+ (error "Mismatched #ifdef #endif pair")))
(cond ((hif-looking-at-endif)
- (hif-endif-to-ifdef) ; find beginning of nested if
- (hif-endif-to-ifdef)) ; find beginning of outer if or else
- ((hif-looking-at-else)
- (hif-endif-to-ifdef))
- ((hif-looking-at-ifX)
- 'done)
- (t))) ; never gets here
+ (hif-endif-to-ifdef) ; find beginning of nested if
+ (hif-endif-to-ifdef)) ; find beginning of outer if or else
+ ((hif-looking-at-elif)
+ (hif-endif-to-ifdef))
+ ((hif-looking-at-else)
+ (hif-endif-to-ifdef))
+ ((hif-looking-at-ifX)
+ 'done)
+ (t
+ (error "Mismatched #endif")))) ; never gets here
(defun forward-ifdef (&optional arg)
@@ -649,12 +1242,12 @@ With argument, do this that many times."
(while (< 0 arg)
(setq arg (- arg))
(let ((start (point)))
- (unless (hif-looking-at-ifX)
- (hif-find-next-relevant))
- (if (hif-looking-at-ifX)
- (hif-ifdef-to-endif)
- (goto-char start)
- (error "No following #ifdef"))))))
+ (unless (hif-looking-at-ifX)
+ (hif-find-next-relevant))
+ (if (hif-looking-at-ifX)
+ (hif-ifdef-to-endif)
+ (goto-char start)
+ (error "No following #ifdef"))))))
(defun backward-ifdef (&optional arg)
@@ -667,12 +1260,12 @@ With argument, do this that many times."
(setq arg (1- arg))
(beginning-of-line)
(let ((start (point)))
- (unless (hif-looking-at-endif)
- (hif-find-previous-relevant))
- (if (hif-looking-at-endif)
- (hif-endif-to-ifdef)
- (goto-char start)
- (error "No previous #ifdef"))))))
+ (unless (hif-looking-at-endif)
+ (hif-find-previous-relevant))
+ (if (hif-looking-at-endif)
+ (hif-endif-to-ifdef)
+ (goto-char start)
+ (error "No previous #ifdef"))))))
(defun down-ifdef ()
@@ -681,9 +1274,9 @@ With argument, do this that many times."
(let ((start (point)))
(hif-find-next-relevant)
(if (or (hif-looking-at-ifX) (hif-looking-at-else))
- ()
- (goto-char start)
- (error "No following #ifdef"))))
+ ()
+ (goto-char start)
+ (error "No following #ifdef"))))
(defun up-ifdef ()
@@ -694,9 +1287,9 @@ With argument, do this that many times."
(unless (hif-looking-at-endif)
(hif-find-previous-relevant))
(if (hif-looking-at-endif)
- (hif-endif-to-ifdef))
+ (hif-endif-to-ifdef))
(if (= start (point))
- (error "No previous #ifdef"))))
+ (error "No previous #ifdef"))))
(defun next-ifdef (&optional arg)
"Move to the beginning of the next #ifX, #else, or #endif.
@@ -708,8 +1301,8 @@ With argument, do this that many times."
(setq arg (1- arg))
(hif-find-next-relevant)
(when (eolp)
- (beginning-of-line)
- (error "No following #ifdefs, #elses, or #endifs")))))
+ (beginning-of-line)
+ (error "No following #ifdefs, #elses, or #endifs")))))
(defun previous-ifdef (&optional arg)
"Move to the beginning of the previous #ifX, #else, or #endif.
@@ -720,9 +1313,9 @@ With argument, do this that many times."
(while (< 0 arg)
(setq arg (1- arg))
(let ((start (point)))
- (hif-find-previous-relevant)
- (if (= start (point))
- (error "No previous #ifdefs, #elses, or #endifs"))))))
+ (hif-find-previous-relevant)
+ (if (= start (point))
+ (error "No previous #ifdefs, #elses, or #endifs"))))))
;;===%%SF%% parsing (End) ===
@@ -732,19 +1325,18 @@ With argument, do this that many times."
;;; A range is a structure with four components:
-;;; ELSE-P True if there was an else clause for the ifdef.
-;;; START The start of the range. (beginning of line)
-;;; ELSE The else marker (beginning of line)
-;;; Only valid if ELSE-P is true.
-;;; END The end of the range. (beginning of line)
+;;; START The start of the range. (beginning of line)
+;;; ELSE The else marker (beginning of line)
+;;; END The end of the range. (beginning of line)
+;;; ELIF A sequence of #elif markers (beginning of line)
-(defsubst hif-make-range (start end &optional else)
- (list start else end))
+(defsubst hif-make-range (start end &optional else elif)
+ (list start else end elif))
(defsubst hif-range-start (range) (elt range 0))
(defsubst hif-range-else (range) (elt range 1))
(defsubst hif-range-end (range) (elt range 2))
-
+(defsubst hif-range-elif (range) (elt range 3))
;;; Find-Range
@@ -759,29 +1351,33 @@ Point is left unchanged."
(save-excursion
(beginning-of-line)
(let ((start (point))
- (else nil)
- (end nil))
- ;; Part one. Look for either #endif or #else.
+ (elif nil)
+ (else nil)
+ (end nil))
+ ;; Part one. Look for either #elif, #else or #endif.
;; This loop-and-a-half dedicated to E. Dijkstra.
- (while (progn
- (hif-find-next-relevant)
- (hif-looking-at-ifX)) ; Skip nested ifdef
- (hif-ifdef-to-endif))
- ;; Found either a #else or an #endif.
- (cond ((hif-looking-at-else)
- (setq else (point)))
- (t
- (setq end (point)))) ; (line-end-position)
+ (while (and (not else) (not end))
+ (while (progn
+ (hif-find-next-relevant)
+ (hif-looking-at-ifX)) ; Skip nested ifdef
+ (hif-ifdef-to-endif))
+ ;; Found either a #else, #elif, or an #endif.
+ (cond ((hif-looking-at-elif)
+ (setq elif (nconc elif (list (point)))))
+ ((hif-looking-at-else)
+ (setq else (point)))
+ (t
+ (setq end (point)))))
;; If found #else, look for #endif.
(when else
- (while (progn
- (hif-find-next-relevant)
- (hif-looking-at-ifX)) ; Skip nested ifdef
- (hif-ifdef-to-endif))
- (if (hif-looking-at-else)
- (error "Found two elses in a row? Broken!"))
- (setq end (point))) ; (line-end-position)
- (hif-make-range start end else))))
+ (while (progn
+ (hif-find-next-relevant)
+ (hif-looking-at-ifX)) ; Skip nested ifdef
+ (hif-ifdef-to-endif))
+ (if (hif-looking-at-else)
+ (error "Found two elses in a row? Broken!"))
+ (setq end (point))) ; (line-end-position)
+ (hif-make-range start end else elif))))
;;; A bit slimy.
@@ -802,15 +1398,18 @@ Point is left unchanged."
;;; compiled.
;;;
;;; Case 1: #ifX taken, and there's an #else.
-;;; The #else part must be hidden. The #if (then) part must be
-;;; processed for nested #ifX's.
+;;; The #else part must be hidden. The #if (then) part must be
+;;; processed for nested #ifX's.
;;; Case 2: #ifX taken, and there's no #else.
-;;; The #if part must be processed for nested #ifX's.
-;;; Case 3: #ifX not taken, and there's an #else.
-;;; The #if part must be hidden. The #else part must be processed
-;;; for nested #ifs.
-;;; Case 4: #ifX not taken, and there's no #else.
-;;; The #ifX part must be hidden.
+;;; The #if part must be processed for nested #ifX's.
+;;; Case 3: #ifX not taken, and there's an #elif
+;;; The #if part must be hidden, and then evaluate
+;;; the #elif condition like a new #ifX.
+;;; Case 4: #ifX not taken, and there's just an #else.
+;;; The #if part must be hidden. The #else part must be processed
+;;; for nested #ifs.
+;;; Case 5: #ifX not taken, and there's no #else.
+;;; The #ifX part must be hidden.
;;;
;;; Further processing is done by narrowing to the relevant region
;;; and just recursively calling hide-ifdef-guts.
@@ -818,61 +1417,249 @@ Point is left unchanged."
;;; When hif-possibly-hide returns, point is at the end of the
;;; possibly-hidden range.
-(defun hif-recurse-on (start end)
+(defvar hif-recurse-level 0)
+
+(defun hif-recurse-on (start end &optional dont-go-eol)
"Call `hide-ifdef-guts' after narrowing to end of START line and END line."
(save-excursion
(save-restriction
(goto-char start)
- (end-of-line)
+ (unless dont-go-eol
+ (end-of-line))
(narrow-to-region (point) end)
- (hide-ifdef-guts))))
+ (let ((hif-recurse-level (1+ hif-recurse-level)))
+ (hide-ifdef-guts)))))
-(defun hif-possibly-hide ()
+(defun hif-possibly-hide (expand-reinclusion)
"Called at #ifX expression, this hides those parts that should be hidden.
It uses the judgment of `hide-ifdef-evaluator'."
;; (message "hif-possibly-hide") (sit-for 1)
- (let ((test (hif-canonicalize))
- (range (hif-find-range)))
+ (let* ((case-fold-search nil)
+ (test (hif-canonicalize hif-ifx-regexp))
+ (range (hif-find-range))
+ (elifs (hif-range-elif range))
+ (if-part t) ;; everytime we start from if-part
+ (complete nil))
;; (message "test = %s" test) (sit-for 1)
(hif-hide-line (hif-range-end range))
- (if (not (hif-not (funcall hide-ifdef-evaluator test)))
- (cond ((hif-range-else range) ; case 1
- (hif-hide-line (hif-range-else range))
- (hide-ifdef-region (hif-range-else range)
- (1- (hif-range-end range)))
- (hif-recurse-on (hif-range-start range)
- (hif-range-else range)))
- (t ; case 2
- (hif-recurse-on (hif-range-start range)
- (hif-range-end range))))
- (cond ((hif-range-else range) ; case 3
- (hif-hide-line (hif-range-else range))
- (hide-ifdef-region (hif-range-start range)
- (1- (hif-range-else range)))
- (hif-recurse-on (hif-range-else range)
- (hif-range-end range)))
- (t ; case 4
- (hide-ifdef-region (point)
- (1- (hif-range-end range))))))
+
+ (while (not complete)
+ (if (and (not (and expand-reinclusion if-part))
+ (hif-not (funcall hide-ifdef-evaluator test)))
+ ;; ifX/elif is FALSE
+ (if elifs
+ ;; Case 3 - Hide the #ifX and eval #elif
+ (let ((newstart (car elifs)))
+ (hif-hide-line (hif-range-start range))
+ (hide-ifdef-region (hif-range-start range)
+ (1- newstart))
+ (setcar range newstart)
+ (goto-char newstart)
+ (setq elifs (cdr elifs))
+ (setq test (hif-canonicalize hif-elif-regexp)))
+
+ ;; Check for #else
+ (cond ((hif-range-else range)
+ ;; Case 4 - #else block visible
+ (hif-hide-line (hif-range-else range))
+ (hide-ifdef-region (hif-range-start range)
+ (1- (hif-range-else range)))
+ (hif-recurse-on (hif-range-else range)
+ (hif-range-end range)))
+ (t
+ ;; Case 5 - No #else block, hide #ifX
+ (hide-ifdef-region (point)
+ (1- (hif-range-end range)))))
+ (setq complete t))
+
+ ;; ifX/elif is TRUE
+ (cond (elifs
+ ;; Luke fix: distinguish from #elif..#elif to #elif..#else [2013-08-30 14:10:40 +0800]
+ (let ((elif (car elifs)))
+ ;; hide all elifs
+ (hif-hide-line elif)
+ (hide-ifdef-region elif (1- (hif-range-end range)))
+ (hif-recurse-on (hif-range-start range)
+ elif)))
+ ((hif-range-else range)
+ ;; Case 1 - Hide #elif and #else blocks, recurse #ifX
+ (hif-hide-line (hif-range-else range))
+ (hide-ifdef-region (hif-range-else range)
+ (1- (hif-range-end range)))
+ (hif-recurse-on (hif-range-start range)
+ (hif-range-else range)))
+
+ (t
+ ;; Case 2 - No #else, just recurse #ifX
+ (hif-recurse-on (hif-range-start range)
+ (hif-range-end range))))
+ (setq complete t))
+ (setq if-part nil))
+
+ ;; complete = t
(hif-hide-line (hif-range-start range)) ; Always hide start.
(goto-char (hif-range-end range))
(end-of-line)))
+(defun hif-evaluate-region (start end)
+ (let* ((tokens (ignore-errors ;; prevent C statement things like 'do { ... } while (0)'
+ (hif-tokenize start end)))
+ (expr (and tokens
+ (condition-case nil
+ (hif-parse-if-exp tokens)
+ (error
+ tokens))))
+ (result (funcall hide-ifdef-evaluator expr)))
+ result))
+
+(defun hif-evaluate-macro (rstart rend)
+ "Evaluate the macro expansion result for a region. If no region active,
+find the current #ifdefs and evaluate the result. Currently it support only
+math calculation, no string or argumented macros can be expanded."
+ (interactive "r")
+ (let ((case-fold-search nil))
+ (save-excursion
+ (unless mark-active
+ (setq rstart nil rend nil)
+ (beginning-of-line)
+ (when (and (re-search-forward hif-macro-expr-prefix-regexp nil t)
+ (string= "define" (match-string 2)))
+ (re-search-forward hif-macroname nil t)))
+ (let* ((start (or rstart (point)))
+ (end (or rend (progn (hif-end-of-line) (point))))
+ (defined nil)
+ (simple 't)
+ (tokens (ignore-errors ;; prevent C statement things like 'do { ... } while (0)'
+ (hif-tokenize start end)))
+ (expr (or (and (<= (length tokens) 1) ;; simple token
+ (setq defined (assoc (car tokens) hide-ifdef-env))
+ (setq simple (atom (hif-lookup (car tokens))))
+ (hif-lookup (car tokens)))
+ (and tokens
+ (condition-case nil
+ (hif-parse-if-exp tokens)
+ (error
+ nil)))))
+ (result (funcall hide-ifdef-evaluator expr))
+ (exprstring (replace-regexp-in-string
+ "^[ \t]*\\([^ \t]+\\)[ \t]*" "\\1" ;; trim off leading/trailing whites
+ (replace-regexp-in-string
+ "\\(//.*\\)" "" ;; trim off end-of-line comments
+ (buffer-substring-no-properties start end)))))
+ (cond
+ ((and (<= (length tokens) 1) simple) ;; simple token
+ (if defined
+ (message "%S <= `%s'" result exprstring)
+ (message "`%s' is not defined" exprstring)))
+ ((integerp result)
+ (if (or (= 0 result) (= 1 result))
+ (message "%S <= `%s'" result exprstring)
+ (message "%S (0x%x) <= `%s'" result result exprstring)))
+ ((null result) (message "%S <= `%s'" 'false exprstring))
+ ((eq t result) (message "%S <= `%s'" 'true exprstring))
+ (t (message "%S <= `%s'" result exprstring)))
+ result))))
+
+(defun hif-parse-macro-arglist (str)
+ "Parse argument list formatted as '( arg1 [ , argn] [...] )', includeing the '...'
+Return a list of the arguments, if '...' exists the first arg will be hif-etc."
+ (let ((tokenlist (cdr (hif-tokenize (- (point) (length str)) (point)))) ; remove hif-lparen
+ result token)
+ (while (not (eq (setq token (car tokenlist)) 'hif-rparen))
+ (setq tokenlist (cdr tokenlist))
+ (cond
+ ((eq token 'hif-etc)
+ (setq result (cons 'hif-etc result)))
+ ((eq token 'hif-comma)
+ t)
+ (t
+ (setq result (append result (cons token nil))))))
+ result))
+
+(defun hif-find-define (&optional min max)
+ (interactive)
+ (and min (goto-char min))
+ (and (re-search-forward hif-define max t)
+ (or
+ (let* ((defining (string= "define" (match-string 2)))
+ (name (and (re-search-forward hif-macroname max t)
+ (match-string 1)))
+ (parsed nil)
+ (parmlist (and (match-string 3) ;; first arg id found
+ (hif-parse-macro-arglist (match-string 2)))))
+ (if defining
+ ;; ignore name (still need to return 't), or define the name
+ (or (and hide-ifdef-exclude-define-regexp-pattern
+ (string-match hide-ifdef-exclude-define-regexp-pattern name))
+
+ (let* ((start (point))
+ (end (progn (hif-end-of-line) (point)))
+ (tokens (and name
+ (condition-case nil ;; prevent C statement things like 'do { ... } while (0)'
+ (hif-tokenize start end)
+ (error ;; we can't just return nil since this will stop searching for the remaining #defines.
+ (setq hif-simple-token-only t)
+ (buffer-substring-no-properties start end)))))
+ ;; For simple token we save only the parsed result;
+ ;; or we save the tokens, parse it after parameter replacement
+ (expr (and tokens
+ (or (and hif-simple-token-only
+ (listp tokens)
+ (= (length tokens) 1)
+ (hif-parse-if-exp tokens))
+ `(hif-define-macro ,parmlist ,tokens))))
+ (SA (and name
+ (assoc (intern name) hide-ifdef-env))))
+ (and name
+ (if SA
+ (or (setcdr SA expr) t) ;; Lazy evaluation, eval only if hif-lookup find it
+ ;; define it anyway, even if nil it's still in list and therefore considerred defined
+ (push (cons (intern name) expr) hide-ifdef-env)))))
+ ;; #undef
+ (and name
+ (hif-undefine-symbol (intern name))))))
+ t))
+
+;;(defun mark-region (min max)
+;; (set-mark (or max (point-max)))
+;; (goto-char min))
+
+(defun hif-add-new-defines (&optional min max)
+ "Scan and add all #define macros between min .. max"
+ (interactive)
+ (save-excursion
+ (save-restriction
+ ;; (mark-region min max) ;; for debugging
+ (while (hif-find-define min max)
+ (setf min (point)))
+ (if max (goto-char max)
+ (goto-char (point-max))))))
(defun hide-ifdef-guts ()
"Does most of the work of `hide-ifdefs'.
It does not do the work that's pointless to redo on a recursive entry."
;; (message "hide-ifdef-guts")
(save-excursion
- (goto-char (point-min))
- (while (hif-find-any-ifX)
- (hif-possibly-hide))))
+ (let ((case-fold-search nil)
+ (expand-header (and hide-ifdef-expand-re-inclusion-protection
+ (string-match hide-ifdef-header-regexp-pattern
+ (buffer-name (current-buffer)))
+ (zerop hif-recurse-level)))
+ min max)
+ (goto-char (point-min))
+ (setf min (point))
+ (loop do
+ (setf max (hif-find-any-ifX))
+ (hif-add-new-defines min max)
+ (if max
+ (hif-possibly-hide expand-header))
+ (setf min (point))
+ while max))))
;;===%%SF%% hide-ifdef-hiding (End) ===
-
;;===%%SF%% exports (Start) ===
(defun hide-ifdef-toggle-read-only ()
@@ -880,7 +1667,7 @@ It does not do the work that's pointless to redo on a recursive entry."
(interactive)
(setq hide-ifdef-read-only (not hide-ifdef-read-only))
(message "Hide-Read-Only %s"
- (if hide-ifdef-read-only "ON" "OFF"))
+ (if hide-ifdef-read-only "ON" "OFF"))
(if hide-ifdef-hiding
(setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only)))
(force-mode-line-update))
@@ -890,10 +1677,10 @@ It does not do the work that's pointless to redo on a recursive entry."
(interactive)
(setq hif-outside-read-only (not hif-outside-read-only))
(message "Read only %s"
- (if hif-outside-read-only "ON" "OFF"))
+ (if hif-outside-read-only "ON" "OFF"))
(setq buffer-read-only
- (or (and hide-ifdef-hiding hide-ifdef-read-only)
- hif-outside-read-only))
+ (or (and hide-ifdef-hiding hide-ifdef-read-only)
+ hif-outside-read-only))
(force-mode-line-update))
(defun hide-ifdef-toggle-shadowing ()
@@ -905,45 +1692,81 @@ It does not do the work that's pointless to redo on a recursive entry."
(widen)
(dolist (overlay (overlays-in (point-min) (point-max)))
(when (overlay-get overlay 'hide-ifdef)
- (if hide-ifdef-shadow
- (progn
- (overlay-put overlay 'invisible nil)
- (overlay-put overlay 'face 'hide-ifdef-shadow))
- (overlay-put overlay 'face nil)
- (overlay-put overlay 'invisible 'hide-ifdef))))))
-
-(defun hide-ifdef-define (var)
- "Define a VAR so that #ifdef VAR would be included."
- (interactive "SDefine what? ")
- (hif-set-var var 1)
- (if hide-ifdef-hiding (hide-ifdefs)))
-
-(defun hide-ifdef-undef (var)
+ (if hide-ifdef-shadow
+ (progn
+ (overlay-put overlay 'invisible nil)
+ (overlay-put overlay 'face 'hide-ifdef-shadow))
+ (overlay-put overlay 'face nil)
+ (overlay-put overlay 'invisible 'hide-ifdef))))))
+
+(defun hide-ifdef-define (var val)
+ "Define a VAR, optionally to a specific value, so that #ifdef VAR
+would be included."
+ (interactive
+ (let* ((default (save-excursion
+ (beginning-of-line)
+ (cond ((looking-at hif-ifx-else-endif-regexp)
+ (forward-word 2)
+ (current-word 'strict))
+ (t
+ nil))))
+ (var (read-minibuffer "Define what? " default))
+ (val (read-from-minibuffer (format "Set %s to? (default 1): " var)
+ nil nil t nil "1")))
+ (list var val)))
+ (hif-set-var var (or val 1))
+ (message "%s set to %s" var (or val 1))
+ (sleep-for 1)
+ (if hide-ifdef-hiding (hide-ifdefs)))
+
+(defun hif-undefine-symbol (var)
+ (setq hide-ifdef-env
+ (delete (assoc var hide-ifdef-env) hide-ifdef-env)))
+
+;;(defun hide-ifdef-undef (var)
+;; "Undefine a VAR so that #ifdef VAR would not be included."
+;; (interactive "SUndefine what? ")
+;; ;;(hif-set-var var nil);;Luke fixed: set it nil is still considered defined so #ifdef VAR is still true.
+;; (hif-undefine-symbol var)
+;; (if hide-ifdef-hiding (hide-ifdefs)))
+
+(defun hide-ifdef-undef (start end)
"Undefine a VAR so that #ifdef VAR would not be included."
- (interactive "SUndefine what? ")
- (hif-set-var var nil)
- (if hide-ifdef-hiding (hide-ifdefs)))
-
+ (interactive "r")
+ (let* ((symstr
+ (or (and mark-active
+ (buffer-substring-no-properties start end))
+ (read-string "Undefine what? " (current-word))))
+ (sym (and symstr
+ (intern symstr))))
+ (if (zerop (hif-defined sym))
+ (message "`%s' not defined, no need to undefine it" symstr)
+ (hif-undefine-symbol sym)
+ (if hide-ifdef-hiding (hide-ifdefs))
+ (message "`%S' undefined" sym))))
(defun hide-ifdefs (&optional nomsg)
"Hide the contents of some #ifdefs.
Assume that defined symbols have been added to `hide-ifdef-env'.
The text hidden is the text that would not be included by the C
preprocessor if it were given the file with those symbols defined.
+If this command is prefixed, hide also the #ifdefs themselves.
Turn off hiding by calling `show-ifdefs'."
(interactive)
- (message "Hiding...")
- (setq hif-outside-read-only buffer-read-only)
- (unless hide-ifdef-mode (hide-ifdef-mode 1)) ; turn on hide-ifdef-mode
- (if hide-ifdef-hiding
- (show-ifdefs)) ; Otherwise, deep confusion.
- (setq hide-ifdef-hiding t)
- (hide-ifdef-guts)
- (setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only))
- (or nomsg
- (message "Hiding done")))
+ (let ((hide-ifdef-lines current-prefix-arg))
+ (or nomsg
+ (message "Hiding..."))
+ (setq hif-outside-read-only buffer-read-only)
+ (unless hide-ifdef-mode (hide-ifdef-mode 1)) ; turn on hide-ifdef-mode
+ (if hide-ifdef-hiding
+ (show-ifdefs)) ; Otherwise, deep confusion.
+ (setq hide-ifdef-hiding t)
+ (hide-ifdef-guts)
+ (setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only))
+ (or nomsg
+ (message "Hiding done"))))
(defun show-ifdefs ()
@@ -957,49 +1780,89 @@ Turn off hiding by calling `show-ifdefs'."
(defun hif-find-ifdef-block ()
"Utility for hide and show `ifdef-block'.
Return as (TOP . BOTTOM) the extent of ifdef block."
- (let (max-bottom)
- (cons (save-excursion
- (beginning-of-line)
- (unless (or (hif-looking-at-else) (hif-looking-at-ifX))
- (up-ifdef))
- (prog1 (point)
- (hif-ifdef-to-endif)
- (setq max-bottom (1- (point)))))
- (save-excursion
- (beginning-of-line)
- (unless (hif-looking-at-endif)
- (hif-find-next-relevant))
- (while (hif-looking-at-ifX)
- (hif-ifdef-to-endif)
- (hif-find-next-relevant))
- (min max-bottom (1- (point)))))))
-
-
-(defun hide-ifdef-block ()
- "Hide the ifdef block (true or false part) enclosing or before the cursor."
- (interactive)
- (unless hide-ifdef-mode (hide-ifdef-mode 1))
- (let ((top-bottom (hif-find-ifdef-block)))
- (hide-ifdef-region (car top-bottom) (cdr top-bottom))
- (when hide-ifdef-lines
- (hif-hide-line (car top-bottom))
- (hif-hide-line (1+ (cdr top-bottom))))
- (setq hide-ifdef-hiding t))
- (setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only)))
-
-(defun show-ifdef-block ()
+ (if (and (fboundp 'c-backward-conditional-with-else)
+ (fboundp 'c-forward-conditional-with-else))
+ ;;Use my modified functions in cc-mode.
+ (save-excursion
+ (cons
+ (progn
+ (if (= (line-number-at-pos)
+ (save-excursion
+ (beginning-of-line)
+ (re-search-forward hif-ifx-else-endif-regexp)
+ (line-number-at-pos)))
+ (beginning-of-line)
+ (c-backward-conditional-with-else 1))
+ (point))
+ (progn (c-forward-conditional-with-else 1) (1- (point)))))
+ ;; original implementation in hideif.el
+ (let (max-bottom)
+ (cons (save-excursion
+ (beginning-of-line)
+ (unless (or (hif-looking-at-else) (hif-looking-at-ifX))
+ (up-ifdef))
+ (prog1 (point)
+ (hif-ifdef-to-endif)
+ (setq max-bottom (1- (point)))))
+ (save-excursion
+ (beginning-of-line)
+ (unless (hif-looking-at-endif)
+ (hif-find-next-relevant))
+ (while (hif-looking-at-ifX)
+ (hif-ifdef-to-endif)
+ (hif-find-next-relevant))
+ (min max-bottom (1- (point))))))))
+
+(defun hide-ifdef-block (&optional start end)
+ "Hide the ifdef block (true or false part) enclosing or before the cursor.
+If prefixed, it will also hide #ifdefs themselves."
+ (interactive "r")
+ (let ((hide-ifdef-lines current-prefix-arg))
+ (if mark-active
+ (let ((hif-recurse-level (1+ hif-recurse-level)))
+ (hif-recurse-on start end t)
+ (setq mark-active nil))
+ (unless hide-ifdef-mode (hide-ifdef-mode 1))
+ (let ((top-bottom (hif-find-ifdef-block)))
+ (hide-ifdef-region (car top-bottom) (cdr top-bottom))
+ (when hide-ifdef-lines
+ (hif-hide-line (car top-bottom))
+ (hif-hide-line (1+ (cdr top-bottom))))
+ (setq hide-ifdef-hiding t))
+ (setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only)))))
+
+(defun show-ifdef-block (&optional start end)
"Show the ifdef block (true or false part) enclosing or before the cursor."
- (interactive)
- (let ((top-bottom (hif-find-ifdef-block)))
- (if hide-ifdef-lines
- (hif-show-ifdef-region
- (save-excursion
- (goto-char (car top-bottom)) (line-beginning-position))
- (save-excursion
- (goto-char (1+ (cdr top-bottom)))
- (hif-end-of-line) (point)))
- (hif-show-ifdef-region (1- (car top-bottom)) (cdr top-bottom)))))
-
+ (interactive "r")
+ (if mark-active
+ (progn
+ (dolist (o (overlays-in start end))
+ (if (overlay-get o 'hide-ifdef)
+ (delete-overlay o)))
+ (setq mark-active nil))
+ (let ((top-bottom (condition-case nil
+ (hif-find-ifdef-block)
+ (error
+ nil)))
+ (ovrs (overlays-in (max (point-min) (1- (point)))
+ (min (point-max) (1+ (point)))))
+ (del nil))
+ (if top-bottom
+ (if hide-ifdef-lines
+ (hif-show-ifdef-region
+ (save-excursion
+ (goto-char (car top-bottom)) (line-beginning-position))
+ (save-excursion
+ (goto-char (1+ (cdr top-bottom)))
+ (hif-end-of-line) (point)))
+ (setf del (hif-show-ifdef-region (1- (car top-bottom)) (cdr top-bottom)))))
+ (if (not (and top-bottom
+ del))
+ (dolist (o ovrs)
+ ;;(dolist (o (overlays-in (1- (point)) (1+ (point))))
+ ;; (if (overlay-get o 'hide-ifdef) (message "%S" o)))
+ (if (overlay-get o 'hide-ifdef)
+ (delete-overlay o)))))))
;;; definition alist support
@@ -1016,24 +1879,28 @@ Return as (TOP . BOTTOM) the extent of ifdef block."
"Set the association for NAME to `hide-ifdef-env'."
(interactive "SSet define list: ")
(push (cons name (hif-compress-define-list hide-ifdef-env))
- hide-ifdef-define-alist))
+ hide-ifdef-define-alist))
(defun hide-ifdef-use-define-alist (name)
"Set `hide-ifdef-env' to the define list specified by NAME."
(interactive
(list (completing-read "Use define list: "
- (mapcar (lambda (x) (symbol-name (car x)))
+ (mapcar (lambda (x) (symbol-name (car x)))
hide-ifdef-define-alist)
nil t)))
(if (stringp name) (setq name (intern name)))
(let ((define-list (assoc name hide-ifdef-define-alist)))
(if define-list
- (setq hide-ifdef-env
- (mapcar (lambda (arg) (cons arg t))
- (cdr define-list)))
+ (setq hide-ifdef-env
+ (mapcar (lambda (arg) (cons arg t))
+ (cdr define-list)))
(error "No define list for %s" name))
(if hide-ifdef-hiding (hide-ifdefs))))
(provide 'hideif)
+;; Local variables:
+;; byte-compile-warnings: (not cl-functions)
+;; End:
+
;;; hideif.el ends here
^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: Fwd: Update earlier posted hideif.el enhancements
2013-11-25 6:35 ` Fwd: " Luke Lee
@ 2013-11-29 21:59 ` Stefan Monnier
2013-12-03 4:33 ` Luke Lee
0 siblings, 1 reply; 11+ messages in thread
From: Stefan Monnier @ 2013-11-29 21:59 UTC (permalink / raw)
To: Luke Lee; +Cc: emacs-devel
> Sure, no problem. Attached is the patch against Emacs trunk.
Thanks. Came through unadulterated ;-)
> I'm using git://git.savannah.gnu.org/emacs.git as my Emacs remote
> source. I've checked the trunk, master and emacs-24 and they seems to
> have the identical hideif.el version so I think it should be okay to
> patch it.
Indeed, there's been no real development on it in recently. See my
comments below. Overall, I think it looks good and could be included in
hideif.el, but I'd appreciate if you could clean up a few things first
and split the change into a few chunks (this is a bit large to review as
one single chunk). IIUC one chunk would focus on extend the current
parser & evaluator to handle the full CPP syntax.
Stefan
> (if hide-ifdef-mode
> (progn
> ;; inherit global values
> - (set (make-local-variable 'hide-ifdef-env)
> - (default-value 'hide-ifdef-env))
> +;; (set (make-local-variable 'hide-ifdef-env) ;; [2012-09-27 11:05:26 +0800] Luke rem 2 ins 2
> +;; (default-value 'hide-ifdef-env))
> + (set 'hide-ifdef-env (default-value 'hide-ifdef-env))
> (set (make-local-variable 'hide-ifdef-hiding)
> (default-value 'hide-ifdef-hiding))
> (set (make-local-variable 'hif-outside-read-only) buffer-read-only)
I don't undertand this change. "(set '<foo> ...)" is just a bad form of
(setq <foo> ...) so use `setq' instead.
> +(defun merge-ifdef-region (start end)
This lacks the "hif-" or "hide-ifdef-" prefix.
> ;;;-----------------------------------------------------------------
> ;;; Translate C preprocessor #if expressions using recursive descent.
> ;;; This parser is limited to the operators &&, ||, !, and "defined".
> ;;; Added ==, !=, +, and -. Gary Oberbrunner, garyo@avs.com, 8/9/94
> +;;;
> +;;; Implement the C language operator precedence table. Add all those
> +;;; missing operators that could be used in macros. Luke Lee 2013-09-04
";;;" should be limited to headers. The pre-existing code is already at
fault, but we should fix the pre-existing code rather than repeating
its mistake.
> +;;; | Unary Operators | * & + - ! ~ ++expr --expr (typecast) sizeof | right-to-left |
Try really hard to stay within 80 columns, please.
> +(defun hif-expand-token-list (tokens &optional macroname reflist) ;; reference list to prevent self-referencing
Same here. Also, we like to capitalize our comments and terminate them
with full-stops.
BTW, maybe we could/should add some code to smie.el so as to not only
skip a expression but return a parse tree. Then we could use maybe it here.
> +(defun shiftleft (a b)
> +(defun shiftright (a b)
> +(defun flatten (l)
> +(defun delimit (l a)
Lack the "hif-" prefix.
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Fwd: Update earlier posted hideif.el enhancements
2013-11-29 21:59 ` Stefan Monnier
@ 2013-12-03 4:33 ` Luke Lee
2013-12-03 13:45 ` Stefan Monnier
0 siblings, 1 reply; 11+ messages in thread
From: Luke Lee @ 2013-12-03 4:33 UTC (permalink / raw)
To: Stefan Monnier; +Cc: emacs-devel
[-- Attachment #1.1: Type: text/plain, Size: 2634 bytes --]
>> ;; inherit global values
>> - (set (make-local-variable 'hide-ifdef-env)
>> - (default-value 'hide-ifdef-env))
>> +;; (set (make-local-variable 'hide-ifdef-env)
>> +;; (default-value 'hide-ifdef-env))
>> + (set 'hide-ifdef-env (default-value 'hide-ifdef-env))
>
>I don't undertand this change. "(set '<foo> ...)" is just a bad form of
>(setq <foo> ...) so use `setq' instead.
Umm, here I only comment out the "make-local-variable" for hide-ifdef-env.
Otherwise the defined tokens works only for that buffer. I would like it to
work for all currently openned buffers in a "project" based manner. The
"set"
form derived from the original code. And I think it follows the example help
page of 'make-variable-buffer-local'. Is that help page out-dated?
>Indeed, there's been no real development on it in recently. See my
>comments below. Overall, I think it looks good and could be included in
>hideif.el, but I'd appreciate if you could clean up a few things first
>and split the change into a few chunks (this is a bit large to review as
>one single chunk). IIUC one chunk would focus on extend the current
>parser & evaluator to handle the full CPP syntax.
>The remaining cleanups
The remaining cleanups are done. The original code that I derived from
contains a lot of ';;;' comments, I fixed most of them but left some since
they looks like to be placed on purpose to become a separator there.
To split the patch into some topic chunks is quite difficult now since it's
originally derived from a lot of commits in my local branch.
Even the core of my modification is rewritten twice. The first time I tried
is to store the parsing tree for each defined symbol so that there is no
need to reparse every time. However later I found it mandatory to restart
from token level since the token expansion sometimes re-ordered the
parse tree due to operator precedence. For example
#define EXPR(a,b) a * b
#define EXPR2 EXPR(c+d,e+f)
The final result of EXPR2 will become c+d*e+f where d*e must be
calculated first. If we keep the parsing tree it will become (c+d) * (e+f).
Although good programs should not have such kind of errors but if we're
implement hideif this way it will not help programmer to catch such kind of
hidden C programming bugs early. Especially when a lot of operators
mixed together with some parenthesis skipped.
Therefore it's extremely time consuming to cherry-pick among all those
changes and group them into several valid topic patches, sorry about that...
Attached is the cleanup patch add-on to my previously posted patch.
Thanks.
--
Best regards,
Luke Lee
[-- Attachment #1.2: Type: text/html, Size: 4835 bytes --]
[-- Attachment #2: hideif-cleanup.patch --]
[-- Type: application/octet-stream, Size: 17252 bytes --]
From 0fdb2dffa06d299d2c73d1a079c44e4c4f87fd8d Mon Sep 17 00:00:00 2001
From: Luke Lee <luke.yx.lee@gmail.com>
Date: Tue, 3 Dec 2013 12:31:04 +0800
Subject: [PATCH] Some cleanups for hideif.
---
lisp/progmodes/hideif.el | 201 ++++++++++++++++++++++-------------------------
1 file changed, 95 insertions(+), 106 deletions(-)
diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el
index b89d42f..e5a2a3d 100644
--- a/lisp/progmodes/hideif.el
+++ b/lisp/progmodes/hideif.el
@@ -142,14 +142,16 @@
:group 'hide-ifdef)
(defcustom hide-ifdef-expand-re-inclusion-protection t
- "When hiding header files, always expand the re-inclusion protecting ifdefs.
-Most header files are wrapped with ifdefs to prevent re-inclusion:
+ "When hiding header files, always expand the re-inclusion protected
+ifdefs. Most C/C++ header files are wrapped with ifdefs to prevent
+re-inclusion of this form
#ifdef _XXX_HEADER_FILE_INCLUDED_
#define _XXX_HEADER_FILE_INCLUDED_
...
#endif
-hence if we try to hide ifdefs, it will hide everything when we tried
-the second time since _XXX_HEADER_FILE_INCLUDED_ already defined."
+Hence, if we try to hide ifdefs in the header file, it will hide
+everything when we tried the second time,since _XXX_HEADER_FILE_INCLUDED_
+is defined at the first time that we hide it."
:type 'boolean
:group 'hide-ifdef)
@@ -320,7 +322,7 @@ Several variables affect how the hiding is done:
(while (= (logand 1 (skip-chars-backward "\\\\")) 1)
(end-of-line 2)))
-(defun merge-ifdef-region (start end)
+(defun hif-merge-ifdef-region (start end)
;; Genernally there is no need to call itself recursively since there should originally
;; exists no un-merged regions; however, if a part of the file is hidden with 'hide-ifdef-lines'
;; as nil while another part with 't, this case happens.
@@ -346,7 +348,7 @@ total number of overlays created."
(setq b (min start (overlay-start o))
e (max end (overlay-end o)))
(move-overlay o b e)
- (merge-ifdef-region b e)
+ (hif-merge-ifdef-region b e)
(setq ob o)))
;; merge overlays after 'end'
(dolist (o endovrs)
@@ -354,7 +356,7 @@ total number of overlays created."
(setq b (min start (overlay-start o))
e (max end (overlay-end o)))
(move-overlay o b e)
- (merge-ifdef-region b e)
+ (hif-merge-ifdef-region b e)
(setf oe o)))
;; if both 'start' 'end' merging happens, merge into bigger one
(when (and ob oe)
@@ -362,11 +364,11 @@ total number of overlays created."
(e (max (overlay-end ob) (overlay-end oe))))
(delete-overlay oe)
(move-overlay ob b e)
- (merge-ifdef-region b e)))
+ (hif-merge-ifdef-region b e)))
(or ob oe))))
(defun hide-ifdef-region-internal (start end)
- (unless (merge-ifdef-region start end)
+ (unless (hif-merge-ifdef-region start end)
(let ((o (make-overlay start end)))
(overlay-put o 'hide-ifdef t)
(if hide-ifdef-shadow
@@ -451,7 +453,6 @@ that form should be displayed.")
"\\(\\.\\.\\.\\)?" hif-white
")"
"\\)?" ))
-;;(defconst hif-header-regexp "^.*\\.[hH]\\([hH]\\|[xX][xX]\\|[pP][pP]\\)?")
;; Used to store the current token and the whole token list during parsing.
;; Only bound dynamically.
@@ -541,37 +542,39 @@ that form should be displayed.")
(t (error "Bad #if expression: %s" (buffer-string)))))))
(nreverse token-list)))
-;;;-----------------------------------------------------------------
-;;; Translate C preprocessor #if expressions using recursive descent.
-;;; This parser is limited to the operators &&, ||, !, and "defined".
-;;; Added ==, !=, +, and -. Gary Oberbrunner, garyo@avs.com, 8/9/94
-;;;
-;;; Implement the C language operator precedence table. Add all those
-;;; missing operators that could be used in macros. Luke Lee 2013-09-04
-
-;;; | Operator Type | Operator | Associativity |
-;;; +----------------------+---------------------------------------------+---------------+
-;;; | Primary Expression | () [] . -> expr++ expr-- | left-to-right |
-;;; | Unary Operators | * & + - ! ~ ++expr --expr (typecast) sizeof | right-to-left |
-;;; | Binary Operators | * / % | left-to-right |
-;;; | | + - | |
-;;; | | >> << | |
-;;; | | < > <= >= | |
-;;; | | == != | |
-;;; | | & | |
-;;; | | ^ | |
-;;; | | | | |
-;;; | | && | |
-;;; | | || | |
-;;; | Ternary Operator | ?: | right-to-left |
-;;; x| Assignment Operators | = += -= *= /= %= >>= <<= &= ^= = | right-to-left |
-;;; | Comma | , | left-to-right |
+;;------------------------------------------------------------------------
+;; Translate C preprocessor #if expressions using recursive descent.
+;; This parser is limited to the operators &&, ||, !, and "defined".
+;; Added ==, !=, +, and -. Gary Oberbrunner, garyo@avs.com, 8/9/94
+;;
+;; Implement the C language operator precedence table. Add all those
+;; missing operators that could be used in macros. Luke Lee 2013-09-04
+
+;; | Operator Type | Operator | Associativity |
+;; +----------------------+-----------------------------+---------------+
+;; | Primary Expression | () [] . -> expr++ expr-- | left-to-right |
+;; | Unary Operators | * & + - ! ~ ++expr --expr | right-to-left |
+;; | | (typecast) sizeof | |
+;; | Binary Operators | * / % | left-to-right |
+;; | | + - | |
+;; | | >> << | |
+;; | | < > <= >= | |
+;; | | == != | |
+;; | | & | |
+;; | | ^ | |
+;; | | | | |
+;; | | && | |
+;; | | || | |
+;; | Ternary Operator | ?: | right-to-left |
+;; x| Assignment Operators | = += -= *= /= %= >>= <<= &= | right-to-left |
+;; | | ^= = | |
+;; | Comma | , | left-to-right |
(defsubst hif-nexttoken ()
"Pop the next token from token-list into the let variable \"hif-token\"."
(setq hif-token (pop hif-token-list)))
-(defsubst if-valid-identifier (id)
+(defsubst hif-if-valid-identifier (id)
(not (or (numberp id)
(stringp id))))
@@ -590,19 +593,27 @@ that form should be displayed.")
(progn
(setq tok (cadr tokens))
(if (eq (car tokens) 'hif-lparen)
- (if (and (if-valid-identifier tok)
+ (if (and (hif-if-valid-identifier tok)
(eq (caddr tokens) 'hif-rparen))
(setq tokens (cdddr tokens))
(error "operator \"defined\" requires an identifier"))
(setq tok (car tokens)
tokens (cdr tokens))
- (unless (if-valid-identifier tok)
+ (unless (hif-if-valid-identifier tok)
(error "operator \"defined\" requires an identifier")))
(list 'hif-defined 'hif-lparen tok 'hif-rparen))
tok)))))
result))
-(defun hif-expand-token-list (tokens &optional macroname reflist) ;; reference list to prevent self-referencing
+(defun hif-flatten (l)
+ "Flatten a tree"
+ (if (and l (atom l))
+ (list l)
+ (if (consp l)
+ (nconc (hif-flatten (car l)) (hif-flatten (cdr l))))))
+
+(defun hif-expand-token-list (tokens &optional macroname reflist)
+ ;; 'reflist' is the reference list to prevent self-referencing
"Perform expansion till everything expanded. No self-reference expansion."
(catch 'self-referencing
(let ((expanded nil)
@@ -651,14 +662,15 @@ that form should be displayed.")
;; lookup tok returns an atom
(list rep)))
- ;;[2013-10-22 16:06:12 +0800] Must keep the token, removeing this token might results in a incomplete expression which cannot be parsed.
+ ;;[2013-10-22 16:06:12 +0800] Must keep the token, removeing this token might results in
+ ;; an incomplete expression that cannot be parsed further.
;;((= 1 (hif-defined tok)) ;; defined (hif-defined tok)=1, but empty (hif-lookup tok)=nil, thus remove this token
;; (setq remains (delete tok remains))
;; nil)
(t ;; usual IDs
(list tok))))))
- (flatten expanded))))
+ (hif-flatten expanded))))
(defun hif-parse-if-exp (token-list &optional macroname)
"Parse the TOKEN-LIST. Return translated list in prefix form."
@@ -670,22 +682,6 @@ that form should be displayed.")
(if hif-token ; is there still a token?
(error "Error: unexpected token: %s" hif-token)))))
-;;;
-;;;To manually test these functions, try the following in scratch buffer:
-;;;
-;;;(hif-find-define (point)) ;; find only one #define
-;;;(hif-add-new-defines) ;; find all #defines
-;;;
-;;;#define macro ( arg1 , arg2 , arg3 ... ) arg1 + arg2 * arg3
-;;;
-;;;(assoc 'macro hide-ifdef-env)
-;;;
-;;;(hif-canonicalize-tokens hif-ifx-regexp)
-;;;(hif-expand-token-list (hif-canonicalize-tokens hif-ifx-regexp))
-;;;(hif-canonicalize hif-ifx-regexp)
-;;;
-;;;#if macro( (a,2,3), b<<1, (c&7,d) )
-;;;
(defun hif-exprlist ()
"Parse an exprlist: expr { ',' expr}"
@@ -975,12 +971,12 @@ we ignore them all here."
,(format "Like `%s' but treat t and nil as 1 and 0." fun)
(,fun (hif-mathify a) (hif-mathify b))))
-(defun shiftleft (a b)
+(defun shiftleft-hif (a b)
(if (< a 0)
(ash a b)
(lsh a b)))
-(defun shiftright (a b)
+(defun shiftright-hif (a b)
(if (< a 0)
(ash a (- 0 b))
(lsh a (- 0 b))))
@@ -1000,8 +996,8 @@ we ignore them all here."
(defalias 'hif-logior (hif-mathify-binop logior))
(defalias 'hif-logxor (hif-mathify-binop logxor))
(defalias 'hif-logand (hif-mathify-binop logand))
-(defalias 'hif-shiftleft (hif-mathify-binop shiftleft))
-(defalias 'hif-shiftright (hif-mathify-binop shiftright))
+(defalias 'hif-shiftleft (hif-mathify-binop shiftleft-hif))
+(defalias 'hif-shiftright (hif-mathify-binop shiftright-hif))
(defun hif-comma (&rest expr)
@@ -1049,14 +1045,7 @@ we ignore them all here."
(append result (list prev))
result)))
-(defun flatten (l)
- "Flatten a tree"
- (if (and l (atom l))
- (list l)
- (if (consp l)
- (nconc (flatten (car l)) (flatten (cdr l))))))
-
-(defun delimit (l a)
+(defun hif-delimit (l a)
"Delmit a list 'l' with delimiter atom 'd'"
(nconc (mapcan (lambda (l)
(list l a)) (butlast l))
@@ -1109,12 +1098,12 @@ we ignore them all here."
;; Unlike 'subst', 'substitute' replace only the top level instead of the whole tree,
;; more importantly, it's not destructive.
(if (and etc (null formal-parms))
- (substitute (delimit actual-parms 'hif-comma) formal macro-body)
+ (substitute (hif-delimit actual-parms 'hif-comma) formal macro-body)
(substitute (car actual-parms) formal macro-body)))
(setq actual-parms (cdr actual-parms)))
;; Replacement completed, flatten the whole token list,
- (setq macro-body (flatten macro-body))
+ (setq macro-body (hif-flatten macro-body))
;; Stringification and token concatenation happens here
(hif-token-concatenation (hif-token-stringification macro-body)))))
@@ -1324,11 +1313,11 @@ With argument, do this that many times."
;;===%%SF%% hide-ifdef-hiding (Start) ===
-;;; A range is a structure with four components:
-;;; START The start of the range. (beginning of line)
-;;; ELSE The else marker (beginning of line)
-;;; END The end of the range. (beginning of line)
-;;; ELIF A sequence of #elif markers (beginning of line)
+;; A range is a structure with four components:
+;; START The start of the range. (beginning of line)
+;; ELSE The else marker (beginning of line)
+;; END The end of the range. (beginning of line)
+;; ELIF A sequence of #elif markers (beginning of line)
(defsubst hif-make-range (start end &optional else elif)
(list start else end elif))
@@ -1339,10 +1328,10 @@ With argument, do this that many times."
(defsubst hif-range-elif (range) (elt range 3))
-;;; Find-Range
-;;; The workhorse, it delimits the #if region. Reasonably simple:
-;;; Skip until an #else or #endif is found, remembering positions. If
-;;; an #else was found, skip some more, looking for the true #endif.
+;; Find-Range
+;; The workhorse, it delimits the #if region. Reasonably simple:
+;; Skip until an #else or #endif is found, remembering positions. If
+;; an #else was found, skip some more, looking for the true #endif.
(defun hif-find-range ()
"Return a Range structure describing the current #if region.
@@ -1380,7 +1369,7 @@ Point is left unchanged."
(hif-make-range start end else elif))))
-;;; A bit slimy.
+;; A bit slimy.
(defun hif-hide-line (point)
"Hide the line containing point. Does nothing if `hide-ifdef-lines' is nil."
@@ -1391,31 +1380,31 @@ Point is left unchanged."
(line-beginning-position) (progn (hif-end-of-line) (point))))))
-;;; Hif-Possibly-Hide
-;;; There are four cases. The #ifX expression is "taken" if it
-;;; the hide-ifdef-evaluator returns T. Presumably, this means the code
-;;; inside the #ifdef would be included when the program was
-;;; compiled.
-;;;
-;;; Case 1: #ifX taken, and there's an #else.
-;;; The #else part must be hidden. The #if (then) part must be
-;;; processed for nested #ifX's.
-;;; Case 2: #ifX taken, and there's no #else.
-;;; The #if part must be processed for nested #ifX's.
-;;; Case 3: #ifX not taken, and there's an #elif
-;;; The #if part must be hidden, and then evaluate
-;;; the #elif condition like a new #ifX.
-;;; Case 4: #ifX not taken, and there's just an #else.
-;;; The #if part must be hidden. The #else part must be processed
-;;; for nested #ifs.
-;;; Case 5: #ifX not taken, and there's no #else.
-;;; The #ifX part must be hidden.
-;;;
-;;; Further processing is done by narrowing to the relevant region
-;;; and just recursively calling hide-ifdef-guts.
-;;;
-;;; When hif-possibly-hide returns, point is at the end of the
-;;; possibly-hidden range.
+;; Hif-Possibly-Hide
+;; There are four cases. The #ifX expression is "taken" if it
+;; the hide-ifdef-evaluator returns T. Presumably, this means the code
+;; inside the #ifdef would be included when the program was
+;; compiled.
+;;
+;; Case 1: #ifX taken, and there's an #else.
+;; The #else part must be hidden. The #if (then) part must be
+;; processed for nested #ifX's.
+;; Case 2: #ifX taken, and there's no #else.
+;; The #if part must be processed for nested #ifX's.
+;; Case 3: #ifX not taken, and there's an #elif
+;; The #if part must be hidden, and then evaluate
+;; the #elif condition like a new #ifX.
+;; Case 4: #ifX not taken, and there's just an #else.
+;; The #if part must be hidden. The #else part must be processed
+;; for nested #ifs.
+;; Case 5: #ifX not taken, and there's no #else.
+;; The #ifX part must be hidden.
+;;
+;; Further processing is done by narrowing to the relevant region
+;; and just recursively calling hide-ifdef-guts.
+;;
+;; When hif-possibly-hide returns, point is at the end of the
+;; possibly-hidden range.
(defvar hif-recurse-level 0)
--
1.8.3.24.g67b0998
^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: Fwd: Update earlier posted hideif.el enhancements
2013-12-03 4:33 ` Luke Lee
@ 2013-12-03 13:45 ` Stefan Monnier
2013-12-04 2:06 ` Luke Lee
0 siblings, 1 reply; 11+ messages in thread
From: Stefan Monnier @ 2013-12-03 13:45 UTC (permalink / raw)
To: Luke Lee; +Cc: emacs-devel
> Umm, here I only comment out the "make-local-variable" for hide-ifdef-env.
> Otherwise the defined tokens works only for that buffer. I would like it to
> work for all currently openned buffers in a "project" based manner.
Hmm... I see.
Affecting the value globally would also affect buffers that are
unrelated. Sadly we don't really have an easy way currently to talk
about project-wide settings.
I guess we should use the CEDET infrastructure for that (which would
also make it possible to scan files which aren't currently visited).
But I guess for now we can try your "quick&dirty" solution of making the
settings global.
> The "set" form derived from the original code.
Ah, right. Then just replace "(set 'hide-ifdef-env" with "(setq
hide-ifdef-env". It's just a stylistic issue.
>> Indeed, there's been no real development on it in recently. See my
>> comments below. Overall, I think it looks good and could be included in
>> hideif.el, but I'd appreciate if you could clean up a few things first
>> and split the change into a few chunks (this is a bit large to review as
>> one single chunk). IIUC one chunk would focus on extend the current
>> parser & evaluator to handle the full CPP syntax.
>> The remaining cleanups
> The remaining cleanups are done. The original code that I derived from
> contains a lot of ';;;' comments, I fixed most of them but left some since
> they looks like to be placed on purpose to become a separator there.
Thanks. Fixing the pre-existing issues is gravy. The main part is
to not make it worse ;-)
> Therefore it's extremely time consuming to cherry-pick among all those
> changes and group them into several valid topic patches, sorry about that...
I'm not asking you to cherry pick commits. Instead you should take your
current code (call it "target") and remove "all but the parsing-related
modifications", for example (I usually do that with "C-x v d" then C-u
C-c C-a to undo the hunks that are not related, plus manual changes for
those hunks which contain both changes I want to keep and changes I want
to remove). That gives you a first patch to send. Then you diff the
result with your "target code" and remove "all but something else".
This does not use the commit history. Instead it kind of "creates
a brand new and clean history".
Stefan
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Fwd: Update earlier posted hideif.el enhancements
2013-12-03 13:45 ` Stefan Monnier
@ 2013-12-04 2:06 ` Luke Lee
2013-12-04 15:28 ` Luke Lee
0 siblings, 1 reply; 11+ messages in thread
From: Luke Lee @ 2013-12-04 2:06 UTC (permalink / raw)
To: Stefan Monnier; +Cc: emacs-devel
[-- Attachment #1: Type: text/plain, Size: 1560 bytes --]
>I guess we should use the CEDET infrastructure for that (which would
>also make it possible to scan files which aren't currently visited).
Indeed, I tried CEDET for several years but it always have problems here
or there. After I patch this, that failed.. My embedded system C++ code
contains some non-standard extensions that always causing CEDET
fail so I decide to go hideif solution since it's much smaller :-) and does
not that much rely on the previous parsing contexts to continue parsing.
>But I guess for now we can try your "quick&dirty" solution of making the
>settings global.
I got no better idea but providing one more custom option for that.
Personally I always open different Emacs for different projects with
each its own local session/desktop/... settings; while leaving emacs
server for other general purpose use.
>This does not use the commit history. Instead it kind of "creates
>a brand new and clean history".
I see. After some thoughts it's still worthwhile even if I do the
cherry-picking
since I've been troubled by those kind of complicate nested #if..#endif
for years and I believe a lot others should have similar problems too.
By the way, what "certification" (sorry that I can't think of a better
word)
is required to be able to commit code directly into the main Emacs
repository (or a branch)? I'm currently working on auto *.h scanning
for hideif.el in my spare time. Maybe there will be more updates some
weeks/months later.
I'll send out two or three patches when I completed the splitting.
Best regards,
Luke Lee
[-- Attachment #2: Type: text/html, Size: 5967 bytes --]
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: Fwd: Update earlier posted hideif.el enhancements
2013-12-04 2:06 ` Luke Lee
@ 2013-12-04 15:28 ` Luke Lee
2013-12-04 17:33 ` Stefan Monnier
0 siblings, 1 reply; 11+ messages in thread
From: Luke Lee @ 2013-12-04 15:28 UTC (permalink / raw)
To: Stefan Monnier; +Cc: emacs-devel
[-- Attachment #1.1: Type: text/plain, Size: 468 bytes --]
Whew! Finally I create 4 featured patches for hideif. I tried to make each
of
the patch standalone and feature complete but I can't guarantee that.
Attached are those 4 patches. Please apply the patches according to the
numeric order from 0001~0004.The only guarantee is that hideif.el can still
be compiled into .elc file without error when each patch is applied (in
order
0001~0004).These 4 patches are created using "git format-patch".
--
Best regards,
Luke Lee
[-- Attachment #1.2: Type: text/html, Size: 671 bytes --]
[-- Attachment #2: 0001-Aggregate-hideif-parser-enhancements-for-a-complete-.patch --]
[-- Type: application/octet-stream, Size: 15292 bytes --]
From 3cf95473e30d8a302d85ec4f42ef5d504d42f484 Mon Sep 17 00:00:00 2001
From: Luke Lee <luke.yx.lee@gmail.com>
Date: Wed, 4 Dec 2013 14:15:56 +0800
Subject: [PATCH 1/4] Aggregate hideif parser enhancements for a complete
supporting of C/C++ expressions and operator precedence.
---
lisp/progmodes/hideif.el | 238 +++++++++++++++++++++++++++++++++++++++--------
1 file changed, 199 insertions(+), 39 deletions(-)
diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el
index e264682..cbee895 100644
--- a/lisp/progmodes/hideif.el
+++ b/lisp/progmodes/hideif.el
@@ -35,9 +35,9 @@
;; M-x hide-ifdefs or C-c @ h
;;
;; Hide-ifdef suppresses the display of code that the preprocessor wouldn't
-;; pass through. The support of constant expressions in #if lines is
-;; limited to identifiers, parens, and the operators: &&, ||, !, and
-;; "defined". Please extend this.
+;; pass through. Support complete C/C++ expression and precedence.
+;; It will automatically scans for new #define symbols and macros on the way
+;; parsing.
;;
;; The hidden code is marked by ellipses (...). Be
;; cautious when editing near ellipses, since the hidden text is
@@ -97,6 +97,9 @@
;;
;; Written by Brian Marick, at Gould, Computer Systems Division, Urbana IL.
;; Extensively modified by Daniel LaLiberte (while at Gould).
+;;
+;; Extensively modified by Luke Lee in 2013 to support complete C expression
+;; evaluation and argumented macro expansion.
;;; Code:
@@ -355,43 +358,65 @@ that form should be displayed.")
;;; The code that understands what ifs and ifdef in files look like.
(defconst hif-cpp-prefix "\\(^\\|\r\\)[ \t]*#[ \t]*")
+(defconst hif-ifxdef-regexp (concat hif-cpp-prefix "if\\(n\\)?def"))
(defconst hif-ifndef-regexp (concat hif-cpp-prefix "ifndef"))
(defconst hif-ifx-regexp (concat hif-cpp-prefix "if\\(n?def\\)?[ \t]+"))
+(defconst hif-elif-regexp (concat hif-cpp-prefix "elif"))
(defconst hif-else-regexp (concat hif-cpp-prefix "else"))
(defconst hif-endif-regexp (concat hif-cpp-prefix "endif"))
(defconst hif-ifx-else-endif-regexp
(concat hif-ifx-regexp "\\|" hif-else-regexp "\\|" hif-endif-regexp))
+(defconst hif-white "[ \t]*")
+
;; Used to store the current token and the whole token list during parsing.
;; Only bound dynamically.
(defvar hif-token)
(defvar hif-token-list)
(defconst hif-token-alist
- '(("||" . or)
- ("&&" . and)
+ '(("||" . hif-or)
+ ("&&" . hif-and)
("|" . hif-logior)
+ ("^" . hif-logxor)
("&" . hif-logand)
- ("==" . equal)
+ ("<<" . hif-shiftleft)
+ (">>" . hif-shiftright)
+ ("==" . hif-equal)
+ ("=" . hif-assign)
("!=" . hif-notequal)
- ("!" . not)
- ("(" . lparen)
- (")" . rparen)
+ ("##" . hif-token-concat)
+ ("!" . hif-not)
+ ("~" . hif-lognot)
+ ("(" . hif-lparen)
+ (")" . hif-rparen)
(">" . hif-greater)
("<" . hif-less)
(">=" . hif-greater-equal)
("<=" . hif-less-equal)
("+" . hif-plus)
("-" . hif-minus)
+ ("*" . hif-multiply)
+ ("/" . hif-divide)
+ ("%" . hif-modulo)
("?" . hif-conditional)
(":" . hif-colon)))
(defconst hif-token-regexp
- (concat (regexp-opt (mapcar 'car hif-token-alist)) "\\|\\w+"))
+ (concat (regexp-opt (mapcar 'car hif-token-alist))
+ "\\|0x[0-9a-fA-F]+\\.?[0-9a-fA-F]*"
+ "\\|[0-9]+\\.?[0-9]*" ;; decimal/octal
+ "\\|\\w+"))
+
+(defconst hif-string-literal-regexp
+ (concat hif-white "\\(\"[^\"]*\"\\)"))
+
+(defvar hif-simple-token-only nil)
(defun hif-tokenize (start end)
"Separate string between START and END into a list of tokens."
(let ((token-list nil))
+ (setq hif-simple-token-only t)
(with-syntax-table hide-ifdef-syntax-table
(save-excursion
(goto-char start)
@@ -401,23 +426,54 @@ that form should be displayed.")
((looking-at "\\\\\n")
(forward-char 2))
+ ((looking-at hif-string-literal-regexp)
+ (push (substring-no-properties (match-string 1)) token-list)
+ (goto-char (match-end 0)))
((looking-at hif-token-regexp)
(let ((token (buffer-substring (point) (match-end 0))))
(goto-char (match-end 0))
;; (message "token: %s" token) (sit-for 1)
(push (or (cdr (assoc token hif-token-alist))
(if (string-equal token "defined") 'hif-defined)
- (if (string-match "\\`[0-9]*\\'" token)
- (string-to-number token))
- (intern token))
+ (if (string-match "0x\\([a-fA-F0-9]+\\)" token)
+ (string-to-number (match-string 1 token) 16)) ;; hexadecimal
+ (if (string-match "\\`0[0-9]*\\(\\.[0-9]+\\)?\\'" token)
+ (string-to-number token 8)) ;; octal
+ (if (string-match "\\`[1-9][0-9]*\\(\\.[0-9]+\\)?\\'" token)
+ (string-to-number token)) ;; decimal
+ (prog1 (intern token)
+ (setq hif-simple-token-only nil)))
token-list)))
(t (error "Bad #if expression: %s" (buffer-string)))))))
(nreverse token-list)))
-;;;-----------------------------------------------------------------
-;;; Translate C preprocessor #if expressions using recursive descent.
-;;; This parser is limited to the operators &&, ||, !, and "defined".
-;;; Added ==, !=, +, and -. Gary Oberbrunner, garyo@avs.com, 8/9/94
+;;------------------------------------------------------------------------
+;; Translate C preprocessor #if expressions using recursive descent.
+;; This parser is limited to the operators &&, ||, !, and "defined".
+;; Added ==, !=, +, and -. Gary Oberbrunner, garyo@avs.com, 8/9/94
+;;
+;; Implement the C language operator precedence table. Add all those
+;; missing operators that could be used in macros. Luke Lee 2013-09-04
+
+;; | Operator Type | Operator | Associativity |
+;; +----------------------+-----------------------------+---------------+
+;; | Primary Expression | () [] . -> expr++ expr-- | left-to-right |
+;; | Unary Operators | * & + - ! ~ ++expr --expr | right-to-left |
+;; | | (typecast) sizeof | |
+;; | Binary Operators | * / % | left-to-right |
+;; | | + - | |
+;; | | >> << | |
+;; | | < > <= >= | |
+;; | | == != | |
+;; | | & | |
+;; | | ^ | |
+;; | | | | |
+;; | | && | |
+;; | | || | |
+;; | Ternary Operator | ?: | right-to-left |
+;; x| Assignment Operators | = += -= *= /= %= >>= <<= &= | right-to-left |
+;; | | ^= = | |
+;; | Comma | , | left-to-right |
(defsubst hif-nexttoken ()
"Pop the next token from token-list into the let variable \"hif-token\"."
@@ -428,10 +484,26 @@ that form should be displayed.")
(let ((hif-token-list token-list))
(hif-nexttoken)
(prog1
- (hif-expr)
+ (and hif-token
+ (hif-exprlist))
(if hif-token ; is there still a token?
(error "Error: unexpected token: %s" hif-token)))))
+
+(defun hif-exprlist ()
+ "Parse an exprlist: expr { ',' expr}"
+ (let ((result (hif-expr))
+ comma)
+ (while (eq hif-token 'hif-comma)
+ (unless comma
+ (setq result (list result)))
+ (setq comma t)
+ (hif-nexttoken)
+ (setq result (append result (list (hif-expr)))))
+ (if comma
+ (append (list 'hif-comma) result)
+ result)))
+
(defun hif-expr ()
"Parse an expression as found in #if.
expr : or-expr | or-expr '?' expr ':' expr."
@@ -448,67 +520,125 @@ that form should be displayed.")
result))
(defun hif-or-expr ()
- "Parse n or-expr : and-expr | or-expr '||' and-expr."
+ "Parse an or-expr : and-expr | or-expr '||' and-expr."
(let ((result (hif-and-expr)))
- (while (eq hif-token 'or)
+ (while (eq hif-token 'hif-or)
(hif-nexttoken)
(setq result (list 'hif-or result (hif-and-expr))))
result))
(defun hif-and-expr ()
- "Parse an and-expr : eq-expr | and-expr '&&' eq-expr."
+ "Parse an and-expr : logior-expr | and-expr '&&' logior-expr."
+ (let ((result (hif-logior-expr)))
+ (while (eq hif-token 'hif-and)
+ (hif-nexttoken)
+ (setq result (list 'hif-and result (hif-logior-expr))))
+ result))
+
+(defun hif-logior-expr ()
+ "Parse a logor-expr : logxor-expr | logor-expr '|' logxor-expr."
+ (let ((result (hif-logxor-expr)))
+ (while (eq hif-token 'hif-logior)
+ (hif-nexttoken)
+ (setq result (list 'hif-logior result (hif-logxor-expr))))
+ result))
+
+(defun hif-logxor-expr ()
+ "Parse a logxor-expr : logand-expr | logxor-expr '^' logand-expr."
+ (let ((result (hif-logand-expr)))
+ (while (eq hif-token 'hif-logxor)
+ (hif-nexttoken)
+ (setq result (list 'hif-logxor result (hif-logand-expr))))
+ result))
+
+(defun hif-logand-expr ()
+ "Parse a logand-expr : eq-expr | logand-expr '&' eq-expr."
(let ((result (hif-eq-expr)))
- (while (eq hif-token 'and)
+ (while (eq hif-token 'hif-logand)
(hif-nexttoken)
- (setq result (list 'hif-and result (hif-eq-expr))))
+ (setq result (list 'hif-logand result (hif-eq-expr))))
result))
(defun hif-eq-expr ()
- "Parse an eq-expr : math | eq-expr `=='|`!='|`<'|`>'|`>='|`<=' math."
- (let ((result (hif-math))
+ "Parse an eq-expr : comp | eq-expr `=='|`!=' comp."
+ (let ((result (hif-comp-expr))
(eq-token nil))
- (while (memq hif-token '(equal hif-notequal hif-greater hif-less
- hif-greater-equal hif-less-equal))
+ (while (memq hif-token '(hif-equal hif-notequal))
(setq eq-token hif-token)
(hif-nexttoken)
- (setq result (list eq-token result (hif-math))))
+ (setq result (list eq-token result (hif-comp-expr))))
+ result))
+
+(defun hif-comp-expr ()
+ "Parse a comp-expr : logshift | comp-expr `<'|`>'|`>='|`<=' logshift."
+ (let ((result (hif-logshift-expr))
+ (comp-token nil))
+ (while (memq hif-token '(hif-greater hif-less hif-greater-equal hif-less-equal))
+ (setq comp-token hif-token)
+ (hif-nexttoken)
+ (setq result (list comp-token result (hif-logshift-expr))))
+ result))
+
+(defun hif-logshift-expr ()
+ "Parse a logshift : math | logshift `<<'|`>>' math."
+ (let ((result (hif-math))
+ (shift-token nil))
+ (while (memq hif-token '(hif-shiftleft hif-shiftright))
+ (setq shift-token hif-token)
+ (hif-nexttoken)
+ (setq result (list shift-token result (hif-math))))
result))
(defun hif-math ()
- "Parse an expression with + or - and simpler things.
- math : factor | math '+|-' factor."
+ "Parse an expression with + or -.
+ math : muldiv | math '+|-' muldiv."
+ (let ((result (hif-muldiv-expr))
+ (math-op nil))
+ (while (memq hif-token '(hif-plus hif-minus))
+ (setq math-op hif-token)
+ (hif-nexttoken)
+ (setq result (list math-op result (hif-muldiv-expr))))
+ result))
+
+(defun hif-muldiv-expr ()
+ "Parse an expression with *,/,%.
+ muldiv : factor | muldiv '*|/|%' factor."
(let ((result (hif-factor))
(math-op nil))
- (while (memq hif-token '(hif-plus hif-minus hif-logior hif-logand))
+ (while (memq hif-token '(hif-multiply hif-divide hif-modulo))
(setq math-op hif-token)
(hif-nexttoken)
(setq result (list math-op result (hif-factor))))
result))
(defun hif-factor ()
- "Parse a factor: '!' factor | '(' expr ')' | 'defined(' id ')' | id."
+ "Parse a factor: '!' factor | '~' factor | '(' expr ')' | 'defined(' id ')' | 'id(parmlist)' | strings | id."
(cond
- ((eq hif-token 'not)
+ ((eq hif-token 'hif-not)
(hif-nexttoken)
(list 'hif-not (hif-factor)))
- ((eq hif-token 'lparen)
+ ((eq hif-token 'hif-lognot)
(hif-nexttoken)
- (let ((result (hif-expr)))
- (if (not (eq hif-token 'rparen))
+ (list 'hif-lognot (hif-factor)))
+
+ ((eq hif-token 'hif-lparen)
+ (hif-nexttoken)
+ (let ((result (hif-exprlist)))
+ (if (not (eq hif-token 'hif-rparen))
(error "Bad token in parenthesized expression: %s" hif-token)
(hif-nexttoken)
result)))
((eq hif-token 'hif-defined)
(hif-nexttoken)
- (let ((paren (when (eq hif-token 'lparen) (hif-nexttoken) t))
+ (let ((paren (when (eq hif-token 'hif-lparen) (hif-nexttoken) t))
(ident hif-token))
- (if (memq hif-token '(or and not hif-defined lparen rparen))
+ (if (memq hif-token '(or and not hif-defined hif-lparen hif-rparen))
(error "Error: unexpected token: %s" hif-token))
(when paren
(hif-nexttoken)
- (unless (eq hif-token 'rparen)
+ (unless (eq hif-token 'hif-rparen)
(error "Error: expected \")\" after identifier")))
(hif-nexttoken)
`(hif-defined (quote ,ident))))
@@ -541,21 +671,51 @@ that form should be displayed.")
(or (not (zerop (hif-mathify a))) (not (zerop (hif-mathify b)))))
(defun hif-not (a)
(zerop (hif-mathify a)))
+(defun hif-lognot (a)
+ (lognot a))
(defmacro hif-mathify-binop (fun)
`(lambda (a b)
,(format "Like `%s' but treat t and nil as 1 and 0." fun)
(,fun (hif-mathify a) (hif-mathify b))))
+(defun shiftleft-hif (a b)
+ (if (< a 0)
+ (ash a b)
+ (lsh a b)))
+
+(defun shiftright-hif (a b)
+ (if (< a 0)
+ (ash a (- 0 b))
+ (lsh a (- 0 b))))
+
+
+(defalias 'hif-multiply (hif-mathify-binop *))
+(defalias 'hif-divide (hif-mathify-binop /))
+(defalias 'hif-modulo (hif-mathify-binop %))
(defalias 'hif-plus (hif-mathify-binop +))
(defalias 'hif-minus (hif-mathify-binop -))
+(defalias 'hif-equal (hif-mathify-binop =))
(defalias 'hif-notequal (hif-mathify-binop /=))
(defalias 'hif-greater (hif-mathify-binop >))
(defalias 'hif-less (hif-mathify-binop <))
(defalias 'hif-greater-equal (hif-mathify-binop >=))
(defalias 'hif-less-equal (hif-mathify-binop <=))
(defalias 'hif-logior (hif-mathify-binop logior))
+(defalias 'hif-logxor (hif-mathify-binop logxor))
(defalias 'hif-logand (hif-mathify-binop logand))
+(defalias 'hif-shiftleft (hif-mathify-binop shiftleft-hif))
+(defalias 'hif-shiftright (hif-mathify-binop shiftright-hif))
+
+
+(defun hif-comma (&rest expr)
+ "Evaluate a list of expr, return the result of the last item"
+ (let ((result nil))
+ (dolist (e expr)
+ (ignore-errors
+ (setq result (funcall hide-ifdef-evaluator e))))
+ result))
+
;;;----------- end of parser -----------------------
--
1.8.3.24.g67b0998
[-- Attachment #3: 0002-Aggregate-enhancements-for-hideif-macro-expansion.patch --]
[-- Type: application/octet-stream, Size: 24705 bytes --]
From 38d37e865359435d59196b894c36e87d5883fbe0 Mon Sep 17 00:00:00 2001
From: Luke Lee <luke.yx.lee@gmail.com>
Date: Wed, 4 Dec 2013 15:15:41 +0800
Subject: [PATCH 2/4] Aggregate enhancements for hideif macro expansion.
* Supporting argumented macro expansion.
* Stringification, tokenization and concatenation of strings and tokens.
* Add functions to find defines and parse argumented macros into a macro tree
containing macro name, formal parameters and macro body.
* Later macro expansion time it will be applied by actual parameters and then
got expanded recursively.
---
lisp/progmodes/hideif.el | 454 ++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 431 insertions(+), 23 deletions(-)
diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el
index cbee895..c53036b 100644
--- a/lisp/progmodes/hideif.el
+++ b/lisp/progmodes/hideif.el
@@ -104,6 +104,7 @@
;;; Code:
(require 'cc-mode)
+(eval-when-compile (require 'cl))
(defgroup hide-ifdef nil
"Hide selected code within `ifdef'."
@@ -135,6 +136,10 @@
:group 'hide-ifdef
:version "23.1")
+(defcustom hide-ifdef-exclude-define-regexp-pattern nil
+ "Ignore #define name if that name match this exclusion pattern."
+ :type 'string
+ :group 'hide-ifdef)
(defvar hide-ifdef-mode-submap
;; Set up the submap that goes after the prefix key.
@@ -365,9 +370,20 @@ that form should be displayed.")
(defconst hif-else-regexp (concat hif-cpp-prefix "else"))
(defconst hif-endif-regexp (concat hif-cpp-prefix "endif"))
(defconst hif-ifx-else-endif-regexp
- (concat hif-ifx-regexp "\\|" hif-else-regexp "\\|" hif-endif-regexp))
+ (concat hif-ifx-regexp "\\|" hif-elif-regexp "\\|" hif-else-regexp "\\|" hif-endif-regexp))
+(defconst hif-macro-expr-prefix-regexp (concat hif-cpp-prefix "\\(if\\(n?def\\)?\\|elif\\|define\\)[ \t]+"))
(defconst hif-white "[ \t]*")
+(defconst hif-define (concat hif-cpp-prefix "\\(define\\|undef\\)"))
+(defconst hif-id (concat "[A-Za-z_][0-9A-Za-z_]*"))
+(defconst hif-macroname (concat hif-white "\\(" hif-id "\\)" hif-white
+ "\\("
+ "(" hif-white
+ "\\(" hif-id "\\)?" hif-white
+ "\\(" "," hif-white hif-id hif-white "\\)*"
+ "\\(\\.\\.\\.\\)?" hif-white
+ ")"
+ "\\)?" ))
;; Used to store the current token and the whole token list during parsing.
;; Only bound dynamically.
@@ -400,7 +416,12 @@ that form should be displayed.")
("/" . hif-divide)
("%" . hif-modulo)
("?" . hif-conditional)
- (":" . hif-colon)))
+ (":" . hif-colon)
+ ("," . hif-comma)
+ ("#" . hif-stringify)
+ ("..." . hif-etc)))
+
+(defconst hif-valid-token-list (mapcar 'cdr hif-token-alist))
(defconst hif-token-regexp
(concat (regexp-opt (mapcar 'car hif-token-alist))
@@ -430,7 +451,7 @@ that form should be displayed.")
(push (substring-no-properties (match-string 1)) token-list)
(goto-char (match-end 0)))
((looking-at hif-token-regexp)
- (let ((token (buffer-substring (point) (match-end 0))))
+ (let ((token (buffer-substring-no-properties (point) (match-end 0))))
(goto-char (match-end 0))
;; (message "token: %s" token) (sit-for 1)
(push (or (cdr (assoc token hif-token-alist))
@@ -479,9 +500,107 @@ that form should be displayed.")
"Pop the next token from token-list into the let variable \"hif-token\"."
(setq hif-token (pop hif-token-list)))
-(defun hif-parse-if-exp (token-list)
+(defsubst hif-if-valid-identifier (id)
+ (not (or (numberp id)
+ (stringp id))))
+
+(defun hif-define-operator (tokens)
+ "`Upgrade' hif-define xxx to '(hif-define xxx)' so that it won't be subsitituted"
+ (let ((result nil)
+ (tok nil))
+ (while tokens
+ (setq tok (car tokens)
+ tokens (cdr tokens))
+ (setq result
+ (append
+ result
+ (list
+ (if (eq tok 'hif-defined)
+ (progn
+ (setq tok (cadr tokens))
+ (if (eq (car tokens) 'hif-lparen)
+ (if (and (hif-if-valid-identifier tok)
+ (eq (caddr tokens) 'hif-rparen))
+ (setq tokens (cdddr tokens))
+ (error "operator \"defined\" requires an identifier"))
+ (setq tok (car tokens)
+ tokens (cdr tokens))
+ (unless (hif-if-valid-identifier tok)
+ (error "operator \"defined\" requires an identifier")))
+ (list 'hif-defined 'hif-lparen tok 'hif-rparen))
+ tok)))))
+ result))
+
+(defun hif-flatten (l)
+ "Flatten a tree"
+ (if (and l (atom l))
+ (list l)
+ (if (consp l)
+ (nconc (hif-flatten (car l)) (hif-flatten (cdr l))))))
+
+(defun hif-expand-token-list (tokens &optional macroname reflist)
+ ;; 'reflist' is the reference list to prevent self-referencing
+ "Perform expansion till everything expanded. No self-reference expansion."
+ (catch 'self-referencing
+ (let ((expanded nil)
+ (remains (hif-define-operator
+ (hif-token-concatenation (hif-token-stringification tokens))))
+ tok rep)
+ (if macroname
+ (setq reflist (cons macroname reflist)))
+ ;; Expanding all tokens till list exhausted
+ (while remains
+ (setq tok (car remains)
+ remains (cdr remains))
+ (if (memq tok reflist) ;; for self-referencing tokens, don't expand it
+ (throw 'self-referencing tokens))
+ (setq expanded
+ (append
+ expanded
+ (cond
+ ((or (memq tok hif-valid-token-list)
+ (numberp tok)
+ (stringp tok))
+ (list tok))
+
+ ((setq rep (hif-lookup tok))
+ (if (and (listp rep)
+ (eq (car rep) 'hif-define-macro)) ;; a defined macro
+ ;; recursively expand it
+ (if (cadr rep) ;; arglist is not nil
+ (if (eq (car remains) 'hif-lparen)
+ ;; Argumented macro, get arguments and invoke it
+ (let* ((hif-token-list (cdr remains)) ;; dynamic binding for hif-macro-supply-arguments
+ (hif-token nil) ;; dynamic binding for hif-macro-supply-arguments
+ (parmlist (mapcar 'hif-expand-token-list
+ (hif-get-argument-list tok)))
+ (result (hif-expand-token-list (hif-macro-supply-arguments tok parmlist)
+ tok reflist)))
+ (setq remains (cons hif-token hif-token-list))
+ result)
+ ;; no argument supplied, no invocation for this macro
+ (list tok))
+ ;; arglist is nil, direct expansion
+ (setq rep (hif-expand-token-list (caddr rep) ;; macro's token list
+ tok reflist))
+ (setq remains (substitute tok rep remains)) ;; replace all remaining references immediately
+ (list rep))
+ ;; lookup tok returns an atom
+ (list rep)))
+
+ ;;[2013-10-22 16:06:12 +0800] Must keep the token, removeing this token might results in
+ ;; an incomplete expression that cannot be parsed further.
+ ;;((= 1 (hif-defined tok)) ;; defined (hif-defined tok)=1, but empty (hif-lookup tok)=nil, thus remove this token
+ ;; (setq remains (delete tok remains))
+ ;; nil)
+
+ (t ;; usual IDs
+ (list tok))))))
+ (hif-flatten expanded))))
+
+(defun hif-parse-if-exp (token-list &optional macroname)
"Parse the TOKEN-LIST. Return translated list in prefix form."
- (let ((hif-token-list token-list))
+ (let ((hif-token-list (hif-expand-token-list token-list macroname)))
(hif-nexttoken)
(prog1
(and hif-token
@@ -645,6 +764,8 @@ that form should be displayed.")
((numberp hif-token)
(prog1 hif-token (hif-nexttoken)))
+ ((stringp hif-token)
+ (hif-string-concatenation))
;; Unary plus/minus.
((memq hif-token '(hif-minus hif-plus))
@@ -652,10 +773,105 @@ that form should be displayed.")
(t ; identifier
(let ((ident hif-token))
- (if (memq ident '(or and))
- (error "Error: missing identifier"))
(hif-nexttoken)
- `(hif-lookup (quote ,ident))))))
+ (if (eq hif-token 'hif-lparen)
+ (hif-place-macro-invocation ident)
+ `(hif-lookup (quote ,ident)))))))
+
+(defun hif-get-argument-list (ident)
+ (let ((nest 0)
+ (parmlist nil) ;; a "token" list of parameters, will later be parsed
+ (parm nil))
+ (while (or (not (eq (hif-nexttoken) 'hif-rparen))
+ (/= nest 0))
+ (if (eq (car parm) 'hif-comma)
+ (setq parm nil))
+ (cond
+ ((eq hif-token 'hif-lparen)
+ (setq nest (1+ nest)))
+ ((eq hif-token 'hif-rparen)
+ (setq nest (1- nest))
+ (if (< nest 0)
+ (error "Unbalanced parenthesis when invoking macro %S" ident)))
+ ((and (eq hif-token 'hif-comma)
+ (= nest 0))
+ (setq parmlist (append parmlist (list parm))
+ parm nil)))
+ (setq parm (append parm (list hif-token))))
+ (setq parmlist (append parmlist (list parm))) ; okay even if parm is nil
+ (hif-nexttoken) ; drop the hif-rparen, get next token
+ parmlist))
+
+(defun hif-place-macro-invocation (ident)
+ (let ((parmlist (hif-get-argument-list ident)))
+ `(hif-invoke (quote ,ident) (quote ,parmlist))))
+
+(defun hif-string-concatenation ()
+ "Parse concatenated strings: string | strings string"
+ (let ((result (substring-no-properties hif-token)))
+ (while (stringp (hif-nexttoken))
+ (setq result (concat
+ (substring result 0 -1) ; remove trailing '"'
+ (substring hif-token 1)))) ; remove leading '"'
+ result))
+
+(defun hif-define-macro (parmlist token-body)
+ "A marker for defined macro with arguments, cannot be evaluated alone with no parameters inputed."
+ ;; TODO: input parameters at run time, use minibuffer to query all parameters
+ (error "Argumented macro cannot be evaluated without passing any parameter."))
+
+(defun hif-stringify (a)
+ "Stringify a number, string or symbol"
+ (cond
+ ((numberp a)
+ (number-to-string a))
+ ((atom a)
+ (symbol-name a))
+ ((stringp a)
+ (concat "\"" a "\""))
+ (t
+ (error "Invalid token to stringify"))))
+
+(defun intern-safe (str)
+ (if (stringp str)
+ (intern str)))
+
+(defun hif-merge-operator-token (a b)
+ "Support weird (but valid) use of token concatenation. Here we take care only those that can be evaluated during
+preprocessing time. For those computable syntax that can only be evaluated during C runtime (like '++','--','+='...),
+we ignore them all here."
+ (cond
+ ((and (eq a 'hif-logior) (eq b 'hif-logior)) ;; '|''|' -> '||'
+ 'hif-or)
+ ((and (eq a 'hif-logand) (eq b 'hif-logand)) ;; '&''&' -> '&&'
+ 'hif-and)
+ ((and (eq a 'hif-assign) (eq b 'hif-assign)) ;; '=''=' -> '=='
+ 'hif-equal)
+ ((and (eq a 'hif-not) (eq b 'hif-assign)) ;; '!''=' -> '!='
+ 'hif-notequal)
+ ((eq a 'hif-less)
+ (if (eq b 'hif-less) ;; '<''<' -> '<<'
+ 'hif-shiftleft
+ (if (eq b 'hif-assign) ;; '<''=' -> '<='
+ 'hif-less-equal)))
+ ((eq a 'hif-greater)
+ (if (eq b 'hif-greater) ;; '>''>' -> '>>'
+ 'hif-shiftleft
+ (if (eq b 'hif-assign) ;; '>''=' -> '>='
+ 'hif-greater-equal)))))
+
+(defun hif-token-concat (a b)
+ "Concatenation two symbol name into a longer symbol, currently support only simple symbol concatenation."
+ (if (or (memq a hif-valid-token-list)
+ (memq b hif-valid-token-list))
+ (let ((result (hif-merge-operator-token a b)))
+ (or result
+ ;;(error "Invalid token to concatenate")
+ (error "pasting \"%s\" and \"%s\" does not give a valid preprocessing token"
+ (if (memq a hif-valid-token-list) (car (rassoc a hif-token-alist)) (symbol-name a))
+ (if (memq b hif-valid-token-list) (car (rassoc b hif-token-alist)) (symbol-name b)))))
+ (intern-safe (concat (hif-stringify a)
+ (hif-stringify b)))))
(defun hif-mathify (val)
"Treat VAL as a number: if it's t or nil, use 1 or 0."
@@ -716,23 +932,149 @@ that form should be displayed.")
(setq result (funcall hide-ifdef-evaluator e))))
result))
+(defun hif-token-stringification (l)
+ "Scan token list for 'hif-stringify' ('#') token and stringify the next token"
+ (let (result)
+ (while l
+ (setq result
+ (append result
+ (list
+ (if (eq (car l) 'hif-stringify)
+ (prog1
+ (if (cadr l)
+ (hif-stringify (cadr l))
+ (error "No token to stringify"))
+ (setq l (cdr l)))
+ (car l)))))
+ (setq l (cdr l)))
+ result))
+
+(defun hif-token-concatenation (l)
+ "Scan token list for 'hif-token-concat' ('##') token and concatenate two tokens"
+ (let ((prev nil)
+ result)
+ (while l
+ (while (eq (car l) 'hif-token-concat)
+ (unless prev
+ (error "No token before ## to concatenate"))
+ (unless (cdr l)
+ (error "No token after ## to concatenate"))
+ (setq prev (hif-token-concat prev (cadr l)))
+ (setq l (cddr l)))
+ (if prev
+ (setq result (append result (list prev))))
+ (setq prev (car l)
+ l (cdr l)))
+ (if prev
+ (append result (list prev))
+ result)))
+
+(defun hif-delimit (l a)
+ "Delmit a list 'l' with delimiter atom 'd'"
+ (nconc (mapcan (lambda (l)
+ (list l a)) (butlast l))
+ (last l)))
+
+;; Perform token replacement:
+(defun hif-macro-supply-arguments (macro-name actual-parms)
+ "Expand a macro function, replace 'actual-parms' to the function body."
+ (let* ((SA (assoc macro-name hide-ifdef-env))
+ (macro (and SA
+ (cdr SA)
+ (eq (cadr SA) 'hif-define-macro)
+ (cddr SA)))
+ (formal-parms (and macro (car macro)))
+ (macro-body (and macro (cadr macro)))
+ (hide-ifdef-local-env nil) ;; dynamic binding local table
+ actual-count
+ formal-count
+ actual
+ formal
+ etc)
+
+ (when (and actual-parms formal-parms macro-body)
+ ;; For each actual parameter, evaluate each one and associate it
+ ;; with the associated actual parameter, put it into local table and finally
+ ;; evaluate the macro body.
+ (if (setq etc (eq (car formal-parms) 'hif-etc)) ;; Take care of 'hif-etc first. Prefix 'hif-comma back if needed.
+ (setq formal-parms (cdr formal-parms)))
+ (setq formal-count (length formal-parms)
+ actual-count (length actual-parms))
+
+ (if (> formal-count actual-count)
+ (error "Too few parmameter for macro %S" macro-name)
+ (if (< formal-count actual-count)
+ (or etc
+ (error "Too many parameters for macro %S" macro-name))))
+
+ ;; Perform token replacement on the macro-body on the parameters
+ (while (setq formal (car formal-parms))
+ (setq formal-parms (cdr formal-parms))
+ ;; Prevent repettative substitutation, thus cannot use 'subst'
+ ;; for example:
+ ;; #define mac(a,b) (a+b)
+ ;; #define testmac mac(b,y)
+ ;; testmac should expand to (b+y): replace of argument a and b occurs simultaneously
+ ;; not sequentially. If this occurs sequentially according to the argument order,
+ ;; it will become: 1. formal parm #1 'a' replaced by actual parm 'b', thus (a+b) becomes (b+b)
+ ;; 2. formal parm #2 'b' replaced by actual parm 'y', thus (b+b) becomes (y+y).
+ (setq macro-body
+ ;; Unlike 'subst', 'substitute' replace only the top level instead of the whole tree,
+ ;; more importantly, it's not destructive.
+ (if (and etc (null formal-parms))
+ (substitute (hif-delimit actual-parms 'hif-comma) formal macro-body)
+ (substitute (car actual-parms) formal macro-body)))
+ (setq actual-parms (cdr actual-parms)))
+
+ ;; Replacement completed, flatten the whole token list,
+ (setq macro-body (hif-flatten macro-body))
+
+ ;; Stringification and token concatenation happens here
+ (hif-token-concatenation (hif-token-stringification macro-body)))))
+
+(defun hif-invoke (macro-name actual-parms)
+ "Invoke a macro by first expanding it, then reparse the macro-body, finally invoke the macro."
+ ;; Reparse the macro body and evaluate it
+ (funcall hide-ifdef-evaluator
+ (hif-parse-if-exp
+ (hif-macro-supply-arguments macro-name actual-parms)
+ macro-name)))
;;;----------- end of parser -----------------------
-(defun hif-canonicalize ()
- "When at beginning of #ifX, return a Lisp expression for its condition."
+(defun hif-canonicalize-tokens (regexp) ;; for debugging
+ "Return the expanded result of the scanned tokens."
(save-excursion
- (let ((negate (looking-at hif-ifndef-regexp)))
- (re-search-forward hif-ifx-regexp)
+ (re-search-forward regexp)
+ (let* ((curr-regexp (match-string 0))
+ (defined (string-match hif-ifxdef-regexp curr-regexp))
+ (negate (and defined
+ (string= (match-string 2 curr-regexp) "n"))))
(let* ((tokens (hif-tokenize (point)
- (progn (hif-end-of-line) (point))))
- (expr (hif-parse-if-exp tokens)))
- ;; (message "hif-canonicalized: %s" expr)
+ (progn (hif-end-of-line) (point)))))
+ (if defined
+ (setq tokens (list 'hif-defined tokens)))
(if negate
- (list 'hif-not expr)
- expr)))))
+ (setq tokens (list 'hif-not tokens)))
+ tokens))))
+(defun hif-canonicalize (regexp)
+ "When at beginning of `regexp' (i.e. #ifX), return a Lisp expression for its condition."
+ (let ((case-fold-search nil))
+ (save-excursion
+ (re-search-forward regexp)
+ (let* ((curr-regexp (match-string 0))
+ (defined (string-match hif-ifxdef-regexp curr-regexp))
+ (negate (and defined
+ (string= (match-string 2 curr-regexp) "n")))
+ (tokens (hif-tokenize (point)
+ (progn (hif-end-of-line) (point)))))
+ (if defined
+ (setq tokens (list 'hif-defined tokens)))
+ (if negate
+ (setq tokens (list 'hif-not tokens)))
+ (hif-parse-if-exp tokens)))))
(defun hif-find-any-ifX ()
"Move to next #if..., or #ifndef, at point or after."
@@ -991,7 +1333,7 @@ Point is left unchanged."
"Called at #ifX expression, this hides those parts that should be hidden.
It uses the judgment of `hide-ifdef-evaluator'."
;; (message "hif-possibly-hide") (sit-for 1)
- (let ((test (hif-canonicalize))
+ (let ((test (hif-canonicalize hif-ifx-regexp))
(range (hif-find-range)))
;; (message "test = %s" test) (sit-for 1)
@@ -1019,6 +1361,65 @@ It uses the judgment of `hide-ifdef-evaluator'."
(goto-char (hif-range-end range))
(end-of-line)))
+(defun hif-parse-macro-arglist (str)
+ "Parse argument list formatted as '( arg1 [ , argn] [...] )', includeing the '...'
+Return a list of the arguments, if '...' exists the first arg will be hif-etc."
+ (let ((tokenlist (cdr (hif-tokenize (- (point) (length str)) (point)))) ; remove hif-lparen
+ result token)
+ (while (not (eq (setq token (car tokenlist)) 'hif-rparen))
+ (setq tokenlist (cdr tokenlist))
+ (cond
+ ((eq token 'hif-etc)
+ (setq result (cons 'hif-etc result)))
+ ((eq token 'hif-comma)
+ t)
+ (t
+ (setq result (append result (cons token nil))))))
+ result))
+
+(defun hif-find-define (&optional min max)
+ (interactive)
+ (and min (goto-char min))
+ (and (re-search-forward hif-define max t)
+ (or
+ (let* ((defining (string= "define" (match-string 2)))
+ (name (and (re-search-forward hif-macroname max t)
+ (match-string 1)))
+ (parsed nil)
+ (parmlist (and (match-string 3) ;; first arg id found
+ (hif-parse-macro-arglist (match-string 2)))))
+ (if defining
+ ;; ignore name (still need to return 't), or define the name
+ (or (and hide-ifdef-exclude-define-regexp-pattern
+ (string-match hide-ifdef-exclude-define-regexp-pattern name))
+
+ (let* ((start (point))
+ (end (progn (hif-end-of-line) (point)))
+ (tokens (and name
+ (condition-case nil ;; prevent C statement things like 'do { ... } while (0)'
+ (hif-tokenize start end)
+ (error ;; we can't just return nil since this will stop searching for the remaining #defines.
+ (setq hif-simple-token-only t)
+ (buffer-substring-no-properties start end)))))
+ ;; For simple token we save only the parsed result;
+ ;; or we save the tokens, parse it after parameter replacement
+ (expr (and tokens
+ (or (and hif-simple-token-only
+ (listp tokens)
+ (= (length tokens) 1)
+ (hif-parse-if-exp tokens))
+ `(hif-define-macro ,parmlist ,tokens))))
+ (SA (and name
+ (assoc (intern name) hide-ifdef-env))))
+ (and name
+ (if SA
+ (or (setcdr SA expr) t) ;; Lazy evaluation, eval only if hif-lookup find it
+ ;; define it anyway, even if nil it's still in list and therefore considerred defined
+ (push (cons (intern name) expr) hide-ifdef-env)))))
+ ;; #undef
+ (and name
+ (hif-undefine-symbol (intern name))))))
+ t))
(defun hide-ifdef-guts ()
@@ -1078,12 +1479,16 @@ It does not do the work that's pointless to redo on a recursive entry."
(hif-set-var var 1)
(if hide-ifdef-hiding (hide-ifdefs)))
-(defun hide-ifdef-undef (var)
- "Undefine a VAR so that #ifdef VAR would not be included."
- (interactive "SUndefine what? ")
- (hif-set-var var nil)
- (if hide-ifdef-hiding (hide-ifdefs)))
+(defun hif-undefine-symbol (var)
+ (setq hide-ifdef-env
+ (delete (assoc var hide-ifdef-env) hide-ifdef-env)))
+;;(defun hide-ifdef-undef (var)
+;; "Undefine a VAR so that #ifdef VAR would not be included."
+;; (interactive "SUndefine what? ")
+;; ;;(hif-set-var var nil);;Luke fixed: set it nil is still considered defined so #ifdef VAR is still true.
+;; (hif-undefine-symbol var)
+;; (if hide-ifdef-hiding (hide-ifdefs)))
(defun hide-ifdefs (&optional nomsg)
"Hide the contents of some #ifdefs.
@@ -1195,5 +1600,8 @@ Return as (TOP . BOTTOM) the extent of ifdef block."
(if hide-ifdef-hiding (hide-ifdefs))))
(provide 'hideif)
+;; Local variables:
+;; byte-compile-warnings: (not cl-functions)
+;; End:
;;; hideif.el ends here
--
1.8.3.24.g67b0998
[-- Attachment #4: 0003-Other-hideif-enhancements-and-bug-fixes.patch --]
[-- Type: application/octet-stream, Size: 28765 bytes --]
From 05d5993d81bab1bea15ff89741e01fc4632c586f Mon Sep 17 00:00:00 2001
From: Luke Lee <luke.yx.lee@gmail.com>
Date: Wed, 4 Dec 2013 15:39:58 +0800
Subject: [PATCH 3/4] Other hideif enhancements and bug fixes:
* Add macro evaluation function and key binding.
* Automatic search for defines on hiding.
* Merge continuous "..." into one.
* Fix original bug that sometimes fail to hide the correct portion in a long
ifdefs containing elif and else.
* Support hide/show commands in a marked region.
* Expand top level for .h files to prevent re-inclusion protection.
* Others.
---
lisp/progmodes/hideif.el | 455 ++++++++++++++++++++++++++++++++++++++---------
1 file changed, 368 insertions(+), 87 deletions(-)
diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el
index c53036b..01edfb4 100644
--- a/lisp/progmodes/hideif.el
+++ b/lisp/progmodes/hideif.el
@@ -140,6 +140,24 @@
"Ignore #define name if that name match this exclusion pattern."
:type 'string
:group 'hide-ifdef)
+(defcustom hide-ifdef-expand-re-inclusion-protection t
+ "When hiding header files, always expand the re-inclusion protected
+ifdefs. Most C/C++ header files are wrapped with ifdefs to prevent
+re-inclusion of this form
+ #ifdef _XXX_HEADER_FILE_INCLUDED_
+ #define _XXX_HEADER_FILE_INCLUDED_
+ ...
+ #endif
+Hence, if we try to hide ifdefs in the header file, it will hide
+everything when we tried the second time,since _XXX_HEADER_FILE_INCLUDED_
+is defined at the first time that we hide it."
+ :type 'boolean
+ :group 'hide-ifdef)
+
+(defcustom hide-ifdef-header-regexp-pattern "^.*\\.[hH]\\([hH]\\|[xX][xX]\\|[pP][pP]\\)?"
+ "C/C++ header file name patterns. Effective only if 'hide-ifdef-expand-re-inclusion-protection' is t."
+ :type 'string
+ :group 'hide-ifdef)
(defvar hide-ifdef-mode-submap
;; Set up the submap that goes after the prefix key.
@@ -153,6 +171,7 @@
(define-key map "s" 'show-ifdefs)
(define-key map "\C-d" 'hide-ifdef-block)
(define-key map "\C-s" 'show-ifdef-block)
+ (define-key map "e" 'hif-evaluate-macro)
(define-key map "\C-q" 'hide-ifdef-toggle-read-only)
(define-key map "\C-w" 'hide-ifdef-toggle-shadowing)
@@ -260,8 +279,9 @@ Several variables affect how the hiding is done:
(if hide-ifdef-mode
(progn
;; inherit global values
- (set (make-local-variable 'hide-ifdef-env)
- (default-value 'hide-ifdef-env))
+;; (set (make-local-variable 'hide-ifdef-env) ;; [2012-09-27 11:05:26 +0800] Luke rem 2 ins 2
+;; (default-value 'hide-ifdef-env))
+ (set 'hide-ifdef-env (default-value 'hide-ifdef-env))
(set (make-local-variable 'hide-ifdef-hiding)
(default-value 'hide-ifdef-hiding))
(set (make-local-variable 'hif-outside-read-only) buffer-read-only)
@@ -298,17 +318,61 @@ Several variables affect how the hiding is done:
(end-of-line)
(while (= (logand 1 (skip-chars-backward "\\\\")) 1)
(end-of-line 2)))
+(defun hif-merge-ifdef-region (start end)
+ ;; Genernally there is no need to call itself recursively since there should originally
+ ;; exists no un-merged regions; however, if a part of the file is hidden with 'hide-ifdef-lines'
+ ;; as nil while another part with 't, this case happens.
+ ;; TODO: should we merge? or just create a container overlay? -- this can prevent hideif-show-ifdef
+ ;; expand too many since there is only a big overlay exists there without any smaller overlays.
+ "Merge nearby ifdef regions to form a bigger overlay. This will decrease the
+total number of overlays created."
+ (save-restriction
+ (widen) ;; otherwise (point-min) and (point-max) will be
+ ;; restricted and thus fail to find neighbor overlays
+ (let ((begovrs (overlays-in
+ (max (- start 2) (point-min))
+ (max (- start 1) (point-min))))
+ (endovrs (overlays-in
+ (min (+ end 1) (point-max))
+ (min (+ end 2) (point-max))))
+ (ob nil)
+ (oe nil)
+ b e)
+ ;; merge overlays before 'start'
+ (dolist (o begovrs)
+ (when (overlay-get o 'hide-ifdef)
+ (setq b (min start (overlay-start o))
+ e (max end (overlay-end o)))
+ (move-overlay o b e)
+ (hif-merge-ifdef-region b e)
+ (setq ob o)))
+ ;; merge overlays after 'end'
+ (dolist (o endovrs)
+ (when (overlay-get o 'hide-ifdef)
+ (setq b (min start (overlay-start o))
+ e (max end (overlay-end o)))
+ (move-overlay o b e)
+ (hif-merge-ifdef-region b e)
+ (setf oe o)))
+ ;; if both 'start' 'end' merging happens, merge into bigger one
+ (when (and ob oe)
+ (let ((b (min (overlay-start ob) (overlay-start oe)))
+ (e (max (overlay-end ob) (overlay-end oe))))
+ (delete-overlay oe)
+ (move-overlay ob b e)
+ (hif-merge-ifdef-region b e)))
+ (or ob oe))))
(defun hide-ifdef-region-internal (start end)
- (remove-overlays start end 'hide-ifdef t)
+ (unless (hif-merge-ifdef-region start end)
(let ((o (make-overlay start end)))
(overlay-put o 'hide-ifdef t)
(if hide-ifdef-shadow
(overlay-put o 'face 'hide-ifdef-shadow)
- (overlay-put o 'invisible 'hide-ifdef))))
+ (overlay-put o 'invisible 'hide-ifdef)))))
(defun hide-ifdef-region (start end)
- "START is the start of a #if or #else form. END is the ending part.
+ "START is the start of a #if, #elif, or #else form. END is the ending part.
Everything including these lines is made invisible."
(save-excursion
(goto-char start) (hif-end-of-line) (setq start (point))
@@ -317,7 +381,9 @@ Everything including these lines is made invisible."
(defun hif-show-ifdef-region (start end)
"Everything between START and END is made visible."
- (remove-overlays start end 'hide-ifdef t))
+ (let ((onum (length (overlays-in start end))))
+ (remove-overlays start end 'hide-ifdef t)
+ (/= onum (length (overlays-in start end)))))
;;===%%SF%% evaluation (Start) ===
@@ -465,6 +531,8 @@ that form should be displayed.")
(prog1 (intern token)
(setq hif-simple-token-only nil)))
token-list)))
+ ((looking-at "\r") ;; sometimes Windows user will leave CR in the source code
+ (forward-char 1)) ;; let's don't stuck here.
(t (error "Bad #if expression: %s" (buffer-string)))))))
(nreverse token-list)))
@@ -1085,7 +1153,7 @@ we ignore them all here."
(defun hif-find-next-relevant ()
- "Move to next #if..., #else, or #endif, after the current line."
+ "Move to next #if..., #elif..., #else, or #endif, after the current line."
;; (message "hif-find-next-relevant at %d" (point))
(end-of-line)
;; avoid infinite recursion by only going to beginning of line if match found
@@ -1108,15 +1176,19 @@ we ignore them all here."
(defun hif-looking-at-else ()
(looking-at hif-else-regexp))
+(defun hif-looking-at-elif ()
+ (looking-at hif-elif-regexp))
(defun hif-ifdef-to-endif ()
- "If positioned at #ifX or #else form, skip to corresponding #endif."
+ "If positioned at #ifX, #elif, or #else form, skip to corresponding #endif."
;; (message "hif-ifdef-to-endif at %d" (point)) (sit-for 1)
(hif-find-next-relevant)
(cond ((hif-looking-at-ifX)
(hif-ifdef-to-endif) ; find endif of nested if
(hif-ifdef-to-endif)) ; find outer endif or else
+ ((hif-looking-at-elif)
+ (hif-ifdef-to-endif))
((hif-looking-at-else)
(hif-ifdef-to-endif)) ; find endif following else
((hif-looking-at-endif)
@@ -1135,11 +1207,14 @@ we ignore them all here."
(cond ((hif-looking-at-endif)
(hif-endif-to-ifdef) ; find beginning of nested if
(hif-endif-to-ifdef)) ; find beginning of outer if or else
+ ((hif-looking-at-elif)
+ (hif-endif-to-ifdef))
((hif-looking-at-else)
(hif-endif-to-ifdef))
((hif-looking-at-ifX)
'done)
- (t))) ; never gets here
+ (t
+ (error "Mismatched #endif")))) ; never gets here
(defun forward-ifdef (&optional arg)
@@ -1233,26 +1308,26 @@ With argument, do this that many times."
;;===%%SF%% hide-ifdef-hiding (Start) ===
-;;; A range is a structure with four components:
-;;; ELSE-P True if there was an else clause for the ifdef.
-;;; START The start of the range. (beginning of line)
-;;; ELSE The else marker (beginning of line)
-;;; Only valid if ELSE-P is true.
-;;; END The end of the range. (beginning of line)
+;; A range is a structure with four components:
+;; START The start of the range. (beginning of line)
+;; ELSE The else marker (beginning of line)
+;; END The end of the range. (beginning of line)
+;; ELIF A sequence of #elif markers (beginning of line)
-(defsubst hif-make-range (start end &optional else)
- (list start else end))
+(defsubst hif-make-range (start end &optional else elif)
+ (list start else end elif))
(defsubst hif-range-start (range) (elt range 0))
(defsubst hif-range-else (range) (elt range 1))
(defsubst hif-range-end (range) (elt range 2))
+(defsubst hif-range-elif (range) (elt range 3))
-;;; Find-Range
-;;; The workhorse, it delimits the #if region. Reasonably simple:
-;;; Skip until an #else or #endif is found, remembering positions. If
-;;; an #else was found, skip some more, looking for the true #endif.
+;; Find-Range
+;; The workhorse, it delimits the #if region. Reasonably simple:
+;; Skip until an #else or #endif is found, remembering positions. If
+;; an #else was found, skip some more, looking for the true #endif.
(defun hif-find-range ()
"Return a Range structure describing the current #if region.
@@ -1261,19 +1336,23 @@ Point is left unchanged."
(save-excursion
(beginning-of-line)
(let ((start (point))
+ (elif nil)
(else nil)
(end nil))
- ;; Part one. Look for either #endif or #else.
+ ;; Part one. Look for either #elif, #else or #endif.
;; This loop-and-a-half dedicated to E. Dijkstra.
+ (while (and (not else) (not end))
(while (progn
(hif-find-next-relevant)
(hif-looking-at-ifX)) ; Skip nested ifdef
(hif-ifdef-to-endif))
- ;; Found either a #else or an #endif.
- (cond ((hif-looking-at-else)
+ ;; Found either a #else, #elif, or an #endif.
+ (cond ((hif-looking-at-elif)
+ (setq elif (nconc elif (list (point)))))
+ ((hif-looking-at-else)
(setq else (point)))
(t
- (setq end (point)))) ; (line-end-position)
+ (setq end (point)))))
;; If found #else, look for #endif.
(when else
(while (progn
@@ -1283,10 +1362,10 @@ Point is left unchanged."
(if (hif-looking-at-else)
(error "Found two elses in a row? Broken!"))
(setq end (point))) ; (line-end-position)
- (hif-make-range start end else))))
+ (hif-make-range start end else elif))))
-;;; A bit slimy.
+;; A bit slimy.
(defun hif-hide-line (point)
"Hide the line containing point. Does nothing if `hide-ifdef-lines' is nil."
@@ -1297,69 +1376,172 @@ Point is left unchanged."
(line-beginning-position) (progn (hif-end-of-line) (point))))))
-;;; Hif-Possibly-Hide
-;;; There are four cases. The #ifX expression is "taken" if it
-;;; the hide-ifdef-evaluator returns T. Presumably, this means the code
-;;; inside the #ifdef would be included when the program was
-;;; compiled.
-;;;
-;;; Case 1: #ifX taken, and there's an #else.
-;;; The #else part must be hidden. The #if (then) part must be
-;;; processed for nested #ifX's.
-;;; Case 2: #ifX taken, and there's no #else.
-;;; The #if part must be processed for nested #ifX's.
-;;; Case 3: #ifX not taken, and there's an #else.
-;;; The #if part must be hidden. The #else part must be processed
-;;; for nested #ifs.
-;;; Case 4: #ifX not taken, and there's no #else.
-;;; The #ifX part must be hidden.
-;;;
-;;; Further processing is done by narrowing to the relevant region
-;;; and just recursively calling hide-ifdef-guts.
-;;;
-;;; When hif-possibly-hide returns, point is at the end of the
-;;; possibly-hidden range.
-
-(defun hif-recurse-on (start end)
+;; Hif-Possibly-Hide
+;; There are four cases. The #ifX expression is "taken" if it
+;; the hide-ifdef-evaluator returns T. Presumably, this means the code
+;; inside the #ifdef would be included when the program was
+;; compiled.
+;;
+;; Case 1: #ifX taken, and there's an #else.
+;; The #else part must be hidden. The #if (then) part must be
+;; processed for nested #ifX's.
+;; Case 2: #ifX taken, and there's no #else.
+;; The #if part must be processed for nested #ifX's.
+;; Case 3: #ifX not taken, and there's an #elif
+;; The #if part must be hidden, and then evaluate
+;; the #elif condition like a new #ifX.
+;; Case 4: #ifX not taken, and there's just an #else.
+;; The #if part must be hidden. The #else part must be processed
+;; for nested #ifs.
+;; Case 5: #ifX not taken, and there's no #else.
+;; The #ifX part must be hidden.
+;;
+;; Further processing is done by narrowing to the relevant region
+;; and just recursively calling hide-ifdef-guts.
+;;
+;; When hif-possibly-hide returns, point is at the end of the
+;; possibly-hidden range.
+
+(defvar hif-recurse-level 0)
+
+(defun hif-recurse-on (start end &optional dont-go-eol)
"Call `hide-ifdef-guts' after narrowing to end of START line and END line."
(save-excursion
(save-restriction
(goto-char start)
- (end-of-line)
+ (unless dont-go-eol
+ (end-of-line))
(narrow-to-region (point) end)
- (hide-ifdef-guts))))
+ (let ((hif-recurse-level (1+ hif-recurse-level)))
+ (hide-ifdef-guts)))))
-(defun hif-possibly-hide ()
+(defun hif-possibly-hide (expand-reinclusion)
"Called at #ifX expression, this hides those parts that should be hidden.
It uses the judgment of `hide-ifdef-evaluator'."
;; (message "hif-possibly-hide") (sit-for 1)
- (let ((test (hif-canonicalize hif-ifx-regexp))
- (range (hif-find-range)))
+ (let* ((case-fold-search nil)
+ (test (hif-canonicalize hif-ifx-regexp))
+ (range (hif-find-range))
+ (elifs (hif-range-elif range))
+ (if-part t) ;; everytime we start from if-part
+ (complete nil))
;; (message "test = %s" test) (sit-for 1)
(hif-hide-line (hif-range-end range))
- (if (not (hif-not (funcall hide-ifdef-evaluator test)))
- (cond ((hif-range-else range) ; case 1
+ (while (not complete)
+ (if (and (not (and expand-reinclusion if-part))
+ (hif-not (funcall hide-ifdef-evaluator test)))
+ ;; ifX/elif is FALSE
+ (if elifs
+ ;; Case 3 - Hide the #ifX and eval #elif
+ (let ((newstart (car elifs)))
+ (hif-hide-line (hif-range-start range))
+ (hide-ifdef-region (hif-range-start range)
+ (1- newstart))
+ (setcar range newstart)
+ (goto-char newstart)
+ (setq elifs (cdr elifs))
+ (setq test (hif-canonicalize hif-elif-regexp)))
+
+ ;; Check for #else
+ (cond ((hif-range-else range)
+ ;; Case 4 - #else block visible
+ (hif-hide-line (hif-range-else range))
+ (hide-ifdef-region (hif-range-start range)
+ (1- (hif-range-else range)))
+ (hif-recurse-on (hif-range-else range)
+ (hif-range-end range)))
+ (t
+ ;; Case 5 - No #else block, hide #ifX
+ (hide-ifdef-region (point)
+ (1- (hif-range-end range)))))
+ (setq complete t))
+
+ ;; ifX/elif is TRUE
+ (cond (elifs
+ ;; Luke fix: distinguish from #elif..#elif to #elif..#else [2013-08-30 14:10:40 +0800]
+ (let ((elif (car elifs)))
+ ;; hide all elifs
+ (hif-hide-line elif)
+ (hide-ifdef-region elif (1- (hif-range-end range)))
+ (hif-recurse-on (hif-range-start range)
+ elif)))
+ ((hif-range-else range)
+ ;; Case 1 - Hide #elif and #else blocks, recurse #ifX
(hif-hide-line (hif-range-else range))
(hide-ifdef-region (hif-range-else range)
(1- (hif-range-end range)))
(hif-recurse-on (hif-range-start range)
(hif-range-else range)))
- (t ; case 2
+ (t
+ ;; Case 2 - No #else, just recurse #ifX
(hif-recurse-on (hif-range-start range)
(hif-range-end range))))
- (cond ((hif-range-else range) ; case 3
- (hif-hide-line (hif-range-else range))
- (hide-ifdef-region (hif-range-start range)
- (1- (hif-range-else range)))
- (hif-recurse-on (hif-range-else range)
- (hif-range-end range)))
- (t ; case 4
- (hide-ifdef-region (point)
- (1- (hif-range-end range))))))
+ (setq complete t))
+ (setq if-part nil))
+
+ ;; complete = t
(hif-hide-line (hif-range-start range)) ; Always hide start.
(goto-char (hif-range-end range))
(end-of-line)))
+(defun hif-evaluate-region (start end)
+ (let* ((tokens (ignore-errors ;; prevent C statement things like 'do { ... } while (0)'
+ (hif-tokenize start end)))
+ (expr (and tokens
+ (condition-case nil
+ (hif-parse-if-exp tokens)
+ (error
+ tokens))))
+ (result (funcall hide-ifdef-evaluator expr)))
+ result))
+
+(defun hif-evaluate-macro (rstart rend)
+ "Evaluate the macro expansion result for a region. If no region active,
+find the current #ifdefs and evaluate the result. Currently it support only
+math calculation, no string or argumented macros can be expanded."
+ (interactive "r")
+ (let ((case-fold-search nil))
+ (save-excursion
+ (unless mark-active
+ (setq rstart nil rend nil)
+ (beginning-of-line)
+ (when (and (re-search-forward hif-macro-expr-prefix-regexp nil t)
+ (string= "define" (match-string 2)))
+ (re-search-forward hif-macroname nil t)))
+ (let* ((start (or rstart (point)))
+ (end (or rend (progn (hif-end-of-line) (point))))
+ (defined nil)
+ (simple 't)
+ (tokens (ignore-errors ;; prevent C statement things like 'do { ... } while (0)'
+ (hif-tokenize start end)))
+ (expr (or (and (<= (length tokens) 1) ;; simple token
+ (setq defined (assoc (car tokens) hide-ifdef-env))
+ (setq simple (atom (hif-lookup (car tokens))))
+ (hif-lookup (car tokens)))
+ (and tokens
+ (condition-case nil
+ (hif-parse-if-exp tokens)
+ (error
+ nil)))))
+ (result (funcall hide-ifdef-evaluator expr))
+ (exprstring (replace-regexp-in-string
+ "^[ \t]*\\([^ \t]+\\)[ \t]*" "\\1" ;; trim off leading/trailing whites
+ (replace-regexp-in-string
+ "\\(//.*\\)" "" ;; trim off end-of-line comments
+ (buffer-substring-no-properties start end)))))
+ (cond
+ ((and (<= (length tokens) 1) simple) ;; simple token
+ (if defined
+ (message "%S <= `%s'" result exprstring)
+ (message "`%s' is not defined" exprstring)))
+ ((integerp result)
+ (if (or (= 0 result) (= 1 result))
+ (message "%S <= `%s'" result exprstring)
+ (message "%S (0x%x) <= `%s'" result result exprstring)))
+ ((null result) (message "%S <= `%s'" 'false exprstring))
+ ((eq t result) (message "%S <= `%s'" 'true exprstring))
+ (t (message "%S <= `%s'" result exprstring)))
+ result))))
(defun hif-parse-macro-arglist (str)
"Parse argument list formatted as '( arg1 [ , argn] [...] )', includeing the '...'
@@ -1421,15 +1603,41 @@ Return a list of the arguments, if '...' exists the first arg will be hif-etc."
(hif-undefine-symbol (intern name))))))
t))
+;;(defun mark-region (min max)
+;; (set-mark (or max (point-max)))
+;; (goto-char min))
+
+(defun hif-add-new-defines (&optional min max)
+ "Scan and add all #define macros between min .. max"
+ (interactive)
+ (save-excursion
+ (save-restriction
+ ;; (mark-region min max) ;; for debugging
+ (while (hif-find-define min max)
+ (setf min (point)))
+ (if max (goto-char max)
+ (goto-char (point-max))))))
(defun hide-ifdef-guts ()
"Does most of the work of `hide-ifdefs'.
It does not do the work that's pointless to redo on a recursive entry."
;; (message "hide-ifdef-guts")
(save-excursion
+ (let ((case-fold-search nil)
+ (expand-header (and hide-ifdef-expand-re-inclusion-protection
+ (string-match hide-ifdef-header-regexp-pattern
+ (buffer-name (current-buffer)))
+ (zerop hif-recurse-level)))
+ min max)
(goto-char (point-min))
- (while (hif-find-any-ifX)
- (hif-possibly-hide))))
+ (setf min (point))
+ (loop do
+ (setf max (hif-find-any-ifX))
+ (hif-add-new-defines min max)
+ (if max
+ (hif-possibly-hide expand-header))
+ (setf min (point))
+ while max))))
;;===%%SF%% hide-ifdef-hiding (End) ===
@@ -1473,10 +1681,24 @@ It does not do the work that's pointless to redo on a recursive entry."
(overlay-put overlay 'face nil)
(overlay-put overlay 'invisible 'hide-ifdef))))))
-(defun hide-ifdef-define (var)
- "Define a VAR so that #ifdef VAR would be included."
- (interactive "SDefine what? ")
- (hif-set-var var 1)
+(defun hide-ifdef-define (var val)
+ "Define a VAR, optionally to a specific value, so that #ifdef VAR
+would be included."
+ (interactive
+ (let* ((default (save-excursion
+ (beginning-of-line)
+ (cond ((looking-at hif-ifx-else-endif-regexp)
+ (forward-word 2)
+ (current-word 'strict))
+ (t
+ nil))))
+ (var (read-minibuffer "Define what? " default))
+ (val (read-from-minibuffer (format "Set %s to? (default 1): " var)
+ nil nil t nil "1")))
+ (list var val)))
+ (hif-set-var var (or val 1))
+ (message "%s set to %s" var (or val 1))
+ (sleep-for 1)
(if hide-ifdef-hiding (hide-ifdefs)))
(defun hif-undefine-symbol (var)
@@ -1489,17 +1711,34 @@ It does not do the work that's pointless to redo on a recursive entry."
;; ;;(hif-set-var var nil);;Luke fixed: set it nil is still considered defined so #ifdef VAR is still true.
;; (hif-undefine-symbol var)
;; (if hide-ifdef-hiding (hide-ifdefs)))
+(defun hide-ifdef-undef (start end)
+ "Undefine a VAR so that #ifdef VAR would not be included."
+ (interactive "r")
+ (let* ((symstr
+ (or (and mark-active
+ (buffer-substring-no-properties start end))
+ (read-string "Undefine what? " (current-word))))
+ (sym (and symstr
+ (intern symstr))))
+ (if (zerop (hif-defined sym))
+ (message "`%s' not defined, no need to undefine it" symstr)
+ (hif-undefine-symbol sym)
+ (if hide-ifdef-hiding (hide-ifdefs))
+ (message "`%S' undefined" sym))))
(defun hide-ifdefs (&optional nomsg)
"Hide the contents of some #ifdefs.
Assume that defined symbols have been added to `hide-ifdef-env'.
The text hidden is the text that would not be included by the C
preprocessor if it were given the file with those symbols defined.
+If this command is prefixed, hide also the #ifdefs themselves.
Turn off hiding by calling `show-ifdefs'."
(interactive)
- (message "Hiding...")
+ (let ((hide-ifdef-lines current-prefix-arg))
+ (or nomsg
+ (message "Hiding..."))
(setq hif-outside-read-only buffer-read-only)
(unless hide-ifdef-mode (hide-ifdef-mode 1)) ; turn on hide-ifdef-mode
(if hide-ifdef-hiding
@@ -1508,7 +1747,7 @@ Turn off hiding by calling `show-ifdefs'."
(hide-ifdef-guts)
(setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only))
(or nomsg
- (message "Hiding done")))
+ (message "Hiding done"))))
(defun show-ifdefs ()
@@ -1522,6 +1761,22 @@ Turn off hiding by calling `show-ifdefs'."
(defun hif-find-ifdef-block ()
"Utility for hide and show `ifdef-block'.
Return as (TOP . BOTTOM) the extent of ifdef block."
+ (if (and (fboundp 'c-backward-conditional-with-else)
+ (fboundp 'c-forward-conditional-with-else))
+ ;;Use my modified functions in cc-mode.
+ (save-excursion
+ (cons
+ (progn
+ (if (= (line-number-at-pos)
+ (save-excursion
+ (beginning-of-line)
+ (re-search-forward hif-ifx-else-endif-regexp)
+ (line-number-at-pos)))
+ (beginning-of-line)
+ (c-backward-conditional-with-else 1))
+ (point))
+ (progn (c-forward-conditional-with-else 1) (1- (point)))))
+ ;; original implementation in hideif.el
(let (max-bottom)
(cons (save-excursion
(beginning-of-line)
@@ -1537,12 +1792,18 @@ Return as (TOP . BOTTOM) the extent of ifdef block."
(while (hif-looking-at-ifX)
(hif-ifdef-to-endif)
(hif-find-next-relevant))
- (min max-bottom (1- (point)))))))
-
-
-(defun hide-ifdef-block ()
- "Hide the ifdef block (true or false part) enclosing or before the cursor."
- (interactive)
+ (min max-bottom (1- (point))))))))
+
+
+(defun hide-ifdef-block (&optional start end)
+ "Hide the ifdef block (true or false part) enclosing or before the cursor.
+If prefixed, it will also hide #ifdefs themselves."
+ (interactive "r")
+ (let ((hide-ifdef-lines current-prefix-arg))
+ (if mark-active
+ (let ((hif-recurse-level (1+ hif-recurse-level)))
+ (hif-recurse-on start end t)
+ (setq mark-active nil))
(unless hide-ifdef-mode (hide-ifdef-mode 1))
(let ((top-bottom (hif-find-ifdef-block)))
(hide-ifdef-region (car top-bottom) (cdr top-bottom))
@@ -1550,12 +1811,25 @@ Return as (TOP . BOTTOM) the extent of ifdef block."
(hif-hide-line (car top-bottom))
(hif-hide-line (1+ (cdr top-bottom))))
(setq hide-ifdef-hiding t))
- (setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only)))
+ (setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only)))))
-(defun show-ifdef-block ()
+(defun show-ifdef-block (&optional start end)
"Show the ifdef block (true or false part) enclosing or before the cursor."
- (interactive)
- (let ((top-bottom (hif-find-ifdef-block)))
+ (interactive "r")
+ (if mark-active
+ (progn
+ (dolist (o (overlays-in start end))
+ (if (overlay-get o 'hide-ifdef)
+ (delete-overlay o)))
+ (setq mark-active nil))
+ (let ((top-bottom (condition-case nil
+ (hif-find-ifdef-block)
+ (error
+ nil)))
+ (ovrs (overlays-in (max (point-min) (1- (point)))
+ (min (point-max) (1+ (point)))))
+ (del nil))
+ (if top-bottom
(if hide-ifdef-lines
(hif-show-ifdef-region
(save-excursion
@@ -1563,7 +1837,14 @@ Return as (TOP . BOTTOM) the extent of ifdef block."
(save-excursion
(goto-char (1+ (cdr top-bottom)))
(hif-end-of-line) (point)))
- (hif-show-ifdef-region (1- (car top-bottom)) (cdr top-bottom)))))
+ (setf del (hif-show-ifdef-region (1- (car top-bottom)) (cdr top-bottom)))))
+ (if (not (and top-bottom
+ del))
+ (dolist (o ovrs)
+ ;;(dolist (o (overlays-in (1- (point)) (1+ (point))))
+ ;; (if (overlay-get o 'hide-ifdef) (message "%S" o)))
+ (if (overlay-get o 'hide-ifdef)
+ (delete-overlay o)))))))
;;; definition alist support
--
1.8.3.24.g67b0998
[-- Attachment #5: 0004-Cleanup-hideif.el-for-white-spaces-tabs-and-indentat.patch --]
[-- Type: application/octet-stream, Size: 33457 bytes --]
From 467743c11db5f9991fe98f544f157e16d49c331e Mon Sep 17 00:00:00 2001
From: Luke Lee <luke.yx.lee@gmail.com>
Date: Wed, 4 Dec 2013 15:50:49 +0800
Subject: [PATCH 4/4] Cleanup hideif.el for white spaces/tabs and indentation.
Update version number.
---
lisp/progmodes/hideif.el | 421 ++++++++++++++++++++++++-----------------------
1 file changed, 214 insertions(+), 207 deletions(-)
diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el
index 01edfb4..3e7660a 100644
--- a/lisp/progmodes/hideif.el
+++ b/lisp/progmodes/hideif.el
@@ -1,9 +1,9 @@
;;; hideif.el --- hides selected code within ifdef
-;; Copyright (C) 1988, 1994, 2001-2013 Free Software Foundation, Inc.
+;; Copyright (C) 1988, 1994, 2001-2013 Free Software Foundation, Inc.
;; Author: Brian Marick
-;; Daniel LaLiberte <liberte@holonexus.org>
+;; Daniel LaLiberte <liberte@holonexus.org>
;; Maintainer: FSF
;; Keywords: c, outlines
@@ -66,11 +66,11 @@
;;
;; (add-hook 'hide-ifdef-mode-hook
;; (lambda ()
-;; (unless hide-ifdef-define-alist
-;; (setq hide-ifdef-define-alist
-;; '((list1 ONE TWO)
-;; (list2 TWO THREE))))
-;; (hide-ifdef-use-define-alist 'list2))) ; use list2 by default
+;; (unless hide-ifdef-define-alist
+;; (setq hide-ifdef-define-alist
+;; '((list1 ONE TWO)
+;; (list2 TWO THREE))))
+;; (hide-ifdef-use-define-alist 'list2))) ; use list2 by default
;;
;; You can call hide-ifdef-use-define-alist (C-c @ U) at any time to specify
;; another list to use.
@@ -129,17 +129,18 @@
"Non-nil means shadow text instead of hiding it."
:type 'boolean
:group 'hide-ifdef
- :version "23.1")
+ :version "25.0")
(defface hide-ifdef-shadow '((t (:inherit shadow)))
"Face for shadowing ifdef blocks."
:group 'hide-ifdef
- :version "23.1")
+ :version "25.0")
(defcustom hide-ifdef-exclude-define-regexp-pattern nil
"Ignore #define name if that name match this exclusion pattern."
:type 'string
:group 'hide-ifdef)
+
(defcustom hide-ifdef-expand-re-inclusion-protection t
"When hiding header files, always expand the re-inclusion protected
ifdefs. Most C/C++ header files are wrapped with ifdefs to prevent
@@ -159,6 +160,7 @@ is defined at the first time that we hide it."
:type 'string
:group 'hide-ifdef)
+
(defvar hide-ifdef-mode-submap
;; Set up the submap that goes after the prefix key.
(let ((map (make-sparse-keymap)))
@@ -171,6 +173,7 @@ is defined at the first time that we hide it."
(define-key map "s" 'show-ifdefs)
(define-key map "\C-d" 'hide-ifdef-block)
(define-key map "\C-s" 'show-ifdef-block)
+
(define-key map "e" 'hif-evaluate-macro)
(define-key map "\C-q" 'hide-ifdef-toggle-read-only)
@@ -252,48 +255,48 @@ that the C preprocessor would eliminate may be hidden from view.
Several variables affect how the hiding is done:
`hide-ifdef-env'
- An association list of defined and undefined symbols for the
- current buffer. Initially, the global value of `hide-ifdef-env'
- is used.
+ An association list of defined and undefined symbols for the
+ current buffer. Initially, the global value of `hide-ifdef-env'
+ is used.
`hide-ifdef-define-alist'
- An association list of defined symbol lists.
+ An association list of defined symbol lists.
Use `hide-ifdef-set-define-alist' to save the current `hide-ifdef-env'
and `hide-ifdef-use-define-alist' to set the current `hide-ifdef-env'
from one of the lists in `hide-ifdef-define-alist'.
`hide-ifdef-lines'
- Set to non-nil to not show #if, #ifdef, #ifndef, #else, and
- #endif lines when hiding.
+ Set to non-nil to not show #if, #ifdef, #ifndef, #else, and
+ #endif lines when hiding.
`hide-ifdef-initially'
- Indicates whether `hide-ifdefs' should be called when Hide-Ifdef mode
- is activated.
+ Indicates whether `hide-ifdefs' should be called when Hide-Ifdef mode
+ is activated.
`hide-ifdef-read-only'
- Set to non-nil if you want to make buffers read only while hiding.
- After `show-ifdefs', read-only status is restored to previous value.
+ Set to non-nil if you want to make buffers read only while hiding.
+ After `show-ifdefs', read-only status is restored to previous value.
\\{hide-ifdef-mode-map}"
:group 'hide-ifdef :lighter " Ifdef"
(if hide-ifdef-mode
(progn
- ;; inherit global values
+ ;; inherit global values
;; (set (make-local-variable 'hide-ifdef-env) ;; [2012-09-27 11:05:26 +0800] Luke rem 2 ins 2
;; (default-value 'hide-ifdef-env))
(set 'hide-ifdef-env (default-value 'hide-ifdef-env))
- (set (make-local-variable 'hide-ifdef-hiding)
- (default-value 'hide-ifdef-hiding))
- (set (make-local-variable 'hif-outside-read-only) buffer-read-only)
- (set (make-local-variable 'line-move-ignore-invisible) t)
- (add-hook 'change-major-mode-hook
- (lambda () (hide-ifdef-mode -1)) nil t)
-
- (add-to-invisibility-spec '(hide-ifdef . t))
-
- (if hide-ifdef-initially
- (hide-ifdefs)
- (show-ifdefs)))
+ (set (make-local-variable 'hide-ifdef-hiding)
+ (default-value 'hide-ifdef-hiding))
+ (set (make-local-variable 'hif-outside-read-only) buffer-read-only)
+ (set (make-local-variable 'line-move-ignore-invisible) t)
+ (add-hook 'change-major-mode-hook
+ (lambda () (hide-ifdef-mode -1)) nil t)
+
+ (add-to-invisibility-spec '(hide-ifdef . t))
+
+ (if hide-ifdef-initially
+ (hide-ifdefs)
+ (show-ifdefs)))
;; else end hide-ifdef-mode
(kill-local-variable 'line-move-ignore-invisible)
(remove-from-invisibility-spec '(hide-ifdef . t))
@@ -318,6 +321,7 @@ Several variables affect how the hiding is done:
(end-of-line)
(while (= (logand 1 (skip-chars-backward "\\\\")) 1)
(end-of-line 2)))
+
(defun hif-merge-ifdef-region (start end)
;; Genernally there is no need to call itself recursively since there should originally
;; exists no un-merged regions; however, if a part of the file is hidden with 'hide-ifdef-lines'
@@ -365,10 +369,10 @@ total number of overlays created."
(defun hide-ifdef-region-internal (start end)
(unless (hif-merge-ifdef-region start end)
- (let ((o (make-overlay start end)))
- (overlay-put o 'hide-ifdef t)
- (if hide-ifdef-shadow
- (overlay-put o 'face 'hide-ifdef-shadow)
+ (let ((o (make-overlay start end)))
+ (overlay-put o 'hide-ifdef t)
+ (if hide-ifdef-shadow
+ (overlay-put o 'face 'hide-ifdef-shadow)
(overlay-put o 'invisible 'hide-ifdef)))))
(defun hide-ifdef-region (start end)
@@ -385,7 +389,6 @@ Everything including these lines is made invisible."
(remove-overlays start end 'hide-ifdef t)
(/= onum (length (overlays-in start end)))))
-
;;===%%SF%% evaluation (Start) ===
;; It is not useful to set this to anything but `eval'.
@@ -408,11 +411,11 @@ that form should be displayed.")
(defun hif-lookup (var)
(or (when (bound-and-true-p semantic-c-takeover-hideif)
- (semantic-c-hideif-lookup var))
+ (semantic-c-hideif-lookup var))
(let ((val (assoc var hide-ifdef-env)))
- (if val
- (cdr val)
- hif-undefined-symbol))))
+ (if val
+ (cdr val)
+ hif-undefined-symbol))))
(defun hif-defined (var)
(cond
@@ -428,13 +431,13 @@ that form should be displayed.")
;;===%%SF%% parsing (Start) ===
;;; The code that understands what ifs and ifdef in files look like.
-(defconst hif-cpp-prefix "\\(^\\|\r\\)[ \t]*#[ \t]*")
+(defconst hif-cpp-prefix "\\(^\\|\r\\)[ \t]*#[ \t]*")
(defconst hif-ifxdef-regexp (concat hif-cpp-prefix "if\\(n\\)?def"))
(defconst hif-ifndef-regexp (concat hif-cpp-prefix "ifndef"))
-(defconst hif-ifx-regexp (concat hif-cpp-prefix "if\\(n?def\\)?[ \t]+"))
+(defconst hif-ifx-regexp (concat hif-cpp-prefix "if\\(n?def\\)?[ \t]+"))
(defconst hif-elif-regexp (concat hif-cpp-prefix "elif"))
-(defconst hif-else-regexp (concat hif-cpp-prefix "else"))
-(defconst hif-endif-regexp (concat hif-cpp-prefix "endif"))
+(defconst hif-else-regexp (concat hif-cpp-prefix "else"))
+(defconst hif-endif-regexp (concat hif-cpp-prefix "endif"))
(defconst hif-ifx-else-endif-regexp
(concat hif-ifx-regexp "\\|" hif-elif-regexp "\\|" hif-else-regexp "\\|" hif-endif-regexp))
(defconst hif-macro-expr-prefix-regexp (concat hif-cpp-prefix "\\(if\\(n?def\\)?\\|elif\\|define\\)[ \t]+"))
@@ -459,29 +462,29 @@ that form should be displayed.")
(defconst hif-token-alist
'(("||" . hif-or)
("&&" . hif-and)
- ("|" . hif-logior)
+ ("|" . hif-logior)
("^" . hif-logxor)
- ("&" . hif-logand)
+ ("&" . hif-logand)
("<<" . hif-shiftleft)
(">>" . hif-shiftright)
("==" . hif-equal)
("=" . hif-assign)
- ("!=" . hif-notequal)
+ ("!=" . hif-notequal)
("##" . hif-token-concat)
("!" . hif-not)
("~" . hif-lognot)
("(" . hif-lparen)
(")" . hif-rparen)
- (">" . hif-greater)
- ("<" . hif-less)
- (">=" . hif-greater-equal)
- ("<=" . hif-less-equal)
- ("+" . hif-plus)
- ("-" . hif-minus)
+ (">" . hif-greater)
+ ("<" . hif-less)
+ (">=" . hif-greater-equal)
+ ("<=" . hif-less-equal)
+ ("+" . hif-plus)
+ ("-" . hif-minus)
("*" . hif-multiply)
("/" . hif-divide)
("%" . hif-modulo)
- ("?" . hif-conditional)
+ ("?" . hif-conditional)
(":" . hif-colon)
("," . hif-comma)
("#" . hif-stringify)
@@ -506,21 +509,22 @@ that form should be displayed.")
(setq hif-simple-token-only t)
(with-syntax-table hide-ifdef-syntax-table
(save-excursion
- (goto-char start)
- (while (progn (forward-comment (point-max)) (< (point) end))
- ;; (message "expr-start = %d" expr-start) (sit-for 1)
- (cond
- ((looking-at "\\\\\n")
- (forward-char 2))
+ (goto-char start)
+ (while (progn (forward-comment (point-max)) (< (point) end))
+ ;; (message "expr-start = %d" expr-start) (sit-for 1)
+ (cond
+ ((looking-at "\\\\\n")
+ (forward-char 2))
((looking-at hif-string-literal-regexp)
(push (substring-no-properties (match-string 1)) token-list)
(goto-char (match-end 0)))
- ((looking-at hif-token-regexp)
+
+ ((looking-at hif-token-regexp)
(let ((token (buffer-substring-no-properties (point) (match-end 0))))
- (goto-char (match-end 0))
- ;; (message "token: %s" token) (sit-for 1)
- (push (or (cdr (assoc token hif-token-alist))
+ (goto-char (match-end 0))
+ ;; (message "token: %s" token) (sit-for 1)
+ (push (or (cdr (assoc token hif-token-alist))
(if (string-equal token "defined") 'hif-defined)
(if (string-match "0x\\([a-fA-F0-9]+\\)" token)
(string-to-number (match-string 1 token) 16)) ;; hexadecimal
@@ -530,10 +534,12 @@ that form should be displayed.")
(string-to-number token)) ;; decimal
(prog1 (intern token)
(setq hif-simple-token-only nil)))
- token-list)))
+ token-list)))
+
((looking-at "\r") ;; sometimes Windows user will leave CR in the source code
(forward-char 1)) ;; let's don't stuck here.
- (t (error "Bad #if expression: %s" (buffer-string)))))))
+
+ (t (error "Bad #if expression: %s" (buffer-string)))))))
(nreverse token-list)))
;;------------------------------------------------------------------------
@@ -695,15 +701,15 @@ that form should be displayed.")
"Parse an expression as found in #if.
expr : or-expr | or-expr '?' expr ':' expr."
(let ((result (hif-or-expr))
- middle)
+ middle)
(while (eq hif-token 'hif-conditional)
(hif-nexttoken)
(setq middle (hif-expr))
(if (eq hif-token 'hif-colon)
- (progn
- (hif-nexttoken)
- (setq result (list 'hif-conditional result middle (hif-expr))))
- (error "Error: unexpected token: %s" hif-token)))
+ (progn
+ (hif-nexttoken)
+ (setq result (list 'hif-conditional result middle (hif-expr))))
+ (error "Error: unexpected token: %s" hif-token)))
result))
(defun hif-or-expr ()
@@ -749,7 +755,7 @@ that form should be displayed.")
(defun hif-eq-expr ()
"Parse an eq-expr : comp | eq-expr `=='|`!=' comp."
(let ((result (hif-comp-expr))
- (eq-token nil))
+ (eq-token nil))
(while (memq hif-token '(hif-equal hif-notequal))
(setq eq-token hif-token)
(hif-nexttoken)
@@ -791,12 +797,12 @@ that form should be displayed.")
"Parse an expression with *,/,%.
muldiv : factor | muldiv '*|/|%' factor."
(let ((result (hif-factor))
- (math-op nil))
+ (math-op nil))
(while (memq hif-token '(hif-multiply hif-divide hif-modulo))
(setq math-op hif-token)
(hif-nexttoken)
(setq result (list math-op result (hif-factor))))
- result))
+ result))
(defun hif-factor ()
"Parse a factor: '!' factor | '~' factor | '(' expr ')' | 'defined(' id ')' | 'id(parmlist)' | strings | id."
@@ -813,25 +819,26 @@ that form should be displayed.")
(hif-nexttoken)
(let ((result (hif-exprlist)))
(if (not (eq hif-token 'hif-rparen))
- (error "Bad token in parenthesized expression: %s" hif-token)
- (hif-nexttoken)
- result)))
+ (error "Bad token in parenthesized expression: %s" hif-token)
+ (hif-nexttoken)
+ result)))
((eq hif-token 'hif-defined)
(hif-nexttoken)
(let ((paren (when (eq hif-token 'hif-lparen) (hif-nexttoken) t))
- (ident hif-token))
+ (ident hif-token))
(if (memq hif-token '(or and not hif-defined hif-lparen hif-rparen))
- (error "Error: unexpected token: %s" hif-token))
+ (error "Error: unexpected token: %s" hif-token))
(when paren
- (hif-nexttoken)
+ (hif-nexttoken)
(unless (eq hif-token 'hif-rparen)
- (error "Error: expected \")\" after identifier")))
+ (error "Error: expected \")\" after identifier")))
(hif-nexttoken)
`(hif-defined (quote ,ident))))
((numberp hif-token)
(prog1 hif-token (hif-nexttoken)))
+
((stringp hif-token)
(hif-string-concatenation))
@@ -839,7 +846,7 @@ that form should be displayed.")
((memq hif-token '(hif-minus hif-plus))
(list (prog1 hif-token (hif-nexttoken)) 0 (hif-factor)))
- (t ; identifier
+ (t ; identifier
(let ((ident hif-token))
(hif-nexttoken)
(if (eq hif-token 'hif-lparen)
@@ -944,11 +951,12 @@ we ignore them all here."
(defun hif-mathify (val)
"Treat VAL as a number: if it's t or nil, use 1 or 0."
(cond ((eq val t) 1)
- ((null val) 0)
- (t val)))
+ ((null val) 0)
+ (t val)))
(defun hif-conditional (a b c)
(if (not (zerop (hif-mathify a))) (hif-mathify b) (hif-mathify c)))
+
(defun hif-and (a b)
(and (not (zerop (hif-mathify a))) (not (zerop (hif-mathify b)))))
(defun hif-or (a b)
@@ -1110,7 +1118,6 @@ we ignore them all here."
;;;----------- end of parser -----------------------
-
(defun hif-canonicalize-tokens (regexp) ;; for debugging
"Return the expanded result of the scanned tokens."
(save-excursion
@@ -1123,7 +1130,7 @@ we ignore them all here."
(progn (hif-end-of-line) (point)))))
(if defined
(setq tokens (list 'hif-defined tokens)))
- (if negate
+ (if negate
(setq tokens (list 'hif-not tokens)))
tokens))))
@@ -1151,7 +1158,6 @@ we ignore them all here."
(re-search-forward hif-ifx-regexp (point-max) t)
(beginning-of-line)))
-
(defun hif-find-next-relevant ()
"Move to next #if..., #elif..., #else, or #endif, after the current line."
;; (message "hif-find-next-relevant at %d" (point))
@@ -1169,13 +1175,12 @@ we ignore them all here."
(beginning-of-line)))
-(defun hif-looking-at-ifX () ;; Should eventually see #if
+(defun hif-looking-at-ifX () ;; Should eventually see #if
(looking-at hif-ifx-regexp))
(defun hif-looking-at-endif ()
(looking-at hif-endif-regexp))
(defun hif-looking-at-else ()
(looking-at hif-else-regexp))
-
(defun hif-looking-at-elif ()
(looking-at hif-elif-regexp))
@@ -1185,16 +1190,16 @@ we ignore them all here."
;; (message "hif-ifdef-to-endif at %d" (point)) (sit-for 1)
(hif-find-next-relevant)
(cond ((hif-looking-at-ifX)
- (hif-ifdef-to-endif) ; find endif of nested if
- (hif-ifdef-to-endif)) ; find outer endif or else
+ (hif-ifdef-to-endif) ; find endif of nested if
+ (hif-ifdef-to-endif)) ; find outer endif or else
((hif-looking-at-elif)
(hif-ifdef-to-endif))
- ((hif-looking-at-else)
- (hif-ifdef-to-endif)) ; find endif following else
- ((hif-looking-at-endif)
- 'done)
- (t
- (error "Mismatched #ifdef #endif pair"))))
+ ((hif-looking-at-else)
+ (hif-ifdef-to-endif)) ; find endif following else
+ ((hif-looking-at-endif)
+ 'done)
+ (t
+ (error "Mismatched #ifdef #endif pair"))))
(defun hif-endif-to-ifdef ()
@@ -1203,16 +1208,16 @@ we ignore them all here."
(let ((start (point)))
(hif-find-previous-relevant)
(if (= start (point))
- (error "Mismatched #ifdef #endif pair")))
+ (error "Mismatched #ifdef #endif pair")))
(cond ((hif-looking-at-endif)
- (hif-endif-to-ifdef) ; find beginning of nested if
- (hif-endif-to-ifdef)) ; find beginning of outer if or else
+ (hif-endif-to-ifdef) ; find beginning of nested if
+ (hif-endif-to-ifdef)) ; find beginning of outer if or else
((hif-looking-at-elif)
(hif-endif-to-ifdef))
- ((hif-looking-at-else)
- (hif-endif-to-ifdef))
- ((hif-looking-at-ifX)
- 'done)
+ ((hif-looking-at-else)
+ (hif-endif-to-ifdef))
+ ((hif-looking-at-ifX)
+ 'done)
(t
(error "Mismatched #endif")))) ; never gets here
@@ -1226,12 +1231,12 @@ With argument, do this that many times."
(while (< 0 arg)
(setq arg (- arg))
(let ((start (point)))
- (unless (hif-looking-at-ifX)
- (hif-find-next-relevant))
- (if (hif-looking-at-ifX)
- (hif-ifdef-to-endif)
- (goto-char start)
- (error "No following #ifdef"))))))
+ (unless (hif-looking-at-ifX)
+ (hif-find-next-relevant))
+ (if (hif-looking-at-ifX)
+ (hif-ifdef-to-endif)
+ (goto-char start)
+ (error "No following #ifdef"))))))
(defun backward-ifdef (&optional arg)
@@ -1244,12 +1249,12 @@ With argument, do this that many times."
(setq arg (1- arg))
(beginning-of-line)
(let ((start (point)))
- (unless (hif-looking-at-endif)
- (hif-find-previous-relevant))
- (if (hif-looking-at-endif)
- (hif-endif-to-ifdef)
- (goto-char start)
- (error "No previous #ifdef"))))))
+ (unless (hif-looking-at-endif)
+ (hif-find-previous-relevant))
+ (if (hif-looking-at-endif)
+ (hif-endif-to-ifdef)
+ (goto-char start)
+ (error "No previous #ifdef"))))))
(defun down-ifdef ()
@@ -1258,9 +1263,9 @@ With argument, do this that many times."
(let ((start (point)))
(hif-find-next-relevant)
(if (or (hif-looking-at-ifX) (hif-looking-at-else))
- ()
- (goto-char start)
- (error "No following #ifdef"))))
+ ()
+ (goto-char start)
+ (error "No following #ifdef"))))
(defun up-ifdef ()
@@ -1271,9 +1276,9 @@ With argument, do this that many times."
(unless (hif-looking-at-endif)
(hif-find-previous-relevant))
(if (hif-looking-at-endif)
- (hif-endif-to-ifdef))
+ (hif-endif-to-ifdef))
(if (= start (point))
- (error "No previous #ifdef"))))
+ (error "No previous #ifdef"))))
(defun next-ifdef (&optional arg)
"Move to the beginning of the next #ifX, #else, or #endif.
@@ -1285,8 +1290,8 @@ With argument, do this that many times."
(setq arg (1- arg))
(hif-find-next-relevant)
(when (eolp)
- (beginning-of-line)
- (error "No following #ifdefs, #elses, or #endifs")))))
+ (beginning-of-line)
+ (error "No following #ifdefs, #elses, or #endifs")))))
(defun previous-ifdef (&optional arg)
"Move to the beginning of the previous #ifX, #else, or #endif.
@@ -1297,9 +1302,9 @@ With argument, do this that many times."
(while (< 0 arg)
(setq arg (1- arg))
(let ((start (point)))
- (hif-find-previous-relevant)
- (if (= start (point))
- (error "No previous #ifdefs, #elses, or #endifs"))))))
+ (hif-find-previous-relevant)
+ (if (= start (point))
+ (error "No previous #ifdefs, #elses, or #endifs"))))))
;;===%%SF%% parsing (End) ===
@@ -1323,7 +1328,6 @@ With argument, do this that many times."
(defsubst hif-range-elif (range) (elt range 3))
-
;; Find-Range
;; The workhorse, it delimits the #if region. Reasonably simple:
;; Skip until an #else or #endif is found, remembering positions. If
@@ -1337,31 +1341,31 @@ Point is left unchanged."
(beginning-of-line)
(let ((start (point))
(elif nil)
- (else nil)
- (end nil))
+ (else nil)
+ (end nil))
;; Part one. Look for either #elif, #else or #endif.
;; This loop-and-a-half dedicated to E. Dijkstra.
(while (and (not else) (not end))
- (while (progn
- (hif-find-next-relevant)
- (hif-looking-at-ifX)) ; Skip nested ifdef
- (hif-ifdef-to-endif))
+ (while (progn
+ (hif-find-next-relevant)
+ (hif-looking-at-ifX)) ; Skip nested ifdef
+ (hif-ifdef-to-endif))
;; Found either a #else, #elif, or an #endif.
(cond ((hif-looking-at-elif)
(setq elif (nconc elif (list (point)))))
((hif-looking-at-else)
- (setq else (point)))
- (t
+ (setq else (point)))
+ (t
(setq end (point)))))
;; If found #else, look for #endif.
(when else
- (while (progn
- (hif-find-next-relevant)
- (hif-looking-at-ifX)) ; Skip nested ifdef
- (hif-ifdef-to-endif))
- (if (hif-looking-at-else)
- (error "Found two elses in a row? Broken!"))
- (setq end (point))) ; (line-end-position)
+ (while (progn
+ (hif-find-next-relevant)
+ (hif-looking-at-ifX)) ; Skip nested ifdef
+ (hif-ifdef-to-endif))
+ (if (hif-looking-at-else)
+ (error "Found two elses in a row? Broken!"))
+ (setq end (point))) ; (line-end-position)
(hif-make-range start end else elif))))
@@ -1428,6 +1432,7 @@ It uses the judgment of `hide-ifdef-evaluator'."
;; (message "test = %s" test) (sit-for 1)
(hif-hide-line (hif-range-end range))
+
(while (not complete)
(if (and (not (and expand-reinclusion if-part))
(hif-not (funcall hide-ifdef-evaluator test)))
@@ -1468,15 +1473,16 @@ It uses the judgment of `hide-ifdef-evaluator'."
elif)))
((hif-range-else range)
;; Case 1 - Hide #elif and #else blocks, recurse #ifX
- (hif-hide-line (hif-range-else range))
- (hide-ifdef-region (hif-range-else range)
- (1- (hif-range-end range)))
- (hif-recurse-on (hif-range-start range)
- (hif-range-else range)))
+ (hif-hide-line (hif-range-else range))
+ (hide-ifdef-region (hif-range-else range)
+ (1- (hif-range-end range)))
+ (hif-recurse-on (hif-range-start range)
+ (hif-range-else range)))
+
(t
;; Case 2 - No #else, just recurse #ifX
- (hif-recurse-on (hif-range-start range)
- (hif-range-end range))))
+ (hif-recurse-on (hif-range-start range)
+ (hif-range-end range))))
(setq complete t))
(setq if-part nil))
@@ -1484,6 +1490,8 @@ It uses the judgment of `hide-ifdef-evaluator'."
(hif-hide-line (hif-range-start range)) ; Always hide start.
(goto-char (hif-range-end range))
(end-of-line)))
+
+
(defun hif-evaluate-region (start end)
(let* ((tokens (ignore-errors ;; prevent C statement things like 'do { ... } while (0)'
(hif-tokenize start end)))
@@ -1629,7 +1637,7 @@ It does not do the work that's pointless to redo on a recursive entry."
(buffer-name (current-buffer)))
(zerop hif-recurse-level)))
min max)
- (goto-char (point-min))
+ (goto-char (point-min))
(setf min (point))
(loop do
(setf max (hif-find-any-ifX))
@@ -1641,7 +1649,6 @@ It does not do the work that's pointless to redo on a recursive entry."
;;===%%SF%% hide-ifdef-hiding (End) ===
-
;;===%%SF%% exports (Start) ===
(defun hide-ifdef-toggle-read-only ()
@@ -1649,7 +1656,7 @@ It does not do the work that's pointless to redo on a recursive entry."
(interactive)
(setq hide-ifdef-read-only (not hide-ifdef-read-only))
(message "Hide-Read-Only %s"
- (if hide-ifdef-read-only "ON" "OFF"))
+ (if hide-ifdef-read-only "ON" "OFF"))
(if hide-ifdef-hiding
(setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only)))
(force-mode-line-update))
@@ -1659,10 +1666,10 @@ It does not do the work that's pointless to redo on a recursive entry."
(interactive)
(setq hif-outside-read-only (not hif-outside-read-only))
(message "Read only %s"
- (if hif-outside-read-only "ON" "OFF"))
+ (if hif-outside-read-only "ON" "OFF"))
(setq buffer-read-only
- (or (and hide-ifdef-hiding hide-ifdef-read-only)
- hif-outside-read-only))
+ (or (and hide-ifdef-hiding hide-ifdef-read-only)
+ hif-outside-read-only))
(force-mode-line-update))
(defun hide-ifdef-toggle-shadowing ()
@@ -1674,12 +1681,12 @@ It does not do the work that's pointless to redo on a recursive entry."
(widen)
(dolist (overlay (overlays-in (point-min) (point-max)))
(when (overlay-get overlay 'hide-ifdef)
- (if hide-ifdef-shadow
- (progn
- (overlay-put overlay 'invisible nil)
- (overlay-put overlay 'face 'hide-ifdef-shadow))
- (overlay-put overlay 'face nil)
- (overlay-put overlay 'invisible 'hide-ifdef))))))
+ (if hide-ifdef-shadow
+ (progn
+ (overlay-put overlay 'invisible nil)
+ (overlay-put overlay 'face 'hide-ifdef-shadow))
+ (overlay-put overlay 'face nil)
+ (overlay-put overlay 'invisible 'hide-ifdef))))))
(defun hide-ifdef-define (var val)
"Define a VAR, optionally to a specific value, so that #ifdef VAR
@@ -1699,7 +1706,7 @@ would be included."
(hif-set-var var (or val 1))
(message "%s set to %s" var (or val 1))
(sleep-for 1)
- (if hide-ifdef-hiding (hide-ifdefs)))
+ (if hide-ifdef-hiding (hide-ifdefs)))
(defun hif-undefine-symbol (var)
(setq hide-ifdef-env
@@ -1711,6 +1718,7 @@ would be included."
;; ;;(hif-set-var var nil);;Luke fixed: set it nil is still considered defined so #ifdef VAR is still true.
;; (hif-undefine-symbol var)
;; (if hide-ifdef-hiding (hide-ifdefs)))
+
(defun hide-ifdef-undef (start end)
"Undefine a VAR so that #ifdef VAR would not be included."
(interactive "r")
@@ -1739,14 +1747,14 @@ Turn off hiding by calling `show-ifdefs'."
(let ((hide-ifdef-lines current-prefix-arg))
(or nomsg
(message "Hiding..."))
- (setq hif-outside-read-only buffer-read-only)
- (unless hide-ifdef-mode (hide-ifdef-mode 1)) ; turn on hide-ifdef-mode
- (if hide-ifdef-hiding
- (show-ifdefs)) ; Otherwise, deep confusion.
- (setq hide-ifdef-hiding t)
- (hide-ifdef-guts)
- (setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only))
- (or nomsg
+ (setq hif-outside-read-only buffer-read-only)
+ (unless hide-ifdef-mode (hide-ifdef-mode 1)) ; turn on hide-ifdef-mode
+ (if hide-ifdef-hiding
+ (show-ifdefs)) ; Otherwise, deep confusion.
+ (setq hide-ifdef-hiding t)
+ (hide-ifdef-guts)
+ (setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only))
+ (or nomsg
(message "Hiding done"))))
@@ -1777,24 +1785,23 @@ Return as (TOP . BOTTOM) the extent of ifdef block."
(point))
(progn (c-forward-conditional-with-else 1) (1- (point)))))
;; original implementation in hideif.el
- (let (max-bottom)
- (cons (save-excursion
- (beginning-of-line)
- (unless (or (hif-looking-at-else) (hif-looking-at-ifX))
- (up-ifdef))
- (prog1 (point)
- (hif-ifdef-to-endif)
- (setq max-bottom (1- (point)))))
- (save-excursion
- (beginning-of-line)
- (unless (hif-looking-at-endif)
- (hif-find-next-relevant))
- (while (hif-looking-at-ifX)
- (hif-ifdef-to-endif)
- (hif-find-next-relevant))
+ (let (max-bottom)
+ (cons (save-excursion
+ (beginning-of-line)
+ (unless (or (hif-looking-at-else) (hif-looking-at-ifX))
+ (up-ifdef))
+ (prog1 (point)
+ (hif-ifdef-to-endif)
+ (setq max-bottom (1- (point)))))
+ (save-excursion
+ (beginning-of-line)
+ (unless (hif-looking-at-endif)
+ (hif-find-next-relevant))
+ (while (hif-looking-at-ifX)
+ (hif-ifdef-to-endif)
+ (hif-find-next-relevant))
(min max-bottom (1- (point))))))))
-
(defun hide-ifdef-block (&optional start end)
"Hide the ifdef block (true or false part) enclosing or before the cursor.
If prefixed, it will also hide #ifdefs themselves."
@@ -1804,13 +1811,13 @@ If prefixed, it will also hide #ifdefs themselves."
(let ((hif-recurse-level (1+ hif-recurse-level)))
(hif-recurse-on start end t)
(setq mark-active nil))
- (unless hide-ifdef-mode (hide-ifdef-mode 1))
- (let ((top-bottom (hif-find-ifdef-block)))
- (hide-ifdef-region (car top-bottom) (cdr top-bottom))
- (when hide-ifdef-lines
- (hif-hide-line (car top-bottom))
- (hif-hide-line (1+ (cdr top-bottom))))
- (setq hide-ifdef-hiding t))
+ (unless hide-ifdef-mode (hide-ifdef-mode 1))
+ (let ((top-bottom (hif-find-ifdef-block)))
+ (hide-ifdef-region (car top-bottom) (cdr top-bottom))
+ (when hide-ifdef-lines
+ (hif-hide-line (car top-bottom))
+ (hif-hide-line (1+ (cdr top-bottom))))
+ (setq hide-ifdef-hiding t))
(setq buffer-read-only (or hide-ifdef-read-only hif-outside-read-only)))))
(defun show-ifdef-block (&optional start end)
@@ -1830,13 +1837,13 @@ If prefixed, it will also hide #ifdefs themselves."
(min (point-max) (1+ (point)))))
(del nil))
(if top-bottom
- (if hide-ifdef-lines
- (hif-show-ifdef-region
- (save-excursion
- (goto-char (car top-bottom)) (line-beginning-position))
- (save-excursion
- (goto-char (1+ (cdr top-bottom)))
- (hif-end-of-line) (point)))
+ (if hide-ifdef-lines
+ (hif-show-ifdef-region
+ (save-excursion
+ (goto-char (car top-bottom)) (line-beginning-position))
+ (save-excursion
+ (goto-char (1+ (cdr top-bottom)))
+ (hif-end-of-line) (point)))
(setf del (hif-show-ifdef-region (1- (car top-bottom)) (cdr top-bottom)))))
(if (not (and top-bottom
del))
@@ -1846,7 +1853,6 @@ If prefixed, it will also hide #ifdefs themselves."
(if (overlay-get o 'hide-ifdef)
(delete-overlay o)))))))
-
;;; definition alist support
(defvar hide-ifdef-define-alist nil
@@ -1862,25 +1868,26 @@ If prefixed, it will also hide #ifdefs themselves."
"Set the association for NAME to `hide-ifdef-env'."
(interactive "SSet define list: ")
(push (cons name (hif-compress-define-list hide-ifdef-env))
- hide-ifdef-define-alist))
+ hide-ifdef-define-alist))
(defun hide-ifdef-use-define-alist (name)
"Set `hide-ifdef-env' to the define list specified by NAME."
(interactive
(list (completing-read "Use define list: "
- (mapcar (lambda (x) (symbol-name (car x)))
+ (mapcar (lambda (x) (symbol-name (car x)))
hide-ifdef-define-alist)
nil t)))
(if (stringp name) (setq name (intern name)))
(let ((define-list (assoc name hide-ifdef-define-alist)))
(if define-list
- (setq hide-ifdef-env
- (mapcar (lambda (arg) (cons arg t))
- (cdr define-list)))
+ (setq hide-ifdef-env
+ (mapcar (lambda (arg) (cons arg t))
+ (cdr define-list)))
(error "No define list for %s" name))
(if hide-ifdef-hiding (hide-ifdefs))))
(provide 'hideif)
+
;; Local variables:
;; byte-compile-warnings: (not cl-functions)
;; End:
--
1.8.3.24.g67b0998
^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: Fwd: Update earlier posted hideif.el enhancements
2013-12-04 15:28 ` Luke Lee
@ 2013-12-04 17:33 ` Stefan Monnier
0 siblings, 0 replies; 11+ messages in thread
From: Stefan Monnier @ 2013-12-04 17:33 UTC (permalink / raw)
To: Luke Lee; +Cc: emacs-devel
> Whew! Finally I create 4 featured patches for hideif. I tried to make
> each of the patch standalone and feature complete but I can't
> guarantee that.
Thanks, I'll take a look ASAP, but to tell you the truth I'm swamped
these days with lots of non-Emacs stuff. Next week will be very
different, and hopefully better in this respect.
Stefan
^ permalink raw reply [flat|nested] 11+ messages in thread
end of thread, other threads:[~2013-12-04 17:33 UTC | newest]
Thread overview: 11+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2013-11-08 1:59 Update earlier posted hideif.el enhancements Luke Lee
2013-11-08 2:54 ` Stefan Monnier
2013-11-08 4:07 ` Luke Lee
2013-11-24 17:50 ` Stefan Monnier
[not found] ` <CAA=xLROospEnRM_Es0bBkQUpC_RmrS-vQDxprD2it+fVDbVKog@mail.gmail.com>
2013-11-25 6:35 ` Fwd: " Luke Lee
2013-11-29 21:59 ` Stefan Monnier
2013-12-03 4:33 ` Luke Lee
2013-12-03 13:45 ` Stefan Monnier
2013-12-04 2:06 ` Luke Lee
2013-12-04 15:28 ` Luke Lee
2013-12-04 17:33 ` Stefan Monnier
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).