org-compat.el 47 KB

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