sgml-mode.el 69.4 KB
Newer Older
1
;;; sgml-mode.el --- SGML- and HTML-editing modes
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Stefan Monnier's avatar
Stefan Monnier committed
3
;; Copyright (C) 1992, 1995, 1996, 1998, 2001, 2002, 2003, 2004, 2005
Stefan Monnier's avatar
Stefan Monnier committed
4
;;           Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6
;; Author: James Clark <jjc@jclark.com>
Stefan Monnier's avatar
Stefan Monnier committed
7
;; Maintainer: FSF
Karl Heuer's avatar
Karl Heuer committed
8
;; Adapted-By: ESR, Daniel Pfeiffer <occitan@esperanto.org>,
9
;;             F.Potorti@cnuce.cnr.it
10
;; Keywords: wp, hypermedia, comm, languages
Eric S. Raymond's avatar
Eric S. Raymond committed
11 12 13 14 15

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Karl Heuer's avatar
Karl Heuer committed
16
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
17 18 19 20 21 22 23 24
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
25 26 27
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
28 29 30

;;; Commentary:

31 32 33
;; Configurable major mode for editing document in the SGML standard general
;; markup language.  As an example contains a mode for editing the derived
;; HTML hypertext markup language.
Eric S. Raymond's avatar
Eric S. Raymond committed
34 35 36

;;; Code:

Dave Love's avatar
Dave Love committed
37 38
(eval-when-compile
  (require 'skeleton)
Mike Williams's avatar
Mike Williams committed
39 40
  (require 'outline)
  (require 'cl))
Dave Love's avatar
Dave Love committed
41

42
(defgroup sgml nil
43
  "SGML editing mode."
44 45
  :group 'languages)

Stefan Monnier's avatar
Stefan Monnier committed
46 47 48 49 50
(defcustom sgml-basic-offset 2
  "*Specifies the basic indentation level for `sgml-indent-line'."
  :type 'integer
  :group 'sgml)

51
(defcustom sgml-transformation 'identity
52 53
  "*Default value for `skeleton-transformation' (which see) in SGML mode."
  :type 'function
54
  :group 'sgml)
55 56 57 58

(put 'sgml-transformation 'variable-interactive
     "aTransformation function: ")

Dave Love's avatar
Dave Love committed
59 60 61 62 63 64
(defcustom sgml-mode-hook nil
  "Hook run by command `sgml-mode'.
`text-mode-hook' is run first."
  :group 'sgml
  :type 'hook)

65 66 67
;; As long as Emacs' syntax can't be complemented with predicates to context
;; sensitively confirm the syntax of characters, we have to live with this
;; kludgy kind of tradeoff.
68
(defvar sgml-specials '(?\")
Richard M. Stallman's avatar
Richard M. Stallman committed
69
  "List of characters that have a special meaning for SGML mode.
70
This list is used when first loading the `sgml-mode' library.
71 72 73 74 75 76
The supported characters and potential disadvantages are:

  ?\\\"	Makes \" in text start a string.
  ?'	Makes ' in text start a string.
  ?-	Makes -- in text start a comment.

77
When only one of ?\\\" or ?' are included, \"'\" or '\"', as can be found in
78
DTDs, start a string.  To partially avoid this problem this also makes these
79 80 81 82
self insert as named entities depending on `sgml-quick-keys'.

Including ?- has the problem of affecting dashes that have nothing to do
with comments, so we normally turn it off.")
83 84

(defvar sgml-quick-keys nil
85
  "Use <, >, &, /, SPC and `sgml-specials' keys \"electrically\" when non-nil.
86
This takes effect when first loading the `sgml-mode' library.")
87 88

(defvar sgml-mode-map
89
  (let ((map (make-keymap))	;`sparse' doesn't allow binding to charsets.
90 91 92
	(menu-map (make-sparse-keymap "SGML")))
    (define-key map "\C-c\C-i" 'sgml-tags-invisible)
    (define-key map "/" 'sgml-slash)
93 94
    (define-key map "\C-c\C-n" 'sgml-name-char)
    (define-key map "\C-c\C-t" 'sgml-tag)
95 96 97 98 99 100 101 102
    (define-key map "\C-c\C-a" 'sgml-attributes)
    (define-key map "\C-c\C-b" 'sgml-skip-tag-backward)
    (define-key map [?\C-c left] 'sgml-skip-tag-backward)
    (define-key map "\C-c\C-f" 'sgml-skip-tag-forward)
    (define-key map [?\C-c right] 'sgml-skip-tag-forward)
    (define-key map "\C-c\C-d" 'sgml-delete-tag)
    (define-key map "\C-c\^?" 'sgml-delete-tag)
    (define-key map "\C-c?" 'sgml-tag-help)
Mike Williams's avatar
Mike Williams committed
103
    (define-key map "\C-c/" 'sgml-close-tag)
104 105
    (define-key map "\C-c8" 'sgml-name-8bit-mode)
    (define-key map "\C-c\C-v" 'sgml-validate)
106 107 108 109 110 111 112 113 114
    (when sgml-quick-keys
      (define-key map "&" 'sgml-name-char)
      (define-key map "<" 'sgml-tag)
      (define-key map " " 'sgml-auto-attributes)
      (define-key map ">" 'sgml-maybe-end-tag)
      (when (memq ?\" sgml-specials)
        (define-key map "\"" 'sgml-name-self))
      (when (memq ?' sgml-specials)
        (define-key map "'" 'sgml-name-self)))
Stefan Monnier's avatar
Stefan Monnier committed
115 116
    (define-key map (vector (make-char 'latin-iso8859-1))
      'sgml-maybe-name-self)
117 118 119 120
    (let ((c 127)
	  (map (nth 1 map)))
      (while (< (setq c (1+ c)) 256)
	(aset map c 'sgml-maybe-name-self)))
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
    (define-key map [menu-bar sgml] (cons "SGML" menu-map))
    (define-key menu-map [sgml-validate] '("Validate" . sgml-validate))
    (define-key menu-map [sgml-name-8bit-mode]
      '("Toggle 8 Bit Insertion" . sgml-name-8bit-mode))
    (define-key menu-map [sgml-tags-invisible]
      '("Toggle Tag Visibility" . sgml-tags-invisible))
    (define-key menu-map [sgml-tag-help]
      '("Describe Tag" . sgml-tag-help))
    (define-key menu-map [sgml-delete-tag]
      '("Delete Tag" . sgml-delete-tag))
    (define-key menu-map [sgml-skip-tag-forward]
      '("Forward Tag" . sgml-skip-tag-forward))
    (define-key menu-map [sgml-skip-tag-backward]
      '("Backward Tag" . sgml-skip-tag-backward))
    (define-key menu-map [sgml-attributes]
      '("Insert Attributes" . sgml-attributes))
    (define-key menu-map [sgml-tag] '("Insert Tag" . sgml-tag))
    map)
  "Keymap for SGML mode.  See also `sgml-specials'.")

141 142
(defun sgml-make-syntax-table (specials)
  (let ((table (make-syntax-table text-mode-syntax-table)))
143 144
    (modify-syntax-entry ?< "(>" table)
    (modify-syntax-entry ?> ")<" table)
145 146 147 148
    (modify-syntax-entry ?: "_" table)
    (modify-syntax-entry ?_ "_" table)
    (modify-syntax-entry ?. "_" table)
    (if (memq ?- specials)
149
	(modify-syntax-entry ?- "_ 1234" table))
150
    (if (memq ?\" specials)
151
	(modify-syntax-entry ?\" "\"\"" table))
152
    (if (memq ?' specials)
153
	(modify-syntax-entry ?\' "\"'" table))
154 155 156
    table))

(defvar sgml-mode-syntax-table (sgml-make-syntax-table sgml-specials)
157 158
  "Syntax table used in SGML mode.  See also `sgml-specials'.")

159 160 161 162 163 164 165
(defconst sgml-tag-syntax-table
  (let ((table (sgml-make-syntax-table '(?- ?\" ?\'))))
    (dolist (char '(?\( ?\) ?\{ ?\} ?\[ ?\] ?$ ?% ?& ?* ?+ ?/))
      (modify-syntax-entry char "." table))
    table)
  "Syntax table used to parse SGML tags.")

166
(defcustom sgml-name-8bit-mode nil
167
  "*When non-nil, insert non-ASCII characters as named entities."
168 169
  :type 'boolean
  :group 'sgml)
Eric S. Raymond's avatar
Eric S. Raymond committed
170

171 172 173 174 175
(defvar sgml-char-names
  [nil nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
176
   "nbsp" "excl" "quot" "num" "dollar" "percnt" "amp" "apos"
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
   "lpar" "rpar" "ast" "plus" "comma" "hyphen" "period" "sol"
   nil nil nil nil nil nil nil nil
   nil nil "colon" "semi" "lt" "eq" "gt" "quest"
   "commat" nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
   nil nil nil "lsqb" nil "rsqb" "uarr" "lowbar"
   "lsquo" nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
   nil nil nil "lcub" "verbar" "rcub" "tilde" nil
   nil nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
   nil nil nil nil nil nil nil nil
   "nbsp" "iexcl" "cent" "pound" "curren" "yen" "brvbar" "sect"
   "uml" "copy" "ordf" "laquo" "not" "shy" "reg" "macr"
   "ring" "plusmn" "sup2" "sup3" "acute" "micro" "para" "middot"
195
   "cedil" "sup1" "ordm" "raquo" "frac14" "frac12" "frac34" "iquest"
196 197 198 199 200 201 202 203 204 205
   "Agrave" "Aacute" "Acirc" "Atilde" "Auml" "Aring" "AElig" "Ccedil"
   "Egrave" "Eacute" "Ecirc" "Euml" "Igrave" "Iacute" "Icirc" "Iuml"
   "ETH" "Ntilde" "Ograve" "Oacute" "Ocirc" "Otilde" "Ouml" nil
   "Oslash" "Ugrave" "Uacute" "Ucirc" "Uuml" "Yacute" "THORN" "szlig"
   "agrave" "aacute" "acirc" "atilde" "auml" "aring" "aelig" "ccedil"
   "egrave" "eacute" "ecirc" "euml" "igrave" "iacute" "icirc" "iuml"
   "eth" "ntilde" "ograve" "oacute" "ocirc" "otilde" "ouml" "divide"
   "oslash" "ugrave" "uacute" "ucirc" "uuml" "yacute" "thorn" "yuml"]
  "Vector of symbolic character names without `&' and `;'.")

206 207 208 209 210 211 212 213 214 215 216 217 218 219
(put 'sgml-table 'char-table-extra-slots 0)

(defvar sgml-char-names-table
  (let ((table (make-char-table 'sgml-table))
	(i 32)
	elt)
    (while (< i 256)
      (setq elt (aref sgml-char-names i))
      (if elt (aset table (make-char 'latin-iso8859-1 i) elt))
      (setq i (1+ i)))
    table)
  "A table for mapping non-ASCII characters into SGML entity names.
Currently, only Latin-1 characters are supported.")

220 221
;; nsgmls is a free SGML parser in the SP suite available from
;; ftp.jclark.com and otherwise packaged for GNU systems.
222 223 224
;; Its error messages can be parsed by next-error.
;; The -s option suppresses output.

225
(defcustom sgml-validate-command "nsgmls -s" ; replaced old `sgmls'
Eric S. Raymond's avatar
Eric S. Raymond committed
226 227
  "*The command to validate an SGML document.
The file name of current buffer file name will be appended to this,
228 229
separated by a space."
  :type 'string
Dave Love's avatar
Dave Love committed
230
  :version "21.1"
231
  :group 'sgml)
Eric S. Raymond's avatar
Eric S. Raymond committed
232 233 234 235

(defvar sgml-saved-validate-command nil
  "The command last used to validate in this buffer.")

236 237
;; I doubt that null end tags are used much for large elements,
;; so use a small distance here.
238
(defcustom sgml-slash-distance 1000
Richard M. Stallman's avatar
Richard M. Stallman committed
239
  "*If non-nil, is the maximum distance to search for matching `/'."
240 241
  :type '(choice (const nil) integer)
  :group 'sgml)
Eric S. Raymond's avatar
Eric S. Raymond committed
242

243
(defconst sgml-namespace-re "[_[:alpha:]][-_.[:alnum:]]*")
Stefan Monnier's avatar
Stefan Monnier committed
244 245 246 247
(defconst sgml-name-re "[_:[:alpha:]][-_.:[:alnum:]]*")
(defconst sgml-tag-name-re (concat "<\\([!/?]?" sgml-name-re "\\)"))
(defconst sgml-attrs-re "\\(?:[^\"'/><]\\|\"[^\"]*\"\\|'[^']*'\\)*")
(defconst sgml-start-tag-regex (concat "<" sgml-name-re sgml-attrs-re)
248
  "Regular expression that matches a non-empty start tag.
Richard M. Stallman's avatar
Richard M. Stallman committed
249
Any terminating `>' or `/' is not matched.")
250

251
(defface sgml-namespace
252
  '((t (:inherit font-lock-builtin-face)))
253 254
  "`sgml-mode' face used to highlight the namespace part of identifiers."
  :group 'sgml)
255 256 257
;; backward-compatibility alias
(put 'sgml-namespace-face 'face-alias 'sgml-namespace)
(defvar sgml-namespace-face 'sgml-namespace)
258

259 260
;; internal
(defconst sgml-font-lock-keywords-1
Stefan Monnier's avatar
Stefan Monnier committed
261
  `((,(concat "<\\([!?]" sgml-name-re "\\)") 1 font-lock-keyword-face)
262 263 264 265 266
    ;; We could use the simpler "\\(" sgml-namespace-re ":\\)?" instead,
    ;; but it would cause a bit more backtracking in the re-matcher.
    (,(concat "</?\\(" sgml-namespace-re "\\)\\(?::\\(" sgml-name-re "\\)\\)?")
     (1 (if (match-end 2) sgml-namespace-face font-lock-function-name-face))
     (2 font-lock-function-name-face nil t))
267
    ;; FIXME: this doesn't cover the variables using a default value.
268 269 270 271
    (,(concat "\\(" sgml-namespace-re "\\)\\(?::\\("
	      sgml-name-re "\\)\\)?=[\"']")
     (1 (if (match-end 2) sgml-namespace-face font-lock-variable-name-face))
     (2 font-lock-variable-name-face nil t))
Stefan Monnier's avatar
Stefan Monnier committed
272
    (,(concat "[&%]" sgml-name-re ";?") . font-lock-variable-name-face)))
273 274 275 276 277 278 279 280 281

(defconst sgml-font-lock-keywords-2
  (append
   sgml-font-lock-keywords-1
   '((eval
      . (cons (concat "<"
		      (regexp-opt (mapcar 'car sgml-tag-face-alist) t)
		      "\\([ \t][^>]*\\)?>\\([^<]+\\)</\\1>")
	      '(3 (cdr (assoc (downcase (match-string 1))
282
			      sgml-tag-face-alist)) prepend))))))
283 284 285 286

;; for font-lock, but must be defvar'ed after
;; sgml-font-lock-keywords-1 and sgml-font-lock-keywords-2 above
(defvar sgml-font-lock-keywords sgml-font-lock-keywords-1
287 288
  "*Rules for highlighting SGML code.  See also `sgml-tag-face-alist'.")

289 290 291 292 293 294 295 296
(defvar sgml-font-lock-syntactic-keywords
  ;; Use the `b' style of comments to avoid interference with the -- ... --
  ;; comments recognized when `sgml-specials' includes ?-.
  ;; FIXME: beware of <!--> blabla <!--> !!
  '(("\\(<\\)!--" (1 "< b"))
    ("--[ \t\n]*\\(>\\)" (1 "> b")))
  "Syntactic keywords for `sgml-mode'.")

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
;; internal
(defvar sgml-face-tag-alist ()
  "Alist of face and tag name for facemenu.")

(defvar sgml-tag-face-alist ()
  "Tag names and face or list of faces to fontify with when invisible.
When `font-lock-maximum-decoration' is 1 this is always used for fontifying.
When more these are fontified together with `sgml-font-lock-keywords'.")

(defvar sgml-display-text ()
  "Tag names as lowercase symbols, and display string when invisible.")

;; internal
(defvar sgml-tags-invisible nil)

312
(defcustom sgml-tag-alist
313 314
  '(("![" ("ignore" t) ("include" t))
    ("!attlist")
315 316 317 318 319 320 321 322 323
    ("!doctype")
    ("!element")
    ("!entity"))
  "*Alist of tag names for completing read and insertion rules.
This alist is made up as

  ((\"tag\" . TAGRULE)
   ...)

Mike Williams's avatar
Mike Williams committed
324 325
TAGRULE is a list of optionally t (no endtag) or `\\n' (separate endtag by
newlines) or a skeleton with nil, t or `\\n' in place of the interactor
326 327 328 329 330 331 332 333
followed by an ATTRIBUTERULE (for an always present attribute) or an
attribute alist.

The attribute alist is made up as

  ((\"attribute\" . ATTRIBUTERULE)
   ...)

Mike Williams's avatar
Mike Williams committed
334
ATTRIBUTERULE is a list of optionally t (no value when no input) followed by
335 336 337 338
an optional alist of possible values."
  :type '(repeat (cons (string :tag "Tag Name")
		       (repeat :tag "Tag Rule" sexp)))
  :group 'sgml)
339

340
(defcustom sgml-tag-help
341 342 343 344 345 346
  '(("!" . "Empty declaration for comment")
    ("![" . "Embed declarations with parser directive")
    ("!attlist" . "Tag attributes declaration")
    ("!doctype" . "Document type (DTD) declaration")
    ("!element" . "Tag declaration")
    ("!entity" . "Entity (macro) declaration"))
347 348 349 350
  "*Alist of tag name and short description."
  :type '(repeat (cons (string :tag "Tag Name")
		       (string :tag "Description")))
  :group 'sgml)
351

352
(defcustom sgml-xml-mode nil
353 354 355
  "*When non-nil, tag insertion functions will be XML-compliant.
If this variable is customized, the custom value is used always.
Otherwise, it is set to be buffer-local when the file has
Juri Linkov's avatar
Juri Linkov committed
356
a DOCTYPE or an XML declaration."
357
  :type 'boolean
358
  :version "22.1"
359 360
  :group 'sgml)

Stefan Monnier's avatar
Stefan Monnier committed
361 362 363
(defvar sgml-empty-tags nil
  "List of tags whose !ELEMENT definition says EMPTY.")

Stefan Monnier's avatar
Stefan Monnier committed
364 365 366
(defvar sgml-unclosed-tags nil
  "List of tags whose !ELEMENT definition says the end-tag is optional.")

367 368 369 370
(defun sgml-xml-guess ()
  "Guess whether the current buffer is XML."
  (save-excursion
    (goto-char (point-min))
371 372 373 374
    (when (or (string= "xml" (file-name-extension (or buffer-file-name "")))
	      (looking-at "\\s-*<\\?xml")
	      (when (re-search-forward
		     (eval-when-compile
375 376
		 (mapconcat 'identity
			    '("<!DOCTYPE" "\\(\\w+\\)" "\\(\\w+\\)"
377 378 379 380 381
				    "\"\\([^\"]+\\)\"" "\"\\([^\"]+\\)\"")
				  "\\s-+"))
		     nil t)
		(string-match "X\\(HT\\)?ML" (match-string 3))))
      (set (make-local-variable 'sgml-xml-mode) t))))
382

Dave Love's avatar
Dave Love committed
383 384
(defvar v2)				; free for skeleton

385 386 387 388 389 390 391
(defun sgml-comment-indent-new-line (&optional soft)
  (let ((comment-start "-- ")
	(comment-start-skip "\\(<!\\)?--[ \t]*")
	(comment-end " --")
	(comment-style 'plain))
    (comment-indent-new-line soft)))

392 393 394 395 396 397 398 399
(defun sgml-mode-facemenu-add-face-function (face end)
  (if (setq face (cdr (assq face sgml-face-tag-alist)))
      (progn
	(setq face (funcall skeleton-transformation face))
	(setq facemenu-end-add-face (concat "</" face ">"))
	(concat "<" face ">"))
    (error "Face not configured for %s mode" mode-name)))

Stefan Monnier's avatar
Stefan Monnier committed
400 401 402 403 404 405 406 407
(defun sgml-fill-nobreak ()
  ;; Don't break between a tag name and its first argument.
  (save-excursion
    (skip-chars-backward " \t")
    (and (not (zerop (skip-syntax-backward "w_")))
	 (skip-chars-backward "/?!")
	 (eq (char-before) ?<))))

408 409 410 411
;;;###autoload
(define-derived-mode sgml-mode text-mode "SGML"
  "Major mode for editing SGML documents.
Makes > match <.
412
Keys <, &, SPC within <>, \", / and ' can be electric depending on
413 414 415 416 417 418 419 420 421 422 423 424 425 426
`sgml-quick-keys'.

An argument of N to a tag-inserting command means to wrap it around
the next N words.  In Transient Mark mode, when the mark is active,
N defaults to -1, which means to wrap it around the current region.

If you like upcased tags, put (setq sgml-transformation 'upcase) in
your `.emacs' file.

Use \\[sgml-validate] to validate your document with an SGML parser.

Do \\[describe-variable] sgml- SPC to see available variables.
Do \\[describe-key] on the following bindings to discover what they do.
\\{sgml-mode-map}"
Eric S. Raymond's avatar
Eric S. Raymond committed
427
  (make-local-variable 'sgml-saved-validate-command)
428 429
  (make-local-variable 'facemenu-end-add-face)
  ;;(make-local-variable 'facemenu-remove-face-function)
430 431 432
  ;; A start or end tag by itself on a line separates a paragraph.
  ;; This is desirable because SGML discards a newline that appears
  ;; immediately after a start tag or immediately before an end tag.
Stefan Monnier's avatar
Stefan Monnier committed
433 434 435 436
  (set (make-local-variable 'paragraph-start) (concat "[ \t]*$\\|\
\[ \t]*</?\\(" sgml-name-re sgml-attrs-re "\\)?>"))
  (set (make-local-variable 'paragraph-separate)
       (concat paragraph-start "$"))
437
  (set (make-local-variable 'adaptive-fill-regexp) "[ \t]*")
Stefan Monnier's avatar
Stefan Monnier committed
438
  (add-hook 'fill-nobreak-predicate 'sgml-fill-nobreak nil t)
439
  (set (make-local-variable 'indent-line-function) 'sgml-indent-line)
440 441 442
  (set (make-local-variable 'comment-start) "<!-- ")
  (set (make-local-variable 'comment-end) " -->")
  (set (make-local-variable 'comment-indent-function) 'sgml-comment-indent)
443 444
  (set (make-local-variable 'comment-line-break-function)
       'sgml-comment-indent-new-line)
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
  (set (make-local-variable 'skeleton-further-elements)
       '((completion-ignore-case t)))
  (set (make-local-variable 'skeleton-end-hook)
       (lambda ()
         (or (eolp)
             (not (or (eq v2 '\n) (eq (car-safe v2) '\n)))
             (newline-and-indent))))
  (set (make-local-variable 'font-lock-defaults)
       '((sgml-font-lock-keywords
          sgml-font-lock-keywords-1
          sgml-font-lock-keywords-2)
         nil t nil nil
         (font-lock-syntactic-keywords
          . sgml-font-lock-syntactic-keywords)))
  (set (make-local-variable 'facemenu-add-face-function)
       'sgml-mode-facemenu-add-face-function)
461 462 463 464
  (sgml-xml-guess)
  (if sgml-xml-mode
      (setq mode-name "XML")
    (set (make-local-variable 'skeleton-transformation) sgml-transformation))
465 466 467
  ;; This will allow existing comments within declarations to be
  ;; recognized.
  (set (make-local-variable 'comment-start-skip) "\\(?:<!\\)?--[ \t]*")
468
  (set (make-local-variable 'comment-end-skip) "[ \t]*--\\([ \t\n]*>\\)?")
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
  ;; This definition has an HTML leaning but probably fits well for other modes.
  (setq imenu-generic-expression
	`((nil
	   ,(concat "<!\\(element\\|entity\\)[ \t\n]+%?[ \t\n]*\\("
		    sgml-name-re "\\)")
	   2)
	  ("Id"
	   ,(concat "<[^>]+[ \t\n]+[Ii][Dd]=\\(['\"]"
		    (if sgml-xml-mode "" "?")
		    "\\)\\(" sgml-name-re "\\)\\1")
	   2)
	  ("Name"
	   ,(concat "<[^>]+[ \t\n]+[Nn][Aa][Mm][Ee]=\\(['\"]"
		    (if sgml-xml-mode "" "?")
		    "\\)\\(" sgml-name-re "\\)\\1")
	   2))))
485

486 487
;; Some programs (such as Glade 2) generate XML which has
;; -*- mode: xml -*-.
488
;;;###autoload
489 490
(defalias 'xml-mode 'sgml-mode)

Eric S. Raymond's avatar
Eric S. Raymond committed
491
(defun sgml-comment-indent ()
492
  (if (looking-at "--") comment-column 0))
Eric S. Raymond's avatar
Eric S. Raymond committed
493 494

(defun sgml-slash (arg)
495 496 497 498 499 500 501 502 503 504 505
  "Insert ARG slash characters.
Behaves electrically if `sgml-quick-keys' is non-nil."
  (interactive "p")
  (cond
   ((not (and (eq (char-before) ?<) (= arg 1)))
    (sgml-slash-matching arg))
   ((eq sgml-quick-keys 'indent)
    (insert-char ?/ 1)
    (indent-according-to-mode))
   ((eq sgml-quick-keys 'close)
    (delete-backward-char 1)
Mike Williams's avatar
Mike Williams committed
506
    (sgml-close-tag))
507 508 509 510
   (t
    (sgml-slash-matching arg))))

(defun sgml-slash-matching (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
511 512 513
  "Insert `/' and display any previous matching `/'.
Two `/'s are treated as matching if the first `/' ends a net-enabling
start tag, and the second `/' is the corresponding null end tag."
Eric S. Raymond's avatar
Eric S. Raymond committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
  (interactive "p")
  (insert-char ?/ arg)
  (if (> arg 0)
      (let ((oldpos (point))
	    (blinkpos)
	    (level 0))
	(save-excursion
	  (save-restriction
	    (if sgml-slash-distance
		(narrow-to-region (max (point-min)
				       (- (point) sgml-slash-distance))
				  oldpos))
	    (if (and (re-search-backward sgml-start-tag-regex (point-min) t)
		     (eq (match-end 0) (1- oldpos)))
		()
	      (goto-char (1- oldpos))
	      (while (and (not blinkpos)
			  (search-backward "/" (point-min) t))
		(let ((tagend (save-excursion
				(if (re-search-backward sgml-start-tag-regex
							(point-min) t)
				    (match-end 0)
				  nil))))
		  (if (eq tagend (point))
		      (if (eq level 0)
			  (setq blinkpos (point))
			(setq level (1- level)))
		    (setq level (1+ level)))))))
542 543 544 545 546 547 548
	  (when blinkpos
            (goto-char blinkpos)
            (if (pos-visible-in-window-p)
                (sit-for 1)
              (message "Matches %s"
                       (buffer-substring (line-beginning-position)
                                         (1+ blinkpos)))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
549

Stefan Monnier's avatar
Stefan Monnier committed
550 551 552
;; Why doesn't this use the iso-cvt table or, preferably, generate the
;; inverse of the extensive table in the SGML Quail input method?  -- fx
;; I guess that's moot since it only works with Latin-1 anyhow.
553 554
(defun sgml-name-char (&optional char)
  "Insert a symbolic character name according to `sgml-char-names'.
555 556 557
Non-ASCII chars may be inserted either with the meta key, as in M-SPC for
no-break space or M-- for a soft hyphen; or via an input method or
encoded keyboard operation."
558 559 560
  (interactive "*")
  (insert ?&)
  (or char
561
      (setq char (read-quoted-char "Enter char or octal number")))
562 563 564
  (delete-backward-char 1)
  (insert char)
  (undo-boundary)
Stefan Monnier's avatar
Stefan Monnier committed
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
  (sgml-namify-char))

(defun sgml-namify-char ()
  "Change the char before point into its `&name;' equivalent.
Uses `sgml-char-names'."
  (interactive)
  (let* ((char (char-before))
	 (name
	  (cond
	   ((null char) (error "No char before point"))
	   ((< char 256) (or (aref sgml-char-names char) char))
	   ((aref sgml-char-names-table char))
	   ((encode-char char 'ucs)))))
    (if (not name)
	(error "Don't know the name of `%c'" char)
      (delete-backward-char 1)
      (insert (format (if (numberp name) "&#%d;" "&%s;") name)))))
582 583 584 585 586 587 588 589 590 591

(defun sgml-name-self ()
  "Insert a symbolic character name according to `sgml-char-names'."
  (interactive "*")
  (sgml-name-char last-command-char))

(defun sgml-maybe-name-self ()
  "Insert a symbolic character name according to `sgml-char-names'."
  (interactive "*")
  (if sgml-name-8bit-mode
592 593 594 595 596
      (let ((mc last-command-char))
	(if (< mc 256)
	    (setq mc (unibyte-char-to-multibyte mc)))
	(or mc (setq mc last-command-char))
	(sgml-name-char mc))
597 598 599
    (self-insert-command 1)))

(defun sgml-name-8bit-mode ()
Stefan Monnier's avatar
Stefan Monnier committed
600 601
  "Toggle whether to insert named entities instead of non-ASCII characters.
This only works for Latin-1 input."
602
  (interactive)
603
  (setq sgml-name-8bit-mode (not sgml-name-8bit-mode))
604
  (message "sgml name entity mode is now %s"
605
	   (if sgml-name-8bit-mode "ON" "OFF")))
606

Richard M. Stallman's avatar
Richard M. Stallman committed
607 608 609 610
;; When an element of a skeleton is a string "str", it is passed
;; through skeleton-transformation and inserted.  If "str" is to be
;; inserted literally, one should obtain it as the return value of a
;; function, e.g. (identity "str").
611

Stefan Monnier's avatar
Stefan Monnier committed
612 613
(defvar sgml-tag-last nil)
(defvar sgml-tag-history nil)
614
(define-skeleton sgml-tag
Richard M. Stallman's avatar
Richard M. Stallman committed
615 616
  "Prompt for a tag and insert it, optionally with attributes.
Completion and configuration are done according to `sgml-tag-alist'.
617
If you like tags and attributes in uppercase do \\[set-variable]
Richard M. Stallman's avatar
Richard M. Stallman committed
618 619
skeleton-transformation RET upcase RET, or put this in your `.emacs':
  (setq sgml-transformation 'upcase)"
620
  (funcall (or skeleton-transformation 'identity)
Stefan Monnier's avatar
Stefan Monnier committed
621 622 623 624 625 626
           (setq sgml-tag-last
		 (completing-read
		  (if (> (length sgml-tag-last) 0)
		      (format "Tag (default %s): " sgml-tag-last)
		    "Tag: ")
		  sgml-tag-alist nil nil nil 'sgml-tag-history sgml-tag-last)))
627
  ?< str |
628
  (("") -1 '(undo-boundary) (identity "&lt;")) |	; see comment above
Stefan Monnier's avatar
Stefan Monnier committed
629 630 631 632 633
  `(("") '(setq v2 (sgml-attributes ,str t)) ?>
    (cond
     ((string= "![" ,str)
      (backward-char)
      '(("") " [ " _ " ]]"))
634
     ((and (eq v2 t) sgml-xml-mode (member ,str sgml-empty-tags))
Juri Linkov's avatar
Juri Linkov committed
635
      '(("") -1 " />"))
636
     ((or (and (eq v2 t) (not sgml-xml-mode)) (string-match "^[/!?]" ,str))
Stefan Monnier's avatar
Stefan Monnier committed
637 638 639 640 641 642 643 644 645 646 647 648 649 650
      nil)
     ((symbolp v2)
      ;; Make sure we don't fall into an infinite loop.
      ;; For xhtml's `tr' tag, we should maybe use \n instead.
      (if (eq v2 t) (setq v2 nil))
      ;; We use `identity' to prevent skeleton from passing
      ;; `str' through skeleton-transformation a second time.
      '(("") v2 _ v2 "</" (identity ',str) ?>))
     ((eq (car v2) t)
      (cons '("") (cdr v2)))
     (t
      (append '(("") (car v2))
	      (cdr v2)
	      '(resume: (car v2) _ "</" (identity ',str) ?>))))))
651 652 653

(autoload 'skeleton-read "skeleton")

654
(defun sgml-attributes (tag &optional quiet)
Richard M. Stallman's avatar
Richard M. Stallman committed
655
  "When at top level of a tag, interactively insert attributes.
656

Richard M. Stallman's avatar
Richard M. Stallman committed
657 658
Completion and configuration of TAG are done according to `sgml-tag-alist'.
If QUIET, do not print a message when there are no attributes for TAG."
659
  (interactive (list (save-excursion (sgml-beginning-of-tag t))))
660 661
  (or (stringp tag) (error "Wrong context for adding attribute"))
  (if tag
662
      (let ((completion-ignore-case t)
663
	    (alist (cdr (assoc (downcase tag) sgml-tag-alist)))
664 665 666 667 668 669 670 671 672
	    car attribute i)
	(if (or (symbolp (car alist))
		(symbolp (car (car alist))))
	    (setq car (car alist)
		  alist (cdr alist)))
	(or quiet
	    (message "No attributes configured."))
	(if (stringp (car alist))
	    (progn
673
	      (insert (if (eq (preceding-char) ?\s) "" ?\s)
674
		      (funcall skeleton-transformation (car alist)))
675 676 677
	      (sgml-value alist))
	  (setq i (length alist))
	  (while (> i 0)
678
	    (insert ?\s)
679 680 681
	    (insert (funcall skeleton-transformation
			     (setq attribute
				   (skeleton-read '(completing-read
682
						    "Attribute: "
683 684 685
						    alist)))))
	    (if (string= "" attribute)
		(setq i 0)
686
	      (sgml-value (assoc (downcase attribute) alist))
687
	      (setq i (1- i))))
688
	  (if (eq (preceding-char) ?\s)
689 690 691 692
	      (delete-backward-char 1)))
	car)))

(defun sgml-auto-attributes (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
693 694
  "Self insert the character typed; at top level of tag, prompt for attributes.
With prefix argument, only self insert."
695 696 697 698 699 700 701 702 703
  (interactive "*P")
  (let ((point (point))
	tag)
    (if (or arg
	    (not sgml-tag-alist)	; no message when nothing configured
	    (symbolp (setq tag (save-excursion (sgml-beginning-of-tag t))))
	    (eq (aref tag 0) ?/))
	(self-insert-command (prefix-numeric-value arg))
      (sgml-attributes tag)
704
      (setq last-command-char ?\s)
705 706 707 708
      (or (> (point) point)
	  (self-insert-command 1)))))

(defun sgml-tag-help (&optional tag)
Richard M. Stallman's avatar
Richard M. Stallman committed
709
  "Display description of tag TAG.  If TAG is omitted, use the tag at point."
710 711 712 713 714 715 716 717 718
  (interactive)
  (or tag
      (save-excursion
	(if (eq (following-char) ?<)
	    (forward-char))
	(setq tag (sgml-beginning-of-tag))))
  (or (stringp tag)
      (error "No tag selected"))
  (setq tag (downcase tag))
719
  (message "%s"
720
	   (or (cdr (assoc (downcase tag) sgml-tag-help))
721
	       (and (eq (aref tag 0) ?/)
722
		    (cdr (assoc (downcase (substring tag 1)) sgml-tag-help)))
723 724
	       "No description available")))

725 726 727 728 729 730
(defun sgml-maybe-end-tag (&optional arg)
  "Name self unless in position to end a tag or a prefix ARG is given."
  (interactive "P")
  (if (or arg (eq (car (sgml-lexical-context)) 'tag))
      (self-insert-command (prefix-numeric-value arg))
    (sgml-name-self)))
731 732 733

(defun sgml-skip-tag-backward (arg)
  "Skip to beginning of tag or matching opening tag if present.
Richard M. Stallman's avatar
Richard M. Stallman committed
734
With prefix argument ARG, repeat this ARG times."
735
  (interactive "p")
Stefan Monnier's avatar
Stefan Monnier committed
736
  ;; FIXME: use sgml-get-context or something similar.
737 738 739 740 741
  (while (>= arg 1)
    (search-backward "<" nil t)
    (if (looking-at "</\\([^ \n\t>]+\\)")
	;; end tag, skip any nested pairs
	(let ((case-fold-search t)
742 743 744
	      (re (concat "</?" (regexp-quote (match-string 1))
			  ;; Ignore empty tags like <foo/>.
			  "\\([^>]*[^/>]\\)?>")))
745 746 747 748 749 750
	  (while (and (re-search-backward re nil t)
		      (eq (char-after (1+ (point))) ?/))
	    (forward-char 1)
	    (sgml-skip-tag-backward 1))))
    (setq arg (1- arg))))

751
(defun sgml-skip-tag-forward (arg)
752
  "Skip to end of tag or matching closing tag if present.
Richard M. Stallman's avatar
Richard M. Stallman committed
753
With prefix argument ARG, repeat this ARG times.
754 755
Return t iff after a closing tag."
  (interactive "p")
Stefan Monnier's avatar
Stefan Monnier committed
756 757 758
  ;; FIXME: Use sgml-get-context or something similar.
  ;; It currently might jump to an unrelated </P> if the <P>
  ;; we're skipping has no matching </P>.
759
  (let ((return t))
Stefan Monnier's avatar
Stefan Monnier committed
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
    (with-syntax-table sgml-tag-syntax-table
      (while (>= arg 1)
	(skip-chars-forward "^<>")
	(if (eq (following-char) ?>)
	    (up-list -1))
	(if (looking-at "<\\([^/ \n\t>]+\\)\\([^>]*[^/>]\\)?>")
	    ;; start tag, skip any nested same pairs _and_ closing tag
	    (let ((case-fold-search t)
		  (re (concat "</?" (regexp-quote (match-string 1))
			      ;; Ignore empty tags like <foo/>.
			      "\\([^>]*[^/>]\\)?>"))
		  point close)
	      (forward-list 1)
	      (setq point (point))
	      ;; FIXME: This re-search-forward will mistakenly match
	      ;; tag-like text inside attributes.
	      (while (and (re-search-forward re nil t)
			  (not (setq close
				     (eq (char-after (1+ (match-beginning 0))) ?/)))
			  (goto-char (match-beginning 0))
			  (sgml-skip-tag-forward 1))
		(setq close nil))
	      (unless close
		(goto-char point)
		(setq return nil)))
	  (forward-list 1))
	(setq arg (1- arg)))
      return)))
788 789

(defun sgml-delete-tag (arg)
Stefan Monnier's avatar
Stefan Monnier committed
790
  ;; FIXME: Should be called sgml-kill-tag or should not touch the kill-ring.
791
  "Delete tag on or after cursor, and matching closing or opening tag.
Richard M. Stallman's avatar
Richard M. Stallman committed
792
With prefix argument ARG, repeat this ARG times."
793 794 795 796
  (interactive "p")
  (while (>= arg 1)
    (save-excursion
      (let* (close open)
797
	(if (looking-at "[ \t\n]*<")
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
	    ;; just before tag
	    (if (eq (char-after (match-end 0)) ?/)
		;; closing tag
		(progn
		  (setq close (point))
		  (goto-char (match-end 0))))
	  ;; on tag?
	  (or (save-excursion (setq close (sgml-beginning-of-tag)
				    close (and (stringp close)
					       (eq (aref close 0) ?/)
					       (point))))
	      ;; not on closing tag
	      (let ((point (point)))
		(sgml-skip-tag-backward 1)
		(if (or (not (eq (following-char) ?<))
			(save-excursion
			  (forward-list 1)
			  (<= (point) point)))
		    (error "Not on or before tag")))))
	(if close
	    (progn
	      (sgml-skip-tag-backward 1)
	      (setq open (point))
	      (goto-char close)
	      (kill-sexp 1))
	  (setq open (point))
Juri Linkov's avatar
Juri Linkov committed
824 825
	  (when (and (sgml-skip-tag-forward 1)
		     (not (looking-back "/>")))
Stefan Monnier's avatar
Stefan Monnier committed
826 827 828 829 830
	    (kill-sexp -1)))
	;; Delete any resulting empty line.  If we didn't kill-sexp,
	;; this *should* do nothing, because we're right after the tag.
	(if (progn (forward-line 0) (looking-at "\\(?:[ \t]*$\\)\n?"))
	    (delete-region (match-beginning 0) (match-end 0)))
831
	(goto-char open)
Stefan Monnier's avatar
Stefan Monnier committed
832 833 834
	(kill-sexp 1)
	(if (progn (forward-line 0) (looking-at "\\(?:[ \t]*$\\)\n?"))
	    (delete-region (match-beginning 0) (match-end 0)))))
835
    (setq arg (1- arg))))
Mike Williams's avatar
Mike Williams committed
836

837 838 839 840 841 842 843 844 845

;; Put read-only last to enable setting this even when read-only enabled.
(or (get 'sgml-tag 'invisible)
    (setplist 'sgml-tag
	      (append '(invisible t
			point-entered sgml-point-entered
			rear-nonsticky t
			read-only t)
		      (symbol-plist 'sgml-tag))))
846 847 848 849 850 851

(defun sgml-tags-invisible (arg)
  "Toggle visibility of existing tags."
  (interactive "P")
  (let ((modified (buffer-modified-p))
	(inhibit-read-only t)
852 853 854
	(inhibit-modification-hooks t)
	;; Avoid spurious the `file-locked' checks.
	(buffer-file-name nil)
855 856
	;; This is needed in case font lock gets called,
	;; since it moves point and might call sgml-point-entered.
857
	;; How could it get called?  -stef
858
	(inhibit-point-motion-hooks t)
859
	string)
860 861 862
    (unwind-protect
	(save-excursion
	  (goto-char (point-min))
Stefan Monnier's avatar
Stefan Monnier committed
863 864 865 866
	  (if (set (make-local-variable 'sgml-tags-invisible)
		   (if arg
		       (>= (prefix-numeric-value arg) 0)
		     (not sgml-tags-invisible)))
867
	      (while (re-search-forward sgml-tag-name-re nil t)
868 869 870
		(setq string
		      (cdr (assq (intern-soft (downcase (match-string 1)))
				 sgml-display-text)))
871
		(goto-char (match-beginning 0))
872
		(and (stringp string)
873
		     (not (overlays-at (point)))
Stefan Monnier's avatar
Stefan Monnier committed
874 875 876
		     (let ((ol (make-overlay (point) (match-beginning 1))))
		       (overlay-put ol 'before-string string)
		       (overlay-put ol 'sgml-tag t)))
877 878 879
		(put-text-property (point)
				   (progn (forward-list) (point))
				   'category 'sgml-tag))
880
	    (let ((pos (point-min)))
881
	      (while (< (setq pos (next-overlay-change pos)) (point-max))
Stefan Monnier's avatar
Stefan Monnier committed
882
		(dolist (ol (overlays-at pos))
Stefan Monnier's avatar
Stefan Monnier committed
883
		  (if (overlay-get ol 'sgml-tag)
Stefan Monnier's avatar
Stefan Monnier committed
884
		      (delete-overlay ol)))))
885
	    (remove-text-properties (point-min) (point-max) '(category nil))))
886
      (restore-buffer-modified-p modified))
887 888 889 890 891 892 893 894
    (run-hooks 'sgml-tags-invisible-hook)
    (message "")))

(defun sgml-point-entered (x y)
  ;; Show preceding or following hidden tag, depending of cursor direction.
  (let ((inhibit-point-motion-hooks t))
    (save-excursion
      (message "Invisible tag: %s"
895 896
	       ;; Strip properties, otherwise, the text is invisible.
	       (buffer-substring-no-properties
897 898 899 900 901 902 903
		(point)
		(if (or (and (> x y)
			     (not (eq (following-char) ?<)))
			(and (< x y)
			     (eq (preceding-char) ?>)))
		    (backward-list)
		  (forward-list)))))))
Mike Williams's avatar
Mike Williams committed
904

905

906 907
(autoload 'compile-internal "compile")

Eric S. Raymond's avatar
Eric S. Raymond committed
908 909 910
(defun sgml-validate (command)
  "Validate an SGML document.
Runs COMMAND, a shell command, in a separate process asynchronously
Richard M. Stallman's avatar
Richard M. Stallman committed
911
with output going to the buffer `*compilation*'.
Eric S. Raymond's avatar
Eric S. Raymond committed
912 913 914 915 916 917 918 919 920 921 922
You can then use the command \\[next-error] to find the next error message
and move to the line in the SGML document that caused it."
  (interactive
   (list (read-string "Validate command: "
		      (or sgml-saved-validate-command
			  (concat sgml-validate-command
				  " "
				  (let ((name (buffer-file-name)))
				    (and name
					 (file-name-nondirectory name))))))))
  (setq sgml-saved-validate-command command)
923
  (save-some-buffers (not compilation-ask-about-save) nil)
924
  (compile-internal command "No more errors"))
Eric S. Raymond's avatar
Eric S. Raymond committed
925

926 927 928 929 930 931
(defsubst sgml-at-indentation-p ()
  "Return true if point is at the first non-whitespace character on the line."
  (save-excursion
    (skip-chars-backward " \t")
    (bolp)))

932 933 934
(defun sgml-lexical-context (&optional limit)
  "Return the lexical context at point as (TYPE . START).
START is the location of the start of the lexical element.
Mike Williams's avatar
Mike Williams committed
935
TYPE is one of `string', `comment', `tag', `cdata', or `text'.
936

937 938
Optional argument LIMIT is the position to start parsing from.
If nil, start from a preceding tag at indentation."
939 940
  (save-excursion
    (let ((pos (point))
941
	  text-start state)
942 943 944 945 946
      (if limit
          (goto-char limit)
        ;; Skip tags backwards until we find one at indentation
        (while (and (ignore-errors (sgml-parse-tag-backward))
                    (not (sgml-at-indentation-p)))))
Stefan Monnier's avatar
Stefan Monnier committed
947 948 949
      (with-syntax-table sgml-tag-syntax-table
	(while (< (point) pos)
	  ;; When entering this loop we're inside text.
950
	  (setq text-start (point))
Stefan Monnier's avatar
Stefan Monnier committed
951
	  (skip-chars-forward "^<" pos)
952 953
          (setq state
                (cond
954
                 ((= (point) pos)
955 956 957 958 959 960 961 962
                  ;; We got to the end without seeing a tag.
                  nil)
                 ((looking-at "<!\\[[A-Z]+\\[")
                  ;; We've found a CDATA section or similar.
                  (let ((cdata-start (point)))
                    (unless (search-forward "]]>" pos 'move)
                      (list 0 nil nil 'cdata nil nil nil nil cdata-start))))
                 (t
963
                  ;; We've reached a tag.  Parse it.
964 965 966 967 968 969 970 971
                  ;; FIXME: Handle net-enabling start-tags
                  (parse-partial-sexp (point) pos 0))))))
      (cond
       ((eq (nth 3 state) 'cdata) (cons 'cdata (nth 8 state)))
       ((nth 3 state) (cons 'string (nth 8 state)))
       ((nth 4 state) (cons 'comment (nth 8 state)))
       ((and state (> (nth 0 state) 0)) (cons 'tag (nth 1 state)))
       (t (cons 'text text-start))))))
972

973 974
(defun sgml-beginning-of-tag (&optional top-level)
  "Skip to beginning of tag and return its name.
975 976 977 978 979 980 981 982
If this can't be done, return nil."
  (let ((context (sgml-lexical-context)))
    (if (eq (car context) 'tag)
	(progn
	  (goto-char (cdr context))
	  (when (looking-at sgml-tag-name-re)
	    (match-string-no-properties 1)))
      (if top-level nil
983
	(when (not (eq (car context) 'text))
984 985
	  (goto-char (cdr context))
	  (sgml-beginning-of-tag t))))))
986 987

(defun sgml-value (alist)
988
  "Interactively insert value taken from attribute-rule ALIST.
989
See `sgml-tag-alist' for info about attribute rules."
990 991 992
  (setq alist (cdr alist))
  (if (stringp (car alist))
      (insert "=\"" (car alist) ?\")
993
    (if (and (eq (car alist) t) (not sgml-xml-mode))
994
	(when (cdr alist)
Stefan Monnier's avatar
Stefan Monnier committed
995 996 997 998 999
	  (insert "=\"")
	  (setq alist (skeleton-read '(completing-read "Value: " (cdr alist))))
	  (if (string< "" alist)
	      (insert alist ?\")
	    (delete-backward-char 2)))
1000
      (insert "=\"")
1001 1002
      (when alist
        (insert (skeleton-read '(completing-read "Value: " alist))))
1003
      (insert ?\"))))
1004 1005

(defun sgml-quote (start end &optional unquotep)
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
  "Quote SGML text in region START ... END.
Only &, < and > are quoted, the rest is left untouched.
With prefix argument UNQUOTEP, unquote the region."
  (interactive "r\nP")
  (save-restriction
    (narrow-to-region start end)
    (goto-char (point-min))
    (if unquotep
	;; FIXME: We should unquote other named character references as well.
	(while (re-search-forward
		"\\(&\\(amp\\|\\(l\\|\\(g\\)\\)t\\)\\)[][<>&;\n\t \"%!'(),/=?]"
		nil t)
	  (replace-match (if (match-end 4) ">" (if (match-end 3) "<" "&")) t t
			 nil (if (eq (char-before (match-end 0)) ?\;) 0 1)))
      (while (re-search-forward "[&<>]" nil t)
	(replace-match (cdr (assq (char-before) '((?& . "&amp;")
						  (?< . "&lt;")
						  (?> . "&gt;"))))
		       t t)))))

(defun sgml-pretty-print (beg end)
  "Simple-minded pretty printer for SGML.
Re-indents the code and inserts newlines between BEG and END.
You might want to turn on `auto-fill-mode' to get better results."
  ;; TODO:
  ;; - insert newline between some start-tag and text.
  ;; - don't insert newline in front of some end-tags.
  (interactive "r")
  (save-excursion
    (if (< beg end)
	(goto-char beg)
      (goto-char end)
      (setq end beg)
      (setq beg (point)))
    ;; Don't use narrowing because it screws up auto-indent.
    (setq end (copy-marker end t))
    (with-syntax-table sgml-tag-syntax-table
      (while (re-search-forward "<" end t)
	(goto-char (match-beginning 0))
	(unless (or ;;(looking-at "</")
		    (progn (skip-chars-backward " \t") (bolp)))
	  (reindent-then-newline-and-indent))
	(forward-sexp 1)))
    ;; (indent-region beg end)
    ))
1051

1052 1053 10