sgml-mode.el 70.1 KB
Newer Older
1
;;; sgml-mode.el --- SGML- and HTML-editing modes -*- coding: iso-2022-7bit -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1992, 1995, 1996, 1998, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 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
16
;; the Free Software Foundation; either version 3, 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
26 27
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, 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
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
45 46
  :group 'languages)

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

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

57
(put 'sgml-transformation-function 'variable-interactive
58
     "aTransformation function: ")
59
(defvaralias 'sgml-transformation 'sgml-transformation-function)
60

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

67 68 69
;; 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.
70
(defvar sgml-specials '(?\")
Richard M. Stallman's avatar
Richard M. Stallman committed
71
  "List of characters that have a special meaning for SGML mode.
72
This list is used when first loading the `sgml-mode' library.
73 74 75 76 77 78
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.

79
When only one of ?\\\" or ?' are included, \"'\" or '\"', as can be found in
80
DTDs, start a string.  To partially avoid this problem this also makes these
81 82 83 84
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.")
85 86

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

(defvar sgml-mode-map
91
  (let ((map (make-keymap))	;`sparse' doesn't allow binding to charsets.
92 93 94
	(menu-map (make-sparse-keymap "SGML")))
    (define-key map "\C-c\C-i" 'sgml-tags-invisible)
    (define-key map "/" 'sgml-slash)
95 96
    (define-key map "\C-c\C-n" 'sgml-name-char)
    (define-key map "\C-c\C-t" 'sgml-tag)
97 98 99 100 101 102 103 104
    (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
105
    (define-key map "\C-c/" 'sgml-close-tag)
106 107
    (define-key map "\C-c8" 'sgml-name-8bit-mode)
    (define-key map "\C-c\C-v" 'sgml-validate)
108 109 110 111 112 113 114 115 116
    (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
117 118
    (define-key map (vector (make-char 'latin-iso8859-1))
      'sgml-maybe-name-self)
119 120 121 122
    (let ((c 127)
	  (map (nth 1 map)))
      (while (< (setq c (1+ c)) 256)
	(aset map c 'sgml-maybe-name-self)))
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
    (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'.")

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

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

161 162 163 164 165 166 167
(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.")

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

173 174 175 176 177
(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
178
   "nbsp" "excl" "quot" "num" "dollar" "percnt" "amp" "apos"
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
   "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"
197
   "cedil" "sup1" "ordm" "raquo" "frac14" "frac12" "frac34" "iquest"
198 199 200 201 202 203 204 205 206 207
   "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 `;'.")

208 209 210 211 212 213 214 215 216 217 218 219 220 221
(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.")

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

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

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

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

245
(defconst sgml-namespace-re "[_[:alpha:]][-_.[:alnum:]]*")
Stefan Monnier's avatar
Stefan Monnier committed
246 247 248 249
(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)
250
  "Regular expression that matches a non-empty start tag.
Richard M. Stallman's avatar
Richard M. Stallman committed
251
Any terminating `>' or `/' is not matched.")
252

253
(defface sgml-namespace
254
  '((t (:inherit font-lock-builtin-face)))
255 256
  "`sgml-mode' face used to highlight the namespace part of identifiers."
  :group 'sgml)
257
(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
    ;; The first shy-group is an important anchor: it prevents an O(n^2)
    ;; pathological case where we otherwise keep retrying a failing match
    ;; against a very long word at every possible position within the word.
    (,(concat "\\(?:^\\|[ \t]\\)\\(" sgml-namespace-re "\\)\\(?::\\("
272 273 274
	      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
275
    (,(concat "[&%]" sgml-name-re ";?") . font-lock-variable-name-face)))
276 277 278 279 280 281 282 283 284

(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))
285
			      sgml-tag-face-alist)) prepend))))))
286 287 288 289

;; 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
290 291
  "*Rules for highlighting SGML code.  See also `sgml-tag-face-alist'.")

292 293 294 295 296 297 298 299
(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'.")

300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
;; 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)

315
(defcustom sgml-tag-alist
316 317
  '(("![" ("ignore" t) ("include" t))
    ("!attlist")
318 319 320 321 322 323 324 325 326
    ("!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
327 328
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
329 330 331 332 333 334 335 336
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
337
ATTRIBUTERULE is a list of optionally t (no value when no input) followed by
338 339 340 341
an optional alist of possible values."
  :type '(repeat (cons (string :tag "Tag Name")
		       (repeat :tag "Tag Rule" sexp)))
  :group 'sgml)
342
(put 'sgml-tag-alist 'risky-local-variable t)
343

344
(defcustom sgml-tag-help
345 346 347 348 349 350
  '(("!" . "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"))
351 352 353 354
  "*Alist of tag name and short description."
  :type '(repeat (cons (string :tag "Tag Name")
		       (string :tag "Description")))
  :group 'sgml)
355

356
(defcustom sgml-xml-mode nil
357 358 359
  "*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
360
a DOCTYPE or an XML declaration."
361
  :type 'boolean
362
  :version "22.1"
363 364
  :group 'sgml)

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

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

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

Dave Love's avatar
Dave Love committed
387 388
(defvar v2)				; free for skeleton

389 390 391 392 393 394 395
(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)))

396 397 398
(defun sgml-mode-facemenu-add-face-function (face end)
  (if (setq face (cdr (assq face sgml-face-tag-alist)))
      (progn
399
	(setq face (funcall skeleton-transformation-function face))
400 401 402 403
	(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
404 405 406 407 408 409 410 411
(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) ?<))))

412 413 414 415
;;;###autoload
(define-derived-mode sgml-mode text-mode "SGML"
  "Major mode for editing SGML documents.
Makes > match <.
416
Keys <, &, SPC within <>, \", / and ' can be electric depending on
417 418 419 420 421 422
`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.

423 424
If you like upcased tags, put (setq sgml-transformation-function 'upcase)
in your `.emacs' file.
425 426 427 428 429 430

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
431
  (make-local-variable 'sgml-saved-validate-command)
432 433
  (make-local-variable 'facemenu-end-add-face)
  ;;(make-local-variable 'facemenu-remove-face-function)
434 435 436
  ;; 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
437 438 439 440
  (set (make-local-variable 'paragraph-start) (concat "[ \t]*$\\|\
\[ \t]*</?\\(" sgml-name-re sgml-attrs-re "\\)?>"))
  (set (make-local-variable 'paragraph-separate)
       (concat paragraph-start "$"))
441
  (set (make-local-variable 'adaptive-fill-regexp) "[ \t]*")
Stefan Monnier's avatar
Stefan Monnier committed
442
  (add-hook 'fill-nobreak-predicate 'sgml-fill-nobreak nil t)
443
  (set (make-local-variable 'indent-line-function) 'sgml-indent-line)
444 445 446
  (set (make-local-variable 'comment-start) "<!-- ")
  (set (make-local-variable 'comment-end) " -->")
  (set (make-local-variable 'comment-indent-function) 'sgml-comment-indent)
447 448
  (set (make-local-variable 'comment-line-break-function)
       'sgml-comment-indent-new-line)
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
  (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)
465 466 467
  (sgml-xml-guess)
  (if sgml-xml-mode
      (setq mode-name "XML")
468 469
    (set (make-local-variable 'skeleton-transformation-function)
         sgml-transformation-function))
470 471
  ;; This will allow existing comments within declarations to be
  ;; recognized.
472 473 474 475 476 477
  ;; I can't find a clear description of SGML/XML comments, but it seems that
  ;; the only reliable ones are <!-- ... --> although it's not clear what
  ;; "..." can contain.  It used to accept -- ... -- as well, but that was
  ;; apparently a mistake.
  (set (make-local-variable 'comment-start-skip) "<!--[ \t]*")
  (set (make-local-variable 'comment-end-skip) "[ \t]*--[ \t\n]*>")
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
  ;; 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))))
494

495 496
;; Some programs (such as Glade 2) generate XML which has
;; -*- mode: xml -*-.
497
;;;###autoload
498 499
(defalias 'xml-mode 'sgml-mode)

Eric S. Raymond's avatar
Eric S. Raymond committed
500
(defun sgml-comment-indent ()
501
  (if (looking-at "--") comment-column 0))
Eric S. Raymond's avatar
Eric S. Raymond committed
502 503

(defun sgml-slash (arg)
504 505 506 507 508 509 510 511 512 513 514
  "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
515
    (sgml-close-tag))
516 517 518 519
   (t
    (sgml-slash-matching arg))))

(defun sgml-slash-matching (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
520 521 522
  "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
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
  (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)))))))
551 552 553 554 555 556 557
	  (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
558

Stefan Monnier's avatar
Stefan Monnier committed
559 560 561
;; 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.
562 563
(defun sgml-name-char (&optional char)
  "Insert a symbolic character name according to `sgml-char-names'.
564 565 566
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."
567 568 569
  (interactive "*")
  (insert ?&)
  (or char
570
      (setq char (read-quoted-char "Enter char or octal number")))
571 572 573
  (delete-backward-char 1)
  (insert char)
  (undo-boundary)
Stefan Monnier's avatar
Stefan Monnier committed
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
  (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)))))
591 592 593 594 595 596 597 598 599 600

(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
601 602 603 604 605
      (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))
606 607 608
    (self-insert-command 1)))

(defun sgml-name-8bit-mode ()
Stefan Monnier's avatar
Stefan Monnier committed
609 610
  "Toggle whether to insert named entities instead of non-ASCII characters.
This only works for Latin-1 input."
611
  (interactive)
612
  (setq sgml-name-8bit-mode (not sgml-name-8bit-mode))
613
  (message "sgml name entity mode is now %s"
614
	   (if sgml-name-8bit-mode "ON" "OFF")))
615

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

Stefan Monnier's avatar
Stefan Monnier committed
621 622
(defvar sgml-tag-last nil)
(defvar sgml-tag-history nil)
623
(define-skeleton sgml-tag
Richard M. Stallman's avatar
Richard M. Stallman committed
624 625
  "Prompt for a tag and insert it, optionally with attributes.
Completion and configuration are done according to `sgml-tag-alist'.
626
If you like tags and attributes in uppercase do \\[set-variable]
627 628 629 630
`skeleton-transformation-function' RET `upcase' RET, or put this
in your `.emacs':
  (setq sgml-transformation-function 'upcase)"
  (funcall (or skeleton-transformation-function 'identity)
Stefan Monnier's avatar
Stefan Monnier committed
631 632 633 634 635 636
           (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)))
637
  ?< str |
638
  (("") -1 '(undo-boundary) (identity "&lt;")) |	; see comment above
Stefan Monnier's avatar
Stefan Monnier committed
639 640 641 642 643
  `(("") '(setq v2 (sgml-attributes ,str t)) ?>
    (cond
     ((string= "![" ,str)
      (backward-char)
      '(("") " [ " _ " ]]"))
644
     ((and (eq v2 t) sgml-xml-mode (member ,str sgml-empty-tags))
Juri Linkov's avatar
Juri Linkov committed
645
      '(("") -1 " />"))
646
     ((or (and (eq v2 t) (not sgml-xml-mode)) (string-match "^[/!?]" ,str))
Stefan Monnier's avatar
Stefan Monnier committed
647 648 649 650 651 652
      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
653
      ;; `str' through `skeleton-transformation-function' a second time.
Stefan Monnier's avatar
Stefan Monnier committed
654 655 656 657 658 659 660
      '(("") v2 _ v2 "</" (identity ',str) ?>))
     ((eq (car v2) t)
      (cons '("") (cdr v2)))
     (t
      (append '(("") (car v2))
	      (cdr v2)
	      '(resume: (car v2) _ "</" (identity ',str) ?>))))))
661 662 663

(autoload 'skeleton-read "skeleton")

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

Richard M. Stallman's avatar
Richard M. Stallman committed
667 668
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."
669
  (interactive (list (save-excursion (sgml-beginning-of-tag t))))
670 671
  (or (stringp tag) (error "Wrong context for adding attribute"))
  (if tag
672
      (let ((completion-ignore-case t)
673
	    (alist (cdr (assoc (downcase tag) sgml-tag-alist)))
674 675 676 677 678 679 680 681 682
	    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
683
	      (insert (if (eq (preceding-char) ?\s) "" ?\s)
684
		      (funcall skeleton-transformation-function (car alist)))
685 686 687
	      (sgml-value alist))
	  (setq i (length alist))
	  (while (> i 0)
688
	    (insert ?\s)
689
	    (insert (funcall skeleton-transformation-function
690 691
			     (setq attribute
				   (skeleton-read '(completing-read
692
						    "Attribute: "
693 694 695
						    alist)))))
	    (if (string= "" attribute)
		(setq i 0)
696
	      (sgml-value (assoc (downcase attribute) alist))
697
	      (setq i (1- i))))
698
	  (if (eq (preceding-char) ?\s)
699 700 701 702
	      (delete-backward-char 1)))
	car)))

(defun sgml-auto-attributes (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
703 704
  "Self insert the character typed; at top level of tag, prompt for attributes.
With prefix argument, only self insert."
705 706 707 708 709 710 711 712 713
  (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)
714
      (setq last-command-char ?\s)
715 716 717 718
      (or (> (point) point)
	  (self-insert-command 1)))))

(defun sgml-tag-help (&optional tag)
Richard M. Stallman's avatar
Richard M. Stallman committed
719
  "Display description of tag TAG.  If TAG is omitted, use the tag at point."
720 721 722 723 724 725 726 727 728
  (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))
729
  (message "%s"
730
	   (or (cdr (assoc (downcase tag) sgml-tag-help))
731
	       (and (eq (aref tag 0) ?/)
732
		    (cdr (assoc (downcase (substring tag 1)) sgml-tag-help)))
733 734
	       "No description available")))

735 736 737 738 739 740
(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)))
741 742 743

(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
744
With prefix argument ARG, repeat this ARG times."
745
  (interactive "p")
Stefan Monnier's avatar
Stefan Monnier committed
746
  ;; FIXME: use sgml-get-context or something similar.
747 748 749 750 751
  (while (>= arg 1)
    (search-backward "<" nil t)
    (if (looking-at "</\\([^ \n\t>]+\\)")
	;; end tag, skip any nested pairs
	(let ((case-fold-search t)
752 753 754
	      (re (concat "</?" (regexp-quote (match-string 1))
			  ;; Ignore empty tags like <foo/>.
			  "\\([^>]*[^/>]\\)?>")))
755 756 757 758 759 760
	  (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))))

761
(defun sgml-skip-tag-forward (arg)
762
  "Skip to end of tag or matching closing tag if present.
Richard M. Stallman's avatar
Richard M. Stallman committed
763
With prefix argument ARG, repeat this ARG times.
764
Return t if after a closing tag."
765
  (interactive "p")
Stefan Monnier's avatar
Stefan Monnier committed
766 767 768
  ;; 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>.
769
  (let ((return t))
Stefan Monnier's avatar
Stefan Monnier committed
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
    (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)))
798 799

(defun sgml-delete-tag (arg)
Stefan Monnier's avatar
Stefan Monnier committed
800
  ;; FIXME: Should be called sgml-kill-tag or should not touch the kill-ring.
801
  "Delete tag on or after cursor, and matching closing or opening tag.
Richard M. Stallman's avatar
Richard M. Stallman committed
802
With prefix argument ARG, repeat this ARG times."
803 804 805 806
  (interactive "p")
  (while (>= arg 1)
    (save-excursion
      (let* (close open)
807
	(if (looking-at "[ \t\n]*<")
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
	    ;; 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
834 835
	  (when (and (sgml-skip-tag-forward 1)
		     (not (looking-back "/>")))
Stefan Monnier's avatar
Stefan Monnier committed
836 837 838 839 840
	    (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)))
841
	(goto-char open)
Stefan Monnier's avatar
Stefan Monnier committed
842 843 844
	(kill-sexp 1)
	(if (progn (forward-line 0) (looking-at "\\(?:[ \t]*$\\)\n?"))
	    (delete-region (match-beginning 0) (match-end 0)))))
845
    (setq arg (1- arg))))
Mike Williams's avatar
Mike Williams committed
846

847 848 849 850 851 852 853 854 855

;; 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))))
856 857 858 859 860 861

(defun sgml-tags-invisible (arg)
  "Toggle visibility of existing tags."
  (interactive "P")
  (let ((modified (buffer-modified-p))
	(inhibit-read-only t)
862 863 864
	(inhibit-modification-hooks t)
	;; Avoid spurious the `file-locked' checks.
	(buffer-file-name nil)
865 866
	;; This is needed in case font lock gets called,
	;; since it moves point and might call sgml-point-entered.
867
	;; How could it get called?  -stef
868
	(inhibit-point-motion-hooks t)
869
	string)
870 871 872
    (unwind-protect
	(save-excursion
	  (goto-char (point-min))
Stefan Monnier's avatar
Stefan Monnier committed
873 874 875 876
	  (if (set (make-local-variable 'sgml-tags-invisible)
		   (if arg
		       (>= (prefix-numeric-value arg) 0)
		     (not sgml-tags-invisible)))
877
	      (while (re-search-forward sgml-tag-name-re nil t)
878 879 880
		(setq string
		      (cdr (assq (intern-soft (downcase (match-string 1)))
				 sgml-display-text)))
881
		(goto-char (match-beginning 0))
882
		(and (stringp string)
883
		     (not (overlays-at (point)))
Stefan Monnier's avatar
Stefan Monnier committed
884 885 886
		     (let ((ol (make-overlay (point) (match-beginning 1))))
		       (overlay-put ol 'before-string string)
		       (overlay-put ol 'sgml-tag t)))
887 888 889
		(put-text-property (point)
				   (progn (forward-list) (point))
				   'category 'sgml-tag))
890
	    (let ((pos (point-min)))
891
	      (while (< (setq pos (next-overlay-change pos)) (point-max))
Stefan Monnier's avatar
Stefan Monnier committed
892
		(dolist (ol (overlays-at pos))
Stefan Monnier's avatar
Stefan Monnier committed
893
		  (if (overlay-get ol 'sgml-tag)
Stefan Monnier's avatar
Stefan Monnier committed
894
		      (delete-overlay ol)))))
895
	    (remove-text-properties (point-min) (point-max) '(category nil))))
896
      (restore-buffer-modified-p modified))
897 898 899 900 901 902 903
    (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
904 905 906 907 908 909 910 911 912 913 914 915 916
      (condition-case nil
	  (message "Invisible tag: %s"
		   ;; Strip properties, otherwise, the text is invisible.
		   (buffer-substring-no-properties
		    (point)
		    (if (or (and (> x y)
				 (not (eq (following-char) ?<)))
			    (and (< x y)
				 (eq (preceding-char) ?>)))
			(backward-list)
		      (forward-list))))
	(error nil)))))

Mike Williams's avatar
Mike Williams committed
917

918

Eric S. Raymond's avatar
Eric S. Raymond committed
919 920 921
(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
922
with output going to the buffer `*compilation*'.
Eric S. Raymond's avatar
Eric S. Raymond committed
923 924 925 926 927 928 929
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
				  " "
930 931 932 933
				  (shell-quote-argument
				   (let ((name (buffer-file-name)))
				     (and name
					  (file-name-nondirectory name)))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
934
  (setq sgml-saved-validate-command command)
935
  (save-some-buffers (not compilation-ask-about-save) nil)
936
  (compilation-start command))
Eric S. Raymond's avatar
Eric S. Raymond committed
937

938 939 940 941 942 943
(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)))

944 945 946
(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
947
TYPE is one of `string', `comment', `tag', `cdata', or `text'.
948

949 950
Optional argument LIMIT is the position to start parsing from.
If nil, start from a preceding tag at indentation."
951 952
  (save-excursion
    (let ((pos (point))
953
	  text-start state)
954 955 956 957 958
      (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
959 960 961
      (with-syntax-table sgml-tag-syntax-table
	(while (< (point) pos)
	  ;; When entering this loop we're inside text.
962
	  (setq text-start (point))
Stefan Monnier's avatar
Stefan Monnier committed
963
	  (skip-chars-forward "^<" pos)
964 965
          (setq state
                (cond
966
                 ((= (point) pos)
967 968 969 970 971 972 973 974
                  ;; 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
975
                  ;; We've reached a tag.  Parse it.
976 977 978 979 980 981 982 983
                  ;; 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))))))
984

985 986
(defun sgml-beginning-of-tag (&optional top-level)
  "Skip to beginning of tag and return its name.
987 988 989 990 991 992 993 994
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
995
	(when (not (eq (car context) 'text))
996 997
	  (goto-char (cdr context))
	  (sgml-beginning-of-tag t))))))
998 999

(defun sgml-value (alist)
1000
  "Interactively insert value taken from attribute-rule ALIST.
1001
See `sgml-tag-alist' for info about attribute rules."
1002 1003 1004
  (setq alist (cdr alist))
  (if (stringp (car alist))
      (insert "=\"" (car alist) ?\")
1005
    (if (and (eq (car alist) t) (not sgml-xml-mode))
1006
	(when (cdr alist)
Stefan Monnier's avatar
Stefan Monnier committed
1007 1008 1009 1010 1011
	  (insert "=\"")
	  (setq alist (skeleton-read '(completing-read "Value: " (cdr alist))))
	  (if (string< "" alist)
	      (insert alist ?\")
	    (delete-backward-char 2)))
1012
      (insert "=\"")
1013 1014
      (when alist
        (insert (skeleton-read '(completing-read