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