lisp/org-compat.el

   1 ;;; org-compat.el --- Compatibility Code for Older Emacsen -*- lexical-binding: t; -*-
   2
   3 ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
   4
   5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
   6 ;; Keywords: outlines, hypermedia, calendar, wp
   7 ;; Homepage: http://orgmode.org
   8 ;;
   9 ;; This file is part of GNU Emacs.
  10 ;;
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  24 ;;
  25 ;;; Commentary:
  26
  27 ;; This file contains code needed for compatibility with older
  28 ;; versions of GNU Emacs.
  29
  30 ;;; Code:
  31
  32 (require 'cl-lib)
  33 (require 'org-macs)
  34
  35 (declare-function org-at-table.el-p "org" (&optional table-type))
  36 (declare-function org-element-at-point "org-element" ())
  37 (declare-function org-element-type "org-element" (element))
  38 (declare-function org-end-of-subtree "org" (&optional invisible-ok to-heading))
  39 (declare-function org-link-set-parameters "org" (type &rest rest))
  40 (declare-function org-table-end (&optional table-type))
  41 (declare-function outline-next-heading "outline" ())
  42 (declare-function table--at-cell-p "table" (position &optional object at-column))
  43
  44 (defvar org-table-any-border-regexp)
  45 (defvar org-table-dataline-regexp)
  46 (defvar org-table-tab-recognizes-table.el)
  47 (defvar org-table1-hline-regexp)
  48
  49 ;;; Emacs < 25.1 compatibility
  50
  51 (when (< emacs-major-version 25)
  52   (defalias 'outline-hide-entry 'hide-entry)
  53   (defalias 'outline-hide-sublevels 'hide-sublevels)
  54   (defalias 'outline-hide-subtree 'hide-subtree)
  55   (defalias 'outline-show-all 'show-all)
  56   (defalias 'outline-show-branches 'show-branches)
  57   (defalias 'outline-show-children 'show-children)
  58   (defalias 'outline-show-entry 'show-entry)
  59   (defalias 'outline-show-subtree 'show-subtree)
  60   (defalias 'xref-find-definitions 'find-tag)
  61   (defalias 'format-message 'format)
  62   (defalias 'gui-get-selection 'x-get-selection))
  63
  64 (unless (fboundp 'directory-name-p)
  65   (defun directory-name-p (name)
  66     "Return non-nil if NAME ends with a directory separator character."
  67     (let ((len (length name))
  68           (lastc ?.))
  69       (if (> len 0)
  70           (setq lastc (aref name (1- len))))
  71       (or (= lastc ?/)
  72           (and (memq system-type '(windows-nt ms-dos))
  73                (= lastc ?\\))))))
  74
  75 (unless (fboundp 'directory-files-recursively)
  76   (defun directory-files-recursively (dir regexp &optional include-directories)
  77     "Return list of all files under DIR that have file names matching REGEXP.
  78 This function works recursively.  Files are returned in \"depth first\"
  79 order, and files from each directory are sorted in alphabetical order.
  80 Each file name appears in the returned list in its absolute form.
  81 Optional argument INCLUDE-DIRECTORIES non-nil means also include in the
  82 output directories whose names match REGEXP."
  83     (let ((result nil)
  84           (files nil)
  85           ;; When DIR is "/", remote file names like "/method:" could
  86           ;; also be offered.  We shall suppress them.
  87           (tramp-mode (and tramp-mode (file-remote-p (expand-file-name dir)))))
  88       (dolist (file (sort (file-name-all-completions "" dir)
  89                           'string<))
  90         (unless (member file '("./" "../"))
  91           (if (directory-name-p file)
  92               (let* ((leaf (substring file 0 (1- (length file))))
  93                      (full-file (expand-file-name leaf dir)))
  94                 ;; Don't follow symlinks to other directories.
  95                 (unless (file-symlink-p full-file)
  96                   (setq result
  97                         (nconc result (directory-files-recursively
  98                                        full-file regexp include-directories))))
  99                 (when (and include-directories
 100                            (string-match regexp leaf))
 101                   (setq result (nconc result (list full-file)))))
 102             (when (string-match regexp file)
 103               (push (expand-file-name file dir) files)))))
 104       (nconc result (nreverse files)))))
 105
 106 \f
 107 ;;; Obsolete aliases (remove them after the next major release).
 108
 109 ;;;; XEmacs compatibility, now removed.
 110 (define-obsolete-function-alias 'org-activate-mark 'activate-mark)
 111 (define-obsolete-function-alias 'org-add-hook 'add-hook "Org 9.0")
 112 (define-obsolete-function-alias 'org-bound-and-true-p 'bound-and-true-p "Org 9.0")
 113 (define-obsolete-function-alias 'org-decompose-region 'decompose-region "Org 9.0")
 114 (define-obsolete-function-alias 'org-defvaralias 'defvaralias "Org 9.0")
 115 (define-obsolete-function-alias 'org-detach-overlay 'delete-overlay "Org 9.0")
 116 (define-obsolete-function-alias 'org-file-equal-p 'file-equal-p "Org 9.0")
 117 (define-obsolete-function-alias 'org-float-time 'float-time "Org 9.0")
 118 (define-obsolete-function-alias 'org-indent-line-to 'indent-line-to "Org 9.0")
 119 (define-obsolete-function-alias 'org-indent-to-column 'indent-to-column "Org 9.0")
 120 (define-obsolete-function-alias 'org-looking-at-p 'looking-at-p "Org 9.0")
 121 (define-obsolete-function-alias 'org-looking-back 'looking-back "Org 9.0")
 122 (define-obsolete-function-alias 'org-match-string-no-properties 'match-string-no-properties "Org 9.0")
 123 (define-obsolete-function-alias 'org-propertize 'propertize "Org 9.0")
 124 (define-obsolete-function-alias 'org-select-frame-set-input-focus 'select-frame-set-input-focus "Org 9.0")
 125
 126 (defmacro org-re (s)
 127   "Replace posix classes in regular expression S."
 128   (declare (debug (form))
 129            (obsolete "you can safely remove it." "Org 9.0"))
 130   s)
 131
 132 ;;;; Functions from cl-lib that Org used to have its own implementation of.
 133 (define-obsolete-function-alias 'org-count 'cl-count "Org 9.0")
 134 (define-obsolete-function-alias 'org-every 'cl-every "Org 9.0")
 135 (define-obsolete-function-alias 'org-find-if 'cl-find-if "Org 9.0")
 136 (define-obsolete-function-alias 'org-reduce 'cl-reduce "Org 9.0")
 137 (define-obsolete-function-alias 'org-remove-if 'cl-remove-if "Org 9.0")
 138 (define-obsolete-function-alias 'org-remove-if-not 'cl-remove-if-not "Org 9.0")
 139 (define-obsolete-function-alias 'org-some 'cl-some "Org 9.0")
 140 (define-obsolete-function-alias 'org-floor* 'cl-floor "Org 9.0")
 141
 142 (defun org-sublist (list start end)
 143   "Return a section of LIST, from START to END.
 144 Counting starts at 1."
 145   (cl-subseq list (1- start) end))
 146 (make-obsolete 'org-sublist
 147                "use cl-subseq (note the 0-based counting)."
 148                "Org 9.0")
 149
 150
 151 ;;;; Functions available since Emacs 24.3
 152 (define-obsolete-function-alias 'org-buffer-narrowed-p 'buffer-narrowed-p "Org 9.0")
 153 (define-obsolete-function-alias 'org-called-interactively-p 'called-interactively-p "Org 9.0")
 154 (define-obsolete-function-alias 'org-char-to-string 'char-to-string "Org 9.0")
 155 (define-obsolete-function-alias 'org-delete-directory 'delete-directory "Org 9.0")
 156 (define-obsolete-function-alias 'org-format-seconds 'format-seconds "Org 9.0")
 157 (define-obsolete-function-alias 'org-link-escape-browser 'url-encode-url "Org 9.0")
 158 (define-obsolete-function-alias 'org-no-warnings 'with-no-warnings "Org 9.0")
 159 (define-obsolete-function-alias 'org-number-sequence 'number-sequence "Org 9.0")
 160 (define-obsolete-function-alias 'org-pop-to-buffer-same-window 'pop-to-buffer-same-window "Org 9.0")
 161 (define-obsolete-function-alias 'org-string-match-p 'string-match-p "Org 9.0")
 162
 163 ;;;; Functions and variables from previous releases now obsolete.
 164 (define-obsolete-function-alias 'org-element-remove-indentation
 165   'org-remove-indentation "Org 9.0")
 166 (define-obsolete-variable-alias 'org-latex-create-formula-image-program
 167   'org-preview-latex-default-process "Org 9.0")
 168 (define-obsolete-variable-alias 'org-latex-preview-ltxpng-directory
 169   'org-preview-latex-image-directory "Org 9.0")
 170 (define-obsolete-function-alias 'org-table-p 'org-at-table-p "Org 9.0")
 171 (define-obsolete-function-alias 'org-on-heading-p 'org-at-heading-p "Org 9.0")
 172 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp "Org 8.3")
 173 (define-obsolete-function-alias 'org-image-file-name-regexp
 174   'image-file-name-regexp "Org 9.0")
 175 (define-obsolete-function-alias 'org-completing-read-no-i
 176   'completing-read "Org 9.0")
 177 (define-obsolete-function-alias 'org-icompleting-read
 178   'completing-read "Org 9.0")
 179 (define-obsolete-function-alias 'org-iread-file-name 'read-file-name "Org 9.0")
 180 (define-obsolete-function-alias 'org-days-to-time
 181   'org-time-stamp-to-now "Org 8.2")
 182 (define-obsolete-variable-alias 'org-agenda-ignore-drawer-properties
 183   'org-agenda-ignore-properties "Org 9.0")
 184 (define-obsolete-function-alias 'org-preview-latex-fragment
 185   'org-toggle-latex-fragment "Org 8.3")
 186 (define-obsolete-function-alias 'org-export-get-genealogy
 187   'org-element-lineage "Org 9.0")
 188 (define-obsolete-variable-alias 'org-latex-with-hyperref
 189   'org-latex-hyperref-template "Org 9.0")
 190 (define-obsolete-variable-alias 'hfy-optimisations 'hfy-optimizations "Org 9.0")
 191 (define-obsolete-variable-alias 'org-export-htmlized-org-css-url
 192   'org-org-htmlized-css-url "Org 8.2")
 193 (define-obsolete-function-alias 'org-list-parse-list 'org-list-to-lisp "Org 9.0")
 194 (define-obsolete-function-alias 'org-agenda-todayp
 195   'org-agenda-today-p "Org 9.0")
 196 (define-obsolete-function-alias 'org-babel-examplize-region
 197   'org-babel-examplify-region "Org 9.0")
 198 (define-obsolete-variable-alias 'org-babel-capitalize-example-region-markers
 199   'org-babel-uppercase-example-markers "Org 9.1")
 200
 201 (define-obsolete-function-alias 'org-babel-trim 'org-trim "Org 9.0")
 202 (define-obsolete-variable-alias 'org-html-style 'org-html-head "24.4")
 203 (define-obsolete-function-alias 'org-insert-columns-dblock
 204   'org-columns-insert-dblock "Org 9.0")
 205 (define-obsolete-variable-alias 'org-export-babel-evaluate
 206   'org-export-use-babel "Org 9.1")
 207 (define-obsolete-function-alias 'org-activate-bracket-links
 208   'org-activate-links "Org 9.0")
 209 (define-obsolete-function-alias 'org-activate-plain-links 'ignore "Org 9.0")
 210 (define-obsolete-function-alias 'org-activate-angle-links 'ignore "Org 9.0")
 211
 212 (defun org-in-fixed-width-region-p ()
 213   "Non-nil if point in a fixed-width region."
 214   (save-match-data
 215     (eq 'fixed-width (org-element-type (org-element-at-point)))))
 216 (make-obsolete 'org-in-fixed-width-region-p
 217                "use `org-element' library"
 218                "Org 9.0")
 219
 220 (defun org-compatible-face (inherits specs)
 221   "Make a compatible face specification.
 222 If INHERITS is an existing face and if the Emacs version supports
 223 it, just inherit the face.  If INHERITS is not given and SPECS
 224 is, use SPECS to define the face."
 225   (declare (indent 1))
 226   (if (facep inherits)
 227       (list (list t :inherit inherits))
 228     specs))
 229 (make-obsolete 'org-compatible-face "you can remove it." "Org 9.0")
 230
 231 (defun org-add-link-type (type &optional follow export)
 232   "Add a new TYPE link.
 233 FOLLOW and EXPORT are two functions.
 234
 235 FOLLOW should take the link path as the single argument and do whatever
 236 is necessary to follow the link, for example find a file or display
 237 a mail message.
 238
 239 EXPORT should format the link path for export to one of the export formats.
 240 It should be a function accepting three arguments:
 241
 242   path    the path of the link, the text after the prefix (like \"http:\")
 243   desc    the description of the link, if any
 244   format  the export format, a symbol like `html' or `latex' or `ascii'.
 245
 246 The function may use the FORMAT information to return different values
 247 depending on the format.  The return value will be put literally into
 248 the exported file.  If the return value is nil, this means Org should
 249 do what it normally does with links which do not have EXPORT defined.
 250
 251 Org mode has a built-in default for exporting links.  If you are happy with
 252 this default, there is no need to define an export function for the link
 253 type.  For a simple example of an export function, see `org-bbdb.el'.
 254
 255 If TYPE already exists, update it with the arguments.
 256 See `org-link-parameters' for documentation on the other parameters."
 257   (org-link-set-parameters type :follow follow :export export)
 258   (message "Created %s link." type))
 259
 260 (make-obsolete 'org-add-link-type "use `org-link-set-parameters' instead." "Org 9.0")
 261
 262 (defun org-table-recognize-table.el ()
 263   "If there is a table.el table nearby, recognize it and move into it."
 264   (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
 265     (beginning-of-line)
 266     (unless (or (looking-at org-table-dataline-regexp)
 267                 (not (looking-at org-table1-hline-regexp)))
 268       (forward-line)
 269       (when (looking-at org-table-any-border-regexp)
 270         (forward-line -2)))
 271     (if (re-search-forward "|" (org-table-end t) t)
 272         (progn
 273           (require 'table)
 274           (if (table--at-cell-p (point)) t
 275             (message "recognizing table.el table...")
 276             (table-recognize-table)
 277             (message "recognizing table.el table...done")))
 278       (error "This should not happen"))))
 279
 280 ;; Not used by Org core since commit 6d1e3082, Feb 2010.
 281 (make-obsolete 'org-table-recognize-table.el
 282                "please notify the org mailing list if you use this function."
 283                "Org 9.0")
 284
 285 (defun org-remove-angle-brackets (s)
 286   (org-unbracket-string "<" ">" s))
 287 (make-obsolete 'org-remove-angle-brackets 'org-unbracket-string "Org 9.0")
 288
 289 (defun org-remove-double-quotes (s)
 290   (org-unbracket-string "\"" "\"" s))
 291 (make-obsolete 'org-remove-double-quotes 'org-unbracket-string "Org 9.0")
 292
 293 (defcustom org-publish-sitemap-file-entry-format "%t"
 294   "Format string for site-map file entry.
 295 You could use brackets to delimit on what part the link will be.
 296
 297 %t is the title.
 298 %a is the author.
 299 %d is the date formatted using `org-publish-sitemap-date-format'."
 300   :group 'org-export-publish
 301   :type 'string)
 302 (make-obsolete-variable
 303  'org-publish-sitemap-file-entry-format
 304  "set `:sitemap-format-entry' in `org-publish-project-alist' instead."
 305  "Org 9.1")
 306
 307 (defvar org-agenda-skip-regexp)
 308 (defun org-agenda-skip-entry-when-regexp-matches ()
 309   "Check if the current entry contains match for `org-agenda-skip-regexp'.
 310 If yes, it returns the end position of this entry, causing agenda commands
 311 to skip the entry but continuing the search in the subtree.  This is a
 312 function that can be put into `org-agenda-skip-function' for the duration
 313 of a command."
 314   (declare (obsolete "use `org-agenda-skip-if' instead." "Org 9.1"))
 315   (let ((end (save-excursion (org-end-of-subtree t)))
 316         skip)
 317     (save-excursion
 318       (setq skip (re-search-forward org-agenda-skip-regexp end t)))
 319     (and skip end)))
 320
 321 (defun org-agenda-skip-subtree-when-regexp-matches ()
 322   "Check if the current subtree contains match for `org-agenda-skip-regexp'.
 323 If yes, it returns the end position of this tree, causing agenda commands
 324 to skip this subtree.  This is a function that can be put into
 325 `org-agenda-skip-function' for the duration of a command."
 326   (declare (obsolete "use `org-agenda-skip-if' instead." "Org 9.1"))
 327   (let ((end (save-excursion (org-end-of-subtree t)))
 328         skip)
 329     (save-excursion
 330       (setq skip (re-search-forward org-agenda-skip-regexp end t)))
 331     (and skip end)))
 332
 333 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
 334   "Check if the current subtree contains match for `org-agenda-skip-regexp'.
 335 If yes, it returns the end position of the current entry (NOT the tree),
 336 causing agenda commands to skip the entry but continuing the search in
 337 the subtree.  This is a function that can be put into
 338 `org-agenda-skip-function' for the duration of a command.  An important
 339 use of this function is for the stuck project list."
 340   (declare (obsolete "use `org-agenda-skip-if' instead." "Org 9.1"))
 341   (let ((end (save-excursion (org-end-of-subtree t)))
 342         (entry-end (save-excursion (outline-next-heading) (1- (point))))
 343         skip)
 344     (save-excursion
 345       (setq skip (re-search-forward org-agenda-skip-regexp end t)))
 346     (and skip entry-end)))
 347
 348 (define-obsolete-function-alias 'org-minutes-to-clocksum-string
 349   'org-duration-from-minutes "Org 9.1")
 350
 351 (define-obsolete-function-alias 'org-hh:mm-string-to-minutes
 352   'org-duration-to-minutes "Org 9.1")
 353
 354 (define-obsolete-function-alias 'org-duration-string-to-minutes
 355   'org-duration-to-minutes "Org 9.1")
 356
 357 (make-obsolete-variable 'org-time-clocksum-format
 358   "set `org-duration-format' instead." "Org 9.1")
 359
 360 (make-obsolete-variable 'org-time-clocksum-use-fractional
 361   "set `org-duration-format' instead." "Org 9.1")
 362
 363 (make-obsolete-variable 'org-time-clocksum-fractional-format
 364   "set `org-duration-format' instead." "Org 9.1")
 365
 366 (make-obsolete-variable 'org-time-clocksum-use-effort-durations
 367   "set `org-duration-units' instead." "Org 9.1")
 368
 369 (define-obsolete-function-alias 'org-babel-number-p
 370   'org-babel--string-to-number "Org 9.0")
 371
 372 (define-obsolete-variable-alias 'org-usenet-links-prefer-google
 373   'org-gnus-prefer-web-links "Org 9.1")
 374
 375 (define-obsolete-variable-alias 'org-texinfo-def-table-markup
 376   'org-texinfo-table-default-markup "Org 9.1")
 377
 378
 379 ;;;; Obsolete link types
 380
 381 (eval-after-load 'org
 382   '(progn
 383      (org-link-set-parameters "file+emacs") ;since Org 9.0
 384      (org-link-set-parameters "file+sys"))) ;since Org 9.0
 385
 386
 387 \f
 388 ;;; Miscellaneous functions
 389
 390 (defun org-version-check (version feature level)
 391   (let* ((v1 (mapcar 'string-to-number (split-string version "[.]")))
 392          (v2 (mapcar 'string-to-number (split-string emacs-version "[.]")))
 393          (rmaj (or (nth 0 v1) 99))
 394          (rmin (or (nth 1 v1) 99))
 395          (rbld (or (nth 2 v1) 99))
 396          (maj (or (nth 0 v2) 0))
 397          (min (or (nth 1 v2) 0))
 398          (bld (or (nth 2 v2) 0)))
 399     (if (or (< maj rmaj)
 400             (and (= maj rmaj)
 401                  (< min rmin))
 402             (and (= maj rmaj)
 403                  (= min rmin)
 404                  (< bld rbld)))
 405         (if (eq level :predicate)
 406             ;; just return if we have the version
 407             nil
 408           (let ((msg (format "Emacs %s or greater is recommended for %s"
 409                              version feature)))
 410             (display-warning 'org msg level)
 411             t))
 412       t)))
 413
 414 (defun org-get-x-clipboard (value)
 415   "Get the value of the X or Windows clipboard."
 416   (cond ((and (eq window-system 'x)
 417               (fboundp 'gui-get-selection)) ;Silence byte-compiler.
 418          (org-no-properties
 419           (ignore-errors
 420             (or (gui-get-selection value 'UTF8_STRING)
 421                 (gui-get-selection value 'COMPOUND_TEXT)
 422                 (gui-get-selection value 'STRING)
 423                 (gui-get-selection value 'TEXT)))))
 424         ((and (eq window-system 'w32) (fboundp 'w32-get-clipboard-data))
 425          (w32-get-clipboard-data))))
 426
 427 (defun org-add-props (string plist &rest props)
 428   "Add text properties to entire string, from beginning to end.
 429 PLIST may be a list of properties, PROPS are individual properties and values
 430 that will be added to PLIST.  Returns the string that was modified."
 431   (add-text-properties
 432    0 (length string) (if props (append plist props) plist) string)
 433   string)
 434 (put 'org-add-props 'lisp-indent-function 2)
 435
 436 (defun org-fit-window-to-buffer (&optional window max-height min-height
 437                                            shrink-only)
 438   "Fit WINDOW to the buffer, but only if it is not a side-by-side window.
 439 WINDOW defaults to the selected window.  MAX-HEIGHT and MIN-HEIGHT are
 440 passed through to `fit-window-to-buffer'.  If SHRINK-ONLY is set, call
 441 `shrink-window-if-larger-than-buffer' instead, the height limit is
 442 ignored in this case."
 443   (cond ((if (fboundp 'window-full-width-p)
 444              (not (window-full-width-p window))
 445            ;; do nothing if another window would suffer
 446            (> (frame-width) (window-width window))))
 447         ((and (fboundp 'fit-window-to-buffer) (not shrink-only))
 448          (fit-window-to-buffer window max-height min-height))
 449         ((fboundp 'shrink-window-if-larger-than-buffer)
 450          (shrink-window-if-larger-than-buffer window)))
 451   (or window (selected-window)))
 452
 453 ;; `set-transient-map' is only in Emacs >= 24.4
 454 (defalias 'org-set-transient-map
 455   (if (fboundp 'set-transient-map)
 456       'set-transient-map
 457     'set-temporary-overlay-map))
 458
 459 ;;; Region compatibility
 460
 461 (defvar org-ignore-region nil
 462   "Non-nil means temporarily disable the active region.")
 463
 464 (defun org-region-active-p ()
 465   "Non-nil when the region active.
 466 Unlike to `use-region-p', this function also checks
 467 `org-ignore-region'."
 468   (and (not org-ignore-region) (use-region-p)))
 469
 470 (defun org-cursor-to-region-beginning ()
 471   (when (and (org-region-active-p)
 472              (> (point) (region-beginning)))
 473     (exchange-point-and-mark)))
 474
 475 ;;; Invisibility compatibility
 476
 477 (defun org-remove-from-invisibility-spec (arg)
 478   "Remove elements from `buffer-invisibility-spec'."
 479   (if (fboundp 'remove-from-invisibility-spec)
 480       (remove-from-invisibility-spec arg)
 481     (if (consp buffer-invisibility-spec)
 482         (setq buffer-invisibility-spec
 483               (delete arg buffer-invisibility-spec)))))
 484
 485 (defun org-in-invisibility-spec-p (arg)
 486   "Is ARG a member of `buffer-invisibility-spec'?"
 487   (if (consp buffer-invisibility-spec)
 488       (member arg buffer-invisibility-spec)))
 489
 490 (defun org-move-to-column (column &optional force _buffer)
 491   "Move to column COLUMN.
 492 Pass COLUMN and FORCE to `move-to-column'."
 493   (let ((buffer-invisibility-spec
 494          (if (listp buffer-invisibility-spec)
 495              (remove '(org-filtered) buffer-invisibility-spec)
 496            buffer-invisibility-spec)))
 497     (move-to-column column force)))
 498
 499 (defmacro org-find-library-dir (library)
 500   `(file-name-directory (or (locate-library ,library) "")))
 501
 502 (defun org-count-lines (s)
 503   "How many lines in string S?"
 504   (let ((start 0) (n 1))
 505     (while (string-match "\n" s start)
 506       (setq start (match-end 0) n (1+ n)))
 507     (if (and (> (length s) 0) (= (aref s (1- (length s))) ?\n))
 508         (setq n (1- n)))
 509     n))
 510
 511 (defun org-kill-new (string &rest args)
 512   (remove-text-properties 0 (length string) '(line-prefix t wrap-prefix t)
 513                           string)
 514   (apply 'kill-new string args))
 515
 516 ;; `font-lock-ensure' is only available from 24.4.50 on
 517 (defalias 'org-font-lock-ensure
 518   (if (fboundp 'font-lock-ensure)
 519       #'font-lock-ensure
 520     (lambda (&optional _beg _end)
 521       (with-no-warnings (font-lock-fontify-buffer)))))
 522
 523 ;; `file-local-name' was added in Emacs 26.1.
 524 (defalias 'org-babel-local-file-name
 525   (if (fboundp 'file-local-name)
 526       'file-local-name
 527     (lambda (file)
 528       "Return the local name component of FILE."
 529       (or (file-remote-p file 'localname) file))))
 530
 531 (defmacro org-no-popups (&rest body)
 532   "Suppress popup windows.
 533 Let-bind some variables to nil around BODY to achieve the desired
 534 effect, which variables to use depends on the Emacs version."
 535   (if (org-version-check "24.2.50" "" :predicate)
 536       `(let (pop-up-frames display-buffer-alist)
 537          ,@body)
 538     `(let (pop-up-frames special-display-buffer-names special-display-regexps special-display-function)
 539        ,@body)))
 540
 541 ;;;###autoload
 542 (defmacro org-check-version ()
 543   "Try very hard to provide sensible version strings."
 544   (let* ((org-dir        (org-find-library-dir "org"))
 545          (org-version.el (concat org-dir "org-version.el"))
 546          (org-fixup.el   (concat org-dir "../mk/org-fixup.el")))
 547     (if (require 'org-version org-version.el 'noerror)
 548         '(progn
 549            (autoload 'org-release     "org-version.el")
 550            (autoload 'org-git-version "org-version.el"))
 551       (if (require 'org-fixup org-fixup.el 'noerror)
 552           '(org-fixup)
 553         ;; provide fallback definitions and complain
 554         (warn "Could not define org version correctly.  Check installation!")
 555         '(progn
 556            (defun org-release () "N/A")
 557            (defun org-git-version () "N/A !!check installation!!"))))))
 558
 559 (defmacro org-with-silent-modifications (&rest body)
 560   (if (fboundp 'with-silent-modifications)
 561       `(with-silent-modifications ,@body)
 562     `(org-unmodified ,@body)))
 563 (def-edebug-spec org-with-silent-modifications (body))
 564
 565 ;; Functions for Emacs < 24.4 compatibility
 566 (defun org-define-error (name message)
 567   "Define NAME as a new error signal.
 568 MESSAGE is a string that will be output to the echo area if such
 569 an error is signaled without being caught by a `condition-case'.
 570 Implements `define-error' for older emacsen."
 571   (if (fboundp 'define-error) (define-error name message)
 572     (put name 'error-conditions
 573          (copy-sequence (cons name (get 'error 'error-conditions))))))
 574
 575 (unless (fboundp 'string-suffix-p)
 576   ;; From Emacs subr.el.
 577   (defun string-suffix-p (suffix string  &optional ignore-case)
 578     "Return non-nil if SUFFIX is a suffix of STRING.
 579 If IGNORE-CASE is non-nil, the comparison is done without paying
 580 attention to case differences."
 581     (let ((start-pos (- (length string) (length suffix))))
 582       (and (>= start-pos 0)
 583            (eq t (compare-strings suffix nil nil
 584                                   string start-pos nil ignore-case))))))
 585
 586 (provide 'org-compat)
 587
 588 ;;; org-compat.el ends here