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