mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-11-29 07:58:21 +00:00
58f1dbccf8
Also remove blank lines before the ";;; org*el ends here" declarations. Having a "Version" header forced us to update every file when releasing a new version of Org; it also forced us to update every file when merging Org with Emacs trunk, thus cluttering the diffs between the previously merged version and the new one with useless information. Glenn Morris suggested this in emacs-devel: http://lists.gnu.org/archive/html/emacs-devel/2011-08/msg00322.html
279 lines
9.1 KiB
EmacsLisp
279 lines
9.1 KiB
EmacsLisp
;;; org-pcomplete.el --- In-buffer completion code
|
|
|
|
;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
|
|
;;
|
|
;; Author: Carsten Dominik <carsten at orgmode dot org>
|
|
;; John Wiegley <johnw at gnu dot org>
|
|
;; Keywords: outlines, hypermedia, calendar, wp
|
|
;; Homepage: http://orgmode.org
|
|
;;
|
|
;; This file is part of GNU Emacs.
|
|
;;
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; 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
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
;;
|
|
;;; Code:
|
|
|
|
;;;; Require other packages
|
|
|
|
(eval-when-compile
|
|
(require 'cl))
|
|
|
|
(require 'org-macs)
|
|
(require 'pcomplete)
|
|
|
|
(declare-function org-split-string "org" (string &optional separators))
|
|
(declare-function org-get-current-options "org-exp" ())
|
|
(declare-function org-make-org-heading-search-string "org"
|
|
(&optional string heading))
|
|
(declare-function org-get-buffer-tags "org" ())
|
|
(declare-function org-get-tags "org" ())
|
|
(declare-function org-buffer-property-keys "org"
|
|
(&optional include-specials include-defaults include-columns))
|
|
(declare-function org-entry-properties "org" (&optional pom which specific))
|
|
|
|
;;;; Customization variables
|
|
|
|
(defgroup org-complete nil
|
|
"Outline-based notes management and organizer."
|
|
:tag "Org"
|
|
:group 'org)
|
|
|
|
(defun org-thing-at-point ()
|
|
"Examine the thing at point and let the caller know what it is.
|
|
The return value is a string naming the thing at point."
|
|
(let ((beg1 (save-excursion
|
|
(skip-chars-backward (org-re "[:alnum:]_@"))
|
|
(point)))
|
|
(beg (save-excursion
|
|
(skip-chars-backward "a-zA-Z0-9_:$")
|
|
(point)))
|
|
(line-to-here (buffer-substring (point-at-bol) (point))))
|
|
(cond
|
|
((string-match "\\`[ \t]*#\\+begin: clocktable[ \t]+" line-to-here)
|
|
(cons "block-option" "clocktable"))
|
|
((string-match "\\`[ \t]*#\\+begin_src[ \t]+" line-to-here)
|
|
(cons "block-option" "src"))
|
|
((save-excursion
|
|
(re-search-backward "^[ \t]*#\\+\\([A-Z_]+\\):.*"
|
|
(line-beginning-position) t))
|
|
(cons "file-option" (match-string-no-properties 1)))
|
|
((string-match "\\`[ \t]*#\\+[a-zA-Z]*\\'" line-to-here)
|
|
(cons "file-option" nil))
|
|
((equal (char-before beg) ?\[)
|
|
(cons "link" nil))
|
|
((equal (char-before beg) ?\\)
|
|
(cons "tex" nil))
|
|
((string-match "\\`\\*+[ \t]+\\'"
|
|
(buffer-substring (point-at-bol) beg))
|
|
(cons "todo" nil))
|
|
((equal (char-before beg) ?*)
|
|
(cons "searchhead" nil))
|
|
((and (equal (char-before beg1) ?:)
|
|
(equal (char-after (point-at-bol)) ?*))
|
|
(cons "tag" nil))
|
|
((and (equal (char-before beg1) ?:)
|
|
(not (equal (char-after (point-at-bol)) ?*)))
|
|
(cons "prop" nil))
|
|
(t nil))))
|
|
|
|
(defun org-command-at-point ()
|
|
"Return the qualified name of the Org completion entity at point.
|
|
When completing for #+STARTUP, for example, this function returns
|
|
\"file-option/startup\"."
|
|
(let ((thing (org-thing-at-point)))
|
|
(cond
|
|
((string= "file-option" (car thing))
|
|
(concat (car thing) "/" (downcase (cdr thing))))
|
|
((string= "block-option" (car thing))
|
|
(concat (car thing) "/" (downcase (cdr thing))))
|
|
(t
|
|
(car thing)))))
|
|
|
|
(defun org-parse-arguments ()
|
|
"Parse whitespace separated arguments in the current region."
|
|
(let ((begin (line-beginning-position))
|
|
(end (line-end-position))
|
|
begins args)
|
|
(save-restriction
|
|
(narrow-to-region begin end)
|
|
(save-excursion
|
|
(goto-char (point-min))
|
|
(while (not (eobp))
|
|
(skip-chars-forward " \t\n[")
|
|
(setq begins (cons (point) begins))
|
|
(skip-chars-forward "^ \t\n[")
|
|
(setq args (cons (buffer-substring-no-properties
|
|
(car begins) (point))
|
|
args)))
|
|
(cons (reverse args) (reverse begins))))))
|
|
|
|
|
|
(defun org-pcomplete-initial ()
|
|
"Calls the right completion function for first argument completions."
|
|
(ignore
|
|
(funcall (or (pcomplete-find-completion-function
|
|
(car (org-thing-at-point)))
|
|
pcomplete-default-completion-function))))
|
|
|
|
(defvar org-additional-option-like-keywords)
|
|
(defun pcomplete/org-mode/file-option ()
|
|
"Complete against all valid file options."
|
|
(require 'org-exp)
|
|
(pcomplete-here
|
|
(org-pcomplete-case-double
|
|
(mapcar (lambda (x)
|
|
(if (= ?: (aref x (1- (length x))))
|
|
(concat x " ")
|
|
x))
|
|
(delq nil
|
|
(pcomplete-uniqify-list
|
|
(append
|
|
(mapcar (lambda (x)
|
|
(if (string-match "^#\\+\\([A-Z_]+:?\\)" x)
|
|
(match-string 1 x)))
|
|
(org-split-string (org-get-current-options) "\n"))
|
|
org-additional-option-like-keywords)))))
|
|
(substring pcomplete-stub 2)))
|
|
|
|
(defvar org-startup-options)
|
|
(defun pcomplete/org-mode/file-option/startup ()
|
|
"Complete arguments for the #+STARTUP file option."
|
|
(while (pcomplete-here
|
|
(let ((opts (pcomplete-uniqify-list
|
|
(mapcar 'car org-startup-options))))
|
|
;; Some options are mutually exclusive, and shouldn't be completed
|
|
;; against if certain other options have already been seen.
|
|
(dolist (arg pcomplete-args)
|
|
(cond
|
|
((string= arg "hidestars")
|
|
(setq opts (delete "showstars" opts)))))
|
|
opts))))
|
|
|
|
(defun pcomplete/org-mode/file-option/bind ()
|
|
"Complete arguments for the #+BIND file option, which are variable names"
|
|
(let (vars)
|
|
(mapatoms
|
|
(lambda (a) (if (boundp a) (setq vars (cons (symbol-name a) vars)))))
|
|
(pcomplete-here vars)))
|
|
|
|
(defvar org-link-abbrev-alist-local)
|
|
(defvar org-link-abbrev-alist)
|
|
(defun pcomplete/org-mode/link ()
|
|
"Complete against defined #+LINK patterns."
|
|
(pcomplete-here
|
|
(pcomplete-uniqify-list
|
|
(copy-sequence
|
|
(append (mapcar 'car org-link-abbrev-alist-local)
|
|
(mapcar 'car org-link-abbrev-alist))))))
|
|
|
|
(defvar org-entities)
|
|
(defun pcomplete/org-mode/tex ()
|
|
"Complete against TeX-style HTML entity names."
|
|
(require 'org-entities)
|
|
(while (pcomplete-here
|
|
(pcomplete-uniqify-list (remove nil (mapcar 'car-safe org-entities)))
|
|
(substring pcomplete-stub 1))))
|
|
|
|
(defvar org-todo-keywords-1)
|
|
(defun pcomplete/org-mode/todo ()
|
|
"Complete against known TODO keywords."
|
|
(pcomplete-here (pcomplete-uniqify-list (copy-sequence org-todo-keywords-1))))
|
|
|
|
(defvar org-todo-line-regexp)
|
|
(defun pcomplete/org-mode/searchhead ()
|
|
"Complete against all headings.
|
|
This needs more work, to handle headings with lots of spaces in them."
|
|
(while
|
|
(pcomplete-here
|
|
(save-excursion
|
|
(goto-char (point-min))
|
|
(let (tbl)
|
|
(while (re-search-forward org-todo-line-regexp nil t)
|
|
(push (org-make-org-heading-search-string
|
|
(match-string-no-properties 3) t)
|
|
tbl))
|
|
(pcomplete-uniqify-list tbl)))
|
|
(substring pcomplete-stub 1))))
|
|
|
|
(defvar org-tag-alist)
|
|
(defun pcomplete/org-mode/tag ()
|
|
"Complete a tag name. Omit tags already set."
|
|
(while (pcomplete-here
|
|
(mapcar (lambda (x)
|
|
(concat x ":"))
|
|
(let ((lst (pcomplete-uniqify-list
|
|
(or (remove
|
|
nil
|
|
(mapcar (lambda (x)
|
|
(and (stringp (car x)) (car x)))
|
|
org-tag-alist))
|
|
(mapcar 'car (org-get-buffer-tags))))))
|
|
(dolist (tag (org-get-tags))
|
|
(setq lst (delete tag lst)))
|
|
lst))
|
|
(and (string-match ".*:" pcomplete-stub)
|
|
(substring pcomplete-stub (match-end 0))))))
|
|
|
|
(defun pcomplete/org-mode/prop ()
|
|
"Complete a property name. Omit properties already set."
|
|
(pcomplete-here
|
|
(mapcar (lambda (x)
|
|
(concat x ": "))
|
|
(let ((lst (pcomplete-uniqify-list
|
|
(copy-sequence
|
|
(org-buffer-property-keys nil t t)))))
|
|
(dolist (prop (org-entry-properties))
|
|
(setq lst (delete (car prop) lst)))
|
|
lst))
|
|
(substring pcomplete-stub 1)))
|
|
|
|
(defun pcomplete/org-mode/block-option/src ()
|
|
"Complete the arguments of a begin_src block.
|
|
Complete a language in the first field, the header arguments and switches."
|
|
(pcomplete-here
|
|
(mapcar
|
|
(lambda(x) (symbol-name (nth 3 x)))
|
|
(cdr (car (cdr (memq :key-type (plist-get
|
|
(symbol-plist
|
|
'org-babel-load-languages)
|
|
'custom-type)))))))
|
|
(while (pcomplete-here
|
|
'("-n" "-r" "-l"
|
|
":cache" ":colnames" ":comments" ":dir" ":eval" ":exports"
|
|
":file" ":hlines" ":no-expand" ":noweb" ":results" ":rownames"
|
|
":session" ":shebang" ":tangle" ":var"))))
|
|
|
|
(defun pcomplete/org-mode/block-option/clocktable ()
|
|
"Complete keywords in a clocktable line"
|
|
(while (pcomplete-here '(":maxlevel" ":scope"
|
|
":tstart" ":tend" ":block" ":step"
|
|
":stepskip0" ":fileskip0"
|
|
":emphasize" ":link" ":narrow" ":indent"
|
|
":tcolumns" ":level" ":compact" ":timestamp"
|
|
":formula" ":formatter"))))
|
|
|
|
(defun org-pcomplete-case-double (list)
|
|
"Return list with both upcase and downcase version of all strings in LIST."
|
|
(let (e res)
|
|
(while (setq e (pop list))
|
|
(setq res (cons (downcase e) (cons (upcase e) res))))
|
|
(nreverse res)))
|
|
|
|
;;;; Finish up
|
|
|
|
(provide 'org-pcomplete)
|
|
|
|
;;; org-pcomplete.el ends here
|