annotate lisp/nxml/nxml-util.el @ 106815:1d1d5d9bd884

Add 2010 to copyright years.
author Glenn Morris <rgm@gnu.org>
date Wed, 13 Jan 2010 00:35:10 -0800
parents a9dc0e7c3f2b
children 376148b31b5e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
1 ;;; nxml-util.el --- utility functions for nxml-*.el
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
2
106815
1d1d5d9bd884 Add 2010 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
3 ;; Copyright (C) 2003, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
4
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
5 ;; Author: James Clark
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
6 ;; Keywords: XML
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
7
86544
b4afd9aef830 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 86379
diff changeset
8 ;; This file is part of GNU Emacs.
b4afd9aef830 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 86379
diff changeset
9
94666
d495d4d5452f Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87665
diff changeset
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
86544
b4afd9aef830 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 86379
diff changeset
11 ;; it under the terms of the GNU General Public License as published by
94666
d495d4d5452f Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87665
diff changeset
12 ;; the Free Software Foundation, either version 3 of the License, or
d495d4d5452f Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87665
diff changeset
13 ;; (at your option) any later version.
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
14
86544
b4afd9aef830 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 86379
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
b4afd9aef830 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 86379
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
b4afd9aef830 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 86379
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b4afd9aef830 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 86379
diff changeset
18 ;; GNU General Public License for more details.
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
19
86544
b4afd9aef830 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 86379
diff changeset
20 ;; You should have received a copy of the GNU General Public License
94666
d495d4d5452f Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87665
diff changeset
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
22
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
23 ;;; Commentary:
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
24
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
25 ;;; Code:
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
26
95598
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
27 (defconst nxml-debug nil
96496
e374c747704b Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents: 95599
diff changeset
28 "Enable nxml debugging. Effective only at compile time.")
95598
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
29
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
30 (defsubst nxml-debug (format &rest args)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
31 (when nxml-debug
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
32 (apply #'message format args)))
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
33
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
34 (defmacro nxml-debug-change (name start end)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
35 (when nxml-debug
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
36 `(nxml-debug "%s: %S" ,name
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
37 (buffer-substring-no-properties ,start ,end))))
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
38
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
39 (defmacro nxml-debug-set-inside (start end)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
40 (when nxml-debug
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
41 `(let ((overlay (make-overlay ,start ,end)))
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
42 (overlay-put overlay 'face '(:background "red"))
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
43 (overlay-put overlay 'nxml-inside-debug t)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
44 (nxml-debug-change "nxml-set-inside" ,start ,end))))
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
45
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
46 (defmacro nxml-debug-clear-inside (start end)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
47 (when nxml-debug
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
48 `(loop for overlay in (overlays-in ,start ,end)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
49 if (overlay-get overlay 'nxml-inside-debug)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
50 do (delete-overlay overlay)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
51 finally (nxml-debug-change "nxml-clear-inside" ,start ,end))))
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
52
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
53 (defun nxml-make-namespace (str)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
54 "Return a symbol for the namespace URI STR.
96496
e374c747704b Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents: 95599
diff changeset
55 STR must be a string. If STR is the empty string, return nil.
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
56 Otherwise, return the symbol whose name is STR prefixed with a colon."
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
57 (if (string-equal str "")
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
58 nil
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
59 (intern (concat ":" str))))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
60
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
61 (defun nxml-namespace-name (ns)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
62 "Return the namespace URI corresponding to the symbol NS.
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
63 This is the inverse of `nxml-make-namespace'."
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
64 (and ns (substring (symbol-name ns) 1)))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
65
95598
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
66 (defconst nxml-xml-namespace-uri
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
67 (nxml-make-namespace "http://www.w3.org/XML/1998/namespace"))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
68
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
69 (defconst nxml-xmlns-namespace-uri
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
70 (nxml-make-namespace "http://www.w3.org/2000/xmlns/"))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
71
95598
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
72 (defmacro nxml-with-degradation-on-error (context &rest body)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
73 (if (not nxml-debug)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
74 (let ((error-symbol (make-symbol "err")))
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
75 `(condition-case ,error-symbol
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
76 (progn ,@body)
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
77 (error
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
78 (nxml-degrade ,context ,error-symbol))))
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
79 `(progn ,@body)))
8c4c0ca00399 nXML: Use font lock
Michael Olson <mwolson@gnu.org>
parents: 94666
diff changeset
80
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
81 (defmacro nxml-with-unmodifying-text-property-changes (&rest body)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
82 "Evaluate BODY without any text property changes modifying the buffer.
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
83 Any text properties changes happen as usual but the changes are not treated as
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
84 modifications to the buffer."
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
85 (let ((modified (make-symbol "modified")))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
86 `(let ((,modified (buffer-modified-p))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
87 (inhibit-read-only t)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
88 (inhibit-modification-hooks t)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
89 (buffer-undo-list t)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
90 (deactivate-mark nil)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
91 ;; Apparently these avoid file locking problems.
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
92 (buffer-file-name nil)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
93 (buffer-file-truename nil))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
94 (unwind-protect
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
95 (progn ,@body)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
96 (unless ,modified
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
97 (restore-buffer-modified-p nil))))))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
98
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
99 (put 'nxml-with-unmodifying-text-property-changes 'lisp-indent-function 0)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
100 (def-edebug-spec nxml-with-unmodifying-text-property-changes t)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
101
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
102 (defmacro nxml-with-invisible-motion (&rest body)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
103 "Evaluate body without calling any point motion hooks."
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
104 `(let ((inhibit-point-motion-hooks t))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
105 ,@body))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
106
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
107 (put 'nxml-with-invisible-motion 'lisp-indent-function 0)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
108 (def-edebug-spec nxml-with-invisible-motion t)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
109
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
110 (defun nxml-display-file-parse-error (err)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
111 (let* ((filename (nth 1 err))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
112 (buffer (find-file-noselect filename))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
113 (pos (nth 2 err))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
114 (message (nth 3 err)))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
115 (pop-to-buffer buffer)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
116 ;; What's the right thing to do if the buffer's modified?
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
117 ;; The position in the saved file could be completely different.
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
118 (goto-char (if (buffer-modified-p) 1 pos))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
119 (error "%s" message)))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
120
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
121 (defun nxml-signal-file-parse-error (file pos message &optional error-symbol)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
122 (signal (or error-symbol 'nxml-file-parse-error)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
123 (list file pos message)))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
124
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
125 (put 'nxml-file-parse-error
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
126 'error-conditions
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
127 '(error nxml-file-parse-error))
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
128
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
129 (put 'nxml-parse-file-error
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
130 'error-message
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
131 "Error parsing file")
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
132
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
133 (provide 'nxml-util)
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
134
86379
2ac1a9b70580 Add arch tagline
Miles Bader <miles@gnu.org>
parents: 86361
diff changeset
135 ;; arch-tag: 7d3b3af4-de2b-4410-bf67-94d64824324b
86361
38f93f3d00a2 Initial merge of nxml
Mark A. Hershberger <mah@everybody.org>
parents:
diff changeset
136 ;;; nxml-util.el ends here