Commit | Line | Data |
---|---|---|
ed21c5c8 | 1 | ;;; org-ctags.el - Integrate Emacs "tags" facility with org mode. |
45d6be0a | 2 | ;; |
ba318903 | 3 | ;; Copyright (C) 2007-2014 Free Software Foundation, Inc. |
ed21c5c8 | 4 | |
45d6be0a | 5 | ;; Author: Paul Sexton <eeeickythump@gmail.com> |
e66ba1df | 6 | |
ed21c5c8 CD |
7 | |
8 | ;; Keywords: org, wp | |
ed21c5c8 CD |
9 | ;; |
10 | ;; This file is part of GNU Emacs. | |
11 | ;; | |
12 | ;; GNU Emacs is free software: you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
14 | ;; the Free Software Foundation, either version 3 of the License, or | |
15 | ;; (at your option) any later version. | |
16 | ||
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. | |
24 | ||
45d6be0a SM |
25 | ;; |
26 | ;; Synopsis | |
27 | ;; ======== | |
28 | ;; | |
8223b1d2 | 29 | ;; Allows org-mode to make use of the Emacs `etags' system. Defines tag |
45d6be0a SM |
30 | ;; destinations in org-mode files as any text between <<double angled |
31 | ;; brackets>>. This allows the tags-generation program `exuberant ctags' to | |
32 | ;; parse these files and create tag tables that record where these | |
8223b1d2 | 33 | ;; destinations are found. Plain [[links]] in org mode files which do not have |
45d6be0a SM |
34 | ;; <<matching destinations>> within the same file will then be interpreted as |
35 | ;; links to these 'tagged' destinations, allowing seamless navigation between | |
8223b1d2 BG |
36 | ;; multiple org-mode files. Topics can be created in any org mode file and |
37 | ;; will always be found by plain links from other files. Other file types | |
27e428e7 | 38 | ;; recognized by ctags (source code files, latex files, etc) will also be |
45d6be0a | 39 | ;; available as destinations for plain links, and similarly, org-mode links |
8223b1d2 | 40 | ;; will be available as tags from source files. Finally, the function |
45d6be0a SM |
41 | ;; `org-ctags-find-tag-interactive' lets you choose any known tag, using |
42 | ;; autocompletion, and quickly jump to it. | |
43 | ;; | |
44 | ;; Installation | |
45 | ;; ============ | |
46 | ;; | |
47 | ;; Install org mode | |
48 | ;; Ensure org-ctags.el is somewhere in your emacs load path. | |
49 | ;; Download and install Exuberant ctags -- "http://ctags.sourceforge.net/" | |
50 | ;; Edit your .emacs file (see next section) and load emacs. | |
51 | ||
52 | ;; To put in your init file (.emacs): | |
53 | ;; ================================== | |
54 | ;; | |
55 | ;; Assuming you already have org mode installed and set up: | |
56 | ;; | |
57 | ;; (setq org-ctags-path-to-ctags "/path/to/ctags/executable") | |
58 | ;; (add-hook 'org-mode-hook | |
59 | ;; (lambda () | |
60 | ;; (define-key org-mode-map "\C-co" 'org-ctags-find-tag-interactive))) | |
61 | ;; | |
62 | ;; By default, with org-ctags loaded, org will first try and visit the tag | |
63 | ;; with the same name as the link; then, if unsuccessful, ask the user if | |
64 | ;; he/she wants to rebuild the 'TAGS' database and try again; then ask if | |
65 | ;; the user wishes to append 'tag' as a new toplevel heading at the end of | |
3c8b09ca | 66 | ;; the buffer; and finally, defer to org's default behaviour which is to |
45d6be0a SM |
67 | ;; search the entire text of the current buffer for 'tag'. |
68 | ;; | |
3c8b09ca | 69 | ;; This behaviour can be modified by changing the value of |
45d6be0a | 70 | ;; ORG-CTAGS-OPEN-LINK-FUNCTIONS. For example I have the following in my |
3c8b09ca | 71 | ;; .emacs, which describes the same behaviour as the above paragraph with |
45d6be0a SM |
72 | ;; one difference: |
73 | ;; | |
74 | ;; (setq org-ctags-open-link-functions | |
75 | ;; '(org-ctags-find-tag | |
76 | ;; org-ctags-ask-rebuild-tags-file-then-find-tag | |
77 | ;; org-ctags-ask-append-topic | |
3c8b09ca | 78 | ;; org-ctags-fail-silently)) ; <-- prevents org default behaviour |
45d6be0a SM |
79 | ;; |
80 | ;; | |
81 | ;; Usage | |
82 | ;; ===== | |
83 | ;; | |
84 | ;; When you click on a link "[[foo]]" and org cannot find a matching "<<foo>>" | |
8223b1d2 | 85 | ;; in the current buffer, the tags facility will take over. The file TAGS in |
45d6be0a | 86 | ;; the active directory is examined to see if the tags facility knows about |
8223b1d2 | 87 | ;; "<<foo>>" in any other files. If it does, the matching file will be opened |
45d6be0a SM |
88 | ;; and the cursor will jump to the position of "<<foo>>" in that file. |
89 | ;; | |
90 | ;; User-visible functions: | |
91 | ;; - `org-ctags-find-tag-interactive': type a tag (plain link) name and visit | |
8223b1d2 BG |
92 | ;; it. With autocompletion. Bound to ctrl-O in the above setup. |
93 | ;; - All the etags functions should work. These include: | |
45d6be0a SM |
94 | ;; |
95 | ;; M-. `find-tag' -- finds the tag at point | |
96 | ;; | |
97 | ;; C-M-. find-tag based on regular expression | |
98 | ;; | |
99 | ;; M-x tags-search RET -- like C-M-. but searches through ENTIRE TEXT | |
8223b1d2 | 100 | ;; of ALL the files referenced in the TAGS file. A quick way to |
45d6be0a SM |
101 | ;; search through an entire 'project'. |
102 | ;; | |
8223b1d2 | 103 | ;; M-* "go back" from a tag jump. Like `org-mark-ring-goto'. |
45d6be0a SM |
104 | ;; You may need to bind this key yourself with (eg) |
105 | ;; (global-set-key (kbd "<M-kp-multiply>") 'pop-tag-mark) | |
106 | ;; | |
107 | ;; (see etags chapter in Emacs manual for more) | |
108 | ;; | |
109 | ;; | |
110 | ;; Keeping the TAGS file up to date | |
111 | ;; ================================ | |
112 | ;; | |
113 | ;; Tags mode has no way of knowing that you have created new tags by typing in | |
114 | ;; your org-mode buffer. New tags make it into the TAGS file in 3 ways: | |
115 | ;; | |
116 | ;; 1. You re-run (org-ctags-create-tags "directory") to rebuild the file. | |
117 | ;; 2. You put the function `org-ctags-ask-rebuild-tags-file-then-find-tag' in | |
118 | ;; your `org-open-link-functions' list, as is done in the setup | |
8223b1d2 BG |
119 | ;; above. This will cause the TAGS file to be rebuilt whenever a link |
120 | ;; cannot be found. This may be slow with large file collections however. | |
45d6be0a SM |
121 | ;; 3. You run the following from the command line (all 1 line): |
122 | ;; | |
123 | ;; ctags --langdef=orgmode --langmap=orgmode:.org | |
124 | ;; --regex-orgmode="/<<([^>]+)>>/\1/d,definition/" | |
125 | ;; -f /your/path/TAGS -e -R /your/path/*.org | |
126 | ;; | |
127 | ;; If you are paranoid, you might want to run (org-ctags-create-tags | |
128 | ;; "/path/to/org/files") at startup, by including the following toplevel form | |
8223b1d2 | 129 | ;; in .emacs. However this can cause a pause of several seconds if ctags has |
45d6be0a SM |
130 | ;; to scan lots of files. |
131 | ;; | |
132 | ;; (progn | |
133 | ;; (message "-- rebuilding tags tables...") | |
271672fa | 134 | ;; (mapc 'org-ctags-create-tags tags-table-list)) |
ed21c5c8 | 135 | |
86fbb8ca CD |
136 | ;;; Code: |
137 | ||
ed21c5c8 | 138 | (eval-when-compile (require 'cl)) |
86fbb8ca | 139 | |
ed21c5c8 CD |
140 | (require 'org) |
141 | ||
e66ba1df BG |
142 | (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label)) |
143 | ||
ed21c5c8 CD |
144 | (defgroup org-ctags nil |
145 | "Options concerning use of ctags within org mode." | |
146 | :tag "Org-Ctags" | |
147 | :group 'org-link) | |
148 | ||
149 | (defvar org-ctags-enabled-p t | |
150 | "Activate ctags support in org mode?") | |
151 | ||
152 | (defvar org-ctags-tag-regexp "/<<([^>]+)>>/\\1/d,definition/" | |
86fbb8ca CD |
153 | "Regexp expression used by ctags external program. |
154 | The regexp matches tag destinations in org-mode files. | |
ed21c5c8 CD |
155 | Format is: /REGEXP/TAGNAME/FLAGS,TAGTYPE/ |
156 | See the ctags documentation for more information.") | |
157 | ||
158 | (defcustom org-ctags-path-to-ctags | |
271672fa BG |
159 | (if (executable-find "ctags-exuberant") "ctags-exuberant" "ctags") |
160 | "Name of the ctags executable file." | |
ed21c5c8 | 161 | :group 'org-ctags |
372d7b21 | 162 | :version "24.1" |
ed21c5c8 CD |
163 | :type 'file) |
164 | ||
165 | (defcustom org-ctags-open-link-functions | |
166 | '(org-ctags-find-tag | |
167 | org-ctags-ask-rebuild-tags-file-then-find-tag | |
168 | org-ctags-ask-append-topic) | |
86fbb8ca | 169 | "List of functions to be prepended to ORG-OPEN-LINK-FUNCTIONS when ORG-CTAGS is active." |
ed21c5c8 | 170 | :group 'org-ctags |
372d7b21 | 171 | :version "24.1" |
ed21c5c8 CD |
172 | :type 'hook |
173 | :options '(org-ctags-find-tag | |
174 | org-ctags-ask-rebuild-tags-file-then-find-tag | |
175 | org-ctags-rebuild-tags-file-then-find-tag | |
176 | org-ctags-ask-append-topic | |
177 | org-ctags-append-topic | |
178 | org-ctags-ask-visit-buffer-or-file | |
179 | org-ctags-visit-buffer-or-file | |
180 | org-ctags-fail-silently)) | |
181 | ||
182 | ||
183 | (defvar org-ctags-tag-list nil | |
86fbb8ca CD |
184 | "List of all tags in the active TAGS file. |
185 | Created as a local variable in each buffer.") | |
ed21c5c8 CD |
186 | |
187 | (defcustom org-ctags-new-topic-template | |
0cd38783 | 188 | "* <<%t>>\n\n\n\n\n\n" |
ed21c5c8 CD |
189 | "Text to insert when creating a new org file via opening a hyperlink. |
190 | The following patterns are replaced in the string: | |
191 | `%t' - replaced with the capitalized title of the hyperlink" | |
192 | :group 'org-ctags | |
8223b1d2 | 193 | :version "24.1" |
ed21c5c8 CD |
194 | :type 'string) |
195 | ||
196 | ||
197 | (add-hook 'org-mode-hook | |
198 | (lambda () | |
199 | (when (and org-ctags-enabled-p | |
200 | (buffer-file-name)) | |
201 | ;; Make sure this file's directory is added to default | |
202 | ;; directories in which to search for tags. | |
203 | (let ((tags-filename | |
204 | (expand-file-name | |
205 | (concat (file-name-directory (buffer-file-name)) | |
206 | "/TAGS")))) | |
207 | (when (file-exists-p tags-filename) | |
208 | (visit-tags-table tags-filename)))))) | |
209 | ||
210 | ||
211 | (defadvice visit-tags-table (after org-ctags-load-tag-list activate compile) | |
212 | (when (and org-ctags-enabled-p tags-file-name) | |
213 | (set (make-local-variable 'org-ctags-tag-list) | |
214 | (org-ctags-all-tags-in-current-tags-table)))) | |
215 | ||
216 | ||
217 | (defun org-ctags-enable () | |
218 | (put 'org-mode 'find-tag-default-function 'org-ctags-find-tag-at-point) | |
219 | (setq org-ctags-enabled-p t) | |
220 | (dolist (fn org-ctags-open-link-functions) | |
221 | (add-hook 'org-open-link-functions fn t))) | |
222 | ||
223 | ||
86fbb8ca | 224 | ;;; General utility functions. =============================================== |
45d6be0a | 225 | ;; These work outside org-ctags mode. |
ed21c5c8 CD |
226 | |
227 | (defun org-ctags-get-filename-for-tag (tag) | |
86fbb8ca CD |
228 | "TAG is a string. Search the active TAGS file for a matching tag. |
229 | If the tag is found, return a list containing the filename, line number, and | |
ed21c5c8 CD |
230 | buffer position where the tag is found." |
231 | (interactive "sTag: ") | |
232 | (unless tags-file-name | |
233 | (call-interactively (visit-tags-table))) | |
234 | (save-excursion | |
235 | (visit-tags-table-buffer 'same) | |
236 | (when tags-file-name | |
237 | (with-current-buffer (get-file-buffer tags-file-name) | |
238 | (goto-char (point-min)) | |
239 | (cond | |
240 | ((re-search-forward (format "^.*\7f%s\ 1\\([0-9]+\\),\\([0-9]+\\)$" | |
241 | (regexp-quote tag)) nil t) | |
242 | (let ((line (string-to-number (match-string 1))) | |
243 | (pos (string-to-number (match-string 2)))) | |
244 | (cond | |
245 | ((re-search-backward "\f\n\\(.*\\),[0-9]+\n") | |
246 | (list (match-string 1) line pos)) | |
247 | (t ; can't find a file name preceding the matched | |
8223b1d2 | 248 | ; tag?? |
ed21c5c8 CD |
249 | (error "Malformed TAGS file: %s" (buffer-name)))))) |
250 | (t ; tag not found | |
251 | nil)))))) | |
252 | ||
253 | ||
254 | (defun org-ctags-all-tags-in-current-tags-table () | |
255 | "Read all tags defined in the active TAGS file, into a list of strings. | |
256 | Return the list." | |
257 | (interactive) | |
258 | (let ((taglist nil)) | |
259 | (unless tags-file-name | |
260 | (call-interactively (visit-tags-table))) | |
261 | (save-excursion | |
262 | (visit-tags-table-buffer 'same) | |
263 | (with-current-buffer (get-file-buffer tags-file-name) | |
264 | (goto-char (point-min)) | |
265 | (while (re-search-forward "^.*\7f\\(.*\\)\ 1\\([0-9]+\\),\\([0-9]+\\)$" | |
266 | nil t) | |
267 | (push (substring-no-properties (match-string 1)) taglist))) | |
268 | taglist))) | |
269 | ||
270 | ||
271 | (defun org-ctags-string-search-and-replace (search replace string) | |
272 | "Replace all instances of SEARCH with REPLACE in STRING." | |
273 | (replace-regexp-in-string (regexp-quote search) replace string t t)) | |
274 | ||
275 | ||
276 | (defun y-or-n-minibuffer (prompt) | |
277 | (let ((use-dialog-box nil)) | |
278 | (y-or-n-p prompt))) | |
279 | ||
280 | ||
281 | ;;; Internal functions ======================================================= | |
282 | ||
283 | ||
284 | (defun org-ctags-open-file (name &optional title) | |
86fbb8ca CD |
285 | "Visit or create a file called `NAME.org', and insert a new topic. |
286 | The new topic will be titled NAME (or TITLE if supplied)." | |
ed21c5c8 CD |
287 | (interactive "sFile name: ") |
288 | (let ((filename (substitute-in-file-name (expand-file-name name)))) | |
289 | (condition-case v | |
290 | (progn | |
291 | (org-open-file name t) | |
292 | (message "Opened file OK") | |
293 | (goto-char (point-max)) | |
294 | (insert (org-ctags-string-search-and-replace | |
295 | "%t" (capitalize (or title name)) | |
296 | org-ctags-new-topic-template)) | |
297 | (message "Inserted new file text OK") | |
298 | (org-mode-restart)) | |
299 | (error (error "Error %S in org-ctags-open-file" v))))) | |
300 | ||
301 | ||
302 | ;;;; Misc interoperability with etags system ================================= | |
303 | ||
304 | ||
305 | (defadvice find-tag (before org-ctags-set-org-mark-before-finding-tag | |
306 | activate compile) | |
307 | "Before trying to find a tag, save our current position on org mark ring." | |
308 | (save-excursion | |
8223b1d2 | 309 | (if (and (derived-mode-p 'org-mode) org-ctags-enabled-p) |
ed21c5c8 CD |
310 | (org-mark-ring-push)))) |
311 | ||
312 | ||
313 | ||
314 | (defun org-ctags-find-tag-at-point () | |
315 | "Determine default tag to search for, based on text at point. | |
316 | If there is no plausible default, return nil." | |
317 | (let (from to bound) | |
318 | (when (or (ignore-errors | |
319 | ;; Look for hyperlink around `point'. | |
320 | (save-excursion | |
321 | (search-backward "[[") (setq from (+ 2 (point)))) | |
322 | (save-excursion | |
323 | (goto-char from) | |
324 | (search-forward "]") (setq to (- (point) 1))) | |
325 | (and (> to from) (>= (point) from) (<= (point) to))) | |
326 | (progn | |
327 | ;; Look at text around `point'. | |
328 | (save-excursion | |
329 | (skip-syntax-backward "w_") (setq from (point))) | |
330 | (save-excursion | |
331 | (skip-syntax-forward "w_") (setq to (point))) | |
332 | (> to from)) | |
333 | ;; Look between `line-beginning-position' and `point'. | |
334 | (save-excursion | |
335 | (and (setq bound (line-beginning-position)) | |
336 | (skip-syntax-backward "^w_" bound) | |
337 | (> (setq to (point)) bound) | |
338 | (skip-syntax-backward "w_") | |
339 | (setq from (point)))) | |
340 | ;; Look between `point' and `line-end-position'. | |
341 | (save-excursion | |
342 | (and (setq bound (line-end-position)) | |
343 | (skip-syntax-forward "^w_" bound) | |
344 | (< (setq from (point)) bound) | |
345 | (skip-syntax-forward "w_") | |
346 | (setq to (point))))) | |
347 | (buffer-substring-no-properties from to)))) | |
348 | ||
349 | ||
350 | ;;; Functions for use with 'org-open-link-functions' hook ================= | |
351 | ||
352 | ||
353 | (defun org-ctags-find-tag (name) | |
354 | "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS. | |
86fbb8ca | 355 | Look for a tag called `NAME' in the current TAGS table. If it is found, |
ed21c5c8 CD |
356 | visit the file and location where the tag is found." |
357 | (interactive "sTag: ") | |
358 | (let ((old-buf (current-buffer)) | |
359 | (old-pnt (point-marker)) | |
360 | (old-mark (copy-marker (mark-marker)))) | |
361 | (condition-case nil | |
362 | (progn (find-tag name) | |
363 | t) | |
364 | (error | |
365 | ;; only restore old location if find-tag raises error | |
366 | (set-buffer old-buf) | |
367 | (goto-char old-pnt) | |
368 | (set-marker (mark-marker) old-mark) | |
369 | nil)))) | |
370 | ||
371 | ||
372 | (defun org-ctags-visit-buffer-or-file (name &optional create) | |
373 | "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS. | |
86fbb8ca CD |
374 | Visit buffer named `NAME.org'. If there is no such buffer, visit the file |
375 | with the same name if it exists. If the file does not exist, then behavior | |
ed21c5c8 CD |
376 | depends on the value of CREATE. |
377 | ||
86fbb8ca | 378 | If CREATE is nil (default), then return nil. Do not create a new file. |
ed21c5c8 CD |
379 | If CREATE is t, create the new file and visit it. |
380 | If CREATE is the symbol `ask', then ask the user if they wish to create | |
381 | the new file." | |
382 | (interactive) | |
383 | (let ((filename (concat (substitute-in-file-name | |
384 | (expand-file-name name)) | |
385 | ".org"))) | |
386 | (cond | |
387 | ((get-buffer (concat name ".org")) | |
388 | ;; Buffer is already open | |
e66ba1df | 389 | (org-pop-to-buffer-same-window (get-buffer (concat name ".org")))) |
ed21c5c8 CD |
390 | ((file-exists-p filename) |
391 | ;; File exists but is not open --> open it | |
392 | (message "Opening existing org file `%S'..." | |
393 | filename) | |
394 | (org-open-file filename t)) | |
395 | ((or (eql create t) | |
396 | (and (eql create 'ask) | |
397 | (y-or-n-p (format "File `%s.org' not found; create?" name)))) | |
398 | (org-ctags-open-file filename name)) | |
399 | (t ;; File does not exist, and we don't want to create it. | |
400 | nil)))) | |
401 | ||
402 | ||
403 | (defun org-ctags-ask-visit-buffer-or-file (name) | |
404 | "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS. | |
405 | Wrapper for org-ctags-visit-buffer-or-file, which ensures the user is | |
406 | asked before creating a new file." | |
407 | (org-ctags-visit-buffer-or-file name 'ask)) | |
408 | ||
409 | ||
410 | (defun org-ctags-append-topic (name &optional narrowp) | |
411 | "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS. | |
8223b1d2 | 412 | Append a new toplevel heading to the end of the current buffer. The |
ed21c5c8 CD |
413 | heading contains NAME surrounded by <<angular brackets>>, thus making |
414 | the heading a destination for the tag `NAME'." | |
415 | (interactive "sTopic: ") | |
416 | (widen) | |
417 | (goto-char (point-max)) | |
418 | (newline 2) | |
419 | (message "Adding topic in buffer %s" (buffer-name)) | |
420 | (insert (org-ctags-string-search-and-replace | |
421 | "%t" (capitalize name) org-ctags-new-topic-template)) | |
422 | (backward-char 4) | |
423 | (org-update-radio-target-regexp) | |
424 | (end-of-line) | |
425 | (forward-line 2) | |
426 | (when narrowp | |
427 | ;;(org-tree-to-indirect-buffer 1) ;; opens new frame | |
428 | (org-narrow-to-subtree)) | |
429 | t) | |
430 | ||
431 | ||
432 | (defun org-ctags-ask-append-topic (name &optional narrowp) | |
433 | "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS. | |
434 | Wrapper for org-ctags-append-topic, which first asks the user if they want | |
435 | to append a new topic." | |
436 | (if (y-or-n-p (format "Topic `%s' not found; append to end of buffer?" | |
437 | name)) | |
438 | (org-ctags-append-topic name narrowp) | |
439 | nil)) | |
440 | ||
441 | ||
442 | (defun org-ctags-rebuild-tags-file-then-find-tag (name) | |
443 | "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS. | |
444 | Like ORG-CTAGS-FIND-TAG, but calls the external ctags program first, | |
445 | to rebuild (update) the TAGS file." | |
446 | (unless tags-file-name | |
447 | (call-interactively (visit-tags-table))) | |
448 | (when (buffer-file-name) | |
449 | (org-ctags-create-tags)) | |
450 | (org-ctags-find-tag name)) | |
451 | ||
452 | ||
453 | (defun org-ctags-ask-rebuild-tags-file-then-find-tag (name) | |
454 | "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS. | |
455 | Wrapper for org-ctags-rebuild-tags-file-then-find-tag." | |
456 | (if (and (buffer-file-name) | |
8223b1d2 BG |
457 | (y-or-n-p |
458 | (format | |
459 | "Tag `%s' not found. Rebuild table `%s/TAGS' and look again?" | |
460 | name | |
461 | (file-name-directory (buffer-file-name))))) | |
462 | (org-ctags-rebuild-tags-file-then-find-tag name) | |
ed21c5c8 CD |
463 | nil)) |
464 | ||
465 | ||
466 | (defun org-ctags-fail-silently (name) | |
467 | "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS. | |
468 | Put as the last function in the list if you want to prevent org's default | |
86fbb8ca | 469 | behavior of free text search." |
ed21c5c8 CD |
470 | t) |
471 | ||
472 | ||
473 | ;;; User-visible functions =================================================== | |
474 | ||
475 | ||
476 | (defun org-ctags-create-tags (&optional directory-name) | |
86fbb8ca CD |
477 | "(Re)create tags file in the directory of the active buffer. |
478 | The file will contain tag definitions for all the files in the | |
479 | directory and its subdirectories which are recognized by ctags. | |
480 | This will include files ending in `.org' as well as most other | |
481 | source files (.C, .H, .EL, .LISP, etc). All the resulting tags | |
482 | end up in one file, called TAGS, located in the directory. This | |
483 | function may take several seconds to finish if the directory or | |
484 | its subdirectories contain large numbers of taggable files." | |
ed21c5c8 CD |
485 | (interactive) |
486 | (assert (buffer-file-name)) | |
487 | (let ((dir-name (or directory-name | |
488 | (file-name-directory (buffer-file-name)))) | |
489 | (exitcode nil)) | |
490 | (save-excursion | |
491 | (setq exitcode | |
492 | (shell-command | |
493 | (format (concat "%s --langdef=orgmode --langmap=orgmode:.org " | |
494 | "--regex-orgmode=\"%s\" -f \"%s\" -e -R \"%s\"") | |
495 | org-ctags-path-to-ctags | |
496 | org-ctags-tag-regexp | |
497 | (expand-file-name (concat dir-name "/TAGS")) | |
498 | (expand-file-name (concat dir-name "/*"))))) | |
499 | (cond | |
500 | ((eql 0 exitcode) | |
501 | (set (make-local-variable 'org-ctags-tag-list) | |
502 | (org-ctags-all-tags-in-current-tags-table))) | |
503 | (t | |
504 | ;; This seems to behave differently on Linux, so just ignore | |
505 | ;; error codes for now | |
506 | ;;(error "Calling ctags executable resulted in error code: %s" | |
507 | ;; exitcode) | |
508 | nil))))) | |
509 | ||
510 | ||
511 | (defvar org-ctags-find-tag-history nil | |
512 | "History of tags visited by org-ctags-find-tag-interactive.") | |
513 | ||
514 | (defun org-ctags-find-tag-interactive () | |
86fbb8ca CD |
515 | "Prompt for the name of a tag, with autocompletion, then visit the named tag. |
516 | Uses `ido-mode' if available. | |
ed21c5c8 CD |
517 | If the user enters a string that does not match an existing tag, create |
518 | a new topic." | |
519 | (interactive) | |
520 | (let* ((completing-read-fn (if (fboundp 'ido-completing-read) | |
521 | 'ido-completing-read | |
522 | 'completing-read)) | |
523 | (tag (funcall completing-read-fn "Topic: " org-ctags-tag-list | |
524 | nil 'confirm nil 'org-ctags-find-tag-history))) | |
525 | (when tag | |
526 | (cond | |
527 | ((member tag org-ctags-tag-list) | |
528 | ;; Existing tag | |
529 | (push tag org-ctags-find-tag-history) | |
530 | (find-tag tag)) | |
531 | (t | |
532 | ;; New tag | |
533 | (run-hook-with-args-until-success | |
8223b1d2 | 534 | 'org-open-link-functions tag)))))) |
ed21c5c8 CD |
535 | |
536 | ||
537 | (org-ctags-enable) | |
538 | ||
539 | (provide 'org-ctags) | |
540 | ||
ed21c5c8 | 541 | ;;; org-ctags.el ends here |