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