;;; psgml.el --- SGML-editing mode with parsing support ;; $Id: psgml.el,v 2.70 2005/03/02 19:44:04 lenst Exp $ ;; Copyright (C) 1993-2002 Lennart Staflin ;; Copyright (C) 1992 Free Software Foundation, Inc. ;; Author: Lennart Staflin ;; James Clark ;; Maintainer: Lennart Staflin ;; Keywords: languages ;; ;; This program is free software; you can redistribute it and/or ;; modify it under the terms of the GNU General Public License ;; as published by the Free Software Foundation; either version 2 ;; of the License, or (at your option) any later version. ;; ;; This program is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; ;; You should have received a copy of the GNU General Public License ;; along with this program; if not, write to the Free Software ;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. ;;; Commentary: ;; Major mode for editing the SGML document-markup language. ;; Send bugs to lenst@lysator.liu.se ;; WHAT IT CAN DO ;; - Identify structural errors (but it is not a validator) ;; - Menus for inserting tags with only the contextually valid tags ;; - Edit attribute values in separate window with information about types ;; and defaults ;; - Hide attributes ;; - Fold elements ;; - Indent according to element nesting depth ;; - Show context ;; - Structure editing: move and kill by element ;; - Find next data context ;; LIMITATIONS ;; - only accepts the reference concrete syntax, though it does allow ;; unlimited lengths on names ;;; Code: (defconst psgml-version "1.3.2" "Version of psgml package.") (defconst psgml-maintainer-address "lenst@lysator.liu.se") (eval-when-compile (require 'cl)) (require 'easymenu) (defvar sgml-debug nil) (defmacro sgml-debug (&rest x) (list 'if 'sgml-debug (cons 'message x))) ;;;; Variables (defvar sgml-mode-abbrev-table nil "Abbrev table in use in SGML mode.") (define-abbrev-table 'sgml-mode-abbrev-table ()) (eval-and-compile (defconst sgml-have-re-char-clases (string-match "[[:alpha:]]" "x") "Non-nil if this Emacs supports regexp character classes. E.g. `[-.[:alnum:]]'.")) (defconst sgml-default-nonsticky (boundp 'text-property-default-nonsticky) "Non-nil means use `text-property-default-nonsticky' locally. Otherwise put explicit properties.") (defvar sgml-xml-p nil "Is this an XML document?") (make-variable-buffer-local 'sgml-xml-p) ;;; User settable options: (defvar sgml-insert-defaulted-attributes nil "*Controls whether defaulted attributes (not #FIXED) are inserted explicitly or not. nil means don't insert, t means insert.") (defgroup sgml nil "Standard Generalized Markup Language" :group 'languages) (defgroup psgml nil "SGML-editing mode with parsing support" :prefix "sgml-" :group 'sgml) (defgroup psgml-insert nil "Inserting features of psgml" :prefix "sgml-" :group 'psgml) (defgroup psgml-dtd nil "DTD, CATALOG and DOCTYPE customizations in psgml" :prefix "sgml-" :group 'psgml) (defcustom sgml-insert-missing-element-comment t "*If true, and sgml-auto-insert-required-elements also true, `sgml-insert-element' will insert a comment if there is an element required but there is more than one to choose from." :type 'boolean :group 'psgml-insert) (defcustom sgml-insert-end-tag-on-new-line nil "*If true, `sgml-insert-element' will put the end-tag on a new line after the start-tag. Useful on slow terminals if you find the end-tag after the cursor irritating." :type 'boolean :group 'psgml-insert) (defvar sgml-doctype nil "*If non-nil the name of a file that contains the doctype declaration to use. Setting this variable automatically makes it local to the current buffer.") (put 'sgml-doctype 'sgml-type 'string) (make-variable-buffer-local 'sgml-doctype) (defcustom sgml-system-identifiers-are-preferred nil "*Controls lookup of external entities. nil means look up external entities by searching the catalogs in `sgml-local-catalogs' and `sgml-catalog-files' and only if the entity is not found in the catalogs, use a given system identifier. Non-nil means use a system identifier for the entity if one is given. If no system identifier is given the catalogs will searched." :type 'boolean :group 'psgml-dtd) (defcustom sgml-range-indicator-max-length 9 "*Control of menu indicators. Maximum number of characters used from the first and last entry of a submenu to indicate the range of that menu." :type 'integer :group 'psgml) (defcustom sgml-default-doctype-name nil "*Document type name to use if no document type declaration is present." :type '(choice string (const nil)) :group 'psgml-dtd) (put 'sgml-default-doctype-name 'sgml-type 'string-or-nil) (defcustom sgml-markup-faces ;; Fixme: are the font-lock correspondences here the most appopriate ;; ones? I don't recall whence this set came. -- fx `((start-tag . ,(if (facep 'font-lock-function-name-face) 'font-lock-function-name-face 'bold)) (end-tag . ,(if (facep 'font-lock-function-name-face) 'font-lock-function-name-face 'bold)) (comment . ,(if (facep 'font-lock-comment-face) 'font-lock-comment-face 'bold)) (pi . ,(if (facep 'font-lock-type-face) 'font-lock-type-face 'bold)) (sgml . ,(if (facep 'font-lock-type-face) 'font-lock-type-face 'bold)) (doctype . ,(if (facep 'font-lock-keyword-face) 'font-lock-keyword-face 'bold)) (entity . ,(if (facep 'font-lock-string-face) 'font-lock-string-face 'bold)) (shortref . ,(if (facep 'font-lock-string-face) 'font-lock-string-face 'bold)) (ignored . ,(if (facep 'font-lock-constant-face) 'font-lock-constant-face 'default)) (ms-start . ,(if (facep 'font-lock-constant-face) 'font-lock-constant-face 'default)) (ms-end . ,(if (facep 'font-lock-constant-face) 'font-lock-constant-face 'default))) "*List of markup to face mappings. Element are of the form (MARKUP-TYPE . FACE). Possible values for MARKUP-TYPE are: comment - comment declaration doctype - doctype declaration end-tag ignored - ignored marked section ms-end - marked section start, if not ignored ms-start- marked section end, if not ignored pi - processing instruction sgml - SGML declaration start-tag entity - general entity reference shortref- short reference" :type '(repeat (cons symbol face)) :group 'psgml) (defvar sgml-buggy-subst-char-in-region (or (not (boundp 'emacs-minor-version)) (not (natnump emacs-minor-version)) (and (eq emacs-major-version 19) (< emacs-minor-version 23))) "*If non-nil, work around a bug in subst-char-in-region. The bug sets the buffer modified. If this is set, folding commands will be slower.") (defcustom sgml-set-face nil "*If non-nil, psgml will set the face of parsed markup." :type 'boolean :group 'psgml) (put 'sgml-set-face 'sgml-desc "Set face of parsed markup") (defcustom sgml-live-element-indicator nil "*If non-nil, indicate current element in mode line. This may be slow." :type 'boolean :group 'psgml) (defcustom sgml-auto-activate-dtd nil "*If non-nil, loading a sgml-file will automatically try to activate its DTD. Activation means either to parse the document type declaration or to load a previously saved parsed DTD. The name of the activated DTD will be shown in the mode line." :type 'boolean :group 'psgml-dtd) (put 'sgml-auto-activate-dtd 'sgml-desc "Auto Activate DTD") (defcustom sgml-offer-save t "*If non-nil, ask about saving modified buffers before \\[sgml-validate] is run." :type 'boolean :group 'psgml) (defvar sgml-parent-document nil "*How to handle the current file as part of a bigger document. The variable describes how the current file's content fit into the element hierarchy. The value should have the form (PARENT-FILE CONTEXT-ELEMENT* TOP-ELEMENT (HAS-SEEN-ELEMENT*)?) PARENT-FILE is a string, the name of the file containing the document entity. CONTEXT-ELEMENT is a string, that is the name of an element type. It can occur 0 or more times and is used to set up exceptions and short reference map. Good candidates for these elements are the elements open when the entity pointing to the current file is used. TOP-ELEMENT is a string that is the name of the element type of the top level element in the current file. The file should contain one instance of this element, unless the last \(Lisp) element of `sgml-parent-document' is a list. If it is a list, the top level of the file should follow the content model of top-element. HAS-SEEN-ELEMENT is a string that is the name of an element type. This element is satisfied in the content model of top-element. Setting this variable automatically makes it local to the current buffer.") (make-variable-buffer-local 'sgml-parent-document) (put 'sgml-parent-document 'sgml-type 'list) (defcustom sgml-tag-region-if-active t ;; wing change "*If non-nil, the Tags menu will tag a region if the region is considered active by emacs. If nil, region must be active and `transient-mark-mode' must be on for the region to be tagged." :type 'boolean :group 'psgml) (defcustom sgml-normalize-trims t "*If non-nil, sgml-normalize will trim off white space from end of element when adding end tag." :type 'boolean :group 'psgml) (defvar sgml-omittag t "*Non-nil means use OMITTAG YES. Setting this variable automatically makes it local to the current buffer.") (make-variable-buffer-local 'sgml-omittag) (put 'sgml-omittag 'sgml-desc "OMITTAG") (defvar sgml-shorttag t "*Non-nil means use SHORTTAG YES. Setting this variable automatically makes it local to the current buffer.") (make-variable-buffer-local 'sgml-shorttag) (put 'sgml-shorttag 'sgml-desc "SHORTTAG") (defvar sgml-namecase-general t "*Non-nil means use NAMECASE GENERAL YES. Setting this variable automatically makes it local to the current buffer.") (make-variable-buffer-local 'sgml-namecase-general) (put 'sgml-namecase-general 'sgml-desc "NAMECASE GENERAL") ;;[lenst/1998-03-09 19:51:55] (defconst sgml-namecase-entity nil) (defcustom sgml-general-insert-case 'lower "*The case that will be used for general names in inserted markup. This can be the symbol `lower' or `upper'. Only effective if `sgml-namecase-general' is true." :type '(choice (const lower) (const upper)) :group 'psgml-insert) (put 'sgml-general-insert-case 'sgml-type '(lower upper)) (defvar sgml-entity-insert-case nil) (defvar sgml-minimize-attributes nil "*Determines minimization of attributes inserted by edit-attributes. Actually two things are done 1. If non-nil, omit attribute name, if attribute value is from a token group. 2. If `max', omit attributes with default value. Setting this variable automatically makes it local to the current buffer.") (make-variable-buffer-local 'sgml-minimize-attributes) (put 'sgml-minimize-attributes 'sgml-type '(("No" . nil) ("Yes" . t) ("Max" . max))) (defvar sgml-always-quote-attributes t "*Non-nil means quote all attribute values inserted after editing attributes. Setting this variable automatically makes it local to the current buffer.") (make-variable-buffer-local 'sgml-always-quote-attributes) (defcustom sgml-auto-insert-required-elements t "*If non-nil, automatically insert required elements in the content of an inserted element." :type 'boolean :group 'psgml-insert) (defcustom sgml-balanced-tag-edit t "*If non-nil, always insert start-end tag pairs." :type 'boolean :group 'psgml-insert) (defcustom sgml-omittag-transparent (not sgml-balanced-tag-edit) "*If non-nil, will show legal tags inside elements with omittable start tags and legal tags beyond omittable end tags." :type 'boolean :group 'psgml) (defcustom sgml-leave-point-after-insert nil "*If non-nil, the point will remain after inserted tag(s). If nil, the point will be placed before the inserted tag(s)." :type 'boolean :group 'psgml-insert) (defcustom sgml-warn-about-undefined-elements t "*If non-nil, print a warning when a tag for an undefined element is found." :type 'boolean :group 'psgml) (defcustom sgml-warn-about-undefined-entities t "*If non-nil, print a warning when an undefined entity is found." :type 'boolean :group 'psgml) (defcustom sgml-ignore-undefined-elements nil "*If non-nil, recover from an undefined element by ignoring the tag. If nil, recover from an undefined element by assuming it can occur any where and has content model ANY." :type 'boolean :group 'psgml) (defcustom sgml-recompile-out-of-date-cdtd 'ask "*If non-nil, out of date compiled DTDs will be automatically recompiled. If the value is `ask', PSGML will ask before recompiling. A `nil' value will cause PSGML to silently load an out of date compiled DTD. A DTD that refers to undefined external entities is always out of date, thus in such case it can be useful to set this variable to `nil'." :type 'symbol :group 'psgml-dtd) (put 'sgml-recompile-out-of-date-cdtd 'sgml-type '(("No" . nil) ("Yes" . t) ("Ask" . ask))) (defcustom sgml-trace-entity-lookup nil "*If non-nil, log messages about catalog files used to look for external entities." :type 'boolean :group 'psgml-dtd) (defvar sgml-indent-step 2 "*How much to increment indent for every element level. If nil, no indentation. Setting this variable automatically makes it local to the current buffer.") (make-variable-buffer-local 'sgml-indent-step) (put 'sgml-indent-step 'sgml-type '(("None" . nil) 0 1 2 3 4 5 6 7 8)) (defvar sgml-indent-data nil "*If non-nil, indent in data/mixed context also. Setting this variable automatically makes it local to the current buffer.") (make-variable-buffer-local 'sgml-indent-data) (defvar sgml-content-indent-function 'sgml-indent-according-to-level) (defvar sgml-attribute-indent-function 'sgml-indent-according-to-stag) ;;; Wing addition (defcustom sgml-inhibit-indent-tags nil "*List of tags within which indentation is inhibited. The tags should be given as strings." :type 'boolean :group 'psgml) ;;; James addition (defvar sgml-menu-name "SGML" "*The name of the menu on which the SGML mode options appear. This is intended to be overridden by submodes of sgml-mode.") ;;; XEmacs change (defvar sgml-data-directory (or (locate-data-directory "psgml-dtds") (locate-data-directory "psgml") (locate-data-directory "sgml")) "*Directory for pre-supplied data files (DTD's and such). Set this before loading psgml.") ;; XEmacs note: this isn't in use, we're using `split-path'. (defun sgml-parse-colon-path (cd-path) "Explode a colon-separated list of paths into a string list." (if (null cd-path) nil (let ((cd-sep ":") cd-list (cd-start 0) cd-colon) (if (boundp 'path-separator) (setq cd-sep path-separator)) (setq cd-path (concat cd-path cd-sep)) (while (setq cd-colon (string-match cd-sep cd-path cd-start)) (setq cd-list (nconc cd-list (list (if (= cd-start cd-colon) nil (substitute-in-file-name (substring cd-path cd-start cd-colon)))))) (setq cd-start (+ cd-colon 1))) cd-list))) ;; XEmacs change: use `split-path' (defcustom sgml-system-path (split-path (or (getenv "SGML_SEARCH_PATH") ".")) "*List of directories used to look for system identifiers. The directory listed in `sgml-data-directory' is always searched in addition to the directories listed here." :type '(repeat directory) :group 'psgml) (put 'sgml-system-path 'sgml-type 'file-list) ;; XEmacs change: use `split-path' (defcustom sgml-public-map (split-path (or (getenv "SGML_PATH") ;; Wing/Krause change (concat "%S" path-separator (directory-file-name sgml-data-directory) "%o/%c/%d"))) "*Mapping from public identifiers to file names. This is a list of possible file names. To find the file for a public identifier the elements of the list are used one at the time from the beginning. If the element is a string a file name is constructed from the string by substitution of the whole public identifier for %P, owner for %O, public text class for %C, and public text description for %D. The text class will be converted to lower case and the owner and description will be transliterated according to the variable `sgml-public-transliterations'. If the file exists it will be the file used for the public identifier. An element can also be a dotted pair \(regexp . filename), the filename is a string treated as above, but only if the regular expression, regexp, matches the public identifier." :type '(repeat file) :group 'psgml-dtd) (put 'sgml-public-map 'sgml-type 'list) (defcustom sgml-local-catalogs nil "*A list of SGML entity catalogs to be searched first when parsing the buffer. This is used in addition to `sgml-catalog-files', and `sgml-public-map'. This variable is automatically local to the buffer." :type '(repeat file) :group 'psgml-dtd) (make-variable-buffer-local 'sgml-local-catalogs) (put 'sgml-local-catalogs 'sgml-type 'file-list) ;; XEmacs chanage: use `split-path'. (defcustom sgml-catalog-files (split-path (or (getenv "SGML_CATALOG_FILES") ;; Wing/Krause addition (concat "CATALOG" path-separator (expand-file-name "CATALOG" sgml-data-directory)))) "*List of catalog entry files. The files are in the format defined in the SGML Open Draft Technical Resolution on Entity Management." :type '(repeat file) :group 'psgml-dtd) (put 'sgml-catalog-files 'sgml-type 'file-list) (defcustom sgml-ecat-files (list "ECAT" "~/sgml/ECAT" ;; XEmacs change (expand-file-name "ECAT" sgml-data-directory)) "*List of catalog files for PSGML." :type '(repeat file) :group 'psgml-dtd) (put 'sgml-ecat-files 'sgml-type 'file-list) (defcustom sgml-local-ecat-files nil "*List of local catalog files for PSGML. Automatically becomes buffer local if set." :type '(repeat file) :group 'psgml-dtd) (make-variable-buffer-local 'sgml-local-ecat-files) (put 'sgml-local-ecat-files 'sgml-type 'file-list) ;; XEmacs change: transliterate colons to hyphens for Windows reasons. (defcustom sgml-public-transliterations '((? . ?_) (?/ . ?%) (?: . ?-)) "*Transliteration for characters that should be avoided in file names. This is a list of dotted pairs (FROM . TO); where FROM is the the character to be translated to TO. This is used when parts of a public identifier are used to construct a file name." :type '(repeat (cons character character)) :group 'psgml-dtd) (defvar sgml-default-dtd-file nil "*This is the default file name for saved DTD. This is set by sgml-mode from the buffer file name. Can be changed in the Local variables section of the file.") (put 'sgml-default-dtd-file 'sgml-type 'string) (put 'sgml-default-dtd-file 'sgml-desc "Default (saved) DTD File") (defvar sgml-exposed-tags '() "*The list of tag names that remain visible, despite \\[sgml-hide-tags]. Each name is a lowercase string, and start-tags and end-tags must be listed individually. `sgml-exposed-tags' is local to each buffer in which it has been set; use `setq-default' to set it to a value that is shared among buffers.") (make-variable-buffer-local 'sgml-exposed-tags) (put 'sgml-exposed-tags 'sgml-type 'list) (defcustom sgml-custom-markup nil "*Menu entries to be added to the Markup menu. The value should be a list of lists of two strings. The first string is the menu line and the second string is the text inserted when the menu item is chosen. The second string can contain a \\r where the cursor should be left. Also if a selection is made according the same rules as for the Tags menu, the selection is replaced with the second string and \\r is replaced with the selection. Example: ((\"Version1\" \"\") (\"New page\" \"\")) " :type '(repeat (list :inline t (string :tag "Menu Line") (string :tag "Inserted String"))) :group 'psgml) (defcustom sgml-custom-dtd nil "Menu entries to be added to the DTD menu. The value should be a list of entries to be added to the DTD menu. Every entry should be a list. The first element of the entry is a string used as the menu entry. The second element is a string containing a doctype declaration (this can be nil if no doctype). The rest of the list should be a list of variables and values. For backward compatibility a single string instead of a variable is assigned to `sgml-default-dtd-file'. All variables are made buffer local and are also added to the buffers local variables list. Example: ((\"HTML\" nil sgml-default-dtd-file \"~/sgml/html.ced\" sgml-omittag nil sgml-shorttag nil) (\"HTML+\" \"\" \"~/sgml/htmlplus.ced\" sgml-omittag t sgml-shorttag nil) (\"DOCBOOK\" \"\" \"~/sgml/docbook.ced\" sgml-omittag nil sgml-shorttag t))) " :type '(repeat (list (string :tag "Menu Entry") (choice (const :tag "No doctype") (string :tag "Declaration")) (repeat :inline t (list :inline t (symbol :tag "Variable") (sexp :tag "Value"))))) :group 'psgml-dtd) ;;; Faces used in edit attribute buffer: (put 'sgml-default 'face 'underline) ; Face for #DEFAULT (put 'sgml-fixed 'face 'underline) ; Face of #FIXED "..." ;;; nsgmls is a free SGML parser in the SP suite available from ;;; ftp.jclark.com:pub/sp ;;; Its error messages can be parsed by next-error. ;;; The -s option suppresses output. ;; XEmacs change: (defcustom sgml-validate-command (concat "nsgmls -s -m " (expand-file-name "CATALOG" sgml-data-directory) " %s %s") "*The shell command to validate an SGML document. This is a `format' control string that by default should contain two `%s' conversion specifications: the first will be replaced by the value of `sgml-declaration' \(or the empty string, if nil\); the second will be replaced by the current buffer's file name \(or the empty string, if nil\). If `sgml-validate-files' is non-nil, the format string should contain one `%s' conversion specification for each element of its result. If sgml-validate-command is a list, then every element should be a string. The strings will be tried in order and %-sequences in the string will be replaced according to the list below, if the string contains %-sequences with no replacement value the next string will be tried. %b means the visited file of the current buffer %s means the SGML declaration specified in the `sgml-declaration' variable %d means the file containing the DOCTYPE declaration, if not in the buffer " :type '(choice string (repeat string)) :group 'psgml) (make-variable-buffer-local 'sgml-validate-command) (defcustom sgml-xml-validate-command "onsgmls -wxml -s %s %s" "*The shell command to validate an SGML document being edited in `xml-mode'. See `sgml-validate-command' for details." :type '(choice string (repeat string)) :group 'psgml) (defcustom sgml-validate-files nil "If non-nil, a function of no arguments that returns a list of file names. These file names will serve as the arguments to the `sgml-validate-command' format control string instead of the defaults." :type 'hook :group 'psgml) (defvar sgml-validate-error-regexps '((".*:\\(.+\\):\\([0-9]+\\):\\([0-9]+\\):[EXW]: " 1 2 3) ("\\(error\\|warning\\) at \\([^,]+\\), line \\([0-9]+\\)" 2 3) ("\n[a-zA-Z]?:?[^0-9 \n\t:]+:[ \t]*\\([^ \n\t:]+\\):\ \\([0-9]+\\):\\(\\([0-9]+\\)[: \t]\\)?" 1 2 4)) "Alist of regexps to recognize error messages from `sgml-validate'. See `compilation-error-regexp-alist'.") (defcustom sgml-declaration nil "*If non-nil, the name of the SGML declaration file." :type '(choice (const nil) file) :group 'psgml-dtd) (put 'sgml-declaration 'sgml-type 'file-or-nil) (defcustom sgml-xml-declaration nil "*If non-nil, the name of the SGML declaration for XML files." :type '(choice (const nil) file) :group 'psgml-dtd) (put 'sgml-xml-declaration 'sgml-type 'file-or-nil) (defcustom sgml-mode-hook nil "A hook or list of hooks to be run when entering `sgml-mode'." :type 'hook :group 'psgml) (defvar sgml-mode-map nil "Keymap for SGML mode") (defvar sgml-show-context-function 'sgml-show-context-standard "*Function to called to show context of and element. Should return a string suitable form printing in the echo area.") (defconst sgml-file-options '( sgml-omittag sgml-shorttag sgml-namecase-general sgml-general-insert-case sgml-minimize-attributes sgml-always-quote-attributes sgml-indent-step sgml-indent-data sgml-doctype sgml-parent-document sgml-default-dtd-file sgml-exposed-tags sgml-local-catalogs sgml-local-ecat-files ) "Options for the current file, can be saved or set from menu." ) (defconst sgml-user-options '( sgml-set-face sgml-live-element-indicator sgml-auto-activate-dtd sgml-offer-save sgml-tag-region-if-active sgml-normalize-trims sgml-auto-insert-required-elements sgml-balanced-tag-edit sgml-omittag-transparent sgml-leave-point-after-insert sgml-insert-missing-element-comment sgml-insert-end-tag-on-new-line sgml-warn-about-undefined-elements sgml-warn-about-undefined-entities sgml-ignore-undefined-elements sgml-recompile-out-of-date-cdtd sgml-default-doctype-name sgml-declaration sgml-validate-command sgml-markup-faces sgml-system-identifiers-are-preferred sgml-trace-entity-lookup sgml-system-path ;; XEmacs addition sgml-public-map sgml-catalog-files sgml-ecat-files sgml-general-insert-case ) "User options that can be saved or set from menu." ) ;;; Internal variables (defvar sgml-validate-command-history nil "The minibuffer history list for `sgml-validate''s COMMAND argument.") (defvar sgml-active-dtd-indicator nil "Displayed in the mode line") ;;;; User options handling (defun sgml-variable-description (var) (or (get var 'sgml-desc) (let ((desc (symbol-name var))) (if (string= "sgml-" (substring desc 0 5)) (setq desc (substring desc 5))) (loop for c across-ref desc do (if (eq c ?-) (setf c ? ))) (capitalize desc)))) (defun sgml-variable-type (var) (or (get var 'sgml-type) (if (memq (symbol-value var) '(t nil)) 'toggle))) (defun sgml-set-local-variable (var val) "Set the value of variable VAR to VAL in buffer and local variables list." (set (make-local-variable var) val) (save-excursion (let ((prefix "") (suffix "") (case-fold-search t)) (goto-char (max (point-min) (- (point-max) 3000))) (cond ((search-forward "Local Variables:" nil t) (setq suffix (buffer-substring (point) (save-excursion (end-of-line 1) (point)))) (setq prefix (buffer-substring (save-excursion (beginning-of-line 1) (point)) (match-beginning 0)))) (t (goto-char (point-max)) (unless (bolp) (insert ?\n)) (insert "\n") (forward-line -3))) (let* ((endpos (save-excursion (search-forward (format "\n%send:" prefix)))) (varpos (search-forward (format "\n%s%s:" prefix var) endpos t))) (cond (varpos (delete-region (point) (save-excursion (end-of-line 1) (point))) (insert (format "%S" val) suffix)) (t (goto-char endpos) (beginning-of-line 1) (insert prefix (format "%s:%S" var val) suffix ?\n))))))) (defun sgml-valid-option (var) (let ((type (sgml-variable-type var)) (val (symbol-value var))) (cond ((eq 'string type) (stringp val)) ((eq 'list-or-string type) (or (stringp val) (consp val))) (t t)))) (defun sgml-save-options () "Save user options for SGML mode that have buffer local values." (interactive) (loop for var in sgml-file-options do (when (sgml-valid-option var) (sgml-set-local-variable var (symbol-value var))))) ;;;; Run hook with args (unless (fboundp 'run-hook-with-args) (defun run-hook-with-args (hook &rest args) "Run HOOK with the specified arguments ARGS. HOOK should be a symbol, a hook variable. If HOOK has a non-nil value, that value may be a function or a list of functions to be called to run the hook. If the value is a function, it is called with the given arguments and its return value is returned. If it is a list of functions, those functions are called, in order, with the given arguments ARGS. It is best not to depend on the value return by `run-hook-with-args', as that may change." (and (boundp hook) (symbol-value hook) (let ((value (symbol-value hook))) (if (and (listp value) (not (eq (car value) 'lambda))) (mapcar '(lambda (foo) (apply foo args)) value) (apply value args)))))) ;;;; SGML mode: template functions (defun sgml-markup (entry text) (cons entry (` (lambda () (interactive) (sgml-insert-markup (, text)))))) (defun sgml-insert-markup (text) (let ((end (sgml-mouse-region)) before after old-text) (when end (setq old-text (buffer-substring (point) end)) (delete-region (point) end)) (setq before (point)) (if (stringp text) (insert text) (eval text)) (setq after (point)) (goto-char before) (when (search-forward "\r" after t) (delete-char -1)) (when old-text (insert old-text)))) (defun sgml-mouse-region () (let (start end) (cond (running-xemacs ;; XEmacs change (cond ((null (mark-marker)) nil) (t (setq start (region-beginning) end (region-end))))) ((and transient-mark-mode mark-active) (setq start (region-beginning) end (region-end))) ((and mouse-secondary-overlay (eq (current-buffer) (overlay-buffer mouse-secondary-overlay))) (setq start (overlay-start mouse-secondary-overlay) end (overlay-end mouse-secondary-overlay)) (delete-overlay mouse-secondary-overlay))) (when start (goto-char start)) end)) ;;;; SGML mode: indentation (defun sgml-indent-or-tab () "Indent line in proper way for current major mode." (interactive) (if (null sgml-indent-step) (insert-tab) (funcall indent-line-function))) ;;;; Bug reporting (eval-and-compile (autoload 'reporter-submit-bug-report "reporter")) (defun sgml-submit-bug-report () "Submit via mail a bug report on PSGML." (interactive) (and (y-or-n-p "Do you really want to submit a report on PSGML? ") (reporter-submit-bug-report psgml-maintainer-address (concat "psgml.el " psgml-version) (list 'major-mode 'sgml-always-quote-attributes 'sgml-auto-activate-dtd 'sgml-auto-insert-required-elements 'sgml-balanced-tag-edit 'sgml-catalog-files 'sgml-declaration 'sgml-doctype 'sgml-ecat-files 'sgml-indent-data 'sgml-indent-step 'sgml-leave-point-after-insert 'sgml-live-element-indicator 'sgml-local-catalogs 'sgml-local-ecat-files 'sgml-markup-faces 'sgml-minimize-attributes 'sgml-normalize-trims 'sgml-omittag 'sgml-omittag-transparent 'sgml-parent-document 'sgml-public-map 'sgml-set-face 'sgml-shorttag 'sgml-namecase-general 'sgml-tag-region-if-active 'sgml-use-text-properties )))) ;;;; SGML mode: syntax table (defvar sgml-mode-syntax-table (let ((s (copy-syntax-table text-mode-syntax-table))) (modify-syntax-entry ?< "." s) (modify-syntax-entry ?> "." s) s)) ;;;; SGML mode: keys and menus (if sgml-mode-map () (setq sgml-mode-map (make-sparse-keymap))) (defvar sgml-prefix-f-map (make-sparse-keymap)) (defvar sgml-prefix-u-map (make-sparse-keymap)) (define-key sgml-mode-map "\C-c\C-f" sgml-prefix-f-map) (define-key sgml-mode-map "\C-c\C-u" sgml-prefix-u-map) ;;; Key commands (define-key sgml-mode-map "\t" 'sgml-indent-or-tab) ;(define-key sgml-mode-map "<" 'sgml-insert-tag) (define-key sgml-mode-map ">" 'sgml-close-angle) (define-key sgml-mode-map "/" 'sgml-slash) (define-key sgml-mode-map "\C-c#" 'sgml-make-character-reference) (define-key sgml-mode-map "\C-c-" 'sgml-untag-element) (define-key sgml-mode-map "\C-c+" 'sgml-insert-attribute) (define-key sgml-mode-map "\C-c/" 'sgml-insert-end-tag) (define-key sgml-mode-map "\C-c<" 'sgml-insert-tag) (define-key sgml-mode-map "\C-c=" 'sgml-change-element-name) (define-key sgml-mode-map "\C-c\C-a" 'sgml-edit-attributes) (define-key sgml-mode-map "\C-c\C-c" 'sgml-show-context) (define-key sgml-mode-map "\C-c\C-d" 'sgml-next-data-field) (define-key sgml-mode-map "\C-c\C-e" 'sgml-insert-element) (define-key sgml-mode-map "\C-c\C-f\C-e" 'sgml-fold-element) (define-key sgml-mode-map "\C-c\C-f\C-r" 'sgml-fold-region) (define-key sgml-mode-map "\C-c\C-f\C-s" 'sgml-fold-subelement) (define-key sgml-mode-map "\C-c\C-f\C-x" 'sgml-expand-element) (define-key sgml-mode-map "\C-c\C-i" 'sgml-add-element-to-element) (define-key sgml-mode-map "\C-c\C-k" 'sgml-kill-markup) (define-key sgml-mode-map "\C-c\r" 'sgml-split-element) (define-key sgml-mode-map "\C-c\C-n" 'sgml-up-element) (define-key sgml-mode-map "\C-c\C-o" 'sgml-next-trouble-spot) (define-key sgml-mode-map "\C-c\C-p" 'sgml-load-doctype) (define-key sgml-mode-map "\C-c\C-q" 'sgml-fill-element) (define-key sgml-mode-map "\C-c\C-r" 'sgml-tag-region) (define-key sgml-mode-map "\C-c\C-s" 'sgml-show-structure) ;(define-key sgml-mode-map "\C-c\C-t" 'sgml-list-valid-tags) (define-key sgml-mode-map "\C-c\C-t" 'sgml-show-current-element-type) (define-key sgml-mode-map "\C-c\C-u\C-a" 'sgml-unfold-all) (define-key sgml-mode-map "\C-c\C-u\C-d" 'sgml-custom-dtd) (define-key sgml-mode-map "\C-c\C-u\C-e" 'sgml-unfold-element) (define-key sgml-mode-map "\C-c\C-u\C-l" 'sgml-unfold-line) (define-key sgml-mode-map "\C-c\C-u\C-m" 'sgml-custom-markup) (define-key sgml-mode-map "\C-c\C-v" 'sgml-validate) (define-key sgml-mode-map "\C-c\C-w" 'sgml-what-element) (define-key sgml-mode-map "\C-c\C-z" 'sgml-trim-and-leave-element) (define-key sgml-mode-map "\e\C-a" 'sgml-beginning-of-element) (define-key sgml-mode-map "\e\C-e" 'sgml-end-of-element) (define-key sgml-mode-map "\e\C-f" 'sgml-forward-element) (define-key sgml-mode-map "\e\C-b" 'sgml-backward-element) (define-key sgml-mode-map "\e\C-d" 'sgml-down-element) (define-key sgml-mode-map "\e\C-u" 'sgml-backward-up-element) (define-key sgml-mode-map "\e\C-k" 'sgml-kill-element) (define-key sgml-mode-map "\e\C-@" 'sgml-mark-element) ;;(define-key sgml-mode-map [?\M-\C-\ ] 'sgml-mark-element) (define-key sgml-mode-map [(meta control h)] 'sgml-mark-current-element) (define-key sgml-mode-map "\e\C-t" 'sgml-transpose-element) (define-key sgml-mode-map "\M-\t" 'sgml-complete) ;;;; Menu bar (easy-menu-define sgml-main-menu sgml-mode-map "Main menu" '("SGML" ["Parse DTD" sgml-parse-prolog t] ("DTD Info" ["General DTD info" sgml-general-dtd-info t] ["Describe element type" sgml-describe-element-type t] ["Describe entity" sgml-describe-entity t] ["List elements" sgml-list-elements t] ["List attributes" sgml-list-attributes t] ["List terminals" sgml-list-terminals t] ["List content elements" sgml-list-content-elements t] ["List occur in elements" sgml-list-occur-in-elements t]) ("Insert Markup" ["Insert Element" sgml-element-menu t] ["Insert Start-Tag" sgml-start-tag-menu t] ["Insert End-Tag" sgml-end-tag-menu t] ["End Current Element" sgml-insert-end-tag t] ["Tag Region" sgml-tag-region-menu t] ["Insert Attribute" sgml-attrib-menu t] ["Insert Entity" sgml-entities-menu t] ["Add Element to Element" sgml-add-element-menu t] ("Insert DTD") ("Custom markup" "---")) "--" ["Show Context" sgml-show-context t] ["What Element" sgml-what-element t] ["List Valid Tags" sgml-list-valid-tags t] ["Validate" sgml-validate t] "--" ("Move" ["Next trouble spot" sgml-next-trouble-spot t] ["Next data field" sgml-next-data-field t] ["Forward element" sgml-forward-element t] ["Backward element" sgml-backward-element t] ["Up element" sgml-up-element t] ["Down element" sgml-down-element t] ["Backward up element" sgml-backward-up-element t] ["Beginning of element" sgml-beginning-of-element t] ["End of element" sgml-end-of-element t]) ("View" ["Fold Element" sgml-fold-element t] ["Fold Subelement" sgml-fold-subelement t] ["Unfold Line" sgml-unfold-line t] ["Unfold Element" sgml-unfold-element t] ["Expand" sgml-expand-element t] ["Fold Region" sgml-fold-region t] ["Unfold All" sgml-unfold-all t] ["Hide Tags" sgml-hide-tags t] ["Hide Attributes" sgml-hide-attributes t] ["Show All Tags" sgml-show-tags t]) "--" ["Normalize Document" sgml-normalize t] ["Normalize Element" sgml-normalize-element t] ["Expand All Short References" sgml-expand-all-shortrefs (not sgml-xml-p)] ["Expand Entity Reference" sgml-expand-entity-reference t] ["Make Character Reference" sgml-make-character-reference t] ["Unmake Character Reference" (sgml-make-character-reference t) t] ["Fill Element" sgml-fill-element t] ["Change Element Name..." sgml-change-element-name t] ["Edit Attributes..." sgml-edit-attributes t] ["Kill Markup" sgml-kill-markup t] ["Kill Element" sgml-kill-element t] ["Untag Element" sgml-untag-element t] ["Trim and leave element" sgml-trim-and-leave-element t] ["Decode Character Entities" sgml-charent-to-display-char t] ["Encode Characters" sgml-display-char-to-charent t] "--" ("File Options" "---") ("User Options" "---") ["Reset Buffer" normal-mode t] ["Submit Bug Report" sgml-submit-bug-report t] )) ;; XEmacs change: psgml-xemacs hasn't been necessarily pulled in before ;; we need this. (eval-and-compile (and running-xemacs (autoload 'sgml-make-options-menu "psgml-xemacs"))) (defun sgml-options-menu-items (vars) ;; XEmacs change: use sgml-make-options-menu on XEmacs (if running-xemacs (sgml-make-options-menu vars) (mapcar (lambda (var) (let ((desc (format "%s [%s]" (sgml-variable-description var) (sgml-option-value-indicator var))) (type (sgml-variable-type var))) (cond ((consp type) (cons desc (mapcar (lambda (c) (vector (if (consp c) (car c) (format "%s" c)) `(setq ,var ',(if (consp c) (cdr c) c)) t)) type))) (t (vector desc `(sgml-do-set-option ',var) t))))) vars))) (defun sgml-option-value-indicator (var) (let ((type (sgml-variable-type var)) (val (symbol-value var))) (cond ((eq type 'toggle) (if val "Yes" "No")) ((eq type 'string) (if (stringp val) (substring val 0 (min (length val) 4)) "-")) ((and (atom type) val) "...") ((consp type) (or (car (rassq val type)) val)) (t "-")))) (defvar sgml-last-options-menu-values ()) (defun sgml-any-option-changed (oldvalues vars) (not (loop for val in oldvalues for var in vars always (eq val (symbol-value var))))) (defun sgml-update-options-menu (menuname option-vars &optional save-func) (let ((last-values (assoc menuname sgml-last-options-menu-values))) (when (or (null last-values) (sgml-any-option-changed (cdr last-values) option-vars)) (condition-case err ;; XEmacs change: `sgml-menu-name' (easy-menu-change (list sgml-menu-name) menuname (nconc (sgml-options-menu-items option-vars) (if save-func (list "---" (vector (format "Save %s" menuname) save-func t))))) (error (message "Error in update menu: %s" err))) (unless last-values (setq last-values (cons menuname nil)) (push last-values sgml-last-options-menu-values)) (setf (cdr last-values) (mapcar (function symbol-value) option-vars))))) (defun sgml-update-all-options-menus () (sgml-update-options-menu "File Options" sgml-file-options 'sgml-save-options) (sgml-update-options-menu "User Options" sgml-user-options) nil) (defun sgml-compute-insert-dtd-items () (loop for e in sgml-custom-dtd collect (vector (first e) (` (sgml-doctype-insert (, (cadr e)) '(, (cddr e)))) t))) (defun sgml-compute-custom-markup-items () (loop for e in sgml-custom-markup collect (vector (first e) (` (sgml-insert-markup (, (cadr e)))) t))) (defun sgml-build-custom-menus () "Build custom parts of Markup and DTD menus." (let ((button3 (lookup-key (current-local-map) [button3]))) (unless (or (null button3) (numberp button3)) (local-set-key [button3] button3)) (when sgml-custom-dtd (easy-menu-change '("SGML" "Insert Markup") "Insert DTD" (sgml-compute-insert-dtd-items))) (when sgml-custom-markup (easy-menu-change '("SGML" "Insert Markup") "Custom markup" (sgml-compute-custom-markup-items)))) nil) ;;;; Post command hook (defvar sgml-auto-activate-dtd-tried nil) (make-variable-buffer-local 'sgml-auto-activate-dtd-tried) (defvar sgml-buffer-parse-state nil "If the buffers DTD has been activated this contains the parser state. The parser state has been created with `sgml-make-pstate' and contains the information about the DTD and the parse tree. This parse state is actually only the state that persists between commands.") (make-variable-buffer-local 'sgml-buffer-parse-state) (eval-and-compile ; Interface to psgml-parse (loop for fun in '(sgml-need-dtd sgml-update-display sgml-fontify-buffer sgml-subst-expand sgml-declaration) do (autoload fun "psgml-parse"))) (defun sgml-command-post () (when (and (null sgml-buffer-parse-state) sgml-auto-activate-dtd (null sgml-auto-activate-dtd-tried) (not (zerop (buffer-size))) (looking-at ".*<")) (setq sgml-auto-activate-dtd-tried t) (ignore-errors (sgml-need-dtd) (sgml-fontify-buffer 0))) (when sgml-buffer-parse-state (sgml-update-display))) ;;;; SGML mode: major mode definition ;;; This section is mostly from sgml-mode by James Clark. ;;;###autoload (defun sgml-mode () "Major mode for editing SGML. \\Makes > display the matching <. Makes / display matching /. Use \\[sgml-validate] to validate your document with an SGML parser. You can find information with: \\[sgml-show-context] Show the nesting of elements at cursor position. \\[sgml-list-valid-tags] Show the tags valid at cursor position. Insert tags with completion of contextually valid tags with \\[sgml-insert-tag]. End the current element with \\[sgml-insert-end-tag]. Insert an element (i.e. both start and end tag) with \\[sgml-insert-element]. Or tag a region with \\[sgml-tag-region]. To tag a region with the mouse, use transient mark mode or secondary selection. Structure editing: \\[sgml-backward-element] Moves backwards over the previous element. \\[sgml-forward-element] Moves forward over the next element. \\[sgml-down-element] Move forward and down one level in the element structure. \\[sgml-backward-up-element] Move backward out of this element level. \\[sgml-beginning-of-element] Move to after the start tag of the current element. \\[sgml-end-of-element] Move to before the end tag of the current element. \\[sgml-kill-element] Kill the element following the cursor. Finding interesting positions \\[sgml-next-data-field] Move forward to next point where data is allowed. \\[sgml-next-trouble-spot] Move forward to next point where something is amiss with the structure. Folding and unfolding \\[sgml-fold-element] Fold the lines comprising the current element, leaving the first line visible. \\[sgml-fold-subelement] Fold the elements in the content of the current element. Leaving the first line of every element visible. \\[sgml-unfold-line] Show hidden lines in current line. User options: sgml-omittag Set this to reflect OMITTAG in the SGML declaration. sgml-shorttag Set this to reflect SHORTTAG in the SGML declaration. sgml-namecase-general Set this to reflect NAMECASE GENERAL in the SGML declaration. sgml-auto-insert-required-elements If non-nil, automatically insert required elements in the content of an inserted element. sgml-balanced-tag-edit If non-nil, always insert start-end tag pairs. sgml-omittag-transparent If non-nil, will show legal tags inside elements with omitable start tags and legal tags beyond omitable end tags. sgml-leave-point-after-insert If non-nil, the point will remain after inserted tag(s). sgml-warn-about-undefined-elements If non-nil, print a warning when a tag for a undefined element is found. sgml-max-menu-size Max number of entries in Tags and Entities menus before they are split into several panes. sgml-always-quote-attributes If non-nil, quote all attribute values inserted after finishing edit attributes. sgml-minimize-attributes Determines minimization of attributes inserted by edit-attributes. sgml-normalize-trims If non-nil, sgml-normalize will trim off white space from end of element when adding end tag. sgml-indent-step How much to increment indent for every element level. sgml-indent-data If non-nil, indent in data/mixed context also. sgml-set-face If non-nil, psgml will set the face of parsed markup. sgml-markup-faces The faces used when the above variable is non-nil. sgml-system-path List of directories used to look for system identifiers. sgml-public-map Mapping from public identifiers to file names. sgml-offer-save If non-nil, ask about saving modified buffers before \\[sgml-validate] is run. All bindings: \\{sgml-mode-map}" (interactive) (kill-all-local-variables) (setq sgml-xml-p nil) (setq local-abbrev-table sgml-mode-abbrev-table) (use-local-map sgml-mode-map) (setq mode-name "SGML") (setq major-mode 'sgml-mode) ;; A start or end tag by itself on a line separates a paragraph. ;; This is desirable because SGML discards a newline that appears ;; immediately after a start tag or immediately before an end tag. (set (make-local-variable 'paragraph-separate) (if sgml-have-re-char-clases "^[ \t\n]*$\\|\ ^[ \t]*$" "^[ \t\n]*$\\|\ ^[ \t]*$")) (set (make-local-variable 'paragraph-start) paragraph-separate) (set-syntax-table sgml-mode-syntax-table) (make-local-variable 'comment-start) (setq comment-start "") (make-local-variable 'comment-indent-function) (setq comment-indent-function 'sgml-comment-indent) (make-local-variable 'comment-start-skip) ;; This will allow existing comments within declarations to be ;; recognized. [Does not work well with auto-fill, Lst/940205] ;;(setq comment-start-skip "--[ \t]*") (setq comment-start-skip "