org-compat.el 47 KB

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