Compare commits

..

140 commits

Author SHA1 Message Date
Jiri Jakes
ed23480e4b Apply #459
Some checks failed
CI / build (27.1) (push) Has been cancelled
CI / build (27.2) (push) Has been cancelled
CI / build (28.1) (push) Has been cancelled
CI / build (28.2) (push) Has been cancelled
CI / build (29.1) (push) Has been cancelled
CI / build (29.2) (push) Has been cancelled
CI / build (29.3) (push) Has been cancelled
CI / build (29.4) (push) Has been cancelled
CI / build (snapshot) (push) Has been cancelled
2026-08-17 19:55:50 +08:00
Adam Porter
4b8330a683
Merge pull request #491 from alhassy/master
Docs: Remove grammatical typo from “org-ql-search-block”
2025-04-20 20:33:00 -05:00
Musa Al-hassy
9946299bec Docs: Remove grammatical typo from “org-ql-search-block” 2025-04-20 07:50:43 -04:00
Adam Porter
98c62ab0a6 Docs: Fix some predicate arguments
Reported-by: Trevoke <https://github.com/Trevoke>
2024-11-25 17:49:54 -06:00
Adam Porter
a5650e2be8 Merge: v0.8.10 2024-11-06 21:45:09 -06:00
Adam Porter
9c53c1bddf Release: v0.8.10 2024-11-06 21:43:13 -06:00
Adam Porter
c95bb8a3ef Fix: (org-ql-refile) Use base buffer
See #466.
2024-11-06 21:42:40 -06:00
Adam Porter
0e68cc9fac Fix: (link) Don't match against null groups
e.g. in a source block containing Bash shell code like:

  [[ -z $data ]]

The matched groups could be null, since it's not actually an Org link,
so calling STRING-MATCH-P on them would signal an error.

Reported-by: John Wiegley <jwiegley@gmail.com>
2024-11-06 21:42:27 -06:00
Adam Porter
3cfc77d2ff Meta: v0.8.10-pre 2024-11-06 21:42:10 -06:00
Adam Porter
b6f8a315e9 Fix: (org-ql-view--format-element) Font-lock Org syntax
Not sure why I overlooked this for so long (links already worked,
which is probably why).
2024-09-16 18:25:02 -05:00
Adam Porter
fff110acde Fix: (org-ql-refile) Use base buffer
Should probably release this in a v0.8.10.

See #466.
2024-09-16 13:42:17 -05:00
Adam Porter
d574b60551 Add: (defface org-ql-view-query) 2024-09-11 01:50:16 -05:00
Adam Porter
82f762e31c Add: (org-ql-view-relative-deadline-prefix) 2024-09-11 01:01:30 -05:00
Adam Porter
a3c0205a68 Fix: (defface org-ql-view-due-date) Customization group 2024-09-10 22:38:19 -05:00
Adam Porter
1c8c89f264 Add: (defface org-ql-view-title) Use in -view--header-line-format
Note that we also add a safety check in ORG-QL-VIEW--LINK-FOLLOW,
because the addition of a call to PROPERTIZE in
ORG-QL-VIEW--HEADER-LINE-FORMAT effectively removes what was
functioning as a safety check there (as CONCAT had been signaling an
error for the unsafe argument, whereas PROPERTIZE, which is called to
apply the new face, does not).  We also change the expected error in
the tests accordingly.
2024-09-10 22:37:19 -05:00
Adam Porter
c3519fb4a0 Merge: v0.8.9 2024-09-05 18:58:13 -05:00
Adam Porter
81281350d4 Release: v0.8.9 2024-09-05 18:56:47 -05:00
Adam Porter
e241354fd6 Fix: (org-ql--define-query-preamble-fn) Pcase pattern for Emacs 30
Now all tests and lints pass on Emacs versions 27.1-29.4, and the
current 30.0.50-ish snapshot build.

Note: This change was originally applied on master, but it seems
reasonable to apply it to this stable bugfix release now.

Fixes #433.

Reported-by: Akira Komamura <akira.komamura@gmail.com>
Co-developed-by: Stefan Monnier <monnier@iro.umontreal.ca>
2024-09-05 18:45:58 -05:00
Adam Porter
5ea97d2272 Fix: (level) Check number argument for preamble
This allows a query like this:

  (level <= (string-to-number (property PROPERTY)))

to proceed without signaling an error from ORG-QL--QUERY-PREAMBLE.

See #460.

Reported-by: Stewmath <https://github.com/Stewmath>
2024-09-05 18:35:19 -05:00
Adam Porter
3e7f48ad7e Meta: (test.yml) Also test on Emacs 29.1-29.4 2024-09-05 04:26:59 -05:00
Adam Porter
c77bade432 Tests: Fix filenames for CI (better)
This is much simpler.
2024-09-05 04:25:59 -05:00
Adam Porter
86d338729f Fix: (property) Calling like (property PROPERTY :inherit t)
Supporting this form isn't really required, since it violates the
CL-style argument parsing of CL-DEFUN, but it's convenient, and
probably saves some hair-pulling for users who are less familiar with
Elisp.

Fixes #460.

Reported-by: Stewmath <https://github.com/Stewmath>
2024-09-05 04:24:24 -05:00
Adam Porter
a373e812d0 Fix: (org-ql-view--link-follow) Reading link parameters
This is needed due to changes in Emacs 30, but this code was always
mistaken, and it just happened to work.

See <https://github.com/jorgenschaefer/emacs-buttercup/issues/247>.

Fixes #441.

Suggested-by: Ola Nilsson <ola.nilsson@gmail.com>
2024-09-04 23:48:34 -05:00
Adam Porter
bcb77b75cc Meta: v0.8.9-pre 2024-09-04 21:55:10 -05:00
Adam Porter
831a1d4736 Tests: Fix filenames for CI (better)
This is much simpler.
2024-09-04 21:47:53 -05:00
Adam Porter
f72feb8018 Revert "Tests: Fix filename tests for CI"
This reverts commit 611198155d.
2024-09-04 21:40:36 -05:00
Adam Porter
fcb4e3ee62 Merge: v0.8.8 2024-08-29 16:38:58 -05:00
Adam Porter
20c0e5a9a7 Release: v0.8.8 2024-08-29 16:37:08 -05:00
Adam Porter
fd82c83d49 Fix: (org-ql-defpred) Docstring quote escapes 2024-08-29 16:35:57 -05:00
Adam Porter
847c066d54 Comment: TODO 2024-08-29 16:31:42 -05:00
Adam Porter
04b3bd2664 Fix: Use of org-ql-completing-read--snippet-regexp
* org-ql-completing-read.el (org-ql-completing-read-snippet): Call
snippet function with argument
(org-ql-completing-read): Call snippet function passed in rather than
hard-coded function.
(org-ql-completing-read--snippet-simple): Accept optional, ignored argument.
(org-ql-completing-read--snippet-regexp): Make argument optional;
rename for clarity.

Fixes #419.

Reported-by: tpeacock19 <https://github.com/tpeacock19>
2024-08-29 16:31:07 -05:00
Adam Porter
3c1dd36990 Fix: (org-ql-completing-read) Binding of completion-styles-alist
Fixes #337.

Thanks to Nicholas Vollmer (@progfolio), viz (@9viz), and Karthik
Chikmagalur (@karthink) for reporting and suggesting fixes.
2024-08-29 14:39:55 -05:00
Adam Porter
357d533b75 Fix: (-view--format-element) Remove text properties from keywords
Modes like org-indent-mode and org-modern can add text properties to
to-do keywords in Org buffers, and those properties can "bleed over"
when org-element copies those regions into strings.  When those
strings are then displayed in an org-ql-view buffer, they can affect
how the keywords appear, e.g. having extra spaces prefixing them,
which breaks alignment.  We apply faces to the keywords ourselves, so
we don't need any properties from the source buffer.

Fixes #455.
2024-08-29 14:27:09 -05:00
Adam Porter
b6704c2814 Meta: v0.8.8-pre 2024-08-29 14:19:10 -05:00
Adam Porter
b0cb7618e9 Merge: Respect narrowing in org-ql-find 2024-08-26 07:19:18 -05:00
Adam Porter
cfe5300987 Docs: Update changelog 2024-08-26 07:19:09 -05:00
Adam Porter
ba49d0e3c7 Change: Respect narrowing in org-ql-find
This allows searching within a narrowed buffer with org-ql-find.
Using "C-u" searches the widened buffer, while "C-u C-u" prompts to
select the buffers to search (which previously worked with just
"C-u").
2024-08-26 07:14:31 -05:00
Adam Porter
b7d4856f92 Fix: (org-ql--define-query-preamble-fn) Pcase pattern for Emacs 30
Now all tests and lints pass on Emacs versions 27.1-29.4.  But on the
current Emacs snapshot build used in CI, Buttercup is hanging
indefinitely, which may be the same problem that led Guix to disable
the tests in
<https://git.savannah.gnu.org/cgit/guix.git/commit/gnu/packages/emacs-xyz.scm?id=3add97c7761e6c58a1d7405f417a49dda5f0a742>.
But I've no way of knowing whether that's a problem in org-ql (seems
unlikely), Emacs snapshot, or Buttercup.  It would be nice to solve
this before Emacs 30.1 is released, but I don't know how to peer
inside Buttercup to find out what it's hanging on.

Fixes #433.

Reported-by: Akira Komamura <akira.komamura@gmail.com>
Co-developed-by: Stefan Monnier <monnier@iro.umontreal.ca>
2024-06-27 09:32:34 -05:00
Adam Porter
611198155d Tests: Fix filename tests for CI
As the comment says, in CI the filenames are being abbreviated, which
I can't explain (it has not always been this way).  So we compare them
in abbreviated form.
2024-06-27 08:03:04 -05:00
Adam Porter
a8608f408b Fix/Meta: (makem.sh) Update to v0.7.1
This omits the obsolete Org ELPA repository, which apparently was
causing a very old version of Org to be installed, which appeared to
be causing Buttercup to inexplicably hang (sometimes, on some systems,
in some circumstances...?).

I don't know if this is related to Guix commit
<https://git.savannah.gnu.org/cgit/guix.git/commit/gnu/packages/emacs-xyz.scm?id=3add97c7761e6c58a1d7405f417a49dda5f0a742>,
which disables the tests due to Buttercup hanging, because Guix is not
running the tests through makem.sh.
2024-06-27 07:44:10 -05:00
Adam Porter
bfb0fbeec1 Tests: Declare requirement on xr
This was overlooked because makem.sh gets run with --install-linters,
which installs relint, which depends on xr.
2024-06-27 07:41:16 -05:00
Adam Porter
ccbd5b4594 Meta: (test.yml) Also test on Emacs 29.1-29.4 2024-06-27 07:02:09 -05:00
Adam Porter
d4faa21640 Fix: (data-ts.org) French day-of-week abbreviation
The test data in v0.8.7 was accidentally changed to the English
abbreviation (the perils of working on systems with differing
locales), but the feature works as intended.

See <ffc3477013 (r143566834)>.
2024-06-26 12:01:32 -05:00
Adam Porter
f24d93f038 Merge: v0.8.7 2024-06-26 11:32:45 -05:00
Adam Porter
c2b4404808 Release: v0.8.7 2024-06-26 11:31:17 -05:00
Adam Porter
b362dd68b0 Fix: (org-dblock-write:org-ql) Resolve element properties
Fixes <https://github.com/alphapapa/org-ql/issues/431>.

Reported-by: Jez Cope <https://github.com/jezcope>
2024-06-26 11:30:26 -05:00
Adam Porter
ffc3477013 Fix: (org-ql-regexp-part-ts-date) Allow punctuation in day-of-week
Fixes <https://github.com/alphapapa/org-ql/issues/432>.  Closes
<https://github.com/alphapapa/org-ql/pull/435>.

Reported-by: Florian D. <https://github.com/neurolit>
2024-06-26 11:20:28 -05:00
Adam Porter
914e64746f Fix: (org-ql-search) Interactive narrowing
Fixes #430.  Closes #436.

Reported-by: Akira Komamura <akira.komamura@gmail.com>
2024-06-26 10:41:58 -05:00
Adam Porter
4af08e37f9 Merge: Match timestamps with inner time ranges
Note that this is a form of basic, initial support.  More
comprehensive support will require refactoring of how timestamp values
are handled, which is deferred until a future version.

See <https://github.com/alphapapa/org-ql/pull/237> and
<https://github.com/alphapapa/org-ql/issues/371>.

Reported-by: Ihor Radchenko <yantar92@gmail.com>
2024-06-26 10:29:28 -05:00
Adam Porter
e3b956e54d Docs: Update changelog 2024-06-26 10:25:41 -05:00
Adam Porter
02b4213826 Tests: Timestamps with inner time ranges 2024-06-26 10:20:35 -05:00
Ihor Radchenko
0d9c46247d org-ql-regexp-part-ts-time: Fix for time intervals 2024-06-26 10:01:20 -05:00
Adam Porter
b8284c8f5c Meta: v0.8.7-pre 2024-06-26 09:58:11 -05:00
Adam Porter
5ef4364d0a Tidy: Compiler warnings 2024-06-22 05:00:03 -05:00
Adam Porter
d5269bb5e2 Comment: Add FIXME 2024-06-12 23:45:43 -05:00
Adam Porter
e9d08ca344 Tidy: (org-ql-defpred) Docstring
This does not solve the compilation warning, because that's caused by
the Pcase patterns at the end of the docstring, which the linter
falsely identifies as incorrect.
2024-06-12 23:33:36 -05:00
Adam Porter
f7c3a61e32 Fix: (helm-org-ql [v0.6.2]) Compilation warnings 2024-06-12 22:55:29 -05:00
Adam Porter
0f01f0a9d8 Tidy: Compilation warnings 2024-06-12 22:47:33 -05:00
Adam Porter
c9370982bf Merge: v0.8.6 2024-04-03 15:27:29 -05:00
Adam Porter
1f264bf464 Release: v0.8.6 2024-04-03 15:26:33 -05:00
Adam Porter
8bd73b4b46 Fix: (org-ql-view-bookmark-make-record) buffers-files as symbol 2024-04-03 15:25:58 -05:00
Adam Porter
d3f6dde344 Meta: v0.8.6-pre 2024-04-03 15:25:06 -05:00
Adam Porter
e41fe9018a Docs: Add development section 2024-02-21 20:00:39 -06:00
Adam Porter
f5cda3d127 Merge: v0.8.5 2024-02-21 05:47:17 -06:00
Adam Porter
bfff0b5517 Release: v0.8.5 2024-02-21 05:46:04 -06:00
Adam Porter
c90bae0eab Fix: (ancestors, parent) Normalize sub-queries
I'm not sure why calling the REC labeled function didn't correctly
normalize these sub-queries; it seemed to only normalize for one
round, leaving some queries incorrectly normalized.  But this fixes
it.

Fixes #365.

Reported-by: Gabriele Mongiano <https://github.com/kofm>
2024-02-21 05:45:46 -06:00
Adam Porter
b6efba9aeb Fix: (heading) Don't match strings as regexps
Reported-by: Alex Popescu <https://github.com/al3xandru>
2024-02-21 05:45:36 -06:00
Adam Porter
770e60766a Meta: v0.8.5-pre 2024-02-21 05:45:25 -06:00
Adam Porter
8d3c93b883 Tidy: Compiler warning
I've no explanation for why this isn't caught by makem.sh's linting
compilation and declarations, but somehow it shows up at installation
time.
2024-01-13 00:47:47 -06:00
Adam Porter
9c63a45821 Meta: Update makem.sh 2024-01-13 00:47:35 -06:00
Adam Porter
a305862d7e Merge: v0.8.4 2024-01-13 00:04:27 -06:00
Adam Porter
9606aaf812 Release: v0.8.4 2024-01-13 00:03:28 -06:00
Adam Porter
34f8b75b35 Fix: (org-ql-find) Go to base buffer if possible
Use the base buffer if it has one, because if we run the search from
an indirect buffer, it's likely already narrowed to a different entry,
and making an indirect buffer from that one would end up with a
restriction that would likely hide the selected entry.
2024-01-13 00:03:03 -06:00
Adam Porter
0168171a14 Meta: v0.8.4-pre 2024-01-12 23:58:41 -06:00
Adam Porter
6679bdea00 Merge: v0.8.3 2024-01-10 01:56:57 -06:00
Adam Porter
7d8bd8b884 Release: v0.8.3 2024-01-10 01:56:00 -06:00
Adam Porter
0b1e4b43ec Fix: (org-ql-find) Moving point and widening buffer as needed
See #380.

Reported-by: Omar Antolín Camarena <omar.antolin@gmail.com>
2024-01-10 01:55:16 -06:00
Adam Porter
694739b31d Meta: v0.8.3-pre 2024-01-10 01:38:15 -06:00
Adam Porter
5b0026260a Merge: v0.8.2 2024-01-09 02:28:19 -06:00
Adam Porter
3448e49d86 Release: v0.8.2 2024-01-09 02:27:11 -06:00
Adam Porter
7ff6cc2ef7 Fix: (org-ql-find) Don't use org-with-point-at
See <https://github.com/alphapapa/org-ql/issues/380#issuecomment-1881913025>.

Reported-by: Bram Schoenmakers <me@bramschoenmakers.nl>
2024-01-09 02:25:46 -06:00
Adam Porter
8595139f5b Meta: v0.8.2-pre 2024-01-09 02:22:38 -06:00
Adam Porter
39394c831a Merge: v0.8.1 2024-01-03 18:49:09 -06:00
Adam Porter
51869fd7f9 Release: v0.8.1 2024-01-03 18:47:44 -06:00
Adam Porter
02a2e256dc Docs: Fix v0.7 changelog
Fixes #335.

Reported-by: Nicholas Vollmer <https://github.com/progfolio>
2024-01-03 18:46:21 -06:00
Ivan Perez
393f88e7f3 Remove mentions of removed functions from v0.7 subheading in Changelog.
These commands were removed in 5768c685ad,
but they were still mentioned in the release that was going to
incorporate those two functions, v0.7.

This commit removes the mention of those two functions from the v0.7
subheading in the changelog. Note that `org-ql-find-path` was
re-introduced in v0.8, so it remains under that subheading as a separate
addition.
2024-01-03 18:44:56 -06:00
Adam Porter
529e05851b Fix: (org-ql-view--format-element) Avoid unlinkifying links
I don't fully understand why this is the correct fix, because I don't
know where the raw heading text is being linkified (it seems like the
:raw-value property should be the unlinkified text), but this seems to
work correctly now.  If it turns out to break something else, we'll
find out and fix it.

Fixes #282.

Reported-by: Jacob Boxerman <https://github.com/jakebox>
2024-01-03 18:35:11 -06:00
Adam Porter
8e9a8fe090 Fix: (org-ql-find) Widen buffer
This fixes the case in which a user calls org-ql-find from a narrowed
buffer and chooses a result outside the restriction.  This is already
done in, e.g. org-ql-open-link; it's just an oversight here.
2024-01-03 18:28:06 -06:00
Adam Porter
24b799ab0b Meta: v0.8.1-pre 2024-01-03 18:25:18 -06:00
Adam Porter
a4bf5b0a92 Tidy: (org-ql-view--display) Take STRINGS instead of STRING
No need to allocate one large string just to insert it into the
buffer.
2023-12-24 01:10:27 -06:00
Adam Porter
0e39372146 Meta: v0.9-pre 2023-12-24 01:09:49 -06:00
Adam Porter
087e99703e Release: v0.8 2023-12-21 17:14:30 -06:00
Adam Porter
09e7b60505 Tidy: Compatibility aliases for Org 9.6 2023-12-21 17:11:01 -06:00
Adam Porter
b015b3b910 Tidy: Indentation, variable 2023-12-21 17:10:53 -06:00
Adam Porter
eaf58b463e Meta: Update copyright years
Fixes #336.
2023-12-21 16:54:17 -06:00
Adam Porter
08497a1648 Merge: org-ql-completing-read-export 2023-12-21 16:49:13 -06:00
Adam Porter
f98dee54c8 Docs: Update changelog and usage 2023-12-21 16:49:06 -06:00
Adam Porter
f4b006ffb9 Remap embark-collect to embark-export 2023-12-21 16:40:09 -06:00
Adam Porter
2644f53fe2 Tidy, rename 2023-12-21 16:40:09 -06:00
Omar Antolín
0552aa8b93 Use a keymap for the org-ql-view export functionality 2023-12-21 16:40:09 -06:00
Omar Antolín Camarena
121af5c5d5 Add C-c C-e key binding to save an org-ql-find session 2023-12-21 16:40:09 -06:00
Adam Porter
4ef9d9efed Meta: (bug_report.yml) Add Org version, remove labels and assignee 2023-12-19 03:27:01 -06:00
Adam Porter
77b4c2bce2 Meta: Add bug report template 2023-12-16 07:55:16 -06:00
Adam Porter
3dc2409539 Meta: Require Emacs 27.1 or later
Emacs 26.3 is quite old now, and I can't practically run tests for it
anymore because some other dependencies have dropped support for it.
2023-12-16 07:10:52 -06:00
Adam Porter
9a5680c6f3 Merge: (property) Use 'selective argument to org-entry-get
Closes #346.  See also #356.

Reported-by: Bram Schoenmakers <https://github.com/bram85>
Co-developed-by: Bram Schoenmakers <https://github.com/bram85>
2023-12-16 05:39:33 -06:00
Adam Porter
c78f785378 Docs: Update changelog 2023-12-16 05:39:08 -06:00
Bram Schoenmakers
f6d7514159 Handle the case when org-use-property-inheritance is a list of strings
When org-use-property-inheritance is a list, then the query

(property "FOO" "BAR")

would bail out with:

org-ql--byte-compile-warning: Invalid Org QL query: "Invalid Org QL
query: \"‘\\\"BLAH\\\"’ is a malformed function\", :warning", :error

(property "FOO") would still work though.

So, if org-use-property-inheritance is a list, cast it to
the (default) boolean value for this variable: nil.

Use 'selective' inheritance when org-use-property-inheritance is a list

This symbol is mentioned in the org-entry-get documentation.
2023-12-16 05:39:05 -06:00
Adam Porter
1496185141 Fix: (property) Handle org-use-property-inheritance when unspecified
Fixes #356.

Reported-by: beast-pro <https://github.com/beast-pro>
Reported-by: pcompassion <https://github.com/pcompassion>
2023-12-16 05:37:48 -06:00
Adam Porter
004ed1ee0f Tidy: Indentation
For Emacs 29.1's and with-simulated-input's changes.
2023-12-16 05:37:48 -06:00
Adam Porter
c62ff77cd3 Tidy: Use compat and newer symbol names 2023-12-16 05:37:48 -06:00
Adam Porter
0ab236f95b Tidy: Docstring
The compiler still complains that it has wrong usage of an unescaped
single quote, but nothing seems to fix it.
2023-12-16 05:37:48 -06:00
Adam Porter
a31baebc4f Add: (org-ql-view--format-element) org-category property
Hopefully this does not cause a noticeable performance impact.  Maybe
the new org-element caching features in Org will help with that.

Fixes #363.

Reported-by: Gabriele Mongiano <https://github.com/kofm>
2023-12-16 04:47:06 -06:00
Adam Porter
ace5e361af Merge: v0.7.4 2023-12-16 04:13:38 -06:00
Adam Porter
4f62ba3bd6 Fix: (org-ql-find) Pop to buffer then go to position
Seems that selecting the window after going to the position can
sometimes break (probably because of the window point).
2023-11-06 16:30:20 -06:00
Adam Porter
72b9934d1f Change: (org-ql-find.el) Factor out interactive form
And use in org-ql-find-path.
2023-11-06 15:55:39 -06:00
Adam Porter
e885001a2a Comment: Add TODO 2023-11-01 14:37:59 -05:00
Adam Porter
bd2dd12a41 Merge: (org-ql-open-link) And associated changes 2023-10-25 03:30:41 -05:00
Adam Porter
2319fc9d8b Docs: Update changelog, Usage 2023-10-25 03:29:03 -05:00
Adam Porter
58d29d0fff Comment: Add FIXME 2023-10-25 03:21:03 -05:00
Adam Porter
a802579f86 Tidy 2023-10-25 03:19:29 -05:00
Adam Porter
40b25ac319 Fix: (org-ql-completing-read-snippet) while-no-input 2023-10-23 18:57:58 -05:00
Adam Porter
7ecb4a8b10 Tidy 2023-10-23 18:57:58 -05:00
Adam Porter
9aba73a28b WIP 2023-10-23 18:57:58 -05:00
Adam Porter
3f08d45ace Fix: (org-ql-completing-read-action) Format link 2023-10-23 18:57:58 -05:00
Adam Porter
6c18f133e9 Tidy: Function, docstrings, commented code 2023-10-23 18:57:58 -05:00
Adam Porter
e030627aeb WIP: Add display-sort-function 2023-10-23 18:57:58 -05:00
Adam Porter
28f5aa3100 WIP: Many improvements
Now need to do some kind of sorting...
2023-10-23 18:57:56 -05:00
Adam Porter
deada67e1d WIP: org-ql-open-link
Need to tidy up and generalize org-ql-completing-read a bit more, but
this is basically working, and should be very useful.
2023-10-23 18:56:45 -05:00
Adam Porter
ee01bcb6e8 Merge: v0.7.3 2023-10-23 18:55:00 -05:00
Adam Porter
ac2d43588a Add: (org-ql-find-path) 2023-10-19 21:44:26 -05:00
Adam Porter
6d5b614fc5 Fix: (org-ql-find) Interactive form
Fixes silly mistake in ab720689e9.
2023-10-02 22:52:25 -05:00
Adam Porter
ab720689e9 Change: (org-ql-find) Interactively, search relevant buffers 2023-09-30 20:09:12 -05:00
Adam Porter
ca23b1c7bd Merge: Embark support 2023-09-27 15:03:30 -05:00
Adam Porter
a41dfe25ea Docs: Update changelog, usage 2023-09-27 15:02:40 -05:00
Omar Antolín Camarena
641ec0ac50 Add category metadatum to org-ql-completing-read
This is all that is needed to gain support for Embark actions on
org-ql-find candidates.
2023-09-27 14:53:44 -05:00
Adam Porter
8250349e35 Merge: Update for Org 9.7 org-element API changes
See #364.
2023-09-27 13:40:53 -05:00
Adam Porter
5c9d4cdb48 Docs: Update changelog 2023-09-27 13:40:30 -05:00
Adam Porter
9e72bf6947 Fix: (org-ql-view--format-element) Check habit in source buffer
See #364.
2023-09-27 13:36:47 -05:00
Adam Porter
0e702ecb48 Change: Resolve Org element properties on 9.7+
See #364.
2023-09-27 13:36:47 -05:00
Adam Porter
0a0291288e Meta: v0.8-pre 2023-09-27 13:36:18 -05:00
15 changed files with 1792 additions and 710 deletions

78
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -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

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -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.

View file

@ -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

View file

@ -41,11 +41,14 @@ jobs:
fail-fast: false fail-fast: false
matrix: matrix:
emacs_version: emacs_version:
- 26.3
- 27.1 - 27.1
- 27.2 - 27.2
- 28.1 - 28.1
- 28.2 - 28.2
- 29.1
- 29.2
- 29.3
- 29.4
- snapshot - snapshot
steps: steps:
- uses: purcell/setup-emacs@master - uses: purcell/setup-emacs@master

View file

@ -19,6 +19,7 @@ It includes three libraries: The =org-ql= library is flexible and may be used as
- [[#installation][Installation]] - [[#installation][Installation]]
- [[#usage][Usage]] - [[#usage][Usage]]
- [[#changelog][Changelog]] - [[#changelog][Changelog]]
- [[#development][Development]]
:END: :END:
@ -111,11 +112,20 @@ 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: 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~ 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-agenda~ searches in ~(org-agenda-files)~.
- ~org-ql-find-in-org-directory~ searches in ~org-directory~. - ~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]] [[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 *** 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. 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.
@ -146,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:* 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 *** helm-org-ql
/Note: This command uses [[#non-sexp-query-syntax][non-sexp queries]]. It is available separately in the package =helm-org-ql=./ /Note: This command uses [[#non-sexp-query-syntax][non-sexp queries]]. It is available separately in the package =helm-org-ql=./
@ -221,7 +233,7 @@ Note that the =effort=, =level=, and =priority= predicates do not support compar
Arguments are listed next to predicate names, where applicable. 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. + =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). + =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~. + =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=. + =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. + =habit= :: Return non-nil if entry is a habit.
@ -237,23 +249,23 @@ Arguments are listed next to predicate names, where applicable.
- Aliases: ~olps~. - 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. + =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~). + =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 &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 Boolean value of ~org-use-property-inheritance~, which see (i.e. it is only interpreted as nil or non-nil). + =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. + =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=. - 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. + =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~. - 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~. - *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. Matching is done case-insensitively. + ~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 (&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 (&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 (&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. + =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~. - 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~. - 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&~. - 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. + =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*~. - 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 *** Ancestor/descendant predicates
@ -542,6 +554,114 @@ 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. /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.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 ** 0.7.4
*Fixes* *Fixes*
@ -573,7 +693,7 @@ Simple links may also be written manually in either sexp or non-sexp form, like:
** 0.7 ** 0.7
*Added* *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. + 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=.) + 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). + Option ~org-ql-default-predicate~, applied to plain-string query tokens (before, the ~regexp~ predicate was always used, but now it may be customized).
@ -883,6 +1003,14 @@ Simple links may also be written manually in either sexp or non-sexp form, like:
First tagged release. 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 * Notes
:PROPERTIES: :PROPERTIES:
:TOC: :ignore this :TOC: :ignore this

View file

@ -2,8 +2,8 @@
;; Author: Adam Porter <adam@alphapapa.net> ;; Author: Adam Porter <adam@alphapapa.net>
;; URL: https://github.com/alphapapa/org-ql ;; URL: https://github.com/alphapapa/org-ql
;; Version: 0.6.1 ;; Version: 0.6.2
;; Package-Requires: ((emacs "26.1") (dash "2.18.1") (s "1.12.0") (helm-org "1.0") (org-ql "0.6-pre")) ;; 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: ;;; Commentary:
@ -35,6 +35,7 @@
(require 'cl-lib) (require 'cl-lib)
(require 'org) (require 'org)
(require 'compat)
(require 'dash) (require 'dash)
(require 's) (require 's)
@ -44,6 +45,15 @@
(require 'org-ql) (require 'org-ql)
(require 'org-ql-search) (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 ;;;; Variables
(defvar helm-org-ql-map (defvar helm-org-ql-map
@ -102,7 +112,7 @@ NAME is passed to `helm-org-ql-source', which see.
NOTE: Atoms in the query are turned into strings where NOTE: Atoms in the query are turned into strings where
appropriate, which makes it unnecessary to type quotation marks 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. strings.
All query tokens are wrapped in the operator BOOLEAN (default All query tokens are wrapped in the operator BOOLEAN (default
@ -151,7 +161,7 @@ Is transformed into this query:
;; it to go to the previous heading. I don't know why it does that. ;; it to go to the previous heading. I don't know why it does that.
(switch-to-buffer (marker-buffer marker)) (switch-to-buffer (marker-buffer marker))
(goto-char marker) (goto-char marker)
(org-show-entry)) (helm-org-ql--show-entry))
(defun helm-org-ql-show-marker-indirect (marker) (defun helm-org-ql-show-marker-indirect (marker)
"Show heading at MARKER with `org-tree-to-indirect-buffer'." "Show heading at MARKER with `org-tree-to-indirect-buffer'."
@ -177,7 +187,7 @@ Is transformed into this query:
;;;###autoload ;;;###autoload
(cl-defun helm-org-ql-source (buffers-files &key (name "helm-org-ql")) (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. ;; Expansion of `helm-build-sync-source' macro.
(helm-make-source name 'helm-source-sync (helm-make-source name 'helm-source-sync
:candidates (lambda () :candidates (lambda ()
@ -201,7 +211,7 @@ Is transformed into this query:
(defun helm-org-ql--heading (window-width) (defun helm-org-ql--heading (window-width)
"Return string for Helm for heading at point. "Return string for Helm for heading at point.
WINDOW-WIDTH should be the width of the Helm window." 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 ;; 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 ;; 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 ;; buffer, unless we manually called `org-ql' in each buffer, which

View file

@ -3,7 +3,7 @@
# * makem.sh --- Script to aid building and testing Emacs Lisp packages # * makem.sh --- Script to aid building and testing Emacs Lisp packages
# URL: https://github.com/alphapapa/makem.sh # URL: https://github.com/alphapapa/makem.sh
# Version: 0.6-pre # Version: 0.7.1
# * Commentary: # * Commentary:
@ -112,6 +112,12 @@ Source files are automatically discovered from git, or may be
specified with options. Package dependencies are discovered from specified with options. Package dependencies are discovered from
"Package-Requires" headers in source files, from -pkg.el files, and "Package-Requires" headers in source files, from -pkg.el files, and
from a Cask file. 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 EOF
} }
@ -177,6 +183,7 @@ function elisp-checkdoc-file {
(setq makem-checkdoc-errors-p t) (setq makem-checkdoc-errors-p t)
;; Return nil because we *are* generating a buffered list of errors. ;; Return nil because we *are* generating a buffered list of errors.
nil)))) nil))))
(put 'ispell-buffer-session-localwords 'safe-local-variable #'list-of-strings-p)
(mapcar #'checkdoc-file files) (mapcar #'checkdoc-file files)
(when makem-checkdoc-errors-p (when makem-checkdoc-errors-p
(kill-emacs 1)))) (kill-emacs 1))))
@ -300,7 +307,6 @@ function elisp-package-initialize-file {
(setq package-archives (list (cons "gnu" "https://elpa.gnu.org/packages/") (setq package-archives (list (cons "gnu" "https://elpa.gnu.org/packages/")
(cons "melpa" "https://melpa.org/packages/") (cons "melpa" "https://melpa.org/packages/")
(cons "melpa-stable" "https://stable.melpa.org/packages/"))) (cons "melpa-stable" "https://stable.melpa.org/packages/")))
$elisp_org_package_archive
(package-initialize) (package-initialize)
EOF EOF
echo $file echo $file
@ -379,6 +385,36 @@ function byte-compile-file {
# ** Files # ** 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 { function dirs-project {
# Echo list of directories to be used in load path. # Echo list of directories to be used in load path.
files-project-feature | dirnames files-project-feature | dirnames
@ -387,7 +423,7 @@ function dirs-project {
function files-project-elisp { function files-project-elisp {
# Echo list of Elisp files in project. # Echo list of Elisp files in project.
git ls-files 2>/dev/null \ files-project 2>/dev/null \
| egrep "\.el$" \ | egrep "\.el$" \
| filter-files-exclude-default \ | filter-files-exclude-default \
| filter-files-exclude-args | filter-files-exclude-args
@ -396,13 +432,13 @@ function files-project-elisp {
function files-project-feature { function files-project-feature {
# Echo list of Elisp files that are not tests and provide a feature. # Echo list of Elisp files that are not tests and provide a feature.
files-project-elisp \ files-project-elisp \
| egrep -v "$test_files_regexp" \ | grep -E -v "$test_files_regexp" \
| filter-files-feature | filter-files-feature
} }
function files-project-test { function files-project-test {
# Echo list of Elisp test files. # Echo list of Elisp test files.
files-project-elisp | egrep "$test_files_regexp" files-project-elisp | grep -E "$test_files_regexp"
} }
function dirnames { function dirnames {
@ -415,7 +451,7 @@ function dirnames {
function filter-files-exclude-default { function filter-files-exclude-default {
# Filter out paths (STDIN) which should be excluded by 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 { function filter-files-exclude-args {
@ -441,7 +477,7 @@ function filter-files-feature {
# Read paths on STDIN and echo ones that (provide 'a-feature). # Read paths on STDIN and echo ones that (provide 'a-feature).
while read path while read path
do do
egrep "^\\(provide '" "$path" &>/dev/null \ grep -E "^\\(provide '" "$path" &>/dev/null \
&& echo "$path" && echo "$path"
done done
} }
@ -489,7 +525,7 @@ function ert-tests-p {
function package-main-file { function package-main-file {
# Echo the package's 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 ]] if [[ $file_pkg ]]
then then
@ -512,23 +548,23 @@ function dependencies {
# Search package headers. Use -a so grep won't think that an Elisp file containing # 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. # control characters (rare, but sometimes necessary) is binary and refuse to search it.
egrep -a -i '^;; Package-Requires: ' $(files-project-feature) $(files-project-test) \ grep -E -a -i '^;; Package-Requires: ' $(files-project-feature) $(files-project-test) \
| egrep -o '\([^([:space:]][^)]*\)' \ | grep -E -o '\([^([:space:]][^)]*\)' \
| egrep -o '^[^[:space:])]+' \ | grep -E -o '^[^[:space:])]+' \
| sed -r 's/\(//g' \ | sed -r 's/\(//g' \
| egrep -v '^emacs$' # Ignore Emacs version requirement. | grep -E -v '^emacs$' # Ignore Emacs version requirement.
# Search Cask file. # Search Cask file.
if [[ -r Cask ]] if [[ -r Cask ]]
then then
egrep '\(depends-on "[^"]+"' Cask \ grep -E '\(depends-on "[^"]+"' Cask \
| sed -r -e 's/\(depends-on "([^"]+)".*/\1/g' | sed -r -e 's/\(depends-on "([^"]+)".*/\1/g'
fi fi
# Search -pkg.el file. # Search -pkg.el file.
if [[ $(git ls-files ./*-pkg.el 2>/dev/null) ]] if [[ $(files-project "*-pkg.el" 2>/dev/null) ]]
then 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 fi
} }
@ -581,6 +617,9 @@ function sandbox {
local deps=($(dependencies)) local deps=($(dependencies))
debug "Installing dependencies: ${deps[@]}" 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[@]}" for package in "${deps[@]}"
do do
args_sandbox_package_install+=(--eval "(package-install '$package)") args_sandbox_package_install+=(--eval "(package-install '$package)")
@ -1084,21 +1123,15 @@ args_package_archives=(
--eval "(add-to-list 'package-archives '(\"melpa\" . \"https://melpa.org/packages/\") t)" --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=( args_package_init=(
--eval "(package-initialize)" --eval "(package-initialize)"
) )
elisp_org_package_archive="(add-to-list 'package-archives '(\"org\" . \"https://orgmode.org/elpa/\") t)"
# * Args # * Args
args=$(getopt -n "$0" \ args=$(getopt -n "$0" \
-o dhce:E:i:s::vf:CO \ -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,no-org-repo,sandbox:: \ -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; } || { usage; exit 1; }
eval set -- "$args" eval set -- "$args"
@ -1162,9 +1195,6 @@ do
shift shift
args_files+=("$1") args_files+=("$1")
;; ;;
-O|--no-org-repo)
unset elisp_org_package_archive
;;
--no-color) --no-color)
unset color unset color
;; ;;
@ -1193,6 +1223,9 @@ paths_temp+=("$package_initialize_file")
trap cleanup EXIT INT TERM trap cleanup EXIT INT TERM
# Change to project root directory first.
cd "$(project-root)"
# Discover project files. # Discover project files.
files_project_feature=($(files-project-feature)) files_project_feature=($(files-project-feature))
files_project_test=($(files-project-test)) files_project_test=($(files-project-test))

View file

@ -1,6 +1,6 @@
;;; org-ql-completing-read.el --- Completing read of Org entries using org-ql -*- lexical-binding: t; -*- ;;; org-ql-completing-read.el --- Completing read of Org entries using org-ql -*- lexical-binding: t; -*-
;; Copyright (C) 2022 Adam Porter ;; Copyright (C) 2022-2023 Adam Porter
;; Author: Adam Porter <adam@alphapapa.net> ;; Author: Adam Porter <adam@alphapapa.net>
@ -26,6 +26,19 @@
(require 'org-ql) (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 ;;;; Customization
(defgroup org-ql-completing-read nil (defgroup org-ql-completing-read nil
@ -37,12 +50,10 @@
:type 'boolean) :type 'boolean)
(defcustom org-ql-completing-read-snippet-function #'org-ql-completing-read--snippet-simple (defcustom org-ql-completing-read-snippet-function #'org-ql-completing-read--snippet-simple
;; TODO: I'd like to make the -regexp one the default, but with ;; TODO(v0.9): Performance of completion annotations seems to be
;; default Emacs completion affixation, it can sometimes be a bit ;; much improved now (whether due to changes in Emacs, Vertico, or
;; slow, and I don't want that to be a user's first impression. It ;; both, I don't know). It may be reasonable to make the context
;; may be possible to further optimize the -regexp one so that it ;; snippet the default now.
;; 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-completing-read'. "Function used to annotate results in `org-ql-completing-read'.
Function is called at entry beginning. (When set to Function is called at entry beginning. (When set to
`org-ql-completing-read--snippet-regexp', it is called with a `org-ql-completing-read--snippet-regexp', it is called with a
@ -73,16 +84,69 @@ For an experience like `org-rifle', use a newline."
(defface org-ql-completing-read-snippet '((t (:inherit font-lock-comment-face))) (defface org-ql-completing-read-snippet '((t (:inherit font-lock-comment-face)))
"Snippets.") "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 ;;;; 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 ;;;;; 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 ;;;###autoload
(cl-defun org-ql-completing-read (buffers-files &key query-prefix query-filter (cl-defun org-ql-completing-read
(prompt "Find entry: ")) (buffers-files &key query-prefix query-filter narrowp
"Return marker at Org entry in BUFFERS-FILES selected with `org-ql'. (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. 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 QUERY-PREFIX may be a string to prepend to the query entered by
the user (e.g. use \"heading:\" to only search headings, easily the user (e.g. use \"heading:\" to only search headings, easily
creating a custom command that saves the user from having to type creating a custom command that saves the user from having to type
@ -107,30 +171,28 @@ single predicate)."
(let ((table (make-hash-table :test #'equal)) (let ((table (make-hash-table :test #'equal))
(disambiguations (make-hash-table :test #'equal)) (disambiguations (make-hash-table :test #'equal))
(window-width (window-width)) (window-width (window-width))
last-input org-outline-path-cache query-tokens snippet-regexp) last-input org-outline-path-cache query-tokens)
(cl-labels (;; (debug-message (cl-labels (;; (debug-message
;; (f &rest args) (apply #'message (concat "ORG-QL-COMPLETING-READ: " f) args)) ;; (f &rest args) (apply #'message (concat "ORG-QL-COMPLETING-READ: " f) args))
(action (action ()
() (font-lock-ensure (point-at-bol) (point-at-eol)) (font-lock-ensure (pos-bol) (pos-eol))
;; FIXME: We want the fontified heading, and `org-heading-components' returns it ;; This function needs to handle multiple candidates per
;; without properties, so we have to use `org-get-heading', which added additional ;; call, so we loop over a list of values by default.
;; optional arguments in a certain Org version, so in those versions, it will (pcase-dolist (`(,string . ,marker) (funcall action-filter (funcall action)))
;; return priority cookies and comment strings. (when string
(let ((heading (org-link-display-format (org-entry-get (point) "ITEM")))) (if (string-empty-p string)
(if (string-empty-p heading) ;; A heading's string can be empty, but we can't use one because it
;; 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
;; 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
;; likely to indicate an unnoticed mistake or corruption in the ;; file: so display a warning and don't record it as a candidate.
;; 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))
(warn "Empty heading at %S in %S" (point) (buffer-name)) (when (gethash string table)
(when (gethash heading table) ;; Disambiguate string (even adding the path isn't enough, because that could
;; Disambiguate heading (even adding the path isn't enough, because that could ;; also be duplicated).
;; also be duplicated). (if-let ((suffix (gethash string disambiguations)))
(if-let ((suffix (gethash heading disambiguations))) (setf string (format "%s <%s>" string (cl-incf suffix)))
(setf heading (format "%s <%s>" heading (cl-incf suffix))) (setf string (format "%s <%s>" string (puthash string 2 disambiguations)))))
(setf heading (format "%s <%s>" heading (puthash heading 2 disambiguations))))) (puthash (propertize string 'org-marker marker) marker table)))))
(let ((marker (point-marker)))
(puthash (propertize heading 'org-marker marker) marker table)))))
(path (marker) (path (marker)
(org-with-point-at marker (org-with-point-at marker
(let* ((path (thread-first (org-get-outline-path nil t) (let* ((path (thread-first (org-get-outline-path nil t)
@ -140,16 +202,16 @@ single predicate)."
(concat "\\" (string-join (reverse path) "\\")) (concat "\\" (string-join (reverse path) "\\"))
(concat "/" (string-join path "/"))))) (concat "/" (string-join path "/")))))
formatted-path))) formatted-path)))
(todo (todo (marker)
(marker) (if-let (it (org-entry-get marker "TODO")) (if-let (it (org-entry-get marker "TODO"))
(concat (propertize it 'face (org-get-todo-face it)) " ") (concat (propertize it 'face (org-get-todo-face it)) " ")
"")) ""))
(affix (completions) (affix (completions)
;; (debug-message "AFFIX:%S" completions) ;; (debug-message "AFFIX:%S" completions)
(cl-loop for completion in completions (cl-loop for completion in completions
for marker = (get-text-property 0 'org-marker completion) for marker = (get-text-property 0 'org-marker completion)
for prefix = (todo marker) for prefix = (todo marker)
for suffix = (concat (path marker) " " (snippet marker)) for suffix = (concat (funcall path marker) " " (funcall snippet marker))
collect (list completion prefix suffix))) collect (list completion prefix suffix)))
(annotate (candidate) (annotate (candidate)
;; (debug-message "ANNOTATE:%S" candidate) ;; (debug-message "ANNOTATE:%S" candidate)
@ -157,15 +219,7 @@ single predicate)."
;; Using `while-no-input' here doesn't make it as responsive as, ;; 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 ;; e.g. Helm while typing, but it seems to help a little when using the
;; org-rifle-style snippets. ;; org-rifle-style snippets.
(or (snippet (get-text-property 0 'org-marker candidate)) ""))) (or (funcall snippet (get-text-property 0 'org-marker candidate)) "")))
(snippet
(marker) (when-let
((snippet
(org-with-point-at marker
(or (funcall org-ql-completing-read-snippet-function snippet-regexp)
(org-ql-completing-read--snippet-simple)))))
(propertize (concat " " snippet)
'face 'org-ql-completing-read-snippet)))
(group (candidate transform) (group (candidate transform)
(pcase transform (pcase transform
(`nil (buffer-name (marker-buffer (get-text-property 0 'org-marker candidate)))) (`nil (buffer-name (marker-buffer (get-text-property 0 'org-marker candidate))))
@ -180,9 +234,19 @@ single predicate)."
(collection (input _pred flag) (collection (input _pred flag)
(pcase flag (pcase flag
('metadata (list 'metadata ('metadata (list 'metadata
(cons 'category 'org-heading)
(cons 'group-function #'group) (cons 'group-function #'group)
(cons 'affixation-function #'affix) (cons 'affixation-function #'affix)
(cons 'annotation-function #'annotate))) (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 (`t
;; (debug-message "COLLECTION:t INPUT:%S KEYS:%S" ;; (debug-message "COLLECTION:t INPUT:%S KEYS:%S"
;; input (hash-table-keys table)) ;; input (hash-table-keys table))
@ -239,23 +303,25 @@ single predicate)."
(clrhash disambiguations) (clrhash disambiguations)
(when query-filter (when query-filter
(setf input (funcall query-filter input))) (setf input (funcall query-filter input)))
(pcase org-ql-completing-read-snippet-function (setf query-tokens
('org-ql-completing-read--snippet-regexp ;; Remove any tokens that specify predicates or are too short.
(setf query-tokens (--select (not (or (string-match-p (rx bos (1+ (not (any ":"))) ":") it)
;; Remove any tokens that specify predicates or are too short. (< (length it) org-ql-completing-read-snippet-minimum-token-length)))
(--select (not (or (string-match-p (rx bos (1+ (not (any ":"))) ":") it) (split-string input nil t (rx blank)))
(< (length it) org-ql-completing-read-snippet-minimum-token-length))) org-ql-completing-read-input-regexp
(split-string input nil t (rx space))) (when query-tokens
snippet-regexp ;; Limiting each context word to 15 characters prevents
(when query-tokens ;; excessively long, non-word strings from ending up in
;; Limiting each context word to 15 characters prevents ;; snippets, which can adversely affect performance.
;; excessively long, non-word strings from ending up in (rx-to-string `(seq (optional (repeat 1 3 (repeat 1 15 (not space)) (0+ space)))
;; snippets, which can adversely affect performance. bow (or ,@query-tokens) (0+ (not space))
(rx-to-string `(seq (optional (repeat 1 3 (repeat 1 15 (not space)) (0+ space))) (optional (repeat 1 3 (0+ space) (repeat 1 15 (not 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) (org-ql-select buffers-files (org-ql--query-string-to-sexp input)
:narrow narrowp
:action #'action)))) :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 ;; 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 ;; 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 ;; prepare an Org buffer when an Org file is loaded. This results in, e.g. the buffer being
@ -265,13 +331,27 @@ single predicate)."
;; `completing-read' machinery, which interrupts it, so we must work around this problem by ;; `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 ;; ensuring all of the BUFFERS-FILES are loaded and initialized before calling
;; `completing-read'. ;; `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) (mapc #'org-ql--ensure-buffer buffers-files)
(let* ((completion-styles '(org-ql-completing-read)) (let* ((completion-styles '(org-ql-completing-read))
(completion-styles-alist (list (list 'org-ql-completing-read #'try #'all "Org QL Find"))) (completion-styles-alist (cons (list 'org-ql-completing-read #'try #'all "Org QL Find")
(selected (completing-read prompt #'collection nil t))) 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)) ;; (debug-message "SELECTED:%S KEYS:%S" selected (hash-table-keys table))
(or (gethash selected table) (or (gethash selected table)
;; If there are completions in the table, but none of them exactly match the user input ;; If there are completions in the table, but none of them exactly match the user input
@ -286,7 +366,7 @@ single predicate)."
(car (hash-table-values table)) (car (hash-table-values table))
(user-error "No results for input")))))) (user-error "No results for input"))))))
(defun org-ql-completing-read--snippet-simple (&optional _regexp) (defun org-ql-completing-read--snippet-simple (&optional _input-regexp)
"Return a snippet of the current entry. "Return a snippet of the current entry.
Returns up to `org-ql-completing-read-snippet-length' characters." Returns up to `org-ql-completing-read-snippet-length' characters."
(save-excursion (save-excursion
@ -300,15 +380,15 @@ Returns up to `org-ql-completing-read-snippet-length' characters."
t t) t t)
50 nil nil t)))))) 50 nil nil t))))))
(defun org-ql-completing-read--snippet-regexp (regexp) (defun org-ql-completing-read--snippet-regexp (&optional input-regexp)
"Return a snippet of the current entry's matches for 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. ;; REGEXP may be nil if there are no qualifying tokens in the query.
(when regexp (when input-regexp
(save-excursion (save-excursion
(org-end-of-meta-data t) (org-end-of-meta-data t)
(unless (org-at-heading-p) (unless (org-at-heading-p)
(let* ((end (org-entry-end-position)) (let* ((end (org-entry-end-position))
(snippets (cl-loop while (re-search-forward regexp end t) (snippets (cl-loop while (re-search-forward input-regexp end t)
concat (match-string 0) concat "" concat (match-string 0) concat ""
do (goto-char (match-end 0))))) do (goto-char (match-end 0)))))
(unless (string-empty-p snippets) (unless (string-empty-p snippets)

View file

@ -1,6 +1,6 @@
;;; org-ql-find.el --- Find headings with completion using org-ql -*- lexical-binding: t; -*- ;;; 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 <adam@alphapapa.net> ;; Author: Adam Porter <adam@alphapapa.net>
@ -33,6 +33,8 @@
(require 'org-ql-search) (require 'org-ql-search)
(require 'org-ql-completing-read) (require 'org-ql-completing-read)
(declare-function org-ql--normalize-query "org-ql" t t)
;;;; Customization ;;;; Customization
(defgroup org-ql-find nil (defgroup org-ql-find nil
@ -49,14 +51,21 @@
See function `display-buffer'." See function `display-buffer'."
:type 'sexp) :type 'sexp)
;;;; Functions ;;;; Commands
;;;###autoload ;;;###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: ")) (prompt "Find entry: "))
"Go to an Org entry in BUFFERS-FILES selected by searching entries with `org-ql'. "Go to an Org entry in BUFFERS-FILES selected by searching entries with `org-ql'.
Interactively, with universal prefix, select multiple buffers to Interactively, search the buffers and files relevant to the
search with completion and PROMPT. 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 QUERY-PREFIX may be a string to prepend to the query (e.g. use
\"heading:\" to only search headings, easily creating a custom \"heading:\" to only search headings, easily creating a custom
@ -67,28 +76,35 @@ types is filtered before execution (e.g. it could replace spaces
with commas to turn multiple tokens, which would normally be with commas to turn multiple tokens, which would normally be
treated as multiple predicates, into multiple arguments to a treated as multiple predicates, into multiple arguments to a
single predicate)." single predicate)."
(interactive (interactive (list (org-ql-find--buffers
(list (if current-prefix-arg :read-buffer-p (equal '(16) current-prefix-arg))
(mapcar #'get-buffer :widen current-prefix-arg))
(completing-read-multiple (let ((marker (save-restriction
"Buffers: " (when (and widen (equal (current-buffer) buffers-files))
(cl-loop for buffer in (buffer-list) (widen))
when (eq 'org-mode (buffer-local-value 'major-mode buffer)) (org-ql-completing-read buffers-files
collect (buffer-name buffer)) :narrowp (not widen)
nil t)) :query-prefix query-prefix
(progn :query-filter query-filter
(unless (eq major-mode 'org-mode) :prompt prompt))))
(user-error "This is not an Org buffer: %S" (current-buffer))) (set-buffer (or (buffer-base-buffer (marker-buffer marker))
(current-buffer))))) (marker-buffer marker)))
(let ((marker (org-ql-completing-read buffers-files (pop-to-buffer (current-buffer) org-ql-find-display-buffer-action)
:query-prefix query-prefix (without-restriction
:query-filter query-filter (goto-char marker)
:prompt prompt))) (run-hook-with-args 'org-ql-find-goto-hook))
(set-buffer (marker-buffer marker)) (when (equal (current-buffer) (marker-buffer marker))
(goto-char marker) ;; Ensure point is still within visible portion of buffer. (If
(display-buffer (current-buffer) org-ql-find-display-buffer-action) ;; `org-tree-to-indirect-buffer' is used in `org-ql-find-goto-hook',
(select-window (get-buffer-window (current-buffer))) ;; the buffer will have been changed and it won't matter; otherwise,
(run-hook-with-args 'org-ql-find-goto-hook))) ;; 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 ;;;###autoload
(defun org-ql-refile (marker) (defun org-ql-refile (marker)
@ -106,18 +122,20 @@ which see (but only the files are used)."
((and (pred listp) files) files))) ((and (pred listp) files) files)))
(list files-spec))))))) (list files-spec)))))))
(list (org-ql-completing-read buffers-files :prompt "Refile to: ")))) (list (org-ql-completing-read buffers-files :prompt "Refile to: "))))
(org-refile nil nil (let ((buffer (or (buffer-base-buffer (marker-buffer marker))
;; The RFLOC argument: (marker-buffer marker))))
(list (org-refile nil nil
;; Name ;; The RFLOC argument:
(org-with-point-at marker (list
(nth 4 (org-heading-components))) ;; Name
;; File (org-with-point-at marker
(buffer-file-name (marker-buffer marker)) (nth 4 (org-heading-components)))
;; nil ;; File
nil (buffer-file-name buffer)
;; Position ;; nil
marker))) nil
;; Position
marker))))
;;;###autoload ;;;###autoload
(defun org-ql-find-in-agenda () (defun org-ql-find-in-agenda ()
@ -131,6 +149,85 @@ which see (but only the files are used)."
(interactive) (interactive)
(org-ql-find (org-ql-search-directories-files))) (org-ql-find (org-ql-search-directories-files)))
;;;###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)))
;;;###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) (provide 'org-ql-find)
;;; org-ql-find.el ends here ;;; org-ql-find.el ends here

View file

@ -1,5 +1,7 @@
;;; org-ql-search.el --- Search commands for org-ql -*- lexical-binding: t; -*- ;;; org-ql-search.el --- Search commands for org-ql -*- lexical-binding: t; -*-
;; Copyright (C) 2019-2023 Adam Porter
;; Author: Adam Porter <adam@alphapapa.net> ;; Author: Adam Porter <adam@alphapapa.net>
;; Url: https://github.com/alphapapa/org-ql ;; Url: https://github.com/alphapapa/org-ql
@ -38,6 +40,8 @@
(require 'org-ql) (require 'org-ql)
(require 'org-ql-view) (require 'org-ql-view)
(declare-function org-ql--normalize-query "org-ql" t t)
;;;; Compatibility ;;;; Compatibility
(defalias 'org-ql-search--link-heading-search-string (defalias 'org-ql-search--link-heading-search-string
@ -56,6 +60,16 @@
((fboundp 'org-store-link-props) #'org-store-link-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")))) (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 ;;;; Variables
(defvar org-ql-block-header nil (defvar org-ql-block-header nil
@ -124,10 +138,10 @@ Runs `org-occur-hook' after making the sparse tree."
query)))) query))))
(org-ql-select buffer query (org-ql-select buffer query
:action (lambda () :action (lambda ()
(org-show-context 'occur-tree) (org-ql--org-show-context 'occur-tree)
(cl-incf num-results))) (cl-incf num-results)))
(unless org-sparse-tree-open-archived-trees (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) (run-hooks 'org-occur-hook)
(unless (get-buffer-window buffer) (unless (get-buffer-window buffer)
(pop-to-buffer buffer)) (pop-to-buffer buffer))
@ -172,7 +186,7 @@ necessary."
(interactive (list (org-ql-view--complete-buffers-files) (interactive (list (org-ql-view--complete-buffers-files)
(read-string "Query: " (when org-ql-view-query (read-string "Query: " (when org-ql-view-query
(format "%S" 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) :super-groups (org-ql-view--complete-super-groups)
:sort (org-ql-view--complete-sort))) :sort (org-ql-view--complete-sort)))
;; NOTE: Using `with-temp-buffer' is a hack to work around the fact that `make-local-variable' ;; NOTE: Using `with-temp-buffer' is a hack to work around the fact that `make-local-variable'
@ -208,23 +222,28 @@ necessary."
(symbol (symbol-value super-groups)) (symbol (symbol-value super-groups))
(list super-groups)))) (list super-groups))))
(setf strings (org-super-agenda--group-items strings)))) (setf strings (org-super-agenda--group-items strings))))
(org-ql-view--display :buffer buffer :header header (org-ql-view--display :buffer buffer :header header :strings strings))))
:string (s-join "\n" strings)))))
;;;###autoload ;;;###autoload
(defun org-ql-search-block (query) (defun org-ql-search-block (args)
"Insert items for QUERY into current buffer. "Insert items for ARGS into current buffer.
QUERY should be an `org-ql' query form. Intended to be used as a Intended to be used as a user-defined function in
user-defined function in `org-agenda-custom-commands'. QUERY `org-agenda-custom-commands'. ARGS corresponds to the `match'
corresponds to the `match' item in the custom command form. 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 Like other agenda block commands, it searches files returned by
function `org-agenda-files'. Inserts a newline after the block. function `org-agenda-files'. Inserts a newline after the block.
If `org-ql-block-header' is non-nil, it is used as the header 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." 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 (when-let* ((from (pcase org-agenda-restrict
('nil (org-agenda-files nil 'ifmode)) ('nil (org-agenda-files nil 'ifmode))
(_ (prog1 org-agenda-restrict (_ (prog1 org-agenda-restrict
@ -235,7 +254,7 @@ automatically from the query."
(narrow-to-region org-agenda-restrict-begin org-agenda-restrict-end)))))) (narrow-to-region org-agenda-restrict-begin org-agenda-restrict-end))))))
(items (org-ql-select from query (items (org-ql-select from query
:action 'element-with-markers :action 'element-with-markers
:narrow narrow-p))) :narrow narrow-p :sort sort)))
(when narrow-p (when narrow-p
;; Restore buffer's previous restrictions. ;; Restore buffer's previous restrictions.
(with-current-buffer from (with-current-buffer from
@ -245,16 +264,25 @@ automatically from the query."
;; FIXME: `org-agenda--insert-overriding-header' is from an Org version newer than ;; 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. ;; 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))) ;; (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 ;; FIXME: Should we really use `org-ql-block-header' AND `header', or just one of them?
:buffers-files from :query query)) (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") nil 'face 'org-agenda-structure) "\n")
;; Calling `org-agenda-finalize' should be unnecessary, because in a "series" agenda, ;; 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. ;; `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. ;; But we do call `org-agenda-finalize-entries', which allows `org-super-agenda' to work.
(->> items ;; However, `org-agenda-finalize-entries' sorts entries with `org-entries-lessp', which
(-map #'org-ql-view--format-element) ;; overrides the sorting `org-ql' has already done, so we rebind `org-entries-lessp' to
org-agenda-finalize-entries ;; prevent it from affecting sort order. (Ideally we would let `org-entries-lessp'
insert) ;; 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")))) (insert "\n"))))
;;;###autoload ;;;###autoload
@ -335,23 +363,24 @@ this (must be a single line in the Org buffer):
(org-element-property (intern (concat ":" (upcase property))) element))))) (org-element-property (intern (concat ":" (upcase property))) element)))))
(elements (org-ql-query :from (current-buffer) (elements (org-ql-query :from (current-buffer)
:where query :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))) :order-by sort)))
(when take (when take
(setf elements (cl-etypecase take (setf elements (cl-etypecase take
((and integer (satisfies cl-minusp)) (-take-last (abs take) elements)) ((and integer (satisfies cl-minusp)) (-take-last (abs take) elements))
(integer (-take take elements))))) (integer (-take take elements)))))
(cl-labels ((format-element (cl-labels ((format-element (element)
(element) (string-join (cl-loop for column in columns (string-join (cl-loop for column in columns
collect (or (pcase-exhaustive column collect (or (pcase-exhaustive column
((pred symbolp) ((pred symbolp)
(funcall (alist-get column format-fns) element)) (funcall (alist-get column format-fns) element))
(`((,column . ,args) ,_header) (`((,column . ,args) ,_header)
(apply (alist-get column format-fns) element args)) (apply (alist-get column format-fns) element args))
(`(,column ,_header) (`(,column ,_header)
(funcall (alist-get column format-fns) element))) (funcall (alist-get column format-fns) element)))
"")) ""))
" | "))) " | ")))
;; Table header ;; Table header
(insert "| " (string-join (--map (pcase it (insert "| " (string-join (--map (pcase it
((pred symbolp) (capitalize (symbol-name it))) ((pred symbolp) (capitalize (symbol-name it)))

View file

@ -1,5 +1,7 @@
;;; org-ql-view.el --- Agenda-like view based on org-ql -*- lexical-binding: t; -*- ;;; org-ql-view.el --- Agenda-like view based on org-ql -*- lexical-binding: t; -*-
;; Copyright (C) 2019-2023 Adam Porter
;; Author: Adam Porter <adam@alphapapa.net> ;; Author: Adam Porter <adam@alphapapa.net>
;; Url: https://github.com/alphapapa/org-ql ;; Url: https://github.com/alphapapa/org-ql
@ -42,6 +44,7 @@
(declare-function org-ql-search "org-ql-search" t) (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-search--org-link-store-props "org-ql-search" t)
(declare-function org-ql--normalize-query "org-ql" t t)
(require 'dash) (require 'dash)
(require 's) (require 's)
@ -54,7 +57,18 @@
(defface org-ql-view-due-date (defface org-ql-view-due-date
'((t (:slant italic :weight bold))) '((t (:slant italic :weight bold)))
"Face for due dates in `org-ql-view' views." "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 ;;;; Variables
@ -235,6 +249,12 @@ See info node `(elisp)Cyclic Window Ordering'."
(sexp :tag "org-super-agenda grouping expression") (sexp :tag "org-super-agenda grouping expression")
(variable :tag "Variable holding 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 ;;;; Commands
;;;###autoload ;;;###autoload
@ -302,10 +322,10 @@ SLOT is passed to `display-buffer-in-side-window', which see."
(defun org-ql-view-switch () (defun org-ql-view-switch ()
"Switch to view at point." "Switch to view at point."
(interactive) (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) (unless (string-empty-p key)
(ov-clear :org-ql-view-selected) (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)) 'face '(:weight bold :inherit highlight))
(org-ql-view key)))) (org-ql-view key))))
@ -369,7 +389,7 @@ update search arguments."
(defun org-ql-view-customize () (defun org-ql-view-customize ()
"Customize view at point in `org-ql-view-sidebar' buffer." "Customize view at point in `org-ql-view-sidebar' buffer."
(interactive) (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) (customize-option 'org-ql-views)
(search-forward (concat "Name: " key)))) (search-forward (concat "Name: " key))))
@ -406,7 +426,7 @@ update search arguments."
(defvar bookmark-make-record-function) (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. "Display STRING in `org-ql-view' BUFFER.
BUFFER may be a buffer, or a string naming a buffer, which is BUFFER may be a buffer, or a string naming a buffer, which is
@ -444,7 +464,9 @@ subsequent refreshing of the buffer: `org-ql-view-buffers-files',
;; Clear buffer, insert entries, etc. ;; Clear buffer, insert entries, etc.
(let ((inhibit-read-only t)) (let ((inhibit-read-only t))
(erase-buffer) (erase-buffer)
(insert string "\n") (dolist (string strings)
(insert string "\n"))
(insert "\n")
(pop-to-buffer (current-buffer) org-ql-view-display-buffer-action) (pop-to-buffer (current-buffer) org-ql-view-display-buffer-action)
(org-agenda-finalize) (org-agenda-finalize)
(goto-char (point-min)))))) (goto-char (point-min))))))
@ -454,7 +476,8 @@ subsequent refreshing of the buffer: `org-ql-view-buffers-files',
If TITLE, prepend it to the header." If TITLE, prepend it to the header."
(let* ((title (if title (let* ((title (if title
(concat (propertize "View:" 'face 'transient-argument) (concat (propertize "View:" 'face 'transient-argument)
title " ") (propertize title 'face 'org-ql-view-title)
" ")
"")) ""))
(query-formatted (when query (query-formatted (when query
(org-ql-view--format-query query))) (org-ql-view--format-query query)))
@ -473,6 +496,7 @@ If TITLE, prepend it to the header."
(org-ql-view--font-lock-string 'emacs-lisp-mode) (org-ql-view--font-lock-string 'emacs-lisp-mode)
(s-truncate available-width)) (s-truncate available-width))
'help-echo buffers-files-formatted)))) 'help-echo buffers-files-formatted))))
(add-face-text-property 0 (length query-propertized) 'org-ql-view-query 'append query-propertized)
(concat title (concat title
(when query (propertize "Query:" 'face 'transient-argument)) (when query (propertize "Query:" 'face 'transient-argument))
(when query query-propertized) (when query query-propertized)
@ -487,11 +511,11 @@ If TITLE, prepend it to the header."
Makes QUERY more readable, e.g. timestamp objects are replaced Makes QUERY more readable, e.g. timestamp objects are replaced
with human-readable strings." with human-readable strings."
(cl-labels ((rec (form) (cl-labels ((rec (form)
(cl-typecase form (cl-typecase form
(ts (ts-format form)) (ts (ts-format form))
(cons (cons (rec (car form)) (cons (cons (rec (car form))
(rec (cdr form)))) (rec (cdr form))))
(otherwise form)))) (otherwise form))))
(format "%S" (rec query)))) (format "%S" (rec query))))
(defun org-ql-view--font-lock-string (mode s) (defun org-ql-view--font-lock-string (mode s)
@ -504,6 +528,22 @@ with human-readable strings."
(font-lock-ensure) (font-lock-ensure)
(buffer-string)))) (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) (defun org-ql-view--buffer (&optional name)
"Return `org-ql-view' buffer, creating it if necessary. "Return `org-ql-view' buffer, creating it if necessary.
If NAME is non-nil, return buffer by that name instead of using If NAME is non-nil, return buffer by that name instead of using
@ -533,19 +573,20 @@ dates in the past, and negative for dates in the future."
(defun org-ql-view-bookmark-make-record () (defun org-ql-view-bookmark-make-record ()
"Return a bookmark record for the current Org QL View buffer." "Return a bookmark record for the current Org QL View buffer."
(cl-labels ((file-nameize (cl-labels ((file-nameize (b-f)
(b-f) (abbreviate-file-name (abbreviate-file-name
(cl-typecase b-f (cl-typecase b-f
(string b-f) (string b-f)
(buffer (or (buffer-file-name b-f) (buffer (or (buffer-file-name b-f)
(when (buffer-base-buffer b-f) (when (buffer-base-buffer b-f)
(buffer-file-name (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)))))) (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))) (-let* ((plist (org-ql-view--plist (current-buffer)))
((&plist :buffers-files) plist)) ((&plist :buffers-files) plist))
;; Replace buffers with their filenames, and signal error if any are not file-backed. ;; Replace buffers with their filenames, and signal error if any are not file-backed.
(setf plist (plist-put plist :buffers-files (setf plist (plist-put plist :buffers-files
(cl-etypecase buffers-files (cl-etypecase buffers-files
(symbol buffers-files)
(string buffers-files) (string buffers-files)
(buffer (file-nameize buffers-files)) (buffer (file-nameize buffers-files))
(list (mapcar #'file-nameize buffers-files))))) (list (mapcar #'file-nameize buffers-files)))))
@ -605,6 +646,7 @@ The optional, second argument is temporarily _IGNORED for
purposes of compatibility with changes in Org 9.4." purposes of compatibility with changes in Org 9.4."
(require 'url-parse) (require 'url-parse)
(require 'url-util) (require 'url-util)
(declare-function url-path-and-query "url-parse")
(when (version<= "9.3" (org-version)) (when (version<= "9.3" (org-version))
;; Org 9.3+ makes a backward-incompatible change to link escaping. ;; 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 ;; I don't think it would be a good idea to try to guess whether
@ -619,7 +661,7 @@ purposes of compatibility with changes in Org 9.4."
(query (url-unhex-string query)) (query (url-unhex-string query))
(params (when params (url-parse-query-string params))) (params (when params (url-parse-query-string params)))
;; `url-parse-query-string' returns "improper" alists, which makes this awkward. ;; `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))) (read-value (read stored-string)))
;; Ensure the value is either a symbol or list of symbols (which excludes lambdas). ;; Ensure the value is either a symbol or list of symbols (which excludes lambdas).
(unless (or (symbolp read-value) (cl-every #'symbolp read-value)) (unless (or (symbolp read-value) (cl-every #'symbolp read-value))
@ -627,17 +669,19 @@ purposes of compatibility with changes in Org 9.4."
read-value)) read-value))
read-value)) read-value))
(org-super-agenda-allow-unsafe-groups nil) ; Disallow unsafe group selectors. (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))) (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))) (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)) (org-ql-view--expand-buffers-files (read it))
(current-buffer)))) (current-buffer))))
(unless (or (bufferp buffers-files) (unless (or (bufferp buffers-files)
(stringp buffers-files) (stringp buffers-files)
(cl-every #'stringp buffers-files)) (cl-every #'stringp buffers-files))
(error "CAUTION: Link not opened because unsafe buffers-files parameter detected: %s" 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) (when (or (listp query)
(string-match (rx bol (0+ space) "(") query)) (string-match (rx bol (0+ space) "(") query))
;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code. ;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code.
@ -655,23 +699,25 @@ When opened, the link searches the buffer it's opened from."
(when org-ql-view-query (when org-ql-view-query
;; Only Org QL View buffers should have `org-ql-view-query' set. ;; Only Org QL View buffers should have `org-ql-view-query' set.
(cl-labels ((prompt-for (buffers-files) (cl-labels ((prompt-for (buffers-files)
(pcase-exhaustive (pcase-exhaustive
(completing-read (format "Make link that searches: ") (completing-read (format "Make link that searches: ")
'("file link is in" "files currently searched") '("file link is in" "files currently searched")
nil t nil nil "file link is in") nil t nil nil "file link is in")
("file link is in" nil) ("file link is in" nil)
("files currently searched" buffers-files))) ("files currently searched" buffers-files)))
(strings-or-file-buffers-p (strings-or-file-buffers-p (thing)
(thing) (cl-etypecase thing (cl-etypecase thing
(list (cl-every #'strings-or-file-buffers-p thing)) (list (cl-every #'strings-or-file-buffers-p thing))
(string thing) (string thing)
(buffer (or (buffer-file-name thing) (buffer (or (buffer-file-name thing)
;; TODO: Should indirect buffers be allowed? Maybe not, since their narrowing isn't preserved. ;; TODO: Should indirect buffers be allowed? Maybe not, since their
;; On the other hand, it's possible to accidentally make a search view for an indirect buffer ;; narrowing isn't preserved. On the other hand, it's possible to
;; that's since been widened, and forcing the user to manually change that would be awkward, ;; accidentally make a search view for an indirect buffer that's
;; and trying to communicate the problem would be difficult, so maybe it's okay to allow it. ;; since been widened, and forcing the user to manually change that
(when (buffer-base-buffer thing) ;; would be awkward, and trying to communicate the problem would be
(buffer-file-name (buffer-base-buffer thing)))))))) ;; 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) (unless (strings-or-file-buffers-p org-ql-view-buffers-files)
(user-error "%s" "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) (let* ((query-string (--if-let (org-ql--query-sexp-to-string org-ql-view-query)
@ -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 ;; Transient manual is written very well, not everything is covered in
;; it, so I'm having to try to imitate examples from `magit-transient'. ;; it, so I'm having to try to imitate examples from `magit-transient'.
(require 'eieio-core)
(require 'transient) (require 'transient)
(defclass org-ql-view--variable (transient-variable) (defclass org-ql-view--variable (transient-variable)
@ -820,6 +868,20 @@ When opened, the link searches the buffer it's opened from."
;;;; Faces/properties ;;;; 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) (defun org-ql-view--format-element (element)
;; This essentially needs to do what `org-agenda-format-item' does, ;; 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. ;; 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." return an empty string."
(if (not element) (if (not element)
"" ""
(setf element (org-ql-view--resolve-element-properties element))
(let* ((properties (cadr element)) (let* ((properties (cadr element))
;; Remove the :parent property, which so bloats the size of ;; Remove the :parent property, which so bloats the size of
;; the properties list that it makes it essentially ;; 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 ;; 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). ;; (which would also make it easier to do it independently of faces, etc).
(title (--> (org-ql-view--add-faces element) (title (--> (org-ql-view--add-faces element)
(org-element-property :raw-value it) (org-element-property :raw-value it)))
(org-link-display-format 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) (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 (tag-list (if org-use-tag-inheritance
;; MAYBE: Use our own variable instead of `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) (if-let ((marker (or (org-element-property :org-hd-marker element)
@ -874,12 +942,21 @@ return an empty string."
(s-join ":" it) (s-join ":" it)
(s-wrap it ":") (s-wrap it ":")
(org-add-props it nil 'face 'org-tag)))) (org-add-props it nil 'face 'org-tag))))
;; (category (org-element-property :category element)) (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) (priority-string (-some->> (org-element-property :priority element)
(char-to-string) (char-to-string)
(format "[#%s]") (format "[#%s]")
(org-ql-view--add-priority-face))) (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) (when (org-is-habit-p)
(org-habit-parse-todo)))) (org-habit-parse-todo))))
(due-string (pcase (org-element-property :relative-due-date element) (due-string (pcase (org-element-property :relative-due-date element)
@ -893,6 +970,7 @@ return an empty string."
(concat " " it) (concat " " it)
(org-add-props it properties (org-add-props it properties
'org-agenda-type 'search 'org-agenda-type 'search
'org-category category
'todo-state todo-keyword 'todo-state todo-keyword
'tags tag-list 'tags tag-list
'org-habit-p habit-property))))) 'org-habit-p habit-property)))))
@ -978,7 +1056,9 @@ property."
(deadline-day-number (org-time-string-to-absolute (deadline-day-number (org-time-string-to-absolute
(org-element-timestamp-interpreter deadline-date 'ignore))) (org-element-timestamp-interpreter deadline-date 'ignore)))
(difference-days (- today-day-number deadline-day-number)) (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))) '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: (todo-keyword (org-element-property :todo-keyword element))
;; FIXME: Unused for now: (done-p (member todo-keyword org-done-keywords)) ;; FIXME: Unused for now: (done-p (member todo-keyword org-done-keywords))
@ -1023,11 +1103,11 @@ the variable), \"org-directory\" if it matches the value of
current buffer. Otherwise BUFFERS-FILES is returned unchanged." current buffer. Otherwise BUFFERS-FILES is returned unchanged."
;; Used in `org-ql-view--complete-buffers-files' and ;; Used in `org-ql-view--complete-buffers-files' and
;; `org-ql-view--header-line-format'. ;; `org-ql-view--header-line-format'.
(cl-labels ((expand-files (cl-labels ((expand-files (list)
(list) (--map (cl-typecase it (--map (cl-typecase it
(string (expand-file-name it)) (string (expand-file-name it))
(otherwise it)) (otherwise it))
list))) list)))
;; TODO: Test this more exhaustively. ;; TODO: Test this more exhaustively.
(pcase buffers-files (pcase buffers-files
((pred listp) ((pred listp)
@ -1049,10 +1129,10 @@ current buffer. Otherwise BUFFERS-FILES is returned unchanged."
(defun org-ql-view--complete-buffers-files () (defun org-ql-view--complete-buffers-files ()
"Return value for `org-ql-view-buffers-files' using completion." "Return value for `org-ql-view-buffers-files' using completion."
(cl-labels ((initial-input (cl-labels ((initial-input ()
() (when org-ql-view-buffers-files (when org-ql-view-buffers-files
(org-ql-view--contract-buffers-files (org-ql-view--contract-buffers-files
org-ql-view-buffers-files)))) org-ql-view-buffers-files))))
(if (and org-ql-view-buffers-files (if (and org-ql-view-buffers-files
(bufferp 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. ;; Buffers can't be input by name, so if the default value is a buffer, just use it.

557
org-ql.el
View file

@ -1,11 +1,11 @@
;;; org-ql.el --- Org Query Language, search command, and agenda-like view -*- lexical-binding: t; -*- ;;; org-ql.el --- Org Query Language, search command, and agenda-like view -*- lexical-binding: t; -*-
;; Copyright (C) 2017-2022 Adam Porter ;; Copyright (C) 2017-2023 Adam Porter
;; Author: Adam Porter <adam@alphapapa.net> ;; Author: Adam Porter <adam@alphapapa.net>
;; Url: https://github.com/alphapapa/org-ql ;; Url: https://github.com/alphapapa/org-ql
;; Version: 0.7.4 ;; Version: 0.9-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.1") (s "1.12.0") (transient "0.1") (ts "0.2-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 ;; Keywords: hypermedia, outlines, Org, agenda
;;; License: ;;; License:
@ -43,6 +43,7 @@
(require 'seq) (require 'seq)
(require 'subr-x) (require 'subr-x)
(require 'compat)
(require 'dash) (require 'dash)
(require 'map) (require 'map)
(require 'ts) (require 'ts)
@ -95,6 +96,12 @@ Necessary because of backward-incompatible changes in Org
`org-bracket-link-regexp' was marked as an obsolete alias for it, `org-bracket-link-regexp' was marked as an obsolete alias for it,
but the match groups were changed, so they are not compatible.") 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 ;;;; Variables
(defvar org-ql--today nil) (defvar org-ql--today nil)
@ -150,10 +157,9 @@ This list should not contain any duplicates."))
(defvar org-ql-regexp-part-ts-date (defvar org-ql-regexp-part-ts-date
(rx (repeat 4 digit) "-" (repeat 2 digit) "-" (repeat 2 digit) (rx (repeat 4 digit) "-" (repeat 2 digit) "-" (repeat 2 digit)
;; Day of week ;; Day of week
(optional " " (1+ alpha))) (optional " " (1+ (or alpha punct))))
"Matches the inner, date part of an Org timestamp, both active and inactive. "Matches the inner, date part of an Org timestamp, both active and inactive.
Also matches optional day-of-week. Used to build other timestamp Used to build other timestamp regexps.")
regexps.")
(defvar org-ql-regexp-part-ts-repeaters (defvar org-ql-regexp-part-ts-repeaters
;; Repeaters (not sure if the colon is necessary, but it's in the org.el one) ;; Repeaters (not sure if the colon is necessary, but it's in the org.el one)
@ -163,7 +169,8 @@ regexps.")
Includes leading space character.") Includes leading space character.")
(defvar org-ql-regexp-part-ts-time (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). "Matches the inner, time part of an Org timestamp (i.e. HH:MM).
Includes leading space character. Used to build other timestamp Includes leading space character. Used to build other timestamp
regexps.") regexps.")
@ -754,38 +761,38 @@ be coalesced."
;; can't be coalesced with it since they don't specify the same ;; 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. ;; language. That could be fixed, but it's probably not worth it.
(cl-labels ((rec (sexp) (cl-labels ((rec (sexp)
(pcase sexp (pcase sexp
(`(,(and boolean (or 'or 'not)) . ,sexps) (`(,(and boolean (or 'or 'not)) . ,sexps)
`(,boolean ,@(mapcar #'rec sexps))) `(,boolean ,@(mapcar #'rec sexps)))
(`(and . ,sexps) (`(and . ,sexps)
(anded sexps)) (anded sexps))
(_ sexp))) (_ sexp)))
(anded (sexps) (anded (sexps)
(let (anded-predicates new-sexp) (let (anded-predicates new-sexp)
(dolist (sexp sexps) (dolist (sexp sexps)
(pcase sexp (pcase sexp
(`(,(or 'or 'not) . ,_) (`(,(or 'or 'not) . ,_)
(push (rec sexp) new-sexp)) (push (rec sexp) new-sexp))
(`(,predicate . ,args) (`(,predicate . ,args)
(pcase-exhaustive (plist-get (alist-get predicate org-ql-predicates) :coalesce) (pcase-exhaustive (plist-get (alist-get predicate org-ql-predicates) :coalesce)
(`nil (push sexp new-sexp)) (`nil (push sexp new-sexp))
(`t (setf (alist-get predicate anded-predicates) (`t (setf (alist-get predicate anded-predicates)
(append (alist-get predicate anded-predicates) args))) (append (alist-get predicate anded-predicates) args)))
((and fn (pred functionp)) ((and fn (pred functionp))
(if-let (new-args (funcall fn (alist-get predicate anded-predicates) args)) (if-let (new-args (funcall fn (alist-get predicate anded-predicates) args))
(setf (alist-get predicate anded-predicates) new-args) (setf (alist-get predicate anded-predicates) new-args)
(push sexp new-sexp))))))) (push sexp new-sexp)))))))
(delq nil `(and ,@(nreverse new-sexp) ,@(nreverse anded-predicates)))))) (delq nil `(and ,@(nreverse new-sexp) ,@(nreverse anded-predicates))))))
(rec query))) (rec query)))
(defun org-ql--sanity-check-form (form) (defun org-ql--sanity-check-form (form)
"Signal error if any forms in FORM do not have preconditions met. "Signal error if any forms in FORM do not have preconditions met.
Or, when possible, fix the problem." Or, when possible, fix the problem."
(cl-flet ((check (symbol) (cl-flet ((check (symbol)
(pcase symbol (pcase symbol
('done (unless org-done-keywords ('done (unless org-done-keywords
;; NOTE: This check needs to be done from within the Org buffer being checked. ;; 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?")))))) (error "Variable `org-done-keywords' is nil. Are you running this from an Org buffer?"))))))
(cl-loop for elem in form (cl-loop for elem in form
if (consp elem) if (consp elem)
do (progn do (progn
@ -807,28 +814,27 @@ respectively."
(and "\\" (0+ "\\\\") (any "[]")) (and "\\" (0+ "\\\\") (any "[]"))
(and (1+ "\\") (not (any "[]"))))))) (and (1+ "\\") (not (any "[]")))))))
(cl-labels (cl-labels
((no-desc ((no-desc (match)
(match) (rx-to-string `(seq (or bol (1+ blank)) (rx-to-string `(seq (or bol (1+ blank))
"[[" ,link-target-part (regexp ,match) ,link-target-part "[[" ,link-target-part (regexp ,match) ,link-target-part
"]]"))) "]]")))
(match-both (match-both (description target)
(description target) (rx-to-string `(seq (or bol (1+ blank))
(rx-to-string `(seq (or bol (1+ blank)) "[[" ,link-target-part (regexp ,target) ,link-target-part
"[[" ,link-target-part (regexp ,target) ,link-target-part "][" (*? anything) (regexp ,description) (*? anything)
"][" (*? anything) (regexp ,description) (*? anything) "]]")))
"]]")))
;; Note that these actually allow empty descriptions ;; Note that these actually allow empty descriptions
;; or targets, depending on what they are matching. ;; or targets, depending on what they are matching.
(match-desc (match-desc (match)
(match) (rx-to-string `(seq (or bol (1+ blank)) (rx-to-string `(seq (or bol (1+ blank))
"[[" ,link-target-part "[[" ,link-target-part
"][" (*? anything) (regexp ,match) (*? anything) "][" (*? anything) (regexp ,match) (*? anything)
"]]"))) "]]")))
(match-target (match-target (match)
(match) (rx-to-string `(seq (or bol (1+ blank)) (rx-to-string `(seq (or bol (1+ blank))
"[[" ,link-target-part (regexp ,match) ,link-target-part "[[" ,link-target-part (regexp ,match) ,link-target-part
"][" (*? anything) "][" (*? anything)
"]]")))) "]]"))))
(cond (description-or-target (cond (description-or-target
(rx-to-string `(or (regexp ,(no-desc description-or-target)) (rx-to-string `(or (regexp ,(no-desc description-or-target))
(regexp ,(match-desc description-or-target)) (regexp ,(match-desc description-or-target))
@ -883,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 ;; NOTE: The pcases check for both t/nil symbols and strings, because the
;; string queries always return keyword arguments' values as strings. ;; string queries always return keyword arguments' values as strings.
(cl-macrolet ((clocked (&key from to on) (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)) (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)) (deadline (&key from to on (with-time 'not-found))
`(org-ql--predicate-deadline `(org-ql--predicate-deadline
:from ,from :to ,to :with-time ',with-time :from ,from :to ,to :with-time ',with-time
:regexp ,(pcase-exhaustive with-time :regexp ,(pcase-exhaustive with-time
((or 't "t") org-ql-regexp-deadline-with-time) ((or 't "t") org-ql-regexp-deadline-with-time)
((or 'nil "nil") org-ql-regexp-deadline-without-time) ((or 'nil "nil") org-ql-regexp-deadline-without-time)
('not-found org-ql-regexp-deadline)))) ('not-found org-ql-regexp-deadline))))
(planning (&key from to on (with-time 'not-found)) (planning (&key from to on (with-time 'not-found))
`(org-ql--predicate-planning `(org-ql--predicate-planning
:from ,from :to ,to :with-time ',with-time :from ,from :to ,to :with-time ',with-time
:regexp ,(pcase-exhaustive with-time :regexp ,(pcase-exhaustive with-time
((or 't "t") org-ql-regexp-planning-with-time) ((or 't "t") org-ql-regexp-planning-with-time)
((or 'nil "nil") org-ql-regexp-planning-without-time) ((or 'nil "nil") org-ql-regexp-planning-without-time)
('not-found org-ql-regexp-planning)))) ('not-found org-ql-regexp-planning))))
(scheduled (&key from to on (with-time 'not-found)) (scheduled (&key from to on (with-time 'not-found))
`(org-ql--predicate-scheduled `(org-ql--predicate-scheduled
:from ,from :to ,to :with-time ',with-time :from ,from :to ,to :with-time ',with-time
:regexp ,(pcase-exhaustive with-time :regexp ,(pcase-exhaustive with-time
((or 't "t") org-ql-regexp-scheduled-with-time) ((or 't "t") org-ql-regexp-scheduled-with-time)
((or 'nil "nil") org-ql-regexp-scheduled-without-time) ((or 'nil "nil") org-ql-regexp-scheduled-without-time)
('not-found org-ql-regexp-scheduled)))) ('not-found org-ql-regexp-scheduled))))
(ts (&key from to on (type 'both) (with-time 'not-found)) (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. ;; 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. ;; MAYBE: Move the :regexp handling out of this macrolet and into the normalizer.
`(org-ql--predicate-ts `(org-ql--predicate-ts
:from ,from :to ,to :with-time ',with-time :from ,from :to ,to :with-time ',with-time
:regexp ,(pcase type :regexp ,(pcase type
((or 'nil 'both) (pcase-exhaustive with-time ((or 'nil 'both) (pcase-exhaustive with-time
((or 't "t") org-ql-regexp-ts-both-with-time) ((or 't "t") org-ql-regexp-ts-both-with-time)
((or 'nil "nil") org-ql-regexp-ts-both-without-time) ((or 'nil "nil") org-ql-regexp-ts-both-without-time)
('not-found org-ql-regexp-ts-both))) ('not-found org-ql-regexp-ts-both)))
('active (pcase-exhaustive with-time ('active (pcase-exhaustive with-time
((or 't "t") org-ql-regexp-ts-active-with-time) ((or 't "t") org-ql-regexp-ts-active-with-time)
((or 'nil "nil") org-ql-regexp-ts-active-without-time) ((or 'nil "nil") org-ql-regexp-ts-active-without-time)
('not-found org-ql-regexp-ts-active))) ('not-found org-ql-regexp-ts-active)))
('inactive (pcase-exhaustive with-time ('inactive (pcase-exhaustive with-time
((or 't "t") org-ql-regexp-ts-inactive-with-time) ((or 't "t") org-ql-regexp-ts-inactive-with-time)
((or 'nil "nil") org-ql-regexp-ts-inactive-without-time) ((or 'nil "nil") org-ql-regexp-ts-inactive-without-time)
('not-found org-ql-regexp-ts-inactive))))))) ('not-found org-ql-regexp-ts-inactive)))))))
,query))))) ,query)))))
;;;;; String query parsing ;;;;; String query parsing
@ -1041,21 +1047,21 @@ This function is defined by calling
`org-ql--define-normalize-query-fn', which uses normalizer forms `org-ql--define-normalize-query-fn', which uses normalizer forms
defined in `org-ql-predicates' by calling `org-ql-defpred'." defined in `org-ql-predicates' by calling `org-ql-defpred'."
(cl-labels ((rec (element) (cl-labels ((rec (element)
(pcase element (pcase element
(`(or . ,clauses) `(or ,@(mapcar #'rec clauses))) (`(or . ,clauses) `(or ,@(mapcar #'rec clauses)))
(`(and . ,clauses) `(and ,@(mapcar #'rec clauses))) (`(and . ,clauses) `(and ,@(mapcar #'rec clauses)))
(`(not . ,clauses) `(not ,@(mapcar #'rec clauses))) (`(not . ,clauses) `(not ,@(mapcar #'rec clauses)))
(`(when ,condition . ,clauses) `(when ,(rec condition) (`(when ,condition . ,clauses) `(when ,(rec condition)
,@(mapcar #'rec clauses))) ,@(mapcar #'rec clauses)))
(`(unless ,condition . ,clauses) `(unless ,(rec condition) (`(unless ,condition . ,clauses) `(unless ,(rec condition)
,@(mapcar #'rec clauses))) ,@(mapcar #'rec clauses)))
;; TODO: Combine (regexp) when appropriate (i.e. inside an OR, not an AND). ;; TODO: Combine (regexp) when appropriate (i.e. inside an OR, not an AND).
((pred stringp) `(,org-ql-default-predicate ,element)) ((pred stringp) `(,org-ql-default-predicate ,element))
,@normalizer-patterns ,@normalizer-patterns
;; Any other form: passed through unchanged. ;; Any other form: passed through unchanged.
(_ element)))) (_ element))))
;; Repeat normalization until result doesn't change (limiting to 10 in case of an infinite-loop bug). ;; 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 (cl-loop with limit = 10 and count = 0
for new-query = (rec query) for new-query = (rec query)
@ -1108,18 +1114,21 @@ defined in `org-ql-predicates' by calling `org-ql-defpred'."
(_ (let ((preamble-case-fold t) (_ (let ((preamble-case-fold t)
org-ql-preamble) org-ql-preamble)
(cl-labels ((rec (element) (cl-labels ((rec (element)
(or (when org-ql-preamble (or (when org-ql-preamble
;; Only one preamble is allowed ;; Only one preamble is allowed
element) element)
(pcase element (pcase element
(`(or _) 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) (`(and . ,rest)
(let ((clauses (mapcar #'rec rest))) (let ((clauses (mapcar #'rec rest)))
`(and ,@(-non-nil clauses)))) `(and ,@(-non-nil clauses))))
(_ element))))) (_ element)))))
(setq query (pcase (mapcar #'rec (list query)) (setq query (pcase (mapcar #'rec (list query))
((or `(nil) ((or `(nil)
`((nil)) `((nil))
@ -1135,7 +1144,7 @@ defined in `org-ql-predicates' by calling `org-ql-defpred'."
(byte-compile 'org-ql--query-preamble))) (byte-compile 'org-ql--query-preamble)))
(cl-defmacro org-ql-defpred (name args docstring &key body preambles normalizers coalesce) (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 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 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 created for NAME, not for aliases, so a normalizer should be used
@ -1180,7 +1189,7 @@ to variables bound in the pattern:
:case-fold Bound to `case-fold-search' around the regexp search. :case-fold Bound to `case-fold-search' around the regexp search.
:query Expression which should replace the query expression, :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 regexp is insufficient to determine whether a
heading matches, in which case the predicate's body heading matches, in which case the predicate's body
needs to be tested on the heading). If the regexp needs to be tested on the heading). If the regexp
@ -1207,7 +1216,7 @@ e.g. a predicate takes keyword arguments, so arguments to
multiple calls can't be simply appended.) multiple calls can't be simply appended.)
For convenience, within the `pcase' patterns, the symbol 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 pattern matching any of the predicate's name and aliases. For
example, if NAME were: example, if NAME were:
@ -1215,13 +1224,13 @@ example, if NAME were:
Then if NORMALIZERS were: Then if NORMALIZERS were:
((`(,predicate-names . ,args) ((\\=`(,predicate-names . ,args)
`(heading ,@args))) \\=`(heading ,@args)))
It would be expanded to: It would be expanded to:
((`(,(or 'heading 'h) . ,args) ((\\=`(,(or \\='heading \\='h) . ,args)
`(heading ,@args)))" \\=`(heading ,@args)))"
;; FIXME: Update defpred tutorial to include :coalesce. ;; FIXME: Update defpred tutorial to include :coalesce.
;; NOTE: The debug form works, completely! For example, use `edebug-defun' ;; NOTE: The debug form works, completely! For example, use `edebug-defun'
@ -1455,40 +1464,16 @@ Org effort string, like \"5\" or \"0:05\"."
(list :regexp (rx bol (0+ space) ":STYLE:" (1+ space) "habit" (0+ space) eol)))) (list :regexp (rx bol (0+ space) ":STYLE:" (1+ space) "habit" (0+ space) eol))))
:body (org-is-habit-p)) :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. "Return non-nil if current entry's heading matches all STRINGS.
Matching is done case-insensitively." Matching is done case-insensitively."
:coalesce t :coalesce t
:normalizers ((`(,predicate-names . ,args) :normalizers ((`(,predicate-names . ,args)
;; "h" alias. ;; NOTE: Each string argument must be converted to a regexp
`(heading ,@args))) ;; for testing by the body, so we just normalize to the
;; TODO: Adjust regexp to avoid matching in tag list. ;; `heading-regexp' predicate, leaving this predicate as
:preambles ((`(,predicate-names) ;; one that merely regexp-quotes its arguments.
;; This clause protects against the case in which the `(heading-regexp ,@(mapcar #'regexp-quote args)))))
;; 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 ,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)))
(org-ql-defpred (heading-regexp h*) (&rest regexps) (org-ql-defpred (heading-regexp h*) (&rest regexps)
"Return non-nil if current entry's heading matches all REGEXPS (regexp strings). "Return non-nil if current entry's heading matches all REGEXPS (regexp strings).
@ -1552,7 +1537,8 @@ COMPARATOR may be `<', `<=', `>', or `>='."
;; is "h:" while the user is typing. ;; is "h:" while the user is typing.
(list :regexp (rx bol (1+ "*") " ") (list :regexp (rx bol (1+ "*") " ")
:case-fold t)) :case-fold t))
(`(,predicate-names ,comparator-or-num ,num) ((and `(,predicate-names ,comparator-or-num ,num)
(guard (numberp num)))
(let ((repeat (pcase comparator-or-num (let ((repeat (pcase comparator-or-num
('< `(repeat 1 ,(1- num) "*")) ('< `(repeat 1 ,(1- num) "*"))
('<= `(repeat 1 ,num "*")) ('<= `(repeat 1 ,num "*"))
@ -1561,7 +1547,8 @@ COMPARATOR may be `<', `<=', `>', or `>='."
((pred integerp) `(repeat ,comparator-or-num ,num "*"))))) ((pred integerp) `(repeat ,comparator-or-num ,num "*")))))
(list :regexp (rx-to-string `(seq bol ,repeat " ") t) (list :regexp (rx-to-string `(seq bol ,repeat " ") t)
:case-fold t))) :case-fold t)))
(`(,predicate-names ,num) ((and `(,predicate-names ,num)
(guard (numberp num)))
(list :regexp (rx-to-string `(seq bol (repeat ,num "*") " ") t) (list :regexp (rx-to-string `(seq bol (repeat ,num "*") " ") t)
:case-fold t))) :case-fold t)))
;; NOTE: It might be necessary to take into account `org-odd-levels'; see docstring for ;; NOTE: It might be necessary to take into account `org-odd-levels'; see docstring for
@ -1639,11 +1626,15 @@ any link is found."
(or (null description) (or (null description)
(string-match-p description (match-string org-ql-link-description-group))))) (string-match-p description (match-string org-ql-link-description-group)))))
(_ (if (and description target) (_ (if (and description target)
(and (string-match-p target (match-string 1)) (and (and (match-string 1)
(string-match-p description (match-string org-ql-link-description-group))) (string-match-p target (match-string 1)))
(or (string-match-p description-or-target (match-string 1)) (and (match-string org-ql-link-description-group)
(string-match-p description-or-target (string-match-p description (match-string org-ql-link-description-group))))
(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) (org-ql-defpred (rifle smart) (&rest strings)
"Return non-nil if each of strings is found in the entry or its outline path. "Return non-nil if each of strings is found in the entry or its outline path.
@ -1817,34 +1808,62 @@ interpreted as nil or non-nil)."
;; predicate test for whether an entry has local ;; predicate test for whether an entry has local
;; properties when no arguments are given. ;; properties when no arguments are given.
(list 'property "")) (list 'property ""))
(`(,predicate-names ,property ,value . ,plist) (`(,predicate-names ,property)
;; Convert keyword property arguments to strings. Non-sexp ;; Convert keyword property arguments to strings. Non-sexp
;; queries result in keyword property arguments (because to do ;; queries result in keyword property arguments (because to do
;; otherwise would require ugly special-casing in the parsing). ;; otherwise would require ugly special-casing in the parsing).
(when (keywordp property) (when (keywordp property)
(setf property (substring (symbol-name property) 1))) (setf property (substring (symbol-name property) 1)))
(list 'property property value (list 'property property))
:inherit (if (plist-member plist :inherit) (`(,predicate-names ,property . ,rest)
(plist-get plist :inherit) (pcase rest
org-use-property-inheritance)))) (`(,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: Should case folding be disabled for properties? What about values?
;; MAYBE: Support (property) without args. ;; MAYBE: Support (property) without args.
;; NOTE: When inheritance is enabled, the preamble can't be used, ;; NOTE: When inheritance is enabled, the preamble can't be used,
;; which will make the search slower. ;; which will make the search slower.
:preambles ((`(,predicate-names ,property ,value . ,(map :inherit)) :preambles (((and `(,predicate-names ,property ,value)
(guard (atom value)))
;; We do NOT return nil, because the predicate still needs to be tested, ;; 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. ;; because the regexp could match a string not inside a property drawer.
(list :regexp (unless inherit (list :regexp (rx-to-string `(seq bol (0+ space) ":" ,property ":"
(rx-to-string `(seq bol (0+ space) ":" ,property ":" (1+ space) ,value (0+ space) eol))
(1+ space) ,value (0+ space) eol)))
:query query)) :query query))
(`(,predicate-names ,property . ,(map :inherit)) ((and `(,predicate-names ,property ,value . ,plist)
;; We do NOT return nil, because the predicate still needs to be tested, (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. ;; because the regexp could match a string not inside a property drawer.
;; NOTE: The preamble only matches if there appears to be a value. ;; NOTE: The preamble only matches if there appears to be a value.
;; A line like ":ID: " without any other text does not match. ;; A line like ":ID: " without any other text does not match.
(list :regexp (unless inherit (list :regexp (unless (plist-get plist :inherit)
(rx-to-string `(seq bol (0+ space) ":" ,property ":" (1+ space) (rx-to-string `(seq bol (0+ space) ":" ,property ":" (1+ space)
(minimal-match (1+ not-newline)) eol))) (minimal-match (1+ not-newline)) eol)))
:query query))) :query query)))
@ -1856,7 +1875,7 @@ interpreted as nil or non-nil)."
;; Check that PROPERTY exists ;; Check that PROPERTY exists
(org-ql--value-at (org-ql--value-at
(point) (lambda () (point) (lambda ()
(org-entry-get (point) property)))) (org-entry-get (point) property inherit))))
(_ (_
;; Check that PROPERTY has VALUE. ;; Check that PROPERTY has VALUE.
@ -1973,7 +1992,7 @@ language. Matching is done case-insensitively."
(point))) (point)))
(contents-end (progn (contents-end (progn
(goto-char (match-end 0)) (goto-char (match-end 0))
(point-at-bol)))) (pos-bol))))
(cl-loop for re in regexps (cl-loop for re in regexps
do (goto-char contents-beg) do (goto-char contents-beg)
always (re-search-forward re contents-end t)))))))))) always (re-search-forward re contents-end t))))))))))
@ -1983,8 +2002,8 @@ language. Matching is done case-insensitively."
Tests both inherited and local tags." Tests both inherited and local tags."
;; MAYBE: -all versions for inherited and local. ;; MAYBE: -all versions for inherited and local.
:body (cl-macrolet ((tags-p (tags) :body (cl-macrolet ((tags-p (tags)
`(and ,tags `(and ,tags
(not (eq 'org-ql-nil ,tags))))) (not (eq 'org-ql-nil ,tags)))))
(-let* (((inherited local) (org-ql--tags-at (point)))) (-let* (((inherited local) (org-ql--tags-at (point))))
(cl-typecase tags (cl-typecase tags
(null (or (tags-p inherited) (null (or (tags-p inherited)
@ -2009,8 +2028,8 @@ If TAGS is nil, return non-nil if heading has any inherited tags."
:normalizers ((`(,predicate-names . ,tags) :normalizers ((`(,predicate-names . ,tags)
`(tags-inherited ,@tags))) `(tags-inherited ,@tags)))
:body (cl-macrolet ((tags-p (tags) :body (cl-macrolet ((tags-p (tags)
`(and ,tags `(and ,tags
(not (eq 'org-ql-nil ,tags))))) (not (eq 'org-ql-nil ,tags)))))
(-let* (((inherited _) (org-ql--tags-at (point)))) (-let* (((inherited _) (org-ql--tags-at (point))))
(cl-typecase tags (cl-typecase tags
(null (tags-p inherited)) (null (tags-p inherited))
@ -2030,8 +2049,8 @@ If TAGS is nil, return non-nil if heading has any local tags."
t) t)
:query t))) :query t)))
:body (cl-macrolet ((tags-p (tags) :body (cl-macrolet ((tags-p (tags)
`(and ,tags `(and ,tags
(not (eq 'org-ql-nil ,tags))))) (not (eq 'org-ql-nil ,tags)))))
(-let* (((_ local) (org-ql--tags-at (point)))) (-let* (((_ local) (org-ql--tags-at (point))))
(cl-typecase tags (cl-typecase tags
(null (tags-p local)) (null (tags-p local))
@ -2044,8 +2063,8 @@ Tests both inherited and local tags."
:normalizers ((`(,predicate-names . ,regexps) :normalizers ((`(,predicate-names . ,regexps)
`(tags-regexp ,@regexps))) `(tags-regexp ,@regexps)))
:body (cl-macrolet ((tags-p (tags) :body (cl-macrolet ((tags-p (tags)
`(and ,tags `(and ,tags
(not (eq 'org-ql-nil ,tags))))) (not (eq 'org-ql-nil ,tags)))))
(-let* (((inherited local) (org-ql--tags-at (point)))) (-let* (((inherited local) (org-ql--tags-at (point))))
(cl-typecase regexps (cl-typecase regexps
(null (or (tags-p inherited) (null (or (tags-p inherited)
@ -2095,7 +2114,7 @@ With KEYWORDS, return non-nil if its keyword is one of KEYWORDS."
:normalizers ((`(,predicate-names :normalizers ((`(,predicate-names
;; Avoid infinitely compiling already-compiled functions. ;; Avoid infinitely compiling already-compiled functions.
,(and query (guard (not (byte-code-function-p query))))) ,(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)))) (`(,predicate-names) '(ancestors (lambda () t))))
:body :body
(org-with-wide-buffer (org-with-wide-buffer
@ -2107,7 +2126,7 @@ With KEYWORDS, return non-nil if its keyword is one of KEYWORDS."
:normalizers ((`(,predicate-names :normalizers ((`(,predicate-names
;; Avoid infinitely compiling already-compiled functions. ;; Avoid infinitely compiling already-compiled functions.
,(and query (guard (not (byte-code-function-p query))))) ,(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)))) (`(,predicate-names) '(parent (lambda () t))))
:body :body
(org-with-wide-buffer (org-with-wide-buffer
@ -2393,12 +2412,12 @@ any planning prefix); it defaults to 0 (i.e. the whole regexp)."
:body :body
(cl-macrolet ((next-timestamp () (cl-macrolet ((next-timestamp ()
`(when (re-search-forward regexp limit t) `(when (re-search-forward regexp limit t)
(ts-parse-org (match-string match-group)))) (ts-parse-org (match-string match-group))))
(test-timestamps (pred-form) (test-timestamps (pred-form)
`(cl-loop for next-ts = (next-timestamp) `(cl-loop for next-ts = (next-timestamp)
while next-ts while next-ts
thereis ,pred-form))) thereis ,pred-form)))
(save-excursion (save-excursion
(cond ((not (or from to)) (re-search-forward regexp limit t)) (cond ((not (or from to)) (re-search-forward regexp limit t))
((and from to) (test-timestamps (ts-in from to next-ts))) ((and from to) (test-timestamps (ts-in from to next-ts)))
@ -2424,27 +2443,27 @@ PREDICATES is a list of one or more sorting methods, including:
`deadline', `scheduled', `closed' and `priority'." `deadline', `scheduled', `closed' and `priority'."
;; MAYBE: Use macrolet instead of flet. ;; MAYBE: Use macrolet instead of flet.
(cl-flet* ((sorter (symbol) (cl-flet* ((sorter (symbol)
(pcase symbol (pcase symbol
((or 'deadline 'scheduled 'closed) ((or 'deadline 'scheduled 'closed)
(apply-partially #'org-ql--date-type< (intern (concat ":" (symbol-name symbol))))) (apply-partially #'org-ql--date-type< (intern (concat ":" (symbol-name symbol)))))
;; TODO: Rename `date' to `planning'. `date' should be something else. ;; TODO: Rename `date' to `planning'. `date' should be something else.
('date #'org-ql--date<) ('date #'org-ql--date<)
('priority #'org-ql--priority<) ('priority #'org-ql--priority<)
('random (lambda (&rest _ignore) ('random (lambda (&rest _ignore)
(= 0 (random 2)))) (= 0 (random 2))))
;; NOTE: reverse and todo are handled below. ;; NOTE: reverse and todo are handled below.
;; TODO: Add more. ;; TODO: Add more.
(_ (user-error "Invalid sorting predicate: %s" symbol)))) (_ (user-error "Invalid sorting predicate: %s" symbol))))
(sort-by-todo-keyword (items) (sort-by-todo-keyword (items)
(let* ((grouped-items (--group-by (when-let (keyword (org-element-property :todo-keyword it)) (let* ((grouped-items (--group-by (when-let (keyword (org-element-property :todo-keyword it))
(substring-no-properties keyword)) (substring-no-properties keyword))
items)) items))
(sorted-groups (cl-sort grouped-items #'< (sorted-groups (cl-sort grouped-items #'<
:key (lambda (keyword) :key (lambda (keyword)
(or (cl-position (car keyword) org-todo-keywords-1 :test #'string=) (or (cl-position (car keyword) org-todo-keywords-1 :test #'string=)
;; Put at end of list if not found ;; Put at end of list if not found
(1+ (length org-todo-keywords-1))))))) (1+ (length org-todo-keywords-1)))))))
(-flatten-n 1 (-map #'cdr sorted-groups))))) (-flatten-n 1 (-map #'cdr sorted-groups)))))
(dolist (pred predicates) (dolist (pred predicates)
(setq items (pcase pred (setq items (pcase pred
;; NOTE: Using `reverse' instead of `nreverse' because my gut ;; NOTE: Using `reverse' instead of `nreverse' because my gut
@ -2469,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. "Return non-nil if A's deadline or scheduled property is earlier than B's.
Deadline is considered before scheduled." Deadline is considered before scheduled."
(cl-macrolet ((ts (item) (cl-macrolet ((ts (item)
`(or (org-element-property :deadline ,item) `(or (org-element-property :deadline ,item)
(org-element-property :scheduled ,item)))) (org-element-property :scheduled ,item))))
(org-ql--org-timestamp-element< (ts a) (ts b)))) (org-ql--org-timestamp-element< (ts a) (ts b))))
(defun org-ql--org-timestamp-element< (a b) (defun org-ql--org-timestamp-element< (a b)
"Return non-nil if A's date element is earlier than B's. "Return non-nil if A's date element is earlier than B's.
A and B are Org timestamp elements." A and B are Org timestamp elements."
(cl-macrolet ((ts (ts) (cl-macrolet ((ts (ts)
`(when ,ts `(when ,ts
(org-timestamp-format ,ts "%s")))) (org-ql--org-timestamp-format ,ts "%s"))))
(let* ((a-ts (ts a)) (let* ((a-ts (ts a))
(b-ts (ts b))) (b-ts (ts b)))
(cond ((and a-ts b-ts) (cond ((and a-ts b-ts)
@ -2490,7 +2509,7 @@ A and B are Org timestamp elements."
"Return non-nil if A's priority is higher than B's. "Return non-nil if A's priority is higher than B's.
A and B are Org headline elements." A and B are Org headline elements."
(cl-macrolet ((priority (item) (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. ;; NOTE: Priorities are numbers in Org elements. This might differ from the priority selector logic.
(let ((a-priority (priority a)) (let ((a-priority (priority a))
(b-priority (priority b))) (b-priority (priority b)))
@ -2518,66 +2537,66 @@ element should be a regexp string."
If QUERY can't be converted to a string, return nil." 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? ;; This started out pretty simple...but at least it's not just one long function, right?
(cl-labels ((complex-p (query) (cl-labels ((complex-p (query)
(or (contains-p 'or query) (or (contains-p 'or query)
(contains-p 'ancestors query) (contains-p 'ancestors query)
(contains-p 'children query) (contains-p 'children query)
(contains-p 'descendants query) (contains-p 'descendants query)
(contains-p 'parent query))) (contains-p 'parent query)))
(contains-p (symbol list) (contains-p (symbol list)
(cl-loop for element in list (cl-loop for element in list
thereis (or (eq symbol element) thereis (or (eq symbol element)
(and (listp element) (and (listp element)
(contains-p symbol element))))) (contains-p symbol element)))))
(format-args (format-args (args)
(args) (let (non-paired paired next-keyword) (let (non-paired paired next-keyword)
(cl-loop for arg in args (cl-loop for arg in args
do (cond (next-keyword (push (cons next-keyword arg) paired) do (cond (next-keyword (push (cons next-keyword arg) paired)
(setf next-keyword nil)) (setf next-keyword nil))
((keywordp arg) (setf next-keyword (substring (symbol-name arg) 1))) ((keywordp arg) (setf next-keyword (substring (symbol-name arg) 1)))
(t (push arg non-paired)))) (t (push arg non-paired))))
(string-join (append (mapcar #'format-atom non-paired) (string-join (append (mapcar #'format-atom non-paired)
(nreverse (--map (format "%s=%s" (car it) (cdr it)) (nreverse (--map (format "%s=%s" (car it) (cdr it))
paired))) paired)))
","))) ",")))
(format-atom (format-atom (atom)
(atom) (cl-typecase atom (cl-typecase atom
(string (if (string-match (rx space) atom) (string (if (string-match (rx space) atom)
(format "%S" atom) (format "%S" atom)
(format "%s" atom))) (format "%s" atom)))
(t (format "%s" atom)))) (t (format "%s" atom))))
(format-form (format-form (form)
(form) (pcase form (pcase form
(`(not . (,rest)) (concat "!" (format-form rest))) (`(not . (,rest)) (concat "!" (format-form rest)))
(`(priority . ,_) (format-priority form)) (`(priority . ,_) (format-priority form))
;; FIXME: Convert (src) queries to non-sexp form...someday... ;; FIXME: Convert (src) queries to non-sexp form...someday...
(`(src . ,_) (user-error "Converting (src ...) queries to non-sexp form is not implemented")) (`(src . ,_) (user-error "Converting (src ...) queries to non-sexp form is not implemented"))
(_ (pcase-let* ((`(,pred . ,args) form) (_ (pcase-let* ((`(,pred . ,args) form)
(args-string (pcase args (args-string (pcase args
('() "") ('() "")
((guard (= 1 (length args))) (format "%s" (car args))) ((guard (= 1 (length args))) (format "%s" (car args)))
(_ (format-args args))))) (_ (format-args args)))))
(format "%s:%s" pred args-string))))) (format "%s:%s" pred args-string)))))
(format-and (format-and (form)
(form) (pcase-let* ((`(and . ,rest) form)) (pcase-let* ((`(and . ,rest) form))
(string-join (mapcar #'format-form rest) " "))) (string-join (mapcar #'format-form rest) " ")))
(format-priority (format-priority (form)
(form) (pcase-let* ((`(priority . ,rest) form) (pcase-let* ((`(priority . ,rest) form)
(args (pcase rest (args (pcase rest
(`(,(and comparator (or '< '<= '> '>= '=)) ,letter) (`(,(and comparator (or '< '<= '> '>= '=)) ,letter)
(priority-letters comparator letter)) (priority-letters comparator letter))
(_ rest)))) (_ rest))))
(concat "priority:" (string-join args ",")))) (concat "priority:" (string-join args ","))))
(priority-letters (priority-letters (comparator letter)
(comparator letter) (let* ((char (string-to-char (upcase (symbol-name letter)))) (let* ((char (string-to-char (upcase (symbol-name letter))))
(numeric-priorities '(?A ?B ?C)) (numeric-priorities '(?A ?B ?C))
;; NOTE: The comparator inversion is intentional. ;; NOTE: The comparator inversion is intentional.
(others (pcase comparator (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)) ('> (--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)))) (mapcar #'char-to-string others))))
;; FIXME: Error out for ts structs passed to `ts' predicate (very unlikely to be linked to). ;; FIXME: Error out for ts structs passed to `ts' predicate (very unlikely to be linked to).
(unless (complex-p query) (unless (complex-p query)
(pcase query (pcase query

View file

@ -26,6 +26,7 @@ and saved views.
* Installation:: * Installation::
* Usage:: * Usage::
* Changelog:: * Changelog::
* Development::
* Notes:: * Notes::
* License:: * License::
@ -48,6 +49,7 @@ Usage
Commands Commands
* org-ql-find:: * org-ql-find::
* org-ql-open-link::
* org-ql-refile:: * org-ql-refile::
* org-ql-search:: * org-ql-search::
* helm-org-ql:: * helm-org-ql::
@ -71,6 +73,18 @@ Functions / Macros
Changelog Changelog
* 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.4: 074.
* 0.7.3: 073. * 0.7.3: 073.
* 0.7.2: 072. * 0.7.2: 072.
@ -102,6 +116,14 @@ Changelog
* 0.2: 02. * 0.2: 02.
* 0.1: 01. * 0.1: 01.
0.9-pre
* helm-org-ql: helm-org-ql (1).
Development
* Copyright assignment::
Notes Notes
* Comparison with Org Agenda searches:: * Comparison with Org Agenda searches::
@ -114,7 +136,7 @@ File: README.info, Node: Contents, Next: Screenshots, Prev: Top, Up: Top
1 Contents 1 Contents
********** **********
• • • • • • • •
 
File: README.info, Node: Screenshots, Next: Installation, Prev: Contents, Up: Top File: README.info, Node: Screenshots, Next: Installation, Prev: Contents, Up: Top
@ -207,6 +229,7 @@ File: README.info, Node: Commands, Next: Queries, Up: Usage
* Menu: * Menu:
* org-ql-find:: * org-ql-find::
* org-ql-open-link::
* org-ql-refile:: * org-ql-refile::
* org-ql-search:: * org-ql-search::
* helm-org-ql:: * helm-org-ql::
@ -216,7 +239,7 @@ File: README.info, Node: Commands, Next: Queries, Up: Usage
* org-ql-sparse-tree:: * org-ql-sparse-tree::
 
File: README.info, Node: org-ql-find, Next: org-ql-refile, Up: Commands File: README.info, Node: org-ql-find, Next: org-ql-open-link, Up: Commands
4.1.1 org-ql-find 4.1.1 org-ql-find
----------------- -----------------
@ -227,13 +250,40 @@ _Note: These commands use ._
completion facilities with an Org QL query: completion facilities with an Org QL query:
org-ql-find searches in the current buffer. 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-agenda searches in (org-agenda-files).
org-ql-find-in-org-directory searches in org-directory. org-ql-find-in-org-directory searches in org-directory.
 Note that these commands are compatible with Embark
File: README.info, Node: org-ql-refile, Next: org-ql-search, Prev: org-ql-find, Up: Commands (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-refile 
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 This command refiles the current Org entry to one selected by searching
@ -243,7 +293,7 @@ with Org QL completion. It searches files listed in
 
File: README.info, Node: org-ql-search, Next: helm-org-ql, Prev: org-ql-refile, Up: Commands File: README.info, Node: org-ql-search, Next: helm-org-ql, Prev: org-ql-refile, Up: Commands
4.1.3 org-ql-search 4.1.4 org-ql-search
------------------- -------------------
_Note: This command supports both sexp queries and ._ _Note: This command supports both sexp queries and ._
@ -283,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 all commands. (It works to the extent it does because the appropriate
text properties are placed on each item, imitating an Agenda buffer.) 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 File: README.info, Node: helm-org-ql, Next: org-ql-view, Prev: org-ql-search, Up: Commands
4.1.4 helm-org-ql 4.1.5 helm-org-ql
----------------- -----------------
_Note: This command uses . It is available separately in the package _Note: This command uses . It is available separately in the package
@ -300,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 File: README.info, Node: org-ql-view, Next: org-ql-view-sidebar, Prev: helm-org-ql, Up: Commands
4.1.5 org-ql-view 4.1.6 org-ql-view
----------------- -----------------
Choose and display a view stored in org-ql-views. Choose and display a view stored in org-ql-views.
@ -315,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 File: README.info, Node: org-ql-view-sidebar, Next: org-ql-view-recent-items, Prev: org-ql-view, Up: Commands
4.1.6 org-ql-view-sidebar 4.1.7 org-ql-view-sidebar
------------------------- -------------------------
Show a sidebar window listing views stored in org-ql-views for easy Show a sidebar window listing views stored in org-ql-views for easy
@ -325,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 File: README.info, Node: org-ql-view-recent-items, Next: org-ql-sparse-tree, Prev: org-ql-view-sidebar, Up: Commands
4.1.7 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. Show items in FILES from last DAYS days with timestamps of TYPE.
@ -336,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 File: README.info, Node: org-ql-sparse-tree, Prev: org-ql-view-recent-items, Up: Commands
4.1.8 org-ql-sparse-tree 4.1.9 org-ql-sparse-tree
------------------------ ------------------------
Arguments: (query &key keep-previous (buffer (current-buffer))) Arguments: (query &key keep-previous (buffer (current-buffer)))
@ -488,9 +543,8 @@ Arguments are listed next to predicate names, where applicable.
Return non-nil if current entry has PROPERTY (a string), and Return non-nil if current entry has PROPERTY (a string), and
optionally VALUE (a string). If INHERIT is nil, only match optionally VALUE (a string). If INHERIT is nil, only match
entries with PROPERTY set on the entry; if t, also match entries entries with PROPERTY set on the entry; if t, also match entries
with inheritance. If INHERIT is not specified, use the Boolean with inheritance. If INHERIT is not specified, use the value of
value of org-use-property-inheritance, which see (i.e. it is org-use-property-inheritance, which see.
only interpreted as nil or non-nil).
regexp (&rest regexps) regexp (&rest regexps)
Return non-nil if current entry matches all of REGEXPS (regexp Return non-nil if current entry matches all of REGEXPS (regexp
strings). Matches against entire entry, from beginning of its strings). Matches against entire entry, from beginning of its
@ -981,7 +1035,7 @@ File: README.info, Node: Tips, Prev: Links, Up: Usage
(https://github.com/alphapapa/burly.el). (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 5 Changelog
*********** ***********
@ -994,6 +1048,18 @@ releases.
* Menu: * Menu:
* 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.4: 074.
* 0.7.3: 073. * 0.7.3: 073.
* 0.7.2: 072. * 0.7.2: 072.
@ -1026,11 +1092,277 @@ releases.
* 0.1: 01. * 0.1: 01.
 
File: README.info, Node: 074, Next: 073, Up: Changelog File: README.info, Node: 09-pre, Next: 0810, Up: Changelog
5.1 0.7.4 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 levels 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 Helms 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-agendas 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.7s 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* *Fixes*
• Ignore empty quoted strings in plain-string queries (#383 • Ignore empty quoted strings in plain-string queries (#383
(https://github.com/alphapapa/org-ql/issues/383)). (https://github.com/alphapapa/org-ql/issues/383)).
@ -1038,8 +1370,8 @@ File: README.info, Node: 074, Next: 073, Up: Changelog
 
File: README.info, Node: 073, Next: 072, Prev: 074, Up: Changelog File: README.info, Node: 073, Next: 072, Prev: 074, Up: Changelog
5.2 0.7.3 5.14 0.7.3
========= ==========
*Fixes* *Fixes*
• Disable case-fold-search when collecting headings in outline • Disable case-fold-search when collecting headings in outline
@ -1056,8 +1388,8 @@ File: README.info, Node: 073, Next: 072, Prev: 074, Up: Changelog
 
File: README.info, Node: 072, Next: 071, Prev: 073, Up: Changelog File: README.info, Node: 072, Next: 071, Prev: 073, Up: Changelog
5.3 0.7.2 5.15 0.7.2
========= ==========
*Fixes* *Fixes*
• Timestamp predicates are more tolerant of partial input (e.g. • Timestamp predicates are more tolerant of partial input (e.g.
@ -1077,8 +1409,8 @@ File: README.info, Node: 072, Next: 071, Prev: 073, Up: Changelog
 
File: README.info, Node: 071, Next: 07, Prev: 072, Up: Changelog File: README.info, Node: 071, Next: 07, Prev: 072, Up: Changelog
5.4 0.7.1 5.16 0.7.1
========= ==========
*Fixes* *Fixes*
• Function org-ql-completing-read is more compatible with default • Function org-ql-completing-read is more compatible with default
@ -1096,13 +1428,12 @@ File: README.info, Node: 071, Next: 07, Prev: 072, Up: Changelog
 
File: README.info, Node: 07, Next: 063, Prev: 071, Up: Changelog File: README.info, Node: 07, Next: 063, Prev: 071, Up: Changelog
5.5 0.7 5.17 0.7
======= ========
*Added* *Added*
• Commands org-ql-find, org-ql-find-heading, and • Command org-ql-find, which jumps to entries selected using
org-ql-find-path, which jump to entries selected using Emacss Emacss built-in completion facilities and Org QL queries (like
built-in completion facilities and Org QL queries (like
helm-org-ql, but doesnt require Helm.). helm-org-ql, but doesnt require Helm.).
• Command org-ql-refile, which refiles the entry at point to one • Command org-ql-refile, which refiles the entry at point to one
selected using Org QL completion. selected using Org QL completion.
@ -1156,8 +1487,8 @@ File: README.info, Node: 07, Next: 063, Prev: 071, Up: Changelog
 
File: README.info, Node: 063, Next: 062, Prev: 07, Up: Changelog File: README.info, Node: 063, Next: 062, Prev: 07, Up: Changelog
5.6 0.6.3 5.18 0.6.3
========= ==========
*Fixed* *Fixed*
• Non-sexp query parsing with updated version 1.0.1 of the peg • Non-sexp query parsing with updated version 1.0.1 of the peg
@ -1172,8 +1503,8 @@ File: README.info, Node: 063, Next: 062, Prev: 07, Up: Changelog
 
File: README.info, Node: 062, Next: 061, Prev: 063, Up: Changelog File: README.info, Node: 062, Next: 061, Prev: 063, Up: Changelog
5.7 0.6.2 5.19 0.6.2
========= ==========
*Fixed* *Fixed*
link predicate when used in an ored query. (#279 link predicate when used in an ored query. (#279
@ -1183,8 +1514,8 @@ File: README.info, Node: 062, Next: 061, Prev: 063, Up: Changelog
 
File: README.info, Node: 061, Next: 06, Prev: 062, Up: Changelog File: README.info, Node: 061, Next: 06, Prev: 062, Up: Changelog
5.8 0.6.1 5.20 0.6.1
========= ==========
*Fixed* *Fixed*
• In dynamic blocks, links to headings with statistics cookies were • In dynamic blocks, links to headings with statistics cookies were
@ -1201,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 File: README.info, Node: 06, Next: 052, Prev: 061, Up: Changelog
5.9 0.6 5.21 0.6
======= ========
*Added* *Added*
• Macro org-ql-defpred, used to define search predicates. (See • Macro org-ql-defpred, used to define search predicates. (See
@ -1268,7 +1599,7 @@ File: README.info, Node: 06, Next: 052, Prev: 061, Up: Changelog
 
File: README.info, Node: 052, Next: 051, Prev: 06, Up: Changelog File: README.info, Node: 052, Next: 051, Prev: 06, Up: Changelog
5.10 0.5.2 5.22 0.5.2
========== ==========
*Fixed* *Fixed*
@ -1279,7 +1610,7 @@ File: README.info, Node: 052, Next: 051, Prev: 06, Up: Changelog
 
File: README.info, Node: 051, Next: 05, Prev: 052, Up: Changelog File: README.info, Node: 051, Next: 05, Prev: 052, Up: Changelog
5.11 0.5.1 5.23 0.5.1
========== ==========
*Fixed* *Fixed*
@ -1292,7 +1623,7 @@ File: README.info, Node: 051, Next: 05, Prev: 052, Up: Changelog
 
File: README.info, Node: 05, Next: 049, Prev: 051, Up: Changelog File: README.info, Node: 05, Next: 049, Prev: 051, Up: Changelog
5.12 0.5 5.24 0.5
======== ========
*Added* *Added*
@ -1333,7 +1664,7 @@ File: README.info, Node: 05, Next: 049, Prev: 051, Up: Changelog
 
File: README.info, Node: 049, Next: 048, Prev: 05, Up: Changelog File: README.info, Node: 049, Next: 048, Prev: 05, Up: Changelog
5.13 0.4.9 5.25 0.4.9
========== ==========
*Fixed* *Fixed*
@ -1344,7 +1675,7 @@ File: README.info, Node: 049, Next: 048, Prev: 05, Up: Changelog
 
File: README.info, Node: 048, Next: 047, Prev: 049, Up: Changelog File: README.info, Node: 048, Next: 047, Prev: 049, Up: Changelog
5.14 0.4.8 5.26 0.4.8
========== ==========
*Fixed* *Fixed*
@ -1356,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 File: README.info, Node: 047, Next: 046, Prev: 048, Up: Changelog
5.15 0.4.7 5.27 0.4.7
========== ==========
*Fixed* *Fixed*
@ -1369,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 File: README.info, Node: 046, Next: 045, Prev: 047, Up: Changelog
5.16 0.4.6 5.28 0.4.6
========== ==========
*Fixed* *Fixed*
@ -1382,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 File: README.info, Node: 045, Next: 044, Prev: 046, Up: Changelog
5.17 0.4.5 5.29 0.4.5
========== ==========
*Fixed* *Fixed*
@ -1394,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 File: README.info, Node: 044, Next: 043, Prev: 045, Up: Changelog
5.18 0.4.4 5.30 0.4.4
========== ==========
*Fixed* *Fixed*
@ -1406,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 File: README.info, Node: 043, Next: 042, Prev: 044, Up: Changelog
5.19 0.4.3 5.31 0.4.3
========== ==========
*Fixed* *Fixed*
@ -1416,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 File: README.info, Node: 042, Next: 041, Prev: 043, Up: Changelog
5.20 0.4.2 5.32 0.4.2
========== ==========
*Fixed* *Fixed*
@ -1425,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 File: README.info, Node: 041, Next: 04, Prev: 042, Up: Changelog
5.21 0.4.1 5.33 0.4.1
========== ==========
*Fixed* *Fixed*
@ -1435,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 File: README.info, Node: 04, Next: 032, Prev: 041, Up: Changelog
5.22 0.4 5.34 0.4
======== ========
_Note:_ The next release, 0.5, may include changes which will require _Note:_ The next release, 0.5, may include changes which will require
@ -1516,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 File: README.info, Node: 032, Next: 031, Prev: 04, Up: Changelog
5.23 0.3.2 5.35 0.3.2
========== ==========
*Fixed* *Fixed*
@ -1529,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 File: README.info, Node: 031, Next: 03, Prev: 032, Up: Changelog
5.24 0.3.1 5.36 0.3.1
========== ==========
*Fixed* *Fixed*
@ -1539,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 File: README.info, Node: 03, Next: 023, Prev: 031, Up: Changelog
5.25 0.3 5.37 0.3
======== ========
*Added* *Added*
@ -1607,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 File: README.info, Node: 023, Next: 022, Prev: 03, Up: Changelog
5.26 0.2.3 5.38 0.2.3
========== ==========
*Fixed* *Fixed*
@ -1617,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 File: README.info, Node: 022, Next: 021, Prev: 023, Up: Changelog
5.27 0.2.2 5.39 0.2.2
========== ==========
*Fixed* *Fixed*
@ -1628,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 File: README.info, Node: 021, Next: 02, Prev: 022, Up: Changelog
5.28 0.2.1 5.40 0.2.1
========== ==========
*Fixed* *Fixed*
@ -1638,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 File: README.info, Node: 02, Next: 01, Prev: 021, Up: Changelog
5.29 0.2 5.41 0.2
======== ========
*Added* *Added*
@ -1721,15 +2052,42 @@ File: README.info, Node: 02, Next: 01, Prev: 021, Up: Changelog
 
File: README.info, Node: 01, Prev: 02, Up: Changelog File: README.info, Node: 01, Prev: 02, Up: Changelog
5.30 0.1 5.42 0.1
======== ========
First tagged release. 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, its 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 <assign@gnu.org> to request the appropriate form.

File: README.info, Node: Notes, Next: License, Prev: Development, Up: Top
7 Notes
******* *******
* Menu: * Menu:
@ -1740,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 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 Of course, queries like these can already be written with Org Agenda
@ -1760,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 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 This package is used by org-sidebar
@ -1770,7 +2128,7 @@ customizable agenda-like view in a sidebar window.
 
File: README.info, Node: License, Prev: Notes, Up: Top File: README.info, Node: License, Prev: Notes, Up: Top
7 License 8 License
********* *********
GPLv3 GPLv3
@ -1779,74 +2137,90 @@ GPLv3
 
Tag Table: Tag Table:
Node: Top225 Node: Top225
Node: Contents1819 Node: Contents2109
Node: Screenshots1942 Node: Screenshots2236
Node: Installation2060 Node: Installation2354
Node: Quelpa2574 Node: Quelpa2868
Node: Helm support3102 Node: Helm support3396
Node: Usage3505 Node: Usage3799
Node: Commands3903 Node: Commands4197
Node: org-ql-find4347 Node: org-ql-find4662
Node: org-ql-refile4813 Node: org-ql-open-link5570
Node: org-ql-search5136 Node: org-ql-refile6425
Node: helm-org-ql6832 Node: org-ql-search6753
Node: org-ql-view7210 Node: helm-org-ql8684
Node: org-ql-view-sidebar7740 Node: org-ql-view9062
Node: org-ql-view-recent-items8120 Node: org-ql-view-sidebar9592
Node: org-ql-sparse-tree8616 Node: org-ql-view-recent-items9972
Node: Queries9416 Node: org-ql-sparse-tree10468
Node: Non-sexp query syntax10533 Node: Queries11268
Node: General predicates12292 Node: Non-sexp query syntax12385
Node: Ancestor/descendant predicates19279 Node: General predicates14144
Node: Date/time predicates20407 Node: Ancestor/descendant predicates21069
Node: Functions / Macros23531 Node: Date/time predicates22197
Node: Agenda-like views23829 Node: Functions / Macros25321
Ref: Function org-ql-block23991 Node: Agenda-like views25619
Node: Listing / acting-on results25252 Ref: Function org-ql-block25781
Ref: Caching25460 Node: Listing / acting-on results27042
Ref: Function org-ql-select26373 Ref: Caching27250
Ref: Function org-ql-query28799 Ref: Function org-ql-select28163
Ref: Macro org-ql (deprecated)30573 Ref: Function org-ql-query30589
Node: Custom predicates30888 Ref: Macro org-ql (deprecated)32363
Ref: Macro org-ql-defpred31112 Node: Custom predicates32678
Node: Dynamic block34553 Ref: Macro org-ql-defpred32902
Node: Links37277 Node: Dynamic block36343
Node: Tips37964 Node: Links39067
Node: Changelog38288 Node: Tips39754
Node: 07439093 Node: Changelog40078
Node: 07339305 Node: 09-pre41061
Node: 07240037 Node: helm-org-ql (1)41987
Node: 07140956 Node: 081042128
Node: 0741765 Node: 08942657
Node: 06344689 Node: 08843797
Node: 06245220 Node: 08744873
Node: 06145525 Node: 08646101
Node: 0646093 Node: 08546335
Node: 05249147 Node: 08446991
Node: 05149449 Node: 08347443
Node: 0549874 Node: 08247784
Node: 04951405 Node: 08148179
Node: 04851687 Node: 0848602
Node: 04752036 Node: 07451328
Node: 04652445 Node: 07351553
Node: 04552853 Node: 07252287
Node: 04453214 Node: 07153208
Node: 04353573 Node: 0754019
Node: 04253776 Node: 06356885
Node: 04153937 Node: 06257418
Node: 0454184 Node: 06157725
Node: 03258285 Node: 0658295
Node: 03158688 Node: 05261351
Node: 0358885 Node: 05161653
Node: 02362185 Node: 0562078
Node: 02262419 Node: 04963609
Node: 02162699 Node: 04863891
Node: 0262904 Node: 04764240
Node: 0166982 Node: 04664649
Node: Notes67083 Node: 04565057
Node: Comparison with Org Agenda searches67245 Node: 04465418
Node: org-sidebar68134 Node: 04365777
Node: License68413 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 End Tag Table

29
tests/data-ts.org Normal file
View file

@ -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./

View file

@ -3,7 +3,7 @@
;; Copyright (C) 2019 Adam Porter ;; Copyright (C) 2019 Adam Porter
;; Author: Adam Porter <adam@alphapapa.net> ;; Author: Adam Porter <adam@alphapapa.net>
;; 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 ;; 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 ;; it under the terms of the GNU General Public License as published by
@ -35,6 +35,8 @@
(require 'xr) (require 'xr)
(declare-function org-ql--normalize-query "org-ql" t t)
;;;; Variables ;;;; Variables
(defvar org-ql-test-buffer nil (defvar org-ql-test-buffer nil
@ -218,7 +220,8 @@ with keyword arg NOW in PLIST."
(it "coalesces a single AND clause that uses two predicates (and preserves predicate order)" (it "coalesces a single AND clause that uses two predicates (and preserves predicate order)"
(expect (org-ql--normalize-query '(and (rifle "foo") (rifle "bar") (expect (org-ql--normalize-query '(and (rifle "foo") (rifle "bar")
(heading "baz") (heading "buz"))) (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" (it "preserves independent OR clauses"
(expect (org-ql--normalize-query '(and (or (rifle "foo") (rifle "bar")) (expect (org-ql--normalize-query '(and (or (rifle "foo") (rifle "bar"))
(or (rifle "baz") (rifle "buz")))) (or (rifle "baz") (rifle "buz"))))
@ -253,6 +256,18 @@ with keyword arg NOW in PLIST."
(expect (org-ql--normalize-query "\"quoted phrase\"") (expect (org-ql--normalize-query "\"quoted phrase\"")
:to-equal '(rifle :regexps '("\"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" (describe "Plain strings"
(it "normalizes plain strings to the default predicate (using AND)" (it "normalizes plain strings to the default predicate (using AND)"
(expect (org-ql--normalize-query '(and "string1" "string2")) (expect (org-ql--normalize-query '(and "string1" "string2"))
@ -623,6 +638,11 @@ with keyword arg NOW in PLIST."
:to-equal (list :query t :to-equal (list :query t
:preamble (rx bol (repeat 2 4 "*") " ") :preamble (rx bol (repeat 2 4 "*") " ")
:preamble-case-fold t))) :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 "<" (it "<"
(expect (org-ql--query-preamble '(level < 3)) (expect (org-ql--query-preamble '(level < 3))
:to-equal (list :query t :to-equal (list :query t
@ -1112,7 +1132,12 @@ with keyword arg NOW in PLIST."
'("Take over the world"))) '("Take over the world")))
(org-ql-it "with two arguments" (org-ql-it "with two arguments"
(org-ql-expect ('(heading "Take over" "world")) (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)" (describe "(heading-regexp)"
(org-ql-it "with one argument" (org-ql-it "with one argument"
@ -1319,7 +1344,15 @@ with keyword arg NOW in PLIST."
(org-ql-it "with a property and a value" (org-ql-it "with a property and a value"
(org-ql-expect ('(property "agenda-group" "plans")) (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)" (describe "(regexp)"
@ -1670,7 +1703,36 @@ with keyword arg NOW in PLIST."
(org-ql-expect ((org-ql--query-string-to-sexp "ts-active:with-time=")) (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")) '("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")) (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" (describe "inactive"
@ -1809,7 +1871,20 @@ with keyword arg NOW in PLIST."
'("Visit Mars"))) '("Visit Mars")))
(org-ql-then (:now "2019-07-07") (org-ql-then (:now "2019-07-07")
(org-ql-expect ('(ts :on today)) (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" (describe "Compound queries"
@ -1844,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. ;; 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*"))) (let ((test-buffer (get-buffer-create "*test-org-ql*")))
(cl-flet ((open-link (cl-flet ((open-link (link)
(link) (with-current-buffer test-buffer (with-current-buffer test-buffer
(erase-buffer) (erase-buffer)
(org-mode) (org-mode)
(insert "* TODO Test heading \n\n") (insert "* TODO Test heading \n\n")
(insert link) (insert link)
(backward-char 1) (backward-char 1)
(call-interactively #'org-open-at-point)))) (call-interactively #'org-open-at-point))))
(describe "buffers-files parameter" (describe "buffers-files parameter"
:var ((quoted-lambda-link "[[org-ql-search:todo:?buffers-files%3D%28lambda%20nil%20%28error%20%22UNSAFE%22%29%29]]") :var ((quoted-lambda-link "[[org-ql-search:todo:?buffers-files%3D%28lambda%20nil%20%28error%20%22UNSAFE%22%29%29]]")
@ -1911,13 +1986,13 @@ with keyword arg NOW in PLIST."
(expression-link "[[org-ql-search:todo:?title%3D%28error%20%22UNSAFE%22%29]]")) (expression-link "[[org-ql-search:todo:?title%3D%28error%20%22UNSAFE%22%29]]"))
(it "Errors for a quoted lambda" (it "Errors for a quoted lambda"
(expect (open-link quoted-lambda-link) (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" (it "Errors for an unquoted lambda"
(expect (open-link unquoted-lambda-link) (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" (it "Errors for an expression"
(expect (open-link expression-link) (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" (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]]") :var ((quoted-lambda-link "[[org-ql-search:todo:?sort%3D%28lambda%20%28_%20_%29%20%28error%20%22UNSAFE%22%29%29]]")
@ -1943,7 +2018,7 @@ with keyword arg NOW in PLIST."
(describe "View saving/loading" (describe "View saving/loading"
:var* ((temp-dir (make-temp-file "test-org-ql-" 'dir)) :var* ((temp-dir (make-temp-file "test-org-ql-" 'dir))
(temp-filenames (cl-loop for file in '("test1.org" "test2.org") (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 (file-contents (with-temp-buffer
(insert "#+TITLE: Test data\n\n" (insert "#+TITLE: Test data\n\n"
"* TODO Heading 1\n" "* TODO Heading 1\n"
@ -2006,16 +2081,15 @@ with keyword arg NOW in PLIST."
(when-let ((buffer (find-file-noselect filename 'nowarn))) (when-let ((buffer (find-file-noselect filename 'nowarn)))
(kill-buffer buffer)))) (kill-buffer buffer))))
(cl-flet ((var-after-bookmark-set-and-jump (cl-flet ((var-after-bookmark-set-and-jump (var buffers-files query &key sort super-groups)
(var buffers-files query &key sort super-groups) (org-ql-search buffers-files query
(org-ql-search buffers-files query :super-groups super-groups
:super-groups super-groups :sort sort :title title :buffer view-buffer)
:sort sort :title title :buffer view-buffer) (set-buffer view-buffer)
(set-buffer view-buffer) (bookmark-set title)
(bookmark-set title) (kill-buffer)
(kill-buffer) (bookmark-jump title)
(bookmark-jump title) (buffer-local-value var (get-buffer (concat "*Org QL View: " title "*")))))
(buffer-local-value var (get-buffer (concat "*Org QL View: " title "*")))))
(describe "Grouping" (describe "Grouping"
:var ((query '(and (todo "TODO") (regexp "heading"))) :var ((query '(and (todo "TODO") (regexp "heading")))
@ -2069,18 +2143,18 @@ with keyword arg NOW in PLIST."
(describe "Dynamic blocks" (describe "Dynamic blocks"
(describe "warn about sexp queries" (describe "warn about sexp queries"
(cl-flet ((test-dblock (cl-flet ((test-dblock (&optional input)
(&optional input) (with-current-buffer (get-buffer-create "*TEST DBLOCK*") (with-current-buffer (get-buffer-create "*TEST DBLOCK*")
(erase-buffer) (erase-buffer)
(org-mode) (org-mode)
(insert "* TODO Heading 1\n\n" (insert "* TODO Heading 1\n\n"
"#+BEGIN: org-ql :query (or (todo) (regexp \"Heading\")) :columns (todo)\n" "#+BEGIN: org-ql :query (or (todo) (regexp \"Heading\")) :columns (todo)\n"
"#+END:") "#+END:")
(goto-char (point-min)) (goto-char (point-min))
(forward-line 2) (forward-line 2)
(with-simulated-input input (with-simulated-input input
(org-dblock-update)) (org-dblock-update))
(kill-buffer)))) (kill-buffer))))
(it "when org-ql-ask-unsafe-queries is non-nil" (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? ;; TODO: Should the query be converted to string form if possible and only warn if not?
@ -2109,39 +2183,37 @@ with keyword arg NOW in PLIST."
(insert "* TODO Test heading\n\n") (insert "* TODO Test heading\n\n")
(org-mode))) (org-mode)))
(cl-flet* ((open-link-in (cl-flet* ((open-link-in (link buffer input)
(link buffer input) ;; Org REDUCED THE NUMBER OF ARGUMENTS TO `org-open-link-from-string'! That BREAKS BACKWARD
;; 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!
;; COMPATIBILITY! So I have to make my own function so these tests can work across Org versions! (with-current-buffer buffer
(with-current-buffer buffer (erase-buffer)
(erase-buffer) (org-mode)
(org-mode) (insert "* TODO Test heading\n\n")
(insert "* TODO Test heading\n\n") (insert link)
(insert link) (backward-char 1)
(backward-char 1) (with-simulated-input input
(with-simulated-input input (org-open-at-point))))
(org-open-at-point))))
(var-after-link-save-open (var-after-link-save-open (var buffers-files query &key sort super-groups
(var buffers-files query &key sort super-groups (buffer link-buffer) (store-input "RET") open-input)
(buffer link-buffer) (store-input "RET") open-input) (org-ql-search buffers-files query
(org-ql-search buffers-files query :super-groups super-groups
:super-groups super-groups :sort sort :title title :buffer view-buffer)
:sort sort :title title :buffer view-buffer) (with-current-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)
(cl-assert (member '("org-ql-search" :follow org-ql-view--link-follow :store org-ql-view--link-store) org-link-parameters)
org-link-parameters) t)
t) (with-simulated-input store-input
(with-simulated-input store-input ;; Avoid writing "Stored: ..." to test output.
;; Avoid writing "Stored: ..." to test output. (let ((inhibit-message t))
(let ((inhibit-message t)) (call-interactively #'org-store-link nil)))
(call-interactively #'org-store-link nil))) (kill-buffer))
(kill-buffer)) (cl-assert (and org-stored-links (caar org-stored-links)) t)
(cl-assert (and org-stored-links (caar org-stored-links)) t) (open-link-in (caar org-stored-links) buffer open-input)
(open-link-in (caar org-stored-links) buffer open-input) (with-current-buffer (get-buffer (concat "*Org QL View: " title "*"))
(with-current-buffer (get-buffer (concat "*Org QL View: " title "*")) (prog1 (buffer-local-value var (current-buffer))
(prog1 (buffer-local-value var (current-buffer)) (kill-buffer)))))
(kill-buffer)))))
(describe "Queries" (describe "Queries"
:var ((string-query "todo:TODO regexp:heading") :var ((string-query "todo:TODO regexp:heading")