Mercurial > urweb

annotate src/elisp/urweb-mode.el @ 366:3004f8843e36

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Proper indenting of normal ML-y code after </xml>
author Adam Chlipala <adamc@hcoop.net>
date Thu, 16 Oct 2008 13:17:09 -0400
parents dda8f3c6ae7c
children 28d3d7210687
rev   line source
adamc@350 1 ;;; urweb-mode.el --- Major mode for editing (Standard) ML
adamc@350 2
adamc@350 3 ;; Based on sml-mode:
adamc@350 4 ;; Copyright (C) 1999,2000,2004 Stefan Monnier
adamc@350 5 ;; Copyright (C) 1994-1997 Matthew J. Morley
adamc@350 6 ;; Copyright (C) 1989 Lars Bo Nielsen
adamc@350 7 ;;
adamc@350 8 ;; Modified for urweb-mode:
adamc@350 9 ;; Copyright (C) 2008 Adam Chlipala <adamc@hcoop.net>
adamc@350 10
adamc@350 11 ;; Author: Lars Bo Nielsen
adamc@350 12 ;; Olin Shivers
adamc@350 13 ;; Fritz Knabe (?)
adamc@350 14 ;; Steven Gilmore (?)
adamc@350 15 ;; Matthew Morley <mjm@scs.leeds.ac.uk> (aka <matthew@verisity.com>)
adamc@350 16 ;; Matthias Blume <blume@cs.princeton.edu> (aka <blume@kurims.kyoto-u.ac.jp>)
adamc@350 17 ;; (Stefan Monnier) monnier@cs.yale.edu
adamc@350 18 ;; Adam Chlipala
adamc@350 19
adamc@350 20 ;; This file is not part of GNU Emacs, but it is distributed under the
adamc@350 21 ;; same conditions.
adamc@350 22
adamc@350 23 ;; This program is free software; you can redistribute it and/or
adamc@350 24 ;; modify it under the terms of the GNU General Public License as
adamc@350 25 ;; published by the Free Software Foundation; either version 2, or (at
adamc@350 26 ;; your option) any later version.
adamc@350 27
adamc@350 28 ;; This program is distributed in the hope that it will be useful, but
adamc@350 29 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
adamc@350 30 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
adamc@350 31 ;; General Public License for more details.
adamc@350 32
adamc@350 33 ;; You should have received a copy of the GNU General Public License
adamc@350 34 ;; along with GNU Emacs; see the file COPYING. If not, write to the
adamc@350 35 ;; Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
adamc@350 36
adamc@350 37 ;;; Commentary:
adamc@350 38
adamc@350 39 ;;; HISTORY
adamc@350 40
adamc@350 41 ;; Still under construction: History obscure, needs a biographer as
adamc@350 42 ;; well as a M-x doctor. Change Log on request.
adamc@350 43
adamc@358 44 ;; Hacked by Olin Shivers for comint from Lars Bo Nielsen's sml.el.
adamc@350 45
adamc@350 46 ;; Hacked by Matthew Morley to incorporate Fritz Knabe's hilite and
adamc@350 47 ;; font-lock patterns, some of Steven Gilmore's (reduced) easy-menus,
adamc@350 48 ;; and numerous bugs and bug-fixes.
adamc@350 49
adamc@350 50 ;;; DESCRIPTION
adamc@350 51
adamc@350 52 ;; See accompanying info file: urweb-mode.info
adamc@350 53
adamc@350 54 ;;; FOR YOUR .EMACS FILE
adamc@350 55
adamc@350 56 ;; If urweb-mode.el lives in some non-standard directory, you must tell
adamc@350 57 ;; emacs where to get it. This may or may not be necessary:
adamc@350 58
adamc@350 59 ;; (add-to-list 'load-path "~jones/lib/emacs/")
adamc@350 60
adamc@350 61 ;; Then to access the commands autoload urweb-mode with that command:
adamc@350 62
adamc@350 63 ;; (load "urweb-mode-startup")
adamc@350 64
adamc@350 65 ;; urweb-mode-hook is run whenever a new urweb-mode buffer is created.
adamc@350 66
adamc@350 67 ;;; Code:
adamc@350 68
adamc@350 69 (eval-when-compile (require 'cl))
adamc@350 70 (require 'urweb-util)
adamc@350 71 (require 'urweb-move)
adamc@350 72 (require 'urweb-defs)
adamc@350 73 (condition-case nil (require 'skeleton) (error nil))
adamc@350 74
adamc@350 75 ;;; VARIABLES CONTROLLING INDENTATION
adamc@350 76
adamc@350 77 (defcustom urweb-indent-level 4
adamc@350 78 "*Indentation of blocks in Ur/Web (see also `urweb-structure-indent')."
adamc@350 79 :group 'urweb
adamc@350 80 :type '(integer))
adamc@350 81
adamc@350 82 (defcustom urweb-indent-args urweb-indent-level
adamc@350 83 "*Indentation of args placed on a separate line."
adamc@350 84 :group 'urweb
adamc@350 85 :type '(integer))
adamc@350 86
adamc@350 87 (defcustom urweb-electric-semi-mode nil
adamc@350 88 "*If non-nil, `\;' will self insert, reindent the line, and do a newline.
adamc@350 89 If nil, just insert a `\;'. (To insert while t, do: \\[quoted-insert] \;)."
adamc@350 90 :group 'urweb
adamc@350 91 :type 'boolean)
adamc@350 92
adamc@350 93 (defcustom urweb-rightalign-and t
adamc@350 94 "If non-nil, right-align `and' with its leader.
adamc@350 95 If nil: If t:
adamc@350 96 datatype a = A datatype a = A
adamc@350 97 and b = B and b = B"
adamc@350 98 :group 'urweb
adamc@350 99 :type 'boolean)
adamc@350 100
adamc@350 101 ;;; OTHER GENERIC MODE VARIABLES
adamc@350 102
adamc@350 103 (defvar urweb-mode-info "urweb-mode"
adamc@350 104 "*Where to find Info file for `urweb-mode'.
adamc@350 105 The default assumes the info file \"urweb-mode.info\" is on Emacs' info
adamc@350 106 directory path. If it is not, either put the file on the standard path
adamc@350 107 or set the variable `urweb-mode-info' to the exact location of this file
adamc@350 108
adamc@350 109 (setq urweb-mode-info \"/usr/me/lib/info/urweb-mode\")
adamc@350 110
adamc@350 111 in your .emacs file. You can always set it interactively with the
adamc@350 112 set-variable command.")
adamc@350 113
adamc@350 114 (defvar urweb-mode-hook nil
adamc@350 115 "*Run upon entering `urweb-mode'.
adamc@350 116 This is a good place to put your preferred key bindings.")
adamc@350 117
adamc@350 118 ;;; CODE FOR Ur/Web-MODE
adamc@350 119
adamc@350 120 (defun urweb-mode-info ()
adamc@350 121 "Command to access the TeXinfo documentation for `urweb-mode'.
adamc@350 122 See doc for the variable `urweb-mode-info'."
adamc@350 123 (interactive)
adamc@350 124 (require 'info)
adamc@350 125 (condition-case nil
adamc@350 126 (info urweb-mode-info)
adamc@350 127 (error (progn
adamc@350 128 (describe-variable 'urweb-mode-info)
adamc@350 129 (message "Can't find it... set this variable first!")))))
adamc@350 130
adamc@350 131
adamc@350 132 ;; font-lock setup
adamc@350 133
adamc@350 134 (defconst urweb-keywords-regexp
adamc@350 135 (urweb-syms-re "and" "case" "class" "con" "constraint" "constraints"
adamc@350 136 "datatype" "else" "end" "extern" "fn" "fold"
adamc@350 137 "fun" "functor" "if" "include"
adamc@350 138 "of" "open"
adamc@350 139 "rec" "sequence" "sig" "signature"
adamc@350 140 "struct" "structure" "table" "then" "type" "val" "where"
adamc@350 141 "with"
adamc@350 142
adamc@350 143 "Name" "Type" "Unit")
adamc@350 144 "A regexp that matches any non-SQL keywords of Ur/Web.")
adamc@350 145
adamc@350 146 (defconst urweb-sql-keywords-regexp
adamc@350 147 (urweb-syms-re "SELECT" "FROM" "AS" "WHERE" "SQL" "GROUP" "ORDER" "BY"
adamc@350 148 "HAVING" "LIMIT" "OFFSET" "ALL" "UNION" "INTERSECT" "EXCEPT"
adamc@350 149 "TRUE" "FALSE" "AND" "OR" "NOT" "COUNT" "AVG" "SUM" "MIN" "MAX"
adamc@350 150 "ASC" "DESC" "INSERT" "INTO" "VALUES" "UPDATE" "SET" "DELETE")
adamc@350 151 "A regexp that matches SQL keywords.")
adamc@350 152
adamc@351 153 (defconst urweb-lident-regexp "\\<[a-z_][A-Za-z0-9_']*\\>"
adamc@351 154 "A regexp that matches lowercase Ur/Web identifiers.")
adamc@351 155
adamc@351 156 (defconst urweb-cident-regexp "\\<[A-Z][A-Za-z0-9_']*\\>"
adamc@351 157 "A regexp that matches uppercase Ur/Web identifiers.")
adamc@351 158
adamc@350 159 ;;; Font-lock settings ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
adamc@350 160
adamc@350 161 ;; The font lock regular expressions.
adamc@350 162
adamc@363 163 (defun urweb-in-xml ()
adamc@360 164 (save-excursion
adamc@360 165 (let (
adamc@360 166 (depth 0)
adamc@360 167 (finished nil)
adamc@360 168 (answer nil)
adamc@360 169 )
adamc@360 170 (while (and (not finished) (re-search-backward "[<>{}]" nil t))
adamc@360 171 (cond
adamc@360 172 ((looking-at "{")
adamc@360 173 (if (> depth 0)
adamc@363 174 (decf depth)
adamc@360 175 (setq finished t)))
adamc@360 176 ((looking-at "}")
adamc@363 177 (incf depth))
adamc@360 178 ((save-excursion (backward-char 1) (or (looking-at "=>") (looking-at "->")))
adamc@360 179 nil)
adamc@360 180 ((looking-at "<")
adamc@360 181 (setq finished t))
adamc@360 182 ((looking-at ">")
adamc@360 183 (if (> depth 0)
adamc@360 184 (if (not (re-search-backward "<" nil t))
adamc@360 185 (setq finished t))
adamc@360 186 (progn (backward-char 4)
adamc@360 187 (setq answer (not (or
adamc@360 188 (looking-at "/xml")
adamc@360 189 (looking-at "xml/"))))
adamc@360 190 (setq finished t))))))
adamc@360 191 answer)))
adamc@360 192
adamc@360 193 (defun amAttribute (face)
adamc@360 194 (if (ignore-errors (save-excursion (backward-word 2) (backward-char 1) (looking-at "<")))
adamc@360 195 nil
adamc@360 196 face))
adamc@358 197
adamc@350 198 (defconst urweb-font-lock-keywords
adamc@350 199 `(;;(urweb-font-comments-and-strings)
adamc@362 200 ("\\(<\\sw+\\)\\(\\s-\\|\\sw\\|=\\|\"[^\"]*\"\\|{[^}]*}\\)*\\(/?>\\)"
adamc@359 201 (1 font-lock-tag-face)
adamc@359 202 (3 font-lock-tag-face))
adamc@359 203 ("\\(</\\sw+>\\)"
adamc@359 204 (1 font-lock-tag-face))
adamc@359 205 ("\\([^<>{}]+\\)"
adamc@363 206 (1 (if (urweb-in-xml)
adamc@359 207 font-lock-string-face
adamc@359 208 nil)))
adamc@359 209
adamc@357 210 ("\\<\\(fun\\|and\\)\\s-+\\(\\sw+\\)\\s-+[^ \t\n=]"
adamc@350 211 (1 font-lock-keyword-face)
adamc@360 212 (2 (amAttribute font-lock-function-name-face)))
adamc@357 213 ("\\<\\(\\(data\\)?type\\|con\\|class\\)\\s-+\\(\\sw+\\)"
adamc@350 214 (1 font-lock-keyword-face)
adamc@360 215 (3 (amAttribute font-lock-type-def-face)))
adamc@353 216 ("\\<\\(val\\|table\\|sequence\\)\\s-+\\(\\sw+\\>\\s-*\\)?\\(\\sw+\\)\\s-*[=:]"
adamc@350 217 (1 font-lock-keyword-face)
adamc@360 218 (3 (amAttribute font-lock-variable-name-face)))
adamc@350 219 ("\\<\\(structure\\|functor\\)\\s-+\\(\\sw+\\)"
adamc@350 220 (1 font-lock-keyword-face)
adamc@360 221 (2 (amAttribute font-lock-module-def-face)))
adamc@350 222 ("\\<\\(signature\\)\\s-+\\(\\sw+\\)"
adamc@350 223 (1 font-lock-keyword-face)
adamc@360 224 (2 (amAttribute font-lock-interface-def-face)))
adamc@350 225
adamc@350 226 (,urweb-keywords-regexp . font-lock-keyword-face)
adamc@351 227 (,urweb-sql-keywords-regexp . font-lock-sql-face)
adamc@351 228 (,urweb-cident-regexp . font-lock-cvariable-face))
adamc@350 229 "Regexps matching standard Ur/Web keywords.")
adamc@350 230
adamc@350 231 (defface font-lock-type-def-face
adamc@350 232 '((t (:bold t)))
adamc@350 233 "Font Lock mode face used to highlight type definitions."
adamc@350 234 :group 'font-lock-highlighting-faces)
adamc@350 235 (defvar font-lock-type-def-face 'font-lock-type-def-face
adamc@350 236 "Face name to use for type definitions.")
adamc@350 237
adamc@350 238 (defface font-lock-module-def-face
adamc@350 239 '((t (:bold t)))
adamc@350 240 "Font Lock mode face used to highlight module definitions."
adamc@350 241 :group 'font-lock-highlighting-faces)
adamc@350 242 (defvar font-lock-module-def-face 'font-lock-module-def-face
adamc@350 243 "Face name to use for module definitions.")
adamc@350 244
adamc@350 245 (defface font-lock-interface-def-face
adamc@350 246 '((t (:bold t)))
adamc@350 247 "Font Lock mode face used to highlight interface definitions."
adamc@350 248 :group 'font-lock-highlighting-faces)
adamc@350 249 (defvar font-lock-interface-def-face 'font-lock-interface-def-face
adamc@350 250 "Face name to use for interface definitions.")
adamc@350 251
adamc@350 252 (defface font-lock-sql-face
adamc@350 253 '((t (:bold t)))
adamc@350 254 "Font Lock mode face used to highlight SQL keywords."
adamc@350 255 :group 'font-lock-highlighting-faces)
adamc@350 256 (defvar font-lock-sql-face 'font-lock-sql-face
adamc@350 257 "Face name to use for SQL keywords.")
adamc@350 258
adamc@351 259 (defface font-lock-cvariable-face
adamc@351 260 '((t (:foreground "dark blue")))
adamc@351 261 "Font Lock mode face used to highlight capitalized identifiers."
adamc@351 262 :group 'font-lock-highlighting-faces)
adamc@351 263 (defvar font-lock-cvariable-face 'font-lock-cvariable-face
adamc@351 264 "Face name to use for capitalized identifiers.")
adamc@351 265
adamc@357 266 (defface font-lock-tag-face
adamc@357 267 '((t (:bold t)))
adamc@357 268 "Font Lock mode face used to highlight XML tags."
adamc@357 269 :group 'font-lock-highlighting-faces)
adamc@357 270 (defvar font-lock-tag-face 'font-lock-tag-face
adamc@357 271 "Face name to use for XML tags.")
adamc@357 272
adamc@358 273 (defface font-lock-attr-face
adamc@358 274 '((t (:bold t)))
adamc@358 275 "Font Lock mode face used to highlight XML attributes."
adamc@358 276 :group 'font-lock-highlighting-faces)
adamc@358 277 (defvar font-lock-attr-face 'font-lock-attr-face
adamc@358 278 "Face name to use for XML attributes.")
adamc@358 279
adamc@350 280 ;;
adamc@350 281 ;; Code to handle nested comments and unusual string escape sequences
adamc@350 282 ;;
adamc@350 283
adamc@350 284 (defsyntax urweb-syntax-prop-table
adamc@350 285 '((?\\ . ".") (?* . "."))
adamc@350 286 "Syntax table for text-properties")
adamc@350 287
adamc@350 288 ;; For Emacsen that have no built-in support for nested comments
adamc@350 289 (defun urweb-get-depth-st ()
adamc@350 290 (save-excursion
adamc@350 291 (let* ((disp (if (eq (char-before) ?\)) (progn (backward-char) -1) nil))
adamc@350 292 (_ (backward-char))
adamc@350 293 (disp (if (eq (char-before) ?\() (progn (backward-char) 0) disp))
adamc@350 294 (pt (point)))
adamc@350 295 (when disp
adamc@350 296 (let* ((depth
adamc@350 297 (save-match-data
adamc@350 298 (if (re-search-backward "\\*)\\|(\\*" nil t)
adamc@350 299 (+ (or (get-char-property (point) 'comment-depth) 0)
adamc@350 300 (case (char-after) (?\( 1) (?* 0))
adamc@350 301 disp)
adamc@350 302 0)))
adamc@350 303 (depth (if (> depth 0) depth)))
adamc@350 304 (put-text-property pt (1+ pt) 'comment-depth depth)
adamc@350 305 (when depth urweb-syntax-prop-table))))))
adamc@350 306
adamc@350 307 (defconst urweb-font-lock-syntactic-keywords
adamc@350 308 `(("^\\s-*\\(\\\\\\)" (1 ',urweb-syntax-prop-table))
adamc@350 309 ,@(unless urweb-builtin-nested-comments-flag
adamc@350 310 '(("(?\\(\\*\\))?" (1 (urweb-get-depth-st)))))))
adamc@350 311
adamc@350 312 (defconst urweb-font-lock-defaults
adamc@350 313 '(urweb-font-lock-keywords nil nil ((?_ . "w") (?' . "w")) nil
adamc@350 314 (font-lock-syntactic-keywords . urweb-font-lock-syntactic-keywords)))
adamc@350 315
adamc@350 316 ;;;;
adamc@350 317 ;;;; Imenu support
adamc@350 318 ;;;;
adamc@350 319
adamc@350 320 (defvar urweb-imenu-regexp
adamc@350 321 (concat "^[ \t]*\\(let[ \t]+\\)?"
adamc@350 322 (regexp-opt (append urweb-module-head-syms
adamc@350 323 '("and" "fun" "datatype" "type")) t)
adamc@350 324 "\\>"))
adamc@350 325
adamc@350 326 (defun urweb-imenu-create-index ()
adamc@350 327 (let (alist)
adamc@350 328 (goto-char (point-max))
adamc@350 329 (while (re-search-backward urweb-imenu-regexp nil t)
adamc@350 330 (save-excursion
adamc@350 331 (let ((kind (match-string 2))
adamc@350 332 (column (progn (goto-char (match-beginning 2)) (current-column)))
adamc@350 333 (location
adamc@350 334 (progn (goto-char (match-end 0))
adamc@350 335 (urweb-forward-spaces)
adamc@350 336 (when (looking-at urweb-tyvarseq-re)
adamc@350 337 (goto-char (match-end 0)))
adamc@350 338 (point)))
adamc@350 339 (name (urweb-forward-sym)))
adamc@350 340 ;; Eliminate trivial renamings.
adamc@350 341 (when (or (not (member kind '("structure" "signature")))
adamc@350 342 (progn (search-forward "=")
adamc@350 343 (urweb-forward-spaces)
adamc@350 344 (looking-at "sig\\|struct")))
adamc@350 345 (push (cons (concat (make-string (/ column 2) ?\ ) name) location)
adamc@350 346 alist)))))
adamc@350 347 alist))
adamc@350 348
adamc@350 349 ;;; MORE CODE FOR URWEB-MODE
adamc@350 350
adamc@350 351 ;;;###autoload (add-to-list 'load-path (file-name-directory load-file-name))
adamc@350 352 ;;;###autoload
adamc@362 353 (add-to-list 'auto-mode-alist '("\\.urs?\\'" . urweb-mode))
adamc@350 354
adamc@350 355 ;;;###autoload
adamc@350 356 (define-derived-mode urweb-mode fundamental-mode "Ur/Web"
adamc@350 357 "\\<urweb-mode-map>Major mode for editing Ur/Web code.
adamc@350 358 This mode runs `urweb-mode-hook' just before exiting.
adamc@350 359 \\{urweb-mode-map}"
adamc@350 360 (set (make-local-variable 'font-lock-defaults) urweb-font-lock-defaults)
adamc@358 361 (set (make-local-variable 'font-lock-multiline) 'undecided)
adamc@350 362 (set (make-local-variable 'outline-regexp) urweb-outline-regexp)
adamc@350 363 (set (make-local-variable 'imenu-create-index-function)
adamc@350 364 'urweb-imenu-create-index)
adamc@350 365 (set (make-local-variable 'add-log-current-defun-function)
adamc@350 366 'urweb-current-fun-name)
adamc@350 367 ;; Treat paragraph-separators in comments as paragraph-separators.
adamc@350 368 (set (make-local-variable 'paragraph-separate)
adamc@350 369 (concat "\\([ \t]*\\*)?\\)?\\(" paragraph-separate "\\)"))
adamc@350 370 (set (make-local-variable 'require-final-newline) t)
adamc@350 371 ;; forward-sexp-function is an experimental variable in my hacked Emacs.
adamc@350 372 (set (make-local-variable 'forward-sexp-function) 'urweb-user-forward-sexp)
adamc@350 373 ;; For XEmacs
adamc@350 374 (easy-menu-add urweb-mode-menu)
adamc@358 375
adamc@350 376 ;; Compatibility. FIXME: we should use `-' in Emacs-CVS.
adamc@350 377 (unless (boundp 'skeleton-positions) (set (make-local-variable '@) nil))
adamc@358 378
adamc@360 379 (urweb-mode-variables))
adamc@350 380
adamc@350 381 (defun urweb-mode-variables ()
adamc@350 382 (set-syntax-table urweb-mode-syntax-table)
adamc@350 383 (setq local-abbrev-table urweb-mode-abbrev-table)
adamc@350 384 ;; A paragraph is separated by blank lines or ^L only.
adamc@350 385
adamc@350 386 (set (make-local-variable 'indent-line-function) 'urweb-indent-line)
adamc@350 387 (set (make-local-variable 'comment-start) "(* ")
adamc@350 388 (set (make-local-variable 'comment-end) " *)")
adamc@350 389 (set (make-local-variable 'comment-nested) t)
adamc@350 390 ;;(set (make-local-variable 'block-comment-start) "* ")
adamc@350 391 ;;(set (make-local-variable 'block-comment-end) "")
adamc@350 392 ;; (set (make-local-variable 'comment-column) 40)
adamc@350 393 (set (make-local-variable 'comment-start-skip) "(\\*+\\s-*"))
adamc@350 394
adamc@350 395 (defun urweb-funname-of-and ()
adamc@350 396 "Name of the function this `and' defines, or nil if not a function.
adamc@350 397 Point has to be right after the `and' symbol and is not preserved."
adamc@350 398 (urweb-forward-spaces)
adamc@350 399 (if (looking-at urweb-tyvarseq-re) (goto-char (match-end 0)))
adamc@350 400 (let ((sym (urweb-forward-sym)))
adamc@350 401 (urweb-forward-spaces)
adamc@350 402 (unless (or (member sym '(nil "d="))
adamc@350 403 (member (urweb-forward-sym) '("d=")))
adamc@350 404 sym)))
adamc@350 405
adamc@350 406 ;;; INDENTATION !!!
adamc@350 407
adamc@350 408 (defun urweb-mark-function ()
adamc@350 409 "Synonym for `mark-paragraph' -- sorry.
adamc@350 410 If anyone has a good algorithm for this..."
adamc@350 411 (interactive)
adamc@350 412 (mark-paragraph))
adamc@350 413
adamc@350 414 (defun urweb-indent-line ()
adamc@350 415 "Indent current line of Ur/Web code."
adamc@350 416 (interactive)
adamc@350 417 (let ((savep (> (current-column) (current-indentation)))
adamc@350 418 (indent (max (or (ignore-errors (urweb-calculate-indentation)) 0) 0)))
adamc@350 419 (if savep
adamc@350 420 (save-excursion (indent-line-to indent))
adamc@350 421 (indent-line-to indent))))
adamc@350 422
adamc@350 423 (defun urweb-back-to-outer-indent ()
adamc@350 424 "Unindents to the next outer level of indentation."
adamc@350 425 (interactive)
adamc@350 426 (save-excursion
adamc@350 427 (beginning-of-line)
adamc@350 428 (skip-chars-forward "\t ")
adamc@350 429 (let ((start-column (current-column))
adamc@350 430 (indent (current-column)))
adamc@350 431 (if (> start-column 0)
adamc@350 432 (progn
adamc@350 433 (save-excursion
adamc@350 434 (while (>= indent start-column)
adamc@350 435 (if (re-search-backward "^[^\n]" nil t)
adamc@350 436 (setq indent (current-indentation))
adamc@350 437 (setq indent 0))))
adamc@350 438 (backward-delete-char-untabify (- start-column indent)))))))
adamc@350 439
adamc@350 440 (defun urweb-find-comment-indent ()
adamc@350 441 (save-excursion
adamc@350 442 (let ((depth 1))
adamc@350 443 (while (> depth 0)
adamc@350 444 (if (re-search-backward "(\\*\\|\\*)" nil t)
adamc@350 445 (cond
adamc@350 446 ;; FIXME: That's just a stop-gap.
adamc@350 447 ((eq (get-text-property (point) 'face) 'font-lock-string-face))
adamc@350 448 ((looking-at "*)") (incf depth))
adamc@350 449 ((looking-at comment-start-skip) (decf depth)))
adamc@350 450 (setq depth -1)))
adamc@350 451 (if (= depth 0)
adamc@350 452 (1+ (current-column))
adamc@350 453 nil))))
adamc@350 454
adamc@365 455 (defun urweb-begun-xml ()
adamc@365 456 "Check if this is the first new line in a new <xml>...</xml> section"
adamc@365 457 (save-excursion
adamc@365 458 (let ((start-pos (point)))
adamc@365 459 (previous-line 1)
adamc@365 460 (search-forward "<xml>" start-pos t))))
adamc@365 461
adamc@363 462 (defun urweb-new-tags ()
adamc@363 463 "Decide if the previous line of XML introduced unclosed tags"
adamc@363 464 (save-excursion
adamc@363 465 (let ((start-pos (point))
adamc@363 466 (depth 0)
adamc@363 467 (done nil))
adamc@363 468 (previous-line 1)
adamc@363 469 (beginning-of-line)
adamc@363 470 (while (and (not done) (search-forward "<" start-pos t))
adamc@363 471 (if (looking-at "/")
adamc@363 472 (if (search-forward ">" start-pos t)
adamc@363 473 (when (> depth 0) (decf depth))
adamc@363 474 (setq done t))
adamc@363 475 (if (search-forward ">" start-pos t)
adamc@363 476 (if (not (save-excursion (backward-char 2) (looking-at "/")))
adamc@363 477 (incf depth))
adamc@363 478 (setq done t))))
adamc@363 479 (and (not done) (> depth 0)))))
adamc@363 480
adamc@363 481 (defun urweb-tag-matching-indent ()
adamc@363 482 "Seek back to a matching opener tag and get its line's indent"
adamc@363 483 (save-excursion
adamc@363 484 (let ((depth 0)
adamc@363 485 (done nil))
adamc@363 486 (while (and (not done) (search-backward ">" nil t))
adamc@363 487 (if (save-excursion (backward-char 1) (looking-at "/"))
adamc@363 488 (when (not (search-backward "<" nil t))
adamc@363 489 (setq done t))
adamc@363 490 (if (search-backward "<" nil t)
adamc@363 491 (if (looking-at "</")
adamc@363 492 (incf depth)
adamc@363 493 (if (= depth 0)
adamc@363 494 (setq done t)
adamc@363 495 (decf depth)))
adamc@363 496 (setq done t))))
adamc@365 497 (if (looking-at "<xml")
adamc@365 498 (+ (current-indentation) 2)
adamc@365 499 (current-indentation)))))
adamc@363 500
adamc@350 501 (defun urweb-calculate-indentation ()
adamc@350 502 (save-excursion
adamc@350 503 (beginning-of-line) (skip-chars-forward "\t ")
adamc@350 504 (urweb-with-ist
adamc@350 505 ;; Indentation for comments alone on a line, matches the
adamc@350 506 ;; proper indentation of the next line.
adamc@350 507 (when (looking-at "(\\*") (urweb-forward-spaces))
adamc@350 508 (let (data
adamc@350 509 (sym (save-excursion (urweb-forward-sym))))
adamc@350 510 (or
adamc@350 511 ;; Allow the user to override the indentation.
adamc@350 512 (when (looking-at (concat ".*" (regexp-quote comment-start)
adamc@350 513 "[ \t]*fixindent[ \t]*"
adamc@350 514 (regexp-quote comment-end)))
adamc@350 515 (current-indentation))
adamc@350 516
adamc@350 517 ;; Continued comment.
adamc@350 518 (and (looking-at "\\*") (urweb-find-comment-indent))
adamc@350 519
adamc@363 520 (and (urweb-in-xml)
adamc@363 521 (let ((prev-indent (save-excursion
adamc@363 522 (previous-line 1)
adamc@364 523 (end-of-line 1)
adamc@363 524 (re-search-backward "^[^\n]" nil t)
adamc@363 525 (current-indentation))))
adamc@363 526 (cond
adamc@363 527 ((looking-at "</")
adamc@363 528 (urweb-tag-matching-indent))
adamc@365 529 ((urweb-begun-xml)
adamc@365 530 (+ prev-indent 4))
adamc@363 531 ((urweb-new-tags)
adamc@363 532 (+ prev-indent 2))
adamc@363 533 (t
adamc@363 534 prev-indent))))
adamc@363 535
adamc@350 536 ;; Continued string ? (Added 890113 lbn)
adamc@350 537 (and (looking-at "\\\\")
adamc@350 538 (save-excursion
adamc@350 539 (if (save-excursion (previous-line 1)
adamc@350 540 (beginning-of-line)
adamc@350 541 (looking-at "[\t ]*\\\\"))
adamc@350 542 (progn (previous-line 1) (current-indentation))
adamc@350 543 (if (re-search-backward "[^\\\\]\"" nil t)
adamc@350 544 (1+ (current-column))
adamc@350 545 0))))
adamc@350 546
adamc@350 547 ;; Closing parens. Could be handled below with `urweb-indent-relative'?
adamc@350 548 (and (looking-at "\\s)")
adamc@350 549 (save-excursion
adamc@350 550 (skip-syntax-forward ")")
adamc@350 551 (backward-sexp 1)
adamc@350 552 (if (urweb-dangling-sym)
adamc@350 553 (urweb-indent-default 'noindent)
adamc@350 554 (current-column))))
adamc@350 555
adamc@350 556 (and (setq data (assoc sym urweb-close-paren))
adamc@350 557 (urweb-indent-relative sym data))
adamc@350 558
adamc@350 559 (and (member sym urweb-starters-syms)
adamc@350 560 (urweb-indent-starter sym))
adamc@350 561
adamc@350 562 (and (string= sym "|") (urweb-indent-pipe))
adamc@350 563
adamc@350 564 (urweb-indent-arg)
adamc@350 565 (urweb-indent-default))))))
adamc@350 566
adamc@350 567 (defsubst urweb-bolp ()
adamc@350 568 (save-excursion (skip-chars-backward " \t|") (bolp)))
adamc@350 569
adamc@350 570 (defun urweb-indent-starter (orig-sym)
adamc@350 571 "Return the indentation to use for a symbol in `urweb-starters-syms'.
adamc@350 572 Point should be just before the symbol ORIG-SYM and is not preserved."
adamc@350 573 (let ((sym (unless (save-excursion (urweb-backward-arg))
adamc@350 574 (urweb-backward-spaces)
adamc@350 575 (urweb-backward-sym))))
adamc@366 576 (if (and (= sym ">") (save-excursion (backward-char 5) (looking-at "</xml")))
adamc@366 577 (setq sym "</xml>"))
adamc@350 578 (if (member sym '(";" "d=")) (setq sym nil))
adamc@350 579 (if sym (urweb-get-sym-indent sym)
adamc@350 580 ;; FIXME: this can take a *long* time !!
adamc@350 581 (setq sym (urweb-find-matching-starter urweb-starters-syms))
adamc@350 582 ;; Don't align with `and' because it might be specially indented.
adamc@350 583 (if (and (or (equal orig-sym "and") (not (equal sym "and")))
adamc@350 584 (urweb-bolp))
adamc@350 585 (+ (current-column)
adamc@350 586 (if (and urweb-rightalign-and (equal orig-sym "and"))
adamc@350 587 (- (length sym) 3) 0))
adamc@350 588 (urweb-indent-starter orig-sym)))))
adamc@350 589
adamc@350 590 (defun urweb-indent-relative (sym data)
adamc@350 591 (save-excursion
adamc@350 592 (urweb-forward-sym) (urweb-backward-sexp nil)
adamc@350 593 (unless (second data) (urweb-backward-spaces) (urweb-backward-sym))
adamc@350 594 (+ (or (cdr (assoc sym urweb-symbol-indent)) 0)
adamc@350 595 (urweb-delegated-indent))))
adamc@350 596
adamc@350 597 (defun urweb-indent-pipe ()
adamc@350 598 (let ((sym (urweb-find-matching-starter urweb-pipeheads
adamc@350 599 (urweb-op-prec "|" 'back))))
adamc@350 600 (when sym
adamc@350 601 (if (string= sym "|")
adamc@350 602 (if (urweb-bolp) (current-column) (urweb-indent-pipe))
adamc@350 603 (let ((pipe-indent (or (cdr (assoc "|" urweb-symbol-indent)) -2)))
adamc@350 604 (when (or (member sym '("datatype"))
adamc@350 605 (and (equal sym "and")
adamc@350 606 (save-excursion
adamc@350 607 (forward-word 1)
adamc@350 608 (not (urweb-funname-of-and)))))
adamc@350 609 (re-search-forward "="))
adamc@350 610 (urweb-forward-sym)
adamc@350 611 (urweb-forward-spaces)
adamc@350 612 (+ pipe-indent (current-column)))))))
adamc@350 613
adamc@350 614 (defun urweb-find-forward (re)
adamc@350 615 (urweb-forward-spaces)
adamc@350 616 (while (and (not (looking-at re))
adamc@350 617 (progn
adamc@350 618 (or (ignore-errors (forward-sexp 1) t) (forward-char 1))
adamc@350 619 (urweb-forward-spaces)
adamc@350 620 (not (looking-at re))))))
adamc@350 621
adamc@350 622 (defun urweb-indent-arg ()
adamc@350 623 (and (save-excursion (ignore-errors (urweb-forward-arg)))
adamc@350 624 ;;(not (looking-at urweb-not-arg-re))
adamc@350 625 ;; looks like a function or an argument
adamc@350 626 (urweb-move-if (urweb-backward-arg))
adamc@350 627 ;; an argument
adamc@350 628 (if (save-excursion (not (urweb-backward-arg)))
adamc@350 629 ;; a first argument
adamc@350 630 (+ (current-column) urweb-indent-args)
adamc@350 631 ;; not a first arg
adamc@350 632 (while (and (/= (current-column) (current-indentation))
adamc@350 633 (urweb-move-if (urweb-backward-arg))))
adamc@350 634 (unless (save-excursion (urweb-backward-arg))
adamc@350 635 ;; all earlier args are on the same line
adamc@350 636 (urweb-forward-arg) (urweb-forward-spaces))
adamc@350 637 (current-column))))
adamc@350 638
adamc@350 639 (defun urweb-get-indent (data sym)
adamc@350 640 (let (d)
adamc@350 641 (cond
adamc@350 642 ((not (listp data)) data)
adamc@350 643 ((setq d (member sym data)) (cadr d))
adamc@350 644 ((and (consp data) (not (stringp (car data)))) (car data))
adamc@350 645 (t urweb-indent-level))))
adamc@350 646
adamc@350 647 (defun urweb-dangling-sym ()
adamc@350 648 "Non-nil if the symbol after point is dangling.
adamc@350 649 The symbol can be an Ur/Web symbol or an open-paren. \"Dangling\" means that
adamc@350 650 it is not on its own line but is the last element on that line."
adamc@350 651 (save-excursion
adamc@350 652 (and (not (urweb-bolp))
adamc@350 653 (< (urweb-point-after (end-of-line))
adamc@350 654 (urweb-point-after (or (urweb-forward-sym) (skip-syntax-forward "("))
adamc@350 655 (urweb-forward-spaces))))))
adamc@350 656
adamc@350 657 (defun urweb-delegated-indent ()
adamc@350 658 (if (urweb-dangling-sym)
adamc@350 659 (urweb-indent-default 'noindent)
adamc@350 660 (urweb-move-if (backward-word 1)
adamc@350 661 (looking-at urweb-agglomerate-re))
adamc@350 662 (current-column)))
adamc@350 663
adamc@350 664 (defun urweb-get-sym-indent (sym &optional style)
adamc@350 665 "Find the indentation for the SYM we're `looking-at'.
adamc@350 666 If indentation is delegated, point will move to the start of the parent.
adamc@350 667 Optional argument STYLE is currently ignored."
adamc@350 668 (assert (equal sym (save-excursion (urweb-forward-sym))))
adamc@350 669 (save-excursion
adamc@350 670 (let ((delegate (and (not (equal sym "end")) (assoc sym urweb-close-paren)))
adamc@350 671 (head-sym sym))
adamc@350 672 (when (and delegate (not (eval (third delegate))))
adamc@350 673 ;;(urweb-find-match-backward sym delegate)
adamc@350 674 (urweb-forward-sym) (urweb-backward-sexp nil)
adamc@350 675 (setq head-sym
adamc@350 676 (if (second delegate)
adamc@350 677 (save-excursion (urweb-forward-sym))
adamc@350 678 (urweb-backward-spaces) (urweb-backward-sym))))
adamc@350 679
adamc@350 680 (let ((idata (assoc head-sym urweb-indent-rule)))
adamc@350 681 (when idata
adamc@350 682 ;;(if (or style (not delegate))
adamc@350 683 ;; normal indentation
adamc@350 684 (let ((indent (urweb-get-indent (cdr idata) sym)))
adamc@350 685 (when indent (+ (urweb-delegated-indent) indent)))
adamc@350 686 ;; delgate indentation to the parent
adamc@350 687 ;;(urweb-forward-sym) (urweb-backward-sexp nil)
adamc@350 688 ;;(let* ((parent-sym (save-excursion (urweb-forward-sym)))
adamc@350 689 ;; (parent-indent (cdr (assoc parent-sym urweb-indent-starters))))
adamc@350 690 ;; check the special rules
adamc@350 691 ;;(+ (urweb-delegated-indent)
adamc@350 692 ;; (or (urweb-get-indent (cdr indent-data) 1 'strict)
adamc@350 693 ;; (urweb-get-indent (cdr parent-indent) 1 'strict)
adamc@350 694 ;; (urweb-get-indent (cdr indent-data) 0)
adamc@350 695 ;; (urweb-get-indent (cdr parent-indent) 0))))))))
adamc@350 696 )))))
adamc@350 697
adamc@350 698 (defun urweb-indent-default (&optional noindent)
adamc@350 699 (let* ((sym-after (save-excursion (urweb-forward-sym)))
adamc@350 700 (_ (urweb-backward-spaces))
adamc@350 701 (sym-before (urweb-backward-sym))
adamc@350 702 (sym-indent (and sym-before (urweb-get-sym-indent sym-before)))
adamc@350 703 (indent-after (or (cdr (assoc sym-after urweb-symbol-indent)) 0)))
adamc@350 704 (when (equal sym-before "end")
adamc@350 705 ;; I don't understand what's really happening here, but when
adamc@350 706 ;; it's `end' clearly, we need to do something special.
adamc@350 707 (forward-word 1)
adamc@350 708 (setq sym-before nil sym-indent nil))
adamc@350 709 (cond
adamc@350 710 (sym-indent
adamc@350 711 ;; the previous sym is an indentation introducer: follow the rule
adamc@350 712 (if noindent
adamc@350 713 ;;(current-column)
adamc@350 714 sym-indent
adamc@350 715 (+ sym-indent indent-after)))
adamc@350 716 ;; If we're just after a hanging open paren.
adamc@350 717 ((and (eq (char-syntax (preceding-char)) ?\()
adamc@350 718 (save-excursion (backward-char) (urweb-dangling-sym)))
adamc@350 719 (backward-char)
adamc@350 720 (urweb-indent-default))
adamc@350 721 (t
adamc@350 722 ;; default-default
adamc@350 723 (let* ((prec-after (urweb-op-prec sym-after 'back))
adamc@350 724 (prec (or (urweb-op-prec sym-before 'back) prec-after 100)))
adamc@350 725 ;; go back until you hit a symbol that has a lower prec than the
adamc@350 726 ;; "current one", or until you backed over a sym that has the same prec
adamc@350 727 ;; but is at the beginning of a line.
adamc@350 728 (while (and (not (urweb-bolp))
adamc@350 729 (while (urweb-move-if (urweb-backward-sexp (1- prec))))
adamc@350 730 (not (urweb-bolp)))
adamc@350 731 (while (urweb-move-if (urweb-backward-sexp prec))))
adamc@350 732 (if noindent
adamc@350 733 ;; the `noindent' case does back over an introductory symbol
adamc@350 734 ;; such as `fun', ...
adamc@350 735 (progn
adamc@350 736 (urweb-move-if
adamc@350 737 (urweb-backward-spaces)
adamc@350 738 (member (urweb-backward-sym) urweb-starters-syms))
adamc@350 739 (current-column))
adamc@350 740 ;; Use `indent-after' for cases such as when , or ; should be
adamc@350 741 ;; outdented so that their following terms are aligned.
adamc@350 742 (+ (if (progn
adamc@350 743 (if (equal sym-after ";")
adamc@350 744 (urweb-move-if
adamc@350 745 (urweb-backward-spaces)
adamc@350 746 (member (urweb-backward-sym) urweb-starters-syms)))
adamc@350 747 (and sym-after (not (looking-at sym-after))))
adamc@350 748 indent-after 0)
adamc@350 749 (current-column))))))))
adamc@350 750
adamc@350 751
adamc@350 752 ;; maybe `|' should be set to word-syntax in our temp syntax table ?
adamc@350 753 (defun urweb-current-indentation ()
adamc@350 754 (save-excursion
adamc@350 755 (beginning-of-line)
adamc@350 756 (skip-chars-forward " \t|")
adamc@350 757 (current-column)))
adamc@350 758
adamc@350 759
adamc@350 760 (defun urweb-find-matching-starter (syms &optional prec)
adamc@350 761 (let (sym)
adamc@350 762 (ignore-errors
adamc@350 763 (while
adamc@350 764 (progn (urweb-backward-sexp prec)
adamc@350 765 (setq sym (save-excursion (urweb-forward-sym)))
adamc@350 766 (not (or (member sym syms) (bobp)))))
adamc@350 767 (if (member sym syms) sym))))
adamc@350 768
adamc@350 769 (defun urweb-skip-siblings ()
adamc@350 770 (while (and (not (bobp)) (urweb-backward-arg))
adamc@350 771 (urweb-find-matching-starter urweb-starters-syms)))
adamc@350 772
adamc@350 773 (defun urweb-beginning-of-defun ()
adamc@350 774 (let ((sym (urweb-find-matching-starter urweb-starters-syms)))
adamc@350 775 (if (member sym '("fun" "and" "functor" "signature" "structure"
adamc@350 776 "datatype"))
adamc@350 777 (save-excursion (urweb-forward-sym) (urweb-forward-spaces)
adamc@350 778 (urweb-forward-sym))
adamc@350 779 ;; We're inside a "non function declaration": let's skip all other
adamc@350 780 ;; declarations that we find at the same level and try again.
adamc@350 781 (urweb-skip-siblings)
adamc@350 782 ;; Obviously, let's not try again if we're at bobp.
adamc@350 783 (unless (bobp) (urweb-beginning-of-defun)))))
adamc@350 784
adamc@350 785 (defcustom urweb-max-name-components 3
adamc@350 786 "Maximum number of components to use for the current function name."
adamc@350 787 :group 'urweb
adamc@350 788 :type 'integer)
adamc@350 789
adamc@350 790 (defun urweb-current-fun-name ()
adamc@350 791 (save-excursion
adamc@350 792 (let ((count urweb-max-name-components)
adamc@350 793 fullname name)
adamc@350 794 (end-of-line)
adamc@350 795 (while (and (> count 0)
adamc@350 796 (setq name (urweb-beginning-of-defun)))
adamc@350 797 (decf count)
adamc@350 798 (setq fullname (if fullname (concat name "." fullname) name))
adamc@350 799 ;; Skip all other declarations that we find at the same level.
adamc@350 800 (urweb-skip-siblings))
adamc@350 801 fullname)))
adamc@350 802
adamc@358 803
adamc@358 804
adamc@350 805 (provide 'urweb-mode)
adamc@350 806
adamc@350 807 ;;; urweb-mode.el ends here