lisp/progmodes/f90.el

   1 ;;; f90.el --- Fortran-90 mode (free format)
   2
   3 ;; Copyright (C) 1995, 1996, 1997, 2000 Free Software Foundation, Inc.
   4
   5 ;; Author: Torbj\"orn Einarsson <Torbjorn.Einarsson@era.ericsson.se>
   6 ;; Maintainer: Glenn Morris <gmorris@ast.cam.ac.uk>
   7 ;; Keywords: fortran, f90, languages
   8
   9 ;; This file is part of GNU Emacs.
  10
  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)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  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.
  25
  26 ;;; Commentary:
  27
  28 ;; Major mode for editing F90 programs in FREE FORMAT.
  29 ;; The minor language revision F95 is also supported (with font-locking).
  30
  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.
  37
  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).
  42
  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.
  48
  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):
  51
  52 ;; start-string/regexp  indent         variable holding start-string/regexp
  53 ;;    !!!                  0
  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
  58
  59 ;; Ex: Here is the result of 3 different settings of f90-indented-comment-re
  60 ;;     f90-indented-comment-re  !-indentation      !!-indentation
  61 ;;          !                    as code             as code
  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.
  67
  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.
  72 ;; For example:
  73 ;; (add-to-list 'auto-mode-alist '("\\.f\\'" . f90-mode))
  74
  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>.
  79
  80 ;; To customize f90-mode for your taste, use, for example:
  81 ;; (you don't have to specify values for all the parameters below)
  82 ;;
  83 ;;(add-hook 'f90-mode-hook
  84 ;;      ;; These are the default values.
  85 ;;      '(lambda () (setq f90-do-indent 3
  86 ;;                        f90-if-indent 3
  87 ;;                        f90-type-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
 101 ;;                  )
 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))
 107 ;;       ))
 108 ;;
 109 ;; in your .emacs file. You can also customize the lists
 110 ;; f90-font-lock-keywords, etc.
 111 ;;
 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.
 114
 115 ;; Remarks
 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.
 129
 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
 138 ;;   f90-fill-region
 139 ;;   f90-insert-end
 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
 145
 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.
 152
 153 ;; TODO
 154 ;; Support for hideshow, align.
 155 ;; OpenMP, preprocessor highlighting.
 156
 157 ;;; Code:
 158
 159 ;; User options
 160
 161 (defgroup f90 nil
 162   "Major mode for editing Fortran 90,95 code."
 163   :group 'languages)
 164
 165 (defgroup f90-indent nil
 166   "Indentation in free-format Fortran."
 167   :prefix "f90-"
 168   :group 'f90)
 169
 170
 171 (defcustom f90-do-indent 3
 172   "*Extra indentation applied to DO blocks."
 173   :type 'integer
 174   :group 'f90-indent)
 175
 176 (defcustom f90-if-indent 3
 177   "*Extra indentation applied to IF, SELECT CASE, WHERE and FORALL blocks."
 178   :type 'integer
 179   :group 'f90-indent)
 180
 181 (defcustom f90-type-indent 3
 182   "*Extra indentation applied to TYPE, INTERFACE and BLOCK DATA blocks."
 183   :type 'integer
 184   :group 'f90-indent)
 185
 186 (defcustom f90-program-indent 2
 187   "*Extra indentation applied to PROGRAM/MODULE/SUBROUTINE/FUNCTION blocks."
 188   :type 'integer
 189   :group 'f90-indent)
 190
 191 (defcustom f90-continuation-indent 5
 192   "*Extra indentation applied to F90 continuation lines."
 193   :type 'integer
 194   :group 'f90-indent)
 195
 196 (defcustom f90-comment-region "!!$"
 197   "*String inserted by \\[f90-comment-region] at start of each line in region."
 198   :type 'string
 199   :group 'f90-indent)
 200
 201 (defcustom f90-indented-comment-re "!"
 202   "*Regexp saying which comments to indent like code."
 203   :type 'regexp
 204   :group 'f90-indent)
 205
 206 (defcustom f90-directive-comment-re "!hpf\\$"
 207   "*Regexp of comment-like directive like \"!HPF\\\\$\", not to be indented."
 208   :type 'regexp
 209   :group 'f90-indent)
 210
 211 (defcustom f90-beginning-ampersand t
 212   "*Non-nil gives automatic insertion of \& at start of continuation line."
 213   :type 'boolean
 214   :group 'f90)
 215
 216 (defcustom f90-smart-end 'blink
 217   "*From an END statement, check and fill the end using matching block start.
 218 Allowed values are 'blink, 'no-blink, and nil, which determine
 219 whether to blink the matching beginning."
 220   :type '(choice (const blink) (const no-blink) (const nil))
 221   :group 'f90)
 222
 223 (defcustom f90-break-delimiters "[-+\\*/><=,% \t]"
 224   "*Regexp holding list of delimiters at which lines may be broken."
 225   :type 'regexp
 226   :group 'f90)
 227
 228 (defcustom f90-break-before-delimiters t
 229   "*Non-nil causes `f90-do-auto-fill' to break lines before delimiters."
 230   :type 'boolean
 231   :group 'f90)
 232
 233 (defcustom f90-auto-keyword-case nil
 234   "*Automatic case conversion of keywords.
 235 The options are 'downcase-word, 'upcase-word, 'capitalize-word and nil."
 236   :type '(choice (const downcase-word) (const upcase-word)
 237                  (const capitalize-word) (const nil))
 238   :group 'f90)
 239
 240 (defcustom f90-leave-line-no nil
 241   "*If non-nil, line numbers are not left justified."
 242   :type 'boolean
 243   :group 'f90)
 244
 245 (defconst f90-xemacs-flag (string-match "XEmacs\\|Lucid" emacs-version)
 246   "Non-nil means f90-mode thinks it is running under XEmacs.")
 247
 248 (defconst f90-keywords-re
 249   (regexp-opt '("allocatable" "allocate" "assign" "assignment" "backspace"
 250                 "block" "call" "case" "character" "close" "common" "complex"
 251                 "contains" "continue" "cycle" "data" "deallocate"
 252                 "dimension" "do" "double" "else" "elseif" "elsewhere" "end"
 253                 "enddo" "endfile" "endif" "entry" "equivalence" "exit"
 254                 "external" "forall" "format" "function" "goto" "if"
 255                 "implicit" "include" "inquire" "integer" "intent"
 256                 "interface" "intrinsic" "logical" "module" "namelist" "none"
 257                 "nullify" "only" "open" "operator" "optional" "parameter"
 258                 "pause" "pointer" "precision" "print" "private" "procedure"
 259                 "program" "public" "read" "real" "recursive" "result" "return"
 260                 "rewind" "save" "select" "sequence" "stop" "subroutine"
 261                 "target" "then" "type" "use" "where" "while" "write"
 262                 ;; F95 keywords.
 263                 "elemental" "pure") 'words)
 264   "Regexp for F90 keywords.")
 265
 266 (defconst f90-keywords-level-3-re
 267   (regexp-opt
 268    '("allocatable" "allocate" "assign" "assignment" "backspace"
 269      "close" "deallocate" "dimension" "endfile" "entry" "equivalence"
 270      "external" "inquire" "intent" "intrinsic" "nullify" "only" "open"
 271      "operator" "optional" "parameter" "pause" "pointer" "print" "private"
 272      "public" "read" "recursive" "result" "rewind" "save" "select"
 273      "sequence" "target" "write"
 274      ;; F95 keywords.
 275      "elemental" "pure") 'words)
 276   "Keyword-regexp for font-lock level >= 3.")
 277
 278 (defconst f90-procedures-re
 279   (concat "\\<"
 280    (regexp-opt
 281     '("abs" "achar" "acos" "adjustl" "adjustr" "aimag" "aint"
 282       "all" "allocated" "anint" "any" "asin" "associated"
 283       "atan" "atan2" "bit_size" "btest" "ceiling" "char" "cmplx"
 284       "conjg" "cos" "cosh" "count" "cshift" "date_and_time" "dble"
 285       "digits" "dim" "dot_product" "dprod" "eoshift" "epsilon"
 286       "exp" "exponent" "floor" "fraction" "huge" "iachar" "iand"
 287       "ibclr" "ibits" "ibset" "ichar" "ieor" "index" "int" "ior"
 288       "ishft" "ishftc" "kind" "lbound" "len" "len_trim" "lge" "lgt"
 289       "lle" "llt" "log" "log10" "logical" "matmul" "max"
 290       "maxexponent" "maxloc" "maxval" "merge" "min" "minexponent"
 291       "minloc" "minval" "mod" "modulo" "mvbits" "nearest" "nint"
 292       "not" "pack" "precision" "present" "product" "radix"
 293       ;; Real is taken out here to avoid highlighting declarations.
 294       "random_number" "random_seed" "range" ;; "real"
 295       "repeat" "reshape" "rrspacing" "scale" "scan"
 296       "selected_int_kind" "selected_real_kind" "set_exponent"
 297       "shape" "sign" "sin" "sinh" "size" "spacing" "spread" "sqrt"
 298       "sum" "system_clock" "tan" "tanh" "tiny" "transfer"
 299       "transpose" "trim" "ubound" "unpack" "verify"
 300       ;; F95 intrinsic functions.
 301       "null" "cpu_time") t)
 302    ;; A left parenthesis to avoid highlighting non-procedures.
 303    "[ \t]*(")
 304   "Regexp whose first part matches F90 intrinsic procedures.")
 305
 306 (defconst f90-operators-re
 307  (concat "\\."
 308          (regexp-opt '("and" "eq" "eqv" "false" "ge" "gt" "le" "lt" "ne"
 309                        "neqv" "not" "or" "true") t)
 310          "\\.")
 311   "Regexp matching intrinsic operators.")
 312
 313 (defconst f90-hpf-keywords-re
 314   (regexp-opt
 315    ;; Intrinsic procedures
 316    '("all_prefix" "all_scatter" "all_suffix" "any_prefix"
 317      "any_scatter" "any_suffix" "copy_prefix" "copy_scatter"
 318      "copy_suffix" "count_prefix" "count_scatter" "count_suffix"
 319      "grade_down" "grade_up"
 320      "hpf_alignment" "hpf_distribution" "hpf_template" "iall" "iall_prefix"
 321      "iall_scatter" "iall_suffix" "iany" "iany_prefix" "iany_scatter"
 322      "iany_suffix" "ilen" "iparity" "iparity_prefix"
 323      "iparity_scatter" "iparity_suffix" "leadz" "maxval_prefix"
 324      "maxval_scatter" "maxval_suffix" "minval_prefix" "minval_scatter"
 325      "minval_suffix" "number_of_processors" "parity"
 326      "parity_prefix" "parity_scatter" "parity_suffix" "popcnt" "poppar"
 327      "processors_shape" "product_prefix" "product_scatter"
 328      "product_suffix" "sum_prefix" "sum_scatter" "sum_suffix"
 329      ;; Directives
 330      "align" "distribute" "dynamic" "independent" "inherit" "processors"
 331      "realign" "redistribute" "template"
 332      ;; Keywords
 333      "block" "cyclic" "extrinsic" "new" "onto" "pure" "with") 'words)
 334   "Regexp for all HPF keywords, procedures and directives.")
 335
 336 ;; Highlighting patterns
 337
 338 (defvar f90-font-lock-keywords-1
 339   (list
 340    ;; Special highlighting of "module procedure foo-list"
 341    '("\\<\\(module[ \t]*procedure\\)\\>" (1 font-lock-keyword-face))
 342    ;; Highlight definition of new type
 343    '("\\<\\(type\\)[ \t]*\\(.*::[ \t]*\\|[ \t]+\\)\\(\\sw+\\)"
 344      (1 font-lock-keyword-face) (3 font-lock-function-name-face))
 345    ;; Other functions and declarations.
 346    '("\\<\\(\\(?:end[ \t]*\\)?\\(program\\|module\\|function\\|subroutine\\|type\\)\\|use\\|call\\)\\>[ \t]*\\(\\sw+\\)?"
 347      (1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
 348    "\\<\\(\\(end[ \t]*\\)?\\(interface\\|block[ \t]*data\\)\\|contains\\)\\>")
 349   "This does fairly subdued highlighting of comments and function calls.")
 350
 351 (defvar f90-font-lock-keywords-2
 352   (append f90-font-lock-keywords-1
 353       (list
 354        ;; Variable declarations (avoid the real function call)
 355        '("^[ \t0-9]*\\(real\\|integer\\|c\\(haracter\\|omplex\\)\\|logical\\|type[ \t]*(\\sw+)\\)\\(.*::\\|[ \t]*(.*)\\)?\\([^!\n]*\\)"
 356          (1 font-lock-type-face) (4 font-lock-variable-name-face))
 357        ;; do, if, select, where, and forall constructs
 358        '("\\<\\(end[ \t]*\\(do\\|if\\|select\\|forall\\|where\\)\\)\\>\\([ \t]+\\(\\sw+\\)\\)?"
 359          (1 font-lock-keyword-face) (3 font-lock-constant-face nil t))
 360        '("^[ \t0-9]*\\(\\(\\sw+\\)[ \t]*:[ \t]*\\)?\\(\\(if\\|do\\([ \t]*while\\)?\\|select[ \t]*case\\|where\\|forall\\)\\)\\>"
 361          (2 font-lock-constant-face nil t) (3 font-lock-keyword-face))
 362        ;; implicit declaration
 363        '("\\<\\(implicit\\)[ \t]*\\(real\\|integer\\|c\\(haracter\\|omplex\\)\\|logical\\|type[ \t]*(\\sw+)\\|none\\)\\>" (1 font-lock-keyword-face) (2 font-lock-type-face))
 364        '("\\<\\(namelist\\|common\\)[ \t]*\/\\(\\sw+\\)?\/" (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
 365        "\\<else\\([ \t]*if\\|where\\)?\\>"
 366        "\\<\\(then\\|continue\\|format\\|include\\|stop\\|return\\)\\>"
 367        '("\\<\\(exit\\|cycle\\)[ \t]*\\(\\sw+\\)?\\>"
 368          (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
 369        '("\\<\\(case\\)[ \t]*\\(default\\|(\\)" . 1)
 370        '("\\<\\(do\\|go *to\\)\\>[ \t]*\\([0-9]+\\)"
 371          (1 font-lock-keyword-face) (2 font-lock-constant-face))
 372        ;; line numbers (lines whose first character after number is letter)
 373        '("^[ \t]*\\([0-9]+\\)[ \t]*[a-z]+" (1 font-lock-constant-face t))))
 374   "Highlights declarations, do-loops and other constructs.")
 375
 376 (defvar f90-font-lock-keywords-3
 377   (append f90-font-lock-keywords-2
 378    (list
 379     f90-keywords-level-3-re
 380     f90-operators-re
 381     (list f90-procedures-re '(1 font-lock-keyword-face keep))
 382     "\\<real\\>"                        ; Avoid overwriting real defs.
 383    ))
 384   "Highlights all F90 keywords and intrinsic procedures.")
 385
 386 (defvar f90-font-lock-keywords-4
 387   (append f90-font-lock-keywords-3
 388     (list f90-hpf-keywords-re))
 389   "Highlights all F90 and HPF keywords.")
 390
 391 (defvar f90-font-lock-keywords
 392   f90-font-lock-keywords-2
 393   "*Default expressions to highlight in F90 mode.")
 394
 395 ;; syntax table
 396 (defvar f90-mode-syntax-table nil
 397   "Syntax table in use in F90 mode buffers.")
 398
 399 (if f90-mode-syntax-table
 400     ()
 401   (setq f90-mode-syntax-table (make-syntax-table))
 402   (modify-syntax-entry ?\! "<" f90-mode-syntax-table)  ; beg. comment
 403   (modify-syntax-entry ?\n ">" f90-mode-syntax-table)  ; end comment
 404   (modify-syntax-entry ?_ "w" f90-mode-syntax-table)   ; underscore in names
 405   (modify-syntax-entry ?\' "\"" f90-mode-syntax-table) ; string quote
 406   (modify-syntax-entry ?\" "\"" f90-mode-syntax-table) ; string quote
 407   (modify-syntax-entry ?\` "w" f90-mode-syntax-table)  ; for abbrevs
 408   (modify-syntax-entry ?\r " " f90-mode-syntax-table)  ; return is whitespace
 409   (modify-syntax-entry ?+ "." f90-mode-syntax-table)
 410   (modify-syntax-entry ?- "." f90-mode-syntax-table)
 411   (modify-syntax-entry ?= "." f90-mode-syntax-table)
 412   (modify-syntax-entry ?* "." f90-mode-syntax-table)
 413   (modify-syntax-entry ?/ "." f90-mode-syntax-table)
 414   (modify-syntax-entry ?\\ "\\" f90-mode-syntax-table)) ; escape chars
 415
 416 ;; keys
 417 (defvar f90-mode-map ()
 418   "Keymap used in F90 mode.")
 419
 420 (if f90-mode-map
 421     ()
 422   (setq f90-mode-map (make-sparse-keymap))
 423   (define-key f90-mode-map "`"        'f90-abbrev-start)
 424   (define-key f90-mode-map "\C-c;"    'f90-comment-region)
 425   (define-key f90-mode-map "\C-\M-a"  'f90-beginning-of-subprogram)
 426   (define-key f90-mode-map "\C-\M-e"  'f90-end-of-subprogram)
 427   (define-key f90-mode-map "\C-\M-h"  'f90-mark-subprogram)
 428   (define-key f90-mode-map "\C-\M-q"  'f90-indent-subprogram)
 429   (define-key f90-mode-map "\C-j"     'f90-indent-new-line) ; LFD equals C-j
 430   (define-key f90-mode-map "\r"       'newline)
 431   (define-key f90-mode-map "\C-c\r"   'f90-break-line)
 432   ;;  (define-key f90-mode-map [M-return] 'f90-break-line)
 433   (define-key f90-mode-map "\C-c\C-d" 'f90-join-lines)
 434   (define-key f90-mode-map "\C-c\C-f" 'f90-fill-region)
 435   (define-key f90-mode-map "\C-c\C-p" 'f90-previous-statement)
 436   (define-key f90-mode-map "\C-c\C-n" 'f90-next-statement)
 437   (define-key f90-mode-map "\C-c\C-w" 'f90-insert-end)
 438   (define-key f90-mode-map "\t"       'f90-indent-line)
 439   (define-key f90-mode-map ","        'f90-electric-insert)
 440   (define-key f90-mode-map "+"        'f90-electric-insert)
 441   (define-key f90-mode-map "-"        'f90-electric-insert)
 442   (define-key f90-mode-map "*"        'f90-electric-insert)
 443   (define-key f90-mode-map "/"        'f90-electric-insert))
 444
 445
 446 ;; menus
 447 (if f90-xemacs-flag
 448     (defvar f90-xemacs-menu
 449       '("F90"
 450         ["Indent Subprogram"       f90-indent-subprogram t]
 451         ["Mark Subprogram"         f90-mark-subprogram t]
 452         ["Beginning of Subprogram" f90-beginning-of-subprogram t]
 453         ["End of Subprogram"       f90-end-of-subprogram t]
 454         "-----"
 455         ["(Un)Comment Region"      f90-comment-region t]
 456         ["Indent Region"           indent-region t]
 457         ["Fill Region"             f90-fill-region t]
 458         "-----"
 459         ["Break Line at Point"     f90-break-line t]
 460         ["Join with Next Line"     f90-join-lines t]
 461         ["Insert Newline"          newline t]
 462         ["Insert Block End"        f90-insert-end t]
 463         "-----"
 464         ["Upcase Keywords (buffer)"      f90-upcase-keywords t]
 465         ["Upcase Keywords (region)"      f90-upcase-region-keywords
 466          t]
 467         ["Capitalize Keywords (buffer)"  f90-capitalize-keywords t]
 468         ["Capitalize Keywords (region)"
 469          f90-capitalize-region-keywords t]
 470         ["Downcase Keywords (buffer)"    f90-downcase-keywords t]
 471         ["Downcase Keywords (region)"
 472          f90-downcase-region-keywords t]
 473         "-----"
 474         ["Toggle abbrev-mode"   abbrev-mode             t]
 475         ["Toggle auto-fill"     auto-fill-mode          t])
 476       "XEmacs menu for F90 mode.")
 477   ;; Emacs
 478
 479   (defvar f90-change-case-menu
 480     (let ((map (make-sparse-keymap "Change Keyword Case")))
 481
 482       (define-key map [dkr] (cons "Downcase Keywords (region)"
 483                                   'f90-downcase-region-keywords))
 484       (put 'f90-downcase-region-keywords 'menu-enable 'mark-active)
 485
 486       (define-key map [ckr] (cons "Capitalize Keywords (region)"
 487                                   'f90-capitalize-region-keywords))
 488       (put 'f90-capitalize-region-keywords 'menu-enable 'mark-active)
 489
 490       (define-key map [ukr] (cons "Upcase Keywords (region)"
 491                                   'f90-upcase-region-keywords))
 492       (put 'f90-upcase-region-keywords 'menu-enable 'mark-active)
 493
 494       (define-key map [line] (list "-----------------"))
 495
 496       (define-key map [dkb] (cons "Downcase Keywords (buffer)"
 497                                   'f90-downcase-keywords))
 498
 499       (define-key map [ckb] (cons "Capitalize Keywords (buffer)"
 500                                   'f90-capitalize-keywords))
 501
 502       (define-key map [ukb] (cons "Upcase Keywords (buffer)"
 503                                   'f90-upcase-keywords))
 504       map)
 505     "Submenu for change of case.")
 506   (defalias 'f90-change-case-menu f90-change-case-menu)
 507
 508   ;; font-lock-menu and function calls
 509   (defalias 'f90-font-lock-on  'font-lock-mode)
 510   (defalias 'f90-font-lock-off 'font-lock-mode)
 511   (put 'f90-font-lock-on  'menu-enable 'font-lock-mode)
 512   (put 'f90-font-lock-off 'menu-enable '(not font-lock-mode))
 513
 514   (defun f90-font-lock-1 ()
 515     (interactive)
 516     "Set font-lock-keywords to f90-font-lock-keywords-1."
 517     (font-lock-mode 1)
 518     (setq font-lock-keywords f90-font-lock-keywords-1)
 519     (font-lock-fontify-buffer))
 520
 521   (defun f90-font-lock-2 ()
 522     (interactive)
 523     "Set font-lock-keywords to f90-font-lock-keywords-2."
 524     (font-lock-mode 1)
 525     (setq font-lock-keywords f90-font-lock-keywords-2)
 526     (font-lock-fontify-buffer))
 527
 528   (defun f90-font-lock-3 ()
 529     (interactive)
 530     "Set font-lock-keywords to f90-font-lock-keywords-3."
 531     (font-lock-mode 1)
 532     (setq font-lock-keywords f90-font-lock-keywords-3)
 533     (font-lock-fontify-buffer))
 534
 535   (defun f90-font-lock-4 ()
 536     (interactive)
 537     "Set font-lock-keywords to f90-font-lock-keywords-4."
 538     (font-lock-mode 1)
 539     (setq font-lock-keywords f90-font-lock-keywords-4)
 540     (font-lock-fontify-buffer))
 541
 542   (defvar f90-font-lock-menu
 543     (let ((map (make-sparse-keymap "f90-font-lock-menu")))
 544       (define-key map [h4] (cons "Maximum highlighting (level 4)"
 545                                  'f90-font-lock-4))
 546       (define-key map [h3] (cons "Heavy highlighting (level 3)"
 547                                  'f90-font-lock-3))
 548       (define-key map [h2] (cons "Default highlighting (level 2)"
 549                                  'f90-font-lock-2))
 550       (define-key map [h1] (cons "Light highlighting (level 1)"
 551                                  'f90-font-lock-1))
 552       (define-key map [line] (list "-----------------"))
 553       (define-key map [floff] (cons "Turn off font-lock-mode"
 554                                     'f90-font-lock-on))
 555       (define-key map [flon] (cons "Turn on font-lock-mode"
 556                                    'f90-font-lock-off))
 557       map)
 558     "Submenu for highlighting using font-lock-mode.")
 559   (defalias 'f90-font-lock-menu f90-font-lock-menu)
 560
 561   (define-key f90-mode-map [menu-bar] (make-sparse-keymap))
 562   (define-key f90-mode-map [menu-bar f90]
 563     (cons "F90" (make-sparse-keymap "f90")))
 564
 565   (define-key f90-mode-map [menu-bar f90 f90-imenu-menu]
 566     '("Add imenu Menu" . f90-add-imenu-menu))
 567   (define-key f90-mode-map [menu-bar f90 abbrev-mode]
 568     '("Toggle abbrev-mode" . abbrev-mode))
 569   (define-key f90-mode-map [menu-bar f90 auto-fill-mode]
 570     '("Toggle auto-fill" . auto-fill-mode))
 571   (define-key f90-mode-map [menu-bar f90 line1]
 572     '("----"))
 573   (define-key f90-mode-map [menu-bar f90 f90-change-case-menu]
 574     (cons "Change Keyword Case" 'f90-change-case-menu))
 575   (define-key f90-mode-map [menu-bar f90 f90-font-lock-menu]
 576     (cons "Highlighting" 'f90-font-lock-menu))
 577   (define-key f90-mode-map [menu-bar f90 line2]
 578     '("----"))
 579
 580   (define-key f90-mode-map [menu-bar f90 f90-insert-end]
 581     '("Insert Block End" . f90-insert-end))
 582   (define-key f90-mode-map [menu-bar f90 f90-join-lines]
 583     '("Join with Next Line" . f90-join-lines))
 584   (define-key f90-mode-map [menu-bar f90 f90-break-line]
 585     '("Break Line at Point" . f90-break-line))
 586
 587   (define-key f90-mode-map [menu-bar f90 line3]
 588     '("----"))
 589
 590   (define-key f90-mode-map [menu-bar f90 f90-fill-region]
 591     '("Fill Region" . f90-fill-region))
 592   (put 'f90-fill-region 'menu-enable 'mark-active)
 593
 594   (define-key f90-mode-map [menu-bar f90 indent-region]
 595     '("Indent Region" . indent-region))
 596
 597   (define-key f90-mode-map [menu-bar f90 f90-comment-region]
 598     '("(Un)Comment Region" . f90-comment-region))
 599   (put 'f90-comment-region 'menu-enable 'mark-active)
 600
 601   (define-key f90-mode-map [menu-bar f90 line4]
 602     '("----"))
 603
 604   (define-key f90-mode-map [menu-bar f90 f90-end-of-subprogram]
 605     '("End of Subprogram" . f90-end-of-subprogram))
 606   (define-key f90-mode-map [menu-bar f90 f90-beginning-of-subprogram]
 607     '("Beginning of Subprogram" . f90-beginning-of-subprogram))
 608   (define-key f90-mode-map [menu-bar f90 f90-mark-subprogram]
 609     '("Mark Subprogram" . f90-mark-subprogram))
 610   (define-key f90-mode-map [menu-bar f90 f90-indent-subprogram]
 611     '("Indent Subprogram" . f90-indent-subprogram))
 612   )
 613
 614 ;; Regexps for finding program structures.
 615 (defconst f90-blocks-re
 616   "\\(block[ \t]*data\\|do\\|if\\|interface\\|function\\|module\\|\
 617 program\\|select\\|subroutine\\|type\\|where\\|forall\\)\\>")
 618 (defconst f90-program-block-re
 619   "\\(program\\|module\\|subroutine\\|function\\)")
 620 (defconst f90-else-like-re
 621   "\\(else\\([ \t]*if\\|where\\)?\\|case[ \t]*\\(default\\|(\\)\\)")
 622 (defconst f90-end-if-re
 623   "end[ \t]*\\(if\\|select\\|where\\|forall\\)\\>")
 624 (defconst f90-end-type-re
 625   "end[ \t]*\\(type\\|interface\\|block[ \t]*data\\)")
 626 (defconst f90-type-def-re
 627   "\\<\\(type\\)\\([^(\n]*\\)\\(::\\)?[ \t]*\\b\\(\\sw+\\)")
 628 (defconst f90-no-break-re  "\\(\\*\\*\\|//\\|=>\\)")
 629 ;; A temporary position to make region operators faster
 630 (defvar f90-cache-position nil)
 631 (make-variable-buffer-local 'f90-cache-position)
 632 ;; A flag to tell whether f90-imenu is turned on.
 633 (defvar f90-imenu nil)
 634 (make-variable-buffer-local 'f90-imenu)
 635
 636 \f
 637 ;; Imenu support
 638 (defvar f90-imenu-generic-expression
 639   (let ((good-char "[^!\"\&\n \t]") (not-e "[^e!\n\"\& \t]")
 640         (not-n "[^n!\n\"\& \t]") (not-d "[^d!\n\"\& \t]"))
 641     (list
 642      '(nil "^[ \t0-9]*program[ \t]+\\(\\sw+\\)" 1)
 643      '("Modules" "^[ \t0-9]*module[ \t]+\\(\\sw+\\)[ \t]*\\(!\\|$\\)" 1)
 644      '("Types" "^[ \t0-9]*type[ \t]+\\(\\sw+\\)" 1)
 645      (list
 646       "Procedures"
 647       (concat
 648        "^[ \t0-9]*"
 649        "\\("
 650        ;; At least three non-space characters before function/subroutine
 651        ;; Check that the last three non-space characters don't spell E N D
 652        "[^!\"\&\n]*\\("
 653        not-e good-char good-char "\\|"
 654        good-char not-n good-char "\\|"
 655        good-char good-char not-d "\\)"
 656        "\\|"
 657        ;; Less than three non-space characters before function/subroutine
 658        good-char "?" good-char "?"
 659        "\\)"
 660        "[ \t]*\\(function\\|subroutine\\)[ \t]+\\(\\sw+\\)")
 661     4)))
 662   "Generic imenu expression for F90 mode.")
 663
 664 (defun f90-add-imenu-menu ()
 665   "Add an imenu menu to the menubar."
 666   (interactive)
 667   (if (not f90-imenu)
 668       (progn
 669         (imenu-add-to-menubar "F90-imenu")
 670         (redraw-frame (selected-frame))
 671         (setq f90-imenu t))
 672     (message "%s" "F90-imenu already exists.")))
 673 (put 'f90-add-imenu-menu 'menu-enable '(not f90-imenu))
 674
 675
 676 ;; When compiling under GNU Emacs, load imenu during compilation.  If
 677 ;; you have 19.22 or earlier, comment this out, or get imenu.
 678 (or f90-xemacs-flag (eval-when-compile (require 'imenu)))
 679
 680 \f
 681 ;; abbrevs have generally two letters, except standard types `c, `i, `r, `t
 682 (defvar f90-mode-abbrev-table nil)
 683 (if f90-mode-abbrev-table
 684     ()
 685   (let ((ac abbrevs-changed))
 686     (define-abbrev-table 'f90-mode-abbrev-table ())
 687     (define-abbrev f90-mode-abbrev-table  "`al"  "allocate" nil 0 t)
 688     (define-abbrev f90-mode-abbrev-table  "`ab"  "allocatable" nil 0 t)
 689     (define-abbrev f90-mode-abbrev-table  "`as"  "assignment" nil 0 t)
 690     (define-abbrev f90-mode-abbrev-table  "`ba"  "backspace" nil 0 t)
 691     (define-abbrev f90-mode-abbrev-table  "`bd"  "block data" nil 0 t)
 692     (define-abbrev f90-mode-abbrev-table  "`c"   "character" nil 0 t)
 693     (define-abbrev f90-mode-abbrev-table  "`cl"  "close" nil 0 t)
 694     (define-abbrev f90-mode-abbrev-table  "`cm"  "common" nil 0 t)
 695     (define-abbrev f90-mode-abbrev-table  "`cx"  "complex" nil 0 t)
 696     (define-abbrev f90-mode-abbrev-table  "`cn"  "contains" nil 0 t)
 697     (define-abbrev f90-mode-abbrev-table  "`cy"  "cycle" nil 0 t)
 698     (define-abbrev f90-mode-abbrev-table  "`de"  "deallocate" nil 0 t)
 699     (define-abbrev f90-mode-abbrev-table  "`df"  "define" nil 0 t)
 700     (define-abbrev f90-mode-abbrev-table  "`di"  "dimension" nil 0 t)
 701     (define-abbrev f90-mode-abbrev-table  "`dw"  "do while" nil 0 t)
 702     (define-abbrev f90-mode-abbrev-table  "`el"  "else" nil 0 t)
 703     (define-abbrev f90-mode-abbrev-table  "`eli" "else if" nil 0 t)
 704     (define-abbrev f90-mode-abbrev-table  "`elw" "elsewhere" nil 0 t)
 705     (define-abbrev f90-mode-abbrev-table  "`eq"  "equivalence" nil 0 t)
 706     (define-abbrev f90-mode-abbrev-table  "`ex"  "external" nil 0 t)
 707     (define-abbrev f90-mode-abbrev-table  "`ey"  "entry" nil 0 t)
 708     (define-abbrev f90-mode-abbrev-table  "`fl"  "forall" nil 0 t)
 709     (define-abbrev f90-mode-abbrev-table  "`fo"  "format" nil 0 t)
 710     (define-abbrev f90-mode-abbrev-table  "`fu"  "function" nil 0 t)
 711     (define-abbrev f90-mode-abbrev-table  "`fa"  ".false." nil 0 t)
 712     (define-abbrev f90-mode-abbrev-table  "`im"  "implicit none" nil 0 t)
 713     (define-abbrev f90-mode-abbrev-table  "`in " "include" nil 0 t)
 714     (define-abbrev f90-mode-abbrev-table  "`i"   "integer" nil 0 t)
 715     (define-abbrev f90-mode-abbrev-table  "`it"  "intent" nil 0 t)
 716     (define-abbrev f90-mode-abbrev-table  "`if"  "interface" nil 0 t)
 717     (define-abbrev f90-mode-abbrev-table  "`lo"  "logical" nil 0 t)
 718     (define-abbrev f90-mode-abbrev-table  "`mo"  "module" nil 0 t)
 719     (define-abbrev f90-mode-abbrev-table  "`na"  "namelist" nil 0 t)
 720     (define-abbrev f90-mode-abbrev-table  "`nu"  "nullify" nil 0 t)
 721     (define-abbrev f90-mode-abbrev-table  "`op"  "optional" nil 0 t)
 722     (define-abbrev f90-mode-abbrev-table  "`pa"  "parameter" nil 0 t)
 723     (define-abbrev f90-mode-abbrev-table  "`po"  "pointer" nil 0 t)
 724     (define-abbrev f90-mode-abbrev-table  "`pr"  "print" nil 0 t)
 725     (define-abbrev f90-mode-abbrev-table  "`pi"  "private" nil 0 t)
 726     (define-abbrev f90-mode-abbrev-table  "`pm"  "program" nil 0 t)
 727     (define-abbrev f90-mode-abbrev-table  "`pu"  "public" nil 0 t)
 728     (define-abbrev f90-mode-abbrev-table  "`r"   "real" nil 0 t)
 729     (define-abbrev f90-mode-abbrev-table  "`rc"  "recursive" nil 0 t)
 730     (define-abbrev f90-mode-abbrev-table  "`rt"  "return" nil 0 t)
 731     (define-abbrev f90-mode-abbrev-table  "`rw"  "rewind" nil 0 t)
 732     (define-abbrev f90-mode-abbrev-table  "`se"  "select" nil 0 t)
 733     (define-abbrev f90-mode-abbrev-table  "`sq"  "sequence" nil 0 t)
 734     (define-abbrev f90-mode-abbrev-table  "`su"  "subroutine" nil 0 t)
 735     (define-abbrev f90-mode-abbrev-table  "`ta"  "target" nil 0 t)
 736     (define-abbrev f90-mode-abbrev-table  "`tr"  ".true." nil 0 t)
 737     (define-abbrev f90-mode-abbrev-table  "`t"   "type" nil 0 t)
 738     (define-abbrev f90-mode-abbrev-table  "`wh"  "where" nil 0 t)
 739     (define-abbrev f90-mode-abbrev-table  "`wr"  "write" nil 0 t)
 740     (setq abbrevs-changed ac)))
 741 \f
 742 (defcustom f90-mode-hook nil
 743   "Hook run by F90 mode."
 744   :type 'hook
 745   :options '(f90-add-imenu-menu)
 746   :group 'f90)
 747
 748 ;;;###autoload
 749 (defun f90-mode ()
 750   "Major mode for editing Fortran 90,95 code in free format.
 751
 752 \\[f90-indent-new-line] corrects current indentation and creates new\
 753  indented line.
 754 \\[f90-indent-line] indents the current line correctly.
 755 \\[f90-indent-subprogram] indents the current subprogram.
 756
 757 Type `? or `\\[help-command] to display a list of built-in\
 758  abbrevs for F90 keywords.
 759
 760 Key definitions:
 761 \\{f90-mode-map}
 762
 763 Variables controlling indentation style and extra features:
 764
 765  `f90-do-indent'
 766     Extra indentation within do blocks.  (default 3)
 767  `f90-if-indent'
 768     Extra indentation within if/select case/where/forall blocks.  (default 3)
 769  `f90-type-indent'
 770     Extra indentation within type/interface/block-data blocks.  (default 3)
 771  `f90-program-indent'
 772     Extra indentation within program/module/subroutine/function blocks.
 773     (default 2)
 774  `f90-continuation-indent'
 775     Extra indentation applied to continuation lines.  (default 5)
 776  `f90-comment-region'
 777     String inserted by \\[f90-comment-region] at start of each line in
 778     region.  (default \"!!!$\")
 779  `f90-indented-comment-re'
 780     Regexp determining the type of comment to be intended like code.
 781     (default \"!\")
 782  `f90-directive-comment-re'
 783     Regexp of comment-like directive like \"!HPF\\\\$\", not to be indented.
 784     (default \"!hpf\\\\$\")
 785  `f90-break-delimiters'
 786     Regexp holding list of delimiters at which lines may be broken.
 787     (default \"[-+*/><=,% \\t]\")
 788  `f90-break-before-delimiters'
 789     Non-nil causes `f90-do-auto-fill' to break lines before delimiters.
 790     (default t)
 791  `f90-beginning-ampersand'
 792     Automatic insertion of \& at beginning of continuation lines. (default t)
 793  `f90-smart-end'
 794     From an END statement, check and fill the end using matching block start.
 795     Allowed values are 'blink, 'no-blink, and nil, which determine
 796     whether to blink the matching beginning.  (default 'blink)
 797  `f90-auto-keyword-case'
 798     Automatic change of case of keywords.  (default nil)
 799     The possibilities are 'downcase-word, 'upcase-word, 'capitalize-word.
 800  `f90-leave-line-no'
 801     Do not left-justify line numbers.  (default nil)
 802  `f90-keywords-re'
 803     List of keywords used for highlighting/upcase-keywords etc.
 804
 805 Turning on F90 mode calls the value of the variable `f90-mode-hook'
 806 with no args, if that value is non-nil."
 807   (interactive)
 808   (kill-all-local-variables)
 809   (setq major-mode 'f90-mode)
 810   (setq mode-name "F90")
 811   (setq local-abbrev-table f90-mode-abbrev-table)
 812   (set-syntax-table f90-mode-syntax-table)
 813   (use-local-map f90-mode-map)
 814   (make-local-variable 'indent-line-function)
 815   (setq indent-line-function 'f90-indent-line)
 816   (make-local-variable 'indent-region-function)
 817   (setq indent-region-function 'f90-indent-region)
 818   (make-local-variable 'require-final-newline)
 819   (setq require-final-newline t)
 820   (make-local-variable 'comment-start)
 821   (setq comment-start "!")
 822   (make-local-variable 'comment-start-skip)
 823   (setq comment-start-skip "!+ *")
 824   (make-local-variable 'comment-indent-function)
 825   (setq comment-indent-function 'f90-comment-indent)
 826   (make-local-variable 'abbrev-all-caps)
 827   (setq abbrev-all-caps t)
 828   (make-local-variable 'normal-auto-fill-function)
 829   (setq normal-auto-fill-function 'f90-do-auto-fill)
 830   (setq indent-tabs-mode nil)
 831   ;; Setting up things for font-lock
 832   (when f90-xemacs-flag
 833     (put 'f90-mode 'font-lock-keywords-case-fold-search t)
 834     (when (and (featurep 'menubar)
 835              current-menubar
 836              (not (assoc "F90" current-menubar)))
 837           (set-buffer-menubar (copy-sequence current-menubar))
 838           (add-submenu nil f90-xemacs-menu)))
 839   ;; XEmacs: (Don't need a special case, since both emacsen work alike -sb)
 840   (make-local-variable 'font-lock-defaults)
 841   (setq font-lock-defaults
 842         '((f90-font-lock-keywords f90-font-lock-keywords-1
 843                                   f90-font-lock-keywords-2
 844                                   f90-font-lock-keywords-3
 845                                   f90-font-lock-keywords-4)
 846           nil t))
 847   ;; Tell imenu how to handle f90.
 848   (set (make-local-variable 'imenu-case-fold-search) t)
 849   (make-local-variable 'imenu-generic-expression)
 850   (setq imenu-generic-expression f90-imenu-generic-expression)
 851   (set (make-local-variable 'add-log-current-defun-function)
 852        #'f90-current-defun)
 853   (run-hooks 'f90-mode-hook))
 854 \f
 855 ;; inline-functions
 856 (defsubst f90-in-string ()
 857   (let ((beg-pnt
 858          (if (and f90-cache-position (> (point) f90-cache-position))
 859              f90-cache-position
 860            (point-min))))
 861     (nth 3 (parse-partial-sexp beg-pnt (point)))))
 862
 863 (defsubst f90-in-comment ()
 864   (let ((beg-pnt
 865          (if (and f90-cache-position (> (point) f90-cache-position))
 866              f90-cache-position
 867            (point-min))))
 868     (nth 4 (parse-partial-sexp beg-pnt (point)))))
 869
 870 (defsubst f90-line-continued ()
 871   (save-excursion
 872     (beginning-of-line)
 873     (while (and (looking-at "[ \t]*\\(!\\|$\\)") (zerop (forward-line -1))))
 874     (let ((bol (line-beginning-position)))
 875       (end-of-line)
 876       (while (f90-in-comment)
 877         (search-backward "!" bol)
 878         (skip-chars-backward "!"))
 879       (skip-chars-backward " \t")
 880       (= (preceding-char) ?&))))
 881
 882 (defsubst f90-current-indentation ()
 883   "Return indentation of current line.
 884 Line-numbers are considered whitespace characters."
 885   (save-excursion
 886     (beginning-of-line) (skip-chars-forward " \t0-9")))
 887
 888 (defsubst f90-indent-to (col &optional no-line-number)
 889   "Indent current line to column COL.
 890 If optional argument NO-LINE-NUMBER is nil, jump over a possible line-number."
 891   (beginning-of-line)
 892   (if (not no-line-number)
 893       (skip-chars-forward " \t0-9"))
 894   (delete-horizontal-space)
 895   (if (zerop (current-column))
 896       (indent-to col)
 897     (indent-to col 1)))
 898
 899 (defsubst f90-get-present-comment-type ()
 900   (save-excursion
 901     (let ((type nil) (eol (line-end-position)))
 902       (if (f90-in-comment)
 903           (progn
 904             (beginning-of-line)
 905             (re-search-forward "[!]+" eol)
 906             (while (f90-in-string)
 907               (re-search-forward "[!]+" eol))
 908             (setq type (match-string 0))))
 909       type)))
 910
 911 (defsubst f90-equal-symbols (a b)
 912   "Compare strings neglecting case and allowing for nil value."
 913   (let ((a-local (if a (downcase a) nil))
 914         (b-local (if b (downcase b) nil)))
 915     (equal a-local b-local)))
 916
 917 ;; XEmacs 19.11 & 19.12 gives back a single char when matching an empty regular
 918 ;; expression. Therefore, the next 2 functions are longer than necessary.
 919
 920 (defsubst f90-looking-at-do ()
 921   "Return (\"do\" name) if a do statement starts after point.
 922 Name is nil if the statement has no label."
 923   (if (looking-at "\\(\\(\\sw+\\)[ \t]*\:\\)?[ \t]*\\(do\\)\\>")
 924       (let (label
 925             (struct (match-string 3)))
 926         (if (looking-at "\\(\\sw+\\)[ \t]*\:")
 927             (setq label (match-string 1)))
 928         (list struct label))))
 929
 930 (defsubst f90-looking-at-select-case ()
 931   "Return (\"select\" name) if a select-case statement starts after point.
 932 Name is nil if the statement has no label."
 933   (if (looking-at "\\(\\(\\sw+\\)[ \t]*\:\\)?[ \t]*\\(select\\)[ \t]*case[ \t]*(")
 934       (let (label
 935             (struct (match-string 3)))
 936         (if (looking-at "\\(\\sw+\\)[ \t]*\:")
 937             (setq label (match-string 1)))
 938         (list struct label))))
 939
 940 (defsubst f90-looking-at-if-then ()
 941   "Return (\"if\" name) if an if () then statement starts after point.
 942 Name is nil if the statement has no label."
 943   (save-excursion
 944     (let (struct (label nil))
 945       (if (looking-at "\\(\\(\\sw+\\)[ \t]*\:\\)?[ \t]*\\(if\\)\\>")
 946           (progn
 947             (setq struct (match-string 3))
 948             (if (looking-at "\\(\\sw+\\)[ \t]*\:")
 949                 (setq label (match-string 1)))
 950             (let ((pos (scan-lists (point) 1 0)))
 951               (and pos (goto-char pos)))
 952             (skip-chars-forward " \t")
 953             (if (or (looking-at "then\\>")
 954                     (if (f90-line-continued)
 955                         (progn
 956                           (f90-next-statement)
 957                           (skip-chars-forward " \t0-9&")
 958                           (looking-at "then\\>"))))
 959                 (list struct label)))))))
 960
 961 (defsubst f90-looking-at-where-or-forall ()
 962   "Return (kind name) if a where or forall block starts after point.
 963 Name is nil if the statement has no label."
 964   (if (looking-at "\\(\\(\\sw+\\)[ \t]*\:\\)?[ \t]*\\(where\\|forall\\)[ \t]*(.*)[ \t]*\\(!\\|$\\)")
 965       (let (label
 966             (struct (match-string 3)))
 967         (if (looking-at "\\(\\sw+\\)[ \t]*\:")
 968             (setq label (match-string 1)))
 969         (list struct label))))
 970
 971 (defsubst f90-looking-at-type-like ()
 972   "Return (kind name) at the start of a type/interface/block-data block.
 973 Name is non-nil only for type."
 974   (cond
 975    ((looking-at f90-type-def-re)
 976     (list (match-string 1) (match-string 4)))
 977    ((looking-at "\\(interface\\|block[\t]*data\\)\\>")
 978     (list (match-string 1) nil))))
 979
 980 (defsubst f90-looking-at-program-block-start ()
 981   "Return (kind name) if a program block with name name starts after point."
 982   (cond
 983    ((looking-at "\\(program\\)[ \t]+\\(\\sw+\\)\\>")
 984     (list (match-string 1) (match-string 2)))
 985    ((and (not (looking-at "module[ \t]*procedure\\>"))
 986          (looking-at "\\(module\\)[ \t]+\\(\\sw+\\)\\>"))
 987     (list (match-string 1) (match-string 2)))
 988    ((and (not (looking-at "end[ \t]*\\(function\\|subroutine\\)"))
 989          (looking-at "[^!'\"\&\n]*\\(function\\|subroutine\\)[ \t]+\\(\\sw+\\)"))
 990     (list (match-string 1) (match-string 2)))))
 991
 992 (defsubst f90-looking-at-program-block-end ()
 993   "Return list of type and name of end of block."
 994   (if (looking-at (concat "end[ \t]*" f90-blocks-re
 995                           "?\\([ \t]+\\(\\sw+\\)\\)?\\>"))
 996       (list (match-string 1) (match-string 3))))
 997
 998 (defsubst f90-comment-indent ()
 999   (cond ((looking-at "!!!") 0)
1000         ((and f90-directive-comment-re
1001               (looking-at f90-directive-comment-re)) 0)
1002         ((looking-at (regexp-quote f90-comment-region)) 0)
1003         ((and (looking-at f90-indented-comment-re)
1004               ;; Don't attempt to indent trailing comment as code.
1005               (save-excursion
1006                 (skip-chars-backward " \t")
1007                 (bolp)))
1008          (f90-calculate-indent))
1009         (t (skip-chars-backward " \t")
1010            (max (if (bolp) 0 (1+ (current-column))) comment-column))))
1011
1012 (defsubst f90-present-statement-cont ()
1013   "Return continuation properties of present statement."
1014   (let (pcont cont)
1015     (save-excursion
1016       (setq pcont (if (f90-previous-statement) (f90-line-continued) nil)))
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)))))
1023
1024 (defsubst f90-indent-line-no ()
1025   (if f90-leave-line-no
1026       ()
1027     (if (and (not (zerop (skip-chars-forward " \t")))
1028              (looking-at "[0-9]"))
1029         (delete-horizontal-space)))
1030   (skip-chars-forward " \t0-9"))
1031
1032 (defsubst f90-no-block-limit ()
1033   (let ((eol (line-end-position)))
1034     (save-excursion
1035       (not (or (looking-at "end")
1036                (looking-at "\\(do\\|if\\|else\\(if\\|where\\)?\
1037 \\|select[ \t]*case\\|case\\|where\\|forall\\)\\>")
1038                (looking-at "\\(program\\|module\\|interface\\|\
1039 block[ \t]*data\\)\\>")
1040                (looking-at "\\(contains\\|\\sw+[ \t]*:\\)")
1041                (looking-at f90-type-def-re)
1042                (re-search-forward "\\(function\\|subroutine\\)" eol t))))))
1043
1044 (defsubst f90-update-line ()
1045   (let (bol eol)
1046     (if f90-auto-keyword-case
1047         (progn (setq bol (line-beginning-position)
1048                      eol (line-end-position))
1049                (if f90-auto-keyword-case
1050                    (f90-change-keywords f90-auto-keyword-case bol eol))))))
1051 \f
1052 (defun f90-electric-insert ()
1053   "Call `f90-do-auto-fill' at each operator insertion."
1054   (interactive)
1055   (self-insert-command 1)
1056   (f90-update-line)
1057   (if auto-fill-function (f90-do-auto-fill)))
1058
1059 (defun f90-get-correct-indent ()
1060   "Get correct indent for a line starting with line number.
1061 Does not check type and subprogram indentation."
1062   (let ((epnt (line-end-position)) icol cont)
1063     (save-excursion
1064       (while (and (f90-previous-statement)
1065                   (or (progn
1066                         (setq cont (f90-present-statement-cont))
1067                         (or (eq cont 'end) (eq cont 'middle)))
1068                       (looking-at "[ \t]*[0-9]"))))
1069       (setq icol (current-indentation))
1070       (beginning-of-line)
1071       (if (re-search-forward "\\(if\\|do\\|select\\|where\\|forall\\)"
1072                              (line-end-position) t)
1073           (progn
1074             (beginning-of-line) (skip-chars-forward " \t")
1075             (cond ((f90-looking-at-do)
1076                    (setq icol (+ icol f90-do-indent)))
1077                   ((or (f90-looking-at-if-then)
1078                        (f90-looking-at-where-or-forall)
1079                        (f90-looking-at-select-case))
1080                    (setq icol (+ icol f90-if-indent))))
1081             (end-of-line)))
1082       (while (re-search-forward
1083               "\\(if\\|do\\|select\\|where\\|forall\\)" epnt t)
1084         (beginning-of-line) (skip-chars-forward " \t0-9")
1085         (cond  ((f90-looking-at-do)
1086                 (setq icol (+ icol f90-do-indent)))
1087                ((or (f90-looking-at-if-then)
1088                     (f90-looking-at-where-or-forall)
1089                     (f90-looking-at-select-case))
1090                 (setq icol (+ icol f90-if-indent)))
1091                ((looking-at f90-end-if-re)
1092                 (setq icol (- icol f90-if-indent)))
1093                ((looking-at "end[ \t]*do\\>")
1094                 (setq icol (- icol f90-do-indent))))
1095         (end-of-line))
1096       icol)))
1097
1098
1099 (defun f90-calculate-indent ()
1100   "Calculate the indent column based on previous statements."
1101   (interactive)
1102   (let (icol cont (case-fold-search t) (pnt (point)))
1103     (save-excursion
1104       (if (not (f90-previous-statement))
1105           (setq icol 0)
1106         (setq cont (f90-present-statement-cont))
1107         (if (eq cont 'end)
1108             (while (not (eq 'begin (f90-present-statement-cont)))
1109               (f90-previous-statement)))
1110         (cond ((eq cont 'begin)
1111                (setq icol (+ (f90-current-indentation)
1112                              f90-continuation-indent)))
1113               ((eq cont 'middle) (setq icol(current-indentation)))
1114               (t (setq icol (f90-current-indentation))
1115                  (skip-chars-forward " \t")
1116                  (if (looking-at "[0-9]")
1117                      (setq icol (f90-get-correct-indent))
1118                    (cond ((or (f90-looking-at-if-then)
1119                               (f90-looking-at-where-or-forall)
1120                               (f90-looking-at-select-case)
1121                               (looking-at f90-else-like-re))
1122                           (setq icol (+ icol f90-if-indent)))
1123                          ((f90-looking-at-do)
1124                           (setq icol (+ icol f90-do-indent)))
1125                          ((f90-looking-at-type-like)
1126                           (setq icol (+ icol f90-type-indent)))
1127                          ((or (f90-looking-at-program-block-start)
1128                               (looking-at "contains[ \t]*\\($\\|!\\)"))
1129                           (setq icol (+ icol f90-program-indent)))))
1130                  (goto-char pnt)
1131                  (beginning-of-line)
1132                  (cond ((looking-at "[ \t]*$"))
1133                        ((looking-at "[ \t]*#") ; Check for cpp directive.
1134                         (setq icol 0))
1135                        (t
1136                         (skip-chars-forward " \t0-9")
1137                         (cond ((or (looking-at f90-else-like-re)
1138                                    (looking-at f90-end-if-re))
1139                                (setq icol (- icol f90-if-indent)))
1140                               ((looking-at "end[ \t]*do\\>")
1141                                (setq icol (- icol f90-do-indent)))
1142                               ((looking-at f90-end-type-re)
1143                                (setq icol (- icol f90-type-indent)))
1144                               ((or (looking-at "contains[ \t]*\\(!\\|$\\)")
1145                                    (f90-looking-at-program-block-end))
1146                                (setq icol (- icol f90-program-indent))))))
1147                  ))))
1148     icol))
1149 \f
1150 ;; Statement = statement line, a line which is neither blank, nor a comment.
1151 (defun f90-previous-statement ()
1152   "Move point to beginning of the previous F90 statement.
1153 Return nil if no previous statement is found."
1154   (interactive)
1155   (let (not-first-statement)
1156     (beginning-of-line)
1157     (while (and (setq not-first-statement (zerop (forward-line -1)))
1158                 (looking-at "[ \t0-9]*\\(!\\|$\\|#\\)")))
1159     not-first-statement))
1160
1161 (defun f90-next-statement ()
1162   "Move point to beginning of the next F90 statement.
1163 Return nil if no later statement is found."
1164   (interactive)
1165   (let (not-last-statement)
1166     (beginning-of-line)
1167     (while (and (setq not-last-statement
1168                       (and (zerop (forward-line 1))
1169                            (not (eobp))))
1170                 (looking-at "[ \t0-9]*\\(!\\|$\\)")))
1171     not-last-statement))
1172
1173 (defun f90-beginning-of-subprogram ()
1174   "Move point to the beginning of subprogram.
1175 Return (type name) or nil if not found."
1176   (interactive)
1177   (let ((count 1) (case-fold-search t) matching-beg)
1178     (beginning-of-line) (skip-chars-forward " \t0-9")
1179     (if (setq matching-beg (f90-looking-at-program-block-start))
1180         (setq count (- count 1)))
1181     (while (and (not (zerop count))
1182                 (re-search-backward f90-program-block-re nil 'move))
1183       (beginning-of-line) (skip-chars-forward " \t0-9")
1184       (cond
1185        ((setq matching-beg (f90-looking-at-program-block-start))
1186         (setq count (- count 1)))
1187        ((f90-looking-at-program-block-end)
1188         (setq count (+ count 1)))))
1189     (beginning-of-line)
1190     (if (zerop count)
1191         matching-beg
1192       (message "No beginning-found.")
1193       nil)))
1194
1195 (defun f90-end-of-subprogram ()
1196   "Move point to the end of subprogram.
1197 Return (type name) or nil if not found."
1198   (interactive)
1199   (let ((count 1) (case-fold-search t) matching-end)
1200     (beginning-of-line) (skip-chars-forward " \t0-9")
1201     (if (setq matching-end (f90-looking-at-program-block-end))
1202         (setq count (1- count)))
1203     (end-of-line)
1204     (while (and (not (zerop count))
1205                 (re-search-forward f90-program-block-re nil 'move))
1206       (beginning-of-line) (skip-chars-forward " \t0-9")
1207       (cond ((f90-looking-at-program-block-start)
1208              (setq count (+ count 1)))
1209             ((setq matching-end (f90-looking-at-program-block-end))
1210              (setq count (1- count ))))
1211       (end-of-line))
1212     (forward-line 1)
1213     (if (zerop count)
1214         matching-end
1215       (message "No end found.")
1216       nil)))
1217
1218 (defvar f90-mark-subprogram-overlay nil
1219   "Used internally by `f90-mark-subprogram' to highlight the subprogram.")
1220 (make-variable-buffer-local 'f90-mark-subprogram-overlay)
1221
1222 (defun f90-mark-subprogram ()
1223   "Put mark at end of F90 subprogram, point at beginning, push marks.
1224 If called interactively, highlight the subprogram with the face `highlight'.
1225 Call again to remove the highlighting."
1226   (interactive)
1227   (let ((pos (point)) program)
1228     (f90-end-of-subprogram)
1229     (push-mark (point) t)
1230     (goto-char pos)
1231     (setq program (f90-beginning-of-subprogram))
1232     ;; The keywords in the preceding lists assume case-insensitivity.
1233     (if f90-xemacs-flag
1234         (zmacs-activate-region)
1235       (setq mark-active t
1236             deactivate-mark nil)
1237       (if (interactive-p)
1238           (if (overlayp f90-mark-subprogram-overlay)
1239               (if (overlay-buffer f90-mark-subprogram-overlay)
1240                   (delete-overlay f90-mark-subprogram-overlay)
1241                 (move-overlay f90-mark-subprogram-overlay (point) (mark)))
1242             (setq f90-mark-subprogram-overlay (make-overlay (point) (mark)))
1243             (overlay-put f90-mark-subprogram-overlay 'face 'highlight))))
1244     program))
1245
1246 (defun f90-comment-region (beg-region end-region)
1247   "Comment/uncomment every line in the region.
1248 Insert f90-comment-region at the beginning of every line in the region
1249 or, if already present, remove it."
1250   (interactive "*r")
1251   (let ((end (make-marker)))
1252     (set-marker end end-region)
1253     (goto-char beg-region)
1254     (beginning-of-line)
1255     (if (looking-at (regexp-quote f90-comment-region))
1256         (delete-region (point) (match-end 0))
1257       (insert f90-comment-region))
1258     (while (and  (zerop (forward-line 1))
1259                  (< (point) (marker-position end)))
1260       (if (looking-at (regexp-quote f90-comment-region))
1261           (delete-region (point) (match-end 0))
1262         (insert f90-comment-region)))
1263     (set-marker end nil)))
1264
1265 (defun f90-indent-line (&optional no-update)
1266   "Indent current line as F90 code.
1267 Unless optional argument NO-UPDATE is non-nil, call `f90-update-line'
1268 after indenting."
1269   (interactive)
1270   (let (indent (no-line-number nil) (pos (make-marker)) (case-fold-search t))
1271     (set-marker pos (point))
1272     (beginning-of-line)                 ; Digits after & \n are not line-no
1273     (if (save-excursion (and (f90-previous-statement) (f90-line-continued)))
1274         (progn (setq no-line-number t) (skip-chars-forward " \t"))
1275       (f90-indent-line-no))
1276     (if (looking-at "!")
1277         (setq indent (f90-comment-indent))
1278       (if (and (looking-at "end") f90-smart-end)
1279             (f90-match-end))
1280       (setq indent (f90-calculate-indent)))
1281     (if (zerop (- indent (current-column)))
1282         nil
1283       (f90-indent-to indent no-line-number))
1284     ;; If initial point was within line's indentation,
1285     ;; position after the indentation.  Else stay at same point in text.
1286     (if (< (point) (marker-position pos))
1287         (goto-char (marker-position pos)))
1288     (if (not no-update) (f90-update-line))
1289     (if auto-fill-function (f90-do-auto-fill))
1290     (set-marker pos nil)))
1291
1292 (defun f90-indent-new-line ()
1293   "Reindent current line, insert a newline and indent the newline.
1294 An abbrev before point is expanded if the variable `abbrev-mode' is non-nil.
1295 If run in the middle of a line, the line is not broken."
1296   (interactive)
1297   (let (string cont (case-fold-search t))
1298     (if abbrev-mode (expand-abbrev))
1299     (beginning-of-line)                 ; Reindent where likely to be needed.
1300     (f90-indent-line-no)
1301     (if (or (looking-at "\\(end\\|else\\|!\\)"))
1302         (f90-indent-line 'no-update))
1303     (end-of-line)
1304     (delete-horizontal-space)           ;Destroy trailing whitespace
1305     (setq string (f90-in-string))
1306     (setq cont (f90-line-continued))
1307     (if (and string (not cont)) (insert "&"))
1308     (f90-update-line)
1309     (newline)
1310     (if (or string (and cont f90-beginning-ampersand)) (insert "&"))
1311     (f90-indent-line 'no-update)))
1312
1313
1314 (defun f90-indent-region (beg-region end-region)
1315   "Indent every line in region by forward parsing."
1316   (interactive "*r")
1317   (let ((end-region-mark (make-marker)) (save-point (point-marker))
1318         (block-list nil) ind-lev ind-curr ind-b cont
1319         struct beg-struct end-struct)
1320     (set-marker end-region-mark end-region)
1321     (goto-char beg-region)
1322     ;; first find a line which is not a continuation line or comment
1323     (beginning-of-line)
1324     (while (and (looking-at "[ \t]*[0-9]*\\(!\\|#\\|[ \t]*$\\)")
1325                 (progn (f90-indent-line 'no-update)
1326                        (zerop (forward-line 1)))
1327                 (< (point) end-region-mark)))
1328     (setq cont (f90-present-statement-cont))
1329     (while (and (or (eq cont 'middle) (eq cont 'end))
1330                 (f90-previous-statement))
1331       (setq cont (f90-present-statement-cont)))
1332     ;; process present line for beginning of block
1333     (setq f90-cache-position (point))
1334     (f90-indent-line 'no-update)
1335     (setq ind-lev (f90-current-indentation))
1336     (setq ind-curr ind-lev)
1337     (beginning-of-line) (skip-chars-forward " \t0-9")
1338     (setq struct nil)
1339     (setq ind-b (cond ((setq struct (f90-looking-at-do)) f90-do-indent)
1340                       ((or (setq struct (f90-looking-at-if-then))
1341                            (setq struct (f90-looking-at-select-case))
1342                            (setq struct (f90-looking-at-where-or-forall))
1343                            (looking-at f90-else-like-re))
1344                        f90-if-indent)
1345                       ((setq struct (f90-looking-at-type-like))
1346                        f90-type-indent)
1347                       ((or(setq struct (f90-looking-at-program-block-start))
1348                           (looking-at "contains[ \t]*\\($\\|!\\)"))
1349                        f90-program-indent)))
1350     (if ind-b (setq ind-lev (+ ind-lev ind-b)))
1351     (if struct (setq block-list (cons struct block-list)))
1352     (while (and (f90-line-continued) (zerop (forward-line 1))
1353                 (< (point) end-region-mark))
1354       (if (not (zerop (- (current-indentation)
1355                          (+ ind-curr f90-continuation-indent))))
1356           (f90-indent-to (+ ind-curr f90-continuation-indent) 'no-line-no)))
1357     ;; process all following lines
1358     (while (and  (zerop (forward-line 1)) (< (point) end-region-mark))
1359       (beginning-of-line)
1360       (f90-indent-line-no)
1361       (setq f90-cache-position (point))
1362       (cond ((looking-at "[ \t]*$") (setq ind-curr 0))
1363             ((looking-at "[ \t]*#") (setq ind-curr 0))
1364             ((looking-at "!") (setq ind-curr (f90-comment-indent)))
1365             ((f90-no-block-limit) (setq ind-curr ind-lev))
1366             ((looking-at f90-else-like-re) (setq ind-curr
1367                                                  (- ind-lev f90-if-indent)))
1368             ((looking-at "contains[ \t]*\\($\\|!\\)")
1369              (setq ind-curr (- ind-lev f90-program-indent)))
1370             ((setq ind-b
1371                    (cond ((setq struct (f90-looking-at-do)) f90-do-indent)
1372                          ((or (setq struct (f90-looking-at-if-then))
1373                               (setq struct (f90-looking-at-select-case))
1374                               (setq struct (f90-looking-at-where-or-forall)))
1375                           f90-if-indent)
1376                          ((setq struct (f90-looking-at-type-like))
1377                           f90-type-indent)
1378                          ((setq struct (f90-looking-at-program-block-start))
1379                           f90-program-indent)))
1380              (setq ind-curr ind-lev)
1381              (if ind-b (setq ind-lev (+ ind-lev ind-b)))
1382              (setq block-list (cons struct block-list)))
1383             ((setq end-struct (f90-looking-at-program-block-end))
1384              (setq beg-struct (car block-list)
1385                    block-list (cdr block-list))
1386              (if f90-smart-end
1387                  (save-excursion
1388                    (f90-block-match (car beg-struct)(car (cdr beg-struct))
1389                                     (car end-struct)(car (cdr end-struct)))))
1390              (setq ind-b
1391                    (cond ((looking-at f90-end-if-re) f90-if-indent)
1392                          ((looking-at "end[ \t]*do\\>")  f90-do-indent)
1393                          ((looking-at f90-end-type-re) f90-type-indent)
1394                          ((f90-looking-at-program-block-end)
1395                           f90-program-indent)))
1396              (if ind-b (setq ind-lev (- ind-lev ind-b)))
1397              (setq ind-curr ind-lev))
1398             (t (setq ind-curr ind-lev)))
1399       ;; do the indentation if necessary
1400       (if (not (zerop (- ind-curr (current-column))))
1401           (f90-indent-to ind-curr))
1402       (while (and (f90-line-continued) (zerop (forward-line 1))
1403                   (< (point) end-region-mark))
1404         (if (not (zerop (- (current-indentation)
1405                            (+ ind-curr f90-continuation-indent))))
1406             (f90-indent-to (+ ind-curr f90-continuation-indent) 'no-line-no))))
1407     ;; restore point etc
1408     (setq f90-cache-position nil)
1409     (goto-char save-point)
1410     (set-marker end-region-mark nil)
1411     (set-marker save-point nil)
1412     (if f90-xemacs-flag
1413         (zmacs-deactivate-region)
1414       (deactivate-mark))))
1415
1416 (defun f90-indent-subprogram ()
1417   "Properly indent the subprogram which contains point."
1418   (interactive)
1419   (save-excursion
1420     (let (program)
1421       (setq program (f90-mark-subprogram))
1422       (if program
1423           (progn
1424             (message "Indenting %s %s..."
1425                      (car program) (car (cdr program)))
1426             (indent-region (point) (mark) nil)
1427             (message "Indenting %s %s...done"
1428                      (car program) (car (cdr program))))
1429         (message "Indenting the whole file...")
1430         (indent-region (point) (mark) nil)
1431         (message "Indenting the whole file...done")))))
1432
1433 ;; autofill and break-line
1434 (defun f90-break-line (&optional no-update)
1435   "Break line at point, insert continuation marker(s) and indent.
1436 Unless in a string or comment, or if the optional argument NO-UPDATE
1437 is non-nil, call `f90-update-line' after inserting the continuation marker."
1438   (interactive)
1439   (let (ctype)
1440     (cond ((f90-in-string)
1441            (insert "&") (newline 1) (insert "&"))
1442           ((f90-in-comment)
1443            (setq ctype (f90-get-present-comment-type))
1444            (newline 1)
1445            (insert ctype))
1446           (t (insert "&")
1447              (if (not no-update) (f90-update-line))
1448              (newline 1)
1449              (if f90-beginning-ampersand (insert "&")))))
1450   (indent-according-to-mode))
1451
1452 (defun f90-find-breakpoint ()
1453   "From `fill-column', search backward for break-delimiter."
1454   (let ((bol (line-beginning-position)))
1455     (re-search-backward f90-break-delimiters bol)
1456     (if f90-break-before-delimiters
1457         (progn (backward-char)
1458                (if (not (looking-at f90-no-break-re))
1459                    (forward-char)))
1460       (if (looking-at f90-no-break-re)
1461           (forward-char 2)
1462         (forward-char)))))
1463
1464 (defun f90-do-auto-fill ()
1465   "Break line if non-white characters beyond `fill-column'. Also, update line."
1466   (interactive)
1467   ;; Break the line before or after the last delimiter (non-word char) if
1468   ;; position is beyond fill-column.
1469   ;; Will not break **, //, or => (specified by f90-no-break-re).
1470   (f90-update-line)
1471   (while (> (current-column) fill-column)
1472       (let ((pos-mark (point-marker)))
1473         (move-to-column fill-column)
1474         (if (not (f90-in-string))
1475             (f90-find-breakpoint))
1476         (f90-break-line)
1477         (goto-char pos-mark)
1478         (set-marker pos-mark nil))))
1479
1480
1481 (defun f90-join-lines ()
1482   "Join present line with next line, if this line ends with \&."
1483   (interactive)
1484   (let (pos (oldpos (point)))
1485     (end-of-line)
1486     (skip-chars-backward " \t")
1487     (cond ((= (preceding-char) ?&)
1488            (delete-char -1)
1489            (setq pos (point))
1490            (forward-line 1)
1491            (skip-chars-forward " \t")
1492            (if (looking-at "\&") (delete-char 1))
1493            (delete-region pos (point))
1494            (if (not (f90-in-string))
1495                (progn (delete-horizontal-space) (insert " ")))
1496            (if (and auto-fill-function
1497                     (> (save-excursion (end-of-line)
1498                                        (current-column))
1499                        fill-column))
1500                (f90-do-auto-fill))
1501            (goto-char oldpos)
1502            t))))
1503
1504 (defun f90-fill-region (beg-region end-region)
1505   "Fill every line in region by forward parsing. Join lines if possible."
1506   (interactive "*r")
1507   (let ((end-region-mark (make-marker))
1508         (f90-smart-end nil) (f90-auto-keyword-case nil) (go-on t)
1509         (auto-fill-function nil))
1510     (set-marker end-region-mark end-region)
1511     (goto-char beg-region)
1512     (while go-on
1513       ;; join as much as possible
1514       (while (f90-join-lines))
1515       ;; chop the line if necessary
1516       (while (> (save-excursion (end-of-line) (current-column))
1517                 fill-column)
1518         (move-to-column fill-column)
1519         (f90-find-breakpoint)
1520         (f90-break-line 'no-update))
1521       (setq go-on (and  (< (point) (marker-position end-region-mark))
1522                         (zerop (forward-line 1))))
1523       (setq f90-cache-position (point)))
1524     (setq f90-cache-position nil)
1525     (if f90-xemacs-flag
1526         (zmacs-deactivate-region)
1527       (deactivate-mark))))
1528 \f
1529 (defun f90-block-match (beg-block beg-name end-block end-name)
1530   "Match end-struct with beg-struct and complete end-block if possible.
1531 Leave point at the end of line."
1532   (search-forward "end" (line-end-position))
1533   (catch 'no-match
1534     (if (not (f90-equal-symbols beg-block end-block))
1535         (if end-block
1536             (progn
1537               (message "END %s does not match %s." end-block beg-block)
1538               (end-of-line)
1539               (throw 'no-match nil))
1540           (message "Inserting %s." beg-block)
1541           (insert (concat " " beg-block)))
1542       (search-forward end-block))
1543     (if (not (f90-equal-symbols beg-name end-name))
1544         (cond ((and beg-name (not end-name))
1545                (message "Inserting %s." beg-name)
1546                (insert (concat " " beg-name)))
1547               ((and beg-name end-name)
1548                (message "Replacing %s with %s." end-name beg-name)
1549                (search-forward end-name)
1550                (replace-match beg-name))
1551               ((and (not beg-name) end-name)
1552                (message "Deleting %s." end-name)
1553                (search-forward end-name)
1554                (replace-match "")))
1555       (if end-name (search-forward end-name)))
1556     (if (not (looking-at "[ \t]*!")) (delete-horizontal-space))))
1557
1558 (defun f90-match-end ()
1559   "From an end foo statement, find the corresponding foo including name."
1560   (interactive)
1561   (let ((count 1) (top-of-window (window-start)) (matching-beg nil)
1562         (end-point (point)) (case-fold-search t)
1563         beg-name end-name beg-block end-block end-struct)
1564     (if (save-excursion (beginning-of-line) (skip-chars-forward " \t0-9")
1565                         (setq end-struct (f90-looking-at-program-block-end)))
1566         (progn
1567           (setq end-block (car end-struct))
1568           (setq end-name  (car (cdr end-struct)))
1569           (save-excursion
1570             (beginning-of-line)
1571             (while
1572                 (and (not (zerop count))
1573                      (let ((stop nil) notexist)
1574                        (while (not stop)
1575                          (setq notexist
1576                                (not (re-search-backward
1577                                      (concat "\\(" f90-blocks-re "\\)") nil t)))
1578                          (if notexist
1579                              (setq stop t)
1580                            (setq stop
1581                                  (not (or (f90-in-string)
1582                                           (f90-in-comment))))))
1583                        (not notexist)))
1584               (beginning-of-line) (skip-chars-forward " \t0-9")
1585               (cond ((setq matching-beg
1586                            (cond
1587                             ((f90-looking-at-do))
1588                             ((f90-looking-at-if-then))
1589                             ((f90-looking-at-where-or-forall))
1590                             ((f90-looking-at-select-case))
1591                             ((f90-looking-at-type-like))
1592                             ((f90-looking-at-program-block-start))))
1593                      (setq count (- count 1)))
1594                     ((looking-at (concat "end[ \t]*" f90-blocks-re "\\b"))
1595                      (setq count (+ count 1)))))
1596             (if (not (zerop count))
1597                 (message "No matching beginning.")
1598               (f90-update-line)
1599               (if (eq f90-smart-end 'blink)
1600                   (if (< (point) top-of-window)
1601                       (message "Matches %s: %s"
1602                                (what-line)
1603                                (buffer-substring
1604                                 (line-beginning-position)
1605                                 (line-end-position)))
1606                     (sit-for 1)))
1607               (setq beg-block (car matching-beg))
1608               (setq beg-name (car (cdr matching-beg)))
1609               (goto-char end-point)
1610               (beginning-of-line)
1611               (f90-block-match beg-block beg-name end-block end-name)))))))
1612
1613 (defun f90-insert-end ()
1614   "Insert a complete end statement matching beginning of present block."
1615   (interactive)
1616   (let ((f90-smart-end (if f90-smart-end f90-smart-end 'blink)))
1617     (insert "end")
1618     (f90-indent-new-line)))
1619 \f
1620 ;; abbrevs and keywords
1621
1622 (defun f90-abbrev-start ()
1623   "Typing `\\[help-command] or `? lists all the F90 abbrevs.
1624 Any other key combination is executed normally."
1625   (interactive)
1626   (let (e c)
1627     (insert last-command-char)
1628     (if (not f90-xemacs-flag)
1629         (setq c (read-event))
1630       (setq e (next-command-event)
1631             c (event-to-character e)))
1632     ;; insert char if not equal to `?'
1633     (if (or (eq c ??) (eq c help-char))
1634         (f90-abbrev-help)
1635       (if f90-xemacs-flag
1636           (setq unread-command-event e)
1637         (setq unread-command-events (list c))))))
1638
1639 (defun f90-abbrev-help ()
1640   "List the currently defined abbrevs in F90 mode."
1641   (interactive)
1642   (message "Listing abbrev table...")
1643   (display-buffer (f90-prepare-abbrev-list-buffer))
1644   (message "Listing abbrev table...done"))
1645
1646 (defun f90-prepare-abbrev-list-buffer ()
1647   (save-excursion
1648     (set-buffer (get-buffer-create "*Abbrevs*"))
1649     (erase-buffer)
1650     (insert-abbrev-table-description 'f90-mode-abbrev-table t)
1651     (goto-char (point-min))
1652     (set-buffer-modified-p nil)
1653     (edit-abbrevs-mode))
1654   (get-buffer-create "*Abbrevs*"))
1655
1656 (defun f90-upcase-keywords ()
1657   "Upcase all F90 keywords in the buffer."
1658   (interactive)
1659   (f90-change-keywords 'upcase-word))
1660
1661 (defun f90-capitalize-keywords ()
1662   "Capitalize all F90 keywords in the buffer."
1663   (interactive)
1664   (f90-change-keywords 'capitalize-word))
1665
1666 (defun f90-downcase-keywords ()
1667   "Downcase all F90 keywords in the buffer."
1668   (interactive)
1669   (f90-change-keywords 'downcase-word))
1670
1671 (defun f90-upcase-region-keywords (beg end)
1672   "Upcase all F90 keywords in the region."
1673   (interactive "*r")
1674   (f90-change-keywords 'upcase-word beg end))
1675
1676 (defun f90-capitalize-region-keywords (beg end)
1677   "Capitalize all F90 keywords in the region."
1678   (interactive "*r")
1679   (f90-change-keywords 'capitalize-word beg end))
1680
1681 (defun f90-downcase-region-keywords (beg end)
1682   "Downcase all F90 keywords in the region."
1683   (interactive "*r")
1684   (f90-change-keywords 'downcase-word beg end))
1685
1686 ;; Change the keywords according to argument.
1687 (defun f90-change-keywords (change-word &optional beg end)
1688   (save-excursion
1689     (setq beg (if beg beg (point-min)))
1690     (setq end (if end end (point-max)))
1691     (let ((keyword-re
1692            (concat "\\("
1693                    f90-keywords-re "\\|" f90-procedures-re "\\|"
1694                    f90-hpf-keywords-re "\\|" f90-operators-re "\\)"))
1695           (ref-point (point-min)) state
1696           (modified (buffer-modified-p)) saveword back-point)
1697       (goto-char beg)
1698       (unwind-protect
1699           (while (re-search-forward keyword-re end t)
1700             (if (progn
1701                   (setq state (parse-partial-sexp ref-point (point)))
1702                   (or (nth 3 state) (nth 4 state)
1703                       (save-excursion   ; Check for cpp directive.
1704                         (beginning-of-line)
1705                         (skip-chars-forward " \t0-9")
1706                         (looking-at "#"))))
1707                 ()
1708               (setq ref-point (point)
1709                     back-point (save-excursion (backward-word 1) (point)))
1710               (setq saveword (buffer-substring back-point ref-point))
1711               (funcall change-word -1)
1712               (or (string= saveword (buffer-substring back-point ref-point))
1713                   (setq modified t))))
1714         (or modified (set-buffer-modified-p nil))))))
1715
1716
1717 (defun f90-current-defun ()
1718   "Function to use for `add-log-current-defun-function' in F90 mode."
1719   (save-excursion
1720     (nth 1 (f90-beginning-of-subprogram))))
1721
1722 (provide 'f90)
1723
1724 ;;; f90.el ends here