Mercurial > urweb

annotate src/elisp/urweb-mode.el @ 386:ef43ed6cd1de

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix a nasty indent bug, found while working on listFun
author Adam Chlipala <adamc@hcoop.net>
date Sun, 19 Oct 2008 16:49:09 -0400
parents d3de57ce4bca
children bc5a56ed0cd6
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@374 178 ((save-excursion (backward-char 1) (or (looking-at "=>")
adamc@374 179 (looking-at "->")
adamc@374 180 (looking-at "<>")))
adamc@360 181 nil)
adamc@360 182 ((looking-at "<")
adamc@360 183 (setq finished t))
adamc@360 184 ((looking-at ">")
adamc@374 185 (cond
adamc@374 186 ((> depth 0)
adamc@374 187 (if (not (re-search-backward "<" nil t))
adamc@374 188 (setq finished t)))
adamc@374 189 (t
adamc@360 190 (progn (backward-char 4)
adamc@360 191 (setq answer (not (or
adamc@360 192 (looking-at "/xml")
adamc@360 193 (looking-at "xml/"))))
adamc@374 194 (setq finished t)))))))
adamc@360 195 answer)))
adamc@360 196
adamc@360 197 (defun amAttribute (face)
adamc@360 198 (if (ignore-errors (save-excursion (backward-word 2) (backward-char 1) (looking-at "<")))
adamc@360 199 nil
adamc@360 200 face))
adamc@358 201
adamc@350 202 (defconst urweb-font-lock-keywords
adamc@350 203 `(;;(urweb-font-comments-and-strings)
adamc@362 204 ("\\(<\\sw+\\)\\(\\s-\\|\\sw\\|=\\|\"[^\"]*\"\\|{[^}]*}\\)*\\(/?>\\)"
adamc@359 205 (1 font-lock-tag-face)
adamc@359 206 (3 font-lock-tag-face))
adamc@359 207 ("\\(</\\sw+>\\)"
adamc@359 208 (1 font-lock-tag-face))
adamc@359 209 ("\\([^<>{}]+\\)"
adamc@363 210 (1 (if (urweb-in-xml)
adamc@359 211 font-lock-string-face
adamc@359 212 nil)))
adamc@359 213
adamc@357 214 ("\\<\\(fun\\|and\\)\\s-+\\(\\sw+\\)\\s-+[^ \t\n=]"
adamc@350 215 (1 font-lock-keyword-face)
adamc@360 216 (2 (amAttribute font-lock-function-name-face)))
adamc@357 217 ("\\<\\(\\(data\\)?type\\|con\\|class\\)\\s-+\\(\\sw+\\)"
adamc@350 218 (1 font-lock-keyword-face)
adamc@360 219 (3 (amAttribute font-lock-type-def-face)))
adamc@353 220 ("\\<\\(val\\|table\\|sequence\\)\\s-+\\(\\sw+\\>\\s-*\\)?\\(\\sw+\\)\\s-*[=:]"
adamc@350 221 (1 font-lock-keyword-face)
adamc@360 222 (3 (amAttribute font-lock-variable-name-face)))
adamc@350 223 ("\\<\\(structure\\|functor\\)\\s-+\\(\\sw+\\)"
adamc@350 224 (1 font-lock-keyword-face)
adamc@360 225 (2 (amAttribute font-lock-module-def-face)))
adamc@350 226 ("\\<\\(signature\\)\\s-+\\(\\sw+\\)"
adamc@350 227 (1 font-lock-keyword-face)
adamc@360 228 (2 (amAttribute font-lock-interface-def-face)))
adamc@350 229
adamc@350 230 (,urweb-keywords-regexp . font-lock-keyword-face)
adamc@351 231 (,urweb-sql-keywords-regexp . font-lock-sql-face)
adamc@351 232 (,urweb-cident-regexp . font-lock-cvariable-face))
adamc@350 233 "Regexps matching standard Ur/Web keywords.")
adamc@350 234
adamc@350 235 (defface font-lock-type-def-face
adamc@350 236 '((t (:bold t)))
adamc@350 237 "Font Lock mode face used to highlight type definitions."
adamc@350 238 :group 'font-lock-highlighting-faces)
adamc@350 239 (defvar font-lock-type-def-face 'font-lock-type-def-face
adamc@350 240 "Face name to use for type definitions.")
adamc@350 241
adamc@350 242 (defface font-lock-module-def-face
adamc@350 243 '((t (:bold t)))
adamc@350 244 "Font Lock mode face used to highlight module definitions."
adamc@350 245 :group 'font-lock-highlighting-faces)
adamc@350 246 (defvar font-lock-module-def-face 'font-lock-module-def-face
adamc@350 247 "Face name to use for module definitions.")
adamc@350 248
adamc@350 249 (defface font-lock-interface-def-face
adamc@350 250 '((t (:bold t)))
adamc@350 251 "Font Lock mode face used to highlight interface definitions."
adamc@350 252 :group 'font-lock-highlighting-faces)
adamc@350 253 (defvar font-lock-interface-def-face 'font-lock-interface-def-face
adamc@350 254 "Face name to use for interface definitions.")
adamc@350 255
adamc@350 256 (defface font-lock-sql-face
adamc@350 257 '((t (:bold t)))
adamc@350 258 "Font Lock mode face used to highlight SQL keywords."
adamc@350 259 :group 'font-lock-highlighting-faces)
adamc@350 260 (defvar font-lock-sql-face 'font-lock-sql-face
adamc@350 261 "Face name to use for SQL keywords.")
adamc@350 262
adamc@351 263 (defface font-lock-cvariable-face
adamc@351 264 '((t (:foreground "dark blue")))
adamc@351 265 "Font Lock mode face used to highlight capitalized identifiers."
adamc@351 266 :group 'font-lock-highlighting-faces)
adamc@351 267 (defvar font-lock-cvariable-face 'font-lock-cvariable-face
adamc@351 268 "Face name to use for capitalized identifiers.")
adamc@351 269
adamc@357 270 (defface font-lock-tag-face
adamc@357 271 '((t (:bold t)))
adamc@357 272 "Font Lock mode face used to highlight XML tags."
adamc@357 273 :group 'font-lock-highlighting-faces)
adamc@357 274 (defvar font-lock-tag-face 'font-lock-tag-face
adamc@357 275 "Face name to use for XML tags.")
adamc@357 276
adamc@358 277 (defface font-lock-attr-face
adamc@358 278 '((t (:bold t)))
adamc@358 279 "Font Lock mode face used to highlight XML attributes."
adamc@358 280 :group 'font-lock-highlighting-faces)
adamc@358 281 (defvar font-lock-attr-face 'font-lock-attr-face
adamc@358 282 "Face name to use for XML attributes.")
adamc@358 283
adamc@350 284 ;;
adamc@350 285 ;; Code to handle nested comments and unusual string escape sequences
adamc@350 286 ;;
adamc@350 287
adamc@350 288 (defsyntax urweb-syntax-prop-table
adamc@350 289 '((?\\ . ".") (?* . "."))
adamc@350 290 "Syntax table for text-properties")
adamc@350 291
adamc@350 292 ;; For Emacsen that have no built-in support for nested comments
adamc@350 293 (defun urweb-get-depth-st ()
adamc@350 294 (save-excursion
adamc@350 295 (let* ((disp (if (eq (char-before) ?\)) (progn (backward-char) -1) nil))
adamc@350 296 (_ (backward-char))
adamc@350 297 (disp (if (eq (char-before) ?\() (progn (backward-char) 0) disp))
adamc@350 298 (pt (point)))
adamc@350 299 (when disp
adamc@350 300 (let* ((depth
adamc@350 301 (save-match-data
adamc@350 302 (if (re-search-backward "\\*)\\|(\\*" nil t)
adamc@350 303 (+ (or (get-char-property (point) 'comment-depth) 0)
adamc@350 304 (case (char-after) (?\( 1) (?* 0))
adamc@350 305 disp)
adamc@350 306 0)))
adamc@350 307 (depth (if (> depth 0) depth)))
adamc@350 308 (put-text-property pt (1+ pt) 'comment-depth depth)
adamc@350 309 (when depth urweb-syntax-prop-table))))))
adamc@350 310
adamc@350 311 (defconst urweb-font-lock-syntactic-keywords
adamc@350 312 `(("^\\s-*\\(\\\\\\)" (1 ',urweb-syntax-prop-table))
adamc@350 313 ,@(unless urweb-builtin-nested-comments-flag
adamc@350 314 '(("(?\\(\\*\\))?" (1 (urweb-get-depth-st)))))))
adamc@350 315
adamc@350 316 (defconst urweb-font-lock-defaults
adamc@350 317 '(urweb-font-lock-keywords nil nil ((?_ . "w") (?' . "w")) nil
adamc@350 318 (font-lock-syntactic-keywords . urweb-font-lock-syntactic-keywords)))
adamc@350 319
adamc@350 320 ;;;;
adamc@350 321 ;;;; Imenu support
adamc@350 322 ;;;;
adamc@350 323
adamc@350 324 (defvar urweb-imenu-regexp
adamc@350 325 (concat "^[ \t]*\\(let[ \t]+\\)?"
adamc@350 326 (regexp-opt (append urweb-module-head-syms
adamc@350 327 '("and" "fun" "datatype" "type")) t)
adamc@350 328 "\\>"))
adamc@350 329
adamc@350 330 (defun urweb-imenu-create-index ()
adamc@350 331 (let (alist)
adamc@350 332 (goto-char (point-max))
adamc@350 333 (while (re-search-backward urweb-imenu-regexp nil t)
adamc@350 334 (save-excursion
adamc@350 335 (let ((kind (match-string 2))
adamc@350 336 (column (progn (goto-char (match-beginning 2)) (current-column)))
adamc@350 337 (location
adamc@350 338 (progn (goto-char (match-end 0))
adamc@350 339 (urweb-forward-spaces)
adamc@350 340 (when (looking-at urweb-tyvarseq-re)
adamc@350 341 (goto-char (match-end 0)))
adamc@350 342 (point)))
adamc@350 343 (name (urweb-forward-sym)))
adamc@350 344 ;; Eliminate trivial renamings.
adamc@350 345 (when (or (not (member kind '("structure" "signature")))
adamc@350 346 (progn (search-forward "=")
adamc@350 347 (urweb-forward-spaces)
adamc@350 348 (looking-at "sig\\|struct")))
adamc@350 349 (push (cons (concat (make-string (/ column 2) ?\ ) name) location)
adamc@350 350 alist)))))
adamc@350 351 alist))
adamc@350 352
adamc@350 353 ;;; MORE CODE FOR URWEB-MODE
adamc@350 354
adamc@350 355 ;;;###autoload (add-to-list 'load-path (file-name-directory load-file-name))
adamc@350 356 ;;;###autoload
adamc@362 357 (add-to-list 'auto-mode-alist '("\\.urs?\\'" . urweb-mode))
adamc@350 358
adamc@350 359 ;;;###autoload
adamc@350 360 (define-derived-mode urweb-mode fundamental-mode "Ur/Web"
adamc@350 361 "\\<urweb-mode-map>Major mode for editing Ur/Web code.
adamc@350 362 This mode runs `urweb-mode-hook' just before exiting.
adamc@350 363 \\{urweb-mode-map}"
adamc@350 364 (set (make-local-variable 'font-lock-defaults) urweb-font-lock-defaults)
adamc@358 365 (set (make-local-variable 'font-lock-multiline) 'undecided)
adamc@350 366 (set (make-local-variable 'outline-regexp) urweb-outline-regexp)
adamc@350 367 (set (make-local-variable 'imenu-create-index-function)
adamc@350 368 'urweb-imenu-create-index)
adamc@350 369 (set (make-local-variable 'add-log-current-defun-function)
adamc@350 370 'urweb-current-fun-name)
adamc@350 371 ;; Treat paragraph-separators in comments as paragraph-separators.
adamc@350 372 (set (make-local-variable 'paragraph-separate)
adamc@350 373 (concat "\\([ \t]*\\*)?\\)?\\(" paragraph-separate "\\)"))
adamc@350 374 (set (make-local-variable 'require-final-newline) t)
adamc@350 375 ;; forward-sexp-function is an experimental variable in my hacked Emacs.
adamc@350 376 (set (make-local-variable 'forward-sexp-function) 'urweb-user-forward-sexp)
adamc@350 377 ;; For XEmacs
adamc@350 378 (easy-menu-add urweb-mode-menu)
adamc@358 379
adamc@350 380 ;; Compatibility. FIXME: we should use `-' in Emacs-CVS.
adamc@350 381 (unless (boundp 'skeleton-positions) (set (make-local-variable '@) nil))
adamc@358 382
adamc@360 383 (urweb-mode-variables))
adamc@350 384
adamc@350 385 (defun urweb-mode-variables ()
adamc@350 386 (set-syntax-table urweb-mode-syntax-table)
adamc@350 387 (setq local-abbrev-table urweb-mode-abbrev-table)
adamc@350 388 ;; A paragraph is separated by blank lines or ^L only.
adamc@350 389
adamc@350 390 (set (make-local-variable 'indent-line-function) 'urweb-indent-line)
adamc@350 391 (set (make-local-variable 'comment-start) "(* ")
adamc@350 392 (set (make-local-variable 'comment-end) " *)")
adamc@350 393 (set (make-local-variable 'comment-nested) t)
adamc@350 394 ;;(set (make-local-variable 'block-comment-start) "* ")
adamc@350 395 ;;(set (make-local-variable 'block-comment-end) "")
adamc@350 396 ;; (set (make-local-variable 'comment-column) 40)
adamc@350 397 (set (make-local-variable 'comment-start-skip) "(\\*+\\s-*"))
adamc@350 398
adamc@350 399 (defun urweb-funname-of-and ()
adamc@350 400 "Name of the function this `and' defines, or nil if not a function.
adamc@350 401 Point has to be right after the `and' symbol and is not preserved."
adamc@350 402 (urweb-forward-spaces)
adamc@350 403 (if (looking-at urweb-tyvarseq-re) (goto-char (match-end 0)))
adamc@350 404 (let ((sym (urweb-forward-sym)))
adamc@350 405 (urweb-forward-spaces)
adamc@350 406 (unless (or (member sym '(nil "d="))
adamc@350 407 (member (urweb-forward-sym) '("d=")))
adamc@350 408 sym)))
adamc@350 409
adamc@350 410 ;;; INDENTATION !!!
adamc@350 411
adamc@350 412 (defun urweb-mark-function ()
adamc@350 413 "Synonym for `mark-paragraph' -- sorry.
adamc@350 414 If anyone has a good algorithm for this..."
adamc@350 415 (interactive)
adamc@350 416 (mark-paragraph))
adamc@350 417
adamc@350 418 (defun urweb-indent-line ()
adamc@350 419 "Indent current line of Ur/Web code."
adamc@350 420 (interactive)
adamc@350 421 (let ((savep (> (current-column) (current-indentation)))
adamc@350 422 (indent (max (or (ignore-errors (urweb-calculate-indentation)) 0) 0)))
adamc@350 423 (if savep
adamc@350 424 (save-excursion (indent-line-to indent))
adamc@350 425 (indent-line-to indent))))
adamc@350 426
adamc@350 427 (defun urweb-back-to-outer-indent ()
adamc@350 428 "Unindents to the next outer level of indentation."
adamc@350 429 (interactive)
adamc@350 430 (save-excursion
adamc@350 431 (beginning-of-line)
adamc@350 432 (skip-chars-forward "\t ")
adamc@350 433 (let ((start-column (current-column))
adamc@350 434 (indent (current-column)))
adamc@350 435 (if (> start-column 0)
adamc@350 436 (progn
adamc@350 437 (save-excursion
adamc@350 438 (while (>= indent start-column)
adamc@350 439 (if (re-search-backward "^[^\n]" nil t)
adamc@350 440 (setq indent (current-indentation))
adamc@350 441 (setq indent 0))))
adamc@350 442 (backward-delete-char-untabify (- start-column indent)))))))
adamc@350 443
adamc@350 444 (defun urweb-find-comment-indent ()
adamc@350 445 (save-excursion
adamc@350 446 (let ((depth 1))
adamc@350 447 (while (> depth 0)
adamc@350 448 (if (re-search-backward "(\\*\\|\\*)" nil t)
adamc@350 449 (cond
adamc@350 450 ;; FIXME: That's just a stop-gap.
adamc@350 451 ((eq (get-text-property (point) 'face) 'font-lock-string-face))
adamc@350 452 ((looking-at "*)") (incf depth))
adamc@350 453 ((looking-at comment-start-skip) (decf depth)))
adamc@350 454 (setq depth -1)))
adamc@350 455 (if (= depth 0)
adamc@350 456 (1+ (current-column))
adamc@350 457 nil))))
adamc@350 458
adamc@369 459 (defun urweb-empty-line ()
adamc@365 460 (save-excursion
adamc@369 461 (beginning-of-line)
adamc@365 462 (let ((start-pos (point)))
adamc@369 463 (end-of-line)
adamc@369 464 (not (re-search-backward "[^\n \t]" start-pos t)))))
adamc@365 465
adamc@369 466 (defun urweb-seek-back ()
adamc@369 467 (while (urweb-empty-line) (previous-line 1)))
adamc@363 468
adamc@369 469 (defun urweb-skip-matching-braces ()
adamc@367 470 "Skip backwards past matching brace pairs, to calculate XML indentation after quoted Ur code"
adamc@367 471 (beginning-of-line)
adamc@367 472 (let ((start-pos (point))
adamc@367 473 (depth 0))
adamc@367 474 (end-of-line)
adamc@367 475 (while (re-search-backward "[{}]" start-pos t)
adamc@367 476 (cond
adamc@367 477 ((looking-at "}")
adamc@367 478 (incf depth))
adamc@367 479 ((looking-at "{")
adamc@367 480 (decf depth))))
adamc@367 481 (while (and (> depth 0) (re-search-backward "[{}]" nil t)
adamc@367 482 (cond
adamc@367 483 ((looking-at "}")
adamc@367 484 (incf depth))
adamc@367 485 ((looking-at "{")
adamc@367 486 (decf depth)))))))
adamc@367 487
adamc@369 488 (defun urweb-new-tags ()
adamc@369 489 "Decide if the previous line of XML introduced unclosed tags"
adamc@369 490 (save-excursion
adamc@369 491 (let ((start-pos (point))
adamc@369 492 (depth 0)
adamc@369 493 (done nil))
adamc@369 494 (previous-line 1)
adamc@369 495 (urweb-seek-back)
adamc@369 496 (urweb-skip-matching-braces)
adamc@369 497 (urweb-seek-back)
adamc@369 498 (beginning-of-line)
adamc@369 499 (while (and (not done) (search-forward "<" start-pos t))
adamc@369 500 (if (looking-at "/")
adamc@369 501 (if (search-forward ">" start-pos t)
adamc@369 502 (when (> depth 0) (decf depth))
adamc@369 503 (setq done t))
adamc@369 504 (if (search-forward ">" start-pos t)
adamc@369 505 (if (not (save-excursion (backward-char 2) (looking-at "/")))
adamc@369 506 (incf depth))
adamc@369 507 (setq done t))))
adamc@369 508 (and (not done) (> depth 0)))))
adamc@369 509
adamc@363 510 (defun urweb-tag-matching-indent ()
adamc@363 511 "Seek back to a matching opener tag and get its line's indent"
adamc@363 512 (save-excursion
adamc@369 513 (end-of-line)
adamc@369 514 (search-backward "</" nil t)
adamc@368 515 (urweb-tag-matcher)
adamc@369 516 (beginning-of-line)
adamc@369 517 (current-indentation)))
adamc@363 518
adamc@373 519 (defconst urweb-sql-main-starters
adamc@374 520 '("SQL" "SELECT" "INSERT" "UPDATE" "DELETE"))
adamc@373 521
adamc@372 522 (defconst urweb-sql-starters
adamc@373 523 (append urweb-sql-main-starters
adamc@373 524 '("^\\s-+FROM" "WHERE" "GROUP" "ORDER" "HAVING" "LIMIT" "OFFSET"
adamc@373 525 "VALUES" "SET")))
adamc@372 526
adamc@373 527 (defconst urweb-sql-main-starters-re
adamc@373 528 (urweb-syms-re urweb-sql-main-starters))
adamc@372 529 (defconst urweb-sql-starters-re
adamc@372 530 (urweb-syms-re urweb-sql-starters))
adamc@372 531
adamc@374 532 (defconst urweb-sql-main-starters-paren-re
adamc@374 533 (concat "(" urweb-sql-main-starters-re))
adamc@374 534
adamc@374 535 (defun urweb-in-sql ()
adamc@374 536 "Check if the point is in a block of SQL syntax."
adamc@374 537 (save-excursion
adamc@375 538 (let ((start-pos (point))
adamc@375 539 (depth 0)
adamc@375 540 done
adamc@375 541 (good t))
adamc@375 542 (when (re-search-backward urweb-sql-main-starters-paren-re nil t)
adamc@375 543 (forward-char)
adamc@375 544 (while (and (not done) (re-search-forward "[()]" start-pos t))
adamc@375 545 (save-excursion
adamc@375 546 (backward-char)
adamc@375 547 (cond
adamc@375 548 ((looking-at ")")
adamc@375 549 (cond
adamc@375 550 ((= depth 0) (setq done t) (setq good nil))
adamc@375 551 (t (decf depth))))
adamc@375 552 ((looking-at "(")
adamc@375 553 (incf depth)))))
adamc@375 554 good))))
adamc@374 555
adamc@374 556 (defun urweb-sql-depth ()
adamc@374 557 "Check if the point is in a block of SQL syntax.
adamc@374 558 Returns the paren nesting depth if so, and nil otherwise."
adamc@374 559 (save-excursion
adamc@374 560 (let ((depth 0)
adamc@374 561 done)
adamc@374 562 (while (and (not done)
adamc@374 563 (re-search-backward "[()]" nil t))
adamc@374 564 (cond
adamc@374 565 ((looking-at ")")
adamc@374 566 (decf depth))
adamc@374 567 ((looking-at "(")
adamc@374 568 (if (looking-at urweb-sql-main-starters-paren-re)
adamc@374 569 (setq done t)
adamc@374 570 (incf depth)))))
adamc@374 571 (max 0 depth))))
adamc@374 572
adamc@350 573 (defun urweb-calculate-indentation ()
adamc@350 574 (save-excursion
adamc@350 575 (beginning-of-line) (skip-chars-forward "\t ")
adamc@350 576 (urweb-with-ist
adamc@350 577 ;; Indentation for comments alone on a line, matches the
adamc@350 578 ;; proper indentation of the next line.
adamc@350 579 (when (looking-at "(\\*") (urweb-forward-spaces))
adamc@350 580 (let (data
adamc@350 581 (sym (save-excursion (urweb-forward-sym))))
adamc@350 582 (or
adamc@350 583 ;; Allow the user to override the indentation.
adamc@350 584 (when (looking-at (concat ".*" (regexp-quote comment-start)
adamc@350 585 "[ \t]*fixindent[ \t]*"
adamc@350 586 (regexp-quote comment-end)))
adamc@350 587 (current-indentation))
adamc@350 588
adamc@350 589 ;; Continued comment.
adamc@350 590 (and (looking-at "\\*") (urweb-find-comment-indent))
adamc@350 591
adamc@363 592 (and (urweb-in-xml)
adamc@363 593 (let ((prev-indent (save-excursion
adamc@363 594 (previous-line 1)
adamc@369 595 (urweb-seek-back)
adamc@369 596 (urweb-skip-matching-braces)
adamc@369 597 (urweb-seek-back)
adamc@363 598 (current-indentation))))
adamc@363 599 (cond
adamc@363 600 ((looking-at "</")
adamc@363 601 (urweb-tag-matching-indent))
adamc@363 602 ((urweb-new-tags)
adamc@363 603 (+ prev-indent 2))
adamc@363 604 (t
adamc@363 605 prev-indent))))
adamc@363 606
adamc@350 607 ;; Continued string ? (Added 890113 lbn)
adamc@350 608 (and (looking-at "\\\\")
adamc@350 609 (save-excursion
adamc@350 610 (if (save-excursion (previous-line 1)
adamc@350 611 (beginning-of-line)
adamc@350 612 (looking-at "[\t ]*\\\\"))
adamc@350 613 (progn (previous-line 1) (current-indentation))
adamc@350 614 (if (re-search-backward "[^\\\\]\"" nil t)
adamc@350 615 (1+ (current-column))
adamc@350 616 0))))
adamc@350 617
adamc@350 618 ;; Closing parens. Could be handled below with `urweb-indent-relative'?
adamc@350 619 (and (looking-at "\\s)")
adamc@350 620 (save-excursion
adamc@350 621 (skip-syntax-forward ")")
adamc@350 622 (backward-sexp 1)
adamc@350 623 (if (urweb-dangling-sym)
adamc@350 624 (urweb-indent-default 'noindent)
adamc@350 625 (current-column))))
adamc@350 626
adamc@374 627 (and (or (looking-at "FROM") (looking-at urweb-sql-starters-re))
adamc@386 628
adamc@372 629 (save-excursion
adamc@372 630 (and (re-search-backward urweb-sql-starters-re nil t)
adamc@373 631 (if (looking-at urweb-sql-main-starters-re)
adamc@373 632 (current-column)
adamc@373 633 (current-indentation)))))
adamc@372 634
adamc@374 635 (and (urweb-in-sql)
adamc@374 636 (setq data (urweb-sql-depth))
adamc@374 637 (save-excursion
adamc@374 638 (re-search-backward urweb-sql-starters-re nil t)
adamc@374 639 (+ (current-column) 2 (* 2 data))))
adamc@374 640
adamc@350 641 (and (setq data (assoc sym urweb-close-paren))
adamc@350 642 (urweb-indent-relative sym data))
adamc@350 643
adamc@350 644 (and (member sym urweb-starters-syms)
adamc@350 645 (urweb-indent-starter sym))
adamc@350 646
adamc@350 647 (and (string= sym "|") (urweb-indent-pipe))
adamc@350 648
adamc@350 649 (urweb-indent-arg)
adamc@350 650 (urweb-indent-default))))))
adamc@350 651
adamc@350 652 (defsubst urweb-bolp ()
adamc@350 653 (save-excursion (skip-chars-backward " \t|") (bolp)))
adamc@350 654
adamc@350 655 (defun urweb-indent-starter (orig-sym)
adamc@350 656 "Return the indentation to use for a symbol in `urweb-starters-syms'.
adamc@350 657 Point should be just before the symbol ORIG-SYM and is not preserved."
adamc@350 658 (let ((sym (unless (save-excursion (urweb-backward-arg))
adamc@350 659 (urweb-backward-spaces)
adamc@350 660 (urweb-backward-sym))))
adamc@350 661 (if (member sym '(";" "d=")) (setq sym nil))
adamc@350 662 (if sym (urweb-get-sym-indent sym)
adamc@350 663 ;; FIXME: this can take a *long* time !!
adamc@350 664 (setq sym (urweb-find-matching-starter urweb-starters-syms))
adamc@350 665 ;; Don't align with `and' because it might be specially indented.
adamc@350 666 (if (and (or (equal orig-sym "and") (not (equal sym "and")))
adamc@350 667 (urweb-bolp))
adamc@350 668 (+ (current-column)
adamc@350 669 (if (and urweb-rightalign-and (equal orig-sym "and"))
adamc@350 670 (- (length sym) 3) 0))
adamc@350 671 (urweb-indent-starter orig-sym)))))
adamc@350 672
adamc@350 673 (defun urweb-indent-relative (sym data)
adamc@350 674 (save-excursion
adamc@350 675 (urweb-forward-sym) (urweb-backward-sexp nil)
adamc@350 676 (unless (second data) (urweb-backward-spaces) (urweb-backward-sym))
adamc@350 677 (+ (or (cdr (assoc sym urweb-symbol-indent)) 0)
adamc@350 678 (urweb-delegated-indent))))
adamc@350 679
adamc@350 680 (defun urweb-indent-pipe ()
adamc@350 681 (let ((sym (urweb-find-matching-starter urweb-pipeheads
adamc@350 682 (urweb-op-prec "|" 'back))))
adamc@350 683 (when sym
adamc@350 684 (if (string= sym "|")
adamc@350 685 (if (urweb-bolp) (current-column) (urweb-indent-pipe))
adamc@350 686 (let ((pipe-indent (or (cdr (assoc "|" urweb-symbol-indent)) -2)))
adamc@350 687 (when (or (member sym '("datatype"))
adamc@350 688 (and (equal sym "and")
adamc@350 689 (save-excursion
adamc@350 690 (forward-word 1)
adamc@350 691 (not (urweb-funname-of-and)))))
adamc@350 692 (re-search-forward "="))
adamc@350 693 (urweb-forward-sym)
adamc@350 694 (urweb-forward-spaces)
adamc@350 695 (+ pipe-indent (current-column)))))))
adamc@350 696
adamc@350 697 (defun urweb-find-forward (re)
adamc@350 698 (urweb-forward-spaces)
adamc@350 699 (while (and (not (looking-at re))
adamc@350 700 (progn
adamc@350 701 (or (ignore-errors (forward-sexp 1) t) (forward-char 1))
adamc@350 702 (urweb-forward-spaces)
adamc@350 703 (not (looking-at re))))))
adamc@350 704
adamc@350 705 (defun urweb-indent-arg ()
adamc@350 706 (and (save-excursion (ignore-errors (urweb-forward-arg)))
adamc@350 707 ;;(not (looking-at urweb-not-arg-re))
adamc@350 708 ;; looks like a function or an argument
adamc@350 709 (urweb-move-if (urweb-backward-arg))
adamc@350 710 ;; an argument
adamc@350 711 (if (save-excursion (not (urweb-backward-arg)))
adamc@350 712 ;; a first argument
adamc@350 713 (+ (current-column) urweb-indent-args)
adamc@350 714 ;; not a first arg
adamc@350 715 (while (and (/= (current-column) (current-indentation))
adamc@350 716 (urweb-move-if (urweb-backward-arg))))
adamc@350 717 (unless (save-excursion (urweb-backward-arg))
adamc@350 718 ;; all earlier args are on the same line
adamc@350 719 (urweb-forward-arg) (urweb-forward-spaces))
adamc@350 720 (current-column))))
adamc@350 721
adamc@350 722 (defun urweb-get-indent (data sym)
adamc@350 723 (let (d)
adamc@350 724 (cond
adamc@350 725 ((not (listp data)) data)
adamc@350 726 ((setq d (member sym data)) (cadr d))
adamc@350 727 ((and (consp data) (not (stringp (car data)))) (car data))
adamc@350 728 (t urweb-indent-level))))
adamc@350 729
adamc@350 730 (defun urweb-dangling-sym ()
adamc@350 731 "Non-nil if the symbol after point is dangling.
adamc@350 732 The symbol can be an Ur/Web symbol or an open-paren. \"Dangling\" means that
adamc@350 733 it is not on its own line but is the last element on that line."
adamc@350 734 (save-excursion
adamc@350 735 (and (not (urweb-bolp))
adamc@350 736 (< (urweb-point-after (end-of-line))
adamc@350 737 (urweb-point-after (or (urweb-forward-sym) (skip-syntax-forward "("))
adamc@350 738 (urweb-forward-spaces))))))
adamc@350 739
adamc@350 740 (defun urweb-delegated-indent ()
adamc@350 741 (if (urweb-dangling-sym)
adamc@350 742 (urweb-indent-default 'noindent)
adamc@350 743 (urweb-move-if (backward-word 1)
adamc@350 744 (looking-at urweb-agglomerate-re))
adamc@350 745 (current-column)))
adamc@350 746
adamc@350 747 (defun urweb-get-sym-indent (sym &optional style)
adamc@350 748 "Find the indentation for the SYM we're `looking-at'.
adamc@350 749 If indentation is delegated, point will move to the start of the parent.
adamc@350 750 Optional argument STYLE is currently ignored."
adamc@371 751 ;;(assert (equal sym (save-excursion (urweb-forward-sym))))
adamc@350 752 (save-excursion
adamc@350 753 (let ((delegate (and (not (equal sym "end")) (assoc sym urweb-close-paren)))
adamc@350 754 (head-sym sym))
adamc@350 755 (when (and delegate (not (eval (third delegate))))
adamc@350 756 ;;(urweb-find-match-backward sym delegate)
adamc@350 757 (urweb-forward-sym) (urweb-backward-sexp nil)
adamc@350 758 (setq head-sym
adamc@350 759 (if (second delegate)
adamc@350 760 (save-excursion (urweb-forward-sym))
adamc@350 761 (urweb-backward-spaces) (urweb-backward-sym))))
adamc@350 762 (let ((idata (assoc head-sym urweb-indent-rule)))
adamc@350 763 (when idata
adamc@350 764 ;;(if (or style (not delegate))
adamc@350 765 ;; normal indentation
adamc@350 766 (let ((indent (urweb-get-indent (cdr idata) sym)))
adamc@350 767 (when indent (+ (urweb-delegated-indent) indent)))
adamc@350 768 ;; delgate indentation to the parent
adamc@350 769 ;;(urweb-forward-sym) (urweb-backward-sexp nil)
adamc@350 770 ;;(let* ((parent-sym (save-excursion (urweb-forward-sym)))
adamc@350 771 ;; (parent-indent (cdr (assoc parent-sym urweb-indent-starters))))
adamc@350 772 ;; check the special rules
adamc@350 773 ;;(+ (urweb-delegated-indent)
adamc@350 774 ;; (or (urweb-get-indent (cdr indent-data) 1 'strict)
adamc@350 775 ;; (urweb-get-indent (cdr parent-indent) 1 'strict)
adamc@350 776 ;; (urweb-get-indent (cdr indent-data) 0)
adamc@350 777 ;; (urweb-get-indent (cdr parent-indent) 0))))))))
adamc@350 778 )))))
adamc@350 779
adamc@350 780 (defun urweb-indent-default (&optional noindent)
adamc@386 781 (condition-case nil
adamc@386 782 (progn
adamc@386 783 (let* ((sym-after (save-excursion (urweb-forward-sym)))
adamc@386 784 (_ (urweb-backward-spaces))
adamc@386 785 (sym-before (urweb-backward-sym))
adamc@386 786 (sym-indent (and sym-before (urweb-get-sym-indent sym-before)))
adamc@386 787 (indent-after (or (cdr (assoc sym-after urweb-symbol-indent)) 0)))
adamc@386 788 (when (equal sym-before "end")
adamc@386 789 ;; I don't understand what's really happening here, but when
adamc@386 790 ;; it's `end' clearly, we need to do something special.
adamc@386 791 (forward-word 1)
adamc@386 792 (setq sym-before nil sym-indent nil))
adamc@386 793 (cond
adamc@386 794 (sym-indent
adamc@386 795 ;; the previous sym is an indentation introducer: follow the rule
adamc@386 796 (if noindent
adamc@386 797 ;;(current-column)
adamc@386 798 sym-indent
adamc@386 799 (+ sym-indent indent-after)))
adamc@386 800 ;; If we're just after a hanging open paren.
adamc@386 801 ((and (eq (char-syntax (preceding-char)) ?\()
adamc@386 802 (save-excursion (backward-char) (urweb-dangling-sym)))
adamc@386 803 (backward-char)
adamc@386 804 (urweb-indent-default))
adamc@386 805 (t
adamc@386 806 ;; default-default
adamc@386 807 (let* ((prec-after (urweb-op-prec sym-after 'back))
adamc@386 808 (prec (or (urweb-op-prec sym-before 'back) prec-after 100)))
adamc@386 809 ;; go back until you hit a symbol that has a lower prec than the
adamc@386 810 ;; "current one", or until you backed over a sym that has the same prec
adamc@386 811 ;; but is at the beginning of a line.
adamc@386 812 (while (and (not (urweb-bolp))
adamc@386 813 (while (urweb-move-if (urweb-backward-sexp (1- prec))))
adamc@386 814 (not (urweb-bolp)))
adamc@386 815 (while (urweb-move-if (urweb-backward-sexp prec))))
adamc@386 816 (if noindent
adamc@386 817 ;; the `noindent' case does back over an introductory symbol
adamc@386 818 ;; such as `fun', ...
adamc@386 819 (progn
adamc@386 820 (urweb-move-if
adamc@386 821 (urweb-backward-spaces)
adamc@386 822 (member (urweb-backward-sym) urweb-starters-syms))
adamc@386 823 (current-column))
adamc@386 824 ;; Use `indent-after' for cases such as when , or ; should be
adamc@386 825 ;; outdented so that their following terms are aligned.
adamc@386 826 (+ (if (progn
adamc@386 827 (if (equal sym-after ";")
adamc@386 828 (urweb-move-if
adamc@386 829 (urweb-backward-spaces)
adamc@386 830 (member (urweb-backward-sym) urweb-starters-syms)))
adamc@386 831 (and sym-after (not (looking-at sym-after))))
adamc@386 832 indent-after 0)
adamc@386 833 (current-column))))))))
adamc@386 834 (error 0)))
adamc@350 835
adamc@350 836
adamc@350 837 ;; maybe `|' should be set to word-syntax in our temp syntax table ?
adamc@350 838 (defun urweb-current-indentation ()
adamc@350 839 (save-excursion
adamc@350 840 (beginning-of-line)
adamc@350 841 (skip-chars-forward " \t|")
adamc@350 842 (current-column)))
adamc@350 843
adamc@350 844
adamc@350 845 (defun urweb-find-matching-starter (syms &optional prec)
adamc@350 846 (let (sym)
adamc@350 847 (ignore-errors
adamc@350 848 (while
adamc@350 849 (progn (urweb-backward-sexp prec)
adamc@350 850 (setq sym (save-excursion (urweb-forward-sym)))
adamc@350 851 (not (or (member sym syms) (bobp)))))
adamc@350 852 (if (member sym syms) sym))))
adamc@350 853
adamc@350 854 (defun urweb-skip-siblings ()
adamc@350 855 (while (and (not (bobp)) (urweb-backward-arg))
adamc@350 856 (urweb-find-matching-starter urweb-starters-syms)))
adamc@350 857
adamc@350 858 (defun urweb-beginning-of-defun ()
adamc@350 859 (let ((sym (urweb-find-matching-starter urweb-starters-syms)))
adamc@350 860 (if (member sym '("fun" "and" "functor" "signature" "structure"
adamc@350 861 "datatype"))
adamc@350 862 (save-excursion (urweb-forward-sym) (urweb-forward-spaces)
adamc@350 863 (urweb-forward-sym))
adamc@350 864 ;; We're inside a "non function declaration": let's skip all other
adamc@350 865 ;; declarations that we find at the same level and try again.
adamc@350 866 (urweb-skip-siblings)
adamc@350 867 ;; Obviously, let's not try again if we're at bobp.
adamc@350 868 (unless (bobp) (urweb-beginning-of-defun)))))
adamc@350 869
adamc@350 870 (defcustom urweb-max-name-components 3
adamc@350 871 "Maximum number of components to use for the current function name."
adamc@350 872 :group 'urweb
adamc@350 873 :type 'integer)
adamc@350 874
adamc@350 875 (defun urweb-current-fun-name ()
adamc@350 876 (save-excursion
adamc@350 877 (let ((count urweb-max-name-components)
adamc@350 878 fullname name)
adamc@350 879 (end-of-line)
adamc@350 880 (while (and (> count 0)
adamc@350 881 (setq name (urweb-beginning-of-defun)))
adamc@350 882 (decf count)
adamc@350 883 (setq fullname (if fullname (concat name "." fullname) name))
adamc@350 884 ;; Skip all other declarations that we find at the same level.
adamc@350 885 (urweb-skip-siblings))
adamc@350 886 fullname)))
adamc@350 887
adamc@358 888
adamc@358 889
adamc@350 890 (provide 'urweb-mode)
adamc@350 891
adamc@350 892 ;;; urweb-mode.el ends here