]> code.delx.au - gnu-emacs/blob - lisp/progmodes/pascal.el
(msdos-shells): Add defvar.
[gnu-emacs] / lisp / progmodes / pascal.el
1 ;;; pascal.el --- major mode for editing pascal source in Emacs
2
3 ;; Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
4 ;; 2003, 2004, 2005 Free Software Foundation, Inc.
5
6 ;; Author: Espen Skoglund <esk@gnu.org>
7 ;; Keywords: languages
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to
23 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
25
26 ;;; Commentary:
27
28 ;; USAGE
29 ;; =====
30
31 ;; Emacs should enter Pascal mode when you find a Pascal source file.
32 ;; When you have entered Pascal mode, you may get more info by pressing
33 ;; C-h m. You may also get online help describing various functions by:
34 ;; C-h f <Name of function you want described>
35
36 ;; If you want to customize Pascal mode to fit you better, you may add
37 ;; these lines (the values of the variables presented here are the defaults):
38 ;;
39 ;; ;; User customization for Pascal mode
40 ;; (setq pascal-indent-level 3
41 ;; pascal-case-indent 2
42 ;; pascal-auto-newline nil
43 ;; pascal-tab-always-indent t
44 ;; pascal-auto-endcomments t
45 ;; pascal-auto-lineup '(all)
46 ;; pascal-toggle-completions nil
47 ;; pascal-type-keywords '("array" "file" "packed" "char"
48 ;; "integer" "real" "string" "record")
49 ;; pascal-start-keywords '("begin" "end" "function" "procedure"
50 ;; "repeat" "until" "while" "read" "readln"
51 ;; "reset" "rewrite" "write" "writeln")
52 ;; pascal-separator-keywords '("downto" "else" "mod" "div" "then"))
53
54 ;; KNOWN BUGS / BUGREPORTS
55 ;; =======================
56 ;; As far as I know, there are no bugs in the current version of this
57 ;; package. This may not be true however, since I never use this mode
58 ;; myself and therefore would never notice them anyway. If you do
59 ;; find any bugs, you may submit them to: esk@gnu.org as well as to
60 ;; bug-gnu-emacs@gnu.org.
61 \f
62 ;;; Code:
63
64 (defgroup pascal nil
65 "Major mode for editing Pascal source in Emacs."
66 :group 'languages)
67
68 (defvar pascal-mode-abbrev-table nil
69 "Abbrev table in use in Pascal-mode buffers.")
70 (define-abbrev-table 'pascal-mode-abbrev-table ())
71
72 (defvar pascal-mode-map ()
73 "Keymap used in Pascal mode.")
74 (if pascal-mode-map
75 ()
76 (setq pascal-mode-map (make-sparse-keymap))
77 (define-key pascal-mode-map ";" 'electric-pascal-semi-or-dot)
78 (define-key pascal-mode-map "." 'electric-pascal-semi-or-dot)
79 (define-key pascal-mode-map ":" 'electric-pascal-colon)
80 (define-key pascal-mode-map "=" 'electric-pascal-equal)
81 (define-key pascal-mode-map "#" 'electric-pascal-hash)
82 (define-key pascal-mode-map "\r" 'electric-pascal-terminate-line)
83 (define-key pascal-mode-map "\t" 'electric-pascal-tab)
84 (define-key pascal-mode-map "\M-\t" 'pascal-complete-word)
85 (define-key pascal-mode-map "\M-?" 'pascal-show-completions)
86 (define-key pascal-mode-map "\177" 'backward-delete-char-untabify)
87 (define-key pascal-mode-map "\M-\C-h" 'pascal-mark-defun)
88 (define-key pascal-mode-map "\C-c\C-b" 'pascal-insert-block)
89 (define-key pascal-mode-map "\M-*" 'pascal-star-comment)
90 (define-key pascal-mode-map "\C-c\C-c" 'pascal-comment-area)
91 (define-key pascal-mode-map "\C-c\C-u" 'pascal-uncomment-area)
92 (define-key pascal-mode-map "\M-\C-a" 'pascal-beg-of-defun)
93 (define-key pascal-mode-map "\M-\C-e" 'pascal-end-of-defun)
94 (define-key pascal-mode-map "\C-c\C-d" 'pascal-goto-defun)
95 (define-key pascal-mode-map "\C-c\C-o" 'pascal-outline)
96 ;;; A command to change the whole buffer won't be used terribly
97 ;;; often, so no need for a key binding.
98 ; (define-key pascal-mode-map "\C-cd" 'pascal-downcase-keywords)
99 ; (define-key pascal-mode-map "\C-cu" 'pascal-upcase-keywords)
100 ; (define-key pascal-mode-map "\C-cc" 'pascal-capitalize-keywords)
101 )
102
103 (defvar pascal-imenu-generic-expression
104 '((nil "^[ \t]*\\(function\\|procedure\\)[ \t\n]+\\([a-zA-Z0-9_.:]+\\)" 2))
105 "Imenu expression for Pascal-mode. See `imenu-generic-expression'.")
106
107 (defvar pascal-keywords
108 '("and" "array" "begin" "case" "const" "div" "do" "downto" "else" "end"
109 "file" "for" "function" "goto" "if" "in" "label" "mod" "nil" "not" "of"
110 "or" "packed" "procedure" "program" "record" "repeat" "set" "then" "to"
111 "type" "until" "var" "while" "with"
112 ;; The following are not standard in pascal, but widely used.
113 "get" "put" "input" "output" "read" "readln" "reset" "rewrite" "write"
114 "writeln"))
115
116 ;;;
117 ;;; Regular expressions used to calculate indent, etc.
118 ;;;
119 (defconst pascal-symbol-re "\\<[a-zA-Z_][a-zA-Z_0-9.]*\\>")
120 (defconst pascal-beg-block-re "\\<\\(begin\\|case\\|record\\|repeat\\)\\>")
121 (defconst pascal-end-block-re "\\<\\(end\\|until\\)\\>")
122 (defconst pascal-declaration-re "\\<\\(const\\|label\\|type\\|var\\)\\>")
123 (defconst pascal-progbeg-re "\\<\\program\\>")
124 (defconst pascal-defun-re "\\<\\(function\\|procedure\\|program\\)\\>")
125 (defconst pascal-sub-block-re "\\<\\(if\\|else\\|for\\|while\\|with\\)\\>")
126 (defconst pascal-noindent-re "\\<\\(begin\\|end\\|until\\|else\\)\\>")
127 (defconst pascal-nosemi-re "\\<\\(begin\\|repeat\\|then\\|do\\|else\\)\\>")
128 (defconst pascal-autoindent-lines-re
129 "\\<\\(label\\|var\\|type\\|const\\|until\\|end\\|begin\\|repeat\\|else\\)\\>")
130
131 ;;; Strings used to mark beginning and end of excluded text
132 (defconst pascal-exclude-str-start "{-----\\/----- EXCLUDED -----\\/-----")
133 (defconst pascal-exclude-str-end " -----/\\----- EXCLUDED -----/\\-----}")
134
135 (defvar pascal-mode-syntax-table nil
136 "Syntax table in use in Pascal-mode buffers.")
137
138 (if pascal-mode-syntax-table
139 ()
140 (setq pascal-mode-syntax-table (make-syntax-table))
141 (modify-syntax-entry ?\\ "." pascal-mode-syntax-table)
142 (modify-syntax-entry ?( "()1" pascal-mode-syntax-table)
143 (modify-syntax-entry ?) ")(4" pascal-mode-syntax-table)
144 (modify-syntax-entry ?* ". 23b" pascal-mode-syntax-table)
145 (modify-syntax-entry ?{ "<" pascal-mode-syntax-table)
146 (modify-syntax-entry ?} ">" pascal-mode-syntax-table)
147 (modify-syntax-entry ?+ "." pascal-mode-syntax-table)
148 (modify-syntax-entry ?- "." pascal-mode-syntax-table)
149 (modify-syntax-entry ?= "." pascal-mode-syntax-table)
150 (modify-syntax-entry ?% "." pascal-mode-syntax-table)
151 (modify-syntax-entry ?< "." pascal-mode-syntax-table)
152 (modify-syntax-entry ?> "." pascal-mode-syntax-table)
153 (modify-syntax-entry ?& "." pascal-mode-syntax-table)
154 (modify-syntax-entry ?| "." pascal-mode-syntax-table)
155 (modify-syntax-entry ?_ "_" pascal-mode-syntax-table)
156 (modify-syntax-entry ?\' "\"" pascal-mode-syntax-table))
157
158 (defconst pascal-font-lock-keywords (purecopy
159 (list
160 '("^[ \t]*\\(function\\|pro\\(cedure\\|gram\\)\\)\\>[ \t]*\\([a-z]\\)"
161 1 font-lock-keyword-face)
162 '("^[ \t]*\\(function\\|pro\\(cedure\\|gram\\)\\)\\>[ \t]*\\([a-z][a-z0-9_]*\\)"
163 3 font-lock-function-name-face t)
164 ; ("type" "const" "real" "integer" "char" "boolean" "var"
165 ; "record" "array" "file")
166 (cons (concat "\\<\\(array\\|boolean\\|c\\(har\\|onst\\)\\|file\\|"
167 "integer\\|re\\(al\\|cord\\)\\|type\\|var\\)\\>")
168 'font-lock-type-face)
169 '("\\<\\(label\\|external\\|forward\\)\\>" . font-lock-constant-face)
170 '("\\<\\([0-9]+\\)[ \t]*:" 1 font-lock-function-name-face)
171 ; ("of" "to" "for" "if" "then" "else" "case" "while"
172 ; "do" "until" "and" "or" "not" "in" "with" "repeat" "begin" "end")
173 (concat "\\<\\("
174 "and\\|begin\\|case\\|do\\|e\\(lse\\|nd\\)\\|for\\|i[fn]\\|"
175 "not\\|o[fr]\\|repeat\\|t\\(hen\\|o\\)\\|until\\|w\\(hile\\|ith\\)"
176 "\\)\\>")
177 '("\\<\\(goto\\)\\>[ \t]*\\([0-9]+\\)?"
178 1 font-lock-keyword-face)
179 '("\\<\\(goto\\)\\>[ \t]*\\([0-9]+\\)?"
180 2 font-lock-keyword-face t)))
181 "Additional expressions to highlight in Pascal mode.")
182 (put 'pascal-mode 'font-lock-defaults '(pascal-font-lock-keywords nil t))
183
184 (defcustom pascal-indent-level 3
185 "*Indentation of Pascal statements with respect to containing block."
186 :type 'integer
187 :group 'pascal)
188
189 (defcustom pascal-case-indent 2
190 "*Indentation for case statements."
191 :type 'integer
192 :group 'pascal)
193
194 (defcustom pascal-auto-newline nil
195 "*Non-nil means automatically insert newlines in certain cases.
196 These include after semicolons and after the punctuation mark after an `end'."
197 :type 'boolean
198 :group 'pascal)
199
200 (defcustom pascal-indent-nested-functions t
201 "*Non-nil means nested functions are indented."
202 :type 'boolean
203 :group 'pascal)
204
205 (defcustom pascal-tab-always-indent t
206 "*Non-nil means TAB in Pascal mode should always reindent the current line.
207 If this is nil, TAB inserts a tab if it is at the end of the line
208 and follows non-whitespace text."
209 :type 'boolean
210 :group 'pascal)
211
212 (defcustom pascal-auto-endcomments t
213 "*Non-nil means automatically insert comments after certain `end's.
214 Specifically, this is done after the ends of cases statements and functions.
215 The name of the function or case is included between the braces."
216 :type 'boolean
217 :group 'pascal)
218
219 (defcustom pascal-auto-lineup '(all)
220 "*List of contexts where auto lineup of :'s or ='s should be done.
221 Elements can be of type: 'paramlist', 'declaration' or 'case', which will
222 do auto lineup in parameterlist, declarations or case-statements
223 respectively. The word 'all' will do all lineups. '(case paramlist) for
224 instance will do lineup in case-statements and parameterlist, while '(all)
225 will do all lineups."
226 :type '(set :extra-offset 8
227 (const :tag "Everything" all)
228 (const :tag "Parameter lists" paramlist)
229 (const :tag "Decalrations" declaration)
230 (const :tag "Case statements" case))
231 :group 'pascal)
232
233 (defcustom pascal-toggle-completions nil
234 "*Non-nil means \\<pascal-mode-map>\\[pascal-complete-word] should try all possible completions one by one.
235 Repeated use of \\[pascal-complete-word] will show you all of them.
236 Normally, when there is more than one possible completion,
237 it displays a list of all possible completions."
238 :type 'boolean
239 :group 'pascal)
240
241 (defcustom pascal-type-keywords
242 '("array" "file" "packed" "char" "integer" "real" "string" "record")
243 "*Keywords for types used when completing a word in a declaration or parmlist.
244 These include integer, real, char, etc.
245 The types defined within the Pascal program
246 are handled in another way, and should not be added to this list."
247 :type '(repeat (string :tag "Keyword"))
248 :group 'pascal)
249
250 (defcustom pascal-start-keywords
251 '("begin" "end" "function" "procedure" "repeat" "until" "while"
252 "read" "readln" "reset" "rewrite" "write" "writeln")
253 "*Keywords to complete when standing at the first word of a statement.
254 These are keywords such as begin, repeat, until, readln.
255 The procedures and variables defined within the Pascal program
256 are handled in another way, and should not be added to this list."
257 :type '(repeat (string :tag "Keyword"))
258 :group 'pascal)
259
260 (defcustom pascal-separator-keywords
261 '("downto" "else" "mod" "div" "then")
262 "*Keywords to complete when NOT standing at the first word of a statement.
263 These are keywords such as downto, else, mod, then.
264 Variables and function names defined within the Pascal program
265 are handled in another way, and should not be added to this list."
266 :type '(repeat (string :tag "Keyword"))
267 :group 'pascal)
268
269
270 ;;;
271 ;;; Macros
272 ;;;
273
274 (defsubst pascal-get-beg-of-line (&optional arg)
275 (save-excursion
276 (beginning-of-line arg)
277 (point)))
278
279 (defsubst pascal-get-end-of-line (&optional arg)
280 (save-excursion
281 (end-of-line arg)
282 (point)))
283
284 (defun pascal-declaration-end ()
285 (let ((nest 1))
286 (while (and (> nest 0)
287 (re-search-forward
288 "[:=]\\|\\(\\<record\\>\\)\\|\\(\\<end\\>\\)"
289 (save-excursion (end-of-line 2) (point)) t))
290 (cond ((match-beginning 1) (setq nest (1+ nest)))
291 ((match-beginning 2) (setq nest (1- nest)))
292 ((looking-at "[^(\n]+)") (setq nest 0))))))
293
294
295 (defun pascal-declaration-beg ()
296 (let ((nest 1))
297 (while (and (> nest 0)
298 (re-search-backward "[:=]\\|\\<\\(type\\|var\\|label\\|const\\)\\>\\|\\(\\<record\\>\\)\\|\\(\\<end\\>\\)" (pascal-get-beg-of-line 0) t))
299 (cond ((match-beginning 1) (setq nest 0))
300 ((match-beginning 2) (setq nest (1- nest)))
301 ((match-beginning 3) (setq nest (1+ nest)))))
302 (= nest 0)))
303
304
305 (defsubst pascal-within-string ()
306 (save-excursion
307 (nth 3 (parse-partial-sexp (pascal-get-beg-of-line) (point)))))
308
309
310 ;;;###autoload
311 (defun pascal-mode ()
312 "Major mode for editing Pascal code. \\<pascal-mode-map>
313 TAB indents for Pascal code. Delete converts tabs to spaces as it moves back.
314
315 \\[pascal-complete-word] completes the word around current point with respect \
316 to position in code
317 \\[pascal-show-completions] shows all possible completions at this point.
318
319 Other useful functions are:
320
321 \\[pascal-mark-defun]\t- Mark function.
322 \\[pascal-insert-block]\t- insert begin ... end;
323 \\[pascal-star-comment]\t- insert (* ... *)
324 \\[pascal-comment-area]\t- Put marked area in a comment, fixing nested comments.
325 \\[pascal-uncomment-area]\t- Uncomment an area commented with \
326 \\[pascal-comment-area].
327 \\[pascal-beg-of-defun]\t- Move to beginning of current function.
328 \\[pascal-end-of-defun]\t- Move to end of current function.
329 \\[pascal-goto-defun]\t- Goto function prompted for in the minibuffer.
330 \\[pascal-outline]\t- Enter pascal-outline-mode (see also pascal-outline).
331
332 Variables controlling indentation/edit style:
333
334 pascal-indent-level (default 3)
335 Indentation of Pascal statements with respect to containing block.
336 pascal-case-indent (default 2)
337 Indentation for case statements.
338 pascal-auto-newline (default nil)
339 Non-nil means automatically newline after semicolons and the punctuation
340 mark after an end.
341 pascal-indent-nested-functions (default t)
342 Non-nil means nested functions are indented.
343 pascal-tab-always-indent (default t)
344 Non-nil means TAB in Pascal mode should always reindent the current line,
345 regardless of where in the line point is when the TAB command is used.
346 pascal-auto-endcomments (default t)
347 Non-nil means a comment { ... } is set after the ends which ends cases and
348 functions. The name of the function or case will be set between the braces.
349 pascal-auto-lineup (default t)
350 List of contexts where auto lineup of :'s or ='s should be done.
351
352 See also the user variables pascal-type-keywords, pascal-start-keywords and
353 pascal-separator-keywords.
354
355 Turning on Pascal mode calls the value of the variable pascal-mode-hook with
356 no args, if that value is non-nil."
357 (interactive)
358 (kill-all-local-variables)
359 (use-local-map pascal-mode-map)
360 (setq major-mode 'pascal-mode)
361 (setq mode-name "Pascal")
362 (setq local-abbrev-table pascal-mode-abbrev-table)
363 (set-syntax-table pascal-mode-syntax-table)
364 (make-local-variable 'indent-line-function)
365 (setq indent-line-function 'pascal-indent-line)
366 (make-local-variable 'comment-indent-function)
367 (setq comment-indent-function 'pascal-indent-comment)
368 (make-local-variable 'parse-sexp-ignore-comments)
369 (setq parse-sexp-ignore-comments nil)
370 (make-local-variable 'blink-matching-paren-dont-ignore-comments)
371 (setq blink-matching-paren-dont-ignore-comments t)
372 (make-local-variable 'case-fold-search)
373 (setq case-fold-search t)
374 (make-local-variable 'comment-start)
375 (setq comment-start "{")
376 (make-local-variable 'comment-start-skip)
377 (setq comment-start-skip "(\\*+ *\\|{ *")
378 (make-local-variable 'comment-end)
379 (setq comment-end "}")
380 ;; Font lock support
381 (make-local-variable 'font-lock-defaults)
382 (setq font-lock-defaults '(pascal-font-lock-keywords nil t))
383 ;; Imenu support
384 (make-local-variable 'imenu-generic-expression)
385 (setq imenu-generic-expression pascal-imenu-generic-expression)
386 (setq imenu-case-fold-search t)
387 (run-mode-hooks 'pascal-mode-hook))
388
389 \f
390
391 ;;;
392 ;;; Electric functions
393 ;;;
394 (defun electric-pascal-terminate-line ()
395 "Terminate line and indent next line."
396 (interactive)
397 ;; First, check if current line should be indented
398 (save-excursion
399 (beginning-of-line)
400 (skip-chars-forward " \t")
401 (if (looking-at pascal-autoindent-lines-re)
402 (pascal-indent-line)))
403 (delete-horizontal-space) ; Removes trailing whitespaces
404 (newline)
405 ;; Indent next line
406 (pascal-indent-line)
407 ;; Maybe we should set some endcomments
408 (if pascal-auto-endcomments
409 (pascal-set-auto-comments))
410 ;; Check if we shall indent inside comment
411 (let ((setstar nil))
412 (save-excursion
413 (forward-line -1)
414 (skip-chars-forward " \t")
415 (cond ((looking-at "\\*[ \t]+)")
416 ;; Delete region between `*' and `)' if there is only whitespaces.
417 (forward-char 1)
418 (delete-horizontal-space))
419 ((and (looking-at "(\\*\\|\\*[^)]")
420 (not (save-excursion
421 (search-forward "*)" (pascal-get-end-of-line) t))))
422 (setq setstar t))))
423 ;; If last line was a star comment line then this one shall be too.
424 (if (null setstar)
425 (pascal-indent-line)
426 (insert "* "))))
427
428
429 (defun electric-pascal-semi-or-dot ()
430 "Insert `;' or `.' character and reindent the line."
431 (interactive)
432 (insert last-command-char)
433 (save-excursion
434 (beginning-of-line)
435 (pascal-indent-line))
436 (if pascal-auto-newline
437 (electric-pascal-terminate-line)))
438
439 (defun electric-pascal-colon ()
440 "Insert `:' and do all indentions except line indent on this line."
441 (interactive)
442 (insert last-command-char)
443 ;; Do nothing if within string.
444 (if (pascal-within-string)
445 ()
446 (save-excursion
447 (beginning-of-line)
448 (pascal-indent-line))
449 (let ((pascal-tab-always-indent nil))
450 (pascal-indent-command))))
451
452 (defun electric-pascal-equal ()
453 "Insert `=', and do indention if within type declaration."
454 (interactive)
455 (insert last-command-char)
456 (if (eq (car (pascal-calculate-indent)) 'declaration)
457 (let ((pascal-tab-always-indent nil))
458 (pascal-indent-command))))
459
460 (defun electric-pascal-hash ()
461 "Insert `#', and indent to column 0 if this is a CPP directive."
462 (interactive)
463 (insert last-command-char)
464 (if (save-excursion (beginning-of-line) (looking-at "^[ \t]*#"))
465 (save-excursion (beginning-of-line)
466 (delete-horizontal-space))))
467
468 (defun electric-pascal-tab ()
469 "Function called when TAB is pressed in Pascal mode."
470 (interactive)
471 ;; Do nothing if within a string or in a CPP directive.
472 (if (or (pascal-within-string)
473 (and (not (bolp))
474 (save-excursion (beginning-of-line) (eq (following-char) ?#))))
475 (insert "\t")
476 ;; If pascal-tab-always-indent, indent the beginning of the line.
477 (if pascal-tab-always-indent
478 (save-excursion
479 (beginning-of-line)
480 (pascal-indent-line))
481 (if (save-excursion
482 (skip-chars-backward " \t")
483 (bolp))
484 (pascal-indent-line)
485 (insert "\t")))
486 (pascal-indent-command)))
487
488 \f
489
490 ;;;
491 ;;; Interactive functions
492 ;;;
493 (defun pascal-insert-block ()
494 "Insert Pascal begin ... end; block in the code with right indentation."
495 (interactive)
496 (insert "begin")
497 (electric-pascal-terminate-line)
498 (save-excursion
499 (newline)
500 (insert "end;")
501 (beginning-of-line)
502 (pascal-indent-line)))
503
504 (defun pascal-star-comment ()
505 "Insert Pascal star comment at point."
506 (interactive)
507 (pascal-indent-line)
508 (insert "(*")
509 (electric-pascal-terminate-line)
510 (save-excursion
511 (electric-pascal-terminate-line)
512 (delete-horizontal-space)
513 (insert ")"))
514 (insert " "))
515
516 (defun pascal-mark-defun ()
517 "Mark the current pascal function (or procedure).
518 This puts the mark at the end, and point at the beginning."
519 (interactive)
520 (push-mark (point))
521 (pascal-end-of-defun)
522 (push-mark (point))
523 (pascal-beg-of-defun)
524 (if (fboundp 'zmacs-activate-region)
525 (zmacs-activate-region)))
526
527 (defun pascal-comment-area (start end)
528 "Put the region into a Pascal comment.
529 The comments that are in this area are \"deformed\":
530 `*)' becomes `!(*' and `}' becomes `!{'.
531 These deformed comments are returned to normal if you use
532 \\[pascal-uncomment-area] to undo the commenting.
533
534 The commented area starts with `pascal-exclude-str-start', and ends with
535 `pascal-include-str-end'. But if you change these variables,
536 \\[pascal-uncomment-area] won't recognize the comments."
537 (interactive "r")
538 (save-excursion
539 ;; Insert start and endcomments
540 (goto-char end)
541 (if (and (save-excursion (skip-chars-forward " \t") (eolp))
542 (not (save-excursion (skip-chars-backward " \t") (bolp))))
543 (forward-line 1)
544 (beginning-of-line))
545 (insert pascal-exclude-str-end)
546 (setq end (point))
547 (newline)
548 (goto-char start)
549 (beginning-of-line)
550 (insert pascal-exclude-str-start)
551 (newline)
552 ;; Replace end-comments within commented area
553 (goto-char end)
554 (save-excursion
555 (while (re-search-backward "\\*)" start t)
556 (replace-match "!(*" t t)))
557 (save-excursion
558 (while (re-search-backward "}" start t)
559 (replace-match "!{" t t)))))
560
561 (defun pascal-uncomment-area ()
562 "Uncomment a commented area; change deformed comments back to normal.
563 This command does nothing if the pointer is not in a commented
564 area. See also `pascal-comment-area'."
565 (interactive)
566 (save-excursion
567 (let ((start (point))
568 (end (point)))
569 ;; Find the boundaries of the comment
570 (save-excursion
571 (setq start (progn (search-backward pascal-exclude-str-start nil t)
572 (point)))
573 (setq end (progn (search-forward pascal-exclude-str-end nil t)
574 (point))))
575 ;; Check if we're really inside a comment
576 (if (or (equal start (point)) (<= end (point)))
577 (message "Not standing within commented area.")
578 (progn
579 ;; Remove endcomment
580 (goto-char end)
581 (beginning-of-line)
582 (let ((pos (point)))
583 (end-of-line)
584 (delete-region pos (1+ (point))))
585 ;; Change comments back to normal
586 (save-excursion
587 (while (re-search-backward "!{" start t)
588 (replace-match "}" t t)))
589 (save-excursion
590 (while (re-search-backward "!(\\*" start t)
591 (replace-match "*)" t t)))
592 ;; Remove startcomment
593 (goto-char start)
594 (beginning-of-line)
595 (let ((pos (point)))
596 (end-of-line)
597 (delete-region pos (1+ (point)))))))))
598
599 (defun pascal-beg-of-defun ()
600 "Move backward to the beginning of the current function or procedure."
601 (interactive)
602 (catch 'found
603 (if (not (looking-at (concat "\\s \\|\\s)\\|" pascal-defun-re)))
604 (forward-sexp 1))
605 (let ((nest 0) (max -1) (func 0)
606 (reg (concat pascal-beg-block-re "\\|"
607 pascal-end-block-re "\\|"
608 pascal-defun-re)))
609 (while (re-search-backward reg nil 'move)
610 (cond ((let ((state (save-excursion
611 (parse-partial-sexp (point-min) (point)))))
612 (or (nth 3 state) (nth 4 state))) ; Inside string or comment
613 ())
614 ((match-end 1) ; begin|case|record|repeat
615 (if (and (looking-at "\\<record\\>") (>= max 0))
616 (setq func (1- func)))
617 (setq nest (1+ nest)
618 max (max nest max)))
619 ((match-end 2) ; end|until
620 (if (and (= nest max) (>= max 0))
621 (setq func (1+ func)))
622 (setq nest (1- nest)))
623 ((match-end 3) ; function|procedure
624 (if (= 0 func)
625 (throw 'found t)
626 (setq func (1- func)))))))
627 nil))
628
629 (defun pascal-end-of-defun ()
630 "Move forward to the end of the current function or procedure."
631 (interactive)
632 (if (looking-at "\\s ")
633 (forward-sexp 1))
634 (if (not (looking-at pascal-defun-re))
635 (pascal-beg-of-defun))
636 (forward-char 1)
637 (let ((nest 0) (func 1)
638 (reg (concat pascal-beg-block-re "\\|"
639 pascal-end-block-re "\\|"
640 pascal-defun-re)))
641 (while (and (/= func 0)
642 (re-search-forward reg nil 'move))
643 (cond ((let ((state (save-excursion
644 (parse-partial-sexp (point-min) (point)))))
645 (or (nth 3 state) (nth 4 state))) ; Inside string or comment
646 ())
647 ((match-end 1)
648 (setq nest (1+ nest))
649 (if (save-excursion
650 (goto-char (match-beginning 0))
651 (looking-at "\\<record\\>"))
652 (setq func (1+ func))))
653 ((match-end 2)
654 (setq nest (1- nest))
655 (if (= nest 0)
656 (setq func (1- func))))
657 ((match-end 3)
658 (setq func (1+ func))))))
659 (forward-line 1))
660
661 (defun pascal-end-of-statement ()
662 "Move forward to end of current statement."
663 (interactive)
664 (let ((parse-sexp-ignore-comments t)
665 (nest 0) pos
666 (regexp (concat "\\(" pascal-beg-block-re "\\)\\|\\("
667 pascal-end-block-re "\\)")))
668 (if (not (looking-at "[ \t\n]")) (forward-sexp -1))
669 (or (looking-at pascal-beg-block-re)
670 ;; Skip to end of statement
671 (setq pos (catch 'found
672 (while t
673 (forward-sexp 1)
674 (cond ((looking-at "[ \t]*;")
675 (skip-chars-forward "^;")
676 (forward-char 1)
677 (throw 'found (point)))
678 ((save-excursion
679 (forward-sexp -1)
680 (looking-at pascal-beg-block-re))
681 (goto-char (match-beginning 0))
682 (throw 'found nil))
683 ((eobp)
684 (throw 'found (point))))))))
685 (if (not pos)
686 ;; Skip a whole block
687 (catch 'found
688 (while t
689 (re-search-forward regexp nil 'move)
690 (setq nest (if (match-end 1)
691 (1+ nest)
692 (1- nest)))
693 (cond ((eobp)
694 (throw 'found (point)))
695 ((= 0 nest)
696 (throw 'found (pascal-end-of-statement))))))
697 pos)))
698
699 (defun pascal-downcase-keywords ()
700 "Downcase all Pascal keywords in the buffer."
701 (interactive)
702 (pascal-change-keywords 'downcase-word))
703
704 (defun pascal-upcase-keywords ()
705 "Upcase all Pascal keywords in the buffer."
706 (interactive)
707 (pascal-change-keywords 'upcase-word))
708
709 (defun pascal-capitalize-keywords ()
710 "Capitalize all Pascal keywords in the buffer."
711 (interactive)
712 (pascal-change-keywords 'capitalize-word))
713
714 ;; Change the keywords according to argument.
715 (defun pascal-change-keywords (change-word)
716 (save-excursion
717 (let ((keyword-re (concat "\\<\\("
718 (mapconcat 'identity pascal-keywords "\\|")
719 "\\)\\>")))
720 (goto-char (point-min))
721 (while (re-search-forward keyword-re nil t)
722 (funcall change-word -1)))))
723
724 \f
725
726 ;;;
727 ;;; Other functions
728 ;;;
729 (defun pascal-set-auto-comments ()
730 "Insert `{ case }' or `{ NAME }' on this line if appropriate.
731 Insert `{ case }' if there is an `end' on the line which
732 ends a case block. Insert `{ NAME }' if there is an `end'
733 on the line which ends a function or procedure named NAME."
734 (save-excursion
735 (forward-line -1)
736 (skip-chars-forward " \t")
737 (if (and (looking-at "\\<end;")
738 (not (save-excursion
739 (end-of-line)
740 (search-backward "{" (pascal-get-beg-of-line) t))))
741 (let ((type (car (pascal-calculate-indent))))
742 (if (eq type 'declaration)
743 ()
744 (if (eq type 'case)
745 ;; This is a case block
746 (progn
747 (end-of-line)
748 (delete-horizontal-space)
749 (insert " { case }"))
750 (let ((nest 1))
751 ;; Check if this is the end of a function
752 (save-excursion
753 (while (not (or (looking-at pascal-defun-re) (bobp)))
754 (backward-sexp 1)
755 (cond ((looking-at pascal-beg-block-re)
756 (setq nest (1- nest)))
757 ((looking-at pascal-end-block-re)
758 (setq nest (1+ nest)))))
759 (if (bobp)
760 (setq nest 1)))
761 (if (zerop nest)
762 (progn
763 (end-of-line)
764 (delete-horizontal-space)
765 (insert " { ")
766 (let (b e)
767 (save-excursion
768 (setq b (progn (pascal-beg-of-defun)
769 (skip-chars-forward "^ \t")
770 (skip-chars-forward " \t")
771 (point))
772 e (progn (skip-chars-forward "a-zA-Z0-9_")
773 (point))))
774 (insert-buffer-substring (current-buffer) b e))
775 (insert " }"))))))))))
776
777 \f
778
779 ;;;
780 ;;; Indentation
781 ;;;
782 (defconst pascal-indent-alist
783 '((block . (+ ind pascal-indent-level))
784 (case . (+ ind pascal-case-indent))
785 (caseblock . ind) (cpp . 0)
786 (declaration . (+ ind pascal-indent-level))
787 (paramlist . (pascal-indent-paramlist t))
788 (comment . (pascal-indent-comment))
789 (defun . ind) (contexp . ind)
790 (unknown . ind) (string . 0) (progbeg . 0)))
791
792 (defun pascal-indent-command ()
793 "Indent for special part of code."
794 (let* ((indent-str (pascal-calculate-indent))
795 (type (car indent-str))
796 (ind (car (cdr indent-str))))
797 (cond ((and (eq type 'paramlist)
798 (or (memq 'all pascal-auto-lineup)
799 (memq 'paramlist pascal-auto-lineup)))
800 (pascal-indent-paramlist)
801 (pascal-indent-paramlist))
802 ((and (eq type 'declaration)
803 (or (memq 'all pascal-auto-lineup)
804 (memq 'declaration pascal-auto-lineup)))
805 (pascal-indent-declaration))
806 ((and (eq type 'case) (not (looking-at "^[ \t]*$"))
807 (or (memq 'all pascal-auto-lineup)
808 (memq 'case pascal-auto-lineup)))
809 (pascal-indent-case)))
810 (if (looking-at "[ \t]+$")
811 (skip-chars-forward " \t"))))
812
813 (defun pascal-indent-line ()
814 "Indent current line as a Pascal statement."
815 (let* ((indent-str (pascal-calculate-indent))
816 (type (car indent-str))
817 (ind (car (cdr indent-str))))
818 ;; Labels should not be indented.
819 (if (and (looking-at "^[0-9a-zA-Z]+[ \t]*:[^=]")
820 (not (eq type 'declaration)))
821 (search-forward ":" nil t))
822 (delete-horizontal-space)
823 (cond (; Some things should not be indented
824 (or (and (eq type 'declaration) (looking-at pascal-declaration-re))
825 (eq type 'cpp))
826 ())
827 (; Other things should have no extra indent
828 (looking-at pascal-noindent-re)
829 (indent-to ind))
830 (; Nested functions should be indented
831 (looking-at pascal-defun-re)
832 (if (and pascal-indent-nested-functions
833 (eq type 'defun))
834 (indent-to (+ ind pascal-indent-level))
835 (indent-to ind)))
836 (; But most lines are treated this way
837 (indent-to (eval (cdr (assoc type pascal-indent-alist))))
838 ))))
839
840 (defun pascal-calculate-indent ()
841 "Calculate the indent of the current Pascal line.
842 Return a list of two elements: (INDENT-TYPE INDENT-LEVEL)."
843 (save-excursion
844 (let* ((parse-sexp-ignore-comments t)
845 (oldpos (point))
846 (state (save-excursion (parse-partial-sexp (point-min) (point))))
847 (nest 0) (par 0) (complete (looking-at "[ \t]*end\\>"))
848 (elsed (looking-at "[ \t]*else\\>")) (funccnt 0)
849 (did-func (looking-at "[ \t]*\\(procedure\\|function\\)\\>"))
850 (type (catch 'nesting
851 ;; Check if inside a string, comment or parenthesis
852 (cond ((nth 3 state) (throw 'nesting 'string))
853 ((nth 4 state) (throw 'nesting 'comment))
854 ((> (car state) 0)
855 (goto-char (scan-lists (point) -1 (car state)))
856 (setq par (1+ (current-column))))
857 ((save-excursion (beginning-of-line)
858 (eq (following-char) ?#))
859 (throw 'nesting 'cpp)))
860 ;; Loop until correct indent is found
861 (while t
862 (backward-sexp 1)
863 (cond (;--Escape from case statements
864 (and (looking-at "[A-Za-z0-9]+[ \t]*:[^=]")
865 (not complete)
866 (save-excursion (skip-chars-backward " \t")
867 (bolp))
868 (= (save-excursion
869 (end-of-line) (backward-sexp) (point))
870 (point))
871 (> (save-excursion (goto-char oldpos)
872 (beginning-of-line)
873 (point))
874 (point)))
875 (throw 'nesting 'caseblock))
876 (;--Beginning of program
877 (looking-at pascal-progbeg-re)
878 (throw 'nesting 'progbeg))
879 (;--No known statements
880 (bobp)
881 (throw 'nesting 'progbeg))
882 (;--Nest block outwards
883 (looking-at pascal-beg-block-re)
884 (if (= nest 0)
885 (cond ((looking-at "case\\>")
886 (throw 'nesting 'case))
887 ((looking-at "record\\>")
888 (throw 'nesting 'declaration))
889 (t (throw 'nesting 'block)))
890 (if (and (looking-at "record\\>") (= nest 1))
891 (setq funccnt (1- funccnt)))
892 (setq nest (1- nest))))
893 (;--Nest block inwards
894 (looking-at pascal-end-block-re)
895 (if (and (looking-at "end\\s ")
896 elsed (not complete))
897 (throw 'nesting 'block))
898 (if (= nest 0)
899 (setq funccnt (1+ funccnt)))
900 (setq complete t
901 nest (1+ nest)))
902 (;--Defun (or parameter list)
903 (and (looking-at pascal-defun-re)
904 (progn (setq funccnt (1- funccnt)
905 did-func t)
906 (or (bolp) (< funccnt 0))))
907 ;; Prevent searching whole buffer
908 (if (and (bolp) (>= funccnt 0))
909 (throw 'nesting 'progbeg))
910 (if (= 0 par)
911 (throw 'nesting 'defun)
912 (setq par 0)
913 (let ((n 0))
914 (while (re-search-forward
915 "\\(\\<record\\>\\)\\|\\<end\\>"
916 oldpos t)
917 (if (match-end 1)
918 (setq n (1+ n)) (setq n (1- n))))
919 (if (> n 0)
920 (throw 'nesting 'declaration)
921 (throw 'nesting 'paramlist)))))
922 (;--Declaration part
923 (and (looking-at pascal-declaration-re)
924 (not did-func)
925 (= funccnt 0))
926 (if (save-excursion
927 (goto-char oldpos)
928 (forward-line -1)
929 (looking-at "^[ \t]*$"))
930 (throw 'nesting 'unknown)
931 (throw 'nesting 'declaration)))
932 (;--If, else or while statement
933 (and (not complete)
934 (looking-at pascal-sub-block-re))
935 (throw 'nesting 'block))
936 (;--Found complete statement
937 (save-excursion (forward-sexp 1)
938 (= (following-char) ?\;))
939 (setq complete t))
940 )))))
941
942 ;; Return type of block and indent level.
943 (if (> par 0) ; Unclosed Parenthesis
944 (list 'contexp par)
945 (list type (pascal-indent-level))))))
946
947 (defun pascal-indent-level ()
948 "Return the indent-level the current statement has.
949 Do not count labels, case-statements or records."
950 (save-excursion
951 (beginning-of-line)
952 (if (looking-at "[ \t]*[0-9a-zA-Z]+[ \t]*:[^=]")
953 (search-forward ":" nil t)
954 (if (looking-at ".*=[ \t]*record\\>")
955 (search-forward "=" nil t)))
956 (skip-chars-forward " \t")
957 (current-column)))
958
959 (defun pascal-indent-comment ()
960 "Return indent for current comment."
961 (save-excursion
962 (re-search-backward "\\((\\*\\)\\|{" nil t)
963 (if (match-beginning 1)
964 (1+ (current-column))
965 (current-column))))
966
967 (defun pascal-indent-case ()
968 "Indent within case statements."
969 (let ((savepos (point-marker))
970 (end (prog2
971 (end-of-line)
972 (point-marker)
973 (re-search-backward "\\<case\\>" nil t)))
974 (beg (point)) oldpos
975 (ind 0))
976 ;; Get right indent
977 (while (< (point) end)
978 (if (re-search-forward
979 "^[ \t]*[^ \t,:]+[ \t]*\\(,[ \t]*[^ \t,:]+[ \t]*\\)*:"
980 (marker-position end) 'move)
981 (forward-char -1))
982 (if (< (point) end)
983 (progn
984 (delete-horizontal-space)
985 (if (> (current-column) ind)
986 (setq ind (current-column)))
987 (pascal-end-of-statement))))
988 (goto-char beg)
989 (setq oldpos (marker-position end))
990 ;; Indent all case statements
991 (while (< (point) end)
992 (if (re-search-forward
993 "^[ \t]*[^][ \t,\\.:]+[ \t]*\\(,[ \t]*[^ \t,:]+[ \t]*\\)*:"
994 (marker-position end) 'move)
995 (forward-char -1))
996 (indent-to (1+ ind))
997 (if (/= (following-char) ?:)
998 ()
999 (forward-char 1)
1000 (delete-horizontal-space)
1001 (insert " "))
1002 (setq oldpos (point))
1003 (pascal-end-of-statement))
1004 (goto-char savepos)))
1005
1006 (defun pascal-indent-paramlist (&optional arg)
1007 "Indent current line in parameterlist.
1008 If optional arg is non-nil, just return the
1009 indent of the current line in parameterlist."
1010 (save-excursion
1011 (let* ((oldpos (point))
1012 (stpos (progn (goto-char (scan-lists (point) -1 1)) (point)))
1013 (stcol (1+ (current-column)))
1014 (edpos (progn (pascal-declaration-end)
1015 (search-backward ")" (pascal-get-beg-of-line) t)
1016 (point)))
1017 (usevar (re-search-backward "\\<var\\>" stpos t)))
1018 (if arg (progn
1019 ;; If arg, just return indent
1020 (goto-char oldpos)
1021 (beginning-of-line)
1022 (if (or (not usevar) (looking-at "[ \t]*var\\>"))
1023 stcol (+ 4 stcol)))
1024 (goto-char stpos)
1025 (forward-char 1)
1026 (delete-horizontal-space)
1027 (if (and usevar (not (looking-at "var\\>")))
1028 (indent-to (+ 4 stcol)))
1029 (pascal-indent-declaration nil stpos edpos)))))
1030
1031 (defun pascal-indent-declaration (&optional arg start end)
1032 "Indent current lines as declaration, lining up the `:'s or `='s."
1033 (let ((pos (point-marker)))
1034 (if (and (not (or arg start)) (not (pascal-declaration-beg)))
1035 ()
1036 (let ((lineup (if (or (looking-at "\\<var\\>\\|\\<record\\>") arg start)
1037 ":" "="))
1038 (stpos (if start start
1039 (forward-word 2) (backward-word 1) (point)))
1040 (edpos (set-marker (make-marker)
1041 (if end end
1042 (max (progn (pascal-declaration-end)
1043 (point))
1044 pos))))
1045 ind)
1046
1047 (goto-char stpos)
1048 ;; Indent lines in record block
1049 (if arg
1050 (while (<= (point) edpos)
1051 (beginning-of-line)
1052 (delete-horizontal-space)
1053 (if (looking-at "end\\>")
1054 (indent-to arg)
1055 (indent-to (+ arg pascal-indent-level)))
1056 (forward-line 1)))
1057
1058 ;; Do lineup
1059 (setq ind (pascal-get-lineup-indent stpos edpos lineup))
1060 (goto-char stpos)
1061 (while (and (<= (point) edpos) (not (eobp)))
1062 (if (search-forward lineup (pascal-get-end-of-line) 'move)
1063 (forward-char -1))
1064 (delete-horizontal-space)
1065 (indent-to ind)
1066 (if (not (looking-at lineup))
1067 (forward-line 1) ; No more indent if there is no : or =
1068 (forward-char 1)
1069 (delete-horizontal-space)
1070 (insert " ")
1071 ;; Indent record block
1072 (if (looking-at "record\\>")
1073 (pascal-indent-declaration (current-column)))
1074 (forward-line 1)))))
1075
1076 ;; If arg - move point
1077 (if arg (forward-line -1)
1078 (goto-char pos))))
1079
1080 ; "Return the indent level that will line up several lines within the region
1081 ;from b to e nicely. The lineup string is str."
1082 (defun pascal-get-lineup-indent (b e str)
1083 (save-excursion
1084 (let ((ind 0)
1085 (reg (concat str "\\|\\(\\<record\\>\\)\\|" pascal-defun-re)))
1086 (goto-char b)
1087 ;; Get rightmost position
1088 (while (< (point) e)
1089 (and (re-search-forward reg (min e (pascal-get-end-of-line 2)) 'move)
1090 (cond ((match-beginning 1)
1091 ;; Skip record blocks
1092 (pascal-declaration-end))
1093 ((match-beginning 2)
1094 ;; We have entered a new procedure. Exit.
1095 (goto-char e))
1096 (t
1097 (goto-char (match-beginning 0))
1098 (skip-chars-backward " \t")
1099 (if (> (current-column) ind)
1100 (setq ind (current-column)))
1101 (goto-char (match-end 0))
1102 (end-of-line)
1103 ))))
1104 ;; In case no lineup was found
1105 (if (> ind 0)
1106 (1+ ind)
1107 ;; No lineup-string found
1108 (goto-char b)
1109 (end-of-line)
1110 (skip-chars-backward " \t")
1111 (1+ (current-column))))))
1112
1113 \f
1114
1115 ;;;
1116 ;;; Completion
1117 ;;;
1118 (defvar pascal-str nil)
1119 (defvar pascal-all nil)
1120 (defvar pascal-pred nil)
1121 (defvar pascal-buffer-to-use nil)
1122 (defvar pascal-flag nil)
1123
1124 (defun pascal-string-diff (str1 str2)
1125 "Return index of first letter where STR1 and STR2 differs."
1126 (catch 'done
1127 (let ((diff 0))
1128 (while t
1129 (if (or (> (1+ diff) (length str1))
1130 (> (1+ diff) (length str2)))
1131 (throw 'done diff))
1132 (or (equal (aref str1 diff) (aref str2 diff))
1133 (throw 'done diff))
1134 (setq diff (1+ diff))))))
1135
1136 ;; Calculate all possible completions for functions if argument is `function',
1137 ;; completions for procedures if argument is `procedure' or both functions and
1138 ;; procedures otherwise.
1139
1140 (defun pascal-func-completion (type)
1141 ;; Build regular expression for function/procedure names
1142 (if (string= pascal-str "")
1143 (setq pascal-str "[a-zA-Z_]"))
1144 (let ((pascal-str (concat (cond
1145 ((eq type 'procedure) "\\<\\(procedure\\)\\s +")
1146 ((eq type 'function) "\\<\\(function\\)\\s +")
1147 (t "\\<\\(function\\|procedure\\)\\s +"))
1148 "\\<\\(" pascal-str "[a-zA-Z0-9_.]*\\)\\>"))
1149 match)
1150
1151 (if (not (looking-at "\\<\\(function\\|procedure\\)\\>"))
1152 (re-search-backward "\\<\\(function\\|procedure\\)\\>" nil t))
1153 (forward-char 1)
1154
1155 ;; Search through all reachable functions
1156 (while (pascal-beg-of-defun)
1157 (if (re-search-forward pascal-str (pascal-get-end-of-line) t)
1158 (progn (setq match (buffer-substring (match-beginning 2)
1159 (match-end 2)))
1160 (if (or (null pascal-pred)
1161 (funcall pascal-pred match))
1162 (setq pascal-all (cons match pascal-all)))))
1163 (goto-char (match-beginning 0)))))
1164
1165 (defun pascal-get-completion-decl ()
1166 ;; Macro for searching through current declaration (var, type or const)
1167 ;; for matches of `str' and adding the occurrence to `all'
1168 (let ((end (save-excursion (pascal-declaration-end)
1169 (point)))
1170 match)
1171 ;; Traverse lines
1172 (while (< (point) end)
1173 (if (re-search-forward "[:=]" (pascal-get-end-of-line) t)
1174 ;; Traverse current line
1175 (while (and (re-search-backward
1176 (concat "\\((\\|\\<\\(var\\|type\\|const\\)\\>\\)\\|"
1177 pascal-symbol-re)
1178 (pascal-get-beg-of-line) t)
1179 (not (match-end 1)))
1180 (setq match (buffer-substring (match-beginning 0) (match-end 0)))
1181 (if (string-match (concat "\\<" pascal-str) match)
1182 (if (or (null pascal-pred)
1183 (funcall pascal-pred match))
1184 (setq pascal-all (cons match pascal-all))))))
1185 (if (re-search-forward "\\<record\\>" (pascal-get-end-of-line) t)
1186 (pascal-declaration-end)
1187 (forward-line 1)))))
1188
1189 (defun pascal-type-completion ()
1190 "Calculate all possible completions for types."
1191 (let ((start (point))
1192 goon)
1193 ;; Search for all reachable type declarations
1194 (while (or (pascal-beg-of-defun)
1195 (setq goon (not goon)))
1196 (save-excursion
1197 (if (and (< start (prog1 (save-excursion (pascal-end-of-defun)
1198 (point))
1199 (forward-char 1)))
1200 (re-search-forward
1201 "\\<type\\>\\|\\<\\(begin\\|function\\|procedure\\)\\>"
1202 start t)
1203 (not (match-end 1)))
1204 ;; Check current type declaration
1205 (pascal-get-completion-decl))))))
1206
1207 (defun pascal-var-completion ()
1208 "Calculate all possible completions for variables (or constants)."
1209 (let ((start (point))
1210 goon twice)
1211 ;; Search for all reachable var declarations
1212 (while (or (pascal-beg-of-defun)
1213 (setq goon (not goon)))
1214 (save-excursion
1215 (if (> start (prog1 (save-excursion (pascal-end-of-defun)
1216 (point))))
1217 () ; Declarations not reachable
1218 (if (search-forward "(" (pascal-get-end-of-line) t)
1219 ;; Check parameterlist
1220 (pascal-get-completion-decl))
1221 (setq twice 2)
1222 (while (>= (setq twice (1- twice)) 0)
1223 (cond ((and (re-search-forward
1224 (concat "\\<\\(var\\|const\\)\\>\\|"
1225 "\\<\\(begin\\|function\\|procedure\\)\\>")
1226 start t)
1227 (not (match-end 2)))
1228 ;; Check var/const declarations
1229 (pascal-get-completion-decl))
1230 ((match-end 2)
1231 (setq twice 0)))))))))
1232
1233
1234 (defun pascal-keyword-completion (keyword-list)
1235 "Give list of all possible completions of keywords in KEYWORD-LIST."
1236 (mapcar '(lambda (s)
1237 (if (string-match (concat "\\<" pascal-str) s)
1238 (if (or (null pascal-pred)
1239 (funcall pascal-pred s))
1240 (setq pascal-all (cons s pascal-all)))))
1241 keyword-list))
1242
1243 ;; Function passed to completing-read, try-completion or
1244 ;; all-completions to get completion on STR. If predicate is non-nil,
1245 ;; it must be a function to be called for every match to check if this
1246 ;; should really be a match. If flag is t, the function returns a list
1247 ;; of all possible completions. If it is nil it returns a string, the
1248 ;; longest possible completion, or t if STR is an exact match. If flag
1249 ;; is 'lambda, the function returns t if STR is an exact match, nil
1250 ;; otherwise.
1251
1252 (defun pascal-completion (pascal-str pascal-pred pascal-flag)
1253 (save-excursion
1254 (let ((pascal-all nil))
1255 ;; Set buffer to use for searching labels. This should be set
1256 ;; within functions which use pascal-completions
1257 (set-buffer pascal-buffer-to-use)
1258
1259 ;; Determine what should be completed
1260 (let ((state (car (pascal-calculate-indent))))
1261 (cond (;--Within a declaration or parameterlist
1262 (or (eq state 'declaration) (eq state 'paramlist)
1263 (and (eq state 'defun)
1264 (save-excursion
1265 (re-search-backward ")[ \t]*:"
1266 (pascal-get-beg-of-line) t))))
1267 (if (or (eq state 'paramlist) (eq state 'defun))
1268 (pascal-beg-of-defun))
1269 (pascal-type-completion)
1270 (pascal-keyword-completion pascal-type-keywords))
1271 (;--Starting a new statement
1272 (and (not (eq state 'contexp))
1273 (save-excursion
1274 (skip-chars-backward "a-zA-Z0-9_.")
1275 (backward-sexp 1)
1276 (or (looking-at pascal-nosemi-re)
1277 (progn
1278 (forward-sexp 1)
1279 (looking-at "\\s *\\(;\\|:[^=]\\)")))))
1280 (save-excursion (pascal-var-completion))
1281 (pascal-func-completion 'procedure)
1282 (pascal-keyword-completion pascal-start-keywords))
1283 (t;--Anywhere else
1284 (save-excursion (pascal-var-completion))
1285 (pascal-func-completion 'function)
1286 (pascal-keyword-completion pascal-separator-keywords))))
1287
1288 ;; Now we have built a list of all matches. Give response to caller
1289 (pascal-completion-response))))
1290
1291 (defun pascal-completion-response ()
1292 (cond ((or (equal pascal-flag 'lambda) (null pascal-flag))
1293 ;; This was not called by all-completions
1294 (if (null pascal-all)
1295 ;; Return nil if there was no matching label
1296 nil
1297 ;; Get longest string common in the labels
1298 (let* ((elm (cdr pascal-all))
1299 (match (car pascal-all))
1300 (min (length match))
1301 tmp)
1302 (if (string= match pascal-str)
1303 ;; Return t if first match was an exact match
1304 (setq match t)
1305 (while (not (null elm))
1306 ;; Find longest common string
1307 (if (< (setq tmp (pascal-string-diff match (car elm))) min)
1308 (progn
1309 (setq min tmp)
1310 (setq match (substring match 0 min))))
1311 ;; Terminate with match=t if this is an exact match
1312 (if (string= (car elm) pascal-str)
1313 (progn
1314 (setq match t)
1315 (setq elm nil))
1316 (setq elm (cdr elm)))))
1317 ;; If this is a test just for exact match, return nil ot t
1318 (if (and (equal pascal-flag 'lambda) (not (equal match 't)))
1319 nil
1320 match))))
1321 ;; If flag is t, this was called by all-completions. Return
1322 ;; list of all possible completions
1323 (pascal-flag
1324 pascal-all)))
1325
1326 (defvar pascal-last-word-numb 0)
1327 (defvar pascal-last-word-shown nil)
1328 (defvar pascal-last-completions nil)
1329
1330 (defun pascal-complete-word ()
1331 "Complete word at current point.
1332 \(See also `pascal-toggle-completions', `pascal-type-keywords',
1333 `pascal-start-keywords' and `pascal-separator-keywords'.)"
1334 (interactive)
1335 (let* ((b (save-excursion (skip-chars-backward "a-zA-Z0-9_") (point)))
1336 (e (save-excursion (skip-chars-forward "a-zA-Z0-9_") (point)))
1337 (pascal-str (buffer-substring b e))
1338 ;; The following variable is used in pascal-completion
1339 (pascal-buffer-to-use (current-buffer))
1340 (allcomp (if (and pascal-toggle-completions
1341 (string= pascal-last-word-shown pascal-str))
1342 pascal-last-completions
1343 (all-completions pascal-str 'pascal-completion)))
1344 (match (if pascal-toggle-completions
1345 "" (try-completion
1346 pascal-str (mapcar '(lambda (elm)
1347 (cons elm 0)) allcomp)))))
1348 ;; Delete old string
1349 (delete-region b e)
1350
1351 ;; Toggle-completions inserts whole labels
1352 (if pascal-toggle-completions
1353 (progn
1354 ;; Update entry number in list
1355 (setq pascal-last-completions allcomp
1356 pascal-last-word-numb
1357 (if (>= pascal-last-word-numb (1- (length allcomp)))
1358 0
1359 (1+ pascal-last-word-numb)))
1360 (setq pascal-last-word-shown (elt allcomp pascal-last-word-numb))
1361 ;; Display next match or same string if no match was found
1362 (if (not (null allcomp))
1363 (insert "" pascal-last-word-shown)
1364 (insert "" pascal-str)
1365 (message "(No match)")))
1366 ;; The other form of completion does not necessarily do that.
1367
1368 ;; Insert match if found, or the original string if no match
1369 (if (or (null match) (equal match 't))
1370 (progn (insert "" pascal-str)
1371 (message "(No match)"))
1372 (insert "" match))
1373 ;; Give message about current status of completion
1374 (cond ((equal match 't)
1375 (if (not (null (cdr allcomp)))
1376 (message "(Complete but not unique)")
1377 (message "(Sole completion)")))
1378 ;; Display buffer if the current completion didn't help
1379 ;; on completing the label.
1380 ((and (not (null (cdr allcomp))) (= (length pascal-str)
1381 (length match)))
1382 (with-output-to-temp-buffer "*Completions*"
1383 (display-completion-list allcomp))
1384 ;; Wait for a keypress. Then delete *Completion* window
1385 (momentary-string-display "" (point))
1386 (delete-window (get-buffer-window (get-buffer "*Completions*")))
1387 )))))
1388
1389 (defun pascal-show-completions ()
1390 "Show all possible completions at current point."
1391 (interactive)
1392 (let* ((b (save-excursion (skip-chars-backward "a-zA-Z0-9_") (point)))
1393 (e (save-excursion (skip-chars-forward "a-zA-Z0-9_") (point)))
1394 (pascal-str (buffer-substring b e))
1395 ;; The following variable is used in pascal-completion
1396 (pascal-buffer-to-use (current-buffer))
1397 (allcomp (if (and pascal-toggle-completions
1398 (string= pascal-last-word-shown pascal-str))
1399 pascal-last-completions
1400 (all-completions pascal-str 'pascal-completion))))
1401 ;; Show possible completions in a temporary buffer.
1402 (with-output-to-temp-buffer "*Completions*"
1403 (display-completion-list allcomp))
1404 ;; Wait for a keypress. Then delete *Completion* window
1405 (momentary-string-display "" (point))
1406 (delete-window (get-buffer-window (get-buffer "*Completions*")))))
1407
1408
1409 (defun pascal-get-default-symbol ()
1410 "Return symbol around current point as a string."
1411 (save-excursion
1412 (buffer-substring (progn
1413 (skip-chars-backward " \t")
1414 (skip-chars-backward "a-zA-Z0-9_")
1415 (point))
1416 (progn
1417 (skip-chars-forward "a-zA-Z0-9_")
1418 (point)))))
1419
1420 (defun pascal-build-defun-re (str &optional arg)
1421 "Return function/procedure starting with STR as regular expression.
1422 With optional second arg non-nil, STR is the complete name of the instruction."
1423 (if arg
1424 (concat "^\\(function\\|procedure\\)[ \t]+\\(" str "\\)\\>")
1425 (concat "^\\(function\\|procedure\\)[ \t]+\\(" str "[a-zA-Z0-9_]*\\)\\>")))
1426
1427 ;; Function passed to completing-read, try-completion or
1428 ;; all-completions to get completion on any function name. If
1429 ;; predicate is non-nil, it must be a function to be called for every
1430 ;; match to check if this should really be a match. If flag is t, the
1431 ;; function returns a list of all possible completions. If it is nil
1432 ;; it returns a string, the longest possible completion, or t if STR
1433 ;; is an exact match. If flag is 'lambda, the function returns t if
1434 ;; STR is an exact match, nil otherwise.
1435
1436 (defun pascal-comp-defun (pascal-str pascal-pred pascal-flag)
1437 (save-excursion
1438 (let ((pascal-all nil)
1439 match)
1440
1441 ;; Set buffer to use for searching labels. This should be set
1442 ;; within functions which use pascal-completions
1443 (set-buffer pascal-buffer-to-use)
1444
1445 (let ((pascal-str pascal-str))
1446 ;; Build regular expression for functions
1447 (if (string= pascal-str "")
1448 (setq pascal-str (pascal-build-defun-re "[a-zA-Z_]"))
1449 (setq pascal-str (pascal-build-defun-re pascal-str)))
1450 (goto-char (point-min))
1451
1452 ;; Build a list of all possible completions
1453 (while (re-search-forward pascal-str nil t)
1454 (setq match (buffer-substring (match-beginning 2) (match-end 2)))
1455 (if (or (null pascal-pred)
1456 (funcall pascal-pred match))
1457 (setq pascal-all (cons match pascal-all)))))
1458
1459 ;; Now we have built a list of all matches. Give response to caller
1460 (pascal-completion-response))))
1461
1462 (defun pascal-goto-defun ()
1463 "Move to specified Pascal function/procedure.
1464 The default is a name found in the buffer around point."
1465 (interactive)
1466 (let* ((default (pascal-get-default-symbol))
1467 ;; The following variable is used in pascal-comp-function
1468 (pascal-buffer-to-use (current-buffer))
1469 (default (if (pascal-comp-defun default nil 'lambda)
1470 default ""))
1471 (label (if (not (string= default ""))
1472 ;; Do completion with default
1473 (completing-read (concat "Label: (default " default ") ")
1474 'pascal-comp-defun nil t "")
1475 ;; There is no default value. Complete without it
1476 (completing-read "Label: "
1477 'pascal-comp-defun nil t ""))))
1478 ;; If there was no response on prompt, use default value
1479 (if (string= label "")
1480 (setq label default))
1481 ;; Goto right place in buffer if label is not an empty string
1482 (or (string= label "")
1483 (progn
1484 (goto-char (point-min))
1485 (re-search-forward (pascal-build-defun-re label t))
1486 (beginning-of-line)))))
1487
1488 \f
1489
1490 ;;;
1491 ;;; Pascal-outline-mode
1492 ;;;
1493 (defvar pascal-outline-map nil "Keymap used in Pascal Outline mode.")
1494
1495 (if pascal-outline-map
1496 nil
1497 (if (fboundp 'set-keymap-name)
1498 (set-keymap-name pascal-outline-map 'pascal-outline-map))
1499 (if (fboundp 'set-keymap-parent)
1500 (set-keymap-parent (setq pascal-outline-map (make-sparse-keymap))
1501 pascal-mode-map)
1502 (setq pascal-outline-map (copy-keymap pascal-mode-map)))
1503 (define-key pascal-outline-map "\M-\C-a" 'pascal-outline-prev-defun)
1504 (define-key pascal-outline-map "\M-\C-e" 'pascal-outline-next-defun)
1505 (define-key pascal-outline-map "\C-c\C-d" 'pascal-outline-goto-defun)
1506 (define-key pascal-outline-map "\C-c\C-s" 'pascal-show-all)
1507 (define-key pascal-outline-map "\C-c\C-h" 'pascal-hide-other-defuns))
1508
1509 (defvar pascal-outline-mode nil "Non-nil while using Pascal Outline mode.")
1510 (make-variable-buffer-local 'pascal-outline-mode)
1511 (set-default 'pascal-outline-mode nil)
1512 (if (not (assoc 'pascal-outline-mode minor-mode-alist))
1513 (setq minor-mode-alist (append minor-mode-alist
1514 (list '(pascal-outline-mode " Outl")))))
1515
1516 (defun pascal-outline (&optional arg)
1517 "Outline-line minor mode for Pascal mode.
1518 When in Pascal Outline mode, portions
1519 of the text being edited may be made invisible. \\<pascal-outline-map>
1520
1521 Pascal Outline mode provides some additional commands.
1522
1523 \\[pascal-outline-prev-defun]\
1524 \t- Move to previous function/procedure, hiding everything else.
1525 \\[pascal-outline-next-defun]\
1526 \t- Move to next function/procedure, hiding everything else.
1527 \\[pascal-outline-goto-defun]\
1528 \t- Goto function/procedure prompted for in minibuffer,
1529 \t hide all other functions.
1530 \\[pascal-show-all]\t- Show the whole buffer.
1531 \\[pascal-hide-other-defuns]\
1532 \t- Hide everything but the current function (function under the cursor).
1533 \\[pascal-outline]\t- Leave pascal-outline-mode."
1534 (interactive "P")
1535 (setq pascal-outline-mode
1536 (if (null arg) (not pascal-outline-mode) t))
1537 (if (fboundp 'redraw-mode-line)
1538 (redraw-mode-line))
1539 (if pascal-outline-mode
1540 (progn
1541 (setq selective-display t)
1542 (use-local-map pascal-outline-map))
1543 (progn
1544 (setq selective-display nil)
1545 (pascal-show-all)
1546 (use-local-map pascal-mode-map))))
1547
1548 (defun pascal-outline-change (b e pascal-flag)
1549 (let ((modp (buffer-modified-p)))
1550 (unwind-protect
1551 (subst-char-in-region b e (if (= pascal-flag ?\n)
1552 ?\^M ?\n) pascal-flag)
1553 (set-buffer-modified-p modp))))
1554
1555 (defun pascal-show-all ()
1556 "Show all of the text in the buffer."
1557 (interactive)
1558 (pascal-outline-change (point-min) (point-max) ?\n))
1559
1560 (defun pascal-hide-other-defuns ()
1561 "Show only the current defun."
1562 (interactive)
1563 (save-excursion
1564 (let ((beg (progn (if (not (looking-at "\\(function\\|procedure\\)\\>"))
1565 (pascal-beg-of-defun))
1566 (point)))
1567 (end (progn (pascal-end-of-defun)
1568 (backward-sexp 1)
1569 (search-forward "\n\\|\^M" nil t)
1570 (point)))
1571 (opoint (point-min)))
1572 (goto-char (point-min))
1573
1574 ;; Hide all functions before current function
1575 (while (re-search-forward "^\\(function\\|procedure\\)\\>" beg 'move)
1576 (pascal-outline-change opoint (1- (match-beginning 0)) ?\^M)
1577 (setq opoint (point))
1578 ;; Functions may be nested
1579 (if (> (progn (pascal-end-of-defun) (point)) beg)
1580 (goto-char opoint)))
1581 (if (> beg opoint)
1582 (pascal-outline-change opoint (1- beg) ?\^M))
1583
1584 ;; Show current function
1585 (pascal-outline-change beg end ?\n)
1586 ;; Hide nested functions
1587 (forward-char 1)
1588 (while (re-search-forward "^\\(function\\|procedure\\)\\>" end 'move)
1589 (setq opoint (point))
1590 (pascal-end-of-defun)
1591 (pascal-outline-change opoint (point) ?\^M))
1592
1593 (goto-char end)
1594 (setq opoint end)
1595
1596 ;; Hide all function after current function
1597 (while (re-search-forward "^\\(function\\|procedure\\)\\>" nil 'move)
1598 (pascal-outline-change opoint (1- (match-beginning 0)) ?\^M)
1599 (setq opoint (point))
1600 (pascal-end-of-defun))
1601 (pascal-outline-change opoint (point-max) ?\^M)
1602
1603 ;; Hide main program
1604 (if (< (progn (forward-line -1) (point)) end)
1605 (progn
1606 (goto-char beg)
1607 (pascal-end-of-defun)
1608 (backward-sexp 1)
1609 (pascal-outline-change (point) (point-max) ?\^M))))))
1610
1611 (defun pascal-outline-next-defun ()
1612 "Move to next function/procedure, hiding all others."
1613 (interactive)
1614 (pascal-end-of-defun)
1615 (pascal-hide-other-defuns))
1616
1617 (defun pascal-outline-prev-defun ()
1618 "Move to previous function/procedure, hiding all others."
1619 (interactive)
1620 (pascal-beg-of-defun)
1621 (pascal-hide-other-defuns))
1622
1623 (defun pascal-outline-goto-defun ()
1624 "Move to specified function/procedure, hiding all others."
1625 (interactive)
1626 (pascal-goto-defun)
1627 (pascal-hide-other-defuns))
1628
1629 (provide 'pascal)
1630
1631 ;;; arch-tag: 04535136-fd93-40b4-a505-c9bebdc051f5
1632 ;;; pascal.el ends here