1 ;;; pascal.el --- major mode for editing pascal source in Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1993-2011 Free Software Foundation, Inc.
5 ;; Author: Espen Skoglund <esk@gnu.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; Emacs should enter Pascal mode when you find a Pascal source file.
29 ;; When you have entered Pascal mode, you may get more info by pressing
30 ;; C-h m. You may also get online help describing various functions by:
31 ;; C-h f <Name of function you want described>
33 ;; If you want to customize Pascal mode to fit you better, you may add
34 ;; these lines (the values of the variables presented here are the defaults):
36 ;; ;; User customization for Pascal mode
37 ;; (setq pascal-indent-level 3
38 ;; pascal-case-indent 2
39 ;; pascal-auto-newline nil
40 ;; pascal-tab-always-indent t
41 ;; pascal-auto-endcomments t
42 ;; pascal-auto-lineup '(all)
43 ;; pascal-toggle-completions nil
44 ;; pascal-type-keywords '("array" "file" "packed" "char"
45 ;; "integer" "real" "string" "record")
46 ;; pascal-start-keywords '("begin" "end" "function" "procedure"
47 ;; "repeat" "until" "while" "read" "readln"
48 ;; "reset" "rewrite" "write" "writeln")
49 ;; pascal-separator-keywords '("downto" "else" "mod" "div" "then"))
51 ;; KNOWN BUGS / BUGREPORTS
52 ;; =======================
53 ;; As far as I know, there are no bugs in the current version of this
54 ;; package. This may not be true however, since I never use this mode
55 ;; myself and therefore would never notice them anyway. If you do
56 ;; find any bugs, you may submit them to: esk@gnu.org as well as to
57 ;; bug-gnu-emacs@gnu.org.
61 (eval-when-compile (require 'cl))
64 "Major mode for editing Pascal source in Emacs."
65 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
68 (defvar pascal-mode-abbrev-table nil
69 "Abbrev table in use in Pascal-mode buffers.")
70 (define-abbrev-table 'pascal-mode-abbrev-table ())
72 (defvar pascal-mode-map
73 (let ((map (make-sparse-keymap)))
74 (define-key map ";" 'electric-pascal-semi-or-dot)
75 (define-key map "." 'electric-pascal-semi-or-dot)
76 (define-key map ":" 'electric-pascal-colon)
77 (define-key map "=" 'electric-pascal-equal)
78 (define-key map "#" 'electric-pascal-hash)
79 ;; These are user preferences, so not to set by default.
80 ;;(define-key map "\r" 'electric-pascal-terminate-line)
81 ;;(define-key map "\t" 'electric-pascal-tab)
82 (define-key map "\M-\t" 'pascal-complete-word)
83 (define-key map "\M-?" 'pascal-show-completions)
84 (define-key map "\177" 'backward-delete-char-untabify)
85 (define-key map "\M-\C-h" 'pascal-mark-defun)
86 (define-key map "\C-c\C-b" 'pascal-insert-block)
87 (define-key map "\M-*" 'pascal-star-comment)
88 (define-key map "\C-c\C-c" 'pascal-comment-area)
89 (define-key map "\C-c\C-u" 'pascal-uncomment-area)
90 (define-key map "\M-\C-a" 'pascal-beg-of-defun)
91 (define-key map "\M-\C-e" 'pascal-end-of-defun)
92 (define-key map "\C-c\C-d" 'pascal-goto-defun)
93 (define-key map "\C-c\C-o" 'pascal-outline-mode)
94 ;; A command to change the whole buffer won't be used terribly
95 ;; often, so no need for a key binding.
96 ;; (define-key map "\C-cd" 'pascal-downcase-keywords)
97 ;; (define-key map "\C-cu" 'pascal-upcase-keywords)
98 ;; (define-key map "\C-cc" 'pascal-capitalize-keywords)
100 "Keymap used in Pascal mode.")
102 (defvar pascal-imenu-generic-expression
103 '((nil "^[ \t]*\\(function\\|procedure\\)[ \t\n]+\\([a-zA-Z0-9_.:]+\\)" 2))
104 "Imenu expression for Pascal-mode. See `imenu-generic-expression'.")
106 (defvar pascal-keywords
107 '("and" "array" "begin" "case" "const" "div" "do" "downto" "else" "end"
108 "file" "for" "function" "goto" "if" "in" "label" "mod" "nil" "not" "of"
109 "or" "packed" "procedure" "program" "record" "repeat" "set" "then" "to"
110 "type" "until" "var" "while" "with"
111 ;; The following are not standard in pascal, but widely used.
112 "get" "put" "input" "output" "read" "readln" "reset" "rewrite" "write"
116 ;;; Regular expressions used to calculate indent, etc.
118 (defconst pascal-symbol-re "\\<[a-zA-Z_][a-zA-Z_0-9.]*\\>")
119 (defconst pascal-beg-block-re "\\<\\(begin\\|case\\|record\\|repeat\\)\\>")
120 (defconst pascal-end-block-re "\\<\\(end\\|until\\)\\>")
121 (defconst pascal-declaration-re "\\<\\(const\\|label\\|type\\|var\\)\\>")
122 (defconst pascal-progbeg-re "\\<\\program\\>")
123 (defconst pascal-defun-re "\\<\\(function\\|procedure\\|program\\)\\>")
124 (defconst pascal-sub-block-re "\\<\\(if\\|else\\|for\\|while\\|with\\)\\>")
125 (defconst pascal-noindent-re "\\<\\(begin\\|end\\|until\\|else\\)\\>")
126 (defconst pascal-nosemi-re "\\<\\(begin\\|repeat\\|then\\|do\\|else\\)\\>")
127 (defconst pascal-autoindent-lines-re
128 "\\<\\(label\\|var\\|type\\|const\\|until\\|end\\|begin\\|repeat\\|else\\)\\>")
130 ;;; Strings used to mark beginning and end of excluded text
131 (defconst pascal-exclude-str-start "{-----\\/----- EXCLUDED -----\\/-----")
132 (defconst pascal-exclude-str-end " -----/\\----- EXCLUDED -----/\\-----}")
134 (defvar pascal-mode-syntax-table
135 (let ((st (make-syntax-table)))
136 (modify-syntax-entry ?\\ "." st)
137 (modify-syntax-entry ?\( "()1" st)
138 (modify-syntax-entry ?\) ")(4" st)
139 ;; This used to use comment-syntax `b'. But the only document I could
140 ;; find about the syntax of Pascal's comments said that (* ... } is
141 ;; a valid comment, just as { ... *) or (* ... *) or { ... }.
142 (modify-syntax-entry ?* ". 23" st)
143 (modify-syntax-entry ?{ "<" st)
144 (modify-syntax-entry ?} ">" st)
145 (modify-syntax-entry ?+ "." st)
146 (modify-syntax-entry ?- "." st)
147 (modify-syntax-entry ?= "." st)
148 (modify-syntax-entry ?% "." st)
149 (modify-syntax-entry ?< "." st)
150 (modify-syntax-entry ?> "." st)
151 (modify-syntax-entry ?& "." st)
152 (modify-syntax-entry ?| "." st)
153 (modify-syntax-entry ?_ "_" st)
154 (modify-syntax-entry ?\' "\"" st)
156 "Syntax table in use in Pascal-mode buffers.")
160 (defconst pascal-font-lock-keywords (purecopy
162 '("^[ \t]*\\(function\\|pro\\(cedure\\|gram\\)\\)\\>[ \t]*\\([a-z]\\)"
163 1 font-lock-keyword-face)
164 '("^[ \t]*\\(function\\|pro\\(cedure\\|gram\\)\\)\\>[ \t]*\\([a-z][a-z0-9_]*\\)"
165 3 font-lock-function-name-face t)
166 ; ("type" "const" "real" "integer" "char" "boolean" "var"
167 ; "record" "array" "file")
168 (cons (concat "\\<\\(array\\|boolean\\|c\\(har\\|onst\\)\\|file\\|"
169 "integer\\|re\\(al\\|cord\\)\\|type\\|var\\)\\>")
170 'font-lock-type-face)
171 '("\\<\\(label\\|external\\|forward\\)\\>" . font-lock-constant-face)
172 '("\\<\\([0-9]+\\)[ \t]*:" 1 font-lock-function-name-face)
173 ; ("of" "to" "for" "if" "then" "else" "case" "while"
174 ; "do" "until" "and" "or" "not" "in" "with" "repeat" "begin" "end")
176 "and\\|begin\\|case\\|do\\|e\\(lse\\|nd\\)\\|for\\|i[fn]\\|"
177 "not\\|o[fr]\\|repeat\\|t\\(hen\\|o\\)\\|until\\|w\\(hile\\|ith\\)"
179 '("\\<\\(goto\\)\\>[ \t]*\\([0-9]+\\)?"
180 1 font-lock-keyword-face)
181 '("\\<\\(goto\\)\\>[ \t]*\\([0-9]+\\)?"
182 2 font-lock-keyword-face t)))
183 "Additional expressions to highlight in Pascal mode.")
184 (put 'pascal-mode 'font-lock-defaults '(pascal-font-lock-keywords nil t))
186 (defcustom pascal-indent-level 3
187 "*Indentation of Pascal statements with respect to containing block."
191 (defcustom pascal-case-indent 2
192 "*Indentation for case statements."
196 (defcustom pascal-auto-newline nil
197 "*Non-nil means automatically insert newlines in certain cases.
198 These include after semicolons and after the punctuation mark after an `end'."
202 (defcustom pascal-indent-nested-functions t
203 "*Non-nil means nested functions are indented."
207 (defcustom pascal-tab-always-indent t
208 "*Non-nil means TAB in Pascal mode should always reindent the current line.
209 If this is nil, TAB inserts a tab if it is at the end of the line
210 and follows non-whitespace text."
214 (defcustom pascal-auto-endcomments t
215 "*Non-nil means automatically insert comments after certain `end's.
216 Specifically, this is done after the ends of cases statements and functions.
217 The name of the function or case is included between the braces."
221 (defcustom pascal-auto-lineup '(all)
222 "*List of contexts where auto lineup of :'s or ='s should be done.
223 Elements can be of type: 'paramlist', 'declaration' or 'case', which will
224 do auto lineup in parameterlist, declarations or case-statements
225 respectively. The word 'all' will do all lineups. '(case paramlist) for
226 instance will do lineup in case-statements and parameterlist, while '(all)
227 will do all lineups."
228 :type '(set :extra-offset 8
229 (const :tag "Everything" all)
230 (const :tag "Parameter lists" paramlist)
231 (const :tag "Decalrations" declaration)
232 (const :tag "Case statements" case))
235 (defcustom pascal-toggle-completions nil
236 "*Non-nil means \\<pascal-mode-map>\\[pascal-complete-word] should try all possible completions one by one.
237 Repeated use of \\[pascal-complete-word] will show you all of them.
238 Normally, when there is more than one possible completion,
239 it displays a list of all possible completions."
243 (defcustom pascal-type-keywords
244 '("array" "file" "packed" "char" "integer" "real" "string" "record")
245 "*Keywords for types used when completing a word in a declaration or parmlist.
246 These include integer, real, char, etc.
247 The types defined within the Pascal program
248 are handled in another way, and should not be added to this list."
249 :type '(repeat (string :tag "Keyword"))
252 (defcustom pascal-start-keywords
253 '("begin" "end" "function" "procedure" "repeat" "until" "while"
254 "read" "readln" "reset" "rewrite" "write" "writeln")
255 "*Keywords to complete when standing at the first word of a statement.
256 These are keywords such as begin, repeat, until, readln.
257 The procedures and variables defined within the Pascal program
258 are handled in another way, and should not be added to this list."
259 :type '(repeat (string :tag "Keyword"))
262 (defcustom pascal-separator-keywords
263 '("downto" "else" "mod" "div" "then")
264 "*Keywords to complete when NOT standing at the first word of a statement.
265 These are keywords such as downto, else, mod, then.
266 Variables and function names defined within the Pascal program
267 are handled in another way, and should not be added to this list."
268 :type '(repeat (string :tag "Keyword"))
276 (defun pascal-declaration-end ()
278 (while (and (> nest 0)
280 "[:=]\\|\\(\\<record\\>\\)\\|\\(\\<end\\>\\)"
282 (cond ((match-beginning 1) (setq nest (1+ nest)))
283 ((match-beginning 2) (setq nest (1- nest)))
284 ((looking-at "[^(\n]+)") (setq nest 0))))))
287 (defun pascal-declaration-beg ()
289 (while (and (> nest 0)
290 (re-search-backward "[:=]\\|\\<\\(type\\|var\\|label\\|const\\)\\>\\|\\(\\<record\\>\\)\\|\\(\\<end\\>\\)" (point-at-bol 0) t))
291 (cond ((match-beginning 1) (setq nest 0))
292 ((match-beginning 2) (setq nest (1- nest)))
293 ((match-beginning 3) (setq nest (1+ nest)))))
297 (defsubst pascal-within-string ()
298 (nth 3 (parse-partial-sexp (point-at-bol) (point))))
302 (define-derived-mode pascal-mode prog-mode "Pascal"
303 "Major mode for editing Pascal code. \\<pascal-mode-map>
304 TAB indents for Pascal code. Delete converts tabs to spaces as it moves back.
306 \\[pascal-complete-word] completes the word around current point with respect \
308 \\[pascal-show-completions] shows all possible completions at this point.
310 Other useful functions are:
312 \\[pascal-mark-defun]\t- Mark function.
313 \\[pascal-insert-block]\t- insert begin ... end;
314 \\[pascal-star-comment]\t- insert (* ... *)
315 \\[pascal-comment-area]\t- Put marked area in a comment, fixing nested comments.
316 \\[pascal-uncomment-area]\t- Uncomment an area commented with \
317 \\[pascal-comment-area].
318 \\[pascal-beg-of-defun]\t- Move to beginning of current function.
319 \\[pascal-end-of-defun]\t- Move to end of current function.
320 \\[pascal-goto-defun]\t- Goto function prompted for in the minibuffer.
321 \\[pascal-outline-mode]\t- Enter `pascal-outline-mode'.
323 Variables controlling indentation/edit style:
325 `pascal-indent-level' (default 3)
326 Indentation of Pascal statements with respect to containing block.
327 `pascal-case-indent' (default 2)
328 Indentation for case statements.
329 `pascal-auto-newline' (default nil)
330 Non-nil means automatically newline after semicolons and the punctuation
332 `pascal-indent-nested-functions' (default t)
333 Non-nil means nested functions are indented.
334 `pascal-tab-always-indent' (default t)
335 Non-nil means TAB in Pascal mode should always reindent the current line,
336 regardless of where in the line point is when the TAB command is used.
337 `pascal-auto-endcomments' (default t)
338 Non-nil means a comment { ... } is set after the ends which ends cases and
339 functions. The name of the function or case will be set between the braces.
340 `pascal-auto-lineup' (default t)
341 List of contexts where auto lineup of :'s or ='s should be done.
343 See also the user variables `pascal-type-keywords', `pascal-start-keywords' and
344 `pascal-separator-keywords'.
346 Turning on Pascal mode calls the value of the variable pascal-mode-hook with
347 no args, if that value is non-nil."
348 (set (make-local-variable 'local-abbrev-table) pascal-mode-abbrev-table)
349 (set (make-local-variable 'indent-line-function) 'pascal-indent-line)
350 (set (make-local-variable 'comment-indent-function) 'pascal-indent-comment)
351 (set (make-local-variable 'parse-sexp-ignore-comments) nil)
352 (set (make-local-variable 'blink-matching-paren-dont-ignore-comments) t)
353 (set (make-local-variable 'case-fold-search) t)
354 (set (make-local-variable 'comment-start) "{")
355 (set (make-local-variable 'comment-start-skip) "(\\*+ *\\|{ *")
356 (set (make-local-variable 'comment-end) "}")
358 (set (make-local-variable 'font-lock-defaults)
359 '(pascal-font-lock-keywords nil t))
361 (set (make-local-variable 'imenu-generic-expression)
362 pascal-imenu-generic-expression)
363 (set (make-local-variable 'imenu-case-fold-search) t)
364 ;; Pascal-mode's own hide/show support.
365 (add-to-invisibility-spec '(pascal . t)))
370 ;;; Electric functions
372 (defun electric-pascal-terminate-line ()
373 "Terminate line and indent next line."
375 ;; First, check if current line should be indented
378 (skip-chars-forward " \t")
379 (if (looking-at pascal-autoindent-lines-re)
380 (pascal-indent-line)))
381 (delete-horizontal-space) ; Removes trailing whitespaces
385 ;; Maybe we should set some endcomments
386 (if pascal-auto-endcomments
387 (pascal-set-auto-comments))
388 ;; Check if we shall indent inside comment
392 (skip-chars-forward " \t")
393 (cond ((looking-at "\\*[ \t]+)")
394 ;; Delete region between `*' and `)' if there is only whitespaces.
396 (delete-horizontal-space))
397 ((and (looking-at "(\\*\\|\\*[^)]")
398 (not (save-excursion (search-forward "*)" (point-at-eol) t))))
400 ;; If last line was a star comment line then this one shall be too.
406 (defun electric-pascal-semi-or-dot ()
407 "Insert `;' or `.' character and reindent the line."
409 (insert last-command-event)
412 (pascal-indent-line))
413 (if pascal-auto-newline
414 (electric-pascal-terminate-line)))
416 (defun electric-pascal-colon ()
417 "Insert `:' and do all indentions except line indent on this line."
419 (insert last-command-event)
420 ;; Do nothing if within string.
421 (if (pascal-within-string)
425 (pascal-indent-line))
426 (let ((pascal-tab-always-indent nil))
427 (pascal-indent-command))))
429 (defun electric-pascal-equal ()
430 "Insert `=', and do indention if within type declaration."
432 (insert last-command-event)
433 (if (eq (car (pascal-calculate-indent)) 'declaration)
434 (let ((pascal-tab-always-indent nil))
435 (pascal-indent-command))))
437 (defun electric-pascal-hash ()
438 "Insert `#', and indent to column 0 if this is a CPP directive."
440 (insert last-command-event)
441 (if (save-excursion (beginning-of-line) (looking-at "^[ \t]*#"))
442 (save-excursion (beginning-of-line)
443 (delete-horizontal-space))))
445 (defun electric-pascal-tab ()
446 "Function called when TAB is pressed in Pascal mode."
448 ;; Do nothing if within a string or in a CPP directive.
449 (if (or (pascal-within-string)
451 (save-excursion (beginning-of-line) (eq (following-char) ?#))))
453 ;; If pascal-tab-always-indent, indent the beginning of the line.
454 (if pascal-tab-always-indent
457 (pascal-indent-line))
459 (skip-chars-backward " \t")
463 (pascal-indent-command)))
468 ;;; Interactive functions
470 (defun pascal-insert-block ()
471 "Insert Pascal begin ... end; block in the code with right indentation."
474 (electric-pascal-terminate-line)
479 (pascal-indent-line)))
481 (defun pascal-star-comment ()
482 "Insert Pascal star comment at point."
486 (electric-pascal-terminate-line)
488 (electric-pascal-terminate-line)
489 (delete-horizontal-space)
493 (defun pascal-mark-defun ()
494 "Mark the current pascal function (or procedure).
495 This puts the mark at the end, and point at the beginning."
498 (pascal-end-of-defun)
500 (pascal-beg-of-defun)
501 (when (featurep 'xemacs)
502 (zmacs-activate-region)))
504 (defun pascal-comment-area (start end)
505 "Put the region into a Pascal comment.
506 The comments that are in this area are \"deformed\":
507 `*)' becomes `!(*' and `}' becomes `!{'.
508 These deformed comments are returned to normal if you use
509 \\[pascal-uncomment-area] to undo the commenting.
511 The commented area starts with `pascal-exclude-str-start', and ends with
512 `pascal-include-str-end'. But if you change these variables,
513 \\[pascal-uncomment-area] won't recognize the comments."
516 ;; Insert start and endcomments
518 (if (and (save-excursion (skip-chars-forward " \t") (eolp))
519 (not (save-excursion (skip-chars-backward " \t") (bolp))))
522 (insert pascal-exclude-str-end)
527 (insert pascal-exclude-str-start)
529 ;; Replace end-comments within commented area
532 (while (re-search-backward "\\*)" start t)
533 (replace-match "!(*" t t)))
535 (while (re-search-backward "}" start t)
536 (replace-match "!{" t t)))))
538 (defun pascal-uncomment-area ()
539 "Uncomment a commented area; change deformed comments back to normal.
540 This command does nothing if the pointer is not in a commented
541 area. See also `pascal-comment-area'."
544 (let ((start (point))
546 ;; Find the boundaries of the comment
548 (setq start (progn (search-backward pascal-exclude-str-start nil t)
550 (setq end (progn (search-forward pascal-exclude-str-end nil t)
552 ;; Check if we're really inside a comment
553 (if (or (equal start (point)) (<= end (point)))
554 (message "Not standing within commented area.")
561 (delete-region pos (1+ (point))))
562 ;; Change comments back to normal
564 (while (re-search-backward "!{" start t)
565 (replace-match "}" t t)))
567 (while (re-search-backward "!(\\*" start t)
568 (replace-match "*)" t t)))
569 ;; Remove startcomment
574 (delete-region pos (1+ (point)))))))))
576 (defun pascal-beg-of-defun ()
577 "Move backward to the beginning of the current function or procedure."
580 (if (not (looking-at (concat "\\s \\|\\s)\\|" pascal-defun-re)))
582 (let ((nest 0) (max -1) (func 0)
583 (reg (concat pascal-beg-block-re "\\|"
584 pascal-end-block-re "\\|"
586 (while (re-search-backward reg nil 'move)
587 (cond ((let ((state (save-excursion
588 (parse-partial-sexp (point-min) (point)))))
589 (or (nth 3 state) (nth 4 state))) ; Inside string or comment
591 ((match-end 1) ; begin|case|record|repeat
592 (if (and (looking-at "\\<record\\>") (>= max 0))
593 (setq func (1- func)))
596 ((match-end 2) ; end|until
597 (if (and (= nest max) (>= max 0))
598 (setq func (1+ func)))
599 (setq nest (1- nest)))
600 ((match-end 3) ; function|procedure
603 (setq func (1- func)))))))
606 (defun pascal-end-of-defun ()
607 "Move forward to the end of the current function or procedure."
609 (if (looking-at "\\s ")
611 (if (not (looking-at pascal-defun-re))
612 (pascal-beg-of-defun))
614 (let ((nest 0) (func 1)
615 (reg (concat pascal-beg-block-re "\\|"
616 pascal-end-block-re "\\|"
618 (while (and (/= func 0)
619 (re-search-forward reg nil 'move))
620 (cond ((let ((state (save-excursion
621 (parse-partial-sexp (point-min) (point)))))
622 (or (nth 3 state) (nth 4 state))) ; Inside string or comment
625 (setq nest (1+ nest))
627 (goto-char (match-beginning 0))
628 (looking-at "\\<record\\>"))
629 (setq func (1+ func))))
631 (setq nest (1- nest))
633 (setq func (1- func))))
635 (setq func (1+ func))))))
638 (defun pascal-end-of-statement ()
639 "Move forward to end of current statement."
641 (let ((parse-sexp-ignore-comments t)
643 (regexp (concat "\\(" pascal-beg-block-re "\\)\\|\\("
644 pascal-end-block-re "\\)")))
645 (if (not (looking-at "[ \t\n]")) (forward-sexp -1))
646 (or (looking-at pascal-beg-block-re)
647 ;; Skip to end of statement
648 (setq pos (catch 'found
651 (cond ((looking-at "[ \t]*;")
652 (skip-chars-forward "^;")
654 (throw 'found (point)))
657 (looking-at pascal-beg-block-re))
658 (goto-char (match-beginning 0))
661 (throw 'found (point))))))))
663 ;; Skip a whole block
666 (re-search-forward regexp nil 'move)
667 (setq nest (if (match-end 1)
671 (throw 'found (point)))
673 (throw 'found (pascal-end-of-statement))))))
676 (defun pascal-downcase-keywords ()
677 "Downcase all Pascal keywords in the buffer."
679 (pascal-change-keywords 'downcase-word))
681 (defun pascal-upcase-keywords ()
682 "Upcase all Pascal keywords in the buffer."
684 (pascal-change-keywords 'upcase-word))
686 (defun pascal-capitalize-keywords ()
687 "Capitalize all Pascal keywords in the buffer."
689 (pascal-change-keywords 'capitalize-word))
691 ;; Change the keywords according to argument.
692 (defun pascal-change-keywords (change-word)
694 (let ((keyword-re (concat "\\<\\("
695 (mapconcat 'identity pascal-keywords "\\|")
697 (goto-char (point-min))
698 (while (re-search-forward keyword-re nil t)
699 (funcall change-word -1)))))
706 (defun pascal-set-auto-comments ()
707 "Insert `{ case }' or `{ NAME }' on this line if appropriate.
708 Insert `{ case }' if there is an `end' on the line which
709 ends a case block. Insert `{ NAME }' if there is an `end'
710 on the line which ends a function or procedure named NAME."
713 (skip-chars-forward " \t")
714 (if (and (looking-at "\\<end;")
717 (search-backward "{" (point-at-bol) t))))
718 (let ((type (car (pascal-calculate-indent))))
719 (if (eq type 'declaration)
722 ;; This is a case block
725 (delete-horizontal-space)
726 (insert " { case }"))
728 ;; Check if this is the end of a function
730 (while (not (or (looking-at pascal-defun-re) (bobp)))
732 (cond ((looking-at pascal-beg-block-re)
733 (setq nest (1- nest)))
734 ((looking-at pascal-end-block-re)
735 (setq nest (1+ nest)))))
741 (delete-horizontal-space)
745 (setq b (progn (pascal-beg-of-defun)
746 (skip-chars-forward "^ \t")
747 (skip-chars-forward " \t")
749 e (progn (skip-chars-forward "a-zA-Z0-9_")
751 (insert-buffer-substring (current-buffer) b e))
752 (insert " }"))))))))))
759 (defconst pascal-indent-alist
760 '((block . (+ ind pascal-indent-level))
761 (case . (+ ind pascal-case-indent))
762 (caseblock . ind) (cpp . 0)
763 (declaration . (+ ind pascal-indent-level))
764 (paramlist . (pascal-indent-paramlist t))
765 (comment . (pascal-indent-comment))
766 (defun . ind) (contexp . ind)
767 (unknown . ind) (string . 0) (progbeg . 0)))
769 (defun pascal-indent-command ()
770 "Indent for special part of code."
771 (let* ((indent-str (pascal-calculate-indent))
772 (type (car indent-str)))
773 (cond ((and (eq type 'paramlist)
774 (or (memq 'all pascal-auto-lineup)
775 (memq 'paramlist pascal-auto-lineup)))
776 (pascal-indent-paramlist)
777 (pascal-indent-paramlist))
778 ((and (eq type 'declaration)
779 (or (memq 'all pascal-auto-lineup)
780 (memq 'declaration pascal-auto-lineup)))
781 (pascal-indent-declaration))
782 ((and (eq type 'case) (not (looking-at "^[ \t]*$"))
783 (or (memq 'all pascal-auto-lineup)
784 (memq 'case pascal-auto-lineup)))
785 (pascal-indent-case)))
786 (if (looking-at "[ \t]+$")
787 (skip-chars-forward " \t"))))
789 (defun pascal-indent-line ()
790 "Indent current line as a Pascal statement."
791 (let* ((indent-str (pascal-calculate-indent))
792 (type (car indent-str))
793 (ind (car (cdr indent-str))))
794 ;; Labels should not be indented.
795 (if (and (looking-at "^[0-9a-zA-Z]+[ \t]*:[^=]")
796 (not (eq type 'declaration)))
797 (search-forward ":" nil t))
798 (delete-horizontal-space)
799 (cond (; Some things should not be indented
800 (or (and (eq type 'declaration) (looking-at pascal-declaration-re))
803 (; Other things should have no extra indent
804 (looking-at pascal-noindent-re)
806 (; Nested functions should be indented
807 (looking-at pascal-defun-re)
808 (if (and pascal-indent-nested-functions
810 (indent-to (+ ind pascal-indent-level))
812 (; But most lines are treated this way
813 (indent-to (eval (cdr (assoc type pascal-indent-alist))))
816 (defun pascal-calculate-indent ()
817 "Calculate the indent of the current Pascal line.
818 Return a list of two elements: (INDENT-TYPE INDENT-LEVEL)."
820 (let* ((parse-sexp-ignore-comments t)
822 (state (save-excursion (parse-partial-sexp (point-min) (point))))
823 (nest 0) (par 0) (complete (looking-at "[ \t]*end\\>"))
824 (elsed (looking-at "[ \t]*else\\>")) (funccnt 0)
825 (did-func (looking-at "[ \t]*\\(procedure\\|function\\)\\>"))
826 (type (catch 'nesting
827 ;; Check if inside a string, comment or parenthesis
828 (cond ((nth 3 state) (throw 'nesting 'string))
829 ((nth 4 state) (throw 'nesting 'comment))
831 (goto-char (scan-lists (point) -1 (car state)))
832 (setq par (1+ (current-column))))
833 ((save-excursion (beginning-of-line)
834 (eq (following-char) ?#))
835 (throw 'nesting 'cpp)))
836 ;; Loop until correct indent is found
839 (cond (;--Escape from case statements
840 (and (looking-at "[A-Za-z0-9]+[ \t]*:[^=]")
842 (save-excursion (skip-chars-backward " \t")
845 (end-of-line) (backward-sexp) (point))
847 (> (save-excursion (goto-char oldpos)
851 (throw 'nesting 'caseblock))
852 (;--Beginning of program
853 (looking-at pascal-progbeg-re)
854 (throw 'nesting 'progbeg))
855 (;--No known statements
857 (throw 'nesting 'progbeg))
858 (;--Nest block outwards
859 (looking-at pascal-beg-block-re)
861 (cond ((looking-at "case\\>")
862 (throw 'nesting 'case))
863 ((looking-at "record\\>")
864 (throw 'nesting 'declaration))
865 (t (throw 'nesting 'block)))
866 (if (and (looking-at "record\\>") (= nest 1))
867 (setq funccnt (1- funccnt)))
868 (setq nest (1- nest))))
869 (;--Nest block inwards
870 (looking-at pascal-end-block-re)
871 (if (and (looking-at "end\\s ")
872 elsed (not complete))
873 (throw 'nesting 'block))
875 (setq funccnt (1+ funccnt)))
878 (;--Defun (or parameter list)
879 (and (looking-at pascal-defun-re)
880 (progn (setq funccnt (1- funccnt)
882 (or (bolp) (< funccnt 0))))
883 ;; Prevent searching whole buffer
884 (if (and (bolp) (>= funccnt 0))
885 (throw 'nesting 'progbeg))
887 (throw 'nesting 'defun)
890 (while (re-search-forward
891 "\\(\\<record\\>\\)\\|\\<end\\>"
894 (setq n (1+ n)) (setq n (1- n))))
896 (throw 'nesting 'declaration)
897 (throw 'nesting 'paramlist)))))
899 (and (looking-at pascal-declaration-re)
905 (looking-at "^[ \t]*$"))
906 (throw 'nesting 'unknown)
907 (throw 'nesting 'declaration)))
908 (;--If, else or while statement
910 (looking-at pascal-sub-block-re))
911 (throw 'nesting 'block))
912 (;--Found complete statement
913 (save-excursion (forward-sexp 1)
914 (= (following-char) ?\;))
918 ;; Return type of block and indent level.
919 (if (> par 0) ; Unclosed Parenthesis
921 (list type (pascal-indent-level))))))
923 (defun pascal-indent-level ()
924 "Return the indent-level the current statement has.
925 Do not count labels, case-statements or records."
928 (if (looking-at "[ \t]*[0-9a-zA-Z]+[ \t]*:[^=]")
929 (search-forward ":" nil t)
930 (if (looking-at ".*=[ \t]*record\\>")
931 (search-forward "=" nil t)))
932 (skip-chars-forward " \t")
935 (defun pascal-indent-comment ()
936 "Return indent for current comment."
938 (re-search-backward "\\((\\*\\)\\|{" nil t)
939 (if (match-beginning 1)
940 (1+ (current-column))
943 (defun pascal-indent-case ()
944 "Indent within case statements."
945 (let ((savepos (point-marker))
949 (re-search-backward "\\<case\\>" nil t)))
953 (while (< (point) end)
954 (if (re-search-forward
955 "^[ \t]*[^ \t,:]+[ \t]*\\(,[ \t]*[^ \t,:]+[ \t]*\\)*:"
956 (marker-position end) 'move)
960 (delete-horizontal-space)
961 (if (> (current-column) ind)
962 (setq ind (current-column)))
963 (pascal-end-of-statement))))
965 ;; Indent all case statements
966 (while (< (point) end)
967 (if (re-search-forward
968 "^[ \t]*[^][ \t,\\.:]+[ \t]*\\(,[ \t]*[^ \t,:]+[ \t]*\\)*:"
969 (marker-position end) 'move)
972 (if (/= (following-char) ?:)
975 (delete-horizontal-space)
977 (pascal-end-of-statement))
978 (goto-char savepos)))
980 (defun pascal-indent-paramlist (&optional arg)
981 "Indent current line in parameterlist.
982 If optional arg is non-nil, just return the
983 indent of the current line in parameterlist."
985 (let* ((oldpos (point))
986 (stpos (progn (goto-char (scan-lists (point) -1 1)) (point)))
987 (stcol (1+ (current-column)))
988 (edpos (progn (pascal-declaration-end)
989 (search-backward ")" (point-at-bol) t)
991 (usevar (re-search-backward "\\<var\\>" stpos t)))
993 ;; If arg, just return indent
996 (if (or (not usevar) (looking-at "[ \t]*var\\>"))
1000 (delete-horizontal-space)
1001 (if (and usevar (not (looking-at "var\\>")))
1002 (indent-to (+ 4 stcol)))
1003 (pascal-indent-declaration nil stpos edpos)))))
1005 (defun pascal-indent-declaration (&optional arg start end)
1006 "Indent current lines as declaration, lining up the `:'s or `='s."
1007 (let ((pos (point-marker)))
1008 (if (and (not (or arg start)) (not (pascal-declaration-beg)))
1010 (let ((lineup (if (or (looking-at "\\<var\\>\\|\\<record\\>") arg start)
1012 (stpos (if start start
1013 (forward-word 2) (backward-word 1) (point)))
1014 (edpos (set-marker (make-marker)
1016 (max (progn (pascal-declaration-end)
1022 ;; Indent lines in record block
1024 (while (<= (point) edpos)
1026 (delete-horizontal-space)
1027 (if (looking-at "end\\>")
1029 (indent-to (+ arg pascal-indent-level)))
1033 (setq ind (pascal-get-lineup-indent stpos edpos lineup))
1035 (while (and (<= (point) edpos) (not (eobp)))
1036 (if (search-forward lineup (point-at-eol) 'move)
1038 (delete-horizontal-space)
1040 (if (not (looking-at lineup))
1041 (forward-line 1) ; No more indent if there is no : or =
1043 (delete-horizontal-space)
1045 ;; Indent record block
1046 (if (looking-at "record\\>")
1047 (pascal-indent-declaration (current-column)))
1048 (forward-line 1)))))
1050 ;; If arg - move point
1051 (if arg (forward-line -1)
1054 ; "Return the indent level that will line up several lines within the region
1055 ;from b to e nicely. The lineup string is str."
1056 (defun pascal-get-lineup-indent (b e str)
1059 (reg (concat str "\\|\\(\\<record\\>\\)\\|" pascal-defun-re)))
1061 ;; Get rightmost position
1062 (while (< (point) e)
1063 (and (re-search-forward reg (min e (point-at-eol 2)) 'move)
1064 (cond ((match-beginning 1)
1065 ;; Skip record blocks
1066 (pascal-declaration-end))
1067 ((match-beginning 2)
1068 ;; We have entered a new procedure. Exit.
1071 (goto-char (match-beginning 0))
1072 (skip-chars-backward " \t")
1073 (if (> (current-column) ind)
1074 (setq ind (current-column)))
1075 (goto-char (match-end 0))
1078 ;; In case no lineup was found
1081 ;; No lineup-string found
1084 (skip-chars-backward " \t")
1085 (1+ (current-column))))))
1092 (defun pascal-string-diff (str1 str2)
1093 "Return index of first letter where STR1 and STR2 differs."
1097 (if (or (> (1+ diff) (length str1))
1098 (> (1+ diff) (length str2)))
1100 (or (equal (aref str1 diff) (aref str2 diff))
1102 (setq diff (1+ diff))))))
1104 ;; Calculate all possible completions for functions if argument is `function',
1105 ;; completions for procedures if argument is `procedure' or both functions and
1106 ;; procedures otherwise.
1108 (defun pascal-func-completion (type pascal-str)
1109 ;; Build regular expression for function/procedure names
1111 (if (string= pascal-str "")
1112 (setq pascal-str "[a-zA-Z_]"))
1113 (let ((pascal-str (concat (cond
1114 ((eq type 'procedure) "\\<\\(procedure\\)\\s +")
1115 ((eq type 'function) "\\<\\(function\\)\\s +")
1116 (t "\\<\\(function\\|procedure\\)\\s +"))
1117 "\\<\\(" pascal-str "[a-zA-Z0-9_.]*\\)\\>"))
1121 (if (not (looking-at "\\<\\(function\\|procedure\\)\\>"))
1122 (re-search-backward "\\<\\(function\\|procedure\\)\\>" nil t))
1125 ;; Search through all reachable functions
1126 (while (pascal-beg-of-defun)
1127 (if (re-search-forward pascal-str (point-at-eol) t)
1128 (progn (setq match (buffer-substring (match-beginning 2)
1130 (push match pascal-all)))
1131 (goto-char (match-beginning 0)))
1135 (defun pascal-get-completion-decl (pascal-str)
1136 ;; Macro for searching through current declaration (var, type or const)
1137 ;; for matches of `str' and adding the occurrence to `all'
1138 (let ((end (save-excursion (pascal-declaration-end)
1143 (while (< (point) end)
1144 (if (re-search-forward "[:=]" (point-at-eol) t)
1145 ;; Traverse current line
1146 (while (and (re-search-backward
1147 (concat "\\((\\|\\<\\(var\\|type\\|const\\)\\>\\)\\|"
1150 (not (match-end 1)))
1151 (setq match (buffer-substring (match-beginning 0) (match-end 0)))
1152 (if (string-match (concat "\\<" pascal-str) match)
1153 (push match pascal-all))))
1154 (if (re-search-forward "\\<record\\>" (point-at-eol) t)
1155 (pascal-declaration-end)
1160 (defun pascal-type-completion (pascal-str)
1161 "Calculate all possible completions for types."
1162 (let ((start (point))
1165 ;; Search for all reachable type declarations
1166 (while (or (pascal-beg-of-defun)
1167 (setq goon (not goon)))
1169 (if (and (< start (prog1 (save-excursion (pascal-end-of-defun)
1173 "\\<type\\>\\|\\<\\(begin\\|function\\|procedure\\)\\>"
1175 (not (match-end 1)))
1176 ;; Check current type declaration
1178 (nconc (pascal-get-completion-decl pascal-str)
1183 (defun pascal-var-completion (prefix)
1184 "Calculate all possible completions for variables (or constants)."
1186 (let ((start (point))
1189 ;; Search for all reachable var declarations
1190 (while (or (pascal-beg-of-defun)
1191 (setq goon (not goon)))
1193 (if (> start (prog1 (save-excursion (pascal-end-of-defun)
1195 () ; Declarations not reachable
1196 (if (search-forward "(" (point-at-eol) t)
1197 ;; Check parameterlist
1198 ;; FIXME: pascal-get-completion-decl doesn't understand
1199 ;; the var declarations in parameter lists :-(
1201 (nconc (pascal-get-completion-decl prefix)
1204 (while (>= (setq twice (1- twice)) 0)
1206 ((and (re-search-forward
1207 (concat "\\<\\(var\\|const\\)\\>\\|"
1208 "\\<\\(begin\\|function\\|procedure\\)\\>")
1210 (not (match-end 2)))
1211 ;; Check var/const declarations
1213 (nconc (pascal-get-completion-decl prefix)
1216 (setq twice 0)))))))
1220 (defun pascal-keyword-completion (keyword-list pascal-str)
1221 "Give list of all possible completions of keywords in KEYWORD-LIST."
1222 (let ((pascal-all ()))
1223 (dolist (s keyword-list)
1224 (if (string-match (concat "\\<" pascal-str) s)
1225 (push s pascal-all)))
1228 ;; Function passed to completing-read, try-completion or
1229 ;; all-completions to get completion on STR. If predicate is non-nil,
1230 ;; it must be a function to be called for every match to check if this
1231 ;; should really be a match. If flag is t, the function returns a list
1232 ;; of all possible completions. If it is nil it returns a string, the
1233 ;; longest possible completion, or t if STR is an exact match. If flag
1234 ;; is 'lambda, the function returns t if STR is an exact match, nil
1237 (defvar pascal-completion-cache nil)
1239 (defun pascal-completion (pascal-str pascal-pred pascal-flag)
1240 (let ((all (car pascal-completion-cache)))
1241 ;; Check the cache's freshness.
1242 (unless (and pascal-completion-cache
1243 (string-prefix-p (nth 1 pascal-completion-cache) pascal-str)
1244 (eq (current-buffer) (nth 2 pascal-completion-cache))
1245 (eq (field-beginning) (nth 3 pascal-completion-cache)))
1246 (let ((state (car (pascal-calculate-indent))))
1248 ;; Determine what should be completed
1250 ( ;--Within a declaration or parameterlist
1251 (or (eq state 'declaration) (eq state 'paramlist)
1252 (and (eq state 'defun)
1254 (re-search-backward ")[ \t]*:" (point-at-bol) t))))
1255 (if (or (eq state 'paramlist) (eq state 'defun))
1256 (pascal-beg-of-defun))
1258 (pascal-type-completion pascal-str)
1259 (pascal-keyword-completion pascal-type-keywords pascal-str)))
1260 ( ;--Starting a new statement
1261 (and (not (eq state 'contexp))
1263 (skip-chars-backward "a-zA-Z0-9_.")
1265 (or (looking-at pascal-nosemi-re)
1268 (looking-at "\\s *\\(;\\|:[^=]\\)")))))
1270 (pascal-var-completion pascal-str)
1271 (pascal-func-completion 'procedure pascal-str)
1272 (pascal-keyword-completion pascal-start-keywords pascal-str)))
1275 (pascal-var-completion pascal-str)
1276 (pascal-func-completion 'function pascal-str)
1277 (pascal-keyword-completion pascal-separator-keywords
1280 (setq pascal-completion-cache
1281 (list all pascal-str (current-buffer) (field-beginning)))))
1283 ;; Now we have built a list of all matches. Give response to caller
1284 (complete-with-action pascal-flag all pascal-str pascal-pred)))
1286 (defvar pascal-last-word-numb 0)
1287 (defvar pascal-last-word-shown nil)
1288 (defvar pascal-last-completions nil)
1290 (defun pascal-complete-word ()
1291 "Complete word at current point.
1292 \(See also `pascal-toggle-completions', `pascal-type-keywords',
1293 `pascal-start-keywords' and `pascal-separator-keywords'.)"
1295 (let* ((b (save-excursion (skip-chars-backward "a-zA-Z0-9_") (point)))
1296 (e (save-excursion (skip-chars-forward "a-zA-Z0-9_") (point))))
1298 ;; Toggle-completions inserts whole labels
1299 (if pascal-toggle-completions
1300 (let* ((pascal-str (buffer-substring b e))
1301 (allcomp (if (and pascal-toggle-completions
1302 (string= pascal-last-word-shown pascal-str))
1303 pascal-last-completions
1304 (all-completions pascal-str 'pascal-completion))))
1305 ;; Update entry number in list
1306 (setq pascal-last-completions allcomp
1307 pascal-last-word-numb
1308 (if (>= pascal-last-word-numb (1- (length allcomp)))
1310 (1+ pascal-last-word-numb)))
1311 (setq pascal-last-word-shown (elt allcomp pascal-last-word-numb))
1312 ;; Display next match or same string if no match was found
1316 (insert-before-markers pascal-last-word-shown)
1317 (delete-region b e))
1318 (message "(No match)")))
1319 ;; The other form of completion does not necessarily do that.
1320 (completion-in-region b e 'pascal-completion))))
1322 (defun pascal-show-completions ()
1323 "Show all possible completions at current point."
1325 (let* ((b (save-excursion (skip-chars-backward "a-zA-Z0-9_") (point)))
1326 (e (save-excursion (skip-chars-forward "a-zA-Z0-9_") (point)))
1327 (pascal-str (buffer-substring b e))
1328 (allcomp (if (and pascal-toggle-completions
1329 (string= pascal-last-word-shown pascal-str))
1330 pascal-last-completions
1331 (all-completions pascal-str 'pascal-completion))))
1332 ;; Show possible completions in a temporary buffer.
1333 (with-output-to-temp-buffer "*Completions*"
1334 (display-completion-list allcomp pascal-str))
1335 ;; Wait for a keypress. Then delete *Completion* window
1336 (momentary-string-display "" (point))
1337 (delete-window (get-buffer-window (get-buffer "*Completions*")))))
1340 (defun pascal-get-default-symbol ()
1341 "Return symbol around current point as a string."
1343 (buffer-substring (progn
1344 (skip-chars-backward " \t")
1345 (skip-chars-backward "a-zA-Z0-9_")
1348 (skip-chars-forward "a-zA-Z0-9_")
1351 (defun pascal-build-defun-re (str &optional arg)
1352 "Return function/procedure starting with STR as regular expression.
1353 With optional second arg non-nil, STR is the complete name of the instruction."
1355 (concat "^\\(function\\|procedure\\)[ \t]+\\(" str "\\)\\>")
1356 (concat "^\\(function\\|procedure\\)[ \t]+\\(" str "[a-zA-Z0-9_]*\\)\\>")))
1358 ;; Function passed to completing-read, try-completion or
1359 ;; all-completions to get completion on any function name. If
1360 ;; predicate is non-nil, it must be a function to be called for every
1361 ;; match to check if this should really be a match. If flag is t, the
1362 ;; function returns a list of all possible completions. If it is nil
1363 ;; it returns a string, the longest possible completion, or t if STR
1364 ;; is an exact match. If flag is 'lambda, the function returns t if
1365 ;; STR is an exact match, nil otherwise.
1367 (defun pascal-comp-defun (pascal-str pascal-pred pascal-flag)
1369 (let ((pascal-all nil))
1371 ;; Build regular expression for functions
1372 (let ((pascal-str (pascal-build-defun-re (if (string= pascal-str "")
1375 (goto-char (point-min))
1377 ;; Build a list of all possible completions
1378 (while (re-search-forward pascal-str nil t)
1379 (push (match-string 2) pascal-all)))
1381 ;; Now we have built a list of all matches. Give response to caller
1382 (complete-with-action pascal-flag pascal-all pascal-str pascal-pred))))
1384 (defun pascal-goto-defun ()
1385 "Move to specified Pascal function/procedure.
1386 The default is a name found in the buffer around point."
1388 (let* ((default (pascal-get-default-symbol))
1389 (default (if (pascal-comp-defun default nil 'lambda)
1392 ;; Do completion with default
1393 (completing-read (if (not (string= default ""))
1394 (concat "Label (default " default "): ")
1396 ;; Complete with the defuns found in the
1398 (lexical-let ((buf (current-buffer)))
1400 (with-current-buffer buf
1401 (pascal-comp-defun s p a))))
1403 ;; If there was no response on prompt, use default value
1404 (if (string= label "")
1405 (setq label default))
1406 ;; Goto right place in buffer if label is not an empty string
1407 (or (string= label "")
1409 (goto-char (point-min))
1410 (re-search-forward (pascal-build-defun-re label t))
1411 (beginning-of-line)))))
1416 ;;; Pascal-outline-mode
1418 (defvar pascal-outline-map
1419 (let ((map (make-sparse-keymap)))
1420 (if (fboundp 'set-keymap-name)
1421 (set-keymap-name pascal-outline-map 'pascal-outline-map))
1422 (define-key map "\M-\C-a" 'pascal-outline-prev-defun)
1423 (define-key map "\M-\C-e" 'pascal-outline-next-defun)
1424 (define-key map "\C-c\C-d" 'pascal-outline-goto-defun)
1425 (define-key map "\C-c\C-s" 'pascal-show-all)
1426 (define-key map "\C-c\C-h" 'pascal-hide-other-defuns)
1428 "Keymap used in Pascal Outline mode.")
1430 (define-obsolete-function-alias 'pascal-outline 'pascal-outline-mode "22.1")
1431 (define-minor-mode pascal-outline-mode
1432 "Outline-line minor mode for Pascal mode.
1433 When in Pascal Outline mode, portions
1434 of the text being edited may be made invisible. \\<pascal-outline-map>
1436 Pascal Outline mode provides some additional commands.
1438 \\[pascal-outline-prev-defun]\
1439 \t- Move to previous function/procedure, hiding everything else.
1440 \\[pascal-outline-next-defun]\
1441 \t- Move to next function/procedure, hiding everything else.
1442 \\[pascal-outline-goto-defun]\
1443 \t- Goto function/procedure prompted for in minibuffer,
1444 \t hide all other functions.
1445 \\[pascal-show-all]\t- Show the whole buffer.
1446 \\[pascal-hide-other-defuns]\
1447 \t- Hide everything but the current function (function under the cursor).
1448 \\[pascal-outline]\t- Leave pascal-outline-mode."
1449 :init-value nil :lighter " Outl" :keymap pascal-outline-map
1450 (add-to-invisibility-spec '(pascal . t))
1451 (unless pascal-outline-mode
1454 (defun pascal-outline-change (b e hide)
1456 ;; We could try and optimize this in the case where the region is
1457 ;; already hidden. But I'm not sure it's worth the trouble.
1458 (remove-overlays b e 'invisible 'pascal)
1460 (let ((ol (make-overlay b e nil t nil)))
1461 (overlay-put ol 'invisible 'pascal)
1462 (overlay-put ol 'evaporate t)))))
1464 (defun pascal-show-all ()
1465 "Show all of the text in the buffer."
1467 (pascal-outline-change (point-min) (point-max) nil))
1469 (defun pascal-hide-other-defuns ()
1470 "Show only the current defun."
1473 (let ((beg (progn (if (not (looking-at "\\(function\\|procedure\\)\\>"))
1474 (pascal-beg-of-defun))
1475 (line-beginning-position)))
1476 (end (progn (pascal-end-of-defun)
1478 (line-beginning-position 2)))
1479 (opoint (point-min)))
1483 (goto-char (point-min))
1485 ;; Hide all functions before current function
1486 (while (re-search-forward "^[ \t]*\\(function\\|procedure\\)\\>"
1488 (pascal-outline-change opoint (line-end-position 0) t)
1489 (setq opoint (line-end-position))
1490 ;; Functions may be nested
1491 (if (> (progn (pascal-end-of-defun) (point)) beg)
1492 (goto-char opoint)))
1494 (pascal-outline-change opoint (1- beg) t))
1496 ;; Show current function
1497 (pascal-outline-change (1- beg) end nil)
1498 ;; Hide nested functions
1500 (while (re-search-forward "^\\(function\\|procedure\\)\\>" end 'move)
1501 (setq opoint (line-end-position))
1502 (pascal-end-of-defun)
1503 (pascal-outline-change opoint (line-end-position) t))
1508 ;; Hide all function after current function
1509 (while (re-search-forward "^\\(function\\|procedure\\)\\>" nil 'move)
1510 (pascal-outline-change opoint (line-end-position 0) t)
1511 (setq opoint (line-end-position))
1512 (pascal-end-of-defun))
1513 (pascal-outline-change opoint (point-max) t)
1515 ;; Hide main program
1516 (if (< (progn (forward-line -1) (point)) end)
1519 (pascal-end-of-defun)
1521 (pascal-outline-change (line-end-position) (point-max) t))))))
1523 (defun pascal-outline-next-defun ()
1524 "Move to next function/procedure, hiding all others."
1526 (pascal-end-of-defun)
1527 (pascal-hide-other-defuns))
1529 (defun pascal-outline-prev-defun ()
1530 "Move to previous function/procedure, hiding all others."
1532 (pascal-beg-of-defun)
1533 (pascal-hide-other-defuns))
1535 (defun pascal-outline-goto-defun ()
1536 "Move to specified function/procedure, hiding all others."
1539 (pascal-hide-other-defuns))
1543 ;;; pascal.el ends here