Mercurial > emacs
annotate lisp/nxml/nxml-ns.el @ 101510:89895e7b4ac6
Add an introductory comment.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Mon, 26 Jan 2009 02:48:23 +0000 |
parents | a9dc0e7c3f2b |
children | 1d1d5d9bd884 |
rev | line source |
---|---|
86361 | 1 ;;; nxml-ns.el --- XML namespace processing |
2 | |
100908 | 3 ;; Copyright (C) 2003, 2007, 2008, 2009 Free Software Foundation, Inc. |
86361 | 4 |
5 ;; Author: James Clark | |
6 ;; Keywords: XML | |
7 | |
86539 | 8 ;; This file is part of GNU Emacs. |
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 |
86539 | 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 | 14 |
86539 | 15 ;; GNU Emacs is distributed in the hope that it will be useful, |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
86361 | 19 |
86539 | 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 | 22 |
23 ;;; Commentary: | |
24 | |
25 ;; This file uses a prefix of `nxml-ns'. | |
26 | |
27 ;;; Code: | |
28 | |
29 (require 'nxml-util) | |
30 | |
31 (defvar nxml-ns-state nil | |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
32 "Contains the state of namespace processing. |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
33 The state is never modified destructively and so can be saved and |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
34 restored without copying. |
86361 | 35 |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
36 The value is a stack represented by a list. The list has length |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
37 N + 1 where N is the number of open elements. Each member of the |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
38 list represents the bindings in effect for a particular element. |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
39 Each member is itself a list whose car is the default namespace |
86361 | 40 \(a symbol or nil) and whose cdr is an alist of (PREFIX . NS) pairs |
41 where PREFIX is a string (never nil) and NS is the namespace URI | |
42 symbol.") | |
43 | |
44 (defconst nxml-ns-initial-state | |
45 (list (list nil (cons "xml" nxml-xml-namespace-uri))) | |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
46 "A list to be used as the initial value of `nxml-ns-state'. |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
47 This represents the state with no open elements and with the default |
86361 | 48 namespace bindings (no default namespace and only the xml prefix bound).") |
49 | |
50 (defsubst nxml-ns-state () nxml-ns-state) | |
51 | |
52 (defsubst nxml-ns-set-state (state) | |
53 (setq nxml-ns-state state)) | |
54 | |
55 (defsubst nxml-ns-state-equal (state) | |
56 (equal nxml-ns-state state)) | |
57 | |
58 (defmacro nxml-ns-save (&rest body) | |
59 `(let ((nxml-ns-state nxml-ns-initial-state)) | |
60 ,@body)) | |
61 | |
62 (put 'nxml-ns-save 'lisp-indent-function 0) | |
63 (def-edebug-spec nxml-ns-save t) | |
64 | |
65 (defun nxml-ns-init () | |
66 (setq nxml-ns-state nxml-ns-initial-state)) | |
67 | |
68 (defun nxml-ns-push-state () | |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
69 "Change the state by starting a new element. |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
70 Namespace declarations are inherited from the parent state." |
86361 | 71 (setq nxml-ns-state (cons (car nxml-ns-state) nxml-ns-state))) |
72 | |
73 (defun nxml-ns-pop-state () | |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
74 "Change the state by ending an element. |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
75 The behavior is undefined if there is no open element." |
86361 | 76 (setq nxml-ns-state (cdr nxml-ns-state))) |
77 | |
78 (defun nxml-ns-get-prefix (prefix) | |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
79 "Return the symbol for namespace bound to PREFIX. |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
80 Return nil if PREFIX is unbound. PREFIX is a string, never nil." |
86361 | 81 (let ((binding (assoc prefix (cdar nxml-ns-state)))) |
82 (and binding (cdr binding)))) | |
83 | |
84 (defun nxml-ns-set-prefix (prefix ns) | |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
85 "Change the binding of PREFIX. |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
86 PREFIX is a string (never nil). NS is a symbol (never nil). |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
87 The change will be in effect until the end of the current element." |
86361 | 88 (setq nxml-ns-state |
89 (let ((bindings (car nxml-ns-state))) | |
90 (cons (cons (car bindings) | |
91 (cons (cons prefix ns) (cdr bindings))) | |
92 (cdr nxml-ns-state))))) | |
93 | |
94 (defun nxml-ns-get-default () | |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
95 "Return the current default namespace as a symbol. |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
96 Return nil if there is no default namespace." |
86361 | 97 (caar nxml-ns-state)) |
98 | |
99 (defun nxml-ns-set-default (ns) | |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
100 "Changes the current default namespace. |
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
101 The change will be in effect until the end of the current element. |
86361 | 102 NS is a symbol or nil." |
103 (setq nxml-ns-state | |
104 (cons (cons ns (cdar nxml-ns-state)) | |
105 (cdr nxml-ns-state)))) | |
106 | |
107 (defun nxml-ns-get-context () | |
108 (car nxml-ns-state)) | |
109 | |
110 (defun nxml-ns-prefixes-for (ns &optional attributep) | |
111 (let ((current (car nxml-ns-state)) | |
112 prefixes) | |
113 (when (if attributep | |
114 (not ns) | |
115 (eq (car current) ns)) | |
116 (setq prefixes '(nil))) | |
117 (setq current (cdr current)) | |
118 (while (let ((binding (rassq ns current))) | |
119 (when binding | |
120 (when (eq (nxml-ns-get-prefix (car binding)) ns) | |
121 (add-to-list 'prefixes | |
122 (car binding))) | |
123 (setq current | |
124 (cdr (member binding current)))))) | |
125 prefixes)) | |
126 | |
127 (defun nxml-ns-prefix-for (ns) | |
128 (car (rassq ns (cdar nxml-ns-state)))) | |
129 | |
130 (defun nxml-ns-changed-prefixes () | |
131 (let ((old (cadr nxml-ns-state)) | |
132 (new (car nxml-ns-state)) | |
133 changed) | |
134 (if (eq old new) | |
135 nil | |
136 (unless (eq (car new) (car old)) | |
137 (setq changed '(nil))) | |
138 (setq new (cdr new)) | |
139 (setq old (cdr old)) | |
140 (while (not (eq new old)) | |
141 (setq changed | |
142 (cons (caar new) changed)) | |
143 (setq new (cdr new)))) | |
144 changed)) | |
96496
e374c747704b
Fix typos, and general docstring cleanup.
Juanma Barranquero <lekktu@gmail.com>
parents:
96376
diff
changeset
|
145 |
86361 | 146 (provide 'nxml-ns) |
147 | |
86379 | 148 ;; arch-tag: 5968e4b7-fb37-46ce-8621-c65db9793028 |
86361 | 149 ;;; nxml-ns.el ends here |