setup/nxml.el

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