nxml-ns.el 4.62 KB
Newer Older
1
;;; nxml-ns.el --- XML namespace processing  -*- lexical-binding:t -*-
Mark A. Hershberger's avatar
Mark A. Hershberger committed
2

3
;; Copyright (C) 2003, 2007-2014 Free Software Foundation, Inc.
Mark A. Hershberger's avatar
Mark A. Hershberger committed
4 5 6 7

;; Author: James Clark
;; Keywords: XML

Glenn Morris's avatar
Glenn Morris committed
8
;; This file is part of GNU Emacs.
Mark A. Hershberger's avatar
Mark A. Hershberger committed
9

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Glenn Morris's avatar
Glenn Morris committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Mark A. Hershberger's avatar
Mark A. Hershberger committed
14

Glenn Morris's avatar
Glenn Morris committed
15 16 17 18 19 20
;; GNU Emacs 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
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Mark A. Hershberger's avatar
Mark A. Hershberger committed
22 23 24 25 26 27 28 29 30 31

;;; Commentary:

;; This file uses a prefix of `nxml-ns'.

;;; Code:

(require 'nxml-util)

(defvar nxml-ns-state nil
32 33 34 35 36 37 38 39
  "Contains the state of namespace processing.
The state is never modified destructively and so can be saved and
restored without copying.

The value is a stack represented by a list.  The list has length
N + 1 where N is the number of open elements.  Each member of the
list represents the bindings in effect for a particular element.
Each member is itself a list whose car is the default namespace
Mark A. Hershberger's avatar
Mark A. Hershberger committed
40 41 42 43 44 45
\(a symbol or nil) and whose cdr is an alist of (PREFIX . NS) pairs
where PREFIX is a string (never nil) and NS is the namespace URI
symbol.")

(defconst nxml-ns-initial-state
  (list (list nil (cons "xml" nxml-xml-namespace-uri)))
46 47
  "A list to be used as the initial value of `nxml-ns-state'.
This represents the state with no open elements and with the default
Mark A. Hershberger's avatar
Mark A. Hershberger committed
48 49 50 51 52 53 54 55 56 57 58
namespace bindings (no default namespace and only the xml prefix bound).")

(defsubst nxml-ns-state () nxml-ns-state)

(defsubst nxml-ns-set-state (state)
  (setq nxml-ns-state state))

(defsubst nxml-ns-state-equal (state)
  (equal nxml-ns-state state))

(defmacro nxml-ns-save (&rest body)
59
  (declare (indent 0) (debug t))
Mark A. Hershberger's avatar
Mark A. Hershberger committed
60 61 62 63 64 65 66
  `(let ((nxml-ns-state nxml-ns-initial-state))
     ,@body))

(defun nxml-ns-init ()
  (setq nxml-ns-state nxml-ns-initial-state))

(defun nxml-ns-push-state ()
67 68
  "Change the state by starting a new element.
Namespace declarations are inherited from the parent state."
Mark A. Hershberger's avatar
Mark A. Hershberger committed
69 70 71
  (setq nxml-ns-state (cons (car nxml-ns-state) nxml-ns-state)))

(defun nxml-ns-pop-state ()
72 73
  "Change the state by ending an element.
The behavior is undefined if there is no open element."
Mark A. Hershberger's avatar
Mark A. Hershberger committed
74 75 76
  (setq nxml-ns-state (cdr nxml-ns-state)))

(defun nxml-ns-get-prefix (prefix)
77 78
  "Return the symbol for namespace bound to PREFIX.
Return nil if PREFIX is unbound.  PREFIX is a string, never nil."
Mark A. Hershberger's avatar
Mark A. Hershberger committed
79 80 81 82
  (let ((binding (assoc prefix (cdar nxml-ns-state))))
    (and binding (cdr binding))))

(defun nxml-ns-set-prefix (prefix ns)
83 84 85
  "Change the binding of PREFIX.
PREFIX is a string (never nil).  NS is a symbol (never nil).
The change will be in effect until the end of the current element."
Mark A. Hershberger's avatar
Mark A. Hershberger committed
86 87 88 89 90 91 92
  (setq nxml-ns-state
	(let ((bindings (car nxml-ns-state)))
	  (cons (cons (car bindings)
		      (cons (cons prefix ns) (cdr bindings)))
		(cdr nxml-ns-state)))))

(defun nxml-ns-get-default ()
93 94
  "Return the current default namespace as a symbol.
Return nil if there is no default namespace."
Mark A. Hershberger's avatar
Mark A. Hershberger committed
95 96 97
  (caar nxml-ns-state))

(defun nxml-ns-set-default (ns)
98 99
  "Changes the current default namespace.
The change will be in effect until the end of the current element.
Mark A. Hershberger's avatar
Mark A. Hershberger committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
NS is a symbol or nil."
  (setq nxml-ns-state
	(cons (cons ns (cdar nxml-ns-state))
	      (cdr nxml-ns-state))))

(defun nxml-ns-get-context ()
  (car nxml-ns-state))

(defun nxml-ns-prefixes-for (ns &optional attributep)
  (let ((current (car nxml-ns-state))
	prefixes)
    (when (if attributep
	      (not ns)
	    (eq (car current) ns))
      (setq prefixes '(nil)))
    (setq current (cdr current))
    (while (let ((binding (rassq ns current)))
	     (when binding
118 119 120 121 122 123
               (let ((prefix (car binding)))
                 (when (eq (nxml-ns-get-prefix prefix) ns)
                   (unless (member prefix prefixes)
                     (push prefix prefixes))))
               (setq current
                     (cdr (member binding current))))))
Mark A. Hershberger's avatar
Mark A. Hershberger committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
    prefixes))

(defun nxml-ns-prefix-for (ns)
  (car (rassq ns (cdar nxml-ns-state))))

(defun nxml-ns-changed-prefixes ()
  (let ((old (cadr nxml-ns-state))
	(new (car nxml-ns-state))
	changed)
    (if (eq old new)
	nil
      (unless (eq (car new) (car old))
	(setq changed '(nil)))
      (setq new (cdr new))
      (setq old (cdr old))
      (while (not (eq new old))
	(setq changed
	      (cons (caar new) changed))
	(setq new (cdr new))))
    changed))
144

Mark A. Hershberger's avatar
Mark A. Hershberger committed
145 146 147
(provide 'nxml-ns)

;;; nxml-ns.el ends here