setup/nxml.el

   1 (defvar nxml-where-elements-to-id 3)
   2 (defvar nxml-where-max-elements 6)
   3
   4 (require 'cl)
   5
   6 (defun nxml-where ()
   7   "Display the hierarchy of XML elements the point is on as a path."
   8   (and (eq major-mode 'nxml-mode)
   9            (let (path-to-id path-rest)
  10                  (save-excursion
  11                    (save-restriction
  12                          (widen)
  13                          (while (and (not (bobp))
  14                                                  (condition-case nil (progn (nxml-backward-up-element) t) (error nil)))
  15                            (multiple-value-bind
  16                                    (has-id step)
  17                                    (loop with has-id = nil
  18                          with step = (xmltok-start-tag-local-name)
  19                                              for att in xmltok-attributes
  20                                                  if (string= (xmltok-attribute-local-name att) "id")
  21                                                  return (values t (concat "\"" (xmltok-attribute-value att) "\""))
  22                                                  else if (string= (xmltok-attribute-local-name att) "name")
  23                                                  do (setq has-id t step (concat "\"" (xmltok-attribute-value att) "\""))
  24                                                  finally return (values has-id step ))
  25                                  (if (or path-to-id has-id)
  26                                          (setq path-to-id (cons step path-to-id))
  27                                    (setq path-rest (cons step path-rest)))))))
  28                  (let ((path-to-id-len (length path-to-id))
  29                            (path-rest-len (length path-rest)))
  30                    (if (> path-to-id-len nxml-where-elements-to-id)
  31                            (progn
  32                                  (setq path-to-id (nthcdr (- path-to-id-len nxml-where-elements-to-id -1) path-to-id))
  33                                  (setq path-to-id (cons "..." path-to-id))
  34                                  (setq path-to-id-len nxml-where-elements-to-id))
  35                          (setq path-to-id (cons "" path-to-id)))
  36                    (when (> (+ path-to-id-len path-rest-len) nxml-where-max-elements)
  37                          (setq path-rest (nbutlast path-rest (- path-rest-len (- nxml-where-max-elements path-to-id-len) -1)))
  38                          (setq path-rest (nconc path-rest (list "...")))))
  39                  (mapconcat 'identity (nconc path-to-id path-rest) "/"))))
  40
  41 (require 'which-func)
  42
  43 (add-to-list 'which-func-functions 'nxml-where)
  44 (add-to-list 'which-func-modes 'nxml-mode)
  45 (add-to-list 'which-func-non-auto-modes 'nxml-mode)
  46
  47 (add-to-list 'auto-mode-alist '("\\.xslt?\\'" . nxml-mode))
  48 (add-to-list 'auto-mode-alist '("\\.xsd\\'" . nxml-mode))
  49
  50 (require 'hideshow)
  51
  52 (add-to-list 'hs-special-modes-alist '(nxml-mode ("\\(<[^/>]*>\\)$" 1)
  53                                                                                                  "</[^/>]*>$"))
  54 (defun nxml-enable-hs ()
  55   (setq nxml-sexp-element-flag t)
  56   (hs-minor-mode 1))
  57
  58 (add-hook 'nxml-mode-hook 'nxml-enable-hs)
  59
  60 (defun hs-nxml-enter ()
  61   (interactive)
  62   (when (hs-already-hidden-p)
  63         (hs-show-block)
  64         (hs-hide-level 1)
  65         (nxml-forward-element)
  66         (nxml-backward-element)))
  67
  68 (defun hs-nxml-leave ()
  69   (interactive)
  70   (nxml-backward-up-element)
  71   (hs-hide-block)
  72   (nxml-backward-up-element))
  73
  74 (defun hs-nxml-hide-other ()
  75   (interactive)
  76   (let ((p (point)))
  77     (hs-hide-all)
  78     (while (progn (goto-char p) (hs-already-hidden-p))
  79       (hs-nxml-enter))
  80     (hs-show-block)
  81     (goto-char p)
  82     (recenter-top-bottom)))
  83
  84 (define-key nxml-mode-map (kbd "\C-c <left>") 'hs-nxml-leave)
  85 (define-key nxml-mode-map (kbd "\C-c <right>") 'hs-nxml-enter)
  86 (define-key nxml-mode-map (kbd "\C-c @ o") 'hs-nxml-hide-other)
  87
  88 (defun nxml-complete-and-autoclose-element (use-region)
  89   (interactive "P")
  90   (let* ((start (if use-region (setq start (set-marker (make-marker) (region-beginning)))))
  91          (end (setq use-region (set-marker (make-marker) (region-end))))
  92          (beg (and start (= (point) start))))
  93   (save-excursion
  94     (insert " "))
  95   (nxml-complete)
  96   (let ((name (xmltok-start-tag-local-name)))
  97     (delete-char 1)
  98     (if (and start end)
  99         (progn
 100           (if (not beg)
 101               (progn
 102                 (delete-char (- (1+ (length name))))
 103                 (goto-char start)
 104                 (insert "<" name ">"))
 105             (insert ">"))
 106           (goto-char end))
 107       (insert ">"))
 108     (save-excursion
 109       (insert "</" name ">")))))
 110
 111 (define-key nxml-mode-map (kbd "\C-c ." ) 'nxml-complete-and-autoclose-element)
 112 (define-key nxml-mode-map (kbd "\C-c\C-c") 'recompile)
 113
 114 (defconst nxml-docbook-common-elements
 115   '(("section" . ("para" "itemizedlist" "variablelist" "section" "bridgehead" "task" "procedure" "title"))
 116     ("para" . ("emphasis" "code" "replaceable"))
 117     ("emphasis" . ("code"))
 118     ("itemizedlist" . ("listitem"))
 119     ("orderedlist" . ("listitem"))
 120     ("variablelist" . ("varlistentry"))
 121     ("varlistentry" . ("term" "listitem"))
 122     ("term" . ("emphasis" "code"))
 123     ("listitem" . ("para" "itemizedlist"))
 124     ("task" . ("tasksummary" "procedure" "title"))
 125     ("tasksummary" . ("para"))
 126     ("procedure" . ("step"))
 127     ("step" . ("para" "procedure"))
 128     ("mathphrase" . ("replaceable" "superscript" "subscript"))
 129     ("title" . ("code" "replaceable"))
 130     ("literallayout" . ("replaceable" "emphasis" "code"))
 131     ("table" . ("title" . "tgroup"))
 132     ("tgroup" . ("colspec" "thead" "tbody"))
 133     ("thead" . ("row"))
 134     ("tbody" . ("row"))
 135     ("row". ("entry"))
 136     ("entry" . ("emphasis" "code"))))
 137
 138 (defvar nxml-docbook-common-elements-next-args nil)
 139
 140 (defun nxml-docbook-make-common-element (&optional start end kill-tag use-index old-tag valid)
 141   (interactive (cond ((and (eq real-last-command 'nxml-docbook-make-common-element)
 142                            nxml-docbook-common-elements-next-args)
 143                       nxml-docbook-common-elements-next-args)
 144                      (current-prefix-arg
 145                       (save-excursion
 146                         (nxml-backward-up-element)
 147                         (let ((tag (xmltok-start-tag-qname)))
 148                           (list (save-excursion
 149                                   (skip-chars-forward "^>")
 150                                   (forward-char 1)
 151                                   (point))
 152                                 (progn
 153                                   (nxml-forward-balanced-item)
 154                                   (skip-chars-backward "^<")
 155                                   (forward-char -1)
 156                                   (point))
 157                                 t nil tag))))
 158                      ((region-active-p)
 159                       (list (region-beginning) (region-end) nil))))
 160   (setq nxml-docbook-common-elements-next-args nil)
 161   (let ((start (set-marker (make-marker) (or start (point))))
 162         (end (set-marker (make-marker) (or end (point)))))
 163     (when kill-tag
 164       (delete-region (save-excursion (goto-char start) (skip-chars-backward "^<") (1- (point))) start)
 165       (delete-region end (save-excursion (goto-char end) (skip-chars-forward "^>") (1+ (point)))))
 166     (save-excursion
 167       (goto-char start)
 168       (let* ((token-end (nxml-token-before))
 169              (start-tag-end
 170               (save-excursion
 171                 (when (and (< (point) token-end)
 172                            (memq xmltok-type
 173                                  '(cdata-section
 174                                    processing-instruction
 175                                    comment
 176                                    start-tag
 177                                    end-tag
 178                                    empty-element)))
 179                   (error "Point is inside a %s"
 180                          (nxml-token-type-friendly-name xmltok-type)))
 181                 (nxml-scan-element-backward token-end t)))
 182              (context (xmltok-start-tag-qname))
 183              (common-elements (cdr (assoc context nxml-docbook-common-elements)))
 184              (valid-elements (or valid
 185                                  (let ((lt-pos (point)))
 186                                    (rng-set-state-after lt-pos)
 187                                    (loop for (ns . name) in (rng-match-possible-start-tag-names)
 188                                          if (not (member name elements)) collect name into elements
 189                                          finally return elements))))
 190              (elements (loop for element in common-elements
 191                              if (member element valid-elements) collect element))
 192              (index (or (and elements
 193                              (or use-index
 194                                  (and old-tag
 195                                       (loop for i from 0
 196                                             for elt in elements
 197                                             if (string= elt old-tag) return (1+ i)
 198                                             finally return 0))))
 199                         0))
 200              (element (and elements (nth index elements))))
 201         (message "!elements %s %s %s" common-elements valid-elements elements)
 202         (when (not elements)
 203           (error "No common elements for %s" context))
 204         (if element
 205             (progn
 206               (goto-char start)
 207               (insert-before-markers "<" element ">")
 208               (goto-char end)
 209               (insert "</" element ">")
 210               (goto-char end)
 211               (setq nxml-docbook-common-elements-next-args (list (marker-position start)
 212                                                                  (marker-position end)
 213                                                                  t
 214                                                                  (1+ index)
 215                                                                  valid-elements)))
 216           (setq nxml-docbook-common-elements-next-args (list (marker-position start)
 217                                                              (marker-position end)
 218                                                              nil
 219                                                              0
 220                                                              valid-elements)))))))
 221
 222 (defun nxml-just-one-space-or-skip-end ()
 223   (interactive)
 224   (if (looking-at "</")
 225       (progn
 226         (skip-chars-forward "^>")
 227         (forward-char 1))
 228     (just-one-space)))
 229
 230 (define-key nxml-mode-map (kbd "M-RET") 'nxml-docbook-make-common-element)
 231 (define-key nxml-mode-map (kbd "M-SPC") 'nxml-just-one-space-or-skip-end)
 232
 233 (defun nxml-open-line ()
 234   (interactive)
 235   (open-line 1)
 236   (save-excursion
 237     (forward-line 1)
 238     (indent-according-to-mode))
 239   (newline-and-indent))
 240
 241 (define-key nxml-mode-map (kbd "M-o") 'nxml-open-line)