1 ;;; f90.el --- Fortran-90 mode (free format)
3 ;; Copyright (C) 1995, 1996, 1997, 2000, 2004 Free Software Foundation, Inc.
5 ;; Author: Torbj\"orn Einarsson <Torbjorn.Einarsson@era.ericsson.se>
6 ;; Maintainer: Glenn Morris <gmorris@ast.cam.ac.uk>
7 ;; Keywords: fortran, f90, languages
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
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.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; Major mode for editing F90 programs in FREE FORMAT.
29 ;; The minor language revision F95 is also supported (with font-locking).
31 ;; Knows about continuation lines, named structured statements, and other
32 ;; features in F90 including HPF (High Performance Fortran) structures.
33 ;; The basic feature provides accurate indentation of F90 programs.
34 ;; In addition, there are many more features like automatic matching of all
35 ;; end statements, an auto-fill function to break long lines, a join-lines
36 ;; function which joins continued lines, etc.
38 ;; To facilitate typing, a fairly complete list of abbreviations is provided.
39 ;; All abbreviations begin with the backquote character "`"
40 ;; (this requires modification of the syntax-table).
41 ;; For example, `i expands to integer (if abbrev-mode is on).
43 ;; There are two separate features for altering the appearance of code:
44 ;; 1) Upcasing or capitalizing of all keywords.
45 ;; 2) Colors/fonts using font-lock-mode.
46 ;; Automatic upcase or downcase of keywords is controlled by the variable
47 ;; f90-auto-keyword-case.
49 ;; The indentations of lines starting with ! is determined by the first of the
50 ;; following matches (values in the left column are the defaults):
52 ;; start-string/regexp indent variable holding start-string/regexp
54 ;; !hpf\\$ (re) 0 f90-directive-comment-re
55 ;; !!$ 0 f90-comment-region
56 ;; ! (re) as code f90-indented-comment-re
57 ;; default comment-column
59 ;; Ex: Here is the result of 3 different settings of f90-indented-comment-re
60 ;; f90-indented-comment-re !-indentation !!-indentation
62 ;; !! comment-column as code
63 ;; ![^!] as code comment-column
64 ;; Trailing comments are indented to comment-column with indent-for-comment.
65 ;; The function f90-comment-region toggles insertion of
66 ;; the variable f90-comment-region in every line of the region.
68 ;; One common convention for free vs. fixed format is that free format files
69 ;; have the ending .f90 or .f95 while fixed format files have the ending .f.
70 ;; Emacs automatically loads Fortran files in the appropriate mode based
71 ;; on extension. You can modify this by adjusting the variable auto-mode-alist.
73 ;; (add-to-list 'auto-mode-alist '("\\.f\\'" . f90-mode))
75 ;; Once you have entered f90-mode, you may get more info by using
76 ;; the command describe-mode (C-h m). For online help use
77 ;; C-h f <Name of function you want described>, or
78 ;; C-h v <Name of variable you want described>.
80 ;; To customize f90-mode for your taste, use, for example:
81 ;; (you don't have to specify values for all the parameters below)
83 ;;(add-hook 'f90-mode-hook
84 ;; ;; These are the default values.
85 ;; '(lambda () (setq f90-do-indent 3
88 ;; f90-program-indent 2
89 ;; f90-continuation-indent 5
90 ;; f90-comment-region "!!$"
91 ;; f90-directive-comment-re "!hpf\\$"
92 ;; f90-indented-comment-re "!"
93 ;; f90-break-delimiters "[-+\\*/><=,% \t]"
94 ;; f90-break-before-delimiters t
95 ;; f90-beginning-ampersand t
96 ;; f90-smart-end 'blink
97 ;; f90-auto-keyword-case nil
98 ;; f90-leave-line-no nil
99 ;; indent-tabs-mode nil
100 ;; f90-font-lock-keywords f90-font-lock-keywords-2
102 ;; ;; These are not default.
103 ;; (abbrev-mode 1) ; turn on abbreviation mode
104 ;; (f90-add-imenu-menu) ; extra menu with functions etc.
105 ;; (if f90-auto-keyword-case ; change case of all keywords on startup
106 ;; (f90-change-keywords f90-auto-keyword-case))
109 ;; in your .emacs file. You can also customize the lists
110 ;; f90-font-lock-keywords, etc.
112 ;; The auto-fill and abbreviation minor modes are accessible from the F90 menu,
113 ;; or by using M-x auto-fill-mode and M-x abbrev-mode, respectively.
116 ;; 1) Line numbers are by default left-justified. If f90-leave-line-no is
117 ;; non-nil, the line numbers are never touched.
118 ;; 2) Multi-; statements like "do i=1,20 ; j=j+i ; end do" are not handled
119 ;; correctly, but I imagine them to be rare.
120 ;; 3) Regexps for hilit19 are no longer supported.
121 ;; 4) For FIXED FORMAT code, use fortran mode.
122 ;; 5) This mode does not work under emacs-18.x.
123 ;; 6) Preprocessor directives, i.e., lines starting with # are left-justified
124 ;; and are untouched by all case-changing commands. There is, at present, no
125 ;; mechanism for treating multi-line directives (continued by \ ).
126 ;; 7) f77 do-loops do 10 i=.. ; ; 10 continue are not correctly indented.
127 ;; You are urged to use f90-do loops (with labels if you wish).
128 ;; 8) The highlighting mode under XEmacs is not as complete as under Emacs.
130 ;; List of user commands
131 ;; f90-previous-statement f90-next-statement
132 ;; f90-beginning-of-subprogram f90-end-of-subprogram f90-mark-subprogram
133 ;; f90-comment-region
134 ;; f90-indent-line f90-indent-new-line
135 ;; f90-indent-region (can be called by calling indent-region)
136 ;; f90-indent-subprogram
137 ;; f90-break-line f90-join-lines
140 ;; f90-upcase-keywords f90-upcase-region-keywords
141 ;; f90-downcase-keywords f90-downcase-region-keywords
142 ;; f90-capitalize-keywords f90-capitalize-region-keywords
143 ;; f90-add-imenu-menu
144 ;; f90-font-lock-1, f90-font-lock-2, f90-font-lock-3, f90-font-lock-4
146 ;; Original author's thanks
147 ;; Thanks to all the people who have tested the mode. Special thanks to Jens
148 ;; Bloch Helmers for encouraging me to write this code, for creative
149 ;; suggestions as well as for the lists of hpf-commands.
150 ;; Also thanks to the authors of the fortran and pascal modes, on which some
151 ;; of this code is built.
156 ;; Support for align.
157 ;; OpenMP, preprocessor highlighting.
159 (defvar comment-auto-fill-only-comments)
160 (defvar font-lock-keywords)
165 "Major mode for editing free format Fortran 90,95 code."
168 (defgroup f90-indent nil
169 "Indentation in free format Fortran."
174 (defcustom f90-do-indent 3
175 "*Extra indentation applied to DO blocks."
179 (defcustom f90-if-indent 3
180 "*Extra indentation applied to IF, SELECT CASE, WHERE and FORALL blocks."
184 (defcustom f90-type-indent 3
185 "*Extra indentation applied to TYPE, INTERFACE and BLOCK DATA blocks."
189 (defcustom f90-program-indent 2
190 "*Extra indentation applied to PROGRAM, MODULE, SUBROUTINE, FUNCTION blocks."
194 (defcustom f90-continuation-indent 5
195 "*Extra indentation applied to continuation lines."
199 (defcustom f90-comment-region "!!$"
200 "*String inserted by \\[f90-comment-region] at start of each line in region."
204 (defcustom f90-indented-comment-re "!"
205 "*Regexp matching comments to indent as code."
209 (defcustom f90-directive-comment-re "!hpf\\$"
210 "*Regexp of comment-like directive like \"!HPF\\\\$\", not to be indented."
214 (defcustom f90-beginning-ampersand t
215 "*Non-nil gives automatic insertion of \& at start of continuation line."
219 (defcustom f90-smart-end 'blink
220 "*From an END statement, check and fill the end using matching block start.
221 Allowed values are 'blink, 'no-blink, and nil, which determine
222 whether to blink the matching beginning."
223 :type '(choice (const blink) (const no-blink) (const nil))
226 (defcustom f90-break-delimiters "[-+\\*/><=,% \t]"
227 "*Regexp matching delimiter characters at which lines may be broken.
228 There are certain tokens comprised entirely of characters
229 matching this regexp that should not be split, and these are
230 specified by the constant `f90-no-break-re'."
234 (defcustom f90-break-before-delimiters t
235 "*Non-nil causes `f90-do-auto-fill' to break lines before delimiters."
239 (defcustom f90-auto-keyword-case nil
240 "*Automatic case conversion of keywords.
241 The options are 'downcase-word, 'upcase-word, 'capitalize-word and nil."
242 :type '(choice (const downcase-word) (const upcase-word)
243 (const capitalize-word) (const nil))
246 (defcustom f90-leave-line-no nil
247 "*If non-nil, line numbers are not left justified."
251 (defcustom f90-mode-hook nil
252 "Hook run when entering F90 mode."
254 :options '(f90-add-imenu-menu)
257 ;; User options end here.
259 (defconst f90-keywords-re
260 (regexp-opt '("allocatable" "allocate" "assign" "assignment" "backspace"
261 "block" "call" "case" "character" "close" "common" "complex"
262 "contains" "continue" "cycle" "data" "deallocate"
263 "dimension" "do" "double" "else" "elseif" "elsewhere" "end"
264 "enddo" "endfile" "endif" "entry" "equivalence" "exit"
265 "external" "forall" "format" "function" "goto" "if"
266 "implicit" "include" "inquire" "integer" "intent"
267 "interface" "intrinsic" "logical" "module" "namelist" "none"
268 "nullify" "only" "open" "operator" "optional" "parameter"
269 "pause" "pointer" "precision" "print" "private" "procedure"
270 "program" "public" "read" "real" "recursive" "result" "return"
271 "rewind" "save" "select" "sequence" "stop" "subroutine"
272 "target" "then" "type" "use" "where" "while" "write"
274 "elemental" "pure") 'words)
275 "Regexp for F90 keywords.")
277 (defconst f90-keywords-level-3-re
279 '("allocatable" "allocate" "assign" "assignment" "backspace"
280 "close" "deallocate" "dimension" "endfile" "entry" "equivalence"
281 "external" "inquire" "intent" "intrinsic" "nullify" "only" "open"
282 "operator" "optional" "parameter" "pause" "pointer" "print" "private"
283 "public" "read" "recursive" "result" "rewind" "save" "select"
284 "sequence" "target" "write"
286 "elemental" "pure") 'words)
287 "Keyword-regexp for font-lock level >= 3.")
289 (defconst f90-procedures-re
292 '("abs" "achar" "acos" "adjustl" "adjustr" "aimag" "aint"
293 "all" "allocated" "anint" "any" "asin" "associated"
294 "atan" "atan2" "bit_size" "btest" "ceiling" "char" "cmplx"
295 "conjg" "cos" "cosh" "count" "cshift" "date_and_time" "dble"
296 "digits" "dim" "dot_product" "dprod" "eoshift" "epsilon"
297 "exp" "exponent" "floor" "fraction" "huge" "iachar" "iand"
298 "ibclr" "ibits" "ibset" "ichar" "ieor" "index" "int" "ior"
299 "ishft" "ishftc" "kind" "lbound" "len" "len_trim" "lge" "lgt"
300 "lle" "llt" "log" "log10" "logical" "matmul" "max"
301 "maxexponent" "maxloc" "maxval" "merge" "min" "minexponent"
302 "minloc" "minval" "mod" "modulo" "mvbits" "nearest" "nint"
303 "not" "pack" "precision" "present" "product" "radix"
304 ;; Real is taken out here to avoid highlighting declarations.
305 "random_number" "random_seed" "range" ;; "real"
306 "repeat" "reshape" "rrspacing" "scale" "scan"
307 "selected_int_kind" "selected_real_kind" "set_exponent"
308 "shape" "sign" "sin" "sinh" "size" "spacing" "spread" "sqrt"
309 "sum" "system_clock" "tan" "tanh" "tiny" "transfer"
310 "transpose" "trim" "ubound" "unpack" "verify"
311 ;; F95 intrinsic functions.
312 "null" "cpu_time") t)
313 ;; A left parenthesis to avoid highlighting non-procedures.
315 "Regexp whose first part matches F90 intrinsic procedures.")
317 (defconst f90-operators-re
319 (regexp-opt '("and" "eq" "eqv" "false" "ge" "gt" "le" "lt" "ne"
320 "neqv" "not" "or" "true") t)
322 "Regexp matching intrinsic operators.")
324 (defconst f90-hpf-keywords-re
326 ;; Intrinsic procedures.
327 '("all_prefix" "all_scatter" "all_suffix" "any_prefix"
328 "any_scatter" "any_suffix" "copy_prefix" "copy_scatter"
329 "copy_suffix" "count_prefix" "count_scatter" "count_suffix"
330 "grade_down" "grade_up"
331 "hpf_alignment" "hpf_distribution" "hpf_template" "iall" "iall_prefix"
332 "iall_scatter" "iall_suffix" "iany" "iany_prefix" "iany_scatter"
333 "iany_suffix" "ilen" "iparity" "iparity_prefix"
334 "iparity_scatter" "iparity_suffix" "leadz" "maxval_prefix"
335 "maxval_scatter" "maxval_suffix" "minval_prefix" "minval_scatter"
336 "minval_suffix" "number_of_processors" "parity"
337 "parity_prefix" "parity_scatter" "parity_suffix" "popcnt" "poppar"
338 "processors_shape" "product_prefix" "product_scatter"
339 "product_suffix" "sum_prefix" "sum_scatter" "sum_suffix"
341 "align" "distribute" "dynamic" "independent" "inherit" "processors"
342 "realign" "redistribute" "template"
344 "block" "cyclic" "extrinsic" "new" "onto" "pure" "with") 'words)
345 "Regexp for all HPF keywords, procedures and directives.")
347 ;; Highlighting patterns.
349 (defvar f90-font-lock-keywords-1
351 ;; Special highlighting of "module procedure".
352 '("\\<\\(module[ \t]*procedure\\)\\>" (1 font-lock-keyword-face))
353 ;; Highlight definition of derived type.
354 '("\\<\\(\\(?:end[ \t]*\\)?type\\)\\>\\([^()\n]*::\\)?[ \t]*\\(\\sw+\\)"
355 (1 font-lock-keyword-face) (3 font-lock-function-name-face))
356 ;; Other functions and declarations.
357 '("\\<\\(\\(?:end[ \t]*\\)?\\(program\\|module\\|function\\|\
358 subroutine\\)\\|use\\|call\\)\\>[ \t]*\\(\\sw+\\)?"
359 (1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
360 "\\<\\(\\(end[ \t]*\\)?\\(interface\\|block[ \t]*data\\)\\|contains\\)\\>")
361 "This does fairly subdued highlighting of comments and function calls.")
363 (defvar f90-font-lock-keywords-2
365 f90-font-lock-keywords-1
367 ;; Variable declarations (avoid the real function call).
368 '("^[ \t0-9]*\\(real\\|integer\\|c\\(haracter\\|omplex\\)\\|\
369 logical\\|type[ \t]*(\\sw+)\\)\\(.*::\\|[ \t]*(.*)\\)?\\([^&!\n]*\\)"
370 (1 font-lock-type-face t) (4 font-lock-variable-name-face t))
371 ;; do, if, select, where, and forall constructs.
372 '("\\<\\(end[ \t]*\\(do\\|if\\|select\\|forall\\|where\\)\\)\\>\
373 \\([ \t]+\\(\\sw+\\)\\)?"
374 (1 font-lock-keyword-face) (3 font-lock-constant-face nil t))
375 '("^[ \t0-9]*\\(\\(\\sw+\\)[ \t]*:[ \t]*\\)?\\(\\(if\\|\
376 do\\([ \t]*while\\)?\\|select[ \t]*case\\|where\\|forall\\)\\)\\>"
377 (2 font-lock-constant-face nil t) (3 font-lock-keyword-face))
378 ;; Implicit declaration.
379 '("\\<\\(implicit\\)[ \t]*\\(real\\|integer\\|c\\(haracter\\|omplex\\)\
380 \\|logical\\|type[ \t]*(\\sw+)\\|none\\)[ \t]*"
381 (1 font-lock-keyword-face) (2 font-lock-type-face))
382 '("\\<\\(namelist\\|common\\)[ \t]*\/\\(\\sw+\\)?\/"
383 (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
384 "\\<else\\([ \t]*if\\|where\\)?\\>"
385 '("\\(&\\)[ \t]*\\(!\\|$\\)" (1 font-lock-keyword-face))
386 "\\<\\(then\\|continue\\|format\\|include\\|stop\\|return\\)\\>"
387 '("\\<\\(exit\\|cycle\\)[ \t]*\\(\\sw+\\)?\\>"
388 (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
389 '("\\<\\(case\\)[ \t]*\\(default\\|(\\)" . 1)
390 '("\\<\\(do\\|go *to\\)\\>[ \t]*\\([0-9]+\\)"
391 (1 font-lock-keyword-face) (2 font-lock-constant-face))
392 ;; Line numbers (lines whose first character after number is letter).
393 '("^[ \t]*\\([0-9]+\\)[ \t]*[a-z]+" (1 font-lock-constant-face t))))
394 "Highlights declarations, do-loops and other constructs.")
396 (defvar f90-font-lock-keywords-3
397 (append f90-font-lock-keywords-2
399 f90-keywords-level-3-re
401 (list f90-procedures-re '(1 font-lock-keyword-face keep))
402 "\\<real\\>" ; avoid overwriting real defs
404 "Highlights all F90 keywords and intrinsic procedures.")
406 (defvar f90-font-lock-keywords-4
407 (append f90-font-lock-keywords-3
408 (list f90-hpf-keywords-re))
409 "Highlights all F90 and HPF keywords.")
411 (defvar f90-font-lock-keywords
412 f90-font-lock-keywords-2
413 "*Default expressions to highlight in F90 mode.
414 Can be overridden by the value of `font-lock-maximum-decoration'.")
417 (defvar f90-mode-syntax-table
418 (let ((table (make-syntax-table)))
419 (modify-syntax-entry ?\! "<" table) ; begin comment
420 (modify-syntax-entry ?\n ">" table) ; end comment
421 (modify-syntax-entry ?_ "w" table) ; underscore in names
422 (modify-syntax-entry ?\' "\"" table) ; string quote
423 (modify-syntax-entry ?\" "\"" table) ; string quote
424 (modify-syntax-entry ?\` "w" table) ; for abbrevs
425 (modify-syntax-entry ?\r " " table) ; return is whitespace
426 (modify-syntax-entry ?+ "." table) ; punctuation
427 (modify-syntax-entry ?- "." table)
428 (modify-syntax-entry ?= "." table)
429 (modify-syntax-entry ?* "." table)
430 (modify-syntax-entry ?/ "." table)
431 (modify-syntax-entry ?\\ "\\" table) ; escape chars
433 "Syntax table used in F90 mode.")
436 (let ((map (make-sparse-keymap)))
437 (define-key map "`" 'f90-abbrev-start)
438 (define-key map "\C-c;" 'f90-comment-region)
439 (define-key map "\C-\M-a" 'f90-beginning-of-subprogram)
440 (define-key map "\C-\M-e" 'f90-end-of-subprogram)
441 (define-key map "\C-\M-h" 'f90-mark-subprogram)
442 (define-key map "\C-\M-n" 'f90-end-of-block)
443 (define-key map "\C-\M-p" 'f90-beginning-of-block)
444 (define-key map "\C-\M-q" 'f90-indent-subprogram)
445 (define-key map "\C-j" 'f90-indent-new-line) ; LFD equals C-j
446 (define-key map "\r" 'newline)
447 (define-key map "\C-c\r" 'f90-break-line)
448 ;;; (define-key map [M-return] 'f90-break-line)
449 (define-key map "\C-c\C-a" 'f90-previous-block)
450 (define-key map "\C-c\C-e" 'f90-next-block)
451 (define-key map "\C-c\C-d" 'f90-join-lines)
452 (define-key map "\C-c\C-f" 'f90-fill-region)
453 (define-key map "\C-c\C-p" 'f90-previous-statement)
454 (define-key map "\C-c\C-n" 'f90-next-statement)
455 (define-key map "\C-c\C-w" 'f90-insert-end)
456 (define-key map "\t" 'f90-indent-line)
457 (define-key map "," 'f90-electric-insert)
458 (define-key map "+" 'f90-electric-insert)
459 (define-key map "-" 'f90-electric-insert)
460 (define-key map "*" 'f90-electric-insert)
461 (define-key map "/" 'f90-electric-insert)
463 (easy-menu-define f90-menu map "Menu for F90 mode."
466 ,(custom-menu-create 'f90)
468 ["Save" Custom-save t]
469 ["Reset to Current" Custom-reset-current t]
470 ["Reset to Saved" Custom-reset-saved t]
471 ["Reset to Standard Settings" Custom-reset-standard t]
474 ["Indent Subprogram" f90-indent-subprogram t]
475 ["Mark Subprogram" f90-mark-subprogram t]
476 ["Beginning of Subprogram" f90-beginning-of-subprogram t]
477 ["End of Subprogram" f90-end-of-subprogram t]
479 ["(Un)Comment Region" f90-comment-region mark-active]
480 ["Indent Region" f90-indent-region mark-active]
481 ["Fill Region" f90-fill-region mark-active]
483 ["Break Line at Point" f90-break-line t]
484 ["Join with Previous Line" f90-join-lines t]
485 ["Insert Block End" f90-insert-end t]
488 ["Toggle font-lock-mode" font-lock-mode :selected font-lock-mode
491 ["Light highlighting (level 1)" f90-font-lock-1 t]
492 ["Moderate highlighting (level 2)" f90-font-lock-2 t]
493 ["Heavy highlighting (level 3)" f90-font-lock-3 t]
494 ["Maximum highlighting (level 4)" f90-font-lock-4 t]
496 ("Change Keyword Case"
497 ["Upcase Keywords (buffer)" f90-upcase-keywords t]
498 ["Capitalize Keywords (buffer)" f90-capitalize-keywords t]
499 ["Downcase Keywords (buffer)" f90-downcase-keywords t]
501 ["Upcase Keywords (region)" f90-upcase-region-keywords
503 ["Capitalize Keywords (region)" f90-capitalize-region-keywords
505 ["Downcase Keywords (region)" f90-downcase-region-keywords
509 ["Toggle auto-fill" auto-fill-mode :selected auto-fill-function
511 ["Toggle abbrev-mode" abbrev-mode :selected abbrev-mode
513 ["Add imenu Menu" f90-add-imenu-menu
514 :active (not (lookup-key (current-local-map) [menu-bar index]))
515 :included (fboundp 'imenu-add-to-menubar)]))
517 "Keymap used in F90 mode.")
520 (defun f90-font-lock-1 ()
521 "Set `font-lock-keywords' to `f90-font-lock-keywords-1'."
524 (setq font-lock-keywords f90-font-lock-keywords-1)
525 (font-lock-fontify-buffer))
527 (defun f90-font-lock-2 ()
528 "Set `font-lock-keywords' to `f90-font-lock-keywords-2'."
531 (setq font-lock-keywords f90-font-lock-keywords-2)
532 (font-lock-fontify-buffer))
534 (defun f90-font-lock-3 ()
535 "Set `font-lock-keywords' to `f90-font-lock-keywords-3'."
538 (setq font-lock-keywords f90-font-lock-keywords-3)
539 (font-lock-fontify-buffer))
541 (defun f90-font-lock-4 ()
542 "Set `font-lock-keywords' to `f90-font-lock-keywords-4'."
545 (setq font-lock-keywords f90-font-lock-keywords-4)
546 (font-lock-fontify-buffer))
549 ;; Regexps for finding program structures.
550 (defconst f90-blocks-re
551 (concat "\\(block[ \t]*data\\|"
552 (regexp-opt '("do" "if" "interface" "function" "module" "program"
553 "select" "subroutine" "type" "where" "forall"))
555 "Regexp potentially indicating a \"block\" of F90 code.")
557 (defconst f90-program-block-re
558 (regexp-opt '("program" "module" "subroutine" "function") 'paren)
559 "Regexp used to locate the start/end of a \"subprogram\".")
561 (defconst f90-else-like-re
562 "\\(else\\([ \t]*if\\|where\\)?\\|case[ \t]*\\(default\\|(\\)\\)"
563 "Regexp matching an ELSE IF, ELSEWHERE, CASE statement.")
565 (defconst f90-end-if-re
567 (regexp-opt '("if" "select" "where" "forall") 'paren)
569 "Regexp matching the end of an IF, SELECT, WHERE, FORALL block.")
571 (defconst f90-end-type-re
572 "end[ \t]*\\(type\\|interface\\|block[ \t]*data\\)\\>"
573 "Regexp matching the end of a TYPE, INTERFACE, BLOCK DATA section.")
575 (defconst f90-type-def-re
576 "\\<\\(type\\)\\>\\(?:[^()\n]*::\\)?[ \t]*\\(\\sw+\\)"
577 "Regexp matching the definition of a derived type.")
579 (defconst f90-no-break-re
580 (regexp-opt '("**" "//" "=>" ">=" "<=" "==" "/=") 'paren)
581 "Regexp specifying where not to break lines when filling.
582 This regexp matches certain tokens comprised entirely of
583 characters matching the regexp `f90-break-delimiters' that should
584 not be split by filling. Each element is assumed to be two
587 (defvar f90-cache-position nil
588 "Temporary position used to speed up region operations.")
589 (make-variable-buffer-local 'f90-cache-position)
593 (defconst f90-end-block-re
594 (concat "^[ \t0-9]*\\<end\\>[ \t]*"
595 (regexp-opt '("do" "if" "forall" "function" "interface"
596 "module" "program" "select" "subroutine"
599 "Regexp matching the end of a \"block\" of F90 code.
600 Used in the F90 entry in `hs-special-modes-alist'.")
602 ;; Ignore the fact that FUNCTION, SUBROUTINE, WHERE, FORALL have a
603 ;; following "(". DO, CASE, IF can have labels; IF must be
604 ;; accompanied by THEN.
605 ;; A big problem is that many of these statements can be broken over
606 ;; lines, even with embedded comments. We only try to handle this for
607 ;; IF ... THEN statements, assuming and hoping it will be less common
608 ;; for other constructs. We match up to one new-line, provided ")
609 ;; THEN" appears on one line. Matching on just ") THEN" is no good,
610 ;; since that includes ELSE branches.
611 ;; For a fully accurate solution, hideshow would probably have to be
612 ;; modified to allow functions as well as regexps to be used to
613 ;; specify block start and end positions.
614 (defconst f90-start-block-re
616 "^[ \t0-9]*" ; statement number
618 "\\(\\sw+[ \t]*:[ \t]*\\)?" ; structure label
619 "\\(do\\|select[ \t]*case\\|if[ \t]*(.*\n?.*)[ \t]*then\\|"
620 ;; Distinguish WHERE block from isolated WHERE.
621 "\\(where\\|forall\\)[ \t]*(.*)[ \t]*\\(!\\|$\\)\\)\\)"
623 "program\\|interface\\|module\\|type\\|function\\|subroutine"
624 ;; ") THEN" at line end. Problem - also does ELSE.
625 ;;; "\\|.*)[ \t]*then[ \t]*\\($\\|!\\)"
628 "Regexp matching the start of a \"block\" of F90 code.
629 A simple regexp cannot do this in fully correct fashion, so this
630 tries to strike a compromise between complexity and flexibility.
631 Used in the F90 entry in `hs-special-modes-alist'.")
633 ;; hs-special-modes-alist is autoloaded.
634 (add-to-list 'hs-special-modes-alist
635 `(f90-mode ,f90-start-block-re ,f90-end-block-re
636 "!" f90-end-of-block nil))
640 (defvar f90-imenu-generic-expression
641 (let ((good-char "[^!\"\&\n \t]") (not-e "[^e!\n\"\& \t]")
642 (not-n "[^n!\n\"\& \t]") (not-d "[^d!\n\"\& \t]"))
644 '(nil "^[ \t0-9]*program[ \t]+\\(\\sw+\\)" 1)
645 '("Modules" "^[ \t0-9]*module[ \t]+\\(\\sw+\\)[ \t]*\\(!\\|$\\)" 1)
646 '("Types" "^[ \t0-9]*type[ \t]+\\(\\sw+\\)" 1)
652 ;; At least three non-space characters before function/subroutine.
653 ;; Check that the last three non-space characters do not spell E N D.
655 not-e good-char good-char "\\|"
656 good-char not-n good-char "\\|"
657 good-char good-char not-d "\\)"
659 ;; Less than three non-space characters before function/subroutine.
660 good-char "?" good-char "?"
662 "[ \t]*\\(function\\|subroutine\\)[ \t]+\\(\\sw+\\)")
664 "Value for `imenu-generic-expression' in F90 mode.")
666 (defun f90-add-imenu-menu ()
667 "Add an imenu menu to the menubar."
669 (if (lookup-key (current-local-map) [menu-bar index])
670 (message "%s" "F90-imenu already exists.")
671 (imenu-add-to-menubar "F90-imenu")
672 (redraw-frame (selected-frame))))
675 ;; Abbrevs have generally two letters, except standard types `c, `i, `r, `t.
676 (defvar f90-mode-abbrev-table
677 (let (abbrevs-changed)
678 (define-abbrev-table 'f90-mode-abbrev-table nil)
679 ;; Use the 6th arg (SYSTEM-FLAG) of define-abbrev if possible.
680 ;; A little baroque to quieten the byte-compiler.
682 (function (lambda (element)
684 (apply 'define-abbrev f90-mode-abbrev-table
685 (append element '(nil 0 t)))
686 (wrong-number-of-arguments
687 (apply 'define-abbrev f90-mode-abbrev-table
688 (append element '(nil 0)))))))
689 '(("`al" "allocate" )
690 ("`ab" "allocatable" )
691 ("`as" "assignment" )
693 ("`bd" "block data" )
700 ("`de" "deallocate" )
706 ("`elw" "elsewhere" )
707 ("`eq" "equivalence" )
714 ("`im" "implicit none")
736 ("`su" "subroutine" )
742 f90-mode-abbrev-table)
743 "Abbrev table for F90 mode.")
748 "Major mode for editing Fortran 90,95 code in free format.
749 For fixed format code, use `fortran-mode'.
751 \\[f90-indent-line] indents the current line.
752 \\[f90-indent-new-line] indents current line and creates a new\
754 \\[f90-indent-subprogram] indents the current subprogram.
756 Type `? or `\\[help-command] to display a list of built-in\
757 abbrevs for F90 keywords.
762 Variables controlling indentation style and extra features:
765 Extra indentation within do blocks (default 3).
767 Extra indentation within if/select case/where/forall blocks (default 3).
769 Extra indentation within type/interface/block-data blocks (default 3).
771 Extra indentation within program/module/subroutine/function blocks
773 `f90-continuation-indent'
774 Extra indentation applied to continuation lines (default 5).
776 String inserted by function \\[f90-comment-region] at start of each
777 line in region (default \"!!!$\").
778 `f90-indented-comment-re'
779 Regexp determining the type of comment to be intended like code
781 `f90-directive-comment-re'
782 Regexp of comment-like directive like \"!HPF\\\\$\", not to be indented
783 (default \"!hpf\\\\$\").
784 `f90-break-delimiters'
785 Regexp holding list of delimiters at which lines may be broken
786 (default \"[-+*/><=,% \\t]\").
787 `f90-break-before-delimiters'
788 Non-nil causes `f90-do-auto-fill' to break lines before delimiters
790 `f90-beginning-ampersand'
791 Automatic insertion of \& at beginning of continuation lines (default t).
793 From an END statement, check and fill the end using matching block start.
794 Allowed values are 'blink, 'no-blink, and nil, which determine
795 whether to blink the matching beginning (default 'blink).
796 `f90-auto-keyword-case'
797 Automatic change of case of keywords (default nil).
798 The possibilities are 'downcase-word, 'upcase-word, 'capitalize-word.
800 Do not left-justify line numbers (default nil).
802 List of keywords used for highlighting/upcase-keywords etc.
804 Turning on F90 mode calls the value of the variable `f90-mode-hook'
805 with no args, if that value is non-nil."
807 (kill-all-local-variables)
808 (setq major-mode 'f90-mode
810 local-abbrev-table f90-mode-abbrev-table)
811 (set-syntax-table f90-mode-syntax-table)
812 (use-local-map f90-mode-map)
813 (set (make-local-variable 'indent-line-function) 'f90-indent-line)
814 (set (make-local-variable 'indent-region-function) 'f90-indent-region)
815 (set (make-local-variable 'require-final-newline) t)
816 (set (make-local-variable 'comment-start) "!")
817 (set (make-local-variable 'comment-start-skip) "!+ *")
818 (set (make-local-variable 'comment-indent-function) 'f90-comment-indent)
819 (set (make-local-variable 'abbrev-all-caps) t)
820 (set (make-local-variable 'normal-auto-fill-function) 'f90-do-auto-fill)
821 (setq indent-tabs-mode nil) ; auto buffer local
822 (set (make-local-variable 'font-lock-defaults)
823 '((f90-font-lock-keywords f90-font-lock-keywords-1
824 f90-font-lock-keywords-2
825 f90-font-lock-keywords-3
826 f90-font-lock-keywords-4)
828 (set (make-local-variable 'imenu-case-fold-search) t)
829 (set (make-local-variable 'imenu-generic-expression)
830 f90-imenu-generic-expression)
831 (set (make-local-variable 'beginning-of-defun-function)
832 'f90-beginning-of-subprogram)
833 (set (make-local-variable 'end-of-defun-function) 'f90-end-of-subprogram)
834 (set (make-local-variable 'add-log-current-defun-function)
836 (run-hooks 'f90-mode-hook))
840 (defsubst f90-in-string ()
841 "Return non-nil if point is inside a string.
842 Checks from `point-min', or `f90-cache-position', if that is non-nil
843 and lies before point."
845 (if (and f90-cache-position (> (point) f90-cache-position))
848 (nth 3 (parse-partial-sexp beg-pnt (point)))))
850 (defsubst f90-in-comment ()
851 "Return non-nil if point is inside a comment.
852 Checks from `point-min', or `f90-cache-position', if that is non-nil
853 and lies before point."
855 (if (and f90-cache-position (> (point) f90-cache-position))
858 (nth 4 (parse-partial-sexp beg-pnt (point)))))
860 (defsubst f90-line-continued ()
861 "Return t if the current line is a continued one.
862 This includes comment lines embedded in continued lines, but
863 not the last line of a continued statement."
866 (while (and (looking-at "[ \t]*\\(!\\|$\\)") (zerop (forward-line -1))))
868 (while (f90-in-comment)
869 (search-backward "!" (line-beginning-position))
870 (skip-chars-backward "!"))
871 (skip-chars-backward " \t")
872 (= (preceding-char) ?&)))
874 ;; GM this is not right, eg a continuation line starting with a number.
875 ;; Need f90-code-start-position function.
876 ;; And yet, things seems to work with this...
877 ;; cf f90-indent-line
878 ;; (beginning-of-line) ; digits after & \n are not line-nos
879 ;; (if (not (save-excursion (and (f90-previous-statement)
880 ;; (f90-line-continued))))
881 ;; (f90-indent-line-no)
882 (defsubst f90-current-indentation ()
883 "Return indentation of current line.
884 Line-numbers are considered whitespace characters."
885 (save-excursion (beginning-of-line) (skip-chars-forward " \t0-9")))
887 (defsubst f90-indent-to (col &optional no-line-number)
888 "Indent current line to column COL.
889 If optional argument NO-LINE-NUMBER is nil, jump over a possible
890 line-number before indenting."
893 (skip-chars-forward " \t0-9"))
894 (delete-horizontal-space)
895 ;; Leave >= 1 space after line number.
896 (indent-to col (if (zerop (current-column)) 0 1)))
898 (defsubst f90-get-present-comment-type ()
899 "If point lies within a comment, return the string starting the comment.
900 For example, \"!\" or \"!!\", followed by the appropriate amount of
902 ;; Include the whitespace for consistent auto-filling of comment blocks.
904 (when (f90-in-comment)
906 (re-search-forward "!+[ \t]*" (line-end-position))
907 (while (f90-in-string)
908 (re-search-forward "!+[ \t]*" (line-end-position)))
909 (match-string-no-properties 0))))
911 (defsubst f90-equal-symbols (a b)
912 "Compare strings A and B neglecting case and allowing for nil value."
913 (equal (if a (downcase a) nil)
914 (if b (downcase b) nil)))
916 (defsubst f90-looking-at-do ()
917 "Return (\"do\" NAME) if a do statement starts after point.
918 NAME is nil if the statement has no label."
919 (if (looking-at "\\(\\(\\sw+\\)[ \t]*:\\)?[ \t]*\\(do\\)\\>")
920 (list (match-string 3) (match-string 2))))
922 (defsubst f90-looking-at-select-case ()
923 "Return (\"select\" NAME) if a select-case statement starts after point.
924 NAME is nil if the statement has no label."
925 (if (looking-at "\\(\\(\\sw+\\)[ \t]*:\\)?[ \t]*\
926 \\(select\\)[ \t]*case[ \t]*(")
927 (list (match-string 3) (match-string 2))))
929 (defsubst f90-looking-at-if-then ()
930 "Return (\"if\" NAME) if an if () then statement starts after point.
931 NAME is nil if the statement has no label."
933 (when (looking-at "\\(\\(\\sw+\\)[ \t]*:\\)?[ \t]*\\(if\\)\\>")
934 (let ((struct (match-string 3))
935 (label (match-string 2))
936 (pos (scan-lists (point) 1 0)))
937 (and pos (goto-char pos))
938 (skip-chars-forward " \t")
939 (if (or (looking-at "then\\>")
940 (when (f90-line-continued)
942 (skip-chars-forward " \t0-9&")
943 (looking-at "then\\>")))
944 (list struct label))))))
946 (defsubst f90-looking-at-where-or-forall ()
947 "Return (KIND NAME) if a where or forall block starts after point.
948 NAME is nil if the statement has no label."
950 (when (looking-at "\\(\\(\\sw+\\)[ \t]*:\\)?[ \t]*\
951 \\(where\\|forall\\)\\>")
952 (let ((struct (match-string 3))
953 (label (match-string 2))
954 (pos (scan-lists (point) 1 0)))
955 (and pos (goto-char pos))
956 (skip-chars-forward " \t")
957 (if (looking-at "\\(!\\|$\\)") (list struct label))))))
959 (defsubst f90-looking-at-type-like ()
960 "Return (KIND NAME) if a type/interface/block-data block starts after point.
961 NAME is non-nil only for type."
963 ((looking-at f90-type-def-re)
964 (list (match-string 1) (match-string 2)))
965 ((looking-at "\\(interface\\|block[\t]*data\\)\\>")
966 (list (match-string 1) nil))))
968 (defsubst f90-looking-at-program-block-start ()
969 "Return (KIND NAME) if a program block with name NAME starts after point."
971 ((looking-at "\\(program\\)[ \t]+\\(\\sw+\\)\\>")
972 (list (match-string 1) (match-string 2)))
973 ((and (not (looking-at "module[ \t]*procedure\\>"))
974 (looking-at "\\(module\\)[ \t]+\\(\\sw+\\)\\>"))
975 (list (match-string 1) (match-string 2)))
976 ((and (not (looking-at "end[ \t]*\\(function\\|subroutine\\)"))
977 (looking-at "[^!'\"\&\n]*\\(function\\|subroutine\\)[ \t]+\
979 (list (match-string 1) (match-string 2)))))
981 (defsubst f90-looking-at-program-block-end ()
982 "Return (KIND NAME) if a block with name NAME ends after point."
983 (if (looking-at (concat "end[ \t]*" f90-blocks-re
984 "?\\([ \t]+\\(\\sw+\\)\\)?\\>"))
985 (list (match-string 1) (match-string 3))))
987 (defsubst f90-comment-indent ()
988 "Return the indentation to be used for a comment starting at point.
989 Used for `comment-indent-function' by F90 mode.
990 \"!!!\", `f90-directive-comment-re', variable `f90-comment-region' return 0.
991 `f90-indented-comment-re' (if not trailing code) calls `f90-calculate-indent'.
992 All others return `comment-column', leaving at least one space after code."
993 (cond ((looking-at "!!!") 0)
994 ((and f90-directive-comment-re
995 (looking-at f90-directive-comment-re)) 0)
996 ((looking-at (regexp-quote f90-comment-region)) 0)
997 ((and (looking-at f90-indented-comment-re)
998 ;; Don't attempt to indent trailing comment as code.
1000 (skip-chars-backward " \t")
1002 (f90-calculate-indent))
1003 (t (skip-chars-backward " \t")
1004 (max (if (bolp) 0 (1+ (current-column))) comment-column))))
1006 (defsubst f90-present-statement-cont ()
1007 "Return continuation properties of present statement.
1008 Possible return values are:
1009 single - statement is not continued.
1010 begin - current line is the first in a continued statement.
1011 end - current line is the last in a continued statement
1012 middle - current line is neither first nor last in a continued statement.
1013 Comment lines embedded amongst continued lines return 'middle."
1016 (setq pcont (if (f90-previous-statement) (f90-line-continued))))
1017 (setq cont (f90-line-continued))
1018 (cond ((and (not pcont) (not cont)) 'single)
1019 ((and (not pcont) cont) 'begin)
1020 ((and pcont (not cont)) 'end)
1021 ((and pcont cont) 'middle)
1022 (t (error "The impossible occurred")))))
1024 (defsubst f90-indent-line-no ()
1025 "If `f90-leave-line-no' is nil, left-justify a line number.
1026 Leaves point at the first non-blank character after the line number.
1027 Call from beginning of line."
1028 (and (null f90-leave-line-no) (looking-at "[ \t]+[0-9]")
1029 (delete-horizontal-space))
1030 (skip-chars-forward " \t0-9"))
1032 (defsubst f90-no-block-limit ()
1033 "Return nil if point is at the edge of a code block.
1034 Searches line forward for \"function\" or \"subroutine\",
1037 (not (or (looking-at "end")
1038 (looking-at "\\(do\\|if\\|else\\(if\\|where\\)?\
1039 \\|select[ \t]*case\\|case\\|where\\|forall\\)\\>")
1040 (looking-at "\\(program\\|module\\|interface\\|\
1041 block[ \t]*data\\)\\>")
1042 (looking-at "\\(contains\\|\\sw+[ \t]*:\\)")
1043 (looking-at f90-type-def-re)
1044 (re-search-forward "\\(function\\|subroutine\\)"
1045 (line-end-position) t)))))
1047 (defsubst f90-update-line ()
1048 "Change case of current line as per `f90-auto-keyword-case'."
1049 (if f90-auto-keyword-case
1050 (f90-change-keywords f90-auto-keyword-case
1051 (line-beginning-position) (line-end-position))))
1053 (defun f90-electric-insert ()
1054 "Change keyword case and auto-fill line as operators are inserted."
1056 (self-insert-command 1)
1057 (if auto-fill-function (f90-do-auto-fill) ; also updates line
1061 (defun f90-get-correct-indent ()
1062 "Get correct indent for a line starting with line number.
1063 Does not check type and subprogram indentation."
1064 (let ((epnt (line-end-position)) icol cont)
1066 (while (and (f90-previous-statement)
1068 (setq cont (f90-present-statement-cont))
1069 (or (eq cont 'end) (eq cont 'middle)))
1070 (looking-at "[ \t]*[0-9]"))))
1071 (setq icol (current-indentation))
1073 (when (re-search-forward "\\(if\\|do\\|select\\|where\\|forall\\)"
1074 (line-end-position) t)
1076 (skip-chars-forward " \t")
1077 (cond ((f90-looking-at-do)
1078 (setq icol (+ icol f90-do-indent)))
1079 ((or (f90-looking-at-if-then)
1080 (f90-looking-at-where-or-forall)
1081 (f90-looking-at-select-case))
1082 (setq icol (+ icol f90-if-indent))))
1084 (while (re-search-forward
1085 "\\(if\\|do\\|select\\|where\\|forall\\)" epnt t)
1087 (skip-chars-forward " \t0-9")
1088 (cond ((f90-looking-at-do)
1089 (setq icol (+ icol f90-do-indent)))
1090 ((or (f90-looking-at-if-then)
1091 (f90-looking-at-where-or-forall)
1092 (f90-looking-at-select-case))
1093 (setq icol (+ icol f90-if-indent)))
1094 ((looking-at f90-end-if-re)
1095 (setq icol (- icol f90-if-indent)))
1096 ((looking-at "end[ \t]*do\\>")
1097 (setq icol (- icol f90-do-indent))))
1101 (defun f90-calculate-indent ()
1102 "Calculate the indent column based on previous statements."
1104 (let (icol cont (case-fold-search t) (pnt (point)))
1106 (if (not (f90-previous-statement))
1108 (setq cont (f90-present-statement-cont))
1110 (while (not (eq 'begin (f90-present-statement-cont)))
1111 (f90-previous-statement)))
1112 (cond ((eq cont 'begin)
1113 (setq icol (+ (f90-current-indentation)
1114 f90-continuation-indent)))
1115 ((eq cont 'middle) (setq icol (current-indentation)))
1116 (t (setq icol (f90-current-indentation))
1117 (skip-chars-forward " \t")
1118 (if (looking-at "[0-9]")
1119 (setq icol (f90-get-correct-indent))
1120 (cond ((or (f90-looking-at-if-then)
1121 (f90-looking-at-where-or-forall)
1122 (f90-looking-at-select-case)
1123 (looking-at f90-else-like-re))
1124 (setq icol (+ icol f90-if-indent)))
1125 ((f90-looking-at-do)
1126 (setq icol (+ icol f90-do-indent)))
1127 ((f90-looking-at-type-like)
1128 (setq icol (+ icol f90-type-indent)))
1129 ((or (f90-looking-at-program-block-start)
1130 (looking-at "contains[ \t]*\\($\\|!\\)"))
1131 (setq icol (+ icol f90-program-indent)))))
1134 (cond ((looking-at "[ \t]*$"))
1135 ((looking-at "[ \t]*#") ; check for cpp directive
1138 (skip-chars-forward " \t0-9")
1139 (cond ((or (looking-at f90-else-like-re)
1140 (looking-at f90-end-if-re))
1141 (setq icol (- icol f90-if-indent)))
1142 ((looking-at "end[ \t]*do\\>")
1143 (setq icol (- icol f90-do-indent)))
1144 ((looking-at f90-end-type-re)
1145 (setq icol (- icol f90-type-indent)))
1146 ((or (looking-at "contains[ \t]*\\(!\\|$\\)")
1147 (f90-looking-at-program-block-end))
1148 (setq icol (- icol f90-program-indent))))))
1152 (defun f90-previous-statement ()
1153 "Move point to beginning of the previous F90 statement.
1154 Return nil if no previous statement is found.
1155 A statement is a line which is neither blank nor a comment."
1157 (let (not-first-statement)
1159 (while (and (setq not-first-statement (zerop (forward-line -1)))
1160 (looking-at "[ \t0-9]*\\(!\\|$\\|#\\)")))
1161 not-first-statement))
1163 (defun f90-next-statement ()
1164 "Move point to beginning of the next F90 statement.
1165 Return nil if no later statement is found."
1167 (let (not-last-statement)
1169 (while (and (setq not-last-statement
1170 (and (zerop (forward-line 1))
1172 (looking-at "[ \t0-9]*\\(!\\|$\\)")))
1173 not-last-statement))
1175 (defun f90-beginning-of-subprogram ()
1176 "Move point to the beginning of the current subprogram.
1177 Return (TYPE NAME), or nil if not found."
1179 (let ((count 1) (case-fold-search t) matching-beg)
1181 (while (and (> count 0)
1182 (re-search-backward f90-program-block-re nil 'move))
1184 (skip-chars-forward " \t0-9")
1185 (cond ((setq matching-beg (f90-looking-at-program-block-start))
1186 (setq count (1- count)))
1187 ((f90-looking-at-program-block-end)
1188 (setq count (1+ count)))))
1192 (message "No beginning found.")
1195 (defun f90-end-of-subprogram ()
1196 "Move point to the end of the current subprogram.
1197 Return (TYPE NAME), or nil if not found."
1199 (let ((case-fold-search t)
1203 (while (and (> count 0)
1204 (re-search-forward f90-program-block-re nil 'move))
1206 (skip-chars-forward " \t0-9")
1207 (cond ((f90-looking-at-program-block-start)
1208 (setq count (1+ count)))
1209 ((setq matching-end (f90-looking-at-program-block-end))
1210 (setq count (1- count))))
1212 ;; This means f90-end-of-subprogram followed by f90-start-of-subprogram
1213 ;; has a net non-zero effect, which seems odd.
1214 ;;; (forward-line 1)
1217 (message "No end found.")
1221 (defun f90-end-of-block (&optional num)
1222 "Move point forward to the end of the current code block.
1223 With optional argument NUM, go forward that many balanced blocks.
1224 If NUM is negative, go backward to the start of a block.
1225 Checks for consistency of block types and labels (if present),
1226 and completes outermost block if necessary."
1228 (if (and num (< num 0)) (f90-beginning-of-block (- num)))
1229 (let ((f90-smart-end nil) ; for the final `f90-match-end'
1230 (case-fold-search t)
1232 start-list start-this start-type start-label end-type end-label)
1233 (if (interactive-p) (push-mark (point) t))
1234 (end-of-line) ; probably want this
1235 (while (and (> count 0) (re-search-forward f90-blocks-re nil 'move))
1237 (skip-chars-forward " \t0-9")
1238 (cond ((or (f90-in-string) (f90-in-comment)))
1242 (f90-looking-at-select-case)
1243 (f90-looking-at-type-like)
1244 (f90-looking-at-program-block-start)
1245 (f90-looking-at-if-then)
1246 (f90-looking-at-where-or-forall)))
1247 (setq start-list (cons start-this start-list) ; not add-to-list!
1249 ((looking-at (concat "end[ \t]*" f90-blocks-re
1250 "[ \t]*\\(\\sw+\\)?"))
1251 (setq end-type (match-string 1)
1252 end-label (match-string 2)
1254 ;; Check any internal blocks.
1256 (setq start-this (car start-list)
1257 start-list (cdr start-list)
1258 start-type (car start-this)
1259 start-label (cadr start-this))
1260 (or (f90-equal-symbols start-type end-type)
1261 (error "End type `%s' does not match start type `%s'"
1262 end-type start-type))
1263 (or (f90-equal-symbols start-label end-label)
1264 (error "End label `%s' does not match start label `%s'"
1265 end-label start-label)))))
1267 (if (> count 0) (error "Missing block end"))
1268 ;; Check outermost block.
1272 (skip-chars-forward " \t0-9")
1275 (defun f90-beginning-of-block (&optional num)
1276 "Move point backwards to the start of the current code block.
1277 With optional argument NUM, go backward that many balanced blocks.
1278 If NUM is negative, go forward to the end of a block.
1279 Checks for consistency of block types and labels (if present).
1280 Does not check the outermost block, because it may be incomplete."
1282 (if (and num (< num 0)) (f90-end-of-block (- num)))
1283 (let ((case-fold-search t)
1285 end-list end-this end-type end-label
1286 start-this start-type start-label)
1287 (if (interactive-p) (push-mark (point) t))
1288 (beginning-of-line) ; probably want this
1289 (while (and (> count 0) (re-search-backward f90-blocks-re nil 'move))
1291 (skip-chars-forward " \t0-9")
1292 (cond ((or (f90-in-string) (f90-in-comment)))
1293 ((looking-at (concat "end[ \t]*" f90-blocks-re
1294 "[ \t]*\\(\\sw+\\)?"))
1295 (setq end-list (cons (list (match-string 1) (match-string 2))
1301 (f90-looking-at-select-case)
1302 (f90-looking-at-type-like)
1303 (f90-looking-at-program-block-start)
1304 (f90-looking-at-if-then)
1305 (f90-looking-at-where-or-forall)))
1306 (setq start-type (car start-this)
1307 start-label (cadr start-this)
1309 ;; Check any internal blocks.
1311 (setq end-this (car end-list)
1312 end-list (cdr end-list)
1313 end-type (car end-this)
1314 end-label (cadr end-this))
1315 (or (f90-equal-symbols start-type end-type)
1316 (error "Start type `%s' does not match end type `%s'"
1317 start-type end-type))
1318 (or (f90-equal-symbols start-label end-label)
1319 (error "Start label `%s' does not match end label `%s'"
1320 start-label end-label))))))
1321 (if (> count 0) (error "Missing block start"))))
1323 (defun f90-next-block (&optional num)
1324 "Move point forward to the next end or start of a code block.
1325 With optional argument NUM, go forward that many blocks.
1326 If NUM is negative, go backwards.
1327 A block is a subroutine, if-endif, etc."
1329 (let ((case-fold-search t)
1330 (count (if num (abs num) 1)))
1331 (while (and (> count 0)
1332 (if (> num 0) (re-search-forward f90-blocks-re nil 'move)
1333 (re-search-backward f90-blocks-re nil 'move)))
1335 (skip-chars-forward " \t0-9")
1336 (cond ((or (f90-in-string) (f90-in-comment)))
1338 (looking-at "end[ \t]*")
1340 (f90-looking-at-select-case)
1341 (f90-looking-at-type-like)
1342 (f90-looking-at-program-block-start)
1343 (f90-looking-at-if-then)
1344 (f90-looking-at-where-or-forall))
1345 (setq count (1- count))))
1346 (if (> num 0) (end-of-line)
1347 (beginning-of-line)))))
1350 (defun f90-previous-block (&optional num)
1351 "Move point backward to the previous end or start of a code block.
1352 With optional argument NUM, go backward that many blocks.
1353 If NUM is negative, go forwards.
1354 A block is a subroutine, if-endif, etc."
1356 (f90-next-block (- (or num 1))))
1359 (defun f90-mark-subprogram ()
1360 "Put mark at end of F90 subprogram, point at beginning, push mark."
1362 (let ((pos (point)) program)
1363 (f90-end-of-subprogram)
1366 (setq program (f90-beginning-of-subprogram))
1367 (if (fboundp 'zmacs-activate-region)
1368 (zmacs-activate-region)
1370 deactivate-mark nil))
1373 (defun f90-comment-region (beg-region end-region)
1374 "Comment/uncomment every line in the region.
1375 Insert the variable `f90-comment-region' at the start of every line
1376 in the region, or, if already present, remove it."
1378 (let ((end (copy-marker end-region)))
1379 (goto-char beg-region)
1381 (if (looking-at (regexp-quote f90-comment-region))
1382 (delete-region (point) (match-end 0))
1383 (insert f90-comment-region))
1384 (while (and (zerop (forward-line 1))
1386 (if (looking-at (regexp-quote f90-comment-region))
1387 (delete-region (point) (match-end 0))
1388 (insert f90-comment-region)))
1389 (set-marker end nil)))
1391 (defun f90-indent-line (&optional no-update)
1392 "Indent current line as F90 code.
1393 Unless optional argument NO-UPDATE is non-nil, call `f90-update-line'
1396 (let ((case-fold-search t)
1397 (pos (point-marker))
1398 indent no-line-number)
1399 (beginning-of-line) ; digits after & \n are not line-nos
1400 (if (not (save-excursion (and (f90-previous-statement)
1401 (f90-line-continued))))
1402 (f90-indent-line-no)
1403 (setq no-line-number t)
1404 (skip-chars-forward " \t"))
1405 (if (looking-at "!")
1406 (setq indent (f90-comment-indent))
1407 (and f90-smart-end (looking-at "end")
1409 (setq indent (f90-calculate-indent)))
1410 (or (= indent (current-column))
1411 (f90-indent-to indent no-line-number))
1412 ;; If initial point was within line's indentation,
1413 ;; position after the indentation. Else stay at same point in text.
1414 (and (< (point) pos)
1416 (if auto-fill-function
1417 ;; GM NO-UPDATE not honoured, since this calls f90-update-line.
1419 (or no-update (f90-update-line)))
1420 (set-marker pos nil)))
1422 (defun f90-indent-new-line ()
1423 "Re-indent current line, insert a newline and indent the newline.
1424 An abbrev before point is expanded if the variable `abbrev-mode' is non-nil.
1425 If run in the middle of a line, the line is not broken."
1427 (if abbrev-mode (expand-abbrev))
1428 (beginning-of-line) ; reindent where likely to be needed
1429 (f90-indent-line) ; calls indent-line-no, update-line
1431 (delete-horizontal-space) ; destroy trailing whitespace
1432 (let ((string (f90-in-string))
1433 (cont (f90-line-continued)))
1434 (and string (not cont) (insert "&"))
1436 (if (or string (and cont f90-beginning-ampersand)) (insert "&")))
1437 (f90-indent-line 'no-update)) ; nothing to update
1440 (defun f90-indent-region (beg-region end-region)
1441 "Indent every line in region by forward parsing."
1443 (let ((end-region-mark (copy-marker end-region))
1444 (save-point (point-marker))
1445 block-list ind-lev ind-curr ind-b cont struct beg-struct end-struct)
1446 (goto-char beg-region)
1447 ;; First find a line which is not a continuation line or comment.
1449 (while (and (looking-at "[ \t]*[0-9]*\\(!\\|#\\|[ \t]*$\\)")
1450 (progn (f90-indent-line 'no-update)
1451 (zerop (forward-line 1)))
1452 (< (point) end-region-mark)))
1453 (setq cont (f90-present-statement-cont))
1454 (while (and (or (eq cont 'middle) (eq cont 'end))
1455 (f90-previous-statement))
1456 (setq cont (f90-present-statement-cont)))
1457 ;; Process present line for beginning of block.
1458 (setq f90-cache-position (point))
1459 (f90-indent-line 'no-update)
1460 (setq ind-lev (f90-current-indentation)
1463 (skip-chars-forward " \t0-9")
1465 ind-b (cond ((setq struct (f90-looking-at-do)) f90-do-indent)
1466 ((or (setq struct (f90-looking-at-if-then))
1467 (setq struct (f90-looking-at-select-case))
1468 (setq struct (f90-looking-at-where-or-forall))
1469 (looking-at f90-else-like-re))
1471 ((setq struct (f90-looking-at-type-like))
1473 ((or (setq struct (f90-looking-at-program-block-start))
1474 (looking-at "contains[ \t]*\\($\\|!\\)"))
1475 f90-program-indent)))
1476 (if ind-b (setq ind-lev (+ ind-lev ind-b)))
1477 (if struct (setq block-list (cons struct block-list)))
1478 (while (and (f90-line-continued) (zerop (forward-line 1))
1479 (< (point) end-region-mark))
1480 (if (looking-at "[ \t]*!")
1481 (f90-indent-to (f90-comment-indent))
1482 (or (= (current-indentation)
1483 (+ ind-curr f90-continuation-indent))
1484 (f90-indent-to (+ ind-curr f90-continuation-indent) 'no-line-no))))
1485 ;; Process all following lines.
1486 (while (and (zerop (forward-line 1)) (< (point) end-region-mark))
1488 (f90-indent-line-no)
1489 (setq f90-cache-position (point))
1490 (cond ((looking-at "[ \t]*$") (setq ind-curr 0))
1491 ((looking-at "[ \t]*#") (setq ind-curr 0))
1492 ((looking-at "!") (setq ind-curr (f90-comment-indent)))
1493 ((f90-no-block-limit) (setq ind-curr ind-lev))
1494 ((looking-at f90-else-like-re) (setq ind-curr
1495 (- ind-lev f90-if-indent)))
1496 ((looking-at "contains[ \t]*\\($\\|!\\)")
1497 (setq ind-curr (- ind-lev f90-program-indent)))
1499 (cond ((setq struct (f90-looking-at-do)) f90-do-indent)
1500 ((or (setq struct (f90-looking-at-if-then))
1501 (setq struct (f90-looking-at-select-case))
1502 (setq struct (f90-looking-at-where-or-forall)))
1504 ((setq struct (f90-looking-at-type-like))
1506 ((setq struct (f90-looking-at-program-block-start))
1507 f90-program-indent)))
1508 (setq ind-curr ind-lev)
1509 (if ind-b (setq ind-lev (+ ind-lev ind-b)))
1510 (setq block-list (cons struct block-list)))
1511 ((setq end-struct (f90-looking-at-program-block-end))
1512 (setq beg-struct (car block-list)
1513 block-list (cdr block-list))
1516 (f90-block-match (car beg-struct) (car (cdr beg-struct))
1517 (car end-struct) (car (cdr end-struct)))))
1519 (cond ((looking-at f90-end-if-re) f90-if-indent)
1520 ((looking-at "end[ \t]*do\\>") f90-do-indent)
1521 ((looking-at f90-end-type-re) f90-type-indent)
1522 ((f90-looking-at-program-block-end)
1523 f90-program-indent)))
1524 (if ind-b (setq ind-lev (- ind-lev ind-b)))
1525 (setq ind-curr ind-lev))
1526 (t (setq ind-curr ind-lev)))
1527 ;; Do the indentation if necessary.
1528 (or (= ind-curr (current-column))
1529 (f90-indent-to ind-curr))
1530 (while (and (f90-line-continued) (zerop (forward-line 1))
1531 (< (point) end-region-mark))
1532 (if (looking-at "[ \t]*!")
1533 (f90-indent-to (f90-comment-indent))
1534 (or (= (current-indentation)
1535 (+ ind-curr f90-continuation-indent))
1537 (+ ind-curr f90-continuation-indent) 'no-line-no)))))
1538 ;; Restore point, etc.
1539 (setq f90-cache-position nil)
1540 (goto-char save-point)
1541 (set-marker end-region-mark nil)
1542 (set-marker save-point nil)
1543 (if (fboundp 'zmacs-deactivate-region)
1544 (zmacs-deactivate-region)
1545 (deactivate-mark))))
1547 (defun f90-indent-subprogram ()
1548 "Properly indent the subprogram containing point."
1551 (let ((program (f90-mark-subprogram)))
1554 (message "Indenting %s %s..."
1555 (car program) (car (cdr program)))
1556 (indent-region (point) (mark) nil)
1557 (message "Indenting %s %s...done"
1558 (car program) (car (cdr program))))
1559 (message "Indenting the whole file...")
1560 (indent-region (point) (mark) nil)
1561 (message "Indenting the whole file...done")))))
1563 (defun f90-break-line (&optional no-update)
1564 "Break line at point, insert continuation marker(s) and indent.
1565 Unless in a string or comment, or if the optional argument NO-UPDATE
1566 is non-nil, call `f90-update-line' after inserting the continuation marker."
1568 (cond ((f90-in-string)
1571 (delete-horizontal-space 'backwards) ; remove trailing whitespace
1572 (insert "\n" (f90-get-present-comment-type)))
1574 (or no-update (f90-update-line))
1576 (if f90-beginning-ampersand (insert "&"))))
1577 (indent-according-to-mode))
1579 (defun f90-find-breakpoint ()
1580 "From `fill-column', search backward for break-delimiter."
1581 (re-search-backward f90-break-delimiters (line-beginning-position))
1582 (if (not f90-break-before-delimiters)
1583 (forward-char (if (looking-at f90-no-break-re) 2 1))
1585 (or (looking-at f90-no-break-re)
1588 (defun f90-do-auto-fill ()
1589 "Break line if non-white characters beyond `fill-column'.
1590 Update keyword case first."
1592 ;; Break line before or after last delimiter (non-word char) if
1593 ;; position is beyond fill-column.
1594 ;; Will not break **, //, or => (as specified by f90-no-break-re).
1596 ;; Need this for `f90-electric-insert' and other f90- callers.
1597 (unless (and (boundp 'comment-auto-fill-only-comments)
1598 comment-auto-fill-only-comments
1599 (not (f90-in-comment)))
1600 (while (> (current-column) fill-column)
1601 (let ((pos-mark (point-marker)))
1602 (move-to-column fill-column)
1603 (or (f90-in-string) (f90-find-breakpoint))
1605 (goto-char pos-mark)
1606 (set-marker pos-mark nil)))))
1608 (defun f90-join-lines (&optional arg)
1609 "Join current line to previous, fix whitespace, continuation, comments.
1610 With optional argument ARG, join current line to following line.
1611 Like `join-line', but handles F90 syntax."
1614 (if arg (forward-line 1))
1615 (when (eq (preceding-char) ?\n)
1616 (skip-chars-forward " \t")
1617 (if (looking-at "\&") (delete-char 1))
1619 (delete-region (point) (1- (point)))
1620 (skip-chars-backward " \t")
1621 (and (eq (preceding-char) ?&) (delete-char -1))
1622 (and (f90-in-comment)
1623 (looking-at "[ \t]*!+")
1626 (fixup-whitespace))))
1628 (defun f90-fill-region (beg-region end-region)
1629 "Fill every line in region by forward parsing. Join lines if possible."
1631 (let ((end-region-mark (copy-marker end-region))
1633 f90-smart-end f90-auto-keyword-case auto-fill-function)
1634 (goto-char beg-region)
1636 ;; Join as much as possible.
1639 (skip-chars-backward " \t")
1640 (eq (preceding-char) ?&))
1641 (f90-join-lines 'forward))
1642 ;; Chop the line if necessary.
1643 (while (> (save-excursion (end-of-line) (current-column))
1645 (move-to-column fill-column)
1646 (f90-find-breakpoint)
1647 (f90-break-line 'no-update))
1648 (setq go-on (and (< (point) end-region-mark)
1649 (zerop (forward-line 1)))
1650 f90-cache-position (point)))
1651 (setq f90-cache-position nil)
1652 (set-marker end-region-mark nil)
1653 (if (fboundp 'zmacs-deactivate-region)
1654 (zmacs-deactivate-region)
1655 (deactivate-mark))))
1657 (defun f90-block-match (beg-block beg-name end-block end-name)
1658 "Match end-struct with beg-struct and complete end-block if possible.
1659 BEG-BLOCK is the type of block as indicated at the start (e.g., do).
1660 BEG-NAME is the block start name (may be nil).
1661 END-BLOCK is the type of block as indicated at the end (may be nil).
1662 END-NAME is the block end name (may be nil).
1663 Leave point at the end of line."
1664 (search-forward "end" (line-end-position))
1666 (if (f90-equal-symbols beg-block end-block)
1667 (search-forward end-block)
1670 (message "END %s does not match %s." end-block beg-block)
1672 (throw 'no-match nil))
1673 (message "Inserting %s." beg-block)
1674 (insert (concat " " beg-block))))
1675 (if (f90-equal-symbols beg-name end-name)
1676 (and end-name (search-forward end-name))
1677 (cond ((and beg-name (not end-name))
1678 (message "Inserting %s." beg-name)
1679 (insert (concat " " beg-name)))
1680 ((and beg-name end-name)
1681 (message "Replacing %s with %s." end-name beg-name)
1682 (search-forward end-name)
1683 (replace-match beg-name))
1684 ((and (not beg-name) end-name)
1685 (message "Deleting %s." end-name)
1686 (search-forward end-name)
1687 (replace-match ""))))
1688 (or (looking-at "[ \t]*!") (delete-horizontal-space))))
1690 (defun f90-match-end ()
1691 "From an end block statement, find the corresponding block and name."
1694 (top-of-window (window-start))
1696 (case-fold-search t)
1697 matching-beg beg-name end-name beg-block end-block end-struct)
1698 (when (save-excursion (beginning-of-line) (skip-chars-forward " \t0-9")
1699 (setq end-struct (f90-looking-at-program-block-end)))
1700 (setq end-block (car end-struct)
1701 end-name (car (cdr end-struct)))
1704 (while (and (> count 0) (re-search-backward f90-blocks-re nil t))
1706 ;; GM not a line number if continued line.
1707 ;;; (skip-chars-forward " \t")
1708 ;;; (skip-chars-forward "0-9")
1709 (skip-chars-forward " \t0-9")
1710 (cond ((or (f90-in-string) (f90-in-comment)))
1714 (f90-looking-at-if-then)
1715 (f90-looking-at-where-or-forall)
1716 (f90-looking-at-select-case)
1717 (f90-looking-at-type-like)
1718 (f90-looking-at-program-block-start)))
1719 (setq count (1- count)))
1720 ((looking-at (concat "end[ \t]*" f90-blocks-re))
1721 (setq count (1+ count)))))
1723 (message "No matching beginning.")
1725 (if (eq f90-smart-end 'blink)
1726 (if (< (point) top-of-window)
1727 (message "Matches %s: %s"
1730 (line-beginning-position)
1731 (line-end-position)))
1733 (setq beg-block (car matching-beg)
1734 beg-name (car (cdr matching-beg)))
1735 (goto-char end-point)
1737 (f90-block-match beg-block beg-name end-block end-name))))))
1739 (defun f90-insert-end ()
1740 "Insert a complete end statement matching beginning of present block."
1742 (let ((f90-smart-end (or f90-smart-end 'blink)))
1744 (f90-indent-new-line)))
1746 ;; Abbrevs and keywords.
1748 (defun f90-abbrev-start ()
1749 "Typing `\\[help-command] or `? lists all the F90 abbrevs.
1750 Any other key combination is executed normally."
1752 (insert last-command-char)
1754 (if (fboundp 'next-command-event) ; XEmacs
1755 (setq event (next-command-event)
1756 char (event-to-character event))
1757 (setq event (read-event)
1759 ;; Insert char if not equal to `?', or if abbrev-mode is off.
1760 (if (and abbrev-mode (or (eq char ??) (eq char help-char)))
1762 (setq unread-command-events (list event)))))
1764 (defun f90-abbrev-help ()
1765 "List the currently defined abbrevs in F90 mode."
1767 (message "Listing abbrev table...")
1768 (display-buffer (f90-prepare-abbrev-list-buffer))
1769 (message "Listing abbrev table...done"))
1771 (defun f90-prepare-abbrev-list-buffer ()
1772 "Create a buffer listing the F90 mode abbreviations."
1774 (set-buffer (get-buffer-create "*Abbrevs*"))
1776 (insert-abbrev-table-description 'f90-mode-abbrev-table t)
1777 (goto-char (point-min))
1778 (set-buffer-modified-p nil)
1779 (edit-abbrevs-mode))
1780 (get-buffer-create "*Abbrevs*"))
1782 (defun f90-upcase-keywords ()
1783 "Upcase all F90 keywords in the buffer."
1785 (f90-change-keywords 'upcase-word))
1787 (defun f90-capitalize-keywords ()
1788 "Capitalize all F90 keywords in the buffer."
1790 (f90-change-keywords 'capitalize-word))
1792 (defun f90-downcase-keywords ()
1793 "Downcase all F90 keywords in the buffer."
1795 (f90-change-keywords 'downcase-word))
1797 (defun f90-upcase-region-keywords (beg end)
1798 "Upcase all F90 keywords in the region."
1800 (f90-change-keywords 'upcase-word beg end))
1802 (defun f90-capitalize-region-keywords (beg end)
1803 "Capitalize all F90 keywords in the region."
1805 (f90-change-keywords 'capitalize-word beg end))
1807 (defun f90-downcase-region-keywords (beg end)
1808 "Downcase all F90 keywords in the region."
1810 (f90-change-keywords 'downcase-word beg end))
1812 ;; Change the keywords according to argument.
1813 (defun f90-change-keywords (change-word &optional beg end)
1814 "Change the case of F90 keywords in the region (if specified) or buffer.
1815 CHANGE-WORD should be one of 'upcase-word, 'downcase-word, 'capitalize-word."
1817 (setq beg (or beg (point-min))
1818 end (or end (point-max)))
1821 f90-keywords-re "\\|" f90-procedures-re "\\|"
1822 f90-hpf-keywords-re "\\|" f90-operators-re "\\)"))
1823 (ref-point (point-min))
1824 (modified (buffer-modified-p))
1825 state saveword back-point)
1828 (while (re-search-forward keyword-re end t)
1830 (setq state (parse-partial-sexp ref-point (point)))
1831 (or (nth 3 state) (nth 4 state)
1832 ;; GM f90-directive-comment-re?
1833 (save-excursion ; check for cpp directive
1835 (skip-chars-forward " \t0-9")
1837 (setq ref-point (point)
1838 back-point (save-excursion (backward-word 1) (point))
1839 saveword (buffer-substring back-point ref-point))
1840 (funcall change-word -1)
1841 (or (string= saveword (buffer-substring back-point ref-point))
1842 (setq modified t))))
1843 (or modified (set-buffer-modified-p nil))))))
1846 (defun f90-current-defun ()
1847 "Function to use for `add-log-current-defun-function' in F90 mode."
1849 (nth 1 (f90-beginning-of-subprogram))))
1853 ;;; arch-tag: fceac97c-c147-44bd-aec0-172d4b560ef8
1854 ;;; f90.el ends here