org-compat.el 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222
  1. ;;; org-compat.el --- Compatibility Code for Older Emacsen -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2004-2021 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten.dominik@gmail.com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: https://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains code needed for compatibility with older
  23. ;; versions of GNU Emacs and integration with other packages.
  24. ;;; Code:
  25. (require 'cl-lib)
  26. (require 'org-macs)
  27. (declare-function org-agenda-diary-entry "org-agenda")
  28. (declare-function org-agenda-maybe-redo "org-agenda" ())
  29. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  30. (declare-function org-agenda-remove-restriction-lock "org-agenda" (&optional noupdate))
  31. (declare-function org-calendar-goto-agenda "org-agenda" ())
  32. (declare-function org-align-tags "org" (&optional all))
  33. (declare-function org-at-heading-p "org" (&optional ignored))
  34. (declare-function org-at-table.el-p "org" ())
  35. (declare-function org-element-at-point "org-element" (&optional pom cached-only))
  36. (declare-function org-element-at-point-no-context "org-element" (&optional pom))
  37. (declare-function org-element-context "org-element" (&optional element))
  38. (declare-function org-element-lineage "org-element" (blob &optional types with-self))
  39. (declare-function org-element-type "org-element" (element))
  40. (declare-function org-element-property "org-element" (property element))
  41. (declare-function org-end-of-subtree "org" (&optional invisible-ok to-heading))
  42. (declare-function org-get-heading "org" (&optional no-tags no-todo no-priority no-comment))
  43. (declare-function org-get-tags "org" (&optional pos local))
  44. (declare-function org-hide-block-toggle "org" (&optional force no-error element))
  45. (declare-function org-link-display-format "ol" (s))
  46. (declare-function org-link-set-parameters "ol" (type &rest rest))
  47. (declare-function org-log-into-drawer "org" ())
  48. (declare-function org-make-tag-string "org" (tags))
  49. (declare-function org-reduced-level "org" (l))
  50. (declare-function org-return "org" (&optional indent arg interactive))
  51. (declare-function org-show-context "org" (&optional key))
  52. (declare-function org-table-end "org-table" (&optional table-type))
  53. (declare-function outline-next-heading "outline" ())
  54. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  55. (declare-function table--at-cell-p "table" (position &optional object at-column))
  56. (defvar calendar-mode-map)
  57. (defvar org-complex-heading-regexp)
  58. (defvar org-agenda-diary-file)
  59. (defvar org-agenda-overriding-restriction)
  60. (defvar org-agenda-restriction-lock-overlay)
  61. (defvar org-table-any-border-regexp)
  62. (defvar org-table-dataline-regexp)
  63. (defvar org-table-tab-recognizes-table.el)
  64. (defvar org-table1-hline-regexp)
  65. ;;; Emacs < 28.1 compatibility
  66. (if (fboundp 'file-name-concat)
  67. (defalias 'org-file-name-concat #'file-name-concat)
  68. (defun org-file-name-concat (directory &rest components)
  69. "Append COMPONENTS to DIRECTORY and return the resulting string.
  70. Elements in COMPONENTS must be a string or nil.
  71. DIRECTORY or the non-final elements in COMPONENTS may or may not end
  72. with a slash -- if they don't end with a slash, a slash will be
  73. inserted before contatenating."
  74. (save-match-data
  75. (mapconcat
  76. #'identity
  77. (delq nil
  78. (mapcar
  79. (lambda (str)
  80. (when (and str (not (string-empty-p str))
  81. (string-match "\\(.+\\)/?" str))
  82. (match-string 1 str)))
  83. (cons directory components)))
  84. "/"))))
  85. (if (fboundp 'directory-empty-p)
  86. (defalias 'org-directory-empty-p #'directory-empty-p)
  87. (defun org-directory-empty-p (dir)
  88. "Return t if DIR names an existing directory containing no other files."
  89. (and (file-directory-p dir)
  90. (null (directory-files dir nil directory-files-no-dot-files-regexp t)))))
  91. ;;; Emacs < 27.1 compatibility
  92. (unless (fboundp 'proper-list-p)
  93. ;; `proper-list-p' was added in Emacs 27.1. The function below is
  94. ;; taken from Emacs subr.el 200195e824b^.
  95. (defun proper-list-p (object)
  96. "Return OBJECT's length if it is a proper list, nil otherwise.
  97. A proper list is neither circular nor dotted (i.e., its last cdr
  98. is nil)."
  99. (and (listp object) (ignore-errors (length object)))))
  100. (if (fboundp 'xor)
  101. ;; `xor' was added in Emacs 27.1.
  102. (defalias 'org-xor #'xor)
  103. (defsubst org-xor (a b)
  104. "Exclusive `or'."
  105. (if a (not b) b)))
  106. (unless (fboundp 'pcomplete-uniquify-list)
  107. ;; The misspelled variant was made obsolete in Emacs 27.1
  108. (defalias 'pcomplete-uniquify-list 'pcomplete-uniqify-list))
  109. (if (fboundp 'time-convert)
  110. (progn
  111. (defsubst org-time-convert-to-integer (time)
  112. (time-convert time 'integer))
  113. (defsubst org-time-convert-to-list (time)
  114. (time-convert time 'list)))
  115. (defun org-time-convert-to-integer (time)
  116. (floor (float-time time)))
  117. (defun org-time-convert-to-list (time)
  118. (seconds-to-time (float-time time))))
  119. ;; `newline-and-indent' did not take a numeric argument before 27.1.
  120. (if (version< emacs-version "27")
  121. (defsubst org-newline-and-indent (&optional _arg)
  122. (newline-and-indent))
  123. (defalias 'org-newline-and-indent #'newline-and-indent))
  124. (defun org--set-faces-extend (faces extend-p)
  125. "Set the :extend attribute of FACES to EXTEND-P.
  126. This is a no-op for Emacs versions lower than 27, since face
  127. extension beyond end of line was not controllable."
  128. (when (fboundp 'set-face-extend)
  129. (mapc (lambda (f) (set-face-extend f extend-p)) faces)))
  130. (if (fboundp 'string-distance)
  131. (defalias 'org-string-distance 'string-distance)
  132. (defun org-string-distance (s1 s2)
  133. "Return the edit (levenshtein) distance between strings S1 S2."
  134. (let* ((l1 (length s1))
  135. (l2 (length s2))
  136. (dist (vconcat (mapcar (lambda (_) (make-vector (1+ l2) nil))
  137. (number-sequence 1 (1+ l1)))))
  138. (in (lambda (i j) (aref (aref dist i) j))))
  139. (setf (aref (aref dist 0) 0) 0)
  140. (dolist (j (number-sequence 1 l2))
  141. (setf (aref (aref dist 0) j) j))
  142. (dolist (i (number-sequence 1 l1))
  143. (setf (aref (aref dist i) 0) i)
  144. (dolist (j (number-sequence 1 l2))
  145. (setf (aref (aref dist i) j)
  146. (min
  147. (1+ (funcall in (1- i) j))
  148. (1+ (funcall in i (1- j)))
  149. (+ (if (equal (aref s1 (1- i)) (aref s2 (1- j))) 0 1)
  150. (funcall in (1- i) (1- j)))))))
  151. (funcall in l1 l2))))
  152. (define-obsolete-function-alias 'org-babel-edit-distance 'org-string-distance
  153. "9.5")
  154. ;;; Emacs < 26.1 compatibility
  155. (if (fboundp 'line-number-display-width)
  156. (defalias 'org-line-number-display-width 'line-number-display-width)
  157. (defun org-line-number-display-width (&rest _) 0))
  158. (if (fboundp 'buffer-hash)
  159. (defalias 'org-buffer-hash 'buffer-hash)
  160. (defun org-buffer-hash () (md5 (current-buffer))))
  161. (unless (fboundp 'file-attribute-modification-time)
  162. (defsubst file-attribute-modification-time (attributes)
  163. "The modification time in ATTRIBUTES returned by `file-attributes'.
  164. This is the time of the last change to the file's contents, and
  165. is a list of integers (HIGH LOW USEC PSEC) in the same style
  166. as (current-time)."
  167. (nth 5 attributes)))
  168. (unless (fboundp 'file-attribute-size)
  169. (defsubst file-attribute-size (attributes)
  170. "The size (in bytes) in ATTRIBUTES returned by `file-attributes'.
  171. This is a floating point number if the size is too large for an integer."
  172. (nth 7 attributes)))
  173. ;;; Obsolete aliases (remove them after the next major release).
  174. ;;;; XEmacs compatibility, now removed.
  175. (define-obsolete-function-alias 'org-activate-mark 'activate-mark "9.0")
  176. (define-obsolete-function-alias 'org-add-hook 'add-hook "9.0")
  177. (define-obsolete-function-alias 'org-bound-and-true-p 'bound-and-true-p "9.0")
  178. (define-obsolete-function-alias 'org-decompose-region 'decompose-region "9.0")
  179. (define-obsolete-function-alias 'org-defvaralias 'defvaralias "9.0")
  180. (define-obsolete-function-alias 'org-detach-overlay 'delete-overlay "9.0")
  181. (define-obsolete-function-alias 'org-file-equal-p 'file-equal-p "9.0")
  182. (define-obsolete-function-alias 'org-float-time 'float-time "9.0")
  183. (define-obsolete-function-alias 'org-indent-line-to 'indent-line-to "9.0")
  184. (define-obsolete-function-alias 'org-indent-to-column 'indent-to-column "9.0")
  185. (define-obsolete-function-alias 'org-looking-at-p 'looking-at-p "9.0")
  186. (define-obsolete-function-alias 'org-looking-back 'looking-back "9.0")
  187. (define-obsolete-function-alias 'org-match-string-no-properties 'match-string-no-properties "9.0")
  188. (define-obsolete-function-alias 'org-propertize 'propertize "9.0")
  189. (define-obsolete-function-alias 'org-select-frame-set-input-focus 'select-frame-set-input-focus "9.0")
  190. (define-obsolete-function-alias 'org-file-remote-p 'file-remote-p "9.2")
  191. (defmacro org-re (s)
  192. "Replace posix classes in regular expression S."
  193. (declare (debug (form))
  194. (obsolete "you can safely remove it." "9.0"))
  195. s)
  196. ;;;; Functions from cl-lib that Org used to have its own implementation of.
  197. (define-obsolete-function-alias 'org-count 'cl-count "9.0")
  198. (define-obsolete-function-alias 'org-every 'cl-every "9.0")
  199. (define-obsolete-function-alias 'org-find-if 'cl-find-if "9.0")
  200. (define-obsolete-function-alias 'org-reduce 'cl-reduce "9.0")
  201. (define-obsolete-function-alias 'org-remove-if 'cl-remove-if "9.0")
  202. (define-obsolete-function-alias 'org-remove-if-not 'cl-remove-if-not "9.0")
  203. (define-obsolete-function-alias 'org-some 'cl-some "9.0")
  204. (define-obsolete-function-alias 'org-floor* 'cl-floor "9.0")
  205. (defun org-sublist (list start end)
  206. "Return a section of LIST, from START to END.
  207. Counting starts at 1."
  208. (cl-subseq list (1- start) end))
  209. (make-obsolete 'org-sublist
  210. "use cl-subseq (note the 0-based counting)."
  211. "9.0")
  212. ;;;; Functions available since Emacs 25.1
  213. (define-obsolete-function-alias 'org-string-collate-lessp 'string-collate-lessp "9.6")
  214. (define-obsolete-function-alias 'org-decode-time 'decode-time "9.6")
  215. (define-obsolete-function-alias 'org-format-time-string 'format-time-string "9.6")
  216. (define-obsolete-function-alias 'org-time-add 'time-add "9.6")
  217. (define-obsolete-function-alias 'org-time-subtract 'time-subtract "9.6")
  218. (define-obsolete-function-alias 'org-time-since 'time-since "9.6")
  219. (define-obsolete-function-alias 'org-time-less-p 'time-less-p "9.6")
  220. ;;;; Functions available since Emacs 24.3
  221. (define-obsolete-function-alias 'org-buffer-narrowed-p 'buffer-narrowed-p "9.0")
  222. (define-obsolete-function-alias 'org-called-interactively-p 'called-interactively-p "9.0")
  223. (define-obsolete-function-alias 'org-char-to-string 'char-to-string "9.0")
  224. (define-obsolete-function-alias 'org-delete-directory 'delete-directory "9.0")
  225. (define-obsolete-function-alias 'org-format-seconds 'format-seconds "9.0")
  226. (define-obsolete-function-alias 'org-link-escape-browser 'url-encode-url "9.0")
  227. (define-obsolete-function-alias 'org-no-warnings 'with-no-warnings "9.0")
  228. (define-obsolete-function-alias 'org-number-sequence 'number-sequence "9.0")
  229. (define-obsolete-function-alias 'org-pop-to-buffer-same-window 'pop-to-buffer-same-window "9.0")
  230. (define-obsolete-function-alias 'org-string-match-p 'string-match-p "9.0")
  231. ;;;; Functions and variables from previous releases now obsolete.
  232. (define-obsolete-function-alias 'org-element-remove-indentation
  233. 'org-remove-indentation "9.0")
  234. (define-obsolete-variable-alias 'org-latex-create-formula-image-program
  235. 'org-preview-latex-default-process "9.0")
  236. (define-obsolete-variable-alias 'org-latex-preview-ltxpng-directory
  237. 'org-preview-latex-image-directory "9.0")
  238. (define-obsolete-function-alias 'org-table-p 'org-at-table-p "9.0")
  239. (define-obsolete-function-alias 'org-on-heading-p 'org-at-heading-p "9.0")
  240. (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp "8.3")
  241. (define-obsolete-function-alias 'org-image-file-name-regexp
  242. 'image-file-name-regexp "9.0")
  243. (define-obsolete-function-alias 'org-completing-read-no-i
  244. 'completing-read "9.0")
  245. (define-obsolete-function-alias 'org-icompleting-read
  246. 'completing-read "9.0")
  247. (define-obsolete-function-alias 'org-iread-file-name 'read-file-name "9.0")
  248. (define-obsolete-function-alias 'org-days-to-time
  249. 'org-time-stamp-to-now "8.2")
  250. (define-obsolete-variable-alias 'org-agenda-ignore-drawer-properties
  251. 'org-agenda-ignore-properties "9.0")
  252. (define-obsolete-function-alias 'org-preview-latex-fragment
  253. 'org-toggle-latex-fragment "8.3")
  254. (define-obsolete-function-alias 'org-export-get-genealogy
  255. 'org-element-lineage "9.0")
  256. (define-obsolete-variable-alias 'org-latex-with-hyperref
  257. 'org-latex-hyperref-template "9.0")
  258. (define-obsolete-variable-alias 'hfy-optimisations 'hfy-optimizations "9.0")
  259. (define-obsolete-variable-alias 'org-export-htmlized-org-css-url
  260. 'org-org-htmlized-css-url "8.2")
  261. (define-obsolete-function-alias 'org-list-parse-list 'org-list-to-lisp "9.0")
  262. (define-obsolete-function-alias 'org-agenda-todayp
  263. 'org-agenda-today-p "9.0")
  264. (define-obsolete-function-alias 'org-babel-examplize-region
  265. 'org-babel-examplify-region "9.0")
  266. (define-obsolete-variable-alias 'org-babel-capitalize-example-region-markers
  267. 'org-babel-uppercase-example-markers "9.1")
  268. (define-obsolete-function-alias 'org-babel-trim 'org-trim "9.0")
  269. (define-obsolete-variable-alias 'org-html-style 'org-html-head "24.4")
  270. (define-obsolete-function-alias 'org-insert-columns-dblock
  271. 'org-columns-insert-dblock "9.0")
  272. (define-obsolete-variable-alias 'org-export-babel-evaluate
  273. 'org-export-use-babel "9.1")
  274. (define-obsolete-function-alias 'org-activate-bracket-links
  275. 'org-activate-links "9.0")
  276. (define-obsolete-function-alias 'org-activate-plain-links 'ignore "9.0")
  277. (define-obsolete-function-alias 'org-activate-angle-links 'ignore "9.0")
  278. (define-obsolete-function-alias 'org-remove-double-quotes 'org-strip-quotes "9.0")
  279. (define-obsolete-function-alias 'org-get-indentation
  280. 'current-indentation "9.2")
  281. (define-obsolete-function-alias 'org-capture-member 'org-capture-get "9.2")
  282. (define-obsolete-function-alias 'org-remove-from-invisibility-spec
  283. 'remove-from-invisibility-spec "9.2")
  284. (define-obsolete-variable-alias 'org-effort-durations 'org-duration-units
  285. "9.2")
  286. (define-obsolete-function-alias 'org-toggle-latex-fragment 'org-latex-preview
  287. "9.3")
  288. (define-obsolete-function-alias 'org-remove-latex-fragment-image-overlays
  289. 'org-clear-latex-preview "9.3")
  290. (define-obsolete-variable-alias 'org-attach-directory
  291. 'org-attach-id-dir "9.3")
  292. (make-obsolete 'org-attach-store-link "No longer used" "9.4")
  293. (make-obsolete 'org-attach-expand-link "No longer used" "9.4")
  294. (define-obsolete-function-alias 'org-file-url-p 'org-url-p "9.5")
  295. (defun org-in-fixed-width-region-p ()
  296. "Non-nil if point in a fixed-width region."
  297. (save-match-data
  298. (eq 'fixed-width (org-element-type (org-element-at-point)))))
  299. (make-obsolete 'org-in-fixed-width-region-p
  300. "use `org-element' library"
  301. "9.0")
  302. (defun org-compatible-face (inherits specs)
  303. "Make a compatible face specification.
  304. If INHERITS is an existing face and if the Emacs version supports
  305. it, just inherit the face. If INHERITS is not given and SPECS
  306. is, use SPECS to define the face."
  307. (declare (indent 1))
  308. (if (facep inherits)
  309. (list (list t :inherit inherits))
  310. specs))
  311. (make-obsolete 'org-compatible-face "you can remove it." "9.0")
  312. (defun org-add-link-type (type &optional follow export)
  313. "Add a new TYPE link.
  314. FOLLOW and EXPORT are two functions.
  315. FOLLOW should take the link path as the single argument and do whatever
  316. is necessary to follow the link, for example find a file or display
  317. a mail message.
  318. EXPORT should format the link path for export to one of the export formats.
  319. It should be a function accepting three arguments:
  320. path the path of the link, the text after the prefix (like \"http:\")
  321. desc the description of the link, if any
  322. format the export format, a symbol like `html' or `latex' or `ascii'.
  323. The function may use the FORMAT information to return different values
  324. depending on the format. The return value will be put literally into
  325. the exported file. If the return value is nil, this means Org should
  326. do what it normally does with links which do not have EXPORT defined.
  327. Org mode has a built-in default for exporting links. If you are happy with
  328. this default, there is no need to define an export function for the link
  329. type. For a simple example of an export function, see `org-bbdb.el'.
  330. If TYPE already exists, update it with the arguments.
  331. See `org-link-parameters' for documentation on the other parameters."
  332. (org-link-set-parameters type :follow follow :export export)
  333. (message "Created %s link." type))
  334. (make-obsolete 'org-add-link-type "use `org-link-set-parameters' instead." "9.0")
  335. ;;;; Functions unused in Org core.
  336. (defun org-table-recognize-table.el ()
  337. "If there is a table.el table nearby, recognize it and move into it."
  338. (when (org-at-table.el-p)
  339. (beginning-of-line)
  340. (unless (or (looking-at org-table-dataline-regexp)
  341. (not (looking-at org-table1-hline-regexp)))
  342. (forward-line)
  343. (when (looking-at org-table-any-border-regexp)
  344. (forward-line -2)))
  345. (if (re-search-forward "|" (org-table-end t) t)
  346. (progn
  347. (require 'table)
  348. (if (table--at-cell-p (point)) t
  349. (message "recognizing table.el table...")
  350. (table-recognize-table)
  351. (message "recognizing table.el table...done")))
  352. (error "This should not happen"))))
  353. ;; Not used since commit 6d1e3082, Feb 2010.
  354. (make-obsolete 'org-table-recognize-table.el
  355. "please notify Org mailing list if you use this function."
  356. "9.0")
  357. (defmacro org-preserve-lc (&rest body)
  358. (declare (debug (body))
  359. (obsolete "please notify Org mailing list if you use this function."
  360. "9.2"))
  361. (org-with-gensyms (line col)
  362. `(let ((,line (org-current-line))
  363. (,col (current-column)))
  364. (unwind-protect
  365. (progn ,@body)
  366. (org-goto-line ,line)
  367. (org-move-to-column ,col)))))
  368. (defun org-version-check (version &rest _)
  369. "Non-nil if VERSION is lower (older) than `emacs-version'."
  370. (declare (obsolete "use `version<' or `fboundp' instead."
  371. "9.2"))
  372. (version< version emacs-version))
  373. (defun org-remove-angle-brackets (s)
  374. (org-unbracket-string "<" ">" s))
  375. (make-obsolete 'org-remove-angle-brackets 'org-unbracket-string "9.0")
  376. (defcustom org-publish-sitemap-file-entry-format "%t"
  377. "Format string for site-map file entry.
  378. You could use brackets to delimit on what part the link will be.
  379. %t is the title.
  380. %a is the author.
  381. %d is the date formatted using `org-publish-sitemap-date-format'."
  382. :group 'org-export-publish
  383. :type 'string)
  384. (make-obsolete-variable
  385. 'org-publish-sitemap-file-entry-format
  386. "set `:sitemap-format-entry' in `org-publish-project-alist' instead."
  387. "9.1")
  388. (defvar org-agenda-skip-regexp)
  389. (defun org-agenda-skip-entry-when-regexp-matches ()
  390. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  391. If yes, it returns the end position of this entry, causing agenda commands
  392. to skip the entry but continuing the search in the subtree. This is a
  393. function that can be put into `org-agenda-skip-function' for the duration
  394. of a command."
  395. (declare (obsolete "use `org-agenda-skip-if' instead." "9.1"))
  396. (let ((end (save-excursion (org-end-of-subtree t)))
  397. skip)
  398. (save-excursion
  399. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  400. (and skip end)))
  401. (defun org-agenda-skip-subtree-when-regexp-matches ()
  402. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  403. If yes, it returns the end position of this tree, causing agenda commands
  404. to skip this subtree. This is a function that can be put into
  405. `org-agenda-skip-function' for the duration of a command."
  406. (declare (obsolete "use `org-agenda-skip-if' instead." "9.1"))
  407. (let ((end (save-excursion (org-end-of-subtree t)))
  408. skip)
  409. (save-excursion
  410. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  411. (and skip end)))
  412. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  413. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  414. If yes, it returns the end position of the current entry (NOT the tree),
  415. causing agenda commands to skip the entry but continuing the search in
  416. the subtree. This is a function that can be put into
  417. `org-agenda-skip-function' for the duration of a command. An important
  418. use of this function is for the stuck project list."
  419. (declare (obsolete "use `org-agenda-skip-if' instead." "9.1"))
  420. (let ((end (save-excursion (org-end-of-subtree t)))
  421. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  422. skip)
  423. (save-excursion
  424. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  425. (and skip entry-end)))
  426. (define-obsolete-function-alias 'org-minutes-to-clocksum-string
  427. 'org-duration-from-minutes "9.1")
  428. (define-obsolete-function-alias 'org-hh:mm-string-to-minutes
  429. 'org-duration-to-minutes "9.1")
  430. (define-obsolete-function-alias 'org-duration-string-to-minutes
  431. 'org-duration-to-minutes "9.1")
  432. (make-obsolete-variable 'org-time-clocksum-format
  433. "set `org-duration-format' instead." "9.1")
  434. (make-obsolete-variable 'org-time-clocksum-use-fractional
  435. "set `org-duration-format' instead." "9.1")
  436. (make-obsolete-variable 'org-time-clocksum-fractional-format
  437. "set `org-duration-format' instead." "9.1")
  438. (make-obsolete-variable 'org-time-clocksum-use-effort-durations
  439. "set `org-duration-units' instead." "9.1")
  440. (define-obsolete-function-alias 'org-babel-number-p
  441. 'org-babel--string-to-number "9.0")
  442. (define-obsolete-variable-alias 'org-usenet-links-prefer-google
  443. 'org-gnus-prefer-web-links "9.1")
  444. (define-obsolete-variable-alias 'org-texinfo-def-table-markup
  445. 'org-texinfo-table-default-markup "9.1")
  446. (define-obsolete-variable-alias 'org-agenda-overriding-columns-format
  447. 'org-overriding-columns-format "9.2.2")
  448. (define-obsolete-variable-alias 'org-doi-server-url
  449. 'org-link-doi-server-url "9.3")
  450. (define-obsolete-variable-alias 'org-email-link-description-format
  451. 'org-link-email-description-format "9.3")
  452. (define-obsolete-variable-alias 'org-make-link-description-function
  453. 'org-link-make-description-function "9.3")
  454. (define-obsolete-variable-alias 'org-from-is-user-regexp
  455. 'org-link-from-user-regexp "9.3")
  456. (define-obsolete-variable-alias 'org-descriptive-links
  457. 'org-link-descriptive "9.3")
  458. (define-obsolete-variable-alias 'org-context-in-file-links
  459. 'org-link-context-for-files "9.3")
  460. (define-obsolete-variable-alias 'org-keep-stored-link-after-insertion
  461. 'org-link-keep-stored-after-insertion "9.3")
  462. (define-obsolete-variable-alias 'org-display-internal-link-with-indirect-buffer
  463. 'org-link-use-indirect-buffer-for-internals "9.3")
  464. (define-obsolete-variable-alias 'org-confirm-shell-link-function
  465. 'org-link-shell-confirm-function "9.3")
  466. (define-obsolete-variable-alias 'org-confirm-shell-link-not-regexp
  467. 'org-link-shell-skip-confirm-regexp "9.3")
  468. (define-obsolete-variable-alias 'org-confirm-elisp-link-function
  469. 'org-link-elisp-confirm-function "9.3")
  470. (define-obsolete-variable-alias 'org-confirm-elisp-link-not-regexp
  471. 'org-link-elisp-skip-confirm-regexp "9.3")
  472. (define-obsolete-function-alias 'org-file-complete-link
  473. 'org-link-complete-file "9.3")
  474. (define-obsolete-function-alias 'org-email-link-description
  475. 'org-link-email-description "9.3")
  476. (define-obsolete-function-alias 'org-make-link-string
  477. 'org-link-make-string "9.3")
  478. (define-obsolete-function-alias 'org-store-link-props
  479. 'org-link-store-props "9.3")
  480. (define-obsolete-function-alias 'org-add-link-props
  481. 'org-link-add-props "9.3")
  482. (define-obsolete-function-alias 'org-make-org-heading-search-string
  483. 'org-link-heading-search-string "9.3")
  484. (define-obsolete-function-alias 'org-make-link-regexps
  485. 'org-link-make-regexps "9.3")
  486. (define-obsolete-function-alias 'org-property-global-value
  487. 'org-property-global-or-keyword-value "9.3")
  488. (make-obsolete-variable 'org-file-properties 'org-keyword-properties "9.3")
  489. (define-obsolete-variable-alias 'org-angle-link-re
  490. 'org-link-angle-re "9.3")
  491. (define-obsolete-variable-alias 'org-plain-link-re
  492. 'org-link-plain-re "9.3")
  493. (define-obsolete-variable-alias 'org-bracket-link-regexp
  494. 'org-link-bracket-re "9.3")
  495. (define-obsolete-variable-alias 'org-bracket-link-analytic-regexp
  496. 'org-link-bracket-re "9.3")
  497. (define-obsolete-variable-alias 'org-any-link-re
  498. 'org-link-any-re "9.3")
  499. (define-obsolete-function-alias 'org-open-link-from-string
  500. 'org-link-open-from-string "9.3")
  501. (define-obsolete-function-alias 'org-add-angle-brackets
  502. 'org-link-add-angle-brackets "9.3")
  503. ;; The function was made obsolete by commit 65399674d5 of 2013-02-22.
  504. ;; This make-obsolete call was added 2016-09-01.
  505. (make-obsolete 'org-capture-import-remember-templates
  506. "use the `org-capture-templates' variable instead."
  507. "9.0")
  508. (defun org-show-block-all ()
  509. "Unfold all blocks in the current buffer."
  510. (interactive)
  511. (remove-overlays nil nil 'invisible 'org-hide-block))
  512. (make-obsolete 'org-show-block-all
  513. "use `org-show-all' instead."
  514. "9.2")
  515. (define-obsolete-function-alias 'org-get-tags-at 'org-get-tags "9.2")
  516. (defun org-get-local-tags ()
  517. "Get a list of tags defined in the current headline."
  518. (declare (obsolete "use `org-get-tags' instead." "9.2"))
  519. (org-get-tags nil 'local))
  520. (defun org-get-local-tags-at (&optional pos)
  521. "Get a list of tags defined in the current headline."
  522. (declare (obsolete "use `org-get-tags' instead." "9.2"))
  523. (org-get-tags pos 'local))
  524. (defun org-get-tags-string ()
  525. "Get the TAGS string in the current headline."
  526. (declare (obsolete "use `org-make-tag-string' instead." "9.2"))
  527. (org-make-tag-string (org-get-tags nil t)))
  528. (define-obsolete-function-alias 'org-set-tags-to 'org-set-tags "9.2")
  529. (defun org-align-all-tags ()
  530. "Align the tags in all headings."
  531. (declare (obsolete "use `org-align-tags' instead." "9.2"))
  532. (org-align-tags t))
  533. (define-obsolete-function-alias
  534. 'org-at-property-block-p 'org-at-property-drawer-p "9.4")
  535. (defun org-flag-drawer (flag &optional element beg end)
  536. "When FLAG is non-nil, hide the drawer we are at.
  537. Otherwise make it visible.
  538. When optional argument ELEMENT is a parsed drawer, as returned by
  539. `org-element-at-point', hide or show that drawer instead.
  540. When buffer positions BEG and END are provided, hide or show that
  541. region as a drawer without further ado."
  542. (declare (obsolete "use `org-hide-drawer-toggle' instead." "9.4"))
  543. (if (and beg end) (org-flag-region beg end flag 'outline)
  544. (let ((drawer
  545. (or element
  546. (and (save-excursion
  547. (beginning-of-line)
  548. (looking-at-p "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"))
  549. (org-element-at-point)))))
  550. (when (memq (org-element-type drawer) '(drawer property-drawer))
  551. (let ((post (org-element-property :post-affiliated drawer)))
  552. (org-flag-region
  553. (save-excursion (goto-char post) (line-end-position))
  554. (save-excursion (goto-char (org-element-property :end drawer))
  555. (skip-chars-backward " \t\n")
  556. (line-end-position))
  557. flag 'outline)
  558. ;; When the drawer is hidden away, make sure point lies in
  559. ;; a visible part of the buffer.
  560. (when (invisible-p (max (1- (point)) (point-min)))
  561. (goto-char post)))))))
  562. (defun org-hide-block-toggle-maybe ()
  563. "Toggle visibility of block at point.
  564. Unlike to `org-hide-block-toggle', this function does not throw
  565. an error. Return a non-nil value when toggling is successful."
  566. (declare (obsolete "use `org-hide-block-toggle' instead." "9.4"))
  567. (interactive)
  568. (org-hide-block-toggle nil t))
  569. (defun org-hide-block-toggle-all ()
  570. "Toggle the visibility of all blocks in the current buffer."
  571. (declare (obsolete "please notify Org mailing list if you use this function."
  572. "9.4"))
  573. (let ((start (point-min))
  574. (end (point-max)))
  575. (save-excursion
  576. (goto-char start)
  577. (while (and (< (point) end)
  578. (re-search-forward "^[ \t]*#\\+begin_?\
  579. \\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$" end t))
  580. (save-excursion
  581. (save-match-data
  582. (goto-char (match-beginning 0))
  583. (org-hide-block-toggle)))))))
  584. (defun org-return-indent ()
  585. "Goto next table row or insert a newline and indent.
  586. Calls `org-table-next-row' or `newline-and-indent', depending on
  587. context. See the individual commands for more information."
  588. (declare (obsolete "use `org-return' with INDENT set to t instead."
  589. "9.4"))
  590. (interactive)
  591. (org-return t))
  592. (defmacro org-with-silent-modifications (&rest body)
  593. (declare (obsolete "use `with-silent-modifications' instead." "9.2")
  594. (debug (body)))
  595. `(with-silent-modifications ,@body))
  596. (define-obsolete-function-alias 'org-babel-strip-quotes
  597. 'org-strip-quotes "9.2")
  598. (define-obsolete-variable-alias 'org-sort-agenda-notime-is-late
  599. 'org-agenda-sort-notime-is-late "9.4")
  600. (define-obsolete-variable-alias 'org-sort-agenda-noeffort-is-high
  601. 'org-agenda-sort-noeffort-is-high "9.4")
  602. (defconst org-maybe-keyword-time-regexp
  603. (concat "\\(\\<\\(\\(?:CLO\\(?:CK\\|SED\\)\\|DEADLINE\\|SCHEDULED\\):\\)\\)?"
  604. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*[]>]"
  605. "\\|"
  606. "<%%([^\r\n>]*>\\)")
  607. "Matches a timestamp, possibly preceded by a keyword.")
  608. (make-obsolete-variable
  609. 'org-maybe-keyword-time-regexp
  610. "use `org-planning-line-re', followed by `org-ts-regexp-both' instead."
  611. "9.4")
  612. (define-obsolete-function-alias 'org-copy 'org-refile-copy "9.4")
  613. (define-obsolete-function-alias 'org-get-last-sibling 'org-get-previous-sibling "9.4")
  614. ;;;; Obsolete link types
  615. (eval-after-load 'ol
  616. '(progn
  617. (org-link-set-parameters "file+emacs") ;since Org 9.0
  618. (org-link-set-parameters "file+sys"))) ;since Org 9.0
  619. ;;; Miscellaneous functions
  620. (defun org-get-x-clipboard (value)
  621. "Get the value of the X or Windows clipboard."
  622. (cond ((and (eq window-system 'x)
  623. (fboundp 'gui-get-selection)) ;Silence byte-compiler.
  624. (org-no-properties
  625. (ignore-errors
  626. (or (gui-get-selection value 'UTF8_STRING)
  627. (gui-get-selection value 'COMPOUND_TEXT)
  628. (gui-get-selection value 'STRING)
  629. (gui-get-selection value 'TEXT)))))
  630. ((and (eq window-system 'w32) (fboundp 'w32-get-clipboard-data))
  631. (w32-get-clipboard-data))))
  632. ;; `set-transient-map' is only in Emacs >= 24.4
  633. (defalias 'org-set-transient-map
  634. (if (fboundp 'set-transient-map)
  635. 'set-transient-map
  636. 'set-temporary-overlay-map))
  637. ;;; Region compatibility
  638. (defvar org-ignore-region nil
  639. "Non-nil means temporarily disable the active region.")
  640. (defun org-region-active-p ()
  641. "Non-nil when the region active.
  642. Unlike to `use-region-p', this function also checks
  643. `org-ignore-region'."
  644. (and (not org-ignore-region) (use-region-p)))
  645. (defun org-cursor-to-region-beginning ()
  646. (when (and (org-region-active-p)
  647. (> (point) (region-beginning)))
  648. (exchange-point-and-mark)))
  649. ;;; Invisibility compatibility
  650. (defun org-in-invisibility-spec-p (arg)
  651. "Is ARG a member of `buffer-invisibility-spec'?"
  652. (when (consp buffer-invisibility-spec)
  653. (member arg buffer-invisibility-spec)))
  654. (defun org-move-to-column (column &optional force _buffer)
  655. "Move to column COLUMN.
  656. Pass COLUMN and FORCE to `move-to-column'."
  657. (let ((buffer-invisibility-spec
  658. (if (listp buffer-invisibility-spec)
  659. (remove '(org-filtered) buffer-invisibility-spec)
  660. buffer-invisibility-spec)))
  661. (move-to-column column force)))
  662. (defmacro org-find-library-dir (library)
  663. `(file-name-directory (or (locate-library ,library) "")))
  664. (defun org-count-lines (s)
  665. "How many lines in string S?"
  666. (let ((start 0) (n 1))
  667. (while (string-match "\n" s start)
  668. (setq start (match-end 0) n (1+ n)))
  669. (when (and (> (length s) 0) (= (aref s (1- (length s))) ?\n))
  670. (setq n (1- n)))
  671. n))
  672. (defun org-kill-new (string &rest args)
  673. (remove-text-properties 0 (length string) '(line-prefix t wrap-prefix t)
  674. string)
  675. (apply 'kill-new string args))
  676. ;; `font-lock-ensure' is only available from 24.4.50 on
  677. (defalias 'org-font-lock-ensure
  678. (if (fboundp 'font-lock-ensure)
  679. #'font-lock-ensure
  680. (lambda (&optional _beg _end)
  681. (with-no-warnings (font-lock-fontify-buffer)))))
  682. ;; `file-local-name' was added in Emacs 26.1.
  683. (defalias 'org-babel-local-file-name
  684. (if (fboundp 'file-local-name)
  685. 'file-local-name
  686. (lambda (file)
  687. "Return the local name component of FILE."
  688. (or (file-remote-p file 'localname) file))))
  689. ;;;###autoload
  690. (defmacro org-check-version ()
  691. "Try very hard to provide sensible version strings."
  692. (let* ((org-dir (org-find-library-dir "org"))
  693. (org-version.el (concat org-dir "org-version.el"))
  694. (org-fixup.el (concat org-dir "../mk/org-fixup.el")))
  695. (if (require 'org-version org-version.el 'noerror)
  696. '(progn
  697. (autoload 'org-release "org-version.el")
  698. (autoload 'org-git-version "org-version.el"))
  699. (if (require 'org-fixup org-fixup.el 'noerror)
  700. '(org-fixup)
  701. ;; provide fallback definitions and complain
  702. (warn "Could not define org version correctly. Check installation!")
  703. '(progn
  704. (defun org-release () "N/A")
  705. (defun org-git-version () "N/A !!check installation!!"))))))
  706. ;;; Functions for Emacs < 24.4 compatibility
  707. (defun org-define-error (name message)
  708. "Define NAME as a new error signal.
  709. MESSAGE is a string that will be output to the echo area if such
  710. an error is signaled without being caught by a `condition-case'.
  711. Implements `define-error' for older emacsen."
  712. (if (fboundp 'define-error) (define-error name message)
  713. (put name 'error-conditions
  714. (copy-sequence (cons name (get 'error 'error-conditions))))))
  715. (unless (fboundp 'string-suffix-p)
  716. ;; From Emacs subr.el.
  717. (defun string-suffix-p (suffix string &optional ignore-case)
  718. "Return non-nil if SUFFIX is a suffix of STRING.
  719. If IGNORE-CASE is non-nil, the comparison is done without paying
  720. attention to case differences."
  721. (let ((start-pos (- (length string) (length suffix))))
  722. (and (>= start-pos 0)
  723. (eq t (compare-strings suffix nil nil
  724. string start-pos nil ignore-case))))))
  725. ;;; Integration with and fixes for other packages
  726. (defgroup org-imenu-and-speedbar nil
  727. "Options concerning imenu and speedbar in Org mode."
  728. :tag "Org Imenu and Speedbar"
  729. :group 'org-structure)
  730. (defcustom org-imenu-depth 2
  731. "The maximum level for Imenu access to Org headlines.
  732. This also applied for speedbar access."
  733. :group 'org-imenu-and-speedbar
  734. :type 'integer)
  735. ;;;; Imenu
  736. (defvar-local org-imenu-markers nil
  737. "All markers currently used by Imenu.")
  738. (defun org-imenu-get-tree ()
  739. "Produce the index for Imenu."
  740. (dolist (x org-imenu-markers) (move-marker x nil))
  741. (setq org-imenu-markers nil)
  742. (org-with-wide-buffer
  743. (goto-char (point-max))
  744. (let* ((re (concat "^" (org-get-limited-outline-regexp)))
  745. (subs (make-vector (1+ org-imenu-depth) nil))
  746. (last-level 0))
  747. (while (re-search-backward re nil t)
  748. (let ((level (org-reduced-level (funcall outline-level)))
  749. (headline (org-no-properties
  750. (org-link-display-format (org-get-heading t t t t)))))
  751. (when (and (<= level org-imenu-depth) (org-string-nw-p headline))
  752. (let* ((m (point-marker))
  753. (item (propertize headline 'org-imenu-marker m 'org-imenu t)))
  754. (push m org-imenu-markers)
  755. (if (>= level last-level)
  756. (push (cons item m) (aref subs level))
  757. (push (cons item
  758. (cl-mapcan #'identity (cl-subseq subs (1+ level))))
  759. (aref subs level))
  760. (cl-loop for i from (1+ level) to org-imenu-depth
  761. do (aset subs i nil)))
  762. (setq last-level level)))))
  763. (aref subs 1))))
  764. (eval-after-load 'imenu
  765. '(progn
  766. (add-hook 'imenu-after-jump-hook
  767. (lambda ()
  768. (when (derived-mode-p 'org-mode)
  769. (org-show-context 'org-goto))))
  770. (add-hook 'org-mode-hook
  771. (lambda ()
  772. (setq imenu-create-index-function 'org-imenu-get-tree)))))
  773. ;;;; Speedbar
  774. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  775. "Overlay marking the agenda restriction line in speedbar.")
  776. (overlay-put org-speedbar-restriction-lock-overlay
  777. 'face 'org-agenda-restriction-lock)
  778. (overlay-put org-speedbar-restriction-lock-overlay
  779. 'help-echo "Agendas are currently limited to this item.")
  780. (delete-overlay org-speedbar-restriction-lock-overlay)
  781. (defun org-speedbar-set-agenda-restriction ()
  782. "Restrict future agenda commands to the location at point in speedbar.
  783. If there is already a restriction lock at the location, remove it.
  784. To get rid of the restriction, use `\\[org-agenda-remove-restriction-lock]'."
  785. (interactive)
  786. (require 'org-agenda)
  787. (let (p m tp np dir txt)
  788. (cond
  789. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  790. 'org-imenu t))
  791. (setq m (get-text-property p 'org-imenu-marker))
  792. (with-current-buffer (marker-buffer m)
  793. (goto-char m)
  794. (if (and org-agenda-overriding-restriction
  795. (member org-agenda-restriction-lock-overlay
  796. (overlays-at (point))))
  797. (org-agenda-remove-restriction-lock 'noupdate)
  798. (org-agenda-set-restriction-lock 'subtree))))
  799. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  800. 'speedbar-function 'speedbar-find-file))
  801. (setq tp (previous-single-property-change
  802. (1+ p) 'speedbar-function)
  803. np (next-single-property-change
  804. tp 'speedbar-function)
  805. dir (speedbar-line-directory)
  806. txt (buffer-substring-no-properties (or tp (point-min))
  807. (or np (point-max))))
  808. (with-current-buffer (find-file-noselect
  809. (let ((default-directory dir))
  810. (expand-file-name txt)))
  811. (unless (derived-mode-p 'org-mode)
  812. (user-error "Cannot restrict to non-Org mode file"))
  813. (org-agenda-set-restriction-lock 'file)))
  814. (t (user-error "Don't know how to restrict Org mode agenda")))
  815. (move-overlay org-speedbar-restriction-lock-overlay
  816. (point-at-bol) (point-at-eol))
  817. (setq current-prefix-arg nil)
  818. (org-agenda-maybe-redo)))
  819. (defvar speedbar-file-key-map)
  820. (declare-function speedbar-add-supported-extension "speedbar" (extension))
  821. (eval-after-load 'speedbar
  822. '(progn
  823. (speedbar-add-supported-extension ".org")
  824. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  825. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  826. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  827. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  828. (add-hook 'speedbar-visiting-tag-hook
  829. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  830. ;;;; Add Log
  831. (defun org-add-log-current-headline ()
  832. "Return current headline or nil.
  833. This function ignores inlinetasks. It is meant to be used as
  834. `add-log-current-defun-function' value."
  835. (org-with-limited-levels (org-get-heading t t t t)))
  836. ;;;; Flyspell
  837. (defun org--flyspell-object-check-p (element)
  838. "Non-nil when Flyspell can check object at point.
  839. ELEMENT is the element at point."
  840. (let ((object (save-excursion
  841. (when (looking-at-p "\\>") (backward-char))
  842. (org-element-context element))))
  843. (cl-case (org-element-type object)
  844. ;; Prevent checks in links due to keybinding conflict with
  845. ;; Flyspell.
  846. ((code entity export-snippet inline-babel-call
  847. inline-src-block line-break latex-fragment link macro
  848. statistics-cookie target timestamp verbatim)
  849. nil)
  850. (footnote-reference
  851. ;; Only in inline footnotes, within the definition.
  852. (and (eq (org-element-property :type object) 'inline)
  853. (< (save-excursion
  854. (goto-char (org-element-property :begin object))
  855. (search-forward ":" nil t 2))
  856. (point))))
  857. (otherwise t))))
  858. (defun org-mode-flyspell-verify ()
  859. "Function used for `flyspell-generic-check-word-predicate'."
  860. (if (org-at-heading-p)
  861. ;; At a headline or an inlinetask, check title only.
  862. (and (save-excursion (beginning-of-line)
  863. (and (let ((case-fold-search t))
  864. (not (looking-at-p "\\*+ END[ \t]*$")))
  865. (let ((case-fold-search nil))
  866. (looking-at org-complex-heading-regexp))))
  867. (match-beginning 4)
  868. (>= (point) (match-beginning 4))
  869. (or (not (match-beginning 5))
  870. (< (point) (match-beginning 5)))
  871. ;; Ignore checks in code, verbatim and others.
  872. (org--flyspell-object-check-p (org-element-at-point-no-context)))
  873. (let* ((element (org-element-at-point-no-context))
  874. (post-affiliated (org-element-property :post-affiliated element)))
  875. (cond
  876. ;; Ignore checks in all affiliated keywords but captions.
  877. ((< (point) post-affiliated)
  878. (and (save-excursion
  879. (beginning-of-line)
  880. (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
  881. (> (point) (match-end 0))
  882. (org--flyspell-object-check-p element)))
  883. ;; Ignore checks in LOGBOOK (or equivalent) drawer.
  884. ((let ((log (org-log-into-drawer)))
  885. (and log
  886. (let ((drawer (org-element-lineage element '(drawer))))
  887. (and drawer
  888. (eq (compare-strings
  889. log nil nil
  890. (org-element-property :drawer-name drawer) nil nil t)
  891. t)))))
  892. nil)
  893. (t
  894. (cl-case (org-element-type element)
  895. ((comment quote-section) t)
  896. (comment-block
  897. ;; Allow checks between block markers, not on them.
  898. (and (> (line-beginning-position) post-affiliated)
  899. (save-excursion
  900. (end-of-line)
  901. (skip-chars-forward " \r\t\n")
  902. (< (point) (org-element-property :end element)))))
  903. ;; Arbitrary list of keywords where checks are meaningful.
  904. ;; Make sure point is on the value part of the element.
  905. (keyword
  906. (and (member (org-element-property :key element)
  907. '("DESCRIPTION" "TITLE"))
  908. (save-excursion
  909. (search-backward ":" (line-beginning-position) t))))
  910. ;; Check is globally allowed in paragraphs verse blocks and
  911. ;; table rows (after affiliated keywords) but some objects
  912. ;; must not be affected.
  913. ((paragraph table-row verse-block)
  914. (let ((cbeg (org-element-property :contents-begin element))
  915. (cend (org-element-property :contents-end element)))
  916. (and cbeg (>= (point) cbeg) (< (point) cend)
  917. (org--flyspell-object-check-p element))))))))))
  918. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  919. (defun org-remove-flyspell-overlays-in (beg end)
  920. "Remove flyspell overlays in region."
  921. (and (bound-and-true-p flyspell-mode)
  922. (fboundp 'flyspell-delete-region-overlays)
  923. (flyspell-delete-region-overlays beg end)))
  924. (defvar flyspell-delayed-commands)
  925. (eval-after-load 'flyspell
  926. '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
  927. ;;;; Bookmark
  928. (defun org-bookmark-jump-unhide ()
  929. "Unhide the current position, to show the bookmark location."
  930. (and (derived-mode-p 'org-mode)
  931. (or (org-invisible-p)
  932. (save-excursion (goto-char (max (point-min) (1- (point))))
  933. (org-invisible-p)))
  934. (org-show-context 'bookmark-jump)))
  935. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  936. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  937. ;;;; Calendar
  938. (defcustom org-calendar-to-agenda-key 'default
  939. "Key to be installed in `calendar-mode-map' for switching to the agenda.
  940. The command `org-calendar-goto-agenda' will be bound to this key.
  941. When set to `default', bind the function to `c', but only if it is
  942. available in the Calendar keymap. This is the default choice because
  943. `c' can then be used to switch back and forth between agenda and calendar.
  944. When nil, `org-calendar-goto-agenda' is not bound to any key."
  945. :group 'org-agenda
  946. :type '(choice
  947. (const :tag "Bind to `c' if available" default)
  948. (key-sequence :tag "Other binding")
  949. (const :tag "No binding" nil))
  950. :safe (lambda (v) (or (symbolp v) (stringp v)))
  951. :package-version '(Org . "9.2"))
  952. (defcustom org-calendar-insert-diary-entry-key [?i]
  953. "The key to be installed in `calendar-mode-map' for adding diary entries.
  954. This option is irrelevant until `org-agenda-diary-file' has been configured
  955. to point to an Org file. When that is the case, the command
  956. `org-agenda-diary-entry' will be bound to the key given here, by default
  957. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  958. if you want to continue doing this, you need to change this to a different
  959. key."
  960. :group 'org-agenda
  961. :type 'sexp)
  962. (defun org--setup-calendar-bindings ()
  963. "Bind Org functions in Calendar keymap."
  964. (pcase org-calendar-to-agenda-key
  965. (`nil nil)
  966. ((and key (pred stringp))
  967. (local-set-key (kbd key) #'org-calendar-goto-agenda))
  968. ((guard (not (lookup-key calendar-mode-map "c")))
  969. (local-set-key "c" #'org-calendar-goto-agenda))
  970. (_ nil))
  971. (when (and (boundp 'org-agenda-diary-file)
  972. (not (eq org-agenda-diary-file 'diary-file)))
  973. (local-set-key org-calendar-insert-diary-entry-key
  974. #'org-agenda-diary-entry)))
  975. (eval-after-load 'calendar
  976. '(add-hook 'calendar-mode-hook #'org--setup-calendar-bindings))
  977. ;;;; Saveplace
  978. ;; Make sure saveplace shows the location if it was hidden
  979. (eval-after-load 'saveplace
  980. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  981. "Make the position visible."
  982. (org-bookmark-jump-unhide)))
  983. ;;;; Ecb
  984. ;; Make sure ecb shows the location if it was hidden
  985. (eval-after-load 'ecb
  986. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  987. "Make hierarchy visible when jumping into location from ECB tree buffer."
  988. (when (derived-mode-p 'org-mode)
  989. (org-show-context))))
  990. ;;;; Simple
  991. (defun org-mark-jump-unhide ()
  992. "Make the point visible with `org-show-context' after jumping to the mark."
  993. (when (and (derived-mode-p 'org-mode)
  994. (org-invisible-p))
  995. (org-show-context 'mark-goto)))
  996. (eval-after-load 'simple
  997. '(defadvice pop-to-mark-command (after org-make-visible activate)
  998. "Make the point visible with `org-show-context'."
  999. (org-mark-jump-unhide)))
  1000. (eval-after-load 'simple
  1001. '(defadvice exchange-point-and-mark (after org-make-visible activate)
  1002. "Make the point visible with `org-show-context'."
  1003. (org-mark-jump-unhide)))
  1004. (eval-after-load 'simple
  1005. '(defadvice pop-global-mark (after org-make-visible activate)
  1006. "Make the point visible with `org-show-context'."
  1007. (org-mark-jump-unhide)))
  1008. ;;;; Session
  1009. ;; Make "session.el" ignore our circular variable.
  1010. (defvar session-globals-exclude)
  1011. (eval-after-load 'session
  1012. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  1013. ;;;; Speed commands
  1014. (make-obsolete-variable 'org-speed-commands-user
  1015. "configure `org-speed-commands' instead." "9.5")
  1016. (provide 'org-compat)
  1017. ;; Local variables:
  1018. ;; generated-autoload-file: "org-loaddefs.el"
  1019. ;; End:
  1020. ;;; org-compat.el ends here