code.delx.au - gnu-emacs/blob - lisp/progmodes/f90.el

   1 ;;; f90.el --- Fortran-90 mode (free format)
   2
   3 ;; Copyright (C) 1995, 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2005,
   4 ;;   2006, 2007, 2008  Free Software Foundation, Inc.
   5
   6 ;; Author: Torbj\"orn Einarsson <Torbjorn.Einarsson@era.ericsson.se>
   7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
   8 ;; Keywords: fortran, f90, languages
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; Major mode for editing F90 programs in FREE FORMAT.
  28 ;; The minor language revision F95 is also supported (with font-locking).
  29 ;; Some/many (?) aspects of F2003 are supported.
  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 ;; For example, `i expands to integer (if abbrev-mode is on).
  41
  42 ;; There are two separate features for altering the appearance of code:
  43 ;;   1) Upcasing or capitalizing of all keywords.
  44 ;;   2) Colors/fonts using font-lock-mode.
  45 ;; Automatic upcase or downcase of keywords is controlled by the variable
  46 ;; f90-auto-keyword-case.
  47
  48 ;; The indentations of lines starting with ! is determined by the first of the
  49 ;; following matches (values in the left column are the defaults):
  50
  51 ;; start-string/regexp  indent         variable holding start-string/regexp
  52 ;;    !!!                  0
  53 ;;    !hpf\\$ (re)         0              f90-directive-comment-re
  54 ;;    !!$                  0              f90-comment-region
  55 ;;    !      (re)        as code          f90-indented-comment-re
  56 ;;    default            comment-column
  57
  58 ;; Ex: Here is the result of 3 different settings of f90-indented-comment-re
  59 ;;     f90-indented-comment-re  !-indentation      !!-indentation
  60 ;;          !                    as code             as code
  61 ;;          !!                   comment-column      as code
  62 ;;          ![^!]                as code             comment-column
  63 ;; Trailing comments are indented to comment-column with indent-for-comment.
  64 ;; The function f90-comment-region toggles insertion of
  65 ;; the variable f90-comment-region in every line of the region.
  66
  67 ;; One common convention for free vs. fixed format is that free format files
  68 ;; have the ending .f90 or .f95 while fixed format files have the ending .f.
  69 ;; Emacs automatically loads Fortran files in the appropriate mode based
  70 ;; on extension. You can modify this by adjusting the variable auto-mode-alist.
  71 ;; For example:
  72 ;; (add-to-list 'auto-mode-alist '("\\.f\\'" . f90-mode))
  73
  74 ;; Once you have entered f90-mode, you may get more info by using
  75 ;; the command describe-mode (C-h m). For online help use
  76 ;; C-h f <Name of function you want described>, or
  77 ;; C-h v <Name of variable you want described>.
  78
  79 ;; To customize f90-mode for your taste, use, for example:
  80 ;; (you don't have to specify values for all the parameters below)
  81 ;;
  82 ;;(add-hook 'f90-mode-hook
  83 ;;      ;; These are the default values.
  84 ;;      '(lambda () (setq f90-do-indent 3
  85 ;;                        f90-if-indent 3
  86 ;;                        f90-type-indent 3
  87 ;;                        f90-program-indent 2
  88 ;;                        f90-continuation-indent 5
  89 ;;                        f90-comment-region "!!$"
  90 ;;                        f90-directive-comment-re "!hpf\\$"
  91 ;;                        f90-indented-comment-re "!"
  92 ;;                        f90-break-delimiters "[-+\\*/><=,% \t]"
  93 ;;                        f90-break-before-delimiters t
  94 ;;                        f90-beginning-ampersand t
  95 ;;                        f90-smart-end 'blink
  96 ;;                        f90-auto-keyword-case nil
  97 ;;                        f90-leave-line-no nil
  98 ;;                        indent-tabs-mode nil
  99 ;;                        f90-font-lock-keywords f90-font-lock-keywords-2
 100 ;;                  )
 101 ;;       ;; These are not default.
 102 ;;       (abbrev-mode 1)             ; turn on abbreviation mode
 103 ;;       (f90-add-imenu-menu)        ; extra menu with functions etc.
 104 ;;       (if f90-auto-keyword-case   ; change case of all keywords on startup
 105 ;;           (f90-change-keywords f90-auto-keyword-case))
 106 ;;       ))
 107 ;;
 108 ;; in your .emacs file. You can also customize the lists
 109 ;; f90-font-lock-keywords, etc.
 110 ;;
 111 ;; The auto-fill and abbreviation minor modes are accessible from the F90 menu,
 112 ;; or by using M-x auto-fill-mode and M-x abbrev-mode, respectively.
 113
 114 ;; Remarks
 115 ;; 1) Line numbers are by default left-justified. If f90-leave-line-no is
 116 ;;    non-nil, the line numbers are never touched.
 117 ;; 2) Multi-; statements like "do i=1,20 ; j=j+i ; end do" are not handled
 118 ;;    correctly, but I imagine them to be rare.
 119 ;; 3) Regexps for hilit19 are no longer supported.
 120 ;; 4) For FIXED FORMAT code, use fortran mode.
 121 ;; 5) This mode does not work under emacs-18.x.
 122 ;; 6) Preprocessor directives, i.e., lines starting with # are left-justified
 123 ;;    and are untouched by all case-changing commands. There is, at present, no
 124 ;;    mechanism for treating multi-line directives (continued by \ ).
 125 ;; 7) f77 do-loops do 10 i=.. ; ; 10 continue are not correctly indented.
 126 ;;    You are urged to use f90-do loops (with labels if you wish).
 127 ;; 8) The highlighting mode under XEmacs is not as complete as under Emacs.
 128
 129 ;; List of user commands
 130 ;;   f90-previous-statement         f90-next-statement
 131 ;;   f90-beginning-of-subprogram    f90-end-of-subprogram   f90-mark-subprogram
 132 ;;   f90-comment-region
 133 ;;   f90-indent-line                f90-indent-new-line
 134 ;;   f90-indent-region    (can be called by calling indent-region)
 135 ;;   f90-indent-subprogram
 136 ;;   f90-break-line                 f90-join-lines
 137 ;;   f90-fill-region
 138 ;;   f90-insert-end
 139 ;;   f90-upcase-keywords            f90-upcase-region-keywords
 140 ;;   f90-downcase-keywords          f90-downcase-region-keywords
 141 ;;   f90-capitalize-keywords        f90-capitalize-region-keywords
 142 ;;   f90-add-imenu-menu
 143 ;;   f90-font-lock-1, f90-font-lock-2, f90-font-lock-3, f90-font-lock-4
 144
 145 ;; Original author's thanks
 146 ;; Thanks to all the people who have tested the mode. Special thanks to Jens
 147 ;; Bloch Helmers for encouraging me to write this code, for creative
 148 ;; suggestions as well as for the lists of hpf-commands.
 149 ;; Also thanks to the authors of the fortran and pascal modes, on which some
 150 ;; of this code is built.
 151
 152 ;;; Code:
 153
 154 ;; TODO
 155 ;; 1. Any missing F2003 syntax?
 156 ;; 2. Have "f90-mode" just recognize F90 syntax, then derived modes
 157 ;; "f95-mode", "f2003-mode" for the language revisions.
 158 ;; 3. Support for align.
 159 ;; Font-locking:
 160 ;; 1. OpenMP, OpenMPI?, preprocessor highlighting.
 161 ;; 2. interface blah - Highlight "blah" in function-name face?
 162 ;; Need to avoid "interface operator (+)" etc.
 163 ;; 3. integer_name = 1
 164 ;; 4. Labels for "else" statements (F2003)?
 165
 166 (defvar comment-auto-fill-only-comments)
 167 (defvar font-lock-keywords)
 168
 169 ;; User options
 170
 171 (defgroup f90 nil
 172   "Major mode for editing free format Fortran 90,95 code."
 173   :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
 174   :group 'languages)
 175
 176 (defgroup f90-indent nil
 177   "Indentation in free format Fortran."
 178   :prefix "f90-"
 179   :group  'f90)
 180
 181
 182 (defcustom f90-do-indent 3
 183   "Extra indentation applied to DO blocks."
 184   :type  'integer
 185   :group 'f90-indent)
 186 (put 'f90-do-indent 'safe-local-variable 'integerp)
 187
 188 (defcustom f90-if-indent 3
 189   "Extra indentation applied to IF, SELECT CASE, WHERE and FORALL blocks."
 190   :type  'integer
 191   :group 'f90-indent)
 192 (put 'f90-if-indent 'safe-local-variable 'integerp)
 193
 194 (defcustom f90-type-indent 3
 195   "Extra indentation applied to TYPE, ENUM, INTERFACE and BLOCK DATA blocks."
 196   :type  'integer
 197   :group 'f90-indent)
 198 (put 'f90-type-indent 'safe-local-variable 'integerp)
 199
 200 (defcustom f90-program-indent 2
 201   "Extra indentation applied to PROGRAM, MODULE, SUBROUTINE, FUNCTION blocks."
 202   :type  'integer
 203   :group 'f90-indent)
 204 (put 'f90-program-indent 'safe-local-variable 'integerp)
 205
 206 (defcustom f90-associate-indent 2
 207   "Extra indentation applied to ASSOCIATE blocks."
 208   :type  'integer
 209   :group 'f90-indent
 210   :version "23.1")
 211 (put 'f90-associate-indent 'safe-local-variable 'integerp)
 212
 213 (defcustom f90-continuation-indent 5
 214   "Extra indentation applied to continuation lines."
 215   :type  'integer
 216   :group 'f90-indent)
 217 (put 'f90-continuation-indent 'safe-local-variable 'integerp)
 218
 219 (defcustom f90-comment-region "!!$"
 220   "String inserted by \\[f90-comment-region] at start of each line in region."
 221   :type  'string
 222   :group 'f90-indent)
 223 (put 'f90-comment-region 'safe-local-variable 'stringp)
 224
 225 (defcustom f90-indented-comment-re "!"
 226   "Regexp matching comments to indent as code."
 227   :type  'regexp
 228   :group 'f90-indent)
 229 (put 'f90-indented-comment-re 'safe-local-variable 'stringp)
 230
 231 (defcustom f90-directive-comment-re "!hpf\\$"
 232   "Regexp of comment-like directive like \"!HPF\\\\$\", not to be indented."
 233   :type  'regexp
 234   :group 'f90-indent)
 235 (put 'f90-directive-comment-re 'safe-local-variable 'stringp)
 236
 237 (defcustom f90-beginning-ampersand t
 238   "Non-nil gives automatic insertion of \& at start of continuation line."
 239   :type  'boolean
 240   :group 'f90)
 241 (put 'f90-beginning-ampersand 'safe-local-variable 'booleanp)
 242
 243 (defcustom f90-smart-end 'blink
 244   "Qualification of END statements according to the matching block start.
 245 For example, the END that closes an IF block is changed to END
 246 IF.  If the block has a label, this is added as well.  Allowed
 247 values are 'blink, 'no-blink, and nil.  If nil, nothing is done.
 248 The other two settings have the same effect, but 'blink
 249 additionally blinks the cursor to the start of the block."
 250   :type  '(choice (const blink) (const no-blink) (const nil))
 251   :group 'f90)
 252 (put 'f90-smart-end 'safe-local-variable
 253      (lambda (value) (memq value '(blink no-blink nil))))
 254
 255 (defcustom f90-break-delimiters "[-+\\*/><=,% \t]"
 256   "Regexp matching delimiter characters at which lines may be broken.
 257 There are certain tokens comprised entirely of characters
 258 matching this regexp that should not be split, and these are
 259 specified by the constant `f90-no-break-re'."
 260   :type  'regexp
 261   :group 'f90)
 262 (put 'f90-break-delimiters 'safe-local-variable 'stringp)
 263
 264 (defcustom f90-break-before-delimiters t
 265   "Non-nil causes `f90-do-auto-fill' to break lines before delimiters."
 266   :type  'boolean
 267   :group 'f90)
 268 (put 'f90-break-before-delimiters 'safe-local-variable 'booleanp)
 269
 270 (defcustom f90-auto-keyword-case nil
 271   "Automatic case conversion of keywords.
 272 The options are 'downcase-word, 'upcase-word, 'capitalize-word and nil."
 273   :type  '(choice (const downcase-word) (const upcase-word)
 274                   (const capitalize-word) (const nil))
 275   :group 'f90)
 276 (put 'f90-auto-keyword-case 'safe-local-variable
 277      (lambda (value) (memq value '(downcase-word
 278                                    capitalize-word upcase-word nil))))
 279
 280 (defcustom f90-leave-line-no nil
 281   "If non-nil, line numbers are not left justified."
 282   :type  'boolean
 283   :group 'f90)
 284 (put 'f90-leave-line-no 'safe-local-variable 'booleanp)
 285
 286 (defcustom f90-mode-hook nil
 287   "Hook run when entering F90 mode."
 288   :type    'hook
 289   :options '(f90-add-imenu-menu)
 290   :group   'f90)
 291 (put 'f90-mode-hook 'safe-local-variable
 292      (lambda (value) (member value '((f90-add-imenu-menu) nil))))
 293
 294 ;; User options end here.
 295
 296 (defconst f90-keywords-re
 297   (regexp-opt '("allocatable" "allocate" "assign" "assignment" "backspace"
 298                 "block" "call" "case" "character" "close" "common" "complex"
 299                 "contains" "continue" "cycle" "data" "deallocate"
 300                 "dimension" "do" "double" "else" "elseif" "elsewhere" "end"
 301                 "enddo" "endfile" "endif" "entry" "equivalence" "exit"
 302                 "external" "forall" "format" "function" "goto" "if"
 303                 "implicit" "include" "inquire" "integer" "intent"
 304                 "interface" "intrinsic" "logical" "module" "namelist" "none"
 305                 "nullify" "only" "open" "operator" "optional" "parameter"
 306                 "pause" "pointer" "precision" "print" "private" "procedure"
 307                 "program" "public" "read" "real" "recursive" "result" "return"
 308                 "rewind" "save" "select" "sequence" "stop" "subroutine"
 309                 "target" "then" "type" "use" "where" "while" "write"
 310                 ;; F95 keywords.
 311                 "elemental" "pure"
 312                 ;; F2003
 313                 "abstract" "associate" "asynchronous" "bind" "class"
 314                 "deferred" "enum" "enumerator" "extends" "extends_type_of"
 315                 "final" "generic" "import" "non_intrinsic" "non_overridable"
 316                 "nopass" "pass" "protected" "same_type_as" "value" "volatile"
 317                 ) 'words)
 318   "Regexp used by the function `f90-change-keywords'.")
 319
 320 (defconst f90-keywords-level-3-re
 321   (regexp-opt
 322    '("allocatable" "allocate" "assign" "assignment" "backspace"
 323      "close" "deallocate" "dimension" "endfile" "entry" "equivalence"
 324      "external" "inquire" "intent" "intrinsic" "nullify" "only" "open"
 325      ;; FIXME operator and assignment should be F2003 procedures?
 326      "operator" "optional" "parameter" "pause" "pointer" "print" "private"
 327      "public" "read" "recursive" "result" "rewind" "save" "select"
 328      "sequence" "target" "write"
 329      ;; F95 keywords.
 330      "elemental" "pure"
 331      ;; F2003. asynchronous separate.
 332      "abstract" "deferred" "import" "final" "non_intrinsic" "non_overridable"
 333      "nopass" "pass" "protected" "value" "volatile"
 334      ) 'words)
 335   "Keyword-regexp for font-lock level >= 3.")
 336
 337 (defconst f90-procedures-re
 338   (concat "\\<"
 339           (regexp-opt
 340            '("abs" "achar" "acos" "adjustl" "adjustr" "aimag" "aint"
 341              "all" "allocated" "anint" "any" "asin" "associated"
 342              "atan" "atan2" "bit_size" "btest" "ceiling" "char" "cmplx"
 343              "conjg" "cos" "cosh" "count" "cshift" "date_and_time" "dble"
 344              "digits" "dim" "dot_product" "dprod" "eoshift" "epsilon"
 345              "exp" "exponent" "floor" "fraction" "huge" "iachar" "iand"
 346              "ibclr" "ibits" "ibset" "ichar" "ieor" "index" "int" "ior"
 347              "ishft" "ishftc" "kind" "lbound" "len" "len_trim" "lge" "lgt"
 348              "lle" "llt" "log" "log10" "logical" "matmul" "max"
 349              "maxexponent" "maxloc" "maxval" "merge" "min" "minexponent"
 350              "minloc" "minval" "mod" "modulo" "mvbits" "nearest" "nint"
 351              "not" "pack" "precision" "present" "product" "radix"
 352              ;; Real is taken out here to avoid highlighting declarations.
 353              "random_number" "random_seed" "range" ;; "real"
 354              "repeat" "reshape" "rrspacing" "scale" "scan"
 355              "selected_int_kind" "selected_real_kind" "set_exponent"
 356              "shape" "sign" "sin" "sinh" "size" "spacing" "spread" "sqrt"
 357              "sum" "system_clock" "tan" "tanh" "tiny" "transfer"
 358              "transpose" "trim" "ubound" "unpack" "verify"
 359              ;; F95 intrinsic functions.
 360              "null" "cpu_time"
 361              ;; F2003.
 362              "move_alloc" "command_argument_count" "get_command"
 363              "get_command_argument" "get_environment_variable"
 364              "selected_char_kind" "wait" "flush" "new_line"
 365              "extends" "extends_type_of" "same_type_as" "bind"
 366              ;; F2003 ieee_arithmetic intrinsic module.
 367              "ieee_support_underflow_control" "ieee_get_underflow_mode"
 368              "ieee_set_underflow_mode"
 369              ;; F2003 iso_c_binding intrinsic module.
 370              "c_loc" "c_funloc" "c_associated" "c_f_pointer"
 371              "c_f_procpointer"
 372              ) t)
 373           ;; A left parenthesis to avoid highlighting non-procedures.
 374           "[ \t]*(")
 375   "Regexp whose first part matches F90 intrinsic procedures.")
 376
 377 (defconst f90-operators-re
 378   (concat "\\."
 379           (regexp-opt '("and" "eq" "eqv" "false" "ge" "gt" "le" "lt" "ne"
 380                         "neqv" "not" "or" "true") t)
 381           "\\.")
 382   "Regexp matching intrinsic operators.")
 383
 384 (defconst f90-hpf-keywords-re
 385   (regexp-opt
 386    ;; Intrinsic procedures.
 387    '("all_prefix" "all_scatter" "all_suffix" "any_prefix"
 388      "any_scatter" "any_suffix" "copy_prefix" "copy_scatter"
 389      "copy_suffix" "count_prefix" "count_scatter" "count_suffix"
 390      "grade_down" "grade_up"
 391      "hpf_alignment" "hpf_distribution" "hpf_template" "iall" "iall_prefix"
 392      "iall_scatter" "iall_suffix" "iany" "iany_prefix" "iany_scatter"
 393      "iany_suffix" "ilen" "iparity" "iparity_prefix"
 394      "iparity_scatter" "iparity_suffix" "leadz" "maxval_prefix"
 395      "maxval_scatter" "maxval_suffix" "minval_prefix" "minval_scatter"
 396      "minval_suffix" "number_of_processors" "parity"
 397      "parity_prefix" "parity_scatter" "parity_suffix" "popcnt" "poppar"
 398      "processors_shape" "product_prefix" "product_scatter"
 399      "product_suffix" "sum_prefix" "sum_scatter" "sum_suffix"
 400      ;; Directives.
 401      "align" "distribute" "dynamic" "independent" "inherit" "processors"
 402      "realign" "redistribute" "template"
 403      ;; Keywords.
 404      "block" "cyclic" "extrinsic" "new" "onto" "pure" "with") 'words)
 405   "Regexp for all HPF keywords, procedures and directives.")
 406
 407 (defconst f90-constants-re
 408   (regexp-opt '( ;; F2003 iso_fortran_env constants.
 409                 "iso_fortran_env"
 410                 "input_unit" "output_unit" "error_unit"
 411                 "iostat_end" "iostat_eor"
 412                 "numeric_storage_size" "character_storage_size"
 413                 "file_storage_size"
 414                 ;; F2003 iso_c_binding constants.
 415                 "iso_c_binding"
 416                 "c_int" "c_short" "c_long" "c_long_long" "c_signed_char"
 417                 "c_size_t"
 418                 "c_int8_t" "c_int16_t" "c_int32_t" "c_int64_t"
 419                 "c_int_least8_t" "c_int_least16_t" "c_int_least32_t"
 420                 "c_int_least64_t"
 421                 "c_int_fast8_t" "c_int_fast16_t" "c_int_fast32_t"
 422                 "c_int_fast64_t"
 423                 "c_intmax_t" "c_intptr_t"
 424                 "c_float" "c_double" "c_long_double"
 425                 "c_float_complex" "c_double_complex" "c_long_double_complex"
 426                 "c_bool" "c_char"
 427                 "c_null_char" "c_alert" "c_backspace" "c_form_feed"
 428                 "c_new_line" "c_carriage_return" "c_horizontal_tab"
 429                 "c_vertical_tab"
 430                 "c_ptr" "c_funptr" "c_null_ptr" "c_null_funptr"
 431                 "ieee_exceptions"
 432                 "ieee_arithmetic"
 433                 "ieee_features"
 434                 ) 'words)
 435   "Regexp for Fortran intrinsic constants.")
 436
 437 ;; cf f90-looking-at-type-like.
 438 (defun f90-typedef-matcher (limit)
 439   "Search for the start/end of the definition of a derived type, up to LIMIT.
 440 Set the match data so that subexpression 1,2 are the TYPE, and
 441 type-name parts, respectively."
 442   (let (found l)
 443     (while (and (re-search-forward "\\<\\(\\(?:end[ \t]*\\)?type\\)\\>[ \t]*"
 444                                    limit t)
 445                 (not (setq found
 446                            (progn
 447                              (setq l (match-data))
 448                              (unless (looking-at "\\(is\\>\\|(\\)")
 449                                (when (if (looking-at "\\(\\sw+\\)")
 450                                          (goto-char (match-end 0))
 451                                        (re-search-forward
 452                                         "[ \t]*::[ \t]*\\(\\sw+\\)"
 453                                         (line-end-position) t))
 454                                  ;; 0 is wrong, but we don't use it.
 455                                  (set-match-data
 456                                   (append l (list (match-beginning 1)
 457                                                   (match-end 1))))
 458                                  t)))))))
 459     found))
 460
 461 (defvar f90-font-lock-keywords-1
 462   (list
 463    ;; Special highlighting of "module procedure".
 464    '("\\<\\(module[ \t]*procedure\\)\\>\\([^()\n]*::\\)?[ \t]*\\([^&!\n]*\\)"
 465      (1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
 466    ;; Highlight definition of derived type.
 467 ;;;    '("\\<\\(\\(?:end[ \t]*\\)?type\\)\\>\\([^()\n]*::\\)?[ \t]*\\(\\sw+\\)"
 468 ;;;      (1 font-lock-keyword-face) (3 font-lock-function-name-face))
 469    '(f90-typedef-matcher
 470      (1 font-lock-keyword-face) (2 font-lock-function-name-face))
 471    ;; Other functions and declarations.
 472    '("\\<\\(\\(?:end[ \t]*\\)?\\(program\\|module\\|function\\|associate\\|\
 473 subroutine\\)\\|use\\|call\\)\\>[ \t]*\\(\\sw+\\)?"
 474      (1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
 475    ;; F2003.
 476    '("\\<\\(use\\)[ \t]*,[ \t]*\\(\\(?:non_\\)?intrinsic\\)[ \t]*::[ \t]*\
 477 \\(\\sw+\\)"
 478      (1 font-lock-keyword-face) (2 font-lock-keyword-face)
 479      (3 font-lock-function-name-face))
 480    "\\<\\(\\(end[ \t]*\\)?block[ \t]*data\\|contains\\|\
 481 end[ \t]*interface\\)\\>"
 482    ;; "abstract interface" is F2003. Must come after previous entry.
 483    '("\\<\\(\\(?:abstract[ \t]*\\)?interface\\)\\>"
 484      ;; [ \t]*\\(\\(\\sw+\\)[ \t]*[^(]\\)?"
 485      ;; (2) messes up "interface operator ()", etc.
 486      (1 font-lock-keyword-face))) ;(2 font-lock-function-name-face nil t)))
 487   "This does fairly subdued highlighting of comments and function calls.")
 488
 489 ;; NB not explicitly handling this, yet it seems to work.
 490 ;; type(...) function foo()
 491 (defun f90-typedec-matcher (limit)
 492   "Search for the declaration of variables of derived type, up to LIMIT.
 493 Set the match data so that subexpression 1,2 are the TYPE(...),
 494 and variable-name parts, respectively."
 495   ;; Matcher functions must return nil only when there are no more
 496   ;; matches within the search range.
 497   (let (found l)
 498     (while (and (re-search-forward "\\<\\(type\\|class\\)[ \t]*(" limit t)
 499                 (not
 500                  (setq found
 501                        (condition-case nil
 502                            (progn
 503                              ;; Set l after this to just highlight
 504                              ;; the "type" part.
 505                              (backward-char 1)
 506                              ;; Needed for: type( foo(...) ) :: bar
 507                              (forward-sexp)
 508                              (setq l (list (match-beginning 0) (point)))
 509                              (skip-chars-forward " \t")
 510                              (when
 511                                  (re-search-forward
 512                                   ;; type (foo) bar, qux
 513                                   (if (looking-at "\\sw+")
 514                                       "\\([^&!\n]+\\)"
 515                                     ;; type (foo), stuff :: bar, qux
 516                                     "::[ \t]*\\([^&!\n]+\\)")
 517                                   (line-end-position) t)
 518                                (set-match-data
 519                                 (append (list (car l) (match-end 1))
 520                                         l (list (match-beginning 1)
 521                                                 (match-end 1))))
 522                                t))
 523                          (error nil))))))
 524     found))
 525
 526 (defvar f90-font-lock-keywords-2
 527   (append
 528    f90-font-lock-keywords-1
 529    (list
 530     ;; Variable declarations (avoid the real function call).
 531     ;; NB by accident (?), this correctly fontifies the "integer" in:
 532     ;; integer () function foo ()
 533     ;; because "() function foo ()" matches \\3.
 534     ;; The "pure" part does not really belong here, but was added to
 535     ;; exploit that hack.
 536     ;; The "function foo" bit is correctly fontified by keywords-1.
 537     ;; TODO ? actually check for balanced parens in that case.
 538     '("^[ \t0-9]*\\(?:pure\\|elemental\\)?[ \t]*\
 539 \\(real\\|integer\\|c\\(haracter\\|omplex\\)\\|\
 540 enumerator\\|generic\\|procedure\\|logical\\|double[ \t]*precision\\)\
 541 \\(.*::\\|[ \t]*(.*)\\)?\\([^&!\n]*\\)"
 542       (1 font-lock-type-face t) (4 font-lock-variable-name-face t))
 543     ;; Derived type/class variables.
 544     ;; TODO ? If we just highlighted the "type" part, rather than
 545     ;; "type(...)", this could be in the previous expression. And this
 546     ;; would be consistent with integer( kind=8 ), etc.
 547     '(f90-typedec-matcher
 548       (1 font-lock-type-face) (2 font-lock-variable-name-face))
 549     ;; "real function foo (args)". Must override previous.  Note hack
 550     ;; to get "args" unhighlighted again. Might not always be right,
 551     ;; but probably better than leaving them as variables.
 552     ;; NB not explicitly handling this case:
 553     ;; integer( kind=1 ) function foo()
 554     ;; thanks to the happy accident described above.
 555     ;; Not anchored, so don't need to worry about "pure" etc.
 556     '("\\<\\(\\(real\\|integer\\|c\\(haracter\\|omplex\\)\\|\
 557 logical\\|double[ \t]*precision\\|\
 558 \\(?:type\\|class\\)[ \t]*([ \t]*\\sw+[ \t]*)\\)[ \t]*\\)\
 559 \\(function\\)\\>[ \t]*\\(\\sw+\\)[ \t]*\\(([^&!\n]*)\\)"
 560       (1 font-lock-type-face t) (4 font-lock-keyword-face t)
 561       (5 font-lock-function-name-face t) (6 'default t))
 562     ;; enum (F2003; cf type in -1).
 563     '("\\<\\(enum\\)\\>\\([^()\n]*::\\)?[ \t]*\\(\\sw+\\)"
 564       (1 font-lock-keyword-face) (3 font-lock-function-name-face))
 565     ;; end do, enum (F2003), if, select, where, and forall constructs.
 566     '("\\<\\(end[ \t]*\\(do\\|if\\|enum\\|select\\|forall\\|where\\)\\)\\>\
 567 \\([ \t]+\\(\\sw+\\)\\)?"
 568       (1 font-lock-keyword-face) (3 font-lock-constant-face nil t))
 569     '("^[ \t0-9]*\\(\\(\\sw+\\)[ \t]*:[ \t]*\\)?\\(\\(if\\|\
 570 do\\([ \t]*while\\)?\\|select[ \t]*\\(?:case\\|type\\)\\|where\\|\
 571 forall\\)\\)\\>"
 572       (2 font-lock-constant-face nil t) (3 font-lock-keyword-face))
 573     ;; Implicit declaration.
 574     '("\\<\\(implicit\\)[ \t]*\\(real\\|integer\\|c\\(haracter\\|omplex\\)\
 575 \\|enumerator\\|procedure\\|\
 576 logical\\|double[ \t]*precision\\|type[ \t]*(\\sw+)\\|none\\)[ \t]*"
 577       (1 font-lock-keyword-face) (2 font-lock-type-face))
 578     '("\\<\\(namelist\\|common\\)[ \t]*\/\\(\\sw+\\)?\/"
 579       (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
 580     "\\<else\\([ \t]*if\\|where\\)?\\>"
 581     '("\\(&\\)[ \t]*\\(!\\|$\\)"  (1 font-lock-keyword-face))
 582     "\\<\\(then\\|continue\\|format\\|include\\|stop\\|return\\)\\>"
 583     '("\\<\\(exit\\|cycle\\)[ \t]*\\(\\sw+\\)?\\>"
 584       (1 font-lock-keyword-face) (2 font-lock-constant-face nil t))
 585     '("\\<\\(case\\)[ \t]*\\(default\\|(\\)" . 1)
 586     ;; F2003 "class default".
 587     '("\\<\\(class\\)[ \t]*default" . 1)
 588     ;; F2003 "type is" in a "select type" block.
 589     '("\\<\\(\\(type\\|class\\)[ \t]*is\\)[ \t]*(" (1 font-lock-keyword-face t))
 590     '("\\<\\(do\\|go[ \t]*to\\)\\>[ \t]*\\([0-9]+\\)"
 591       (1 font-lock-keyword-face) (2 font-lock-constant-face))
 592     ;; Line numbers (lines whose first character after number is letter).
 593     '("^[ \t]*\\([0-9]+\\)[ \t]*[a-z]+" (1 font-lock-constant-face t))))
 594   "Highlights declarations, do-loops and other constructs.")
 595
 596 (defvar f90-font-lock-keywords-3
 597   (append f90-font-lock-keywords-2
 598           (list
 599            f90-keywords-level-3-re
 600            f90-operators-re
 601            ;; FIXME why isn't this font-lock-builtin-face, which
 602            ;; otherwise we hardly use, as in fortran.el?
 603            (list f90-procedures-re '(1 font-lock-keyword-face keep))
 604            "\\<real\\>"                 ; avoid overwriting real defs
 605            ;; As an attribute, but not as an optional argument.
 606            '("\\<\\(asynchronous\\)[ \t]*[^=]" . 1)))
 607   "Highlights all F90 keywords and intrinsic procedures.")
 608
 609 (defvar f90-font-lock-keywords-4
 610   (append f90-font-lock-keywords-3
 611           (list (cons f90-constants-re 'font-lock-constant-face)
 612                 f90-hpf-keywords-re))
 613   "Highlights all F90 and HPF keywords and constants.")
 614
 615 (defvar f90-font-lock-keywords
 616   f90-font-lock-keywords-2
 617   "*Default expressions to highlight in F90 mode.
 618 Can be overridden by the value of `font-lock-maximum-decoration'.")
 619
 620
 621 (defvar f90-mode-syntax-table
 622   (let ((table (make-syntax-table)))
 623     (modify-syntax-entry ?\! "<"  table) ; begin comment
 624     (modify-syntax-entry ?\n ">"  table) ; end comment
 625     ;; FIXME: This goes against the convention: it should be "_".
 626     (modify-syntax-entry ?_  "w"  table) ; underscore in names
 627     (modify-syntax-entry ?\' "\"" table) ; string quote
 628     (modify-syntax-entry ?\" "\"" table) ; string quote
 629     ;; FIXME: We used to set ` to word syntax for the benefit of abbrevs, but
 630     ;; we do not need it any more.  Not sure if it should be "_" or "." now.
 631     (modify-syntax-entry ?\` "_"  table)
 632     (modify-syntax-entry ?\r " "  table) ; return is whitespace
 633     (modify-syntax-entry ?+  "."  table) ; punctuation
 634     (modify-syntax-entry ?-  "."  table)
 635     (modify-syntax-entry ?=  "."  table)
 636     (modify-syntax-entry ?*  "."  table)
 637     (modify-syntax-entry ?/  "."  table)
 638     ;; I think that the f95 standard leaves the behavior of \
 639     ;; unspecified, but that f2k will require it to be non-special.
 640     ;; Use `f90-backslash-not-special' to change.
 641     (modify-syntax-entry ?\\ "\\" table) ; escape chars
 642     table)
 643   "Syntax table used in F90 mode.")
 644
 645 (defvar f90-mode-map
 646   (let ((map (make-sparse-keymap)))
 647     (define-key map "`"        'f90-abbrev-start)
 648     (define-key map "\C-c;"    'f90-comment-region)
 649     (define-key map "\C-\M-a"  'f90-beginning-of-subprogram)
 650     (define-key map "\C-\M-e"  'f90-end-of-subprogram)
 651     (define-key map "\C-\M-h"  'f90-mark-subprogram)
 652     (define-key map "\C-\M-n"  'f90-end-of-block)
 653     (define-key map "\C-\M-p"  'f90-beginning-of-block)
 654     (define-key map "\C-\M-q"  'f90-indent-subprogram)
 655     (define-key map "\C-j"     'f90-indent-new-line) ; LFD equals C-j
 656 ;;;    (define-key map "\r"       'newline)
 657     (define-key map "\C-c\r"   'f90-break-line)
 658 ;;;  (define-key map [M-return] 'f90-break-line)
 659     (define-key map "\C-c\C-a" 'f90-previous-block)
 660     (define-key map "\C-c\C-e" 'f90-next-block)
 661     (define-key map "\C-c\C-d" 'f90-join-lines)
 662     (define-key map "\C-c\C-f" 'f90-fill-region)
 663     (define-key map "\C-c\C-p" 'f90-previous-statement)
 664     (define-key map "\C-c\C-n" 'f90-next-statement)
 665     (define-key map "\C-c\C-w" 'f90-insert-end)
 666     ;; Standard tab binding will call this, and also handle regions.
 667 ;;;    (define-key map "\t"       'f90-indent-line)
 668     (define-key map ","        'f90-electric-insert)
 669     (define-key map "+"        'f90-electric-insert)
 670     (define-key map "-"        'f90-electric-insert)
 671     (define-key map "*"        'f90-electric-insert)
 672     (define-key map "/"        'f90-electric-insert)
 673
 674     (easy-menu-define f90-menu map "Menu for F90 mode."
 675       `("F90"
 676         ("Customization"
 677          ,(custom-menu-create 'f90)
 678          ;; FIXME useless?
 679          ["Set"  Custom-set :active t
 680           :help "Set current value of all edited settings in the buffer"]
 681          ["Save" Custom-save :active t
 682           :help "Set and save all edited settings"]
 683          ["Reset to Current" Custom-reset-current :active t
 684           :help "Reset all edited settings to current"]
 685          ["Reset to Saved" Custom-reset-saved :active t
 686           :help "Reset all edited or set settings to saved"]
 687          ["Reset to Standard Settings" Custom-reset-standard :active t
 688           :help "Erase all cusomizations in buffer"]
 689          )
 690         "--"
 691         ["Indent Subprogram" f90-indent-subprogram t]
 692         ["Mark Subprogram" f90-mark-subprogram :active t :help
 693          "Mark the end of the current subprogram, move point to the start"]
 694         ["Beginning of Subprogram" f90-beginning-of-subprogram :active t
 695          :help "Move point to the start of the current subprogram"]
 696         ["End of Subprogram" f90-end-of-subprogram :active t
 697          :help "Move point to the end of the current subprogram"]
 698         "--"
 699         ["(Un)Comment Region" f90-comment-region :active mark-active
 700          :help "Comment or uncomment the region"]
 701         ["Indent Region" f90-indent-region :active mark-active]
 702         ["Fill Region" f90-fill-region :active mark-active
 703          :help "Fill long lines in the region"]
 704         "--"
 705         ["Break Line at Point" f90-break-line :active t
 706          :help "Break the current line at point"]
 707         ["Join with Previous Line" f90-join-lines :active t
 708          :help "Join the current line to the previous one"]
 709         ["Insert Block End" f90-insert-end :active t
 710          :help "Insert an end statement for the current code block"]
 711         "--"
 712         ("Highlighting"
 713          :help "Fontify this buffer to varying degrees"
 714          ["Toggle font-lock-mode" font-lock-mode :selected font-lock-mode
 715           :style toggle :help "Fontify text in this buffer"]
 716          "--"
 717          ["Light highlighting (level 1)"    f90-font-lock-1 t]
 718          ["Moderate highlighting (level 2)" f90-font-lock-2 t]
 719          ["Heavy highlighting (level 3)"    f90-font-lock-3 t]
 720          ["Maximum highlighting (level 4)"  f90-font-lock-4 t]
 721          )
 722         ("Change Keyword Case"
 723          :help "Change the case of keywords in the buffer or region"
 724          ["Upcase Keywords (buffer)"     f90-upcase-keywords     t]
 725          ["Capitalize Keywords (buffer)" f90-capitalize-keywords t]
 726          ["Downcase Keywords (buffer)"   f90-downcase-keywords   t]
 727          "--"
 728          ["Upcase Keywords (region)"     f90-upcase-region-keywords
 729           mark-active]
 730          ["Capitalize Keywords (region)" f90-capitalize-region-keywords
 731           mark-active]
 732          ["Downcase Keywords (region)"   f90-downcase-region-keywords
 733           mark-active]
 734          )
 735         "--"
 736         ["Toggle Auto Fill" auto-fill-mode :selected auto-fill-function
 737          :style toggle
 738          :help "Automatically fill text while typing in this buffer"]
 739         ["Toggle Abbrev Mode" abbrev-mode :selected abbrev-mode
 740          :style toggle :help "Expand abbreviations while typing in this buffer"]
 741         ["Add Imenu Menu" f90-add-imenu-menu
 742          :active   (not (lookup-key (current-local-map) [menu-bar index]))
 743          :included (fboundp 'imenu-add-to-menubar)
 744          :help "Add an index menu to the menu-bar"
 745          ]))
 746     map)
 747   "Keymap used in F90 mode.")
 748
 749
 750 (defun f90-font-lock-n (n)
 751   "Set `font-lock-keywords' to F90 level N keywords."
 752   (font-lock-mode 1)
 753   (setq font-lock-keywords
 754         (symbol-value (intern-soft (format "f90-font-lock-keywords-%d" n))))
 755   (font-lock-fontify-buffer))
 756
 757 (defun f90-font-lock-1 ()
 758   "Set `font-lock-keywords' to `f90-font-lock-keywords-1'."
 759   (interactive)
 760   (f90-font-lock-n 1))
 761
 762 (defun f90-font-lock-2 ()
 763   "Set `font-lock-keywords' to `f90-font-lock-keywords-2'."
 764   (interactive)
 765   (f90-font-lock-n 2))
 766
 767 (defun f90-font-lock-3 ()
 768   "Set `font-lock-keywords' to `f90-font-lock-keywords-3'."
 769   (interactive)
 770   (f90-font-lock-n 3))
 771
 772 (defun f90-font-lock-4 ()
 773   "Set `font-lock-keywords' to `f90-font-lock-keywords-4'."
 774   (interactive)
 775   (f90-font-lock-n 4))
 776 \f
 777 ;; Regexps for finding program structures.
 778 (defconst f90-blocks-re
 779   (concat "\\(block[ \t]*data\\|"
 780           (regexp-opt '("do" "if" "interface" "function" "module" "program"
 781                         "select" "subroutine" "type" "where" "forall"
 782                         ;; F2003.
 783                         "enum" "associate"))
 784           "\\)\\>")
 785   "Regexp potentially indicating a \"block\" of F90 code.")
 786
 787 (defconst f90-program-block-re
 788   (regexp-opt '("program" "module" "subroutine" "function") 'paren)
 789   "Regexp used to locate the start/end of a \"subprogram\".")
 790
 791 ;; "class is" is F2003.
 792 (defconst f90-else-like-re
 793   "\\(else\\([ \t]*if\\|where\\)?\\|case[ \t]*\\(default\\|(\\)\\|\
 794 \\(class\\|type\\)[ \t]*is[ \t]*(\\|class[ \t]*default\\)"
 795   "Regexp matching an ELSE IF, ELSEWHERE, CASE, CLASS/TYPE IS statement.")
 796
 797 (defconst f90-end-if-re
 798   (concat "end[ \t]*"
 799           (regexp-opt '("if" "select" "where" "forall") 'paren)
 800           "\\>")
 801   "Regexp matching the end of an IF, SELECT, WHERE, FORALL block.")
 802
 803 (defconst f90-end-type-re
 804   "end[ \t]*\\(type\\|enum\\|interface\\|block[ \t]*data\\)\\>"
 805   "Regexp matching the end of a TYPE, ENUM, INTERFACE, BLOCK DATA section.")
 806
 807 (defconst f90-end-associate-re
 808   "end[ \t]*associate\\>"
 809   "Regexp matching the end of an ASSOCIATE block.")
 810
 811 ;; This is for a TYPE block, not a variable of derived TYPE.
 812 ;; Hence no need to add CLASS for F2003.
 813 (defconst f90-type-def-re
 814   ;; type word
 815   ;; type :: word
 816   ;; type, stuff :: word
 817   ;; NOT "type ("
 818   "\\<\\(type\\)\\>\\(?:[^()\n]*::\\)?[ \t]*\\(\\sw+\\)"
 819   "Regexp matching the definition of a derived type.")
 820
 821 (defconst f90-typeis-re
 822   "\\<\\(class\\|type\\)[ \t]*is[ \t]*("
 823   "Regexp matching a CLASS/TYPE IS statement.")
 824
 825 (defconst f90-no-break-re
 826   (regexp-opt '("**" "//" "=>" ">=" "<=" "==" "/=") 'paren)
 827   "Regexp specifying where not to break lines when filling.
 828 This regexp matches certain tokens comprised entirely of
 829 characters matching the regexp `f90-break-delimiters' that should
 830 not be split by filling.  Each element is assumed to be two
 831 characters long.")
 832
 833 (defvar f90-cache-position nil
 834   "Temporary position used to speed up region operations.")
 835 (make-variable-buffer-local 'f90-cache-position)
 836
 837 \f
 838 ;; Hideshow support.
 839 (defconst f90-end-block-re
 840   (concat "^[ \t0-9]*\\<end[ \t]*"
 841           (regexp-opt '("do" "if" "forall" "function" "interface"
 842                         "module" "program" "select" "subroutine"
 843                         "type" "where" "enum" "associate") t)
 844           "\\>")
 845   "Regexp matching the end of an F90 \"block\", from the line start.
 846 Used in the F90 entry in `hs-special-modes-alist'.")
 847
 848 ;; Ignore the fact that FUNCTION, SUBROUTINE, WHERE, FORALL have a
 849 ;; following "(".  DO, CASE, IF can have labels.
 850 (defconst f90-start-block-re
 851   (concat
 852    "^[ \t0-9]*"                         ; statement number
 853    "\\(\\("
 854    "\\(\\sw+[ \t]*:[ \t]*\\)?"          ; structure label
 855    "\\(do\\|select[ \t]*\\(case\\|type\\)\\|"
 856    ;; See comments in fortran-start-block-re for the problems of IF.
 857    "if[ \t]*(\\(.*\\|"
 858    ".*\n\\([^if]*\\([^i].\\|.[^f]\\|.\\>\\)\\)\\)\\<then\\|"
 859    ;; Distinguish WHERE block from isolated WHERE.
 860    "\\(where\\|forall\\)[ \t]*(.*)[ \t]*\\(!\\|$\\)\\)\\)"
 861    "\\|"
 862    ;; Avoid F2003 "type is" in "select type",
 863    ;; and also variables of derived type "type (foo)".
 864    ;; "type, foo" must be a block (?).
 865    "type[ \t,]\\("
 866    "[^i(!\n\"\& \t]\\|"                 ; not-i(
 867    "i[^s!\n\"\& \t]\\|"                 ; i not-s
 868    "is\\sw\\)\\|"
 869    ;; "abstract interface" is F2003.
 870    "program\\|\\(?:abstract[ \t]*\\)?interface\\|module\\|"
 871    ;; "enum", but not "enumerator".
 872    "function\\|subroutine\\|enum[^e]\\|associate"
 873    "\\)"
 874    "[ \t]*")
 875   "Regexp matching the start of an F90 \"block\", from the line start.
 876 A simple regexp cannot do this in fully correct fashion, so this
 877 tries to strike a compromise between complexity and flexibility.
 878 Used in the F90 entry in `hs-special-modes-alist'.")
 879
 880 ;; hs-special-modes-alist is autoloaded.
 881 (add-to-list 'hs-special-modes-alist
 882              `(f90-mode ,f90-start-block-re ,f90-end-block-re
 883                         "!" f90-end-of-block nil))
 884
 885 \f
 886 ;; Imenu support.
 887 ;; FIXME trivial to extend this to enum. Worth it?
 888 (defun f90-imenu-type-matcher ()
 889   "Search backward for the start of a derived type.
 890 Set subexpression 1 in the match-data to the name of the type."
 891   (let (found)
 892     (while (and (re-search-backward "^[ \t0-9]*type[ \t]*" nil t)
 893                 (not (setq found
 894                            (save-excursion
 895                              (goto-char (match-end 0))
 896                              (unless (looking-at "\\(is\\>\\|(\\)")
 897                                (or (looking-at "\\(\\sw+\\)")
 898                                    (re-search-forward
 899                                     "[ \t]*::[ \t]*\\(\\sw+\\)"
 900                                     (line-end-position) t))))))))
 901     found))
 902
 903 (defvar f90-imenu-generic-expression
 904   (let ((good-char "[^!\"\&\n \t]") (not-e "[^e!\n\"\& \t]")
 905         (not-n "[^n!\n\"\& \t]") (not-d "[^d!\n\"\& \t]")
 906         ;; (not-ib "[^i(!\n\"\& \t]") (not-s "[^s!\n\"\& \t]")
 907         )
 908     (list
 909      '(nil "^[ \t0-9]*program[ \t]+\\(\\sw+\\)" 1)
 910      '("Modules" "^[ \t0-9]*module[ \t]+\\(\\sw+\\)[ \t]*\\(!\\|$\\)" 1)
 911      (list "Types" 'f90-imenu-type-matcher 1)
 912      ;; Does not handle: "type[, stuff] :: foo".
 913 ;;;      (format "^[ \t0-9]*type[ \t]+\\(\\(%s\\|i%s\\|is\\sw\\)\\sw*\\)"
 914 ;;;              not-ib not-s)
 915 ;;;      1)
 916      ;; Can't get the subexpression numbers to match in the two branches.
 917 ;;;      (format "^[ \t0-9]*type\\([ \t]*,.*\\(::\\)[ \t]*\\(\\sw+\\)\\|[ \t]+\\(\\(%s\\|i%s\\|is\\sw\\)\\sw*\\)\\)" not-ib not-s)
 918 ;;;      3)
 919      (list
 920       "Procedures"
 921       (concat
 922        "^[ \t0-9]*"
 923        "\\("
 924        ;; At least three non-space characters before function/subroutine.
 925        ;; Check that the last three non-space characters do not spell E N D.
 926        "[^!\"\&\n]*\\("
 927        not-e good-char good-char "\\|"
 928        good-char not-n good-char "\\|"
 929        good-char good-char not-d "\\)"
 930        "\\|"
 931        ;; Less than three non-space characters before function/subroutine.
 932        good-char "?" good-char "?"
 933        "\\)"
 934        "[ \t]*\\(function\\|subroutine\\)[ \t]+\\(\\sw+\\)")
 935       4)))
 936   "Value for `imenu-generic-expression' in F90 mode.")
 937
 938 (defun f90-add-imenu-menu ()
 939   "Add an imenu menu to the menubar."
 940   (interactive)
 941   (if (lookup-key (current-local-map) [menu-bar index])
 942       (message "%s" "F90-imenu already exists.")
 943     (imenu-add-to-menubar "F90-imenu")
 944     (redraw-frame (selected-frame))))
 945
 946 \f
 947 ;; Abbrevs have generally two letters, except standard types `c, `i, `r, `t.
 948 (define-abbrev-table 'f90-mode-abbrev-table
 949   (mapcar (lambda (e) (list (car e) (cdr e) nil :system t))
 950           '(("`al"  . "allocate"     )
 951             ("`ab"  . "allocatable"  )
 952             ("`ai"  . "abstract interface")
 953             ("`as"  . "assignment"   )
 954             ("`asy" . "asynchronous" )
 955             ("`ba"  . "backspace"    )
 956             ("`bd"  . "block data"   )
 957             ("`c"   . "character"    )
 958             ("`cl"  . "close"        )
 959             ("`cm"  . "common"       )
 960             ("`cx"  . "complex"      )
 961             ("`cn"  . "contains"     )
 962             ("`cy"  . "cycle"        )
 963             ("`de"  . "deallocate"   )
 964             ("`df"  . "define"       )
 965             ("`di"  . "dimension"    )
 966             ("`dp"  . "double precision")
 967             ("`dw"  . "do while"     )
 968             ("`el"  . "else"         )
 969             ("`eli" . "else if"      )
 970             ("`elw" . "elsewhere"    )
 971             ("`em"  . "elemental"    )
 972             ("`e"   . "enumerator"   )
 973             ("`eq"  . "equivalence"  )
 974             ("`ex"  . "external"     )
 975             ("`ey"  . "entry"        )
 976             ("`fl"  . "forall"       )
 977             ("`fo"  . "format"       )
 978             ("`fu"  . "function"     )
 979             ("`fa"  . ".false."      )
 980             ("`im"  . "implicit none")
 981             ("`in"  . "include"      )
 982             ("`i"   . "integer"      )
 983             ("`it"  . "intent"       )
 984             ("`if"  . "interface"    )
 985             ("`lo"  . "logical"      )
 986             ("`mo"  . "module"       )
 987             ("`na"  . "namelist"     )
 988             ("`nu"  . "nullify"      )
 989             ("`op"  . "optional"     )
 990             ("`pa"  . "parameter"    )
 991             ("`po"  . "pointer"      )
 992             ("`pr"  . "print"        )
 993             ("`pi"  . "private"      )
 994             ("`pm"  . "program"      )
 995             ("`pr"  . "protected"    )
 996             ("`pu"  . "public"       )
 997             ("`r"   . "real"         )
 998             ("`rc"  . "recursive"    )
 999             ("`rt"  . "return"       )
1000             ("`rw"  . "rewind"       )
1001             ("`se"  . "select"       )
1002             ("`sq"  . "sequence"     )
1003             ("`su"  . "subroutine"   )
1004             ("`ta"  . "target"       )
1005             ("`tr"  . ".true."       )
1006             ("`t"   . "type"         )
1007             ("`vo"  . "volatile"     )
1008             ("`wh"  . "where"        )
1009             ("`wr"  . "write"        )))
1010   "Abbrev table for F90 mode."
1011   ;; Accept ` as the first char of an abbrev.  Also allow _ in abbrevs.
1012   :regexp "\\(?:[^[:word:]_`]\\|^\\)\\(`?[[:word:]_]+\\)[^[:word:]_]*")
1013 \f
1014 ;;;###autoload
1015 (defun f90-mode ()
1016   "Major mode for editing Fortran 90,95 code in free format.
1017 For fixed format code, use `fortran-mode'.
1018
1019 \\[f90-indent-line] indents the current line.
1020 \\[f90-indent-new-line] indents current line and creates a new\
1021  indented line.
1022 \\[f90-indent-subprogram] indents the current subprogram.
1023
1024 Type `? or `\\[help-command] to display a list of built-in\
1025  abbrevs for F90 keywords.
1026
1027 Key definitions:
1028 \\{f90-mode-map}
1029
1030 Variables controlling indentation style and extra features:
1031
1032 `f90-do-indent'
1033   Extra indentation within do blocks (default 3).
1034 `f90-if-indent'
1035   Extra indentation within if/select/where/forall blocks (default 3).
1036 `f90-type-indent'
1037   Extra indentation within type/enum/interface/block-data blocks (default 3).
1038 `f90-program-indent'
1039   Extra indentation within program/module/subroutine/function blocks
1040   (default 2).
1041 `f90-continuation-indent'
1042   Extra indentation applied to continuation lines (default 5).
1043 `f90-comment-region'
1044   String inserted by function \\[f90-comment-region] at start of each
1045   line in region (default \"!!!$\").
1046 `f90-indented-comment-re'
1047   Regexp determining the type of comment to be intended like code
1048   (default \"!\").
1049 `f90-directive-comment-re'
1050   Regexp of comment-like directive like \"!HPF\\\\$\", not to be indented
1051   (default \"!hpf\\\\$\").
1052 `f90-break-delimiters'
1053   Regexp holding list of delimiters at which lines may be broken
1054   (default \"[-+*/><=,% \\t]\").
1055 `f90-break-before-delimiters'
1056   Non-nil causes `f90-do-auto-fill' to break lines before delimiters
1057   (default t).
1058 `f90-beginning-ampersand'
1059   Automatic insertion of \& at beginning of continuation lines (default t).
1060 `f90-smart-end'
1061   From an END statement, check and fill the end using matching block start.
1062   Allowed values are 'blink, 'no-blink, and nil, which determine
1063   whether to blink the matching beginning (default 'blink).
1064 `f90-auto-keyword-case'
1065   Automatic change of case of keywords (default nil).
1066   The possibilities are 'downcase-word, 'upcase-word, 'capitalize-word.
1067 `f90-leave-line-no'
1068   Do not left-justify line numbers (default nil).
1069
1070 Turning on F90 mode calls the value of the variable `f90-mode-hook'
1071 with no args, if that value is non-nil."
1072   (interactive)
1073   (kill-all-local-variables)
1074   (setq major-mode 'f90-mode
1075         mode-name "F90"
1076         local-abbrev-table f90-mode-abbrev-table)
1077   (set-syntax-table f90-mode-syntax-table)
1078   (use-local-map f90-mode-map)
1079   (set (make-local-variable 'indent-line-function) 'f90-indent-line)
1080   (set (make-local-variable 'indent-region-function) 'f90-indent-region)
1081   (set (make-local-variable 'require-final-newline) mode-require-final-newline)
1082   (set (make-local-variable 'comment-start) "!")
1083   (set (make-local-variable 'comment-start-skip) "!+ *")
1084   (set (make-local-variable 'comment-indent-function) 'f90-comment-indent)
1085   (set (make-local-variable 'abbrev-all-caps) t)
1086   (set (make-local-variable 'normal-auto-fill-function) 'f90-do-auto-fill)
1087   (setq indent-tabs-mode nil)           ; auto buffer local
1088   (set (make-local-variable 'font-lock-defaults)
1089        '((f90-font-lock-keywords f90-font-lock-keywords-1
1090                                  f90-font-lock-keywords-2
1091                                  f90-font-lock-keywords-3
1092                                  f90-font-lock-keywords-4)
1093          nil t))
1094   (set (make-local-variable 'imenu-case-fold-search) t)
1095   (set (make-local-variable 'imenu-generic-expression)
1096        f90-imenu-generic-expression)
1097   (set (make-local-variable 'beginning-of-defun-function)
1098        'f90-beginning-of-subprogram)
1099   (set (make-local-variable 'end-of-defun-function) 'f90-end-of-subprogram)
1100   (set (make-local-variable 'add-log-current-defun-function)
1101        #'f90-current-defun)
1102   (run-mode-hooks 'f90-mode-hook))
1103
1104 \f
1105 ;; Inline-functions.
1106 (defsubst f90-in-string ()
1107   "Return non-nil if point is inside a string.
1108 Checks from `point-min', or `f90-cache-position', if that is non-nil
1109 and lies before point."
1110   (let ((beg-pnt
1111          (if (and f90-cache-position (> (point) f90-cache-position))
1112              f90-cache-position
1113            (point-min))))
1114     (nth 3 (parse-partial-sexp beg-pnt (point)))))
1115
1116 (defsubst f90-in-comment ()
1117   "Return non-nil if point is inside a comment.
1118 Checks from `point-min', or `f90-cache-position', if that is non-nil
1119 and lies before point."
1120   (let ((beg-pnt
1121          (if (and f90-cache-position (> (point) f90-cache-position))
1122              f90-cache-position
1123            (point-min))))
1124     (nth 4 (parse-partial-sexp beg-pnt (point)))))
1125
1126 (defsubst f90-line-continued ()
1127   "Return t if the current line is a continued one.
1128 This includes comment lines embedded in continued lines, but
1129 not the last line of a continued statement."
1130   (save-excursion
1131     (beginning-of-line)
1132     (while (and (looking-at "[ \t]*\\(!\\|$\\)") (zerop (forward-line -1))))
1133     (end-of-line)
1134     (while (f90-in-comment)
1135       (search-backward "!" (line-beginning-position))
1136       (skip-chars-backward "!"))
1137     (skip-chars-backward " \t")
1138     (= (preceding-char) ?&)))
1139
1140 ;; GM this is not right, eg a continuation line starting with a number.
1141 ;; Need f90-code-start-position function.
1142 ;; And yet, things seems to work with this...
1143 ;; cf f90-indent-line
1144 ;;     (beginning-of-line)           ; digits after & \n are not line-nos
1145 ;;     (if (not (save-excursion (and (f90-previous-statement)
1146 ;;                                   (f90-line-continued))))
1147 ;;         (f90-indent-line-no)
1148 (defsubst f90-current-indentation ()
1149   "Return indentation of current line.
1150 Line-numbers are considered whitespace characters."
1151   (save-excursion (beginning-of-line) (skip-chars-forward " \t0-9")))
1152
1153 (defsubst f90-indent-to (col &optional no-line-number)
1154   "Indent current line to column COL.
1155 If optional argument NO-LINE-NUMBER is nil, jump over a possible
1156 line-number before indenting."
1157   (beginning-of-line)
1158   (or no-line-number
1159       (skip-chars-forward " \t0-9"))
1160   (delete-horizontal-space)
1161   ;; Leave >= 1 space after line number.
1162   (indent-to col (if (zerop (current-column)) 0 1)))
1163
1164 (defsubst f90-get-present-comment-type ()
1165   "If point lies within a comment, return the string starting the comment.
1166 For example, \"!\" or \"!!\", followed by the appropriate amount of
1167 whitespace, if any."
1168   ;; Include the whitespace for consistent auto-filling of comment blocks.
1169   (save-excursion
1170     (when (f90-in-comment)
1171       (beginning-of-line)
1172       (re-search-forward "!+[ \t]*" (line-end-position))
1173       (while (f90-in-string)
1174         (re-search-forward "!+[ \t]*" (line-end-position)))
1175       (match-string-no-properties 0))))
1176
1177 (defsubst f90-equal-symbols (a b)
1178   "Compare strings A and B neglecting case and allowing for nil value."
1179   (equal (if a (downcase a) nil)
1180          (if b (downcase b) nil)))
1181
1182 (defsubst f90-looking-at-do ()
1183   "Return (\"do\" NAME) if a do statement starts after point.
1184 NAME is nil if the statement has no label."
1185   (if (looking-at "\\(\\(\\sw+\\)[ \t]*:\\)?[ \t]*\\(do\\)\\>")
1186       (list (match-string 3) (match-string 2))))
1187
1188 (defsubst f90-looking-at-select-case ()
1189   "Return (\"select\" NAME) if a select statement starts after point.
1190 NAME is nil if the statement has no label."
1191   (if (looking-at "\\(\\(\\sw+\\)[ \t]*:\\)?[ \t]*\
1192 \\(select\\)[ \t]*\\(case\\|type\\)[ \t]*(")
1193       (list (match-string 3) (match-string 2))))
1194
1195 (defsubst f90-looking-at-if-then ()
1196   "Return (\"if\" NAME) if an if () then statement starts after point.
1197 NAME is nil if the statement has no label."
1198   (save-excursion
1199     (when (looking-at "\\(\\(\\sw+\\)[ \t]*:\\)?[ \t]*\\(if\\)\\>")
1200       (let ((struct (match-string 3))
1201             (label (match-string 2))
1202             (pos (scan-lists (point) 1 0)))
1203         (and pos (goto-char pos))
1204         (skip-chars-forward " \t")
1205         (if (or (looking-at "then\\>")
1206                 (when (f90-line-continued)
1207                   (f90-next-statement)
1208                   (skip-chars-forward " \t0-9&")
1209                   (looking-at "then\\>")))
1210             (list struct label))))))
1211
1212 ;; FIXME label?
1213 (defsubst f90-looking-at-associate ()
1214   "Return (\"associate\") if an associate block starts after point."
1215   (if (looking-at "\\<\\(associate\\)[ \t]*(")
1216       (list (match-string 1))))
1217
1218 (defsubst f90-looking-at-where-or-forall ()
1219   "Return (KIND NAME) if a where or forall block starts after point.
1220 NAME is nil if the statement has no label."
1221   (save-excursion
1222     (when (looking-at "\\(\\(\\sw+\\)[ \t]*:\\)?[ \t]*\
1223 \\(where\\|forall\\)\\>")
1224       (let ((struct (match-string 3))
1225             (label (match-string 2))
1226             (pos (scan-lists (point) 1 0)))
1227         (and pos (goto-char pos))
1228         (skip-chars-forward " \t")
1229         (if (looking-at "\\(!\\|$\\)") (list struct label))))))
1230
1231 (defsubst f90-looking-at-type-like ()
1232   "Return (KIND NAME) if a type/enum/interface/block-data starts after point.
1233 NAME is non-nil only for type."
1234   (cond
1235    ((save-excursion
1236       (and (looking-at "\\<type\\>[ \t]*")
1237            (goto-char (match-end 0))
1238            (not (looking-at "\\(is\\>\\|(\\)"))
1239            (or (looking-at "\\(\\sw+\\)")
1240                (re-search-forward "[ \t]*::[ \t]*\\(\\sw+\\)"
1241                                   (line-end-position) t))))
1242     (list "type" (match-string 1)))
1243 ;;;    ((and (not (looking-at f90-typeis-re))
1244 ;;;          (looking-at f90-type-def-re))
1245 ;;;     (list (match-string 1) (match-string 2)))
1246    ((looking-at "\\(enum\\|interface\\|block[ \t]*data\\)\\>")
1247     (list (match-string 1) nil))
1248    ((looking-at "abstract[ \t]*\\(interface\\)\\>")
1249     (list (match-string 1) nil))))
1250
1251 (defsubst f90-looking-at-program-block-start ()
1252   "Return (KIND NAME) if a program block with name NAME starts after point."
1253 ;;;NAME is nil for an un-named main PROGRAM block."
1254   (cond
1255    ((looking-at "\\(program\\)[ \t]+\\(\\sw+\\)\\>")
1256     (list (match-string 1) (match-string 2)))
1257    ((and (not (looking-at "module[ \t]*procedure\\>"))
1258          (looking-at "\\(module\\)[ \t]+\\(\\sw+\\)\\>"))
1259     (list (match-string 1) (match-string 2)))
1260    ((and (not (looking-at "end[ \t]*\\(function\\|subroutine\\)"))
1261          (looking-at "[^!'\"\&\n]*\\(function\\|subroutine\\)[ \t]+\
1262 \\(\\sw+\\)"))
1263     (list (match-string 1) (match-string 2)))))
1264 ;; Following will match an un-named main program block; however
1265 ;; one needs to check if there is an actual PROGRAM statement after
1266 ;; point (and before any END program). Adding this will require
1267 ;; change to eg f90-calculate-indent.
1268 ;;;   ((save-excursion
1269 ;;;     (not (f90-previous-statement)))
1270 ;;;    '("program" nil))))
1271
1272 (defsubst f90-looking-at-program-block-end ()
1273   "Return (KIND NAME) if a block with name NAME ends after point."
1274   (if (looking-at (concat "end[ \t]*" f90-blocks-re
1275                           "?\\([ \t]+\\(\\sw+\\)\\)?\\>"))
1276       (list (match-string 1) (match-string 3))))
1277
1278 (defsubst f90-comment-indent ()
1279   "Return the indentation to be used for a comment starting at point.
1280 Used for `comment-indent-function' by F90 mode.
1281 \"!!!\", `f90-directive-comment-re', variable `f90-comment-region' return 0.
1282 `f90-indented-comment-re' (if not trailing code) calls `f90-calculate-indent'.
1283 All others return `comment-column', leaving at least one space after code."
1284   (cond ((looking-at "!!!") 0)
1285         ((and f90-directive-comment-re
1286               (looking-at f90-directive-comment-re)) 0)
1287         ((looking-at (regexp-quote f90-comment-region)) 0)
1288         ((and (looking-at f90-indented-comment-re)
1289               ;; Don't attempt to indent trailing comment as code.
1290               (save-excursion
1291                 (skip-chars-backward " \t")
1292                 (bolp)))
1293          (f90-calculate-indent))
1294         (t (save-excursion
1295              (skip-chars-backward " \t")
1296              (max (if (bolp) 0 (1+ (current-column))) comment-column)))))
1297
1298 (defsubst f90-present-statement-cont ()
1299   "Return continuation properties of present statement.
1300 Possible return values are:
1301 single - statement is not continued.
1302 begin  - current line is the first in a continued statement.
1303 end    - current line is the last in a continued statement
1304 middle - current line is neither first nor last in a continued statement.
1305 Comment lines embedded amongst continued lines return 'middle."
1306   (let (pcont cont)
1307     (save-excursion
1308       (setq pcont (if (f90-previous-statement) (f90-line-continued))))
1309     (setq cont (f90-line-continued))
1310     (cond ((and (not pcont) (not cont)) 'single)
1311           ((and (not pcont) cont)       'begin)
1312           ((and pcont       (not cont)) 'end)
1313           ((and pcont       cont)       'middle)
1314           (t (error "The impossible occurred")))))
1315
1316 (defsubst f90-indent-line-no ()
1317   "If `f90-leave-line-no' is nil, left-justify a line number.
1318 Leaves point at the first non-blank character after the line number.
1319 Call from beginning of line."
1320   (and (null f90-leave-line-no) (looking-at "[ \t]+[0-9]")
1321        (delete-horizontal-space))
1322   (skip-chars-forward " \t0-9"))
1323
1324 (defsubst f90-no-block-limit ()
1325   "Return nil if point is at the edge of a code block.
1326 Searches line forward for \"function\" or \"subroutine\",
1327 if all else fails."
1328   (save-excursion
1329     (not (or (looking-at "end")
1330              (looking-at "\\(do\\|if\\|else\\(if\\|where\\)?\
1331 \\|select[ \t]*\\(case\\|type\\)\\|case\\|where\\|forall\\)\\>")
1332              (looking-at "\\(program\\|module\\|\
1333 \\(?:abstract[ \t]*\\)?interface\\|block[ \t]*data\\)\\>")
1334              (looking-at "\\(contains\\|\\sw+[ \t]*:\\)")
1335              (looking-at f90-type-def-re)
1336              (re-search-forward "\\(function\\|subroutine\\)"
1337                                 (line-end-position) t)))))
1338
1339 (defsubst f90-update-line ()
1340   "Change case of current line as per `f90-auto-keyword-case'."
1341   (if f90-auto-keyword-case
1342       (f90-change-keywords f90-auto-keyword-case
1343                            (line-beginning-position) (line-end-position))))
1344 \f
1345 (defun f90-electric-insert (&optional arg)
1346   "Change keyword case and auto-fill line as operators are inserted."
1347   (interactive "*p")
1348   (self-insert-command arg)
1349   (if auto-fill-function (f90-do-auto-fill) ; also updates line
1350     (f90-update-line)))
1351
1352
1353 (defun f90-get-correct-indent ()
1354   "Get correct indent for a line starting with line number.
1355 Does not check type and subprogram indentation."
1356   (let ((epnt (line-end-position)) icol cont)
1357     (save-excursion
1358       (while (and (f90-previous-statement)
1359                   (or (progn
1360                         (setq cont (f90-present-statement-cont))
1361                         (or (eq cont 'end) (eq cont 'middle)))
1362                       (looking-at "[ \t]*[0-9]"))))
1363       (setq icol (current-indentation))
1364       (beginning-of-line)
1365       (when (re-search-forward "\\(if\\|do\\|select\\|where\\|forall\\)"
1366                                (line-end-position) t)
1367         (beginning-of-line)
1368         (skip-chars-forward " \t")
1369         (cond ((f90-looking-at-do)
1370                (setq icol (+ icol f90-do-indent)))
1371               ((or (f90-looking-at-if-then)
1372                    (f90-looking-at-where-or-forall)
1373                    (f90-looking-at-select-case))
1374                (setq icol (+ icol f90-if-indent)))
1375               ((f90-looking-at-associate)
1376                (setq icol (+ icol f90-associate-indent))))
1377         (end-of-line))
1378       (while (re-search-forward
1379               "\\(if\\|do\\|select\\|where\\|forall\\)" epnt t)
1380         (beginning-of-line)
1381         (skip-chars-forward " \t0-9")
1382         (cond ((f90-looking-at-do)
1383                (setq icol (+ icol f90-do-indent)))
1384               ((or (f90-looking-at-if-then)
1385                    (f90-looking-at-where-or-forall)
1386                    (f90-looking-at-select-case))
1387                (setq icol (+ icol f90-if-indent)))
1388               ((f90-looking-at-associate)
1389                (setq icol (+ icol f90-associate-indent)))
1390               ((looking-at f90-end-if-re)
1391                (setq icol (- icol f90-if-indent)))
1392               ((looking-at f90-end-associate-re)
1393                (setq icol (- icol f90-associate-indent)))
1394               ((looking-at "end[ \t]*do\\>")
1395                (setq icol (- icol f90-do-indent))))
1396         (end-of-line))
1397       icol)))
1398
1399 (defun f90-calculate-indent ()
1400   "Calculate the indent column based on previous statements."
1401   (interactive)
1402   (let (icol cont (case-fold-search t) (pnt (point)))
1403     (save-excursion
1404       (if (not (f90-previous-statement))
1405           ;; If f90-previous-statement returns nil, we must have been
1406           ;; called from on or before the first line of the first statement.
1407           (setq icol (if (save-excursion
1408                            ;; f90-previous-statement has moved us over
1409                            ;; comment/blank lines, so we need to get
1410                            ;; back to the first code statement.
1411                            (when (looking-at "[ \t]*\\([!#]\\|$\\)")
1412                              (f90-next-statement))
1413                            (skip-chars-forward " \t0-9")
1414                            (f90-looking-at-program-block-start))
1415                          0
1416                        ;; No explicit PROGRAM start statement.
1417                        f90-program-indent))
1418         (setq cont (f90-present-statement-cont))
1419         (if (eq cont 'end)
1420             (while (not (eq 'begin (f90-present-statement-cont)))
1421               (f90-previous-statement)))
1422         (cond ((eq cont 'begin)
1423                (setq icol (+ (f90-current-indentation)
1424                              f90-continuation-indent)))
1425               ((eq cont 'middle) (setq icol (current-indentation)))
1426               (t (setq icol (f90-current-indentation))
1427                  (skip-chars-forward " \t")
1428                  (if (looking-at "[0-9]")
1429                      (setq icol (f90-get-correct-indent))
1430                    (cond ((or (f90-looking-at-if-then)
1431                               (f90-looking-at-where-or-forall)
1432                               (f90-looking-at-select-case)
1433                               (looking-at f90-else-like-re))
1434                           (setq icol (+ icol f90-if-indent)))
1435                          ((f90-looking-at-do)
1436                           (setq icol (+ icol f90-do-indent)))
1437                          ((f90-looking-at-type-like)
1438                           (setq icol (+ icol f90-type-indent)))
1439                          ((f90-looking-at-associate)
1440                           (setq icol (+ icol f90-associate-indent)))
1441                          ((or (f90-looking-at-program-block-start)
1442                               (looking-at "contains[ \t]*\\($\\|!\\)"))
1443                           (setq icol (+ icol f90-program-indent)))))
1444                  (goto-char pnt)
1445                  (beginning-of-line)
1446                  (cond ((looking-at "[ \t]*$"))
1447                        ((looking-at "[ \t]*#") ; check for cpp directive
1448                         (setq icol 0))
1449                        (t
1450                         (skip-chars-forward " \t0-9")
1451                         (cond ((or (looking-at f90-else-like-re)
1452                                    (looking-at f90-end-if-re))
1453                                (setq icol (- icol f90-if-indent)))
1454                               ((looking-at "end[ \t]*do\\>")
1455                                (setq icol (- icol f90-do-indent)))
1456                               ((looking-at f90-end-type-re)
1457                                (setq icol (- icol f90-type-indent)))
1458                               ((looking-at f90-end-associate-re)
1459                                (setq icol (- icol f90-associate-indent)))
1460                               ((or (looking-at "contains[ \t]*\\(!\\|$\\)")
1461                                    (f90-looking-at-program-block-end))
1462                                (setq icol (- icol f90-program-indent))))))))))
1463     icol))
1464 \f
1465 (defun f90-previous-statement ()
1466   "Move point to beginning of the previous F90 statement.
1467 If no previous statement is found (i.e. if called from the first
1468 statement in the buffer), move to the start of the buffer and
1469 return nil.  A statement is a line which is neither blank nor a
1470 comment."
1471   (interactive)
1472   (let (not-first-statement)
1473     (beginning-of-line)
1474     (while (and (setq not-first-statement (zerop (forward-line -1)))
1475                 (looking-at "[ \t0-9]*\\(!\\|$\\|#\\)")))
1476     not-first-statement))
1477
1478 (defun f90-next-statement ()
1479   "Move point to beginning of the next F90 statement.
1480 Return nil if no later statement is found."
1481   (interactive)
1482   (let (not-last-statement)
1483     (beginning-of-line)
1484     (while (and (setq not-last-statement
1485                       (and (zerop (forward-line 1))
1486                            (not (eobp))))
1487                 (looking-at "[ \t0-9]*\\(!\\|$\\)")))
1488     not-last-statement))
1489
1490 (defun f90-beginning-of-subprogram ()
1491   "Move point to the beginning of the current subprogram.
1492 Return (TYPE NAME), or nil if not found."
1493   (interactive)
1494   (let ((count 1) (case-fold-search t) matching-beg)
1495     (beginning-of-line)
1496     (while (and (> count 0)
1497                 (re-search-backward f90-program-block-re nil 'move))
1498       (beginning-of-line)
1499       (skip-chars-forward " \t0-9")
1500       (cond ((setq matching-beg (f90-looking-at-program-block-start))
1501              (setq count (1- count)))
1502             ((f90-looking-at-program-block-end)
1503              (setq count (1+ count)))))
1504     (beginning-of-line)
1505     (if (zerop count)
1506         matching-beg
1507       ;; Note this includes the case of an un-named main program,
1508       ;; in which case we go to (point-min).
1509       (if (interactive-p) (message "No beginning found"))
1510       nil)))
1511
1512 (defun f90-end-of-subprogram ()
1513   "Move point to the end of the current subprogram.
1514 Return (TYPE NAME), or nil if not found."
1515   (interactive)
1516   (let ((case-fold-search t)
1517         (count 1)
1518         matching-end)
1519     (end-of-line)
1520     (while (and (> count 0)
1521                 (re-search-forward f90-program-block-re nil 'move))
1522       (beginning-of-line)
1523       (skip-chars-forward " \t0-9")
1524       (cond ((f90-looking-at-program-block-start)
1525              (setq count (1+ count)))
1526             ((setq matching-end (f90-looking-at-program-block-end))
1527              (setq count (1- count))))
1528       (end-of-line))
1529     ;; This means f90-end-of-subprogram followed by f90-start-of-subprogram
1530     ;; has a net non-zero effect, which seems odd.
1531 ;;;    (forward-line 1)
1532     (if (zerop count)
1533         matching-end
1534       (if (interactive-p) (message "No end found"))
1535       nil)))
1536
1537
1538 (defun f90-end-of-block (&optional num)
1539   "Move point forward to the end of the current code block.
1540 With optional argument NUM, go forward that many balanced blocks.
1541 If NUM is negative, go backward to the start of a block.  Checks
1542 for consistency of block types and labels (if present), and
1543 completes outermost block if `f90-smart-end' is non-nil.
1544 Interactively, pushes mark before moving point."
1545   (interactive "p")
1546   (if (interactive-p) (push-mark (point) t)) ; can move some distance
1547   (and num (< num 0) (f90-beginning-of-block (- num)))
1548   (let ((f90-smart-end (if f90-smart-end 'no-blink)) ; for final match-end
1549         (case-fold-search t)
1550         (count (or num 1))
1551         start-list start-this start-type start-label end-type end-label)
1552     (end-of-line)                       ; probably want this
1553     (while (and (> count 0) (re-search-forward f90-blocks-re nil 'move))
1554       (beginning-of-line)
1555       (skip-chars-forward " \t0-9")
1556       (cond ((or (f90-in-string) (f90-in-comment)))
1557             ((setq start-this
1558                    (or
1559                     (f90-looking-at-do)
1560                     (f90-looking-at-select-case)
1561                     (f90-looking-at-type-like)
1562                     (f90-looking-at-associate)
1563                     (f90-looking-at-program-block-start)
1564                     (f90-looking-at-if-then)
1565                     (f90-looking-at-where-or-forall)))
1566              (setq start-list (cons start-this start-list) ; not add-to-list!
1567                    count (1+ count)))
1568             ((looking-at (concat "end[ \t]*" f90-blocks-re
1569                                  "[ \t]*\\(\\sw+\\)?"))
1570              (setq end-type (match-string 1)
1571                    end-label (match-string 2)
1572                    count (1- count))
1573              ;; Check any internal blocks.
1574              (when start-list
1575                (setq start-this (car start-list)
1576                      start-list (cdr start-list)
1577                      start-type (car start-this)
1578                      start-label (cadr start-this))
1579                (or (f90-equal-symbols start-type end-type)
1580                    (error "End type `%s' does not match start type `%s'"
1581                           end-type start-type))
1582                (or (f90-equal-symbols start-label end-label)
1583                    (error "End label `%s' does not match start label `%s'"
1584                           end-label start-label)))))
1585       (end-of-line))
1586     (if (> count 0) (error "Missing block end"))
1587     ;; Check outermost block.
1588     (when f90-smart-end
1589       (save-excursion
1590         (beginning-of-line)
1591         (skip-chars-forward " \t0-9")
1592         (f90-match-end)))))
1593
1594 (defun f90-beginning-of-block (&optional num)
1595   "Move point backwards to the start of the current code block.
1596 With optional argument NUM, go backward that many balanced blocks.
1597 If NUM is negative, go forward to the end of a block.
1598 Checks for consistency of block types and labels (if present).
1599 Does not check the outermost block, because it may be incomplete.
1600 Interactively, pushes mark before moving point."
1601   (interactive "p")
1602   (if (interactive-p) (push-mark (point) t))
1603   (and num (< num 0) (f90-end-of-block (- num)))
1604   (let ((case-fold-search t)
1605         (count (or num 1))
1606         end-list end-this end-type end-label
1607         start-this start-type start-label)
1608     (beginning-of-line)                 ; probably want this
1609     (while (and (> count 0) (re-search-backward f90-blocks-re nil 'move))
1610       (beginning-of-line)
1611       (skip-chars-forward " \t0-9")
1612       (cond ((or (f90-in-string) (f90-in-comment)))
1613             ((looking-at (concat "end[ \t]*" f90-blocks-re
1614                                  "[ \t]*\\(\\sw+\\)?"))
1615              (setq end-list (cons (list (match-string 1) (match-string 2))
1616                                   end-list)
1617                    count (1+ count)))
1618             ((setq start-this
1619                    (or
1620                     (f90-looking-at-do)
1621                     (f90-looking-at-select-case)
1622                     (f90-looking-at-type-like)
1623                     (f90-looking-at-associate)
1624                     (f90-looking-at-program-block-start)
1625                     (f90-looking-at-if-then)
1626                     (f90-looking-at-where-or-forall)))
1627              (setq start-type (car start-this)
1628                    start-label (cadr start-this)
1629                    count (1- count))
1630              ;; Check any internal blocks.
1631              (when end-list
1632                (setq end-this (car end-list)
1633                      end-list (cdr end-list)
1634                      end-type (car end-this)
1635                      end-label (cadr end-this))
1636                (or (f90-equal-symbols start-type end-type)
1637                    (error "Start type `%s' does not match end type `%s'"
1638                           start-type end-type))
1639                (or (f90-equal-symbols start-label end-label)
1640                    (error "Start label `%s' does not match end label `%s'"
1641                           start-label end-label))))))
1642     ;; Includes an un-named main program block.
1643     (if (> count 0) (error "Missing block start"))))
1644
1645 (defun f90-next-block (&optional num)
1646   "Move point forward to the next end or start of a code block.
1647 With optional argument NUM, go forward that many blocks.
1648 If NUM is negative, go backwards.
1649 A block is a subroutine, if-endif, etc."
1650   (interactive "p")
1651   (let ((case-fold-search t)
1652         (count (if num (abs num) 1)))
1653     (while (and (> count 0)
1654                 (if (> num 0) (re-search-forward f90-blocks-re nil 'move)
1655                   (re-search-backward f90-blocks-re nil 'move)))
1656       (beginning-of-line)
1657       (skip-chars-forward " \t0-9")
1658       (cond ((or (f90-in-string) (f90-in-comment)))
1659             ((or
1660               (looking-at "end[ \t]*")
1661               (f90-looking-at-do)
1662               (f90-looking-at-select-case)
1663               (f90-looking-at-type-like)
1664               (f90-looking-at-associate)
1665               (f90-looking-at-program-block-start)
1666               (f90-looking-at-if-then)
1667               (f90-looking-at-where-or-forall))
1668              (setq count (1- count))))
1669       (if (> num 0) (end-of-line)
1670         (beginning-of-line)))))
1671
1672
1673 (defun f90-previous-block (&optional num)
1674   "Move point backward to the previous end or start of a code block.
1675 With optional argument NUM, go backward that many blocks.
1676 If NUM is negative, go forwards.
1677 A block is a subroutine, if-endif, etc."
1678   (interactive "p")
1679   (f90-next-block (- (or num 1))))
1680
1681
1682 (defun f90-mark-subprogram ()
1683   "Put mark at end of F90 subprogram, point at beginning, push mark."
1684   (interactive)
1685   (let ((pos (point)) program)
1686     (f90-end-of-subprogram)
1687     (push-mark)
1688     (goto-char pos)
1689     (setq program (f90-beginning-of-subprogram))
1690     (if (featurep 'xemacs)
1691         (zmacs-activate-region)
1692       (setq mark-active t
1693             deactivate-mark nil))
1694     program))
1695
1696 (defun f90-comment-region (beg-region end-region)
1697   "Comment/uncomment every line in the region.
1698 Insert the variable `f90-comment-region' at the start of every line
1699 in the region, or, if already present, remove it."
1700   (interactive "*r")
1701   (let ((end (copy-marker end-region)))
1702     (goto-char beg-region)
1703     (beginning-of-line)
1704     (if (looking-at (regexp-quote f90-comment-region))
1705         (delete-region (point) (match-end 0))
1706       (insert f90-comment-region))
1707     (while (and (zerop (forward-line 1))
1708                 (< (point) end))
1709       (if (looking-at (regexp-quote f90-comment-region))
1710           (delete-region (point) (match-end 0))
1711         (insert f90-comment-region)))
1712     (set-marker end nil)))
1713
1714 (defun f90-indent-line (&optional no-update)
1715   "Indent current line as F90 code.
1716 Unless optional argument NO-UPDATE is non-nil, call `f90-update-line'
1717 after indenting."
1718   (interactive "*P")
1719   (let ((case-fold-search t)
1720         (pos (point-marker))
1721         indent no-line-number)
1722     (beginning-of-line)           ; digits after & \n are not line-nos
1723     (if (not (save-excursion (and (f90-previous-statement)
1724                                   (f90-line-continued))))
1725         (f90-indent-line-no)
1726       (setq no-line-number t)
1727       (skip-chars-forward " \t"))
1728     (if (looking-at "!")
1729         (setq indent (f90-comment-indent))
1730       (and f90-smart-end (looking-at "end")
1731            (f90-match-end))
1732       (setq indent (f90-calculate-indent)))
1733     (or (= indent (current-column))
1734         (f90-indent-to indent no-line-number))
1735     ;; If initial point was within line's indentation,
1736     ;; position after the indentation.  Else stay at same point in text.
1737     (and (< (point) pos)
1738          (goto-char pos))
1739     (if auto-fill-function
1740         ;; GM NO-UPDATE not honoured, since this calls f90-update-line.
1741         (f90-do-auto-fill)
1742       (or no-update (f90-update-line)))
1743     (set-marker pos nil)))
1744
1745 (defun f90-indent-new-line ()
1746   "Re-indent current line, insert a newline and indent the newline.
1747 An abbrev before point is expanded if the variable `abbrev-mode' is non-nil.
1748 If run in the middle of a line, the line is not broken."
1749   (interactive "*")
1750   (if abbrev-mode (expand-abbrev))
1751   (beginning-of-line)             ; reindent where likely to be needed
1752   (f90-indent-line)                ; calls indent-line-no, update-line
1753   (end-of-line)
1754   (delete-horizontal-space)             ; destroy trailing whitespace
1755   (let ((string (f90-in-string))
1756         (cont (f90-line-continued)))
1757     (and string (not cont) (insert "&"))
1758     (newline)
1759     (if (or string (and cont f90-beginning-ampersand)) (insert "&")))
1760   (f90-indent-line 'no-update))         ; nothing to update
1761
1762
1763 ;; TODO not add spaces to empty lines at the start.
1764 ;; Why is second line getting extra indent over first?
1765 (defun f90-indent-region (beg-region end-region)
1766   "Indent every line in region by forward parsing."
1767   (interactive "*r")
1768   (let ((end-region-mark (copy-marker end-region))
1769         (save-point (point-marker))
1770         (case-fold-search t)
1771         block-list ind-lev ind-curr ind-b cont struct beg-struct end-struct)
1772     (goto-char beg-region)
1773     ;; First find a line which is not a continuation line or comment.
1774     (beginning-of-line)
1775     (while (and (looking-at "[ \t]*[0-9]*\\(!\\|#\\|[ \t]*$\\)")
1776                 (progn (f90-indent-line 'no-update)
1777                        (zerop (forward-line 1)))
1778                 (< (point) end-region-mark)))
1779     (setq cont (f90-present-statement-cont))
1780     (while (and (or (eq cont 'middle) (eq cont 'end))
1781                 (f90-previous-statement))
1782       (setq cont (f90-present-statement-cont)))
1783     ;; Process present line for beginning of block.
1784     (setq f90-cache-position (point))
1785     (f90-indent-line 'no-update)
1786     (setq ind-lev (f90-current-indentation)
1787           ind-curr ind-lev)
1788     (beginning-of-line)
1789     (skip-chars-forward " \t0-9")
1790     (setq struct nil
1791           ind-b (cond ((setq struct (f90-looking-at-do)) f90-do-indent)
1792                       ((or (setq struct (f90-looking-at-if-then))
1793                            (setq struct (f90-looking-at-select-case))
1794                            (setq struct (f90-looking-at-where-or-forall))
1795                            (looking-at f90-else-like-re))
1796                        f90-if-indent)
1797                       ((setq struct (f90-looking-at-type-like))
1798                        f90-type-indent)
1799                       ((setq struct (f90-looking-at-associate))
1800                        f90-associate-indent)
1801                       ((or (setq struct (f90-looking-at-program-block-start))
1802                            (looking-at "contains[ \t]*\\($\\|!\\)"))
1803                        f90-program-indent)))
1804     (if ind-b (setq ind-lev (+ ind-lev ind-b)))
1805     (if struct (setq block-list (cons struct block-list)))
1806     (while (and (f90-line-continued) (zerop (forward-line 1))
1807                 (< (point) end-region-mark))
1808       (if (looking-at "[ \t]*!")
1809           (f90-indent-to (f90-comment-indent))
1810         (or (= (current-indentation)
1811                (+ ind-curr f90-continuation-indent))
1812             (f90-indent-to (+ ind-curr f90-continuation-indent) 'no-line-no))))
1813     ;; Process all following lines.
1814     (while (and (zerop (forward-line 1)) (< (point) end-region-mark))
1815       (beginning-of-line)
1816       (f90-indent-line-no)
1817       (setq f90-cache-position (point))
1818       (cond ((looking-at "[ \t]*$") (setq ind-curr 0))
1819             ((looking-at "[ \t]*#") (setq ind-curr 0))
1820             ((looking-at "!") (setq ind-curr (f90-comment-indent)))
1821             ((f90-no-block-limit) (setq ind-curr ind-lev))
1822             ((looking-at f90-else-like-re) (setq ind-curr
1823                                                  (- ind-lev f90-if-indent)))
1824             ((looking-at "contains[ \t]*\\($\\|!\\)")
1825              (setq ind-curr (- ind-lev f90-program-indent)))
1826             ((setq ind-b
1827                    (cond ((setq struct (f90-looking-at-do)) f90-do-indent)
1828                          ((or (setq struct (f90-looking-at-if-then))
1829                               (setq struct (f90-looking-at-select-case))
1830                               (setq struct (f90-looking-at-where-or-forall)))
1831                           f90-if-indent)
1832                          ((setq struct (f90-looking-at-type-like))
1833                           f90-type-indent)
1834                          ((setq struct (f90-looking-at-associate))
1835                           f90-associate-indent)
1836                          ((setq struct (f90-looking-at-program-block-start))
1837                           f90-program-indent)))
1838              (setq ind-curr ind-lev)
1839              (if ind-b (setq ind-lev (+ ind-lev ind-b)))
1840              (setq block-list (cons struct block-list)))
1841             ((setq end-struct (f90-looking-at-program-block-end))
1842              (setq beg-struct (car block-list)
1843                    block-list (cdr block-list))
1844              (if f90-smart-end
1845                  (save-excursion
1846                    (f90-block-match (car beg-struct) (cadr beg-struct)
1847                                     (car end-struct) (cadr end-struct))))
1848              (setq ind-b
1849                    (cond ((looking-at f90-end-if-re) f90-if-indent)
1850                          ((looking-at "end[ \t]*do\\>")  f90-do-indent)
1851                          ((looking-at f90-end-type-re) f90-type-indent)
1852                          ((looking-at f90-end-associate-re)
1853                           f90-associate-indent)
1854                          ((f90-looking-at-program-block-end)
1855                           f90-program-indent)))
1856              (if ind-b (setq ind-lev (- ind-lev ind-b)))
1857              (setq ind-curr ind-lev))
1858             (t (setq ind-curr ind-lev)))
1859       ;; Do the indentation if necessary.
1860       (or (= ind-curr (current-column))
1861           (f90-indent-to ind-curr))
1862       (while (and (f90-line-continued) (zerop (forward-line 1))
1863                   (< (point) end-region-mark))
1864         (if (looking-at "[ \t]*!")
1865             (f90-indent-to (f90-comment-indent))
1866           (or (= (current-indentation)
1867                  (+ ind-curr f90-continuation-indent))
1868               (f90-indent-to
1869                (+ ind-curr f90-continuation-indent) 'no-line-no)))))
1870     ;; Restore point, etc.
1871     (setq f90-cache-position nil)
1872     (goto-char save-point)
1873     (set-marker end-region-mark nil)
1874     (set-marker save-point nil)
1875     (if (featurep 'xemacs)
1876         (zmacs-deactivate-region)
1877       (deactivate-mark))))
1878
1879 (defun f90-indent-subprogram ()
1880   "Properly indent the subprogram containing point."
1881   (interactive "*")
1882   (save-excursion
1883     (let ((program (f90-mark-subprogram)))
1884       (if program
1885           (progn
1886             (message "Indenting %s %s..."
1887                      (car program) (cadr program))
1888             (indent-region (point) (mark) nil)
1889             (message "Indenting %s %s...done"
1890                      (car program) (cadr program)))
1891         (message "Indenting the whole file...")
1892         (indent-region (point) (mark) nil)
1893         (message "Indenting the whole file...done")))))
1894
1895 (defun f90-break-line (&optional no-update)
1896   "Break line at point, insert continuation marker(s) and indent.
1897 Unless in a string or comment, or if the optional argument NO-UPDATE
1898 is non-nil, call `f90-update-line' after inserting the continuation marker."
1899   (interactive "*P")
1900   (cond ((f90-in-string)
1901          (insert "&\n&"))
1902         ((f90-in-comment)
1903          (delete-horizontal-space 'backwards) ; remove trailing whitespace
1904          (insert "\n" (f90-get-present-comment-type)))
1905         (t (insert "&")
1906            (or no-update (f90-update-line))
1907            (newline 1)
1908            (if f90-beginning-ampersand (insert "&"))))
1909   (indent-according-to-mode))
1910
1911 (defun f90-find-breakpoint ()
1912   "From `fill-column', search backward for break-delimiter."
1913   (re-search-backward f90-break-delimiters (line-beginning-position))
1914   (if (not f90-break-before-delimiters)
1915       (forward-char (if (looking-at f90-no-break-re) 2 1))
1916     (backward-char)
1917     (or (looking-at f90-no-break-re)
1918         (forward-char))))
1919
1920 (defun f90-do-auto-fill ()
1921   "Break line if non-white characters beyond `fill-column'.
1922 Update keyword case first."
1923   (interactive "*")
1924   ;; Break line before or after last delimiter (non-word char) if
1925   ;; position is beyond fill-column.
1926   ;; Will not break **, //, or => (as specified by f90-no-break-re).
1927   (f90-update-line)
1928   ;; Need this for `f90-electric-insert' and other f90- callers.
1929   (unless (and (boundp 'comment-auto-fill-only-comments)
1930                comment-auto-fill-only-comments
1931                (not (f90-in-comment)))
1932     (while (> (current-column) fill-column)
1933       (let ((pos-mark (point-marker)))
1934         (move-to-column fill-column)
1935         (or (f90-in-string) (f90-find-breakpoint))
1936         (f90-break-line)
1937         (goto-char pos-mark)
1938         (set-marker pos-mark nil)))))
1939
1940 (defun f90-join-lines (&optional arg)
1941   "Join current line to previous, fix whitespace, continuation, comments.
1942 With optional argument ARG, join current line to following line.
1943 Like `join-line', but handles F90 syntax."
1944   (interactive "*P")
1945   (beginning-of-line)
1946   (if arg (forward-line 1))
1947   (when (eq (preceding-char) ?\n)
1948     (skip-chars-forward " \t")
1949     (if (looking-at "\&") (delete-char 1))
1950     (beginning-of-line)
1951     (delete-region (point) (1- (point)))
1952     (skip-chars-backward " \t")
1953     (and (eq (preceding-char) ?&) (delete-char -1))
1954     (and (f90-in-comment)
1955          (looking-at "[ \t]*!+")
1956          (replace-match ""))
1957     (or (f90-in-string)
1958         (fixup-whitespace))))
1959
1960 (defun f90-fill-region (beg-region end-region)
1961   "Fill every line in region by forward parsing.  Join lines if possible."
1962   (interactive "*r")
1963   (let ((end-region-mark (copy-marker end-region))
1964         (go-on t)
1965         f90-smart-end f90-auto-keyword-case auto-fill-function)
1966     (goto-char beg-region)
1967     (while go-on
1968       ;; Join as much as possible.
1969       (while (progn
1970                (end-of-line)
1971                (skip-chars-backward " \t")
1972                (eq (preceding-char) ?&))
1973         (f90-join-lines 'forward))
1974       ;; Chop the line if necessary.
1975       (while (> (save-excursion (end-of-line) (current-column))
1976                 fill-column)
1977         (move-to-column fill-column)
1978         (f90-find-breakpoint)
1979         (f90-break-line 'no-update))
1980       (setq go-on (and (< (point) end-region-mark)
1981                        (zerop (forward-line 1)))
1982             f90-cache-position (point)))
1983     (setq f90-cache-position nil)
1984     (set-marker end-region-mark nil)
1985     (if (featurep 'xemacs)
1986         (zmacs-deactivate-region)
1987       (deactivate-mark))))
1988 \f
1989 (defun f90-block-match (beg-block beg-name end-block end-name)
1990   "Match end-struct with beg-struct and complete end-block if possible.
1991 BEG-BLOCK is the type of block as indicated at the start (e.g., do).
1992 BEG-NAME is the block start name (may be nil).
1993 END-BLOCK is the type of block as indicated at the end (may be nil).
1994 END-NAME is the block end name (may be nil).
1995 Leave point at the end of line."
1996   ;; Hack to deal with the case when this is called from
1997   ;; f90-indent-region on a program block without an explicit PROGRAM
1998   ;; statement at the start. Should really be an error (?).
1999   (or beg-block (setq beg-block "program"))
2000   (search-forward "end" (line-end-position))
2001   (catch 'no-match
2002     (if (and end-block (f90-equal-symbols beg-block end-block))
2003         (search-forward end-block)
2004       (if end-block
2005           (progn
2006             (message "END %s does not match %s." end-block beg-block)
2007             (end-of-line)
2008             (throw 'no-match nil))
2009         (message "Inserting %s." beg-block)
2010         (insert (concat " " beg-block))))
2011     (if (f90-equal-symbols beg-name end-name)
2012         (and end-name (search-forward end-name))
2013       (cond ((and beg-name (not end-name))
2014              (message "Inserting %s." beg-name)
2015              (insert (concat " " beg-name)))
2016             ((and beg-name end-name)
2017              (message "Replacing %s with %s." end-name beg-name)
2018              (search-forward end-name)
2019              (replace-match beg-name))
2020             ((and (not beg-name) end-name)
2021              (message "Deleting %s." end-name)
2022              (search-forward end-name)
2023              (replace-match ""))))
2024     (or (looking-at "[ \t]*!") (delete-horizontal-space))))
2025
2026 (defun f90-match-end ()
2027   "From an end block statement, find the corresponding block and name."
2028   (interactive)
2029   (let ((count 1)
2030         (top-of-window (window-start))
2031         (end-point (point))
2032         (case-fold-search t)
2033         matching-beg beg-name end-name beg-block end-block end-struct)
2034     (when (save-excursion (beginning-of-line) (skip-chars-forward " \t0-9")
2035                           (setq end-struct (f90-looking-at-program-block-end)))
2036       (setq end-block (car end-struct)
2037             end-name  (cadr end-struct))
2038       (save-excursion
2039         (beginning-of-line)
2040         (while (and (> count 0)
2041                     (not (= (line-beginning-position) (point-min))))
2042           (re-search-backward f90-blocks-re nil 'move)
2043           (beginning-of-line)
2044           ;; GM not a line number if continued line.
2045 ;;;          (skip-chars-forward " \t")
2046 ;;;          (skip-chars-forward "0-9")
2047           (skip-chars-forward " \t0-9")
2048           (cond ((or (f90-in-string) (f90-in-comment)))
2049                 ((setq matching-beg
2050                        (or
2051                         (f90-looking-at-do)
2052                         (f90-looking-at-if-then)
2053                         (f90-looking-at-where-or-forall)
2054                         (f90-looking-at-select-case)
2055                         (f90-looking-at-type-like)
2056                         (f90-looking-at-associate)
2057                         (f90-looking-at-program-block-start)
2058                         ;; Interpret a single END without a block
2059                         ;; start to be the END of a program block
2060                         ;; without an initial PROGRAM line.
2061                         (if (= (line-beginning-position) (point-min))
2062                             '("program" nil))))
2063                  (setq count (1- count)))
2064                 ((looking-at (concat "end[ \t]*" f90-blocks-re))
2065                  (setq count (1+ count)))))
2066         (if (> count 0)
2067             (message "No matching beginning.")
2068           (f90-update-line)
2069           (if (eq f90-smart-end 'blink)
2070               (if (< (point) top-of-window)
2071                   (message "Matches %s: %s"
2072                            (what-line)
2073                            (buffer-substring
2074                             (line-beginning-position)
2075                             (line-end-position)))
2076                 (sit-for blink-matching-delay)))
2077           (setq beg-block (car matching-beg)
2078                 beg-name (cadr matching-beg))
2079           (goto-char end-point)
2080           (beginning-of-line)
2081           (f90-block-match beg-block beg-name end-block end-name))))))
2082
2083 (defun f90-insert-end ()
2084   "Insert a complete end statement matching beginning of present block."
2085   (interactive "*")
2086   (let ((f90-smart-end (or f90-smart-end 'blink)))
2087     (insert "end")
2088     (f90-indent-new-line)))
2089 \f
2090 ;; Abbrevs and keywords.
2091
2092 (defun f90-abbrev-start ()
2093   "Typing `\\[help-command] or `? lists all the F90 abbrevs.
2094 Any other key combination is executed normally."
2095   (interactive "*")
2096   (insert last-command-char)
2097   (let (char event)
2098     (if (fboundp 'next-command-event) ; XEmacs
2099         (setq event (next-command-event)
2100               char (and (fboundp 'event-to-character)
2101                         (event-to-character event)))
2102       (setq event (read-event)
2103             char event))
2104     ;; Insert char if not equal to `?', or if abbrev-mode is off.
2105     (if (and abbrev-mode (or (eq char ??) (eq char help-char)))
2106         (f90-abbrev-help)
2107       (setq unread-command-events (list event)))))
2108
2109 (defun f90-abbrev-help ()
2110   "List the currently defined abbrevs in F90 mode."
2111   (interactive)
2112   (message "Listing abbrev table...")
2113   (display-buffer (f90-prepare-abbrev-list-buffer))
2114   (message "Listing abbrev table...done"))
2115
2116 (defun f90-prepare-abbrev-list-buffer ()
2117   "Create a buffer listing the F90 mode abbreviations."
2118   (with-current-buffer (get-buffer-create "*Abbrevs*")
2119     (erase-buffer)
2120     (insert-abbrev-table-description 'f90-mode-abbrev-table t)
2121     (goto-char (point-min))
2122     (set-buffer-modified-p nil)
2123     (edit-abbrevs-mode))
2124   (get-buffer-create "*Abbrevs*"))
2125
2126 (defun f90-upcase-keywords ()
2127   "Upcase all F90 keywords in the buffer."
2128   (interactive "*")
2129   (f90-change-keywords 'upcase-word))
2130
2131 (defun f90-capitalize-keywords ()
2132   "Capitalize all F90 keywords in the buffer."
2133   (interactive "*")
2134   (f90-change-keywords 'capitalize-word))
2135
2136 (defun f90-downcase-keywords ()
2137   "Downcase all F90 keywords in the buffer."
2138   (interactive "*")
2139   (f90-change-keywords 'downcase-word))
2140
2141 (defun f90-upcase-region-keywords (beg end)
2142   "Upcase all F90 keywords in the region."
2143   (interactive "*r")
2144   (f90-change-keywords 'upcase-word beg end))
2145
2146 (defun f90-capitalize-region-keywords (beg end)
2147   "Capitalize all F90 keywords in the region."
2148   (interactive "*r")
2149   (f90-change-keywords 'capitalize-word beg end))
2150
2151 (defun f90-downcase-region-keywords (beg end)
2152   "Downcase all F90 keywords in the region."
2153   (interactive "*r")
2154   (f90-change-keywords 'downcase-word beg end))
2155
2156 ;; Change the keywords according to argument.
2157 (defun f90-change-keywords (change-word &optional beg end)
2158   "Change the case of F90 keywords in the region (if specified) or buffer.
2159 CHANGE-WORD should be one of 'upcase-word, 'downcase-word, 'capitalize-word."
2160   (save-excursion
2161     (setq beg (or beg (point-min))
2162           end (or end (point-max)))
2163     (let ((keyword-re
2164            (concat "\\("
2165                    f90-keywords-re "\\|" f90-procedures-re "\\|"
2166                    f90-hpf-keywords-re "\\|" f90-operators-re "\\)"))
2167           (ref-point (point-min))
2168           (modified (buffer-modified-p))
2169           state saveword back-point)
2170       (goto-char beg)
2171       (unwind-protect
2172           (while (re-search-forward keyword-re end t)
2173             (unless (progn
2174                       (setq state (parse-partial-sexp ref-point (point)))
2175                       (or (nth 3 state) (nth 4 state)
2176                           ;; GM f90-directive-comment-re?
2177                           (save-excursion ; check for cpp directive
2178                             (beginning-of-line)
2179                             (skip-chars-forward " \t0-9")
2180                             (looking-at "#"))))
2181               (setq ref-point (point)
2182                     back-point (save-excursion (backward-word 1) (point))
2183                     saveword (buffer-substring back-point ref-point))
2184               (funcall change-word -1)
2185               (or (string= saveword (buffer-substring back-point ref-point))
2186                   (setq modified t))))
2187         (or modified (restore-buffer-modified-p nil))))))
2188
2189
2190 (defun f90-current-defun ()
2191   "Function to use for `add-log-current-defun-function' in F90 mode."
2192   (save-excursion
2193     (nth 1 (f90-beginning-of-subprogram))))
2194
2195
2196 (defun f90-backslash-not-special (&optional all)
2197   "Make the backslash character (\\) be non-special in the current buffer.
2198 With optional argument ALL, change the default for all present
2199 and future F90 buffers.  F90 mode normally treats backslash as an
2200 escape character."
2201   (or (eq major-mode 'f90-mode)
2202       (error "This function should only be used in F90 buffers"))
2203   (when (equal (char-syntax ?\\ ) ?\\ )
2204     (or all (set-syntax-table (copy-syntax-table (syntax-table))))
2205     (modify-syntax-entry ?\\ ".")))
2206
2207
2208 (provide 'f90)
2209
2210 ;; arch-tag: fceac97c-c147-44bd-aec0-172d4b560ef8
2211 ;;; f90.el ends here