org-compat.el 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914
  1. ;;; org-compat.el --- Compatibility Code for Older Emacsen -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2004-2018 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  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-at-heading-p "org" (&optional ignored))
  30. (declare-function org-at-table.el-p "org" ())
  31. (declare-function org-element-at-point "org-element" ())
  32. (declare-function org-element-context "org-element" (&optional element))
  33. (declare-function org-element-lineage "org-element" (blob &optional types with-self))
  34. (declare-function org-element-type "org-element" (element))
  35. (declare-function org-element-property "org-element" (property element))
  36. (declare-function org-end-of-subtree "org" (&optional invisible-ok to-heading))
  37. (declare-function org-invisible-p "org" (&optional pos))
  38. (declare-function org-link-display-format "org" (s))
  39. (declare-function org-link-set-parameters "org" (type &rest rest))
  40. (declare-function org-log-into-drawer "org" ())
  41. (declare-function org-reduced-level "org" (l))
  42. (declare-function org-show-context "org" (&optional key))
  43. (declare-function org-table-end "org-table" (&optional table-type))
  44. (declare-function outline-next-heading "outline" ())
  45. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  46. (declare-function table--at-cell-p "table" (position &optional object at-column))
  47. (defvar calendar-mode-map)
  48. (defvar org-complex-heading-regexp)
  49. (defvar org-agenda-diary-file)
  50. (defvar org-table-any-border-regexp)
  51. (defvar org-table-dataline-regexp)
  52. (defvar org-table-tab-recognizes-table.el)
  53. (defvar org-table1-hline-regexp)
  54. ;;; Emacs < 25.1 compatibility
  55. (when (< emacs-major-version 25)
  56. (defalias 'outline-hide-entry 'hide-entry)
  57. (defalias 'outline-hide-sublevels 'hide-sublevels)
  58. (defalias 'outline-hide-subtree 'hide-subtree)
  59. (defalias 'outline-show-branches 'show-branches)
  60. (defalias 'outline-show-children 'show-children)
  61. (defalias 'outline-show-entry 'show-entry)
  62. (defalias 'outline-show-subtree 'show-subtree)
  63. (defalias 'xref-find-definitions 'find-tag)
  64. (defalias 'format-message 'format)
  65. (defalias 'gui-get-selection 'x-get-selection))
  66. (unless (fboundp 'directory-name-p)
  67. (defun directory-name-p (name)
  68. "Return non-nil if NAME ends with a directory separator character."
  69. (let ((len (length name))
  70. (lastc ?.))
  71. (if (> len 0)
  72. (setq lastc (aref name (1- len))))
  73. (or (= lastc ?/)
  74. (and (memq system-type '(windows-nt ms-dos))
  75. (= lastc ?\\))))))
  76. ;; `string-collate-lessp' is new in Emacs 25.
  77. (defalias 'org-string-collate-lessp
  78. (if (fboundp 'string-collate-lessp)
  79. 'string-collate-lessp
  80. 'string-lessp))
  81. ;;; Obsolete aliases (remove them after the next major release).
  82. ;;;; XEmacs compatibility, now removed.
  83. (define-obsolete-function-alias 'org-activate-mark 'activate-mark)
  84. (define-obsolete-function-alias 'org-add-hook 'add-hook "Org 9.0")
  85. (define-obsolete-function-alias 'org-bound-and-true-p 'bound-and-true-p "Org 9.0")
  86. (define-obsolete-function-alias 'org-decompose-region 'decompose-region "Org 9.0")
  87. (define-obsolete-function-alias 'org-defvaralias 'defvaralias "Org 9.0")
  88. (define-obsolete-function-alias 'org-detach-overlay 'delete-overlay "Org 9.0")
  89. (define-obsolete-function-alias 'org-file-equal-p 'file-equal-p "Org 9.0")
  90. (define-obsolete-function-alias 'org-float-time 'float-time "Org 9.0")
  91. (define-obsolete-function-alias 'org-indent-line-to 'indent-line-to "Org 9.0")
  92. (define-obsolete-function-alias 'org-indent-to-column 'indent-to-column "Org 9.0")
  93. (define-obsolete-function-alias 'org-looking-at-p 'looking-at-p "Org 9.0")
  94. (define-obsolete-function-alias 'org-looking-back 'looking-back "Org 9.0")
  95. (define-obsolete-function-alias 'org-match-string-no-properties 'match-string-no-properties "Org 9.0")
  96. (define-obsolete-function-alias 'org-propertize 'propertize "Org 9.0")
  97. (define-obsolete-function-alias 'org-select-frame-set-input-focus 'select-frame-set-input-focus "Org 9.0")
  98. (defmacro org-re (s)
  99. "Replace posix classes in regular expression S."
  100. (declare (debug (form))
  101. (obsolete "you can safely remove it." "Org 9.0"))
  102. s)
  103. ;;;; Functions from cl-lib that Org used to have its own implementation of.
  104. (define-obsolete-function-alias 'org-count 'cl-count "Org 9.0")
  105. (define-obsolete-function-alias 'org-every 'cl-every "Org 9.0")
  106. (define-obsolete-function-alias 'org-find-if 'cl-find-if "Org 9.0")
  107. (define-obsolete-function-alias 'org-reduce 'cl-reduce "Org 9.0")
  108. (define-obsolete-function-alias 'org-remove-if 'cl-remove-if "Org 9.0")
  109. (define-obsolete-function-alias 'org-remove-if-not 'cl-remove-if-not "Org 9.0")
  110. (define-obsolete-function-alias 'org-some 'cl-some "Org 9.0")
  111. (define-obsolete-function-alias 'org-floor* 'cl-floor "Org 9.0")
  112. (defun org-sublist (list start end)
  113. "Return a section of LIST, from START to END.
  114. Counting starts at 1."
  115. (cl-subseq list (1- start) end))
  116. (make-obsolete 'org-sublist
  117. "use cl-subseq (note the 0-based counting)."
  118. "Org 9.0")
  119. ;;;; Functions available since Emacs 24.3
  120. (define-obsolete-function-alias 'org-buffer-narrowed-p 'buffer-narrowed-p "Org 9.0")
  121. (define-obsolete-function-alias 'org-called-interactively-p 'called-interactively-p "Org 9.0")
  122. (define-obsolete-function-alias 'org-char-to-string 'char-to-string "Org 9.0")
  123. (define-obsolete-function-alias 'org-delete-directory 'delete-directory "Org 9.0")
  124. (define-obsolete-function-alias 'org-format-seconds 'format-seconds "Org 9.0")
  125. (define-obsolete-function-alias 'org-link-escape-browser 'url-encode-url "Org 9.0")
  126. (define-obsolete-function-alias 'org-no-warnings 'with-no-warnings "Org 9.0")
  127. (define-obsolete-function-alias 'org-number-sequence 'number-sequence "Org 9.0")
  128. (define-obsolete-function-alias 'org-pop-to-buffer-same-window 'pop-to-buffer-same-window "Org 9.0")
  129. (define-obsolete-function-alias 'org-string-match-p 'string-match-p "Org 9.0")
  130. ;;;; Functions and variables from previous releases now obsolete.
  131. (define-obsolete-function-alias 'org-element-remove-indentation
  132. 'org-remove-indentation "Org 9.0")
  133. (define-obsolete-variable-alias 'org-latex-create-formula-image-program
  134. 'org-preview-latex-default-process "Org 9.0")
  135. (define-obsolete-variable-alias 'org-latex-preview-ltxpng-directory
  136. 'org-preview-latex-image-directory "Org 9.0")
  137. (define-obsolete-function-alias 'org-table-p 'org-at-table-p "Org 9.0")
  138. (define-obsolete-function-alias 'org-on-heading-p 'org-at-heading-p "Org 9.0")
  139. (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp "Org 8.3")
  140. (define-obsolete-function-alias 'org-image-file-name-regexp
  141. 'image-file-name-regexp "Org 9.0")
  142. (define-obsolete-function-alias 'org-completing-read-no-i
  143. 'completing-read "Org 9.0")
  144. (define-obsolete-function-alias 'org-icompleting-read
  145. 'completing-read "Org 9.0")
  146. (define-obsolete-function-alias 'org-iread-file-name 'read-file-name "Org 9.0")
  147. (define-obsolete-function-alias 'org-days-to-time
  148. 'org-time-stamp-to-now "Org 8.2")
  149. (define-obsolete-variable-alias 'org-agenda-ignore-drawer-properties
  150. 'org-agenda-ignore-properties "Org 9.0")
  151. (define-obsolete-function-alias 'org-preview-latex-fragment
  152. 'org-toggle-latex-fragment "Org 8.3")
  153. (define-obsolete-function-alias 'org-export-get-genealogy
  154. 'org-element-lineage "Org 9.0")
  155. (define-obsolete-variable-alias 'org-latex-with-hyperref
  156. 'org-latex-hyperref-template "Org 9.0")
  157. (define-obsolete-variable-alias 'hfy-optimisations 'hfy-optimizations "Org 9.0")
  158. (define-obsolete-variable-alias 'org-export-htmlized-org-css-url
  159. 'org-org-htmlized-css-url "Org 8.2")
  160. (define-obsolete-function-alias 'org-list-parse-list 'org-list-to-lisp "Org 9.0")
  161. (define-obsolete-function-alias 'org-agenda-todayp
  162. 'org-agenda-today-p "Org 9.0")
  163. (define-obsolete-function-alias 'org-babel-examplize-region
  164. 'org-babel-examplify-region "Org 9.0")
  165. (define-obsolete-variable-alias 'org-babel-capitalize-example-region-markers
  166. 'org-babel-uppercase-example-markers "Org 9.1")
  167. (define-obsolete-function-alias 'org-babel-trim 'org-trim "Org 9.0")
  168. (define-obsolete-variable-alias 'org-html-style 'org-html-head "24.4")
  169. (define-obsolete-function-alias 'org-insert-columns-dblock
  170. 'org-columns-insert-dblock "Org 9.0")
  171. (define-obsolete-variable-alias 'org-export-babel-evaluate
  172. 'org-export-use-babel "Org 9.1")
  173. (define-obsolete-function-alias 'org-activate-bracket-links
  174. 'org-activate-links "Org 9.0")
  175. (define-obsolete-function-alias 'org-activate-plain-links 'ignore "Org 9.0")
  176. (define-obsolete-function-alias 'org-activate-angle-links 'ignore "Org 9.0")
  177. (defun org-in-fixed-width-region-p ()
  178. "Non-nil if point in a fixed-width region."
  179. (save-match-data
  180. (eq 'fixed-width (org-element-type (org-element-at-point)))))
  181. (make-obsolete 'org-in-fixed-width-region-p
  182. "use `org-element' library"
  183. "Org 9.0")
  184. (defun org-compatible-face (inherits specs)
  185. "Make a compatible face specification.
  186. If INHERITS is an existing face and if the Emacs version supports
  187. it, just inherit the face. If INHERITS is not given and SPECS
  188. is, use SPECS to define the face."
  189. (declare (indent 1))
  190. (if (facep inherits)
  191. (list (list t :inherit inherits))
  192. specs))
  193. (make-obsolete 'org-compatible-face "you can remove it." "Org 9.0")
  194. (defun org-add-link-type (type &optional follow export)
  195. "Add a new TYPE link.
  196. FOLLOW and EXPORT are two functions.
  197. FOLLOW should take the link path as the single argument and do whatever
  198. is necessary to follow the link, for example find a file or display
  199. a mail message.
  200. EXPORT should format the link path for export to one of the export formats.
  201. It should be a function accepting three arguments:
  202. path the path of the link, the text after the prefix (like \"http:\")
  203. desc the description of the link, if any
  204. format the export format, a symbol like `html' or `latex' or `ascii'.
  205. The function may use the FORMAT information to return different values
  206. depending on the format. The return value will be put literally into
  207. the exported file. If the return value is nil, this means Org should
  208. do what it normally does with links which do not have EXPORT defined.
  209. Org mode has a built-in default for exporting links. If you are happy with
  210. this default, there is no need to define an export function for the link
  211. type. For a simple example of an export function, see `org-bbdb.el'.
  212. If TYPE already exists, update it with the arguments.
  213. See `org-link-parameters' for documentation on the other parameters."
  214. (org-link-set-parameters type :follow follow :export export)
  215. (message "Created %s link." type))
  216. (make-obsolete 'org-add-link-type "use `org-link-set-parameters' instead." "Org 9.0")
  217. (defun org-table-recognize-table.el ()
  218. "If there is a table.el table nearby, recognize it and move into it."
  219. (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
  220. (beginning-of-line)
  221. (unless (or (looking-at org-table-dataline-regexp)
  222. (not (looking-at org-table1-hline-regexp)))
  223. (forward-line)
  224. (when (looking-at org-table-any-border-regexp)
  225. (forward-line -2)))
  226. (if (re-search-forward "|" (org-table-end t) t)
  227. (progn
  228. (require 'table)
  229. (if (table--at-cell-p (point)) t
  230. (message "recognizing table.el table...")
  231. (table-recognize-table)
  232. (message "recognizing table.el table...done")))
  233. (error "This should not happen"))))
  234. ;; Not used by Org core since commit 6d1e3082, Feb 2010.
  235. (make-obsolete 'org-table-recognize-table.el
  236. "please notify the org mailing list if you use this function."
  237. "Org 9.0")
  238. (defun org-remove-angle-brackets (s)
  239. (org-unbracket-string "<" ">" s))
  240. (make-obsolete 'org-remove-angle-brackets 'org-unbracket-string "Org 9.0")
  241. (defun org-remove-double-quotes (s)
  242. (org-unbracket-string "\"" "\"" s))
  243. (make-obsolete 'org-remove-double-quotes 'org-unbracket-string "Org 9.0")
  244. (defcustom org-publish-sitemap-file-entry-format "%t"
  245. "Format string for site-map file entry.
  246. You could use brackets to delimit on what part the link will be.
  247. %t is the title.
  248. %a is the author.
  249. %d is the date formatted using `org-publish-sitemap-date-format'."
  250. :group 'org-export-publish
  251. :type 'string)
  252. (make-obsolete-variable
  253. 'org-publish-sitemap-file-entry-format
  254. "set `:sitemap-format-entry' in `org-publish-project-alist' instead."
  255. "Org 9.1")
  256. (defvar org-agenda-skip-regexp)
  257. (defun org-agenda-skip-entry-when-regexp-matches ()
  258. "Check if the current entry contains match for `org-agenda-skip-regexp'.
  259. If yes, it returns the end position of this entry, causing agenda commands
  260. to skip the entry but continuing the search in the subtree. This is a
  261. function that can be put into `org-agenda-skip-function' for the duration
  262. of a command."
  263. (declare (obsolete "use `org-agenda-skip-if' instead." "Org 9.1"))
  264. (let ((end (save-excursion (org-end-of-subtree t)))
  265. skip)
  266. (save-excursion
  267. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  268. (and skip end)))
  269. (defun org-agenda-skip-subtree-when-regexp-matches ()
  270. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  271. If yes, it returns the end position of this tree, causing agenda commands
  272. to skip this subtree. This is a function that can be put into
  273. `org-agenda-skip-function' for the duration of a command."
  274. (declare (obsolete "use `org-agenda-skip-if' instead." "Org 9.1"))
  275. (let ((end (save-excursion (org-end-of-subtree t)))
  276. skip)
  277. (save-excursion
  278. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  279. (and skip end)))
  280. (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
  281. "Check if the current subtree contains match for `org-agenda-skip-regexp'.
  282. If yes, it returns the end position of the current entry (NOT the tree),
  283. causing agenda commands to skip the entry but continuing the search in
  284. the subtree. This is a function that can be put into
  285. `org-agenda-skip-function' for the duration of a command. An important
  286. use of this function is for the stuck project list."
  287. (declare (obsolete "use `org-agenda-skip-if' instead." "Org 9.1"))
  288. (let ((end (save-excursion (org-end-of-subtree t)))
  289. (entry-end (save-excursion (outline-next-heading) (1- (point))))
  290. skip)
  291. (save-excursion
  292. (setq skip (re-search-forward org-agenda-skip-regexp end t)))
  293. (and skip entry-end)))
  294. (define-obsolete-function-alias 'org-minutes-to-clocksum-string
  295. 'org-duration-from-minutes "Org 9.1")
  296. (define-obsolete-function-alias 'org-hh:mm-string-to-minutes
  297. 'org-duration-to-minutes "Org 9.1")
  298. (define-obsolete-function-alias 'org-duration-string-to-minutes
  299. 'org-duration-to-minutes "Org 9.1")
  300. (make-obsolete-variable 'org-time-clocksum-format
  301. "set `org-duration-format' instead." "Org 9.1")
  302. (make-obsolete-variable 'org-time-clocksum-use-fractional
  303. "set `org-duration-format' instead." "Org 9.1")
  304. (make-obsolete-variable 'org-time-clocksum-fractional-format
  305. "set `org-duration-format' instead." "Org 9.1")
  306. (make-obsolete-variable 'org-time-clocksum-use-effort-durations
  307. "set `org-duration-units' instead." "Org 9.1")
  308. (define-obsolete-function-alias 'org-babel-number-p
  309. 'org-babel--string-to-number "Org 9.0")
  310. (define-obsolete-variable-alias 'org-usenet-links-prefer-google
  311. 'org-gnus-prefer-web-links "Org 9.1")
  312. (define-obsolete-variable-alias 'org-texinfo-def-table-markup
  313. 'org-texinfo-table-default-markup "Org 9.1")
  314. ;; The function was made obsolete by commit 65399674d5 of 2013-02-22.
  315. ;; This make-obsolete call was added 2016-09-01.
  316. (make-obsolete 'org-capture-import-remember-templates
  317. "use the `org-capture-templates' variable instead."
  318. "Org 9.0")
  319. (defun org-show-block-all ()
  320. "Unfold all blocks in the current buffer."
  321. (interactive)
  322. (remove-overlays nil nil 'invisible 'org-hide-block))
  323. (make-obsolete 'org-show-block-all
  324. "use `org-show-all' instead."
  325. "Org 9.2")
  326. ;;;; Obsolete link types
  327. (eval-after-load 'org
  328. '(progn
  329. (org-link-set-parameters "file+emacs") ;since Org 9.0
  330. (org-link-set-parameters "file+sys"))) ;since Org 9.0
  331. ;;; Miscellaneous functions
  332. (defun org-version-check (version feature level)
  333. (let* ((v1 (mapcar 'string-to-number (split-string version "[.]")))
  334. (v2 (mapcar 'string-to-number (split-string emacs-version "[.]")))
  335. (rmaj (or (nth 0 v1) 99))
  336. (rmin (or (nth 1 v1) 99))
  337. (rbld (or (nth 2 v1) 99))
  338. (maj (or (nth 0 v2) 0))
  339. (min (or (nth 1 v2) 0))
  340. (bld (or (nth 2 v2) 0)))
  341. (if (or (< maj rmaj)
  342. (and (= maj rmaj)
  343. (< min rmin))
  344. (and (= maj rmaj)
  345. (= min rmin)
  346. (< bld rbld)))
  347. (if (eq level :predicate)
  348. ;; just return if we have the version
  349. nil
  350. (let ((msg (format "Emacs %s or greater is recommended for %s"
  351. version feature)))
  352. (display-warning 'org msg level)
  353. t))
  354. t)))
  355. (defun org-get-x-clipboard (value)
  356. "Get the value of the X or Windows clipboard."
  357. (cond ((and (eq window-system 'x)
  358. (fboundp 'gui-get-selection)) ;Silence byte-compiler.
  359. (org-no-properties
  360. (ignore-errors
  361. (or (gui-get-selection value 'UTF8_STRING)
  362. (gui-get-selection value 'COMPOUND_TEXT)
  363. (gui-get-selection value 'STRING)
  364. (gui-get-selection value 'TEXT)))))
  365. ((and (eq window-system 'w32) (fboundp 'w32-get-clipboard-data))
  366. (w32-get-clipboard-data))))
  367. (defun org-fit-window-to-buffer (&optional window max-height min-height
  368. shrink-only)
  369. "Fit WINDOW to the buffer, but only if it is not a side-by-side window.
  370. WINDOW defaults to the selected window. MAX-HEIGHT and MIN-HEIGHT are
  371. passed through to `fit-window-to-buffer'. If SHRINK-ONLY is set, call
  372. `shrink-window-if-larger-than-buffer' instead, the height limit is
  373. ignored in this case."
  374. (cond ((if (fboundp 'window-full-width-p)
  375. (not (window-full-width-p window))
  376. ;; do nothing if another window would suffer
  377. (> (frame-width) (window-width window))))
  378. ((and (fboundp 'fit-window-to-buffer) (not shrink-only))
  379. (fit-window-to-buffer window max-height min-height))
  380. ((fboundp 'shrink-window-if-larger-than-buffer)
  381. (shrink-window-if-larger-than-buffer window)))
  382. (or window (selected-window)))
  383. ;; `set-transient-map' is only in Emacs >= 24.4
  384. (defalias 'org-set-transient-map
  385. (if (fboundp 'set-transient-map)
  386. 'set-transient-map
  387. 'set-temporary-overlay-map))
  388. ;;; Region compatibility
  389. (defvar org-ignore-region nil
  390. "Non-nil means temporarily disable the active region.")
  391. (defun org-region-active-p ()
  392. "Non-nil when the region active.
  393. Unlike to `use-region-p', this function also checks
  394. `org-ignore-region'."
  395. (and (not org-ignore-region) (use-region-p)))
  396. (defun org-cursor-to-region-beginning ()
  397. (when (and (org-region-active-p)
  398. (> (point) (region-beginning)))
  399. (exchange-point-and-mark)))
  400. ;;; Invisibility compatibility
  401. (defun org-remove-from-invisibility-spec (arg)
  402. "Remove elements from `buffer-invisibility-spec'."
  403. (if (fboundp 'remove-from-invisibility-spec)
  404. (remove-from-invisibility-spec arg)
  405. (if (consp buffer-invisibility-spec)
  406. (setq buffer-invisibility-spec
  407. (delete arg buffer-invisibility-spec)))))
  408. (defun org-in-invisibility-spec-p (arg)
  409. "Is ARG a member of `buffer-invisibility-spec'?"
  410. (if (consp buffer-invisibility-spec)
  411. (member arg buffer-invisibility-spec)))
  412. (defun org-move-to-column (column &optional force _buffer)
  413. "Move to column COLUMN.
  414. Pass COLUMN and FORCE to `move-to-column'."
  415. (let ((buffer-invisibility-spec
  416. (if (listp buffer-invisibility-spec)
  417. (remove '(org-filtered) buffer-invisibility-spec)
  418. buffer-invisibility-spec)))
  419. (move-to-column column force)))
  420. (defmacro org-find-library-dir (library)
  421. `(file-name-directory (or (locate-library ,library) "")))
  422. (defun org-count-lines (s)
  423. "How many lines in string S?"
  424. (let ((start 0) (n 1))
  425. (while (string-match "\n" s start)
  426. (setq start (match-end 0) n (1+ n)))
  427. (if (and (> (length s) 0) (= (aref s (1- (length s))) ?\n))
  428. (setq n (1- n)))
  429. n))
  430. (defun org-kill-new (string &rest args)
  431. (remove-text-properties 0 (length string) '(line-prefix t wrap-prefix t)
  432. string)
  433. (apply 'kill-new string args))
  434. ;; `font-lock-ensure' is only available from 24.4.50 on
  435. (defalias 'org-font-lock-ensure
  436. (if (fboundp 'font-lock-ensure)
  437. #'font-lock-ensure
  438. (lambda (&optional _beg _end)
  439. (with-no-warnings (font-lock-fontify-buffer)))))
  440. ;; `file-local-name' was added in Emacs 26.1.
  441. (defalias 'org-babel-local-file-name
  442. (if (fboundp 'file-local-name)
  443. 'file-local-name
  444. (lambda (file)
  445. "Return the local name component of FILE."
  446. (or (file-remote-p file 'localname) file))))
  447. (defmacro org-no-popups (&rest body)
  448. "Suppress popup windows.
  449. Let-bind some variables to nil around BODY to achieve the desired
  450. effect, which variables to use depends on the Emacs version."
  451. (if (org-version-check "24.2.50" "" :predicate)
  452. `(let (pop-up-frames display-buffer-alist)
  453. ,@body)
  454. `(let (pop-up-frames special-display-buffer-names special-display-regexps special-display-function)
  455. ,@body)))
  456. ;;;###autoload
  457. (defmacro org-check-version ()
  458. "Try very hard to provide sensible version strings."
  459. (let* ((org-dir (org-find-library-dir "org"))
  460. (org-version.el (concat org-dir "org-version.el"))
  461. (org-fixup.el (concat org-dir "../mk/org-fixup.el")))
  462. (if (require 'org-version org-version.el 'noerror)
  463. '(progn
  464. (autoload 'org-release "org-version.el")
  465. (autoload 'org-git-version "org-version.el"))
  466. (if (require 'org-fixup org-fixup.el 'noerror)
  467. '(org-fixup)
  468. ;; provide fallback definitions and complain
  469. (warn "Could not define org version correctly. Check installation!")
  470. '(progn
  471. (defun org-release () "N/A")
  472. (defun org-git-version () "N/A !!check installation!!"))))))
  473. (defmacro org-with-silent-modifications (&rest body)
  474. (if (fboundp 'with-silent-modifications)
  475. `(with-silent-modifications ,@body)
  476. `(org-unmodified ,@body)))
  477. (def-edebug-spec org-with-silent-modifications (body))
  478. ;;; Functions for Emacs < 24.4 compatibility
  479. (defun org-define-error (name message)
  480. "Define NAME as a new error signal.
  481. MESSAGE is a string that will be output to the echo area if such
  482. an error is signaled without being caught by a `condition-case'.
  483. Implements `define-error' for older emacsen."
  484. (if (fboundp 'define-error) (define-error name message)
  485. (put name 'error-conditions
  486. (copy-sequence (cons name (get 'error 'error-conditions))))))
  487. (unless (fboundp 'string-suffix-p)
  488. ;; From Emacs subr.el.
  489. (defun string-suffix-p (suffix string &optional ignore-case)
  490. "Return non-nil if SUFFIX is a suffix of STRING.
  491. If IGNORE-CASE is non-nil, the comparison is done without paying
  492. attention to case differences."
  493. (let ((start-pos (- (length string) (length suffix))))
  494. (and (>= start-pos 0)
  495. (eq t (compare-strings suffix nil nil
  496. string start-pos nil ignore-case))))))
  497. ;;; Integration with and fixes for other packages
  498. (defgroup org-imenu-and-speedbar nil
  499. "Options concerning imenu and speedbar in Org mode."
  500. :tag "Org Imenu and Speedbar"
  501. :group 'org-structure)
  502. (defcustom org-imenu-depth 2
  503. "The maximum level for Imenu access to Org headlines.
  504. This also applied for speedbar access."
  505. :group 'org-imenu-and-speedbar
  506. :type 'integer)
  507. ;;;; Imenu
  508. (defvar-local org-imenu-markers nil
  509. "All markers currently used by Imenu.")
  510. (defun org-imenu-new-marker (&optional pos)
  511. "Return a new marker for use by Imenu, and remember the marker."
  512. (let ((m (make-marker)))
  513. (move-marker m (or pos (point)))
  514. (push m org-imenu-markers)
  515. m))
  516. (defun org-imenu-get-tree ()
  517. "Produce the index for Imenu."
  518. (dolist (x org-imenu-markers) (move-marker x nil))
  519. (setq org-imenu-markers nil)
  520. (let* ((case-fold-search nil)
  521. (n org-imenu-depth)
  522. (re (concat "^" (org-get-limited-outline-regexp)))
  523. (subs (make-vector (1+ n) nil))
  524. (last-level 0)
  525. m level head0 head)
  526. (org-with-wide-buffer
  527. (goto-char (point-max))
  528. (while (re-search-backward re nil t)
  529. (setq level (org-reduced-level (funcall outline-level)))
  530. (when (and (<= level n)
  531. (looking-at org-complex-heading-regexp)
  532. (setq head0 (match-string-no-properties 4)))
  533. (setq head (org-link-display-format head0)
  534. m (org-imenu-new-marker))
  535. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  536. (if (>= level last-level)
  537. (push (cons head m) (aref subs level))
  538. (push (cons head (aref subs (1+ level))) (aref subs level))
  539. (cl-loop for i from (1+ level) to n do (aset subs i nil)))
  540. (setq last-level level))))
  541. (aref subs 1)))
  542. (eval-after-load "imenu"
  543. '(progn
  544. (add-hook 'imenu-after-jump-hook
  545. (lambda ()
  546. (when (derived-mode-p 'org-mode)
  547. (org-show-context 'org-goto))))))
  548. ;;;; Speedbar
  549. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  550. "Overlay marking the agenda restriction line in speedbar.")
  551. (overlay-put org-speedbar-restriction-lock-overlay
  552. 'face 'org-agenda-restriction-lock)
  553. (overlay-put org-speedbar-restriction-lock-overlay
  554. 'help-echo "Agendas are currently limited to this item.")
  555. (delete-overlay org-speedbar-restriction-lock-overlay)
  556. (defun org-speedbar-set-agenda-restriction ()
  557. "Restrict future agenda commands to the location at point in speedbar.
  558. To get rid of the restriction, use `\\[org-agenda-remove-restriction-lock]'."
  559. (interactive)
  560. (require 'org-agenda)
  561. (let (p m tp np dir txt)
  562. (cond
  563. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  564. 'org-imenu t))
  565. (setq m (get-text-property p 'org-imenu-marker))
  566. (with-current-buffer (marker-buffer m)
  567. (goto-char m)
  568. (org-agenda-set-restriction-lock 'subtree)))
  569. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  570. 'speedbar-function 'speedbar-find-file))
  571. (setq tp (previous-single-property-change
  572. (1+ p) 'speedbar-function)
  573. np (next-single-property-change
  574. tp 'speedbar-function)
  575. dir (speedbar-line-directory)
  576. txt (buffer-substring-no-properties (or tp (point-min))
  577. (or np (point-max))))
  578. (with-current-buffer (find-file-noselect
  579. (let ((default-directory dir))
  580. (expand-file-name txt)))
  581. (unless (derived-mode-p 'org-mode)
  582. (user-error "Cannot restrict to non-Org mode file"))
  583. (org-agenda-set-restriction-lock 'file)))
  584. (t (user-error "Don't know how to restrict Org mode agenda")))
  585. (move-overlay org-speedbar-restriction-lock-overlay
  586. (point-at-bol) (point-at-eol))
  587. (setq current-prefix-arg nil)
  588. (org-agenda-maybe-redo)))
  589. (defvar speedbar-file-key-map)
  590. (declare-function speedbar-add-supported-extension "speedbar" (extension))
  591. (eval-after-load "speedbar"
  592. '(progn
  593. (speedbar-add-supported-extension ".org")
  594. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  595. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  596. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  597. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  598. (add-hook 'speedbar-visiting-tag-hook
  599. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  600. ;;;; Flyspell
  601. (defun org--flyspell-object-check-p (element)
  602. "Non-nil when Flyspell can check object at point.
  603. ELEMENT is the element at point."
  604. (let ((object (save-excursion
  605. (when (looking-at-p "\\>") (backward-char))
  606. (org-element-context element))))
  607. (cl-case (org-element-type object)
  608. ;; Prevent checks in links due to keybinding conflict with
  609. ;; Flyspell.
  610. ((code entity export-snippet inline-babel-call
  611. inline-src-block line-break latex-fragment link macro
  612. statistics-cookie target timestamp verbatim)
  613. nil)
  614. (footnote-reference
  615. ;; Only in inline footnotes, within the definition.
  616. (and (eq (org-element-property :type object) 'inline)
  617. (< (save-excursion
  618. (goto-char (org-element-property :begin object))
  619. (search-forward ":" nil t 2))
  620. (point))))
  621. (otherwise t))))
  622. (defun org-mode-flyspell-verify ()
  623. "Function used for `flyspell-generic-check-word-predicate'."
  624. (if (org-at-heading-p)
  625. ;; At a headline or an inlinetask, check title only. This is
  626. ;; faster than relying on `org-element-at-point'.
  627. (and (save-excursion (beginning-of-line)
  628. (and (let ((case-fold-search t))
  629. (not (looking-at-p "\\*+ END[ \t]*$")))
  630. (let ((case-fold-search nil))
  631. (looking-at org-complex-heading-regexp))))
  632. (match-beginning 4)
  633. (>= (point) (match-beginning 4))
  634. (or (not (match-beginning 5))
  635. (< (point) (match-beginning 5))))
  636. (let* ((element (org-element-at-point))
  637. (post-affiliated (org-element-property :post-affiliated element)))
  638. (cond
  639. ;; Ignore checks in all affiliated keywords but captions.
  640. ((< (point) post-affiliated)
  641. (and (save-excursion
  642. (beginning-of-line)
  643. (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
  644. (> (point) (match-end 0))
  645. (org--flyspell-object-check-p element)))
  646. ;; Ignore checks in LOGBOOK (or equivalent) drawer.
  647. ((let ((log (org-log-into-drawer)))
  648. (and log
  649. (let ((drawer (org-element-lineage element '(drawer))))
  650. (and drawer
  651. (eq (compare-strings
  652. log nil nil
  653. (org-element-property :drawer-name drawer) nil nil t)
  654. t)))))
  655. nil)
  656. (t
  657. (cl-case (org-element-type element)
  658. ((comment quote-section) t)
  659. (comment-block
  660. ;; Allow checks between block markers, not on them.
  661. (and (> (line-beginning-position) post-affiliated)
  662. (save-excursion
  663. (end-of-line)
  664. (skip-chars-forward " \r\t\n")
  665. (< (point) (org-element-property :end element)))))
  666. ;; Arbitrary list of keywords where checks are meaningful.
  667. ;; Make sure point is on the value part of the element.
  668. (keyword
  669. (and (member (org-element-property :key element)
  670. '("DESCRIPTION" "TITLE"))
  671. (save-excursion
  672. (search-backward ":" (line-beginning-position) t))))
  673. ;; Check is globally allowed in paragraphs verse blocks and
  674. ;; table rows (after affiliated keywords) but some objects
  675. ;; must not be affected.
  676. ((paragraph table-row verse-block)
  677. (let ((cbeg (org-element-property :contents-begin element))
  678. (cend (org-element-property :contents-end element)))
  679. (and cbeg (>= (point) cbeg) (< (point) cend)
  680. (org--flyspell-object-check-p element))))))))))
  681. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  682. (defun org-remove-flyspell-overlays-in (beg end)
  683. "Remove flyspell overlays in region."
  684. (and (bound-and-true-p flyspell-mode)
  685. (fboundp 'flyspell-delete-region-overlays)
  686. (flyspell-delete-region-overlays beg end)))
  687. (defvar flyspell-delayed-commands)
  688. (eval-after-load "flyspell"
  689. '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
  690. ;;;; Bookmark
  691. (defun org-bookmark-jump-unhide ()
  692. "Unhide the current position, to show the bookmark location."
  693. (and (derived-mode-p 'org-mode)
  694. (or (org-invisible-p)
  695. (save-excursion (goto-char (max (point-min) (1- (point))))
  696. (org-invisible-p)))
  697. (org-show-context 'bookmark-jump)))
  698. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  699. (eval-after-load "bookmark"
  700. '(if (boundp 'bookmark-after-jump-hook)
  701. ;; We can use the hook
  702. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  703. ;; Hook not available, use advice
  704. (defadvice bookmark-jump (after org-make-visible activate)
  705. "Make the position visible."
  706. (org-bookmark-jump-unhide))))
  707. ;;;; Calendar
  708. (defcustom org-calendar-to-agenda-key 'default
  709. "Key to be installed in `calendar-mode-map' for switching to the agenda.
  710. The command `org-calendar-goto-agenda' will be bound to this key.
  711. When set to `default', bind the function to `c', but only if it is
  712. available in the Calendar keymap. This is the default choice because
  713. `c' can then be used to switch back and forth between agenda and calendar.
  714. When nil, `org-calendar-goto-agenda' is not bound to any key."
  715. :group 'org-agenda
  716. :type '(choice
  717. (const :tag "Bind to `c' if available" default)
  718. (key-sequence :tag "Other binding")
  719. (const :tag "No binding" nil))
  720. :safe (lambda (v) (or (symbolp v) (stringp v)))
  721. :package-version '(Org . "9.2"))
  722. (defcustom org-calendar-insert-diary-entry-key [?i]
  723. "The key to be installed in `calendar-mode-map' for adding diary entries.
  724. This option is irrelevant until `org-agenda-diary-file' has been configured
  725. to point to an Org file. When that is the case, the command
  726. `org-agenda-diary-entry' will be bound to the key given here, by default
  727. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  728. if you want to continue doing this, you need to change this to a different
  729. key."
  730. :group 'org-agenda
  731. :type 'sexp)
  732. (defun org--setup-calendar-bindings ()
  733. "Bind Org functions in Calendar keymap."
  734. (pcase org-calendar-to-agenda-key
  735. (`nil nil)
  736. ((and key (pred stringp))
  737. (local-set-key (kbd key) #'org-calendar-goto-agenda))
  738. ((guard (not (lookup-key calendar-mode-map "c")))
  739. (local-set-key "c" #'org-calendar-goto-agenda))
  740. (_ nil))
  741. (unless (eq org-agenda-diary-file 'diary-file)
  742. (local-set-key org-calendar-insert-diary-entry-key
  743. #'org-agenda-diary-entry)))
  744. (eval-after-load "calendar"
  745. '(add-hook 'calendar-mode-hook #'org--setup-calendar-bindings))
  746. ;;;; Saveplace
  747. ;; Make sure saveplace shows the location if it was hidden
  748. (eval-after-load "saveplace"
  749. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  750. "Make the position visible."
  751. (org-bookmark-jump-unhide)))
  752. ;;;; Ecb
  753. ;; Make sure ecb shows the location if it was hidden
  754. (eval-after-load "ecb"
  755. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  756. "Make hierarchy visible when jumping into location from ECB tree buffer."
  757. (when (derived-mode-p 'org-mode)
  758. (org-show-context))))
  759. ;;;; Simple
  760. (defun org-mark-jump-unhide ()
  761. "Make the point visible with `org-show-context' after jumping to the mark."
  762. (when (and (derived-mode-p 'org-mode)
  763. (org-invisible-p))
  764. (org-show-context 'mark-goto)))
  765. (eval-after-load "simple"
  766. '(defadvice pop-to-mark-command (after org-make-visible activate)
  767. "Make the point visible with `org-show-context'."
  768. (org-mark-jump-unhide)))
  769. (eval-after-load "simple"
  770. '(defadvice exchange-point-and-mark (after org-make-visible activate)
  771. "Make the point visible with `org-show-context'."
  772. (org-mark-jump-unhide)))
  773. (eval-after-load "simple"
  774. '(defadvice pop-global-mark (after org-make-visible activate)
  775. "Make the point visible with `org-show-context'."
  776. (org-mark-jump-unhide)))
  777. ;;;; Session
  778. ;; Make "session.el" ignore our circular variable.
  779. (defvar session-globals-exclude)
  780. (eval-after-load "session"
  781. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  782. (provide 'org-compat)
  783. ;;; org-compat.el ends here