(bibtex-find-entry-location): Fix typo.
[bpt/emacs.git] / lisp / textmodes / sgml-mode.el
CommitLineData
1caf38eb 1;;; sgml-mode.el --- SGML- and HTML-editing modes
72c0ae01 2
0fda8eff 3;; Copyright (C) 1992,95,96,98,2001,2002 Free Software Foundation, Inc.
6d74b528 4
64ae0c23 5;; Author: James Clark <jjc@jclark.com>
0fda8eff 6;; Maintainer: FSF
3e910376 7;; Adapted-By: ESR, Daniel Pfeiffer <occitan@esperanto.org>,
a391b179 8;; F.Potorti@cnuce.cnr.it
1caf38eb 9;; Keywords: wp, hypermedia, comm, languages
72c0ae01 10
72c0ae01
ER
11;; This file is part of GNU Emacs.
12
13;; GNU Emacs is free software; you can redistribute it and/or modify
14;; it under the terms of the GNU General Public License as published by
7c938215 15;; the Free Software Foundation; either version 2, or (at your option)
72c0ae01
ER
16;; any later version.
17
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
b578f267
EN
24;; along with GNU Emacs; see the file COPYING. If not, write to the
25;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26;; Boston, MA 02111-1307, USA.
72c0ae01
ER
27
28;;; Commentary:
29
1caf38eb
RS
30;; Configurable major mode for editing document in the SGML standard general
31;; markup language. As an example contains a mode for editing the derived
32;; HTML hypertext markup language.
72c0ae01
ER
33
34;;; Code:
35
d4c89075
DL
36(eval-when-compile
37 (require 'skeleton)
a06283b1
MW
38 (require 'outline)
39 (require 'cl))
b0a377e6 40
64ae0c23
RS
41(defgroup sgml nil
42 "SGML editing mode"
43 :group 'languages)
44
5f3d924d
SM
45(defcustom sgml-basic-offset 2
46 "*Specifies the basic indentation level for `sgml-indent-line'."
47 :type 'integer
48 :group 'sgml)
49
d10447ba 50(defcustom sgml-transformation 'identity
a391b179
RS
51 "*Default value for `skeleton-transformation' (which see) in SGML mode."
52 :type 'function
c60e7b0d 53 :group 'sgml)
a391b179
RS
54
55(put 'sgml-transformation 'variable-interactive
56 "aTransformation function: ")
57
d4c89075
DL
58(defcustom sgml-mode-hook nil
59 "Hook run by command `sgml-mode'.
60`text-mode-hook' is run first."
61 :group 'sgml
62 :type 'hook)
63
1caf38eb
RS
64;; As long as Emacs' syntax can't be complemented with predicates to context
65;; sensitively confirm the syntax of characters, we have to live with this
66;; kludgy kind of tradeoff.
21a6f23c 67(defvar sgml-specials '(?\")
f788776c 68 "List of characters that have a special meaning for SGML mode.
140d71ba 69This list is used when first loading the `sgml-mode' library.
1caf38eb
RS
70The supported characters and potential disadvantages are:
71
72 ?\\\" Makes \" in text start a string.
73 ?' Makes ' in text start a string.
74 ?- Makes -- in text start a comment.
75
4fa91cfe 76When only one of ?\\\" or ?' are included, \"'\" or '\"', as can be found in
1caf38eb 77DTDs, start a string. To partially avoid this problem this also makes these
21a6f23c
RS
78self insert as named entities depending on `sgml-quick-keys'.
79
80Including ?- has the problem of affecting dashes that have nothing to do
81with comments, so we normally turn it off.")
fcc3195e
RS
82
83(defvar sgml-quick-keys nil
2394187c 84 "Use <, >, &, /, SPC and `sgml-specials' keys \"electrically\" when non-nil.
140d71ba 85This takes effect when first loading the `sgml-mode' library.")
1caf38eb 86
1caf38eb 87(defvar sgml-mode-map
e1940c83 88 (let ((map (make-keymap)) ;`sparse' doesn't allow binding to charsets.
1caf38eb 89 (menu-map (make-sparse-keymap "SGML")))
1caf38eb
RS
90 (define-key map "\C-c\C-i" 'sgml-tags-invisible)
91 (define-key map "/" 'sgml-slash)
fcc3195e
RS
92 (define-key map "\C-c\C-n" 'sgml-name-char)
93 (define-key map "\C-c\C-t" 'sgml-tag)
1caf38eb
RS
94 (define-key map "\C-c\C-a" 'sgml-attributes)
95 (define-key map "\C-c\C-b" 'sgml-skip-tag-backward)
96 (define-key map [?\C-c left] 'sgml-skip-tag-backward)
97 (define-key map "\C-c\C-f" 'sgml-skip-tag-forward)
98 (define-key map [?\C-c right] 'sgml-skip-tag-forward)
99 (define-key map "\C-c\C-d" 'sgml-delete-tag)
100 (define-key map "\C-c\^?" 'sgml-delete-tag)
101 (define-key map "\C-c?" 'sgml-tag-help)
f6ab0573 102 (define-key map "\C-c/" 'sgml-close-tag)
1caf38eb
RS
103 (define-key map "\C-c8" 'sgml-name-8bit-mode)
104 (define-key map "\C-c\C-v" 'sgml-validate)
b4f05c38
SS
105 (when sgml-quick-keys
106 (define-key map "&" 'sgml-name-char)
107 (define-key map "<" 'sgml-tag)
108 (define-key map " " 'sgml-auto-attributes)
109 (define-key map ">" 'sgml-maybe-end-tag)
110 (when (memq ?\" sgml-specials)
111 (define-key map "\"" 'sgml-name-self))
112 (when (memq ?' sgml-specials)
113 (define-key map "'" 'sgml-name-self)))
f7ac3e28
SM
114 (define-key map (vector (make-char 'latin-iso8859-1))
115 'sgml-maybe-name-self)
2840d653
EZ
116 (let ((c 127)
117 (map (nth 1 map)))
118 (while (< (setq c (1+ c)) 256)
119 (aset map c 'sgml-maybe-name-self)))
1caf38eb
RS
120 (define-key map [menu-bar sgml] (cons "SGML" menu-map))
121 (define-key menu-map [sgml-validate] '("Validate" . sgml-validate))
122 (define-key menu-map [sgml-name-8bit-mode]
123 '("Toggle 8 Bit Insertion" . sgml-name-8bit-mode))
124 (define-key menu-map [sgml-tags-invisible]
125 '("Toggle Tag Visibility" . sgml-tags-invisible))
126 (define-key menu-map [sgml-tag-help]
127 '("Describe Tag" . sgml-tag-help))
128 (define-key menu-map [sgml-delete-tag]
129 '("Delete Tag" . sgml-delete-tag))
130 (define-key menu-map [sgml-skip-tag-forward]
131 '("Forward Tag" . sgml-skip-tag-forward))
132 (define-key menu-map [sgml-skip-tag-backward]
133 '("Backward Tag" . sgml-skip-tag-backward))
134 (define-key menu-map [sgml-attributes]
135 '("Insert Attributes" . sgml-attributes))
136 (define-key menu-map [sgml-tag] '("Insert Tag" . sgml-tag))
137 map)
138 "Keymap for SGML mode. See also `sgml-specials'.")
139
1c1d2eb6
SM
140(defun sgml-make-syntax-table (specials)
141 (let ((table (make-syntax-table text-mode-syntax-table)))
1caf38eb
RS
142 (modify-syntax-entry ?< "(>" table)
143 (modify-syntax-entry ?> ")<" table)
1c1d2eb6
SM
144 (modify-syntax-entry ?: "_" table)
145 (modify-syntax-entry ?_ "_" table)
146 (modify-syntax-entry ?. "_" table)
147 (if (memq ?- specials)
1caf38eb 148 (modify-syntax-entry ?- "_ 1234" table))
1c1d2eb6 149 (if (memq ?\" specials)
1caf38eb 150 (modify-syntax-entry ?\" "\"\"" table))
1c1d2eb6 151 (if (memq ?' specials)
1caf38eb 152 (modify-syntax-entry ?\' "\"'" table))
1c1d2eb6
SM
153 table))
154
155(defvar sgml-mode-syntax-table (sgml-make-syntax-table sgml-specials)
1caf38eb
RS
156 "Syntax table used in SGML mode. See also `sgml-specials'.")
157
1c1d2eb6
SM
158(defconst sgml-tag-syntax-table
159 (let ((table (sgml-make-syntax-table '(?- ?\" ?\'))))
160 (dolist (char '(?\( ?\) ?\{ ?\} ?\[ ?\] ?$ ?% ?& ?* ?+ ?/))
161 (modify-syntax-entry char "." table))
162 table)
163 "Syntax table used to parse SGML tags.")
164
64ae0c23 165(defcustom sgml-name-8bit-mode nil
2840d653 166 "*When non-nil, insert non-ASCII characters as named entities."
64ae0c23
RS
167 :type 'boolean
168 :group 'sgml)
72c0ae01 169
1caf38eb
RS
170(defvar sgml-char-names
171 [nil nil nil nil nil nil nil nil
172 nil nil nil nil nil nil nil nil
173 nil nil nil nil nil nil nil nil
174 nil nil nil nil nil nil nil nil
a391b179 175 "nbsp" "excl" "quot" "num" "dollar" "percnt" "amp" "apos"
1caf38eb
RS
176 "lpar" "rpar" "ast" "plus" "comma" "hyphen" "period" "sol"
177 nil nil nil nil nil nil nil nil
178 nil nil "colon" "semi" "lt" "eq" "gt" "quest"
179 "commat" nil nil nil nil nil nil nil
180 nil nil nil nil nil nil nil nil
181 nil nil nil nil nil nil nil nil
182 nil nil nil "lsqb" nil "rsqb" "uarr" "lowbar"
183 "lsquo" nil nil nil nil nil nil nil
184 nil nil nil nil nil nil nil nil
185 nil nil nil nil nil nil nil nil
186 nil nil nil "lcub" "verbar" "rcub" "tilde" nil
187 nil nil nil nil nil nil nil nil
188 nil nil nil nil nil nil nil nil
189 nil nil nil nil nil nil nil nil
190 nil nil nil nil nil nil nil nil
191 "nbsp" "iexcl" "cent" "pound" "curren" "yen" "brvbar" "sect"
192 "uml" "copy" "ordf" "laquo" "not" "shy" "reg" "macr"
193 "ring" "plusmn" "sup2" "sup3" "acute" "micro" "para" "middot"
e79ad8a1 194 "cedil" "sup1" "ordm" "raquo" "frac14" "frac12" "frac34" "iquest"
1caf38eb
RS
195 "Agrave" "Aacute" "Acirc" "Atilde" "Auml" "Aring" "AElig" "Ccedil"
196 "Egrave" "Eacute" "Ecirc" "Euml" "Igrave" "Iacute" "Icirc" "Iuml"
197 "ETH" "Ntilde" "Ograve" "Oacute" "Ocirc" "Otilde" "Ouml" nil
198 "Oslash" "Ugrave" "Uacute" "Ucirc" "Uuml" "Yacute" "THORN" "szlig"
199 "agrave" "aacute" "acirc" "atilde" "auml" "aring" "aelig" "ccedil"
200 "egrave" "eacute" "ecirc" "euml" "igrave" "iacute" "icirc" "iuml"
201 "eth" "ntilde" "ograve" "oacute" "ocirc" "otilde" "ouml" "divide"
202 "oslash" "ugrave" "uacute" "ucirc" "uuml" "yacute" "thorn" "yuml"]
203 "Vector of symbolic character names without `&' and `;'.")
204
2840d653
EZ
205(put 'sgml-table 'char-table-extra-slots 0)
206
207(defvar sgml-char-names-table
208 (let ((table (make-char-table 'sgml-table))
209 (i 32)
210 elt)
211 (while (< i 256)
212 (setq elt (aref sgml-char-names i))
213 (if elt (aset table (make-char 'latin-iso8859-1 i) elt))
214 (setq i (1+ i)))
215 table)
216 "A table for mapping non-ASCII characters into SGML entity names.
217Currently, only Latin-1 characters are supported.")
218
5121371d
DL
219;; nsgmls is a free SGML parser in the SP suite available from
220;; ftp.jclark.com and otherwise packaged for GNU systems.
1caf38eb
RS
221;; Its error messages can be parsed by next-error.
222;; The -s option suppresses output.
223
5121371d 224(defcustom sgml-validate-command "nsgmls -s" ; replaced old `sgmls'
72c0ae01
ER
225 "*The command to validate an SGML document.
226The file name of current buffer file name will be appended to this,
64ae0c23
RS
227separated by a space."
228 :type 'string
d4c89075 229 :version "21.1"
64ae0c23 230 :group 'sgml)
72c0ae01
ER
231
232(defvar sgml-saved-validate-command nil
233 "The command last used to validate in this buffer.")
234
e1940c83
SM
235;; I doubt that null end tags are used much for large elements,
236;; so use a small distance here.
64ae0c23 237(defcustom sgml-slash-distance 1000
f788776c 238 "*If non-nil, is the maximum distance to search for matching `/'."
64ae0c23
RS
239 :type '(choice (const nil) integer)
240 :group 'sgml)
72c0ae01 241
5f3d924d
SM
242(defconst sgml-name-re "[_:[:alpha:]][-_.:[:alnum:]]*")
243(defconst sgml-tag-name-re (concat "<\\([!/?]?" sgml-name-re "\\)"))
244(defconst sgml-attrs-re "\\(?:[^\"'/><]\\|\"[^\"]*\"\\|'[^']*'\\)*")
245(defconst sgml-start-tag-regex (concat "<" sgml-name-re sgml-attrs-re)
1caf38eb 246 "Regular expression that matches a non-empty start tag.
f788776c 247Any terminating `>' or `/' is not matched.")
1caf38eb
RS
248
249
c6a63534
RS
250;; internal
251(defconst sgml-font-lock-keywords-1
5f3d924d
SM
252 `((,(concat "<\\([!?]" sgml-name-re "\\)") 1 font-lock-keyword-face)
253 (,(concat "<\\(/?" sgml-name-re"\\)") 1 font-lock-function-name-face)
1c1d2eb6 254 ;; FIXME: this doesn't cover the variables using a default value.
5f3d924d
SM
255 (,(concat "\\(" sgml-name-re "\\)=[\"']") 1 font-lock-variable-name-face)
256 (,(concat "[&%]" sgml-name-re ";?") . font-lock-variable-name-face)))
64367655
SM
257
258(defconst sgml-font-lock-keywords-2
259 (append
260 sgml-font-lock-keywords-1
261 '((eval
262 . (cons (concat "<"
263 (regexp-opt (mapcar 'car sgml-tag-face-alist) t)
264 "\\([ \t][^>]*\\)?>\\([^<]+\\)</\\1>")
265 '(3 (cdr (assoc (downcase (match-string 1))
266 sgml-tag-face-alist))))))))
c6a63534
RS
267
268;; for font-lock, but must be defvar'ed after
269;; sgml-font-lock-keywords-1 and sgml-font-lock-keywords-2 above
270(defvar sgml-font-lock-keywords sgml-font-lock-keywords-1
1caf38eb
RS
271 "*Rules for highlighting SGML code. See also `sgml-tag-face-alist'.")
272
64367655
SM
273(defvar sgml-font-lock-syntactic-keywords
274 ;; Use the `b' style of comments to avoid interference with the -- ... --
275 ;; comments recognized when `sgml-specials' includes ?-.
276 ;; FIXME: beware of <!--> blabla <!--> !!
277 '(("\\(<\\)!--" (1 "< b"))
278 ("--[ \t\n]*\\(>\\)" (1 "> b")))
279 "Syntactic keywords for `sgml-mode'.")
280
1caf38eb 281;; internal
1caf38eb
RS
282(defvar sgml-face-tag-alist ()
283 "Alist of face and tag name for facemenu.")
284
285(defvar sgml-tag-face-alist ()
286 "Tag names and face or list of faces to fontify with when invisible.
287When `font-lock-maximum-decoration' is 1 this is always used for fontifying.
288When more these are fontified together with `sgml-font-lock-keywords'.")
289
1caf38eb
RS
290(defvar sgml-display-text ()
291 "Tag names as lowercase symbols, and display string when invisible.")
292
293;; internal
294(defvar sgml-tags-invisible nil)
295
64ae0c23 296(defcustom sgml-tag-alist
fcc3195e
RS
297 '(("![" ("ignore" t) ("include" t))
298 ("!attlist")
1caf38eb
RS
299 ("!doctype")
300 ("!element")
301 ("!entity"))
302 "*Alist of tag names for completing read and insertion rules.
303This alist is made up as
304
305 ((\"tag\" . TAGRULE)
306 ...)
307
9d4ce428
MW
308TAGRULE is a list of optionally t (no endtag) or `\\n' (separate endtag by
309newlines) or a skeleton with nil, t or `\\n' in place of the interactor
1caf38eb
RS
310followed by an ATTRIBUTERULE (for an always present attribute) or an
311attribute alist.
312
313The attribute alist is made up as
314
315 ((\"attribute\" . ATTRIBUTERULE)
316 ...)
317
9d4ce428 318ATTRIBUTERULE is a list of optionally t (no value when no input) followed by
64ae0c23
RS
319an optional alist of possible values."
320 :type '(repeat (cons (string :tag "Tag Name")
321 (repeat :tag "Tag Rule" sexp)))
322 :group 'sgml)
1caf38eb 323
64ae0c23 324(defcustom sgml-tag-help
1caf38eb
RS
325 '(("!" . "Empty declaration for comment")
326 ("![" . "Embed declarations with parser directive")
327 ("!attlist" . "Tag attributes declaration")
328 ("!doctype" . "Document type (DTD) declaration")
329 ("!element" . "Tag declaration")
330 ("!entity" . "Entity (macro) declaration"))
64ae0c23
RS
331 "*Alist of tag name and short description."
332 :type '(repeat (cons (string :tag "Tag Name")
333 (string :tag "Description")))
334 :group 'sgml)
1caf38eb 335
a3ec4ba0 336(defcustom sgml-xml-mode nil
c77c3a73
SS
337 "*When non-nil, tag insertion functions will be XML-compliant.
338If this variable is customized, the custom value is used always.
339Otherwise, it is set to be buffer-local when the file has
340 a DOCTYPE or an XML declaration."
341 :type 'boolean
89e7ad59 342 :version "21.4"
c77c3a73
SS
343 :group 'sgml)
344
73d25e52
SM
345(defvar sgml-empty-tags nil
346 "List of tags whose !ELEMENT definition says EMPTY.")
347
5f3d924d
SM
348(defvar sgml-unclosed-tags nil
349 "List of tags whose !ELEMENT definition says the end-tag is optional.")
350
c77c3a73
SS
351(defun sgml-xml-guess ()
352 "Guess whether the current buffer is XML."
353 (save-excursion
354 (goto-char (point-min))
a3ec4ba0
SM
355 (when (or (string= "xml" (file-name-extension (or buffer-file-name "")))
356 (looking-at "\\s-*<\\?xml")
357 (when (re-search-forward
358 (eval-when-compile
359 (mapconcat 'identity
360 '("<!DOCTYPE" "\\(\\w+\\)" "\\(\\w+\\)"
361 "\"\\([^\"]+\\)\"" "\"\\([^\"]+\\)\"")
362 "\\s-+"))
363 nil t)
364 (string-match "X\\(HT\\)?ML" (match-string 3))))
365 (set (make-local-variable 'sgml-xml-mode) t))))
c77c3a73 366
b0a377e6
DL
367(defvar v2) ; free for skeleton
368
60128096
SM
369(defun sgml-comment-indent-new-line (&optional soft)
370 (let ((comment-start "-- ")
371 (comment-start-skip "\\(<!\\)?--[ \t]*")
372 (comment-end " --")
373 (comment-style 'plain))
374 (comment-indent-new-line soft)))
375
a3ec4ba0
SM
376(defun sgml-mode-facemenu-add-face-function (face end)
377 (if (setq face (cdr (assq face sgml-face-tag-alist)))
378 (progn
379 (setq face (funcall skeleton-transformation face))
380 (setq facemenu-end-add-face (concat "</" face ">"))
381 (concat "<" face ">"))
382 (error "Face not configured for %s mode" mode-name)))
383
a3ec4ba0
SM
384;;;###autoload
385(define-derived-mode sgml-mode text-mode "SGML"
386 "Major mode for editing SGML documents.
387Makes > match <.
2394187c 388Keys <, &, SPC within <>, \", / and ' can be electric depending on
a3ec4ba0
SM
389`sgml-quick-keys'.
390
391An argument of N to a tag-inserting command means to wrap it around
392the next N words. In Transient Mark mode, when the mark is active,
393N defaults to -1, which means to wrap it around the current region.
394
395If you like upcased tags, put (setq sgml-transformation 'upcase) in
396your `.emacs' file.
397
398Use \\[sgml-validate] to validate your document with an SGML parser.
399
400Do \\[describe-variable] sgml- SPC to see available variables.
401Do \\[describe-key] on the following bindings to discover what they do.
402\\{sgml-mode-map}"
72c0ae01 403 (make-local-variable 'sgml-saved-validate-command)
1caf38eb
RS
404 (make-local-variable 'facemenu-end-add-face)
405 ;;(make-local-variable 'facemenu-remove-face-function)
c77c3a73
SS
406 ;; A start or end tag by itself on a line separates a paragraph.
407 ;; This is desirable because SGML discards a newline that appears
408 ;; immediately after a start tag or immediately before an end tag.
5f3d924d
SM
409 (set (make-local-variable 'paragraph-start) (concat "[ \t]*$\\|\
410\[ \t]*</?\\(" sgml-name-re sgml-attrs-re "\\)?>"))
411 (set (make-local-variable 'paragraph-separate)
412 (concat paragraph-start "$"))
c77c3a73 413 (set (make-local-variable 'adaptive-fill-regexp) "[ \t]*")
9c599518 414 (set (make-local-variable 'indent-line-function) 'sgml-indent-line)
c77c3a73
SS
415 (set (make-local-variable 'comment-start) "<!-- ")
416 (set (make-local-variable 'comment-end) " -->")
417 (set (make-local-variable 'comment-indent-function) 'sgml-comment-indent)
60128096
SM
418 (set (make-local-variable 'comment-line-break-function)
419 'sgml-comment-indent-new-line)
c77c3a73
SS
420 (set (make-local-variable 'skeleton-further-elements)
421 '((completion-ignore-case t)))
422 (set (make-local-variable 'skeleton-end-hook)
423 (lambda ()
424 (or (eolp)
425 (not (or (eq v2 '\n) (eq (car-safe v2) '\n)))
426 (newline-and-indent))))
427 (set (make-local-variable 'font-lock-defaults)
428 '((sgml-font-lock-keywords
429 sgml-font-lock-keywords-1
430 sgml-font-lock-keywords-2)
431 nil t nil nil
432 (font-lock-syntactic-keywords
433 . sgml-font-lock-syntactic-keywords)))
434 (set (make-local-variable 'facemenu-add-face-function)
435 'sgml-mode-facemenu-add-face-function)
a3ec4ba0
SM
436 (sgml-xml-guess)
437 (if sgml-xml-mode
438 (setq mode-name "XML")
439 (set (make-local-variable 'skeleton-transformation) sgml-transformation))
4afa094d
SM
440 ;; This will allow existing comments within declarations to be
441 ;; recognized.
442 (set (make-local-variable 'comment-start-skip) "\\(?:<!\\)?--[ \t]*")
a3ec4ba0
SM
443 (set (make-local-variable 'comment-end-skip) "[ \t]*--\\([ \t\n]*>\\)?")
444 ;; This definition probably is not useful in derived modes.
c77c3a73 445 (set (make-local-variable 'imenu-generic-expression)
5f3d924d
SM
446 (concat "<!\\(element\\|entity\\)[ \t\n]+%?[ \t\n]*\\("
447 sgml-name-re "\\)")))
1caf38eb 448
9d118494
CW
449;; Some programs (such as Glade 2) generate XML which has
450;; -*- mode: xml -*-.
451(defalias 'xml-mode 'sgml-mode)
452
72c0ae01 453(defun sgml-comment-indent ()
4afa094d 454 (if (looking-at "--") comment-column 0))
72c0ae01 455
72c0ae01 456(defun sgml-slash (arg)
2394187c
SM
457 "Insert ARG slash characters.
458Behaves electrically if `sgml-quick-keys' is non-nil."
459 (interactive "p")
460 (cond
461 ((not (and (eq (char-before) ?<) (= arg 1)))
462 (sgml-slash-matching arg))
463 ((eq sgml-quick-keys 'indent)
464 (insert-char ?/ 1)
465 (indent-according-to-mode))
466 ((eq sgml-quick-keys 'close)
467 (delete-backward-char 1)
f6ab0573 468 (sgml-close-tag))
2394187c
SM
469 (t
470 (sgml-slash-matching arg))))
471
472(defun sgml-slash-matching (arg)
f788776c
RS
473 "Insert `/' and display any previous matching `/'.
474Two `/'s are treated as matching if the first `/' ends a net-enabling
475start tag, and the second `/' is the corresponding null end tag."
72c0ae01
ER
476 (interactive "p")
477 (insert-char ?/ arg)
478 (if (> arg 0)
479 (let ((oldpos (point))
480 (blinkpos)
481 (level 0))
482 (save-excursion
483 (save-restriction
484 (if sgml-slash-distance
485 (narrow-to-region (max (point-min)
486 (- (point) sgml-slash-distance))
487 oldpos))
488 (if (and (re-search-backward sgml-start-tag-regex (point-min) t)
489 (eq (match-end 0) (1- oldpos)))
490 ()
491 (goto-char (1- oldpos))
492 (while (and (not blinkpos)
493 (search-backward "/" (point-min) t))
494 (let ((tagend (save-excursion
495 (if (re-search-backward sgml-start-tag-regex
496 (point-min) t)
497 (match-end 0)
498 nil))))
499 (if (eq tagend (point))
500 (if (eq level 0)
501 (setq blinkpos (point))
502 (setq level (1- level)))
503 (setq level (1+ level)))))))
5950e029
SS
504 (when blinkpos
505 (goto-char blinkpos)
506 (if (pos-visible-in-window-p)
507 (sit-for 1)
508 (message "Matches %s"
509 (buffer-substring (line-beginning-position)
510 (1+ blinkpos)))))))))
72c0ae01 511
0fda8eff
SM
512;; Why doesn't this use the iso-cvt table or, preferably, generate the
513;; inverse of the extensive table in the SGML Quail input method? -- fx
514;; I guess that's moot since it only works with Latin-1 anyhow.
1caf38eb
RS
515(defun sgml-name-char (&optional char)
516 "Insert a symbolic character name according to `sgml-char-names'.
2840d653
EZ
517Non-ASCII chars may be inserted either with the meta key, as in M-SPC for
518no-break space or M-- for a soft hyphen; or via an input method or
519encoded keyboard operation."
1caf38eb
RS
520 (interactive "*")
521 (insert ?&)
522 (or char
9b0ffdac 523 (setq char (read-quoted-char "Enter char or octal number")))
1caf38eb
RS
524 (delete-backward-char 1)
525 (insert char)
526 (undo-boundary)
527 (delete-backward-char 1)
2840d653
EZ
528 (cond
529 ((< char 256)
530 (insert ?&
531 (or (aref sgml-char-names char)
532 (format "#%d" char))
533 ?\;))
534 ((aref sgml-char-names-table char)
535 (insert ?& (aref sgml-char-names-table char) ?\;))
0fda8eff
SM
536 ((let ((c (encode-char char 'ucs)))
537 (when c
538 (insert (format "&#%d;" c))
539 t)))
540 (t ; should be an error? -- fx
2840d653 541 (insert char))))
1caf38eb
RS
542
543(defun sgml-name-self ()
544 "Insert a symbolic character name according to `sgml-char-names'."
545 (interactive "*")
546 (sgml-name-char last-command-char))
547
1caf38eb
RS
548(defun sgml-maybe-name-self ()
549 "Insert a symbolic character name according to `sgml-char-names'."
550 (interactive "*")
551 (if sgml-name-8bit-mode
2840d653
EZ
552 (let ((mc last-command-char))
553 (if (< mc 256)
554 (setq mc (unibyte-char-to-multibyte mc)))
555 (or mc (setq mc last-command-char))
556 (sgml-name-char mc))
1caf38eb
RS
557 (self-insert-command 1)))
558
1caf38eb 559(defun sgml-name-8bit-mode ()
0fda8eff
SM
560 "Toggle whether to insert named entities instead of non-ASCII characters.
561This only works for Latin-1 input."
1caf38eb 562 (interactive)
d10447ba 563 (setq sgml-name-8bit-mode (not sgml-name-8bit-mode))
2840d653 564 (message "sgml name entity mode is now %s"
d10447ba 565 (if sgml-name-8bit-mode "ON" "OFF")))
1caf38eb 566
f788776c
RS
567;; When an element of a skeleton is a string "str", it is passed
568;; through skeleton-transformation and inserted. If "str" is to be
569;; inserted literally, one should obtain it as the return value of a
570;; function, e.g. (identity "str").
1caf38eb
RS
571
572(define-skeleton sgml-tag
f788776c
RS
573 "Prompt for a tag and insert it, optionally with attributes.
574Completion and configuration are done according to `sgml-tag-alist'.
d10447ba 575If you like tags and attributes in uppercase do \\[set-variable]
f788776c
RS
576skeleton-transformation RET upcase RET, or put this in your `.emacs':
577 (setq sgml-transformation 'upcase)"
51df53f8
MW
578 (funcall (or skeleton-transformation 'identity)
579 (completing-read "Tag: " sgml-tag-alist))
4afa094d 580 ?< str |
d10447ba 581 (("") -1 '(undo-boundary) (identity "&lt;")) | ; see comment above
73d25e52
SM
582 `(("") '(setq v2 (sgml-attributes ,str t)) ?>
583 (cond
584 ((string= "![" ,str)
585 (backward-char)
586 '(("") " [ " _ " ]]"))
a3ec4ba0 587 ((and (eq v2 t) sgml-xml-mode (member ,str sgml-empty-tags))
73d25e52 588 '(("") -1 "/>"))
a3ec4ba0 589 ((or (and (eq v2 t) (not sgml-xml-mode)) (string-match "^[/!?]" ,str))
73d25e52
SM
590 nil)
591 ((symbolp v2)
592 ;; Make sure we don't fall into an infinite loop.
593 ;; For xhtml's `tr' tag, we should maybe use \n instead.
594 (if (eq v2 t) (setq v2 nil))
595 ;; We use `identity' to prevent skeleton from passing
596 ;; `str' through skeleton-transformation a second time.
597 '(("") v2 _ v2 "</" (identity ',str) ?>))
598 ((eq (car v2) t)
599 (cons '("") (cdr v2)))
600 (t
601 (append '(("") (car v2))
602 (cdr v2)
603 '(resume: (car v2) _ "</" (identity ',str) ?>))))))
1caf38eb
RS
604
605(autoload 'skeleton-read "skeleton")
606
d10447ba 607(defun sgml-attributes (tag &optional quiet)
f788776c 608 "When at top level of a tag, interactively insert attributes.
d10447ba 609
f788776c
RS
610Completion and configuration of TAG are done according to `sgml-tag-alist'.
611If QUIET, do not print a message when there are no attributes for TAG."
1caf38eb 612 (interactive (list (save-excursion (sgml-beginning-of-tag t))))
d10447ba
RS
613 (or (stringp tag) (error "Wrong context for adding attribute"))
614 (if tag
1caf38eb 615 (let ((completion-ignore-case t)
d10447ba 616 (alist (cdr (assoc (downcase tag) sgml-tag-alist)))
1caf38eb 617 car attribute i)
1caf38eb
RS
618 (if (or (symbolp (car alist))
619 (symbolp (car (car alist))))
620 (setq car (car alist)
621 alist (cdr alist)))
622 (or quiet
623 (message "No attributes configured."))
624 (if (stringp (car alist))
625 (progn
d10447ba
RS
626 (insert (if (eq (preceding-char) ? ) "" ? )
627 (funcall skeleton-transformation (car alist)))
1caf38eb
RS
628 (sgml-value alist))
629 (setq i (length alist))
630 (while (> i 0)
631 (insert ? )
632 (insert (funcall skeleton-transformation
633 (setq attribute
634 (skeleton-read '(completing-read
d10447ba 635 "Attribute: "
1caf38eb
RS
636 alist)))))
637 (if (string= "" attribute)
638 (setq i 0)
aa7a8f0e 639 (sgml-value (assoc (downcase attribute) alist))
1caf38eb
RS
640 (setq i (1- i))))
641 (if (eq (preceding-char) ? )
642 (delete-backward-char 1)))
643 car)))
644
645(defun sgml-auto-attributes (arg)
f788776c
RS
646 "Self insert the character typed; at top level of tag, prompt for attributes.
647With prefix argument, only self insert."
1caf38eb
RS
648 (interactive "*P")
649 (let ((point (point))
650 tag)
651 (if (or arg
1caf38eb
RS
652 (not sgml-tag-alist) ; no message when nothing configured
653 (symbolp (setq tag (save-excursion (sgml-beginning-of-tag t))))
654 (eq (aref tag 0) ?/))
655 (self-insert-command (prefix-numeric-value arg))
656 (sgml-attributes tag)
657 (setq last-command-char ? )
658 (or (> (point) point)
659 (self-insert-command 1)))))
660
1caf38eb 661(defun sgml-tag-help (&optional tag)
f788776c 662 "Display description of tag TAG. If TAG is omitted, use the tag at point."
1caf38eb
RS
663 (interactive)
664 (or tag
665 (save-excursion
666 (if (eq (following-char) ?<)
667 (forward-char))
668 (setq tag (sgml-beginning-of-tag))))
669 (or (stringp tag)
670 (error "No tag selected"))
671 (setq tag (downcase tag))
f68f40e0 672 (message "%s"
aa7a8f0e 673 (or (cdr (assoc (downcase tag) sgml-tag-help))
1caf38eb 674 (and (eq (aref tag 0) ?/)
aa7a8f0e 675 (cdr (assoc (downcase (substring tag 1)) sgml-tag-help)))
1caf38eb
RS
676 "No description available")))
677
1c1d2eb6
SM
678(defun sgml-maybe-end-tag (&optional arg)
679 "Name self unless in position to end a tag or a prefix ARG is given."
680 (interactive "P")
681 (if (or arg (eq (car (sgml-lexical-context)) 'tag))
682 (self-insert-command (prefix-numeric-value arg))
683 (sgml-name-self)))
1caf38eb
RS
684
685(defun sgml-skip-tag-backward (arg)
686 "Skip to beginning of tag or matching opening tag if present.
f788776c 687With prefix argument ARG, repeat this ARG times."
1caf38eb
RS
688 (interactive "p")
689 (while (>= arg 1)
690 (search-backward "<" nil t)
691 (if (looking-at "</\\([^ \n\t>]+\\)")
692 ;; end tag, skip any nested pairs
693 (let ((case-fold-search t)
694 (re (concat "</?" (regexp-quote (match-string 1)))))
695 (while (and (re-search-backward re nil t)
696 (eq (char-after (1+ (point))) ?/))
697 (forward-char 1)
698 (sgml-skip-tag-backward 1))))
699 (setq arg (1- arg))))
700
701(defun sgml-skip-tag-forward (arg &optional return)
702 "Skip to end of tag or matching closing tag if present.
f788776c 703With prefix argument ARG, repeat this ARG times.
1caf38eb
RS
704Return t iff after a closing tag."
705 (interactive "p")
706 (setq return t)
707 (while (>= arg 1)
708 (skip-chars-forward "^<>")
709 (if (eq (following-char) ?>)
710 (up-list -1))
711 (if (looking-at "<\\([^/ \n\t>]+\\)")
712 ;; start tag, skip any nested same pairs _and_ closing tag
713 (let ((case-fold-search t)
714 (re (concat "</?" (regexp-quote (match-string 1))))
715 point close)
716 (forward-list 1)
717 (setq point (point))
718 (while (and (re-search-forward re nil t)
719 (not (setq close
720 (eq (char-after (1+ (match-beginning 0))) ?/)))
721 (not (up-list -1))
722 (sgml-skip-tag-forward 1))
723 (setq close nil))
724 (if close
725 (up-list 1)
726 (goto-char point)
727 (setq return)))
728 (forward-list 1))
729 (setq arg (1- arg)))
730 return)
731
732(defun sgml-delete-tag (arg)
733 "Delete tag on or after cursor, and matching closing or opening tag.
f788776c 734With prefix argument ARG, repeat this ARG times."
1caf38eb
RS
735 (interactive "p")
736 (while (>= arg 1)
737 (save-excursion
738 (let* (close open)
fcc3195e 739 (if (looking-at "[ \t\n]*<")
1caf38eb
RS
740 ;; just before tag
741 (if (eq (char-after (match-end 0)) ?/)
742 ;; closing tag
743 (progn
744 (setq close (point))
745 (goto-char (match-end 0))))
746 ;; on tag?
747 (or (save-excursion (setq close (sgml-beginning-of-tag)
748 close (and (stringp close)
749 (eq (aref close 0) ?/)
750 (point))))
751 ;; not on closing tag
752 (let ((point (point)))
753 (sgml-skip-tag-backward 1)
754 (if (or (not (eq (following-char) ?<))
755 (save-excursion
756 (forward-list 1)
757 (<= (point) point)))
758 (error "Not on or before tag")))))
759 (if close
760 (progn
761 (sgml-skip-tag-backward 1)
762 (setq open (point))
763 (goto-char close)
764 (kill-sexp 1))
765 (setq open (point))
766 (sgml-skip-tag-forward 1)
767 (backward-list)
768 (forward-char)
769 (if (eq (aref (sgml-beginning-of-tag) 0) ?/)
770 (kill-sexp 1)))
771 (goto-char open)
772 (kill-sexp 1)))
773 (setq arg (1- arg))))
9d4ce428 774
a391b179
RS
775\f
776;; Put read-only last to enable setting this even when read-only enabled.
777(or (get 'sgml-tag 'invisible)
778 (setplist 'sgml-tag
779 (append '(invisible t
780 intangible t
781 point-entered sgml-point-entered
782 rear-nonsticky t
783 read-only t)
784 (symbol-plist 'sgml-tag))))
1caf38eb
RS
785
786(defun sgml-tags-invisible (arg)
787 "Toggle visibility of existing tags."
788 (interactive "P")
789 (let ((modified (buffer-modified-p))
790 (inhibit-read-only t)
e1940c83
SM
791 (inhibit-modification-hooks t)
792 ;; Avoid spurious the `file-locked' checks.
793 (buffer-file-name nil)
a391b179
RS
794 ;; This is needed in case font lock gets called,
795 ;; since it moves point and might call sgml-point-entered.
64367655 796 ;; How could it get called? -stef
a391b179 797 (inhibit-point-motion-hooks t)
64367655 798 string)
e1940c83
SM
799 (unwind-protect
800 (save-excursion
801 (goto-char (point-min))
73d25e52
SM
802 (if (set (make-local-variable 'sgml-tags-invisible)
803 (if arg
804 (>= (prefix-numeric-value arg) 0)
805 (not sgml-tags-invisible)))
1c1d2eb6 806 (while (re-search-forward sgml-tag-name-re nil t)
64367655
SM
807 (setq string
808 (cdr (assq (intern-soft (downcase (match-string 1)))
809 sgml-display-text)))
e1940c83 810 (goto-char (match-beginning 0))
64367655 811 (and (stringp string)
e1940c83 812 (not (overlays-at (point)))
73d25e52
SM
813 (let ((ol (make-overlay (point) (match-beginning 1))))
814 (overlay-put ol 'before-string string)
815 (overlay-put ol 'sgml-tag t)))
e1940c83
SM
816 (put-text-property (point)
817 (progn (forward-list) (point))
818 'category 'sgml-tag))
64367655 819 (let ((pos (point-min)))
e1940c83 820 (while (< (setq pos (next-overlay-change pos)) (point-max))
73d25e52 821 (dolist (ol (overlays-at pos))
b2e8c203 822 (if (overlay-get ol 'sgml-tag)
73d25e52 823 (delete-overlay ol)))))
64367655 824 (remove-text-properties (point-min) (point-max) '(category nil))))
e1940c83 825 (restore-buffer-modified-p modified))
1caf38eb
RS
826 (run-hooks 'sgml-tags-invisible-hook)
827 (message "")))
828
829(defun sgml-point-entered (x y)
830 ;; Show preceding or following hidden tag, depending of cursor direction.
831 (let ((inhibit-point-motion-hooks t))
832 (save-excursion
833 (message "Invisible tag: %s"
e1940c83
SM
834 ;; Strip properties, otherwise, the text is invisible.
835 (buffer-substring-no-properties
1caf38eb
RS
836 (point)
837 (if (or (and (> x y)
838 (not (eq (following-char) ?<)))
839 (and (< x y)
840 (eq (preceding-char) ?>)))
841 (backward-list)
842 (forward-list)))))))
9d4ce428 843
a391b179 844\f
1caf38eb
RS
845(autoload 'compile-internal "compile")
846
72c0ae01
ER
847(defun sgml-validate (command)
848 "Validate an SGML document.
849Runs COMMAND, a shell command, in a separate process asynchronously
f788776c 850with output going to the buffer `*compilation*'.
72c0ae01
ER
851You can then use the command \\[next-error] to find the next error message
852and move to the line in the SGML document that caused it."
853 (interactive
854 (list (read-string "Validate command: "
855 (or sgml-saved-validate-command
856 (concat sgml-validate-command
857 " "
858 (let ((name (buffer-file-name)))
859 (and name
860 (file-name-nondirectory name))))))))
861 (setq sgml-saved-validate-command command)
b7cd1746 862 (save-some-buffers (not compilation-ask-about-save) nil)
c7aa4667 863 (compile-internal command "No more errors"))
72c0ae01 864
662deeab
MW
865(defsubst sgml-at-indentation-p ()
866 "Return true if point is at the first non-whitespace character on the line."
867 (save-excursion
868 (skip-chars-backward " \t")
869 (bolp)))
870
1c1d2eb6
SM
871(defun sgml-lexical-context (&optional limit)
872 "Return the lexical context at point as (TYPE . START).
873START is the location of the start of the lexical element.
2cfd19d4 874TYPE is one of `string', `comment', `tag', `cdata', or `text'.
1c1d2eb6 875
41bfcbee
MW
876Optional argument LIMIT is the position to start parsing from.
877If nil, start from a preceding tag at indentation."
1c1d2eb6
SM
878 (save-excursion
879 (let ((pos (point))
14614b6d 880 text-start state)
41bfcbee
MW
881 (if limit
882 (goto-char limit)
883 ;; Skip tags backwards until we find one at indentation
884 (while (and (ignore-errors (sgml-parse-tag-backward))
885 (not (sgml-at-indentation-p)))))
5f3d924d
SM
886 (with-syntax-table sgml-tag-syntax-table
887 (while (< (point) pos)
888 ;; When entering this loop we're inside text.
80fc318e 889 (setq text-start (point))
5f3d924d 890 (skip-chars-forward "^<" pos)
14614b6d
MW
891 (setq state
892 (cond
60128096 893 ((= (point) pos)
14614b6d
MW
894 ;; We got to the end without seeing a tag.
895 nil)
896 ((looking-at "<!\\[[A-Z]+\\[")
897 ;; We've found a CDATA section or similar.
898 (let ((cdata-start (point)))
899 (unless (search-forward "]]>" pos 'move)
900 (list 0 nil nil 'cdata nil nil nil nil cdata-start))))
901 (t
2871b07a 902 ;; We've reached a tag. Parse it.
14614b6d
MW
903 ;; FIXME: Handle net-enabling start-tags
904 (parse-partial-sexp (point) pos 0))))))
905 (cond
906 ((eq (nth 3 state) 'cdata) (cons 'cdata (nth 8 state)))
907 ((nth 3 state) (cons 'string (nth 8 state)))
908 ((nth 4 state) (cons 'comment (nth 8 state)))
909 ((and state (> (nth 0 state) 0)) (cons 'tag (nth 1 state)))
910 (t (cons 'text text-start))))))
1c1d2eb6 911
1caf38eb
RS
912(defun sgml-beginning-of-tag (&optional top-level)
913 "Skip to beginning of tag and return its name.
1c1d2eb6
SM
914If this can't be done, return nil."
915 (let ((context (sgml-lexical-context)))
916 (if (eq (car context) 'tag)
917 (progn
918 (goto-char (cdr context))
919 (when (looking-at sgml-tag-name-re)
920 (match-string-no-properties 1)))
921 (if top-level nil
3fb819e5 922 (when (not (eq (car context) 'text))
1c1d2eb6
SM
923 (goto-char (cdr context))
924 (sgml-beginning-of-tag t))))))
1caf38eb
RS
925
926(defun sgml-value (alist)
347ea557 927 "Interactively insert value taken from attribute-rule ALIST.
5950e029 928See `sgml-tag-alist' for info about attribute rules."
1caf38eb
RS
929 (setq alist (cdr alist))
930 (if (stringp (car alist))
931 (insert "=\"" (car alist) ?\")
a3ec4ba0 932 (if (and (eq (car alist) t) (not sgml-xml-mode))
5950e029 933 (when (cdr alist)
73d25e52
SM
934 (insert "=\"")
935 (setq alist (skeleton-read '(completing-read "Value: " (cdr alist))))
936 (if (string< "" alist)
937 (insert alist ?\")
938 (delete-backward-char 2)))
1caf38eb 939 (insert "=\"")
5950e029
SS
940 (when alist
941 (insert (skeleton-read '(completing-read "Value: " alist))))
1caf38eb 942 (insert ?\"))))
64367655
SM
943
944(defun sgml-quote (start end &optional unquotep)
7492ed8e
SM
945 "Quote SGML text in region START ... END.
946Only &, < and > are quoted, the rest is left untouched.
947With prefix argument UNQUOTEP, unquote the region."
948 (interactive "r\nP")
949 (save-restriction
950 (narrow-to-region start end)
951 (goto-char (point-min))
952 (if unquotep
953 ;; FIXME: We should unquote other named character references as well.
954 (while (re-search-forward
955 "\\(&\\(amp\\|\\(l\\|\\(g\\)\\)t\\)\\)[][<>&;\n\t \"%!'(),/=?]"
956 nil t)
957 (replace-match (if (match-end 4) ">" (if (match-end 3) "<" "&")) t t
958 nil (if (eq (char-before (match-end 0)) ?\;) 0 1)))
959 (while (re-search-forward "[&<>]" nil t)
960 (replace-match (cdr (assq (char-before) '((?& . "&amp;")
961 (?< . "&lt;")
962 (?> . "&gt;"))))
963 t t)))))
964
965(defun sgml-pretty-print (beg end)
966 "Simple-minded pretty printer for SGML.
967Re-indents the code and inserts newlines between BEG and END.
968You might want to turn on `auto-fill-mode' to get better results."
969 ;; TODO:
970 ;; - insert newline between some start-tag and text.
971 ;; - don't insert newline in front of some end-tags.
972 (interactive "r")
973 (save-excursion
974 (if (< beg end)
975 (goto-char beg)
976 (goto-char end)
977 (setq end beg)
978 (setq beg (point)))
979 ;; Don't use narrowing because it screws up auto-indent.
980 (setq end (copy-marker end t))
981 (with-syntax-table sgml-tag-syntax-table
982 (while (re-search-forward "<" end t)
983 (goto-char (match-beginning 0))
984 (unless (or ;;(looking-at "</")
985 (progn (skip-chars-backward " \t") (bolp)))
986 (reindent-then-newline-and-indent))
987 (forward-sexp 1)))
988 ;; (indent-region beg end)
989 ))
e1940c83 990
2394187c
SM
991\f
992;; Parsing
993
994(defstruct (sgml-tag
995 (:constructor sgml-make-tag (type start end name)))
996 type start end name)
997
998(defsubst sgml-parse-tag-name ()
999 "Skip past a tag-name, and return the name."
1000 (buffer-substring-no-properties
1001 (point) (progn (skip-syntax-forward "w_") (point))))
1002
41bfcbee
MW
1003(defsubst sgml-looking-back-at (str)
1004 "Return t if the test before point matches STR."
1005 (let ((start (- (point) (length str))))
80fc318e 1006 (and (>= start (point-min))
41bfcbee 1007 (equal str (buffer-substring-no-properties start (point))))))
2394187c
SM
1008
1009(defun sgml-parse-tag-backward ()
1010 "Parse an SGML tag backward, and return information about the tag.
1011Assume that parsing starts from within a textual context.
1012Leave point at the beginning of the tag."
1013 (let (tag-type tag-start tag-end name)
ca05be61
MW
1014 (or (search-backward ">" nil 'move)
1015 (error "No tag found"))
2394187c
SM
1016 (setq tag-end (1+ (point)))
1017 (cond
1018 ((sgml-looking-back-at "--") ; comment
1019 (setq tag-type 'comment
1020 tag-start (search-backward "<!--" nil t)))
1021 ((sgml-looking-back-at "]]") ; cdata
60128096 1022 (setq tag-type 'cdata
2cfd19d4 1023 tag-start (re-search-backward "<!\\[[A-Z]+\\[" nil t)))
2394187c
SM
1024 (t
1025 (setq tag-start
1026 (with-syntax-table sgml-tag-syntax-table
1027 (goto-char tag-end)
1028 (backward-sexp)
1029 (point)))
1030 (goto-char (1+ tag-start))
1031 (case (char-after)
1032 (?! ; declaration
1033 (setq tag-type 'decl))
1034 (?? ; processing-instruction
1035 (setq tag-type 'pi))
1036 (?/ ; close-tag
1037 (forward-char 1)
1038 (setq tag-type 'close
1039 name (sgml-parse-tag-name)))
f6ab0573
MW
1040 (?% ; JSP tags
1041 (setq tag-type 'jsp))
2394187c
SM
1042 (t ; open or empty tag
1043 (setq tag-type 'open
1044 name (sgml-parse-tag-name))
1045 (if (or (eq ?/ (char-before (- tag-end 1)))
1046 (sgml-empty-tag-p name))
1047 (setq tag-type 'empty))))))
1048 (goto-char tag-start)
1049 (sgml-make-tag tag-type tag-start tag-end name)))
1050
2394187c
SM
1051(defun sgml-get-context (&optional full)
1052 "Determine the context of the current position.
1053If FULL is `empty', return even if the context is empty (i.e.
1054we just skipped over some element and got to a beginning of line).
1055If FULL is non-nil, parse back to the beginning of the buffer, otherwise
1056parse until we find a start-tag as the first thing on a line.
1057
1058The context is a list of tag-info structures. The last one is the tag
1059immediately enclosing the current position."
1060 (let ((here (point))
1061 (ignore nil)
1062 (context nil)
1063 tag-info)
1064 ;; CONTEXT keeps track of the tag-stack
1065 ;; IGNORE keeps track of the nesting level of point relative to the
1066 ;; first (outermost) tag on the context. This is the list of
1067 ;; enclosing start-tags we'll have to ignore.
1068 (skip-chars-backward " \t\n") ; Make sure we're not at indentation.
1069 (while
2871b07a 1070 (and (or ignore
2394187c
SM
1071 (not (if full (eq full 'empty) context))
1072 (not (sgml-at-indentation-p))
1073 (and context
1074 (/= (point) (sgml-tag-start (car context)))
1075 (sgml-unclosed-tag-p (sgml-tag-name (car context)))))
1076 (setq tag-info (ignore-errors (sgml-parse-tag-backward))))
1077
1078 ;; This tag may enclose things we thought were tags. If so,
1079 ;; discard them.
1080 (while (and context
1081 (> (sgml-tag-end tag-info)
1082 (sgml-tag-end (car context))))
1083 (setq context (cdr context)))
7492ed8e 1084
2394187c
SM
1085 (cond
1086
2394187c
SM
1087 ;; start-tag
1088 ((eq (sgml-tag-type tag-info) 'open)
1089 (cond
1090 ((null ignore)
1091 (if (and context
1092 (sgml-unclosed-tag-p (sgml-tag-name tag-info))
1093 (eq t (compare-strings
1094 (sgml-tag-name tag-info) nil nil
1095 (sgml-tag-name (car context)) nil nil t)))
1096 ;; There was an implicit end-tag.
1097 nil
1098 (push tag-info context)))
1099 ((eq t (compare-strings (sgml-tag-name tag-info) nil nil
1100 (car ignore) nil nil t))
1101 (setq ignore (cdr ignore)))
1102 (t
1103 ;; The open and close tags don't match.
1104 (if (not sgml-xml-mode)
2394187c 1105 (unless (sgml-unclosed-tag-p (sgml-tag-name tag-info))
7492ed8e
SM
1106 (message "Unclosed tag <%s>" (sgml-tag-name tag-info))
1107 (let ((tmp ignore))
1108 ;; We could just assume that the tag is simply not closed
1109 ;; but it's a bad assumption when tags *are* closed but
1110 ;; not properly nested.
1111 (while (and (cdr tmp)
1112 (not (eq t (compare-strings
1113 (sgml-tag-name tag-info) nil nil
1114 (cadr tmp) nil nil t))))
1115 (setq tmp (cdr tmp)))
1116 (if (cdr tmp) (setcdr tmp (cddr tmp)))))
2394187c
SM
1117 (message "Unmatched tags <%s> and </%s>"
1118 (sgml-tag-name tag-info) (pop ignore))))))
1119
1120 ;; end-tag
1121 ((eq (sgml-tag-type tag-info) 'close)
1122 (if (sgml-empty-tag-p (sgml-tag-name tag-info))
1123 (message "Spurious </%s>: empty tag" (sgml-tag-name tag-info))
1124 (push (sgml-tag-name tag-info) ignore)))
1125 ))
1126
1127 ;; return context
1128 context))
1129
1130(defun sgml-show-context (&optional full)
1131 "Display the current context.
1132If FULL is non-nil, parse back to the beginning of the buffer."
1133 (interactive "P")
1134 (with-output-to-temp-buffer "*XML Context*"
7492ed8e
SM
1135 (save-excursion
1136 (let ((context (sgml-get-context)))
1137 (when full
1138 (let ((more nil))
1139 (while (setq more (sgml-get-context))
1140 (setq context (nconc more context)))))
1141 (pp context)))))
2394187c
SM
1142
1143\f
1144;; Editing shortcuts
1145
f6ab0573
MW
1146(defun sgml-close-tag ()
1147 "Insert an close-tag for the current element."
2394187c 1148 (interactive)
f6ab0573
MW
1149 (case (car (sgml-lexical-context))
1150 (comment (insert " -->"))
1151 (cdata (insert "]]>"))
1152 (pi (insert " ?>"))
1153 (jsp (insert " %>"))
1154 (tag (insert " />"))
1155 (text
1156 (let ((context (save-excursion (sgml-get-context))))
1157 (if context
2871b07a 1158 (progn
f6ab0573
MW
1159 (insert "</" (sgml-tag-name (car (last context))) ">")
1160 (indent-according-to-mode)))))
1161 (otherwise
1162 (error "Nothing to close"))))
2394187c 1163
347ea557
MW
1164(defun sgml-empty-tag-p (tag-name)
1165 "Return non-nil if TAG-NAME is an implicitly empty tag."
1166 (and (not sgml-xml-mode)
1167 (member-ignore-case tag-name sgml-empty-tags)))
1168
1169(defun sgml-unclosed-tag-p (tag-name)
1170 "Return non-nil if TAG-NAME is a tag for which an end-tag is optional."
1171 (and (not sgml-xml-mode)
1172 (member-ignore-case tag-name sgml-unclosed-tags)))
1173
1c1d2eb6
SM
1174(defun sgml-calculate-indent ()
1175 "Calculate the column to which this line should be indented."
1176 (let ((lcon (sgml-lexical-context)))
347ea557 1177
1c1d2eb6
SM
1178 ;; Indent comment-start markers inside <!-- just like comment-end markers.
1179 (if (and (eq (car lcon) 'tag)
1180 (looking-at "--")
1181 (save-excursion (goto-char (cdr lcon)) (looking-at "<!--")))
1182 (setq lcon (cons 'comment (+ (cdr lcon) 2))))
1183
1184 (case (car lcon)
347ea557 1185
1c1d2eb6
SM
1186 (string
1187 ;; Go back to previous non-empty line.
1188 (while (and (> (point) (cdr lcon))
1189 (zerop (forward-line -1))
1190 (looking-at "[ \t]*$")))
1191 (if (> (point) (cdr lcon))
1192 ;; Previous line is inside the string.
1193 (current-indentation)
1194 (goto-char (cdr lcon))
1195 (1+ (current-column))))
1196
1197 (comment
1198 (let ((mark (looking-at "--")))
1199 ;; Go back to previous non-empty line.
1200 (while (and (> (point) (cdr lcon))
1201 (zerop (forward-line -1))
1202 (or (looking-at "[ \t]*$")
1203 (if mark (not (looking-at "[ \t]*--"))))))
1204 (if (> (point) (cdr lcon))
1205 ;; Previous line is inside the comment.
1206 (skip-chars-forward " \t")
1207 (goto-char (cdr lcon)))
1208 (when (and (not mark) (looking-at "--"))
1209 (forward-char 2) (skip-chars-forward " \t"))
1210 (current-column)))
1211
80fc318e
MW
1212 (cdata
1213 (current-column))
1214
1c1d2eb6
SM
1215 (tag
1216 (goto-char (1+ (cdr lcon)))
1217 (skip-chars-forward "^ \t\n") ;Skip tag name.
1218 (skip-chars-forward " \t")
1219 (if (not (eolp))
1220 (current-column)
1221 ;; This is the first attribute: indent.
1222 (goto-char (1+ (cdr lcon)))
1223 (+ (current-column) sgml-basic-offset)))
1224
347ea557 1225 (text
1c1d2eb6
SM
1226 (while (looking-at "</")
1227 (forward-sexp 1)
1228 (skip-chars-forward " \t"))
3fb819e5
SM
1229 (let* ((here (point))
1230 (unclosed (and ;; (not sgml-xml-mode)
1231 (looking-at sgml-tag-name-re)
1232 (member-ignore-case (match-string 1)
1233 sgml-unclosed-tags)
1234 (match-string 1)))
1235 (context
1236 ;; If possible, align on the previous non-empty text line.
1237 ;; Otherwise, do a more serious parsing to find the
1238 ;; tag(s) relative to which we should be indenting.
1239 (if (and (not unclosed) (skip-chars-backward " \t")
1240 (< (skip-chars-backward " \t\n") 0)
1241 (back-to-indentation)
1242 (> (point) (cdr lcon)))
1243 nil
1244 (goto-char here)
2394187c 1245 (nreverse (sgml-get-context (if unclosed nil 'empty)))))
3fb819e5
SM
1246 (there (point)))
1247 ;; Ignore previous unclosed start-tag in context.
1248 (while (and context unclosed
1249 (eq t (compare-strings
2394187c 1250 (sgml-tag-name (car context)) nil nil
3fb819e5
SM
1251 unclosed nil nil t)))
1252 (setq context (cdr context)))
1253 ;; Indent to reflect nesting.
1254 (if (and context
2394187c 1255 (goto-char (sgml-tag-end (car context)))
3fb819e5 1256 (skip-chars-forward " \t\n")
2394187c 1257 (< (point) here) (sgml-at-indentation-p))
3fb819e5
SM
1258 (current-column)
1259 (goto-char there)
1260 (+ (current-column)
347ea557
MW
1261 (* sgml-basic-offset (length context))))))
1262
1263 (otherwise
1264 (error "Unrecognised context %s" (car lcon)))
1265
1266 )))
1c1d2eb6
SM
1267
1268(defun sgml-indent-line ()
1269 "Indent the current line as SGML."
1270 (interactive)
1271 (let* ((savep (point))
1272 (indent-col
1273 (save-excursion
5f3d924d 1274 (back-to-indentation)
1c1d2eb6 1275 (if (>= (point) savep) (setq savep nil))
1c1d2eb6
SM
1276 (sgml-calculate-indent))))
1277 (if savep
1278 (save-excursion (indent-line-to indent-col))
1279 (indent-line-to indent-col))))
1280
2871b07a
MW
1281(defun sgml-guess-indent ()
1282 "Guess an appropriate value for `sgml-basic-offset'.
1283Base the guessed identation level on the first indented tag in the buffer.
1284Add this to `sgml-mode-hook' for convenience."
1285 (interactive)
1286 (save-excursion
1287 (goto-char (point-min))
232dbe4f 1288 (if (re-search-forward "^\\([ \t]+\\)<" 500 'noerror)
2871b07a
MW
1289 (progn
1290 (set (make-local-variable 'sgml-basic-offset)
1c8438ab 1291 (1- (current-column)))
2871b07a
MW
1292 (message "Guessed sgml-basic-offset = %d"
1293 sgml-basic-offset)
1294 ))))
1295
5f3d924d
SM
1296(defun sgml-parse-dtd ()
1297 "Simplistic parse of the current buffer as a DTD.
1298Currently just returns (EMPTY-TAGS UNCLOSED-TAGS)."
1299 (goto-char (point-min))
1300 (let ((empty nil)
1301 (unclosed nil))
1302 (while (re-search-forward "<!ELEMENT[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+[-O][ \t\n]+\\([-O]\\)[ \t\n]+\\([^ \t\n]+\\)" nil t)
1303 (cond
1304 ((string= (match-string 3) "EMPTY")
1305 (push (match-string-no-properties 1) empty))
1306 ((string= (match-string 2) "O")
1307 (push (match-string-no-properties 1) unclosed))))
1308 (setq empty (sort (mapcar 'downcase empty) 'string<))
1309 (setq unclosed (sort (mapcar 'downcase unclosed) 'string<))
1310 (list empty unclosed)))
1311
e1940c83
SM
1312;;; HTML mode
1313
d4c89075
DL
1314(defcustom html-mode-hook nil
1315 "Hook run by command `html-mode'.
1316`text-mode-hook' and `sgml-mode-hook' are run first."
1317 :group 'sgml
1318 :type 'hook
1319 :options '(html-autoview-mode))
1320
fcc3195e 1321(defvar html-quick-keys sgml-quick-keys
b1e7bb48 1322 "Use C-c X combinations for quick insertion of frequent tags when non-nil.
fcc3195e 1323This defaults to `sgml-quick-keys'.
1caf38eb
RS
1324This takes effect when first loading the library.")
1325
1326(defvar html-mode-map
5f5c9e79 1327 (let ((map (make-sparse-keymap))
1caf38eb 1328 (menu-map (make-sparse-keymap "HTML")))
5f5c9e79 1329 (set-keymap-parent map sgml-mode-map)
7e49eef2
RS
1330 (define-key map "\C-c6" 'html-headline-6)
1331 (define-key map "\C-c5" 'html-headline-5)
1332 (define-key map "\C-c4" 'html-headline-4)
1333 (define-key map "\C-c3" 'html-headline-3)
1334 (define-key map "\C-c2" 'html-headline-2)
1335 (define-key map "\C-c1" 'html-headline-1)
fcc3195e
RS
1336 (define-key map "\C-c\r" 'html-paragraph)
1337 (define-key map "\C-c\n" 'html-line)
1338 (define-key map "\C-c\C-c-" 'html-horizontal-rule)
7e49eef2
RS
1339 (define-key map "\C-c\C-co" 'html-ordered-list)
1340 (define-key map "\C-c\C-cu" 'html-unordered-list)
fcc3195e
RS
1341 (define-key map "\C-c\C-cr" 'html-radio-buttons)
1342 (define-key map "\C-c\C-cc" 'html-checkboxes)
1343 (define-key map "\C-c\C-cl" 'html-list-item)
1344 (define-key map "\C-c\C-ch" 'html-href-anchor)
1345 (define-key map "\C-c\C-cn" 'html-name-anchor)
1346 (define-key map "\C-c\C-ci" 'html-image)
5950e029
SS
1347 (when html-quick-keys
1348 (define-key map "\C-c-" 'html-horizontal-rule)
1349 (define-key map "\C-co" 'html-ordered-list)
1350 (define-key map "\C-cu" 'html-unordered-list)
1351 (define-key map "\C-cr" 'html-radio-buttons)
1352 (define-key map "\C-cc" 'html-checkboxes)
1353 (define-key map "\C-cl" 'html-list-item)
1354 (define-key map "\C-ch" 'html-href-anchor)
1355 (define-key map "\C-cn" 'html-name-anchor)
1356 (define-key map "\C-ci" 'html-image))
1caf38eb
RS
1357 (define-key map "\C-c\C-s" 'html-autoview-mode)
1358 (define-key map "\C-c\C-v" 'browse-url-of-buffer)
1359 (define-key map [menu-bar html] (cons "HTML" menu-map))
1360 (define-key menu-map [html-autoview-mode]
1361 '("Toggle Autoviewing" . html-autoview-mode))
1362 (define-key menu-map [browse-url-of-buffer]
1363 '("View Buffer Contents" . browse-url-of-buffer))
1364 (define-key menu-map [nil] '("--"))
7e49eef2
RS
1365 ;;(define-key menu-map "6" '("Heading 6" . html-headline-6))
1366 ;;(define-key menu-map "5" '("Heading 5" . html-headline-5))
1367 ;;(define-key menu-map "4" '("Heading 4" . html-headline-4))
1368 (define-key menu-map "3" '("Heading 3" . html-headline-3))
1369 (define-key menu-map "2" '("Heading 2" . html-headline-2))
1370 (define-key menu-map "1" '("Heading 1" . html-headline-1))
1caf38eb 1371 (define-key menu-map "l" '("Radio Buttons" . html-radio-buttons))
fcc3195e 1372 (define-key menu-map "c" '("Checkboxes" . html-checkboxes))
1caf38eb 1373 (define-key menu-map "l" '("List Item" . html-list-item))
7e49eef2
RS
1374 (define-key menu-map "u" '("Unordered List" . html-unordered-list))
1375 (define-key menu-map "o" '("Ordered List" . html-ordered-list))
fcc3195e 1376 (define-key menu-map "-" '("Horizontal Rule" . html-horizontal-rule))
1caf38eb
RS
1377 (define-key menu-map "\n" '("Line Break" . html-line))
1378 (define-key menu-map "\r" '("Paragraph" . html-paragraph))
1379 (define-key menu-map "i" '("Image" . html-image))
1380 (define-key menu-map "h" '("Href Anchor" . html-href-anchor))
1381 (define-key menu-map "n" '("Name Anchor" . html-name-anchor))
1382 map)
1383 "Keymap for commands for use in HTML mode.")
1384
1caf38eb
RS
1385(defvar html-face-tag-alist
1386 '((bold . "b")
1387 (italic . "i")
1388 (underline . "u")
1389 (modeline . "rev"))
1390 "Value of `sgml-face-tag-alist' for HTML mode.")
1391
1392(defvar html-tag-face-alist
1393 '(("b" . bold)
1394 ("big" . bold)
1395 ("blink" . highlight)
1396 ("cite" . italic)
1397 ("em" . italic)
1398 ("h1" bold underline)
1399 ("h2" bold-italic underline)
1400 ("h3" italic underline)
1401 ("h4" . underline)
1402 ("h5" . underline)
1403 ("h6" . underline)
1404 ("i" . italic)
1405 ("rev" . modeline)
1406 ("s" . underline)
1407 ("small" . default)
1408 ("strong" . bold)
1409 ("title" bold underline)
1410 ("tt" . default)
1411 ("u" . underline)
1412 ("var" . italic))
1413 "Value of `sgml-tag-face-alist' for HTML mode.")
1414
1caf38eb
RS
1415(defvar html-display-text
1416 '((img . "[/]")
1417 (hr . "----------")
1418 (li . "o "))
1419 "Value of `sgml-display-text' for HTML mode.")
b4f05c38 1420
9d4ce428 1421\f
3bf0b727 1422;; should code exactly HTML 3 here when that is finished
1caf38eb 1423(defvar html-tag-alist
d10447ba 1424 (let* ((1-7 '(("1") ("2") ("3") ("4") ("5") ("6") ("7")))
e1940c83 1425 (1-9 `(,@1-7 ("8") ("9")))
1caf38eb
RS
1426 (align '(("align" ("left") ("center") ("right"))))
1427 (valign '(("top") ("middle") ("bottom") ("baseline")))
1428 (rel '(("next") ("previous") ("parent") ("subdocument") ("made")))
1429 (href '("href" ("ftp:") ("file:") ("finger:") ("gopher:") ("http:")
1430 ("mailto:") ("news:") ("rlogin:") ("telnet:") ("tn3270:")
fcc3195e 1431 ("wais:") ("/cgi-bin/")))
1caf38eb
RS
1432 (name '("name"))
1433 (link `(,href
1434 ("rel" ,@rel)
1435 ("rev" ,@rel)
1436 ("title")))
b4f05c38 1437 (list '((nil \n ("List item: " "<li>" str
a3ec4ba0 1438 (if sgml-xml-mode "</li>") \n))))
1caf38eb 1439 (cell `(t
e1940c83 1440 ,@align
1caf38eb
RS
1441 ("valign" ,@valign)
1442 ("colspan" ,@1-9)
1443 ("rowspan" ,@1-9)
1444 ("nowrap" t))))
1445 ;; put ,-expressions first, else byte-compile chokes (as of V19.29)
1446 ;; and like this it's more efficient anyway
1447 `(("a" ,name ,@link)
1448 ("base" t ,@href)
1449 ("dir" ,@list)
d10447ba 1450 ("font" nil "size" ("-1") ("+1") ("-2") ("+2") ,@1-7)
73d25e52 1451 ("form" (\n _ \n "<input type=\"submit\" value=\"\""
a3ec4ba0 1452 (if sgml-xml-mode "/>" ">"))
fcc3195e 1453 ("action" ,@(cdr href)) ("method" ("get") ("post")))
1caf38eb
RS
1454 ("h1" ,@align)
1455 ("h2" ,@align)
1456 ("h3" ,@align)
1457 ("h4" ,@align)
1458 ("h5" ,@align)
1459 ("h6" ,@align)
1460 ("hr" t ("size" ,@1-9) ("width") ("noshade" t) ,@align)
1461 ("img" t ("align" ,@valign ("texttop") ("absmiddle") ("absbottom"))
1462 ("src") ("alt") ("width" "1") ("height" "1")
1463 ("border" "1") ("vspace" "1") ("hspace" "1") ("ismap" t))
1464 ("input" t ("size" ,@1-9) ("maxlength" ,@1-9) ("checked" t) ,name
fcc3195e
RS
1465 ("type" ("text") ("password") ("checkbox") ("radio")
1466 ("submit") ("reset"))
1caf38eb
RS
1467 ("value"))
1468 ("link" t ,@link)
1469 ("menu" ,@list)
d10447ba 1470 ("ol" ,@list ("type" ("A") ("a") ("I") ("i") ("1")))
1caf38eb
RS
1471 ("p" t ,@align)
1472 ("select" (nil \n
1473 ("Text: "
a3ec4ba0 1474 "<option>" str (if sgml-xml-mode "</option>") \n))
1caf38eb
RS
1475 ,name ("size" ,@1-9) ("multiple" t))
1476 ("table" (nil \n
1477 ((completing-read "Cell kind: " '(("td") ("th"))
1478 nil t "t")
73d25e52 1479 "<tr><" str ?> _
a3ec4ba0 1480 (if sgml-xml-mode (concat "<" str "></tr>")) \n))
1caf38eb
RS
1481 ("border" t ,@1-9) ("width" "10") ("cellpadding"))
1482 ("td" ,@cell)
1483 ("textarea" ,name ("rows" ,@1-9) ("cols" ,@1-9))
1484 ("th" ,@cell)
d10447ba 1485 ("ul" ,@list ("type" ("disc") ("circle") ("square")))
1caf38eb
RS
1486
1487 ,@sgml-tag-alist
1488
1489 ("abbrev")
1490 ("acronym")
1491 ("address")
1492 ("array" (nil \n
a3ec4ba0 1493 ("Item: " "<item>" str (if sgml-xml-mode "</item>") \n))
1caf38eb
RS
1494 "align")
1495 ("au")
1496 ("b")
1497 ("big")
1498 ("blink")
1499 ("blockquote" \n)
1500 ("body" \n ("background" ".gif") ("bgcolor" "#") ("text" "#")
1501 ("link" "#") ("alink" "#") ("vlink" "#"))
a3ec4ba0 1502 ("box" (nil _ "<over>" _ (if sgml-xml-mode "</over>")))
1caf38eb
RS
1503 ("br" t ("clear" ("left") ("right")))
1504 ("caption" ("valign" ("top") ("bottom")))
1505 ("center" \n)
1506 ("cite")
1507 ("code" \n)
a3ec4ba0 1508 ("dd" ,(not sgml-xml-mode))
1caf38eb
RS
1509 ("del")
1510 ("dfn")
e1940c83 1511 ("div")
1caf38eb
RS
1512 ("dl" (nil \n
1513 ( "Term: "
a3ec4ba0
SM
1514 "<dt>" str (if sgml-xml-mode "</dt>")
1515 "<dd>" _ (if sgml-xml-mode "</dd>") \n)))
1516 ("dt" (t _ (if sgml-xml-mode "</dt>")
1517 "<dd>" (if sgml-xml-mode "</dd>") \n))
1caf38eb 1518 ("em")
d10447ba 1519 ;("fn" "id" "fn") ; ???
1caf38eb
RS
1520 ("head" \n)
1521 ("html" (\n
1522 "<head>\n"
1523 "<title>" (setq str (read-input "Title: ")) "</title>\n"
5e532c5c 1524 "</head>\n"
1caf38eb
RS
1525 "<body>\n<h1>" str "</h1>\n" _
1526 "\n<address>\n<a href=\"mailto:"
be047262 1527 user-mail-address
5e532c5c
RS
1528 "\">" (user-full-name) "</a>\n</address>\n"
1529 "</body>"
1530 ))
1caf38eb
RS
1531 ("i")
1532 ("ins")
1533 ("isindex" t ("action") ("prompt"))
1534 ("kbd")
1535 ("lang")
a3ec4ba0 1536 ("li" ,(not sgml-xml-mode))
1caf38eb
RS
1537 ("math" \n)
1538 ("nobr")
1539 ("option" t ("value") ("label") ("selected" t))
1540 ("over" t)
1541 ("person")
1542 ("pre" \n)
1543 ("q")
1544 ("rev")
1545 ("s")
1546 ("samp")
1547 ("small")
64367655
SM
1548 ("span" nil
1549 ("class"
1550 ("builtin")
1551 ("comment")
1552 ("constant")
1553 ("function-name")
1554 ("keyword")
1555 ("string")
1556 ("type")
1557 ("variable-name")
1558 ("warning")))
1caf38eb
RS
1559 ("strong")
1560 ("sub")
1561 ("sup")
1562 ("title")
1563 ("tr" t)
1564 ("tt")
1565 ("u")
1566 ("var")
1567 ("wbr" t)))
1568 "*Value of `sgml-tag-alist' for HTML mode.")
1569
1570(defvar html-tag-help
1571 `(,@sgml-tag-help
1572 ("a" . "Anchor of point or link elsewhere")
1573 ("abbrev" . "?")
1574 ("acronym" . "?")
1575 ("address" . "Formatted mail address")
1576 ("array" . "Math array")
1577 ("au" . "?")
1578 ("b" . "Bold face")
1579 ("base" . "Base address for URLs")
1580 ("big" . "Font size")
1581 ("blink" . "Blinking text")
1582 ("blockquote" . "Indented quotation")
1583 ("body" . "Document body")
1584 ("box" . "Math fraction")
1585 ("br" . "Line break")
1586 ("caption" . "Table caption")
1587 ("center" . "Centered text")
1588 ("changed" . "Change bars")
1589 ("cite" . "Citation of a document")
1590 ("code" . "Formatted source code")
1591 ("dd" . "Definition of term")
1592 ("del" . "?")
1593 ("dfn" . "?")
1594 ("dir" . "Directory list (obsolete)")
1595 ("dl" . "Definition list")
1596 ("dt" . "Term to be definined")
b4f05c38 1597 ("em" . "Emphasised")
1caf38eb
RS
1598 ("embed" . "Embedded data in foreign format")
1599 ("fig" . "Figure")
1600 ("figa" . "Figure anchor")
1601 ("figd" . "Figure description")
1602 ("figt" . "Figure text")
d10447ba 1603 ;("fn" . "?") ; ???
1caf38eb
RS
1604 ("font" . "Font size")
1605 ("form" . "Form with input fields")
1606 ("group" . "Document grouping")
1607 ("h1" . "Most important section headline")
1608 ("h2" . "Important section headline")
1609 ("h3" . "Section headline")
1610 ("h4" . "Minor section headline")
1611 ("h5" . "Unimportant section headline")
1612 ("h6" . "Least important section headline")
1613 ("head" . "Document header")
1614 ("hr" . "Horizontal rule")
1615 ("html" . "HTML Document")
1616 ("i" . "Italic face")
1617 ("img" . "Graphic image")
1618 ("input" . "Form input field")
1619 ("ins" . "?")
1620 ("isindex" . "Input field for index search")
1621 ("kbd" . "Keybard example face")
1622 ("lang" . "Natural language")
1623 ("li" . "List item")
1624 ("link" . "Link relationship")
1625 ("math" . "Math formula")
1626 ("menu" . "Menu list (obsolete)")
1627 ("mh" . "Form mail header")
1628 ("nextid" . "Allocate new id")
1629 ("nobr" . "Text without line break")
1630 ("ol" . "Ordered list")
1631 ("option" . "Selection list item")
1632 ("over" . "Math fraction rule")
1633 ("p" . "Paragraph start")
1634 ("panel" . "Floating panel")
1635 ("person" . "?")
1636 ("pre" . "Preformatted fixed width text")
1637 ("q" . "?")
1638 ("rev" . "Reverse video")
1639 ("s" . "?")
1640 ("samp" . "Sample text")
1641 ("select" . "Selection list")
1642 ("small" . "Font size")
1643 ("sp" . "Nobreak space")
1644 ("strong" . "Standout text")
1645 ("sub" . "Subscript")
1646 ("sup" . "Superscript")
1647 ("table" . "Table with rows and columns")
1648 ("tb" . "Table vertical break")
1649 ("td" . "Table data cell")
1650 ("textarea" . "Form multiline edit area")
1651 ("th" . "Table header cell")
1652 ("title" . "Document title")
1653 ("tr" . "Table row separator")
1654 ("tt" . "Typewriter face")
1655 ("u" . "Underlined text")
1656 ("ul" . "Unordered list")
1657 ("var" . "Math variable face")
1658 ("wbr" . "Enable <br> within <nobr>"))
1659"*Value of `sgml-tag-help' for HTML mode.")
9d4ce428 1660
3bf0b727 1661\f
1caf38eb 1662;;;###autoload
64367655 1663(define-derived-mode html-mode sgml-mode "HTML"
1caf38eb 1664 "Major mode based on SGML mode for editing HTML documents.
7be38f7d 1665This allows inserting skeleton constructs used in hypertext documents with
fcc3195e
RS
1666completion. See below for an introduction to HTML. Use
1667\\[browse-url-of-buffer] to see how this comes out. See also `sgml-mode' on
1668which this is based.
1caf38eb 1669
fcc3195e 1670Do \\[describe-variable] html- SPC and \\[describe-variable] sgml- SPC to see available variables.
1caf38eb
RS
1671
1672To write fairly well formatted pages you only need to know few things. Most
1673browsers have a function to read the source code of the page being seen, so
1674you can imitate various tricks. Here's a very short HTML primer which you
1675can also view with a browser to see what happens:
1676
1677<title>A Title Describing Contents</title> should be on every page. Pages can
1678have <h1>Very Major Headlines</h1> through <h6>Very Minor Headlines</h6>
1679<hr> Parts can be separated with horizontal rules.
1680
1681<p>Paragraphs only need an opening tag. Line breaks and multiple spaces are
1682ignored unless the text is <pre>preformatted.</pre> Text can be marked as
1683<b>bold</b>, <i>italic</i> or <u>underlined</u> using the normal M-g or
1684Edit/Text Properties/Face commands.
1685
1686Pages can have <a name=\"SOMENAME\">named points</a> and can link other points
1687to them with <a href=\"#SOMENAME\">see also somename</a>. In the same way <a
1688href=\"URL\">see also URL</a> where URL is a filename relative to current
f788776c 1689directory, or absolute as in `http://www.cs.indiana.edu/elisp/w3/docs.html'.
1caf38eb
RS
1690
1691Images in many formats can be inlined with <img src=\"URL\">.
1692
f788776c
RS
1693If you mainly create your own documents, `sgml-specials' might be
1694interesting. But note that some HTML 2 browsers can't handle `&apos;'.
1695To work around that, do:
1696 (eval-after-load \"sgml-mode\" '(aset sgml-char-names ?' nil))
1caf38eb 1697
1caf38eb 1698\\{html-mode-map}"
64367655
SM
1699 (set (make-local-variable 'sgml-display-text) html-display-text)
1700 (set (make-local-variable 'sgml-tag-face-alist) html-tag-face-alist)
1caf38eb
RS
1701 (make-local-variable 'sgml-tag-alist)
1702 (make-local-variable 'sgml-face-tag-alist)
1703 (make-local-variable 'sgml-tag-help)
1704 (make-local-variable 'outline-regexp)
1705 (make-local-variable 'outline-heading-end-regexp)
1706 (make-local-variable 'outline-level)
da84bdc4
RS
1707 (make-local-variable 'sentence-end)
1708 (setq sentence-end
b8b14971
DL
1709 (if sentence-end-double-space
1710 "[.?!][]\"')}]*\\(<[^>]*>\\)*\\($\\| $\\|\t\\| \\)[ \t\n]*"
64367655 1711 "[.?!][]\"')}]*\\(<[^>]*>\\)*\\($\\|[ \t]\\)[ \t\n]*"))
a01588fc 1712 (setq sgml-tag-alist html-tag-alist
1caf38eb
RS
1713 sgml-face-tag-alist html-face-tag-alist
1714 sgml-tag-help html-tag-help
1715 outline-regexp "^.*<[Hh][1-6]\\>"
1716 outline-heading-end-regexp "</[Hh][1-6]>"
1717 outline-level (lambda ()
0fda8eff 1718 (char-before (match-end 0))))
3bf0b727 1719 (setq imenu-create-index-function 'html-imenu-index)
a3ec4ba0 1720 (when sgml-xml-mode (setq mode-name "XHTML"))
73d25e52 1721 (set (make-local-variable 'sgml-empty-tags)
5f3d924d
SM
1722 ;; From HTML-4.01's loose.dtd, parsed with `sgml-parse-dtd',
1723 ;; plus manual addition of "wbr".
1724 '("area" "base" "basefont" "br" "col" "frame" "hr" "img" "input"
1725 "isindex" "link" "meta" "param" "wbr"))
1726 (set (make-local-variable 'sgml-unclosed-tags)
1727 ;; From HTML-4.01's loose.dtd, parsed with `sgml-parse-dtd'.
1728 '("body" "colgroup" "dd" "dt" "head" "html" "li" "option"
1729 "p" "tbody" "td" "tfoot" "th" "thead" "tr"))
e1940c83
SM
1730 ;; It's for the user to decide if it defeats it or not -stef
1731 ;; (make-local-variable 'imenu-sort-function)
1732 ;; (setq imenu-sort-function nil) ; sorting the menu defeats the purpose
64367655 1733 )
9d4ce428 1734
3bf0b727
RS
1735(defvar html-imenu-regexp
1736 "\\s-*<h\\([1-9]\\)[^\n<>]*>\\(<[^\n<>]*>\\)*\\s-*\\([^\n<>]*\\)"
1737 "*A regular expression matching a head line to be added to the menu.
1738The first `match-string' should be a number from 1-9.
1739The second `match-string' matches extra tags and is ignored.
1740The third `match-string' will be the used in the menu.")
1741
1742(defun html-imenu-index ()
1743 "Return an table of contents for an HTML buffer for use with Imenu."
1744 (let (toc-index)
1745 (save-excursion
1746 (goto-char (point-min))
1747 (while (re-search-forward html-imenu-regexp nil t)
1748 (setq toc-index
1749 (cons (cons (concat (make-string
1750 (* 2 (1- (string-to-number (match-string 1))))
1751 ?\ )
1752 (match-string 3))
5950e029 1753 (line-beginning-position))
3bf0b727
RS
1754 toc-index))))
1755 (nreverse toc-index)))
1caf38eb 1756
3bf0b727 1757(defun html-autoview-mode (&optional arg)
d4c89075 1758 "Toggle automatic viewing via `browse-url-of-buffer' upon saving buffer.
3bf0b727
RS
1759With positive prefix ARG always turns viewing on, with negative ARG always off.
1760Can be used as a value for `html-mode-hook'."
1761 (interactive "P")
1762 (if (setq arg (if arg
1763 (< (prefix-numeric-value arg) 0)
1764 (and (boundp 'after-save-hook)
1765 (memq 'browse-url-of-buffer after-save-hook))))
1766 (setq after-save-hook (delq 'browse-url-of-buffer after-save-hook))
3bf0b727
RS
1767 (add-hook 'after-save-hook 'browse-url-of-buffer nil t))
1768 (message "Autoviewing turned %s."
1769 (if arg "off" "on")))
9d4ce428 1770
3bf0b727 1771\f
1caf38eb
RS
1772(define-skeleton html-href-anchor
1773 "HTML anchor tag with href attribute."
a391b179
RS
1774 "URL: "
1775 '(setq input "http:")
1776 "<a href=\"" str "\">" _ "</a>")
1caf38eb
RS
1777
1778(define-skeleton html-name-anchor
1779 "HTML anchor tag with name attribute."
a391b179
RS
1780 "Name: "
1781 "<a name=\"" str "\">" _ "</a>")
1caf38eb 1782
7e49eef2
RS
1783(define-skeleton html-headline-1
1784 "HTML level 1 headline tags."
1785 nil
1786 "<h1>" _ "</h1>")
1787
1788(define-skeleton html-headline-2
1789 "HTML level 2 headline tags."
1790 nil
1791 "<h2>" _ "</h2>")
1792
1793(define-skeleton html-headline-3
1794 "HTML level 3 headline tags."
1795 nil
1796 "<h3>" _ "</h3>")
1797
1798(define-skeleton html-headline-4
1799 "HTML level 4 headline tags."
1800 nil
1801 "<h4>" _ "</h4>")
1802
1803(define-skeleton html-headline-5
1804 "HTML level 5 headline tags."
1805 nil
1806 "<h5>" _ "</h5>")
1807
1808(define-skeleton html-headline-6
1809 "HTML level 6 headline tags."
1810 nil
1811 "<h6>" _ "</h6>")
1caf38eb
RS
1812
1813(define-skeleton html-horizontal-rule
1814 "HTML horizontal rule tag."
1815 nil
a3ec4ba0 1816 (if sgml-xml-mode "<hr/>" "<hr>") \n)
1caf38eb
RS
1817
1818(define-skeleton html-image
1819 "HTML image tag."
1820 nil
b4f05c38 1821 "<img src=\"" _ "\""
a3ec4ba0 1822 (if sgml-xml-mode "/>" ">"))
1caf38eb
RS
1823
1824(define-skeleton html-line
1825 "HTML line break tag."
1826 nil
a3ec4ba0 1827 (if sgml-xml-mode "<br/>" "<br>") \n)
1caf38eb 1828
7e49eef2
RS
1829(define-skeleton html-ordered-list
1830 "HTML ordered list tags."
1831 nil
a391b179 1832 "<ol>" \n
a3ec4ba0 1833 "<li>" _ (if sgml-xml-mode "</li>") \n
7e49eef2
RS
1834 "</ol>")
1835
1836(define-skeleton html-unordered-list
1837 "HTML unordered list tags."
1838 nil
a391b179 1839 "<ul>" \n
a3ec4ba0 1840 "<li>" _ (if sgml-xml-mode "</li>") \n
7e49eef2 1841 "</ul>")
1caf38eb
RS
1842
1843(define-skeleton html-list-item
1844 "HTML list item tag."
1845 nil
1846 (if (bolp) nil '\n)
a3ec4ba0 1847 "<li>" _ (if sgml-xml-mode "</li>"))
1caf38eb
RS
1848
1849(define-skeleton html-paragraph
1850 "HTML paragraph tag."
1851 nil
1852 (if (bolp) nil ?\n)
a3ec4ba0 1853 \n "<p>" _ (if sgml-xml-mode "</p>"))
1caf38eb 1854
fcc3195e
RS
1855(define-skeleton html-checkboxes
1856 "Group of connected checkbox inputs."
1857 nil
a391b179
RS
1858 '(setq v1 nil
1859 v2 nil)
1860 ("Value: "
d10447ba 1861 "<input type=\"" (identity "checkbox") ; see comment above about identity
a391b179 1862 "\" name=\"" (or v1 (setq v1 (skeleton-read "Name: ")))
fcc3195e 1863 "\" value=\"" str ?\"
b4f05c38
SS
1864 (when (y-or-n-p "Set \"checked\" attribute? ")
1865 (funcall skeleton-transformation " checked"))
a3ec4ba0 1866 (if sgml-xml-mode "/>" ">")
a391b179
RS
1867 (skeleton-read "Text: " (capitalize str))
1868 (or v2 (setq v2 (if (y-or-n-p "Newline after text? ")
b4f05c38 1869 (funcall skeleton-transformation
a3ec4ba0 1870 (if sgml-xml-mode "<br/>" "<br>"))
a391b179
RS
1871 "")))
1872 \n))
fcc3195e 1873
1caf38eb
RS
1874(define-skeleton html-radio-buttons
1875 "Group of connected radio button inputs."
1876 nil
a391b179
RS
1877 '(setq v1 nil
1878 v2 (cons nil nil))
1879 ("Value: "
d10447ba 1880 "<input type=\"" (identity "radio") ; see comment above about identity
a391b179 1881 "\" name=\"" (or (car v2) (setcar v2 (skeleton-read "Name: ")))
1caf38eb 1882 "\" value=\"" str ?\"
b4f05c38
SS
1883 (when (and (not v1) (setq v1 (y-or-n-p "Set \"checked\" attribute? ")))
1884 (funcall skeleton-transformation " checked"))
a3ec4ba0 1885 (if sgml-xml-mode "/>" ">")
a391b179
RS
1886 (skeleton-read "Text: " (capitalize str))
1887 (or (cdr v2) (setcdr v2 (if (y-or-n-p "Newline after text? ")
b4f05c38 1888 (funcall skeleton-transformation
a3ec4ba0 1889 (if sgml-xml-mode "<br/>" "<br>"))
a391b179
RS
1890 "")))
1891 \n))
1caf38eb 1892
e1940c83 1893(provide 'sgml-mode)
6a05d05f 1894
72c0ae01 1895;;; sgml-mode.el ends here