blob: f52f3606450999c0c2909ec21af4de4f1c587b9b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
;;; helm-org.el --- Helm for org headlines and keywords completion -*- lexical-binding: t -*-
;; Copyright (C) 2012 ~ 2015 Thierry Volpiatto <thierry.volpiatto@gmail.com>
;; This program 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.
;; This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
;;; Code:
(require 'cl-lib)
(require 'helm)
(require 'helm-utils)
(require 'org)
(declare-function org-agenda-switch-to "org-agenda.el")
(defgroup helm-org nil
"Org related functions for helm."
:group 'helm)
(defcustom helm-org-headings-fontify nil
"Fontify org buffers before parsing them.
This reflect fontification in helm-buffer when non--nil.
NOTE: This will be slow on large org buffers."
:group 'helm-org
:type 'boolean)
;; Internal
(defvar helm-org-headings--nofilename nil)
;;; Org capture templates
;;
;;
(defvar org-capture-templates)
(defun helm-source-org-capture-templates ()
(helm-build-sync-source "Org Capture Templates:"
:candidates (cl-loop for template in org-capture-templates
collect `(,(nth 1 template) . ,(nth 0 template)))
:action '(("Do capture" . (lambda (template-shortcut)
(org-capture nil template-shortcut))))))
;;; Org headings
;;
;;
(defun helm-org-goto-marker (marker)
(switch-to-buffer (marker-buffer marker))
(goto-char (marker-position marker))
(org-show-context)
(org-show-entry))
(cl-defun helm-source-org-headings-for-files
(filenames
&optional (min-depth 1) (max-depth 8) parents)
(helm-build-sync-source "Org Headings"
:candidates filenames ; Start with only filenames.
:match (lambda (candidate)
(string-match
helm-pattern
(helm-aif (get-text-property 0 'helm-real-display candidate)
it
candidate)))
:candidate-transformer
;; Now that the helm-window is available proceed to truncation
;; and other transformations.
`(lambda (candidates)
(let ((cands (helm-org-get-candidates
candidates ,min-depth ,max-depth ,parents)))
(if ,parents (nreverse cands) cands)))
:action '(("Go to line" . helm-org-goto-marker)
("Refile to this heading" . helm-org-heading-refile)
("Insert link to this heading"
. helm-org-insert-link-to-heading-at-marker))))
(defun helm-org-insert-link-to-heading-at-marker (marker)
(with-current-buffer (marker-buffer marker)
(let ((heading-name (save-excursion (goto-char (marker-position marker))
(nth 4 (org-heading-components))))
(file-name (buffer-file-name)))
(with-helm-current-buffer
(org-insert-link
file-name (concat "file:" file-name "::*" heading-name))))))
(defun helm-org-heading-refile (marker)
(save-selected-window
(when (eq major-mode 'org-agenda-mode)
(org-agenda-switch-to))
(org-cut-subtree)
(let ((target-level (with-current-buffer (marker-buffer marker)
(goto-char (marker-position marker))
(org-current-level))))
(helm-org-goto-marker marker)
(org-end-of-subtree t t)
(org-paste-subtree (+ target-level 1)))))
(defun helm-org-get-candidates (filenames min-depth max-depth &optional parents)
(helm-flatten-list
(mapcar (lambda (filename)
(helm-org--get-candidates-in-file
filename min-depth max-depth
helm-org-headings-fontify
(or parents helm-org-headings--nofilename)
parents))
filenames)
t))
(defun helm-org--get-candidates-in-file (filename min-depth max-depth
&optional fontify nofname parents)
(with-current-buffer (pcase filename
((pred bufferp) filename)
((pred stringp) (find-file-noselect filename)))
(and fontify (jit-lock-fontify-now))
(let ((match-fn (if fontify
#'match-string
#'match-string-no-properties))
(search-fn (lambda ()
(when (or (null parents)
(org-up-heading-safe))
(re-search-forward
org-complex-heading-regexp nil t)))))
(save-excursion
(save-restriction
(widen)
(unless parents (goto-char (point-min)))
(cl-loop with width = (window-width)
while (funcall search-fn)
for num-stars = (length (match-string-no-properties 1))
for heading = (funcall match-fn 4)
for file = (unless nofname
(concat (helm-basename filename) ":"))
for level = (length (match-string-no-properties 1))
if (and (>= num-stars min-depth) (<= num-stars max-depth))
collect (cons (propertize
(org-format-outline-path
(append (apply #'org-get-outline-path
(unless parents
(list t level heading)))
(list heading))
width file) 'helm-real-display heading)
(point-marker))))))))
;;;###autoload
(defun helm-org-agenda-files-headings ()
"Preconfigured helm for org files headings."
(interactive)
(helm :sources (helm-source-org-headings-for-files (org-agenda-files))
:candidate-number-limit 99999
:buffer "*helm org headings*"))
;;;###autoload
(defun helm-org-in-buffer-headings ()
"Preconfigured helm for org buffer headings."
(interactive)
(let ((helm-org-headings--nofilename t))
(helm :sources (helm-source-org-headings-for-files
(list (current-buffer)))
:candidate-number-limit 99999
:buffer "*helm org inbuffer*")))
;;;###autoload
(defun helm-org-parent-headings ()
"Preconfigured helm for org headings that are parents of the
current heading."
(interactive)
(helm :sources (helm-source-org-headings-for-files
(list (current-buffer))
1 50 t) ; Use a large max-depth to ensure all parents are displayed
:preselect (org-format-outline-path (org-get-outline-path))
:candidate-number-limit 99999
:buffer "*helm org parent headings*"))
;;;###autoload
(defun helm-org-capture-templates ()
"Preconfigured helm for org templates."
(interactive)
(helm :sources (helm-source-org-capture-templates)
:candidate-number-limit 99999
:buffer "*helm org capture templates*"))
(provide 'helm-org)
;; Local Variables:
;; byte-compile-warnings: (not cl-functions obsolete)
;; coding: utf-8
;; indent-tabs-mode: nil
;; End:
;;; helm-org.el ends here
|
