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