yatex

annotate yatexpkg.el @ 303:13a62b7c8354

find changesets by author, revision, files, or words in the commit message
(yatexpkg)Add default option for package completion.
author HIROSE Yuuji <yuuji@gentei.org>
date Mon, 06 May 2013 17:24:56 +0900
parents 8d3156073892
children a57f4c74179a
rev   line source
yuuji@287 1 ;;; yatexpkg.el --- YaTeX package manager
yuuji@287 2 ;;;
yuuji@294 3 ;;; (c)2003-2013 by HIROSE, Yuuji [yuuji@yatex.org]
yuuji@303 4 ;;; Last modified Mon May 6 17:20:43 2013 on firestorm
yuuji@78 5 ;;; $Id$
yuuji@78 6
yuuji@287 7 ;;; Code:
yuuji@80 8 (defvar YaTeX-package-ams-envs
yuuji@80 9 (mapcar 'car YaTeX-ams-env-table))
yuuji@80 10
yuuji@78 11 (defvar YaTeX-package-alist-default
yuuji@193 12 '(("version" (env "comment") ;by tsuchiya<at>pine.kuee.kyoto-u.ac.jp
yuuji@79 13 (section "includeversion" "excludeversion"))
yuuji@78 14
yuuji@193 15 ("plext" (section "bou")) ;by yas.axis<at>ma.mni.ne.jp
yuuji@78 16
yuuji@193 17 ("url" (section "url")) ;by fujieda<at>jaist.ac.jp
yuuji@78 18
yuuji@78 19 ("fancybox" (section "shadowbox" "doublebox" "ovalbox" "Ovalbox"))
yuuji@80 20 ("slashbox" (section "slashbox" "backslashbox"))
yuuji@78 21 ("pifont" (section "ding"))
yuuji@78 22 ("longtable" (env "longtable"))
yuuji@78 23 ("ascmac" (env "screen" "boxnote" "shadebox" "itembox")
yuuji@78 24 (maketitle "return" "Return" "yen")
yuuji@79 25 (section "keytop") ("mask") ("maskbox"))
yuuji@193 26 ("bm" (section "bm")) ;by aoyama<at>le.chiba-u.ac.jp
yuuji@78 27
yuuji@78 28 ("alltt" (env "alltt"))
yuuji@78 29 ("misc" (section "verbfile" "listing"))
yuuji@80 30 ("eclbkbox" (env "breakbox"))
yuuji@80 31 ("supertabular" (env "supertabular"))
yuuji@80 32 ("amsmath" (env . YaTeX-package-ams-envs)
yuuji@80 33 (section "tag" "tag*"))
yuuji@134 34 ("amssymb" (maketitle "leqq" "geqq" "mathbb" "mathfrak"
yuuji@144 35 "fallingdotseq"
yuuji@134 36 "lll" "ggg")) ;very few. Please tell us!
yuuji@80 37 ("graphicx" (section "includegraphics"
yuuji@80 38 "rotatebox" "scalebox" "resizebox" "reflectbox")
yuuji@80 39 (option . YaTeX-package-graphics-driver-alist))
yuuji@80 40 ("color" (section "textcolor" "colorbox" "pagecolor" "color")
yuuji@303 41 (option . YaTeX-package-graphics-driver-alist)
yuuji@303 42 (default-option . "usenames,dvipsnames"))
yuuji@303 43 ("xcolor" (same-as . "color"))
yuuji@80 44 ("ulem" (section "uline" "uuline" "uwave")
yuuji@80 45 (option ("normalem")))
yuuji@80 46 ("multicol" (env "multicols")))
yuuji@79 47 "Default package vs. macro list.
yuuji@79 48 Alists contains '(PACKAGENAME . MACROLIST)
yuuji@79 49 PACKAGENAME Basename of package(String).
yuuji@79 50 MACROLIST List of '(TYPE . MACROS)
yuuji@79 51 TYPE One of 'env, 'section or 'maketitle according to completion-type
yuuji@79 52 MACROS List of macros
yuuji@79 53
yuuji@80 54 If TYPE is 'option, its cdr is alist of completion candidates for that
yuuji@80 55 package. Its cdr can be a symbol whose value is alist.
yuuji@80 56
yuuji@79 57 An good example is the value of YaTeX-package-alist-default.")
yuuji@78 58
yuuji@80 59 (defvar YaTeX-package-graphics-driver-alist
yuuji@303 60 '(("dvips") ("dvipsnames") ("usenames")
yuuji@303 61 ("xdvi") ("dvipdf") ("pdftex") ("dvipsone") ("dviwindo")
yuuji@80 62 ("emtex") ("dviwin") ("oztex") ("textures") ("pctexps") ("pctexwin")
yuuji@80 63 ("pctexhp") ("pctex32") ("truetex") ("tcidvi") ("vtex"))
yuuji@80 64 "Drivers alist of graphics/color stylefile's supporting deveces.
yuuji@80 65 This list is taken from
yuuji@80 66 %% graphics.dtx Copyright (C) 1994 David Carlisle Sebastian Rahtz
yuuji@80 67 %% Copyright (C) 1995 1996 1997 1998 David Carlisle
yuuji@80 68 as of 2004/1/19. Thanks.")
yuuji@80 69
yuuji@78 70 (defvar YaTeX-package-alist-private nil
yuuji@78 71 "*User defined package vs. macro list. See also YaTeX-package-alist-default")
yuuji@78 72
yuuji@78 73 (defun YaTeX-package-lookup (macro &optional type)
yuuji@78 74 "Look up a package which contains a definition of MACRO.
yuuji@78 75 Optional second argument TYPE limits the macro type.
yuuji@78 76 TYPE is a symbol, one of 'env, 'section, 'maketitle."
yuuji@78 77 (let ((list (append YaTeX-package-alist-private YaTeX-package-alist-default))
yuuji@80 78 element x val pkg pkglist r)
yuuji@78 79 (while list
yuuji@78 80 (setq element (car list)
yuuji@78 81 pkg (car element)
yuuji@78 82 element (cdr element))
yuuji@78 83 (if (setq r (catch 'found
yuuji@78 84 (while element
yuuji@80 85 (setq x (car element)
yuuji@80 86 val (cdr x))
yuuji@80 87 (if (symbolp val) (setq val (symbol-value val)))
yuuji@80 88 (and (or (null type)
yuuji@78 89 (eq type (car x)))
yuuji@80 90 (YaTeX-member macro val)
yuuji@78 91 (throw 'found (car x))) ;car x is type
yuuji@78 92 (setq element (cdr element)))))
yuuji@78 93 (setq pkglist (cons (cons pkg r) pkglist)))
yuuji@78 94 (setq list (cdr list)))
yuuji@78 95 pkglist))
yuuji@78 96
yuuji@303 97 (defun YaTeX-package-option-lookup (pkg &optional key)
yuuji@80 98 "Look up options for specified pkg and returne them in alist form.
yuuji@303 99 Just only associng against the alist of YaTeX-package-alist-*"
yuuji@303 100 (let*((list (append YaTeX-package-alist-private YaTeX-package-alist-default))
yuuji@303 101 (l (cdr (assq (or key 'option) (assoc pkg list))))
yuuji@303 102 (recur (cdr (assq 'same-as (assoc pkg list)))))
yuuji@303 103 (cond
yuuji@303 104 (recur (YaTeX-package-option-lookup recur key))
yuuji@303 105 ((symbolp l) (symbol-value l))
yuuji@303 106 (t l))))
yuuji@80 107
yuuji@78 108 (defvar YaTeX-package-resolved-list nil
yuuji@78 109 "List of macros whose package is confirmed to be loaded.")
yuuji@78 110
yuuji@78 111 (defun YaTeX-package-auto-usepackage (macro type)
yuuji@78 112 "(Semi)Automatically add the \\usepackage line to main-file.
yuuji@78 113 Search the usepackage for MACRO of the TYPE."
yuuji@78 114 (let ((cb (current-buffer))
yuuji@78 115 (wc (current-window-configuration))
yuuji@78 116 (usepackage (concat YaTeX-ec "usepackage"))
yuuji@80 117 (pkglist (YaTeX-package-lookup macro type))
yuuji@78 118 (usepkgrx (concat
yuuji@78 119 YaTeX-ec-regexp
yuuji@78 120 "\\(usepackage\\|include\\)\\b"))
yuuji@78 121 (register '(lambda () (set-buffer cb)
yuuji@78 122 (set (make-local-variable 'YaTeX-package-resolved-list)
yuuji@78 123 (cons macro YaTeX-package-resolved-list))))
yuuji@78 124 (begdoc (concat YaTeX-ec "begin{document}"))
yuuji@80 125 pb pkg optlist (option "") mb0 uspkgargs)
yuuji@78 126 (if (or (YaTeX-member macro YaTeX-package-resolved-list)
yuuji@78 127 (null pkglist))
yuuji@78 128 nil ;nothing to do
yuuji@78 129 ;; Search `usepackage' into main-file
yuuji@78 130 (YaTeX-visit-main t) ;set buffer to parent file
yuuji@78 131 (setq pb (current-buffer))
yuuji@78 132 (save-excursion
yuuji@78 133 (save-restriction
yuuji@78 134 (if (catch 'found
yuuji@78 135 (goto-char (point-min))
yuuji@78 136 (YaTeX-search-active-forward ;if search fails, goto eob
yuuji@78 137 begdoc YaTeX-comment-prefix nil 1)
yuuji@80 138 (while ;(YaTeX-re-search-active-backward
yuuji@80 139 ;usepkgrx YaTeX-comment-prefix nil t)
yuuji@80 140 ;;allow commented out \usepackages 2004/3/16
yuuji@80 141 (re-search-backward usepkgrx nil t)
yuuji@78 142 (setq mb0 (match-beginning 0))
yuuji@78 143 (skip-chars-forward "^{")
yuuji@80 144 (setq uspkgargs (YaTeX-buffer-substring
yuuji@80 145 (point)
yuuji@80 146 (progn
yuuji@80 147 ;;(forward-list 1) is more precise,
yuuji@80 148 ;; but higher risk.
yuuji@80 149 (skip-chars-forward "^}\n")(point))))
yuuji@78 150 (let ((pl pkglist))
yuuji@78 151 (while pl ;(car pl)'s car is package, cdr is type
yuuji@80 152 (if (string-match
yuuji@80 153 (concat "[{,]\\s *"
yuuji@80 154 (regexp-quote (car (car pl)))
yuuji@80 155 "\\>")
yuuji@80 156 uspkgargs)
yuuji@78 157 (throw 'found t))
yuuji@78 158 (setq pl (cdr pl)))
yuuji@78 159 (goto-char mb0))))
yuuji@78 160 ;;corresponding \usepackage found
yuuji@78 161 (funcall register)
yuuji@78 162 ;; not found, insert it.
yuuji@78 163 (if (y-or-n-p
yuuji@78 164 (format "`%s' requires package. Put \\usepackage now?" macro))
yuuji@78 165 (progn
yuuji@80 166 (require 'yatexadd)
yuuji@78 167 (setq pkg
yuuji@78 168 (completing-read
yuuji@78 169 "Load which package?(TAB for list): "
yuuji@79 170 pkglist nil nil
yuuji@79 171 ;;initial input
yuuji@79 172 (if (= (length pkglist) 1)
yuuji@79 173 (let ((w (car (car pkglist))))
yuuji@80 174 (if YaTeX-emacs-19 (cons w 0) w))))
yuuji@80 175 optlist
yuuji@80 176 (YaTeX-package-option-lookup pkg))
yuuji@80 177 (if optlist
yuuji@80 178 (let ((minibuffer-completion-table optlist)
yuuji@303 179 (delim ",") (w (car (car optlist)))
yuuji@303 180 (dflt (YaTeX-package-option-lookup
yuuji@303 181 pkg 'default-option)))
yuuji@80 182 (setq option
yuuji@80 183 (read-from-minibuffer
yuuji@80 184 (format "Any option for {%s}?: " pkg)
yuuji@303 185 (let ((v (or dflt
yuuji@303 186 (and (= (length optlist) 1) w))))
yuuji@303 187 (and v (if YaTeX-emacs-19 (cons v 0) v)))
yuuji@80 188 YaTeX-minibuffer-completion-map)
yuuji@80 189 option (if (string< "" option)
yuuji@80 190 (concat "[" option "]")
yuuji@80 191 ""))))
yuuji@78 192 (set-buffer pb)
yuuji@78 193 (goto-char (point-min))
yuuji@78 194 (if (YaTeX-re-search-active-forward
yuuji@78 195 (concat YaTeX-ec-regexp
yuuji@78 196 "document\\(style\\|class\\){")
yuuji@78 197 YaTeX-comment-prefix nil t)
yuuji@78 198 (forward-line 1))
yuuji@78 199 (if (YaTeX-search-active-forward
yuuji@78 200 begdoc YaTeX-comment-prefix nil t)
yuuji@78 201 (goto-char (match-beginning 0)))
yuuji@78 202 (insert
yuuji@78 203 usepackage
yuuji@80 204 (format "%s{%s}\t%% required for `\\%s' (yatex added)\n"
yuuji@80 205 option pkg macro))
yuuji@78 206 (funcall register))
yuuji@120 207 (funcall register)
yuuji@78 208 (message "Don't forget to put \\usepackage{%s} yourself later"
yuuji@78 209 (car (car pkglist)))) ;doing car car is negligence...
yuuji@78 210 ))))))