| blob | 39ad676f5932f94f60d9578c811cf9997043326f |
1 ;;; hideif.el --- hides selected code within ifdef
3 ;; Copyright (C) 1988, 1994, 2001-2014 Free Software Foundation, Inc.
5 ;; Author: Brian Marick
6 ;; Daniel LaLiberte <liberte@holonexus.org>
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: c, outlines
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; To initialize, toggle the hide-ifdef minor mode with
28 ;;
29 ;; M-x hide-ifdef-mode
30 ;;
31 ;; This will set up key bindings and call hide-ifdef-mode-hook if it
32 ;; has a value. To explicitly hide ifdefs using a buffer-local
33 ;; define list (default empty), type
34 ;;
35 ;; M-x hide-ifdefs or C-c @ h
36 ;;
37 ;; Hide-ifdef suppresses the display of code that the preprocessor wouldn't
38 ;; pass through. Support complete C/C++ expression and precedence.
39 ;;
40 ;; The hidden code is marked by ellipses (...). Be
41 ;; cautious when editing near ellipses, since the hidden text is
42 ;; still in the buffer, and you can move the point into it and modify
43 ;; text unawares.
44 ;; You can make your buffer read-only while hide-ifdef-hiding by setting
45 ;; hide-ifdef-read-only to a non-nil value. You can toggle this
46 ;; variable with hide-ifdef-toggle-read-only (C-c @ C-q).
47 ;;
48 ;; You can undo the effect of hide-ifdefs by typing
49 ;;
50 ;; M-x show-ifdefs or C-c @ s
51 ;;
52 ;; Use M-x hide-ifdef-define (C-c @ d) to define a symbol.
53 ;; Use M-x hide-ifdef-undef (C-c @ u) to undefine a symbol.
54 ;;
55 ;; If you define or undefine a symbol while hide-ifdef-mode is in effect,
56 ;; the display will be updated. Only the define list for the current
57 ;; buffer will be affected. You can save changes to the local define
58 ;; list with hide-ifdef-set-define-alist. This adds entries
59 ;; to hide-ifdef-define-alist.
60 ;;
61 ;; If you have defined a hide-ifdef-mode-hook, you can set
62 ;; up a list of symbols that may be used by hide-ifdefs as in the
63 ;; following example:
64 ;;
65 ;; (add-hook 'hide-ifdef-mode-hook
66 ;; (lambda ()
67 ;; (unless hide-ifdef-define-alist
68 ;; (setq hide-ifdef-define-alist
69 ;; '((list1 ONE TWO)
70 ;; (list2 TWO THREE))))
71 ;; (hide-ifdef-use-define-alist 'list2))) ; use list2 by default
72 ;;
73 ;; You can call hide-ifdef-use-define-alist (C-c @ U) at any time to specify
74 ;; another list to use.
75 ;;
76 ;; To cause ifdefs to be hidden as soon as hide-ifdef-mode is called,
77 ;; set hide-ifdef-initially to non-nil.
78 ;;
79 ;; If you set hide-ifdef-lines to t, hide-ifdefs hides all the #ifdef lines.
80 ;; In the absence of highlighting, that might be a bad idea. If you set
81 ;; hide-ifdef-lines to nil (the default), the surrounding preprocessor
82 ;; lines will be displayed. That can be confusing in its own
83 ;; right. Other variations on display are possible, but not much
84 ;; better.
85 ;;
86 ;; You can explicitly hide or show individual ifdef blocks irrespective
87 ;; of the define list by using hide-ifdef-block and show-ifdef-block.
88 ;;
89 ;; You can move the point between ifdefs with forward-ifdef, backward-ifdef,
90 ;; up-ifdef, down-ifdef, next-ifdef, and previous-ifdef.
91 ;;
92 ;; If you have minor-mode-alist in your mode line (the default) two labels
93 ;; may appear. "Ifdef" will appear when hide-ifdef-mode is active. "Hiding"
94 ;; will appear when text may be hidden ("hide-ifdef-hiding" is non-nil).
95 ;;
96 ;; Written by Brian Marick, at Gould, Computer Systems Division, Urbana IL.
97 ;; Extensively modified by Daniel LaLiberte (while at Gould).
98 ;;
99 ;; Extensively modified by Luke Lee in 2013 to support complete C expression
100 ;; evaluation.
102 ;;; Code:
107 "Hide selected code within `ifdef'."
111 "Non-nil means call `hide-ifdefs' when Hide-Ifdef mode is first activated."
116 "Set to non-nil if you want buffer to be read-only while hiding text."
121 "Non-nil means hide the #ifX, #else, and #endif lines."
126 "Non-nil means shadow text instead of hiding it."
132 "Face for shadowing ifdef blocks."
138 ;; Set up the submap that goes after the prefix key.
154 map)
161 ;; Set up the mode's main map, which leads via the prefix key to the submap.
164 map)
168 "Menu for `hide-ifdef-mode'."
199 minor-mode-alist)))
201 ;; fix c-mode syntax table so we can recognize whole symbols.
207 st)
216 ;;;###autoload
218 "Toggle features to hide/show #ifdef blocks (Hide-Ifdef mode).
219 With a prefix argument ARG, enable Hide-Ifdef mode if ARG is
220 positive, and disable it otherwise. If called from Lisp, enable
221 the mode if ARG is omitted or nil.
223 Hide-Ifdef mode is a buffer-local minor mode for use with C and
224 C-like major modes. When enabled, code within #ifdef constructs
225 that the C preprocessor would eliminate may be hidden from view.
226 Several variables affect how the hiding is done:
228 `hide-ifdef-env'
229 An association list of defined and undefined symbols for the
230 current buffer. Initially, the global value of `hide-ifdef-env'
231 is used.
233 `hide-ifdef-define-alist'
234 An association list of defined symbol lists.
235 Use `hide-ifdef-set-define-alist' to save the current `hide-ifdef-env'
236 and `hide-ifdef-use-define-alist' to set the current `hide-ifdef-env'
237 from one of the lists in `hide-ifdef-define-alist'.
239 `hide-ifdef-lines'
240 Set to non-nil to not show #if, #ifdef, #ifndef, #else, and
241 #endif lines when hiding.
243 `hide-ifdef-initially'
244 Indicates whether `hide-ifdefs' should be called when Hide-Ifdef mode
245 is activated.
247 `hide-ifdef-read-only'
248 Set to non-nil if you want to make buffers read only while hiding.
249 After `show-ifdefs', read-only status is restored to previous value.
255 ;; inherit global values
270 ;; else end hide-ifdef-mode
278 "Show all of the text in the current buffer."
282 ;; By putting this on after-revert-hook, we arrange that it only
283 ;; does anything when revert-buffer avoids turning off the mode.
284 ;; (That can happen in VC.)
304 "START is the start of a #if or #else form. END is the ending part.
305 Everything including these lines is made invisible."
312 "Everything between START and END is made visible."
316 ;;===%%SF%% evaluation (Start) ===
318 ;; It is not useful to set this to anything but `eval'.
319 ;; In fact, the variable might as well be eliminated.
321 "The function to use to evaluate a form.
322 The evaluator is given a canonical form and returns t if text under
330 "Prepend (var value) pair to `hide-ifdef-env'."
342 hif-undefined-symbol))))
351 ;;===%%SF%% evaluation (End) ===
355 ;;===%%SF%% parsing (Start) ===
356 ;;; The code that understands what ifs and ifdef in files look like.
366 ;; Used to store the current token and the whole token list during parsing.
367 ;; Only bound dynamically.
380 ;; Note: we include tokens like `=' which aren't supported by CPP's
381 ;; expression syntax, because they are still relevant for the tokenizer,
382 ;; especially in conjunction with ##.
412 "Separate string between START and END into a list of tokens."
418 ;; (message "expr-start = %d" expr-start) (sit-for 1)
429 ;; (message "token: %s" token) (sit-for 1)
433 ;; TODO:
434 ;; 1. postfix 'l', 'll', 'ul' and 'ull'
435 ;; 2. floating number formats
436 ;; 3. hexadecimal/octal floats
437 ;; 4. 098 is interpreted as octal conversion error
438 ;; FIXME: string-to-number does not convert hex floats
440 token)
442 ;; FIXME: string-to-number does not convert octal floats
446 token)
449 token-list)))
453 ;;------------------------------------------------------------------------
454 ;; Translate C preprocessor #if expressions using recursive descent.
455 ;; This parser was limited to the operators &&, ||, !, and "defined".
456 ;; Added ==, !=, +, and -. Gary Oberbrunner, garyo@avs.com, 8/9/94
457 ;;
458 ;; Implement the C language operator precedence table. Add all those
459 ;; missing operators that could be used in macros. Luke Lee 2013-09-04
461 ;; | Operator Type | Operator | Associativity |
462 ;; +----------------------+-----------------------------+---------------+
463 ;; | Primary Expression | () [] . -> expr++ expr-- | left-to-right |
464 ;; | Unary Operators | * & + - ! ~ ++expr --expr | right-to-left |
465 ;; | | (typecast) sizeof | |
466 ;; | Binary Operators | * / % | left-to-right |
467 ;; | | + - | |
468 ;; | | >> << | |
469 ;; | | < > <= >= | |
470 ;; | | == != | |
471 ;; | | & | |
472 ;; | | ^ | |
473 ;; | | | | |
474 ;; | | && | |
475 ;; | | || | |
476 ;; | Ternary Operator | ?: | right-to-left |
477 ;; x| Assignment Operators | = += -= *= /= %= >>= <<= &= | right-to-left |
478 ;; | | ^= = | |
479 ;; | Comma | , | left-to-right |
482 "Pop the next token from token-list into the let variable `hif-token'."
486 "Parse the TOKEN-LIST. Return translated list in prefix form."
496 "Parse an exprlist: expr { ',' expr}"
506 result)))
509 "Parse an expression as found in #if.
510 expr : or-expr | or-expr '?' expr ':' expr."
512 middle)
521 result))
524 "Parse an or-expr : and-expr | or-expr '||' and-expr."
529 result))
532 "Parse an and-expr : logior-expr | and-expr '&&' logior-expr."
537 result))
540 "Parse a logor-expr : logxor-expr | logor-expr '|' logxor-expr."
545 result))
548 "Parse a logxor-expr : logand-expr | logxor-expr '^' logand-expr."
553 result))
556 "Parse a logand-expr : eq-expr | logand-expr '&' eq-expr."
561 result))
564 "Parse an eq-expr : comp | eq-expr `=='|`!=' comp."
571 result))
574 "Parse a comp-expr : logshift | comp-expr `<'|`>'|`>='|`<=' logshift."
581 result))
584 "Parse a logshift : math | logshift `<<'|`>>' math."
591 result))
594 "Parse an expression with + or -.
595 math : muldiv | math '+|-' muldiv."
602 result))
605 "Parse an expression with *,/,%.
606 muldiv : factor | muldiv '*|/|%' factor."
613 result))
616 "Parse a factor: '!' factor | '~' factor | '(' expr ')' | 'defined(' id ')' | 'id(parmlist)' | strings | id."
632 result)))
650 ;; Unary plus/minus.
662 "Treat VAL as a number: if it's t or nil, use 1 or 0."
715 "Evaluate a list of expr, return the result of the last item."
720 result))
723 ;;;----------- end of parser -----------------------
727 "When at beginning of #ifX, return a Lisp expression for its condition."
734 ;; (message "hif-canonicalized: %s" expr)
737 expr)))))
741 "Move to next #if..., or #ifndef, at point or after."
742 ;; (message "find ifX at %d" (point))
749 "Move to next #if..., #else, or #endif, after the current line."
750 ;; (message "hif-find-next-relevant at %d" (point))
752 ;; avoid infinite recursion by only going to beginning of line if match found
757 "Move to previous #if..., #else, or #endif, before the current line."
758 ;; (message "hif-find-previous-relevant at %d" (point))
760 ;; avoid infinite recursion by only going to beginning of line if match found
775 "If positioned at #ifX or #else form, skip to corresponding #endif."
776 ;; (message "hif-ifdef-to-endif at %d" (point)) (sit-for 1)
790 "If positioned at #endif form, skip backward to corresponding #ifX."
791 ;; (message "hif-endif-to-ifdef at %d" (point))
807 "Move point to beginning of line of the next ifdef-endif.
808 With argument, do this that many times."
824 "Move point to beginning of the previous ifdef-endif.
825 With argument, do this that many times."
842 "Move point to beginning of nested ifdef or else-part."
847 ()
853 "Move point to beginning of enclosing ifdef or else-part."
865 "Move to the beginning of the next #ifX, #else, or #endif.
866 With argument, do this that many times."
878 "Move to the beginning of the previous #ifX, #else, or #endif.
879 With argument, do this that many times."
891 ;;===%%SF%% parsing (End) ===
894 ;;===%%SF%% hide-ifdef-hiding (Start) ===
897 ;;; A range is a structure with four components:
898 ;;; ELSE-P True if there was an else clause for the ifdef.
899 ;;; START The start of the range. (beginning of line)
900 ;;; ELSE The else marker (beginning of line)
901 ;;; Only valid if ELSE-P is true.
902 ;;; END The end of the range. (beginning of line)
913 ;;; Find-Range
914 ;;; The workhorse, it delimits the #if region. Reasonably simple:
915 ;;; Skip until an #else or #endif is found, remembering positions. If
916 ;;; an #else was found, skip some more, looking for the true #endif.
919 "Return a Range structure describing the current #if region.
920 Point is left unchanged."
921 ;; (message "hif-find-range at %d" (point))
927 ;; Part one. Look for either #endif or #else.
928 ;; This loop-and-a-half dedicated to E. Dijkstra.
933 ;; Found either a #else or an #endif.
938 ;; If found #else, look for #endif.
950 ;;; A bit slimy.
953 "Hide the line containing point. Does nothing if `hide-ifdef-lines' is nil."
961 ;;; Hif-Possibly-Hide
962 ;;; There are four cases. The #ifX expression is "taken" if it
963 ;;; the hide-ifdef-evaluator returns T. Presumably, this means the code
964 ;;; inside the #ifdef would be included when the program was
965 ;;; compiled.
966 ;;;
967 ;;; Case 1: #ifX taken, and there's an #else.
968 ;;; The #else part must be hidden. The #if (then) part must be
969 ;;; processed for nested #ifX's.
970 ;;; Case 2: #ifX taken, and there's no #else.
971 ;;; The #if part must be processed for nested #ifX's.
972 ;;; Case 3: #ifX not taken, and there's an #else.
973 ;;; The #if part must be hidden. The #else part must be processed
974 ;;; for nested #ifs.
975 ;;; Case 4: #ifX not taken, and there's no #else.
976 ;;; The #ifX part must be hidden.
977 ;;;
978 ;;; Further processing is done by narrowing to the relevant region
979 ;;; and just recursively calling hide-ifdef-guts.
980 ;;;
981 ;;; When hif-possibly-hide returns, point is at the end of the
982 ;;; possibly-hidden range.
985 "Call `hide-ifdef-guts' after narrowing to end of START line and END line."
994 "Called at #ifX expression, this hides those parts that should be hidden.
995 It uses the judgment of `hide-ifdef-evaluator'."
996 ;; (message "hif-possibly-hide") (sit-for 1)
999 ;; (message "test = %s" test) (sit-for 1)
1028 "Does most of the work of `hide-ifdefs'.
1029 It does not do the work that's pointless to redo on a recursive entry."
1030 ;; (message "hide-ifdef-guts")
1036 ;;===%%SF%% hide-ifdef-hiding (End) ===
1039 ;;===%%SF%% exports (Start) ===
1042 "Toggle `hide-ifdef-read-only'."
1052 "Replacement for `toggle-read-only' within Hide-Ifdef mode."
1059 hif-outside-read-only))
1063 "Toggle shadowing."
1079 "Define a VAR so that #ifdef VAR would be included."
1085 "Undefine a VAR so that #ifdef VAR would not be included."
1092 "Hide the contents of some #ifdefs.
1093 Assume that defined symbols have been added to `hide-ifdef-env'.
1094 The text hidden is the text that would not be included by the C
1095 preprocessor if it were given the file with those symbols defined.
1097 Turn off hiding by calling `show-ifdefs'."
1113 "Cancel the effects of `hide-ifdef': show the contents of all #ifdefs."
1121 "Utility to hide and show ifdef block.
1122 Return as (TOP . BOTTOM) the extent of ifdef block."
1142 "Hide the ifdef block (true or false part) enclosing or before the cursor."
1154 "Show the ifdef block (true or false part) enclosing or before the cursor."
1167 ;;; definition alist support
1173 "Compress the define list ENV into a list of defined symbols only."
1179 "Set the association for NAME to `hide-ifdef-env'."
1182 hide-ifdef-define-alist))
1185 "Set `hide-ifdef-env' to the define list specified by NAME."
1189 hide-ifdef-define-alist)
1190 nil t)))
1202 ;;; hideif.el ends here