]> code.delx.au - gnu-emacs/blob - lisp/progmodes/fortran.el
(sh-font-lock-syntactic-keywords): \ doesn't escape single quotes.
[gnu-emacs] / lisp / progmodes / fortran.el
1 ;;; fortran.el --- Fortran mode for GNU Emacs
2
3 ;; Copyright (C) 1986, 1993, 1994, 1995, 1997, 1998, 1999, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5
6 ;; Author: Michael D. Prange <prange@erl.mit.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
8 ;; Keywords: fortran, languages
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26
27 ;;; Commentary:
28
29 ;; This mode is documented in the Emacs manual.
30 ;;
31 ;; Note that it is for editing Fortran77 or Fortran90 fixed source
32 ;; form. For editing Fortran 90 free format source, use `f90-mode'
33 ;; (f90.el). It is meant to support the GNU Fortran language
34 ;; implemented by g77 (its extensions to Fortran77 and
35 ;; interpretations, e.g. of blackslash in strings).
36
37 ;;; History:
38
39 ;; Fortran mode was upgraded by Stephen A. Wood (saw@cebaf.gov).
40
41 ;; We acknowledge many contributions and valuable suggestions by
42 ;; Lawrence R. Dodd, Ralf Fassel, Ralph Finch, Stephen Gildea,
43 ;; Dr. Anil Gokhale, Ulrich Mueller, Mark Neale, Eric Prestemon,
44 ;; Gary Sabot and Richard Stallman.
45
46 ;;; Code:
47
48 ;; Todo:
49
50 ;; * Tidy it all up (more)!
51 ;; * Implement insertion and removal of statement continuations in
52 ;; mixed f77/f90 style, with the first `&' past column 72 and the
53 ;; second in column 6.
54 ;; * Support any other extensions to f77 grokked by GNU Fortran I've missed.
55
56 (eval-when-compile ; silence compiler
57 (defvar dabbrev-case-fold-search)
58 (defvar font-lock-syntactic-keywords)
59 (defvar gud-find-expr-function)
60 (defvar imenu-case-fold-search)
61 (defvar imenu-syntax-alist))
62
63
64 (defgroup fortran nil
65 "Major mode for editing fixed format Fortran code."
66 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
67 :link '(custom-manual "(emacs)Fortran")
68 :group 'languages)
69
70 (defgroup fortran-indent nil
71 "Indentation variables in Fortran mode."
72 :prefix "fortran-"
73 :group 'fortran)
74
75 (defgroup fortran-comment nil
76 "Comment-handling variables in Fortran mode."
77 :prefix "fortran-"
78 :group 'fortran)
79
80
81 ;;;###autoload
82 (defcustom fortran-tab-mode-default nil
83 "*Default tabbing/carriage control style for empty files in Fortran mode.
84 A non-nil value specifies tab-digit style of continuation control.
85 A value of nil specifies that continuation lines are marked
86 with a character in column 6."
87 :type 'boolean
88 :group 'fortran-indent)
89
90 (defcustom fortran-tab-mode-string "/t"
91 "*String to appear in mode line in TAB format buffers."
92 :type 'string
93 :group 'fortran-indent)
94
95 (defcustom fortran-do-indent 3
96 "*Extra indentation applied to DO blocks."
97 :type 'integer
98 :group 'fortran-indent)
99
100 (defcustom fortran-if-indent 3
101 "*Extra indentation applied to IF, SELECT CASE and WHERE blocks."
102 :type 'integer
103 :group 'fortran-indent)
104
105 (defcustom fortran-structure-indent 3
106 "*Extra indentation applied to STRUCTURE, UNION, MAP and INTERFACE blocks."
107 :type 'integer
108 :group 'fortran-indent)
109
110 (defcustom fortran-continuation-indent 5
111 "*Extra indentation applied to continuation lines."
112 :type 'integer
113 :group 'fortran-indent)
114
115 (defcustom fortran-comment-indent-style 'fixed
116 "*How to indent comments.
117 nil forces comment lines not to be touched;
118 `fixed' indents to `fortran-comment-line-extra-indent' columns beyond
119 `fortran-minimum-statement-indent-fixed' (if `indent-tabs-mode' nil), or
120 `fortran-minimum-statement-indent-tab' (if `indent-tabs-mode' non-nil);
121 `relative' indents to current Fortran indentation plus
122 `fortran-comment-line-extra-indent'."
123 :type '(radio (const :tag "Untouched" nil) (const fixed) (const relative))
124 :group 'fortran-indent)
125
126 (defcustom fortran-comment-line-extra-indent 0
127 "*Amount of extra indentation for text within full-line comments."
128 :type 'integer
129 :group 'fortran-indent
130 :group 'fortran-comment)
131
132 (defcustom fortran-comment-line-start "C"
133 "*Delimiter inserted to start new full-line comment.
134 You might want to change this to \"*\", for instance."
135 :version "21.1"
136 :type 'string
137 :group 'fortran-comment)
138
139 ;; This used to match preprocessor lines too, but that messes up
140 ;; filling and doesn't seem to be necessary.
141 (defcustom fortran-comment-line-start-skip
142 "^[CcDd*!]\\(\\([^ \t\n]\\)\\2+\\)?[ \t]*"
143 "*Regexp to match the start of a full-line comment."
144 :version "21.1"
145 :type 'regexp
146 :group 'fortran-comment)
147
148 (defcustom fortran-directive-re
149 "^[ \t]*#.*"
150 "*Regexp to match a directive line.
151 The matching text will be fontified with `font-lock-keyword-face'.
152 The matching line will be given zero indentation."
153 :version "22.1"
154 :type 'regexp
155 :group 'fortran-indent)
156
157 (defcustom fortran-minimum-statement-indent-fixed 6
158 "*Minimum statement indentation for fixed format continuation style."
159 :type 'integer
160 :group 'fortran-indent)
161
162 (defcustom fortran-minimum-statement-indent-tab (max tab-width 6)
163 "*Minimum statement indentation for TAB format continuation style."
164 :type 'integer
165 :group 'fortran-indent)
166
167 ;; Note that this is documented in the v18 manuals as being a string
168 ;; of length one rather than a single character.
169 ;; The code in this file accepts either format for compatibility.
170 (defcustom fortran-comment-indent-char " "
171 "*Single-character string inserted for Fortran comment indentation.
172 Normally a space."
173 :type 'string
174 :group 'fortran-comment)
175
176 (defcustom fortran-line-number-indent 1
177 "*Maximum indentation for Fortran line numbers.
178 5 means right-justify them within their five-column field."
179 :type 'integer
180 :group 'fortran-indent)
181
182 (defcustom fortran-check-all-num-for-matching-do nil
183 "*Non-nil causes all numbered lines to be treated as possible DO loop ends."
184 :type 'boolean
185 :group 'fortran)
186
187 (defcustom fortran-blink-matching-if nil
188 "*Non-nil causes \\[fortran-indent-line] on ENDIF to blink on matching IF.
189 Also, from an ENDDO statement blink on matching DO [WHILE] statement."
190 :type 'boolean
191 :group 'fortran)
192
193 (defcustom fortran-continuation-string "$"
194 "*Single-character string used for Fortran continuation lines.
195 In fixed format continuation style, this character is inserted in
196 column 6 by \\[fortran-split-line] to begin a continuation line.
197 Also, if \\[fortran-indent-line] finds this at the beginning of a
198 line, it will convert the line into a continuation line of the
199 appropriate style. Normally $."
200 :type 'string
201 :group 'fortran)
202
203 (defcustom fortran-comment-region "c$$$"
204 "*String inserted by \\[fortran-comment-region] at start of each \
205 line in region."
206 :type 'string
207 :group 'fortran-comment)
208
209 (defcustom fortran-electric-line-number t
210 "*Non-nil causes line numbers to be moved to the correct column as typed."
211 :type 'boolean
212 :group 'fortran)
213
214 (defcustom fortran-column-ruler-fixed
215 "0 4 6 10 20 30 40 5\
216 0 60 70\n\
217 \[ ]|{ | | | | | | | | \
218 \| | | | |}\n"
219 "String displayed above current line by \\[fortran-column-ruler].
220 This variable is used in fixed format mode.
221 See the variable `fortran-column-ruler-tab' for TAB format mode."
222 :type 'string
223 :group 'fortran)
224
225 (defcustom fortran-column-ruler-tab
226 "0 810 20 30 40 5\
227 0 60 70\n\
228 \[ ]| { | | | | | | | | \
229 \| | | | |}\n"
230 "String displayed above current line by \\[fortran-column-ruler].
231 This variable is used in TAB format mode.
232 See the variable `fortran-column-ruler-fixed' for fixed format mode."
233 :type 'string
234 :group 'fortran)
235
236 (defcustom fortran-analyze-depth 100
237 "Number of lines to scan to identify fixed or TAB format style."
238 :type 'integer
239 :group 'fortran)
240
241 (defcustom fortran-break-before-delimiters t
242 "*Non-nil causes filling to break lines before delimiters.
243 Delimiters are characters matching the regexp `fortran-break-delimiters-re'."
244 :type 'boolean
245 :group 'fortran)
246
247 (defconst fortran-break-delimiters-re "[-+*/><=, \t]"
248 "Regexp matching delimiter characters at which lines may be broken.
249 There are certain tokens comprised entirely of characters
250 matching this regexp that should not be split, and these are
251 specified by the constant `fortran-no-break-re'.")
252
253 ;; The ">=", etc F77 extensions are supported by g77.
254 (defconst fortran-no-break-re
255 (regexp-opt '("**" "//" "=>" ">=" "<=" "==" "/=") 'paren)
256 "Regexp specifying where not to break lines when filling.
257 This regexp matches certain tokens comprised entirely of
258 characters matching the regexp `fortran-break-delimiters-re' that should
259 not be split by filling. Each element is assumed to be two
260 characters long.")
261
262 (defcustom fortran-mode-hook nil
263 "Hook run when entering Fortran mode."
264 :type 'hook
265 :group 'fortran)
266
267 \f
268 (defvar fortran-if-start-re "\\(\\(\\sw\\|\\s_\\)+:[ \t]*\\)?if[ \t]*("
269 "Regexp matching the start of an IF statement.")
270
271 (defvar fortran-end-prog-re1
272 "end\
273 \\([ \t]*\\(program\\|subroutine\\|function\\|block[ \t]*data\\)\\>\
274 \\([ \t]*\\(\\sw\\|\\s_\\)+\\)?\\)?"
275 "Regexp possibly matching the end of a subprogram.")
276
277 (defvar fortran-end-prog-re
278 (concat "^[ \t0-9]*" fortran-end-prog-re1)
279 "Regexp possibly matching the end of a subprogram, from the line start.
280 See also `fortran-end-prog-re1'.")
281
282 (defconst fortran-type-types
283 (concat "\\<"
284 (mapconcat 'identity ; " " -> "[ \t]*"
285 (split-string
286 (regexp-opt
287 (let ((simple-types
288 '("character" "byte" "integer" "logical"
289 "none" "real" "complex"
290 "double precision" "double complex"))
291 (structured-types '("structure" "union" "map"))
292 (other-types '("record" "dimension"
293 "parameter" "common" "save"
294 "external" "intrinsic" "data"
295 "equivalence")))
296 (append
297 (mapcar (lambda (x) (concat "implicit " x))
298 simple-types)
299 simple-types
300 (mapcar (lambda (x) (concat "end " x))
301 structured-types)
302 structured-types
303 other-types)) 'paren))
304 "[ \t]*") "\\>")
305 "Regexp matching Fortran types.")
306
307 (defvar fortran-font-lock-keywords-1
308 ;; Program, subroutine and function declarations, plus calls.
309 '(("\\<\\(block[ \t]*data\\|call\\|entry\\|function\\|\
310 program\\|subroutine\\)\\>[ \t]*\\(\\sw+\\)?"
311 (1 font-lock-keyword-face)
312 (2 font-lock-function-name-face nil t)))
313 "Subdued level highlighting for Fortran mode.")
314
315 (defvar fortran-font-lock-keywords-2
316 (append fortran-font-lock-keywords-1
317 (list
318 ;; Fontify all type specifiers (must be first - see below).
319 (cons fortran-type-types 'font-lock-type-face)
320 ;; Builtin keywords (except logical, do and goto - see below).
321 (concat "\\<" (regexp-opt
322 '("continue" "format" "end" "enddo"
323 "if" "then" "else" "endif" "elseif"
324 "while" "inquire" "stop" "return"
325 "include" "open" "close" "read"
326 "write" "format" "print" "select" "case"
327 "cycle" "exit" "rewind" "backspace"
328 "where" "elsewhere")
329 'paren) "\\>")
330 ;; Builtin operators.
331 (concat "\\." (regexp-opt
332 '("and" "or" "not" "lt" "le" "eq" "ge"
333 "gt" "ne" "true" "false")
334 'paren) "\\.")
335 ;; do/goto keywords and targets, and goto tags.
336 '("\\<\\(do\\|go *to\\)\\>[ \t]*\\([0-9]+\\)?"
337 (1 font-lock-keyword-face)
338 (2 font-lock-constant-face nil t))
339 '("^ *\\([0-9]+\\)" . font-lock-constant-face)))
340 "Medium level highlighting for Fortran mode.")
341
342 (defvar fortran-font-lock-keywords-3
343 (append
344 fortran-font-lock-keywords-1
345 ;; All type specifiers plus their declared items.
346 (list
347 (list (concat fortran-type-types "[ \t(/]*\\(*\\)?")
348 ;; Type specifier.
349 '(1 font-lock-type-face)
350 ;; Declaration item (or just /.../ block name).
351 `(font-lock-match-c-style-declaration-item-and-skip-to-next
352 ;; Start after any *(...) expression.
353 (condition-case nil
354 (and (match-beginning ,(1+ (regexp-opt-depth
355 fortran-type-types)))
356 (forward-sexp)
357 (forward-sexp))
358 (error nil))
359 ;; No need to clean up.
360 nil
361 ;; Fontify as a variable name, functions fontified elsewhere.
362 (1 font-lock-variable-name-face nil t))))
363 ;; Things extra to `fortran-font-lock-keywords-3' (must be done first).
364 (list
365 ;; Goto-like `err=label'/`end=label' in read/write statements.
366 '(", *\\(e\\(nd\\|rr\\)\\)\\> *\\(= *\\([0-9]+\\)\\)?"
367 (1 font-lock-keyword-face) (4 font-lock-constant-face nil t))
368 ;; Standard continuation character and in a TAB-formatted line.
369 '("^ \\{5\\}\\([^ 0\n]\\)" 1 font-lock-string-face)
370 '("^\t\\([1-9]\\)" 1 font-lock-string-face))
371 `((,fortran-directive-re (0 font-lock-keyword-face t)))
372 ;; `fortran-font-lock-keywords-2' without types (see above).
373 (cdr (nthcdr (length fortran-font-lock-keywords-1)
374 fortran-font-lock-keywords-2)))
375 "Gaudy level highlighting for Fortran mode.")
376
377 (defvar fortran-font-lock-keywords-4
378 (append fortran-font-lock-keywords-3
379 (list (list
380 (concat "\\<"
381 (regexp-opt
382 '("int" "ifix" "idint" "real" "float" "sngl"
383 "dble" "cmplx" "ichar" "char" "aint" "dint"
384 "anint" "dnint" "nint" "idnint" "iabs" "abs"
385 "dabs" "cabs" "mod" "amod" "dmod" "isign"
386 "sign" "dsign" "idim" "dim" "ddim" "dprod"
387 "max" "max0" "amax1" "dmax1" "amax0" "max1"
388 "min0" "amin1" "dmin1" "amin0" "min1" "len"
389 "index" "lge" "lgt" "lle" "llt" "aimag"
390 "conjg" "sqrt" "dsqrt" "csqrt" "exp" "dexp"
391 "cexp" "log" "alog" "dlog" "clog" "log10"
392 "alog10" "dlog10" "sin" "dsin" "csin" "cos"
393 "dcos" "ccos" "tan" "dtan" "asin" "dasin"
394 "acos" "dacos" "atan" "datan" "atan2" "datan2"
395 "sinh" "dsinh" "cosh" "dcosh" "tanh" "dtanh")
396 'paren) "[ \t]*(") '(1 font-lock-builtin-face))))
397 "Maximum highlighting for Fortran mode.
398 Consists of level 3 plus all other intrinsics not already highlighted.")
399
400 ;; Comments are real pain in Fortran because there is no way to
401 ;; represent the standard comment syntax in an Emacs syntax table.
402 ;; (We can do so for F90-style). Therefore an unmatched quote in a
403 ;; standard comment will throw fontification off on the wrong track.
404 ;; So we do syntactic fontification with regexps.
405 (defvar fortran-font-lock-syntactic-keywords
406 '(("^[cd\\*]" 0 (11))
407 ("^[^cd\\*\t\n].\\{71\\}\\([^\n]+\\)" 1 (11)))
408 "`font-lock-syntactic-keywords' for Fortran.
409 These get fixed-format comments fontified.")
410
411 (defvar fortran-font-lock-keywords fortran-font-lock-keywords-1
412 "Default expressions to highlight in Fortran mode.")
413
414 (defvar fortran-imenu-generic-expression
415 ;; These patterns could be confused by sequence nos. in cols 72+ and
416 ;; don't allow continuations everywhere.
417 (list
418 (list
419 nil
420 ;; [This will be fooled by `end function' allowed by G77. Also,
421 ;; it assumes sensible whitespace is employed.]
422 (concat
423 ;; leading whitespace:
424 "^\\s-+\\("
425 ;; function declaration with optional type, e.g. `real',
426 ;; `real*4', character(*), `double precision':
427 "\\(\\sw\\|\\s-\\|[*()+]\\)*"
428 "\\<function\\|subroutine\\|entry\\|block\\s-*data\\|program\\)"
429 ;; Possible statement continuation:
430 "[ \t" fortran-continuation-string "]+"
431 ;; Variable to index:
432 "\\(\\sw+\\)")
433 3)
434 ;; Un-named block data.
435 '(nil "^\\s-+\\(block\\s-*data\\)\\s-*$" 1))
436 "Value for `imenu-generic-expression' in Fortran mode.")
437
438 \f
439 ;; Hideshow support.
440 (defconst fortran-blocks-re
441 (concat "block[ \t]*data\\|select[ \t]*case\\|"
442 (regexp-opt '("do" "if" "interface" "function" "map" "program"
443 "structure" "subroutine" "union" "where")))
444 "Regexp potentially indicating the start or end of a Fortran \"block\".
445 Omits naked END statements, and DO-loops closed by anything other
446 than ENDDO.")
447
448 (defconst fortran-end-block-re
449 ;; Do-loops terminated by things other than ENDDO cannot be handled
450 ;; with a regexp. This omission does not seem to matter to hideshow...
451 (concat "^[ \t0-9]*\\<end[ \t]*\\("
452 fortran-blocks-re
453 ;; Naked END statement.
454 "\\|!\\|$\\)")
455 "Regexp matching the end of a Fortran \"block\", from the line start.
456 Note that only ENDDO is handled for the end of a DO-loop. Used
457 in the Fortran entry in `hs-special-modes-alist'.")
458
459 (defconst fortran-start-block-re
460 (concat
461 "^[ \t0-9]*\\(" ; statement number
462 ;; Structure label for DO, IF, SELECT, WHERE.
463 "\\(\\(\\sw+[ \t]*:[ \t]*\\)?"
464 ;; IF blocks are a nuisance:
465 ;; IF ( ... ) foo is not a block, but a single statement.
466 ;; IF ( ... ) THEN can be split over multiple lines.
467 ;; [So can, eg, a DO WHILE (... ), but that is less common, I hope.]
468 ;; The regexp below allows for it to be split over at most 2 lines.
469 ;; That leads to the problem of not matching two consecutive IF
470 ;; statements as one, eg:
471 ;; IF ( ... ) foo
472 ;; IF ( ... ) THEN
473 ;; It simply is not possible to do this in a 100% correct fashion
474 ;; using a regexp - see the functions fortran-end-if,
475 ;; fortran-beginning-if for the hoops we have to go through.
476 ;; An alternative is to match on THEN at a line end, eg:
477 ;; ".*)[ \t]*then[ \t]*\\($\\|!\\)"
478 ;; This would also match ELSE branches, though. This does not seem
479 ;; right to me, because then one has neighbouring blocks that are
480 ;; not nested in each other.
481 "\\(if[ \t]*(\\(.*\\|"
482 ".*\n\\([^if]*\\([^i].\\|.[^f]\\|.\\>\\)\\)\\)\\<then\\|"
483 "do\\|select[ \t]*case\\|where\\)\\)\\|"
484 (regexp-opt '("interface" "function" "map" "program"
485 "structure" "subroutine" "union"))
486 "\\|block[ \t]*data\\)[ \t]*")
487 "Regexp matching the start of a Fortran \"block\", from the line start.
488 A simple regexp cannot do this in fully correct fashion, so this
489 tries to strike a compromise between complexity and flexibility.
490 Used in the Fortran entry in `hs-special-modes-alist'.")
491
492 (add-to-list 'hs-special-modes-alist
493 `(fortran-mode ,fortran-start-block-re ,fortran-end-block-re
494 "^[cC*!]" fortran-end-of-block nil))
495
496 \f
497 (defvar fortran-mode-syntax-table
498 (let ((table (make-syntax-table)))
499 ;; We might like `;' to be punctuation (g77 multi-statement
500 ;; lines), but that screws abbrevs.
501 (modify-syntax-entry ?\; "w" table)
502 (modify-syntax-entry ?\r " " table)
503 (modify-syntax-entry ?+ "." table)
504 (modify-syntax-entry ?- "." table)
505 (modify-syntax-entry ?= "." table)
506 (modify-syntax-entry ?* "." table)
507 (modify-syntax-entry ?/ "." table)
508 (modify-syntax-entry ?\' "\"" table)
509 (modify-syntax-entry ?\" "\"" table)
510 ;; Consistent with GNU Fortran's default -- see the manual.
511 ;; The F77 standard imposes no rule on this issue.
512 (modify-syntax-entry ?\\ "\\" table)
513 ;; This might be better as punctuation, as for C, but this way you
514 ;; can treat floating-point numbers as symbols.
515 (modify-syntax-entry ?. "_" table) ; e.g. `a.ne.b'
516 (modify-syntax-entry ?_ "_" table)
517 (modify-syntax-entry ?$ "_" table) ; esp. VMSisms
518 (modify-syntax-entry ?\! "<" table)
519 (modify-syntax-entry ?\n ">" table)
520 table)
521 "Syntax table used in Fortran mode.")
522
523 (defvar fortran-gud-syntax-table
524 (let ((st (make-syntax-table fortran-mode-syntax-table)))
525 (modify-syntax-entry ?\n "." st)
526 st)
527 "Syntax table used to parse Fortran expressions for printing in GUD.")
528
529 (defvar fortran-mode-map
530 (let ((map (make-sparse-keymap)))
531 (define-key map ";" 'fortran-abbrev-start)
532 (define-key map "\C-c;" 'fortran-comment-region)
533 (define-key map "\M-;" 'fortran-indent-comment)
534 (define-key map "\M-\n" 'fortran-split-line)
535 (define-key map "\M-\C-n" 'fortran-end-of-block)
536 (define-key map "\M-\C-p" 'fortran-beginning-of-block)
537 (define-key map "\M-\C-q" 'fortran-indent-subprogram)
538 (define-key map "\C-c\C-w" 'fortran-window-create-momentarily)
539 (define-key map "\C-c\C-r" 'fortran-column-ruler)
540 (define-key map "\C-c\C-p" 'fortran-previous-statement)
541 (define-key map "\C-c\C-n" 'fortran-next-statement)
542 (define-key map "\C-c\C-d" 'fortran-join-line) ; like f90
543 (define-key map "\M-^" 'fortran-join-line) ; subvert delete-indentation
544 (define-key map "0" 'fortran-electric-line-number)
545 (define-key map "1" 'fortran-electric-line-number)
546 (define-key map "2" 'fortran-electric-line-number)
547 (define-key map "3" 'fortran-electric-line-number)
548 (define-key map "4" 'fortran-electric-line-number)
549 (define-key map "5" 'fortran-electric-line-number)
550 (define-key map "6" 'fortran-electric-line-number)
551 (define-key map "7" 'fortran-electric-line-number)
552 (define-key map "8" 'fortran-electric-line-number)
553 (define-key map "9" 'fortran-electric-line-number)
554
555 (easy-menu-define fortran-menu map "Menu for Fortran mode."
556 `("Fortran"
557 ["Manual" (info "(emacs)Fortran")]
558 ("Customization"
559 ,(custom-menu-create 'fortran)
560 ["Set" Custom-set t]
561 ["Save" Custom-save t]
562 ["Reset to Current" Custom-reset-current t]
563 ["Reset to Saved" Custom-reset-saved t]
564 ["Reset to Standard Settings" Custom-reset-standard t]
565 )
566 "--"
567 ["Comment Region" fortran-comment-region mark-active]
568 ["Uncomment Region"
569 (fortran-comment-region (region-beginning) (region-end) 1)
570 mark-active]
571 ["Indent Region" indent-region mark-active]
572 ["Indent Subprogram" fortran-indent-subprogram t]
573 "--"
574 ["Beginning of Subprogram" fortran-beginning-of-subprogram t]
575 ["End of Subprogram" fortran-end-of-subprogram t]
576 ("Mark"
577 ["Subprogram" mark-defun t]
578 ["IF Block" fortran-mark-if t]
579 ["DO Block" fortran-mark-do t]
580 )
581 ["Narrow to Subprogram" narrow-to-defun t]
582 ["Widen" widen t]
583 "--"
584 ["Temporary column ruler" fortran-column-ruler t]
585 ["72-column window" fortran-window-create t]
586 ["Full Width Window"
587 (enlarge-window-horizontally (- (frame-width) (window-width)))
588 (< (window-width) (frame-width))]
589 ["Momentary 72-column window" fortran-window-create-momentarily t]
590 "--"
591 ["Break Line at Point" fortran-split-line t]
592 ["Join Line" fortran-join-line t]
593 ["Fill Statement/Comment" fill-paragraph t]
594 "--"
595 ["Toggle auto-fill" auto-fill-mode :selected auto-fill-function
596 :style toggle]
597 ["Toggle abbrev-mode" abbrev-mode :selected abbrev-mode
598 :style toggle]
599 ["Add imenu Menu" imenu-add-menubar-index
600 :active (not (lookup-key (current-local-map) [menu-bar index]))
601 :included (fboundp 'imenu-add-to-menubar)]))
602 map)
603 "Keymap used in Fortran mode.")
604
605 \f
606 (defvar fortran-mode-abbrev-table
607 (let (abbrevs-changed)
608 (define-abbrev-table 'fortran-mode-abbrev-table nil)
609 ;; Use the 6th arg (SYSTEM-FLAG) of define-abbrev if possible.
610 ;; Only use `apply' to quieten the byte-compiler.
611 (mapcar
612 (function (lambda (element)
613 (condition-case nil
614 (apply 'define-abbrev fortran-mode-abbrev-table
615 (append element '(nil 0 t)))
616 (wrong-number-of-arguments
617 (apply 'define-abbrev fortran-mode-abbrev-table
618 (append element '(nil 0)))))))
619 '((";au" "automatic" )
620 (";b" "byte" )
621 (";bd" "block data" )
622 (";ch" "character" )
623 (";cl" "close" )
624 (";c" "continue" )
625 (";cm" "common" )
626 (";cx" "complex" )
627 (";df" "define" )
628 (";di" "dimension" )
629 (";do" "double" )
630 (";dc" "double complex" )
631 (";dp" "double precision" )
632 (";dw" "do while" )
633 (";e" "else" )
634 (";ed" "enddo" )
635 (";el" "elseif" )
636 (";en" "endif" )
637 (";eq" "equivalence" )
638 (";ew" "endwhere" )
639 (";ex" "external" )
640 (";ey" "entry" )
641 (";f" "format" )
642 (";fa" ".false." )
643 (";fu" "function" )
644 (";g" "goto" )
645 (";im" "implicit" )
646 (";ib" "implicit byte" )
647 (";ic" "implicit complex" )
648 (";ich" "implicit character")
649 (";ii" "implicit integer" )
650 (";il" "implicit logical" )
651 (";ir" "implicit real" )
652 (";inc" "include" )
653 (";in" "integer" )
654 (";intr" "intrinsic" )
655 (";l" "logical" )
656 (";n" "namelist" )
657 (";o" "open" ) ; was ;op
658 (";pa" "parameter" )
659 (";pr" "program" )
660 (";ps" "pause" )
661 (";p" "print" )
662 (";rc" "record" )
663 (";re" "real" )
664 (";r" "read" )
665 (";rt" "return" )
666 (";rw" "rewind" )
667 (";s" "stop" )
668 (";sa" "save" )
669 (";st" "structure" )
670 (";sc" "static" )
671 (";su" "subroutine" )
672 (";tr" ".true." )
673 (";ty" "type" )
674 (";vo" "volatile" )
675 (";w" "write" )
676 (";wh" "where" )))
677 fortran-mode-abbrev-table))
678
679 \f
680
681 ;;;###autoload
682 (defun fortran-mode ()
683 "Major mode for editing Fortran code in fixed format.
684 For free format code, use `f90-mode'.
685
686 \\[fortran-indent-line] indents the current Fortran line correctly.
687 Note that DO statements must not share a common CONTINUE.
688
689 Type ;? or ;\\[help-command] to display a list of built-in abbrevs for\
690 Fortran keywords.
691
692 Key definitions:
693 \\{fortran-mode-map}
694
695 Variables controlling indentation style and extra features:
696
697 `fortran-comment-line-start'
698 To use comments starting with `!', set this to the string \"!\".
699 `fortran-do-indent'
700 Extra indentation within DO blocks (default 3).
701 `fortran-if-indent'
702 Extra indentation within IF blocks (default 3).
703 `fortran-structure-indent'
704 Extra indentation within STRUCTURE, UNION, MAP and INTERFACE blocks.
705 (default 3)
706 `fortran-continuation-indent'
707 Extra indentation applied to continuation statements (default 5).
708 `fortran-comment-line-extra-indent'
709 Amount of extra indentation for text in full-line comments (default 0).
710 `fortran-comment-indent-style'
711 How to indent the text in full-line comments. Allowed values are:
712 nil don't change the indentation
713 fixed indent to `fortran-comment-line-extra-indent' beyond the
714 value of either
715 `fortran-minimum-statement-indent-fixed' (fixed format) or
716 `fortran-minimum-statement-indent-tab' (TAB format),
717 depending on the continuation format in use.
718 relative indent to `fortran-comment-line-extra-indent' beyond the
719 indentation for a line of code.
720 (default 'fixed)
721 `fortran-comment-indent-char'
722 Single-character string to be inserted instead of space for
723 full-line comment indentation (default \" \").
724 `fortran-minimum-statement-indent-fixed'
725 Minimum indentation for statements in fixed format mode (default 6).
726 `fortran-minimum-statement-indent-tab'
727 Minimum indentation for statements in TAB format mode (default 9).
728 `fortran-line-number-indent'
729 Maximum indentation for line numbers (default 1). A line number will
730 get less than this much indentation if necessary to avoid reaching
731 column 5.
732 `fortran-check-all-num-for-matching-do'
733 Non-nil causes all numbered lines to be treated as possible \"continue\"
734 statements (default nil).
735 `fortran-blink-matching-if'
736 Non-nil causes \\[fortran-indent-line] on an ENDIF (or ENDDO) statement
737 to blink on the matching IF (or DO [WHILE]). (default nil)
738 `fortran-continuation-string'
739 Single-character string to be inserted in column 5 of a continuation
740 line (default \"$\").
741 `fortran-comment-region'
742 String inserted by \\[fortran-comment-region] at start of each line in
743 the region (default \"c$$$\").
744 `fortran-electric-line-number'
745 Non-nil causes line number digits to be moved to the correct column
746 as typed (default t).
747 `fortran-break-before-delimiters'
748 Non-nil causes lines to be broken before delimiters (default t).
749
750 Turning on Fortran mode calls the value of the variable `fortran-mode-hook'
751 with no args, if that value is non-nil."
752 (interactive)
753 (kill-all-local-variables)
754 (setq major-mode 'fortran-mode
755 mode-name "Fortran"
756 local-abbrev-table fortran-mode-abbrev-table)
757 (set-syntax-table fortran-mode-syntax-table)
758 (use-local-map fortran-mode-map)
759 (set (make-local-variable 'indent-line-function) 'fortran-indent-line)
760 (set (make-local-variable 'indent-region-function)
761 (lambda (start end)
762 (let (fortran-blink-matching-if ; avoid blinking delay
763 indent-region-function)
764 (indent-region start end nil))))
765 (set (make-local-variable 'require-final-newline) mode-require-final-newline)
766 ;; The syntax tables don't understand the column-0 comment-markers.
767 (set (make-local-variable 'comment-use-syntax) nil)
768 (set (make-local-variable 'comment-padding) "$$$")
769 (set (make-local-variable 'comment-start) fortran-comment-line-start)
770 (set (make-local-variable 'comment-start-skip)
771 ;; We can't reuse `fortran-comment-line-start-skip' directly because
772 ;; it contains backrefs whereas we need submatch-1 to end at the
773 ;; beginning of the comment delimiter.
774 ;; (concat "\\(\\)\\(![ \t]*\\|" fortran-comment-line-start-skip "\\)")
775 "\\(\\)\\(?:^[CcDd*]\\|!\\)\\(?:\\([^ \t\n]\\)\\2+\\)?[ \t]*")
776 (set (make-local-variable 'comment-indent-function) 'fortran-comment-indent)
777 (set (make-local-variable 'abbrev-all-caps) t)
778 (set (make-local-variable 'normal-auto-fill-function) 'fortran-auto-fill)
779 (set (make-local-variable 'indent-tabs-mode) (fortran-analyze-file-format))
780 (setq mode-line-process '(indent-tabs-mode fortran-tab-mode-string))
781 (set (make-local-variable 'fill-column) 72)
782 (set (make-local-variable 'fill-paragraph-function) 'fortran-fill-paragraph)
783 (set (make-local-variable 'font-lock-defaults)
784 '((fortran-font-lock-keywords
785 fortran-font-lock-keywords-1
786 fortran-font-lock-keywords-2
787 fortran-font-lock-keywords-3
788 fortran-font-lock-keywords-4)
789 nil t ((?/ . "$/") ("_$" . "w"))
790 fortran-beginning-of-subprogram))
791 (set (make-local-variable 'font-lock-syntactic-keywords)
792 fortran-font-lock-syntactic-keywords)
793 (set (make-local-variable 'imenu-case-fold-search) t)
794 (set (make-local-variable 'imenu-generic-expression)
795 fortran-imenu-generic-expression)
796 (set (make-local-variable 'imenu-syntax-alist) '(("_$" . "w")))
797 (set (make-local-variable 'beginning-of-defun-function)
798 #'fortran-beginning-of-subprogram)
799 (set (make-local-variable 'end-of-defun-function)
800 #'fortran-end-of-subprogram)
801 (set (make-local-variable 'add-log-current-defun-function)
802 #'fortran-current-defun)
803 (set (make-local-variable 'dabbrev-case-fold-search) 'case-fold-search)
804 (set (make-local-variable 'gud-find-expr-function) 'fortran-gud-find-expr)
805 (run-mode-hooks 'fortran-mode-hook))
806
807 \f
808 (defun fortran-gud-find-expr ()
809 ;; Consider \n as punctuation (end of expression).
810 (with-syntax-table fortran-gud-syntax-table
811 (gud-find-c-expr)))
812
813 (defsubst fortran-comment-indent ()
814 "Return the indentation appropriate for the current comment line.
815 This is 0 for a line matching `fortran-comment-line-start-skip', else
816 the value of `comment-column' (leaving at least one space after code)."
817 (if (looking-at fortran-comment-line-start-skip) 0
818 (save-excursion
819 (skip-chars-backward " \t")
820 (max (1+ (current-column)) comment-column))))
821
822 (defun fortran-indent-comment ()
823 "Align or create comment on current line.
824 Existing comments of all types are recognized and aligned.
825 If the line has no comment, a side-by-side comment is inserted and aligned,
826 if the value of `comment-start' is not nil and allows such comments.
827 Otherwise, a separate-line comment is inserted, on this line
828 or on a new line inserted before this line if this line is not blank."
829 (interactive "*")
830 (beginning-of-line)
831 ;; Recognize existing comments of either kind.
832 (cond ((fortran-find-comment-start-skip 'all)
833 (goto-char (match-beginning 0))
834 (if (bolp)
835 (fortran-indent-line)
836 (unless (= (current-column) (fortran-comment-indent))
837 (delete-horizontal-space)
838 (indent-to (fortran-comment-indent)))))
839 ;; No existing comment.
840 ;; If side-by-side comments are defined, insert one,
841 ;; unless line is now blank.
842 ((and comment-start (not (looking-at "[ \t]*$"))
843 (string-match comment-start-skip (concat " " comment-start)))
844 (end-of-line)
845 (delete-horizontal-space)
846 (indent-to (fortran-comment-indent))
847 (insert comment-start))
848 ;; Else insert separate-line comment, making a new line if nec.
849 (t
850 (if (looking-at "^[ \t]*$")
851 (delete-horizontal-space)
852 (beginning-of-line)
853 (insert ?\n)
854 (forward-char -1))
855 (insert fortran-comment-line-start)
856 (insert-char (if (stringp fortran-comment-indent-char)
857 (aref fortran-comment-indent-char 0)
858 fortran-comment-indent-char)
859 (- (fortran-calculate-indent) (current-column))))))
860
861 (defun fortran-comment-region (beg-region end-region arg)
862 "Comment every line in the region.
863 Inserts the string variable `fortran-comment-region' at the beginning of
864 every line in the region.
865 BEG-REGION and END-REGION specify the region boundaries.
866 With non-nil ARG, uncomments the region."
867 (interactive "*r\nP")
868 (let ((end-region-mark (copy-marker end-region))
869 (save-point (point-marker)))
870 (goto-char beg-region)
871 (beginning-of-line)
872 (if arg
873 (let ((com (regexp-quote fortran-comment-region))) ; uncomment
874 (if (looking-at com)
875 (delete-region (point) (match-end 0)))
876 (while (and (zerop (forward-line 1))
877 (< (point) end-region-mark))
878 (if (looking-at com)
879 (delete-region (point) (match-end 0)))))
880 (insert fortran-comment-region) ; comment
881 (while (and (zerop (forward-line 1))
882 (< (point) end-region-mark))
883 (insert fortran-comment-region)))
884 (goto-char save-point)
885 (set-marker end-region-mark nil)
886 (set-marker save-point nil)))
887
888 \f
889 (defun fortran-abbrev-start ()
890 "Typing ;\\[help-command] or ;? lists all the Fortran abbrevs.
891 Any other key combination is executed normally."
892 (interactive "*")
893 (insert last-command-char)
894 (let (char event)
895 (if (fboundp 'next-command-event) ; XEmacs
896 (setq event (next-command-event)
897 char (event-to-character event))
898 (setq event (read-event)
899 char event))
900 ;; Insert char if not equal to `?', or if abbrev-mode is off.
901 (if (and abbrev-mode (or (eq char ??) (eq char help-char)))
902 (fortran-abbrev-help)
903 (setq unread-command-events (list event)))))
904
905 (defun fortran-abbrev-help ()
906 "List the currently defined abbrevs in Fortran mode."
907 (interactive)
908 (message "Listing abbrev table...")
909 (display-buffer (fortran-prepare-abbrev-list-buffer))
910 (message "Listing abbrev table...done"))
911
912 (defun fortran-prepare-abbrev-list-buffer ()
913 "Create a buffer listing the Fortran mode abbreviations."
914 (save-excursion
915 (set-buffer (get-buffer-create "*Abbrevs*"))
916 (erase-buffer)
917 (insert-abbrev-table-description 'fortran-mode-abbrev-table t)
918 (goto-char (point-min))
919 (set-buffer-modified-p nil)
920 (edit-abbrevs-mode))
921 (get-buffer-create "*Abbrevs*"))
922
923 (defun fortran-column-ruler ()
924 "Insert a column ruler momentarily above current line, till next keystroke.
925 The ruler is defined by the value of `fortran-column-ruler-fixed' in fixed
926 format mode, and `fortran-column-ruler-tab' in TAB format mode.
927 The next key typed is executed unless it is SPC."
928 (interactive)
929 (momentary-string-display
930 (if indent-tabs-mode
931 fortran-column-ruler-tab
932 fortran-column-ruler-fixed)
933 (save-excursion
934 (beginning-of-line)
935 (if (eq (window-start (selected-window))
936 (window-point (selected-window)))
937 (line-beginning-position 2)
938 (point)))
939 nil "Type SPC or any command to erase ruler."))
940
941 (defun fortran-window-create ()
942 "Make the window 72 columns wide.
943 See also `fortran-window-create-momentarily'."
944 (interactive)
945 (let ((window-min-width 2))
946 (if (< (window-width) (frame-width))
947 (enlarge-window-horizontally (- (frame-width)
948 (window-width) 1)))
949 (let* ((window-edges (window-edges))
950 (scroll-bar-width (- (nth 2 window-edges)
951 (car window-edges)
952 (window-width))))
953 (split-window-horizontally (+ 72 scroll-bar-width)))
954 (other-window 1)
955 (switch-to-buffer " fortran-window-extra" t)
956 (select-window (previous-window))))
957
958 (defun fortran-window-create-momentarily (&optional arg)
959 "Momentarily make the window 72 columns wide.
960 Optional ARG non-nil and non-unity disables the momentary feature.
961 See also `fortran-window-create'."
962 (interactive "p")
963 (if (or (not arg)
964 (= arg 1))
965 (save-window-excursion
966 (progn
967 (condition-case nil
968 (fortran-window-create)
969 (error (error "No room for Fortran window")))
970 (message "Type SPC to continue editing.")
971 (let ((char (read-event)))
972 (or (equal char (string-to-char " "))
973 (setq unread-command-events (list char))))))
974 (fortran-window-create)))
975
976 (defun fortran-split-line ()
977 "Break line at point and insert continuation marker and alignment."
978 (interactive "*")
979 (delete-horizontal-space)
980 (if (save-excursion
981 (let ((pos (point)))
982 (beginning-of-line)
983 (and (fortran-find-comment-start-skip 'all)
984 (< (match-beginning 0) pos))))
985 (insert ?\n (match-string 0))
986 (if indent-tabs-mode
987 (insert ?\n ?\t (fortran-numerical-continuation-char))
988 (insert "\n " fortran-continuation-string))) ; space after \n important
989 (fortran-indent-line)) ; when cont string is C, c or *
990
991 (defun fortran-remove-continuation ()
992 "Delete any Fortran continuation characters at point.
993 Returns t if anything actually deleted."
994 (when (looking-at "\\( \\{5\\}[^ 0\n]\\|\t[1-9]\\|&\\)")
995 (replace-match "")
996 (delete-indentation)
997 t))
998
999 (defun fortran-join-line (arg)
1000 "Join current line to the previous one and re-indent.
1001 With a prefix argument, repeat this operation that many times.
1002 If the prefix argument ARG is negative, join the next -ARG lines.
1003 Continuation lines are correctly handled."
1004 (interactive "*p")
1005 (save-excursion
1006 (when (> 0 arg)
1007 (setq arg (- arg))
1008 (forward-line arg))
1009 (while (not (zerop arg))
1010 (beginning-of-line)
1011 (or (fortran-remove-continuation)
1012 (delete-indentation))
1013 (setq arg (1- arg)))
1014 (fortran-indent-line)))
1015
1016 (defun fortran-numerical-continuation-char ()
1017 "Return a digit for tab-digit style of continuation lines.
1018 If previous line is a tab-digit continuation line, return that digit
1019 plus one, otherwise return 1. Zero not allowed."
1020 (save-excursion
1021 (forward-line -1)
1022 (if (looking-at "\t[1-9]")
1023 (+ ?1 (% (- (char-after (1+ (point))) ?0) 9))
1024 ?1)))
1025
1026 (put 'fortran-electric-line-number 'delete-selection t)
1027 (defun fortran-electric-line-number (arg)
1028 "Self insert, but if part of a Fortran line number indent it automatically.
1029 Auto-indent does not happen if a numeric ARG is used."
1030 (interactive "*P")
1031 (if (or arg (not fortran-electric-line-number))
1032 (if arg
1033 (self-insert-command (prefix-numeric-value arg))
1034 (self-insert-command 1))
1035 (if (or (and (= 5 (current-column))
1036 (save-excursion
1037 (beginning-of-line)
1038 ;; In col 5 with only spaces to the left.
1039 (looking-at " \\{5\\}")))
1040 (and (= (if indent-tabs-mode
1041 fortran-minimum-statement-indent-tab
1042 fortran-minimum-statement-indent-fixed) (current-column))
1043 ;; In col 8 with a single tab to the left.
1044 (eq ?\t (char-after (line-beginning-position)))
1045 (not (or (eq last-command 'fortran-indent-line)
1046 (eq last-command
1047 'fortran-indent-new-line))))
1048 (save-excursion
1049 (re-search-backward "[^ \t0-9]"
1050 (line-beginning-position)
1051 t)) ; not a line number
1052 (looking-at "[0-9]")) ; within a line number
1053 (self-insert-command (prefix-numeric-value arg))
1054 (skip-chars-backward " \t")
1055 (insert last-command-char)
1056 (fortran-indent-line))))
1057
1058 \f
1059 (defun fortran-check-end-prog-re ()
1060 "Check a preliminary match against `fortran-end-prog-re'."
1061 ;; Having got a possible match for the subprogram end, we need a
1062 ;; match of whitespace, avoiding possible column 73+ stuff.
1063 (save-match-data
1064 (string-match "^\\s-*\\(\\'\\|\\s<\\)"
1065 (buffer-substring (match-end 0)
1066 (min (line-end-position)
1067 (+ 72 (line-beginning-position)))))))
1068
1069 ;; Note that you can't just check backwards for `subroutine' &c in
1070 ;; case of un-marked main programs not at the start of the file.
1071 (defun fortran-beginning-of-subprogram ()
1072 "Move point to the beginning of the current Fortran subprogram."
1073 (interactive)
1074 (save-match-data
1075 (let ((case-fold-search t))
1076 (beginning-of-line -1)
1077 (if (catch 'ok
1078 (while (re-search-backward fortran-end-prog-re nil 'move)
1079 (if (fortran-check-end-prog-re)
1080 (throw 'ok t))))
1081 (forward-line)))))
1082
1083 (defun fortran-end-of-subprogram ()
1084 "Move point to the end of the current Fortran subprogram."
1085 (interactive)
1086 (save-match-data
1087 (let ((case-fold-search t))
1088 (if (save-excursion ; on END
1089 (beginning-of-line)
1090 (and (looking-at fortran-end-prog-re)
1091 (fortran-check-end-prog-re)))
1092 (forward-line)
1093 (beginning-of-line 2)
1094 (catch 'ok
1095 (while (re-search-forward fortran-end-prog-re nil 'move)
1096 (if (fortran-check-end-prog-re)
1097 (throw 'ok t))))
1098 (goto-char (match-beginning 0))
1099 (forward-line)))))
1100
1101 (defun fortran-previous-statement ()
1102 "Move point to beginning of the previous Fortran statement.
1103 Returns 'first-statement if that statement is the first
1104 non-comment Fortran statement in the file, and nil otherwise.
1105 Directive lines are treated as comments."
1106 (interactive)
1107 (let (not-first-statement continue-test)
1108 (beginning-of-line)
1109 (setq continue-test
1110 (and
1111 (not (looking-at fortran-comment-line-start-skip))
1112 (not (looking-at fortran-directive-re))
1113 (or (looking-at
1114 (concat "[ \t]*"
1115 (regexp-quote fortran-continuation-string)))
1116 (looking-at " \\{5\\}[^ 0\n]\\|\t[1-9]"))))
1117 (while (and (setq not-first-statement (zerop (forward-line -1)))
1118 (or (looking-at fortran-comment-line-start-skip)
1119 (looking-at fortran-directive-re)
1120 (looking-at
1121 (concat "[ \t]*"
1122 (regexp-quote fortran-continuation-string)))
1123 (looking-at "[ \t]*$\\| \\{5\\}[^ 0\n]\\|\t[1-9]")
1124 (looking-at (concat "[ \t]*" comment-start-skip)))))
1125 (cond ((and continue-test
1126 (not not-first-statement))
1127 (message "Incomplete continuation statement."))
1128 (continue-test
1129 (fortran-previous-statement))
1130 ((not not-first-statement)
1131 'first-statement))))
1132
1133 (defun fortran-next-statement ()
1134 "Move point to beginning of the next Fortran statement.
1135 Returns 'last-statement if that statement is the last
1136 non-comment Fortran statement in the file, and nil otherwise.
1137 Directive lines are treated as comments."
1138 (interactive)
1139 (let (not-last-statement)
1140 (beginning-of-line)
1141 (while (and (setq not-last-statement
1142 (and (zerop (forward-line 1))
1143 (not (eobp))))
1144 (or (looking-at fortran-comment-line-start-skip)
1145 (looking-at fortran-directive-re)
1146 (looking-at "[ \t]*$\\| [^ 0\n]\\|\t[1-9]")
1147 (looking-at (concat "[ \t]*" comment-start-skip)))))
1148 (if (not not-last-statement)
1149 'last-statement)))
1150
1151 (defun fortran-looking-at-if-then ()
1152 "Return non-nil if at the start of a line with an IF ... THEN statement."
1153 ;; cf f90-looking-at-if-then.
1154 (let ((p (point))
1155 (i (fortran-beginning-if)))
1156 (if i
1157 (save-excursion
1158 (goto-char i)
1159 (beginning-of-line)
1160 (= (point) p)))))
1161
1162 ;; Used in hs-special-modes-alist.
1163 (defun fortran-end-of-block (&optional num)
1164 "Move point forward to the end of the current code block.
1165 With optional argument NUM, go forward that many balanced blocks.
1166 If NUM is negative, go backward to the start of a block. Does
1167 not check for consistency of block types. Interactively, pushes
1168 mark before moving point."
1169 (interactive "p")
1170 (if (interactive-p) (push-mark (point) t))
1171 (and num (< num 0) (fortran-beginning-of-block (- num)))
1172 (let ((case-fold-search t)
1173 (count (or num 1)))
1174 (end-of-line)
1175 (while (and (> count 0)
1176 (re-search-forward
1177 (concat "\\(" fortran-blocks-re
1178 (if fortran-check-all-num-for-matching-do
1179 "\\|^[ \t]*[0-9]+" "")
1180 "\\|continue\\|end\\)\\>")
1181 nil 'move))
1182 (beginning-of-line)
1183 (if (if (looking-at (concat "^[0-9 \t]*" fortran-if-start-re))
1184 (fortran-looking-at-if-then)
1185 (looking-at fortran-start-block-re))
1186 (setq count (1+ count))
1187 (if (or (looking-at fortran-end-block-re)
1188 (and (or (looking-at "^[0-9 \t]*continue")
1189 (and fortran-check-all-num-for-matching-do
1190 (looking-at "[ \t]*[0-9]+")))
1191 (fortran-check-for-matching-do)))
1192 (setq count (1- count))))
1193 (end-of-line))
1194 (if (> count 0) (error "Missing block end"))))
1195
1196 (defun fortran-beginning-of-block (&optional num)
1197 "Move point backwards to the start of the current code block.
1198 With optional argument NUM, go backward that many balanced
1199 blocks. If NUM is negative, go forward to the end of a block.
1200 Does not check for consistency of block types. Interactively,
1201 pushes mark before moving point."
1202 (interactive "p")
1203 (if (interactive-p) (push-mark (point) t))
1204 (and num (< num 0) (fortran-end-of-block (- num)))
1205 (let ((case-fold-search t)
1206 (count (or num 1)))
1207 (beginning-of-line)
1208 (while (and (> count 0)
1209 (re-search-backward
1210 (concat "\\(" fortran-blocks-re
1211 (if fortran-check-all-num-for-matching-do
1212 "\\|^[ \t]*[0-9]+" "")
1213 "\\|continue\\|end\\)\\>")
1214 nil 'move))
1215 (beginning-of-line)
1216 (if (if (looking-at (concat "^[0-9 \t]*" fortran-if-start-re))
1217 (fortran-looking-at-if-then)
1218 (looking-at fortran-start-block-re))
1219 (setq count (1- count))
1220 (if (or (looking-at fortran-end-block-re)
1221 (and (or (looking-at "^[0-9 \t]*continue")
1222 (and fortran-check-all-num-for-matching-do
1223 (looking-at "[ \t]*[0-9]+")))
1224 (fortran-check-for-matching-do)))
1225 (setq count (1+ count)))))
1226 ;; Includes an un-named main program block.
1227 (if (> count 0) (error "Missing block start"))))
1228
1229 \f
1230 (defun fortran-blink-match (regex keyword find-begin)
1231 "From a line matching REGEX, blink matching KEYWORD statement line.
1232 Use function FIND-BEGIN to match it."
1233 (let ((top-of-window (window-start))
1234 (end-point (point))
1235 (case-fold-search t)
1236 matching
1237 message)
1238 (when (save-excursion
1239 (beginning-of-line)
1240 (skip-chars-forward " \t0-9")
1241 (looking-at regex))
1242 (if (not (setq matching (funcall find-begin)))
1243 (setq message (concat "No matching " keyword "."))
1244 (if (< matching top-of-window)
1245 (save-excursion
1246 (goto-char matching)
1247 (beginning-of-line)
1248 (setq message
1249 (concat "Matches "
1250 (buffer-substring (point)
1251 (line-end-position)))))))
1252 (if message
1253 (message "%s" message)
1254 (goto-char matching)
1255 (sit-for blink-matching-delay)
1256 (goto-char end-point)))))
1257
1258 (defun fortran-blink-matching-if ()
1259 "From an ENDIF or ELSE statement, blink the matching IF statement."
1260 (fortran-blink-match "e\\(nd[ \t]*if\\|lse\\([ \t]*if\\)?\\)\\b"
1261 "if" #'fortran-beginning-if))
1262
1263 (defun fortran-blink-matching-do ()
1264 "From an ENDDO statement, blink the matching DO or DO WHILE statement."
1265 (fortran-blink-match "end[ \t]*do\\b" "do" #'fortran-beginning-do))
1266
1267 (defun fortran-mark-do ()
1268 "Put mark at end of Fortran DO [WHILE]-ENDDO construct, point at beginning.
1269 The marks are pushed."
1270 (interactive)
1271 (let (enddo-point do-point)
1272 (if (setq enddo-point (fortran-end-do))
1273 (if (not (setq do-point (fortran-beginning-do)))
1274 (message "No matching do.")
1275 (goto-char enddo-point)
1276 (push-mark)
1277 (goto-char do-point)))))
1278
1279 (defun fortran-end-do ()
1280 "Search forward for first unmatched ENDDO.
1281 Return point or nil."
1282 (let ((case-fold-search t))
1283 (if (save-excursion (beginning-of-line)
1284 (skip-chars-forward " \t0-9")
1285 (looking-at "end[ \t]*do\\b"))
1286 ;; Sitting on one.
1287 (match-beginning 0)
1288 ;; Search for one.
1289 (save-excursion
1290 (let ((count 1))
1291 (while (and (not (zerop count))
1292 (not (eq (fortran-next-statement) 'last-statement))
1293 ;; Keep local to subprogram.
1294 (not (and (looking-at fortran-end-prog-re)
1295 (fortran-check-end-prog-re))))
1296 (skip-chars-forward " \t0-9")
1297 (cond ((looking-at "end[ \t]*do\\b")
1298 (setq count (1- count)))
1299 ((looking-at
1300 "\\(\\(\\sw\\|\\s_\\)+:[ \t]*\\)?do[ \t]+[^0-9]")
1301 (setq count (1+ count)))))
1302 (and (zerop count)
1303 ;; All pairs accounted for.
1304 (point)))))))
1305
1306 (defun fortran-beginning-do ()
1307 "Search backwards for first unmatched DO [WHILE].
1308 Return point or nil. Ignores labelled DO loops (ie DO 10 ... 10 CONTINUE)."
1309 (let ((case-fold-search t)
1310 (dostart-re "\\(\\(\\sw\\|\\s_\\)+:[ \t]*\\)?do[ \t]+[^0-9]"))
1311 (if (save-excursion
1312 (beginning-of-line)
1313 (skip-chars-forward " \t0-9")
1314 (looking-at dostart-re))
1315 ;; Sitting on one.
1316 (match-beginning 0)
1317 ;; Search for one.
1318 (save-excursion
1319 (let ((count 1))
1320 (while (and (not (zerop count))
1321 (not (eq (fortran-previous-statement) 'first-statement))
1322 ;; Keep local to subprogram.
1323 (not (and (looking-at fortran-end-prog-re)
1324 (fortran-check-end-prog-re))))
1325 (skip-chars-forward " \t0-9")
1326 (cond ((looking-at dostart-re)
1327 (setq count (1- count)))
1328 ;; Note labelled loop ends not considered.
1329 ((looking-at "end[ \t]*do\\b")
1330 (setq count (1+ count)))))
1331 (and (zerop count)
1332 ;; All pairs accounted for.
1333 (point)))))))
1334
1335 (defun fortran-mark-if ()
1336 "Put mark at end of Fortran IF-ENDIF construct, point at beginning.
1337 The marks are pushed."
1338 (interactive)
1339 (let (endif-point if-point)
1340 (if (setq endif-point (fortran-end-if))
1341 (if (not (setq if-point (fortran-beginning-if)))
1342 (message "No matching if.")
1343 ;; Set mark, move point.
1344 (goto-char endif-point)
1345 (push-mark)
1346 (goto-char if-point)))))
1347
1348 (defun fortran-end-if ()
1349 "Search forwards for first unmatched ENDIF.
1350 Return point or nil."
1351 (let ((case-fold-search t))
1352 (if (save-excursion (beginning-of-line)
1353 (skip-chars-forward " \t0-9")
1354 (looking-at "end[ \t]*if\\b"))
1355 ;; Sitting on one.
1356 (match-beginning 0)
1357 ;; Search for one. The point has been already been moved to first
1358 ;; letter on line but this should not cause troubles.
1359 (save-excursion
1360 (let ((count 1))
1361 (while (and (not (zerop count))
1362 (not (eq (fortran-next-statement) 'last-statement))
1363 ;; Keep local to subprogram.
1364 (not (and (looking-at fortran-end-prog-re)
1365 (fortran-check-end-prog-re))))
1366 (skip-chars-forward " \t0-9")
1367 (cond ((looking-at "end[ \t]*if\\b")
1368 (setq count (1- count)))
1369 ((looking-at fortran-if-start-re)
1370 (save-excursion
1371 (if (or
1372 (looking-at ".*)[ \t]*then\\b[ \t]*[^ \t(=a-z0-9]")
1373 (let (then-test) ; multi-line if-then
1374 (while
1375 (and
1376 (zerop (forward-line 1))
1377 ;; Search forward for then.
1378 (looking-at " \\{5\\}[^ 0\n]\\|\t[1-9]")
1379 (not
1380 (setq then-test
1381 (looking-at
1382 ".*then\\b[ \t]*[^ \t(=a-z0-9]")))))
1383 then-test))
1384 (setq count (1+ count)))))))
1385 (and (zerop count)
1386 ;; All pairs accounted for.
1387 (point)))))))
1388
1389 (defun fortran-beginning-if ()
1390 "Search backwards for first unmatched IF-THEN.
1391 Return point or nil."
1392 (let ((case-fold-search t))
1393 (if (save-excursion
1394 ;; May be sitting on multi-line if-then statement, first
1395 ;; move to beginning of current statement. Note:
1396 ;; `fortran-previous-statement' moves to previous statement
1397 ;; *unless* current statement is first one. Only move
1398 ;; forward if not first-statement.
1399 (if (not (eq (fortran-previous-statement) 'first-statement))
1400 (fortran-next-statement))
1401 (skip-chars-forward " \t0-9")
1402 (and
1403 (looking-at fortran-if-start-re)
1404 (save-match-data
1405 (or (looking-at ".*)[ \t]*then\\b[ \t]*[^ \t(=a-z0-9]")
1406 ;; Multi-line if-then.
1407 (let (then-test)
1408 (while
1409 (and (zerop (forward-line 1))
1410 ;; Search forward for then.
1411 (looking-at " \\{5\\}[^ 0\n]\\|\t[1-9]")
1412 (not
1413 (setq then-test
1414 (looking-at
1415 ".*then\\b[ \t]*[^ \t(=a-z0-9]")))))
1416 then-test)))))
1417 ;; Sitting on one.
1418 (match-beginning 0)
1419 ;; Search for one.
1420 (save-excursion
1421 (let ((count 1))
1422 (while (and (not (zerop count))
1423 (not (eq (fortran-previous-statement) 'first-statement))
1424 ;; Keep local to subprogram.
1425 (not (and (looking-at fortran-end-prog-re)
1426 (fortran-check-end-prog-re))))
1427 (skip-chars-forward " \t0-9")
1428 (cond ((looking-at fortran-if-start-re)
1429 (save-excursion
1430 (if (or
1431 (looking-at ".*)[ \t]*then\\b[ \t]*[^ \t(=a-z0-9]")
1432 (let (then-test) ; multi-line if-then
1433 (while
1434 (and
1435 (zerop (forward-line 1))
1436 ;; Search forward for then.
1437 (looking-at " \\{5\\}[^ 0\n]\\|\t[1-9]")
1438 (not
1439 (setq then-test
1440 (looking-at
1441 (concat ".*then\\b[ \t]*"
1442 "[^ \t(=a-z0-9]"))))))
1443 then-test))
1444 (setq count (1- count)))))
1445 ((looking-at "end[ \t]*if\\b")
1446 (setq count (1+ count)))))
1447 (and (zerop count)
1448 ;; All pairs accounted for.
1449 (point)))))))
1450
1451 \f
1452 (defun fortran-indent-line ()
1453 "Indent current Fortran line based on its contents and on previous lines."
1454 (interactive "*")
1455 (let ((cfi (fortran-calculate-indent)))
1456 (save-excursion
1457 (beginning-of-line)
1458 (if (or (not (= cfi (fortran-current-line-indentation)))
1459 (and (re-search-forward "^[ \t]*[0-9]+" (+ (point) 4) t)
1460 (not (fortran-line-number-indented-correctly-p))))
1461 (fortran-indent-to-column cfi)
1462 (beginning-of-line)
1463 (if (fortran-find-comment-start-skip)
1464 (fortran-indent-comment))))
1465 ;; Never leave point in left margin.
1466 (if (< (current-column) cfi)
1467 (move-to-column cfi))
1468 (and auto-fill-function
1469 (> (save-excursion (end-of-line) (current-column))
1470 fill-column)
1471 (save-excursion
1472 (end-of-line)
1473 (fortran-fill)))
1474 (when fortran-blink-matching-if
1475 (fortran-blink-matching-if)
1476 (fortran-blink-matching-do))))
1477
1478 (defun fortran-auto-fill ()
1479 "Function to use for `normal-auto-fill-function' in Fortran mode."
1480 (if (> (current-column) (current-fill-column))
1481 (let ((cfi (fortran-calculate-indent)))
1482 (save-excursion
1483 (beginning-of-line)
1484 (if (or (not (= cfi (fortran-current-line-indentation)))
1485 (and (re-search-forward "^[ \t]*[0-9]+"
1486 (+ (point) 4) t)
1487 (not (fortran-line-number-indented-correctly-p))))
1488 (fortran-indent-to-column cfi)
1489 (beginning-of-line)
1490 (if (fortran-find-comment-start-skip)
1491 (fortran-indent-comment))))
1492 (fortran-fill)
1493 ;; Never leave point in left margin.
1494 (if (< (current-column) cfi)
1495 (move-to-column cfi)))))
1496
1497 ;; Historically this was a separate function which advertised itself
1498 ;; as reindenting but only did so where `most likely to be necessary'.
1499 (defalias 'fortran-indent-new-line 'reindent-then-newline-and-indent)
1500
1501 (defun fortran-indent-subprogram ()
1502 "Properly indent the Fortran subprogram containing point."
1503 (interactive "*")
1504 (save-excursion
1505 (mark-defun)
1506 (message "Indenting subprogram...")
1507 (indent-region (point) (mark) nil))
1508 (message "Indenting subprogram...done."))
1509
1510 (defun fortran-calculate-indent ()
1511 "Calculates the Fortran indent column based on previous lines."
1512 (let (icol first-statement (case-fold-search t)
1513 (fortran-minimum-statement-indent
1514 (if indent-tabs-mode
1515 fortran-minimum-statement-indent-tab
1516 fortran-minimum-statement-indent-fixed)))
1517 (save-excursion
1518 (setq first-statement (fortran-previous-statement))
1519 (if first-statement
1520 (setq icol fortran-minimum-statement-indent)
1521 (if (= (point) (point-min))
1522 (setq icol fortran-minimum-statement-indent)
1523 (setq icol (fortran-current-line-indentation)))
1524 (skip-chars-forward " \t0-9")
1525 (cond ((looking-at "\\(\\(\\sw\\|\\s_\\)+:[ \t]*\\)?if[ \t]*(")
1526 (if (or (looking-at ".*)[ \t]*then\\b[ \t]*[^ \t_$(=a-z0-9]")
1527 (let (then-test) ; multi-line if-then
1528 (while (and (zerop (forward-line 1))
1529 ;; Search forward for then.
1530 (looking-at " \\{5\\}[^ 0\n]\\|\t[1-9]")
1531 (not (setq then-test
1532 (looking-at
1533 ".*then\\b[ \t]\
1534 *[^ \t_$(=a-z0-9]")))))
1535 then-test))
1536 (setq icol (+ icol fortran-if-indent))))
1537 ((looking-at "else\\(if\\)?\\b")
1538 (setq icol (+ icol fortran-if-indent)))
1539 ((looking-at "select[ \t]*case[ \t](.*)")
1540 (setq icol (+ icol fortran-if-indent)))
1541 ((looking-at "case[ \t]*(.*)")
1542 (setq icol (+ icol fortran-if-indent)))
1543 ((looking-at "case[ \t]*default\\b")
1544 (setq icol (+ icol fortran-if-indent)))
1545 ((looking-at "\\(otherwise\\|else[ \t]*where\\)\\b")
1546 (setq icol (+ icol fortran-if-indent)))
1547 ((looking-at "where[ \t]*(.*)[ \t]*\n")
1548 (setq icol (+ icol fortran-if-indent)))
1549 ((looking-at "do\\b")
1550 (setq icol (+ icol fortran-do-indent)))
1551 ((looking-at
1552 "\\(structure\\|union\\|map\\|interface\\)\
1553 \\b[ \t]*[^ \t=(a-z]")
1554 (setq icol (+ icol fortran-structure-indent)))
1555 ((and (looking-at fortran-end-prog-re1)
1556 (fortran-check-end-prog-re))
1557 ;; Previous END resets indent to minimum.
1558 (setq icol fortran-minimum-statement-indent)))))
1559 (save-excursion
1560 (beginning-of-line)
1561 (cond ((looking-at "[ \t]*$"))
1562 ;; Check for directive before comment, so as not to indent.
1563 ((looking-at fortran-directive-re)
1564 (setq fortran-minimum-statement-indent 0 icol 0))
1565 ((looking-at fortran-comment-line-start-skip)
1566 (cond ((eq fortran-comment-indent-style 'relative)
1567 (setq icol (+ icol fortran-comment-line-extra-indent)))
1568 ((eq fortran-comment-indent-style 'fixed)
1569 (setq icol (+ fortran-minimum-statement-indent
1570 fortran-comment-line-extra-indent))))
1571 (setq fortran-minimum-statement-indent 0))
1572 ((or (looking-at (concat "[ \t]*"
1573 (regexp-quote
1574 fortran-continuation-string)))
1575 (looking-at " \\{5\\}[^ 0\n]\\|\t[1-9]"))
1576 (skip-chars-forward " \t")
1577 ;; Do not introduce extra whitespace into a broken string.
1578 (setq icol
1579 (if (fortran-is-in-string-p (point))
1580 6
1581 (+ icol fortran-continuation-indent))))
1582 (first-statement)
1583 ((and fortran-check-all-num-for-matching-do
1584 (looking-at "[ \t]*[0-9]+")
1585 (fortran-check-for-matching-do))
1586 (setq icol (- icol fortran-do-indent)))
1587 (t
1588 (skip-chars-forward " \t0-9")
1589 (cond ((looking-at "end[ \t]*\\(if\\|select\\|where\\)\\b")
1590 (setq icol (- icol fortran-if-indent)))
1591 ((looking-at "else\\(if\\)?\\b")
1592 (setq icol (- icol fortran-if-indent)))
1593 ((looking-at "case[ \t]*\\((.*)\\|default\\>\\)")
1594 (setq icol (- icol fortran-if-indent)))
1595 ((looking-at "\\(otherwise\\|else[ \t]*where\\)\\b")
1596 (setq icol (- icol fortran-if-indent)))
1597 ((and (looking-at "continue\\b")
1598 (fortran-check-for-matching-do))
1599 (setq icol (- icol fortran-do-indent)))
1600 ((looking-at "end[ \t]*do\\b")
1601 (setq icol (- icol fortran-do-indent)))
1602 ((looking-at "end[ \t]*\
1603 \\(structure\\|union\\|map\\|interface\\)\\b[ \t]*[^ \t=(a-z]")
1604 (setq icol (- icol fortran-structure-indent)))
1605 ((and (looking-at fortran-end-prog-re1)
1606 (fortran-check-end-prog-re)
1607 (not (= icol fortran-minimum-statement-indent)))
1608 (message "Warning: `end' not in column %d. Probably\
1609 an unclosed block." fortran-minimum-statement-indent))))))
1610 (max fortran-minimum-statement-indent icol)))
1611
1612 \f
1613 (defun fortran-current-line-indentation ()
1614 "Indentation of current line, ignoring Fortran line number or continuation.
1615 This is the column position of the first non-whitespace character
1616 aside from the line number and/or column 5/8 line-continuation character.
1617 For comment lines, returns indentation of the first
1618 non-indentation text within the comment."
1619 (save-excursion
1620 (beginning-of-line)
1621 (cond ((looking-at fortran-comment-line-start-skip)
1622 (goto-char (match-end 0))
1623 (skip-chars-forward
1624 (if (stringp fortran-comment-indent-char)
1625 fortran-comment-indent-char
1626 (char-to-string fortran-comment-indent-char))))
1627 ((or (looking-at " \\{5\\}[^ 0\n]\\|\t[1-9]"))
1628 (goto-char (match-end 0)))
1629 (t
1630 ;; Move past line number.
1631 (skip-chars-forward "[ \t0-9]")))
1632 ;; Move past whitespace.
1633 (skip-chars-forward " \t")
1634 (current-column)))
1635
1636 (defun fortran-indent-to-column (col)
1637 "Indent current line to column COL.
1638 notes: 1) A non-zero/non-blank character in column 5 indicates a continuation
1639 line, and this continuation character is retained on indentation;
1640 2) If `fortran-continuation-string' is the first non-whitespace
1641 character, this is a continuation line;
1642 3) A non-continuation line which has a number as the first
1643 non-whitespace character is a numbered line.
1644 4) A TAB followed by a digit indicates a continuation line."
1645 (save-excursion
1646 (beginning-of-line)
1647 (if (looking-at fortran-comment-line-start-skip)
1648 (if fortran-comment-indent-style
1649 (let* ((char (if (stringp fortran-comment-indent-char)
1650 (aref fortran-comment-indent-char 0)
1651 fortran-comment-indent-char))
1652 (chars (string ?\s ?\t char)))
1653 (goto-char (match-end 0))
1654 (skip-chars-backward chars)
1655 (delete-region (point) (progn (skip-chars-forward chars)
1656 (point)))
1657 (insert-char char (- col (current-column)))))
1658 (if (looking-at "\t[1-9]")
1659 (if indent-tabs-mode
1660 (goto-char (match-end 0))
1661 (delete-char 2)
1662 (insert-char ?\s 5)
1663 (insert fortran-continuation-string))
1664 (if (looking-at " \\{5\\}[^ 0\n]")
1665 (if indent-tabs-mode
1666 (progn (delete-char 6)
1667 (insert ?\t (fortran-numerical-continuation-char) 1))
1668 (forward-char 6))
1669 (delete-horizontal-space)
1670 ;; Put line number in columns 0-4, or
1671 ;; continuation character in column 5.
1672 (cond ((eobp))
1673 ((looking-at (regexp-quote fortran-continuation-string))
1674 (if indent-tabs-mode
1675 (progn
1676 (indent-to
1677 (if indent-tabs-mode
1678 fortran-minimum-statement-indent-tab
1679 fortran-minimum-statement-indent-fixed))
1680 (delete-char 1)
1681 (insert-char (fortran-numerical-continuation-char) 1))
1682 (indent-to 5)
1683 (forward-char 1)))
1684 ((looking-at "[0-9]+")
1685 (let ((extra-space (- 5 (- (match-end 0) (point)))))
1686 (if (< extra-space 0)
1687 (message "Warning: line number exceeds 5-digit limit.")
1688 (indent-to (min fortran-line-number-indent extra-space))))
1689 (skip-chars-forward "0-9")))))
1690 ;; Point is now after any continuation character or line number.
1691 ;; Put body of statement where specified.
1692 (delete-horizontal-space)
1693 (indent-to col)
1694 ;; Indent any comment following code on the same line.
1695 (when (fortran-find-comment-start-skip)
1696 (goto-char (match-beginning 0))
1697 (unless (= (current-column) (fortran-comment-indent))
1698 (delete-horizontal-space)
1699 (indent-to (fortran-comment-indent)))))))
1700
1701 (defun fortran-line-number-indented-correctly-p ()
1702 "Return t if current line's line number is correctly indented.
1703 Do not call if there is no line number."
1704 (save-excursion
1705 (beginning-of-line)
1706 (skip-chars-forward " \t")
1707 (and (<= (current-column) fortran-line-number-indent)
1708 (or (= (current-column) fortran-line-number-indent)
1709 (progn (skip-chars-forward "0-9")
1710 (= (current-column) 5))))))
1711
1712 (defun fortran-check-for-matching-do ()
1713 "When called from a numbered statement, return t if matching DO is found.
1714 Otherwise return nil."
1715 (let ((case-fold-search t)
1716 charnum)
1717 (save-excursion
1718 (beginning-of-line)
1719 (when (looking-at "[ \t]*[0-9]+")
1720 (skip-chars-forward " \t")
1721 (skip-chars-forward "0") ; skip past leading zeros
1722 (setq charnum
1723 (buffer-substring (point) (progn
1724 (skip-chars-forward "0-9")
1725 (point))))
1726 (beginning-of-line)
1727 (save-restriction
1728 (save-excursion
1729 (narrow-to-defun)
1730 (and (re-search-backward
1731 (concat
1732 "\\(^[ \t0-9]*do[ \t]*0*"
1733 charnum "\\b\\)\\|" "\\(^[ \t]*0*"
1734 charnum "\\b\\)")
1735 nil t)
1736 (looking-at
1737 (concat "^[ \t0-9]*do[ \t]*0*"
1738 charnum)))))))))
1739
1740 (defun fortran-find-comment-start-skip (&optional all)
1741 "Move to past `comment-start-skip' found on current line.
1742 Return non-nil if `comment-start-skip' found, nil if not.
1743 If ALL is nil, only match comments that start in column > 0."
1744 ;; Hopefully at some point we can just use the line below! -stef
1745 ;; (comment-search-forward (line-end-position) t))
1746 (when (or all comment-start-skip)
1747 (let ((pos (point))
1748 (css (if comment-start-skip
1749 (concat fortran-comment-line-start-skip
1750 "\\|" comment-start-skip)
1751 fortran-comment-line-start-skip)))
1752 (when (re-search-forward css (line-end-position) t)
1753 (if (and (or all (> (match-beginning 0) (line-beginning-position)))
1754 (or (save-match-data
1755 (not (fortran-is-in-string-p (match-beginning 0))))
1756 ;; Recurse for rest of line.
1757 (fortran-find-comment-start-skip all)))
1758 (point)
1759 (goto-char pos)
1760 nil)))))
1761
1762 ;; From: ralf@up3aud1.gwdg.de (Ralf Fassel)
1763 ;; Test if TAB format continuation lines work.
1764 (defun fortran-is-in-string-p (where)
1765 "Return non-nil iff WHERE (a buffer position) is inside a Fortran string."
1766 (save-excursion
1767 (goto-char where)
1768 (cond
1769 ((bolp) nil) ; bol is never inside a string
1770 ((save-excursion ; comment lines too
1771 (beginning-of-line)
1772 (looking-at fortran-comment-line-start-skip)) nil)
1773 (t (let ((parse-state '(0 nil nil nil nil nil 0))
1774 (quoted-comment-start (if comment-start
1775 (regexp-quote comment-start)))
1776 (not-done t)
1777 parse-limit end-of-line)
1778 ;; Move to start of current statement.
1779 (fortran-next-statement)
1780 (fortran-previous-statement)
1781 ;; Now parse up to WHERE.
1782 (while not-done
1783 (if (or ;; Skip to next line if:
1784 ;; - comment line?
1785 (looking-at fortran-comment-line-start-skip)
1786 ;; - at end of line?
1787 (eolp)
1788 ;; - not in a string and after comment-start?
1789 (and (not (nth 3 parse-state))
1790 comment-start
1791 (equal comment-start
1792 (char-to-string (preceding-char)))))
1793 (if (> (forward-line) 0)
1794 (setq not-done nil))
1795 ;; else:
1796 ;; If we are at beginning of code line, skip any
1797 ;; whitespace, labels and tab continuation markers.
1798 (if (bolp) (skip-chars-forward " \t0-9"))
1799 ;; If we are in column <= 5 now, check for continuation char.
1800 (cond ((= 5 (current-column)) (forward-char 1))
1801 ((and (< (current-column) 5)
1802 (equal fortran-continuation-string
1803 (char-to-string (following-char)))
1804 (forward-char 1))))
1805 ;; Find out parse-limit from here.
1806 (setq end-of-line (line-end-position))
1807 (setq parse-limit (min where end-of-line))
1808 ;; Parse max up to comment-start, if non-nil and in current line.
1809 (if comment-start
1810 (save-excursion
1811 (if (re-search-forward quoted-comment-start end-of-line t)
1812 (setq parse-limit (min (point) parse-limit)))))
1813 ;; Now parse if still in limits.
1814 (if (< (point) where)
1815 (setq parse-state (parse-partial-sexp
1816 (point) parse-limit nil nil parse-state))
1817 (setq not-done nil))))
1818 ;; Result.
1819 (nth 3 parse-state))))))
1820
1821 ;; From old version.
1822 (defalias 'fortran-auto-fill-mode 'auto-fill-mode)
1823
1824 (defun fortran-fill ()
1825 "Fill the current line at an appropriate point(s)."
1826 (let* ((auto-fill-function #'fortran-auto-fill)
1827 (opoint (point))
1828 (bol (line-beginning-position))
1829 (eol (line-end-position))
1830 (bos (min eol (+ bol (fortran-current-line-indentation))))
1831 ;; If in a string at fill-column, break it either before the
1832 ;; initial quote, or at fill-col (if string is too long).
1833 (quote
1834 (save-excursion
1835 (goto-char bol)
1836 ;; OK to break quotes on comment lines.
1837 (unless (looking-at fortran-comment-line-start-skip)
1838 (let (fcpoint start)
1839 (move-to-column fill-column)
1840 (when (fortran-is-in-string-p (setq fcpoint (point)))
1841 (save-excursion
1842 (re-search-backward "\\S\"\\s\"\\S\"?" bol t)
1843 (setq start
1844 (if fortran-break-before-delimiters
1845 (point)
1846 (1+ (point)))))
1847 (if (re-search-forward "\\S\"\\s\"\\S\"" eol t)
1848 (backward-char 2))
1849 ;; If the current string is longer than (fill-column
1850 ;; - 6) chars, break it at the fill column (else
1851 ;; infinite loop).
1852 (if (> (- (point) start)
1853 (- fill-column 6 fortran-continuation-indent))
1854 fcpoint
1855 start))))))
1856 ;; Decide where to split the line. If a position for a quoted
1857 ;; string was found above then use that, else break the line
1858 ;; before/after the last delimiter.
1859 (fill-point
1860 (or quote
1861 (save-excursion
1862 ;; If f-b-b-d is t, have an extra column to play with,
1863 ;; since delimiter gets shifted to new line.
1864 (move-to-column (if fortran-break-before-delimiters
1865 (1+ fill-column)
1866 fill-column))
1867 (let ((repeat t))
1868 (while repeat
1869 (setq repeat nil)
1870 ;; Adapted from f90-find-breakpoint.
1871 (re-search-backward fortran-break-delimiters-re bol)
1872 (if (not fortran-break-before-delimiters)
1873 (if (looking-at fortran-no-break-re)
1874 ;; Deal with cases such as "**" split over
1875 ;; fill-col. Simpler alternative would be
1876 ;; to start from (1- fill-column) above.
1877 (if (> (+ 2 (current-column)) fill-column)
1878 (setq repeat t)
1879 (forward-char 2))
1880 (forward-char 1))
1881 (backward-char)
1882 (or (looking-at fortran-no-break-re)
1883 (forward-char)))))
1884 ;; Line indented beyond fill-column?
1885 (when (<= (point) bos)
1886 (move-to-column (1+ fill-column))
1887 ;; What is this doing???
1888 (or (re-search-forward "[\t\n,'+-/*)=]" eol t)
1889 (goto-char bol)))
1890 (if (bolp)
1891 (re-search-forward "[ \t]" opoint t))
1892 (point)))))
1893 ;; If we are in an in-line comment, don't break unless the
1894 ;; line of code is longer than it should be. Otherwise
1895 ;; break the line at the column computed above.
1896 ;;
1897 ;; Need to use fortran-find-comment-start-skip to make sure that
1898 ;; quoted !'s don't prevent a break.
1899 (when (and (save-excursion
1900 (beginning-of-line)
1901 (if (not (fortran-find-comment-start-skip))
1902 t
1903 (goto-char (match-beginning 0))
1904 (>= (point) fill-point)))
1905 (save-excursion
1906 (goto-char fill-point)
1907 (not (bolp)))
1908 (> (save-excursion
1909 (goto-char opoint)
1910 (current-column))
1911 (min (1+ fill-column)
1912 (+ (fortran-calculate-indent)
1913 fortran-continuation-indent))))
1914 (goto-char fill-point)
1915 (fortran-break-line)
1916 (end-of-line))))
1917
1918 (defun fortran-break-line ()
1919 "Call `fortran-split-line'. Joins continuation lines first, then refills."
1920 (let ((opoint (point))
1921 (bol (line-beginning-position))
1922 (comment-string
1923 (save-excursion
1924 (if (fortran-find-comment-start-skip)
1925 (delete-and-extract-region
1926 (match-beginning 0) (line-end-position))))))
1927 ;; Forward line 1 really needs to go to next non white line.
1928 (if (save-excursion (forward-line)
1929 (looking-at " \\{5\\}[^ 0\n]\\|\t[1-9]"))
1930 (progn
1931 (end-of-line)
1932 (delete-region (point) (match-end 0))
1933 (delete-horizontal-space)
1934 (fortran-fill))
1935 (fortran-split-line))
1936 (if comment-string
1937 (save-excursion
1938 (goto-char bol)
1939 (end-of-line)
1940 (delete-horizontal-space)
1941 (indent-to (fortran-comment-indent))
1942 (insert comment-string)))))
1943
1944 (defun fortran-analyze-file-format ()
1945 "Return nil if fixed format is used, t if TAB formatting is used.
1946 Use `fortran-tab-mode-default' if no non-comment statements are found
1947 before the end or in the first `fortran-analyze-depth' lines."
1948 (let ((i 0))
1949 (save-excursion
1950 (goto-char (point-min))
1951 (while (not (or
1952 (eobp)
1953 (eq (char-after) ?\t)
1954 (looking-at " \\{6\\}")
1955 (> i fortran-analyze-depth)))
1956 (forward-line)
1957 (setq i (1+ i)))
1958 (cond
1959 ((eq (char-after) ?\t) t)
1960 ((looking-at " \\{6\\}") nil)
1961 (t fortran-tab-mode-default)))))
1962
1963 (defun fortran-fill-paragraph (&optional justify)
1964 "Fill surrounding comment block as paragraphs, else fill statement.
1965 Intended as the value of `fill-paragraph-function'.
1966 A comment block is filled by calling `fill-comment-paragraph' with
1967 argument JUSTIFY, otherwise `fortran-fill-statement' is called.
1968 Always returns non-nil (to prevent `fill-paragraph' being called)."
1969 (interactive "*P")
1970 (or (fill-comment-paragraph justify)
1971 (fortran-fill-statement)
1972 t))
1973
1974 (defun fortran-fill-statement ()
1975 "Fill a Fortran statement up to `fill-column'."
1976 (interactive "*")
1977 (let ((auto-fill-function #'fortran-auto-fill))
1978 (unless (save-excursion
1979 (beginning-of-line)
1980 (or (looking-at "[ \t]*$")
1981 (looking-at fortran-comment-line-start-skip)
1982 (and comment-start-skip
1983 (looking-at (concat "[ \t]*" comment-start-skip)))))
1984 (save-excursion
1985 ;; Find beginning of statement.
1986 (fortran-next-statement)
1987 (fortran-previous-statement)
1988 ;; Re-indent initially.
1989 (fortran-indent-line)
1990 ;; Replace newline plus continuation field plus indentation with
1991 ;; single space.
1992 (while (progn
1993 (forward-line)
1994 (fortran-remove-continuation)))
1995 (fortran-previous-statement)))
1996 (fortran-indent-line)))
1997
1998 (defun fortran-strip-sequence-nos (&optional do-space)
1999 "Delete all text in column 72 and up (assumed to be sequence numbers).
2000 Normally also deletes trailing whitespace after stripping such text.
2001 Supplying prefix arg DO-SPACE prevents stripping the whitespace."
2002 (interactive "*p")
2003 (save-excursion
2004 (goto-char (point-min))
2005 (while (re-search-forward "^.\\{72\\}\\(.*\\)" nil t)
2006 (replace-match "" nil nil nil 1)
2007 (unless do-space (delete-horizontal-space)))))
2008
2009 ;; This code used to live in add-log.el, but this is a better place
2010 ;; for it.
2011 (defun fortran-current-defun ()
2012 "Function to use for `add-log-current-defun-function' in Fortran mode."
2013 (save-excursion
2014 ;; We must be inside function body for this to work.
2015 (fortran-beginning-of-subprogram)
2016 (let ((case-fold-search t)) ; case-insensitive
2017 ;; Search for fortran subprogram start.
2018 (if (re-search-forward
2019 (concat "^[ \t]*\\(program\\|subroutine\\|function"
2020 "\\|[ \ta-z0-9*()]*[ \t]+function\\|"
2021 "\\(block[ \t]*data\\)\\)")
2022 (save-excursion (fortran-end-of-subprogram)
2023 (point))
2024 t)
2025 (or (match-string-no-properties 2)
2026 (progn
2027 ;; Move to EOL or before first left paren.
2028 (if (re-search-forward "[(\n]" nil t)
2029 (progn (backward-char)
2030 (skip-chars-backward " \t"))
2031 (end-of-line))
2032 ;; Use the name preceding that.
2033 (buffer-substring-no-properties (point) (progn (backward-sexp)
2034 (point)))))
2035 "main"))))
2036
2037 (provide 'fortran)
2038
2039 ;;; arch-tag: 74935096-21c4-4cab-8ee5-6ef16090dc04
2040 ;;; fortran.el ends here