| blob | a43b91ce091d3bb439f86ae644222570cf0ed028 |
1 ;;; hide-ifdef-mode.el --- ides selected code within ifdef.
3 ;;; Copyright (C) 1988 Brian Marick and Daniel LaLiberte
4 ;;; Written by Brian Marick, at Gould, Computer Systems Division, Urbana IL.
5 ;;; Extensively modified by Daniel LaLiberte (while at Gould).
6 ;;;
7 ;;; You may freely modify and distribute this, but keep a record
8 ;;; of modifications and send comments to:
9 ;;; liberte@a.cs.uiuc.edu or ihnp4!uiucdcs!liberte
10 ;;; I will continue to upgrade hide-ifdef-mode
11 ;;; with your contributions and will eventually offer it to FSF.
12 ;;;
13 ;;; $Header: hide-ifdef-mode.el,v 1.7 88/02/16 03:12:58 liberte Exp $
14 ;;;
15 ;;; $Log: hide-ifdef-mode.el,v $
16 ;;; Revision 1.7 88/02/16 03:12:58 liberte
17 ;;; Fixed comments and doc strings.
18 ;;; Added optional prefix arg for ifdef motion commands.
19 ;;;
20 ;;; Revision 1.6 88/02/05 00:36:18 liberte
21 ;;; Bug fixes.
22 ;;; 1. A multi-line comment that starts on an #ifdef line
23 ;;; now ends on that line.
24 ;;; 2. Fix bad function name: hide-hif-ifdef-toggle-read-only
25 ;;; 3. Make ifdef-block hiding work outside of ifdefs.
26 ;;;
27 ;;; Revision 1.5 88/01/31 23:19:31 liberte
28 ;;; Major clean up.
29 ;;; Prefix internal names with "hif-".
30 ;;;
31 ;;; Revision 1.4 88/01/30 14:09:38 liberte
32 ;;; Add hide-ifdef-hiding and hide-ifdef-mode to minor-mode-alist.
33 ;;;
34 ;;; Revision 1.3 88/01/29 00:38:19 liberte
35 ;;; Fix three bugs.
36 ;;; 1. Function "defined" is just like lookup.
37 ;;; 2. Skip to newline or cr in case text is hidden.
38 ;;; 3. Use car of token list if just one symbol.
39 ;;;
40 ;;; Revision 1.2 88/01/28 23:32:46 liberte
41 ;;; Use hide-ifdef-mode-prefix-key.
42 ;;; Copy current-local-map so other buffers do not get
43 ;;; hide-ifdef-mode bindings.
44 ;;;
45 ;;;--------------------------------------------------------------
46 ;;; To initialize, toggle the hide-ifdef minor mode with
47 ;;;
48 ;;; M-x hide-ifdef-mode
49 ;;;
50 ;;; This will set up key bindings and call hide-ifdef-mode-hook if it
51 ;;; has a value. To explicitly hide ifdefs using a buffer-local
52 ;;; define list (default empty), type
53 ;;;
54 ;;; M-x hide-ifdefs or C-c h
55 ;;;
56 ;;; Hide-ifdef suppresses the display of code that the preprocessor wouldn't
57 ;;; pass through. The support of constant expressions in #if lines is
58 ;;; limited to identifiers, parens, and the operators: &&, ||, !, and
59 ;;; "defined". Please extend this.
60 ;;;
61 ;;; The hidden code is marked by ellipses (...). Be
62 ;;; cautious when editing near ellipses, since the hidden text is
63 ;;; still in the buffer, and you can move the point into it and modify
64 ;;; text unawares. If you don't want to see the ellipses, set
65 ;;; selective-display-ellipses to nil. But this can be dangerous.
66 ;;; You can make your buffer read-only while hide-ifdef-hiding by setting
67 ;;; hide-ifdef-read-only to a non-nil value. You can toggle this
68 ;;; variable with hide-ifdef-toggle-read-only (C-c C-q).
69 ;;;
70 ;;; You can undo the effect of hide-ifdefs by typing
71 ;;;
72 ;;; M-x show-ifdefs or C-c s
73 ;;;
74 ;;; Use M-x hide-ifdef-define (C-c d) to define a symbol.
75 ;;; Use M-x hide-ifdef-undef (C-c u) to undefine a symbol.
76 ;;;
77 ;;; If you define or undefine a symbol while hide-ifdef-mode is in effect,
78 ;;; the display will be updated. Only the define list for the current
79 ;;; buffer will be affected. You can save changes to the local define
80 ;;; list with hide-ifdef-set-define-alist. This adds entries
81 ;;; to hide-ifdef-define-alist.
82 ;;;
83 ;;; If you have defined a hide-ifdef-mode-hook, you can set
84 ;;; up a list of symbols that may be used by hide-ifdefs as in the
85 ;;; following example:
86 ;;;
87 ;;; (setq hide-ifdef-mode-hook
88 ;;; '(lambda ()
89 ;;; (if (not hide-ifdef-define-alist)
90 ;;; (setq hide-ifdef-define-alist
91 ;;; '((list1 ONE TWO)
92 ;;; (list2 TWO THREE)
93 ;;; )))
94 ;;; (hide-ifdef-use-define-alist 'list2) ; use list2 by default
95 ;;; ))
96 ;;;
97 ;;; You can call hide-ifdef-use-define-alist (C-c u) at any time to specify
98 ;;; another list to use.
99 ;;;
100 ;;; To cause ifdefs to be hidden as soon as hide-ifdef-mode is called,
101 ;;; set hide-ifdef-initially to non-nil.
102 ;;;
103 ;;; If you set hide-ifdef-lines to t, hide-ifdefs hides all the #ifdef lines.
104 ;;; In the absence of highlighting, that might be a bad idea. If you set
105 ;;; hide-ifdef-lines to nil (the default), the surrounding preprocessor
106 ;;; lines will be displayed. That can be confusing in its own
107 ;;; right. Other variations on display are possible, but not much
108 ;;; better.
109 ;;;
110 ;;; You can explicitly hide or show individual ifdef blocks irrespective
111 ;;; of the define list by using hide-ifdef-block and show-ifdef-block.
112 ;;;
113 ;;; You can move the point between ifdefs with forward-ifdef, backward-ifdef,
114 ;;; up-ifdef, down-ifdef, next-ifdef, and previous-ifdef.
115 ;;;
116 ;;; If you have minor-mode-alist in your mode line (the default) two labels
117 ;;; may appear. "Ifdef" will appear when hide-ifdef-mode is active. "Hiding"
118 ;;; will appear when text may be hidden ("hide-ifdef-hiding" is non-nil).
129 "Buffer-local variable to store a copy of the local keymap
156 )
158 )
161 "Update mode-line by setting buffer-modified to itself."
173 minor-mode-alist)))
178 minor-mode-alist)))
181 "Toggle Hide-Ifdef mode. This is a minor mode, albeit a large one.
182 With ARG, turn Hide-Ifdef mode on iff arg is positive.
183 In Hide-Ifdef mode, code within #ifdef constructs that the C preprocessor
184 would eliminate may be hidden from view. Several variables affect
185 how the hiding is done:
187 hide-ifdef-env
188 An association list of defined and undefined symbols for the
189 current buffer. Initially, the global value of `hide-ifdef-env'
190 is used.
192 hide-ifdef-define-alist
193 An association list of defined symbol lists.
194 Use `hide-ifdef-set-define-alist' to save the current `hide-ifdef-env'
195 and `hide-ifdef-use-define-alist' to set the current `hide-ifdef-env'
196 from one of the lists in `hide-ifdef-define-alist'.
198 hide-ifdef-lines
199 Set to non-nil to not show #if, #ifdef, #ifndef, #else, and
200 #endif lines when hiding.
202 hide-ifdef-initially
203 Indicates whether `hide-ifdefs' should be called when Hide-Ifdef mode
204 is activated.
206 hide-ifdef-read-only
207 Set to non-nil if you want to make buffers read only while hiding.
208 After `show-ifdefs', read-only status is restored to previous value.
223 ; fix c-mode syntax table so we can recognize whole symbols.
228 ; inherit global values
251 )
252 ; else end hide-ifdef-mode
257 ))
260 ;; from outline.el with docstring fixed.
262 "Hides or shows lines from FROM to TO, according to FLAG. If FLAG
264 \(control-M) the text is hidden."
269 flag t) )
271 ))
274 "Show all of the text in the current buffer."
279 "START is the start of a #if or #else form. END is the ending part.
280 Everything including these lines is made invisible."
282 )
285 "Everything between START and END is made visible."
287 )
291 ;===%%SF%% evaluation (Start) ===
294 "The evaluator is given a canonical form and returns T if text under
305 "Prepend (var value) pair to hide-ifdef-env."
310 ; (message "hif-lookup %s" var)
314 hif-undefined-symbol)))
318 ; when #if expressions are fully supported, defined result should be 1
319 ; (if (assoc var hide-ifdef-env)
320 ; 1
321 ; nil)
322 )
325 ;===%%SF%% evaluation (End) ===
329 ;===%%SF%% parsing (Start) ===
330 ;;; The code that understands what ifs and ifdef in files look like.
342 "Convert list of tokens in infix into prefix list"
343 ; (message "hif-infix-to-prefix: %s" token-list)
347 )
349 ; pattern to match initial identifier, !, &&, ||, (, or ).
355 "Separate string into a list of tokens"
361 ; (message "expr-start = %d" expr-start) (sit-for 1)
364 ; skip whitespace
366 ; stick newline in string so ^ matches on the next string-match
368 )
379 )
385 ; (message "token: %s" token) (sit-for 1)
396 token-list))
397 ))
399 ))
401 ))
403 ;;;-----------------------------------------------------------------
404 ;;; Translate C preprocessor #if expressions using recursive descent.
405 ;;; This parser is limited to the operators &&, ||, !, and "defined".
408 "Parse the TOKEN-LIST. Return translated list in prefix form."
419 token)
422 "Parse and expression of the form
423 expr : term | expr '||' term."
428 result))
431 "Parse a term of the form
432 term : factor | term '&&' factor."
437 result))
440 "Parse a factor of the form
441 factor : '!' factor | '(' expr ')' | 'defined(' id ')' | id."
453 result)))
468 ))
476 ))
477 ))
479 ;;;----------- end of parser -----------------------
483 "When at beginning of #ifX, returns a canonical (evaluatable)
484 form for the expression."
492 ; (message "hif-canonicalized: %s" expr)
495 expr)))))
499 "Position at beginning of next #if, #ifdef, or #ifndef, including one on
500 this line."
501 ; (message "find ifX at %d" (point))
508 "Position at beginning of next #ifdef, #ifndef, #else, #endif,
509 NOT including one on this line."
510 ; (message "hif-find-next-relevant at %d" (point))
512 ; avoid infinite recursion by only going to beginning of line if match found
517 "Position at beginning of previous #ifdef, #ifndef, #else, #endif,
518 NOT including one on this line."
519 ; (message "hif-find-previous-relevant at %d" (point))
521 ; avoid infinite recursion by only going to beginning of line if match found
536 "If positioned at #ifX or #else form, skip to corresponding #endif."
537 ; (message "hif-ifdef-to-endif at %d" (point)) (sit-for 1)
551 "If positioned at #endif form, skip backward to corresponding #ifX."
552 ; (message "hif-endif-to-ifdef at %d" (point))
568 "Move point to beginning of line of the next ifdef-endif.
569 With argument, do this that many times."
583 ))))
587 "Move point to beginning of the previous ifdef-endif.
588 With argument, do this that many times."
606 "Move point to beginning of nested ifdef or else-part."
611 ()
617 "Move point to beginning of enclosing ifdef or else-part."
629 "Move to the beginning of the next #ifX, #else, or #endif.
630 With argument, do this that many times."
644 "Move to the beginning of the previous #ifX, #else, or #endif.
645 With argument, do this that many times."
656 ))))
659 ;===%%SF%% parsing (End) ===
662 ;===%%SF%% hide-ifdef-hiding (Start) ===
665 ;;; A range is a structure with four components:
666 ;;; ELSE-P True if there was an else clause for the ifdef.
667 ;;; START The start of the range. (beginning of line)
668 ;;; ELSE The else marker (beginning of line)
669 ;;; Only valid if ELSE-P is true.
670 ;;; END The end of the range. (beginning of line)
682 ;;; Find-Range
683 ;;; The workhorse, it delimits the #if region. Reasonably simple:
684 ;;; Skip until an #else or #endif is found, remembering positions. If
685 ;;; an #else was found, skip some more, looking for the true #endif.
688 "Returns a Range structure describing the current #if region.
689 Point is left unchanged."
690 ; (message "hif-find-range at %d" (point))
697 ;; Part one. Look for either #endif or #else.
698 ;; This loop-and-a-half dedicated to E. Dijkstra.
703 ;; Found either a #else or an #endif.
709 ))
710 ;; If found #else, look for #endif.
720 ))
724 ;;; A bit slimy.
725 ;;; NOTE: If there's an #ifdef at the beginning of the file, we can't
726 ;;; hide it. There's no previous newline to replace. If we added
727 ;;; one, we'd throw off all the counts. Feh.
730 "Hide the line containing point. Does nothing if `hide-ifdef-lines' is nil."
741 ))
742 ))
745 ;;; Hif-Possibly-Hide
746 ;;; There are four cases. The #ifX expression is "taken" if it
747 ;;; the hide-ifdef-evaluator returns T. Presumably, this means the code
748 ;;; inside the #ifdef would be included when the program was
749 ;;; compiled.
750 ;;;
751 ;;; Case 1: #ifX taken, and there's an #else.
752 ;;; The #else part must be hidden. The #if (then) part must be
753 ;;; processed for nested #ifX's.
754 ;;; Case 2: #ifX taken, and there's no #else.
755 ;;; The #if part must be processed for nested #ifX's.
756 ;;; Case 3: #ifX not taken, and there's an #else.
757 ;;; The #if part must be hidden. The #else part must be processed
758 ;;; for nested #ifs.
759 ;;; Case 4: #ifX not taken, and there's no #else.
760 ;;; The #ifX part must be hidden.
761 ;;;
762 ;;; Further processing is done by narrowing to the relevant region
763 ;;; and just recursively calling hide-ifdef-guts.
764 ;;;
765 ;;; When hif-possibly-hide returns, point is at the end of the
766 ;;; possibly-hidden range.
769 "Call `hide-ifdef-guts' after narrowing to end of START line and END line."
778 "Called at #ifX expression, this hides those parts that should be
779 hidden, according to judgement of `hide-ifdef-evaluator'."
780 ; (message "hif-possibly-hide") (sit-for 1)
783 ; (message "test = %s" test) (sit-for 1)
805 ))
809 ))
814 "Does the work of `hide-ifdefs', except for the work that's pointless
815 to redo on a recursive entry."
816 ; (message "hide-ifdef-guts")
822 ;===%%SF%% hide-ifdef-hiding (End) ===
825 ;===%%SF%% exports (Start) ===
828 "*Non-nil if `hide-ifdefs' should be called when Hide-Ifdef mode
844 "Toggle hide-ifdef-read-only."
854 "Replacement for `toggle-read-only' within Hide-Ifdef mode."
861 hif-outside-read-only)
862 )
867 "Define a VAR so that #ifdef VAR would be included."
873 "Undefine a VAR so that #ifdef VAR would not be included."
880 "Hide the contents of some #ifdefs. Assume that defined symbols have
881 been added to `hide-ifdef-env'. The text hidden is the text that would not
882 be included by the C preprocessor if it were given the file with those
883 symbols defined.
885 Turn off hiding by calling show-ifdef."
903 "Cancel the effects of hide-ifdef. The contents of all #ifdefs is shown."
914 "Utilitiy for hide and show ifdef-block. Set top and bottom of ifdef block."
931 )
935 "Hide the ifdef block (true or false part) enclosing or before the cursor."
954 "Show the ifdef block (true or false part) enclosing or before the cursor."
966 )
968 ; restore read only status since we dont know if all is shown.
972 ;;; defininition alist support
978 "Compress the define list ENV into a list of defined symbols only."
981 env))
987 new-defs))
990 "Set the association for NAME to hide-ifdef-env."
994 hide-ifdef-define-alist)))
997 "Set hide-ifdef-env to the define list specified by NAME."
1007 ;;; hideif.el ends here