home *** CD-ROM | disk | FTP | other *** search
/ Education Sampler 1992 [NeXTSTEP] / Education_1992_Sampler.iso / NeXT / GnuSource / emacs-15.0.3 / lisp / outline.elc < prev    next >
Text File  |  1990-07-19  |  10KB  |  150 lines

  1.  
  2. (defvar outline-regexp "[* ]+" "\
  3. *Regular expression to match the beginning of a heading line.
  4. Any line whose beginning matches this regexp is considered a heading.
  5. The recommended way to set this is with a Local Variables: list
  6. in the file it applies to.")
  7.  
  8. (defvar outline-mode-map nil "\
  9. ")
  10.  
  11. (if outline-mode-map nil (setq outline-mode-map (copy-keymap text-mode-map)) (define-key outline-mode-map "" (quote outline-next-visible-heading)) (define-key outline-mode-map "" (quote outline-previous-visible-heading)) (define-key outline-mode-map "    " (quote show-children)) (define-key outline-mode-map "" (quote show-subtree)) (define-key outline-mode-map "" (quote hide-subtree)) (define-key outline-mode-map "" (quote outline-up-heading)) (define-key outline-mode-map "" (quote outline-forward-same-level)) (define-key outline-mode-map "" (quote outline-backward-same-level)))
  12.  
  13. (defun outline-mode nil "\
  14. Set major mode for editing outlines with selective display.
  15. Headings are lines which start with asterisks: one for major headings,
  16. two for subheadings, etc.  Lines not starting with asterisks are body lines. 
  17.  
  18. Body text or subheadings under a heading can be made temporarily
  19. invisible, or visible again.  Invisible lines are attached to the end 
  20. of the heading, so they move with it, if the line is killed and yanked
  21. back.  A heading with text hidden under it is marked with an ellipsis (...).
  22.  
  23. Commands:
  24. C-c C-n   outline-next-visible-heading      move by visible headings
  25. C-c C-p   outline-previous-visible-heading
  26. C-c C-f   outline-forward-same-level        similar but skip subheadings
  27. C-c C-b   outline-backward-same-level
  28. C-c C-u   outline-up-heading            move from subheading to heading
  29.  
  30. Meta-x hide-body    make all text invisible (not headings).
  31. Meta-x show-all        make everything in buffer visible.
  32.  
  33. The remaining commands are used when point is on a heading line.
  34. They apply to some of the body or subheadings of that heading.
  35. C-c C-h   hide-subtree    make body and subheadings invisible.
  36. C-c C-s   show-subtree    make body and subheadings visible.
  37. C-c C-i   show-children    make direct subheadings visible.
  38.          No effect on body, or subheadings 2 or more levels down.
  39.          With arg N, affects subheadings N levels down.
  40. M-x hide-entry       make immediately following body invisible.
  41. M-x show-entry       make it visible.
  42. M-x hide-leaves       make body under heading and under its subheadings invisible.
  43.              The subheadings remain visible.
  44. M-x show-branches  make all subheadings at all levels visible.
  45.  
  46. The variable outline-regexp can be changed to control what is a heading.
  47. A line is a heading if outline-regexp matches something at the
  48. beginning of the line.  The longer the match, the deeper the level.
  49.  
  50. Turning on outline mode calls the value of text-mode-hook and then of
  51. outline-mode-hook, if they are non-nil." (interactive) (byte-code "¯È³ ÈˋÉÈ˝
  52. !È˛ÉÈˇÉÈ—˙¯\"ÈÉȱ!ȼ²!È    ½
  53. ¾RÉ    È¼¸!È ½
  54. ¾RÉ Èàáâ\"Ç" [selective-display t outline-mode-map mode-name major-mode nil local-abbrev-table text-mode-abbrev-table text-mode-syntax-table paragraph-start outline-regexp paragraph-separate kill-all-local-variables use-local-map "Outline" outline-mode define-abbrev-table set-syntax-table make-local-variable "\\|^\\(" "\\)" run-hooks text-mode-hook outline-mode-hook] 10))
  55.  
  56. (defun outline-level nil "\
  57. Return the depth to which a statement is nested in the outline.
  58. Point must be at the beginning of a header line.
  59. This is actually the length of whatever outline-regexp matches." (byte-code "Êˋ!È´ˆ!˜ˆ!Z)Ç" [outline-regexp looking-at match-end 0 match-beginning] 5))
  60.  
  61. (defun outline-next-preface nil "\
  62. Skip forward to just before the next heading line." (byte-code "´ˆ˜Qˋ¯#Ģ˙!bÈh¨>IJ˚!Ç" [outline-regexp nil re-search-forward "[
  63. ]\\(" "\\)" move match-beginning 0 (10 13) forward-char -1] 4))
  64.  
  65. (defun outline-next-heading nil "\
  66. Move to the next (possibly invisible) heading line." (interactive) (byte-code "ˋÈ´ˆ˜Qˋ¯#Ģ˙!TbÇ" [outline-regexp nil re-search-forward "[
  67. ]\\(" "\\)" move match-beginning 0] 4))
  68.  
  69. (defun outline-back-to-heading nil "\
  70. Move to previous (possibly invisible) heading line,
  71. or to beginning of this line if it is a heading line." (byte-code "´ Èˆ Å˜¯˘Qˋ˙#Ç" [outline-regexp nil beginning-of-line outline-on-heading-p re-search-backward "^\\(" "\\)" move] 6))
  72.  
  73. (defun outline-on-heading-p nil "\
  74. Return T if point is on a header line." (byte-code "Êˋ Èh´=Ĉ!)Ç" [outline-regexp beginning-of-line 10 looking-at] 3))
  75.  
  76. (defun outline-next-visible-heading (arg) "\
  77. Move to the next visible heading line.
  78. With argument, repeats or can move backward if negative.
  79. A heading line is one that starts with a `*' (or that outline-regexp matches)." (interactive "p") (byte-code "´ÈˆW˜ Á¯ È˘˙    ¨Q´´$Ș Ç" [arg outline-regexp nil 0 beginning-of-line end-of-line re-search-forward "^\\(" "\\)"] 7))
  80.  
  81. (defun outline-previous-visible-heading (arg) "\
  82. Move to the previous heading line.
  83. With argument, repeats or can move forward if negative.
  84. A heading line is one that starts with a `*' (or that outline-regexp matches)." (interactive "p") (byte-code "ˋÈ´[!Ç" [arg nil outline-next-visible-heading] 2))
  85.  
  86. (defun outline-flag-region (from to flag) "\
  87. Hides or shows lines from FROM to TO, according to FLAG.
  88. If FLAG is `\\n' (newline character) then text is shown,
  89. while if FLAG is `\\^M' (control-M) the text is hidden." (byte-code "¯ ˘Î˙    
  90. ¨U²Á¨ ˜%))Ç" [modp from to flag t buffer-modified-p ((byte-code "ˋ!Ç" [modp set-buffer-modified-p] 2)) subst-char-in-region 10 13] 7))
  91.  
  92. (defun hide-entry nil "\
  93. Hide the body directly following this heading." (interactive) (byte-code "¹Èˋ ÈÊ´`ˆ È`˜#)Ç" [nil outline-back-to-heading outline-flag-region outline-next-preface 13] 6))
  94.  
  95. (defun show-entry nil "\
  96. Show the body directly following this heading." (interactive) (byte-code "¹ÈÊˋ`´ È`ˆ#)Ç" [nil outline-flag-region outline-next-preface 10] 5))
  97.  
  98. (defun hide-body nil "\
  99. Hide all of buffer except headings." (interactive) (byte-code "¹Èˋed\"Ç" [nil hide-region-body] 3))
  100.  
  101. (defun hide-region-body (start end) "\
  102. Hide all body lines in the region, but not headings." (byte-code "ÊÌ´    \"ÈebÈm?Ä.ˆ`˜ È`¯#Èm?Ä*˘˙¨!Â(²Á)˚!ÈÁ
  103. ))Ç" [start end narrow-to-region outline-flag-region outline-next-preface 13 forward-char looking-at "[
  104. ][
  105. ]" 2 1] 7))
  106.  
  107. (defun show-all nil "\
  108. Show all of the text in the buffer." (interactive) (byte-code "¹Èˋed´#Ç" [nil outline-flag-region 10] 4))
  109.  
  110. (defun hide-subtree nil "\
  111. Hide everything after this heading at deeper levels." (interactive) (byte-code "¹Èˋ´!Ç" [nil outline-flag-subtree 13] 2))
  112.  
  113. (defun hide-leaves nil "\
  114. Hide all body after this heading at deeper levels." (interactive) (byte-code "¹Èˋ È´`ˆ È`\"Ç" [nil outline-back-to-heading hide-region-body outline-end-of-subtree] 5))
  115.  
  116. (defun show-subtree nil "\
  117. Show everything after this heading at deeper levels." (interactive) (byte-code "¹Èˋ´!Ç" [nil outline-flag-subtree 10] 2))
  118.  
  119. (defun outline-flag-subtree (flag) (byte-code "Êˋ È´`ˆ È`#)Ç" [flag outline-back-to-heading outline-flag-region outline-end-of-subtree] 6))
  120.  
  121. (defun outline-end-of-subtree nil (byte-code "¯ È`´˘ m?Ä    Å˘  VÄ$˜ÉÈ˙ ÈÁ
  122. Ȩ²!Èh˚>Ä2¨²!+Ç" [opoint first t level nil beginning-of-line outline-level outline-next-heading forward-char -1 (10 13)] 7))
  123.  
  124. (defun show-branches nil "\
  125. Show all subheadings of this heading, but not their bodies." (interactive) (byte-code "¹Èˋ´!Ç" [nil show-children 1000] 2))
  126.  
  127. (defun show-children (&optional level) "\
  128. Show all direct subheadings of this heading.  Optional LEVEL specifies
  129. how many levels below the current level should be shown." (interactive "p") (byte-code "´ÈÅ    ˆÉÈÊ̘ È¯ \\ÉÈ˘`˙ È`T\"ÈebÈm?Ä,¨ Èm?ÄS¯ XÄOÊ`T²˚!Èh¸>ÄG²˚!ȳ`    ˝#))ÈÁ\"))Ç" [level end nil 1 beginning-of-line outline-level narrow-to-region outline-end-of-subtree outline-next-heading forward-char -1 (10 13) outline-flag-region 10] 13))
  130.  
  131. (defun outline-up-heading (arg) "\
  132. Move to the heading line of which the present line is a subheading.
  133. With argument, move up ARG levels." (interactive "p") (byte-code "´Èˆ È˜ ¯=Ģ˙!Ș ¯VĨVÄo?Ä?˜ ˜     W?Ä4²¯!ÈÁ%ȯZÉ)ÈÁÇ" [arg present-level nil outline-back-to-heading outline-level 1 error "" 0 outline-previous-visible-heading] 10))
  134.  
  135. (defun outline-forward-same-level (arg) "\
  136. Move forward to the ARG'th subheading from here of the same level as the
  137. present one. It stops at the first and last subheadings of a superior heading." (interactive "p") (byte-code "´Èˆ È˜VÄ*ʯ )    Â    bÈSÉÁ%˜ÉÈ˘˙!)ÈÁÇ" [arg point-to-move-to nil outline-back-to-heading 0 outline-get-next-sibling error ""] 5))
  138.  
  139. (defun outline-get-next-sibling nil "\
  140. Position the point at the next heading of the same level, 
  141. and return that position or nil if it cannot be found." (byte-code "´ ˆ˜!È´ VÄm?Ĉ˜!ÈÁÈ´ WÂ&ˋÁ'`)Ç" [level nil outline-level outline-next-visible-heading 1] 7))
  142.  
  143. (defun outline-backward-same-level (arg) "\
  144. Move backward to the ARG'th subheading from here of the same level as the
  145. present one. It stops at the first and last subheadings of a superior heading." (interactive "p") (byte-code "´Èˆ È˜VÄ*ʯ )    Â    bÈSÉÁ%˜ÉÈ˘˙!)ÈÁÇ" [arg point-to-move-to nil outline-back-to-heading 0 outline-get-last-sibling error ""] 5))
  146.  
  147. (defun outline-get-last-sibling nil "\
  148. Position the point at the previous heading of the same level, 
  149. and return that position or nil if it cannot be found." (byte-code "´ ˆ˜!È´ VÄo?Ĉ˜!ÈÁÈ´ WÂ&ˋÁ'`)Ç" [level nil outline-level outline-previous-visible-heading 1] 7))
  150.