*** empty log message ***
[emacs.git] / lisp / textmodes / sgml-mode.el
blob569f182367b9bcc0819c57fe0ca944a72f022343
1 ;;; sgml-mode.el --- SGML- and HTML-editing modes
3 ;; Copyright (C) 1992,95,96,98,2001,2002 Free Software Foundation, Inc.
5 ;; Author: James Clark <jjc@jclark.com>
6 ;; Maintainer: FSF
7 ;; Adapted-By: ESR, Daniel Pfeiffer <occitan@esperanto.org>,
8 ;; F.Potorti@cnuce.cnr.it
9 ;; Keywords: wp, hypermedia, comm, languages
11 ;; This file is part of GNU Emacs.
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
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
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.
23 ;; You should have received a copy of the GNU General Public License
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.
28 ;;; Commentary:
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.
34 ;;; Code:
36 (eval-when-compile
37 (require 'skeleton)
38 (require 'outline)
39 (require 'cl))
41 (defgroup sgml nil
42 "SGML editing mode"
43 :group 'languages)
45 (defcustom sgml-basic-offset 2
46 "*Specifies the basic indentation level for `sgml-indent-line'."
47 :type 'integer
48 :group 'sgml)
50 (defcustom sgml-transformation 'identity
51 "*Default value for `skeleton-transformation' (which see) in SGML mode."
52 :type 'function
53 :group 'sgml)
55 (put 'sgml-transformation 'variable-interactive
56 "aTransformation function: ")
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)
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.
67 (defvar sgml-specials '(?\")
68 "List of characters that have a special meaning for SGML mode.
69 This list is used when first loading the `sgml-mode' library.
70 The supported characters and potential disadvantages are:
72 ?\\\" Makes \" in text start a string.
73 ?' Makes ' in text start a string.
74 ?- Makes -- in text start a comment.
76 When only one of ?\\\" or ?' are included, \"'\" or '\"', as can be found in
77 DTDs, start a string. To partially avoid this problem this also makes these
78 self insert as named entities depending on `sgml-quick-keys'.
80 Including ?- has the problem of affecting dashes that have nothing to do
81 with comments, so we normally turn it off.")
83 (defvar sgml-quick-keys nil
84 "Use <, >, &, /, SPC and `sgml-specials' keys \"electrically\" when non-nil.
85 This takes effect when first loading the `sgml-mode' library.")
87 (defvar sgml-mode-map
88 (let ((map (make-keymap)) ;`sparse' doesn't allow binding to charsets.
89 (menu-map (make-sparse-keymap "SGML")))
90 (define-key map "\C-c\C-i" 'sgml-tags-invisible)
91 (define-key map "/" 'sgml-slash)
92 (define-key map "\C-c\C-n" 'sgml-name-char)
93 (define-key map "\C-c\C-t" 'sgml-tag)
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)
102 (define-key map "\C-c/" 'sgml-close-tag)
103 (define-key map "\C-c8" 'sgml-name-8bit-mode)
104 (define-key map "\C-c\C-v" 'sgml-validate)
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)))
114 (define-key map (vector (make-char 'latin-iso8859-1))
115 'sgml-maybe-name-self)
116 (let ((c 127)
117 (map (nth 1 map)))
118 (while (< (setq c (1+ c)) 256)
119 (aset map c 'sgml-maybe-name-self)))
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'.")
140 (defun sgml-make-syntax-table (specials)
141 (let ((table (make-syntax-table text-mode-syntax-table)))
142 (modify-syntax-entry ?< "(>" table)
143 (modify-syntax-entry ?> ")<" table)
144 (modify-syntax-entry ?: "_" table)
145 (modify-syntax-entry ?_ "_" table)
146 (modify-syntax-entry ?. "_" table)
147 (if (memq ?- specials)
148 (modify-syntax-entry ?- "_ 1234" table))
149 (if (memq ?\" specials)
150 (modify-syntax-entry ?\" "\"\"" table))
151 (if (memq ?' specials)
152 (modify-syntax-entry ?\' "\"'" table))
153 table))
155 (defvar sgml-mode-syntax-table (sgml-make-syntax-table sgml-specials)
156 "Syntax table used in SGML mode. See also `sgml-specials'.")
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.")
165 (defcustom sgml-name-8bit-mode nil
166 "*When non-nil, insert non-ASCII characters as named entities."
167 :type 'boolean
168 :group 'sgml)
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
175 "nbsp" "excl" "quot" "num" "dollar" "percnt" "amp" "apos"
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"
194 "cedil" "sup1" "ordm" "raquo" "frac14" "frac12" "frac34" "iquest"
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 `;'.")
205 (put 'sgml-table 'char-table-extra-slots 0)
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.
217 Currently, only Latin-1 characters are supported.")
219 ;; nsgmls is a free SGML parser in the SP suite available from
220 ;; ftp.jclark.com and otherwise packaged for GNU systems.
221 ;; Its error messages can be parsed by next-error.
222 ;; The -s option suppresses output.
224 (defcustom sgml-validate-command "nsgmls -s" ; replaced old `sgmls'
225 "*The command to validate an SGML document.
226 The file name of current buffer file name will be appended to this,
227 separated by a space."
228 :type 'string
229 :version "21.1"
230 :group 'sgml)
232 (defvar sgml-saved-validate-command nil
233 "The command last used to validate in this buffer.")
235 ;; I doubt that null end tags are used much for large elements,
236 ;; so use a small distance here.
237 (defcustom sgml-slash-distance 1000
238 "*If non-nil, is the maximum distance to search for matching `/'."
239 :type '(choice (const nil) integer)
240 :group 'sgml)
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)
246 "Regular expression that matches a non-empty start tag.
247 Any terminating `>' or `/' is not matched.")
250 ;; internal
251 (defconst sgml-font-lock-keywords-1
252 `((,(concat "<\\([!?]" sgml-name-re "\\)") 1 font-lock-keyword-face)
253 (,(concat "<\\(/?" sgml-name-re"\\)") 1 font-lock-function-name-face)
254 ;; FIXME: this doesn't cover the variables using a default value.
255 (,(concat "\\(" sgml-name-re "\\)=[\"']") 1 font-lock-variable-name-face)
256 (,(concat "[&%]" sgml-name-re ";?") . font-lock-variable-name-face)))
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))))))))
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
271 "*Rules for highlighting SGML code. See also `sgml-tag-face-alist'.")
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'.")
281 ;; internal
282 (defvar sgml-face-tag-alist ()
283 "Alist of face and tag name for facemenu.")
285 (defvar sgml-tag-face-alist ()
286 "Tag names and face or list of faces to fontify with when invisible.
287 When `font-lock-maximum-decoration' is 1 this is always used for fontifying.
288 When more these are fontified together with `sgml-font-lock-keywords'.")
290 (defvar sgml-display-text ()
291 "Tag names as lowercase symbols, and display string when invisible.")
293 ;; internal
294 (defvar sgml-tags-invisible nil)
296 (defcustom sgml-tag-alist
297 '(("![" ("ignore" t) ("include" t))
298 ("!attlist")
299 ("!doctype")
300 ("!element")
301 ("!entity"))
302 "*Alist of tag names for completing read and insertion rules.
303 This alist is made up as
305 ((\"tag\" . TAGRULE)
306 ...)
308 TAGRULE is a list of optionally t (no endtag) or `\\n' (separate endtag by
309 newlines) or a skeleton with nil, t or `\\n' in place of the interactor
310 followed by an ATTRIBUTERULE (for an always present attribute) or an
311 attribute alist.
313 The attribute alist is made up as
315 ((\"attribute\" . ATTRIBUTERULE)
316 ...)
318 ATTRIBUTERULE is a list of optionally t (no value when no input) followed by
319 an optional alist of possible values."
320 :type '(repeat (cons (string :tag "Tag Name")
321 (repeat :tag "Tag Rule" sexp)))
322 :group 'sgml)
324 (defcustom sgml-tag-help
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"))
331 "*Alist of tag name and short description."
332 :type '(repeat (cons (string :tag "Tag Name")
333 (string :tag "Description")))
334 :group 'sgml)
336 (defcustom sgml-xml-mode nil
337 "*When non-nil, tag insertion functions will be XML-compliant.
338 If this variable is customized, the custom value is used always.
339 Otherwise, it is set to be buffer-local when the file has
340 a DOCTYPE or an XML declaration."
341 :type 'boolean
342 :version "21.4"
343 :group 'sgml)
345 (defvar sgml-empty-tags nil
346 "List of tags whose !ELEMENT definition says EMPTY.")
348 (defvar sgml-unclosed-tags nil
349 "List of tags whose !ELEMENT definition says the end-tag is optional.")
351 (defun sgml-xml-guess ()
352 "Guess whether the current buffer is XML."
353 (save-excursion
354 (goto-char (point-min))
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))))
367 (defvar v2) ; free for skeleton
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)))
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)))
384 ;;;###autoload
385 (define-derived-mode sgml-mode text-mode "SGML"
386 "Major mode for editing SGML documents.
387 Makes > match <.
388 Keys <, &, SPC within <>, \", / and ' can be electric depending on
389 `sgml-quick-keys'.
391 An argument of N to a tag-inserting command means to wrap it around
392 the next N words. In Transient Mark mode, when the mark is active,
393 N defaults to -1, which means to wrap it around the current region.
395 If you like upcased tags, put (setq sgml-transformation 'upcase) in
396 your `.emacs' file.
398 Use \\[sgml-validate] to validate your document with an SGML parser.
400 Do \\[describe-variable] sgml- SPC to see available variables.
401 Do \\[describe-key] on the following bindings to discover what they do.
402 \\{sgml-mode-map}"
403 (make-local-variable 'sgml-saved-validate-command)
404 (make-local-variable 'facemenu-end-add-face)
405 ;;(make-local-variable 'facemenu-remove-face-function)
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.
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 "$"))
413 (set (make-local-variable 'adaptive-fill-regexp) "[ \t]*")
414 (set (make-local-variable 'indent-line-function) 'sgml-indent-line)
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)
418 (set (make-local-variable 'comment-line-break-function)
419 'sgml-comment-indent-new-line)
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)
436 (sgml-xml-guess)
437 (if sgml-xml-mode
438 (setq mode-name "XML")
439 (set (make-local-variable 'skeleton-transformation) sgml-transformation))
440 ;; This will allow existing comments within declarations to be
441 ;; recognized.
442 (set (make-local-variable 'comment-start-skip) "\\(?:<!\\)?--[ \t]*")
443 (set (make-local-variable 'comment-end-skip) "[ \t]*--\\([ \t\n]*>\\)?")
444 ;; This definition probably is not useful in derived modes.
445 (set (make-local-variable 'imenu-generic-expression)
446 (concat "<!\\(element\\|entity\\)[ \t\n]+%?[ \t\n]*\\("
447 sgml-name-re "\\)")))
449 ;; Some programs (such as Glade 2) generate XML which has
450 ;; -*- mode: xml -*-.
451 (defalias 'xml-mode 'sgml-mode)
453 (defun sgml-comment-indent ()
454 (if (looking-at "--") comment-column 0))
456 (defun sgml-slash (arg)
457 "Insert ARG slash characters.
458 Behaves 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)
468 (sgml-close-tag))
470 (sgml-slash-matching arg))))
472 (defun sgml-slash-matching (arg)
473 "Insert `/' and display any previous matching `/'.
474 Two `/'s are treated as matching if the first `/' ends a net-enabling
475 start tag, and the second `/' is the corresponding null end tag."
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)))
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)))))))
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)))))))))
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.
515 (defun sgml-name-char (&optional char)
516 "Insert a symbolic character name according to `sgml-char-names'.
517 Non-ASCII chars may be inserted either with the meta key, as in M-SPC for
518 no-break space or M-- for a soft hyphen; or via an input method or
519 encoded keyboard operation."
520 (interactive "*")
521 (insert ?&)
522 (or char
523 (setq char (read-quoted-char "Enter char or octal number")))
524 (delete-backward-char 1)
525 (insert char)
526 (undo-boundary)
527 (delete-backward-char 1)
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) ?\;))
536 ((let ((c (encode-char char 'ucs)))
537 (when c
538 (insert (format "&#%d;" c))
539 t)))
540 (t ; should be an error? -- fx
541 (insert char))))
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))
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
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))
557 (self-insert-command 1)))
559 (defun sgml-name-8bit-mode ()
560 "Toggle whether to insert named entities instead of non-ASCII characters.
561 This only works for Latin-1 input."
562 (interactive)
563 (setq sgml-name-8bit-mode (not sgml-name-8bit-mode))
564 (message "sgml name entity mode is now %s"
565 (if sgml-name-8bit-mode "ON" "OFF")))
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").
572 (define-skeleton sgml-tag
573 "Prompt for a tag and insert it, optionally with attributes.
574 Completion and configuration are done according to `sgml-tag-alist'.
575 If you like tags and attributes in uppercase do \\[set-variable]
576 skeleton-transformation RET upcase RET, or put this in your `.emacs':
577 (setq sgml-transformation 'upcase)"
578 (funcall (or skeleton-transformation 'identity)
579 (completing-read "Tag: " sgml-tag-alist))
580 ?< str |
581 (("") -1 '(undo-boundary) (identity "&lt;")) | ; see comment above
582 `(("") '(setq v2 (sgml-attributes ,str t)) ?>
583 (cond
584 ((string= "![" ,str)
585 (backward-char)
586 '(("") " [ " _ " ]]"))
587 ((and (eq v2 t) sgml-xml-mode (member ,str sgml-empty-tags))
588 '(("") -1 "/>"))
589 ((or (and (eq v2 t) (not sgml-xml-mode)) (string-match "^[/!?]" ,str))
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)))
601 (append '(("") (car v2))
602 (cdr v2)
603 '(resume: (car v2) _ "</" (identity ',str) ?>))))))
605 (autoload 'skeleton-read "skeleton")
607 (defun sgml-attributes (tag &optional quiet)
608 "When at top level of a tag, interactively insert attributes.
610 Completion and configuration of TAG are done according to `sgml-tag-alist'.
611 If QUIET, do not print a message when there are no attributes for TAG."
612 (interactive (list (save-excursion (sgml-beginning-of-tag t))))
613 (or (stringp tag) (error "Wrong context for adding attribute"))
614 (if tag
615 (let ((completion-ignore-case t)
616 (alist (cdr (assoc (downcase tag) sgml-tag-alist)))
617 car attribute i)
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
626 (insert (if (eq (preceding-char) ? ) "" ? )
627 (funcall skeleton-transformation (car alist)))
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
635 "Attribute: "
636 alist)))))
637 (if (string= "" attribute)
638 (setq i 0)
639 (sgml-value (assoc (downcase attribute) alist))
640 (setq i (1- i))))
641 (if (eq (preceding-char) ? )
642 (delete-backward-char 1)))
643 car)))
645 (defun sgml-auto-attributes (arg)
646 "Self insert the character typed; at top level of tag, prompt for attributes.
647 With prefix argument, only self insert."
648 (interactive "*P")
649 (let ((point (point))
650 tag)
651 (if (or arg
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)))))
661 (defun sgml-tag-help (&optional tag)
662 "Display description of tag TAG. If TAG is omitted, use the tag at point."
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))
672 (message "%s"
673 (or (cdr (assoc (downcase tag) sgml-tag-help))
674 (and (eq (aref tag 0) ?/)
675 (cdr (assoc (downcase (substring tag 1)) sgml-tag-help)))
676 "No description available")))
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)))
685 (defun sgml-skip-tag-backward (arg)
686 "Skip to beginning of tag or matching opening tag if present.
687 With prefix argument ARG, repeat this ARG times."
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 ;; Ignore empty tags like <foo/>.
696 "\\([^>]*[^/>]\\)?>")))
697 (while (and (re-search-backward re nil t)
698 (eq (char-after (1+ (point))) ?/))
699 (forward-char 1)
700 (sgml-skip-tag-backward 1))))
701 (setq arg (1- arg))))
703 (defun sgml-skip-tag-forward (arg)
704 "Skip to end of tag or matching closing tag if present.
705 With prefix argument ARG, repeat this ARG times.
706 Return t iff after a closing tag."
707 (interactive "p")
708 (let ((return t))
709 (while (>= arg 1)
710 (skip-chars-forward "^<>")
711 (if (eq (following-char) ?>)
712 (up-list -1))
713 (if (looking-at "<\\([^/ \n\t>]+\\)\\([^>]*[^/>]\\)?>")
714 ;; start tag, skip any nested same pairs _and_ closing tag
715 (let ((case-fold-search t)
716 (re (concat "</?" (regexp-quote (match-string 1))
717 ;; Ignore empty tags like <foo/>.
718 "\\([^>]*[^/>]\\)?>"))
719 point close)
720 (forward-list 1)
721 (setq point (point))
722 (while (and (re-search-forward re nil t)
723 (not (setq close
724 (eq (char-after (1+ (match-beginning 0))) ?/)))
725 (goto-char (match-beginning 0))
726 (sgml-skip-tag-forward 1))
727 (setq close nil))
728 (unless close
729 (goto-char point)
730 (setq return nil)))
731 (forward-list 1))
732 (setq arg (1- arg)))
733 return))
735 (defun sgml-delete-tag (arg)
736 "Delete tag on or after cursor, and matching closing or opening tag.
737 With prefix argument ARG, repeat this ARG times."
738 (interactive "p")
739 (while (>= arg 1)
740 (save-excursion
741 (let* (close open)
742 (if (looking-at "[ \t\n]*<")
743 ;; just before tag
744 (if (eq (char-after (match-end 0)) ?/)
745 ;; closing tag
746 (progn
747 (setq close (point))
748 (goto-char (match-end 0))))
749 ;; on tag?
750 (or (save-excursion (setq close (sgml-beginning-of-tag)
751 close (and (stringp close)
752 (eq (aref close 0) ?/)
753 (point))))
754 ;; not on closing tag
755 (let ((point (point)))
756 (sgml-skip-tag-backward 1)
757 (if (or (not (eq (following-char) ?<))
758 (save-excursion
759 (forward-list 1)
760 (<= (point) point)))
761 (error "Not on or before tag")))))
762 (if close
763 (progn
764 (sgml-skip-tag-backward 1)
765 (setq open (point))
766 (goto-char close)
767 (kill-sexp 1))
768 (setq open (point))
769 (sgml-skip-tag-forward 1)
770 (backward-list)
771 (forward-char)
772 (if (eq (aref (sgml-beginning-of-tag) 0) ?/)
773 (kill-sexp 1)))
774 (goto-char open)
775 (kill-sexp 1)))
776 (setq arg (1- arg))))
779 ;; Put read-only last to enable setting this even when read-only enabled.
780 (or (get 'sgml-tag 'invisible)
781 (setplist 'sgml-tag
782 (append '(invisible t
783 intangible t
784 point-entered sgml-point-entered
785 rear-nonsticky t
786 read-only t)
787 (symbol-plist 'sgml-tag))))
789 (defun sgml-tags-invisible (arg)
790 "Toggle visibility of existing tags."
791 (interactive "P")
792 (let ((modified (buffer-modified-p))
793 (inhibit-read-only t)
794 (inhibit-modification-hooks t)
795 ;; Avoid spurious the `file-locked' checks.
796 (buffer-file-name nil)
797 ;; This is needed in case font lock gets called,
798 ;; since it moves point and might call sgml-point-entered.
799 ;; How could it get called? -stef
800 (inhibit-point-motion-hooks t)
801 string)
802 (unwind-protect
803 (save-excursion
804 (goto-char (point-min))
805 (if (set (make-local-variable 'sgml-tags-invisible)
806 (if arg
807 (>= (prefix-numeric-value arg) 0)
808 (not sgml-tags-invisible)))
809 (while (re-search-forward sgml-tag-name-re nil t)
810 (setq string
811 (cdr (assq (intern-soft (downcase (match-string 1)))
812 sgml-display-text)))
813 (goto-char (match-beginning 0))
814 (and (stringp string)
815 (not (overlays-at (point)))
816 (let ((ol (make-overlay (point) (match-beginning 1))))
817 (overlay-put ol 'before-string string)
818 (overlay-put ol 'sgml-tag t)))
819 (put-text-property (point)
820 (progn (forward-list) (point))
821 'category 'sgml-tag))
822 (let ((pos (point-min)))
823 (while (< (setq pos (next-overlay-change pos)) (point-max))
824 (dolist (ol (overlays-at pos))
825 (if (overlay-get ol 'sgml-tag)
826 (delete-overlay ol)))))
827 (remove-text-properties (point-min) (point-max) '(category nil))))
828 (restore-buffer-modified-p modified))
829 (run-hooks 'sgml-tags-invisible-hook)
830 (message "")))
832 (defun sgml-point-entered (x y)
833 ;; Show preceding or following hidden tag, depending of cursor direction.
834 (let ((inhibit-point-motion-hooks t))
835 (save-excursion
836 (message "Invisible tag: %s"
837 ;; Strip properties, otherwise, the text is invisible.
838 (buffer-substring-no-properties
839 (point)
840 (if (or (and (> x y)
841 (not (eq (following-char) ?<)))
842 (and (< x y)
843 (eq (preceding-char) ?>)))
844 (backward-list)
845 (forward-list)))))))
848 (autoload 'compile-internal "compile")
850 (defun sgml-validate (command)
851 "Validate an SGML document.
852 Runs COMMAND, a shell command, in a separate process asynchronously
853 with output going to the buffer `*compilation*'.
854 You can then use the command \\[next-error] to find the next error message
855 and move to the line in the SGML document that caused it."
856 (interactive
857 (list (read-string "Validate command: "
858 (or sgml-saved-validate-command
859 (concat sgml-validate-command
861 (let ((name (buffer-file-name)))
862 (and name
863 (file-name-nondirectory name))))))))
864 (setq sgml-saved-validate-command command)
865 (save-some-buffers (not compilation-ask-about-save) nil)
866 (compile-internal command "No more errors"))
868 (defsubst sgml-at-indentation-p ()
869 "Return true if point is at the first non-whitespace character on the line."
870 (save-excursion
871 (skip-chars-backward " \t")
872 (bolp)))
874 (defun sgml-lexical-context (&optional limit)
875 "Return the lexical context at point as (TYPE . START).
876 START is the location of the start of the lexical element.
877 TYPE is one of `string', `comment', `tag', `cdata', or `text'.
879 Optional argument LIMIT is the position to start parsing from.
880 If nil, start from a preceding tag at indentation."
881 (save-excursion
882 (let ((pos (point))
883 text-start state)
884 (if limit
885 (goto-char limit)
886 ;; Skip tags backwards until we find one at indentation
887 (while (and (ignore-errors (sgml-parse-tag-backward))
888 (not (sgml-at-indentation-p)))))
889 (with-syntax-table sgml-tag-syntax-table
890 (while (< (point) pos)
891 ;; When entering this loop we're inside text.
892 (setq text-start (point))
893 (skip-chars-forward "^<" pos)
894 (setq state
895 (cond
896 ((= (point) pos)
897 ;; We got to the end without seeing a tag.
898 nil)
899 ((looking-at "<!\\[[A-Z]+\\[")
900 ;; We've found a CDATA section or similar.
901 (let ((cdata-start (point)))
902 (unless (search-forward "]]>" pos 'move)
903 (list 0 nil nil 'cdata nil nil nil nil cdata-start))))
905 ;; We've reached a tag. Parse it.
906 ;; FIXME: Handle net-enabling start-tags
907 (parse-partial-sexp (point) pos 0))))))
908 (cond
909 ((eq (nth 3 state) 'cdata) (cons 'cdata (nth 8 state)))
910 ((nth 3 state) (cons 'string (nth 8 state)))
911 ((nth 4 state) (cons 'comment (nth 8 state)))
912 ((and state (> (nth 0 state) 0)) (cons 'tag (nth 1 state)))
913 (t (cons 'text text-start))))))
915 (defun sgml-beginning-of-tag (&optional top-level)
916 "Skip to beginning of tag and return its name.
917 If this can't be done, return nil."
918 (let ((context (sgml-lexical-context)))
919 (if (eq (car context) 'tag)
920 (progn
921 (goto-char (cdr context))
922 (when (looking-at sgml-tag-name-re)
923 (match-string-no-properties 1)))
924 (if top-level nil
925 (when (not (eq (car context) 'text))
926 (goto-char (cdr context))
927 (sgml-beginning-of-tag t))))))
929 (defun sgml-value (alist)
930 "Interactively insert value taken from attribute-rule ALIST.
931 See `sgml-tag-alist' for info about attribute rules."
932 (setq alist (cdr alist))
933 (if (stringp (car alist))
934 (insert "=\"" (car alist) ?\")
935 (if (and (eq (car alist) t) (not sgml-xml-mode))
936 (when (cdr alist)
937 (insert "=\"")
938 (setq alist (skeleton-read '(completing-read "Value: " (cdr alist))))
939 (if (string< "" alist)
940 (insert alist ?\")
941 (delete-backward-char 2)))
942 (insert "=\"")
943 (when alist
944 (insert (skeleton-read '(completing-read "Value: " alist))))
945 (insert ?\"))))
947 (defun sgml-quote (start end &optional unquotep)
948 "Quote SGML text in region START ... END.
949 Only &, < and > are quoted, the rest is left untouched.
950 With prefix argument UNQUOTEP, unquote the region."
951 (interactive "r\nP")
952 (save-restriction
953 (narrow-to-region start end)
954 (goto-char (point-min))
955 (if unquotep
956 ;; FIXME: We should unquote other named character references as well.
957 (while (re-search-forward
958 "\\(&\\(amp\\|\\(l\\|\\(g\\)\\)t\\)\\)[][<>&;\n\t \"%!'(),/=?]"
959 nil t)
960 (replace-match (if (match-end 4) ">" (if (match-end 3) "<" "&")) t t
961 nil (if (eq (char-before (match-end 0)) ?\;) 0 1)))
962 (while (re-search-forward "[&<>]" nil t)
963 (replace-match (cdr (assq (char-before) '((?& . "&amp;")
964 (?< . "&lt;")
965 (?> . "&gt;"))))
966 t t)))))
968 (defun sgml-pretty-print (beg end)
969 "Simple-minded pretty printer for SGML.
970 Re-indents the code and inserts newlines between BEG and END.
971 You might want to turn on `auto-fill-mode' to get better results."
972 ;; TODO:
973 ;; - insert newline between some start-tag and text.
974 ;; - don't insert newline in front of some end-tags.
975 (interactive "r")
976 (save-excursion
977 (if (< beg end)
978 (goto-char beg)
979 (goto-char end)
980 (setq end beg)
981 (setq beg (point)))
982 ;; Don't use narrowing because it screws up auto-indent.
983 (setq end (copy-marker end t))
984 (with-syntax-table sgml-tag-syntax-table
985 (while (re-search-forward "<" end t)
986 (goto-char (match-beginning 0))
987 (unless (or ;;(looking-at "</")
988 (progn (skip-chars-backward " \t") (bolp)))
989 (reindent-then-newline-and-indent))
990 (forward-sexp 1)))
991 ;; (indent-region beg end)
995 ;; Parsing
997 (defstruct (sgml-tag
998 (:constructor sgml-make-tag (type start end name)))
999 type start end name)
1001 (defsubst sgml-parse-tag-name ()
1002 "Skip past a tag-name, and return the name."
1003 (buffer-substring-no-properties
1004 (point) (progn (skip-syntax-forward "w_") (point))))
1006 (defsubst sgml-looking-back-at (str)
1007 "Return t if the test before point matches STR."
1008 (let ((start (- (point) (length str))))
1009 (and (>= start (point-min))
1010 (equal str (buffer-substring-no-properties start (point))))))
1012 (defun sgml-parse-tag-backward ()
1013 "Parse an SGML tag backward, and return information about the tag.
1014 Assume that parsing starts from within a textual context.
1015 Leave point at the beginning of the tag."
1016 (let (tag-type tag-start tag-end name)
1017 (or (search-backward ">" nil 'move)
1018 (error "No tag found"))
1019 (setq tag-end (1+ (point)))
1020 (cond
1021 ((sgml-looking-back-at "--") ; comment
1022 (setq tag-type 'comment
1023 tag-start (search-backward "<!--" nil t)))
1024 ((sgml-looking-back-at "]]") ; cdata
1025 (setq tag-type 'cdata
1026 tag-start (re-search-backward "<!\\[[A-Z]+\\[" nil t)))
1028 (setq tag-start
1029 (with-syntax-table sgml-tag-syntax-table
1030 (goto-char tag-end)
1031 (backward-sexp)
1032 (point)))
1033 (goto-char (1+ tag-start))
1034 (case (char-after)
1035 (?! ; declaration
1036 (setq tag-type 'decl))
1037 (?? ; processing-instruction
1038 (setq tag-type 'pi))
1039 (?/ ; close-tag
1040 (forward-char 1)
1041 (setq tag-type 'close
1042 name (sgml-parse-tag-name)))
1043 (?% ; JSP tags
1044 (setq tag-type 'jsp))
1045 (t ; open or empty tag
1046 (setq tag-type 'open
1047 name (sgml-parse-tag-name))
1048 (if (or (eq ?/ (char-before (- tag-end 1)))
1049 (sgml-empty-tag-p name))
1050 (setq tag-type 'empty))))))
1051 (goto-char tag-start)
1052 (sgml-make-tag tag-type tag-start tag-end name)))
1054 (defun sgml-get-context (&optional full)
1055 "Determine the context of the current position.
1056 If FULL is `empty', return even if the context is empty (i.e.
1057 we just skipped over some element and got to a beginning of line).
1058 If FULL is non-nil, parse back to the beginning of the buffer, otherwise
1059 parse until we find a start-tag as the first thing on a line.
1061 The context is a list of tag-info structures. The last one is the tag
1062 immediately enclosing the current position."
1063 (let ((here (point))
1064 (ignore nil)
1065 (context nil)
1066 tag-info)
1067 ;; CONTEXT keeps track of the tag-stack
1068 ;; IGNORE keeps track of the nesting level of point relative to the
1069 ;; first (outermost) tag on the context. This is the list of
1070 ;; enclosing start-tags we'll have to ignore.
1071 (skip-chars-backward " \t\n") ; Make sure we're not at indentation.
1072 (while
1073 (and (or ignore
1074 (not (if full (eq full 'empty) context))
1075 (not (sgml-at-indentation-p))
1076 (and context
1077 (/= (point) (sgml-tag-start (car context)))
1078 (sgml-unclosed-tag-p (sgml-tag-name (car context)))))
1079 (setq tag-info (ignore-errors (sgml-parse-tag-backward))))
1081 ;; This tag may enclose things we thought were tags. If so,
1082 ;; discard them.
1083 (while (and context
1084 (> (sgml-tag-end tag-info)
1085 (sgml-tag-end (car context))))
1086 (setq context (cdr context)))
1088 (cond
1090 ;; start-tag
1091 ((eq (sgml-tag-type tag-info) 'open)
1092 (cond
1093 ((null ignore)
1094 (if (and context
1095 (sgml-unclosed-tag-p (sgml-tag-name tag-info))
1096 (eq t (compare-strings
1097 (sgml-tag-name tag-info) nil nil
1098 (sgml-tag-name (car context)) nil nil t)))
1099 ;; There was an implicit end-tag.
1101 (push tag-info context)))
1102 ((eq t (compare-strings (sgml-tag-name tag-info) nil nil
1103 (car ignore) nil nil t))
1104 (setq ignore (cdr ignore)))
1106 ;; The open and close tags don't match.
1107 (if (not sgml-xml-mode)
1108 (unless (sgml-unclosed-tag-p (sgml-tag-name tag-info))
1109 (message "Unclosed tag <%s>" (sgml-tag-name tag-info))
1110 (let ((tmp ignore))
1111 ;; We could just assume that the tag is simply not closed
1112 ;; but it's a bad assumption when tags *are* closed but
1113 ;; not properly nested.
1114 (while (and (cdr tmp)
1115 (not (eq t (compare-strings
1116 (sgml-tag-name tag-info) nil nil
1117 (cadr tmp) nil nil t))))
1118 (setq tmp (cdr tmp)))
1119 (if (cdr tmp) (setcdr tmp (cddr tmp)))))
1120 (message "Unmatched tags <%s> and </%s>"
1121 (sgml-tag-name tag-info) (pop ignore))))))
1123 ;; end-tag
1124 ((eq (sgml-tag-type tag-info) 'close)
1125 (if (sgml-empty-tag-p (sgml-tag-name tag-info))
1126 (message "Spurious </%s>: empty tag" (sgml-tag-name tag-info))
1127 (push (sgml-tag-name tag-info) ignore)))
1130 ;; return context
1131 context))
1133 (defun sgml-show-context (&optional full)
1134 "Display the current context.
1135 If FULL is non-nil, parse back to the beginning of the buffer."
1136 (interactive "P")
1137 (with-output-to-temp-buffer "*XML Context*"
1138 (save-excursion
1139 (let ((context (sgml-get-context)))
1140 (when full
1141 (let ((more nil))
1142 (while (setq more (sgml-get-context))
1143 (setq context (nconc more context)))))
1144 (pp context)))))
1147 ;; Editing shortcuts
1149 (defun sgml-close-tag ()
1150 "Insert a close-tag for the current element."
1151 (interactive)
1152 (case (car (sgml-lexical-context))
1153 (comment (insert " -->"))
1154 (cdata (insert "]]>"))
1155 (pi (insert " ?>"))
1156 (jsp (insert " %>"))
1157 (tag (insert " />"))
1158 (text
1159 (let ((context (save-excursion (sgml-get-context))))
1160 (if context
1161 (progn
1162 (insert "</" (sgml-tag-name (car (last context))) ">")
1163 (indent-according-to-mode)))))
1164 (otherwise
1165 (error "Nothing to close"))))
1167 (defun sgml-empty-tag-p (tag-name)
1168 "Return non-nil if TAG-NAME is an implicitly empty tag."
1169 (and (not sgml-xml-mode)
1170 (member-ignore-case tag-name sgml-empty-tags)))
1172 (defun sgml-unclosed-tag-p (tag-name)
1173 "Return non-nil if TAG-NAME is a tag for which an end-tag is optional."
1174 (and (not sgml-xml-mode)
1175 (member-ignore-case tag-name sgml-unclosed-tags)))
1177 (defun sgml-calculate-indent ()
1178 "Calculate the column to which this line should be indented."
1179 (let ((lcon (sgml-lexical-context)))
1181 ;; Indent comment-start markers inside <!-- just like comment-end markers.
1182 (if (and (eq (car lcon) 'tag)
1183 (looking-at "--")
1184 (save-excursion (goto-char (cdr lcon)) (looking-at "<!--")))
1185 (setq lcon (cons 'comment (+ (cdr lcon) 2))))
1187 (case (car lcon)
1189 (string
1190 ;; Go back to previous non-empty line.
1191 (while (and (> (point) (cdr lcon))
1192 (zerop (forward-line -1))
1193 (looking-at "[ \t]*$")))
1194 (if (> (point) (cdr lcon))
1195 ;; Previous line is inside the string.
1196 (current-indentation)
1197 (goto-char (cdr lcon))
1198 (1+ (current-column))))
1200 (comment
1201 (let ((mark (looking-at "--")))
1202 ;; Go back to previous non-empty line.
1203 (while (and (> (point) (cdr lcon))
1204 (zerop (forward-line -1))
1205 (or (looking-at "[ \t]*$")
1206 (if mark (not (looking-at "[ \t]*--"))))))
1207 (if (> (point) (cdr lcon))
1208 ;; Previous line is inside the comment.
1209 (skip-chars-forward " \t")
1210 (goto-char (cdr lcon)))
1211 (when (and (not mark) (looking-at "--"))
1212 (forward-char 2) (skip-chars-forward " \t"))
1213 (current-column)))
1215 (cdata
1216 (current-column))
1218 (tag
1219 (goto-char (1+ (cdr lcon)))
1220 (skip-chars-forward "^ \t\n") ;Skip tag name.
1221 (skip-chars-forward " \t")
1222 (if (not (eolp))
1223 (current-column)
1224 ;; This is the first attribute: indent.
1225 (goto-char (1+ (cdr lcon)))
1226 (+ (current-column) sgml-basic-offset)))
1228 (text
1229 (while (looking-at "</")
1230 (forward-sexp 1)
1231 (skip-chars-forward " \t"))
1232 (let* ((here (point))
1233 (unclosed (and ;; (not sgml-xml-mode)
1234 (looking-at sgml-tag-name-re)
1235 (member-ignore-case (match-string 1)
1236 sgml-unclosed-tags)
1237 (match-string 1)))
1238 (context
1239 ;; If possible, align on the previous non-empty text line.
1240 ;; Otherwise, do a more serious parsing to find the
1241 ;; tag(s) relative to which we should be indenting.
1242 (if (and (not unclosed) (skip-chars-backward " \t")
1243 (< (skip-chars-backward " \t\n") 0)
1244 (back-to-indentation)
1245 (> (point) (cdr lcon)))
1247 (goto-char here)
1248 (nreverse (sgml-get-context (if unclosed nil 'empty)))))
1249 (there (point)))
1250 ;; Ignore previous unclosed start-tag in context.
1251 (while (and context unclosed
1252 (eq t (compare-strings
1253 (sgml-tag-name (car context)) nil nil
1254 unclosed nil nil t)))
1255 (setq context (cdr context)))
1256 ;; Indent to reflect nesting.
1257 (if (and context
1258 (goto-char (sgml-tag-end (car context)))
1259 (skip-chars-forward " \t\n")
1260 (< (point) here) (sgml-at-indentation-p))
1261 (current-column)
1262 (goto-char there)
1263 (+ (current-column)
1264 (* sgml-basic-offset (length context))))))
1266 (otherwise
1267 (error "Unrecognised context %s" (car lcon)))
1271 (defun sgml-indent-line ()
1272 "Indent the current line as SGML."
1273 (interactive)
1274 (let* ((savep (point))
1275 (indent-col
1276 (save-excursion
1277 (back-to-indentation)
1278 (if (>= (point) savep) (setq savep nil))
1279 (sgml-calculate-indent))))
1280 (if savep
1281 (save-excursion (indent-line-to indent-col))
1282 (indent-line-to indent-col))))
1284 (defun sgml-guess-indent ()
1285 "Guess an appropriate value for `sgml-basic-offset'.
1286 Base the guessed identation level on the first indented tag in the buffer.
1287 Add this to `sgml-mode-hook' for convenience."
1288 (interactive)
1289 (save-excursion
1290 (goto-char (point-min))
1291 (if (re-search-forward "^\\([ \t]+\\)<" 500 'noerror)
1292 (progn
1293 (set (make-local-variable 'sgml-basic-offset)
1294 (1- (current-column)))
1295 (message "Guessed sgml-basic-offset = %d"
1296 sgml-basic-offset)
1297 ))))
1299 (defun sgml-parse-dtd ()
1300 "Simplistic parse of the current buffer as a DTD.
1301 Currently just returns (EMPTY-TAGS UNCLOSED-TAGS)."
1302 (goto-char (point-min))
1303 (let ((empty nil)
1304 (unclosed nil))
1305 (while (re-search-forward "<!ELEMENT[ \t\n]+\\([^ \t\n]+\\)[ \t\n]+[-O][ \t\n]+\\([-O]\\)[ \t\n]+\\([^ \t\n]+\\)" nil t)
1306 (cond
1307 ((string= (match-string 3) "EMPTY")
1308 (push (match-string-no-properties 1) empty))
1309 ((string= (match-string 2) "O")
1310 (push (match-string-no-properties 1) unclosed))))
1311 (setq empty (sort (mapcar 'downcase empty) 'string<))
1312 (setq unclosed (sort (mapcar 'downcase unclosed) 'string<))
1313 (list empty unclosed)))
1315 ;;; HTML mode
1317 (defcustom html-mode-hook nil
1318 "Hook run by command `html-mode'.
1319 `text-mode-hook' and `sgml-mode-hook' are run first."
1320 :group 'sgml
1321 :type 'hook
1322 :options '(html-autoview-mode))
1324 (defvar html-quick-keys sgml-quick-keys
1325 "Use C-c X combinations for quick insertion of frequent tags when non-nil.
1326 This defaults to `sgml-quick-keys'.
1327 This takes effect when first loading the library.")
1329 (defvar html-mode-map
1330 (let ((map (make-sparse-keymap))
1331 (menu-map (make-sparse-keymap "HTML")))
1332 (set-keymap-parent map sgml-mode-map)
1333 (define-key map "\C-c6" 'html-headline-6)
1334 (define-key map "\C-c5" 'html-headline-5)
1335 (define-key map "\C-c4" 'html-headline-4)
1336 (define-key map "\C-c3" 'html-headline-3)
1337 (define-key map "\C-c2" 'html-headline-2)
1338 (define-key map "\C-c1" 'html-headline-1)
1339 (define-key map "\C-c\r" 'html-paragraph)
1340 (define-key map "\C-c\n" 'html-line)
1341 (define-key map "\C-c\C-c-" 'html-horizontal-rule)
1342 (define-key map "\C-c\C-co" 'html-ordered-list)
1343 (define-key map "\C-c\C-cu" 'html-unordered-list)
1344 (define-key map "\C-c\C-cr" 'html-radio-buttons)
1345 (define-key map "\C-c\C-cc" 'html-checkboxes)
1346 (define-key map "\C-c\C-cl" 'html-list-item)
1347 (define-key map "\C-c\C-ch" 'html-href-anchor)
1348 (define-key map "\C-c\C-cn" 'html-name-anchor)
1349 (define-key map "\C-c\C-ci" 'html-image)
1350 (when html-quick-keys
1351 (define-key map "\C-c-" 'html-horizontal-rule)
1352 (define-key map "\C-co" 'html-ordered-list)
1353 (define-key map "\C-cu" 'html-unordered-list)
1354 (define-key map "\C-cr" 'html-radio-buttons)
1355 (define-key map "\C-cc" 'html-checkboxes)
1356 (define-key map "\C-cl" 'html-list-item)
1357 (define-key map "\C-ch" 'html-href-anchor)
1358 (define-key map "\C-cn" 'html-name-anchor)
1359 (define-key map "\C-ci" 'html-image))
1360 (define-key map "\C-c\C-s" 'html-autoview-mode)
1361 (define-key map "\C-c\C-v" 'browse-url-of-buffer)
1362 (define-key map [menu-bar html] (cons "HTML" menu-map))
1363 (define-key menu-map [html-autoview-mode]
1364 '("Toggle Autoviewing" . html-autoview-mode))
1365 (define-key menu-map [browse-url-of-buffer]
1366 '("View Buffer Contents" . browse-url-of-buffer))
1367 (define-key menu-map [nil] '("--"))
1368 ;;(define-key menu-map "6" '("Heading 6" . html-headline-6))
1369 ;;(define-key menu-map "5" '("Heading 5" . html-headline-5))
1370 ;;(define-key menu-map "4" '("Heading 4" . html-headline-4))
1371 (define-key menu-map "3" '("Heading 3" . html-headline-3))
1372 (define-key menu-map "2" '("Heading 2" . html-headline-2))
1373 (define-key menu-map "1" '("Heading 1" . html-headline-1))
1374 (define-key menu-map "l" '("Radio Buttons" . html-radio-buttons))
1375 (define-key menu-map "c" '("Checkboxes" . html-checkboxes))
1376 (define-key menu-map "l" '("List Item" . html-list-item))
1377 (define-key menu-map "u" '("Unordered List" . html-unordered-list))
1378 (define-key menu-map "o" '("Ordered List" . html-ordered-list))
1379 (define-key menu-map "-" '("Horizontal Rule" . html-horizontal-rule))
1380 (define-key menu-map "\n" '("Line Break" . html-line))
1381 (define-key menu-map "\r" '("Paragraph" . html-paragraph))
1382 (define-key menu-map "i" '("Image" . html-image))
1383 (define-key menu-map "h" '("Href Anchor" . html-href-anchor))
1384 (define-key menu-map "n" '("Name Anchor" . html-name-anchor))
1385 map)
1386 "Keymap for commands for use in HTML mode.")
1388 (defvar html-face-tag-alist
1389 '((bold . "b")
1390 (italic . "i")
1391 (underline . "u")
1392 (modeline . "rev"))
1393 "Value of `sgml-face-tag-alist' for HTML mode.")
1395 (defvar html-tag-face-alist
1396 '(("b" . bold)
1397 ("big" . bold)
1398 ("blink" . highlight)
1399 ("cite" . italic)
1400 ("em" . italic)
1401 ("h1" bold underline)
1402 ("h2" bold-italic underline)
1403 ("h3" italic underline)
1404 ("h4" . underline)
1405 ("h5" . underline)
1406 ("h6" . underline)
1407 ("i" . italic)
1408 ("rev" . modeline)
1409 ("s" . underline)
1410 ("small" . default)
1411 ("strong" . bold)
1412 ("title" bold underline)
1413 ("tt" . default)
1414 ("u" . underline)
1415 ("var" . italic))
1416 "Value of `sgml-tag-face-alist' for HTML mode.")
1418 (defvar html-display-text
1419 '((img . "[/]")
1420 (hr . "----------")
1421 (li . "o "))
1422 "Value of `sgml-display-text' for HTML mode.")
1425 ;; should code exactly HTML 3 here when that is finished
1426 (defvar html-tag-alist
1427 (let* ((1-7 '(("1") ("2") ("3") ("4") ("5") ("6") ("7")))
1428 (1-9 `(,@1-7 ("8") ("9")))
1429 (align '(("align" ("left") ("center") ("right"))))
1430 (valign '(("top") ("middle") ("bottom") ("baseline")))
1431 (rel '(("next") ("previous") ("parent") ("subdocument") ("made")))
1432 (href '("href" ("ftp:") ("file:") ("finger:") ("gopher:") ("http:")
1433 ("mailto:") ("news:") ("rlogin:") ("telnet:") ("tn3270:")
1434 ("wais:") ("/cgi-bin/")))
1435 (name '("name"))
1436 (link `(,href
1437 ("rel" ,@rel)
1438 ("rev" ,@rel)
1439 ("title")))
1440 (list '((nil \n ("List item: " "<li>" str
1441 (if sgml-xml-mode "</li>") \n))))
1442 (cell `(t
1443 ,@align
1444 ("valign" ,@valign)
1445 ("colspan" ,@1-9)
1446 ("rowspan" ,@1-9)
1447 ("nowrap" t))))
1448 ;; put ,-expressions first, else byte-compile chokes (as of V19.29)
1449 ;; and like this it's more efficient anyway
1450 `(("a" ,name ,@link)
1451 ("base" t ,@href)
1452 ("dir" ,@list)
1453 ("font" nil "size" ("-1") ("+1") ("-2") ("+2") ,@1-7)
1454 ("form" (\n _ \n "<input type=\"submit\" value=\"\""
1455 (if sgml-xml-mode "/>" ">"))
1456 ("action" ,@(cdr href)) ("method" ("get") ("post")))
1457 ("h1" ,@align)
1458 ("h2" ,@align)
1459 ("h3" ,@align)
1460 ("h4" ,@align)
1461 ("h5" ,@align)
1462 ("h6" ,@align)
1463 ("hr" t ("size" ,@1-9) ("width") ("noshade" t) ,@align)
1464 ("img" t ("align" ,@valign ("texttop") ("absmiddle") ("absbottom"))
1465 ("src") ("alt") ("width" "1") ("height" "1")
1466 ("border" "1") ("vspace" "1") ("hspace" "1") ("ismap" t))
1467 ("input" t ("size" ,@1-9) ("maxlength" ,@1-9) ("checked" t) ,name
1468 ("type" ("text") ("password") ("checkbox") ("radio")
1469 ("submit") ("reset"))
1470 ("value"))
1471 ("link" t ,@link)
1472 ("menu" ,@list)
1473 ("ol" ,@list ("type" ("A") ("a") ("I") ("i") ("1")))
1474 ("p" t ,@align)
1475 ("select" (nil \n
1476 ("Text: "
1477 "<option>" str (if sgml-xml-mode "</option>") \n))
1478 ,name ("size" ,@1-9) ("multiple" t))
1479 ("table" (nil \n
1480 ((completing-read "Cell kind: " '(("td") ("th"))
1481 nil t "t")
1482 "<tr><" str ?> _
1483 (if sgml-xml-mode (concat "<" str "></tr>")) \n))
1484 ("border" t ,@1-9) ("width" "10") ("cellpadding"))
1485 ("td" ,@cell)
1486 ("textarea" ,name ("rows" ,@1-9) ("cols" ,@1-9))
1487 ("th" ,@cell)
1488 ("ul" ,@list ("type" ("disc") ("circle") ("square")))
1490 ,@sgml-tag-alist
1492 ("abbrev")
1493 ("acronym")
1494 ("address")
1495 ("array" (nil \n
1496 ("Item: " "<item>" str (if sgml-xml-mode "</item>") \n))
1497 "align")
1498 ("au")
1499 ("b")
1500 ("big")
1501 ("blink")
1502 ("blockquote" \n)
1503 ("body" \n ("background" ".gif") ("bgcolor" "#") ("text" "#")
1504 ("link" "#") ("alink" "#") ("vlink" "#"))
1505 ("box" (nil _ "<over>" _ (if sgml-xml-mode "</over>")))
1506 ("br" t ("clear" ("left") ("right")))
1507 ("caption" ("valign" ("top") ("bottom")))
1508 ("center" \n)
1509 ("cite")
1510 ("code" \n)
1511 ("dd" ,(not sgml-xml-mode))
1512 ("del")
1513 ("dfn")
1514 ("div")
1515 ("dl" (nil \n
1516 ( "Term: "
1517 "<dt>" str (if sgml-xml-mode "</dt>")
1518 "<dd>" _ (if sgml-xml-mode "</dd>") \n)))
1519 ("dt" (t _ (if sgml-xml-mode "</dt>")
1520 "<dd>" (if sgml-xml-mode "</dd>") \n))
1521 ("em")
1522 ;("fn" "id" "fn") ; ???
1523 ("head" \n)
1524 ("html" (\n
1525 "<head>\n"
1526 "<title>" (setq str (read-input "Title: ")) "</title>\n"
1527 "</head>\n"
1528 "<body>\n<h1>" str "</h1>\n" _
1529 "\n<address>\n<a href=\"mailto:"
1530 user-mail-address
1531 "\">" (user-full-name) "</a>\n</address>\n"
1532 "</body>"
1534 ("i")
1535 ("ins")
1536 ("isindex" t ("action") ("prompt"))
1537 ("kbd")
1538 ("lang")
1539 ("li" ,(not sgml-xml-mode))
1540 ("math" \n)
1541 ("nobr")
1542 ("option" t ("value") ("label") ("selected" t))
1543 ("over" t)
1544 ("person")
1545 ("pre" \n)
1546 ("q")
1547 ("rev")
1548 ("s")
1549 ("samp")
1550 ("small")
1551 ("span" nil
1552 ("class"
1553 ("builtin")
1554 ("comment")
1555 ("constant")
1556 ("function-name")
1557 ("keyword")
1558 ("string")
1559 ("type")
1560 ("variable-name")
1561 ("warning")))
1562 ("strong")
1563 ("sub")
1564 ("sup")
1565 ("title")
1566 ("tr" t)
1567 ("tt")
1568 ("u")
1569 ("var")
1570 ("wbr" t)))
1571 "*Value of `sgml-tag-alist' for HTML mode.")
1573 (defvar html-tag-help
1574 `(,@sgml-tag-help
1575 ("a" . "Anchor of point or link elsewhere")
1576 ("abbrev" . "?")
1577 ("acronym" . "?")
1578 ("address" . "Formatted mail address")
1579 ("array" . "Math array")
1580 ("au" . "?")
1581 ("b" . "Bold face")
1582 ("base" . "Base address for URLs")
1583 ("big" . "Font size")
1584 ("blink" . "Blinking text")
1585 ("blockquote" . "Indented quotation")
1586 ("body" . "Document body")
1587 ("box" . "Math fraction")
1588 ("br" . "Line break")
1589 ("caption" . "Table caption")
1590 ("center" . "Centered text")
1591 ("changed" . "Change bars")
1592 ("cite" . "Citation of a document")
1593 ("code" . "Formatted source code")
1594 ("dd" . "Definition of term")
1595 ("del" . "?")
1596 ("dfn" . "?")
1597 ("dir" . "Directory list (obsolete)")
1598 ("dl" . "Definition list")
1599 ("dt" . "Term to be definined")
1600 ("em" . "Emphasised")
1601 ("embed" . "Embedded data in foreign format")
1602 ("fig" . "Figure")
1603 ("figa" . "Figure anchor")
1604 ("figd" . "Figure description")
1605 ("figt" . "Figure text")
1606 ;("fn" . "?") ; ???
1607 ("font" . "Font size")
1608 ("form" . "Form with input fields")
1609 ("group" . "Document grouping")
1610 ("h1" . "Most important section headline")
1611 ("h2" . "Important section headline")
1612 ("h3" . "Section headline")
1613 ("h4" . "Minor section headline")
1614 ("h5" . "Unimportant section headline")
1615 ("h6" . "Least important section headline")
1616 ("head" . "Document header")
1617 ("hr" . "Horizontal rule")
1618 ("html" . "HTML Document")
1619 ("i" . "Italic face")
1620 ("img" . "Graphic image")
1621 ("input" . "Form input field")
1622 ("ins" . "?")
1623 ("isindex" . "Input field for index search")
1624 ("kbd" . "Keybard example face")
1625 ("lang" . "Natural language")
1626 ("li" . "List item")
1627 ("link" . "Link relationship")
1628 ("math" . "Math formula")
1629 ("menu" . "Menu list (obsolete)")
1630 ("mh" . "Form mail header")
1631 ("nextid" . "Allocate new id")
1632 ("nobr" . "Text without line break")
1633 ("ol" . "Ordered list")
1634 ("option" . "Selection list item")
1635 ("over" . "Math fraction rule")
1636 ("p" . "Paragraph start")
1637 ("panel" . "Floating panel")
1638 ("person" . "?")
1639 ("pre" . "Preformatted fixed width text")
1640 ("q" . "?")
1641 ("rev" . "Reverse video")
1642 ("s" . "?")
1643 ("samp" . "Sample text")
1644 ("select" . "Selection list")
1645 ("small" . "Font size")
1646 ("sp" . "Nobreak space")
1647 ("strong" . "Standout text")
1648 ("sub" . "Subscript")
1649 ("sup" . "Superscript")
1650 ("table" . "Table with rows and columns")
1651 ("tb" . "Table vertical break")
1652 ("td" . "Table data cell")
1653 ("textarea" . "Form multiline edit area")
1654 ("th" . "Table header cell")
1655 ("title" . "Document title")
1656 ("tr" . "Table row separator")
1657 ("tt" . "Typewriter face")
1658 ("u" . "Underlined text")
1659 ("ul" . "Unordered list")
1660 ("var" . "Math variable face")
1661 ("wbr" . "Enable <br> within <nobr>"))
1662 "*Value of `sgml-tag-help' for HTML mode.")
1665 ;;;###autoload
1666 (define-derived-mode html-mode sgml-mode "HTML"
1667 "Major mode based on SGML mode for editing HTML documents.
1668 This allows inserting skeleton constructs used in hypertext documents with
1669 completion. See below for an introduction to HTML. Use
1670 \\[browse-url-of-buffer] to see how this comes out. See also `sgml-mode' on
1671 which this is based.
1673 Do \\[describe-variable] html- SPC and \\[describe-variable] sgml- SPC to see available variables.
1675 To write fairly well formatted pages you only need to know few things. Most
1676 browsers have a function to read the source code of the page being seen, so
1677 you can imitate various tricks. Here's a very short HTML primer which you
1678 can also view with a browser to see what happens:
1680 <title>A Title Describing Contents</title> should be on every page. Pages can
1681 have <h1>Very Major Headlines</h1> through <h6>Very Minor Headlines</h6>
1682 <hr> Parts can be separated with horizontal rules.
1684 <p>Paragraphs only need an opening tag. Line breaks and multiple spaces are
1685 ignored unless the text is <pre>preformatted.</pre> Text can be marked as
1686 <b>bold</b>, <i>italic</i> or <u>underlined</u> using the normal M-g or
1687 Edit/Text Properties/Face commands.
1689 Pages can have <a name=\"SOMENAME\">named points</a> and can link other points
1690 to them with <a href=\"#SOMENAME\">see also somename</a>. In the same way <a
1691 href=\"URL\">see also URL</a> where URL is a filename relative to current
1692 directory, or absolute as in `http://www.cs.indiana.edu/elisp/w3/docs.html'.
1694 Images in many formats can be inlined with <img src=\"URL\">.
1696 If you mainly create your own documents, `sgml-specials' might be
1697 interesting. But note that some HTML 2 browsers can't handle `&apos;'.
1698 To work around that, do:
1699 (eval-after-load \"sgml-mode\" '(aset sgml-char-names ?' nil))
1701 \\{html-mode-map}"
1702 (set (make-local-variable 'sgml-display-text) html-display-text)
1703 (set (make-local-variable 'sgml-tag-face-alist) html-tag-face-alist)
1704 (make-local-variable 'sgml-tag-alist)
1705 (make-local-variable 'sgml-face-tag-alist)
1706 (make-local-variable 'sgml-tag-help)
1707 (make-local-variable 'outline-regexp)
1708 (make-local-variable 'outline-heading-end-regexp)
1709 (make-local-variable 'outline-level)
1710 (make-local-variable 'sentence-end)
1711 (setq sentence-end
1712 (if sentence-end-double-space
1713 "[.?!][]\"')}]*\\(<[^>]*>\\)*\\($\\| $\\|\t\\| \\)[ \t\n]*"
1714 "[.?!][]\"')}]*\\(<[^>]*>\\)*\\($\\|[ \t]\\)[ \t\n]*"))
1715 (setq sgml-tag-alist html-tag-alist
1716 sgml-face-tag-alist html-face-tag-alist
1717 sgml-tag-help html-tag-help
1718 outline-regexp "^.*<[Hh][1-6]\\>"
1719 outline-heading-end-regexp "</[Hh][1-6]>"
1720 outline-level (lambda ()
1721 (char-before (match-end 0))))
1722 (setq imenu-create-index-function 'html-imenu-index)
1723 (when sgml-xml-mode (setq mode-name "XHTML"))
1724 (set (make-local-variable 'sgml-empty-tags)
1725 ;; From HTML-4.01's loose.dtd, parsed with `sgml-parse-dtd',
1726 ;; plus manual addition of "wbr".
1727 '("area" "base" "basefont" "br" "col" "frame" "hr" "img" "input"
1728 "isindex" "link" "meta" "param" "wbr"))
1729 (set (make-local-variable 'sgml-unclosed-tags)
1730 ;; From HTML-4.01's loose.dtd, parsed with `sgml-parse-dtd'.
1731 '("body" "colgroup" "dd" "dt" "head" "html" "li" "option"
1732 "p" "tbody" "td" "tfoot" "th" "thead" "tr"))
1733 ;; It's for the user to decide if it defeats it or not -stef
1734 ;; (make-local-variable 'imenu-sort-function)
1735 ;; (setq imenu-sort-function nil) ; sorting the menu defeats the purpose
1738 (defvar html-imenu-regexp
1739 "\\s-*<h\\([1-9]\\)[^\n<>]*>\\(<[^\n<>]*>\\)*\\s-*\\([^\n<>]*\\)"
1740 "*A regular expression matching a head line to be added to the menu.
1741 The first `match-string' should be a number from 1-9.
1742 The second `match-string' matches extra tags and is ignored.
1743 The third `match-string' will be the used in the menu.")
1745 (defun html-imenu-index ()
1746 "Return a table of contents for an HTML buffer for use with Imenu."
1747 (let (toc-index)
1748 (save-excursion
1749 (goto-char (point-min))
1750 (while (re-search-forward html-imenu-regexp nil t)
1751 (setq toc-index
1752 (cons (cons (concat (make-string
1753 (* 2 (1- (string-to-number (match-string 1))))
1754 ?\ )
1755 (match-string 3))
1756 (line-beginning-position))
1757 toc-index))))
1758 (nreverse toc-index)))
1760 (defun html-autoview-mode (&optional arg)
1761 "Toggle automatic viewing via `browse-url-of-buffer' upon saving buffer.
1762 With positive prefix ARG always turns viewing on, with negative ARG always off.
1763 Can be used as a value for `html-mode-hook'."
1764 (interactive "P")
1765 (if (setq arg (if arg
1766 (< (prefix-numeric-value arg) 0)
1767 (and (boundp 'after-save-hook)
1768 (memq 'browse-url-of-buffer after-save-hook))))
1769 (setq after-save-hook (delq 'browse-url-of-buffer after-save-hook))
1770 (add-hook 'after-save-hook 'browse-url-of-buffer nil t))
1771 (message "Autoviewing turned %s."
1772 (if arg "off" "on")))
1775 (define-skeleton html-href-anchor
1776 "HTML anchor tag with href attribute."
1777 "URL: "
1778 '(setq input "http:")
1779 "<a href=\"" str "\">" _ "</a>")
1781 (define-skeleton html-name-anchor
1782 "HTML anchor tag with name attribute."
1783 "Name: "
1784 "<a name=\"" str "\">" _ "</a>")
1786 (define-skeleton html-headline-1
1787 "HTML level 1 headline tags."
1789 "<h1>" _ "</h1>")
1791 (define-skeleton html-headline-2
1792 "HTML level 2 headline tags."
1794 "<h2>" _ "</h2>")
1796 (define-skeleton html-headline-3
1797 "HTML level 3 headline tags."
1799 "<h3>" _ "</h3>")
1801 (define-skeleton html-headline-4
1802 "HTML level 4 headline tags."
1804 "<h4>" _ "</h4>")
1806 (define-skeleton html-headline-5
1807 "HTML level 5 headline tags."
1809 "<h5>" _ "</h5>")
1811 (define-skeleton html-headline-6
1812 "HTML level 6 headline tags."
1814 "<h6>" _ "</h6>")
1816 (define-skeleton html-horizontal-rule
1817 "HTML horizontal rule tag."
1819 (if sgml-xml-mode "<hr/>" "<hr>") \n)
1821 (define-skeleton html-image
1822 "HTML image tag."
1824 "<img src=\"" _ "\""
1825 (if sgml-xml-mode "/>" ">"))
1827 (define-skeleton html-line
1828 "HTML line break tag."
1830 (if sgml-xml-mode "<br/>" "<br>") \n)
1832 (define-skeleton html-ordered-list
1833 "HTML ordered list tags."
1835 "<ol>" \n
1836 "<li>" _ (if sgml-xml-mode "</li>") \n
1837 "</ol>")
1839 (define-skeleton html-unordered-list
1840 "HTML unordered list tags."
1842 "<ul>" \n
1843 "<li>" _ (if sgml-xml-mode "</li>") \n
1844 "</ul>")
1846 (define-skeleton html-list-item
1847 "HTML list item tag."
1849 (if (bolp) nil '\n)
1850 "<li>" _ (if sgml-xml-mode "</li>"))
1852 (define-skeleton html-paragraph
1853 "HTML paragraph tag."
1855 (if (bolp) nil ?\n)
1856 \n "<p>" _ (if sgml-xml-mode "</p>"))
1858 (define-skeleton html-checkboxes
1859 "Group of connected checkbox inputs."
1861 '(setq v1 nil
1862 v2 nil)
1863 ("Value: "
1864 "<input type=\"" (identity "checkbox") ; see comment above about identity
1865 "\" name=\"" (or v1 (setq v1 (skeleton-read "Name: ")))
1866 "\" value=\"" str ?\"
1867 (when (y-or-n-p "Set \"checked\" attribute? ")
1868 (funcall skeleton-transformation " checked"))
1869 (if sgml-xml-mode "/>" ">")
1870 (skeleton-read "Text: " (capitalize str))
1871 (or v2 (setq v2 (if (y-or-n-p "Newline after text? ")
1872 (funcall skeleton-transformation
1873 (if sgml-xml-mode "<br/>" "<br>"))
1874 "")))
1875 \n))
1877 (define-skeleton html-radio-buttons
1878 "Group of connected radio button inputs."
1880 '(setq v1 nil
1881 v2 (cons nil nil))
1882 ("Value: "
1883 "<input type=\"" (identity "radio") ; see comment above about identity
1884 "\" name=\"" (or (car v2) (setcar v2 (skeleton-read "Name: ")))
1885 "\" value=\"" str ?\"
1886 (when (and (not v1) (setq v1 (y-or-n-p "Set \"checked\" attribute? ")))
1887 (funcall skeleton-transformation " checked"))
1888 (if sgml-xml-mode "/>" ">")
1889 (skeleton-read "Text: " (capitalize str))
1890 (or (cdr v2) (setcdr v2 (if (y-or-n-p "Newline after text? ")
1891 (funcall skeleton-transformation
1892 (if sgml-xml-mode "<br/>" "<br>"))
1893 "")))
1894 \n))
1896 (provide 'sgml-mode)
1898 ;;; sgml-mode.el ends here