org-ctags.el 19.6 KB
Newer Older
Rasmus's avatar
Rasmus committed
1
;;; org-ctags.el - Integrate Emacs "tags" Facility with Org -*- lexical-binding: t; -*-
Stefan Monnier's avatar
Stefan Monnier committed
2
;;
Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2007-2020 Free Software Foundation, Inc.
4

Stefan Monnier's avatar
Stefan Monnier committed
5
;; Author: Paul Sexton <eeeickythump@gmail.com>
Bastien Guerry's avatar
Bastien Guerry committed
6

7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

;; Keywords: org, wp
;;
;; 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
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
24

Stefan Monnier's avatar
Stefan Monnier committed
25 26 27 28
;;
;; Synopsis
;; ========
;;
Rasmus's avatar
Rasmus committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
;; Allows Org mode to make use of the Emacs `etags' system.  Defines
;; tag destinations in Org files as any text between <<double angled
;; brackets>>. This allows the tags-generation program `exuberant
;; ctags' to parse these files and create tag tables that record where
;; these destinations are found.  Plain [[links]] in org mode files
;; which do not have <<matching destinations>> within the same file
;; will then be interpreted as links to these 'tagged' destinations,
;; allowing seamless navigation between multiple Org files.  Topics
;; can be created in any org mode file and will always be found by
;; plain links from other files.  Other file types recognized by ctags
;; (source code files, latex files, etc) will also be available as
;; destinations for plain links, and similarly, Org links will be
;; available as tags from source files.  Finally, the function
;; `org-ctags-find-tag-interactive' lets you choose any known tag,
;; using autocompletion, and quickly jump to it.
Stefan Monnier's avatar
Stefan Monnier committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
;;
;; Installation
;; ============
;;
;; Install org mode
;; Ensure org-ctags.el is somewhere in your emacs load path.
;; Download and install Exuberant ctags -- "http://ctags.sourceforge.net/"
;; Edit your .emacs file (see next section) and load emacs.

;; To put in your init file (.emacs):
;; ==================================
;;
;; Assuming you already have org mode installed and set up:
;;
;;    (setq org-ctags-path-to-ctags "/path/to/ctags/executable")
;;    (add-hook 'org-mode-hook
;;      (lambda ()
;;        (define-key org-mode-map "\C-co" 'org-ctags-find-tag-interactive)))
;;
;; By default, with org-ctags loaded, org will first try and visit the tag
;; with the same name as the link; then, if unsuccessful, ask the user if
;; he/she wants to rebuild the 'TAGS' database and try again; then ask if
;; the user wishes to append 'tag' as a new toplevel heading at the end of
Paul Eggert's avatar
Paul Eggert committed
67
;; the buffer; and finally, defer to org's default behavior which is to
Stefan Monnier's avatar
Stefan Monnier committed
68 69
;; search the entire text of the current buffer for 'tag'.
;;
Paul Eggert's avatar
Paul Eggert committed
70
;; This behavior can be modified by changing the value of
Stefan Monnier's avatar
Stefan Monnier committed
71
;; ORG-CTAGS-OPEN-LINK-FUNCTIONS. For example I have the following in my
Paul Eggert's avatar
Paul Eggert committed
72
;; .emacs, which describes the same behavior as the above paragraph with
Stefan Monnier's avatar
Stefan Monnier committed
73 74 75 76 77 78
;; one difference:
;;
;; (setq org-ctags-open-link-functions
;;       '(org-ctags-find-tag
;;         org-ctags-ask-rebuild-tags-file-then-find-tag
;;         org-ctags-ask-append-topic
Paul Eggert's avatar
Paul Eggert committed
79
;;         org-ctags-fail-silently))  ; <-- prevents org default behavior
Stefan Monnier's avatar
Stefan Monnier committed
80 81 82 83 84 85
;;
;;
;; Usage
;; =====
;;
;; When you click on a link "[[foo]]" and org cannot find a matching "<<foo>>"
86
;; in the current buffer, the tags facility will take over.  The file TAGS in
Stefan Monnier's avatar
Stefan Monnier committed
87
;; the active directory is examined to see if the tags facility knows about
88
;; "<<foo>>" in any other files.  If it does, the matching file will be opened
Stefan Monnier's avatar
Stefan Monnier committed
89 90 91 92
;; and the cursor will jump to the position of "<<foo>>" in that file.
;;
;; User-visible functions:
;; - `org-ctags-find-tag-interactive': type a tag (plain link) name and visit
93 94
;;   it.  With autocompletion.  Bound to ctrl-O in the above setup.
;; - All the etags functions should work.  These include:
Stefan Monnier's avatar
Stefan Monnier committed
95 96 97 98 99 100
;;
;;      M-.    `find-tag' -- finds the tag at point
;;
;;      C-M-.  find-tag based on regular expression
;;
;;      M-x tags-search RET -- like C-M-. but searches through ENTIRE TEXT
101
;;             of ALL the files referenced in the TAGS file.  A quick way to
Stefan Monnier's avatar
Stefan Monnier committed
102 103
;;             search through an entire 'project'.
;;
104
;;      M-*    "go back" from a tag jump.  Like `org-mark-ring-goto'.
Stefan Monnier's avatar
Stefan Monnier committed
105 106 107 108 109 110 111 112 113
;;             You may need to bind this key yourself with (eg)
;;             (global-set-key (kbd "<M-kp-multiply>") 'pop-tag-mark)
;;
;;      (see etags chapter in Emacs manual for more)
;;
;;
;; Keeping the TAGS file up to date
;; ================================
;;
Rasmus's avatar
Rasmus committed
114 115 116
;; Tags mode has no way of knowing that you have created new tags by
;; typing in your Org buffer.  New tags make it into the TAGS file in
;; 3 ways:
Stefan Monnier's avatar
Stefan Monnier committed
117 118 119 120
;;
;; 1. You re-run (org-ctags-create-tags "directory") to rebuild the file.
;; 2. You put the function `org-ctags-ask-rebuild-tags-file-then-find-tag' in
;;    your `org-open-link-functions' list, as is done in the setup
121 122
;;    above.  This will cause the TAGS file to be rebuilt whenever a link
;;    cannot be found.  This may be slow with large file collections however.
Stefan Monnier's avatar
Stefan Monnier committed
123 124 125 126 127 128 129 130
;; 3. You run the following from the command line (all 1 line):
;;
;;      ctags --langdef=orgmode --langmap=orgmode:.org
;;        --regex-orgmode="/<<([^>]+)>>/\1/d,definition/"
;;          -f /your/path/TAGS -e -R /your/path/*.org
;;
;; If you are paranoid, you might want to run (org-ctags-create-tags
;; "/path/to/org/files") at startup, by including the following toplevel form
131
;; in .emacs.  However this can cause a pause of several seconds if ctags has
Stefan Monnier's avatar
Stefan Monnier committed
132 133 134 135
;; to scan lots of files.
;;
;;     (progn
;;       (message "-- rebuilding tags tables...")
Bastien Guerry's avatar
Bastien Guerry committed
136
;;       (mapc 'org-ctags-create-tags tags-table-list))
137

138 139
;;; Code:

140
(eval-when-compile (require 'cl-lib))
141 142 143 144 145 146 147 148 149 150 151
(require 'org)

(defgroup org-ctags nil
  "Options concerning use of ctags within org mode."
  :tag "Org-Ctags"
  :group 'org-link)

(defvar org-ctags-enabled-p t
  "Activate ctags support in org mode?")

(defvar org-ctags-tag-regexp "/<<([^>]+)>>/\\1/d,definition/"
152
  "Regexp expression used by ctags external program.
Rasmus's avatar
Rasmus committed
153
The regexp matches tag destinations in Org files.
154 155 156 157
Format is: /REGEXP/TAGNAME/FLAGS,TAGTYPE/
See the ctags documentation for more information.")

(defcustom org-ctags-path-to-ctags
Bastien Guerry's avatar
Bastien Guerry committed
158 159
  (if (executable-find "ctags-exuberant") "ctags-exuberant" "ctags")
  "Name of the ctags executable file."
160
  :group 'org-ctags
161
  :version "24.1"
162 163 164 165 166 167
  :type 'file)

(defcustom org-ctags-open-link-functions
  '(org-ctags-find-tag
    org-ctags-ask-rebuild-tags-file-then-find-tag
    org-ctags-ask-append-topic)
168
  "List of functions to be prepended to ORG-OPEN-LINK-FUNCTIONS when ORG-CTAGS is active."
169
  :group 'org-ctags
170
  :version "24.1"
171 172 173 174 175 176 177 178 179 180 181 182
  :type 'hook
  :options '(org-ctags-find-tag
             org-ctags-ask-rebuild-tags-file-then-find-tag
             org-ctags-rebuild-tags-file-then-find-tag
             org-ctags-ask-append-topic
             org-ctags-append-topic
             org-ctags-ask-visit-buffer-or-file
             org-ctags-visit-buffer-or-file
             org-ctags-fail-silently))


(defvar org-ctags-tag-list nil
183 184
  "List of all tags in the active TAGS file.
Created as a local variable in each buffer.")
185 186

(defcustom org-ctags-new-topic-template
187
  "* <<%t>>\n\n\n\n\n\n"
188 189 190 191
  "Text to insert when creating a new org file via opening a hyperlink.
The following patterns are replaced in the string:
    `%t' - replaced with the capitalized title of the hyperlink"
  :group 'org-ctags
192
  :version "24.1"
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
  :type 'string)


(add-hook 'org-mode-hook
          (lambda ()
            (when (and org-ctags-enabled-p
                       (buffer-file-name))
              ;; Make sure this file's directory is added to default
              ;; directories in which to search for tags.
              (let ((tags-filename
                     (expand-file-name
                      (concat (file-name-directory (buffer-file-name))
                              "/TAGS"))))
                (when (file-exists-p tags-filename)
                  (visit-tags-table tags-filename))))))


(defadvice visit-tags-table (after org-ctags-load-tag-list activate compile)
  (when (and org-ctags-enabled-p tags-file-name)
Rasmus's avatar
Rasmus committed
212 213
    (setq-local org-ctags-tag-list
		(org-ctags-all-tags-in-current-tags-table))))
214 215 216 217 218 219 220 221 222


(defun org-ctags-enable ()
  (put 'org-mode 'find-tag-default-function 'org-ctags-find-tag-at-point)
  (setq org-ctags-enabled-p t)
  (dolist (fn org-ctags-open-link-functions)
    (add-hook 'org-open-link-functions fn t)))


223
;;; General utility functions.  ===============================================
Stefan Monnier's avatar
Stefan Monnier committed
224
;; These work outside org-ctags mode.
225 226

(defun org-ctags-get-filename-for-tag (tag)
227 228
  "TAG is a string.  Search the active TAGS file for a matching tag.
If the tag is found, return a list containing the filename, line number, and
229 230 231 232 233 234 235 236 237 238
buffer position where the tag is found."
  (interactive "sTag: ")
  (unless tags-file-name
    (call-interactively (visit-tags-table)))
  (save-excursion
    (visit-tags-table-buffer 'same)
    (when tags-file-name
      (with-current-buffer (get-file-buffer tags-file-name)
        (goto-char (point-min))
        (cond
239
         ((re-search-forward (format "^.*\^?%s\^A\\([0-9]+\\),\\([0-9]+\\)$"
240 241 242 243 244 245 246
                                     (regexp-quote tag)) nil t)
          (let ((line (string-to-number (match-string 1)))
                (pos (string-to-number (match-string 2))))
            (cond
             ((re-search-backward "\n\\(.*\\),[0-9]+\n")
              (list (match-string 1) line pos))
             (t              ; can't find a file name preceding the matched
247
					; tag??
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
              (error "Malformed TAGS file: %s" (buffer-name))))))
         (t                               ; tag not found
          nil))))))


(defun org-ctags-all-tags-in-current-tags-table ()
  "Read all tags defined in the active TAGS file, into a list of strings.
Return the list."
  (interactive)
  (let ((taglist nil))
    (unless tags-file-name
      (call-interactively (visit-tags-table)))
    (save-excursion
      (visit-tags-table-buffer 'same)
      (with-current-buffer (get-file-buffer tags-file-name)
        (goto-char (point-min))
264
        (while (re-search-forward "^.*\^?\\(.*\\)\^A\\([0-9]+\\),\\([0-9]+\\)$"
265 266 267 268 269 270 271 272 273 274 275 276 277 278
                                  nil t)
          (push (substring-no-properties (match-string 1)) taglist)))
      taglist)))


(defun org-ctags-string-search-and-replace (search replace string)
  "Replace all instances of SEARCH with REPLACE in STRING."
  (replace-regexp-in-string (regexp-quote search) replace string t t))


;;; Internal functions =======================================================


(defun org-ctags-open-file (name &optional title)
279 280
  "Visit or create a file called `NAME.org', and insert a new topic.
The new topic will be titled NAME (or TITLE if supplied)."
281
  (interactive "sFile name: ")
Rasmus's avatar
Rasmus committed
282 283 284 285 286 287 288 289 290 291 292
  (condition-case v
      (progn
	(org-open-file name t)
	(message "Opened file OK")
	(goto-char (point-max))
	(insert (org-ctags-string-search-and-replace
		 "%t" (capitalize (or title name))
		 org-ctags-new-topic-template))
	(message "Inserted new file text OK")
	(org-mode-restart))
    (error (error "Error %S in org-ctags-open-file" v))))
293 294 295 296 297


;;;; Misc interoperability with etags system =================================


Rasmus's avatar
Rasmus committed
298 299
(defadvice xref-find-definitions
    (before org-ctags-set-org-mark-before-finding-tag activate compile)
300 301
  "Before trying to find a tag, save our current position on org mark ring."
  (save-excursion
Rasmus's avatar
Rasmus committed
302 303
    (when (and (derived-mode-p 'org-mode) org-ctags-enabled-p)
      (org-mark-ring-push))))
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347



(defun org-ctags-find-tag-at-point ()
  "Determine default tag to search for, based on text at point.
If there is no plausible default, return nil."
  (let (from to bound)
    (when (or (ignore-errors
		;; Look for hyperlink around `point'.
		(save-excursion
		  (search-backward "[[") (setq from (+ 2 (point))))
		(save-excursion
                  (goto-char from)
		  (search-forward "]") (setq to (- (point) 1)))
		(and (> to from) (>= (point) from) (<= (point) to)))
              (progn
		;; Look at text around `point'.
		(save-excursion
		  (skip-syntax-backward "w_") (setq from (point)))
		(save-excursion
		  (skip-syntax-forward "w_") (setq to (point)))
		(> to from))
	      ;; Look between `line-beginning-position' and `point'.
	      (save-excursion
		(and (setq bound (line-beginning-position))
		     (skip-syntax-backward "^w_" bound)
		     (> (setq to (point)) bound)
		     (skip-syntax-backward "w_")
		     (setq from (point))))
	      ;; Look between `point' and `line-end-position'.
	      (save-excursion
		(and (setq bound (line-end-position))
		     (skip-syntax-forward "^w_" bound)
		     (< (setq from (point)) bound)
		     (skip-syntax-forward "w_")
		     (setq to (point)))))
      (buffer-substring-no-properties from to))))


;;; Functions for use with 'org-open-link-functions' hook =================


(defun org-ctags-find-tag (name)
  "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS.
348
Look for a tag called `NAME' in the current TAGS table.  If it is found,
349 350 351 352 353 354
visit the file and location where the tag is found."
  (interactive "sTag: ")
  (let ((old-buf (current-buffer))
        (old-pnt (point-marker))
        (old-mark (copy-marker (mark-marker))))
    (condition-case nil
Rasmus's avatar
Rasmus committed
355
        (progn (xref-find-definitions name)
356 357 358 359 360 361 362 363 364 365 366
               t)
      (error
       ;; only restore old location if find-tag raises error
       (set-buffer old-buf)
       (goto-char old-pnt)
       (set-marker (mark-marker) old-mark)
       nil))))


(defun org-ctags-visit-buffer-or-file (name &optional create)
  "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS.
367 368
Visit buffer named `NAME.org'.  If there is no such buffer, visit the file
with the same name if it exists.  If the file does not exist, then behavior
369 370
depends on the value of CREATE.

371
If CREATE is nil (default), then return nil.  Do not create a new file.
372 373 374 375 376 377 378 379 380 381
If CREATE is t, create the new file and visit it.
If CREATE is the symbol `ask', then ask the user if they wish to create
the new file."
  (interactive)
  (let ((filename (concat (substitute-in-file-name
                           (expand-file-name name))
                          ".org")))
    (cond
     ((get-buffer (concat name ".org"))
      ;; Buffer is already open
Rasmus's avatar
Rasmus committed
382
      (pop-to-buffer-same-window (get-buffer (concat name ".org"))))
383 384 385 386 387 388 389
     ((file-exists-p filename)
      ;; File exists but is not open --> open it
      (message "Opening existing org file `%S'..."
               filename)
      (org-open-file filename t))
     ((or (eql create t)
          (and (eql create 'ask)
Paul Eggert's avatar
Paul Eggert committed
390 391
               (y-or-n-p (format-message
			  "File `%s.org' not found; create?" name))))
392 393 394 395 396 397 398 399 400 401 402 403 404 405
      (org-ctags-open-file filename name))
     (t ;; File does not exist, and we don't want to create it.
      nil))))


(defun org-ctags-ask-visit-buffer-or-file (name)
  "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS.
Wrapper for org-ctags-visit-buffer-or-file, which ensures the user is
asked before creating a new file."
  (org-ctags-visit-buffer-or-file name 'ask))


(defun org-ctags-append-topic (name &optional narrowp)
  "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS.
406
Append a new toplevel heading to the end of the current buffer.  The
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
heading contains NAME surrounded by <<angular brackets>>, thus making
the heading a destination for the tag `NAME'."
  (interactive "sTopic: ")
  (widen)
  (goto-char (point-max))
  (newline 2)
  (message "Adding topic in buffer %s" (buffer-name))
  (insert (org-ctags-string-search-and-replace
           "%t" (capitalize name) org-ctags-new-topic-template))
  (backward-char 4)
  (end-of-line)
  (forward-line 2)
  (when narrowp
    ;;(org-tree-to-indirect-buffer 1)  ;; opens new frame
    (org-narrow-to-subtree))
  t)


(defun org-ctags-ask-append-topic (name &optional narrowp)
  "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS.
Wrapper for org-ctags-append-topic, which first asks the user if they want
to append a new topic."
Paul Eggert's avatar
Paul Eggert committed
429 430
  (if (y-or-n-p (format-message
		 "Topic `%s' not found; append to end of buffer?" name))
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
      (org-ctags-append-topic name narrowp)
    nil))


(defun org-ctags-rebuild-tags-file-then-find-tag (name)
  "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS.
Like ORG-CTAGS-FIND-TAG, but calls the external ctags program first,
to rebuild (update) the TAGS file."
  (unless tags-file-name
    (call-interactively (visit-tags-table)))
  (when (buffer-file-name)
    (org-ctags-create-tags))
  (org-ctags-find-tag name))


(defun org-ctags-ask-rebuild-tags-file-then-find-tag (name)
  "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS.
Wrapper for org-ctags-rebuild-tags-file-then-find-tag."
  (if (and (buffer-file-name)
450
	   (y-or-n-p
451
	    (format-message
452
	     "Tag `%s' not found.  Rebuild table `%s/TAGS' and look again?"
453 454 455
	     name
	     (file-name-directory (buffer-file-name)))))
      (org-ctags-rebuild-tags-file-then-find-tag name)
456 457 458
    nil))


Rasmus's avatar
Rasmus committed
459
(defun org-ctags-fail-silently (_name)
460
  "This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS.
Rasmus's avatar
Rasmus committed
461 462
Put as the last function in the list if you want to prevent Org's
default behavior of free text search."
463 464 465 466 467 468 469
  t)


;;; User-visible functions ===================================================


(defun org-ctags-create-tags (&optional directory-name)
470 471 472 473 474 475 476 477
  "(Re)create tags file in the directory of the active buffer.
The file will contain tag definitions for all the files in the
directory and its subdirectories which are recognized by ctags.
This will include files ending in `.org' as well as most other
source files (.C, .H, .EL, .LISP, etc).  All the resulting tags
end up in one file, called TAGS, located in the directory.  This
function may take several seconds to finish if the directory or
its subdirectories contain large numbers of taggable files."
478
  (interactive)
Rasmus's avatar
Rasmus committed
479
  (cl-assert (buffer-file-name))
480 481 482 483 484 485 486 487 488 489 490 491 492 493
  (let ((dir-name (or directory-name
                      (file-name-directory (buffer-file-name))))
        (exitcode nil))
    (save-excursion
      (setq exitcode
            (shell-command
             (format (concat "%s --langdef=orgmode --langmap=orgmode:.org "
                             "--regex-orgmode=\"%s\" -f \"%s\" -e -R \"%s\"")
                     org-ctags-path-to-ctags
                     org-ctags-tag-regexp
                     (expand-file-name (concat dir-name "/TAGS"))
                     (expand-file-name (concat dir-name "/*")))))
      (cond
       ((eql 0 exitcode)
Rasmus's avatar
Rasmus committed
494 495
        (setq-local org-ctags-tag-list
		    (org-ctags-all-tags-in-current-tags-table)))
496 497 498 499 500 501 502 503 504 505 506 507
       (t
        ;; This seems to behave differently on Linux, so just ignore
        ;; error codes for now
        ;;(error "Calling ctags executable resulted in error code: %s"
        ;;       exitcode)
        nil)))))


(defvar org-ctags-find-tag-history nil
  "History of tags visited by org-ctags-find-tag-interactive.")

(defun org-ctags-find-tag-interactive ()
508 509
  "Prompt for the name of a tag, with autocompletion, then visit the named tag.
Uses `ido-mode' if available.
510 511 512 513 514 515 516 517 518 519 520 521 522
If the user enters a string that does not match an existing tag, create
a new topic."
  (interactive)
  (let* ((completing-read-fn (if (fboundp 'ido-completing-read)
                                 'ido-completing-read
                               'completing-read))
         (tag (funcall completing-read-fn "Topic: " org-ctags-tag-list
                       nil 'confirm nil 'org-ctags-find-tag-history)))
    (when tag
      (cond
       ((member tag org-ctags-tag-list)
        ;; Existing tag
        (push tag org-ctags-find-tag-history)
Rasmus's avatar
Rasmus committed
523
        (xref-find-definitions tag))
524 525 526
       (t
        ;; New tag
        (run-hook-with-args-until-success
527
	 'org-open-link-functions tag))))))
528 529 530 531 532 533 534


(org-ctags-enable)

(provide 'org-ctags)

;;; org-ctags.el ends here