diff options
Diffstat (limited to 'contrib/lisp/org-index.el')
| -rw-r--r-- | contrib/lisp/org-index.el | 2647 |
1 files changed, 1578 insertions, 1069 deletions
diff --git a/contrib/lisp/org-index.el b/contrib/lisp/org-index.el index aee0bac..31b675e 100644 --- a/contrib/lisp/org-index.el +++ b/contrib/lisp/org-index.el @@ -1,9 +1,9 @@ -;;; org-index.el --- A personal index for org and beyond +;;; org-index.el --- A personal adaptive index for org ;; Copyright (C) 2011-2016 Free Software Foundation, Inc. ;; Author: Marc Ihm <org-index@2484.de> -;; Version: 4.2.1 +;; Version: 5.1.3 ;; Keywords: outlines index ;; This file is not part of GNU Emacs. @@ -27,88 +27,113 @@ ;; Purpose: ;; -;; Fast search for selected org headings and things outside of org. +;; Fast search for selected org nodes and things outside of org. ;; -;; This package creates and updates an index table of headings or -;; keywords, references and ids, where each line points to a heading -;; within org or references something outside. This table is sorted by -;; usage count, so that frequently used lines appear among the first -;; search results. +;; org-index creates and updates an index table with keywords; each line +;; either points to a heading in org, references something outside or +;; carries a snippet of text to yank. When searching the index, the set +;; of matching lines is updated with every keystroke; results are sorted +;; by usage count and date, so that frequently used entries appear first +;; in the list of results. ;; -;; References are essentially small numbers (e.g. 'R237' or '--455--'), as -;; created by this package; they are well suited to be used outside of -;; org, e.g. in folder names, issue trackers or on printed documents. +;; References are decorated numbers (e.g. 'R237' or '--455--'); they are +;; well suited to be used outside of org, e.g. in folder names, ticket +;; systems or on printed documents. ;; -;; On first invocation org-index will guide you to create a dedicated node -;; for its index table and its configuration flags. +;; On first invocation org-index will assist you in creating the index +;; table. ;; -;; For basic usage, subcommands 'add' and 'occur' are most important. +;; To start using your index, invoke subcommands 'add', 'ref' and 'yank' +;; to create entries and 'occur' to find them. ;; ;; ;; Setup: ;; +;; - Place this file in a directory from your load-path, +;; e.g. org-mode/contrib/lisp. +;; ;; - Add these lines to your .emacs: ;; ;; (require 'org-index) -;; (org-index-default-keybindings) ; optional +;; (global-set-key (kbd "C-c i") 'org-index-dispatch) ; this is optional ;; ;; - Restart your Emacs to make these lines effective. ;; -;; - Invoke `org-index', which will assist in creating your index -;; table. The variable org-index-id will be persisted within your -;; customization file (typically .emacs). +;; - Invoke `org-index'; on first run it will assist in creating your +;; index table. +;; +;; - Optionally invoke `M-x org-customize' to tune some settings (choose +;; group org-index). +;; ;; +;; Further information: ;; -;; Further reading: +;; - Watch the screencast at http://2484.de/org-index.html. ;; -;; See the documentation of `org-index', which can also be read -;; by invoking `org-index' and choosing the help-command. +;; - See the documentation of `org-index', which can also be read by +;; invoking `org-index' and choosing the command help or '?'. ;; ;; ;; Updates: ;; -;; The latest tested version of this file can always be found at: +;; The latest published version of this file can always be found at: +;; +;; http://orgmode.org/w/?p=org-mode.git;a=blob_plain;f=contrib/lisp/org-index.el;hb=HEAD +;; +;; Development version under: ;; -;; http://orgmode.org/cgit.cgi/org-mode.git/plain/contrib/lisp/org-index.el +;; https://github.com/marcIhm/org-index ;;; Change Log: +;; [2016-08-26 Fr] Version 5.1.3 +;; - Offering help during query for subcommands +;; - Removed org-index-default-keybindings +;; - Renamed subcommand multi-occur to find-ref +;; - Subcommands add and need no longer be invoked from heading +;; - Many Bugfixes +;; +;; [2015-12-29 Tu] Version 5.0.2 +;; - New commands yank, column and edit +;; - New column tags +;; - All columns are now required +;; - References are now optional +;; - Subcommand enter has been renamed to index +;; - Subcommands kill and edit can be invoked from an occur buffer +;; - Many Bugfixes +;; - Added link to screencast +;; +;; [2015-08-20 Th] Version 4.3.0 +;; - Configuration is done now via standard customize +;; - New sorting strategy 'mixed' +;; - Silenced some compiler warnings +;; ;; [2015-03-18 We] Version 4.2.1 ;; - No garbage in kill-ring ;; - No recentering after add ;; ;; [2015-03-08 Su] Version 4.2.0 ;; - Reference numbers for subcommands can be passed as a prefix argument -;; - Renamed subcommand 'point' to 'ping' ;; - New variable org-index-default-keybindings-list with a list of ;; default keybindings for org-index-default-keybindings ;; - Added new column level ;; - removed flags get-category-on-add and get-heading-on-add ;; -;; [2015-03-05 Th] Version 4.1.1 and 4.1.2 -;; - org-mark-ring is now used more consistently -;; - Bugfix when going to a heading by ref -;; -;; [2015-02-26 Th] Version 4.0.0 and 4.1.0: +;; [2015-02-26 Th] to [2015-03-05 Th] Version 4.0.0 to 4.1.2 ;; - Removed command "leave"; rather go back with org-mark-ring-goto -;; - Property "org-index-ref" is no longer used or needed ;; - Renamed column "link" to "id" ;; - Added maintainance options to find duplicate rows, to check ids, ;; update index or remove property org-index-ref from nodes -;; - New command point ;; - Shortened versin history ;; -;; [2014-12-07 Sa] to [2015-01-31 Sa] Version 3.0.0 to 3.2.0: +;; [2014-12-08 Mo] to [2015-01-31 Sa] Version 3.0.0 to 3.2.0: ;; - Complete sorting of index only occurs in idle-timer ;; - New command "maintain" with some subcommands ;; - Rewrote command "occur" with overlays in an indirect buffer -;; - introduced variable org-index-version ;; - Command "add" updates index, if node is already present ;; - New commands "add" and "delete" to easily add and remove ;; the current node to or from your index. ;; - New command "example" to create an example index. -;; - Moved flags to a list within the same node as the index table; -;; this breaks compatibility to prior versions of the package. ;; - Several new flags that are explained within index node. ;; - Removed commands "reuse", "missing", "put", "goto", ;; "update", "link", "fill", "unhighlight" @@ -139,97 +164,150 @@ ;;; Code: (require 'org-table) -(require 'cl) +(require 'cl-lib) +(require 'widget) + +;; Version of this package +(defvar org-index-version "5.1.3" "Version of `org-index', format is major.minor.bugfix, where \"major\" are incompatible changes and \"minor\" are new features.") + +;; customizable options +(defgroup org-index nil + "Options concerning the optional index for org." + :tag "Org Index" + :group 'org) (defcustom org-index-id nil "Id of the Org-mode node, which contains the index table." - :group 'org :group 'org-index) -;; Version of this package -(defvar org-index-version "4.2.1" "Version of `org-index', format is major.minor.bugfix, where \"major\" is a change in index-table and \"minor\" are new features.") +(defcustom org-index-sort-by 'mixed + "Strategy for sorting index table (and whence entries in occur). +Valid values are: + +last-access Sort index by date and time of last access; show + more recent entries first. +count Sort by usage count; more often used entries first. +mixed First, show all index entries, which have been + used today; sort them by last access. Then show + older entries sorted by usage count." + :group 'org-index + :set (lambda (s v) + (set-default s v) + (if (and org-index-id + org-index--buffer + (functionp 'org-index--sort-silent)) + (org-index--sort-silent))) + :initialize 'custom-initialize-default + :type '(choice + (const last-accessed) + (const count) + (const mixed))) + +(defcustom org-index-yank-after-add 'ref + "Specifies which column should be yanked after adding a new index row. +Valid values are some columns of index table." + :group 'org-index + :type '(choice + (const ref) + (const category) + (const keywords))) + +(defcustom org-index-point-on-add 'keywords + "Specifies in which column point will land when adding a new index row. +Valid values are some columns of index table." + :group 'org-index + :type '(choice + (const category) + (const keywords))) + +(defcustom org-index-copy-heading-to-keywords t + "When adding a new node to index: Copy heading to keywords-column ?" + :group 'org-index + :type '(choice (const :tag "Yes" t) + (const :tag "No" nil))) + +(defcustom org-index-strip-ref-and-date-from-heading t + "When adding a node to index: strip leading ref or timestamps ? + +This can be useful, if you have the habit of adding refs and +dates to the start of your headings; then, if you change your +heading and want to update your index, you do not need to remove +those pieces." + :group 'org-index + :type '(choice (const :tag "Yes" t) + (const :tag "No" nil))) + +(defcustom org-index-edit-on-add '(category keywords) + "List of columns to edit when adding a new row." + :group 'org-index + :type '(repeat (choice + (const category) + (const keywords)))) + +(defcustom org-index-edit-on-yank '(yank keywords) + "List of columns to edit when adding new text to yank." + :group 'org-index + :type '(repeat (choice + (const yank) + (const category) + (const keywords)))) + +(defcustom org-index-edit-on-ref '(category keywords) + "List of columns to edit when adding new ref." + :group 'org-index + :type '(repeat (choice + (const category) + (const keywords)))) ;; Variables to hold the configuration of the index table -(defvar org-index--maxref nil "Maximum number from reference table (e.g. '153').") -(defvar org-index--head nil "Any header before number (e.g. 'R').") +(defvar org-index--maxrefnum nil "Maximum number from reference table, e.g. 153.") +(defvar org-index--nextref nil "Next reference, that can be used, e.g. 'R154'.") +(defvar org-index--head nil "Header before number (e.g. 'R').") (defvar org-index--tail nil "Tail after number (e.g. '}' or ')'.") (defvar org-index--numcols nil "Number of columns in index table.") (defvar org-index--ref-regex nil "Regular expression to match a reference.") (defvar org-index--ref-format nil "Format, that can print a reference.") (defvar org-index--columns nil "Columns of index-table.") -(defvar org-index--special-columns nil "Columns with flags, that may appear only once.") -(defvar org-index--flagged-columns nil "Columns with flags, that may appear multiple times.") (defvar org-index--buffer nil "Buffer of index table.") (defvar org-index--point nil "Position at start of headline of index table.") (defvar org-index--below-hline nil "Position of first cell in first line below hline.") +(defvar org-index--saved-positions nil "Saved positions within current buffer and index buffer; filled by ‘org-index--save-positions’.") (defvar org-index--headings nil "Headlines of index-table as a string.") (defvar org-index--headings-visible nil "Visible part of headlines of index-table as a string.") -(defvar org-index--keymap nil "Keymap for shortcuts for some commands of `org-index'. Filled and activated by `org-index-default-keybings'.") ;; Variables to hold context and state -(defvar org-index--last-ref nil "Last reference created or visited.") +(defvar org-index--last-fingerprint nil "Fingerprint of last line created.") (defvar org-index--category-before nil "Category of node before.") (defvar org-index--active-region nil "Active region, initially. I.e. what has been marked.") (defvar org-index--below-cursor nil "Word below cursor.") -(defvar org-index--within-node nil "True, if we are within node of the index table.") +(defvar org-index--within-index-node nil "True, if we are within node of the index table.") +(defvar org-index--within-occur nil "True, if we are within the occur-buffer.") (defvar org-index--message-text nil "Text that was issued as an explanation; helpful for regression tests.") (defvar org-index--occur-help-text nil "Text for help in occur buffer.") (defvar org-index--occur-help-overlay nil "Overlay for help in occur buffer.") (defvar org-index--occur-stack nil "Stack with overlays for hiding lines.") (defvar org-index--occur-tail-overlay nil "Overlay to cover invisible lines.") +(defvar org-index--occur-lines-collected 0 "Number of lines collected in occur buffer; helpful for tests.") (defvar org-index--last-sort nil "Last column, the index has been sorted after.") (defvar org-index--sort-timer nil "Timer to sort index in correct order.") (defvar org-index--aligned nil "Remember for this Emacs session, if table has been aligned at least once.") +(defvar org-index--edit-widgets nil "List of widgets used to edit.") +(defvar org-index--context-index nil "Position and line used for index in edit buffer.") +(defvar org-index--context-occur nil "Position and line used for occur in edit buffer.") +(defvar org-index--context-node nil "Buffer and position for node in edit buffer.") +(defvar org-index--short-help-buffer-name "*org-index commands*" "Name of buffer to display short help.") +(defvar org-index--display-short-help nil "True, if short help should be displayed.") +(defvar org-index--short-help-displayed nil "True, if short help message has been displayed.") +(defvar org-index--minibuffer-saved-key nil "Temporarily save entry of minibuffer keymap.") ;; static information for this program package -(defconst org-index--commands '(occur add delete head ping enter ref help example sort multi-occur highlight maintain) "List of commands available.") -(defconst org-index--required-flags '(sort) "Flags that are required.") -(defconst org-index--single-flags '(sort point-on-add yank-after-add shift-ref-and-date-on-add) "Flags, that may only appear once; these can appear as special-columns.") -(defconst org-index--multiple-flags '(edit-on-add) "Flags, that might appear multiple times.") -(defconst org-index--all-flags (append org-index--single-flags org-index--multiple-flags) "All flags.") -(defconst org-index--required-headings '(ref id created last-accessed count) "All required headings.") -(defconst org-index--valid-headings (append org-index--required-headings '(keywords category level)) "All valid headings.") +(defconst org-index--commands '(occur add kill head ping index ref yank column edit help short-help example sort find-ref highlight maintain) "List of commands available.") +(defconst org-index--valid-headings '(ref id created last-accessed count keywords category level yank tags) "All valid headings.") (defconst org-index--occur-buffer-name "*org-index-occur*" "Name of occur buffer.") +(defconst org-index--edit-buffer-name "*org-index-edit*" "Name of edit buffer.") (defconst org-index--sort-idle-delay 300 "Delay in seconds after which buffer will sorted.") -(defvar org-index-default-keybindings-list '(("a" . 'add) ("i " . nil) ("o" . 'occur) ("a" . 'add) ("d" . 'delete) ("h" . 'head) ("e" . 'enter) ("p." . 'ping) ("r" . 'ref) ("?" . 'help)) "One-letter short cuts for selected subcommands of `org-index', put in effect by `org-index-default-keybindings'") -(defconst org-index--sample-flags -" - - columns-and-flags :: associate columns of index table with flags. Do not remove. - - ref - - yank-after-add - - category - - edit-on-add - - keywords - - edit-on-add - - point-on-add - - count - - sort - - last-accessed - - created - - id - - all-columns-explained :: All columns of the index table and their meaning. - - ref :: The reference number; will be generated automatically. - - id :: id of the node, that this line represents - - created :: When has this entry been created ? - - last-accessed :: When has this entry been accessed last ? - - count :: How many times has this entry been picked ? - - keywords :: Optional column, suggested to keep a list of keywords, - which may match your input during occur. While adding a line to your index, - this column will be filled with the nodes heading. - - category :: (optional) column to store the category of newly added nodes. - - level :: Nesting level of node - - Any name starting with a dot (`.') :: No predefined meaning, - depends on its flags. - - all-flags-explained :: All flags, that can be associated with columns. - - sort :: Sort whole table according to this column. - - yank-after-add :: This column will be yanked after picking this line during - occur. - - edit-on-add :: This field will be presented for editing, when adding - a new line to your index. - - point-on-add :: Point will land here, when adding a new line, e.g. with - command ref. - - shift-ref-and-date-on-add :: Remove leading reference and timestamp on add." -"A sample string of flags.") +(defvar org-index--short-help-text nil "Cache for result of `org-index--get-short-help-text.") +(defvar org-index--shortcut-chars nil "Cache for result of `org-index--get-shortcut-chars.") (defmacro org-index--on (column value &rest body) @@ -241,511 +319,559 @@ if VALUE cannot be found." (foundvar (make-symbol "found")) (retvar (make-symbol "ret"))) `(save-current-buffer - (set-buffer org-index--buffer) - (setq ,pointvar (point)) - (setq ,foundvar nil) - (setq ,retvar nil) + (let ((,pointvar (point)) + ,foundvar + ,retvar) + + (set-buffer org-index--buffer) + + (setq ,foundvar (org-index--go ,column ,value)) + (when ,foundvar + (setq ,retvar (progn ,@body))) + + (goto-char ,pointvar) - (setq ,foundvar (org-index--go ,column ,value)) - (when ,foundvar - (setq ,retvar (progn ,@body))) - - (goto-char ,pointvar) - - ,retvar))) + ,retvar)))) (defun org-index (&optional command search-ref arg) - "Fast search for selected org headings and things outside of org. + "Fast search-index for selected org nodes and things outside of org. -This package creates and updates an index table of headings or -keywords, references and ids, where each line points to a heading -within org or references something outside. This table is sorted by -usage count, so that frequently used lines appear among the first -search results. +org-index creates and updates an index table with keywords; each line +either points to a heading in org, references something outside or +carries a snippet of text to yank. The index table is searched for +keywords through an incremental occur; results are sorted by usage +count and date, so that frequently used entries appear first among +the results. -References are essentially small numbers (e.g. 'R237' or '--455--'), as -created by this package; they are well suited to be used outside of -org, e.g. in folder names, issue trackers or on printed documents. +References are decorated numbers (e.g. 'R237' or '--455--'); they are +well suited to be used outside of org, e.g. in folder names, ticket +systems or on printed documents. -On first invocation `org-index' will guide you to create a dedicated node -for its index table and its configuration flags. +On first invocation org-index will help to create a dedicated node +for its index table. -For basic usage, subcommands 'add' and 'occur' are most important. +To start building up your index, use subcommands 'add', 'ref' and +'yank' to create entries and use 'occur' to find them. -This is version 4.2.1 of org-index.el. -\\<org-mode-map> -The function `org-index' operates on a dedicated table, the index -table, which lives within its own Org-mode node. The table and -its containing node will be created, when you first invoke -`org-index'. The node also contains a commented list, describing -the columns of the index table and their associated flags. The -node is found through its id, which is stored within the variable -`org-index-id'. +This is version 5.1.3 of org-index.el. The function `org-index' is the only interactive function of this package and its main entry point; it will present you with a list of subcommands to choose from: - occur: Incremental search, that shows matching lines from the - index table. It is updated after every keystroke. You may - enter a list of words seperated by space or comma (`,'), to - select lines that contain all of the given words. +\(Note the one-letter shortcuts, e.g. [o]; used like 'C-c i o'.) - add: Add the current node to your index, so that it can be - found through the subcommand \"occur\". Update index, - if node has already been present. + occur: [o] Incrementally show matching lines from index. + Result is updated after every keystroke. You may enter a + list of words seperated by space or comma (`,'), to select + lines that contain all of the given words. - delete: Delete the current node from your index. + add: [a] Add the current node to index. + So that (e.g.) it can be found through the subcommand + 'occur'. Update index, if node is already present. - head: Ask for a reference number and search for this heading. + kill: [k] Kill (delete) the current node from index. + Can be invoked from index, from occur or from a headline. - enter: Enter index table and maybe go to a specific reference; - use `org-mark-ring-goto' (\\[org-mark-ring-goto]) to go back. + head: [h] Search for heading, by ref or from index line. + If invoked from within index table, go to associated + node (if any), otherwise ask for ref to search. - ping: Echo line from index table for current node or first of - its ancestor from index. + index: [i] Enter index table and maybe go to a specific reference. + Use `org-mark-ring-goto' (\\[org-mark-ring-goto]) to go back. - ref: Create a new reference. + ping: [p] Echo line from index table for current node. + If current node is not in index, than search among its + parents. - help: Show this text. + ref: [r] Create a new index line with a reference. + This line will not be associated with a node. - example: Create a temporary index, that will not be saved, but - may serve as an example. + yank: [y] Store a new string, that can be yanked from occur. + The index line will not be associated with a node. - sort: Sort lines in index, in region or buffer by contained - reference, or sort index by count, reference or last access. + column: [c] From within index table: read char and jump to column. + Shortcut for column movement; stays within one index line. - multi-occur: Apply Emacs standard `multi-occur' operation on all - `org-mode' buffers to search for the given reference. + edit: [e] Present current line in edit buffer. + Can be invoked from index, from occur or from a headline. - highlight: Highlight or unhiglight references in active region or buffer. - Call with prefix argument (`C-u') to remove highlights. + help: Show complete help text of org-index. - maintain: Offers some choices to check, update or fix your index. + short-help: [?] Show one-line description of each subcommand. + I.e. show this list but only first sentence each. + + example: Create an example index, that will not be saved. + May serve as an example. + + sort: Sort lines in index, in region or buffer. + Region or buffer can be sorted by contained reference; Index + by count, reference or last access. + + find-ref: Search for given reference in all org-buffers. + A wrapper to employ emacs standard `multi-occur' function; + asks for reference. + + highlight: Highlight or unhighlight all references. + Operates on active region or whole buffer. Call with prefix + argument (`C-u') to remove highlights. + + maintain: Index maintainance. + Offers some choices to check, update or fix your index. If you invoke `org-index' for the first time, an assistant will be -invoked, that helps you to create your own, commented index. +invoked, that helps you to create your own index. -Use `org-index-default-keybindings' to establish convenient -keyboard shortcuts. +Invoke `org-customize' to tweak the behaviour of org-index. -See the commented list of flags within your index node for ways to -modify the behaviour of org-index. +Optionally bind `org-index-dispatch' to a key, e.g. 'C-c i' in +the global keymap to invoke the most important subcommands with +a single key. A numeric prefix argument is used as a reference number for commands, that need one (e.g. 'head'). -Optional arguments for use from elisp: COMMAND is a symbol naming -the command to execute. SEARCH-REF specifies a reference to -search for, if needed. ARG allows passing in a prefix argument -as in interactive calls." +Use from elisp: Optional argument COMMAND is a symbol naming the +command to execute. SEARCH-REF specifies a reference to search +for, if needed. ARG allows passing in a prefix argument as in +interactive calls." (interactive "i\ni\nP") (let (search-id ; id to search for + search-fingerprint ; fingerprint to search for sort-what ; sort what ? kill-new-text ; text that will be appended to kill ring message-text) ; text that will be issued as an explanation + (catch 'new-index - ;; - ;; Initialize and parse - ;; + ;; + ;; Initialize and parse + ;; - ;; creates index table, if necessary - (org-index--verify-id) + ;; creates index table, if necessary + (org-index--verify-id) - ;; Get configuration of index table - (org-index--parse-table) + ;; Get configuration of index table + (org-index--parse-table) - ;; store context information - (org-index--retrieve-context) - - - ;; - ;; Arrange for proper sorting of index - ;; - - ;; lets assume, that it has been sorted this way (we try hard to make sure) - (unless org-index--last-sort (setq org-index--last-sort (org-index--special-column 'sort))) - ;; rearrange for index beeing sorted into default sort order after 300 secs of idle time - (unless org-index--sort-timer - (setq org-index--sort-timer - (run-with-idle-timer org-index--sort-idle-delay t 'org-index--sort-silent))) - - - ;; - ;; Find out, what we are supposed to do - ;; - - ;; check or read command - (if command - (unless (memq command org-index--commands) - (error "Unknown command '%s' passed as argument, valid choices are any of these symbols: %s" - command (mapconcat 'symbol-name org-index--commands ","))) - (setq command (intern (org-completing-read - "Please choose: " - (mapcar 'symbol-name org-index--commands))))) - - - ;; - ;; Get search string, if required; process possible sources one after - ;; another (lisp argument, prefix argumen, user input). - ;; - - ;; Try prefix, if no lisp argument given - (if (and (not search-ref) - (numberp arg)) - (setq search-ref (format "%s%d%s" org-index--head arg org-index--tail))) - - ;; These actions really need a search string and may even prompt for it - (when (memq command '(enter head multi-occur)) - - ;; search from surrounding text ? - (unless search-ref - (if org-index--within-node - - (if (org-at-table-p) - (setq search-ref (org-index--get-or-set-field 'ref))) - - (if (and org-index--below-cursor - (string-match (concat "\\(" org-index--ref-regex "\\)") - org-index--below-cursor)) - (setq search-ref (match-string 1 org-index--below-cursor))))) - - ;; If we still do not have a search string, ask user explicitly - (unless search-ref - (if (eq command 'enter) - (let ((r (org-index--read-search-for-enter))) - (setq search-ref (car r)) - (setq search-id (cdr r))) - (setq search-ref (read-from-minibuffer "Search reference number: ")))) - - ;; Clean up search string - (when search-ref - (setq search-ref (org-trim search-ref)) - (if (string-match "^[0-9]+$" search-ref) - (setq search-ref (concat org-index--head search-ref org-index--tail))) - (if (string= search-ref "") (setq search-ref nil))) + ;; store context information + (org-index--retrieve-context) - (if (and (not search-ref) - (not (eq command 'enter))) - (error "Command %s needs a reference number" command))) - - - ;; - ;; Command sort needs to know in advance, what to sort for - ;; - - (when (eq command 'sort) - (setq sort-what (intern (org-completing-read "You may sort:\n - index : your index table by various columns\n - region : the active region by contained reference\n - buffer : the whole current buffer\nPlease choose what to sort: " (list "index" "region" "buffer") nil t)))) - - - ;; - ;; Enter table - ;; - - ;; Arrange for beeing able to return - (when (and (memq command '(occur head enter ref example sort maintain)) - (not (string= (buffer-name) org-index--occur-buffer-name))) - (org-mark-ring-push)) - - ;; These commands will leave user in index table after they are finished - (when (or (memq command '(enter ref maintain)) - (and (eq command 'sort) - (eq sort-what 'index))) - (pop-to-buffer-same-window org-index--buffer) - (goto-char org-index--point) - (org-index--unfold-buffer)) + ;; + ;; Arrange for proper sorting of index + ;; + ;; lets assume, that it has been sorted this way (we try hard to make sure) + (unless org-index--last-sort (setq org-index--last-sort org-index-sort-by)) + ;; rearrange for index beeing sorted into default sort order after 300 secs of idle time + (unless org-index--sort-timer + (setq org-index--sort-timer + (run-with-idle-timer org-index--sort-idle-delay t 'org-index--sort-silent))) - ;; - ;; Actually do, what is requested - ;; - (cond + ;; + ;; Find out, what we are supposed to do + ;; + ;; Check or read command + (if (and command (not (eq command 'short-help))) + (unless (memq command org-index--commands) + (error "Unknown command '%s' passed as argument, valid choices are any of these symbols: %s" + command (mapconcat 'symbol-name org-index--commands ","))) - ((eq command 'help) + ;; read command; if requested display help in read-loop + (setq org-index--display-short-help (eq command 'short-help)) + (setq command (org-index--read-command)) + (setq org-index--display-short-help nil)) - ;; bring up help-buffer for this function - (describe-function 'org-index)) + ;; + ;; Get search string, if required; process possible sources one after + ;; another (lisp argument, prefix argument, user input). + ;; + + ;; Try prefix, if no lisp argument given + (if (and (not search-ref) + (numberp arg)) + (setq search-ref (format "%s%d%s" org-index--head arg org-index--tail))) + + ;; These actions really need a search string and may even prompt for it + (when (memq command '(index head find-ref)) + + ;; search from surrounding text ? + (unless search-ref + (if org-index--within-index-node + + (if (org-at-table-p) + (setq search-ref (org-index--get-or-set-field 'ref))) + + (if (and org-index--below-cursor + (string-match (concat "\\(" org-index--ref-regex "\\)") + org-index--below-cursor)) + (setq search-ref (match-string 1 org-index--below-cursor))))) + + ;; If we still do not have a search string, ask user explicitly + (unless search-ref + (if (eq command 'index) + (let ((r (org-index--read-search-for-index))) + (setq search-ref (first r)) + (setq search-id (second r)) + (setq search-fingerprint (third r))) + (unless (and (eq command 'head) + org-index--within-index-node + (org-at-table-p)) + (setq search-ref (read-from-minibuffer "Search reference number: "))))) + + ;; Clean up search string + (when search-ref + (setq search-ref (org-trim search-ref)) + (if (string-match "^[0-9]+$" search-ref) + (setq search-ref (concat org-index--head search-ref org-index--tail))) + (if (string= search-ref "") (setq search-ref nil))) + + (if (and (not search-ref) + (not (eq command 'index)) + (not (and (eq command 'head) + org-index--within-index-node + (org-at-table-p)))) + (error "Command %s needs a reference number" command))) + + + ;; + ;; Command sort needs to know in advance, what to sort for + ;; + + (when (eq command 'sort) + (setq sort-what (intern (org-completing-read "You may sort:\n - index : your index table by various columns\n - region : the active region by contained reference\n - buffer : the whole current buffer\nPlease choose what to sort: " (list "index" "region" "buffer") nil t)))) + + + ;; + ;; Enter table + ;; + + ;; Arrange for beeing able to return + (when (and (memq command '(occur head index example sort maintain)) + (not (string= (buffer-name) org-index--occur-buffer-name))) + (org-mark-ring-push)) + + ;; These commands will leave user in index table after they are finished + (when (or (memq command '(index maintain)) + (and (eq command 'sort) + (eq sort-what 'index))) + + (pop-to-buffer-same-window org-index--buffer) + (goto-char org-index--point) + (org-index--unfold-buffer)) + + + ;; + ;; Actually do, what is requested + ;; + (cond - ((eq command 'multi-occur) + ((eq command 'help) - ;; Construct list of all org-buffers - (let (buff org-buffers) - (dolist (buff (buffer-list)) - (set-buffer buff) - (if (string= major-mode "org-mode") - (setq org-buffers (cons buff org-buffers)))) + ;; bring up help-buffer for this function + (describe-function 'org-index)) - ;; Do multi-occur - (multi-occur org-buffers (org-index--make-guarded-search search-ref)) - ;; Present results - (if (get-buffer "*Occur*") - (progn - (setq message-text (format "multi-occur for '%s'" search-ref)) - (other-window 1) - (toggle-truncate-lines 1)) - (setq message-text (format "Did not find '%s'" search-ref))))) + ((eq command 'short-help) + (org-index--display-short-help)) - ((eq command 'add) - (let ((r (org-index--do-add-or-update))) - (setq message-text (car r)) - (setq kill-new-text (cdr r)))) + ((eq command 'find-ref) + ;; Construct list of all org-buffers + (let (org-buffers) + (dolist (buff (buffer-list)) + (set-buffer buff) + (if (string= major-mode "org-mode") + (setq org-buffers (cons buff org-buffers)))) - ((eq command 'delete) + ;; Do multi-occur + (multi-occur org-buffers (org-index--make-guarded-search search-ref)) - (setq message-text (org-index--do-delete))) + ;; Present results + (if (get-buffer "*Occur*") + (progn + (setq message-text (format "Found '%s'" search-ref)) + (other-window 1) + (toggle-truncate-lines 1)) + (setq message-text (format "Did not find '%s'" search-ref))))) - ((eq command 'head) + ((eq command 'add) - (if (and org-index--within-node - (org-at-table-p)) - (setq search-id (org-index--get-or-set-field 'id))) + (let ((r (org-index--do-add-or-update (if (equal arg '(4)) t nil) + (if (numberp arg) arg nil)))) + (setq message-text (car r)) + (setq kill-new-text (cdr r)))) - (setq search-id (or search-id (org-index--id-from-ref search-ref))) - (setq message-text - (if search-id - (org-index--do-head search-ref search-id) - (message "Current line has no id.")))) + ((eq command 'kill) + (setq message-text (org-index--do-kill))) - ((eq command 'enter) - (goto-char org-index--below-hline) + ((eq command 'head) - (setq message-text + (if (and org-index--within-index-node + (org-at-table-p)) + (setq search-id (org-index--get-or-set-field 'id))) - (if search-ref - (if (org-index--go 'ref search-ref) - (progn - (org-index--update-current-line) - (org-table-goto-column (org-index--column-num 'ref)) - (format "Found index line '%s'" search-ref)) - (format "Did not find index line with reference '%s'" search-ref)) + (if (and (not search-id) search-ref) + (setq search-id (org-index--id-from-ref search-ref))) + (setq message-text (if search-id - (if (org-index--go 'id search-id) + (org-index--find-id search-id) + "Current line has no id"))) + + + ((eq command 'index) + + (goto-char org-index--below-hline) + + (setq message-text + + (if search-ref + (if (org-index--go 'ref search-ref) (progn (org-index--update-current-line) (org-table-goto-column (org-index--column-num 'ref)) - (format "Found index line '%s'" (org-index--get-or-set-field 'ref))) - (format "Did not find index line with id '%s'" search-id)) + (format "Found index line '%s'" search-ref)) + (format "Did not find index line with reference '%s'" search-ref)) - ;; simply go into table - (setq message-text "At index table")))) + (if search-id + (if (org-index--go 'id search-id) + (progn + (org-index--update-current-line) + (org-table-goto-column (org-index--column-num 'ref)) + (format "Found index line '%s'" (org-index--get-or-set-field 'ref))) + (format "Did not find index line with id '%s'" search-id)) - (recenter)) + (if search-fingerprint + (if (org-index--go 'fingerprint org-index--last-fingerprint) + (progn + (org-index--update-current-line) + (beginning-of-line) + (format "Found latest index line")) + (format "Did not find index line")) + ;; simply go into table + "At index table")))) - ((eq command 'ping) + (recenter)) - (let ((moved-up 0) id info reached-top) - (unless (string= major-mode "org-mode") (error "No node at point")) - ;; take id from current node or reference - (setq id (if search-ref - (org-index--id-from-ref search-ref) - (org-id-get))) + ((eq command 'ping) - ;; move up until we find a node in index - (save-excursion - (outline-back-to-heading) - (while (not (or info - reached-top)) - (if id - (setq info (org-index--on 'id id - (mapcar (lambda (x) (org-index--get-or-set-field x)) - (list 'ref 'count 'created 'last-accessed 'category 'keywords 'ref))))) + (let ((moved-up 0) id info reached-top) - (setq reached-top (= (org-outline-level) 1)) + (unless (string= major-mode "org-mode") (error "No node at point")) + ;; take id from current node or reference + (setq id (if search-ref + (org-index--id-from-ref search-ref) + (org-id-get))) - (unless (or info - reached-top) - (outline-up-heading 1 t) - (incf moved-up)) + ;; move up until we find a node in index + (save-excursion + (outline-back-to-heading) + (while (not (or info + reached-top)) + (if id + (setq info (org-index--on 'id id + (mapcar (lambda (x) (org-index--get-or-set-field x)) + (list 'ref 'count 'created 'last-accessed 'category 'keywords 'ref))))) - (setq id (org-id-get)))) - - (if info - (progn - (setq message-text - (apply 'format - (append (list "'%s'%shas been accessed %s times between %s and %s; category is '%s', keywords are '%s'" - (pop info) - (if (> moved-up 0) (format " (parent node, %d level up) " moved-up) " ")) - info))) - (setq kill-new-text (car (last info)))) - (setq message-text "Neither this node nor any of its parents is part of index")))) - - - ((eq command 'occur) - - (set-buffer org-index--buffer) - (org-index--do-occur)) - - - ((eq command 'ref) - - (let (new) - - ;; add a new row - (setq new (org-index--create-new-line)) - - ;; fill special columns with standard values - (org-table-goto-column (org-index--column-num 'ref)) - (insert new) - (setq org-index--last-ref new) - - ;; goto point-field or first empty one or first field - (if (org-index--special-column 'point-on-add) - (org-table-goto-column (org-index--column-num (org-index--special-column 'point-on-add))) - (unless (catch 'empty - (dotimes (col org-index--numcols) - (org-table-goto-column (+ col 1)) - (if (string= (org-trim (org-table-get-field)) "") - (throw 'empty t)))) - ;; none found, goto first - (org-table-goto-column 1))) - - (if org-index--active-region (setq kill-new-text org-index--active-region)) - (setq message-text (format "Adding a new row with ref '%s'" new)))) - - - ((eq command 'sort) - - (let ((columns (list "ref" "count" "created" "last-accessed" "id")) - sort groups-and-counts) - - (cond - ((eq sort-what 'index) - (setq sort - (intern - (org-icompleting-read - "Please choose column to sort index table: " - (append (copy-list columns) (list "group-by")) - nil t nil nil (symbol-name (org-index--special-column 'sort))))) - - (when (eq sort 'group-by) - (setq sort - (intern - (org-icompleting-read - "Please choose column to group index table by: " - columns - nil t nil nil (symbol-name (org-index--special-column 'sort))))) - (setq groups-and-counts (org-index--collect-sort-groups sort))) - - (org-index--do-sort-index sort (first groups-and-counts)) - (org-table-goto-column (org-index--column-num sort)) - ;; When saving index, it should again be sorted correctly - (with-current-buffer org-index--buffer - (add-hook 'before-save-hook 'org-index--sort-silent t)) - - (setq message-text - (format - (concat "Your index has been sorted temporarily by %s and will be sorted again by %s after %d seconds of idle time" - (if groups-and-counts - "; %d groups with equal %s and a total of %d lines have been found" - "")) - (symbol-name sort) - (org-index--special-column 'sort) - org-index--sort-idle-delay - (second groups-and-counts) - (symbol-name sort) - (third groups-and-counts)))) - - ((memq sort-what '(region buffer)) - (org-index--do-sort-lines sort-what) - (setq message-text (format "Sorted %s by contained references" sort-what)))))) - - - ((eq command 'highlight) - - (let ((where "buffer")) - (save-excursion - (save-restriction - (when (and transient-mark-mode - mark-active) - (narrow-to-region (region-beginning) (region-end)) - (setq where "region")) - - (if arg - (progn - (unhighlight-regexp org-index--ref-regex) - (setq message-text (format "Removed highlights for references in %s" where))) - (highlight-regexp org-index--ref-regex 'isearch) - (setq message-text (format "Highlighted references in %s" where))))))) + (setq reached-top (= (org-outline-level) 1)) + (unless (or info + reached-top) + (outline-up-heading 1 t) + (cl-incf moved-up)) - ((eq command 'maintain) - (setq message-text (org-index--do-maintain))) + (setq id (org-id-get)))) - - ((eq command 'example) + (if info + (progn + (setq message-text + (apply 'format + (append (list "'%s'%shas been accessed %s times between %s and %s; category is '%s', keywords are '%s'" + (pop info) + (if (> moved-up 0) (format " (parent node, %d level up) " moved-up) " ")) + info))) + (setq kill-new-text (car (last info)))) + (setq message-text "Neither this node nor any of its parents is part of index")))) - (if (y-or-n-p "This assistant will help you to create a temporary index with detailed comments.\nDo you want to proceed ? ") - (org-index--create-index t))) + ((eq command 'occur) - (t (error "Unknown subcommand '%s'" command))) + (set-buffer org-index--buffer) + (org-index--do-occur)) - ;; tell, what we have done and what can be yanked - (if kill-new-text (setq kill-new-text - (substring-no-properties kill-new-text))) - (if (string= kill-new-text "") (setq kill-new-text nil)) - (let ((m (concat - message-text - (if (and message-text kill-new-text) - " and r" - (if kill-new-text "R" "")) - (if kill-new-text (format "eady to yank '%s'." kill-new-text) (if message-text "." ""))))) - (unless (string= m "") - (message m) - (setq org-index--message-text m))) - (if kill-new-text (kill-new kill-new-text)))) + ((eq command 'ref) + (let (args) -(defun org-index-default-keybindings (&optional prefix) - "Set default keybindings for `org-index'. + (setq args (org-index--collect-values-from-user org-index-edit-on-ref)) + (setq args (plist-put args 'category "yank")) + (setq args (plist-put args 'ref org-index--nextref)) + (apply 'org-index--do-new-line args) -Invoke subcommands of org index with a single key -sequence. Establish the common prefix key 'C-c i' which should be -followed by the first letter of a subcommand. + (setq kill-new-text org-index--nextref) -The ist of letters and subcommands is specified in within -`org-index-default-keybindings-list'. - -See `org-index' for a description of all subcommands. + (setq message-text (format "Added new row with ref '%s'" org-index--nextref)))) -Optional argument PREFIX specifies common prefix, defaults to 'C-c i'" - (interactive) - (define-prefix-command 'org-index--keymap) - ;; prefix command - (global-set-key (kbd (or prefix "C-c i")) 'org-index--keymap) - ;; loop over subcommands - (mapcar - (lambda (x) - ;; loop over letters, that invoke the same subcommand - (mapcar (lambda (c) - (define-key org-index--keymap (kbd (char-to-string c)) - `(lambda (arg) (interactive "P") - (message nil) - (org-index ,(cdr x) nil arg)))) - (car x))) - org-index-default-keybindings-list)) + ((eq command 'yank) + + (let (args) + + (setq args (org-index--collect-values-from-user org-index-edit-on-yank)) + (if (plist-get args 'yank) + (plist-put args 'yank (replace-regexp-in-string "|" "\\vert" (plist-get args 'yank) nil 'literal))) + (setq args (plist-put args 'category "yank")) + (apply 'org-index--do-new-line args) + + (setq message-text "Added new row with text to yank"))) + + + ((eq command 'column) + + (if (and org-index--within-index-node + (org-at-table-p)) + (let (char col num) + (setq char (read-char "Please specify, which column to go to (r=ref, k=keywords, c=category, y=yank): ")) + (unless (memq char (list ?r ?k ?c ?y)) + (error (format "Invalid char '%c', cannot goto this column" char))) + (setq col (cdr (assoc char '((?r . ref) (?k . keywords) (?c . category) (?y . yank))))) + (setq num (org-index--column-num col)) + (if num + (progn + (org-table-goto-column num) + (setq message-text (format "At column %s" (symbol-name col)))) + + (error (format "Column '%s' is not present" col)))) + (error "Need to be in index table to go to a specific column"))) + + + ((eq command 'edit) + + (setq message-text (org-index--do-edit))) + + + ((eq command 'sort) + + (let ((sorts (list "count" "last-accessed" "mixed" "id" "ref")) + sort groups-and-counts) + + (cond + ((eq sort-what 'index) + (setq sort + (intern + (completing-read + "Please choose column to sort index table: " + (cl-copy-list sorts) + nil t nil nil (symbol-name org-index-sort-by)))) + + (org-index--do-sort-index sort) + (org-table-goto-column (org-index--column-num (if (eq sort 'mixed) 'last-access sort))) + ;; When saving index, it should again be sorted correctly + (with-current-buffer org-index--buffer + (add-hook 'before-save-hook 'org-index--sort-silent t)) + + (setq message-text + (format + (concat "Your index has been sorted temporarily by %s and will be sorted again by %s after %d seconds of idle time" + (if groups-and-counts + "; %d groups with equal %s and a total of %d lines have been found" + "")) + (symbol-name sort) + org-index-sort-by + org-index--sort-idle-delay + (second groups-and-counts) + (symbol-name sort) + (third groups-and-counts)))) + + ((memq sort-what '(region buffer)) + (org-index--do-sort-lines sort-what) + (setq message-text (format "Sorted %s by contained references" sort-what)))))) + + + ((eq command 'highlight) + + (let ((where "buffer")) + (save-excursion + (save-restriction + (when (and transient-mark-mode + mark-active) + (narrow-to-region (region-beginning) (region-end)) + (setq where "region")) + + (if arg + (progn + (unhighlight-regexp org-index--ref-regex) + (setq message-text (format "Removed highlights for references in %s" where))) + (highlight-regexp org-index--ref-regex 'isearch) + (setq message-text (format "Highlighted references in %s" where))))))) + + + ((eq command 'maintain) + (setq message-text (org-index--do-maintain))) + + + ((eq command 'example) + + (if (y-or-n-p "This assistant will help you to create a temporary index with detailed comments.\nDo you want to proceed ? ") + (org-index--create-index t))) + + + ((not command) (setq message-text "No command given")) + + + (t (error "Unknown subcommand '%s'" command))) + + + ;; tell, what we have done and what can be yanked + (if kill-new-text (setq kill-new-text + (substring-no-properties kill-new-text))) + (if (string= kill-new-text "") (setq kill-new-text nil)) + (let ((m (concat + message-text + (if (and message-text kill-new-text) + " and r" + (if kill-new-text "R" "")) + (if kill-new-text (format "eady to yank '%s'." kill-new-text) (if message-text "." ""))))) + (unless (string= m "") + (message m) + (setq org-index--message-text m))) + (if kill-new-text (kill-new kill-new-text))))) + + +(defun org-index-dispatch (&optional arg) + "Read additional chars and call subcommands of `org-index'. +Can be bound in global keyboard map as central entry point. +Optional argument ARG is passed on." + (interactive "P") + (let (char command) + (if (sit-for 1) + (message "org-index (? for detailed prompt) -")) + (setq char (key-description (read-key-sequence nil))) + (if (string= char "C-g") (keyboard-quit)) + (if (string= char "SPC") (setq char "?")) + (setq command (cdr (assoc char (org-index--get-shortcut-chars)))) + (unless command + (message "No subcommand for '%s'; switching to detailed prompt" char) + (sit-for 1) + (setq command 'short-help)) + (org-index command nil arg))) (defun org-index-new-line (&rest keys-values) @@ -762,60 +888,317 @@ Example: Optional argument KEYS-VALUES specifies content of new line." - (org-index--verify-id) - (org-index--parse-table) + (let ((ref (plist-get keys-values 'ref))) + (org-index--verify-id) + (org-index--parse-table) + (if (not (memq ref '(t nil))) + (error "Column 'ref' accepts only 't' or 'nil'")) + (when ref + (setq ref org-index--nextref) + (setq keys-values (plist-put keys-values 'ref ref))) + + (apply 'org-index--do-new-line keys-values) + ref)) + + +(defun org-index--read-command (&optional with-short-help) + "Read subcommand for ‘org-index’ from minibuffer. +Optional argument WITH-SHORT-HELP displays help screen upfront." + (let (minibuffer-scroll-window + minibuffer-setup-fun + command) + (setq org-index--short-help-displayed nil) + (add-hook 'minibuffer-setup-hook 'org-index--minibuffer-setup-function) + (add-hook 'minibuffer-exit-hook 'org-index--minibuffer-exit-function) + (unwind-protect + (setq command + (intern + (completing-read + (concat + "Please choose" + (if org-index--display-short-help "" " (? for short help)") + ": ") + (mapcar 'symbol-name org-index--commands) nil t))) + (remove-hook 'minibuffer-setup-hook 'org-index--minibuffer-setup-function) + (remove-hook 'minibuffer-exit-hook 'org-index--minibuffer-exit-function) + (when org-index--short-help-displayed + (quit-windows-on org-index--short-help-buffer-name))) + command)) + + +(defun org-index--minibuffer-setup-function () + "Prepare minibuffer for `org-index--read-command'." + (setq org-index--minibuffer-saved-key (local-key-binding (kbd "?"))) + (local-set-key (kbd "?") 'org-index--display-short-help) + (if org-index--display-short-help (org-index--display-short-help))) + + +(defun org-index--minibuffer-exit-function () + "Restore minibuffer after `org-index--read-command'." + (local-set-key (kbd "?") org-index--minibuffer-saved-key) + (setq org-index--minibuffer-saved-key nil)) + + +(defun org-index--display-short-help () + "Helper function to show help in minibuffer." + (interactive) + + (with-temp-buffer-window + org-index--short-help-buffer-name nil nil + (setq org-index--short-help-displayed t) + (princ "Short help; all subcommands of `org-index', shortcuts in []\n") + (princ (org-index--get-short-help-text))) + (with-current-buffer org-index--short-help-buffer-name + (let ((inhibit-read-only t) + height-before height-after win) + (setq win (get-buffer-window)) + (setq height-before (window-height win)) + (shrink-window-if-larger-than-buffer win) + (setq height-after (window-height win)) + (goto-char (point-min)) + (end-of-line) + (insert + (if (> height-before height-after) + "." + (concat ", " + (substitute-command-keys "\\[scroll-other-window]") + " to scroll:"))) + (goto-char (point-min))))) + + +(defun org-index--get-short-help-text () + "Extract text for short help message from long help." + (or org-index--short-help-text + (with-temp-buffer + (insert (documentation 'org-index)) + (goto-char (point-min)) + (search-forward (concat " " (symbol-name (first org-index--commands)) ": ")) + (forward-line 0) + (kill-region (point-min) (point)) + (search-forward (concat " " (symbol-name (car (last org-index--commands))) ": ")) + (forward-line 1) + (kill-region (point) (point-max)) + (keep-lines "^ [-a-z]+:" (point-min) (point-max)) + (align-regexp (point-min) (point-max) "\\(\\s-*\\):") + (goto-char (point-min)) + (while (re-search-forward "\\. *$" nil t) + (replace-match "" nil nil)) + (goto-char (point-min)) + (re-search-forward "short-help") + (end-of-line) + (insert " (this text)") + (goto-char (point-min)) + (unless (= (line-number-at-pos (point-max)) (1+ (length org-index--commands))) + (error "Internal error, unable to properly extract one-line descriptions of subcommands")) + (setq org-index--short-help-text (buffer-string))))) + + +(defun org-index--get-shortcut-chars () + "Collect shortcut chars from short help message." + (or org-index--shortcut-chars + (with-temp-buffer + (insert (org-index--get-short-help-text)) + (goto-char (point-min)) + (while (< (point) (point-max)) + (when (looking-at "^ \\([-a-z]+\\) +: +\\[\\([a-z?]\\)\\] ") + (setq org-index--shortcut-chars + (cons (cons (match-string 2) (intern (match-string 1))) + org-index--shortcut-chars))) + (forward-line 1)) + (unless (> (length org-index--shortcut-chars) 0) + (error "Internal error, did not find shortcut chars")) + org-index--shortcut-chars))) + + +(defun org-index--do-edit () + "Perform command edit." + (let ((maxlen 0) cols-vals buffer-keymap field-keymap keywords-pos val) + + (setq org-index--context-node nil) + (setq org-index--context-occur nil) + + ;; change to index, if whithin occur + (if org-index--within-occur + (let ((pos (get-text-property (point) 'org-index-lbp))) + (org-index--occur-test-stale pos) + (setq org-index--context-occur (cons (point) (org-index--line-in-canonical-form))) + (set-buffer org-index--buffer) + (goto-char pos)) + + ;; change to index, if still not within + (if (not org-index--within-index-node) + (let ((id (org-id-get))) + (setq org-index--context-node (cons (current-buffer) (point))) + (set-buffer org-index--buffer) + (unless (and id (org-index--go 'id id)) + (setq org-index--context-node nil) + (error "This node is not in index"))))) + + ;; retrieve current content of index line + (dolist (col (mapcar 'car (reverse org-index--columns))) + (if (> (length (symbol-name col)) maxlen) + (setq maxlen (length (symbol-name col)))) + (setq val (org-index--get-or-set-field col)) + (if (and val (eq col 'yank)) (setq val (replace-regexp-in-string (regexp-quote "\\vert") "|" val nil 'literal))) + (setq cols-vals (cons (cons col val) + cols-vals))) + + ;; we need two different keymaps + (setq buffer-keymap (make-sparse-keymap)) + (set-keymap-parent buffer-keymap widget-keymap) + (define-key buffer-keymap (kbd "C-c C-c") 'org-index--edit-c-c-c-c) + (define-key buffer-keymap (kbd "C-c C-k") 'org-index--edit-c-c-c-k) + + (setq field-keymap (make-sparse-keymap)) + (set-keymap-parent field-keymap widget-field-keymap) + (define-key field-keymap (kbd "C-c C-c") 'org-index--edit-c-c-c-c) + (define-key field-keymap (kbd "C-c C-k") 'org-index--edit-c-c-c-k) + + ;; prepare buffer + (setq org-index--context-index (cons (point) (org-index--line-in-canonical-form))) + (if (get-buffer org-index--edit-buffer-name) (kill-buffer org-index--edit-buffer-name)) + (switch-to-buffer (get-buffer-create org-index--edit-buffer-name)) + + ;; create and fill widgets + (setq org-index--edit-widgets nil) + (widget-insert "Edit this line from index; type C-c C-c when done, C-c C-k to abort.\n\n") + (dolist (col-val cols-vals) + (if (eq (car col-val) 'keywords) (setq keywords-pos (point))) + (setq org-index--edit-widgets (cons + (cons (car col-val) + (widget-create 'editable-field + :format (format (format "%%%ds: %%%%v" maxlen) (symbol-name (car col-val))) + :keymap field-keymap + (or (cdr col-val) ""))) + org-index--edit-widgets))) + + (widget-setup) + (goto-char keywords-pos) + (beginning-of-line) + (forward-char (+ maxlen 2)) + (use-local-map buffer-keymap) + "Editing a single line from index")) + + +(defun org-index--edit-c-c-c-c () + "Function to invoked on C-c C-c in Edit buffer." + (interactive) - (car (apply 'org-index--do-new-line keys-values))) + (let ((obuf (get-buffer org-index--occur-buffer-name)) + val line) + + ;; Time might have passed + (org-index--refresh-parse-table) + + (with-current-buffer org-index--buffer + + ;; check, if buffer has become stale + (save-excursion + (goto-char (car org-index--context-index)) + (unless (string= (cdr org-index--context-index) + (org-index--line-in-canonical-form)) + (switch-to-buffer org-index--edit-buffer-name) + (error "Index table has changed: Cannot find line, that this buffer is editing"))) + + (pop-to-buffer-same-window org-index--buffer) + (goto-char (car org-index--context-index)) + + ;; write back line to index + (dolist (col-widget org-index--edit-widgets) + (setq val (widget-value (cdr col-widget))) + (if (eq (car col-widget) 'yank) (setq val (replace-regexp-in-string "|" (regexp-quote "\\vert") val))) + (org-index--get-or-set-field (car col-widget) val)) + + (setq line (org-index--align-and-fontify-current-line)) + (beginning-of-line)) + + ;; write line to occur if appropriate + (if org-index--context-occur + (if obuf + (if (string= (cdr org-index--context-index) + (cdr org-index--context-occur)) + (progn + (pop-to-buffer-same-window obuf) + (goto-char (car org-index--context-occur)) + (beginning-of-line) + (let ((inhibit-read-only t)) + (delete-region (line-beginning-position) (line-end-position)) + (insert line) + (put-text-property (line-beginning-position) (line-end-position) + 'org-index-lbp (cdr org-index--context-index)))) + (error "Occur buffer and index buffer do not match any longer")) + (message "Occur buffer has gone, cannot switch back.")) + (setq org-index--context-occur nil)) + + ;; return to node, if invoked from there + (when org-index--context-node + (pop-to-buffer-same-window (car org-index--context-node)) + (goto-char (cdr org-index--context-node))) + + ;; clean up + (kill-buffer org-index--edit-buffer-name) + (setq org-index--context-index nil) + (setq org-index--edit-widgets nil) + (beginning-of-line) + (message "Index line has been edited."))) + + +(defun org-index--edit-c-c-c-k () + "Function invoked on C-c C-k in Edit buffer." + (interactive) + (kill-buffer org-index--edit-buffer-name) + (setq org-index--context-index nil) + (setq org-index--edit-widgets nil) + (beginning-of-line) + (message "Edit aborted.")) (defun org-index--do-new-line (&rest keys-values) "Do the work for `org-index-new-line'. Optional argument KEYS-VALUES specifies content of new line." - (save-excursion - (org-index--retrieve-context) - (with-current-buffer org-index--buffer - (goto-char org-index--point) + (org-index--retrieve-context) + (with-current-buffer org-index--buffer + (goto-char org-index--point) - ;; check arguments early; they might come from lisp-user + ;; check arguments early; they might come from userland + (let ((kvs keys-values) + k v) + (while kvs + (setq k (car kvs)) + (setq v (cadr kvs)) + (if (or (not (symbolp k)) + (and (symbolp v) (not (eq v t)) (not (eq v nil)))) + (error "Arguments must be alternation of key and value")) + (unless (org-index--column-num k) + (error "Unknown column or column not defined in table: '%s'" (symbol-name k))) + (setq kvs (cddr kvs)))) + + (let (yank) + ;; create new line + (org-index--create-new-line) + + ;; fill columns (let ((kvs keys-values) k v) (while kvs (setq k (car kvs)) (setq v (cadr kvs)) - (if (eq k 'ref) - (unless (memq v '(t nil)) - (error "Column 'ref' accepts only \"t\" or \"nil\"")) - (if (or (not (symbolp k)) - (and (symbolp v) (not (eq v t)) (not (eq v nil)))) - (error "Arguments must be alternation of key and value"))) - (unless (org-index--column-num k) - (error "Unknown column or column not defined in table: '%s'" (symbol-name k))) + (org-table-goto-column (org-index--column-num k)) + (insert (org-trim (or v ""))) (setq kvs (cddr kvs)))) - (let (ref yank) - ;; create new line - (setq ref (org-index--create-new-line)) - (plist-put keys-values 'ref ref) + ;; align and fontify line + (org-index--promote-current-line) + (org-index--align-and-fontify-current-line) - ;; fill columns - (let ((kvs keys-values) - k v n) - (while kvs - (setq k (car kvs)) - (setq v (cadr kvs)) - (org-table-goto-column (org-index--column-num k)) - (insert (org-trim v)) - (setq kvs (cddr kvs)))) + ;; remember fingerprint to be able to return + (setq org-index--last-fingerprint (org-index--get-or-set-field 'fingerprint)) - ;; align and fontify line - (org-index--promote-current-line) - (org-index--align-and-fontify-current-line) - - ;; get column to yank - (setq yank (org-index--get-or-set-field (org-index--special-column 'yank-after-add))) + ;; get column to yank + (setq yank (org-index--get-or-set-field org-index-yank-after-add)) - (cons ref yank))))) + yank))) (defun org-index-get-line (column value) @@ -839,7 +1222,7 @@ argument VALUE specifies the value to search for." (unless value (error "Need a value to search for")) - + (org-index--verify-id) (org-index--parse-table) @@ -860,18 +1243,6 @@ Argument COLUMN and VALUE specify line to get." content)) -(defun org-index--delete-line (id) - "Delete a line specified by ID." - (let (content) - (org-index--on - 'id id - (let ((start (line-beginning-position))) - (beginning-of-line) - (forward-line) - (delete-region start (point)) - t)))) - - (defun org-index--ref-from-id (id) "Get reference from line ID." (org-index--on 'id id (org-index--get-or-set-field 'ref))) @@ -882,27 +1253,35 @@ Argument COLUMN and VALUE specify line to get." (org-index--on 'ref ref (org-index--get-or-set-field 'id))) -(defun org-index--read-search-for-enter () - "Special input routine for command enter." - ;; Accept single char commands or switch to reading a sequence of digits - (let (char prompt search-ref search-id) - - ;; start with short prompt but give more help on next iteration - (setq prompt "Please specify, where to go in index (0-9.,space,backspace,return or ? for help): ") - - ;; read one character - (while (not (memq char (append (number-sequence ?0 ?9) (list ?\d ?\b ?\r ?\j ?\s ?.)))) - (setq char (read-char prompt)) - (setq prompt "Go to index table and specific position. Digits specify a reference number to got to, <space> goes to top of index, <backspace> or <delete> to last line created and <return> or `.' to index line of current node. Please choose: ")) - - (if (memq char (number-sequence ?0 ?9)) - ;; read rest of digits - (setq search-ref (read-from-minibuffer "Search reference number: " (char-to-string char)))) - ;; decode single chars - (if (memq char '(?\r ?\n ?.)) (setq search-id (org-id-get))) - (if (memq char '(?\d ?\b)) (setq search-ref (number-to-string org-index--maxref))) - - (cons search-ref search-id))) +(defun org-index--get-fingerprint () + "Get fingerprint of current line." + (replace-regexp-in-string + "\\s " "" + (mapconcat (lambda (x) (org-index--get-or-set-field x)) '(id ref yank keywords created) ""))) + + +(defun org-index--read-search-for-index () + "Special input routine for command index." + + ;; Accept single char commands or switch to reading a sequence of digits + (let (char prompt search-ref search-id search-fingerprint) + + ;; start with short prompt but give more help on next iteration + (setq prompt "Please specify, where to go in index (0-9,.,space,backspace,return or ? for short help) - ") + + ;; read one character + (while (not (memq char (append (number-sequence ?0 ?9) (list ?\d ?\b ?\r ?\j ?\s ?.)))) + (setq char (read-char prompt)) + (setq prompt "Go to specific position in index table. Digits specify a reference number, <space> goes to top of index, <backspace> or <delete> to last line created and <return> or `.' to index line of current node. Please choose - ")) + + (if (memq char (number-sequence ?0 ?9)) + ;; read rest of digits + (setq search-ref (read-from-minibuffer "Search reference number: " (char-to-string char)))) + ;; decode single chars + (if (memq char '(?\r ?\n ?.)) (setq search-id (org-id-get))) + (if (memq char '(?\d ?\b)) (setq search-fingerprint org-index--last-fingerprint)) + + (list search-ref search-id search-fingerprint))) (defun org-index--verify-id () @@ -911,9 +1290,10 @@ Argument COLUMN and VALUE specify line to get." ;; Check id (unless org-index-id (let ((answer (org-completing-read "Cannot find an index (org-index-id is not set). You may:\n - read-help : to learn more about org-index\n - create-index : invoke an assistant to create an initial index\nPlease choose: " (list "read-help" "create-index") nil t nil nil "read-help"))) - (if (string= "create-index" answer) + (if (string= answer "create-index") (org-index--create-missing-index "Variable org-index-id is not set, so probably no index table has been created yet.") - (describe-function 'org-index)))) + (describe-function 'org-index) + (throw 'new-index nil)))) ;; Find node (let (marker) @@ -943,8 +1323,9 @@ Argument COLUMN and VALUE specify line to get." (beginning-of-line) (org-get-category (point) t))) - ;; Find out, if we are within index table or not - (setq org-index--within-node (string= (org-id-get) org-index-id))) + ;; Find out, if we are within index table or occur buffer + (setq org-index--within-index-node (string= (org-id-get) org-index-id)) + (setq org-index--within-occur (string= (buffer-name) org-index--occur-buffer-name))) (defun org-index--parse-table () @@ -958,7 +1339,7 @@ Argument COLUMN and VALUE specify line to get." (with-current-buffer org-index--buffer - (setq org-index--maxref 0) + (setq org-index--maxrefnum 0) (setq initial-point (point)) (org-index--go-below-hline) @@ -974,9 +1355,8 @@ Argument COLUMN and VALUE specify line to get." (org-index--go-below-hline) (setq org-index--aligned t) (set-buffer-modified-p is-modified))) - + (org-index--go-below-hline) - (setq org-index--below-hline (point-marker)) (beginning-of-line) ;; get headings to display during occur @@ -1001,7 +1381,6 @@ Argument COLUMN and VALUE specify line to get." ;; parse list of flags (goto-char org-index--point) - (org-index--parse-flags) ;; Retrieve any decorations around the number within the first nonempty ref-field (goto-char org-index--below-hline) @@ -1025,41 +1404,54 @@ Argument COLUMN and VALUE specify line to get." (regexp-quote org-index--tail))) (setq org-index--ref-format (concat org-index--head "%d" org-index--tail)) + ;; check if the table still seems to be sorted mixed + (goto-char org-index--below-hline) + (when (eq org-index-sort-by 'mixed) + (org-index--go-below-hline) + (if (string< (org-index--get-or-set-field 'last-accessed) + (org-index--get-mixed-time)) + (org-index--do-sort-index org-index-sort-by))) + ;; Go through table to find maximum number and do some checking - (let ((ref 0)) + (let ((refnum 0)) (while (org-at-table-p) (setq ref-field (org-index--get-or-set-field 'ref)) (setq id-field (org-index--get-or-set-field 'id)) - (when (and (not ref-field) - (not id-field)) - (kill-whole-line) - (message "Removing line from index-table with both ref and id empty")) - (if ref-field (if (string-match org-index--ref-regex ref-field) ;; grab number - (setq ref (string-to-number (match-string 1 ref-field))) + (setq refnum (string-to-number (match-string 1 ref-field))) (kill-whole-line) (message "Removing line from index-table whose ref does not contain a number"))) ;; check, if higher ref - (if (> ref org-index--maxref) (setq org-index--maxref ref)) + (if (> refnum org-index--maxrefnum) (setq org-index--maxrefnum refnum)) (forward-line 1))) + (setq org-index--nextref (format "%s%d%s" org-index--head (1+ org-index--maxrefnum) org-index--tail)) ;; go back to initial position (goto-char initial-point)))) +(defun org-index--refresh-parse-table () + "Fast refresh of selected results of parsing index table." + + (setq org-index--point (marker-position (org-id-find org-index-id 'marker))) + (with-current-buffer org-index--buffer + (save-excursion + (org-index--go-below-hline)))) + + (defun org-index--do-maintain () "Choose among and perform some tasks to maintain index." (let ((check-what) (max-mini-window-height 1.0) message-text) - (setq check-what (intern (org-completing-read "These checks and fixes are available:\n - statistics : compute statistics about index table\n - check : check ids by visiting their nodes\n - duplicates : check index for duplicate rows (any column)\n - clean : remove obsolete property org-index-id\n - update : update content of index lines, with an id \nPlease choose: " (list "statistics" "check" "duplicates" "clean" "update") nil t nil nil "statistics"))) + (setq check-what (intern (org-completing-read "These checks and fixes are available:\n - statistics : compute statistics about index table\n - check : check ids by visiting their nodes\n - duplicates : check index for duplicate rows (ref or id)\n - clean : remove obsolete property org-index-id\n - update : update content of index lines, with an id \nPlease choose: " (list "statistics" "check" "duplicates" "clean" "update") nil t nil nil "statistics"))) (message nil) - + (cond ((eq check-what 'check) (setq message-text (or (org-index--check-ids) @@ -1069,43 +1461,53 @@ Argument COLUMN and VALUE specify line to get." (setq message-text (org-index--do-statistics))) ((eq check-what 'duplicates) - (setq message-text "Finding duplcates can be done by sorting your index appropriately: Choose 'group-by' and select a column; rows will then be sorted together, if they have the same value within the coosen column.")) + (setq message-text (org-index--find-duplicates))) ((eq check-what 'clean) (let ((lines 0)) (org-map-entries (lambda () (when (org-entry-get (point) "org-index-ref") - (incf lines) + (cl-incf lines) (org-entry-delete (point) "org-index-ref"))) nil 'agenda) (setq message-text (format "Removed property 'org-index-ref' from %d lines" lines)))) - + ((eq check-what 'update) - (if (y-or-n-p "Updating your index will overwrite certain columns with content from the associated heading and category. If unsure, you may try this for a single, already existing line of your index by doing `add' from within your index. Are you SURE to proceed for ALL INDEX LINES ? ") + (if (y-or-n-p "Updating your index will overwrite certain columns with content from the associated heading and category. If unsure, you may try this for a single, already existing line of your index by invoking `add'. Are you SURE to proceed for ALL INDEX LINES ? ") (setq message-text (org-index--update-all-lines)) (setq message-text "Canceled.")))) message-text)) -(defun org-index--do-sort-index (sort &optional groups) - "Sort index table according to SORT, optinally with GROUPS." +(defun org-index--get-mixed-time () + "Get timestamp for sorting order mixed." + (format-time-string + (org-time-stamp-format t t) + (apply 'encode-time (append '(0 0 0) (nthcdr 3 (decode-time)))))) + + +(defun org-index--do-sort-index (sort) + "Sort index table according to SORT." (let ((is-modified (buffer-modified-p)) top bottom - ref-field - count-field) + mixed-time) (unless buffer-read-only - (message "Sorting table for %s..." (symbol-name sort)) + (message "Sorting index table for %s..." (symbol-name sort)) (undo-boundary) (let ((message-log-max nil)) ; we have just issued a message, dont need those of sort-subr + ;; if needed for mixed sort + (if (eq sort 'mixed) + (setq mixed-time (org-index--get-mixed-time))) + ;; get boundaries of table - (goto-char org-index--below-hline) + (org-index--go-below-hline) (forward-line 0) (setq top (point)) (while (org-at-table-p) (forward-line)) @@ -1116,11 +1518,12 @@ Argument COLUMN and VALUE specify line to get." (org-table-goto-column 1) (and (not (org-index--get-or-set-field 'ref)) - (not (org-index--get-or-set-field 'id)))) + (not (org-index--get-or-set-field 'id)) + (not (org-index--get-or-set-field 'yank)))) (org-table-kill-row)) (forward-line 1) (setq bottom (point)) - + ;; sort lines (save-restriction (narrow-to-region top bottom) @@ -1129,11 +1532,7 @@ Argument COLUMN and VALUE specify line to get." 'forward-line 'end-of-line (lambda () - (concat - (if groups - (format "%06d-" (cdr (assoc (org-index--get-or-set-field sort) groups))) - "") - (org-index--get-sort-key sort t))) + (org-index--get-sort-key sort t mixed-time)) nil 'string<) (goto-char (point-min)) @@ -1144,30 +1543,6 @@ Argument COLUMN and VALUE specify line to get." (setq org-index--last-sort sort)))) -(defun org-index--collect-sort-groups (sort) - "Collect groups to SORT for." - (let ((count-groups 0) (count-lines 0) - groups key key-value) - - (org-index--on - nil nil - (while (org-at-table-p) - (setq key (org-index--get-or-set-field sort)) - (setq key-value (assoc key groups)) - (if key-value - (progn - (incf (cdr key-value))) - (setq groups (cons (cons key 1) groups))) - (forward-line))) - - (mapc (lambda (x) (when (> (cdr x) 1) - (incf count-groups) - (incf count-lines (cdr x)))) - groups) - - (list groups count-groups count-lines))) - - (defun org-index--do-sort-lines (what) "Sort lines in WHAT according to contained reference." (save-restriction @@ -1193,8 +1568,7 @@ Argument COLUMN and VALUE specify line to get." (defun org-index--go-below-hline () "Move below hline in index-table." - (let ((count 0) - (errstring (format "index table within node %s" org-index-id))) + (let ((errstring (format "index table within node %s" org-index-id))) (goto-char org-index--point) @@ -1222,15 +1596,15 @@ Argument COLUMN and VALUE specify line to get." (unless (org-at-table-p) (org-index--report-index-error "Cannot find a hline within %s" errstring)) - (org-table-goto-column 1))) + (org-table-goto-column 1) + (setq org-index--below-hline (point)))) (defun org-index--parse-headings () "Parse headings of index table." - (let (field ;; field content - field-symbol ;; and as a symbol - found) + (let (field ;; field content + field-symbol) ;; and as a symbol (setq org-index--columns nil) @@ -1243,21 +1617,7 @@ Argument COLUMN and VALUE specify line to get." (error "Heading of column cannot be empty")) (if (and (not (string= (substring field 0 1) ".")) (not (member (intern field) org-index--valid-headings))) - - (if (string= field "link") - ;; Ask user to migrate his index to new version (since [2015-02-11 Mi]) - (progn - ;; pop to index buffer - (pop-to-buffer-same-window org-index--buffer) - (goto-char org-index--below-hline) - (org-reveal t) - ;; go to column - (while (org-at-table-p) - (forward-line -1)) - (forward-line) - (org-table-goto-column (+ 1 col)) - (error "Column 'link' should be named 'id' with recent versions of org-index,\nplease adjust your table (cursor is already positioned right)")) - (error "Column name '%s' is not a valid heading (custom headings may start with a dot, e.g. '.foo')" field))) + (error "Column name '%s' is not a valid heading (custom headings may start with a dot, e.g. '.foo')" field)) (setq field-symbol (intern field)) @@ -1274,142 +1634,13 @@ Argument COLUMN and VALUE specify line to get." (mapc (lambda (head) (unless (cdr (assoc head org-index--columns)) (org-index--report-index-error "No column has heading '%s'" head))) - org-index--required-headings)) - - -(defun org-index--parse-flags () - "Parse list of flags in index table." - - (let (parent parent-is-comment child) - - ;; reset configuration variables - (setq org-index--special-columns nil) - (setq org-index--flagged-columns nil) - - (org-index--goto-list "columns-and-flags" t) - (forward-line 1) - - ;; outer loop over columns - (while (and (setq parent (org-index--parse-list-item)) - parent - (> (cdr (assoc :indent parent)) 0)) - - (setq parent-is-comment (member (cdr (assoc :text parent)) '("all-columns-explained" "all-flags-explained"))) - - ;; check, that we have a valid heading - (unless (or parent-is-comment - (assoc (cdr (assoc :sym parent)) org-index--columns)) - (when (string= "link" (cdr (assoc :text parent))) - (pop-to-buffer-same-window org-index--buffer) - (org-reveal t) - (error "Flag 'link' should be named 'id' with recent versions of org-index,\nplease adjust this flag (cursor is already positioned right)")) - (org-index--report-index-error "'%s' appears within flags, but not as a index column. " (cdr (assoc :text parent)))) - - ;; inner loop over children - (while (and (forward-line 1) - (setq child (org-index--parse-list-item)) - child - (> (cdr (assoc :indent child)) - (cdr (assoc :indent parent)))) - - (unless parent-is-comment - ;; check, that we have a valid flag - (unless (memq (cdr (assoc :sym child)) org-index--all-flags) - (org-index--report-index-error "'%s' is not a valid flag" (cdr (assoc :text child)))) - - ;; process flag with respect to current index-column - (if (memq (cdr (assoc :sym child)) org-index--single-flags) - ;; Check, that none of org-index--single-flags appears twice - (if (assoc (cdr (assoc :sym child)) org-index--special-columns) - (org-index--report-index-error - "More than one column is marked with flag '%s'" (cdr (assoc :text child))) - ;; add it to list - (setq org-index--special-columns (cons (cons (cdr (assoc :sym child)) (cdr (assoc :sym parent))) - org-index--special-columns)))) - - ;; all flags are stored in org-index--flagged-columns - (let ((l (assoc (cdr (assoc :sym child)) org-index--flagged-columns))) ;; list of flag and columns, that carry this flag - (unless l - ;; no list of columns with this flag is present, create one - (setq org-index--flagged-columns - (cons (cons (cdr (assoc :sym child)) nil) - org-index--flagged-columns)) - (setq l (car org-index--flagged-columns))) - ;; prepend this column to list of columns with this flag - (setcdr l (cons (cdr (assoc :sym parent)) (cdr l))))))) - - ;; check, that all needed flags have been specified - (mapc (lambda (x) - (unless (assoc x org-index--special-columns) - (org-index--report-index-error "Required flag '%s' does not appear" (substring (symbol-name x) 1)))) - org-index--required-flags))) - - -(defun org-index--goto-list (name &optional required non-top) - "Goto list NAME (maybe NON-TOP Level) in index node, err if REQUIRED list is not present." - (goto-char org-index--point) - - ;; go to heading of node - (while (not (org-at-heading-p)) (forward-line -1)) - (forward-line 1) - - ;; go to named list - (while (and (not (let ((item (org-index--parse-list-item))) - (if item - (and (or non-top (= (cdr (assoc :indent item)) 0)) ;; accept only toplevel ? - (string= (cdr (assoc :text item)) name)) ;; with requested name - nil))) - (not (org-at-table-p)) - (not (org-at-heading-p)) - (not (eobp))) - (forward-line 1)) - - (if (org-at-item-p) - t - (if required - (org-index--report-index-error "Could not find required list '%s'" name) - nil))) - - -(defun org-index--parse-list-item () - "Parse a list item into an assoc array (indent, checkbox, text, value)." - - ;; matche full list-item, maybe with checkbox and double-colon - (if (looking-at org-list-full-item-re) - - ;; retrieve interesting parts of list item from match data - (let (indent checkbox text value next-line) - - (setq indent - (- (save-excursion (goto-char (match-beginning 1)) (current-column)) ; first column - (save-match-data (org-current-level)) ; indent-level - 1)) - (setq checkbox (match-string 3)) - (setq text (match-string 4)) - (set (if text 'value 'text) (buffer-substring (match-end 0) (line-end-position))) ; regexp did not capture this - - ;; peek ahead, if item continues on next line - (forward-line 1) - (if (looking-at org-list-full-item-re) - (forward-line -1) ; already at next item; go back - (setq next-line (buffer-substring (line-beginning-position) (line-end-position)))) - - ;; clean up strings - (mapc (lambda (x) - (if (stringp (symbol-value x)) - (set x (org-trim (substring-no-properties (symbol-value x)))))) - '(text value next-line)) - - (if next-line (setq text (concat text " " next-line))) ; append next line if - - (list (cons :indent indent) (cons :text text) (cons :value value) (cons :sym (intern text)))) - nil)) + org-index--valid-headings)) (defun org-index--create-missing-index (&rest reasons) "Create a new empty index table with detailed explanation. Argument REASONS explains why." - (org-index--ask-before-create-index "Cannot find your index table: " + (org-index--ask-before-create-index "Cannot find index table: " "new permanent" "." reasons) (org-index--create-index)) @@ -1435,7 +1666,7 @@ Argument COLUMN and VALUE specify line to get." (setq reason (apply 'format reasons)) - (setq prompt (concat explanation reason "\n\n" + (setq prompt (concat explanation reason "\n" "However, this assistant can help you to create a " type " index with detailed comments" for-what "\n\n" "Do you want to proceed ?")) @@ -1468,10 +1699,12 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (setq buffer (get-buffer (org-completing-read "Please choose the buffer, where the new node for the index table should be created; the new node will be inserted at its end.\n\nBuffer: " (mapcar 'buffer-name (org-buffer-list)))))) - (setq title (read-from-minibuffer "Please enter the title of the index node: ")) + (setq title (read-from-minibuffer "Please enter the title of the index node (leave empty for default 'index'): ")) + (if (string= title "") (setq title "index")) (while (progn - (setq firstref (read-from-minibuffer "Please enter your first reference-number. This is a number preceeded by some non-digit chars and optionally followed by some more non-digit chars, e.g. 'R1', '-1-' or '#1#' (and your initial number does not need to be '1'). The format of your reference-numbers only needs to make sense for yourself, so that you can spot it easily in your texts or write it on a piece of paper; it should however not already appear to frequently within your existing notes, to avoid too many false hits when searching.\n\nPlease choose: ")) + (setq firstref (read-from-minibuffer "Please enter your first reference-number. This is an integer number preceeded by some and optionally followed by some non-numeric chars; e.g. 'R1', '-1-' or '#1#' (and your initial number does not need to be '1'). The format of your reference-numbers only needs to make sense for yourself, so that you can spot it easily in your texts or write it on a piece of paper; it should however not already appear frequently within your existing notes, to avoid too many false hits when searching.\n\nPlease choose (leave empty for default 'R1'): ")) + (if (string= firstref "") (setq firstref "R1")) (let (desc) (when (string-match "[[:blank:]]" firstref) (setq desc "Contains whitespace")) @@ -1498,28 +1731,26 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (if temporary (insert " Below you find your temporary index table, which WILL NOT LAST LONGER - THAN YOUR CURRENT EMACS SESSION. + THAN YOUR CURRENT EMACS SESSION; please use it only for evaluation. ") (insert " Below you find your initial index table, which will grow over time. ")) - (insert " - You may start using it by adding some lines. Just move to - another heading, invoke `org-index' and choose the command - 'add'. After adding a few nodes, try the command 'occur' - to search among them. + (insert " You may start using it by adding some lines. Just + move to another heading within org, invoke `org-index' and + choose the command 'add'. After adding a few nodes, try the + command 'occur' to search among them. To gain further insight you may invoke the subcommand 'help', or - read the description of `org-index'. + (same content) read the help of `org-index'. - Within the index table below, dhe sequence of columns does not - matter. You may reorder them in any way you please. Columns are - found by their heading. You may also add your own columns, - which should start with a dot (e.g. '.custom'). + Within the index table below, the sequence of columns does not + matter. You may reorder them in any way you like. You may also + add your own columns, which should start with a dot + (e.g. '.my-column'). - Following this explanations you will find the item-list - `columns-and-flags', which influences the behaviour of - `org-index'. See the explanations which are part of this list. + Invoke `org-customize' to tweak the behaviour of org-index + (see the group org-index). This node needs not be a top level node; its name is completely at your choice; it is found through its ID only. @@ -1531,18 +1762,15 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (setq id (org-id-get-create)) (insert (format " -%s - - | ref | category | keywords | count | last-accessed | created | id | - | | | | | | | <4> | - |-----+-----------+----------+-------+---------------+---------+------| - | %s | | %s | | | %s | %s | + | ref | category | keywords | tags | count | level | last-accessed | created | id | yank | + | | | | | | | | | <4> | <4> | + |-----+----------+----------+------+-------+-------+---------------+---------+-----+------| + | %s | | %s | | | | | %s | %s | | " - org-index--sample-flags firstref - "This node" + title (with-temp-buffer (org-insert-time-stamp nil nil t)) id)) @@ -1577,8 +1805,10 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (org-id-goto id) (org-index--unfold-buffer) (if compare - (error "Please compare your existing index (upper window) and a temporary new one (lower window) to fix your index") - (message "This is your new temporary index."))) + (progn + (message "Please compare your existing index (upper window) and a temporary new one (lower window) to fix your index") + (throw 'new-index nil)) + (message "This is your new temporary index, use command add to populate, occur to search."))) (progn ;; Only show the new index (pop-to-buffer-same-window buffer) @@ -1588,12 +1818,14 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (if (y-or-n-p "This is your new index table. It is already set for this Emacs session, so you may try it out. Do you want to save its id to make it available for future Emacs sessions too ? ") (progn (customize-save-variable 'org-index-id id) - (error "Saved org-index-id '%s' to %s" id (or custom-file - user-init-file))) + (message "Saved org-index-id '%s' to %s." id (or custom-file + user-init-file)) + (throw 'new-index nil)) (let (sq) (setq sq (format "(setq org-index-id \"%s\")" id)) (kill-new sq) - (error "Did not make the id of this new index permanent; you may want to put\n\n %s\n\ninto your own initialization; it is copied already, just yank it" sq)))))))) + (message "Did not make the id of this new index permanent; you may want to put\n\n %s\n\ninto your own initialization; it is copied already, just yank it." sq) + (throw 'new-index nil)))))))) (defun org-index--unfold-buffer () @@ -1604,31 +1836,31 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (save-excursion (org-back-to-heading) (forward-line) ;; on property drawer - (org-cycle) - (org-index--goto-list "columns-and-flags") (org-cycle))) -(defun org-index--update-line (&optional ref-or-id) - "Update columns count and last-accessed in line REF-OR-ID." +(defun org-index--update-line (&optional ref-or-id-or-pos) + "Update columns count and last-accessed in line REF-OR-ID-OR-POS." - (let ((newcount 0) - initial) + (let (initial) (with-current-buffer org-index--buffer (unless buffer-read-only ;; search reference or id, if given (or assume, that we are already positioned right) - (when ref-or-id + (when ref-or-id-or-pos (setq initial (point)) (goto-char org-index--below-hline) (while (and (org-at-table-p) - (not (or (string= ref-or-id (org-index--get-or-set-field 'ref)) - (string= ref-or-id (org-index--get-or-set-field 'id))))) + (not (if (integerp ref-or-id-or-pos) + (and (>= ref-or-id-or-pos (line-beginning-position)) + (< ref-or-id-or-pos (line-end-position))) + (or (string= ref-or-id-or-pos (org-index--get-or-set-field 'ref)) + (string= ref-or-id-or-pos (org-index--get-or-set-field 'id)))))) (forward-line))) (if (not (org-at-table-p)) - (error "Did not find reference or id '%s'" ref-or-id) + (error "Did not find reference or id '%s'" ref-or-id-or-pos) (org-index--update-current-line)) (if initial (goto-char initial)))))) @@ -1655,27 +1887,43 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (org-index--align-and-fontify-current-line))) -(defun org-index--align-and-fontify-current-line () - "Make current line blend well among others." - (let ((line (substring-no-properties (delete-and-extract-region (line-beginning-position) (line-end-position))))) - ;; create minimum table with fixed-width columns to align and fontiry new line +(defun org-index--align-and-fontify-current-line (&optional num) + "Make current line (or NUM lines) blend well among others." + (let (lines) + ;; get current content + (unless num (setq num 1)) + (setq lines (delete-and-extract-region (line-beginning-position) (line-end-position num))) + ;; create minimum table with fixed-width columns to align and fontify new line (insert (with-temp-buffer (org-set-font-lock-defaults) (insert org-index--headings-visible) - (goto-char (point-min)) ;; fill columns, so that aligning cannot shrink them + (goto-char (point-min)) (search-forward "|") - (replace-string " " "." nil (point) (line-end-position)) - (replace-string ".|." " | " nil (line-beginning-position) (line-end-position)) - (replace-string "|." "| " nil (line-beginning-position) (line-end-position)) + (while (search-forward " " (line-end-position) t) + (replace-match "." nil t)) + (goto-char (point-min)) + (while (search-forward ".|." (line-end-position) t) + (replace-match " | " nil t)) + (goto-char (point-min)) + (while (search-forward "|." (line-end-position) t) + (replace-match "| " nil t)) (goto-char (point-max)) - (insert line) + (insert lines) (forward-line 0) + (let ((start (point))) + (while (re-search-forward "^\s +|-" nil t) + (replace-match "| -")) + (goto-char start)) + (org-mode) (org-table-align) (font-lock-fontify-region (point-min) (point-max)) (goto-char (point-max)) - (forward-line -1) - (buffer-substring (line-beginning-position) (line-end-position)))))) + (if (eq -1 (skip-chars-backward "\n")) + (delete-char 1)) + (forward-line (- 1 num)) + (buffer-substring (line-beginning-position) (line-end-position num)))) + lines)) (defun org-index--promote-current-line () @@ -1694,7 +1942,7 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (not (org-at-table-hline-p)) (string< (org-index--get-sort-key) key)) - (incf to-skip) + (cl-incf to-skip) (forward-line -1)) (forward-line 1) @@ -1704,8 +1952,8 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (forward-line -1)))) -(defun org-index--get-sort-key (&optional sort with-ref) - "Get value for sorting from column SORT, optional WITH-REF." +(defun org-index--get-sort-key (&optional sort with-ref mixed-time) + "Get value for sorting from column SORT, optional WITH-REF; if mixes use MIXED-TIME." (let (ref ref-field key) @@ -1717,24 +1965,28 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin ;; get reference with leading zeroes, so it can be ;; sorted as text (setq ref-field (org-index--get-or-set-field 'ref)) - (string-match org-index--ref-regex ref-field) - (setq ref (format - "%06d" - (string-to-number - (or (match-string 1 ref-field) - "0"))))) + (if ref-field + (progn + (string-match org-index--ref-regex ref-field) + (setq ref (format + "%06d" + (string-to-number + (match-string 1 ref-field))))) + (setq ref "000000"))) (setq key (cond ((eq sort 'count) (format "%08d" (string-to-number (or (org-index--get-or-set-field 'count) "")))) + ((eq sort 'mixed) + (let ((last-accessed (org-index--get-or-set-field 'last-accessed))) + (unless mixed-time (setq mixed-time (org-index--get-mixed-time))) + (concat + (if (string< mixed-time last-accessed) last-accessed mixed-time) + (format "%08d" (string-to-number (or (org-index--get-or-set-field 'count) "")))))) ((eq sort 'ref) ref) - ((eq sort 'id) - (org-index--get-or-set-field sort)) - ((eq sort 'last-accessed) - (org-index--get-or-set-field sort)) - ((eq sort 'created) + ((memq sort '(id last-accessed created)) (org-index--get-or-set-field sort)) (t (error "This is a bug: unmatched case '%s'" sort)))) @@ -1747,7 +1999,11 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin "Retrieve field KEY from index table or set it to VALUE." (let (field) (save-excursion - (setq field (org-trim (org-table-get-field (cdr (assoc key org-index--columns)) value))) + (if (eq key 'fingerprint) + (progn + (if value (error "Internal error, pseudo-column fingerprint cannot be set")) + (setq field (org-index--get-fingerprint))) + (setq field (org-trim (org-table-get-field (cdr (assoc key org-index--columns)) value)))) (if (string= field "") (setq field nil)) (org-no-properties field)))) @@ -1760,68 +2016,112 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (cdr (assoc key org-index--columns)))) -(defun org-index--special-column (key) - "Return column (not a number) for special column KEY." - (cdr (assoc key org-index--special-columns))) +(defun org-index--make-guarded-search (ref &optional dont-quote) + "Make robust search string from REF; DONT-QUOTE it, if requested." + (concat "\\_<" (if dont-quote ref (regexp-quote ref)) "\\_>")) + + +(defun org-index--find-duplicates () + "Find duplicate references or ids in index table." + (let (ref-duplicates id-duplicates) + (setq ref-duplicates (org-index--find-duplicates-helper 'ref)) + (setq id-duplicates (org-index--find-duplicates-helper 'id)) + (goto-char org-index--below-hline) + (if (or ref-duplicates id-duplicates) + (progn + ;; show results + (pop-to-buffer-same-window + (get-buffer-create "*org-index-duplicates*")) + (when ref-duplicates + (insert "These references appear more than once:\n") + (mapc (lambda (x) (insert " " x "\n")) ref-duplicates) + (insert "\n\n")) + (when id-duplicates + (insert "These ids appear more than once:\n") + (mapc (lambda (x) (insert " " x "\n")) id-duplicates)) + + "Some references or ids are duplicates") + "No duplicate references or ids found"))) + + +(defun org-index--find-duplicates-helper (column) + "Helper for `org-index--find-duplicates': Go through table and count given COLUMN." + (let (counts duplicates field found) + + ;; go through table + (goto-char org-index--below-hline) + (while (org-at-table-p) -(defun org-index--flag-p (flag column) - "Check if COLUMN has FLAG set." - (unless (memq flag org-index--all-flags) - (error (format "Internal error: unknown flag %s" (symbol-name flag)))) - (memq column (assoc flag org-index--flagged-columns))) + ;; get column + (setq field (org-index--get-or-set-field column)) + ;; and increment + (setq found (assoc field counts)) + (if found + (cl-incf (cdr found)) + (setq counts (cons (cons field 1) counts))) -(defun org-index--make-guarded-search (ref &optional dont-quote) - "Make robust search string from REF; DONT-QUOTE it, if requested." - (concat "\\_<" (if dont-quote ref (regexp-quote ref)) "\\_>")) + (forward-line)) + + (mapc (lambda (x) (if (and (> (cdr x) 1) + (car x)) + (setq duplicates (cons (car x) duplicates)))) counts) + + duplicates)) (defun org-index--do-statistics () "Compute statistics about index table." - (let ((total 0) - ref-field ref min max message) - + (let ((total-lines 0) (total-refs 0) + ref ref-field min max message) - ;; go through table and remove all refs, that we see + ;; go through table (goto-char org-index--below-hline) (while (org-at-table-p) - ;; get ref-field and number + ;; get ref (setq ref-field (org-index--get-or-set-field 'ref)) - (if (and ref-field - (string-match org-index--ref-regex ref-field)) - (setq ref (string-to-number (match-string 1 ref-field)))) - ;; record min and max - (if (or (not min) (< ref min)) (setq min ref)) - (if (or (not max) (> ref max)) (setq max ref)) + (when ref-field + (string-match org-index--ref-regex ref-field) + (setq ref (string-to-number (match-string 1 ref-field))) + + ;; record min and max + (if (or (not min) (< ref min)) (setq min ref)) + (if (or (not max) (> ref max)) (setq max ref)) + + (setq total-refs (1+ total-refs))) ;; count - (setq total (1+ total)) + (setq total-lines (1+ total-lines)) (forward-line)) - (setq message (format "First reference is %s, last %s; %d values in between, %d of them are used (%d percent)" - (format org-index--ref-format min) - (format org-index--ref-format max) - (1+ (- max min)) - total - (truncate (* 100 (/ (float total) (1+ (- max min))))) - -)) + (setq message (format "%d Lines in index table. First reference is %s, last %s; %d of them are used (%d percent)" + total-lines + (format org-index--ref-format min) + (format org-index--ref-format max) + total-refs + (truncate (* 100 (/ (float total-refs) (1+ (- max min))))))) (goto-char org-index--below-hline) message)) -(defun org-index--do-add-or-update () - "For current node or current line in index, add a new line to index table or update existing." +(defun org-index--do-add-or-update (&optional create-ref tag-with-ref) + "For current node or current line in index, add or update in index table. +CREATE-REF and TAG-WITH-REF if given." - (let* (id ref args yank ref-and-yank) + (let* (id id-from-index ref args yank ret) - ;; do the same things from within index and from outside - (if org-index--within-node + (org-index--save-positions) + (unless (or org-index--within-index-node + org-index--within-occur) + (org-back-to-heading)) + + ;; try to do the same things from within index and from outside + (if org-index--within-index-node (progn (unless (org-at-table-p) @@ -1830,34 +2130,59 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (setq id (org-index--get-or-set-field 'id)) (setq ref (org-index--get-or-set-field 'ref)) (setq args (org-index--collect-values-for-add-update-remote id)) - (org-index--write-fields-for-add-update args) - (setq yank (org-index--get-or-set-field (org-index--special-column 'yank-after-add))) - - (cons (format "Updated index line %s" ref) yank)) + (org-index--write-fields args) + (setq yank (org-index--get-or-set-field org-index-yank-after-add)) - (unless (org-at-heading-p) - (error "Not at headline")) + (setq ret + (if ref + (cons (format "Updated index line %s" ref) yank) + (cons "Updated index line" nil)))) (setq id (org-id-get-create)) + (org-index--refresh-parse-table) + (setq id-from-index (org-index--on 'id id id)) (setq ref (org-index--on 'id id (org-index--get-or-set-field 'ref))) - (setq args (org-index--collect-values-for-add-update id ref)) - (if ref - ;; already have a ref, find it in index and update fields - (let ((kvs args) - found-and-message) + (if tag-with-ref + (org-toggle-tag (format "%s%d%s" org-index--head tag-with-ref org-index--tail) 'on)) + (setq args (org-index--collect-values-for-add-update id)) + + (when (and create-ref + (not ref)) + (setq ref org-index--nextref) + (setq args (plist-put args 'ref ref))) + + + (if id-from-index + ;; already have an id in index, find it and update fields + (progn (org-index--on - 'ref ref - (org-index--write-fields-for-add-update args) - (setq yank (org-index--get-or-set-field (org-index--special-column 'yank-after-add)))) - - (cons (format "Updated index line %s" ref) yank)) + 'id id + (org-index--write-fields args) + (setq yank (org-index--get-or-set-field org-index-yank-after-add))) + + (setq ret + (if ref + (cons (format "Updated index line %s" ref) yank) + (cons "Updated index line" nil)))) - ;; no ref here, create new line in index - (setq ref-and-yank (apply 'org-index--do-new-line args)) + ;; no id here, create new line in index + (if ref (setq ref (plist-put args 'ref org-index--nextref))) + (setq yank (apply 'org-index--do-new-line args)) - (cons (format "Added index line %s" (car ref-and-yank)) (concat (cdr ref-and-yank) " ")))))) + (setq ret + (if ref + (cons + (format "Added new index line %s" ref) + (concat yank " ")) + (cons + "Added new index line" + nil))))) + + (org-index--restore-positions) + + ret)) (defun org-index--check-ids () @@ -1865,7 +2190,7 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (let ((lines 0) id ids marker) - + (goto-char org-index--below-hline) (catch 'problem @@ -1877,7 +2202,7 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (when (member id ids) (org-table-goto-column (org-index--column-num 'id)) (throw 'problem "This id appears twice in index; please use command 'maintain' to check for duplicate ids")) - (incf lines) + (cl-incf lines) (setq ids (cons id ids)) ;; check, if id is valid @@ -1891,13 +2216,13 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (goto-char org-index--below-hline) nil))) - + (defun org-index--update-all-lines () "Update all lines of index at once." (let ((lines 0) id ref kvs) - + ;; check for double ids (or (org-index--check-ids) @@ -1905,13 +2230,13 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (progn (goto-char org-index--below-hline) (while (org-at-table-p) - + ;; update single line (when (setq id (org-index--get-or-set-field 'id)) (setq ref (org-index--get-or-set-field 'ref)) (setq kvs (org-index--collect-values-for-add-update-remote id)) - (org-index--write-fields-for-add-update kvs) - (incf lines)) + (org-index--write-fields kvs) + (cl-incf lines)) (forward-line)) (goto-char org-index--below-hline) @@ -1921,44 +2246,48 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin (defun org-index--collect-values-for-add-update (id &optional silent category) "Collect values for adding or updating line specified by ID, do not ask if SILENT, use CATEGORY, if given." - - (let ((args (list 'ref t 'id id)) + + (let ((args (list 'id id)) content) - - (dolist (col-num org-index--columns) - + + (dolist (col (mapcar 'car org-index--columns)) + (setq content "") - - (if (eq (car col-num) 'keywords) - (setq content (nth 4 (org-heading-components)))) - - (if (eq (car col-num) 'category) - (setq content (or category org-index--category-before))) - - (if (eq (car col-num) 'level) - (setq content (number-to-string (org-outline-level)))) - - ;; Shift ref and timestamp ? - (if (org-index--flag-p 'shift-ref-and-date-on-add (car col-num)) - (dotimes (i 2) - (if (or (string-match (concat "^\\s-*" org-index--ref-regex) content) - (string-match (concat org-ts-regexp-both) content)) - (setq content (substring content (match-end 0)))))) - - (if (and (not silent) ; do not edit, if heading has already been added - (org-index--flag-p 'edit-on-add (car col-num))) - (setq content (read-from-minibuffer - (format "Edit text for column '%s': " (symbol-name (car col-num))) - content))) - - (if (not (string= content "")) - (setq args (append (list (car col-num) content) args)))) + + (cond + ((eq col 'keywords) + (if org-index-copy-heading-to-keywords + (setq content (nth 4 (org-heading-components)))) + + ;; Shift ref and timestamp ? + (if org-index-strip-ref-and-date-from-heading + (dotimes (i 2) + (if (or (string-match (concat "^\\s-*" org-index--ref-regex) content) + (string-match (concat "^\\s-*" org-ts-regexp-both) content)) + (setq content (substring content (match-end 0))))))) + + ((eq col 'category) + (setq content (or category org-index--category-before))) + + ((eq col 'level) + (setq content (number-to-string (org-outline-level)))) + + ((eq col 'tags) + (setq content (org-get-tags-string)))) + + (unless (string= content "") + (setq args (plist-put args col content)))) + + (if (not silent) + (let ((args-edited (org-index--collect-values-from-user org-index-edit-on-add args))) + (setq args (append args-edited args)))) + args)) (defun org-index--collect-values-for-add-update-remote (id) "Wrap `org-index--collect-values-for-add-update' by prior moving to remote node identified by ID." - + (let (marker point args) (setq marker (org-id-find id t)) @@ -1972,43 +2301,158 @@ specify flag TEMPORARY for th new table temporary, maybe COMPARE it with existin args)) -(defun org-index--write-fields-for-add-update (kvs) +(defun org-index--collect-values-from-user (cols &optional defaults) + "Collect values for adding a new yank-line. +Argument COLS gives list of columns to edit. +Optional argument DEFAULTS gives default values." + + (let (content args) + + (dolist (col cols) + + (setq content "") + + (setq content (read-from-minibuffer + (format "Enter text for column '%s': " (symbol-name col)) + (plist-get col defaults))) + + (unless (string= content "") + (setq args (plist-put args col content)))) + args)) + + +(defun org-index--write-fields (kvs) "Update current line with values from KVS (keys-values)." (while kvs - (unless (eq (car kvs) 'ref) - (org-index--get-or-set-field (car kvs) (org-trim (cadr kvs)))) + (org-index--get-or-set-field (car kvs) (org-trim (cadr kvs))) (setq kvs (cddr kvs)))) -(defun org-index--do-delete () - "Perform command delete." +(defun org-index--do-kill () + "Perform command kill from within occur, index or node." - (unless (org-at-heading-p) - (error "Not at headline")) + (let (id ref chars-deleted-index text-deleted-from pos-in-index) - (let* ((id (org-entry-get (point) "ID")) - (ref (org-index--ref-from-id id))) + (org-index--save-positions) + (unless (or org-index--within-index-node + org-index--within-occur) + (org-back-to-heading)) - ;; maybe delete from heading - (if ref - (save-excursion - (end-of-line) - (let ((end (point))) - (beginning-of-line) - (when (search-forward ref end t) - (delete-char (- (length ref))) - (just-one-space))))) + ;; Collect information: What should be deleted ? + (if (or org-index--within-occur + org-index--within-index-node) - ;; delete from index table - (if (org-index--delete-line id) - (format "Deleted index line %s" ref) - (format "Did not find id %s in index" id)))) + (progn + (if org-index--within-index-node + ;; In index + (setq pos-in-index (point)) + ;; In occur + (setq pos-in-index (get-text-property (point) 'org-index-lbp)) + (org-index--occur-test-stale pos-in-index) + (set-buffer org-index--buffer) + (goto-char pos-in-index)) + ;; In Index (maybe moved there) + (setq id (org-index--get-or-set-field 'id)) + (setq ref (org-index--get-or-set-field 'ref))) + + ;; At a headline + (setq id (org-entry-get (point) "ID")) + (setq ref (org-index--ref-from-id id)) + (setq pos-in-index (org-index--on 'id id (point))) + (unless pos-in-index (error "This node is not in index"))) + + ;; Remark: Current buffer is not certain here, but we have all the information to delete + + ;; Delete from node + (when id + (let ((m (org-id-find id 'marker))) + (set-buffer (marker-buffer m)) + (goto-char m) + (move-marker m nil) + (unless (string= (org-id-get) id) + (error "Could not find node with id %s" id))) + + (org-index--delete-any-ref-from-tags) + (if ref (org-index--delete-ref-from-heading ref)) + (setq text-deleted-from (cons "node" text-deleted-from))) + + ;; Delete from index + (set-buffer org-index--buffer) + (unless pos-in-index "Internal error, pos-in-index should be defined here") + (goto-char pos-in-index) + (setq chars-deleted-index (length (delete-and-extract-region (line-beginning-position) (line-beginning-position 2)))) + (setq text-deleted-from (cons "index" text-deleted-from)) + + ;; Delete from occur only if we started there, accept that it will be stale otherwise + (if org-index--within-occur + (let ((inhibit-read-only t)) + (set-buffer org-index--occur-buffer-name) + (delete-region (line-beginning-position) (line-beginning-position 2)) + ;; correct positions + (while (org-at-table-p) + (put-text-property (line-beginning-position) (line-end-position) 'org-index-lbp + (- (get-text-property (point) 'org-index-lbp) chars-deleted-index)) + (forward-line)) + (setq text-deleted-from (cons "occur" text-deleted-from)))) + + (org-index--restore-positions) + (concat "Deleted from: " (mapconcat 'identity (sort text-deleted-from 'string<) ",")))) + + +(defun org-index--save-positions () + "Save current buffer and positions in index- and current buffer; not in occur-buffer." + + (let (cur-buf cur-mrk idx-pnt idx-mrk) + (setq cur-buf (current-buffer)) + (setq cur-mrk (point-marker)) + (set-buffer org-index--buffer) + (if (string= (org-id-get) org-index-id) + (setq idx-pnt (point)) + (setq idx-mrk (point-marker))) + (set-buffer cur-buf) + (setq org-index--saved-positions (list cur-buf cur-mrk idx-pnt idx-mrk)))) + + +(defun org-index--restore-positions () + "Restore positions as saved by `org-index--save-positions'." + + (cl-multiple-value-bind + (cur-buf cur-mrk idx-pnt idx-mrk buf) + org-index--saved-positions + (setq buf (current-buffer)) + (set-buffer cur-buf) + (goto-char cur-mrk) + (set-buffer org-index--buffer) + (goto-char (or idx-pnt idx-mrk)) + (set-buffer buf)) + (setq org-index--saved-positions nil)) + + +(defun org-index--delete-ref-from-heading (ref) + "Delete given REF from current heading." + (save-excursion + (end-of-line) + (let ((end (point))) + (beginning-of-line) + (when (search-forward ref end t) + (delete-char (- (length ref))) + (just-one-space))))) + + +(defun org-index--delete-any-ref-from-tags () + "Delete any reference from list of tags." + (let (new-tags) + (mapc (lambda (tag) + (unless (string-match org-index--ref-regex tag) + (setq new-tags (cons tag new-tags) ))) + (org-get-tags)) + (org-set-tags-to new-tags))) (defun org-index--go (&optional column value) "Position cursor on index line where COLUMN equals VALUE. Return t or nil, leave point on line or at top of table, needs to be in buffer initially." - (let (found text) + (let (found) (unless (eq (current-buffer) org-index--buffer) (error "This is a bug: Not in index buffer")) @@ -2031,11 +2475,9 @@ Return t or nil, leave point on line or at top of table, needs to be in buffer i nil))) -(defun org-index--do-head (ref id &optional other) +(defun org-index--find-id (id &optional other) "Perform command head: Find node with REF or ID and present it. If OTHER in separate window." - - (setq org-index--last-ref ref) (let (message marker) @@ -2044,25 +2486,27 @@ If OTHER in separate window." (if marker (progn (org-index--update-line id) - (let (cb) - (if other - (progn - (setq cb (current-buffer)) - (pop-to-buffer (marker-buffer marker))) - (pop-to-buffer-same-window (marker-buffer marker))) - - (goto-char marker) - (org-reveal t) - (org-show-entry) - (recenter)) - (setq message (format "Found headline %s" ref))) - (setq message (format "Did not find headline %s" ref))))) + (if other + (progn + (pop-to-buffer (marker-buffer marker))) + (pop-to-buffer-same-window (marker-buffer marker))) + + (goto-char marker) + (org-reveal t) + (org-show-entry) + (recenter) + (unless (string= (org-id-get) id) + (setq message (format "Could not go to node with id %s (narrowed ?)" id))) + (setq message "Found headline")) + (setq message (format "Did not find node with %s" id))) + message)) (defun org-index--do-occur () "Perform command occur." (let ((word "") ; last word to search for growing and shrinking on keystrokes (prompt "Search for: ") + (these-commands " NOTE: If you invoke the org-index subcommands edit or kill from within the occur buffer, the index is updated accordingly.") (lines-wanted (window-body-height)) (lines-found 0) ; number of lines found words ; list words that should match @@ -2070,22 +2514,24 @@ If OTHER in separate window." begin ; position of first line narrow ; start of narrowed buffer help-text ; cons with help text short and long - key-help ; for keys with special function search-text ; description of text to search for done ; true, if loop is done in-c-backspace ; true, while processing C-backspace - show-headings ; true, if headings should be shown help-overlay ; Overlay with help text last-point ; Last position before end of search - key ; input from user - key-sequence) ; as a sequence + initial-frame ; Frame when starting occur + key ; input from user in various forms + key-sequence + key-sequence-raw) + - ;; make and show buffer (if (get-buffer org-index--occur-buffer-name) (kill-buffer org-index--occur-buffer-name)) (setq occur-buffer (make-indirect-buffer org-index--buffer org-index--occur-buffer-name)) (pop-to-buffer-same-window occur-buffer) + (setq initial-frame (selected-frame)) + ;; avoid modifying direct buffer (setq buffer-read-only t) (toggle-truncate-lines 1) @@ -2095,9 +2541,9 @@ If OTHER in separate window." ;; reset stack and overlays (setq org-index--occur-stack nil) (setq org-index--occur-tail-overlay nil) - + ;; narrow to table rows and one line before - (goto-char (marker-position org-index--below-hline)) + (goto-char org-index--below-hline) (forward-line 0) (setq begin (point)) (forward-line -1) @@ -2110,17 +2556,20 @@ If OTHER in separate window." ;; initialize help text (setq help-text (cons - "Incremental occur; `?' toggles help and headlines.\n" (concat - (org-index--wrap - (concat - "Normal keys add to search word; <space> or <comma> start additional word; <backspace> erases last char, <C-backspace> last word; <return> jumps to heading, <tab> jumps to heading in other window; all other keys end search.\n")) + (propertize "Incremental occur" 'face 'org-todo) + (propertize "; ? toggles help and headlines.\n" 'face 'org-agenda-dimmed-todo-face)) + (concat + (propertize + (org-index--wrap + (concat + "Normal keys add to search word; <space> or <comma> start additional word; <backspace> erases last char, <C-backspace> last word; <return> jumps to heading, <tab> jumps to heading in other window, <S-return> jumps to matching line in index; all other keys end search." these-commands "\n")) + 'face 'org-agenda-dimmed-todo-face) org-index--headings))) - + ;; insert overlays for help text and to cover unsearched lines (setq help-overlay (make-overlay (point-min) begin)) (overlay-put help-overlay 'display (car help-text)) - (overlay-put help-overlay 'face 'org-agenda-dimmed-todo-face) (setq org-index--occur-tail-overlay (make-overlay (point-max) (point-max))) (overlay-put org-index--occur-tail-overlay 'invisible t) @@ -2129,14 +2578,25 @@ If OTHER in separate window." (if in-c-backspace (setq key "<backspace>") (setq search-text (mapconcat 'identity (reverse (cons word words)) ",")) - ;; read key - (setq key-sequence - (vector (read-key - (format "%s%s%s" - prompt - search-text - (if (string= search-text "") "" " "))))) - (setq key (key-description key-sequence))) + (message "foo") + + ;; read key, if selected frame has not changed + (if (eq initial-frame (selected-frame)) + (progn + (setq key-sequence + (let ((echo-keystrokes 0) + (full-prompt (format "%s%s%s" + prompt + search-text + (if (string= search-text "") "" " ")))) + (read-key-sequence full-prompt nil nil t t))) + (setq key (key-description key-sequence)) + (setq key-sequence-raw (this-single-command-raw-keys))) + (setq done t) + (setq key-sequence nil) + (setq key nil) + (setq key-sequence-raw nil))) + (cond @@ -2168,11 +2628,11 @@ If OTHER in separate window." ;; free top list of overlays and remove list (setq lines-found (or (org-index--unhide) lines-wanted)) (move-overlay org-index--occur-tail-overlay - (if org-index--occur-stack (cdr (assoc :end-of-visible (car org-index--occur-stack))) + (if org-index--occur-stack (cdr (assq :end-of-visible (car org-index--occur-stack))) (point-max)) (point-max)) - - + + ;; highlight shorter word (unless (= (length word) 0) (highlight-regexp (regexp-quote word) 'isearch)) @@ -2184,8 +2644,9 @@ If OTHER in separate window." ((member key (list "SPC" ",")) ; space or comma: enter an additional search word ;; push current word and clear, no need to change display - (setq words (cons word words)) - (setq word "")) + (unless (string= word "") + (setq words (cons word words)) + (setq word ""))) ((string= key "?") ; question mark: toggle display of headlines and help @@ -2201,17 +2662,17 @@ If OTHER in separate window." ;; add to word (setq word (concat word key)) - + ;; make overlays to hide lines, that do not match longer word any more (goto-char begin) (setq lines-found (org-index--hide-with-overlays (cons word words) lines-wanted)) (move-overlay org-index--occur-tail-overlay - (if org-index--occur-stack (cdr (assoc :end-of-visible (car org-index--occur-stack))) + (if org-index--occur-stack (cdr (assq :end-of-visible (car org-index--occur-stack))) (point-max)) (point-max)) - + (goto-char begin) - + ;; highlight longer word (highlight-regexp (regexp-quote word) 'isearch) @@ -2224,18 +2685,18 @@ If OTHER in separate window." ;; put back input event, that caused the loop to end (unless (string= key "C-g") - (setq unread-command-events (listify-key-sequence key-sequence)) + (setq unread-command-events (listify-key-sequence key-sequence-raw)) (message key)) - + ;; postprocessing (setq last-point (point)) - + ;; For performance reasons do not show matching lines for rest of table. So no code here. - + ;; make permanent copy ;; copy visible lines (let ((lines-collected 0) - keymap line all-lines end-of-head) + keymap line all-lines all-lines-lbp header-lines lbp) (setq cursor-type t) (goto-char begin) @@ -2247,51 +2708,67 @@ If OTHER in separate window." (while (and (invisible-p (point)) (not (eobp))) (goto-char (1+ (overlay-end (car (overlays-at (point))))))) - (setq line (buffer-substring (line-beginning-position) (line-end-position))) + (setq lbp (line-beginning-position)) + (setq line (buffer-substring-no-properties lbp (line-end-position))) (unless (string= line "") - (incf lines-collected) + (cl-incf lines-collected) (setq all-lines (cons (concat line "\n") - all-lines))) + all-lines)) + (setq all-lines-lbp (cons lbp all-lines-lbp))) (forward-line 1)) - + (kill-buffer org-index--occur-buffer-name) ; cannot keep this buffer; might become stale soon ;; create new buffer (setq occur-buffer (get-buffer-create org-index--occur-buffer-name)) (pop-to-buffer-same-window occur-buffer) (insert org-index--headings) - (setq end-of-head (point)) + (setq header-lines (line-number-at-pos)) ;; insert into new buffer (save-excursion (apply 'insert (reverse all-lines)) (if (= lines-collected lines-wanted) (insert "\n(more lines omitted)\n"))) - + (setq org-index--occur-lines-collected lines-collected) + (org-mode) (setq truncate-lines t) - (if (org-at-table-p) (org-table-align)) - (font-lock-fontify-buffer) + (if all-lines (org-index--align-and-fontify-current-line (length all-lines))) + (font-lock-ensure) + (font-lock-flush) + (when all-lines-lbp + (while (not (org-at-table-p)) + (forward-line -1)) + (while all-lines-lbp + (put-text-property (line-beginning-position) (line-end-position) 'org-index-lbp (car all-lines-lbp)) + (setq all-lines-lbp (cdr all-lines-lbp)) + (forward-line -1))) ;; prepare help text - (setq org-index--occur-help-overlay (make-overlay (point-min) end-of-head)) + (goto-char (point-min)) + (forward-line (1- header-lines)) + (setq org-index--occur-help-overlay (make-overlay (point-min) (point))) (setq org-index--occur-help-text (cons (org-index--wrap - (concat "Search is done; `?' toggles help and headlines.\n")) + (propertize "Search is done; ? toggles help and headlines.\n" 'face 'org-agenda-dimmed-todo-face)) (concat - (org-index--wrap (format (concat "Search is done. " - (if (< lines-collected lines-wanted) - " Showing all %d matches for " - " Showing one window of matches for ") - "\"" search-text - "\". <return> jumps to heading, <tab> jumps to heading in other window, <S-return> to matching line in index, <space> increments count.\n" ) - (length all-lines))) + (org-index--wrap + (propertize + (format + (concat "Search is done." + (if (< lines-collected lines-wanted) + " Showing all %d matches for " + " Showing one window of matches for ") + "\"" search-text + "\". <return> jumps to heading, <tab> jumps to heading in other window, <S-return> jumps to matching line in index, <space> increments count.\n" these-commands "\n") + (length all-lines)) + 'face 'org-agenda-dimmed-todo-face)) org-index--headings))) - + (overlay-put org-index--occur-help-overlay 'display (car org-index--occur-help-text)) - (overlay-put org-index--occur-help-overlay 'face 'org-agenda-dimmed-todo-face) ;; highlight words (setq case-fold-search t) @@ -2307,15 +2784,16 @@ If OTHER in separate window." (mapc (lambda (x) (define-key keymap (kbd x) (lambda () (interactive) - (message "%s" (org-index--occur-to-head))))) + (message "%s" (org-index--occur-action))))) (list "<return>" "RET")) (define-key keymap (kbd "<tab>") (lambda () (interactive) - (message (org-index--occur-to-head t)))) - + (message (org-index--occur-action t)))) + (define-key keymap (kbd "SPC") (lambda () (interactive) + (org-index--refresh-parse-table) ;; increment in index (let ((ref (org-index--get-or-set-field 'ref)) count) @@ -2329,19 +2807,44 @@ If OTHER in separate window." (let ((inhibit-read-only t)) (org-index--get-or-set-field 'count (number-to-string count))) (message "Incremented count to %d" count)))) - + (define-key keymap (kbd "<S-return>") (lambda () (interactive) - (org-index 'enter (org-index--get-or-set-field 'ref)))) - + (let ((pos (get-text-property (point) 'org-index-lbp))) + (org-index--refresh-parse-table) + (org-index--occur-test-stale pos) + (pop-to-buffer org-index--buffer) + (goto-char pos) + (org-reveal t) + (org-index--update-current-line) + (beginning-of-line)))) + (define-key keymap (kbd "?") (lambda () (interactive) + (org-index--refresh-parse-table) (setq-local org-index--occur-help-text (cons (cdr org-index--occur-help-text) (car org-index--occur-help-text))) (overlay-put org-index--occur-help-overlay 'display (car org-index--occur-help-text)))) - + (use-local-map keymap)))) +(defun org-index--occur-test-stale (pos) + "Test, if current line in occur buffer has become stale at POS." + (let (here there) + (org-index--refresh-parse-table) + (setq here (org-index--line-in-canonical-form)) + (with-current-buffer org-index--buffer + (goto-char pos) + (setq there (org-index--line-in-canonical-form))) + (unless (string= here there) + (error "Occur buffer has become stale")))) + + +(defun org-index--line-in-canonical-form () + "Return current line in its canonical form." + (org-trim (substring-no-properties (replace-regexp-in-string "\s +" " " (buffer-substring (line-beginning-position) (line-beginning-position 2)))))) + + (defun org-index--wrap (text) "Wrap TEXT at fill column." (with-temp-buffer @@ -2350,13 +2853,27 @@ If OTHER in separate window." (buffer-string))) -(defun org-index--occur-to-head (&optional other) - "Helper for `org-index--occur', find heading with ref or id; if OTHER, in other window." - (let ((ref (org-index--get-or-set-field 'ref)) - (id (org-index--get-or-set-field 'id))) - (if id - (org-index--do-head ref id other) - (message "Current line has no id.")))) +(defun org-index--occur-action (&optional other) + "Helper for `org-index--occur', find heading with ref or id; if OTHER, in other window; or copy yank column." + (if (org-at-table-p) + (let ((id (org-index--get-or-set-field 'id)) + (ref (org-index--get-or-set-field 'ref)) + (yank (org-index--get-or-set-field 'yank))) + (if id + (org-index--find-id id other) + (if ref + (progn + (org-mark-ring-goto) + (format "Found reference %s (no node is associated)" ref)) + (if yank + (progn + (org-index--update-line (get-text-property (point) 'org-index-lbp)) + (setq yank (replace-regexp-in-string (regexp-quote "\\vert") "|" yank nil 'literal)) + (kill-new yank) + (org-mark-ring-goto) + (format "Copied '%s' (no node is associated)" yank)) + (error "Internal error, this line contains neither id, nor reference, nor text to yank"))))) + (message "Not at table"))) (defun org-index--hide-with-overlays (words lines-wanted) @@ -2398,8 +2915,8 @@ If OTHER in separate window." (when matched (forward-line 1) (setq end-of-visible (point)) - (incf lines-found))) - + (cl-incf lines-found))) + ;; put new list on top of stack (setq org-index--occur-stack (cons (list (cons :overlays overlays) @@ -2416,11 +2933,11 @@ If OTHER in separate window." ;; delete overlays and make visible again (mapc (lambda (y) (delete-overlay y)) - (cdr (assoc :overlays (car org-index--occur-stack)))) + (cdr (assq :overlays (car org-index--occur-stack)))) ;; remove from stack (setq org-index--occur-stack (cdr org-index--occur-stack)) ;; return number of lines, that are now visible - (if org-index--occur-stack (cdr (assoc :lines (car org-index--occur-stack)))))) + (if org-index--occur-stack (cdr (assq :lines (car org-index--occur-stack)))))) (defun org-index--test-words (words) @@ -2429,7 +2946,7 @@ If OTHER in separate window." (setq line (downcase (buffer-substring (line-beginning-position) (line-beginning-position 2)))) (catch 'not-found (dolist (w words) - (or (search w line) + (or (cl-search w line) (throw 'not-found nil))) t))) @@ -2437,29 +2954,21 @@ If OTHER in separate window." (defun org-index--create-new-line () "Do the common work for `org-index-new-line' and `org-index'." - (let (new) - - ;; construct new reference - (unless new - (setq new (format "%s%d%s" org-index--head (1+ org-index--maxref) org-index--tail))) - - ;; insert ref or id as last or first line, depending on sort-column - (goto-char org-index--below-hline) - (if (eq (org-index--special-column 'sort) 'count) - (progn - (while (org-at-table-p) - (forward-line)) - (forward-line -1) - (org-table-insert-row t)) - (org-table-insert-row)) - - ;; insert some of the standard values - (org-table-goto-column (org-index--column-num 'created)) - (org-insert-time-stamp nil nil t) - (org-table-goto-column (org-index--column-num 'count)) - (insert "1") + ;; insert ref or id as last or first line, depending on sort-column + (goto-char org-index--below-hline) + (if (eq org-index-sort-by 'count) + (progn + (while (org-at-table-p) + (forward-line)) + (forward-line -1) + (org-table-insert-row t)) + (org-table-insert-row)) - new)) + ;; insert some of the standard values + (org-table-goto-column (org-index--column-num 'created)) + (org-insert-time-stamp nil nil t) + (org-table-goto-column (org-index--column-num 'count)) + (insert "1")) (defun org-index--sort-silent () @@ -2468,13 +2977,13 @@ If OTHER in separate window." (org-index--verify-id) (org-index--parse-table) (org-index--on nil nil - (org-index--do-sort-index (org-index--special-column 'sort)) + (org-index--do-sort-index org-index-sort-by) (org-table-align) (remove-hook 'before-save-hook 'org-index--sort-silent)))) (defun org-index--copy-visible (beg end) - "Copy the visible parts of the region without adding it to kill-ring; copy of `org-copy-visible'" + "Copy the visible parts of the region between BEG and END without adding it to `kill-ring'; copy of `org-copy-visible'." (let (snippets s) (save-excursion (save-restriction |