org-pcomplete.el 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416
  1. ;;; org-pcomplete.el --- In-buffer completion code
  2. ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
  3. ;;
  4. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  5. ;; John Wiegley <johnw at gnu dot org>
  6. ;; Keywords: outlines, hypermedia, calendar, wp
  7. ;; Homepage: http://orgmode.org
  8. ;;
  9. ;; This file is part of GNU Emacs.
  10. ;;
  11. ;; GNU Emacs is free software: you can redistribute it and/or modify
  12. ;; it under the terms of the GNU General Public License as published by
  13. ;; the Free Software Foundation, either version 3 of the License, or
  14. ;; (at your option) any later version.
  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.
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  21. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  22. ;;
  23. ;;; Code:
  24. ;;;; Require other packages
  25. (eval-when-compile
  26. (require 'cl))
  27. (require 'org-macs)
  28. (require 'org-compat)
  29. (require 'pcomplete)
  30. (declare-function org-split-string "org" (string &optional separators))
  31. (declare-function org-make-org-heading-search-string "org"
  32. (&optional string heading))
  33. (declare-function org-get-buffer-tags "org" ())
  34. (declare-function org-get-tags "org" ())
  35. (declare-function org-buffer-property-keys "org"
  36. (&optional include-specials include-defaults include-columns))
  37. (declare-function org-entry-properties "org" (&optional pom which specific))
  38. ;;;; Customization variables
  39. (defgroup org-complete nil
  40. "Outline-based notes management and organizer."
  41. :tag "Org"
  42. :group 'org)
  43. (defvar org-drawer-regexp)
  44. (defvar org-property-re)
  45. (defun org-thing-at-point ()
  46. "Examine the thing at point and let the caller know what it is.
  47. The return value is a string naming the thing at point."
  48. (let ((beg1 (save-excursion
  49. (skip-chars-backward (org-re "[:alnum:]-_@"))
  50. (point)))
  51. (beg (save-excursion
  52. (skip-chars-backward "a-zA-Z0-9-_:$")
  53. (point)))
  54. (line-to-here (buffer-substring (point-at-bol) (point))))
  55. (cond
  56. ((string-match "\\`[ \t]*#\\+begin: clocktable[ \t]+" line-to-here)
  57. (cons "block-option" "clocktable"))
  58. ((string-match "\\`[ \t]*#\\+begin_src[ \t]+" line-to-here)
  59. (cons "block-option" "src"))
  60. ((save-excursion
  61. (re-search-backward "^[ \t]*#\\+\\([A-Z_]+\\):.*"
  62. (line-beginning-position) t))
  63. (cons "file-option" (match-string-no-properties 1)))
  64. ((string-match "\\`[ \t]*#\\+[a-zA-Z_]*\\'" line-to-here)
  65. (cons "file-option" nil))
  66. ((equal (char-before beg) ?\[)
  67. (cons "link" nil))
  68. ((equal (char-before beg) ?\\)
  69. (cons "tex" nil))
  70. ((string-match "\\`\\*+[ \t]+\\'"
  71. (buffer-substring (point-at-bol) beg))
  72. (cons "todo" nil))
  73. ((equal (char-before beg) ?*)
  74. (cons "searchhead" nil))
  75. ((and (equal (char-before beg1) ?:)
  76. (equal (char-after (point-at-bol)) ?*))
  77. (cons "tag" nil))
  78. ((and (equal (char-before beg1) ?:)
  79. (not (equal (char-after (point-at-bol)) ?*))
  80. (save-excursion
  81. (move-beginning-of-line 1)
  82. (skip-chars-backward "[ \t\n]")
  83. ;; org-drawer-regexp matches a whole line but while
  84. ;; looking-back, we just ignore trailing whitespaces
  85. (or (org-looking-back (substring org-drawer-regexp 0 -1))
  86. (org-looking-back org-property-re))))
  87. (cons "prop" nil))
  88. ((and (equal (char-before beg1) ?:)
  89. (not (equal (char-after (point-at-bol)) ?*)))
  90. (cons "drawer" nil))
  91. (t nil))))
  92. (defun org-command-at-point ()
  93. "Return the qualified name of the Org completion entity at point.
  94. When completing for #+STARTUP, for example, this function returns
  95. \"file-option/startup\"."
  96. (let ((thing (org-thing-at-point)))
  97. (cond
  98. ((string= "file-option" (car thing))
  99. (concat (car thing)
  100. (and (cdr thing) (concat "/" (downcase (cdr thing))))))
  101. ((string= "block-option" (car thing))
  102. (concat (car thing) "/" (downcase (cdr thing))))
  103. (t (car thing)))))
  104. (defun org-parse-arguments ()
  105. "Parse whitespace separated arguments in the current region."
  106. (let ((begin (line-beginning-position))
  107. (end (line-end-position))
  108. begins args)
  109. (save-restriction
  110. (narrow-to-region begin end)
  111. (save-excursion
  112. (goto-char (point-min))
  113. (while (not (eobp))
  114. (skip-chars-forward " \t\n[")
  115. (setq begins (cons (point) begins))
  116. (skip-chars-forward "^ \t\n[")
  117. (setq args (cons (buffer-substring-no-properties
  118. (car begins) (point))
  119. args)))
  120. (cons (reverse args) (reverse begins))))))
  121. (defun org-pcomplete-initial ()
  122. "Calls the right completion function for first argument completions."
  123. (ignore
  124. (funcall (or (pcomplete-find-completion-function
  125. (car (org-thing-at-point)))
  126. pcomplete-default-completion-function))))
  127. (defvar org-options-keywords) ; From org.el
  128. (defvar org-element-block-name-alist) ; From org-element.el
  129. (defvar org-element-affiliated-keywords) ; From org-element.el
  130. (declare-function org-get-export-keywords "org" ())
  131. (defun pcomplete/org-mode/file-option ()
  132. "Complete against all valid file options."
  133. (require 'org-element)
  134. (pcomplete-here
  135. (org-pcomplete-case-double
  136. (append (mapcar (lambda (keyword) (concat keyword " "))
  137. org-options-keywords)
  138. (mapcar (lambda (keyword) (concat keyword ": "))
  139. org-element-affiliated-keywords)
  140. (let (block-names)
  141. (mapc (lambda (block-name)
  142. (let ((name (car block-name)))
  143. (push (format "END_%s " name) block-names)
  144. (push (format "BEGIN_%s " name) block-names)
  145. (push (format "ATTR_%s: " name) block-names)))
  146. org-element-block-name-alist)
  147. block-names)
  148. (mapcar (lambda (keyword) (concat keyword ": "))
  149. (org-get-export-keywords))))
  150. (substring pcomplete-stub 2)))
  151. (defun pcomplete/org-mode/file-option/author ()
  152. "Complete arguments for the #+AUTHOR file option."
  153. (pcomplete-here (list user-full-name)))
  154. (defvar org-time-stamp-formats)
  155. (defun pcomplete/org-mode/file-option/date ()
  156. "Complete arguments for the #+DATE file option."
  157. (pcomplete-here (list (format-time-string (car org-time-stamp-formats)))))
  158. (defun pcomplete/org-mode/file-option/email ()
  159. "Complete arguments for the #+EMAIL file option."
  160. (pcomplete-here (list user-mail-address)))
  161. (defvar org-export-exclude-tags)
  162. (defun pcomplete/org-mode/file-option/exclude_tags ()
  163. "Complete arguments for the #+EXCLUDE_TAGS file option."
  164. (require 'ox)
  165. (pcomplete-here
  166. (and org-export-exclude-tags
  167. (list (mapconcat 'identity org-export-exclude-tags " ")))))
  168. (defvar org-file-tags)
  169. (defun pcomplete/org-mode/file-option/filetags ()
  170. "Complete arguments for the #+FILETAGS file option."
  171. (pcomplete-here (and org-file-tags (mapconcat 'identity org-file-tags " "))))
  172. (defvar org-export-default-language)
  173. (defun pcomplete/org-mode/file-option/language ()
  174. "Complete arguments for the #+LANGUAGE file option."
  175. (require 'ox)
  176. (pcomplete-here
  177. (pcomplete-uniqify-list
  178. (list org-export-default-language "en"))))
  179. (defvar org-default-priority)
  180. (defvar org-highest-priority)
  181. (defvar org-lowest-priority)
  182. (defun pcomplete/org-mode/file-option/priorities ()
  183. "Complete arguments for the #+PRIORITIES file option."
  184. (pcomplete-here (list (format "%c %c %c"
  185. org-highest-priority
  186. org-lowest-priority
  187. org-default-priority))))
  188. (defvar org-export-select-tags)
  189. (defun pcomplete/org-mode/file-option/select_tags ()
  190. "Complete arguments for the #+SELECT_TAGS file option."
  191. (require 'ox)
  192. (pcomplete-here
  193. (and org-export-select-tags
  194. (list (mapconcat 'identity org-export-select-tags " ")))))
  195. (defvar org-startup-options)
  196. (defun pcomplete/org-mode/file-option/startup ()
  197. "Complete arguments for the #+STARTUP file option."
  198. (while (pcomplete-here
  199. (let ((opts (pcomplete-uniqify-list
  200. (mapcar 'car org-startup-options))))
  201. ;; Some options are mutually exclusive, and shouldn't be completed
  202. ;; against if certain other options have already been seen.
  203. (dolist (arg pcomplete-args)
  204. (cond
  205. ((string= arg "hidestars")
  206. (setq opts (delete "showstars" opts)))))
  207. opts))))
  208. (defvar org-tag-alist)
  209. (defun pcomplete/org-mode/file-option/tags ()
  210. "Complete arguments for the #+TAGS file option."
  211. (pcomplete-here
  212. (list
  213. (mapconcat (lambda (x)
  214. (cond
  215. ((eq :startgroup (car x)) "{")
  216. ((eq :endgroup (car x)) "}")
  217. ((eq :grouptags (car x)) ":")
  218. ((eq :newline (car x)) "\\n")
  219. ((cdr x) (format "%s(%c)" (car x) (cdr x)))
  220. (t (car x))))
  221. org-tag-alist " "))))
  222. (defun pcomplete/org-mode/file-option/title ()
  223. "Complete arguments for the #+TITLE file option."
  224. (pcomplete-here
  225. (let ((visited-file (buffer-file-name (buffer-base-buffer))))
  226. (list (or (and visited-file
  227. (file-name-sans-extension
  228. (file-name-nondirectory visited-file)))
  229. (buffer-name (buffer-base-buffer)))))))
  230. (defun pcomplete/org-mode/file-option/options ()
  231. "Complete arguments for the #+OPTIONS file option."
  232. (while (pcomplete-here
  233. (pcomplete-uniqify-list
  234. (append
  235. ;; Hard-coded OPTION items always available.
  236. '("H:" "\\n:" "num:" "timestamp:" "arch:" "author:" "c:"
  237. "creator:" "date:" "d:" "email:" "*:" "e:" "::" "f:"
  238. "inline:" "tex:" "p:" "pri:" "':" "-:" "stat:" "^:" "toc:"
  239. "|:" "tags:" "tasks:" "<:" "todo:")
  240. ;; OPTION items from registered back-ends.
  241. (let (items)
  242. (dolist (back-end (org-bound-and-true-p
  243. org-export-registered-backends))
  244. (dolist (option (plist-get (cdr back-end) :options-alist))
  245. (let ((item (nth 2 option)))
  246. (when item (push (concat item ":") items)))))
  247. items))))))
  248. (defun pcomplete/org-mode/file-option/infojs_opt ()
  249. "Complete arguments for the #+INFOJS_OPT file option."
  250. (while (pcomplete-here
  251. (pcomplete-uniqify-list
  252. (mapcar (lambda (item) (format "%s:" (car item)))
  253. (org-bound-and-true-p org-html-infojs-opts-table))))))
  254. (defun pcomplete/org-mode/file-option/bind ()
  255. "Complete arguments for the #+BIND file option, which are variable names."
  256. (let (vars)
  257. (mapatoms
  258. (lambda (a) (if (boundp a) (setq vars (cons (symbol-name a) vars)))))
  259. (pcomplete-here vars)))
  260. (defvar org-link-abbrev-alist-local)
  261. (defvar org-link-abbrev-alist)
  262. (defun pcomplete/org-mode/link ()
  263. "Complete against defined #+LINK patterns."
  264. (pcomplete-here
  265. (pcomplete-uniqify-list
  266. (copy-sequence
  267. (append (mapcar 'car org-link-abbrev-alist-local)
  268. (mapcar 'car org-link-abbrev-alist))))))
  269. (defvar org-entities)
  270. (defun pcomplete/org-mode/tex ()
  271. "Complete against TeX-style HTML entity names."
  272. (require 'org-entities)
  273. (while (pcomplete-here
  274. (pcomplete-uniqify-list (remove nil (mapcar 'car-safe org-entities)))
  275. (substring pcomplete-stub 1))))
  276. (defvar org-todo-keywords-1)
  277. (defun pcomplete/org-mode/todo ()
  278. "Complete against known TODO keywords."
  279. (pcomplete-here (pcomplete-uniqify-list (copy-sequence org-todo-keywords-1))))
  280. (defvar org-todo-line-regexp)
  281. (defun pcomplete/org-mode/searchhead ()
  282. "Complete against all headings.
  283. This needs more work, to handle headings with lots of spaces in them."
  284. (while
  285. (pcomplete-here
  286. (save-excursion
  287. (goto-char (point-min))
  288. (let (tbl)
  289. (while (re-search-forward org-todo-line-regexp nil t)
  290. (push (org-make-org-heading-search-string
  291. (match-string-no-properties 3) t)
  292. tbl))
  293. (pcomplete-uniqify-list tbl)))
  294. (substring pcomplete-stub 1))))
  295. (defvar org-tag-alist)
  296. (defun pcomplete/org-mode/tag ()
  297. "Complete a tag name. Omit tags already set."
  298. (while (pcomplete-here
  299. (mapcar (lambda (x)
  300. (concat x ":"))
  301. (let ((lst (pcomplete-uniqify-list
  302. (or (remove
  303. nil
  304. (mapcar (lambda (x)
  305. (and (stringp (car x)) (car x)))
  306. org-tag-alist))
  307. (mapcar 'car (org-get-buffer-tags))))))
  308. (dolist (tag (org-get-tags))
  309. (setq lst (delete tag lst)))
  310. lst))
  311. (and (string-match ".*:" pcomplete-stub)
  312. (substring pcomplete-stub (match-end 0))))))
  313. (defun pcomplete/org-mode/prop ()
  314. "Complete a property name. Omit properties already set."
  315. (pcomplete-here
  316. (mapcar (lambda (x)
  317. (concat x ": "))
  318. (let ((lst (pcomplete-uniqify-list
  319. (copy-sequence
  320. (org-buffer-property-keys nil t t)))))
  321. (dolist (prop (org-entry-properties))
  322. (setq lst (delete (car prop) lst)))
  323. lst))
  324. (substring pcomplete-stub 1)))
  325. (defvar org-drawers)
  326. (defun pcomplete/org-mode/drawer ()
  327. "Complete a drawer name."
  328. (let ((spc (save-excursion
  329. (move-beginning-of-line 1)
  330. (looking-at "^\\([ \t]*\\):")
  331. (match-string 1)))
  332. (cpllist (mapcar (lambda (x) (concat x ": ")) org-drawers)))
  333. (pcomplete-here cpllist
  334. (substring pcomplete-stub 1)
  335. (unless (or (not (delq
  336. nil
  337. (mapcar (lambda(x)
  338. (string-match (substring pcomplete-stub 1) x))
  339. cpllist)))
  340. (looking-at "[ \t]*\n.*:END:"))
  341. (save-excursion (insert "\n" spc ":END:"))))))
  342. (defun pcomplete/org-mode/block-option/src ()
  343. "Complete the arguments of a begin_src block.
  344. Complete a language in the first field, the header arguments and switches."
  345. (pcomplete-here
  346. (mapcar
  347. (lambda(x) (symbol-name (nth 3 x)))
  348. (cdr (car (cdr (memq :key-type (plist-get
  349. (symbol-plist
  350. 'org-babel-load-languages)
  351. 'custom-type)))))))
  352. (while (pcomplete-here
  353. '("-n" "-r" "-l"
  354. ":cache" ":colnames" ":comments" ":dir" ":eval" ":exports"
  355. ":file" ":hlines" ":no-expand" ":noweb" ":results" ":rownames"
  356. ":session" ":shebang" ":tangle" ":var"))))
  357. (defun pcomplete/org-mode/block-option/clocktable ()
  358. "Complete keywords in a clocktable line."
  359. (while (pcomplete-here '(":maxlevel" ":scope" ":lang"
  360. ":tstart" ":tend" ":block" ":step"
  361. ":stepskip0" ":fileskip0"
  362. ":emphasize" ":link" ":narrow" ":indent"
  363. ":tcolumns" ":level" ":compact" ":timestamp"
  364. ":formula" ":formatter" ":wstart" ":mstart"))))
  365. (defun org-pcomplete-case-double (list)
  366. "Return list with both upcase and downcase version of all strings in LIST."
  367. (let (e res)
  368. (while (setq e (pop list))
  369. (setq res (cons (downcase e) (cons (upcase e) res))))
  370. (nreverse res)))
  371. ;;;; Finish up
  372. (provide 'org-pcomplete)
  373. ;;; org-pcomplete.el ends here