Temp. include org-checklist.el and ol-notmuch.el from Org 9.4.4

3 files changed, 300 insertions, 0 deletions

diff --git a/debian/changelog b/debian/changelog
index 3f9658b5e75..4a2a5b3bbf3 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,6 +1,11 @@
 emacs-snapshot (28~git20210119.1) UNRELEASED; urgency=medium
 
   * Package git snapshot.
+  * Temporarily include org-checklist.el and ol-notmuch.el from Org-mode's
+    9.4.4 release.
+    Debian's Org-mode package fails to bytecompile against Emacs 28 atm,
+    so rely on the version of Org bundled with Emacs, plus these two
+    contrib files.
 
  -- Sean Whitton <spwhitton@spwhitton.name>  Tue, 19 Jan 2021 14:21:45 -0700
 
diff --git a/lisp/org/ol-notmuch.el b/lisp/org/ol-notmuch.el
new file mode 100644
index 00000000000..0fa0c5a2cbc
--- /dev/null
+++ b/lisp/org/ol-notmuch.el
@@ -0,0 +1,154 @@
+;;; ol-notmuch.el --- Links to notmuch messages
+
+;; Copyright (C) 2010-2014  Matthieu Lemerre
+
+;; Author: Matthieu Lemerre <racin@free.fr>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: https://orgmode.org
+
+;; This file is not part of GNU Emacs.
+
+;; This file is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 2, or (at your option)
+;; any later version.
+
+;; This file is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This file implements links to notmuch messages and "searches". A
+;; search is a query to be performed by notmuch; it is the equivalent
+;; to folders in other mail clients. Similarly, mails are referred to
+;; by a query, so both a link can refer to several mails.
+
+;; Links have one the following form
+;; notmuch:<search terms>
+;; notmuch-search:<search terms>.
+
+;; The first form open the queries in notmuch-show mode, whereas the
+;; second link open it in notmuch-search mode. Note that queries are
+;; performed at the time the link is opened, and the result may be
+;; different from when the link was stored.
+
+;;; Code:
+
+(require 'ol)
+
+;; customisable notmuch open functions
+(defcustom org-notmuch-open-function
+  'org-notmuch-follow-link
+  "Function used to follow notmuch links.
+
+Should accept a notmuch search string as the sole argument."
+  :group 'org-notmuch
+  :version "24.4"
+  :package-version '(Org . "8.0")
+  :type 'function)
+
+(defcustom org-notmuch-search-open-function
+  'org-notmuch-search-follow-link
+  "Function used to follow notmuch-search links.
+Should accept a notmuch search string as the sole argument."
+  :group 'org-notmuch
+  :version "24.4"
+  :package-version '(Org . "8.0")
+  :type 'function)
+
+(make-obsolete-variable 'org-notmuch-search-open-function nil "9.3")
+
+
+
+;; Install the link type
+(org-link-set-parameters "notmuch"
+			 :follow #'org-notmuch-open
+			 :store #'org-notmuch-store-link)
+
+(defun org-notmuch-store-link ()
+  "Store a link to a notmuch search or message."
+  (when (memq major-mode '(notmuch-show-mode notmuch-tree-mode))
+    (let* ((message-id (notmuch-show-get-message-id t))
+	   (subject (notmuch-show-get-subject))
+	   (to (notmuch-show-get-to))
+	   (from (notmuch-show-get-from))
+	   (date (org-trim (notmuch-show-get-date)))
+	   desc link)
+      (org-link-store-props :type "notmuch" :from from :to to :date date
+       			    :subject subject :message-id message-id)
+      (setq desc (org-link-email-description))
+      (setq link (concat "notmuch:id:" message-id))
+      (org-link-add-props :link link :description desc)
+      link)))
+
+(defun org-notmuch-open (path _)
+  "Follow a notmuch message link specified by PATH."
+  (funcall org-notmuch-open-function path))
+
+(defun org-notmuch-follow-link (search)
+  "Follow a notmuch link to SEARCH.
+
+Can link to more than one message, if so all matching messages are shown."
+  (require 'notmuch)
+  (notmuch-show search))
+
+
+
+(org-link-set-parameters "notmuch-search"
+			 :follow #'org-notmuch-search-open
+			 :store #'org-notmuch-search-store-link)
+
+(defun org-notmuch-search-store-link ()
+  "Store a link to a notmuch search or message."
+  (when (eq major-mode 'notmuch-search-mode)
+    (let ((link (concat "notmuch-search:" notmuch-search-query-string))
+	  (desc (concat "Notmuch search: " notmuch-search-query-string)))
+      (org-link-store-props :type "notmuch-search"
+			    :link link
+			    :description desc)
+      link)))
+
+(defun org-notmuch-search-open (path _)
+  "Follow a notmuch message link specified by PATH."
+  (message "%s" path)
+  (org-notmuch-search-follow-link path))
+
+(defun org-notmuch-search-follow-link (search)
+  "Follow a notmuch link by displaying SEARCH in notmuch-search mode."
+  (require 'notmuch)
+  (notmuch-search search))
+
+
+
+(org-link-set-parameters "notmuch-tree"
+			 :follow #'org-notmuch-tree-open
+			 :store #'org-notmuch-tree-store-link)
+
+(defun org-notmuch-tree-store-link ()
+  "Store a link to a notmuch search or message."
+  (when (eq major-mode 'notmuch-tree-mode)
+    (let ((link (concat "notmuch-tree:" (notmuch-tree-get-query)))
+	  (desc (concat "Notmuch tree: " (notmuch-tree-get-query))))
+      (org-link-store-props :type "notmuch-tree"
+			    :link link
+			    :description desc)
+      link)))
+
+(defun org-notmuch-tree-open (path _)
+  "Follow a notmuch message link specified by PATH."
+  (message "%s" path)
+  (org-notmuch-tree-follow-link path))
+
+(defun org-notmuch-tree-follow-link (search)
+  "Follow a notmuch link by displaying SEARCH in notmuch-tree mode."
+  (require 'notmuch)
+  (notmuch-tree search))
+
+(provide 'ol-notmuch)
+
+;;; ol-notmuch.el ends here
diff --git a/lisp/org/org-checklist.el b/lisp/org/org-checklist.el
new file mode 100644
index 00000000000..2bc00c0b9d1
--- /dev/null
+++ b/lisp/org/org-checklist.el
@@ -0,0 +1,141 @@
+;;; org-checklist.el --- org functions for checklist handling
+
+;; Copyright (C) 2008-2014 James TD Smith
+
+;; Author: James TD Smith (@ ahktenzero (. mohorovi cc))
+;; Version: 1.0
+;; Keywords: org, checklists
+;;
+;; This file is not part of GNU Emacs.
+;;
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This file provides some functions for handing repeated tasks which involve
+;; checking off a list of items. By setting the RESET_CHECK_BOXES property in an
+;; item, when the TODO state is set to done all checkboxes under that item are
+;; cleared. If the LIST_EXPORT_BASENAME property is set, a file will be created
+;; using the value of that property plus a timestamp, containing all the items
+;; in the list which are not checked. Additionally the user will be prompted to
+;; print the list.
+;;
+;; I use this for to keep track of stores of various things (food stores,
+;; components etc) which I check periodically and use the exported list of items
+;; which are not present as a shopping list.
+;;
+;;; Usage:
+;; (require 'org-checklist)
+;;
+;; Set the RESET_CHECK_BOXES and LIST_EXPORT_BASENAME properties in items as
+;; needed.
+;;
+;;; Code:
+(require 'org)
+(load "a2ps-print" 'no-error)
+
+(setq org-default-properties (cons "RESET_CHECK_BOXES" (cons "LIST_EXPORT_BASENAME" org-default-properties)))
+
+(defgroup org-checklist nil
+  "Extended checklist handling for org"
+  :tag "Org-checklist"
+  :group 'org)
+
+(defcustom org-checklist-export-time-format "%Y%m%d%H%M"
+  "The format of timestamp appended to LIST_EXPORT_BASENAME to
+  make the name of the export file."
+  :link '(function-link format-time-string)
+  :group 'org-checklist
+  :type 'string)
+
+(defcustom org-checklist-export-function 'org-export-as-ascii
+  "function used to prepare the export file for printing"
+  :group 'org-checklist
+  :type '(radio (function-item :tag "ascii text" org-export-as-ascii)
+		(function-item :tag "HTML"  org-export-as-html)
+		(function-item :tag "LaTeX" :value org-export-as-latex)
+		(function-item :tag "XOXO" :value org-export-as-xoxo)))
+
+(defcustom org-checklist-export-params nil
+  "options for the export function file for printing"
+  :group 'org-checklist
+  :type '(repeat string))
+
+(defcustom org-checklist-a2ps-params nil
+  "options for a2ps for printing"
+  :group 'org-checklist
+  :type '(repeat string))
+
+(defun org-reset-checkbox-state-maybe ()
+  "Reset all checkboxes in an entry if the `RESET_CHECK_BOXES' property is set"
+  (interactive "*")
+  (if (org-entry-get (point) "RESET_CHECK_BOXES")
+      (org-reset-checkbox-state-subtree)))
+
+
+(defun org-make-checklist-export ()
+  "Produce a checklist containing all unchecked items from a list
+of checkbox items"
+  (interactive "*")
+  (if (org-entry-get (point) "LIST_EXPORT_BASENAME")
+      (let* ((export-file (concat (org-entry-get (point) "LIST_EXPORT_BASENAME" nil)
+				  "-" (format-time-string
+				       org-checklist-export-time-format)
+				  ".org"))
+	     (print (case (org-entry-get (point) "PRINT_EXPORT" nil)
+		      (("" "nil" nil) nil)
+		      (t t)
+		      (nil (y-or-n-p "Print list? "))))
+	     exported-lines
+	     (title "Checklist export"))
+	(save-restriction
+	  (save-excursion
+	    (org-narrow-to-subtree)
+	    (org-update-checkbox-count-maybe)
+	    (org-show-subtree)
+	    (goto-char (point-min))
+	    (when (looking-at org-complex-heading-regexp)
+	      (setq title (match-string 4)))
+	    (goto-char (point-min))
+	    (let ((end (point-max)))
+	      (while (< (point) end)
+		(when (and (org-at-item-checkbox-p)
+			   (or (string= (match-string 0) "[ ]")
+			       (string= (match-string 0) "[-]")))
+		  (add-to-list 'exported-lines (thing-at-point 'line) t))
+		(beginning-of-line 2)))
+	    (set-buffer (get-buffer-create export-file))
+	    (org-insert-heading)
+	    (insert (or title export-file) "\n")
+	    (dolist (entry exported-lines) (insert entry))
+	    (org-update-checkbox-count-maybe)
+	    (write-file export-file)
+	    (if (print)
+		(progn (funcall org-checklist-export-function
+				org-checklist-export-params)
+		       (let* ((current-a2ps-switches a2ps-switches)
+			      (a2ps-switches (append current-a2ps-switches
+						     org-checklist-a2ps-params)))
+			 (a2ps-buffer)))))))))
+
+(defun org-checklist ()
+  (when (member org-state org-done-keywords) ;; org-state dynamically bound in org.el/org-todo
+    (org-make-checklist-export)
+    (org-reset-checkbox-state-maybe)))
+
+(add-hook 'org-after-todo-state-change-hook 'org-checklist)
+
+(provide 'org-checklist)
+
+;;; org-checklist.el ends here