diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..7e1b0c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,78 @@ +name: Bug Report +description: File a bug report +# labels: ["bug"] +# assignees: +# - alphapapa +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: os-platform + attributes: + label: OS/platform + description: What operating system or platform are you running Emacs on? + validations: + required: true + - type: textarea + id: emacs-provenance + attributes: + label: Emacs version and provenance + description: What version of Emacs are you using, where did you acquire it, and how did you install it? + validations: + required: true + - type: input + id: emacs-command + attributes: + label: Emacs command + description: By what method did you run Emacs? (i.e. what command did you run?) + validations: + required: true + - type: textarea + id: org-provenance + attributes: + label: Org version and provenance + description: What version of Org are you using, where did you acquire it, and how did you install it? + validations: + required: true + - type: input + id: package-provenance + attributes: + label: org-ql package version and provenance + description: What version of org-ql are you using, where did you acquire it, and how did you install it? + validations: + required: true + - type: textarea + id: actions + attributes: + label: Actions taken + description: What actions did you take, step-by-step, in order, before the problem was noticed? + validations: + required: true + - type: textarea + id: results + attributes: + label: Observed results + description: What behavior did you observe that seemed wrong? + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected results + description: What behavior did you expect to observe? + validations: + required: true + - type: textarea + id: backtrace + attributes: + label: Backtrace + description: If an error was signaled, please use `M-x toggle-debug-on-error RET` and cause the error to happen again, then paste the contents of the `*Backtrace*` buffer here. + render: elisp + - type: textarea + id: etc + attributes: + label: Etc. + description: Any other information that seems relevant + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..7e36d80 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Support questions + url: https://github.com/alphapapa/org-ql/discussions + about: Please ask and answer support questions here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..7b14c94 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,45 @@ +name: Feature Request +description: File a feature request +labels: ["enhancement"] +body: + - type: input + id: os-platform + attributes: + label: OS/platform + description: What operating system or platform are you running Emacs on? + validations: + required: true + - type: textarea + id: emacs-provenance + attributes: + label: Emacs version and provenance + description: What version of Emacs are you using, where did you acquire it, and how did you install it? + validations: + required: true + - type: textarea + id: org-provenance + attributes: + label: Org version and provenance + description: What version of Org are you using, where did you acquire it, and how did you install it? + validations: + required: true + - type: input + id: package-provenance + attributes: + label: org-ql package version and provenance + description: What version of org-ql are you using, where did you acquire it, and how did you install it? + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: Describe your request. + validations: + required: true + - type: textarea + id: etc + attributes: + label: Etc. + description: Any other information that seems relevant + diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index bbedb2e..2de58b4 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -41,9 +41,14 @@ jobs: fail-fast: false matrix: emacs_version: - - 26.3 - 27.1 - 27.2 + - 28.1 + - 28.2 + - 29.1 + - 29.2 + - 29.3 + - 29.4 - snapshot steps: - uses: purcell/setup-emacs@master diff --git a/README.org b/README.org index 10d6e07..457dedd 100644 --- a/README.org +++ b/README.org @@ -1,7 +1,6 @@ #+TITLE: org-ql # NOTE: Using =BEGIN_HTML= for this causes TeX/info export to fail, but this HTML block works. -# #+HTML: #+HTML: # NOTE: To avoid having this in the info manual, we use HTML rather than Org syntax; it still appears with the GitHub renderer. @@ -20,6 +19,7 @@ It includes three libraries: The =org-ql= library is flexible and may be used as - [[#installation][Installation]] - [[#usage][Usage]] - [[#changelog][Changelog]] +- [[#development][Development]] :END: @@ -112,11 +112,24 @@ Lisp code examples are in [[examples.org]]. These commands jump to a heading selected using Emacs's built-in completion facilities with an Org QL query: - ~org-ql-find~ searches in the current buffer. +- ~org-ql-find-path~ searches outline paths in the current buffer. - ~org-ql-find-in-agenda~ searches in ~(org-agenda-files)~. - ~org-ql-find-in-org-directory~ searches in ~org-directory~. +Note that these commands are compatible with [[https://github.com/oantolin/embark][Embark]]: the ~embark-act~ command can be called on a completion candidate (i.e. a search result) to act on it immediately, without having to visit the entry in its source Org buffer, and ~embark-export~ may be called to show the results in an ~org-ql-view~ buffer. + [[images/org-ql-find.png]] +*** org-ql-open-link + +This command finds links in entries matching the input query and offers them for selection; the selected link is then opened with ~org-open-at-point~. + +The input is matched using the default predicate, which means it searches both entry content and outline paths. This is helpful when a collection of links are kept in Org files: rather than having to first visit the entry containing the desired link, then locate it within the entry, and then open it, the user can simply select the link and open it directly. For example, if an entry with the heading =Emacs= contained a link named =mailing list=, one could search for =Emacs list= and open the link to the mailing list directly. + +*** org-ql-refile + +This command refiles the current Org entry to one selected by searching with Org QL completion. It searches files listed in ~org-refile-targets~ as well as the current buffer. + *** org-ql-search /Note: This command supports both sexp queries and [[#non-sexp-query-syntax][non-sexp queries]]./ @@ -143,6 +156,8 @@ Read ~QUERY~ and search with ~org-ql~. Interactively, prompt for these variable *Note:* The view buffer is currently put in ~org-agenda-mode~, which means that /some/ Org Agenda commands work, such as jumping to entries and changing item priorities (without necessarily updating the view). This feature is experimental and not guaranteed to work correctly with all commands. (It works to the extent it does because the appropriate text properties are placed on each item, imitating an Agenda buffer.) +*Note:* Also, this buffer is compatible with [[https://github.com/oantolin/embark][Embark]]: the ~embark-act~ command can be called on an entry to act on it immediately, without having to visit the entry in its source Org buffer. + *** helm-org-ql /Note: This command uses [[#non-sexp-query-syntax][non-sexp queries]]. It is available separately in the package =helm-org-ql=./ @@ -217,7 +232,8 @@ Note that the =effort=, =level=, and =priority= predicates do not support compar Arguments are listed next to predicate names, where applicable. -+ =category (&optional categories)= :: Return non-nil if current heading is in one or more of ~CATEGORIES~ (a list of strings). ++ =blocked= :: Return non-nil if current heading is blocked. Calls ~org-entry-blocked-p~, which see. ++ =category (&rest categories)= :: Return non-nil if current heading is in one or more of ~CATEGORIES~ (a list of strings). + =done= :: Return non-nil if entry's ~TODO~ keyword is in ~org-done-keywords~. + =effort (&optional effort-or-comparator effort)= :: Return non-nil if current heading's effort property matches arguments. The following forms are accepted: ~(effort DURATION)~: Matches if effort is ~DURATION~. ~(effort DURATION DURATION)~: Matches if effort is between DURATIONs, inclusive. ~(effort COMPARATOR DURATION)~: Matches if effort compares to ~DURATION~ with ~COMPARATOR~. ~COMPARATOR~ may be ~<~, ~<=~, ~>~, or ~>=~. ~DURATION~ should be an Org effort string, like =5= or =0:05=. + =habit= :: Return non-nil if entry is a habit. @@ -233,23 +249,23 @@ Arguments are listed next to predicate names, where applicable. - Aliases: ~olps~. + =path (&rest regexps)= :: Return non-nil if current heading's buffer's filename path matches any of ~REGEXPS~ (regexp strings). Without arguments, return non-nil if buffer is file-backed. + =priority (&rest args)= :: Return non-nil if current heading has a certain priority. ~ARGS~ may be either a list of one or more priority letters as strings, or a comparator function symbol followed by a priority letter string. For example: ~(priority "A") (priority "A" "B") (priority '>= "B")~ Note that items without a priority cookie never match this predicate (while Org itself considers items without a cookie to have the default priority, which, by default, is equal to priority ~B~). -+ =property (property &optional value)= :: Return non-nil if current entry has ~PROPERTY~ (a string), and optionally ~VALUE~ (a string). Note that property inheritance is currently /not/ enabled for this predicate. If you need to test with inheritance, you could use a custom predicate form, like ~(org-entry-get (point) "PROPERTY" 'inherit)~. ++ =property (property &optional value &key inherit)= :: Return non-nil if current entry has ~PROPERTY~ (a string), and optionally ~VALUE~ (a string). If ~INHERIT~ is nil, only match entries with ~PROPERTY~ set on the entry; if t, also match entries with inheritance. If ~INHERIT~ is not specified, use the value of ~org-use-property-inheritance~, which see. + =regexp (&rest regexps)= :: Return non-nil if current entry matches all of ~REGEXPS~ (regexp strings). Matches against entire entry, from beginning of its heading to the next heading. - Aliases: =r=. + =rifle (&rest strings)= :: Return non-nil if each string is found in either the entry or its outline path. Works like =org-rifle=. This is probably the most useful, intuitive, general-purpose predicate. - Aliases: ~smart~. - *Note:* By default, this is the default predicate used for plain-string query tokens (i.e. given without a specified predicate). This can be customized with the option ~org-ql-default-predicate~. -+ ~src (&key lang regexps)~ :: Return non-nil if current entry contains an Org Babel source block. If ~LANG~ is non-nil, match blocks of that language. If ~REGEXPS~ is non-nil, require that block's contents match all regexps. -+ =tags (&optional tags)= :: Return non-nil if current heading has one or more of ~TAGS~ (a list of strings). Tests both inherited and local tags. -+ =tags-inherited (&optional tags)= :: Return non-nil if current heading's inherited tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any inherited tags. ++ ~src (&key lang regexps)~ :: Return non-nil if current entry contains an Org Babel source block. If ~LANG~ is non-nil, match blocks of that language. If ~REGEXPS~ is non-nil, require that block's contents match all regexps. Matching is done case-insensitively. ++ =tags (&rest tags)= :: Return non-nil if current heading has one or more of ~TAGS~ (a list of strings). Tests both inherited and local tags. ++ =tags-inherited (&rest tags)= :: Return non-nil if current heading's inherited tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any inherited tags. - Aliases: ~inherited-tags~, ~tags-i~, ~itags~. -+ =tags-local (&optional tags)= :: Return non-nil if current heading's local tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any local tags. ++ =tags-local (&rest tags)= :: Return non-nil if current heading's local tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any local tags. - Aliases: ~local-tags~, ~tags-l~, ~ltags~. -+ =tags-all (tags)= :: Return non-nil if current heading includes all of ~TAGS~. Tests both inherited and local tags. ++ =tags-all (&rest tags)= :: Return non-nil if current heading includes all of ~TAGS~. Tests both inherited and local tags. - Aliases: ~tags&~. + =tags-regexp (&rest regexps)= :: Return non-nil if current heading has tags matching one or more of ~REGEXPS~. Tests both inherited and local tags. - Aliases: ~tags*~. -+ =todo (&optional keywords)= :: Return non-nil if current heading is a ~TODO~ item. With ~KEYWORDS~, return non-nil if its keyword is one of ~KEYWORDS~ (a list of strings). When called without arguments, only matches non-done tasks (i.e. does not match keywords in ~org-done-keywords~). ++ =todo (&rest keywords)= :: Return non-nil if current heading is a ~TODO~ item. With ~KEYWORDS~, return non-nil if its keyword is one of ~KEYWORDS~ (a list of strings). When called without arguments, only matches non-done tasks (i.e. does not match keywords in ~org-done-keywords~). *** Ancestor/descendant predicates @@ -538,19 +554,177 @@ Simple links may also be written manually in either sexp or non-sexp form, like: /Note:/ Breaking changes may be made before version 1.0, but in the event of major changes, attempts at backward compatibility will be made with obsolescence declarations, translation of arguments, etc. Users who need stability guarantees before 1.0 may choose to use tagged stable releases. -** 0.7-pre +** 0.9-pre + +*Additions* ++ Face ~org-ql-view-query~, applied to view queries in header line. ++ Face ~org-ql-view-title~, applied to view titles in header line. ++ Option ~org-ql-view-relative-deadline-prefix~. + +*Changes* ++ Command ~org-ql-find~ respects narrowing of the current buffer by default, allowing searching within the narrowed region. (Using one ~C-u~ argument widens the current buffer, and using two ~C-u~ arguments prompts for the buffers to search.) ++ Function ~org-ql-completing-read~ accepts a new ~NARROWP~ argument, which is passed to ~org-ql-select~. + +*Fixes* ++ Customization group for face ~org-ql-view-due-date~. ++ Apply Org syntax font-locking to items in ~org-ql-view~ buffers. + +*** helm-org-ql + +Tagged v0.6.2, fixing a compilation warning. + +** 0.8.10 + +*Fixes* ++ Command ~org-ql-refile~ uses the base buffer when refiling to an indirect buffer. ([[https://github.com/alphapapa/org-ql/issues/466][#466]].) ++ Predicate ~link~ could signal an error when searching text that is mistakenly recognized as an Org link (e.g. Bash double-bracket constructs in a source block). (Thanks to [[https://github.com/jwiegley][John Wiegley]] for reporting.) + +** 0.8.9 + +*Fixes* ++ Predicate ~property~ when called with argument form ~(property "PROPERTY-NAME" :inherit t)~. ([[https://github.com/alphapapa/org-ql/issues/460][#460]]. Thanks to [[https://github.com/Stewmath][Stewmath]] for reporting.) ++ Predicate ~level~'s preamble optimizer allows expressions in place of the numeric argument. (See [[https://github.com/alphapapa/org-ql/issues/460][#460]]. Thanks to [[https://github.com/Stewmath][Stewmath]] for reporting.) ++ Reading of view settings from Org links in upcoming Emacs version. ([[https://github.com/alphapapa/org-ql/issues/461][#461]]. Thanks to [[https://github.com/snogge][Ola Nilsson]] for help debugging, and for maintaining [[https://github.com/jorgenschaefer/emacs-buttercup][Buttercup]].) + +*Compatibility* ++ Fix compilation error on Emacs 30. ([[https://github.com/alphapapa/org-ql/issues/433][#433]]. Thanks to [[https://github.com/akirak][Akira Komamura]] and [[https://github.com/monnier][Stefan Monnier]].) + +** 0.8.8 + +*Fixes* ++ Remove text properties from to-do keywords before displaying them in an ~org-ql-view~ buffer. (Such text properties could cause them to, e.g. display with extra leading spaces, depending on which other modes might be enabled in the source Org buffer.) ++ Binding of ~completion-styles-alist~ in ~org-ql-completing-read~. (This fixes compatibility with Helm's ~helm~ completion style, as well as default Emacs completion in recursive minibuffers. [[https://github.com/alphapapa/org-ql/issues/337][#337]]. Thanks to [[https://github.com/progfolio][Nicholas Vollmer]], [[https://github.com/9viz][viz]], and [[https://github.com/karthink][Karthik Chikmagalur]] for reporting and suggesting fixes.) ++ Use of the context snippet function for ~org-ql-completing-read~. ([[https://github.com/alphapapa/org-ql/issues/419][#419]]. Thanks to [[https://github.com/tpeacock19][tpeacock19]] for reporting.) + +** 0.8.7 + +*Fixes* ++ Timestamps with internal time ranges (e.g. ~<2024-06-26 10:00-11:00>~) are matched for simple queries. (This support is not yet comprehensive, e.g. a query that depends on the specific inner time range may not behave as expected. Previously such timestamps were not matched at all. See [[https://github.com/alphapapa/org-ql/pull/237][#237]] and [[https://github.com/alphapapa/org-ql/issues/371][#371]]. Thanks to [[https://github.com/yantar92][Ihor Radchenko]].) ++ Timestamps with day-of-the-week abbreviations are matched more flexibly (allowing, e.g. a period in French locales). (See [[https://github.com/alphapapa/org-ql/discussions/429][#429]], [[https://github.com/alphapapa/org-ql/issues/432][#432]]. Thanks to [[https://github.com/neurolit][Florian D.]] for reporting.) ++ Command ~org-ql-search~ did not narrow properly when called interactively. + +*Compatibility* ++ Dynamic blocks work with Org 9.7. ([[https://github.com/alphapapa/org-ql/issues/431][#431]]. Thanks to [[https://github.com/jezcope][Jez Cope]] for reporting.) + +** 0.8.6 + +*Fixes* ++ Bookmarking ~org-ql-view~ buffers when the ~buffers-files~ argument is a symbol (like ~org-agenda-files~). + +** 0.8.5 + +*Fixes* ++ Predicate ~heading~ incorrectly matched strings as regular expressions, sometimes returning incorrect results. (See [[https://github.com/alphapapa/org-ql/discussions/410][discussion]]. Thanks to [[https://github.com/al3xandru][Alex Popescu]] for reporting.) ++ Predicates ~ancestor~ and ~parent~ did not normalize their sub-queries, sometimes returning incorrect results. ([[https://github.com/alphapapa/org-ql/issues/365][#365]]. Thanks to [[https://github.com/kofm][Gabriele Mongiano]] for reporting.) + +** 0.8.4 + +*Fixes* + ++ Command ~org-ql-find~ goes to the selected entry in the base buffer (rather than potentially an indirect buffer, whose narrowing could leave the selected entry hidden. The nuances around going to entries in buffers that may be indirect and/or narrowed are surprisingly complicated. Hopefully this is the last fix). + +** 0.8.3 + +*Fixes* + ++ Command ~org-ql-find~ incorrectly moved point. (See [[https://github.com/alphapapa/org-ql/issues/380#issuecomment-1881913025][#380]]. Thanks to [[https://github.com/oantolin][Omar Antolín Camarena]] for reporting.) + +** 0.8.2 + +*Fixes* + ++ Command ~org-ql-find~ incorrectly restored the buffer after jumping when not using indirect buffers. (See [[https://github.com/alphapapa/org-ql/issues/380#issuecomment-1881913025][#380]]. Thanks to [[https://github.com/bram85][Bram Schoenmakers]] for reporting.) + +** 0.8.1 + +*Fixes* + ++ Command ~org-ql-find~ widens the buffer before going to the selected entry. ++ In ~org-ql-view~ buffers, links in headings remain clickable links. (Fixes [[https://github.com/alphapapa/org-ql/issues/282][#282]]. Thanks to [[https://github.com/jakebox][Jacob Boxerman]] for reporting.) + +** 0.8 + +*Additions* + ++ Function ~org-ql-completing-read~, used by command ~org-ql-find~, now specifies the completion category as ~org-heading~, providing compatibility with [[https://github.com/oantolin/embark][Embark]]. (This is a powerful feature, as it means any ~org-ql-find~ result can be acted on from inside the search results with Embark, which provides common actions from Org Agenda and Org speed keys bindings.) ([[https://github.com/alphapapa/org-ql/issues/299][#299]]. Thanks to [[https://github.com/oantolin][Omar Antolín Camarena]], [[https://github.com/minad][Daniel Mendler]], and [[https://github.com/akirak][Akira Komamura]].) + - Command ~org-ql-completing-read-export~, bound to ~C-c C-e~ or ~embark-export~ while in an ~org-ql-completing-read~ session, exits and shows an ~org-ql-view~ buffer for the current search. ++ Command ~org-ql-find~ may be called in an ~org-agenda~ or ~org-ql-view~ buffer to search the buffers which contributed to the agenda/view buffer. ++ Command ~org-ql-find-path~, which searches outline paths in the current buffer. ++ Command ~org-ql-open-link~, which finds links in entries matching the given query, and opens the selected one with ~org-open-at-point~. (This is helpful when a collection of links are kept in Org files: rather than having to first visit the entry containing the desired link, then locate it within the entry, and then open it, the user can simply select the link and open it directly.) ++ Items in ~org-ql-view~ buffers now include the ~org-category~ text property, like Org Agenda buffers, which allows grouping with ~org-super-agenda~'s category-related selectors. ([[https://github.com/alphapapa/org-ql/issues/363][#363]]. Thanks to [[https://github.com/kofm][Gabriele Mongiano]] for reporting.) + +*Fixes* + ++ Predicate ~property~ correctly uses the value of ~org-use-property-inheritance~ when not specified. ([[https://github.com/alphapapa/org-ql/pull/346][#346]], [[https://github.com/alphapapa/org-ql/issues/356][#356]]. Thanks to [[https://github.com/bram85][Bram Schoenmakers]].) + +*Compatibility* + ++ Emacs 27.1 or later is now required. ++ Org v9.7's ~org-element~ API changes required some adjustments. ([[https://github.com/alphapapa/org-ql/issues/364][#364]]. Thanks to several users for reporting, and to [[https://github.com/yantar92][Ihor Radchenko]] for his feedback.) + +** 0.7.4 + +*Fixes* ++ Ignore empty quoted strings in plain-string queries ([[https://github.com/alphapapa/org-ql/issues/383][#383]]). + +** 0.7.3 + +*Fixes* ++ Disable ~case-fold-search~ when collecting headings in outline paths. (Headings that started with a word that is also a to-do keyword but with different capitalization would be matched incorrectly.) ++ Saving of ~org-ql-view~ views. ([[https://github.com/alphapapa/org-ql/issues/378][#378]]. Thanks to [[https://github.com/Pentaquark1][Pentaquark1]] for reporting.) ++ Command ~org-ql-find~ didn't move point to the selected entry. ([[https://github.com/alphapapa/org-ql/issues/380][#380]]. Thanks to [[https://github.com/oantolin][Omar Antolín Camarena]] for reporting.) + +** 0.7.2 + +*Fixes* ++ Timestamp predicates are more tolerant of partial input (e.g. preventing errors while the user is typing a query into ~org-ql-find~). ++ Query parser ignores leading whitespace (e.g. preventing errors while the user is typing a query into ~org-ql-find~). ++ Use of ~org-ql-find~ with ~:query-prefix~ argument prevented selection of results. ([[https://github.com/alphapapa/org-ql/issues/351][#351]]. Thanks to [[https://github.com/danielfleischer][Daniel Fleischer]] for reporting.) ++ Handle narrowed buffers correctly in ~org-ql-find~. ++ Warn about empty headings in ~org-ql-completing-read~ (the Org format allows a heading line to have no text, but it's useless for this purpose, and usually indicates unnoticed corruption). + +** 0.7.1 + +*Fixes* ++ Function ~org-ql-completing-read~ is more compatible with default Emacs completion. (See [[https://github.com/alphapapa/org-ql/issues/338][#338]]. Thanks to [[https://github.com/arozbiz][arozbiz]] for reporting.) ++ Function ~org-ql-completing-read~ would sometimes stop updating with changes in input. (See [[https://github.com/alphapapa/org-ql/issues/350][#350]]. Thanks to [[https://github.com/anpandey][Ankit Raj Pandey]] for reporting and fixing, and to [[https://github.com/minad][Daniel Mendler]] for advising.) ++ In ~org-ql-completing-read~, format links for display, and use ~org-entry-get~ internally rather than ~org-get-heading~. + +** 0.7 *Added* -+ Commands ~org-ql-find~, ~org-ql-find-heading~, and ~org-ql-find-path~, which jump to entries selected using Emacs's built-in completion facilities and Org QL queries (like ~helm-org-ql~, but doesn't require Helm.). ++ Command ~org-ql-find~, which jumps to entries selected using Emacs's built-in completion facilities and Org QL queries (like ~helm-org-ql~, but doesn't require Helm.). ++ Command ~org-ql-refile~, which refiles the entry at point to one selected using Org QL completion. + Predicate ~rifle~, which matches an entry if each of the given arguments is found in either the entry's contents or its outline path. This provides very intuitive results, mimicing the behavior of [[https://github.com/alphapapa/org-rifle][=org-rifle=]]. In fact, the results are so useful that it's now the default predicate for plain-string query tokens. (It is also aliased to ~smart~, since it's so "smart," and not all users have used =org-rifle=.) + Option ~org-ql-default-predicate~, applied to plain-string query tokens (before, the ~regexp~ predicate was always used, but now it may be customized). ++ Alias ~c~ for predicate ~category~. ++ Predicate ~property~ now accepts the argument ~:inherit~ to match entries with property inheritance, and when unspecified, the option ~org-use-property-inheritance~ controls whether inheritance is used. ++ Predicate ~blocked~. (Thanks to [[https://github.com/akirak][Akira Komamura]].) *Changed* + Give more useful error message for invalid queries. ++ Predicate ~src~ now matches case-insensitively. ++ Command ~org-ql-sparse-tree~ accepts both string and sexp queries. (Thanks to [[https://github.com/akirak][Akira Komamura]].) + +*Fixed* ++ Predicate ~link~ matches links whose descriptions contain escaped brackets (changed in Org 9.3). (Thanks to [[https://github.com/exot][Daniel Borchmann]] for reporting.) ++ Predicate ~src~'s matching of begin/end block lines, normalization of arguments, and handling in non-sexp queries. (Thanks to [[https://github.com/akirak][Akira Komamura]] for reporting.) ++ Predicate ~src~'s behavior with various arguments. ++ Various compilation warnings. *Internal* + Certain query predicates, when called multiple times in an ~and~ sub-expression, are optimized to a single call. + Use ~buffer-chars-modified-tick~ instead of ~buffer-modified-tick~. (Thanks to [[https://github.com/yantar92][Ihor Radchenko]].) ++ Implemented tests for ~src~ predicate. + +*Credits* ++ Thanks to [[https://github.com/chasecaleb][Caleb Chase]] for help with [[https://github.com/alphapapa/org-ql/pull/285][#285]], fixed in [[https://github.com/alphapapa/org-ql/commit/91908186fcca4b5fd2e9d26da5bc0375c2b41acf][9190818]]. + +** 0.6.3 + +*Fixed* ++ Non-sexp query parsing with updated version 1.0.1 of the ~peg~ package. (Fixes [[https://github.com/alphapapa/org-ql/issues/314][#314]], [[https://github.com/alphapapa/org-ql/issues/316][#316]]. Thanks to [[https://github.com/akirak][Akira Komamura]] and [[https://github.com/joonro][Joon Ro]] for reporting.) ++ Require library ~org-duration~ (apparently necessary in newer Org versions). ** 0.6.2 @@ -829,6 +1003,14 @@ Simple links may also be written manually in either sexp or non-sexp form, like: First tagged release. +* Development + +Bug reports, feature requests, and suggestions are welcome. For patches, see below. + +** Copyright assignment + +While Org QL is currently distributed in MELPA, it's [[https://github.com/alphapapa/org-ql/issues/409][intended]] to merge Org QL into Org mode. When that happens, it will become a part of Emacs and Org, and therefore cumulative contributions of more than 15 lines of code will require that the author assign copyright of such contributions to the FSF. Authors who are interested in doing so may contact [[mailto:assign@gnu.org][assign@gnu.org]] to request the appropriate form. + * Notes :PROPERTIES: :TOC: :ignore this diff --git a/helm-org-ql.el b/helm-org-ql.el index 38b9722..c6a38a7 100644 --- a/helm-org-ql.el +++ b/helm-org-ql.el @@ -2,8 +2,8 @@ ;; Author: Adam Porter ;; URL: https://github.com/alphapapa/org-ql -;; Version: 0.6.1 -;; Package-Requires: ((emacs "26.1") (dash "2.18.1") (s "1.12.0") (helm-org "1.0") (org-ql "0.6-pre")) +;; Version: 0.6.2 +;; Package-Requires: ((emacs "26.1") (compat "29.1.4.5") (dash "2.18.1") (s "1.12.0") (helm-org "1.0") (org-ql "0.6-pre")) ;;; Commentary: @@ -35,6 +35,7 @@ (require 'cl-lib) (require 'org) +(require 'compat) (require 'dash) (require 's) @@ -44,6 +45,15 @@ (require 'org-ql) (require 'org-ql-search) +(declare-function org-ql--normalize-query "org-ql" t t) + +;;;; Compatibility + +(defalias 'helm-org-ql--show-entry + (if (version< org-version "9.6") + 'org-show-entry + 'org-fold-show-entry)) + ;;;; Variables (defvar helm-org-ql-map @@ -59,8 +69,8 @@ Based on `helm-map'.") (helm-make-source "Org QL Views" 'helm-source-sync :candidates (lambda () (->> org-ql-views - (-map #'car) - (-sort #'string<))) + (-map #'car) + (-sort #'string<))) :action (list (cons "Show view" #'org-ql-view))) "Helm source for `org-ql-views'.") @@ -98,9 +108,11 @@ Based on `helm-map'.") Interactively, search the current buffer. Note that this command only accepts non-sexp, \"plain\" queries. +NAME is passed to `helm-org-ql-source', which see. + NOTE: Atoms in the query are turned into strings where appropriate, which makes it unnecessary to type quotation marks -around words that are intended to be searched for as indepenent +around words that are intended to be searched for as independent strings. All query tokens are wrapped in the operator BOOLEAN (default @@ -149,7 +161,7 @@ Is transformed into this query: ;; it to go to the previous heading. I don't know why it does that. (switch-to-buffer (marker-buffer marker)) (goto-char marker) - (org-show-entry)) + (helm-org-ql--show-entry)) (defun helm-org-ql-show-marker-indirect (marker) "Show heading at MARKER with `org-tree-to-indirect-buffer'." @@ -175,7 +187,7 @@ Is transformed into this query: ;;;###autoload (cl-defun helm-org-ql-source (buffers-files &key (name "helm-org-ql")) - "Return Helm source named NAME that searches BUFFERS-FILES with `helm-org-ql'." + "Return Helm source named NAME to search BUFFERS-FILES with `helm-org-ql'." ;; Expansion of `helm-build-sync-source' macro. (helm-make-source name 'helm-source-sync :candidates (lambda () @@ -199,7 +211,7 @@ Is transformed into this query: (defun helm-org-ql--heading (window-width) "Return string for Helm for heading at point. WINDOW-WIDTH should be the width of the Helm window." - (font-lock-ensure (point-at-bol) (point-at-eol)) + (font-lock-ensure (pos-bol) (pos-eol)) ;; TODO: It would be better to avoid calculating the prefix and width ;; at each heading, but there's no easy way to do that once in each ;; buffer, unless we manually called `org-ql' in each buffer, which @@ -209,8 +221,8 @@ WINDOW-WIDTH should be the width of the Helm window." (width (- window-width (length prefix))) (heading (org-get-heading t)) (path (-> (org-get-outline-path) - (org-format-outline-path width nil "") - (org-split-string ""))) + (org-format-outline-path width nil "") + (org-split-string ""))) (path (if helm-org-ql-reverse-paths (concat heading "\\" (s-join "\\" (nreverse path))) (concat (s-join "/" path) "/" heading)))) diff --git a/images/dont-tread-on-emacs-150.png b/images/dont-tread-on-emacs-150.png deleted file mode 100644 index 71f3736..0000000 Binary files a/images/dont-tread-on-emacs-150.png and /dev/null differ diff --git a/makem.sh b/makem.sh index d06bca3..fd81e0f 100755 --- a/makem.sh +++ b/makem.sh @@ -3,7 +3,7 @@ # * makem.sh --- Script to aid building and testing Emacs Lisp packages # URL: https://github.com/alphapapa/makem.sh -# Version: 0.6-pre +# Version: 0.7.1 # * Commentary: @@ -112,6 +112,12 @@ Source files are automatically discovered from git, or may be specified with options. Package dependencies are discovered from "Package-Requires" headers in source files, from -pkg.el files, and from a Cask file. + +Checkdoc's spell checker may not recognize some words, causing the +`lint-checkdoc' rule to fail. Custom words can be added in file-local +or directory-local variables using the variable +`ispell-buffer-session-localwords', which should be set to a list of +strings. EOF } @@ -177,6 +183,7 @@ function elisp-checkdoc-file { (setq makem-checkdoc-errors-p t) ;; Return nil because we *are* generating a buffered list of errors. nil)))) + (put 'ispell-buffer-session-localwords 'safe-local-variable #'list-of-strings-p) (mapcar #'checkdoc-file files) (when makem-checkdoc-errors-p (kill-emacs 1)))) @@ -300,7 +307,6 @@ function elisp-package-initialize-file { (setq package-archives (list (cons "gnu" "https://elpa.gnu.org/packages/") (cons "melpa" "https://melpa.org/packages/") (cons "melpa-stable" "https://stable.melpa.org/packages/"))) -$elisp_org_package_archive (package-initialize) EOF echo $file @@ -379,6 +385,36 @@ function byte-compile-file { # ** Files +function submodules { + # Echo a list of submodules's paths relative to the repo root. + # TODO: Parse with bash regexp instead of cut. + git submodule status | awk '{print $2}' +} + +function project-root { + # Echo the root of the project (or superproject, if running from + # within a submodule). + root_dir=$(git rev-parse --show-superproject-working-tree) + [[ $root_dir ]] || root_dir=$(git rev-parse --show-toplevel) + [[ $root_dir ]] || error "Can't find repo root." + + echo "$root_dir" +} + +function files-project { + # Echo a list of files in project; or with $1, files in it + # matching that pattern with "git ls-files". Excludes submodules. + [[ $1 ]] && pattern="/$1" || pattern="." + + local excludes + for submodule in $(submodules) + do + excludes+=(":!:$submodule") + done + + git ls-files -- "$pattern" "${excludes[@]}" +} + function dirs-project { # Echo list of directories to be used in load path. files-project-feature | dirnames @@ -387,7 +423,7 @@ function dirs-project { function files-project-elisp { # Echo list of Elisp files in project. - git ls-files 2>/dev/null \ + files-project 2>/dev/null \ | egrep "\.el$" \ | filter-files-exclude-default \ | filter-files-exclude-args @@ -396,13 +432,13 @@ function files-project-elisp { function files-project-feature { # Echo list of Elisp files that are not tests and provide a feature. files-project-elisp \ - | egrep -v "$test_files_regexp" \ + | grep -E -v "$test_files_regexp" \ | filter-files-feature } function files-project-test { # Echo list of Elisp test files. - files-project-elisp | egrep "$test_files_regexp" + files-project-elisp | grep -E "$test_files_regexp" } function dirnames { @@ -415,7 +451,7 @@ function dirnames { function filter-files-exclude-default { # Filter out paths (STDIN) which should be excluded by default. - egrep -v "(/\.cask/|-autoloads.el|.dir-locals)" + grep -E -v "(/\.cask/|-autoloads\.el|\.dir-locals)" } function filter-files-exclude-args { @@ -441,7 +477,7 @@ function filter-files-feature { # Read paths on STDIN and echo ones that (provide 'a-feature). while read path do - egrep "^\\(provide '" "$path" &>/dev/null \ + grep -E "^\\(provide '" "$path" &>/dev/null \ && echo "$path" done } @@ -489,7 +525,7 @@ function ert-tests-p { function package-main-file { # Echo the package's main file. - file_pkg=$(git ls-files ./*-pkg.el 2>/dev/null) + file_pkg=$(files-project "*-pkg.el" 2>/dev/null) if [[ $file_pkg ]] then @@ -512,23 +548,23 @@ function dependencies { # Search package headers. Use -a so grep won't think that an Elisp file containing # control characters (rare, but sometimes necessary) is binary and refuse to search it. - egrep -a -i '^;; Package-Requires: ' $(files-project-feature) $(files-project-test) \ - | egrep -o '\([^([:space:]][^)]*\)' \ - | egrep -o '^[^[:space:])]+' \ + grep -E -a -i '^;; Package-Requires: ' $(files-project-feature) $(files-project-test) \ + | grep -E -o '\([^([:space:]][^)]*\)' \ + | grep -E -o '^[^[:space:])]+' \ | sed -r 's/\(//g' \ - | egrep -v '^emacs$' # Ignore Emacs version requirement. + | grep -E -v '^emacs$' # Ignore Emacs version requirement. # Search Cask file. if [[ -r Cask ]] then - egrep '\(depends-on "[^"]+"' Cask \ + grep -E '\(depends-on "[^"]+"' Cask \ | sed -r -e 's/\(depends-on "([^"]+)".*/\1/g' fi # Search -pkg.el file. - if [[ $(git ls-files ./*-pkg.el 2>/dev/null) ]] + if [[ $(files-project "*-pkg.el" 2>/dev/null) ]] then - sed -nr 's/.*\(([-[:alnum:]]+)[[:blank:]]+"[.[:digit:]]+"\).*/\1/p' $(git ls-files ./*-pkg.el 2>/dev/null) + sed -nr 's/.*\(([-[:alnum:]]+)[[:blank:]]+"[.[:digit:]]+"\).*/\1/p' $(files-project- -- -pkg.el 2>/dev/null) fi } @@ -581,6 +617,9 @@ function sandbox { local deps=($(dependencies)) debug "Installing dependencies: ${deps[@]}" + # Ensure built-in packages get upgraded to newer versions from ELPA. + args_sandbox_package_install+=(--eval "(setq package-install-upgrade-built-in t)") + for package in "${deps[@]}" do args_sandbox_package_install+=(--eval "(package-install '$package)") @@ -1009,7 +1048,8 @@ function test-buttercup { run_emacs \ $(args-load-files "${files_project_test[@]}") \ - -f buttercup-run \ + --load "$buttercup_file" \ + --eval "(progn (setq backtrace-on-error-noninteractive nil) (buttercup-run))" \ && success "Buttercup tests finished without errors." \ || error "Buttercup tests failed." } @@ -1083,21 +1123,15 @@ args_package_archives=( --eval "(add-to-list 'package-archives '(\"melpa\" . \"https://melpa.org/packages/\") t)" ) -args_org_package_archives=( - --eval "(add-to-list 'package-archives '(\"org\" . \"https://orgmode.org/elpa/\") t)" -) - args_package_init=( --eval "(package-initialize)" ) -elisp_org_package_archive="(add-to-list 'package-archives '(\"org\" . \"https://orgmode.org/elpa/\") t)" - # * Args args=$(getopt -n "$0" \ - -o dhce:E:i:s::vf:CO \ - -l compile-batch,exclude:,emacs:,install-deps,install-linters,debug,debug-load-path,help,install:,verbose,file:,no-color,no-compile,no-org-repo,sandbox:: \ + -o dhce:E:i:s::vf:C \ + -l compile-batch,exclude:,emacs:,install-deps,install-linters,debug,debug-load-path,help,install:,verbose,file:,no-color,no-compile,sandbox:: \ -- "$@") \ || { usage; exit 1; } eval set -- "$args" @@ -1161,9 +1195,6 @@ do shift args_files+=("$1") ;; - -O|--no-org-repo) - unset elisp_org_package_archive - ;; --no-color) unset color ;; @@ -1192,6 +1223,9 @@ paths_temp+=("$package_initialize_file") trap cleanup EXIT INT TERM +# Change to project root directory first. +cd "$(project-root)" + # Discover project files. files_project_feature=($(files-project-feature)) files_project_test=($(files-project-test)) diff --git a/org-ql-completing-read.el b/org-ql-completing-read.el new file mode 100644 index 0000000..93dbf00 --- /dev/null +++ b/org-ql-completing-read.el @@ -0,0 +1,402 @@ +;;; org-ql-completing-read.el --- Completing read of Org entries using org-ql -*- lexical-binding: t; -*- + +;; Copyright (C) 2022-2023 Adam Porter + +;; Author: Adam Porter + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Commentary: + +;; This library provides completing-read of Org entries using `org-ql' +;; search. + +;;; Code: + +(require 'org-ql) + +(declare-function org-ql-search "org-ql-search") +(declare-function org-ql--normalize-query "org-ql" t t) + +;;;; Variables + +(defvar-keymap org-ql-completing-read-map + :doc "Active during `org-ql-completing-read' sessions." + "C-c C-e" #'org-ql-completing-read-export) + +;; `embark-collect' doesn't work for `org-ql-completing-read', so remap +;; it to `embark-export' (which `keymap-set', et al doesn't allow). +(define-key org-ql-completing-read-map [remap embark-collect] 'embark-export) + +;;;; Customization + +(defgroup org-ql-completing-read nil + "Completing-read of Org entries using `org-ql' search." + :group 'org-ql) + +(defcustom org-ql-completing-read-reverse-paths t + "Whether to reverse Org outline paths in `org-ql-completing-read' results." + :type 'boolean) + +(defcustom org-ql-completing-read-snippet-function #'org-ql-completing-read--snippet-simple + ;; TODO(v0.9): Performance of completion annotations seems to be + ;; much improved now (whether due to changes in Emacs, Vertico, or + ;; both, I don't know). It may be reasonable to make the context + ;; snippet the default now. + "Function used to annotate results in `org-ql-completing-read'. +Function is called at entry beginning. (When set to +`org-ql-completing-read--snippet-regexp', it is called with a +regexp matching plain query tokens.)" + :type '(choice (function-item :tag "Show context around search terms" org-ql-completing-read--snippet-regexp) + (function-item :tag "Show first N characters" org-ql-completing-read--snippet-simple) + (function :tag "Custom function"))) + +(defcustom org-ql-completing-read-snippet-length 51 + "Size of snippets of entry content to include in completion annotations. +Only used when `org-ql-completing-read-snippet-function' is set +to `org-ql-completing-read--snippet-regexp'." + :type 'integer) + +(defcustom org-ql-completing-read-snippet-minimum-token-length 3 + "Query tokens shorter than this many characters are ignored. +That is, they are not included when gathering entry snippets. +This avoids too-small tokens causing performance problems." + :type 'integer) + +(defcustom org-ql-completing-read-snippet-prefix nil + "String prepended to snippets. +For an experience like `org-rifle', use a newline." + :type '(choice (const :tag "None (shown on same line)" nil) + (const :tag "New line (shown under heading)" "\n") + string)) + +(defface org-ql-completing-read-snippet '((t (:inherit font-lock-comment-face))) + "Snippets.") + +(defvar org-ql-completing-read-input-regexp nil + "Current regexp for `org-ql-completing-read' input. +To be used in, e.g. annotation functions.") + +;;;; Functions + +(defun org-ql-completing-read-action () + "Default action for `org-ql-completing-read'. +Returns (STRING . MARKER) cons for entry at point." + (font-lock-ensure (pos-bol) (pos-eol)) + (cons (org-link-display-format (org-entry-get nil "ITEM")) (point-marker))) + +(defun org-ql-completing-read-snippet (marker) + "Return snippet for entry at MARKER. +Returns value returned by function +`org-ql-completing-read-snippet-function' or +`org-ql-completing-read--snippet-simple', whichever returns a +value, or nil." + (pcase (while-no-input + ;; Using `while-no-input' here doesn't make it as + ;; responsive as, e.g. Helm while typing, but it seems to + ;; help a little when using the org-rifle-style snippets. + (org-with-point-at marker + (or (funcall org-ql-completing-read-snippet-function + org-ql-completing-read-input-regexp) + (org-ql-completing-read--snippet-simple)))) + (`t ;; Interrupted: return nil (which can be concatted). + nil) + (else (propertize (concat " " else) + 'face 'org-ql-completing-read-snippet)))) + +(defun org-ql-completing-read-path (marker) + "Return formatted outline path for entry at MARKER." + (org-with-point-at marker + (let ((path (thread-first (org-get-outline-path nil t) + (org-format-outline-path (window-width) nil "") + (org-split-string "")))) + (if org-ql-completing-read-reverse-paths + (concat "\\" (string-join (reverse path) "\\")) + (concat "/" (string-join path "/")))))) + +;;;;; Completing read + +(defun org-ql-completing-read-export () + "Show `org-ql-view' buffer for current `org-ql-completing-read'-based search." + (interactive) + (user-error "Not in an `org-ql-completing-read' session")) + +;;;###autoload +(cl-defun org-ql-completing-read + (buffers-files &key query-prefix query-filter narrowp + (action #'org-ql-completing-read-action) + ;; FIXME: Unused argument. + ;; (annotate #'org-ql-completing-read-snippet) + (snippet #'org-ql-completing-read-snippet) + (path #'org-ql-completing-read-path) + (action-filter #'list) + (prompt "Find entry: ")) + "Return marker at entry in BUFFERS-FILES selected with `org-ql'. +PROMPT is shown to the user. + +NARROWP is passed to `org-ql-select', which see. + +QUERY-PREFIX may be a string to prepend to the query entered by +the user (e.g. use \"heading:\" to only search headings, easily +creating a custom command that saves the user from having to type +it). + +QUERY-FILTER may be a function through which the query the user +types is filtered before execution (e.g. it could replace spaces +with commas to turn multiple tokens, which would normally be +treated as multiple predicates, into multiple arguments to a +single predicate)." + (declare (indent defun)) + ;; Emacs's completion API is not always easy to understand, especially when using "programmed + ;; completion." This code was made possible by the example Clemens Radermacher shared at + ;; . + + ;; NOTE: I don't usually leave commented-out debugging code, but due to the incredibly tedious + ;; complexity of the "Programmed Completion" API and the time spent trying to get this reasonably + ;; close to "correct," I'm leaving it in, because I will undoubtedly have to go through this + ;; process again. + + ;; (message "ORG-QL-COMPLETING-READ: Starts.") + (let ((table (make-hash-table :test #'equal)) + (disambiguations (make-hash-table :test #'equal)) + (window-width (window-width)) + last-input org-outline-path-cache query-tokens) + (cl-labels (;; (debug-message + ;; (f &rest args) (apply #'message (concat "ORG-QL-COMPLETING-READ: " f) args)) + (action () + (font-lock-ensure (pos-bol) (pos-eol)) + ;; This function needs to handle multiple candidates per + ;; call, so we loop over a list of values by default. + (pcase-dolist (`(,string . ,marker) (funcall action-filter (funcall action))) + (when string + (if (string-empty-p string) + ;; A heading's string can be empty, but we can't use one because it + ;; wouldn't be useful to the user; and if one is found, it's very + ;; likely to indicate an unnoticed mistake or corruption in the + ;; file: so display a warning and don't record it as a candidate. + (display-warning 'org-ql-completing-read (format-message "Empty heading at %S" marker)) + (when (gethash string table) + ;; Disambiguate string (even adding the path isn't enough, because that could + ;; also be duplicated). + (if-let ((suffix (gethash string disambiguations))) + (setf string (format "%s <%s>" string (cl-incf suffix))) + (setf string (format "%s <%s>" string (puthash string 2 disambiguations))))) + (puthash (propertize string 'org-marker marker) marker table))))) + (path (marker) + (org-with-point-at marker + (let* ((path (thread-first (org-get-outline-path nil t) + (org-format-outline-path window-width nil "") + (org-split-string ""))) + (formatted-path (if org-ql-completing-read-reverse-paths + (concat "\\" (string-join (reverse path) "\\")) + (concat "/" (string-join path "/"))))) + formatted-path))) + (todo (marker) + (if-let (it (org-entry-get marker "TODO")) + (concat (propertize it 'face (org-get-todo-face it)) " ") + "")) + (affix (completions) + ;; (debug-message "AFFIX:%S" completions) + (cl-loop for completion in completions + for marker = (get-text-property 0 'org-marker completion) + for prefix = (todo marker) + for suffix = (concat (funcall path marker) " " (funcall snippet marker)) + collect (list completion prefix suffix))) + (annotate (candidate) + ;; (debug-message "ANNOTATE:%S" candidate) + (while-no-input + ;; Using `while-no-input' here doesn't make it as responsive as, + ;; e.g. Helm while typing, but it seems to help a little when using the + ;; org-rifle-style snippets. + (or (funcall snippet (get-text-property 0 'org-marker candidate)) ""))) + (group (candidate transform) + (pcase transform + (`nil (buffer-name (marker-buffer (get-text-property 0 'org-marker candidate)))) + (_ candidate))) + (try (string _collection _pred point &optional _metadata) + ;; (debug-message "TRY: STRING:%S" string) + (cons string point)) + (all (string table pred _point) + ;; (debug-message "all: STRING:%S" string) + ;; (debug-message "all-completions RETURNS: %S" (all-completions string table pred)) + (all-completions string table pred)) + (collection (input _pred flag) + (pcase flag + ('metadata (list 'metadata + (cons 'category 'org-heading) + (cons 'group-function #'group) + (cons 'affixation-function #'affix) + (cons 'annotation-function #'annotate) + (cons 'display-sort-function + (lambda (strings) + (let ((quoted-tokens (mapcar #'regexp-quote query-tokens))) + (sort strings + (lambda (a b) + (cl-labels ((matches + (s) (cl-loop for token in quoted-tokens + count (string-match-p token s)))) + (> (matches a) (matches b)))))))))) + (`t + ;; (debug-message "COLLECTION:t INPUT:%S KEYS:%S" + ;; input (hash-table-keys table)) + ;; It's not ideal to call `run-query' unconditionally here, but due to + ;; the complexity of the "Programmed Completion" API, it's basically + ;; necessary, and org-ql's caching should make it nearly free. + (run-query input) + (hash-table-keys table)) + ('lambda + ;; (debug-message "COLLECTION:lambda INPUT:%S KEYS:%S" + ;; input (hash-table-keys table)) + (if (not (hash-table-empty-p table)) + (when (gethash input table) + t) + (run-query input) + (when (gethash input table) + ;; (debug-message "COLLECTION:lambda INPUT:%S FOUND" input) + t))) + (`nil + ;; (debug-message "COLLECTION:nil INPUT:%S" input) + (if (not (hash-table-empty-p table)) + (when (gethash input table) + t) + (run-query input) + ;; (debug-message "COLLECTION:nil INPUT:%S KEYS:%S" + ;; input (hash-table-keys table)) + (cond ((hash-table-empty-p table) + nil) + ((gethash input table) + t) + (t + ;; FIXME: "it should return the longest common prefix + ;; substring of all matches otherwise"...but there's no + ;; function to compute that? At least returning an empty + ;; string doesn't seem to break anything. + input)))) + (`(boundaries . ,suffix) + ;; (debug-message "COLLECTION:boundaries INPUT:%S SUFFIX:%S KEYS:%S" + ;; input suffix (hash-table-keys table)) + ;; FIXME: This is unlikely to be correct, but I'm not even sure if it + ;; can be correct in this case since the input (e.g. "todo: foo") + ;; usually won't match a completion candidate directly. + `(boundaries 0 . ,(length suffix))))) + (run-query (input) + ;; (debug-message "RUN-QUERY:%S" input) + (when query-prefix + (setf input (concat query-prefix input))) + (unless (or (string-empty-p input) + (equal last-input input)) + ;; (debug-message "RUN-QUERY:%S RUNNING" input) + (setf last-input input) + ;; Clear hash table each time the user changes the input. + (clrhash table) + (clrhash disambiguations) + (when query-filter + (setf input (funcall query-filter input))) + (setf query-tokens + ;; Remove any tokens that specify predicates or are too short. + (--select (not (or (string-match-p (rx bos (1+ (not (any ":"))) ":") it) + (< (length it) org-ql-completing-read-snippet-minimum-token-length))) + (split-string input nil t (rx blank))) + org-ql-completing-read-input-regexp + (when query-tokens + ;; Limiting each context word to 15 characters prevents + ;; excessively long, non-word strings from ending up in + ;; snippets, which can adversely affect performance. + (rx-to-string `(seq (optional (repeat 1 3 (repeat 1 15 (not space)) (0+ space))) + bow (or ,@query-tokens) (0+ (not space)) + (optional (repeat 1 3 (0+ space) (repeat 1 15 (not space)))))))) + (org-ql-select buffers-files (org-ql--query-string-to-sexp input) + :narrow narrowp + :action #'action)))) + (unless (listp buffers-files) + ;; Since we map across this argument, we ensure it's a list. + (setf buffers-files (list buffers-files))) + ;; NOTE: It seems that the `completing-read' machinery can call, abort, and re-call the + ;; collection function while the user is typing, which can interrupt the machinery Org uses to + ;; prepare an Org buffer when an Org file is loaded. This results in, e.g. the buffer being + ;; left in fundamental-mode, unprepared to be used as an Org buffer, which breaks many things + ;; and is very confusing for the user. Ideally, of course, we would solve this in + ;; `org-ql-select', and we already attempt to, but that function is called by the + ;; `completing-read' machinery, which interrupts it, so we must work around this problem by + ;; ensuring all of the BUFFERS-FILES are loaded and initialized before calling + ;; `completing-read'. + (mapc #'org-ql--ensure-buffer buffers-files) + (let* ((completion-styles '(org-ql-completing-read)) + (completion-styles-alist (cons (list 'org-ql-completing-read #'try #'all "Org QL Find") + completion-styles-alist)) + (selected + (minibuffer-with-setup-hook + (lambda () + (use-local-map (make-composed-keymap org-ql-completing-read-map (current-local-map)))) + (cl-letf* (((symbol-function 'org-ql-completing-read-export) + (lambda () + (interactive) + (run-at-time 0 nil + #'org-ql-search + buffers-files + (minibuffer-contents-no-properties)) + (if (fboundp 'minibuffer-quit-recursive-edit) + (minibuffer-quit-recursive-edit) + (abort-recursive-edit)))) + ((symbol-function 'embark-export) + (symbol-function 'org-ql-completing-read-export))) + (completing-read prompt #'collection nil t))))) + ;; (debug-message "SELECTED:%S KEYS:%S" selected (hash-table-keys table)) + (or (gethash selected table) + ;; If there are completions in the table, but none of them exactly match the user input + ;; (e.g. a heading "foo" that matches a query "todo:"), `completing-read' will not + ;; select it automatically, so we return it ourselves. But note that this is not + ;; necessarily correct. For example, if the user types "todo:" and gets a list of + ;; completions ("foo" "bar"), and then changes the input to "ba" and presses RET + ;; immediately (without getting a new list of completions), the table will include "foo" + ;; and "bar", and we will return "foo"'s value rather than the first match for the query + ;; "ba", because `completing-read' will not cause the COLLECTION function to run a new + ;; query for the new input. + (car (hash-table-values table)) + (user-error "No results for input")))))) + +(defun org-ql-completing-read--snippet-simple (&optional _input-regexp) + "Return a snippet of the current entry. +Returns up to `org-ql-completing-read-snippet-length' characters." + (save-excursion + (org-end-of-meta-data t) + (unless (org-at-heading-p) + (let ((end (min (+ (point) org-ql-completing-read-snippet-length) + (org-entry-end-position)))) + (concat org-ql-completing-read-snippet-prefix + (truncate-string-to-width + (replace-regexp-in-string "\n" " " (buffer-substring (point) end) + t t) + 50 nil nil t)))))) + +(defun org-ql-completing-read--snippet-regexp (&optional input-regexp) + "Return a snippet of the current entry's matches for INPUT-REGEXP." + ;; REGEXP may be nil if there are no qualifying tokens in the query. + (when input-regexp + (save-excursion + (org-end-of-meta-data t) + (unless (org-at-heading-p) + (let* ((end (org-entry-end-position)) + (snippets (cl-loop while (re-search-forward input-regexp end t) + concat (match-string 0) concat "…" + do (goto-char (match-end 0))))) + (unless (string-empty-p snippets) + (concat org-ql-completing-read-snippet-prefix + (replace-regexp-in-string (rx (1+ "\n")) " " snippets t t)))))))) + +;;;; Footer + +(provide 'org-ql-completing-read) + +;;; org-ql-completing-read.el ends here diff --git a/org-ql-find.el b/org-ql-find.el index 4f8e981..e6c4795 100644 --- a/org-ql-find.el +++ b/org-ql-find.el @@ -1,6 +1,6 @@ ;;; org-ql-find.el --- Find headings with completion using org-ql -*- lexical-binding: t; -*- -;; Copyright (C) 2022 Adam Porter +;; Copyright (C) 2022-2023 Adam Porter ;; Author: Adam Porter @@ -31,6 +31,9 @@ (require 'org) (require 'org-ql) (require 'org-ql-search) +(require 'org-ql-completing-read) + +(declare-function org-ql--normalize-query "org-ql" t t) ;;;; Customization @@ -38,59 +41,31 @@ "Options for `org-ql-find'." :group 'org-ql) -(defcustom org-ql-find-reverse-paths t - "Whether to reverse Org outline paths in `org-ql-find' results." - :type 'boolean) - -(defcustom org-ql-find-goto-hook '(org-show-entry) +(defcustom org-ql-find-goto-hook '(org-show-entry org-reveal) "Functions called when selecting an entry." + ;; TODO: Add common choices, including `org-tree-to-indirect-buffer'. :type 'hook) -(defcustom org-ql-find-snippet-function #'org-ql-find--snippet-simple - ;; TODO: I'd like to make the -regexp one the default, but with - ;; default Emacs completion affixation, it can sometimes be a bit - ;; slow, and I don't want that to be a user's first impression. It - ;; may be possible to further optimize the -regexp one so that it - ;; can be used by default. In the meantime, the -simple one seems - ;; fast enough for general use. - "Function used to annotate results in `org-ql-find'. -Function is called at entry beginning. (When set to -`org-ql-find--snippet-regexp', it is called with a regexp -matching plain query tokens.)" - :type '(choice (function-item :tag "Show context around search terms" org-ql-find--snippet-regexp) - (function-item :tag "Show first N characters" org-ql-find--snippet-simple) - (function :tag "Custom function"))) +(defcustom org-ql-find-display-buffer-action '(display-buffer-same-window) + "Display buffer action list for `org-ql-find'. +See function `display-buffer'." + :type 'sexp) -(defcustom org-ql-find-snippet-length 51 - "Size of snippets of entry content to include in `org-ql-find' annotations. -Only used when `org-ql-find-snippet-function' is set to -`org-ql-find--snippet-regexp'." - :type 'integer) - -(defcustom org-ql-find-snippet-minimum-token-length 3 - "Query tokens shorter than this many characters are ignored. -That is, they are not included when gathering entry snippets. -This avoids too-small tokens causing performance problems." - :type 'integer) - -(defcustom org-ql-find-snippet-prefix nil - "String prepended to snippets. -For an experience like `org-rifle', use a newline." - :type '(choice (const :tag "None (shown on same line)" nil) - (const :tag "New line (shown under heading)" "\n") - string)) - -(defface org-ql-find-snippet '((t (:inherit font-lock-comment-face))) - "Snippets.") - -;;;; Functions +;;;; Commands ;;;###autoload -(cl-defun org-ql-find (buffers-files &key query-prefix query-filter +(cl-defun org-ql-find (buffers-files &key query-prefix query-filter widen (prompt "Find entry: ")) "Go to an Org entry in BUFFERS-FILES selected by searching entries with `org-ql'. -Interactively, with universal prefix, select multiple buffers to -search with completion. +Interactively, search the buffers and files relevant to the +current buffer (i.e. in `org-agenda-mode', the value of +`org-ql-view-buffers-files' or `org-agenda-contributing-files'; +in `org-mode', that buffer). + +With one or more universal prefix arguments, WIDEN buffers before +searching (otherwise, respect any narrowing). With two universal +prefix arguments, select multiple buffers to search with +completion and PROMPT. QUERY-PREFIX may be a string to prepend to the query (e.g. use \"heading:\" to only search headings, easily creating a custom @@ -101,121 +76,66 @@ types is filtered before execution (e.g. it could replace spaces with commas to turn multiple tokens, which would normally be treated as multiple predicates, into multiple arguments to a single predicate)." - (interactive - (list (if current-prefix-arg - (mapcar #'get-buffer - (completing-read-multiple - "Buffers: " - (mapcar #'buffer-name - (cl-remove-if-not (lambda (buffer) - (eq 'org-mode (buffer-local-value 'major-mode buffer))) - (buffer-list))) nil t)) - (progn - (unless (eq major-mode 'org-mode) - (user-error "This is not an Org buffer: %S" (current-buffer))) - (current-buffer))))) - ;; Emacs's completion API is not always easy to understand, - ;; especially when using "programmed completion." This code was - ;; made possible by the example Clemens Radermacher shared at - ;; . - (let ((table (make-hash-table :test #'equal)) - (window-width (window-width)) - query-tokens snippet-regexp) - (cl-labels ((action - () (font-lock-ensure (point-at-bol) (point-at-eol)) - (let* ((path (thread-first (org-get-outline-path t t) - (org-format-outline-path window-width nil "") - (org-split-string ""))) - (path (if org-ql-find-reverse-paths - (string-join (nreverse path) "\\") - (string-join path "/")))) - (puthash path (point-marker) table) - path)) - (affix (completions) - (cl-loop for completion in completions - for marker = (gethash completion table) - for todo-state = (if-let (it (org-entry-get marker "TODO")) - (concat (propertize it - 'face (org-get-todo-face it)) - " ") - "") - for snippet = (if-let (it (snippet marker)) - (propertize (concat " " it) - 'face 'org-ql-find-snippet) - "") - collect (list completion todo-state snippet))) - (annotate (candidate) - (while-no-input - ;; Using `while-no-input' here doesn't make it as - ;; responsive as, e.g. Helm while typing, but it seems to - ;; help a little when using the org-rifle-style snippets. - (or (snippet (gethash candidate table)) ""))) - (snippet (marker) - (org-with-point-at marker - (or (funcall org-ql-find-snippet-function snippet-regexp) - (org-ql-find--snippet-simple)))) - (group (candidate transform) - (pcase transform - (`nil (buffer-name (marker-buffer (gethash candidate table)))) - (_ candidate))) - (try (string _table _pred point &optional _metadata) - (cons string point)) - (all (string table pred _point) - (all-completions string table pred)) - (collection (str _pred flag) - (when query-prefix - (setf str (concat query-prefix str))) - (pcase flag - ('metadata (list 'metadata - (cons 'group-function #'group) - (cons 'affixation-function #'affix) - (cons 'annotation-function #'annotate))) - (`t (unless (string-empty-p str) - (when query-filter - (setf str (funcall query-filter str))) - (pcase org-ql-find-snippet-function - ('org-ql-find--snippet-regexp - (setf query-tokens - ;; Remove any tokens that specify predicates or are too short. - (--select (not (or (string-match-p (rx bos (1+ (not (any ":"))) ":") it) - (< (length it) org-ql-find-snippet-minimum-token-length))) - (split-string str nil t (rx space))) - snippet-regexp - (when query-tokens - ;; Limiting each context word to 15 characters - ;; prevents excessively long, non-word strings - ;; from ending up in snippets, which can - ;; adversely affect performance. - (rx-to-string `(seq (optional (repeat 1 3 (repeat 1 15 (not space)) (0+ space))) - bow (or ,@query-tokens) (0+ (not space)) - (optional (repeat 1 3 (0+ space) (repeat 1 15 (not space)))))))))) - (org-ql-select buffers-files (org-ql--query-string-to-sexp str) - :action #'action)))))) - ;; NOTE: It seems that the `completing-read' machinery can call, - ;; abort, and re-call the collection function while the user is - ;; typing, which can interrupt the machinery Org uses to prepare - ;; an Org buffer when an Org file is loaded. This results in, - ;; e.g. the buffer being left in fundamental-mode, unprepared to - ;; be used as an Org buffer, which breaks many things and is - ;; very confusing for the user. Ideally, of course, we would - ;; solve this in `org-ql-select', and we already attempt to, but - ;; that function is called by the `completing-read' machinery, - ;; which interrupts it, so we must work around this problem by - ;; ensuring all of the BUFFERS-FILES are loaded and initialized - ;; before calling `completing-read'. - (unless (listp buffers-files) - ;; Since we map across this argument, we ensure it's a list. - (setf buffers-files (list buffers-files))) - (mapc #'org-ql--ensure-buffer buffers-files) - (let* ((completion-styles '(org-ql-find)) - (completion-styles-alist (list (list 'org-ql-find #'try #'all "Org QL Find"))) - (selected (completing-read prompt #'collection nil)) - (marker (gethash selected table))) - (with-current-buffer (marker-buffer marker) - (goto-char marker) - (display-buffer (current-buffer)) - (select-window (get-buffer-window (current-buffer))) - (run-hook-with-args 'org-ql-find-goto-hook)))))) + (interactive (list (org-ql-find--buffers + :read-buffer-p (equal '(16) current-prefix-arg)) + :widen current-prefix-arg)) + (let ((marker (save-restriction + (when (and widen (equal (current-buffer) buffers-files)) + (widen)) + (org-ql-completing-read buffers-files + :narrowp (not widen) + :query-prefix query-prefix + :query-filter query-filter + :prompt prompt)))) + (set-buffer (or (buffer-base-buffer (marker-buffer marker)) + (marker-buffer marker))) + (pop-to-buffer (current-buffer) org-ql-find-display-buffer-action) + (without-restriction + (goto-char marker) + (run-hook-with-args 'org-ql-find-goto-hook)) + (when (equal (current-buffer) (marker-buffer marker)) + ;; Ensure point is still within visible portion of buffer. (If + ;; `org-tree-to-indirect-buffer' is used in `org-ql-find-goto-hook', + ;; the buffer will have been changed and it won't matter; otherwise, + ;; the buffer could have been narrowed to a region excluding the + ;; selected entry.) + (let ((end-of-subtree (org-with-point-at marker + (org-end-of-subtree 'invisible-ok)))) + (unless (and (<= (point-min) marker) + (>= (point-max) end-of-subtree)) + (widen) + (goto-char marker)))))) + +;;;###autoload +(defun org-ql-refile (marker) + "Refile current entry to MARKER (interactively, one selected with `org-ql'). +Interactive completion uses files listed in `org-refile-targets', +which see (but only the files are used)." + (interactive (let ((buffers-files (delete-dups + ;; Always include the current buffer. + (cons (current-buffer) + (cl-loop for (files-spec . _candidate-spec) in org-refile-targets + append (cl-typecase files-spec + (null (list (current-buffer))) + (symbol (pcase (funcall files-spec) + ((and (pred stringp) file) (list file)) + ((and (pred listp) files) files))) + (list files-spec))))))) + (list (org-ql-completing-read buffers-files :prompt "Refile to: ")))) + (let ((buffer (or (buffer-base-buffer (marker-buffer marker)) + (marker-buffer marker)))) + (org-refile nil nil + ;; The RFLOC argument: + (list + ;; Name + (org-with-point-at marker + (nth 4 (org-heading-components))) + ;; File + (buffer-file-name buffer) + ;; nil + nil + ;; Position + marker)))) ;;;###autoload (defun org-ql-find-in-agenda () @@ -229,32 +149,84 @@ single predicate)." (interactive) (org-ql-find (org-ql-search-directories-files))) -(defun org-ql-find--snippet-simple (&optional _regexp) - "Return a snippet of the current entry. -Returns up to `org-ql-find-snippet-length' characters." - (org-end-of-meta-data t) - (unless (org-at-heading-p) - (let ((end (min (+ (point) org-ql-find-snippet-length) - (org-entry-end-position)))) - (concat org-ql-find-snippet-prefix - (truncate-string-to-width - (replace-regexp-in-string "\n" " " (buffer-substring (point) end) - t t) - 50 nil nil t))))) +;;;###autoload +(defun org-ql-find-path (buffers-files) + "Call `org-ql-find' to search outline paths in BUFFERS-FILES. +Interactively, search the buffers and files relevant to the +current buffer (i.e. in `org-agenda-mode', the value of +`org-ql-view-buffers-files' or `org-agenda-contributing-files'; +in `org-mode', that buffer). With universal prefix, select +multiple buffers to search with completion and PROMPT." + (interactive (list (org-ql-find--buffers))) + (let ((org-ql-default-predicate 'outline-path)) + (org-ql-find buffers-files))) -(defun org-ql-find--snippet-regexp (regexp) - "Return a snippet of the current entry's matches for REGEXP." - ;; REGEXP may be nil if there are no qualifying tokens in the query. - (when regexp - (org-end-of-meta-data t) - (unless (org-at-heading-p) - (let* ((end (org-entry-end-position)) - (snippets (cl-loop while (re-search-forward regexp end t) - concat (match-string 0) concat "…" - do (goto-char (match-end 0))))) - (unless (string-empty-p snippets) - (concat org-ql-find-snippet-prefix - (replace-regexp-in-string (rx (1+ "\n")) " " snippets t t))))))) +;;;###autoload +(cl-defun org-ql-open-link (buffers-files &key query-prefix query-filter + (prompt "Open link: ")) + "Open a link selected with `org-ql-completing-read'. +Links found in entries matching the input query are offered as +candidates, and the selected one is opened with +`org-open-at-point'. Arguments BUFFERS-FILES, QUERY-FILTER, +QUERY-PREFIX, and PROMPT are passed to `org-ql-completing-read', +which see. + +Interactively, search the buffers and files relevant to the +current buffer (i.e. in `org-agenda-mode', the value of +`org-ql-view-buffers-files' or `org-agenda-contributing-files'; +in `org-mode', that buffer). With universal prefix, select +multiple buffers to search with completion and PROMPT." + (interactive (list (org-ql-find--buffers))) + (let* ((marker (org-ql-completing-read buffers-files + :query-prefix query-prefix + :query-filter query-filter + :prompt prompt + :action-filter #'identity + :action (lambda () + (save-excursion + (cl-loop with limit = (org-entry-end-position) + while (re-search-forward org-link-any-re limit t) + for link = (string-trim (match-string 0)) + do (progn + (set-text-properties 0 (length link) '(face org-link) link) + (setf link (org-link-display-format link))) + collect (cons link (copy-marker (match-beginning 0)))))) + :snippet (lambda (&rest _) + "") + :path (lambda (marker) + (org-with-point-at marker + (let* ((path (thread-first (org-get-outline-path t t) + (org-format-outline-path (window-width) nil "") + (org-split-string ""))) + (formatted-path (if org-ql-completing-read-reverse-paths + (concat "\\" (string-join (reverse path) "\\")) + (concat "/" (string-join path "/"))))) + formatted-path)))))) + (org-with-point-at marker + (org-open-at-point)))) + +;;;; Functions + +(cl-defun org-ql-find--buffers (&key read-buffer-p) + "Return buffer or list of buffers to search in. +In a mode derived from `org-agenda-mode', return the value of +`org-ql-view-buffers-files' or `org-agenda-contributing-files'. +In a mode derived from `org-mode', return the current buffer. If +READ-BUFFER-P, read a list of buffers in `org-mode' with +completion. To be used in `org-ql-find' commands' interactive +forms." + (if read-buffer-p + (mapcar #'get-buffer + (completing-read-multiple + "Buffers: " + (cl-loop for buffer in (buffer-list) + when (eq 'org-mode (buffer-local-value 'major-mode buffer)) + collect (buffer-name buffer)) + nil t)) + (cond ((derived-mode-p 'org-agenda-mode) (or org-ql-view-buffers-files + org-agenda-contributing-files)) + ((derived-mode-p 'org-mode) (current-buffer)) + (t (user-error "This is not an Org-related buffer: %S" (current-buffer)))))) (provide 'org-ql-find) diff --git a/org-ql-search.el b/org-ql-search.el index aa75656..6fe0e55 100644 --- a/org-ql-search.el +++ b/org-ql-search.el @@ -1,5 +1,7 @@ ;;; org-ql-search.el --- Search commands for org-ql -*- lexical-binding: t; -*- +;; Copyright (C) 2019-2023 Adam Porter + ;; Author: Adam Porter ;; Url: https://github.com/alphapapa/org-ql @@ -38,19 +40,40 @@ (require 'org-ql) (require 'org-ql-view) +(declare-function org-ql--normalize-query "org-ql" t t) + ;;;; Compatibility (defalias 'org-ql-search--link-heading-search-string (cond ((fboundp 'org-link--normalize-string) #'org-link--normalize-string) ((fboundp 'org-link-heading-search-string) #'org-link-heading-search-string) ((fboundp 'org-make-org-heading-search-string) #'org-make-org-heading-search-string) - (t (warn "org-ql: Unable to define alias `org-ql-search--link-heading-search-string'. This may affect links in dynamic blocks. Please report this as a bug.") - #'identity))) + (t (error "org-ql: Unable to define alias `org-ql-search--link-heading-search-string'. This may affect links in dynamic blocks. Please report this as a bug")))) + +(defalias 'org-ql-search--org-make-link-string + (cond ((fboundp 'org-link-make-string) #'org-link-make-string) + ((fboundp 'org-make-link-string) #'org-make-link-string) + (t (error "org-ql: Unable to define alias `org-ql-search--org-make-link-string'. Please report this as a bug")))) + +(defalias 'org-ql-search--org-link-store-props + (cond ((fboundp 'org-link-store-props) #'org-link-store-props) + ((fboundp 'org-store-link-props) #'org-store-link-props) + (t (error "org-ql: Unable to define alias `org-ql-search--org-link-store-props'. Please report this as a bug")))) + +(defalias 'org-ql--org-hide-archived-subtrees + (if (version<= "9.6" org-version) + 'org-fold-hide-archived-subtrees + 'org-hide-archived-subtrees)) + +(defalias 'org-ql--org-show-context + (if (version<= "9.6" org-version) + 'org-fold-show-context + 'org-show-context)) ;;;; Variables (defvar org-ql-block-header nil - "An optional string to override the default header in `org-ql-block' agenda blocks.") + "Optional string overriding default header in `org-ql-block' agenda blocks.") ;;;; Customization @@ -84,8 +107,8 @@ directories, etc, which would make it slow to list the The tree will show the lines where the query matches, and any other context defined in `org-show-context-detail', which see. -QUERY is an `org-ql' query sexp (quoted, since this is a -function). BUFFER defaults to the current buffer. +QUERY is an `org-ql' query in either sexp or string form (see +Info node `(org-ql)Queries'). When KEEP-PREVIOUS is non-nil (interactively, with prefix), the outline is not reset to the overview state before finding @@ -93,7 +116,7 @@ matches, which allows stacking calls to this command. Runs `org-occur-hook' after making the sparse tree." ;; Code based on `org-occur'. - (interactive (list (read-minibuffer "Query: ") + (interactive (list (read-string "Query: ") :keep-previous current-prefix-arg)) (with-current-buffer buffer (unless keep-previous @@ -101,14 +124,24 @@ Runs `org-occur-hook' after making the sparse tree." ;; we remove existing `org-occur' highlights, just in case. (org-remove-occur-highlights nil nil t) (org-overview)) - (let ((num-results 0)) - ;; FIXME: Accept plain queries as well. + (let ((num-results 0) + (query (pcase-exhaustive query + ((and (pred stringp) + (rx bos (0+ blank) (or "(" "\""))) + ;; Read sexp query from string. + (read query)) + ((pred stringp) + ;; Parse string query into sexp query. + (org-ql--query-string-to-sexp query)) + ((pred listp) + ;; Sexp query. + query)))) (org-ql-select buffer query :action (lambda () - (org-show-context 'occur-tree) + (org-ql--org-show-context 'occur-tree) (cl-incf num-results))) (unless org-sparse-tree-open-archived-trees - (org-hide-archived-subtrees (point-min) (point-max))) + (org-ql--org-hide-archived-subtrees (point-min) (point-max))) (run-hooks 'org-occur-hook) (unless (get-buffer-window buffer) (pop-to-buffer buffer)) @@ -138,7 +171,7 @@ SUPER-GROUPS: An `org-super-agenda' group set. See variable selectors'. NARROW: When non-nil, don't widen buffers before -searching. Interactively, with prefix, leave narrowed. +searching. Interactively, with prefix, leave narrowed. SORT: One or a list of `org-ql' sorting functions, like `date' or `priority' (see Info node `(org-ql)Listing / acting-on results'). @@ -153,7 +186,7 @@ necessary." (interactive (list (org-ql-view--complete-buffers-files) (read-string "Query: " (when org-ql-view-query (format "%S" org-ql-view-query))) - :narrow (or org-ql-view-narrow (eq current-prefix-arg '(4))) + :narrow (or org-ql-view-narrow (equal current-prefix-arg '(4))) :super-groups (org-ql-view--complete-super-groups) :sort (org-ql-view--complete-sort))) ;; NOTE: Using `with-temp-buffer' is a hack to work around the fact that `make-local-variable' @@ -189,23 +222,28 @@ necessary." (symbol (symbol-value super-groups)) (list super-groups)))) (setf strings (org-super-agenda--group-items strings)))) - (org-ql-view--display :buffer buffer :header header - :string (s-join "\n" strings))))) + (org-ql-view--display :buffer buffer :header header :strings strings)))) ;;;###autoload -(defun org-ql-search-block (query) - "Insert items for QUERY into current buffer. -QUERY should be an `org-ql' query form. Intended to be used as a -user-defined function in `org-agenda-custom-commands'. QUERY -corresponds to the `match' item in the custom command form. +(defun org-ql-search-block (args) + "Insert items for ARGS into current buffer. +Intended to be used as a user-defined function in +`org-agenda-custom-commands'. ARGS corresponds to the `match' +item in the custom command form. It should be a list of +arguments which may be applied to `org-ql-select', which see, but +not including its BUFFERS-FILES argument (which is supplied +through the Agenda). An additional `:header' keyword argument +may be supplied as a string, like that supplied to +`org-ql-view--display'. Like other agenda block commands, it searches files returned by function `org-agenda-files'. Inserts a newline after the block. If `org-ql-block-header' is non-nil, it is used as the header -string for the block, otherwise a the header is formed +string for the block, otherwise the header is formed automatically from the query." - (let (narrow-p old-beg old-end) + (pcase-let ((`(,query . ,(map :header :sort)) args) + (narrow-p) (old-beg) (old-end)) (when-let* ((from (pcase org-agenda-restrict ('nil (org-agenda-files nil 'ifmode)) (_ (prog1 org-agenda-restrict @@ -216,7 +254,7 @@ automatically from the query." (narrow-to-region org-agenda-restrict-begin org-agenda-restrict-end)))))) (items (org-ql-select from query :action 'element-with-markers - :narrow narrow-p))) + :narrow narrow-p :sort sort))) (when narrow-p ;; Restore buffer's previous restrictions. (with-current-buffer from @@ -226,16 +264,25 @@ automatically from the query." ;; FIXME: `org-agenda--insert-overriding-header' is from an Org version newer than ;; I'm using. Should probably declare it as a minimum Org version after upgrading. ;; (org-agenda--insert-overriding-header (or org-ql-block-header (org-ql-agenda--header-line-format from query))) - (insert (org-add-props (or org-ql-block-header (org-ql-view--header-line-format - :buffers-files from :query query)) + ;; FIXME: Should we really use `org-ql-block-header' AND `header', or just one of them? + (insert (org-add-props (or org-ql-block-header header + (org-ql-view--header-line-format + :buffers-files from :query query)) nil 'face 'org-agenda-structure) "\n") ;; Calling `org-agenda-finalize' should be unnecessary, because in a "series" agenda, ;; `org-agenda-multi' is bound non-nil, in which case `org-agenda-finalize' does nothing. ;; But we do call `org-agenda-finalize-entries', which allows `org-super-agenda' to work. - (->> items - (-map #'org-ql-view--format-element) - org-agenda-finalize-entries - insert) + ;; However, `org-agenda-finalize-entries' sorts entries with `org-entries-lessp', which + ;; overrides the sorting `org-ql' has already done, so we rebind `org-entries-lessp' to + ;; prevent it from affecting sort order. (Ideally we would let `org-entries-lessp' + ;; handle sorting, but that's not possible, because we can't add the `type' text property + ;; it uses to sort entries, because the design of org-ql and org-agenda is fundamentally + ;; different. So we have to do the sorting ourselves.) + (cl-letf (((symbol-function 'org-entries-lessp) #'ignore)) + (->> items + (-map #'org-ql-view--format-element) + org-agenda-finalize-entries + insert)) (insert "\n")))) ;;;###autoload @@ -277,13 +324,16 @@ Valid parameters include: :ts-format Optional format string used to format timestamp-based columns. -For example, an org-ql dynamic block header could look like: +For example, an org-ql dynamic block header could look like +this (must be a single line in the Org buffer): - #+BEGIN: org-ql :query (todo \"UNDERWAY\") :columns (priority todo heading) :sort (priority date) :ts-format \"%Y-%m-%d %H:%M\"" + #+BEGIN: org-ql :query (todo \"UNDERWAY\") +:columns (priority todo heading) :sort (priority date) +:ts-format \"%Y-%m-%d %H:%M\"" (-let* (((&plist :query :columns :sort :ts-format :take) params) (query (cl-etypecase query (string (org-ql--query-string-to-sexp query)) - (list ;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code. + (list ;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code. (org-ql--ask-unsafe-query query) query))) (columns (or columns '(heading todo (priority "P")))) @@ -296,7 +346,7 @@ For example, an org-ql dynamic block header could look like: (cons 'heading (lambda (element) (let ((normalized-heading (org-ql-search--link-heading-search-string (org-element-property :raw-value element)))) - (org-make-link-string normalized-heading (org-link-display-format normalized-heading))))) + (org-ql-search--org-make-link-string normalized-heading (org-link-display-format normalized-heading))))) (cons 'priority (lambda (element) (--when-let (org-element-property :priority element) (char-to-string it)))) @@ -313,23 +363,24 @@ For example, an org-ql dynamic block header could look like: (org-element-property (intern (concat ":" (upcase property))) element))))) (elements (org-ql-query :from (current-buffer) :where query - :select '(org-element-headline-parser (line-end-position)) + :select '(org-ql-view--resolve-element-properties + (org-element-headline-parser (line-end-position))) :order-by sort))) (when take (setf elements (cl-etypecase take ((and integer (satisfies cl-minusp)) (-take-last (abs take) elements)) (integer (-take take elements))))) - (cl-labels ((format-element - (element) (string-join (cl-loop for column in columns - collect (or (pcase-exhaustive column - ((pred symbolp) - (funcall (alist-get column format-fns) element)) - (`((,column . ,args) ,_header) - (apply (alist-get column format-fns) element args)) - (`(,column ,_header) - (funcall (alist-get column format-fns) element))) - "")) - " | "))) + (cl-labels ((format-element (element) + (string-join (cl-loop for column in columns + collect (or (pcase-exhaustive column + ((pred symbolp) + (funcall (alist-get column format-fns) element)) + (`((,column . ,args) ,_header) + (apply (alist-get column format-fns) element args)) + (`(,column ,_header) + (funcall (alist-get column format-fns) element))) + "")) + " | "))) ;; Table header (insert "| " (string-join (--map (pcase it ((pred symbolp) (capitalize (symbol-name it))) @@ -337,7 +388,7 @@ For example, an org-ql dynamic block header could look like: columns) " | ") " |" "\n") - (insert "|- \n") ; Separator hline + (insert "|- \n") ; Separator hline (dolist (element elements) (insert "| " (format-element element) " |" "\n")) (delete-char -1) @@ -345,18 +396,24 @@ For example, an org-ql dynamic block header could look like: ;;;; Functions +(defvar org-ql-search-directories-files-error + ;; Workaround to silence byte-compiler which thinks having this string in an + ;; argument's default value form is a too-long docstring. + "No DIRECTORIES given, and `org-directory' doesn't exist") + (cl-defun org-ql-search-directories-files - (&key (directories (if (file-exists-p org-directory) - (list org-directory) - (user-error "Org-ql-search-directories-files: No DIRECTORIES given, and `org-directory' doesn't exist"))) + (&key (directories + (if (file-exists-p org-directory) + (list org-directory) + (user-error org-ql-search-directories-files-error))) (recurse org-ql-search-directories-files-recursive) (regexp org-ql-search-directories-files-regexp)) - "Return list of matching files in DIRECTORIES, a list of directory paths. + "Return list of matching files in DIRECTORIES. When RECURSE is non-nil, recurse into subdirectories. When REGEXP is non-nil, only return files that match REGEXP." (let ((files (->> directories - (--map (f-files it nil recurse)) - -flatten))) + (--map (f-files it nil recurse)) + -flatten))) (if regexp (--select (string-match regexp it) files) diff --git a/org-ql-sort.el b/org-ql-sort.el deleted file mode 100644 index e45962d..0000000 --- a/org-ql-sort.el +++ /dev/null @@ -1,56 +0,0 @@ -;;; org-ql-sort.el --- Library for sorting org-elements -*- lexical-binding: t; -*- - -;; Copyright (C) 2022 Adam Porter - -;; Author: Adam Porter -;; Keywords: - -;; This program is free software; you can redistribute it and/or modify -;; it under the terms of the GNU General Public License as published by -;; the Free Software Foundation, either version 3 of the License, or -;; (at your option) any later version. - -;; This program is distributed in the hope that it will be useful, -;; but WITHOUT ANY WARRANTY; without even the implied warranty of -;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -;; GNU General Public License for more details. - -;; You should have received a copy of the GNU General Public License -;; along with this program. If not, see . - -;;; Commentary: - -;; This library provides tools for sorting `org-element' items. - -;;; Code: - -;;;; Requirements - -(require 'cl-lib) -(require 'map) - -(require 'org-element) - -;;;; Variables - -(defvar org-ql-sorters nil - "Alist of sort functions defined with `org-ql-sort-define-sorter'. -Maps sorters' short names to function symbols.") - -;;;; Macros - -(defmacro org-ql-sort-define-sorter (name docstring &rest body) - "FIXME: Docstring." - (let ((fn-symbol (intern (concat "org-ql-sort--sort-by-" (symbol-name name))))) - (map-put org-ql-sorters name fn-symbol) - `(defun ,fn-symbol (a b) - ,docstring - ,@body))) - -;;;; Functions - - - - -(provide 'org-ql-sort) -;;; org-ql-sort.el ends here diff --git a/org-ql-view.el b/org-ql-view.el index 74f74d9..8d65582 100644 --- a/org-ql-view.el +++ b/org-ql-view.el @@ -1,5 +1,7 @@ ;;; org-ql-view.el --- Agenda-like view based on org-ql -*- lexical-binding: t; -*- +;; Copyright (C) 2019-2023 Adam Porter + ;; Author: Adam Porter ;; Url: https://github.com/alphapapa/org-ql @@ -40,10 +42,9 @@ (require 'org-ql) -;; FIXME: check-declare declares "function not found", even though it -;; clearly is. It seems to not handle cl-defun, even though its code -;; appears to account for it. (declare-function org-ql-search "org-ql-search" t) +(declare-function org-ql-search--org-link-store-props "org-ql-search" t) +(declare-function org-ql--normalize-query "org-ql" t t) (require 'dash) (require 's) @@ -56,7 +57,18 @@ (defface org-ql-view-due-date '((t (:slant italic :weight bold))) "Face for due dates in `org-ql-view' views." - :group 'org-ql) + :group 'org-ql-view) + +(defface org-ql-view-query nil + "View query in header line. +This face is added to the formatted query after font-lock faces +are applied to it. It may be used, e.g. to reduce the height so +more of it is visible." + :group 'org-ql-view) + +(defface org-ql-view-title '((t :weight bold)) + "View title in header line." + :group 'org-ql-view) ;;;; Variables @@ -153,11 +165,11 @@ See info node `(elisp)Cyclic Window Ordering'." (interactive) (let* ((ts (ts-now)) (beg-of-week (->> ts - (ts-adjust 'day (- (ts-dow (ts-now)))) - (ts-apply :hour 0 :minute 0 :second 0))) + (ts-adjust 'day (- (ts-dow (ts-now)))) + (ts-apply :hour 0 :minute 0 :second 0))) (end-of-week (->> ts - (ts-adjust 'day (- 6 (ts-dow (ts-now)))) - (ts-apply :hour 23 :minute 59 :second 59)))) + (ts-adjust 'day (- 6 (ts-dow (ts-now)))) + (ts-apply :hour 23 :minute 59 :second 59)))) (org-ql-search (org-agenda-files) `(ts-active :from ,beg-of-week :to ,end-of-week) @@ -170,11 +182,11 @@ See info node `(elisp)Cyclic Window Ordering'." (interactive) (let* ((ts (ts-adjust 'day 7 (ts-now))) (beg-of-week (->> ts - (ts-adjust 'day (- (ts-dow (ts-now)))) - (ts-apply :hour 0 :minute 0 :second 0))) + (ts-adjust 'day (- (ts-dow (ts-now)))) + (ts-apply :hour 0 :minute 0 :second 0))) (end-of-week (->> ts - (ts-adjust 'day (- 6 (ts-dow (ts-now)))) - (ts-apply :hour 23 :minute 59 :second 59)))) + (ts-adjust 'day (- 6 (ts-dow (ts-now)))) + (ts-apply :hour 23 :minute 59 :second 59)))) (org-ql-search (org-agenda-files) `(ts-active :from ,beg-of-week :to ,end-of-week) @@ -237,6 +249,12 @@ See info node `(elisp)Cyclic Window Ordering'." (sexp :tag "org-super-agenda grouping expression") (variable :tag "Variable holding org-super-agenda grouping expression")))))))) +(defcustom org-ql-view-relative-deadline-prefix "due " + ;; TODO(v0.9): Add one for scheduled, too. + "Prefix for relative deadlines. +Relative deadlines are, e.g. \"in 5d\", \"5d ago\"." + :type 'string) + ;;;; Commands ;;;###autoload @@ -272,8 +290,8 @@ TYPE may be `ts', `ts-active', `ts-inactive', `clocked', or `closed'." (interactive (list :num-days (read-number "Days: ") :type (->> '(ts ts-active ts-inactive clocked closed) - (completing-read "Timestamp type: ") - intern))) + (completing-read "Timestamp type: ") + intern))) ;; It doesn't make much sense to use other date-based selectors to ;; look into the past, so to prevent confusion, we won't allow them. (-let* ((query (pcase-exhaustive type @@ -288,7 +306,8 @@ TYPE may be `ts', `ts-active', `ts-inactive', `clocked', or ;;;###autoload (cl-defun org-ql-view-sidebar (&key (slot org-ql-view-list-slot)) - "Show `org-ql-view' view list sidebar." + "Show `org-ql-view' view list sidebar. +SLOT is passed to `display-buffer-in-side-window', which see." ;; TODO: Update sidebar when `org-ql-views' changes. (interactive) (select-window @@ -303,10 +322,10 @@ TYPE may be `ts', `ts-active', `ts-inactive', `clocked', or (defun org-ql-view-switch () "Switch to view at point." (interactive) - (let ((key (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) + (let ((key (buffer-substring-no-properties (pos-bol) (pos-eol)))) (unless (string-empty-p key) (ov-clear :org-ql-view-selected) - (ov (point-at-bol) (1+ (point-at-eol)) :org-ql-view-selected t + (ov (pos-bol) (1+ (pos-eol)) :org-ql-view-selected t 'face '(:weight bold :inherit highlight)) (org-ql-view key)))) @@ -353,7 +372,8 @@ update search arguments." (yes-or-no-p (format "Overwrite view \"%s\"?" name))) (setf (map-elt org-ql-views name nil #'equal) plist) (customize-set-variable 'org-ql-views org-ql-views) - (customize-mark-to-save 'org-ql-views)))) + (customize-mark-to-save 'org-ql-views) + (custom-save-all)))) (defun org-ql-view-delete () "Delete current view (with confirmation)." @@ -363,12 +383,13 @@ update search arguments." (--remove (equal (car it) org-ql-view-title) org-ql-views)) (customize-set-variable 'org-ql-views org-ql-views) - (customize-mark-to-save 'org-ql-views))) + (customize-mark-to-save 'org-ql-views) + (custom-save-all))) (defun org-ql-view-customize () "Customize view at point in `org-ql-view-sidebar' buffer." (interactive) - (let ((key (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) + (let ((key (buffer-substring-no-properties (pos-bol) (pos-eol)))) (customize-option 'org-ql-views) (search-forward (concat "Name: " key)))) @@ -395,17 +416,17 @@ update search arguments." (let ((inhibit-read-only t)) (erase-buffer) (->> org-ql-views - (-map #'car) - (-sort (if org-ql-view-sidebar-sort-views - #'string< - #'ignore)) - (s-join "\n") - insert)) + (-map #'car) + (-sort (if org-ql-view-sidebar-sort-views + #'string< + #'ignore)) + (s-join "\n") + insert)) (current-buffer))) (defvar bookmark-make-record-function) -(cl-defun org-ql-view--display (&key (buffer org-ql-view-buffer) header string) +(cl-defun org-ql-view--display (&key (buffer org-ql-view-buffer) header strings) "Display STRING in `org-ql-view' BUFFER. BUFFER may be a buffer, or a string naming a buffer, which is @@ -443,7 +464,9 @@ subsequent refreshing of the buffer: `org-ql-view-buffers-files', ;; Clear buffer, insert entries, etc. (let ((inhibit-read-only t)) (erase-buffer) - (insert string "\n") + (dolist (string strings) + (insert string "\n")) + (insert "\n") (pop-to-buffer (current-buffer) org-ql-view-display-buffer-action) (org-agenda-finalize) (goto-char (point-min)))))) @@ -453,7 +476,8 @@ subsequent refreshing of the buffer: `org-ql-view-buffers-files', If TITLE, prepend it to the header." (let* ((title (if title (concat (propertize "View:" 'face 'transient-argument) - title " ") + (propertize title 'face 'org-ql-view-title) + " ") "")) (query-formatted (when query (org-ql-view--format-query query))) @@ -469,9 +493,10 @@ If TITLE, prepend it to the header." (format "%s" (org-ql-view--contract-buffers-files buffers-files)))) (buffers-files-formatted (when buffers-files-formatted (propertize (->> buffers-files-formatted - (org-ql-view--font-lock-string 'emacs-lisp-mode) - (s-truncate available-width)) + (org-ql-view--font-lock-string 'emacs-lisp-mode) + (s-truncate available-width)) 'help-echo buffers-files-formatted)))) + (add-face-text-property 0 (length query-propertized) 'org-ql-view-query 'append query-propertized) (concat title (when query (propertize "Query:" 'face 'transient-argument)) (when query query-propertized) @@ -486,11 +511,11 @@ If TITLE, prepend it to the header." Makes QUERY more readable, e.g. timestamp objects are replaced with human-readable strings." (cl-labels ((rec (form) - (cl-typecase form - (ts (ts-format form)) - (cons (cons (rec (car form)) - (rec (cdr form)))) - (otherwise form)))) + (cl-typecase form + (ts (ts-format form)) + (cons (cons (rec (car form)) + (rec (cdr form)))) + (otherwise form)))) (format "%S" (rec query)))) (defun org-ql-view--font-lock-string (mode s) @@ -503,6 +528,22 @@ with human-readable strings." (font-lock-ensure) (buffer-string)))) +(defun org-ql-view--font-lock-as-org (s) + "Return string S font-locked as in `org-mode'." + ;; This works like `org-fontify-like-in-org-mode', but uses a single + ;; buffer instead of a new one every time. + ;; TODO(C): Submit these improvements upstream. + (let ((buffer (or (get-buffer " *org-ql-view--font-lock-as-org*") + (with-current-buffer (get-buffer-create " *org-ql-view--font-lock-as-org*") + (buffer-disable-undo) + (org-mode) + (current-buffer))))) + (with-current-buffer buffer + (insert s) + (font-lock-ensure) + (prog1 (buffer-string) + (erase-buffer))))) + (defun org-ql-view--buffer (&optional name) "Return `org-ql-view' buffer, creating it if necessary. If NAME is non-nil, return buffer by that name instead of using @@ -532,19 +573,20 @@ dates in the past, and negative for dates in the future." (defun org-ql-view-bookmark-make-record () "Return a bookmark record for the current Org QL View buffer." - (cl-labels ((file-nameize - (b-f) (abbreviate-file-name - (cl-typecase b-f - (string b-f) - (buffer (or (buffer-file-name b-f) - (when (buffer-base-buffer b-f) - (buffer-file-name (buffer-base-buffer b-f))))) - (t (user-error "Only file-backed buffers can be bookmarked by Org QL View: %s" b-f)))))) + (cl-labels ((file-nameize (b-f) + (abbreviate-file-name + (cl-typecase b-f + (string b-f) + (buffer (or (buffer-file-name b-f) + (when (buffer-base-buffer b-f) + (buffer-file-name (buffer-base-buffer b-f))))) + (t (user-error "Only file-backed buffers can be bookmarked by Org QL View: %s" b-f)))))) (-let* ((plist (org-ql-view--plist (current-buffer))) ((&plist :buffers-files) plist)) ;; Replace buffers with their filenames, and signal error if any are not file-backed. (setf plist (plist-put plist :buffers-files (cl-etypecase buffers-files + (symbol buffers-files) (string buffers-files) (buffer (file-nameize buffers-files)) (list (mapcar #'file-nameize buffers-files))))) @@ -604,6 +646,7 @@ The optional, second argument is temporarily _IGNORED for purposes of compatibility with changes in Org 9.4." (require 'url-parse) (require 'url-util) + (declare-function url-path-and-query "url-parse") (when (version<= "9.3" (org-version)) ;; Org 9.3+ makes a backward-incompatible change to link escaping. ;; I don't think it would be a good idea to try to guess whether @@ -618,7 +661,7 @@ purposes of compatibility with changes in Org 9.4." (query (url-unhex-string query)) (params (when params (url-parse-query-string params))) ;; `url-parse-query-string' returns "improper" alists, which makes this awkward. - (sort (when-let* ((stored-string (alist-get "sort" params nil nil #'string=)) + (sort (when-let* ((stored-string (car (alist-get "sort" params nil nil #'string=))) (read-value (read stored-string))) ;; Ensure the value is either a symbol or list of symbols (which excludes lambdas). (unless (or (symbolp read-value) (cl-every #'symbolp read-value)) @@ -626,17 +669,19 @@ purposes of compatibility with changes in Org 9.4." read-value)) read-value)) (org-super-agenda-allow-unsafe-groups nil) ; Disallow unsafe group selectors. - (groups (--when-let (alist-get "super-groups" params nil nil #'string=) + (groups (--when-let (car (alist-get "super-groups" params nil nil #'string=)) (read it))) - (title (--when-let (alist-get "title" params nil nil #'string=) + (title (--when-let (car (alist-get "title" params nil nil #'string=)) (read it))) - (buffers-files (--if-let (alist-get "buffers-files" params nil nil #'string=) + (buffers-files (--if-let (car (alist-get "buffers-files" params nil nil #'string=)) (org-ql-view--expand-buffers-files (read it)) (current-buffer)))) (unless (or (bufferp buffers-files) (stringp buffers-files) (cl-every #'stringp buffers-files)) (error "CAUTION: Link not opened because unsafe buffers-files parameter detected: %s" buffers-files)) + (unless (or (stringp title) (null title)) + (error "CAUTION: Link not opened because unsafe title parameter detected: %S" title)) (when (or (listp query) (string-match (rx bol (0+ space) "(") query)) ;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code. @@ -654,25 +699,27 @@ When opened, the link searches the buffer it's opened from." (when org-ql-view-query ;; Only Org QL View buffers should have `org-ql-view-query' set. (cl-labels ((prompt-for (buffers-files) - (pcase-exhaustive - (completing-read (format "Make link that searches: ") - '("file link is in" "files currently searched") - nil t nil nil "file link is in") - ("file link is in" nil) - ("files currently searched" buffers-files))) - (strings-or-file-buffers-p - (thing) (cl-etypecase thing - (list (cl-every #'strings-or-file-buffers-p thing)) - (string thing) - (buffer (or (buffer-file-name thing) - ;; TODO: Should indirect buffers be allowed? Maybe not, since their narrowing isn't preserved. - ;; On the other hand, it's possible to accidentally make a search view for an indirect buffer - ;; that's since been widened, and forcing the user to manually change that would be awkward, - ;; and trying to communicate the problem would be difficult, so maybe it's okay to allow it. - (when (buffer-base-buffer thing) - (buffer-file-name (buffer-base-buffer thing)))))))) + (pcase-exhaustive + (completing-read (format "Make link that searches: ") + '("file link is in" "files currently searched") + nil t nil nil "file link is in") + ("file link is in" nil) + ("files currently searched" buffers-files))) + (strings-or-file-buffers-p (thing) + (cl-etypecase thing + (list (cl-every #'strings-or-file-buffers-p thing)) + (string thing) + (buffer (or (buffer-file-name thing) + ;; TODO: Should indirect buffers be allowed? Maybe not, since their + ;; narrowing isn't preserved. On the other hand, it's possible to + ;; accidentally make a search view for an indirect buffer that's + ;; since been widened, and forcing the user to manually change that + ;; would be awkward, and trying to communicate the problem would be + ;; difficult, so maybe it's okay to allow it. + (when (buffer-base-buffer thing) + (buffer-file-name (buffer-base-buffer thing)))))))) (unless (strings-or-file-buffers-p org-ql-view-buffers-files) - (user-error "Views that search non-file-backed buffers can't be linked to")) + (user-error "%s" "Views that search non-file-backed buffers can't be linked to")) (let* ((query-string (--if-let (org-ql--query-sexp-to-string org-ql-view-query) it (org-ql-view--format-query org-ql-view-query))) (buffers-files (prompt-for (org-ql-view--contract-buffers-files org-ql-view-buffers-files))) @@ -688,8 +735,7 @@ When opened, the link searches the buffer it's opened from." "?" (url-build-query-string (delete nil params)))) (url (url-recreate-url (url-parse-make-urlobj "org-ql-search" nil nil nil nil filename)))) - ;; FIXME: "Warning: ‘org-store-link-props’ is an obsolete function (as of Org 9.3); use ‘org-link-store-props’ instead" - (org-store-link-props + (org-ql-search--org-link-store-props :type "org-ql-search" :link url :description (concat "org-ql-search: " org-ql-view-title)))) @@ -704,6 +750,8 @@ When opened, the link searches the buffer it's opened from." ;; Transient manual is written very well, not everything is covered in ;; it, so I'm having to try to imitate examples from `magit-transient'. +(require 'eieio-core) + (require 'transient) (defclass org-ql-view--variable (transient-variable) @@ -750,8 +798,8 @@ When opened, the link searches the buffer it's opened from." (s-truncate (- (window-width) 15) (concat (propertize key 'face 'transient-argument) ": " (->> value - org-ql-view--format-query - (org-ql-view--font-lock-string 'emacs-lisp-mode))))) + org-ql-view--format-query + (org-ql-view--font-lock-string 'emacs-lisp-mode))))) (transient-define-infix org-ql-view--transient-title () ;; TODO: Add an asterisk or something when the view has been modified but not saved. @@ -820,6 +868,20 @@ When opened, the link searches the buffer it's opened from." ;;;; Faces/properties +(defalias 'org-ql-view--resolve-element-properties + ;; It would be preferable to define this as an inline function, but + ;; that would mean that users would have to recompile org-ql when + ;; upgrading to Org 9.7 or else get weird errors. + ;; TODO(someday): Define `org-ql-view--resolve-element-properties' as inline. + (if (version<= "9.7" org-version) + (lambda (node) + "Resolve NODE's properties using `org-element-properties-resolve'." + ;; Silence warnings about `org-element-properties-resolve' + ;; being unresolved on earlier Org versions. + (with-no-warnings + (org-element-properties-resolve node 'force-undefer))) + #'identity)) + (defun org-ql-view--format-element (element) ;; This essentially needs to do what `org-agenda-format-item' does, ;; which is a lot. We are a long way from that, but it's a start. @@ -829,6 +891,7 @@ returned by `org-element-parse-buffer'. If ELEMENT is nil, return an empty string." (if (not element) "" + (setf element (org-ql-view--resolve-element-properties element)) (let* ((properties (cadr element)) ;; Remove the :parent property, which so bloats the size of ;; the properties list that it makes it essentially @@ -850,10 +913,15 @@ return an empty string." ;; Adding the relative due date property should probably be done explicitly and separately ;; (which would also make it easier to do it independently of faces, etc). (title (--> (org-ql-view--add-faces element) - (org-element-property :raw-value it) - (org-link-display-format it))) + (org-element-property :raw-value it))) + ;; TODO(B): Needs refactoring. A function like `org-ql-view--add-faces' + ;; should return a list of faces to be added. + (title-faces (get-text-property 0 'face title)) + (title (org-ql-view--font-lock-as-org title)) + (_ (add-face-text-property 0 (length title) title-faces t title)) (todo-keyword (-some--> (org-element-property :todo-keyword element) - (org-ql-view--add-todo-face it))) + (org-ql-view--add-todo-face + (substring-no-properties it)))) (tag-list (if org-use-tag-inheritance ;; MAYBE: Use our own variable instead of `org-use-tag-inheritance'. (if-let ((marker (or (org-element-property :org-hd-marker element) @@ -866,21 +934,29 @@ return an empty string." (not type)) append type))) ;; No marker found - ;; TODO: Use `display-warning' with `org-ql' as the type. - (warn "No marker found for item: %s" title) + (display-warning 'org-ql (format "No marker found for item: %s" title)) (org-element-property :tags element)) (org-element-property :tags element))) (tag-string (when tag-list (--> tag-list - (s-join ":" it) - (s-wrap it ":") - (org-add-props it nil 'face 'org-tag)))) - ;; (category (org-element-property :category element)) + (s-join ":" it) + (s-wrap it ":") + (org-add-props it nil 'face 'org-tag)))) + (category (or (org-element-property :CATEGORY element) + (when-let ((marker (or (org-element-property :org-hd-marker element) + (org-element-property :org-marker element)))) + (org-with-point-at marker + (or (org-get-category) + (when buffer-file-name + (file-name-sans-extension + (file-name-nondirectory buffer-file-name)))))) + "")) (priority-string (-some->> (org-element-property :priority element) (char-to-string) (format "[#%s]") (org-ql-view--add-priority-face))) - (habit-property (org-with-point-at (org-element-property :begin element) + (habit-property (org-with-point-at (or (org-element-property :org-hd-marker element) + (org-element-property :org-marker element)) (when (org-is-habit-p) (org-habit-parse-todo)))) (due-string (pcase (org-element-property :relative-due-date element) @@ -890,19 +966,20 @@ return an empty string." (remove-list-of-text-properties 0 (length string) '(line-prefix) string) ;; Add all the necessary properties and faces to the whole string (--> string - ;; FIXME: Use proper prefix - (concat " " it) - (org-add-props it properties - 'org-agenda-type 'search - 'todo-state todo-keyword - 'tags tag-list - 'org-habit-p habit-property))))) + ;; FIXME: Use proper prefix + (concat " " it) + (org-add-props it properties + 'org-agenda-type 'search + 'org-category category + 'todo-state todo-keyword + 'tags tag-list + 'org-habit-p habit-property))))) (defun org-ql-view--add-faces (element) "Return ELEMENT with deadline and scheduled faces added." (->> element - (org-ql-view--add-scheduled-face) - (org-ql-view--add-deadline-face))) + (org-ql-view--add-scheduled-face) + (org-ql-view--add-deadline-face))) (defun org-ql-view--add-priority-face (string) "Return STRING with priority face added." @@ -959,11 +1036,11 @@ return an empty string." ((> today-day-number scheduled-day-number) 'org-scheduled-previously) (t 'org-scheduled))) (title (--> (org-element-property :raw-value element) - (org-add-props it nil - 'face face))) + (org-add-props it nil + 'face face))) (properties (--> (cadr element) - (plist-put it :title title) - (plist-put it :relative-due-date relative-due-date)))) + (plist-put it :title title) + (plist-put it :relative-due-date relative-due-date)))) (list (car element) properties)) ;; Not scheduled @@ -979,22 +1056,24 @@ property." (deadline-day-number (org-time-string-to-absolute (org-element-timestamp-interpreter deadline-date 'ignore))) (difference-days (- today-day-number deadline-day-number)) - (relative-due-date (org-add-props (org-ql-view--format-relative-date difference-days) nil + (relative-due-date (org-add-props + (concat org-ql-view-relative-deadline-prefix + (org-ql-view--format-relative-date difference-days)) nil 'help-echo (org-element-property :raw-value deadline-date))) ;; FIXME: Unused for now: (todo-keyword (org-element-property :todo-keyword element)) ;; FIXME: Unused for now: (done-p (member todo-keyword org-done-keywords)) ;; FIXME: Unused for now: (today-p (= today-day-number deadline-day-number)) (deadline-passed-fraction (--> (- deadline-day-number today-day-number) - (float it) - (/ it (max org-deadline-warning-days 1)) - (- 1 it))) + (float it) + (/ it (max org-deadline-warning-days 1)) + (- 1 it))) (face (org-agenda-deadline-face deadline-passed-fraction)) (title (--> (org-element-property :raw-value element) - (org-add-props it nil - 'face face))) + (org-add-props it nil + 'face face))) (properties (--> (cadr element) - (plist-put it :title title) - (plist-put it :relative-due-date relative-due-date)))) + (plist-put it :title title) + (plist-put it :relative-due-date relative-due-date)))) (list (car element) properties)) ;; No deadline @@ -1013,10 +1092,6 @@ property." ;; These functions are somewhat regrettable because of the need to keep them ;; in sync, but it seems worth it to provide users with the flexibility. -;; FIXME: `check-declare' declares that this function is not in org-ql-search, even though -;; it is. It appears to happen because `org-ql-search-directories-files' is declared with -;; `cl-defun', because when I remove "cl-", it finds it. This makes no sense, because the -;; source code of `check-declare' shows that it searches for "cl-defun" declarations. (declare-function org-ql-search-directories-files "org-ql-search" t) (defun org-ql-view--contract-buffers-files (buffers-files) @@ -1028,11 +1103,11 @@ the variable), \"org-directory\" if it matches the value of current buffer. Otherwise BUFFERS-FILES is returned unchanged." ;; Used in `org-ql-view--complete-buffers-files' and ;; `org-ql-view--header-line-format'. - (cl-labels ((expand-files - (list) (--map (cl-typecase it - (string (expand-file-name it)) - (otherwise it)) - list))) + (cl-labels ((expand-files (list) + (--map (cl-typecase it + (string (expand-file-name it)) + (otherwise it)) + list))) ;; TODO: Test this more exhaustively. (pcase buffers-files ((pred listp) @@ -1054,10 +1129,10 @@ current buffer. Otherwise BUFFERS-FILES is returned unchanged." (defun org-ql-view--complete-buffers-files () "Return value for `org-ql-view-buffers-files' using completion." - (cl-labels ((initial-input - () (when org-ql-view-buffers-files - (org-ql-view--contract-buffers-files - org-ql-view-buffers-files)))) + (cl-labels ((initial-input () + (when org-ql-view-buffers-files + (org-ql-view--contract-buffers-files + org-ql-view-buffers-files)))) (if (and org-ql-view-buffers-files (bufferp org-ql-view-buffers-files)) ;; Buffers can't be input by name, so if the default value is a buffer, just use it. @@ -1117,7 +1192,7 @@ The counterpart to `org-ql-view--contract-buffers-files'." "todo") nil nil (when org-ql-view-sort (prin1-to-string org-ql-view-sort))) - (--remove (equal "buffer-order" it))))) + (--remove (equal "buffer-order" it))))) (pcase input ('nil nil) ((and (pred listp) sort) diff --git a/org-ql.el b/org-ql.el index a0e03eb..f3b7715 100644 --- a/org-ql.el +++ b/org-ql.el @@ -1,19 +1,13 @@ ;;; org-ql.el --- Org Query Language, search command, and agenda-like view -*- lexical-binding: t; -*- +;; Copyright (C) 2017-2023 Adam Porter + ;; Author: Adam Porter ;; Url: https://github.com/alphapapa/org-ql -;; Version: 0.7-pre -;; Package-Requires: ((emacs "26.1") (dash "2.18.1") (f "0.17.2") (map "2.1") (org "9.0") (org-super-agenda "1.2") (ov "1.0.6") (peg "1.0") (s "1.12.0") (transient "0.1") (ts "0.2-pre")) +;; Version: 0.9-pre +;; Package-Requires: ((emacs "27.1") (compat "29.1") (dash "2.18.1") (f "0.17.2") (map "2.1") (org "9.0") (org-super-agenda "1.2") (ov "1.0.6") (peg "1.0.1") (s "1.12.0") (transient "0.1") (ts "0.2-pre")) ;; Keywords: hypermedia, outlines, Org, agenda -;;; Commentary: - -;; `org-ql' is a lispy query language for Org files. It allows you to -;; find Org entries matching certain criteria and return a list of -;; them or perform actions on them. Commands are also provided which -;; display a buffer with matching results, similar to an Org Agenda -;; buffer. - ;;; License: ;; This program is free software; you can redistribute it and/or modify @@ -29,17 +23,27 @@ ;; You should have received a copy of the GNU General Public License ;; along with this program. If not, see . +;;; Commentary: + +;; `org-ql' is a Lispy query language for Org files. It allows you to +;; find Org entries matching certain criteria and return a list of +;; them or perform actions on them. Commands are also provided which +;; display a buffer with matching results, similar to an Org Agenda +;; buffer. + ;;; Code: ;;;; Requirements (require 'cl-lib) (require 'org) +(require 'org-duration) (require 'org-element) (require 'org-habit) (require 'seq) (require 'subr-x) +(require 'compat) (require 'dash) (require 'map) (require 'ts) @@ -72,10 +76,11 @@ That is, \"CLOSED:\", \"DEADLINE:\", or \"SCHEDULED:\".") Tags are stored in match group 1. Match group 2 stores the tags without the enclosing colons.") -(defconst org-ql-link-regexp +(defvaralias 'org-ql-link-regexp + ;; FIXME: `org-link-bracket-re' is void until `org-link-make-regexps' is called. (if (bound-and-true-p org-link-bracket-re) - org-link-bracket-re - org-bracket-link-regexp) + 'org-link-bracket-re + 'org-bracket-link-regexp) "Regexp used to match Org bracket links. Necessary because of changes in Org 9.something.") @@ -91,6 +96,12 @@ Necessary because of backward-incompatible changes in Org `org-bracket-link-regexp' was marked as an obsolete alias for it, but the match groups were changed, so they are not compatible.") +;;;; Compatibility +(defalias 'org-ql--org-timestamp-format + (if (version<= "9.6" org-version) + 'org-format-timestamp + 'org-timestamp-format)) + ;;;; Variables (defvar org-ql--today nil) @@ -146,10 +157,9 @@ This list should not contain any duplicates.")) (defvar org-ql-regexp-part-ts-date (rx (repeat 4 digit) "-" (repeat 2 digit) "-" (repeat 2 digit) ;; Day of week - (optional " " (1+ alpha))) + (optional " " (1+ (or alpha punct)))) "Matches the inner, date part of an Org timestamp, both active and inactive. -Also matches optional day-of-week. Used to build other timestamp -regexps.") +Used to build other timestamp regexps.") (defvar org-ql-regexp-part-ts-repeaters ;; Repeaters (not sure if the colon is necessary, but it's in the org.el one) @@ -159,7 +169,8 @@ regexps.") Includes leading space character.") (defvar org-ql-regexp-part-ts-time - (rx " " (repeat 1 2 digit) ":" (repeat 2 digit)) + (rx " " (repeat 1 2 digit) ":" (repeat 2 digit) + (optional "-" (repeat 1 2 digit) ":" (repeat 2 digit))) "Matches the inner, time part of an Org timestamp (i.e. HH:MM). Includes leading space character. Used to build other timestamp regexps.") @@ -226,7 +237,8 @@ regexps.") (group-n 1 (regexp ,org-ql-regexp-ts-inactive))) (seq (or "DEADLINE" "SCHEDULED") ":" (0+ " ") (group-n 1 (regexp ,org-ql-regexp-ts-active)))))) - "Matches CLOSED, DEADLINE or SCHEDULED keyword with timestamp, with or without time.") + "Matches CLOSED, DEADLINE or SCHEDULED keyword with timestamp. +Matches with or without time.") (defvar org-ql-regexp-planning-with-time (rx-to-string `(seq bow (or (seq "CLOSED" ":" (0+ " ") @@ -280,6 +292,11 @@ regexps.") :link '(custom-manual "(org-ql)Usage") :link '(url-link "https://github.com/alphapapa/org-ql")) +(defcustom org-ql-signal-peg-failure nil + "Signal an error when parsing a plain-string query fails. +This should only be enabled while debugging." + :type 'boolean) + (defcustom org-ql-ask-unsafe-queries t "Ask before running a query that could run arbitrary code. Org QL queries in sexp form can contain arbitrary expressions. @@ -427,10 +444,7 @@ each priority the newest items would appear first." (org-ql--sort-by items (-list sort))) ;; Sort by user-given comparator. ((pred functionp) (-sort sort items)) - ;; FIXME: Test more carefully for sorters with arguments. In the meantime, just try to sort. - (_ (org-ql--sort-by items (-list sort))) - ;; (_ (user-error "SORT must be either nil, one or a list of the defined sorting methods (see documentation), or a comparison function of two arguments")) - ))) + (_ (user-error "SORT must be either nil, one or a list of the defined sorting methods (see documentation), or a comparison function of two arguments"))))) ;;;###autoload (cl-defun org-ql-query (&key (select 'element-with-markers) from where narrow order-by) @@ -503,8 +517,14 @@ NARROW corresponds to the `org-ql-select' argument NARROW." (cl-defun org-ql--select (&key preamble preamble-case-fold predicate action narrow &allow-other-keys) - "Return results of mapping function ACTION across entries in current buffer matching function PREDICATE. -If NARROW is non-nil, buffer will not be widened." + "Return results for given arguments. +Return results of mapping function ACTION across entries in +current buffer matching function PREDICATE. If NARROW is +non-nil, buffer will not be widened. + +PREAMBLE may be a regexp to search for before calling PREDICATE. +When doing so, `case-fold-search' is bound to +PREAMBLE-CASE-FOLD." ;; Since the mappings are stored in the variable `org-ql-predicates', macros like `flet' ;; can't be used, so we do it manually (this is same as the equivalent `flet' expansion). ;; Mappings are stored in the variable because it allows predicates to be defined with a @@ -584,7 +604,7 @@ Returns cons (INHERITED-TAGS . LOCAL-TAGS)." (cond ((and (listp inherited) (listp local)) (->> (append inherited local) - -non-nil -uniq)) + -non-nil -uniq)) ((listp inherited) inherited) ((listp local) local))))) (cl-typecase org-use-tag-inheritance @@ -616,9 +636,10 @@ Returns cons (INHERITED-TAGS . LOCAL-TAGS)." "Return outline path for heading at point." (save-excursion (let ((heading (save-match-data - (if (looking-at org-complex-heading-regexp) - (or (match-string 4) "") - "")))) + (let (case-fold-search) + (if (looking-at org-complex-heading-regexp) + (or (match-string-no-properties 4) "") + ""))))) (if (org-up-heading-safe) ;; MAYBE: It seems wrong to call the cache function from ;; inside this function, like a violation of separation of @@ -680,8 +701,8 @@ from within ELEMENT's buffer." ;; time? I don't know, but for now, it seems that we have to use `copy-marker'. (let* ((marker (copy-marker (org-element-property :begin element))) (properties (--> (cadr element) - (plist-put it :org-marker marker) - (plist-put it :org-hd-marker marker)))) + (plist-put it :org-marker marker) + (plist-put it :org-hd-marker marker)))) (setf (cadr element) properties) element)) @@ -699,7 +720,8 @@ returns nil." (user-error "Query aborted by user"))))) (defun org-ql--plist-get* (plist property) - "Return the value of PROPERTY in PLIST, or `not-found' if the property is missing." + "Return the value of PROPERTY in PLIST, or `not-found'. +Returns `not-found' if the property is missing." (if-let ((pair (plist-member plist property))) (cadr pair) 'not-found)) @@ -739,38 +761,38 @@ be coalesced." ;; can't be coalesced with it since they don't specify the same ;; language. That could be fixed, but it's probably not worth it. (cl-labels ((rec (sexp) - (pcase sexp - (`(,(and boolean (or 'or 'not)) . ,sexps) - `(,boolean ,@(mapcar #'rec sexps))) - (`(and . ,sexps) - (anded sexps)) - (_ sexp))) + (pcase sexp + (`(,(and boolean (or 'or 'not)) . ,sexps) + `(,boolean ,@(mapcar #'rec sexps))) + (`(and . ,sexps) + (anded sexps)) + (_ sexp))) (anded (sexps) - (let (anded-predicates new-sexp) - (dolist (sexp sexps) - (pcase sexp - (`(,(or 'or 'not) . ,_) - (push (rec sexp) new-sexp)) - (`(,predicate . ,args) - (pcase-exhaustive (plist-get (alist-get predicate org-ql-predicates) :coalesce) - (`nil (push sexp new-sexp)) - (`t (setf (alist-get predicate anded-predicates) - (append (alist-get predicate anded-predicates) args))) - ((and fn (pred functionp)) - (if-let (new-args (funcall fn (alist-get predicate anded-predicates) args)) - (setf (alist-get predicate anded-predicates) new-args) - (push sexp new-sexp))))))) - (delq nil `(and ,@(nreverse new-sexp) ,@(nreverse anded-predicates)))))) + (let (anded-predicates new-sexp) + (dolist (sexp sexps) + (pcase sexp + (`(,(or 'or 'not) . ,_) + (push (rec sexp) new-sexp)) + (`(,predicate . ,args) + (pcase-exhaustive (plist-get (alist-get predicate org-ql-predicates) :coalesce) + (`nil (push sexp new-sexp)) + (`t (setf (alist-get predicate anded-predicates) + (append (alist-get predicate anded-predicates) args))) + ((and fn (pred functionp)) + (if-let (new-args (funcall fn (alist-get predicate anded-predicates) args)) + (setf (alist-get predicate anded-predicates) new-args) + (push sexp new-sexp))))))) + (delq nil `(and ,@(nreverse new-sexp) ,@(nreverse anded-predicates)))))) (rec query))) (defun org-ql--sanity-check-form (form) "Signal error if any forms in FORM do not have preconditions met. Or, when possible, fix the problem." (cl-flet ((check (symbol) - (cl-case symbol - ('done (unless org-done-keywords - ;; NOTE: This check needs to be done from within the Org buffer being checked. - (error "Variable `org-done-keywords' is nil. Are you running this from an Org buffer?")))))) + (pcase symbol + ('done (unless org-done-keywords + ;; NOTE: This check needs to be done from within the Org buffer being checked. + (error "Variable `org-done-keywords' is nil. Are you running this from an Org buffer?")))))) (cl-loop for elem in form if (consp elem) do (progn @@ -786,38 +808,42 @@ DESCRIPTION-OR-TARGET, match it in either description or target. If DESCRIPTION, match it in the description. If TARGET, match it in the target. If both DESCRIPTION and TARGET, match both, respectively." - (cl-labels - ((no-desc - (match) (rx-to-string `(seq (or bol (1+ blank)) - "[[" (0+ (not (any "]"))) (regexp ,match) (0+ (not (any "]"))) - "]]"))) - (match-both - (description target) - (rx-to-string `(seq (or bol (1+ blank)) - "[[" (0+ (not (any "]"))) (regexp ,target) (0+ (not (any "]"))) - "][" (0+ (not (any "]"))) (regexp ,description) (0+ (not (any "]"))) - "]]"))) - ;; Note that these actually allow empty descriptions - ;; or targets, depending on what they are matching. - (match-desc - (match) (rx-to-string `(seq (or bol (1+ blank)) - "[[" (0+ (not (any "]"))) - "][" (0+ (not (any "]"))) (regexp ,match) (0+ (not (any "]"))) - "]]"))) - (match-target - (match) (rx-to-string `(seq (or bol (1+ blank)) - "[[" (0+ (not (any "]"))) (regexp ,match) (0+ (not (any "]"))) - "][" (0+ (not (any "]"))) - "]]")))) - (cond (description-or-target - (rx-to-string `(or (regexp ,(no-desc description-or-target)) - (regexp ,(match-desc description-or-target)) - (regexp ,(match-target description-or-target))))) - ((and description target) - (match-both description target)) - (description (match-desc description)) - (target (rx-to-string `(or (regexp ,(no-desc target)) - (regexp ,(match-target target)))))))) + ;; This `rx' part is borrowed from `org-make-link-regexps'. It matches the interior of an + ;; Org link target (i.e. the parts between the brackets, including any escaped brackets). + (let ((link-target-part '(0+ (or (not (any "[]\\")) + (and "\\" (0+ "\\\\") (any "[]")) + (and (1+ "\\") (not (any "[]"))))))) + (cl-labels + ((no-desc (match) + (rx-to-string `(seq (or bol (1+ blank)) + "[[" ,link-target-part (regexp ,match) ,link-target-part + "]]"))) + (match-both (description target) + (rx-to-string `(seq (or bol (1+ blank)) + "[[" ,link-target-part (regexp ,target) ,link-target-part + "][" (*? anything) (regexp ,description) (*? anything) + "]]"))) + ;; Note that these actually allow empty descriptions + ;; or targets, depending on what they are matching. + (match-desc (match) + (rx-to-string `(seq (or bol (1+ blank)) + "[[" ,link-target-part + "][" (*? anything) (regexp ,match) (*? anything) + "]]"))) + (match-target (match) + (rx-to-string `(seq (or bol (1+ blank)) + "[[" ,link-target-part (regexp ,match) ,link-target-part + "][" (*? anything) + "]]")))) + (cond (description-or-target + (rx-to-string `(or (regexp ,(no-desc description-or-target)) + (regexp ,(match-desc description-or-target)) + (regexp ,(match-target description-or-target))))) + ((and description target) + (match-both description target)) + (description (match-desc description)) + (target (rx-to-string `(or (regexp ,(no-desc target)) + (regexp ,(match-target target))))))))) (defun org-ql--format-src-block-regexp (&optional lang) "Return regexp equivalent to `org-babel-src-block-regexp' with LANG filled in." @@ -863,48 +889,48 @@ Arguments STRING, POS, FILL, and LEVEL are according to ;; NOTE: The pcases check for both t/nil symbols and strings, because the ;; string queries always return keyword arguments' values as strings. (cl-macrolet ((clocked (&key from to on) - `(org-ql--predicate-clocked :from ,from :to ,to)) + `(org-ql--predicate-clocked :from ,from :to ,to)) (closed (&key from to on (with-time 'not-found)) - `(org-ql--predicate-closed :from ,from :to ,to)) + `(org-ql--predicate-closed :from ,from :to ,to)) (deadline (&key from to on (with-time 'not-found)) - `(org-ql--predicate-deadline - :from ,from :to ,to :with-time ',with-time - :regexp ,(pcase-exhaustive with-time - ((or 't "t") org-ql-regexp-deadline-with-time) - ((or 'nil "nil") org-ql-regexp-deadline-without-time) - ('not-found org-ql-regexp-deadline)))) + `(org-ql--predicate-deadline + :from ,from :to ,to :with-time ',with-time + :regexp ,(pcase-exhaustive with-time + ((or 't "t") org-ql-regexp-deadline-with-time) + ((or 'nil "nil") org-ql-regexp-deadline-without-time) + ('not-found org-ql-regexp-deadline)))) (planning (&key from to on (with-time 'not-found)) - `(org-ql--predicate-planning - :from ,from :to ,to :with-time ',with-time - :regexp ,(pcase-exhaustive with-time - ((or 't "t") org-ql-regexp-planning-with-time) - ((or 'nil "nil") org-ql-regexp-planning-without-time) - ('not-found org-ql-regexp-planning)))) + `(org-ql--predicate-planning + :from ,from :to ,to :with-time ',with-time + :regexp ,(pcase-exhaustive with-time + ((or 't "t") org-ql-regexp-planning-with-time) + ((or 'nil "nil") org-ql-regexp-planning-without-time) + ('not-found org-ql-regexp-planning)))) (scheduled (&key from to on (with-time 'not-found)) - `(org-ql--predicate-scheduled - :from ,from :to ,to :with-time ',with-time - :regexp ,(pcase-exhaustive with-time - ((or 't "t") org-ql-regexp-scheduled-with-time) - ((or 'nil "nil") org-ql-regexp-scheduled-without-time) - ('not-found org-ql-regexp-scheduled)))) + `(org-ql--predicate-scheduled + :from ,from :to ,to :with-time ',with-time + :regexp ,(pcase-exhaustive with-time + ((or 't "t") org-ql-regexp-scheduled-with-time) + ((or 'nil "nil") org-ql-regexp-scheduled-without-time) + ('not-found org-ql-regexp-scheduled)))) (ts (&key from to on (type 'both) (with-time 'not-found)) - ;; NOTE: The TYPE argument is elided from the arguments actually passed to the predicate, being converted to the REGEXP argument. - ;; MAYBE: Move the :regexp handling out of this macrolet and into the normalizer. - `(org-ql--predicate-ts - :from ,from :to ,to :with-time ',with-time - :regexp ,(pcase type - ((or 'nil 'both) (pcase-exhaustive with-time - ((or 't "t") org-ql-regexp-ts-both-with-time) - ((or 'nil "nil") org-ql-regexp-ts-both-without-time) - ('not-found org-ql-regexp-ts-both))) - ('active (pcase-exhaustive with-time - ((or 't "t") org-ql-regexp-ts-active-with-time) - ((or 'nil "nil") org-ql-regexp-ts-active-without-time) - ('not-found org-ql-regexp-ts-active))) - ('inactive (pcase-exhaustive with-time - ((or 't "t") org-ql-regexp-ts-inactive-with-time) - ((or 'nil "nil") org-ql-regexp-ts-inactive-without-time) - ('not-found org-ql-regexp-ts-inactive))))))) + ;; NOTE: The TYPE argument is elided from the arguments actually passed to the predicate, being converted to the REGEXP argument. + ;; MAYBE: Move the :regexp handling out of this macrolet and into the normalizer. + `(org-ql--predicate-ts + :from ,from :to ,to :with-time ',with-time + :regexp ,(pcase type + ((or 'nil 'both) (pcase-exhaustive with-time + ((or 't "t") org-ql-regexp-ts-both-with-time) + ((or 'nil "nil") org-ql-regexp-ts-both-without-time) + ('not-found org-ql-regexp-ts-both))) + ('active (pcase-exhaustive with-time + ((or 't "t") org-ql-regexp-ts-active-with-time) + ((or 'nil "nil") org-ql-regexp-ts-active-without-time) + ('not-found org-ql-regexp-ts-active))) + ('inactive (pcase-exhaustive with-time + ((or 't "t") org-ql-regexp-ts-inactive-with-time) + ((or 'nil "nil") org-ql-regexp-ts-inactive-without-time) + ('not-found org-ql-regexp-ts-inactive))))))) ,query))))) ;;;;; String query parsing @@ -921,22 +947,21 @@ value of `org-ql-predicates')." (let* ((names (--map (symbol-name (plist-get (cdr it) :name)) predicates)) (aliases (->> predicates - (--map (plist-get (cdr it) :aliases)) - -non-nil - -flatten - (-map #'symbol-name))) + (--map (plist-get (cdr it) :aliases)) + -non-nil + -flatten + (-map #'symbol-name))) (predicate-names (->> (append names aliases) - -uniq - ;; Sort the keywords longest-first to work around what seems to be an - ;; obscure bug in `peg': when one keyword is a substring of another, - ;; and the shorter one is listed first, the shorter one fails to match. - (-sort (-on #'> #'length)))) - (pexs `((query (+ term - (opt (+ (syntax-class whitespace) (any))))) + -uniq + ;; Sort the keywords longest-first to work around what seems to be an + ;; obscure bug in `peg': when one keyword is a substring of another, + ;; and the shorter one is listed first, the shorter one fails to match. + (-sort (-on #'> #'length)))) + (pexs `((query (and (* [blank]) (+ (and term (* [blank]))))) (term (or (and negation (list positive-term) ;; This is a bit confusing, but it seems to work. There's probably a better way. `(pred -- (list 'not (car pred)))) - positive-term)) + positive-term empty-quote)) (positive-term (or (and predicate-with-args `(pred args -- (cons (intern pred) args))) (and predicate-without-args `(pred -- (list (intern pred)))) (and plain-string `(s -- (list org-ql-default-predicate s))))) @@ -949,6 +974,12 @@ value of `org-ql-predicates')." (keyword (substring (+ (not (or separator "=" "\"" (syntax-class whitespace))) (any)))) (quoted-arg "\"" (substring (+ (not (or separator "\"")) (any))) "\"") (unquoted-arg (substring (+ (not (or separator "\"" (syntax-class whitespace))) (any)))) + (empty-quote + ;; This avoids aborting parsing or signaling an + ;; error if the user types in two successive + ;; quotation marks while typing a query (e.g. when + ;; using electric-pair-mode). + "\"\"") (negation "!") (separator "," ))) (closure (lambda (input &optional boolean) @@ -969,7 +1000,10 @@ value of `org-ql-predicates')." ;; have to borrow some code. It ends up that we only have to ;; borrow this `with-peg-rules' call, which isn't too bad. (eval `(with-peg-rules ,pexs - (peg-run (peg ,(caar pexs)) #'peg-signal-failure)))))) + (peg-run (peg ,(caar pexs)) + (lambda (failures) + (when org-ql-signal-peg-failure + (peg-signal-failure failures))))))))) (pcase parsed-sexp (`(,one-predicate) one-predicate) (`(,_ . ,_) (cons boolean (reverse parsed-sexp))) @@ -1003,8 +1037,8 @@ manually; see the definition of `org-ql-defpred').") "Define function `org-ql--normalize-query' for PREDICATES. PREDICATES should be the value of `org-ql-predicates'." (let ((normalizer-patterns (->> predicates - (--map (plist-get (cdr it) :normalizers)) - (-flatten-n 1)))) + (--map (plist-get (cdr it) :normalizers)) + (-flatten-n 1)))) (fset 'org-ql--normalize-query (byte-compile `(lambda (query) @@ -1013,21 +1047,21 @@ This function is defined by calling `org-ql--define-normalize-query-fn', which uses normalizer forms defined in `org-ql-predicates' by calling `org-ql-defpred'." (cl-labels ((rec (element) - (pcase element - (`(or . ,clauses) `(or ,@(mapcar #'rec clauses))) - (`(and . ,clauses) `(and ,@(mapcar #'rec clauses))) - (`(not . ,clauses) `(not ,@(mapcar #'rec clauses))) - (`(when ,condition . ,clauses) `(when ,(rec condition) - ,@(mapcar #'rec clauses))) - (`(unless ,condition . ,clauses) `(unless ,(rec condition) - ,@(mapcar #'rec clauses))) - ;; TODO: Combine (regexp) when appropriate (i.e. inside an OR, not an AND). - ((pred stringp) `(,org-ql-default-predicate ,element)) + (pcase element + (`(or . ,clauses) `(or ,@(mapcar #'rec clauses))) + (`(and . ,clauses) `(and ,@(mapcar #'rec clauses))) + (`(not . ,clauses) `(not ,@(mapcar #'rec clauses))) + (`(when ,condition . ,clauses) `(when ,(rec condition) + ,@(mapcar #'rec clauses))) + (`(unless ,condition . ,clauses) `(unless ,(rec condition) + ,@(mapcar #'rec clauses))) + ;; TODO: Combine (regexp) when appropriate (i.e. inside an OR, not an AND). + ((pred stringp) `(,org-ql-default-predicate ,element)) - ,@normalizer-patterns + ,@normalizer-patterns - ;; Any other form: passed through unchanged. - (_ element)))) + ;; Any other form: passed through unchanged. + (_ element)))) ;; Repeat normalization until result doesn't change (limiting to 10 in case of an infinite-loop bug). (cl-loop with limit = 10 and count = 0 for new-query = (rec query) @@ -1080,18 +1114,21 @@ defined in `org-ql-predicates' by calling `org-ql-defpred'." (_ (let ((preamble-case-fold t) org-ql-preamble) (cl-labels ((rec (element) - (or (when org-ql-preamble - ;; Only one preamble is allowed - element) - (pcase element - (`(or _) element) + (or (when org-ql-preamble + ;; Only one preamble is allowed + element) + (pcase element + (`(or ,element) + ;; A predicate with a single name: unwrap the OR. (Pcase doesn't like + ;; "one-armed ORs", giving a "Please avoid it" compilation error.) + element) - ,@preamble-patterns + ,@preamble-patterns - (`(and . ,rest) - (let ((clauses (mapcar #'rec rest))) - `(and ,@(-non-nil clauses)))) - (_ element))))) + (`(and . ,rest) + (let ((clauses (mapcar #'rec rest))) + `(and ,@(-non-nil clauses)))) + (_ element))))) (setq query (pcase (mapcar #'rec (list query)) ((or `(nil) `((nil)) @@ -1107,7 +1144,7 @@ defined in `org-ql-predicates' by calling `org-ql-defpred'." (byte-compile 'org-ql--query-preamble))) (cl-defmacro org-ql-defpred (name args docstring &key body preambles normalizers coalesce) - "Define an `org-ql' selector predicate named `org-ql--predicate-NAME'. + "Define an Org QL selector predicate \\=`org-ql--predicate-NAME'. NAME may be a symbol or a list of symbols: if a list, the first is used as NAME and the rest are aliases. A function is only created for NAME, not for aliases, so a normalizer should be used @@ -1152,7 +1189,7 @@ to variables bound in the pattern: :case-fold Bound to `case-fold-search' around the regexp search. :query Expression which should replace the query expression, - or `query' if it should not be changed (e.g. if the + or \\+`query' if it should not be changed (e.g. if the regexp is insufficient to determine whether a heading matches, in which case the predicate's body needs to be tested on the heading). If the regexp @@ -1179,7 +1216,7 @@ e.g. a predicate takes keyword arguments, so arguments to multiple calls can't be simply appended.) For convenience, within the `pcase' patterns, the symbol -`predicate-names' is a special form which is replaced with a +\\+`predicate-names' is a special form which is replaced with a pattern matching any of the predicate's name and aliases. For example, if NAME were: @@ -1187,13 +1224,13 @@ example, if NAME were: Then if NORMALIZERS were: - ((`(,predicate-names . ,args) - `(heading ,@args))) + ((\\=`(,predicate-names . ,args) + \\=`(heading ,@args))) It would be expanded to: - ((`(,(or 'heading 'h) . ,args) - `(heading ,@args)))" + ((\\=`(,(or \\='heading \\='h) . ,args) + \\=`(heading ,@args)))" ;; FIXME: Update defpred tutorial to include :coalesce. ;; NOTE: The debug form works, completely! For example, use `edebug-defun' @@ -1222,6 +1259,13 @@ It would be expanded to: normalizers)) (preambles (cl-sublis (list (cons 'predicate-names (cons 'or (--map (list 'quote it) predicate-names)))) preambles))) + ;; Ensure that a normalizer is defined if aliases are defined. + ;; (This doesn't ensure that the normalizer does what is intended, + ;; but it's at least some safeguard.) + ;; TODO: Add per-predicate test in suite to ensure that aliases + ;; are normalized to the full name. + (when (and aliases (not normalizers)) + (user-error "org-ql-defpred: Aliases defined for predicate `%s' without a normalizer (which must be used to replace aliases with the predicate's full name)" name)) `(progn (cl-defun ,fn-name ,args ,docstring ,body) ;; SOMEDAY: Use `map-elt' here, after map 2.1 can be automatically installed in CI sandbox... @@ -1266,34 +1310,40 @@ result form." to on)) (when from (setq from (pcase from + ("-" + ;; Ignore, because it means the user is typing a negative number. + nil) ((or 'today "today") (->> (ts-now) - (ts-apply :hour 0 :minute 0 :second 0))) + (ts-apply :hour 0 :minute 0 :second 0))) ((pred numberp) (->> (ts-now) - (ts-adjust 'day from) - (ts-apply :hour 0 :minute 0 :second 0))) + (ts-adjust 'day from) + (ts-apply :hour 0 :minute 0 :second 0))) ((and (pred stringp) (guard (ignore-errors (cl-parse-integer from)))) ;; The `pcase' `let' pattern doesn't bind values in the ;; body forms, so we have to parse the integer again. (->> (ts-now) - (ts-adjust 'day (cl-parse-integer from)) - (ts-apply :hour 0 :minute 0 :second 0))) + (ts-adjust 'day (cl-parse-integer from)) + (ts-apply :hour 0 :minute 0 :second 0))) ((pred stringp) (ts-parse-fill 'begin from)) ((pred ts-p) from)))) (when to (setq to (pcase to + ("-" + ;; Ignore, because it means the user is typing a negative number. + nil) ((or 'today "today") (->> (ts-now) - (ts-apply :hour 23 :minute 59 :second 59))) + (ts-apply :hour 23 :minute 59 :second 59))) ((pred numberp) (->> (ts-now) - (ts-adjust 'day to) - (ts-apply :hour 23 :minute 59 :second 59))) + (ts-adjust 'day to) + (ts-apply :hour 23 :minute 59 :second 59))) ((and (pred stringp) (guard (ignore-errors (cl-parse-integer to)))) ;; The `pcase' `let' pattern doesn't bind values in the ;; body forms, so we have to parse the integer again. (->> (ts-now) - (ts-adjust 'day (cl-parse-integer to)) - (ts-apply :hour 23 :minute 59 :second 59))) + (ts-adjust 'day (cl-parse-integer to)) + (ts-apply :hour 23 :minute 59 :second 59))) ((pred stringp) (ts-parse-fill 'end to)) ((pred ts-p) to)))) (setf result (progn ,@body)) @@ -1319,8 +1369,15 @@ result form." ;; redefinitions until all of the predicates have been defined. (setf org-ql-defpred-defer t) -(org-ql-defpred category (&rest categories) - "Return non-nil if current heading is in one or more of CATEGORIES (a list of strings)." +(org-ql-defpred blocked () + "Return non-nil if entry is blocked. +Calls `org-entry-blocked-p', which see." + :body (org-entry-blocked-p)) + +(org-ql-defpred (category c) (&rest categories) + "Return non-nil if current heading is in one or more of CATEGORIES." + :normalizers ((`(,predicate-names . ,rest) + `(category ,@rest))) :body (when-let ((category (org-get-category (point)))) (cl-typecase categories (null t) @@ -1331,18 +1388,16 @@ result form." ;; NOTE: This was a defsubst before being defined with the macro. Might be good to make it a defsubst again. :body (or (apply #'org-ql--predicate-todo org-done-keywords))) -(defun org-ql--duration-to-minutes (duration) +(defalias 'org-ql--duration-to-minutes + ;; TODO: Remove when compatibility with Org 9.0 is dropped. + (cond ((fboundp 'org-duration-to-minutes) #'org-duration-to-minutes) + ((fboundp 'org-duration-string-to-minutes) #'org-duration-string-to-minutes) + (t (error "org-ql: Unable to define alias `org-ql-search--link-heading-search-string'. Please report this as a bug"))) "Return DURATION string as a number of minutes. For compatibility, since Org 9.1 deprecated `org-duration-string-to-minutes', replacing it with `org-duration-to-minutes', which seems to return floats instead -of integers." - ;; FIXME: Define this as an alias instead. - ;; MAYBE: Remove if compatibility with Org 9.0 is dropped. - (funcall (if (fboundp 'org-duration-to-minutes) - #'org-duration-to-minutes - #'org-duration-string-to-minutes) - duration)) +of integers.") (org-ql-defpred effort (&optional effort-or-comparator effort) "Return non-nil if current heading's effort property matches arguments. @@ -1350,7 +1405,8 @@ The following forms are accepted: (effort DURATION): Matches if effort is DURATION. (effort DURATION DURATION): Matches if effort is between DURATIONs, inclusive. - (effort COMPARATOR DURATION): Matches if effort compares to DURATION with COMPARATOR. + (effort COMPARATOR DURATION): Matches if effort compares to DURATION with + COMPARATOR. COMPARATOR may be `<', `<=', `>', or `>='. DURATION should be an Org effort string, like \"5\" or \"0:05\"." @@ -1408,32 +1464,16 @@ Org effort string, like \"5\" or \"0:05\"." (list :regexp (rx bol (0+ space) ":STYLE:" (1+ space) "habit" (0+ space) eol)))) :body (org-is-habit-p)) -(org-ql-defpred (heading h) (&rest strings) +(org-ql-defpred (heading h) (&rest _strings) "Return non-nil if current entry's heading matches all STRINGS. Matching is done case-insensitively." :coalesce t :normalizers ((`(,predicate-names . ,args) - ;; "h" alias. - `(heading ,@args))) - ;; TODO: Adjust regexp to avoid matching in tag list. - :preambles ((`(,predicate-names ,string) - ;; Only one string: match with preamble, then let predicate confirm (because - ;; the match could be in e.g. the tags rather than the heading text). - (list :regexp (rx-to-string `(seq bol (1+ "*") (1+ blank) (0+ nonl) - ,string) - 'no-group) - :case-fold t :query query)) - (`(,predicate-names . ,strings) - ;; Multiple strings: use preamble to match against first - ;; string, then let the predicate match the rest. - (list :regexp (rx-to-string `(seq bol (1+ "*") (1+ blank) (0+ nonl) - ,(car strings)) - 'no-group) - :case-fold t :query query))) - ;; TODO: In Org 9.2+, `org-get-heading' takes 2 more arguments. - :body (let ((heading (org-get-heading 'no-tags 'no-todo)) - (case-fold-search t)) - (--all? (string-match it heading) strings))) + ;; NOTE: Each string argument must be converted to a regexp + ;; for testing by the body, so we just normalize to the + ;; `heading-regexp' predicate, leaving this predicate as + ;; one that merely regexp-quotes its arguments. + `(heading-regexp ,@(mapcar #'regexp-quote args))))) (org-ql-defpred (heading-regexp h*) (&rest regexps) "Return non-nil if current entry's heading matches all REGEXPS (regexp strings). @@ -1443,7 +1483,15 @@ Matching is done case-insensitively." ;; "h" alias. `(heading-regexp ,@args))) ;; MAYBE: Adjust regexp to avoid matching in tag list. - :preambles ((`(,predicate-names ,regexp) + :preambles ((`(,predicate-names) + ;; This clause protects against the case in which the + ;; arguments are nil, which would cause an error in + ;; `rx-to-string' in other clauses. This can happen + ;; with `org-ql-completing-read', e.g. when the input + ;; is "h:" while the user is typing. + (list :regexp (rx bol (1+ "*") (1+ blank) (0+ nonl)) + :case-fold t :query query)) + (`(,predicate-names ,regexp) ;; Only one regexp: match with preamble, then let predicate confirm (because ;; the match could be in e.g. the tags rather than the heading text). (list :regexp (rx-to-string `(seq bol (1+ "*") (1+ blank) (0+ nonl) @@ -1467,8 +1515,10 @@ Matching is done case-insensitively." The following forms are accepted: (level NUMBER): Matches if heading level is NUMBER. - (level NUMBER NUMBER): Matches if heading level is equal to or between NUMBERs. - (level COMPARATOR NUMBER): Matches if heading level compares to NUMBER with COMPARATOR. + (level NUMBER NUMBER): Matches if heading level is equal to or between + NUMBERs. + (level COMPARATOR NUMBER): Matches if heading level compares to NUMBER with + COMPARATOR. COMPARATOR may be `<', `<=', `>', or `>='." :normalizers ((`(,predicate-names . ,args) @@ -1479,7 +1529,16 @@ COMPARATOR may be `<', `<=', `>', or `>='." ((pred stringp) (string-to-number it)) (_ it)) args)))) - :preambles ((`(,predicate-names ,comparator-or-num ,num) + :preambles ((`(,predicate-names) + ;; This clause protects against the case in which the + ;; arguments are nil, which would cause an error in + ;; `rx-to-string' in other clauses. This can happen + ;; with `org-ql-completing-read', e.g. when the input + ;; is "h:" while the user is typing. + (list :regexp (rx bol (1+ "*") " ") + :case-fold t)) + ((and `(,predicate-names ,comparator-or-num ,num) + (guard (numberp num))) (let ((repeat (pcase comparator-or-num ('< `(repeat 1 ,(1- num) "*")) ('<= `(repeat 1 ,num "*")) @@ -1488,7 +1547,8 @@ COMPARATOR may be `<', `<=', `>', or `>='." ((pred integerp) `(repeat ,comparator-or-num ,num "*"))))) (list :regexp (rx-to-string `(seq bol ,repeat " ") t) :case-fold t))) - (`(,predicate-names ,num) + ((and `(,predicate-names ,num) + (guard (numberp num))) (list :regexp (rx-to-string `(seq bol (repeat ,num "*") " ") t) :case-fold t))) ;; NOTE: It might be necessary to take into account `org-odd-levels'; see docstring for @@ -1517,12 +1577,8 @@ any link is found." ;; enabled nearly all of the time, in which case this function won't be called anyway, it's ;; probably not worth rewriting code all over the place to fix this. :preambles ((`(,predicate-names) - (list :regexp ;; Match a link with a target and optionally a description. - (rx (or bol (1+ blank)) - "[[" (1+ (not (any "]"))) "]" - (optional (seq "[" (0+ (not (any "]"))) "]")) - "]" - (or eol blank)))) + ;; Match a link with a target and optionally a description. + (list :regexp (org-ql--link-regexp :target ".*"))) (`(,predicate-names ,(and description-or-target (guard (not (keywordp description-or-target)))) . ,plist) @@ -1570,14 +1626,18 @@ any link is found." (or (null description) (string-match-p description (match-string org-ql-link-description-group))))) (_ (if (and description target) - (and (string-match-p target (match-string 1)) - (string-match-p description (match-string org-ql-link-description-group))) - (or (string-match-p description-or-target (match-string 1)) - (string-match-p description-or-target - (match-string org-ql-link-description-group))))))))) + (and (and (match-string 1) + (string-match-p target (match-string 1))) + (and (match-string org-ql-link-description-group) + (string-match-p description (match-string org-ql-link-description-group)))) + (or (and (match-string 1) + (string-match-p description-or-target (match-string 1))) + (and (match-string org-ql-link-description-group) + (string-match-p description-or-target + (match-string org-ql-link-description-group)))))))))) (org-ql-defpred (rifle smart) (&rest strings) - "Return non-nil if each string argument is found in either the entry or its outline path. + "Return non-nil if each of strings is found in the entry or its outline path. Works like `org-rifle'. This is probably the most useful, intuitive, general-purpose predicate." ;; NOTE: This predicate advertises that it takes strings, but they @@ -1644,7 +1704,7 @@ contiguous segment of the outline path: :body (org-ql--infix-p regexps (org-ql--value-at (point) #'org-ql--outline-path))) (org-ql-defpred path (&rest regexps) - "Return non-nil if current heading's buffer's filename path matches any of REGEXPS (regexp strings). + "Return non-nil if current heading's buffer's file path matches any of REGEXPS. Without arguments, return non-nil if buffer is file-backed." ;; FIXME: This should AND the regexps together, not OR them. :body (when (buffer-file-name) @@ -1730,30 +1790,82 @@ priority B)." (cl-loop for priority-arg in args thereis (= item-priority (* 1000 (- org-lowest-priority (string-to-char priority-arg))))))))) -(org-ql-defpred property (property &optional value) - "Return non-nil if current entry has PROPERTY (a string), and optionally VALUE (a string)." - :normalizers ((`(,predicate-names ,property . ,value) +(org-ql-defpred property (property &optional value &key inherit) + "Return non-nil if current entry has PROPERTY, and optionally VALUE. +If INHERIT is nil, only match entries with PROPERTY set on the +entry; if t, also match entries with inheritance. If INHERIT is +not specified, use the Boolean value of +`org-use-property-inheritance', which see (i.e. it is only +interpreted as nil or non-nil)." + :normalizers ((`(,predicate-names) + ;; HACK: This clause protects against the case in + ;; which the arguments are nil, which would cause an + ;; error in `rx-to-string' in other clauses. This + ;; can happen with `org-ql-completing-read', + ;; e.g. when the input is "property:" while the user + ;; is typing. + ;; FIXME: Instead of this being moot, make this + ;; predicate test for whether an entry has local + ;; properties when no arguments are given. + (list 'property "")) + (`(,predicate-names ,property) ;; Convert keyword property arguments to strings. Non-sexp ;; queries result in keyword property arguments (because to do ;; otherwise would require ugly special-casing in the parsing). (when (keywordp property) (setf property (substring (symbol-name property) 1))) - (cons 'property (cons property value)))) + (list 'property property)) + (`(,predicate-names ,property . ,rest) + (pcase rest + (`(,value) + ;; Convert keyword property arguments to strings. Non-sexp + ;; queries result in keyword property arguments (because to do + ;; otherwise would require ugly special-casing in the parsing). + (when (keywordp property) + (setf property (substring (symbol-name property) 1))) + (list 'property property value)) + ((and `(,value . ,plist) + (guard (not (keywordp value)))) + ;; Convert keyword property arguments to strings. Non-sexp + ;; queries result in keyword property arguments (because to do + ;; otherwise would require ugly special-casing in the parsing). + (when (keywordp property) + (setf property (substring (symbol-name property) 1))) + (list 'property property value + :inherit (cond ((plist-member plist :inherit) (plist-get plist :inherit)) + ((listp org-use-property-inheritance) ''selective) + (t org-use-property-inheritance)))) + ((and plist (guard (keywordp (car rest)))) + ;; Convert keyword property arguments to strings. Non-sexp + ;; queries result in keyword property arguments (because to do + ;; otherwise would require ugly special-casing in the parsing). + (when (keywordp property) + (setf property (substring (symbol-name property) 1))) + (list 'property property nil + :inherit (cond ((plist-member plist :inherit) (plist-get plist :inherit)) + ((listp org-use-property-inheritance) ''selective) + (t org-use-property-inheritance))))))) ;; MAYBE: Should case folding be disabled for properties? What about values? ;; MAYBE: Support (property) without args. - :preambles ((`(,predicate-names ,property ,value) + + ;; NOTE: When inheritance is enabled, the preamble can't be used, + ;; which will make the search slower. + :preambles (((and `(,predicate-names ,property ,value) + (guard (atom value))) ;; We do NOT return nil, because the predicate still needs to be tested, ;; because the regexp could match a string not inside a property drawer. (list :regexp (rx-to-string `(seq bol (0+ space) ":" ,property ":" (1+ space) ,value (0+ space) eol)) :query query)) - (`(,predicate-names ,property) - ;; We do NOT return nil, because the predicate still needs to be tested, + ((and `(,predicate-names ,property ,value . ,plist) + (guard (keywordp (car plist)))) + ;; WE do NOT return nil, because the predicate still needs to be tested, ;; because the regexp could match a string not inside a property drawer. ;; NOTE: The preamble only matches if there appears to be a value. ;; A line like ":ID: " without any other text does not match. - (list :regexp (rx-to-string `(seq bol (0+ space) ":" ,property ":" (1+ space) - (minimal-match (1+ not-newline)) eol)) + (list :regexp (unless (plist-get plist :inherit) + (rx-to-string `(seq bol (0+ space) ":" ,property ":" (1+ space) + (minimal-match (1+ not-newline)) eol))) :query query))) :body (pcase property @@ -1761,10 +1873,21 @@ priority B)." (_ (pcase value ('nil ;; Check that PROPERTY exists - (org-entry-get (point) property)) + (org-ql--value-at + (point) (lambda () + (org-entry-get (point) property inherit)))) (_ - ;; Check that PROPERTY has VALUE - (string-equal value (org-entry-get (point) property 'selective))))))) + ;; Check that PROPERTY has VALUE. + + ;; TODO: Since --value-at doesn't account for inheritance, + ;; we should generalize --tags-at to also work for property + ;; inheritance and use it here, which should be much faster. + (string-equal value (org-ql--value-at + (point) (lambda () + (org-entry-get (point) property inherit))))))))) + +;; TODO: Add property-local, property-inherit, etc. to match tags predicates. +;; TODO: Add tests for property inheritance. (org-ql-defpred (regexp r) (&rest regexps) "Return non-nil if current entry matches all of REGEXPS (regexp strings)." @@ -1788,21 +1911,38 @@ priority B)." (re-search-forward regexp end t)))))) (org-ql-defpred src (&key regexps lang) - "Return non-nil if current entry contains an Org source block matching all of REGEXPS. + "Return non-nil if current entry has an Org source block matching all REGEXPS. If keyword argument LANG is non-nil, the block must be in that -language." +language. Matching is done case-insensitively." :coalesce (lambda (coalesced-args current-args) (when (or (not coalesced-args) (equal (plist-get current-args :lang) (plist-get coalesced-args :lang))) - (plist-put coalesced-args :regexps (append (plist-get coalesced-args :regexps) - (plist-get current-args :regexps))) - (plist-put coalesced-args :lang (plist-get current-args :lang)))) - :normalizers ((`(,predicate-names . ,args) + (setf coalesced-args + (plist-put coalesced-args :lang (plist-get current-args :lang))) + (setf coalesced-args + (plist-put coalesced-args + :regexps (list 'quote + (append (car (delq 'quote (plist-get coalesced-args :regexps))) + ;; A bit awkward, but necessary. + (car (delq 'quote (plist-get current-args :regexps))))))))) + :normalizers ((`(,predicate-names) + ;; This clause protects against the case in which the + ;; arguments are nil, which would cause an error in + ;; `rx-to-string' in other clauses. This can happen + ;; with `org-ql-completing-read', e.g. when the input + ;; is "src:" while the user is typing. + (list 'src)) + ;; NOTE: The :regexps argument is a quoted list, + ;; because we call the byte-compiler at runtime, and + ;; without quoting, it would interpret it as a + ;; function call. This requires some awkwardness in + ;; other places to deal with the quoting. + (`(,predicate-names . ,args) ;; Rewrite to use keyword args. (cond ((cl-every #'stringp args) ;; No keywords, only regexps. - `(src :regexps ,args)) + `(src :regexps ',args)) ((and (stringp (car args)) (cl-some #'keywordp args)) ;; Regexp as first arg with keyword later. (let* ((keyword-pos (cl-position :lang args)) @@ -1810,47 +1950,60 @@ language." ;; We assume that if :lang is given, the string argument follows. (lang (nth (1+ (cl-position :lang args)) args))) `(src :lang ,lang - :regexps ,regexps))) + :regexps ',regexps))) ((keywordp (car args)) ;; All plist args. `(src ,@(delq nil (append (when (plist-get args :lang) (list :lang (plist-get args :lang))) - (when (plist-get args :regexps) - (list :regexps (plist-get args :regexps)))))))))) - :preambles ((`(,predicate-names . ,args) + (pcase (plist-get args :regexps) + (`(quote . ,_) + ;; Already quoted: return as-is to stop further normalization. + (list :regexps (plist-get args :regexps))) + (_ (list :regexps `(quote ,(plist-get args :regexps)))))))))))) + ;; NOTE: We match case-insensitively since the + ;; "#+BEGIN_SRC/#+END_SRC" lines could be either upper- or + ;; lowercase, as well as the language name. + :preambles ((`(,predicate-names) + ;; This clause protects against the case in which the + ;; arguments are nil, which would cause an error in + ;; `rx-to-string' in other clauses. This can happen + ;; with `org-ql-completing-read', e.g. when the input + ;; is "src:" while the user is typing. + (list :regexp (org-ql--format-src-block-regexp) + :case-fold t + ;; Always check contents with predicate. + :query query)) + (`(,predicate-names . ,args) (list :regexp (org-ql--format-src-block-regexp (plist-get args :lang)) + :case-fold t ;; Always check contents with predicate. :query query))) :body - (catch 'return - (save-excursion - (save-match-data - (when (re-search-forward org-babel-src-block-regexp (org-entry-end-position) t) - (when lang - (unless (string= lang (match-string 2)) - (throw 'return nil))) - (if regexps - (let ((contents-beg (progn - (goto-char (match-beginning 0)) - (forward-line 1) - (point))) - (contents-end (progn - (goto-char (match-end 0)) - (point-at-bol)))) - (cl-loop for re in regexps - do (goto-char contents-beg) - always (re-search-forward re contents-end t))) - ;; No regexps to check: return non-nil. - t)))))) + (save-excursion + (save-match-data + (cl-loop while (re-search-forward org-babel-src-block-regexp (org-entry-end-position) t) + thereis (when (or (not lang) (equal lang (match-string 2))) + (or (not regexps) + (save-excursion + (let ((contents-beg (progn + (goto-char (match-beginning 0)) + (forward-line 1) + (point))) + (contents-end (progn + (goto-char (match-end 0)) + (pos-bol)))) + (cl-loop for re in regexps + do (goto-char contents-beg) + always (re-search-forward re contents-end t)))))))))) (org-ql-defpred (tags) (&rest tags) "Return non-nil if current heading has one or more of TAGS (a list of strings). Tests both inherited and local tags." ;; MAYBE: -all versions for inherited and local. :body (cl-macrolet ((tags-p (tags) - `(and ,tags - (not (eq 'org-ql-nil ,tags))))) + `(and ,tags + (not (eq 'org-ql-nil ,tags))))) (-let* (((inherited local) (org-ql--tags-at (point)))) (cl-typecase tags (null (or (tags-p inherited) @@ -1870,13 +2023,13 @@ Tests both inherited and local tags." :body (apply #'org-ql--predicate-tags tags)) (org-ql-defpred (tags-inherited inherited-tags tags-i itags) (&rest tags) - "Return non-nil if current heading's inherited tags include one or more of TAGS (a list of strings). + "Return non-nil if current heading's inherited tags include any of TAGS. If TAGS is nil, return non-nil if heading has any inherited tags." :normalizers ((`(,predicate-names . ,tags) `(tags-inherited ,@tags))) :body (cl-macrolet ((tags-p (tags) - `(and ,tags - (not (eq 'org-ql-nil ,tags))))) + `(and ,tags + (not (eq 'org-ql-nil ,tags))))) (-let* (((inherited _) (org-ql--tags-at (point)))) (cl-typecase tags (null (tags-p inherited)) @@ -1884,7 +2037,7 @@ If TAGS is nil, return non-nil if heading has any inherited tags." (seq-intersection tags inherited))))))) (org-ql-defpred (tags-local local-tags tags-l ltags) (&rest tags) - "Return non-nil if current heading's local tags include one or more of TAGS (a list of strings). + "Return non-nil if current heading's local tags include any of TAGS. If TAGS is nil, return non-nil if heading has any local tags." :normalizers ((`(,predicate-names . ,tags) `(tags-local ,@tags))) @@ -1896,8 +2049,8 @@ If TAGS is nil, return non-nil if heading has any local tags." t) :query t))) :body (cl-macrolet ((tags-p (tags) - `(and ,tags - (not (eq 'org-ql-nil ,tags))))) + `(and ,tags + (not (eq 'org-ql-nil ,tags))))) (-let* (((_ local) (org-ql--tags-at (point)))) (cl-typecase tags (null (tags-p local)) @@ -1910,8 +2063,8 @@ Tests both inherited and local tags." :normalizers ((`(,predicate-names . ,regexps) `(tags-regexp ,@regexps))) :body (cl-macrolet ((tags-p (tags) - `(and ,tags - (not (eq 'org-ql-nil ,tags))))) + `(and ,tags + (not (eq 'org-ql-nil ,tags))))) (-let* (((inherited local) (org-ql--tags-at (point)))) (cl-typecase regexps (null (or (tags-p inherited) @@ -1927,7 +2080,7 @@ Tests both inherited and local tags." (org-ql-defpred todo (&rest keywords) "Return non-nil if current heading is a TODO item. -With KEYWORDS, return non-nil if its keyword is one of KEYWORDS (a list of strings)." +With KEYWORDS, return non-nil if its keyword is one of KEYWORDS." ;; TODO: Can we make a preamble for plain (todo) queries? :preambles ((`(,predicate-names . ,(and todo-keywords (guard todo-keywords))) (list :case-fold nil :regexp (rx-to-string `(seq bol (1+ "*") (1+ space) (or ,@todo-keywords) (or " " eol)) t)))) @@ -1961,7 +2114,7 @@ With KEYWORDS, return non-nil if its keyword is one of KEYWORDS (a list of strin :normalizers ((`(,predicate-names ;; Avoid infinitely compiling already-compiled functions. ,(and query (guard (not (byte-code-function-p query))))) - `(ancestors ,(org-ql--query-predicate (rec query)))) + `(ancestors ,(org-ql--query-predicate (org-ql--normalize-query query)))) (`(,predicate-names) '(ancestors (lambda () t)))) :body (org-with-wide-buffer @@ -1973,7 +2126,7 @@ With KEYWORDS, return non-nil if its keyword is one of KEYWORDS (a list of strin :normalizers ((`(,predicate-names ;; Avoid infinitely compiling already-compiled functions. ,(and query (guard (not (byte-code-function-p query))))) - `(parent ,(org-ql--query-predicate (rec query)))) + `(parent ,(org-ql--query-predicate (org-ql--normalize-query query)))) (`(,predicate-names) '(parent (lambda () t)))) :body (org-with-wide-buffer @@ -2117,8 +2270,8 @@ non-nil if entry has a deadline." :normalizers ((`(,predicate-names auto . ,rest) ;; Use `org-deadline-warning-days' as the :to arg. (let ((ts (->> (ts-now) - (ts-adjust 'day org-deadline-warning-days) - (ts-apply :hour 23 :minute 59 :second 59)))) + (ts-adjust 'day org-deadline-warning-days) + (ts-apply :hour 23 :minute 59 :second 59)))) `(deadline-warning :to ,ts ,@rest))) (`(,predicate-names . ,(and rest (guard (numberp (car rest))))) (org-ql--normalize-from-to-on @@ -2141,7 +2294,8 @@ non-nil if entry has a deadline." (org-ql-defpred deadline-warning (&key from to) ;; TODO: Should this also accept a WITH-TIME argument? ;; MAYBE: Use the new org-ql-regexps? - "Internal predicate used to handle `org-deadline-warning-days' and deadlines with warning periods." + "Internal predicate. +Used to handle `org-deadline-warning-days' and deadlines with warning periods." :preambles ((`(,predicate-names . ,_) (list :regexp org-deadline-time-regexp :query query))) :body @@ -2258,12 +2412,12 @@ any planning prefix); it defaults to 0 (i.e. the whole regexp)." :body (cl-macrolet ((next-timestamp () - `(when (re-search-forward regexp limit t) - (ts-parse-org (match-string match-group)))) + `(when (re-search-forward regexp limit t) + (ts-parse-org (match-string match-group)))) (test-timestamps (pred-form) - `(cl-loop for next-ts = (next-timestamp) - while next-ts - thereis ,pred-form))) + `(cl-loop for next-ts = (next-timestamp) + while next-ts + thereis ,pred-form))) (save-excursion (cond ((not (or from to)) (re-search-forward regexp limit t)) ((and from to) (test-timestamps (ts-in from to next-ts))) @@ -2289,34 +2443,27 @@ PREDICATES is a list of one or more sorting methods, including: `deadline', `scheduled', `closed' and `priority'." ;; MAYBE: Use macrolet instead of flet. (cl-flet* ((sorter (symbol) - (pcase symbol - ((or 'deadline 'scheduled 'closed) - (apply-partially #'org-ql--date-type< (intern (concat ":" (symbol-name symbol))))) - ;; TODO: Rename `date' to `planning'. `date' should be something else. - ('date #'org-ql--date<) - ('priority #'org-ql--priority<) - ('random (lambda (&rest _ignore) - (= 0 (random 2)))) - ;; NOTE: reverse and todo are handled below. - ;; TODO: Add more. - (`(tags . ,tags) (lambda (a b) - "Return non-nil if A has certain tags and B doesn't." - (cl-flet ((test-entry - (entry) (org-with-point-at (org-element-property :org-hd-marker entry) - (apply #'org-ql--predicate-tags tags)))) - (and (test-entry a) - (not (test-entry b)))))) - (_ (user-error "Invalid sorting predicate: %s" symbol)))) + (pcase symbol + ((or 'deadline 'scheduled 'closed) + (apply-partially #'org-ql--date-type< (intern (concat ":" (symbol-name symbol))))) + ;; TODO: Rename `date' to `planning'. `date' should be something else. + ('date #'org-ql--date<) + ('priority #'org-ql--priority<) + ('random (lambda (&rest _ignore) + (= 0 (random 2)))) + ;; NOTE: reverse and todo are handled below. + ;; TODO: Add more. + (_ (user-error "Invalid sorting predicate: %s" symbol)))) (sort-by-todo-keyword (items) - (let* ((grouped-items (--group-by (when-let (keyword (org-element-property :todo-keyword it)) - (substring-no-properties keyword)) - items)) - (sorted-groups (cl-sort grouped-items #'< - :key (lambda (keyword) - (or (cl-position (car keyword) org-todo-keywords-1 :test #'string=) - ;; Put at end of list if not found - (1+ (length org-todo-keywords-1))))))) - (-flatten-n 1 (-map #'cdr sorted-groups))))) + (let* ((grouped-items (--group-by (when-let (keyword (org-element-property :todo-keyword it)) + (substring-no-properties keyword)) + items)) + (sorted-groups (cl-sort grouped-items #'< + :key (lambda (keyword) + (or (cl-position (car keyword) org-todo-keywords-1 :test #'string=) + ;; Put at end of list if not found + (1+ (length org-todo-keywords-1))))))) + (-flatten-n 1 (-map #'cdr sorted-groups))))) (dolist (pred predicates) (setq items (pcase pred ;; NOTE: Using `reverse' instead of `nreverse' because my gut @@ -2341,16 +2488,16 @@ A and B are Org headline elements. TYPE should be a symbol like "Return non-nil if A's deadline or scheduled property is earlier than B's. Deadline is considered before scheduled." (cl-macrolet ((ts (item) - `(or (org-element-property :deadline ,item) - (org-element-property :scheduled ,item)))) + `(or (org-element-property :deadline ,item) + (org-element-property :scheduled ,item)))) (org-ql--org-timestamp-element< (ts a) (ts b)))) (defun org-ql--org-timestamp-element< (a b) "Return non-nil if A's date element is earlier than B's. A and B are Org timestamp elements." (cl-macrolet ((ts (ts) - `(when ,ts - (org-timestamp-format ,ts "%s")))) + `(when ,ts + (org-ql--org-timestamp-format ,ts "%s")))) (let* ((a-ts (ts a)) (b-ts (ts b))) (cond ((and a-ts b-ts) @@ -2362,7 +2509,7 @@ A and B are Org timestamp elements." "Return non-nil if A's priority is higher than B's. A and B are Org headline elements." (cl-macrolet ((priority (item) - `(org-element-property :priority ,item))) + `(org-element-property :priority ,item))) ;; NOTE: Priorities are numbers in Org elements. This might differ from the priority selector logic. (let ((a-priority (priority a)) (b-priority (priority b))) @@ -2390,66 +2537,66 @@ element should be a regexp string." If QUERY can't be converted to a string, return nil." ;; This started out pretty simple...but at least it's not just one long function, right? (cl-labels ((complex-p (query) - (or (contains-p 'or query) - (contains-p 'ancestors query) - (contains-p 'children query) - (contains-p 'descendants query) - (contains-p 'parent query))) + (or (contains-p 'or query) + (contains-p 'ancestors query) + (contains-p 'children query) + (contains-p 'descendants query) + (contains-p 'parent query))) (contains-p (symbol list) - (cl-loop for element in list - thereis (or (eq symbol element) - (and (listp element) - (contains-p symbol element))))) - (format-args - (args) (let (non-paired paired next-keyword) - (cl-loop for arg in args - do (cond (next-keyword (push (cons next-keyword arg) paired) - (setf next-keyword nil)) - ((keywordp arg) (setf next-keyword (substring (symbol-name arg) 1))) - (t (push arg non-paired)))) - (string-join (append (mapcar #'format-atom non-paired) - (nreverse (--map (format "%s=%s" (car it) (cdr it)) - paired))) - ","))) - (format-atom - (atom) (cl-typecase atom - (string (if (string-match (rx space) atom) - (format "%S" atom) - (format "%s" atom))) - (t (format "%s" atom)))) - (format-form - (form) (pcase form - (`(not . (,rest)) (concat "!" (format-form rest))) - (`(priority . ,_) (format-priority form)) - ;; FIXME: Convert (src) queries to non-sexp form...someday... - (`(src . ,_) (user-error "Converting (src ...) queries to non-sexp form is not implemented")) - (_ (pcase-let* ((`(,pred . ,args) form) - (args-string (pcase args - ('() "") - ((guard (= 1 (length args))) (format "%s" (car args))) - (_ (format-args args))))) - (format "%s:%s" pred args-string))))) - (format-and - (form) (pcase-let* ((`(and . ,rest) form)) - (string-join (mapcar #'format-form rest) " "))) - (format-priority - (form) (pcase-let* ((`(priority . ,rest) form) - (args (pcase rest - (`(,(and comparator (or '< '<= '> '>= '=)) ,letter) - (priority-letters comparator letter)) - (_ rest)))) - (concat "priority:" (string-join args ",")))) - (priority-letters - (comparator letter) (let* ((char (string-to-char (upcase (symbol-name letter)))) - (numeric-priorities '(?A ?B ?C)) - ;; NOTE: The comparator inversion is intentional. - (others (pcase comparator - ('< (--select (> it char) numeric-priorities)) - ('<= (--select (>= it char) numeric-priorities)) - ('> (--select (< it char) numeric-priorities)) - ('>= (--select (<= it char) numeric-priorities)) - ('= (--select (= it char) numeric-priorities))))) - (mapcar #'char-to-string others)))) + (cl-loop for element in list + thereis (or (eq symbol element) + (and (listp element) + (contains-p symbol element))))) + (format-args (args) + (let (non-paired paired next-keyword) + (cl-loop for arg in args + do (cond (next-keyword (push (cons next-keyword arg) paired) + (setf next-keyword nil)) + ((keywordp arg) (setf next-keyword (substring (symbol-name arg) 1))) + (t (push arg non-paired)))) + (string-join (append (mapcar #'format-atom non-paired) + (nreverse (--map (format "%s=%s" (car it) (cdr it)) + paired))) + ","))) + (format-atom (atom) + (cl-typecase atom + (string (if (string-match (rx space) atom) + (format "%S" atom) + (format "%s" atom))) + (t (format "%s" atom)))) + (format-form (form) + (pcase form + (`(not . (,rest)) (concat "!" (format-form rest))) + (`(priority . ,_) (format-priority form)) + ;; FIXME: Convert (src) queries to non-sexp form...someday... + (`(src . ,_) (user-error "Converting (src ...) queries to non-sexp form is not implemented")) + (_ (pcase-let* ((`(,pred . ,args) form) + (args-string (pcase args + ('() "") + ((guard (= 1 (length args))) (format "%s" (car args))) + (_ (format-args args))))) + (format "%s:%s" pred args-string))))) + (format-and (form) + (pcase-let* ((`(and . ,rest) form)) + (string-join (mapcar #'format-form rest) " "))) + (format-priority (form) + (pcase-let* ((`(priority . ,rest) form) + (args (pcase rest + (`(,(and comparator (or '< '<= '> '>= '=)) ,letter) + (priority-letters comparator letter)) + (_ rest)))) + (concat "priority:" (string-join args ",")))) + (priority-letters (comparator letter) + (let* ((char (string-to-char (upcase (symbol-name letter)))) + (numeric-priorities '(?A ?B ?C)) + ;; NOTE: The comparator inversion is intentional. + (others (pcase comparator + ('< (--select (> it char) numeric-priorities)) + ('<= (--select (>= it char) numeric-priorities)) + ('> (--select (< it char) numeric-priorities)) + ('>= (--select (<= it char) numeric-priorities)) + ('= (--select (= it char) numeric-priorities))))) + (mapcar #'char-to-string others)))) ;; FIXME: Error out for ts structs passed to `ts' predicate (very unlikely to be linked to). (unless (complex-p query) (pcase query diff --git a/org-ql.info b/org-ql.info index cfb9896..7f08c68 100644 --- a/org-ql.info +++ b/org-ql.info @@ -1,4 +1,4 @@ -This is README.info, produced by makeinfo version 5.2 from README.texi. +This is README.info, produced by makeinfo version 6.7 from README.texi. INFO-DIR-SECTION Emacs START-INFO-DIR-ENTRY @@ -26,6 +26,7 @@ and saved views. * Installation:: * Usage:: * Changelog:: +* Development:: * Notes:: * License:: @@ -48,6 +49,8 @@ Usage Commands * org-ql-find:: +* org-ql-open-link:: +* org-ql-refile:: * org-ql-search:: * helm-org-ql:: * org-ql-view:: @@ -70,31 +73,56 @@ Functions / Macros Changelog -* 0.7-pre: 07-pre. -* 0.6.2: 062. -* 0.6.1: 061. -* 0.6: 06. -* 0.5.2: 052. -* 0.5.1: 051. -* 0.5: 05. -* 0.4.9: 049. -* 0.4.8: 048. -* 0.4.7: 047. -* 0.4.6: 046. -* 0.4.5: 045. -* 0.4.4: 044. -* 0.4.3: 043. -* 0.4.2: 042. -* 0.4.1: 041. -* 0.4: 04. -* 0.3.2: 032. -* 0.3.1: 031. -* 0.3: 03. -* 0.2.3: 023. -* 0.2.2: 022. -* 0.2.1: 021. -* 0.2: 02. -* 0.1: 01. +* 0.9-pre: 09-pre. +* 0.8.10: 0810. +* 0.8.9: 089. +* 0.8.8: 088. +* 0.8.7: 087. +* 0.8.6: 086. +* 0.8.5: 085. +* 0.8.4: 084. +* 0.8.3: 083. +* 0.8.2: 082. +* 0.8.1: 081. +* 0.8: 08. +* 0.7.4: 074. +* 0.7.3: 073. +* 0.7.2: 072. +* 0.7.1: 071. +* 0.7: 07. +* 0.6.3: 063. +* 0.6.2: 062. +* 0.6.1: 061. +* 0.6: 06. +* 0.5.2: 052. +* 0.5.1: 051. +* 0.5: 05. +* 0.4.9: 049. +* 0.4.8: 048. +* 0.4.7: 047. +* 0.4.6: 046. +* 0.4.5: 045. +* 0.4.4: 044. +* 0.4.3: 043. +* 0.4.2: 042. +* 0.4.1: 041. +* 0.4: 04. +* 0.3.2: 032. +* 0.3.1: 031. +* 0.3: 03. +* 0.2.3: 023. +* 0.2.2: 022. +* 0.2.1: 021. +* 0.2: 02. +* 0.1: 01. + +0.9-pre + +* helm-org-ql: helm-org-ql (1). + +Development + +* Copyright assignment:: Notes @@ -108,7 +136,7 @@ File: README.info, Node: Contents, Next: Screenshots, Prev: Top, Up: Top 1 Contents ********** - • • • • + • • • • •  File: README.info, Node: Screenshots, Next: Installation, Prev: Contents, Up: Top @@ -201,6 +229,8 @@ File: README.info, Node: Commands, Next: Queries, Up: Usage * Menu: * org-ql-find:: +* org-ql-open-link:: +* org-ql-refile:: * org-ql-search:: * helm-org-ql:: * org-ql-view:: @@ -209,7 +239,7 @@ File: README.info, Node: Commands, Next: Queries, Up: Usage * org-ql-sparse-tree::  -File: README.info, Node: org-ql-find, Next: org-ql-search, Up: Commands +File: README.info, Node: org-ql-find, Next: org-ql-open-link, Up: Commands 4.1.1 org-ql-find ----------------- @@ -220,13 +250,50 @@ _Note: These commands use ._ completion facilities with an Org QL query: • ‘org-ql-find’ searches in the current buffer. + • ‘org-ql-find-path’ searches outline paths in the current buffer. • ‘org-ql-find-in-agenda’ searches in ‘(org-agenda-files)’. • ‘org-ql-find-in-org-directory’ searches in ‘org-directory’. - -File: README.info, Node: org-ql-search, Next: helm-org-ql, Prev: org-ql-find, Up: Commands + Note that these commands are compatible with Embark +(https://github.com/oantolin/embark): the ‘embark-act’ command can be +called on a completion candidate (i.e. a search result) to act on it +immediately, without having to visit the entry in its source Org buffer, +and ‘embark-export’ may be called to show the results in an +‘org-ql-view’ buffer. -4.1.2 org-ql-search + +File: README.info, Node: org-ql-open-link, Next: org-ql-refile, Prev: org-ql-find, Up: Commands + +4.1.2 org-ql-open-link +---------------------- + +This command finds links in entries matching the input query and offers +them for selection; the selected link is then opened with +‘org-open-at-point’. + + The input is matched using the default predicate, which means it +searches both entry content and outline paths. This is helpful when a +collection of links are kept in Org files: rather than having to first +visit the entry containing the desired link, then locate it within the +entry, and then open it, the user can simply select the link and open it +directly. For example, if an entry with the heading ‘Emacs’ contained a +link named ‘mailing list’, one could search for ‘Emacs list’ and open +the link to the mailing list directly. + + +File: README.info, Node: org-ql-refile, Next: org-ql-search, Prev: org-ql-open-link, Up: Commands + +4.1.3 org-ql-refile +------------------- + +This command refiles the current Org entry to one selected by searching +with Org QL completion. It searches files listed in +‘org-refile-targets’ as well as the current buffer. + + +File: README.info, Node: org-ql-search, Next: helm-org-ql, Prev: org-ql-refile, Up: Commands + +4.1.4 org-ql-search ------------------- _Note: This command supports both sexp queries and ._ @@ -266,10 +333,15 @@ This feature is experimental and not guaranteed to work correctly with all commands. (It works to the extent it does because the appropriate text properties are placed on each item, imitating an Agenda buffer.) + *Note:* Also, this buffer is compatible with Embark +(https://github.com/oantolin/embark): the ‘embark-act’ command can be +called on an entry to act on it immediately, without having to visit the +entry in its source Org buffer. +  File: README.info, Node: helm-org-ql, Next: org-ql-view, Prev: org-ql-search, Up: Commands -4.1.3 helm-org-ql +4.1.5 helm-org-ql ----------------- _Note: This command uses . It is available separately in the package @@ -283,7 +355,7 @@ _Note: This command uses . It is available separately in the package  File: README.info, Node: org-ql-view, Next: org-ql-view-sidebar, Prev: helm-org-ql, Up: Commands -4.1.4 org-ql-view +4.1.6 org-ql-view ----------------- Choose and display a view stored in ‘org-ql-views’. @@ -298,7 +370,7 @@ Choose and display a view stored in ‘org-ql-views’.  File: README.info, Node: org-ql-view-sidebar, Next: org-ql-view-recent-items, Prev: org-ql-view, Up: Commands -4.1.5 org-ql-view-sidebar +4.1.7 org-ql-view-sidebar ------------------------- Show a sidebar window listing views stored in ‘org-ql-views’ for easy @@ -308,7 +380,7 @@ point, and press ‘c’ to customize the view at point.  File: README.info, Node: org-ql-view-recent-items, Next: org-ql-sparse-tree, Prev: org-ql-view-sidebar, Up: Commands -4.1.6 org-ql-view-recent-items +4.1.8 org-ql-view-recent-items ------------------------------ Show items in ‘FILES’ from last ‘DAYS’ days with timestamps of ‘TYPE’. @@ -319,7 +391,7 @@ returned by the function ‘org-agenda-files’.  File: README.info, Node: org-ql-sparse-tree, Prev: org-ql-view-recent-items, Up: Commands -4.1.7 org-ql-sparse-tree +4.1.9 org-ql-sparse-tree ------------------------ Arguments: ‘(query &key keep-previous (buffer (current-buffer)))’ @@ -402,6 +474,9 @@ File: README.info, Node: General predicates, Next: Ancestor/descendant predica Arguments are listed next to predicate names, where applicable. +‘blocked’ + Return non-nil if current heading is blocked. Calls + ‘org-entry-blocked-p’, which see. ‘category (&optional categories)’ Return non-nil if current heading is in one or more of ‘CATEGORIES’ (a list of strings). @@ -464,12 +539,12 @@ Arguments are listed next to predicate names, where applicable. predicate (while Org itself considers items without a cookie to have the default priority, which, by default, is equal to priority ‘B’). -‘property (property &optional value)’ +‘property (property &optional value &key inherit)’ Return non-nil if current entry has ‘PROPERTY’ (a string), and - optionally ‘VALUE’ (a string). Note that property inheritance is - currently _not_ enabled for this predicate. If you need to test - with inheritance, you could use a custom predicate form, like - ‘(org-entry-get (point) "PROPERTY" 'inherit)’. + optionally ‘VALUE’ (a string). If ‘INHERIT’ is nil, only match + entries with ‘PROPERTY’ set on the entry; if t, also match entries + with inheritance. If ‘INHERIT’ is not specified, use the value of + ‘org-use-property-inheritance’, which see. ‘regexp (&rest regexps)’ Return non-nil if current entry matches all of ‘REGEXPS’ (regexp strings). Matches against entire entry, from beginning of its @@ -488,6 +563,7 @@ Arguments are listed next to predicate names, where applicable. Return non-nil if current entry contains an Org Babel source block. If ‘LANG’ is non-nil, match blocks of that language. If ‘REGEXPS’ is non-nil, require that block’s contents match all regexps. + Matching is done case-insensitively. ‘tags (&optional tags)’ Return non-nil if current heading has one or more of ‘TAGS’ (a list of strings). Tests both inherited and local tags. @@ -959,7 +1035,7 @@ File: README.info, Node: Tips, Prev: Links, Up: Usage (https://github.com/alphapapa/burly.el).  -File: README.info, Node: Changelog, Next: Notes, Prev: Usage, Up: Top +File: README.info, Node: Changelog, Next: Development, Prev: Usage, Up: Top 5 Changelog *********** @@ -972,43 +1048,395 @@ releases. * Menu: -* 0.7-pre: 07-pre. -* 0.6.2: 062. -* 0.6.1: 061. -* 0.6: 06. -* 0.5.2: 052. -* 0.5.1: 051. -* 0.5: 05. -* 0.4.9: 049. -* 0.4.8: 048. -* 0.4.7: 047. -* 0.4.6: 046. -* 0.4.5: 045. -* 0.4.4: 044. -* 0.4.3: 043. -* 0.4.2: 042. -* 0.4.1: 041. -* 0.4: 04. -* 0.3.2: 032. -* 0.3.1: 031. -* 0.3: 03. -* 0.2.3: 023. -* 0.2.2: 022. -* 0.2.1: 021. -* 0.2: 02. -* 0.1: 01. +* 0.9-pre: 09-pre. +* 0.8.10: 0810. +* 0.8.9: 089. +* 0.8.8: 088. +* 0.8.7: 087. +* 0.8.6: 086. +* 0.8.5: 085. +* 0.8.4: 084. +* 0.8.3: 083. +* 0.8.2: 082. +* 0.8.1: 081. +* 0.8: 08. +* 0.7.4: 074. +* 0.7.3: 073. +* 0.7.2: 072. +* 0.7.1: 071. +* 0.7: 07. +* 0.6.3: 063. +* 0.6.2: 062. +* 0.6.1: 061. +* 0.6: 06. +* 0.5.2: 052. +* 0.5.1: 051. +* 0.5: 05. +* 0.4.9: 049. +* 0.4.8: 048. +* 0.4.7: 047. +* 0.4.6: 046. +* 0.4.5: 045. +* 0.4.4: 044. +* 0.4.3: 043. +* 0.4.2: 042. +* 0.4.1: 041. +* 0.4: 04. +* 0.3.2: 032. +* 0.3.1: 031. +* 0.3: 03. +* 0.2.3: 023. +* 0.2.2: 022. +* 0.2.1: 021. +* 0.2: 02. +* 0.1: 01.  -File: README.info, Node: 07-pre, Next: 062, Up: Changelog +File: README.info, Node: 09-pre, Next: 0810, Up: Changelog -5.1 0.7-pre +5.1 0.9-pre =========== +*Additions* + • Face ‘org-ql-view-query’, applied to view queries in header line. + • Face ‘org-ql-view-title’, applied to view titles in header line. + • Option ‘org-ql-view-relative-deadline-prefix’. + + *Changes* + • Command ‘org-ql-find’ respects narrowing of the current buffer by + default, allowing searching within the narrowed region. (Using one + ‘C-u’ argument widens the current buffer, and using two ‘C-u’ + arguments prompts for the buffers to search.) + • Function ‘org-ql-completing-read’ accepts a new ‘NARROWP’ argument, + which is passed to ‘org-ql-select’. + + *Fixes* + • Customization group for face ‘org-ql-view-due-date’. + • Apply Org syntax font-locking to items in ‘org-ql-view’ buffers. + +* Menu: + +* helm-org-ql: helm-org-ql (1). + + +File: README.info, Node: helm-org-ql (1), Up: 09-pre + +5.1.1 helm-org-ql +----------------- + +Tagged v0.6.2, fixing a compilation warning. + + +File: README.info, Node: 0810, Next: 089, Prev: 09-pre, Up: Changelog + +5.2 0.8.10 +========== + +*Fixes* + • Command ‘org-ql-refile’ uses the base buffer when refiling to an + indirect buffer. (#466 + (https://github.com/alphapapa/org-ql/issues/466).) + • Predicate ‘link’ could signal an error when searching text that is + mistakenly recognized as an Org link (e.g. Bash double-bracket + constructs in a source block). (Thanks to John Wiegley + (https://github.com/jwiegley) for reporting.) + + +File: README.info, Node: 089, Next: 088, Prev: 0810, Up: Changelog + +5.3 0.8.9 +========= + +*Fixes* + • Predicate ‘property’ when called with argument form ‘(property + "PROPERTY-NAME" :inherit t)’. (#460 + (https://github.com/alphapapa/org-ql/issues/460). Thanks to + Stewmath (https://github.com/Stewmath) for reporting.) + • Predicate ‘level’’s preamble optimizer allows expressions in place + of the numeric argument. (See #460 + (https://github.com/alphapapa/org-ql/issues/460). Thanks to + Stewmath (https://github.com/Stewmath) for reporting.) + • Reading of view settings from Org links in upcoming Emacs version. + (#461 (https://github.com/alphapapa/org-ql/issues/461). Thanks to + Ola Nilsson (https://github.com/snogge) for help debugging, and for + maintaining Buttercup + (https://github.com/jorgenschaefer/emacs-buttercup).) + + *Compatibility* + • Fix compilation error on Emacs 30. (#433 + (https://github.com/alphapapa/org-ql/issues/433). Thanks to Akira + Komamura (https://github.com/akirak) and Stefan Monnier + (https://github.com/monnier).) + + +File: README.info, Node: 088, Next: 087, Prev: 089, Up: Changelog + +5.4 0.8.8 +========= + +*Fixes* + • Remove text properties from to-do keywords before displaying them + in an ‘org-ql-view’ buffer. (Such text properties could cause them + to, e.g. display with extra leading spaces, depending on which + other modes might be enabled in the source Org buffer.) + • Binding of ‘completion-styles-alist’ in ‘org-ql-completing-read’. + (This fixes compatibility with Helm’s ‘helm’ completion style, as + well as default Emacs completion in recursive minibuffers. #337 + (https://github.com/alphapapa/org-ql/issues/337). Thanks to + Nicholas Vollmer (https://github.com/progfolio), viz + (https://github.com/9viz), and Karthik Chikmagalur + (https://github.com/karthink) for reporting and suggesting fixes.) + • Use of the context snippet function for ‘org-ql-completing-read’. + (#419 (https://github.com/alphapapa/org-ql/issues/419). Thanks to + tpeacock19 (https://github.com/tpeacock19) for reporting.) + + +File: README.info, Node: 087, Next: 086, Prev: 088, Up: Changelog + +5.5 0.8.7 +========= + +*Fixes* + • Timestamps with internal time ranges (e.g. ‘<2024-06-26 + 10:00-11:00>’) are matched for simple queries. (This support is + not yet comprehensive, e.g. a query that depends on the specific + inner time range may not behave as expected. Previously such + timestamps were not matched at all. See #237 + (https://github.com/alphapapa/org-ql/pull/237) and #371 + (https://github.com/alphapapa/org-ql/issues/371). Thanks to Ihor + Radchenko (https://github.com/yantar92).) + • Timestamps with day-of-the-week abbreviations are matched more + flexibly (allowing, e.g. a period in French locales). (See #429 + (https://github.com/alphapapa/org-ql/discussions/429), #432 + (https://github.com/alphapapa/org-ql/issues/432). Thanks to + Florian D. (https://github.com/neurolit) for reporting.) + • Command ‘org-ql-search’ did not narrow properly when called + interactively. + + *Compatibility* + • Dynamic blocks work with Org 9.7. (#431 + (https://github.com/alphapapa/org-ql/issues/431). Thanks to Jez + Cope (https://github.com/jezcope) for reporting.) + + +File: README.info, Node: 086, Next: 085, Prev: 087, Up: Changelog + +5.6 0.8.6 +========= + +*Fixes* + • Bookmarking ‘org-ql-view’ buffers when the ‘buffers-files’ argument + is a symbol (like ‘org-agenda-files’). + + +File: README.info, Node: 085, Next: 084, Prev: 086, Up: Changelog + +5.7 0.8.5 +========= + +*Fixes* + • Predicate ‘heading’ incorrectly matched strings as regular + expressions, sometimes returning incorrect results. (See + discussion (https://github.com/alphapapa/org-ql/discussions/410). + Thanks to Alex Popescu (https://github.com/al3xandru) for + reporting.) + • Predicates ‘ancestor’ and ‘parent’ did not normalize their + sub-queries, sometimes returning incorrect results. (#365 + (https://github.com/alphapapa/org-ql/issues/365). Thanks to + Gabriele Mongiano (https://github.com/kofm) for reporting.) + + +File: README.info, Node: 084, Next: 083, Prev: 085, Up: Changelog + +5.8 0.8.4 +========= + +*Fixes* + + • Command ‘org-ql-find’ goes to the selected entry in the base buffer + (rather than potentially an indirect buffer, whose narrowing could + leave the selected entry hidden. The nuances around going to + entries in buffers that may be indirect and/or narrowed are + surprisingly complicated. Hopefully this is the last fix). + + +File: README.info, Node: 083, Next: 082, Prev: 084, Up: Changelog + +5.9 0.8.3 +========= + +*Fixes* + + • Command ‘org-ql-find’ incorrectly moved point. (See #380 + (https://github.com/alphapapa/org-ql/issues/380#issuecomment-1881913025). + Thanks to Omar Antolín Camarena (https://github.com/oantolin) for + reporting.) + + +File: README.info, Node: 082, Next: 081, Prev: 083, Up: Changelog + +5.10 0.8.2 +========== + +*Fixes* + + • Command ‘org-ql-find’ incorrectly restored the buffer after jumping + when not using indirect buffers. (See #380 + (https://github.com/alphapapa/org-ql/issues/380#issuecomment-1881913025). + Thanks to Bram Schoenmakers (https://github.com/bram85) for + reporting.) + + +File: README.info, Node: 081, Next: 08, Prev: 082, Up: Changelog + +5.11 0.8.1 +========== + +*Fixes* + + • Command ‘org-ql-find’ widens the buffer before going to the + selected entry. + • In ‘org-ql-view’ buffers, links in headings remain clickable links. + (Fixes #282 (https://github.com/alphapapa/org-ql/issues/282). + Thanks to Jacob Boxerman (https://github.com/jakebox) for + reporting.) + + +File: README.info, Node: 08, Next: 074, Prev: 081, Up: Changelog + +5.12 0.8 +======== + +*Additions* + + • Function ‘org-ql-completing-read’, used by command ‘org-ql-find’, + now specifies the completion category as ‘org-heading’, providing + compatibility with Embark (https://github.com/oantolin/embark). + (This is a powerful feature, as it means any ‘org-ql-find’ result + can be acted on from inside the search results with Embark, which + provides common actions from Org Agenda and Org speed keys + bindings.) (#299 (https://github.com/alphapapa/org-ql/issues/299). + Thanks to Omar Antolín Camarena (https://github.com/oantolin), + Daniel Mendler (https://github.com/minad), and Akira Komamura + (https://github.com/akirak).) + • Command ‘org-ql-completing-read-export’, bound to ‘C-c C-e’ or + ‘embark-export’ while in an ‘org-ql-completing-read’ session, + exits and shows an ‘org-ql-view’ buffer for the current + search. + • Command ‘org-ql-find’ may be called in an ‘org-agenda’ or + ‘org-ql-view’ buffer to search the buffers which contributed to the + agenda/view buffer. + • Command ‘org-ql-find-path’, which searches outline paths in the + current buffer. + • Command ‘org-ql-open-link’, which finds links in entries matching + the given query, and opens the selected one with + ‘org-open-at-point’. (This is helpful when a collection of links + are kept in Org files: rather than having to first visit the entry + containing the desired link, then locate it within the entry, and + then open it, the user can simply select the link and open it + directly.) + • Items in ‘org-ql-view’ buffers now include the ‘org-category’ text + property, like Org Agenda buffers, which allows grouping with + ‘org-super-agenda’’s category-related selectors. (#363 + (https://github.com/alphapapa/org-ql/issues/363). Thanks to + Gabriele Mongiano (https://github.com/kofm) for reporting.) + + *Fixes* + + • Predicate ‘property’ correctly uses the value of + ‘org-use-property-inheritance’ when not specified. (#346 + (https://github.com/alphapapa/org-ql/pull/346), #356 + (https://github.com/alphapapa/org-ql/issues/356). Thanks to Bram + Schoenmakers (https://github.com/bram85).) + + *Compatibility* + + • Emacs 27.1 or later is now required. + • Org v9.7’s ‘org-element’ API changes required some adjustments. + (#364 (https://github.com/alphapapa/org-ql/issues/364). Thanks to + several users for reporting, and to Ihor Radchenko + (https://github.com/yantar92) for his feedback.) + + +File: README.info, Node: 074, Next: 073, Prev: 08, Up: Changelog + +5.13 0.7.4 +========== + +*Fixes* + • Ignore empty quoted strings in plain-string queries (#383 + (https://github.com/alphapapa/org-ql/issues/383)). + + +File: README.info, Node: 073, Next: 072, Prev: 074, Up: Changelog + +5.14 0.7.3 +========== + +*Fixes* + • Disable ‘case-fold-search’ when collecting headings in outline + paths. (Headings that started with a word that is also a to-do + keyword but with different capitalization would be matched + incorrectly.) + • Saving of ‘org-ql-view’ views. (#378 + (https://github.com/alphapapa/org-ql/issues/378). Thanks to + Pentaquark1 (https://github.com/Pentaquark1) for reporting.) + • Command ‘org-ql-find’ didn’t move point to the selected entry. + (#380 (https://github.com/alphapapa/org-ql/issues/380). Thanks to + Omar Antolín Camarena (https://github.com/oantolin) for reporting.) + + +File: README.info, Node: 072, Next: 071, Prev: 073, Up: Changelog + +5.15 0.7.2 +========== + +*Fixes* + • Timestamp predicates are more tolerant of partial input (e.g. + preventing errors while the user is typing a query into + ‘org-ql-find’). + • Query parser ignores leading whitespace (e.g. preventing errors + while the user is typing a query into ‘org-ql-find’). + • Use of ‘org-ql-find’ with ‘:query-prefix’ argument prevented + selection of results. (#351 + (https://github.com/alphapapa/org-ql/issues/351). Thanks to Daniel + Fleischer (https://github.com/danielfleischer) for reporting.) + • Handle narrowed buffers correctly in ‘org-ql-find’. + • Warn about empty headings in ‘org-ql-completing-read’ (the Org + format allows a heading line to have no text, but it’s useless for + this purpose, and usually indicates unnoticed corruption). + + +File: README.info, Node: 071, Next: 07, Prev: 072, Up: Changelog + +5.16 0.7.1 +========== + +*Fixes* + • Function ‘org-ql-completing-read’ is more compatible with default + Emacs completion. (See #338 + (https://github.com/alphapapa/org-ql/issues/338). Thanks to + arozbiz (https://github.com/arozbiz) for reporting.) + • Function ‘org-ql-completing-read’ would sometimes stop updating + with changes in input. (See #350 + (https://github.com/alphapapa/org-ql/issues/350). Thanks to Ankit + Raj Pandey (https://github.com/anpandey) for reporting and fixing, + and to Daniel Mendler (https://github.com/minad) for advising.) + • In ‘org-ql-completing-read’, format links for display, and use + ‘org-entry-get’ internally rather than ‘org-get-heading’. + + +File: README.info, Node: 07, Next: 063, Prev: 071, Up: Changelog + +5.17 0.7 +======== + *Added* - • Commands ‘org-ql-find’, ‘org-ql-find-heading’, and - ‘org-ql-find-path’, which jump to entries selected using Emacs’s - built-in completion facilities and Org QL queries (like + • Command ‘org-ql-find’, which jumps to entries selected using + Emacs’s built-in completion facilities and Org QL queries (like ‘helm-org-ql’, but doesn’t require Helm.). + • Command ‘org-ql-refile’, which refiles the entry at point to one + selected using Org QL completion. • Predicate ‘rifle’, which matches an entry if each of the given arguments is found in either the entry’s contents or its outline path. This provides very intuitive results, mimicing the behavior @@ -1019,21 +1447,64 @@ File: README.info, Node: 07-pre, Next: 062, Up: Changelog • Option ‘org-ql-default-predicate’, applied to plain-string query tokens (before, the ‘regexp’ predicate was always used, but now it may be customized). + • Alias ‘c’ for predicate ‘category’. + • Predicate ‘property’ now accepts the argument ‘:inherit’ to match + entries with property inheritance, and when unspecified, the option + ‘org-use-property-inheritance’ controls whether inheritance is + used. + • Predicate ‘blocked’. (Thanks to Akira Komamura + (https://github.com/akirak).) *Changed* • Give more useful error message for invalid queries. + • Predicate ‘src’ now matches case-insensitively. + • Command ‘org-ql-sparse-tree’ accepts both string and sexp queries. + (Thanks to Akira Komamura (https://github.com/akirak).) + + *Fixed* + • Predicate ‘link’ matches links whose descriptions contain escaped + brackets (changed in Org 9.3). (Thanks to Daniel Borchmann + (https://github.com/exot) for reporting.) + • Predicate ‘src’’s matching of begin/end block lines, normalization + of arguments, and handling in non-sexp queries. (Thanks to Akira + Komamura (https://github.com/akirak) for reporting.) + • Predicate ‘src’’s behavior with various arguments. + • Various compilation warnings. *Internal* • Certain query predicates, when called multiple times in an ‘and’ sub-expression, are optimized to a single call. • Use ‘buffer-chars-modified-tick’ instead of ‘buffer-modified-tick’. (Thanks to Ihor Radchenko (https://github.com/yantar92).) + • Implemented tests for ‘src’ predicate. + + *Credits* + • Thanks to Caleb Chase (https://github.com/chasecaleb) for help with + #285 (https://github.com/alphapapa/org-ql/pull/285), fixed in + 9190818 + (https://github.com/alphapapa/org-ql/commit/91908186fcca4b5fd2e9d26da5bc0375c2b41acf).  -File: README.info, Node: 062, Next: 061, Prev: 07-pre, Up: Changelog +File: README.info, Node: 063, Next: 062, Prev: 07, Up: Changelog -5.2 0.6.2 -========= +5.18 0.6.3 +========== + +*Fixed* + • Non-sexp query parsing with updated version 1.0.1 of the ‘peg’ + package. (Fixes #314 + (https://github.com/alphapapa/org-ql/issues/314), #316 + (https://github.com/alphapapa/org-ql/issues/316). Thanks to Akira + Komamura (https://github.com/akirak) and Joon Ro + (https://github.com/joonro) for reporting.) + • Require library ‘org-duration’ (apparently necessary in newer Org + versions). + + +File: README.info, Node: 062, Next: 061, Prev: 063, Up: Changelog + +5.19 0.6.2 +========== *Fixed* • ‘link’ predicate when used in an ‘or’’ed query. (#279 @@ -1043,8 +1514,8 @@ File: README.info, Node: 062, Next: 061, Prev: 07-pre, Up: Changelog  File: README.info, Node: 061, Next: 06, Prev: 062, Up: Changelog -5.3 0.6.1 -========= +5.20 0.6.1 +========== *Fixed* • In dynamic blocks, links to headings with statistics cookies were @@ -1061,8 +1532,8 @@ File: README.info, Node: 061, Next: 06, Prev: 062, Up: Changelog  File: README.info, Node: 06, Next: 052, Prev: 061, Up: Changelog -5.4 0.6 -======= +5.21 0.6 +======== *Added* • Macro ‘org-ql-defpred’, used to define search predicates. (See @@ -1128,8 +1599,8 @@ File: README.info, Node: 06, Next: 052, Prev: 061, Up: Changelog  File: README.info, Node: 052, Next: 051, Prev: 06, Up: Changelog -5.5 0.5.2 -========= +5.22 0.5.2 +========== *Fixed* • Predicate ‘link’’s ‘:target’ and ‘:regexp-p’ arguments. (#220 @@ -1139,8 +1610,8 @@ File: README.info, Node: 052, Next: 051, Prev: 06, Up: Changelog  File: README.info, Node: 051, Next: 05, Prev: 052, Up: Changelog -5.6 0.5.1 -========= +5.23 0.5.1 +========== *Fixed* • Custom sorting functions could corrupt the cache, causing items to @@ -1152,8 +1623,8 @@ File: README.info, Node: 051, Next: 05, Prev: 052, Up: Changelog  File: README.info, Node: 05, Next: 049, Prev: 051, Up: Changelog -5.7 0.5 -======= +5.24 0.5 +======== *Added* • View dispatcher using ‘transient.el’ (like Magit), bound to ‘v’ in @@ -1193,8 +1664,8 @@ File: README.info, Node: 05, Next: 049, Prev: 051, Up: Changelog  File: README.info, Node: 049, Next: 048, Prev: 05, Up: Changelog -5.8 0.4.9 -========= +5.25 0.4.9 +========== *Fixed* • Agenda restriction in ‘org-ql-block’. (Fixes #84 @@ -1204,8 +1675,8 @@ File: README.info, Node: 049, Next: 048, Prev: 05, Up: Changelog  File: README.info, Node: 048, Next: 047, Prev: 049, Up: Changelog -5.9 0.4.8 -========= +5.26 0.4.8 +========== *Fixed* • Multiple sorters not preserved when refreshing views. (Fixes #136 @@ -1216,7 +1687,7 @@ File: README.info, Node: 048, Next: 047, Prev: 049, Up: Changelog  File: README.info, Node: 047, Next: 046, Prev: 048, Up: Changelog -5.10 0.4.7 +5.27 0.4.7 ========== *Fixed* @@ -1229,7 +1700,7 @@ File: README.info, Node: 047, Next: 046, Prev: 048, Up: Changelog  File: README.info, Node: 046, Next: 045, Prev: 047, Up: Changelog -5.11 0.4.6 +5.28 0.4.6 ========== *Fixed* @@ -1242,7 +1713,7 @@ File: README.info, Node: 046, Next: 045, Prev: 047, Up: Changelog  File: README.info, Node: 045, Next: 044, Prev: 046, Up: Changelog -5.12 0.4.5 +5.29 0.4.5 ========== *Fixed* @@ -1254,7 +1725,7 @@ File: README.info, Node: 045, Next: 044, Prev: 046, Up: Changelog  File: README.info, Node: 044, Next: 043, Prev: 045, Up: Changelog -5.13 0.4.4 +5.30 0.4.4 ========== *Fixed* @@ -1266,7 +1737,7 @@ File: README.info, Node: 044, Next: 043, Prev: 045, Up: Changelog  File: README.info, Node: 043, Next: 042, Prev: 044, Up: Changelog -5.14 0.4.3 +5.31 0.4.3 ========== *Fixed* @@ -1276,7 +1747,7 @@ File: README.info, Node: 043, Next: 042, Prev: 044, Up: Changelog  File: README.info, Node: 042, Next: 041, Prev: 043, Up: Changelog -5.15 0.4.2 +5.32 0.4.2 ========== *Fixed* @@ -1285,7 +1756,7 @@ File: README.info, Node: 042, Next: 041, Prev: 043, Up: Changelog  File: README.info, Node: 041, Next: 04, Prev: 042, Up: Changelog -5.16 0.4.1 +5.33 0.4.1 ========== *Fixed* @@ -1295,7 +1766,7 @@ File: README.info, Node: 041, Next: 04, Prev: 042, Up: Changelog  File: README.info, Node: 04, Next: 032, Prev: 041, Up: Changelog -5.17 0.4 +5.34 0.4 ======== _Note:_ The next release, 0.5, may include changes which will require @@ -1376,7 +1847,7 @@ automatically, as they will be pushed to the ‘master’ branch when ready.  File: README.info, Node: 032, Next: 031, Prev: 04, Up: Changelog -5.18 0.3.2 +5.35 0.3.2 ========== *Fixed* @@ -1389,7 +1860,7 @@ File: README.info, Node: 032, Next: 031, Prev: 04, Up: Changelog  File: README.info, Node: 031, Next: 03, Prev: 032, Up: Changelog -5.19 0.3.1 +5.36 0.3.1 ========== *Fixed* @@ -1399,7 +1870,7 @@ File: README.info, Node: 031, Next: 03, Prev: 032, Up: Changelog  File: README.info, Node: 03, Next: 023, Prev: 031, Up: Changelog -5.20 0.3 +5.37 0.3 ======== *Added* @@ -1467,7 +1938,7 @@ File: README.info, Node: 03, Next: 023, Prev: 031, Up: Changelog  File: README.info, Node: 023, Next: 022, Prev: 03, Up: Changelog -5.21 0.2.3 +5.38 0.2.3 ========== *Fixed* @@ -1477,7 +1948,7 @@ File: README.info, Node: 023, Next: 022, Prev: 03, Up: Changelog  File: README.info, Node: 022, Next: 021, Prev: 023, Up: Changelog -5.22 0.2.2 +5.39 0.2.2 ========== *Fixed* @@ -1488,7 +1959,7 @@ File: README.info, Node: 022, Next: 021, Prev: 023, Up: Changelog  File: README.info, Node: 021, Next: 02, Prev: 022, Up: Changelog -5.23 0.2.1 +5.40 0.2.1 ========== *Fixed* @@ -1498,7 +1969,7 @@ File: README.info, Node: 021, Next: 02, Prev: 022, Up: Changelog  File: README.info, Node: 02, Next: 01, Prev: 021, Up: Changelog -5.24 0.2 +5.41 0.2 ======== *Added* @@ -1581,15 +2052,42 @@ File: README.info, Node: 02, Next: 01, Prev: 021, Up: Changelog  File: README.info, Node: 01, Prev: 02, Up: Changelog -5.25 0.1 +5.42 0.1 ======== First tagged release.  -File: README.info, Node: Notes, Next: License, Prev: Changelog, Up: Top +File: README.info, Node: Development, Next: Notes, Prev: Changelog, Up: Top -6 Notes +6 Development +************* + +Bug reports, feature requests, and suggestions are welcome. For +patches, see below. + +* Menu: + +* Copyright assignment:: + + +File: README.info, Node: Copyright assignment, Up: Development + +6.1 Copyright assignment +======================== + +While Org QL is currently distributed in MELPA, it’s intended +(https://github.com/alphapapa/org-ql/issues/409) to merge Org QL into +Org mode. When that happens, it will become a part of Emacs and Org, +and therefore cumulative contributions of more than 15 lines of code +will require that the author assign copyright of such contributions to +the FSF. Authors who are interested in doing so may contact +assign@gnu.org to request the appropriate form. + + +File: README.info, Node: Notes, Next: License, Prev: Development, Up: Top + +7 Notes ******* * Menu: @@ -1600,7 +2098,7 @@ File: README.info, Node: Notes, Next: License, Prev: Changelog, Up: Top  File: README.info, Node: Comparison with Org Agenda searches, Next: org-sidebar, Up: Notes -6.1 Comparison with Org Agenda searches +7.1 Comparison with Org Agenda searches ======================================= Of course, queries like these can already be written with Org Agenda @@ -1620,7 +2118,7 @@ todo:TO-READ’, or in Lisp syntax, ‘(and "lisp" (todo "TO-READ"))’.  File: README.info, Node: org-sidebar, Prev: Comparison with Org Agenda searches, Up: Notes -6.2 org-sidebar +7.2 org-sidebar =============== This package is used by org-sidebar @@ -1630,7 +2128,7 @@ customizable agenda-like view in a sidebar window.  File: README.info, Node: License, Prev: Notes, Up: Top -7 License +8 License ********* GPLv3 @@ -1639,68 +2137,90 @@ GPLv3  Tag Table: Node: Top225 -Node: Contents1764 -Node: Screenshots1887 -Node: Installation2005 -Node: Quelpa2519 -Node: Helm support3047 -Node: Usage3450 -Node: Commands3848 -Node: org-ql-find4274 -Node: org-ql-search4740 -Node: helm-org-ql6434 -Node: org-ql-view6812 -Node: org-ql-view-sidebar7342 -Node: org-ql-view-recent-items7722 -Node: org-ql-sparse-tree8218 -Node: Queries9018 -Node: Non-sexp query syntax10135 -Node: General predicates11894 -Node: Ancestor/descendant predicates18636 -Node: Date/time predicates19764 -Node: Functions / Macros22888 -Node: Agenda-like views23186 -Ref: Function ‘org-ql-block’23348 -Node: Listing / acting-on results24609 -Ref: Caching24817 -Ref: Function ‘org-ql-select’25730 -Ref: Function ‘org-ql-query’28156 -Ref: Macro ‘org-ql’ (deprecated)29930 -Node: Custom predicates30245 -Ref: Macro ‘org-ql-defpred’30469 -Node: Dynamic block33910 -Node: Links36634 -Node: Tips37321 -Node: Changelog37645 -Node: 07-pre38413 -Node: 06239820 -Node: 06140128 -Node: 0640696 -Node: 05243750 -Node: 05144050 -Node: 0544473 -Node: 04946002 -Node: 04846282 -Node: 04746629 -Node: 04647038 -Node: 04547446 -Node: 04447807 -Node: 04348166 -Node: 04248369 -Node: 04148530 -Node: 0448777 -Node: 03252878 -Node: 03153281 -Node: 0353478 -Node: 02356778 -Node: 02257012 -Node: 02157292 -Node: 0257497 -Node: 0161575 -Node: Notes61676 -Node: Comparison with Org Agenda searches61838 -Node: org-sidebar62727 -Node: License63006 +Node: Contents2109 +Node: Screenshots2236 +Node: Installation2354 +Node: Quelpa2868 +Node: Helm support3396 +Node: Usage3799 +Node: Commands4197 +Node: org-ql-find4662 +Node: org-ql-open-link5570 +Node: org-ql-refile6425 +Node: org-ql-search6753 +Node: helm-org-ql8684 +Node: org-ql-view9062 +Node: org-ql-view-sidebar9592 +Node: org-ql-view-recent-items9972 +Node: org-ql-sparse-tree10468 +Node: Queries11268 +Node: Non-sexp query syntax12385 +Node: General predicates14144 +Node: Ancestor/descendant predicates21069 +Node: Date/time predicates22197 +Node: Functions / Macros25321 +Node: Agenda-like views25619 +Ref: Function org-ql-block25781 +Node: Listing / acting-on results27042 +Ref: Caching27250 +Ref: Function org-ql-select28163 +Ref: Function org-ql-query30589 +Ref: Macro org-ql (deprecated)32363 +Node: Custom predicates32678 +Ref: Macro org-ql-defpred32902 +Node: Dynamic block36343 +Node: Links39067 +Node: Tips39754 +Node: Changelog40078 +Node: 09-pre41061 +Node: helm-org-ql (1)41987 +Node: 081042128 +Node: 08942657 +Node: 08843797 +Node: 08744873 +Node: 08646101 +Node: 08546335 +Node: 08446991 +Node: 08347443 +Node: 08247784 +Node: 08148179 +Node: 0848602 +Node: 07451328 +Node: 07351553 +Node: 07252287 +Node: 07153208 +Node: 0754019 +Node: 06356885 +Node: 06257418 +Node: 06157725 +Node: 0658295 +Node: 05261351 +Node: 05161653 +Node: 0562078 +Node: 04963609 +Node: 04863891 +Node: 04764240 +Node: 04664649 +Node: 04565057 +Node: 04465418 +Node: 04365777 +Node: 04265980 +Node: 04166141 +Node: 0466388 +Node: 03270489 +Node: 03170892 +Node: 0371089 +Node: 02374389 +Node: 02274623 +Node: 02174903 +Node: 0275108 +Node: 0179186 +Node: Development79287 +Node: Copyright assignment79520 +Node: Notes80110 +Node: Comparison with Org Agenda searches80274 +Node: org-sidebar81163 +Node: License81442  End Tag Table diff --git a/tests/data2.org b/tests/data-file-tags.org similarity index 100% rename from tests/data2.org rename to tests/data-file-tags.org diff --git a/tests/data-links.org b/tests/data-links.org new file mode 100644 index 0000000..b158951 --- /dev/null +++ b/tests/data-links.org @@ -0,0 +1,10 @@ +* Alpha + +Let us link to: [[id:74d357ac-fb9c-40d1-a63f-eca8a227321d][Bravo [a phrase in brackets]​]]. + +* Bravo [a phrase in brackets] +:PROPERTIES: +:ID: 74d357ac-fb9c-40d1-a63f-eca8a227321d +:END: + +* Charlie diff --git a/tests/data-src.org b/tests/data-src.org new file mode 100644 index 0000000..20f75a8 --- /dev/null +++ b/tests/data-src.org @@ -0,0 +1,29 @@ +#+title: org-ql test data for ~src~ predicate + +* Alpha + +#+begin_src elisp + (message "foo") +#+end_src + +#+begin_src python + print("foo") +#+end_src + +#+begin_src js + console.log("foo") +#+end_src + +* Bravo + +#+begin_src elisp + (message "bar") +#+end_src + +#+begin_src python + print("bar") +#+end_src + +* Charlie + +This entry has no source block. diff --git a/tests/data-ts.org b/tests/data-ts.org new file mode 100644 index 0000000..d533493 --- /dev/null +++ b/tests/data-ts.org @@ -0,0 +1,29 @@ +#+title: Timestamp-specific tests + +/Timestamps in this file are active ones./ + +* Single-timestamp ranges + +** Single-timestamp, without repeater +<2024-06-25 Tue 08:00-09:00> + +** Single-timestamp, with repeater (deadline) +DEADLINE: <2024-06-25 Tue 08:00-09:00 ++7d> + +* Multi-timestamp ranges + +/Not sure that it would make sense to use repeaters for this kind of range./ + +** Multi-timestamp, without repeater +<2024-06-25 Tue 08:00>--<2024-06-26 Wed 08:00> + +* Day-of-week abbreviations + +** French + +<2024-07-12 ven.> + +* Canary + +/This entry should never be matched./ + diff --git a/tests/test-org-ql.el b/tests/test-org-ql.el index 41ba1f6..923ec66 100644 --- a/tests/test-org-ql.el +++ b/tests/test-org-ql.el @@ -3,7 +3,7 @@ ;; Copyright (C) 2019 Adam Porter ;; Author: Adam Porter -;; Package-Requires: ((buttercup) (with-simulated-input)) +;; Package-Requires: ((buttercup) (with-simulated-input) (xr)) ;; This program is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by @@ -30,8 +30,13 @@ (require 'with-simulated-input) (require 'org-ql) +(require 'org-ql-search) (require 'org-ql-view) +(require 'xr) + +(declare-function org-ql--normalize-query "org-ql" t t) + ;;;; Variables (defvar org-ql-test-buffer nil @@ -105,27 +110,24 @@ Set at runtime by test suite.") "Return buffer visiting FILENAME. FILENAME should be a file in the \"tests\" directory." (->> (locate-dominating-file default-directory ".git") - (expand-file-name "tests") - (expand-file-name filename) - find-file-noselect)) + (expand-file-name "tests") + (expand-file-name filename) + find-file-noselect)) ;;;; Macros (defmacro org-ql-it (description &rest body) - "Expand to two specs, one of which tests with preambles and the other without. -Based on Buttercup macro `it'." + "Expand to two specs, one of which tests with preambles and the other without." (declare (indent 1) (debug (&define sexp def-body))) - (if body - `(progn - (buttercup-it ,(concat description " (preamble) ") - (lambda () - (let ((org-ql-use-preamble t)) - ,@body))) - (buttercup-it ,(concat description " (no preamble)") - (lambda () - (let ((org-ql-use-preamble nil)) - ,@body)))) - `(buttercup-xit ,description))) + `(progn + (it ,(concat description " (preamble) ") + ,(when body + `(let ((org-ql-use-preamble t)) + ,@body))) + (it ,(concat description " (no preamble) ") + ,(when body + `(let ((org-ql-use-preamble nil)) + ,@body)))) ) (cl-defmacro org-ql-expect (ql-args results &key (buffer 'org-ql-test-buffer)) "Expand to `expect' test form that expects QL-ARGS to equal RESULTS. @@ -164,8 +166,9 @@ with keyword arg NOW in PLIST." (substring-no-properties (org-get-heading t t))) (defun org-ql-test-org-get-heading () ;; For Org 9.1.9. - (substring-no-properties (org-get-heading t t t t)))) + (substring-no-properties (org-get-heading t t t t)))) ) + (before-each (setq org-ql-test-buffer (org-ql-test-data-buffer "data.org") ;; For manual testing: ;; org-ql-test-buffer (find-file-noselect "data.org") @@ -202,7 +205,7 @@ with keyword arg NOW in PLIST." (insert "* Heading 1") ;; FIXME: `--value-at' does not actually move point, so we do it here. (goto-char (point-min)) - (expect (org-ql--value-at (point-min) #'org-get-local-tags) + (expect (org-ql--value-at (point-min) #'ignore) :to-be nil)))) (describe "Query pre-processing" @@ -217,7 +220,8 @@ with keyword arg NOW in PLIST." (it "coalesces a single AND clause that uses two predicates (and preserves predicate order)" (expect (org-ql--normalize-query '(and (rifle "foo") (rifle "bar") (heading "baz") (heading "buz"))) - :to-equal '(and (rifle :regexps '("foo" "bar")) (heading "baz" "buz")))) + ;; NOTE: `heading' is normalized to `heading-regexp'. + :to-equal '(and (rifle :regexps '("foo" "bar")) (heading-regexp "baz" "buz")))) (it "preserves independent OR clauses" (expect (org-ql--normalize-query '(and (or (rifle "foo") (rifle "bar")) (or (rifle "baz") (rifle "buz")))) @@ -231,17 +235,17 @@ with keyword arg NOW in PLIST." :to-equal '(or (and (rifle :regexps '("foo" "bar"))) (and (rifle :regexps '("baz" "buz")))))) (it "coalesces arguments to predicates which use coalescing functions and whose calls are eligible for coalescing" (expect (org-ql--normalize-query '(and (src "foo") (src "bar"))) - :to-equal '(and (src :lang nil :regexps ("foo" "bar")))) + :to-equal '(and (src :lang nil :regexps '("foo" "bar")))) (expect (org-ql--normalize-query '(and (src "foo" :lang "elisp") (src "bar" :lang "elisp"))) - :to-equal '(and (src :lang "elisp" :regexps ("foo" "bar"))))) + :to-equal '(and (src :lang "elisp" :regexps '("foo" "bar"))))) (it "does not coalesce arguments to predicates which use coalescing functions and whose calls are ineligible for coalescing" (expect (org-ql--normalize-query '(and (src "foo" :lang "elisp") (src "bar"))) ;; NOTE: The current implementation of `org-ql--normalize-query' ;; reorders clauses in this case. Fixing that would probably ;; not be worth the effort in code or runtime. - :to-equal '(and (src :regexps ("bar")) (src :lang "elisp" :regexps ("foo")))) + :to-equal '(and (src :regexps '("bar")) (src :lang "elisp" :regexps '("foo")))) (expect (org-ql--normalize-query '(and (src "foo" :lang "elisp") (src "bar" :lang "python"))) - :to-equal '(and (src :lang "python" :regexps ("bar")) (src :lang "elisp" :regexps ("foo")))))) + :to-equal '(and (src :lang "python" :regexps '("bar")) (src :lang "elisp" :regexps '("foo")))))) (describe "Normalization" @@ -252,6 +256,18 @@ with keyword arg NOW in PLIST." (expect (org-ql--normalize-query "\"quoted phrase\"") :to-equal '(rifle :regexps '("\"quoted phrase\"")))) + (describe "Ancestor/Parent predicates" + ;; NOTE: Because the ancestor and parent predicates byte-compile their + ;; subquery predicates, we have to test the byte-compiled forms here. + (expect (org-ql--normalize-query '(ancestors "scheduled")) + ;; No colon after keyword, so not a predicate query. + :to-equal ;; '(ancestors (rifle :regexps '("scheduled"))) + `(ancestors #[nil "\300\301\302\"\207" [rifle :regexps ("scheduled")] 3])) + (expect (org-ql--normalize-query '(parent "scheduled")) + ;; No colon after keyword, so not a predicate query. + :to-equal ;; '(parent (rifle :regexps '("scheduled"))) + `(parent #[nil "\300\301\302\"\207" [rifle :regexps ("scheduled")] 3]))) + (describe "Plain strings" (it "normalizes plain strings to the default predicate (using AND)" (expect (org-ql--normalize-query '(and "string1" "string2")) @@ -317,21 +333,27 @@ with keyword arg NOW in PLIST." (describe "(src)" (it "normalizes a non-keyword arg to keywords" (expect (org-ql--normalize-query '(src "foo")) - :to-equal '(src :regexps ("foo")))) + :to-equal '(src :regexps '("foo")))) (it "normalizes non-keyword args to keywords" (expect (org-ql--normalize-query '(src "foo" "bar")) - :to-equal '(src :regexps ("foo" "bar")))) + :to-equal '(src :regexps '("foo" "bar")))) (it "normalizes a non-keyword arg with a :lang keyword arg to keywords" (expect (org-ql--normalize-query '(src "foo" :lang "bar")) - :to-equal '(src :lang "bar" :regexps ("foo")))) + :to-equal '(src :lang "bar" :regexps '("foo")))) (it "normalizes non-keyword args with a :lang keyword arg to keywords" (expect (org-ql--normalize-query '(src "foo" "bar" :lang "baz")) - :to-equal '(src :lang "baz" :regexps ("foo" "bar")))) + :to-equal '(src :lang "baz" :regexps '("foo" "bar")))) + (it "normalizes zero args without looping" + (expect (org-ql--normalize-query '(src)) + :to-equal '(src))) (it "normalizes all-keyword args without looping" (expect (org-ql--normalize-query '(src :regexps ("foo") :lang "bar")) - :to-equal '(src :lang "bar" :regexps ("foo"))) + :to-equal '(src :lang "bar" :regexps '("foo"))) (expect (org-ql--normalize-query '(src :regexps ("foo") :lang)) - :to-equal '(src :regexps ("foo"))))) + :to-equal '(src :regexps '("foo")))) + (it "normalizes just the :lang keyword arg" + (expect (org-ql--normalize-query '(src :lang "bar")) + :to-equal '(src :lang "bar" :regexps 'nil)))) (describe "(tags-inherited)" (it "handles 0 arguments" @@ -616,6 +638,11 @@ with keyword arg NOW in PLIST." :to-equal (list :query t :preamble (rx bol (repeat 2 4 "*") " ") :preamble-case-fold t))) + (it "with an expression in level number's place" + (expect (org-ql--query-preamble '(level <= (string-to-number (property "PROPERTY")))) + :to-equal (list :query '(level <= (string-to-number (property "PROPERTY"))) + :preamble nil + :preamble-case-fold t))) (it "<" (expect (org-ql--query-preamble '(level < 3)) :to-equal (list :query t @@ -641,6 +668,14 @@ with keyword arg NOW in PLIST." ;; TODO: Other predicates. + (it "Ignores empty quoted strings" + (expect (org-ql--query-string-to-sexp "\"\"") + :to-equal nil) + (expect (org-ql--query-string-to-sexp "foo \"\" bar") + :to-equal '(and (rifle "foo") (rifle "bar"))) + (expect (org-ql--query-string-to-sexp "foo \"baz\" bar") + :to-equal '(and (rifle "foo") (rifle "baz") (rifle "bar")))) + (it "Negated terms" (expect (org-ql--query-string-to-sexp "todo: !todo:CHECK,SOMEDAY") :to-equal '(and (todo) (not (todo "CHECK" "SOMEDAY")))) @@ -1097,7 +1132,12 @@ with keyword arg NOW in PLIST." '("Take over the world"))) (org-ql-it "with two arguments" (org-ql-expect ('(heading "Take over" "world")) - '("Take over the world")))) + '("Take over the world"))) + (org-ql-it "does not match strings as regexps" + (org-ql-expect ('(heading "over")) + '("Take over the universe" "Take over the world" "Take over Mars" "Take over the moon")) + (org-ql-expect ('(heading "[over]")) + nil))) (describe "(heading-regexp)" (org-ql-it "with one argument" @@ -1136,7 +1176,41 @@ with keyword arg NOW in PLIST." '("/r/emacs"))) (org-ql-it "with :description and :target regexp" (org-ql-expect ('(link :description "em.cs" :target "em.cs" :regexp-p t)) - '("/r/emacs")))) + '("/r/emacs"))) + + (describe "matches links whose descriptions contain brackets" + (before-each + (setq org-ql-test-buffer (org-ql-test-data-buffer "data-links.org"))) + + (unless (version< org-version "9.3") + ;; Earlier Org versions don't allow escaped brackets in descriptions. + (org-ql-it "without arguments" + (org-ql-expect ('(link)) + '("Alpha"))) + (org-ql-it "with description-or-target" + (org-ql-expect ('(link "phrase")) + '("Alpha"))) + (org-ql-it "with :description" + (org-ql-expect ('(link :description "phrase")) + '("Alpha"))) + (org-ql-it "with :target" + (org-ql-expect ('(link :target "id:")) + '("Alpha"))) + (org-ql-it "with :description and :target" + (org-ql-expect ('(link :description "phrase" :target "id")) + '("Alpha"))) + (org-ql-it "with description-or-target regexp" + (org-ql-expect ('(link "id:.*" :regexp-p t)) + '("Alpha"))) + (org-ql-it "with :description regexp" + (org-ql-expect ('(link :description "phr.se" :regexp-p t)) + '("Alpha"))) + (org-ql-it "with :target regexp" + (org-ql-expect ('(link :target "id:.*" :regexp-p t)) + '("Alpha"))) + (org-ql-it "with :description and :target regexp" + (org-ql-expect ('(link :description "phr.se" :target "id:.*" :regexp-p t)) + '("Alpha")))))) (describe "(outline-path)" (org-ql-it "with one argument" @@ -1270,7 +1344,15 @@ with keyword arg NOW in PLIST." (org-ql-it "with a property and a value" (org-ql-expect ('(property "agenda-group" "plans")) - '("Take over the universe" "Write a symphony")))) + '("Take over the universe" "Write a symphony"))) + + (org-ql-it "with a property and \"nil :inherit t\"" + (org-ql-expect ('(property "agenda-group" nil :inherit t)) + '("Take over the universe" "Take over the world" "Skype with president of Antarctica" "Take over Mars" "Visit Mars" "Take over the moon" "Visit the moon" "Practice leaping tall buildings in a single bound" "Renew membership in supervillain club" "Learn universal sign language" "Spaceship lease" "Recurring" "/r/emacs" "Shop for groceries" "Sunrise/sunset" "Write a symphony"))) + + (org-ql-it "with a property and \":inherit t\"" + (org-ql-expect ('(property "agenda-group" :inherit t)) + '("Take over the universe" "Take over the world" "Skype with president of Antarctica" "Take over Mars" "Visit Mars" "Take over the moon" "Visit the moon" "Practice leaping tall buildings in a single bound" "Renew membership in supervillain club" "Learn universal sign language" "Spaceship lease" "Recurring" "/r/emacs" "Shop for groceries" "Sunrise/sunset" "Write a symphony")))) (describe "(regexp)" @@ -1366,9 +1448,45 @@ with keyword arg NOW in PLIST." (org-ql-expect ('(scheduled :on 0)) '("Practice leaping tall buildings in a single bound" "Order a pizza" "Get haircut" "Fix flux capacitor" "Shop for groceries" "Rewrite Emacs in Common Lisp"))))) - ;; ;; TODO: Test (src) predicate. That will require modifying test data, which will be a - ;; ;; significant hassle. Manual testing shows that the predicate appears to work properly. - ;; + (describe "(src)" + (before-each + ;; It would seem preferable to use :var for this, but this seems more reliable. + (setq org-ql-test-buffer (org-ql-test-data-buffer "data-src.org"))) + + (org-ql-it "without arguments" + (org-ql-expect ('(src)) + '("Alpha" "Bravo"))) + + (org-ql-it "with plain argument" + ;; Finds in first source block in entry. + (org-ql-expect ('(src "foo")) + '("Alpha")) + (org-ql-expect ('(src "bar")) + '("Bravo")) + (org-ql-expect ('(src "print")) + ;; Finds in subsequent source block in entry. + '("Alpha" "Bravo"))) + + (org-ql-it "with :regexps argument" + (org-ql-expect ('(src :regexps ("foo"))) + '("Alpha")) + (org-ql-expect ('(src :regexps ("bar"))) + '("Bravo")) + (org-ql-expect ('(src :regexps ("print" "foo"))) + '("Alpha")) + (org-ql-expect ('(src :regexps ("foo" "bar"))) + nil)) + + (org-ql-it "with :lang argument" + ;; Finds in first source block in entry. + (org-ql-expect ('(src :lang "elisp")) + '("Alpha" "Bravo")) + ;; Finds in subsequent source block in entry. + (org-ql-expect ('(src :lang "python")) + '("Alpha" "Bravo")) + (org-ql-expect ('(src :lang "js")) + '("Alpha")))) + (describe "(todo)" (org-ql-it "without arguments" @@ -1409,10 +1527,10 @@ with keyword arg NOW in PLIST." (org-ql-it "with file tags" (org-ql-expect ('(tags "food")) '("Fruit" "Blueberry" "Strawberry" "Vegetable" "Broccoli" "Potato") - :buffer (org-ql-test-data-buffer "data2.org")) + :buffer (org-ql-test-data-buffer "data-file-tags.org")) (org-ql-expect ('(tags "fruit")) '("Fruit" "Blueberry" "Strawberry") - :buffer (org-ql-test-data-buffer "data2.org")))) + :buffer (org-ql-test-data-buffer "data-file-tags.org")))) (describe "(tags-inherited)" @@ -1440,10 +1558,10 @@ with keyword arg NOW in PLIST." (org-ql-it "with file tags" (org-ql-expect ('(tags-inherited "food")) '("Fruit" "Blueberry" "Strawberry" "Vegetable" "Broccoli" "Potato") - :buffer (org-ql-test-data-buffer "data2.org")) + :buffer (org-ql-test-data-buffer "data-file-tags.org")) (org-ql-expect ('(tags-inherited "fruit")) '("Blueberry" "Strawberry") - :buffer (org-ql-test-data-buffer "data2.org")))) + :buffer (org-ql-test-data-buffer "data-file-tags.org")))) (describe "(tags-local)" @@ -1470,10 +1588,10 @@ with keyword arg NOW in PLIST." (org-ql-it "with file tags" (org-ql-expect ('(tags-local "food")) nil - :buffer (org-ql-test-data-buffer "data2.org")) + :buffer (org-ql-test-data-buffer "data-file-tags.org")) (org-ql-expect ('(tags-local "fruit")) '("Fruit") - :buffer (org-ql-test-data-buffer "data2.org")))) + :buffer (org-ql-test-data-buffer "data-file-tags.org")))) (describe "(tags-all), (tags&)" @@ -1486,7 +1604,7 @@ with keyword arg NOW in PLIST." (org-ql-it "with file tags" (org-ql-expect ('(tags-all "food" "fruit")) '("Fruit" "Blueberry" "Strawberry") - :buffer (org-ql-test-data-buffer "data2.org")))) + :buffer (org-ql-test-data-buffer "data-file-tags.org")))) (describe "(tags-regexp), (tags*)" @@ -1511,10 +1629,10 @@ with keyword arg NOW in PLIST." (org-ql-it "with regexp matching file tags" (org-ql-expect ('(tags-regexp "foo")) '("Fruit" "Blueberry" "Strawberry" "Vegetable" "Broccoli" "Potato") - :buffer (org-ql-test-data-buffer "data2.org")) + :buffer (org-ql-test-data-buffer "data-file-tags.org")) (org-ql-expect ('(tags* "frui")) '("Fruit" "Blueberry" "Strawberry") - :buffer (org-ql-test-data-buffer "data2.org")))) + :buffer (org-ql-test-data-buffer "data-file-tags.org")))) (describe "(ts)" @@ -1585,7 +1703,36 @@ with keyword arg NOW in PLIST." (org-ql-expect ((org-ql--query-string-to-sexp "ts-active:with-time=")) '("Take over the universe" "Take over the world" "Visit Mars" "Visit the moon" "Practice leaping tall buildings in a single bound" "Get haircut" "Internet" "Spaceship lease" "Fix flux capacitor" "/r/emacs" "Shop for groceries" "Rewrite Emacs in Common Lisp")) (org-ql-expect ((org-ql--query-string-to-sexp "ts-active:with-time=t")) - '("Skype with president of Antarctica" "Renew membership in supervillain club" "Order a pizza")))) + '("Skype with president of Antarctica" "Renew membership in supervillain club" "Order a pizza"))) + + (describe "matches timestamps with inner time ranges" + (before-each + (setq org-ql-test-buffer (org-ql-test-data-buffer "data-ts.org") + org-ql-test-num-headings (with-current-buffer org-ql-test-buffer + (org-with-wide-buffer + (goto-char (point-min)) + ;; Exclude the "Canary" heading. + (1- (cl-loop while (re-search-forward org-heading-regexp nil t) + sum 1)))))) + + (org-ql-it "without :with-time" + (org-ql-expect ('(ts-active)) + '("Single-timestamp, without repeater" "Single-timestamp, with repeater (deadline)" "Multi-timestamp, without repeater" "French"))) + (org-ql-it ":with-time t" + (org-ql-expect ('(ts-active :on "2024-06-25" :with-time t)) + '("Single-timestamp, without repeater" "Single-timestamp, with repeater (deadline)" "Multi-timestamp, without repeater")) + (org-ql-expect ('(ts-active :on "2024-06-26" :with-time t)) + '("Multi-timestamp, without repeater"))) + (org-ql-it ":with-time t and with specified time value in :to" + (org-ql-expect ('(ts-active :to "2024-06-25 09:00" :with-time t)) + '("Single-timestamp, without repeater" "Single-timestamp, with repeater (deadline)" "Multi-timestamp, without repeater")) + ;; FIXME: The test below fails because timestamps with + ;; ranges are not yet parsed into multiple timestamps and + ;; compared as a range. This will have to be addressed in + ;; a new version. + ;; (org-ql-expect ('(ts-active :from "2024-06-25 08:30")) + ;; '("Single-timestamp, without repeater" "Single-timestamp, with repeater (deadline)" "Multi-timestamp, without repeater")) + ))) (describe "inactive" @@ -1724,7 +1871,20 @@ with keyword arg NOW in PLIST." '("Visit Mars"))) (org-ql-then (:now "2019-07-07") (org-ql-expect ('(ts :on today)) - nil))))) + nil)))) + + (describe "Day-of-week abbreviations" + (before-each + (setq org-ql-test-buffer (org-ql-test-data-buffer "data-ts.org") + org-ql-test-num-headings (with-current-buffer org-ql-test-buffer + (org-with-wide-buffer + (goto-char (point-min)) + ;; Exclude the "Canary" heading. + (1- (cl-loop while (re-search-forward org-heading-regexp nil t) + sum 1)))))) + (org-ql-it "matches French abbreviations (with trailing period)" + (org-ql-expect ('(ts :on "2024-07-12")) + '("French"))))) (describe "Compound queries" @@ -1759,14 +1919,14 @@ with keyword arg NOW in PLIST." ;; have a chance to be gathered. So we make a test buffer and run the test in that, with a test heading. (let ((test-buffer (get-buffer-create "*test-org-ql*"))) - (cl-flet ((open-link - (link) (with-current-buffer test-buffer - (erase-buffer) - (org-mode) - (insert "* TODO Test heading \n\n") - (insert link) - (backward-char 1) - (call-interactively #'org-open-at-point)))) + (cl-flet ((open-link (link) + (with-current-buffer test-buffer + (erase-buffer) + (org-mode) + (insert "* TODO Test heading \n\n") + (insert link) + (backward-char 1) + (call-interactively #'org-open-at-point)))) (describe "buffers-files parameter" :var ((quoted-lambda-link "[[org-ql-search:todo:?buffers-files%3D%28lambda%20nil%20%28error%20%22UNSAFE%22%29%29]]") @@ -1826,13 +1986,13 @@ with keyword arg NOW in PLIST." (expression-link "[[org-ql-search:todo:?title%3D%28error%20%22UNSAFE%22%29]]")) (it "Errors for a quoted lambda" (expect (open-link quoted-lambda-link) - :to-throw 'wrong-type-argument '(characterp lambda))) + :to-throw 'error '("CAUTION: Link not opened because unsafe title parameter detected: (lambda (_ _) (error \"UNSAFE\"))"))) (it "Errors for an unquoted lambda" (expect (open-link unquoted-lambda-link) - :to-throw 'wrong-type-argument '(characterp lambda))) + :to-throw 'error '("CAUTION: Link not opened because unsafe title parameter detected: (lambda (_ _) (error \"UNSAFE\"))"))) (it "Errors for an expression" (expect (open-link expression-link) - :to-throw 'wrong-type-argument '(characterp error)))) + :to-throw 'error '("CAUTION: Link not opened because unsafe title parameter detected: (error \"UNSAFE\")")))) (describe "sort parameter" :var ((quoted-lambda-link "[[org-ql-search:todo:?sort%3D%28lambda%20%28_%20_%29%20%28error%20%22UNSAFE%22%29%29]]") @@ -1858,7 +2018,7 @@ with keyword arg NOW in PLIST." (describe "View saving/loading" :var* ((temp-dir (make-temp-file "test-org-ql-" 'dir)) (temp-filenames (cl-loop for file in '("test1.org" "test2.org") - collect (expand-file-name file temp-dir))) + collect (abbreviate-file-name (expand-file-name file temp-dir)))) (file-contents (with-temp-buffer (insert "#+TITLE: Test data\n\n" "* TODO Heading 1\n" @@ -1921,16 +2081,15 @@ with keyword arg NOW in PLIST." (when-let ((buffer (find-file-noselect filename 'nowarn))) (kill-buffer buffer)))) - (cl-flet ((var-after-bookmark-set-and-jump - (var buffers-files query &key sort super-groups) - (org-ql-search buffers-files query - :super-groups super-groups - :sort sort :title title :buffer view-buffer) - (set-buffer view-buffer) - (bookmark-set title) - (kill-buffer) - (bookmark-jump title) - (buffer-local-value var (get-buffer (concat "*Org QL View: " title "*"))))) + (cl-flet ((var-after-bookmark-set-and-jump (var buffers-files query &key sort super-groups) + (org-ql-search buffers-files query + :super-groups super-groups + :sort sort :title title :buffer view-buffer) + (set-buffer view-buffer) + (bookmark-set title) + (kill-buffer) + (bookmark-jump title) + (buffer-local-value var (get-buffer (concat "*Org QL View: " title "*"))))) (describe "Grouping" :var ((query '(and (todo "TODO") (regexp "heading"))) @@ -1984,18 +2143,18 @@ with keyword arg NOW in PLIST." (describe "Dynamic blocks" (describe "warn about sexp queries" - (cl-flet ((test-dblock - (&optional input) (with-current-buffer (get-buffer-create "*TEST DBLOCK*") - (erase-buffer) - (org-mode) - (insert "* TODO Heading 1\n\n" - "#+BEGIN: org-ql :query (or (todo) (regexp \"Heading\")) :columns (todo)\n" - "#+END:") - (goto-char (point-min)) - (forward-line 2) - (with-simulated-input input - (org-dblock-update)) - (kill-buffer)))) + (cl-flet ((test-dblock (&optional input) + (with-current-buffer (get-buffer-create "*TEST DBLOCK*") + (erase-buffer) + (org-mode) + (insert "* TODO Heading 1\n\n" + "#+BEGIN: org-ql :query (or (todo) (regexp \"Heading\")) :columns (todo)\n" + "#+END:") + (goto-char (point-min)) + (forward-line 2) + (with-simulated-input input + (org-dblock-update)) + (kill-buffer)))) (it "when org-ql-ask-unsafe-queries is non-nil" ;; TODO: Should the query be converted to string form if possible and only warn if not? @@ -2024,39 +2183,37 @@ with keyword arg NOW in PLIST." (insert "* TODO Test heading\n\n") (org-mode))) - (cl-flet* ((open-link-in - (link buffer input) - ;; Org REDUCED THE NUMBER OF ARGUMENTS TO `org-open-link-from-string'! That BREAKS BACKWARD - ;; COMPATIBILITY! So I have to make my own function so these tests can work across Org versions! - (with-current-buffer buffer - (erase-buffer) - (org-mode) - (insert "* TODO Test heading\n\n") - (insert link) - (backward-char 1) - (with-simulated-input input - (org-open-at-point)))) + (cl-flet* ((open-link-in (link buffer input) + ;; Org REDUCED THE NUMBER OF ARGUMENTS TO `org-open-link-from-string'! That BREAKS BACKWARD + ;; COMPATIBILITY! So I have to make my own function so these tests can work across Org versions! + (with-current-buffer buffer + (erase-buffer) + (org-mode) + (insert "* TODO Test heading\n\n") + (insert link) + (backward-char 1) + (with-simulated-input input + (org-open-at-point)))) - (var-after-link-save-open - (var buffers-files query &key sort super-groups - (buffer link-buffer) (store-input "RET") open-input) - (org-ql-search buffers-files query - :super-groups super-groups - :sort sort :title title :buffer view-buffer) - (with-current-buffer view-buffer - (cl-assert (member '("org-ql-search" :follow org-ql-view--link-follow :store org-ql-view--link-store) - org-link-parameters) - t) - (with-simulated-input store-input - ;; Avoid writing "Stored: ..." to test output. - (let ((inhibit-message t)) - (call-interactively #'org-store-link nil))) - (kill-buffer)) - (cl-assert (and org-stored-links (caar org-stored-links)) t) - (open-link-in (caar org-stored-links) buffer open-input) - (with-current-buffer (get-buffer (concat "*Org QL View: " title "*")) - (prog1 (buffer-local-value var (current-buffer)) - (kill-buffer))))) + (var-after-link-save-open (var buffers-files query &key sort super-groups + (buffer link-buffer) (store-input "RET") open-input) + (org-ql-search buffers-files query + :super-groups super-groups + :sort sort :title title :buffer view-buffer) + (with-current-buffer view-buffer + (cl-assert (member '("org-ql-search" :follow org-ql-view--link-follow :store org-ql-view--link-store) + org-link-parameters) + t) + (with-simulated-input store-input + ;; Avoid writing "Stored: ..." to test output. + (let ((inhibit-message t)) + (call-interactively #'org-store-link nil))) + (kill-buffer)) + (cl-assert (and org-stored-links (caar org-stored-links)) t) + (open-link-in (caar org-stored-links) buffer open-input) + (with-current-buffer (get-buffer (concat "*Org QL View: " title "*")) + (prog1 (buffer-local-value var (current-buffer)) + (kill-buffer))))) (describe "Queries" :var ((string-query "todo:TODO regexp:heading")