Compare commits
No commits in common. "master" and "0.6.1" have entirely different histories.
21 changed files with 1534 additions and 4012 deletions
78
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
78
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -1,78 +0,0 @@
|
||||||
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
5
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -1,5 +0,0 @@
|
||||||
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.
|
|
||||||
45
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
45
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -1,45 +0,0 @@
|
||||||
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
|
|
||||||
|
|
||||||
7
.github/workflows/test.yml
vendored
7
.github/workflows/test.yml
vendored
|
|
@ -41,14 +41,9 @@ 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.2
|
|
||||||
- 29.1
|
|
||||||
- 29.2
|
|
||||||
- 29.3
|
|
||||||
- 29.4
|
|
||||||
- snapshot
|
- snapshot
|
||||||
steps:
|
steps:
|
||||||
- uses: purcell/setup-emacs@master
|
- uses: purcell/setup-emacs@master
|
||||||
|
|
|
||||||
6
Makefile
6
Makefile
|
|
@ -1,7 +1,7 @@
|
||||||
# * makem.sh/Makefile --- Script to aid building and testing Emacs Lisp packages
|
# * makem.sh/Makefile --- 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.5
|
# Version: 0.3
|
||||||
|
|
||||||
# * Arguments
|
# * Arguments
|
||||||
|
|
||||||
|
|
@ -38,9 +38,7 @@ endif
|
||||||
|
|
||||||
verbose = $(v)
|
verbose = $(v)
|
||||||
|
|
||||||
ifneq (,$(findstring vvv,$(verbose)))
|
ifneq (,$(findstring vv,$(verbose)))
|
||||||
VERBOSE = "-vvv"
|
|
||||||
else ifneq (,$(findstring vv,$(verbose)))
|
|
||||||
VERBOSE = "-vv"
|
VERBOSE = "-vv"
|
||||||
else ifneq (,$(findstring v,$(verbose)))
|
else ifneq (,$(findstring v,$(verbose)))
|
||||||
VERBOSE = "-v"
|
VERBOSE = "-v"
|
||||||
|
|
|
||||||
249
README.org
249
README.org
|
|
@ -1,6 +1,7 @@
|
||||||
#+TITLE: org-ql
|
#+TITLE: org-ql
|
||||||
|
|
||||||
# NOTE: Using =BEGIN_HTML= for this causes TeX/info export to fail, but this HTML block works.
|
# NOTE: Using =BEGIN_HTML= for this causes TeX/info export to fail, but this HTML block works.
|
||||||
|
# #+HTML: <a href=https://alphapapa.github.io/dont-tread-on-emacs/><img src="images/dont-tread-on-emacs-150.png" align="right"></a>
|
||||||
#+HTML: <img src="images/dog.png" align="right">
|
#+HTML: <img src="images/dog.png" align="right">
|
||||||
|
|
||||||
# NOTE: To avoid having this in the info manual, we use HTML rather than Org syntax; it still appears with the GitHub renderer.
|
# NOTE: To avoid having this in the info manual, we use HTML rather than Org syntax; it still appears with the GitHub renderer.
|
||||||
|
|
@ -19,7 +20,6 @@ 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:
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -94,41 +94,15 @@ Lisp code examples are in [[examples.org]].
|
||||||
:TOC: ignore-children
|
:TOC: ignore-children
|
||||||
:END:
|
:END:
|
||||||
|
|
||||||
+ *Jumping to an entry:*
|
|
||||||
- [[#org-ql-find][org-ql-find]] and related commands
|
|
||||||
- [[#helm-org-ql][helm-org-ql]]
|
|
||||||
+ *Showing an agenda-like view:*
|
+ *Showing an agenda-like view:*
|
||||||
- [[#org-ql-search][org-ql-search]]
|
- [[#org-ql-search][org-ql-search]] (command)
|
||||||
- [[#org-ql-view][org-ql-view]]
|
- [[#org-ql-view][org-ql-view]] (command)
|
||||||
- [[#org-ql-view-sidebar][org-ql-view-sidebar]]
|
- [[#org-ql-view-sidebar][org-ql-view-sidebar]] (command)
|
||||||
- [[#org-ql-view-recent-items][org-ql-view-recent-items]]
|
- [[#org-ql-view-recent-items][org-ql-view-recent-items]] (command)
|
||||||
+ *Showing a tree in a buffer:*
|
+ *Showing a tree in a buffer:*
|
||||||
- [[#org-ql-sparse-tree][org-ql-sparse-tree]]
|
- [[#org-ql-sparse-tree][org-ql-sparse-tree]] (command)
|
||||||
|
+ *Showing results with Helm*:
|
||||||
*** org-ql-find
|
- [[#helm-org-ql][helm-org-ql]] (command)
|
||||||
|
|
||||||
/Note: These commands use [[#non-sexp-query-syntax][non-sexp queries]]./
|
|
||||||
|
|
||||||
These commands jump to a heading selected using Emacs's built-in completion facilities with an Org QL query:
|
|
||||||
|
|
||||||
- ~org-ql-find~ searches in the current buffer.
|
|
||||||
- ~org-ql-find-path~ searches outline paths in the current buffer.
|
|
||||||
- ~org-ql-find-in-agenda~ searches in ~(org-agenda-files)~.
|
|
||||||
- ~org-ql-find-in-org-directory~ searches in ~org-directory~.
|
|
||||||
|
|
||||||
Note that these commands are compatible with [[https://github.com/oantolin/embark][Embark]]: the ~embark-act~ command can be called on a completion candidate (i.e. a search result) to act on it immediately, without having to visit the entry in its source Org buffer, and ~embark-export~ may be called to show the results in an ~org-ql-view~ buffer.
|
|
||||||
|
|
||||||
[[images/org-ql-find.png]]
|
|
||||||
|
|
||||||
*** org-ql-open-link
|
|
||||||
|
|
||||||
This command finds links in entries matching the input query and offers them for selection; the selected link is then opened with ~org-open-at-point~.
|
|
||||||
|
|
||||||
The input is matched using the default predicate, which means it searches both entry content and outline paths. This is helpful when a collection of links are kept in Org files: rather than having to first visit the entry containing the desired link, then locate it within the entry, and then open it, the user can simply select the link and open it directly. For example, if an entry with the heading =Emacs= contained a link named =mailing list=, one could search for =Emacs list= and open the link to the mailing list directly.
|
|
||||||
|
|
||||||
*** org-ql-refile
|
|
||||||
|
|
||||||
This command refiles the current Org entry to one selected by searching with Org QL completion. It searches files listed in ~org-refile-targets~ as well as the current buffer.
|
|
||||||
|
|
||||||
*** org-ql-search
|
*** org-ql-search
|
||||||
|
|
||||||
|
|
@ -156,8 +130,6 @@ 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=./
|
||||||
|
|
@ -232,8 +204,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.
|
+ =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.
|
||||||
|
|
@ -249,23 +220,20 @@ 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 value of ~org-use-property-inheritance~, which see.
|
+ =property (property &optional value)= :: Return non-nil if current entry has ~PROPERTY~ (a string), and optionally ~VALUE~ (a string). Note that property inheritance is currently /not/ enabled for this predicate. If you need to test with inheritance, you could use a custom predicate form, like ~(org-entry-get (point) "PROPERTY" 'inherit)~.
|
||||||
+ =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.
|
+ ~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.
|
||||||
- Aliases: ~smart~.
|
+ =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.
|
||||||
- *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~.
|
+ =tags-inherited (&optional tags)= :: Return non-nil if current heading's inherited tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any inherited tags.
|
||||||
+ ~src (&key lang regexps)~ :: Return non-nil if current entry contains an Org Babel source block. If ~LANG~ is non-nil, match blocks of that language. If ~REGEXPS~ is non-nil, require that block's contents match all regexps. Matching is done case-insensitively.
|
|
||||||
+ =tags (&rest tags)= :: Return non-nil if current heading has one or more of ~TAGS~ (a list of strings). Tests both inherited and local tags.
|
|
||||||
+ =tags-inherited (&rest tags)= :: Return non-nil if current heading's inherited tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any inherited tags.
|
|
||||||
- Aliases: ~inherited-tags~, ~tags-i~, ~itags~.
|
- Aliases: ~inherited-tags~, ~tags-i~, ~itags~.
|
||||||
+ =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.
|
+ =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.
|
||||||
- Aliases: ~local-tags~, ~tags-l~, ~ltags~.
|
- Aliases: ~local-tags~, ~tags-l~, ~ltags~.
|
||||||
+ =tags-all (&rest tags)= :: Return non-nil if current heading includes all of ~TAGS~. Tests both inherited and local tags.
|
+ =tags-all (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 (&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~).
|
+ =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~).
|
||||||
|
|
||||||
*** Ancestor/descendant predicates
|
*** Ancestor/descendant predicates
|
||||||
|
|
||||||
|
|
@ -554,183 +522,6 @@ 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
|
|
||||||
|
|
||||||
*Fixes*
|
|
||||||
+ Ignore empty quoted strings in plain-string queries ([[https://github.com/alphapapa/org-ql/issues/383][#383]]).
|
|
||||||
|
|
||||||
** 0.7.3
|
|
||||||
|
|
||||||
*Fixes*
|
|
||||||
+ Disable ~case-fold-search~ when collecting headings in outline paths. (Headings that started with a word that is also a to-do keyword but with different capitalization would be matched incorrectly.)
|
|
||||||
+ Saving of ~org-ql-view~ views. ([[https://github.com/alphapapa/org-ql/issues/378][#378]]. Thanks to [[https://github.com/Pentaquark1][Pentaquark1]] for reporting.)
|
|
||||||
+ Command ~org-ql-find~ didn't move point to the selected entry. ([[https://github.com/alphapapa/org-ql/issues/380][#380]]. Thanks to [[https://github.com/oantolin][Omar Antolín Camarena]] for reporting.)
|
|
||||||
|
|
||||||
** 0.7.2
|
|
||||||
|
|
||||||
*Fixes*
|
|
||||||
+ Timestamp predicates are more tolerant of partial input (e.g. preventing errors while the user is typing a query into ~org-ql-find~).
|
|
||||||
+ Query parser ignores leading whitespace (e.g. preventing errors while the user is typing a query into ~org-ql-find~).
|
|
||||||
+ Use of ~org-ql-find~ with ~:query-prefix~ argument prevented selection of results. ([[https://github.com/alphapapa/org-ql/issues/351][#351]]. Thanks to [[https://github.com/danielfleischer][Daniel Fleischer]] for reporting.)
|
|
||||||
+ Handle narrowed buffers correctly in ~org-ql-find~.
|
|
||||||
+ Warn about empty headings in ~org-ql-completing-read~ (the Org format allows a heading line to have no text, but it's useless for this purpose, and usually indicates unnoticed corruption).
|
|
||||||
|
|
||||||
** 0.7.1
|
|
||||||
|
|
||||||
*Fixes*
|
|
||||||
+ Function ~org-ql-completing-read~ is more compatible with default Emacs completion. (See [[https://github.com/alphapapa/org-ql/issues/338][#338]]. Thanks to [[https://github.com/arozbiz][arozbiz]] for reporting.)
|
|
||||||
+ Function ~org-ql-completing-read~ would sometimes stop updating with changes in input. (See [[https://github.com/alphapapa/org-ql/issues/350][#350]]. Thanks to [[https://github.com/anpandey][Ankit Raj Pandey]] for reporting and fixing, and to [[https://github.com/minad][Daniel Mendler]] for advising.)
|
|
||||||
+ In ~org-ql-completing-read~, format links for display, and use ~org-entry-get~ internally rather than ~org-get-heading~.
|
|
||||||
|
|
||||||
** 0.7
|
|
||||||
|
|
||||||
*Added*
|
|
||||||
+ Command ~org-ql-find~, which jumps to entries selected using Emacs's built-in completion facilities and Org QL queries (like ~helm-org-ql~, but doesn't require Helm.).
|
|
||||||
+ Command ~org-ql-refile~, which refiles the entry at point to one selected using Org QL completion.
|
|
||||||
+ Predicate ~rifle~, which matches an entry if each of the given arguments is found in either the entry's contents or its outline path. This provides very intuitive results, mimicing the behavior of [[https://github.com/alphapapa/org-rifle][=org-rifle=]]. In fact, the results are so useful that it's now the default predicate for plain-string query tokens. (It is also aliased to ~smart~, since it's so "smart," and not all users have used =org-rifle=.)
|
|
||||||
+ Option ~org-ql-default-predicate~, applied to plain-string query tokens (before, the ~regexp~ predicate was always used, but now it may be customized).
|
|
||||||
+ Alias ~c~ for predicate ~category~.
|
|
||||||
+ Predicate ~property~ now accepts the argument ~:inherit~ to match entries with property inheritance, and when unspecified, the option ~org-use-property-inheritance~ controls whether inheritance is used.
|
|
||||||
+ Predicate ~blocked~. (Thanks to [[https://github.com/akirak][Akira Komamura]].)
|
|
||||||
|
|
||||||
*Changed*
|
|
||||||
+ Give more useful error message for invalid queries.
|
|
||||||
+ Predicate ~src~ now matches case-insensitively.
|
|
||||||
+ Command ~org-ql-sparse-tree~ accepts both string and sexp queries. (Thanks to [[https://github.com/akirak][Akira Komamura]].)
|
|
||||||
|
|
||||||
*Fixed*
|
|
||||||
+ Predicate ~link~ matches links whose descriptions contain escaped brackets (changed in Org 9.3). (Thanks to [[https://github.com/exot][Daniel Borchmann]] for reporting.)
|
|
||||||
+ Predicate ~src~'s matching of begin/end block lines, normalization of arguments, and handling in non-sexp queries. (Thanks to [[https://github.com/akirak][Akira Komamura]] for reporting.)
|
|
||||||
+ Predicate ~src~'s behavior with various arguments.
|
|
||||||
+ Various compilation warnings.
|
|
||||||
|
|
||||||
*Internal*
|
|
||||||
+ Certain query predicates, when called multiple times in an ~and~ sub-expression, are optimized to a single call.
|
|
||||||
+ Use ~buffer-chars-modified-tick~ instead of ~buffer-modified-tick~. (Thanks to [[https://github.com/yantar92][Ihor Radchenko]].)
|
|
||||||
+ Implemented tests for ~src~ predicate.
|
|
||||||
|
|
||||||
*Credits*
|
|
||||||
+ Thanks to [[https://github.com/chasecaleb][Caleb Chase]] for help with [[https://github.com/alphapapa/org-ql/pull/285][#285]], fixed in [[https://github.com/alphapapa/org-ql/commit/91908186fcca4b5fd2e9d26da5bc0375c2b41acf][9190818]].
|
|
||||||
|
|
||||||
** 0.6.3
|
|
||||||
|
|
||||||
*Fixed*
|
|
||||||
+ Non-sexp query parsing with updated version 1.0.1 of the ~peg~ package. (Fixes [[https://github.com/alphapapa/org-ql/issues/314][#314]], [[https://github.com/alphapapa/org-ql/issues/316][#316]]. Thanks to [[https://github.com/akirak][Akira Komamura]] and [[https://github.com/joonro][Joon Ro]] for reporting.)
|
|
||||||
+ Require library ~org-duration~ (apparently necessary in newer Org versions).
|
|
||||||
|
|
||||||
** 0.6.2
|
|
||||||
|
|
||||||
*Fixed*
|
|
||||||
+ ~link~ predicate when used in an ~or~'ed query. ([[https://github.com/alphapapa/org-ql/issues/279][#279]]. Thanks to [[https://github.com/telenieko][Marc Fargas]] for reporting.)
|
|
||||||
|
|
||||||
** 0.6.1
|
** 0.6.1
|
||||||
|
|
||||||
*Fixed*
|
*Fixed*
|
||||||
|
|
@ -1003,14 +794,6 @@ Tagged v0.6.2, fixing a compilation warning.
|
||||||
|
|
||||||
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
|
||||||
|
|
|
||||||
|
|
@ -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.2
|
;; Version: 0.6.1
|
||||||
;; 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"))
|
;; Package-Requires: ((emacs "26.1") (dash "2.18.1") (s "1.12.0") (helm-org "1.0") (org-ql "0.6-pre"))
|
||||||
|
|
||||||
;;; Commentary:
|
;;; Commentary:
|
||||||
|
|
||||||
|
|
@ -35,7 +35,6 @@
|
||||||
(require 'cl-lib)
|
(require 'cl-lib)
|
||||||
(require 'org)
|
(require 'org)
|
||||||
|
|
||||||
(require 'compat)
|
|
||||||
(require 'dash)
|
(require 'dash)
|
||||||
(require 's)
|
(require 's)
|
||||||
|
|
||||||
|
|
@ -45,15 +44,6 @@
|
||||||
(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
|
||||||
|
|
@ -69,8 +59,8 @@ Based on `helm-map'.")
|
||||||
(helm-make-source "Org QL Views" 'helm-source-sync
|
(helm-make-source "Org QL Views" 'helm-source-sync
|
||||||
:candidates (lambda ()
|
:candidates (lambda ()
|
||||||
(->> org-ql-views
|
(->> org-ql-views
|
||||||
(-map #'car)
|
(-map #'car)
|
||||||
(-sort #'string<)))
|
(-sort #'string<)))
|
||||||
:action (list (cons "Show view" #'org-ql-view)))
|
:action (list (cons "Show view" #'org-ql-view)))
|
||||||
"Helm source for `org-ql-views'.")
|
"Helm source for `org-ql-views'.")
|
||||||
|
|
||||||
|
|
@ -108,11 +98,9 @@ Based on `helm-map'.")
|
||||||
Interactively, search the current buffer. Note that this command
|
Interactively, search the current buffer. Note that this command
|
||||||
only accepts non-sexp, \"plain\" queries.
|
only accepts non-sexp, \"plain\" queries.
|
||||||
|
|
||||||
NAME is passed to `helm-org-ql-source', which see.
|
|
||||||
|
|
||||||
NOTE: Atoms in the query are turned into strings where
|
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 independent
|
around words that are intended to be searched for as indepenent
|
||||||
strings.
|
strings.
|
||||||
|
|
||||||
All query tokens are wrapped in the operator BOOLEAN (default
|
All query tokens are wrapped in the operator BOOLEAN (default
|
||||||
|
|
@ -161,7 +149,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)
|
||||||
(helm-org-ql--show-entry))
|
(org-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'."
|
||||||
|
|
@ -187,7 +175,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 to search BUFFERS-FILES with `helm-org-ql'."
|
"Return Helm source named NAME that searches 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 ()
|
||||||
|
|
@ -211,7 +199,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 (pos-bol) (pos-eol))
|
(font-lock-ensure (point-at-bol) (point-at-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
|
||||||
|
|
@ -221,8 +209,8 @@ WINDOW-WIDTH should be the width of the Helm window."
|
||||||
(width (- window-width (length prefix)))
|
(width (- window-width (length prefix)))
|
||||||
(heading (org-get-heading t))
|
(heading (org-get-heading t))
|
||||||
(path (-> (org-get-outline-path)
|
(path (-> (org-get-outline-path)
|
||||||
(org-format-outline-path width nil "")
|
(org-format-outline-path width nil "")
|
||||||
(org-split-string "")))
|
(org-split-string "")))
|
||||||
(path (if helm-org-ql-reverse-paths
|
(path (if helm-org-ql-reverse-paths
|
||||||
(concat heading "\\" (s-join "\\" (nreverse path)))
|
(concat heading "\\" (s-join "\\" (nreverse path)))
|
||||||
(concat (s-join "/" path) "/" heading))))
|
(concat (s-join "/" path) "/" heading))))
|
||||||
|
|
|
||||||
BIN
images/dont-tread-on-emacs-150.png
Normal file
BIN
images/dont-tread-on-emacs-150.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 92 KiB |
261
makem.sh
261
makem.sh
|
|
@ -3,11 +3,11 @@
|
||||||
# * 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.7.1
|
# Version: 0.3
|
||||||
|
|
||||||
# * Commentary:
|
# * Commentary:
|
||||||
|
|
||||||
# makem.sh is a script that helps to build, lint, and test Emacs Lisp
|
# makem.sh is a script helps to build, lint, and test Emacs Lisp
|
||||||
# packages. It aims to make linting and testing as simple as possible
|
# packages. It aims to make linting and testing as simple as possible
|
||||||
# without requiring per-package configuration.
|
# without requiring per-package configuration.
|
||||||
|
|
||||||
|
|
@ -79,7 +79,7 @@ Rules:
|
||||||
Options:
|
Options:
|
||||||
-d, --debug Print debug info.
|
-d, --debug Print debug info.
|
||||||
-h, --help I need somebody!
|
-h, --help I need somebody!
|
||||||
-v, --verbose Increase verbosity, up to -vvv.
|
-v, --verbose Increase verbosity, up to -vv.
|
||||||
--no-color Disable color output.
|
--no-color Disable color output.
|
||||||
|
|
||||||
--debug-load-path Print load-path from inside Emacs.
|
--debug-load-path Print load-path from inside Emacs.
|
||||||
|
|
@ -112,12 +112,6 @@ 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
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -142,27 +136,6 @@ EOF
|
||||||
echo $file
|
echo $file
|
||||||
}
|
}
|
||||||
|
|
||||||
function elisp-elint-file {
|
|
||||||
local file=$(mktemp)
|
|
||||||
cat >$file <<EOF
|
|
||||||
(require 'cl-lib)
|
|
||||||
(require 'elint)
|
|
||||||
(defun makem-elint-file (file)
|
|
||||||
(let ((errors 0))
|
|
||||||
(cl-letf (((symbol-function 'orig-message) (symbol-function 'message))
|
|
||||||
((symbol-function 'message) (symbol-function 'ignore))
|
|
||||||
((symbol-function 'elint-output)
|
|
||||||
(lambda (string)
|
|
||||||
(cl-incf errors)
|
|
||||||
(orig-message "%s" string))))
|
|
||||||
(elint-file file)
|
|
||||||
;; NOTE: \`errors' is not actually the number of errors, because
|
|
||||||
;; it's incremented for non-error header strings as well.
|
|
||||||
(kill-emacs errors))))
|
|
||||||
EOF
|
|
||||||
echo "$file"
|
|
||||||
}
|
|
||||||
|
|
||||||
function elisp-checkdoc-file {
|
function elisp-checkdoc-file {
|
||||||
# Since checkdoc doesn't have a batch function that exits non-zero
|
# Since checkdoc doesn't have a batch function that exits non-zero
|
||||||
# when errors are found, we make one.
|
# when errors are found, we make one.
|
||||||
|
|
@ -181,9 +154,7 @@ function elisp-checkdoc-file {
|
||||||
": " text)))
|
": " text)))
|
||||||
(message msg)
|
(message msg)
|
||||||
(setq makem-checkdoc-errors-p t)
|
(setq makem-checkdoc-errors-p t)
|
||||||
;; Return nil because we *are* generating a buffered list of errors.
|
(list text start end unfixable)))))
|
||||||
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))))
|
||||||
|
|
@ -194,51 +165,6 @@ EOF
|
||||||
echo $file
|
echo $file
|
||||||
}
|
}
|
||||||
|
|
||||||
function elisp-byte-compile-file {
|
|
||||||
# This seems to be the only way to make byte-compilation signal
|
|
||||||
# errors for warnings AND display all warnings rather than only
|
|
||||||
# the first one.
|
|
||||||
local file=$(mktemp)
|
|
||||||
# TODO: Add file to $paths_temp in other elisp- functions.
|
|
||||||
paths_temp+=("$file")
|
|
||||||
|
|
||||||
cat >"$file" <<EOF
|
|
||||||
(defun makem-batch-byte-compile (&rest args)
|
|
||||||
""
|
|
||||||
(let ((num-errors 0)
|
|
||||||
(num-warnings 0))
|
|
||||||
;; NOTE: Only accepts files as args, not directories.
|
|
||||||
(dolist (file command-line-args-left)
|
|
||||||
(pcase-let ((\`(,errors ,warnings) (makem-byte-compile-file file)))
|
|
||||||
(cl-incf num-errors errors)
|
|
||||||
(cl-incf num-warnings warnings)))
|
|
||||||
(zerop num-errors)))
|
|
||||||
|
|
||||||
(defun makem-byte-compile-file (filename &optional load)
|
|
||||||
"Call \`byte-compile-warn', returning the number of errors and the number of warnings."
|
|
||||||
(let ((num-warnings 0)
|
|
||||||
(num-errors 0))
|
|
||||||
(cl-letf (((symbol-function 'byte-compile-warn)
|
|
||||||
(lambda (format &rest args)
|
|
||||||
;; Copied from \`byte-compile-warn'.
|
|
||||||
(cl-incf num-warnings)
|
|
||||||
(setq format (apply #'format-message format args))
|
|
||||||
(byte-compile-log-warning format t :warning)))
|
|
||||||
((symbol-function 'byte-compile-report-error)
|
|
||||||
(lambda (error-info &optional fill &rest args)
|
|
||||||
(cl-incf num-errors)
|
|
||||||
;; Copied from \`byte-compile-report-error'.
|
|
||||||
(setq byte-compiler-error-flag t)
|
|
||||||
(byte-compile-log-warning
|
|
||||||
(if (stringp error-info) error-info
|
|
||||||
(error-message-string error-info))
|
|
||||||
fill :error))))
|
|
||||||
(byte-compile-file filename load))
|
|
||||||
(list num-errors num-warnings)))
|
|
||||||
EOF
|
|
||||||
echo "$file"
|
|
||||||
}
|
|
||||||
|
|
||||||
function elisp-check-declare-file {
|
function elisp-check-declare-file {
|
||||||
# Since check-declare doesn't have a batch function that exits
|
# Since check-declare doesn't have a batch function that exits
|
||||||
# non-zero when errors are found, we make one.
|
# non-zero when errors are found, we make one.
|
||||||
|
|
@ -274,23 +200,20 @@ Exits non-zero if mis-indented lines are found. Checks files in
|
||||||
(let ((errors-p))
|
(let ((errors-p))
|
||||||
(cl-labels ((lint-file (file)
|
(cl-labels ((lint-file (file)
|
||||||
(find-file file)
|
(find-file file)
|
||||||
(let ((inhibit-message t))
|
(let ((tick (buffer-modified-tick)))
|
||||||
(indent-region (point-min) (point-max)))
|
(let ((inhibit-message t))
|
||||||
(when buffer-undo-list
|
(indent-region (point-min) (point-max)))
|
||||||
;; Indentation changed: warn for each line.
|
(when (/= tick (buffer-modified-tick))
|
||||||
(dolist (line (undo-lines buffer-undo-list))
|
;; Indentation changed: warn for each line.
|
||||||
(message "%s:%s: Indentation mismatch" (buffer-name) line))
|
(dolist (line (undo-lines buffer-undo-list))
|
||||||
(setf errors-p t)))
|
(message "%s:%s: Indentation mismatch" (buffer-name) line))
|
||||||
(undo-pos (entry)
|
(setf errors-p t))))
|
||||||
(cl-typecase (car entry)
|
|
||||||
(number (car entry))
|
|
||||||
(string (abs (cdr entry)))))
|
|
||||||
(undo-lines (undo-list)
|
(undo-lines (undo-list)
|
||||||
;; Return list of lines changed in UNDO-LIST.
|
;; Return list of lines changed in UNDO-LIST.
|
||||||
(nreverse (cl-loop for elt in undo-list
|
(nreverse (cl-loop for elt in undo-list
|
||||||
for pos = (undo-pos elt)
|
when (and (consp elt)
|
||||||
when pos
|
(numberp (car elt)))
|
||||||
collect (line-number-at-pos pos)))))
|
collect (line-number-at-pos (car elt))))))
|
||||||
(mapc #'lint-file (mapcar #'expand-file-name command-line-args-left))
|
(mapc #'lint-file (mapcar #'expand-file-name command-line-args-left))
|
||||||
(when errors-p
|
(when errors-p
|
||||||
(kill-emacs 1)))))
|
(kill-emacs 1)))))
|
||||||
|
|
@ -307,7 +230,9 @@ 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)
|
||||||
|
(setq load-prefer-newer t)
|
||||||
EOF
|
EOF
|
||||||
echo $file
|
echo $file
|
||||||
}
|
}
|
||||||
|
|
@ -320,7 +245,6 @@ function run_emacs {
|
||||||
local emacs_command=(
|
local emacs_command=(
|
||||||
"${emacs_command[@]}"
|
"${emacs_command[@]}"
|
||||||
-Q
|
-Q
|
||||||
--eval "(setq load-prefer-newer t)"
|
|
||||||
"${args_debug[@]}"
|
"${args_debug[@]}"
|
||||||
"${args_sandbox[@]}"
|
"${args_sandbox[@]}"
|
||||||
-l $package_initialize_file
|
-l $package_initialize_file
|
||||||
|
|
@ -362,9 +286,8 @@ function batch-byte-compile {
|
||||||
[[ $compile_error_on_warn ]] && local error_on_warn=(--eval "(setq byte-compile-error-on-warn t)")
|
[[ $compile_error_on_warn ]] && local error_on_warn=(--eval "(setq byte-compile-error-on-warn t)")
|
||||||
|
|
||||||
run_emacs \
|
run_emacs \
|
||||||
--load "$(elisp-byte-compile-file)" \
|
|
||||||
"${error_on_warn[@]}" \
|
"${error_on_warn[@]}" \
|
||||||
--eval "(unless (makem-batch-byte-compile) (kill-emacs 1))" \
|
--funcall batch-byte-compile \
|
||||||
"$@"
|
"$@"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -374,47 +297,14 @@ function byte-compile-file {
|
||||||
|
|
||||||
[[ $compile_error_on_warn ]] && local error_on_warn=(--eval "(setq byte-compile-error-on-warn t)")
|
[[ $compile_error_on_warn ]] && local error_on_warn=(--eval "(setq byte-compile-error-on-warn t)")
|
||||||
|
|
||||||
# FIXME: Why is the line starting with "&& verbose 3" not indented properly? Emacs insists on indenting it back a level.
|
|
||||||
run_emacs \
|
run_emacs \
|
||||||
--load "$(elisp-byte-compile-file)" \
|
|
||||||
"${error_on_warn[@]}" \
|
"${error_on_warn[@]}" \
|
||||||
--eval "(pcase-let ((\`(,num-errors ,num-warnings) (makem-byte-compile-file \"$file\"))) (when (or (and byte-compile-error-on-warn (not (zerop num-warnings))) (not (zerop num-errors))) (kill-emacs 1)))" \
|
--eval "(byte-compile-file \"$file\")" \
|
||||||
&& verbose 3 "Compiling $file finished without errors." \
|
|| error "Compiling file failed: $file"
|
||||||
|| { verbose 3 "Compiling file failed: $file"; return 1; }
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# ** 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
|
||||||
|
|
@ -423,7 +313,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.
|
||||||
files-project 2>/dev/null \
|
git ls-files 2>/dev/null \
|
||||||
| egrep "\.el$" \
|
| egrep "\.el$" \
|
||||||
| filter-files-exclude-default \
|
| filter-files-exclude-default \
|
||||||
| filter-files-exclude-args
|
| filter-files-exclude-args
|
||||||
|
|
@ -432,13 +322,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 \
|
||||||
| grep -E -v "$test_files_regexp" \
|
| egrep -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 | grep -E "$test_files_regexp"
|
files-project-elisp | egrep "$test_files_regexp"
|
||||||
}
|
}
|
||||||
|
|
||||||
function dirnames {
|
function dirnames {
|
||||||
|
|
@ -451,7 +341,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.
|
||||||
grep -E -v "(/\.cask/|-autoloads\.el|\.dir-locals)"
|
egrep -v "(/\.cask/|-autoloads.el|.dir-locals)"
|
||||||
}
|
}
|
||||||
|
|
||||||
function filter-files-exclude-args {
|
function filter-files-exclude-args {
|
||||||
|
|
@ -477,7 +367,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
|
||||||
grep -E "^\\(provide '" "$path" &>/dev/null \
|
egrep "^\\(provide '" "$path" &>/dev/null \
|
||||||
&& echo "$path"
|
&& echo "$path"
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
@ -486,8 +376,7 @@ function args-load-files {
|
||||||
# For file in $@, echo "--load $file".
|
# For file in $@, echo "--load $file".
|
||||||
for file in "$@"
|
for file in "$@"
|
||||||
do
|
do
|
||||||
sans_extension=${file%%.el}
|
printf -- '--load %q ' "$file"
|
||||||
printf -- '--load %q ' "$sans_extension"
|
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -524,8 +413,9 @@ function ert-tests-p {
|
||||||
}
|
}
|
||||||
|
|
||||||
function package-main-file {
|
function package-main-file {
|
||||||
# Echo the package's main file.
|
# Echo the package's main file. Helpful for setting package-lint-main-file.
|
||||||
file_pkg=$(files-project "*-pkg.el" 2>/dev/null)
|
|
||||||
|
file_pkg=$(git ls-files ./*-pkg.el 2>/dev/null)
|
||||||
|
|
||||||
if [[ $file_pkg ]]
|
if [[ $file_pkg ]]
|
||||||
then
|
then
|
||||||
|
|
@ -548,23 +438,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.
|
||||||
grep -E -a -i '^;; Package-Requires: ' $(files-project-feature) $(files-project-test) \
|
egrep -a -i '^;; Package-Requires: ' $(files-project-feature) $(files-project-test) \
|
||||||
| grep -E -o '\([^([:space:]][^)]*\)' \
|
| egrep -o '\([^([:space:]][^)]*\)' \
|
||||||
| grep -E -o '^[^[:space:])]+' \
|
| egrep -o '^[^[:space:])]+' \
|
||||||
| sed -r 's/\(//g' \
|
| sed -r 's/\(//g' \
|
||||||
| grep -E -v '^emacs$' # Ignore Emacs version requirement.
|
| egrep -v '^emacs$' # Ignore Emacs version requirement.
|
||||||
|
|
||||||
# Search Cask file.
|
# Search Cask file.
|
||||||
if [[ -r Cask ]]
|
if [[ -r Cask ]]
|
||||||
then
|
then
|
||||||
grep -E '\(depends-on "[^"]+"' Cask \
|
egrep '\(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 [[ $(files-project "*-pkg.el" 2>/dev/null) ]]
|
if [[ $(git ls-files ./*-pkg.el 2>/dev/null) ]]
|
||||||
then
|
then
|
||||||
sed -nr 's/.*\(([-[:alnum:]]+)[[:blank:]]+"[.[:digit:]]+"\).*/\1/p' $(files-project- -- -pkg.el 2>/dev/null)
|
sed -nr 's/.*\(([-[:alnum:]]+)[[:blank:]]+"[.[:digit:]]+"\).*/\1/p' $(git ls-files ./*-pkg.el 2>/dev/null)
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -606,8 +496,6 @@ function sandbox {
|
||||||
args_sandbox=(
|
args_sandbox=(
|
||||||
--title "makem.sh: $(basename $(pwd)) (sandbox: $sandbox_dir)"
|
--title "makem.sh: $(basename $(pwd)) (sandbox: $sandbox_dir)"
|
||||||
--eval "(setq user-emacs-directory (file-truename \"$sandbox_dir\"))"
|
--eval "(setq user-emacs-directory (file-truename \"$sandbox_dir\"))"
|
||||||
--load package
|
|
||||||
--eval "(setq package-user-dir (expand-file-name \"elpa\" user-emacs-directory))"
|
|
||||||
--eval "(setq user-init-file (file-truename \"$init_file\"))"
|
--eval "(setq user-init-file (file-truename \"$init_file\"))"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
@ -617,9 +505,6 @@ 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)")
|
||||||
|
|
@ -773,8 +658,7 @@ function verbose {
|
||||||
if [[ $verbose -ge $1 ]]
|
if [[ $verbose -ge $1 ]]
|
||||||
then
|
then
|
||||||
[[ $1 -eq 1 ]] && local color_name=blue
|
[[ $1 -eq 1 ]] && local color_name=blue
|
||||||
[[ $1 -eq 2 ]] && local color_name=cyan
|
[[ $1 -ge 2 ]] && local color_name=cyan
|
||||||
[[ $1 -ge 3 ]] && local color_name=white
|
|
||||||
|
|
||||||
shift
|
shift
|
||||||
log_color $color_name "$@" >&2
|
log_color $color_name "$@" >&2
|
||||||
|
|
@ -822,7 +706,9 @@ function compile-batch {
|
||||||
verbose 2 "Batch-compiling files..."
|
verbose 2 "Batch-compiling files..."
|
||||||
debug "Byte-compile files: ${files_project_byte_compile[@]}"
|
debug "Byte-compile files: ${files_project_byte_compile[@]}"
|
||||||
|
|
||||||
batch-byte-compile "${files_project_byte_compile[@]}"
|
batch-byte-compile "${files_project_byte_compile[@]}" \
|
||||||
|
&& success "Compiling finished without errors." \
|
||||||
|
|| error "Compilation failed."
|
||||||
}
|
}
|
||||||
|
|
||||||
function compile-each {
|
function compile-each {
|
||||||
|
|
@ -840,7 +726,9 @@ function compile-each {
|
||||||
|| compile_errors=t
|
|| compile_errors=t
|
||||||
done
|
done
|
||||||
|
|
||||||
[[ ! $compile_errors ]]
|
! [[ $compile_errors ]] \
|
||||||
|
&& success "Compiling finished without errors." \
|
||||||
|
|| error "Compilation failed."
|
||||||
}
|
}
|
||||||
|
|
||||||
function compile {
|
function compile {
|
||||||
|
|
@ -850,18 +738,6 @@ function compile {
|
||||||
else
|
else
|
||||||
compile-each "$@"
|
compile-each "$@"
|
||||||
fi
|
fi
|
||||||
local status=$?
|
|
||||||
|
|
||||||
if [[ $compile_error_on_warn ]]
|
|
||||||
then
|
|
||||||
# Linting: just return status code, because lint rule will print messages.
|
|
||||||
[[ $status = 0 ]]
|
|
||||||
else
|
|
||||||
# Not linting: print messages here.
|
|
||||||
[[ $status = 0 ]] \
|
|
||||||
&& success "Compiling finished without errors." \
|
|
||||||
|| error "Compiling failed."
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function batch {
|
function batch {
|
||||||
|
|
@ -876,15 +752,12 @@ function batch {
|
||||||
|
|
||||||
function interactive {
|
function interactive {
|
||||||
# Run Emacs interactively. Most useful with --sandbox and --install-deps.
|
# Run Emacs interactively. Most useful with --sandbox and --install-deps.
|
||||||
local load_file_args=$(args-load-files "${files_project_feature[@]}" "${files_project_test[@]}")
|
|
||||||
verbose 1 "Running Emacs interactively..."
|
verbose 1 "Running Emacs interactively..."
|
||||||
verbose 2 "Loading files: ${load_file_args//--load /}"
|
verbose 2 "Loading files:" "${files_project_feature[@]}" "${files_project_test[@]}"
|
||||||
|
|
||||||
[[ $compile ]] && compile
|
|
||||||
|
|
||||||
unset arg_batch
|
unset arg_batch
|
||||||
run_emacs \
|
run_emacs \
|
||||||
$load_file_args \
|
$(args-load-files "${files_project_feature[@]}" "${files_project_test[@]}") \
|
||||||
--eval "(load user-init-file)" \
|
--eval "(load user-init-file)" \
|
||||||
"${args_batch_interactive[@]}"
|
"${args_batch_interactive[@]}"
|
||||||
arg_batch="--batch"
|
arg_batch="--batch"
|
||||||
|
|
@ -896,9 +769,6 @@ function lint {
|
||||||
lint-checkdoc
|
lint-checkdoc
|
||||||
lint-compile
|
lint-compile
|
||||||
lint-declare
|
lint-declare
|
||||||
# NOTE: Elint doesn't seem very useful at the moment. See comment
|
|
||||||
# in lint-elint function.
|
|
||||||
# lint-elint
|
|
||||||
lint-indent
|
lint-indent
|
||||||
lint-package
|
lint-package
|
||||||
lint-regexps
|
lint-regexps
|
||||||
|
|
@ -955,28 +825,6 @@ function lint-elsa {
|
||||||
|| error "Linting with Elsa failed."
|
|| error "Linting with Elsa failed."
|
||||||
}
|
}
|
||||||
|
|
||||||
function lint-elint {
|
|
||||||
# NOTE: Elint gives a lot of spurious warnings, apparently because it doesn't load files
|
|
||||||
# that are `require'd, so its output isn't very useful. But in case it's improved in
|
|
||||||
# the future, and since this wrapper code already works, we might as well leave it in.
|
|
||||||
verbose 1 "Linting with Elint..."
|
|
||||||
|
|
||||||
local errors=0
|
|
||||||
for file in "${files_project_feature[@]}"
|
|
||||||
do
|
|
||||||
verbose 2 "Linting with Elint: $file..."
|
|
||||||
run_emacs \
|
|
||||||
--load "$(elisp-elint-file)" \
|
|
||||||
--eval "(makem-elint-file \"$file\")" \
|
|
||||||
&& verbose 3 "Linting with Elint found no errors." \
|
|
||||||
|| { error "Linting with Elint failed: $file"; ((errors++)) ; }
|
|
||||||
done
|
|
||||||
|
|
||||||
[[ $errors = 0 ]] \
|
|
||||||
&& success "Linting with Elint finished without errors." \
|
|
||||||
|| error "Linting with Elint failed."
|
|
||||||
}
|
|
||||||
|
|
||||||
function lint-indent {
|
function lint-indent {
|
||||||
verbose 1 "Linting indentation..."
|
verbose 1 "Linting indentation..."
|
||||||
|
|
||||||
|
|
@ -1048,8 +896,7 @@ function test-buttercup {
|
||||||
|
|
||||||
run_emacs \
|
run_emacs \
|
||||||
$(args-load-files "${files_project_test[@]}") \
|
$(args-load-files "${files_project_test[@]}") \
|
||||||
--load "$buttercup_file" \
|
-f buttercup-run \
|
||||||
--eval "(progn (setq backtrace-on-error-noninteractive nil) (buttercup-run))" \
|
|
||||||
&& success "Buttercup tests finished without errors." \
|
&& success "Buttercup tests finished without errors." \
|
||||||
|| error "Buttercup tests failed."
|
|| error "Buttercup tests failed."
|
||||||
}
|
}
|
||||||
|
|
@ -1123,15 +970,21 @@ 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:C \
|
-o dhce:E:i:s::vf:CO \
|
||||||
-l compile-batch,exclude:,emacs:,install-deps,install-linters,debug,debug-load-path,help,install:,verbose,file:,no-color,no-compile,sandbox:: \
|
-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:: \
|
||||||
-- "$@") \
|
-- "$@") \
|
||||||
|| { usage; exit 1; }
|
|| { usage; exit 1; }
|
||||||
eval set -- "$args"
|
eval set -- "$args"
|
||||||
|
|
@ -1195,6 +1048,9 @@ 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
|
||||||
;;
|
;;
|
||||||
|
|
@ -1223,9 +1079,6 @@ 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))
|
||||||
|
|
|
||||||
|
|
@ -1,402 +0,0 @@
|
||||||
;;; org-ql-completing-read.el --- Completing read of Org entries using org-ql -*- lexical-binding: t; -*-
|
|
||||||
|
|
||||||
;; Copyright (C) 2022-2023 Adam Porter
|
|
||||||
|
|
||||||
;; Author: Adam Porter <adam@alphapapa.net>
|
|
||||||
|
|
||||||
;; This program is free software; you can redistribute it and/or modify
|
|
||||||
;; it under the terms of the GNU General Public License as published by
|
|
||||||
;; the Free Software Foundation, either version 3 of the License, or
|
|
||||||
;; (at your option) any later version.
|
|
||||||
|
|
||||||
;; This program is distributed in the hope that it will be useful,
|
|
||||||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
;; GNU General Public License for more details.
|
|
||||||
|
|
||||||
;; You should have received a copy of the GNU General Public License
|
|
||||||
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
|
|
||||||
;; This library provides completing-read of Org entries using `org-ql'
|
|
||||||
;; search.
|
|
||||||
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(require 'org-ql)
|
|
||||||
|
|
||||||
(declare-function org-ql-search "org-ql-search")
|
|
||||||
(declare-function org-ql--normalize-query "org-ql" t t)
|
|
||||||
|
|
||||||
;;;; Variables
|
|
||||||
|
|
||||||
(defvar-keymap org-ql-completing-read-map
|
|
||||||
:doc "Active during `org-ql-completing-read' sessions."
|
|
||||||
"C-c C-e" #'org-ql-completing-read-export)
|
|
||||||
|
|
||||||
;; `embark-collect' doesn't work for `org-ql-completing-read', so remap
|
|
||||||
;; it to `embark-export' (which `keymap-set', et al doesn't allow).
|
|
||||||
(define-key org-ql-completing-read-map [remap embark-collect] 'embark-export)
|
|
||||||
|
|
||||||
;;;; Customization
|
|
||||||
|
|
||||||
(defgroup org-ql-completing-read nil
|
|
||||||
"Completing-read of Org entries using `org-ql' search."
|
|
||||||
:group 'org-ql)
|
|
||||||
|
|
||||||
(defcustom org-ql-completing-read-reverse-paths t
|
|
||||||
"Whether to reverse Org outline paths in `org-ql-completing-read' results."
|
|
||||||
:type 'boolean)
|
|
||||||
|
|
||||||
(defcustom org-ql-completing-read-snippet-function #'org-ql-completing-read--snippet-simple
|
|
||||||
;; TODO(v0.9): Performance of completion annotations seems to be
|
|
||||||
;; much improved now (whether due to changes in Emacs, Vertico, or
|
|
||||||
;; both, I don't know). It may be reasonable to make the context
|
|
||||||
;; snippet the default now.
|
|
||||||
"Function used to annotate results in `org-ql-completing-read'.
|
|
||||||
Function is called at entry beginning. (When set to
|
|
||||||
`org-ql-completing-read--snippet-regexp', it is called with a
|
|
||||||
regexp matching plain query tokens.)"
|
|
||||||
:type '(choice (function-item :tag "Show context around search terms" org-ql-completing-read--snippet-regexp)
|
|
||||||
(function-item :tag "Show first N characters" org-ql-completing-read--snippet-simple)
|
|
||||||
(function :tag "Custom function")))
|
|
||||||
|
|
||||||
(defcustom org-ql-completing-read-snippet-length 51
|
|
||||||
"Size of snippets of entry content to include in completion annotations.
|
|
||||||
Only used when `org-ql-completing-read-snippet-function' is set
|
|
||||||
to `org-ql-completing-read--snippet-regexp'."
|
|
||||||
:type 'integer)
|
|
||||||
|
|
||||||
(defcustom org-ql-completing-read-snippet-minimum-token-length 3
|
|
||||||
"Query tokens shorter than this many characters are ignored.
|
|
||||||
That is, they are not included when gathering entry snippets.
|
|
||||||
This avoids too-small tokens causing performance problems."
|
|
||||||
:type 'integer)
|
|
||||||
|
|
||||||
(defcustom org-ql-completing-read-snippet-prefix nil
|
|
||||||
"String prepended to snippets.
|
|
||||||
For an experience like `org-rifle', use a newline."
|
|
||||||
:type '(choice (const :tag "None (shown on same line)" nil)
|
|
||||||
(const :tag "New line (shown under heading)" "\n")
|
|
||||||
string))
|
|
||||||
|
|
||||||
(defface org-ql-completing-read-snippet '((t (:inherit font-lock-comment-face)))
|
|
||||||
"Snippets.")
|
|
||||||
|
|
||||||
(defvar org-ql-completing-read-input-regexp nil
|
|
||||||
"Current regexp for `org-ql-completing-read' input.
|
|
||||||
To be used in, e.g. annotation functions.")
|
|
||||||
|
|
||||||
;;;; Functions
|
|
||||||
|
|
||||||
(defun org-ql-completing-read-action ()
|
|
||||||
"Default action for `org-ql-completing-read'.
|
|
||||||
Returns (STRING . MARKER) cons for entry at point."
|
|
||||||
(font-lock-ensure (pos-bol) (pos-eol))
|
|
||||||
(cons (org-link-display-format (org-entry-get nil "ITEM")) (point-marker)))
|
|
||||||
|
|
||||||
(defun org-ql-completing-read-snippet (marker)
|
|
||||||
"Return snippet for entry at MARKER.
|
|
||||||
Returns value returned by function
|
|
||||||
`org-ql-completing-read-snippet-function' or
|
|
||||||
`org-ql-completing-read--snippet-simple', whichever returns a
|
|
||||||
value, or nil."
|
|
||||||
(pcase (while-no-input
|
|
||||||
;; Using `while-no-input' here doesn't make it as
|
|
||||||
;; responsive as, e.g. Helm while typing, but it seems to
|
|
||||||
;; help a little when using the org-rifle-style snippets.
|
|
||||||
(org-with-point-at marker
|
|
||||||
(or (funcall org-ql-completing-read-snippet-function
|
|
||||||
org-ql-completing-read-input-regexp)
|
|
||||||
(org-ql-completing-read--snippet-simple))))
|
|
||||||
(`t ;; Interrupted: return nil (which can be concatted).
|
|
||||||
nil)
|
|
||||||
(else (propertize (concat " " else)
|
|
||||||
'face 'org-ql-completing-read-snippet))))
|
|
||||||
|
|
||||||
(defun org-ql-completing-read-path (marker)
|
|
||||||
"Return formatted outline path for entry at MARKER."
|
|
||||||
(org-with-point-at marker
|
|
||||||
(let ((path (thread-first (org-get-outline-path nil t)
|
|
||||||
(org-format-outline-path (window-width) nil "")
|
|
||||||
(org-split-string ""))))
|
|
||||||
(if org-ql-completing-read-reverse-paths
|
|
||||||
(concat "\\" (string-join (reverse path) "\\"))
|
|
||||||
(concat "/" (string-join path "/"))))))
|
|
||||||
|
|
||||||
;;;;; Completing read
|
|
||||||
|
|
||||||
(defun org-ql-completing-read-export ()
|
|
||||||
"Show `org-ql-view' buffer for current `org-ql-completing-read'-based search."
|
|
||||||
(interactive)
|
|
||||||
(user-error "Not in an `org-ql-completing-read' session"))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(cl-defun org-ql-completing-read
|
|
||||||
(buffers-files &key query-prefix query-filter narrowp
|
|
||||||
(action #'org-ql-completing-read-action)
|
|
||||||
;; FIXME: Unused argument.
|
|
||||||
;; (annotate #'org-ql-completing-read-snippet)
|
|
||||||
(snippet #'org-ql-completing-read-snippet)
|
|
||||||
(path #'org-ql-completing-read-path)
|
|
||||||
(action-filter #'list)
|
|
||||||
(prompt "Find entry: "))
|
|
||||||
"Return marker at entry in BUFFERS-FILES selected with `org-ql'.
|
|
||||||
PROMPT is shown to the user.
|
|
||||||
|
|
||||||
NARROWP is passed to `org-ql-select', which see.
|
|
||||||
|
|
||||||
QUERY-PREFIX may be a string to prepend to the query entered by
|
|
||||||
the user (e.g. use \"heading:\" to only search headings, easily
|
|
||||||
creating a custom command that saves the user from having to type
|
|
||||||
it).
|
|
||||||
|
|
||||||
QUERY-FILTER may be a function through which the query the user
|
|
||||||
types is filtered before execution (e.g. it could replace spaces
|
|
||||||
with commas to turn multiple tokens, which would normally be
|
|
||||||
treated as multiple predicates, into multiple arguments to a
|
|
||||||
single predicate)."
|
|
||||||
(declare (indent defun))
|
|
||||||
;; Emacs's completion API is not always easy to understand, especially when using "programmed
|
|
||||||
;; completion." This code was made possible by the example Clemens Radermacher shared at
|
|
||||||
;; <https://github.com/radian-software/selectrum/issues/114#issuecomment-744041532>.
|
|
||||||
|
|
||||||
;; NOTE: I don't usually leave commented-out debugging code, but due to the incredibly tedious
|
|
||||||
;; complexity of the "Programmed Completion" API and the time spent trying to get this reasonably
|
|
||||||
;; close to "correct," I'm leaving it in, because I will undoubtedly have to go through this
|
|
||||||
;; process again.
|
|
||||||
|
|
||||||
;; (message "ORG-QL-COMPLETING-READ: Starts.")
|
|
||||||
(let ((table (make-hash-table :test #'equal))
|
|
||||||
(disambiguations (make-hash-table :test #'equal))
|
|
||||||
(window-width (window-width))
|
|
||||||
last-input org-outline-path-cache query-tokens)
|
|
||||||
(cl-labels (;; (debug-message
|
|
||||||
;; (f &rest args) (apply #'message (concat "ORG-QL-COMPLETING-READ: " f) args))
|
|
||||||
(action ()
|
|
||||||
(font-lock-ensure (pos-bol) (pos-eol))
|
|
||||||
;; This function needs to handle multiple candidates per
|
|
||||||
;; call, so we loop over a list of values by default.
|
|
||||||
(pcase-dolist (`(,string . ,marker) (funcall action-filter (funcall action)))
|
|
||||||
(when string
|
|
||||||
(if (string-empty-p string)
|
|
||||||
;; A heading's string can be empty, but we can't use one because it
|
|
||||||
;; wouldn't be useful to the user; and if one is found, it's very
|
|
||||||
;; likely to indicate an unnoticed mistake or corruption in the
|
|
||||||
;; file: so display a warning and don't record it as a candidate.
|
|
||||||
(display-warning 'org-ql-completing-read (format-message "Empty heading at %S" marker))
|
|
||||||
(when (gethash string table)
|
|
||||||
;; Disambiguate string (even adding the path isn't enough, because that could
|
|
||||||
;; also be duplicated).
|
|
||||||
(if-let ((suffix (gethash string disambiguations)))
|
|
||||||
(setf string (format "%s <%s>" string (cl-incf suffix)))
|
|
||||||
(setf string (format "%s <%s>" string (puthash string 2 disambiguations)))))
|
|
||||||
(puthash (propertize string 'org-marker marker) marker table)))))
|
|
||||||
(path (marker)
|
|
||||||
(org-with-point-at marker
|
|
||||||
(let* ((path (thread-first (org-get-outline-path nil t)
|
|
||||||
(org-format-outline-path window-width nil "")
|
|
||||||
(org-split-string "")))
|
|
||||||
(formatted-path (if org-ql-completing-read-reverse-paths
|
|
||||||
(concat "\\" (string-join (reverse path) "\\"))
|
|
||||||
(concat "/" (string-join path "/")))))
|
|
||||||
formatted-path)))
|
|
||||||
(todo (marker)
|
|
||||||
(if-let (it (org-entry-get marker "TODO"))
|
|
||||||
(concat (propertize it 'face (org-get-todo-face it)) " ")
|
|
||||||
""))
|
|
||||||
(affix (completions)
|
|
||||||
;; (debug-message "AFFIX:%S" completions)
|
|
||||||
(cl-loop for completion in completions
|
|
||||||
for marker = (get-text-property 0 'org-marker completion)
|
|
||||||
for prefix = (todo marker)
|
|
||||||
for suffix = (concat (funcall path marker) " " (funcall snippet marker))
|
|
||||||
collect (list completion prefix suffix)))
|
|
||||||
(annotate (candidate)
|
|
||||||
;; (debug-message "ANNOTATE:%S" candidate)
|
|
||||||
(while-no-input
|
|
||||||
;; Using `while-no-input' here doesn't make it as responsive as,
|
|
||||||
;; e.g. Helm while typing, but it seems to help a little when using the
|
|
||||||
;; org-rifle-style snippets.
|
|
||||||
(or (funcall snippet (get-text-property 0 'org-marker candidate)) "")))
|
|
||||||
(group (candidate transform)
|
|
||||||
(pcase transform
|
|
||||||
(`nil (buffer-name (marker-buffer (get-text-property 0 'org-marker candidate))))
|
|
||||||
(_ candidate)))
|
|
||||||
(try (string _collection _pred point &optional _metadata)
|
|
||||||
;; (debug-message "TRY: STRING:%S" string)
|
|
||||||
(cons string point))
|
|
||||||
(all (string table pred _point)
|
|
||||||
;; (debug-message "all: STRING:%S" string)
|
|
||||||
;; (debug-message "all-completions RETURNS: %S" (all-completions string table pred))
|
|
||||||
(all-completions string table pred))
|
|
||||||
(collection (input _pred flag)
|
|
||||||
(pcase flag
|
|
||||||
('metadata (list 'metadata
|
|
||||||
(cons 'category 'org-heading)
|
|
||||||
(cons 'group-function #'group)
|
|
||||||
(cons 'affixation-function #'affix)
|
|
||||||
(cons 'annotation-function #'annotate)
|
|
||||||
(cons 'display-sort-function
|
|
||||||
(lambda (strings)
|
|
||||||
(let ((quoted-tokens (mapcar #'regexp-quote query-tokens)))
|
|
||||||
(sort strings
|
|
||||||
(lambda (a b)
|
|
||||||
(cl-labels ((matches
|
|
||||||
(s) (cl-loop for token in quoted-tokens
|
|
||||||
count (string-match-p token s))))
|
|
||||||
(> (matches a) (matches b))))))))))
|
|
||||||
(`t
|
|
||||||
;; (debug-message "COLLECTION:t INPUT:%S KEYS:%S"
|
|
||||||
;; input (hash-table-keys table))
|
|
||||||
;; It's not ideal to call `run-query' unconditionally here, but due to
|
|
||||||
;; the complexity of the "Programmed Completion" API, it's basically
|
|
||||||
;; necessary, and org-ql's caching should make it nearly free.
|
|
||||||
(run-query input)
|
|
||||||
(hash-table-keys table))
|
|
||||||
('lambda
|
|
||||||
;; (debug-message "COLLECTION:lambda INPUT:%S KEYS:%S"
|
|
||||||
;; input (hash-table-keys table))
|
|
||||||
(if (not (hash-table-empty-p table))
|
|
||||||
(when (gethash input table)
|
|
||||||
t)
|
|
||||||
(run-query input)
|
|
||||||
(when (gethash input table)
|
|
||||||
;; (debug-message "COLLECTION:lambda INPUT:%S FOUND" input)
|
|
||||||
t)))
|
|
||||||
(`nil
|
|
||||||
;; (debug-message "COLLECTION:nil INPUT:%S" input)
|
|
||||||
(if (not (hash-table-empty-p table))
|
|
||||||
(when (gethash input table)
|
|
||||||
t)
|
|
||||||
(run-query input)
|
|
||||||
;; (debug-message "COLLECTION:nil INPUT:%S KEYS:%S"
|
|
||||||
;; input (hash-table-keys table))
|
|
||||||
(cond ((hash-table-empty-p table)
|
|
||||||
nil)
|
|
||||||
((gethash input table)
|
|
||||||
t)
|
|
||||||
(t
|
|
||||||
;; FIXME: "it should return the longest common prefix
|
|
||||||
;; substring of all matches otherwise"...but there's no
|
|
||||||
;; function to compute that? At least returning an empty
|
|
||||||
;; string doesn't seem to break anything.
|
|
||||||
input))))
|
|
||||||
(`(boundaries . ,suffix)
|
|
||||||
;; (debug-message "COLLECTION:boundaries INPUT:%S SUFFIX:%S KEYS:%S"
|
|
||||||
;; input suffix (hash-table-keys table))
|
|
||||||
;; FIXME: This is unlikely to be correct, but I'm not even sure if it
|
|
||||||
;; can be correct in this case since the input (e.g. "todo: foo")
|
|
||||||
;; usually won't match a completion candidate directly.
|
|
||||||
`(boundaries 0 . ,(length suffix)))))
|
|
||||||
(run-query (input)
|
|
||||||
;; (debug-message "RUN-QUERY:%S" input)
|
|
||||||
(when query-prefix
|
|
||||||
(setf input (concat query-prefix input)))
|
|
||||||
(unless (or (string-empty-p input)
|
|
||||||
(equal last-input input))
|
|
||||||
;; (debug-message "RUN-QUERY:%S RUNNING" input)
|
|
||||||
(setf last-input input)
|
|
||||||
;; Clear hash table each time the user changes the input.
|
|
||||||
(clrhash table)
|
|
||||||
(clrhash disambiguations)
|
|
||||||
(when query-filter
|
|
||||||
(setf input (funcall query-filter input)))
|
|
||||||
(setf query-tokens
|
|
||||||
;; Remove any tokens that specify predicates or are too short.
|
|
||||||
(--select (not (or (string-match-p (rx bos (1+ (not (any ":"))) ":") it)
|
|
||||||
(< (length it) org-ql-completing-read-snippet-minimum-token-length)))
|
|
||||||
(split-string input nil t (rx blank)))
|
|
||||||
org-ql-completing-read-input-regexp
|
|
||||||
(when query-tokens
|
|
||||||
;; Limiting each context word to 15 characters prevents
|
|
||||||
;; excessively long, non-word strings from ending up in
|
|
||||||
;; snippets, which can adversely affect performance.
|
|
||||||
(rx-to-string `(seq (optional (repeat 1 3 (repeat 1 15 (not space)) (0+ space)))
|
|
||||||
bow (or ,@query-tokens) (0+ (not space))
|
|
||||||
(optional (repeat 1 3 (0+ space) (repeat 1 15 (not space))))))))
|
|
||||||
(org-ql-select buffers-files (org-ql--query-string-to-sexp input)
|
|
||||||
:narrow narrowp
|
|
||||||
:action #'action))))
|
|
||||||
(unless (listp buffers-files)
|
|
||||||
;; Since we map across this argument, we ensure it's a list.
|
|
||||||
(setf buffers-files (list buffers-files)))
|
|
||||||
;; NOTE: It seems that the `completing-read' machinery can call, abort, and re-call the
|
|
||||||
;; collection function while the user is typing, which can interrupt the machinery Org uses to
|
|
||||||
;; prepare an Org buffer when an Org file is loaded. This results in, e.g. the buffer being
|
|
||||||
;; left in fundamental-mode, unprepared to be used as an Org buffer, which breaks many things
|
|
||||||
;; and is very confusing for the user. Ideally, of course, we would solve this in
|
|
||||||
;; `org-ql-select', and we already attempt to, but that function is called by the
|
|
||||||
;; `completing-read' machinery, which interrupts it, so we must work around this problem by
|
|
||||||
;; ensuring all of the BUFFERS-FILES are loaded and initialized before calling
|
|
||||||
;; `completing-read'.
|
|
||||||
(mapc #'org-ql--ensure-buffer buffers-files)
|
|
||||||
(let* ((completion-styles '(org-ql-completing-read))
|
|
||||||
(completion-styles-alist (cons (list 'org-ql-completing-read #'try #'all "Org QL Find")
|
|
||||||
completion-styles-alist))
|
|
||||||
(selected
|
|
||||||
(minibuffer-with-setup-hook
|
|
||||||
(lambda ()
|
|
||||||
(use-local-map (make-composed-keymap org-ql-completing-read-map (current-local-map))))
|
|
||||||
(cl-letf* (((symbol-function 'org-ql-completing-read-export)
|
|
||||||
(lambda ()
|
|
||||||
(interactive)
|
|
||||||
(run-at-time 0 nil
|
|
||||||
#'org-ql-search
|
|
||||||
buffers-files
|
|
||||||
(minibuffer-contents-no-properties))
|
|
||||||
(if (fboundp 'minibuffer-quit-recursive-edit)
|
|
||||||
(minibuffer-quit-recursive-edit)
|
|
||||||
(abort-recursive-edit))))
|
|
||||||
((symbol-function 'embark-export)
|
|
||||||
(symbol-function 'org-ql-completing-read-export)))
|
|
||||||
(completing-read prompt #'collection nil t)))))
|
|
||||||
;; (debug-message "SELECTED:%S KEYS:%S" selected (hash-table-keys table))
|
|
||||||
(or (gethash selected table)
|
|
||||||
;; If there are completions in the table, but none of them exactly match the user input
|
|
||||||
;; (e.g. a heading "foo" that matches a query "todo:"), `completing-read' will not
|
|
||||||
;; select it automatically, so we return it ourselves. But note that this is not
|
|
||||||
;; necessarily correct. For example, if the user types "todo:" and gets a list of
|
|
||||||
;; completions ("foo" "bar"), and then changes the input to "ba" and presses RET
|
|
||||||
;; immediately (without getting a new list of completions), the table will include "foo"
|
|
||||||
;; and "bar", and we will return "foo"'s value rather than the first match for the query
|
|
||||||
;; "ba", because `completing-read' will not cause the COLLECTION function to run a new
|
|
||||||
;; query for the new input.
|
|
||||||
(car (hash-table-values table))
|
|
||||||
(user-error "No results for input"))))))
|
|
||||||
|
|
||||||
(defun org-ql-completing-read--snippet-simple (&optional _input-regexp)
|
|
||||||
"Return a snippet of the current entry.
|
|
||||||
Returns up to `org-ql-completing-read-snippet-length' characters."
|
|
||||||
(save-excursion
|
|
||||||
(org-end-of-meta-data t)
|
|
||||||
(unless (org-at-heading-p)
|
|
||||||
(let ((end (min (+ (point) org-ql-completing-read-snippet-length)
|
|
||||||
(org-entry-end-position))))
|
|
||||||
(concat org-ql-completing-read-snippet-prefix
|
|
||||||
(truncate-string-to-width
|
|
||||||
(replace-regexp-in-string "\n" " " (buffer-substring (point) end)
|
|
||||||
t t)
|
|
||||||
50 nil nil t))))))
|
|
||||||
|
|
||||||
(defun org-ql-completing-read--snippet-regexp (&optional input-regexp)
|
|
||||||
"Return a snippet of the current entry's matches for INPUT-REGEXP."
|
|
||||||
;; REGEXP may be nil if there are no qualifying tokens in the query.
|
|
||||||
(when input-regexp
|
|
||||||
(save-excursion
|
|
||||||
(org-end-of-meta-data t)
|
|
||||||
(unless (org-at-heading-p)
|
|
||||||
(let* ((end (org-entry-end-position))
|
|
||||||
(snippets (cl-loop while (re-search-forward input-regexp end t)
|
|
||||||
concat (match-string 0) concat "…"
|
|
||||||
do (goto-char (match-end 0)))))
|
|
||||||
(unless (string-empty-p snippets)
|
|
||||||
(concat org-ql-completing-read-snippet-prefix
|
|
||||||
(replace-regexp-in-string (rx (1+ "\n")) " " snippets t t))))))))
|
|
||||||
|
|
||||||
;;;; Footer
|
|
||||||
|
|
||||||
(provide 'org-ql-completing-read)
|
|
||||||
|
|
||||||
;;; org-ql-completing-read.el ends here
|
|
||||||
233
org-ql-find.el
233
org-ql-find.el
|
|
@ -1,233 +0,0 @@
|
||||||
;;; org-ql-find.el --- Find headings with completion using org-ql -*- lexical-binding: t; -*-
|
|
||||||
|
|
||||||
;; Copyright (C) 2022-2023 Adam Porter
|
|
||||||
|
|
||||||
;; Author: Adam Porter <adam@alphapapa.net>
|
|
||||||
|
|
||||||
;; This program is free software; you can redistribute it and/or modify
|
|
||||||
;; it under the terms of the GNU General Public License as published by
|
|
||||||
;; the Free Software Foundation, either version 3 of the License, or
|
|
||||||
;; (at your option) any later version.
|
|
||||||
|
|
||||||
;; This program is distributed in the hope that it will be useful,
|
|
||||||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
;; GNU General Public License for more details.
|
|
||||||
|
|
||||||
;; You should have received a copy of the GNU General Public License
|
|
||||||
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
;;; Commentary:
|
|
||||||
|
|
||||||
;; This library provides a way to quickly find and go to Org entries
|
|
||||||
;; selected with Emacs's built-in completions API (so it works with
|
|
||||||
;; packages that extend it, like Vertico, Marginalia, etc). It works
|
|
||||||
;; like `helm-org-ql' but does not require Helm.
|
|
||||||
|
|
||||||
;;; Code:
|
|
||||||
|
|
||||||
(require 'cl-lib)
|
|
||||||
|
|
||||||
(require 'org)
|
|
||||||
(require 'org-ql)
|
|
||||||
(require 'org-ql-search)
|
|
||||||
(require 'org-ql-completing-read)
|
|
||||||
|
|
||||||
(declare-function org-ql--normalize-query "org-ql" t t)
|
|
||||||
|
|
||||||
;;;; Customization
|
|
||||||
|
|
||||||
(defgroup org-ql-find nil
|
|
||||||
"Options for `org-ql-find'."
|
|
||||||
:group 'org-ql)
|
|
||||||
|
|
||||||
(defcustom org-ql-find-goto-hook '(org-show-entry org-reveal)
|
|
||||||
"Functions called when selecting an entry."
|
|
||||||
;; TODO: Add common choices, including `org-tree-to-indirect-buffer'.
|
|
||||||
:type 'hook)
|
|
||||||
|
|
||||||
(defcustom org-ql-find-display-buffer-action '(display-buffer-same-window)
|
|
||||||
"Display buffer action list for `org-ql-find'.
|
|
||||||
See function `display-buffer'."
|
|
||||||
:type 'sexp)
|
|
||||||
|
|
||||||
;;;; Commands
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(cl-defun org-ql-find (buffers-files &key query-prefix query-filter widen
|
|
||||||
(prompt "Find entry: "))
|
|
||||||
"Go to an Org entry in BUFFERS-FILES selected by searching entries with `org-ql'.
|
|
||||||
Interactively, search the buffers and files relevant to the
|
|
||||||
current buffer (i.e. in `org-agenda-mode', the value of
|
|
||||||
`org-ql-view-buffers-files' or `org-agenda-contributing-files';
|
|
||||||
in `org-mode', that buffer).
|
|
||||||
|
|
||||||
With one or more universal prefix arguments, WIDEN buffers before
|
|
||||||
searching (otherwise, respect any narrowing). With two universal
|
|
||||||
prefix arguments, select multiple buffers to search with
|
|
||||||
completion and PROMPT.
|
|
||||||
|
|
||||||
QUERY-PREFIX may be a string to prepend to the query (e.g. use
|
|
||||||
\"heading:\" to only search headings, easily creating a custom
|
|
||||||
command that saves the user from having to type it).
|
|
||||||
|
|
||||||
QUERY-FILTER may be a function through which the query the user
|
|
||||||
types is filtered before execution (e.g. it could replace spaces
|
|
||||||
with commas to turn multiple tokens, which would normally be
|
|
||||||
treated as multiple predicates, into multiple arguments to a
|
|
||||||
single predicate)."
|
|
||||||
(interactive (list (org-ql-find--buffers
|
|
||||||
:read-buffer-p (equal '(16) current-prefix-arg))
|
|
||||||
:widen current-prefix-arg))
|
|
||||||
(let ((marker (save-restriction
|
|
||||||
(when (and widen (equal (current-buffer) buffers-files))
|
|
||||||
(widen))
|
|
||||||
(org-ql-completing-read buffers-files
|
|
||||||
:narrowp (not widen)
|
|
||||||
:query-prefix query-prefix
|
|
||||||
:query-filter query-filter
|
|
||||||
:prompt prompt))))
|
|
||||||
(set-buffer (or (buffer-base-buffer (marker-buffer marker))
|
|
||||||
(marker-buffer marker)))
|
|
||||||
(pop-to-buffer (current-buffer) org-ql-find-display-buffer-action)
|
|
||||||
(without-restriction
|
|
||||||
(goto-char marker)
|
|
||||||
(run-hook-with-args 'org-ql-find-goto-hook))
|
|
||||||
(when (equal (current-buffer) (marker-buffer marker))
|
|
||||||
;; Ensure point is still within visible portion of buffer. (If
|
|
||||||
;; `org-tree-to-indirect-buffer' is used in `org-ql-find-goto-hook',
|
|
||||||
;; the buffer will have been changed and it won't matter; otherwise,
|
|
||||||
;; the buffer could have been narrowed to a region excluding the
|
|
||||||
;; selected entry.)
|
|
||||||
(let ((end-of-subtree (org-with-point-at marker
|
|
||||||
(org-end-of-subtree 'invisible-ok))))
|
|
||||||
(unless (and (<= (point-min) marker)
|
|
||||||
(>= (point-max) end-of-subtree))
|
|
||||||
(widen)
|
|
||||||
(goto-char marker))))))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun org-ql-refile (marker)
|
|
||||||
"Refile current entry to MARKER (interactively, one selected with `org-ql').
|
|
||||||
Interactive completion uses files listed in `org-refile-targets',
|
|
||||||
which see (but only the files are used)."
|
|
||||||
(interactive (let ((buffers-files (delete-dups
|
|
||||||
;; Always include the current buffer.
|
|
||||||
(cons (current-buffer)
|
|
||||||
(cl-loop for (files-spec . _candidate-spec) in org-refile-targets
|
|
||||||
append (cl-typecase files-spec
|
|
||||||
(null (list (current-buffer)))
|
|
||||||
(symbol (pcase (funcall files-spec)
|
|
||||||
((and (pred stringp) file) (list file))
|
|
||||||
((and (pred listp) files) files)))
|
|
||||||
(list files-spec)))))))
|
|
||||||
(list (org-ql-completing-read buffers-files :prompt "Refile to: "))))
|
|
||||||
(let ((buffer (or (buffer-base-buffer (marker-buffer marker))
|
|
||||||
(marker-buffer marker))))
|
|
||||||
(org-refile nil nil
|
|
||||||
;; The RFLOC argument:
|
|
||||||
(list
|
|
||||||
;; Name
|
|
||||||
(org-with-point-at marker
|
|
||||||
(nth 4 (org-heading-components)))
|
|
||||||
;; File
|
|
||||||
(buffer-file-name buffer)
|
|
||||||
;; nil
|
|
||||||
nil
|
|
||||||
;; Position
|
|
||||||
marker))))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun org-ql-find-in-agenda ()
|
|
||||||
"Call `org-ql-find' on `org-agenda-files'."
|
|
||||||
(interactive)
|
|
||||||
(org-ql-find (org-agenda-files)))
|
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun org-ql-find-in-org-directory ()
|
|
||||||
"Call `org-ql-find' on files in `org-directory'."
|
|
||||||
(interactive)
|
|
||||||
(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)
|
|
||||||
|
|
||||||
;;; org-ql-find.el ends here
|
|
||||||
159
org-ql-search.el
159
org-ql-search.el
|
|
@ -1,7 +1,5 @@
|
||||||
;;; 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
|
||||||
|
|
||||||
|
|
@ -40,40 +38,19 @@
|
||||||
(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
|
||||||
(cond ((fboundp 'org-link--normalize-string) #'org-link--normalize-string)
|
(cond ((fboundp 'org-link--normalize-string) #'org-link--normalize-string)
|
||||||
((fboundp 'org-link-heading-search-string) #'org-link-heading-search-string)
|
((fboundp 'org-link-heading-search-string) #'org-link-heading-search-string)
|
||||||
((fboundp 'org-make-org-heading-search-string) #'org-make-org-heading-search-string)
|
((fboundp 'org-make-org-heading-search-string) #'org-make-org-heading-search-string)
|
||||||
(t (error "org-ql: Unable to define alias `org-ql-search--link-heading-search-string'. This may affect links in dynamic blocks. Please report this as a bug"))))
|
(t (warn "org-ql: Unable to define alias `org-ql-search--link-heading-search-string'. This may affect links in dynamic blocks. Please report this as a bug.")
|
||||||
|
#'identity)))
|
||||||
(defalias 'org-ql-search--org-make-link-string
|
|
||||||
(cond ((fboundp 'org-link-make-string) #'org-link-make-string)
|
|
||||||
((fboundp 'org-make-link-string) #'org-make-link-string)
|
|
||||||
(t (error "org-ql: Unable to define alias `org-ql-search--org-make-link-string'. Please report this as a bug"))))
|
|
||||||
|
|
||||||
(defalias 'org-ql-search--org-link-store-props
|
|
||||||
(cond ((fboundp 'org-link-store-props) #'org-link-store-props)
|
|
||||||
((fboundp 'org-store-link-props) #'org-store-link-props)
|
|
||||||
(t (error "org-ql: Unable to define alias `org-ql-search--org-link-store-props'. Please report this as a bug"))))
|
|
||||||
|
|
||||||
(defalias 'org-ql--org-hide-archived-subtrees
|
|
||||||
(if (version<= "9.6" org-version)
|
|
||||||
'org-fold-hide-archived-subtrees
|
|
||||||
'org-hide-archived-subtrees))
|
|
||||||
|
|
||||||
(defalias 'org-ql--org-show-context
|
|
||||||
(if (version<= "9.6" org-version)
|
|
||||||
'org-fold-show-context
|
|
||||||
'org-show-context))
|
|
||||||
|
|
||||||
;;;; Variables
|
;;;; Variables
|
||||||
|
|
||||||
(defvar org-ql-block-header nil
|
(defvar org-ql-block-header nil
|
||||||
"Optional string overriding default header in `org-ql-block' agenda blocks.")
|
"An optional string to override the default header in `org-ql-block' agenda blocks.")
|
||||||
|
|
||||||
;;;; Customization
|
;;;; Customization
|
||||||
|
|
||||||
|
|
@ -107,8 +84,8 @@ directories, etc, which would make it slow to list the
|
||||||
The tree will show the lines where the query matches, and any
|
The tree will show the lines where the query matches, and any
|
||||||
other context defined in `org-show-context-detail', which see.
|
other context defined in `org-show-context-detail', which see.
|
||||||
|
|
||||||
QUERY is an `org-ql' query in either sexp or string form (see
|
QUERY is an `org-ql' query sexp (quoted, since this is a
|
||||||
Info node `(org-ql)Queries').
|
function). BUFFER defaults to the current buffer.
|
||||||
|
|
||||||
When KEEP-PREVIOUS is non-nil (interactively, with prefix), the
|
When KEEP-PREVIOUS is non-nil (interactively, with prefix), the
|
||||||
outline is not reset to the overview state before finding
|
outline is not reset to the overview state before finding
|
||||||
|
|
@ -116,7 +93,7 @@ matches, which allows stacking calls to this command.
|
||||||
|
|
||||||
Runs `org-occur-hook' after making the sparse tree."
|
Runs `org-occur-hook' after making the sparse tree."
|
||||||
;; Code based on `org-occur'.
|
;; Code based on `org-occur'.
|
||||||
(interactive (list (read-string "Query: ")
|
(interactive (list (read-minibuffer "Query: ")
|
||||||
:keep-previous current-prefix-arg))
|
:keep-previous current-prefix-arg))
|
||||||
(with-current-buffer buffer
|
(with-current-buffer buffer
|
||||||
(unless keep-previous
|
(unless keep-previous
|
||||||
|
|
@ -124,24 +101,14 @@ Runs `org-occur-hook' after making the sparse tree."
|
||||||
;; we remove existing `org-occur' highlights, just in case.
|
;; we remove existing `org-occur' highlights, just in case.
|
||||||
(org-remove-occur-highlights nil nil t)
|
(org-remove-occur-highlights nil nil t)
|
||||||
(org-overview))
|
(org-overview))
|
||||||
(let ((num-results 0)
|
(let ((num-results 0))
|
||||||
(query (pcase-exhaustive query
|
;; FIXME: Accept plain queries as well.
|
||||||
((and (pred stringp)
|
|
||||||
(rx bos (0+ blank) (or "(" "\"")))
|
|
||||||
;; Read sexp query from string.
|
|
||||||
(read query))
|
|
||||||
((pred stringp)
|
|
||||||
;; Parse string query into sexp query.
|
|
||||||
(org-ql--query-string-to-sexp query))
|
|
||||||
((pred listp)
|
|
||||||
;; Sexp query.
|
|
||||||
query))))
|
|
||||||
(org-ql-select buffer query
|
(org-ql-select buffer query
|
||||||
:action (lambda ()
|
:action (lambda ()
|
||||||
(org-ql--org-show-context 'occur-tree)
|
(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-ql--org-hide-archived-subtrees (point-min) (point-max)))
|
(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))
|
||||||
|
|
@ -171,7 +138,7 @@ SUPER-GROUPS: An `org-super-agenda' group set. See variable
|
||||||
selectors'.
|
selectors'.
|
||||||
|
|
||||||
NARROW: When non-nil, don't widen buffers before
|
NARROW: When non-nil, don't widen buffers before
|
||||||
searching. Interactively, with prefix, leave narrowed.
|
searching. Interactively, with prefix, leave narrowed.
|
||||||
|
|
||||||
SORT: One or a list of `org-ql' sorting functions, like `date' or
|
SORT: One or a list of `org-ql' sorting functions, like `date' or
|
||||||
`priority' (see Info node `(org-ql)Listing / acting-on results').
|
`priority' (see Info node `(org-ql)Listing / acting-on results').
|
||||||
|
|
@ -186,7 +153,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 (equal current-prefix-arg '(4)))
|
:narrow (or org-ql-view-narrow (eq 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'
|
||||||
|
|
@ -222,28 +189,23 @@ 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 :strings strings))))
|
(org-ql-view--display :buffer buffer :header header
|
||||||
|
:string (s-join "\n" strings)))))
|
||||||
|
|
||||||
;;;###autoload
|
;;;###autoload
|
||||||
(defun org-ql-search-block (args)
|
(defun org-ql-search-block (query)
|
||||||
"Insert items for ARGS into current buffer.
|
"Insert items for QUERY into current buffer.
|
||||||
Intended to be used as a user-defined function in
|
QUERY should be an `org-ql' query form. Intended to be used as a
|
||||||
`org-agenda-custom-commands'. ARGS corresponds to the `match'
|
user-defined function in `org-agenda-custom-commands'. QUERY
|
||||||
item in the custom command form. It should be a list of
|
corresponds to the `match' item in the custom command form.
|
||||||
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 the header is formed
|
string for the block, otherwise a the header is formed
|
||||||
automatically from the query."
|
automatically from the query."
|
||||||
(pcase-let ((`(,query . ,(map :header :sort)) args)
|
(let (narrow-p old-beg old-end)
|
||||||
(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
|
||||||
|
|
@ -254,7 +216,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 :sort sort)))
|
:narrow narrow-p)))
|
||||||
(when narrow-p
|
(when narrow-p
|
||||||
;; Restore buffer's previous restrictions.
|
;; Restore buffer's previous restrictions.
|
||||||
(with-current-buffer from
|
(with-current-buffer from
|
||||||
|
|
@ -264,25 +226,16 @@ 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)))
|
||||||
;; FIXME: Should we really use `org-ql-block-header' AND `header', or just one of them?
|
(insert (org-add-props (or org-ql-block-header (org-ql-view--header-line-format
|
||||||
(insert (org-add-props (or org-ql-block-header header
|
:buffers-files from :query query))
|
||||||
(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.
|
||||||
;; However, `org-agenda-finalize-entries' sorts entries with `org-entries-lessp', which
|
(->> items
|
||||||
;; overrides the sorting `org-ql' has already done, so we rebind `org-entries-lessp' to
|
(-map #'org-ql-view--format-element)
|
||||||
;; prevent it from affecting sort order. (Ideally we would let `org-entries-lessp'
|
org-agenda-finalize-entries
|
||||||
;; handle sorting, but that's not possible, because we can't add the `type' text property
|
insert)
|
||||||
;; 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
|
||||||
|
|
@ -324,16 +277,13 @@ Valid parameters include:
|
||||||
:ts-format Optional format string used to format
|
:ts-format Optional format string used to format
|
||||||
timestamp-based columns.
|
timestamp-based columns.
|
||||||
|
|
||||||
For example, an org-ql dynamic block header could look like
|
For example, an org-ql dynamic block header could look like:
|
||||||
this (must be a single line in the Org buffer):
|
|
||||||
|
|
||||||
#+BEGIN: org-ql :query (todo \"UNDERWAY\")
|
#+BEGIN: org-ql :query (todo \"UNDERWAY\") :columns (priority todo heading) :sort (priority date) :ts-format \"%Y-%m-%d %H:%M\""
|
||||||
:columns (priority todo heading) :sort (priority date)
|
|
||||||
:ts-format \"%Y-%m-%d %H:%M\""
|
|
||||||
(-let* (((&plist :query :columns :sort :ts-format :take) params)
|
(-let* (((&plist :query :columns :sort :ts-format :take) params)
|
||||||
(query (cl-etypecase query
|
(query (cl-etypecase query
|
||||||
(string (org-ql--query-string-to-sexp query))
|
(string (org-ql--query-string-to-sexp query))
|
||||||
(list ;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code.
|
(list ;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code.
|
||||||
(org-ql--ask-unsafe-query query)
|
(org-ql--ask-unsafe-query query)
|
||||||
query)))
|
query)))
|
||||||
(columns (or columns '(heading todo (priority "P"))))
|
(columns (or columns '(heading todo (priority "P"))))
|
||||||
|
|
@ -346,7 +296,7 @@ this (must be a single line in the Org buffer):
|
||||||
(cons 'heading (lambda (element)
|
(cons 'heading (lambda (element)
|
||||||
(let ((normalized-heading
|
(let ((normalized-heading
|
||||||
(org-ql-search--link-heading-search-string (org-element-property :raw-value element))))
|
(org-ql-search--link-heading-search-string (org-element-property :raw-value element))))
|
||||||
(org-ql-search--org-make-link-string normalized-heading (org-link-display-format normalized-heading)))))
|
(org-make-link-string normalized-heading (org-link-display-format normalized-heading)))))
|
||||||
(cons 'priority (lambda (element)
|
(cons 'priority (lambda (element)
|
||||||
(--when-let (org-element-property :priority element)
|
(--when-let (org-element-property :priority element)
|
||||||
(char-to-string it))))
|
(char-to-string it))))
|
||||||
|
|
@ -363,24 +313,23 @@ 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-ql-view--resolve-element-properties
|
:select '(org-element-headline-parser (line-end-position))
|
||||||
(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 (element)
|
(cl-labels ((format-element
|
||||||
(string-join (cl-loop for column in columns
|
(element) (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)))
|
||||||
|
|
@ -388,7 +337,7 @@ this (must be a single line in the Org buffer):
|
||||||
columns)
|
columns)
|
||||||
" | ")
|
" | ")
|
||||||
" |" "\n")
|
" |" "\n")
|
||||||
(insert "|- \n") ; Separator hline
|
(insert "|- \n") ; Separator hline
|
||||||
(dolist (element elements)
|
(dolist (element elements)
|
||||||
(insert "| " (format-element element) " |" "\n"))
|
(insert "| " (format-element element) " |" "\n"))
|
||||||
(delete-char -1)
|
(delete-char -1)
|
||||||
|
|
@ -396,24 +345,18 @@ this (must be a single line in the Org buffer):
|
||||||
|
|
||||||
;;;; Functions
|
;;;; Functions
|
||||||
|
|
||||||
(defvar org-ql-search-directories-files-error
|
|
||||||
;; Workaround to silence byte-compiler which thinks having this string in an
|
|
||||||
;; argument's default value form is a too-long docstring.
|
|
||||||
"No DIRECTORIES given, and `org-directory' doesn't exist")
|
|
||||||
|
|
||||||
(cl-defun org-ql-search-directories-files
|
(cl-defun org-ql-search-directories-files
|
||||||
(&key (directories
|
(&key (directories (if (file-exists-p org-directory)
|
||||||
(if (file-exists-p org-directory)
|
(list org-directory)
|
||||||
(list org-directory)
|
(user-error "Org-ql-search-directories-files: No DIRECTORIES given, and `org-directory' doesn't exist")))
|
||||||
(user-error org-ql-search-directories-files-error)))
|
|
||||||
(recurse org-ql-search-directories-files-recursive)
|
(recurse org-ql-search-directories-files-recursive)
|
||||||
(regexp org-ql-search-directories-files-regexp))
|
(regexp org-ql-search-directories-files-regexp))
|
||||||
"Return list of matching files in DIRECTORIES.
|
"Return list of matching files in DIRECTORIES, a list of directory paths.
|
||||||
When RECURSE is non-nil, recurse into subdirectories. When
|
When RECURSE is non-nil, recurse into subdirectories. When
|
||||||
REGEXP is non-nil, only return files that match REGEXP."
|
REGEXP is non-nil, only return files that match REGEXP."
|
||||||
(let ((files (->> directories
|
(let ((files (->> directories
|
||||||
(--map (f-files it nil recurse))
|
(--map (f-files it nil recurse))
|
||||||
-flatten)))
|
-flatten)))
|
||||||
(if regexp
|
(if regexp
|
||||||
(--select (string-match regexp it)
|
(--select (string-match regexp it)
|
||||||
files)
|
files)
|
||||||
|
|
|
||||||
305
org-ql-view.el
305
org-ql-view.el
|
|
@ -1,7 +1,5 @@
|
||||||
;;; 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,9 +40,10 @@
|
||||||
|
|
||||||
(require 'org-ql)
|
(require 'org-ql)
|
||||||
|
|
||||||
|
;; FIXME: check-declare declares "function not found", even though it
|
||||||
|
;; clearly is. It seems to not handle cl-defun, even though its code
|
||||||
|
;; appears to account for it.
|
||||||
(declare-function org-ql-search "org-ql-search" t)
|
(declare-function org-ql-search "org-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)
|
||||||
|
|
@ -57,18 +56,7 @@
|
||||||
(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-view)
|
:group 'org-ql)
|
||||||
|
|
||||||
(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
|
||||||
|
|
||||||
|
|
@ -165,11 +153,11 @@ See info node `(elisp)Cyclic Window Ordering'."
|
||||||
(interactive)
|
(interactive)
|
||||||
(let* ((ts (ts-now))
|
(let* ((ts (ts-now))
|
||||||
(beg-of-week (->> ts
|
(beg-of-week (->> ts
|
||||||
(ts-adjust 'day (- (ts-dow (ts-now))))
|
(ts-adjust 'day (- (ts-dow (ts-now))))
|
||||||
(ts-apply :hour 0 :minute 0 :second 0)))
|
(ts-apply :hour 0 :minute 0 :second 0)))
|
||||||
(end-of-week (->> ts
|
(end-of-week (->> ts
|
||||||
(ts-adjust 'day (- 6 (ts-dow (ts-now))))
|
(ts-adjust 'day (- 6 (ts-dow (ts-now))))
|
||||||
(ts-apply :hour 23 :minute 59 :second 59))))
|
(ts-apply :hour 23 :minute 59 :second 59))))
|
||||||
(org-ql-search (org-agenda-files)
|
(org-ql-search (org-agenda-files)
|
||||||
`(ts-active :from ,beg-of-week
|
`(ts-active :from ,beg-of-week
|
||||||
:to ,end-of-week)
|
:to ,end-of-week)
|
||||||
|
|
@ -182,11 +170,11 @@ See info node `(elisp)Cyclic Window Ordering'."
|
||||||
(interactive)
|
(interactive)
|
||||||
(let* ((ts (ts-adjust 'day 7 (ts-now)))
|
(let* ((ts (ts-adjust 'day 7 (ts-now)))
|
||||||
(beg-of-week (->> ts
|
(beg-of-week (->> ts
|
||||||
(ts-adjust 'day (- (ts-dow (ts-now))))
|
(ts-adjust 'day (- (ts-dow (ts-now))))
|
||||||
(ts-apply :hour 0 :minute 0 :second 0)))
|
(ts-apply :hour 0 :minute 0 :second 0)))
|
||||||
(end-of-week (->> ts
|
(end-of-week (->> ts
|
||||||
(ts-adjust 'day (- 6 (ts-dow (ts-now))))
|
(ts-adjust 'day (- 6 (ts-dow (ts-now))))
|
||||||
(ts-apply :hour 23 :minute 59 :second 59))))
|
(ts-apply :hour 23 :minute 59 :second 59))))
|
||||||
(org-ql-search (org-agenda-files)
|
(org-ql-search (org-agenda-files)
|
||||||
`(ts-active :from ,beg-of-week
|
`(ts-active :from ,beg-of-week
|
||||||
:to ,end-of-week)
|
:to ,end-of-week)
|
||||||
|
|
@ -249,12 +237,6 @@ 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
|
||||||
|
|
@ -290,8 +272,8 @@ TYPE may be `ts', `ts-active', `ts-inactive', `clocked', or
|
||||||
`closed'."
|
`closed'."
|
||||||
(interactive (list :num-days (read-number "Days: ")
|
(interactive (list :num-days (read-number "Days: ")
|
||||||
:type (->> '(ts ts-active ts-inactive clocked closed)
|
:type (->> '(ts ts-active ts-inactive clocked closed)
|
||||||
(completing-read "Timestamp type: ")
|
(completing-read "Timestamp type: ")
|
||||||
intern)))
|
intern)))
|
||||||
;; It doesn't make much sense to use other date-based selectors to
|
;; It doesn't make much sense to use other date-based selectors to
|
||||||
;; look into the past, so to prevent confusion, we won't allow them.
|
;; look into the past, so to prevent confusion, we won't allow them.
|
||||||
(-let* ((query (pcase-exhaustive type
|
(-let* ((query (pcase-exhaustive type
|
||||||
|
|
@ -306,8 +288,7 @@ TYPE may be `ts', `ts-active', `ts-inactive', `clocked', or
|
||||||
|
|
||||||
;;;###autoload
|
;;;###autoload
|
||||||
(cl-defun org-ql-view-sidebar (&key (slot org-ql-view-list-slot))
|
(cl-defun org-ql-view-sidebar (&key (slot org-ql-view-list-slot))
|
||||||
"Show `org-ql-view' view list sidebar.
|
"Show `org-ql-view' view list sidebar."
|
||||||
SLOT is passed to `display-buffer-in-side-window', which see."
|
|
||||||
;; TODO: Update sidebar when `org-ql-views' changes.
|
;; TODO: Update sidebar when `org-ql-views' changes.
|
||||||
(interactive)
|
(interactive)
|
||||||
(select-window
|
(select-window
|
||||||
|
|
@ -322,10 +303,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 (pos-bol) (pos-eol))))
|
(let ((key (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
|
||||||
(unless (string-empty-p key)
|
(unless (string-empty-p key)
|
||||||
(ov-clear :org-ql-view-selected)
|
(ov-clear :org-ql-view-selected)
|
||||||
(ov (pos-bol) (1+ (pos-eol)) :org-ql-view-selected t
|
(ov (point-at-bol) (1+ (point-at-eol)) :org-ql-view-selected t
|
||||||
'face '(:weight bold :inherit highlight))
|
'face '(:weight bold :inherit highlight))
|
||||||
(org-ql-view key))))
|
(org-ql-view key))))
|
||||||
|
|
||||||
|
|
@ -372,8 +353,7 @@ update search arguments."
|
||||||
(yes-or-no-p (format "Overwrite view \"%s\"?" name)))
|
(yes-or-no-p (format "Overwrite view \"%s\"?" name)))
|
||||||
(setf (map-elt org-ql-views name nil #'equal) plist)
|
(setf (map-elt org-ql-views name nil #'equal) plist)
|
||||||
(customize-set-variable 'org-ql-views org-ql-views)
|
(customize-set-variable 'org-ql-views org-ql-views)
|
||||||
(customize-mark-to-save 'org-ql-views)
|
(customize-mark-to-save 'org-ql-views))))
|
||||||
(custom-save-all))))
|
|
||||||
|
|
||||||
(defun org-ql-view-delete ()
|
(defun org-ql-view-delete ()
|
||||||
"Delete current view (with confirmation)."
|
"Delete current view (with confirmation)."
|
||||||
|
|
@ -383,13 +363,12 @@ update search arguments."
|
||||||
(--remove (equal (car it) org-ql-view-title)
|
(--remove (equal (car it) org-ql-view-title)
|
||||||
org-ql-views))
|
org-ql-views))
|
||||||
(customize-set-variable 'org-ql-views org-ql-views)
|
(customize-set-variable 'org-ql-views org-ql-views)
|
||||||
(customize-mark-to-save 'org-ql-views)
|
(customize-mark-to-save 'org-ql-views)))
|
||||||
(custom-save-all)))
|
|
||||||
|
|
||||||
(defun org-ql-view-customize ()
|
(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 (pos-bol) (pos-eol))))
|
(let ((key (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
|
||||||
(customize-option 'org-ql-views)
|
(customize-option 'org-ql-views)
|
||||||
(search-forward (concat "Name: " key))))
|
(search-forward (concat "Name: " key))))
|
||||||
|
|
||||||
|
|
@ -416,17 +395,17 @@ update search arguments."
|
||||||
(let ((inhibit-read-only t))
|
(let ((inhibit-read-only t))
|
||||||
(erase-buffer)
|
(erase-buffer)
|
||||||
(->> org-ql-views
|
(->> org-ql-views
|
||||||
(-map #'car)
|
(-map #'car)
|
||||||
(-sort (if org-ql-view-sidebar-sort-views
|
(-sort (if org-ql-view-sidebar-sort-views
|
||||||
#'string<
|
#'string<
|
||||||
#'ignore))
|
#'ignore))
|
||||||
(s-join "\n")
|
(s-join "\n")
|
||||||
insert))
|
insert))
|
||||||
(current-buffer)))
|
(current-buffer)))
|
||||||
|
|
||||||
(defvar bookmark-make-record-function)
|
(defvar bookmark-make-record-function)
|
||||||
|
|
||||||
(cl-defun org-ql-view--display (&key (buffer org-ql-view-buffer) header strings)
|
(cl-defun org-ql-view--display (&key (buffer org-ql-view-buffer) header string)
|
||||||
"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
|
||||||
|
|
@ -464,9 +443,7 @@ 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)
|
||||||
(dolist (string strings)
|
(insert string "\n")
|
||||||
(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))))))
|
||||||
|
|
@ -476,8 +453,7 @@ 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)
|
||||||
(propertize title 'face 'org-ql-view-title)
|
title " ")
|
||||||
" ")
|
|
||||||
""))
|
""))
|
||||||
(query-formatted (when query
|
(query-formatted (when query
|
||||||
(org-ql-view--format-query query)))
|
(org-ql-view--format-query query)))
|
||||||
|
|
@ -493,10 +469,9 @@ If TITLE, prepend it to the header."
|
||||||
(format "%s" (org-ql-view--contract-buffers-files buffers-files))))
|
(format "%s" (org-ql-view--contract-buffers-files buffers-files))))
|
||||||
(buffers-files-formatted (when buffers-files-formatted
|
(buffers-files-formatted (when buffers-files-formatted
|
||||||
(propertize (->> buffers-files-formatted
|
(propertize (->> buffers-files-formatted
|
||||||
(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)
|
||||||
|
|
@ -511,11 +486,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)
|
||||||
|
|
@ -528,22 +503,6 @@ 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
|
||||||
|
|
@ -573,20 +532,19 @@ 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 (b-f)
|
(cl-labels ((file-nameize
|
||||||
(abbreviate-file-name
|
(b-f) (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)))))
|
||||||
|
|
@ -646,7 +604,6 @@ 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
|
||||||
|
|
@ -661,7 +618,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 (car (alist-get "sort" params nil nil #'string=)))
|
(sort (when-let* ((stored-string (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))
|
||||||
|
|
@ -669,19 +626,17 @@ 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 (car (alist-get "super-groups" params nil nil #'string=))
|
(groups (--when-let (alist-get "super-groups" params nil nil #'string=)
|
||||||
(read it)))
|
(read it)))
|
||||||
(title (--when-let (car (alist-get "title" params nil nil #'string=))
|
(title (--when-let (alist-get "title" params nil nil #'string=)
|
||||||
(read it)))
|
(read it)))
|
||||||
(buffers-files (--if-let (car (alist-get "buffers-files" params nil nil #'string=))
|
(buffers-files (--if-let (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.
|
||||||
|
|
@ -699,27 +654,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 (thing)
|
(strings-or-file-buffers-p
|
||||||
(cl-etypecase thing
|
(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
|
;; TODO: Should indirect buffers be allowed? Maybe not, since their narrowing isn't preserved.
|
||||||
;; narrowing isn't preserved. On the other hand, it's possible to
|
;; On the other hand, it's possible to accidentally make a search view for an indirect buffer
|
||||||
;; accidentally make a search view for an indirect buffer that's
|
;; that's since been widened, and forcing the user to manually change that would be awkward,
|
||||||
;; since been widened, and forcing the user to manually change that
|
;; and trying to communicate the problem would be difficult, so maybe it's okay to allow it.
|
||||||
;; would be awkward, and trying to communicate the problem would be
|
(when (buffer-base-buffer thing)
|
||||||
;; difficult, so maybe it's okay to allow it.
|
(buffer-file-name (buffer-base-buffer thing))))))))
|
||||||
(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 "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)
|
||||||
it (org-ql-view--format-query org-ql-view-query)))
|
it (org-ql-view--format-query org-ql-view-query)))
|
||||||
(buffers-files (prompt-for (org-ql-view--contract-buffers-files org-ql-view-buffers-files)))
|
(buffers-files (prompt-for (org-ql-view--contract-buffers-files org-ql-view-buffers-files)))
|
||||||
|
|
@ -735,7 +688,8 @@ When opened, the link searches the buffer it's opened from."
|
||||||
"?" (url-build-query-string (delete nil params))))
|
"?" (url-build-query-string (delete nil params))))
|
||||||
(url (url-recreate-url (url-parse-make-urlobj "org-ql-search" nil nil nil nil
|
(url (url-recreate-url (url-parse-make-urlobj "org-ql-search" nil nil nil nil
|
||||||
filename))))
|
filename))))
|
||||||
(org-ql-search--org-link-store-props
|
;; FIXME: "Warning: ‘org-store-link-props’ is an obsolete function (as of Org 9.3); use ‘org-link-store-props’ instead"
|
||||||
|
(org-store-link-props
|
||||||
:type "org-ql-search"
|
:type "org-ql-search"
|
||||||
:link url
|
:link url
|
||||||
:description (concat "org-ql-search: " org-ql-view-title))))
|
:description (concat "org-ql-search: " org-ql-view-title))))
|
||||||
|
|
@ -750,8 +704,6 @@ 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)
|
||||||
|
|
@ -798,8 +750,8 @@ When opened, the link searches the buffer it's opened from."
|
||||||
(s-truncate (- (window-width) 15)
|
(s-truncate (- (window-width) 15)
|
||||||
(concat (propertize key 'face 'transient-argument) ": "
|
(concat (propertize key 'face 'transient-argument) ": "
|
||||||
(->> value
|
(->> value
|
||||||
org-ql-view--format-query
|
org-ql-view--format-query
|
||||||
(org-ql-view--font-lock-string 'emacs-lisp-mode)))))
|
(org-ql-view--font-lock-string 'emacs-lisp-mode)))))
|
||||||
|
|
||||||
(transient-define-infix org-ql-view--transient-title ()
|
(transient-define-infix org-ql-view--transient-title ()
|
||||||
;; TODO: Add an asterisk or something when the view has been modified but not saved.
|
;; TODO: Add an asterisk or something when the view has been modified but not saved.
|
||||||
|
|
@ -868,20 +820,6 @@ 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.
|
||||||
|
|
@ -891,7 +829,6 @@ 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
|
||||||
|
|
@ -913,15 +850,10 @@ 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)
|
||||||
;; TODO(B): Needs refactoring. A function like `org-ql-view--add-faces'
|
(org-link-display-format it)))
|
||||||
;; 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
|
(org-ql-view--add-todo-face it)))
|
||||||
(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)
|
||||||
|
|
@ -934,29 +866,21 @@ return an empty string."
|
||||||
(not type))
|
(not type))
|
||||||
append type)))
|
append type)))
|
||||||
;; No marker found
|
;; No marker found
|
||||||
(display-warning 'org-ql (format "No marker found for item: %s" title))
|
;; TODO: Use `display-warning' with `org-ql' as the type.
|
||||||
|
(warn "No marker found for item: %s" title)
|
||||||
(org-element-property :tags element))
|
(org-element-property :tags element))
|
||||||
(org-element-property :tags element)))
|
(org-element-property :tags element)))
|
||||||
(tag-string (when tag-list
|
(tag-string (when tag-list
|
||||||
(--> tag-list
|
(--> tag-list
|
||||||
(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 (or (org-element-property :CATEGORY element)
|
;; (category (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 (or (org-element-property :org-hd-marker element)
|
(habit-property (org-with-point-at (org-element-property :begin 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)
|
||||||
|
|
@ -966,20 +890,19 @@ return an empty string."
|
||||||
(remove-list-of-text-properties 0 (length string) '(line-prefix) string)
|
(remove-list-of-text-properties 0 (length string) '(line-prefix) string)
|
||||||
;; Add all the necessary properties and faces to the whole string
|
;; Add all the necessary properties and faces to the whole string
|
||||||
(--> string
|
(--> string
|
||||||
;; FIXME: Use proper prefix
|
;; FIXME: Use proper prefix
|
||||||
(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)))))
|
|
||||||
|
|
||||||
(defun org-ql-view--add-faces (element)
|
(defun org-ql-view--add-faces (element)
|
||||||
"Return ELEMENT with deadline and scheduled faces added."
|
"Return ELEMENT with deadline and scheduled faces added."
|
||||||
(->> element
|
(->> element
|
||||||
(org-ql-view--add-scheduled-face)
|
(org-ql-view--add-scheduled-face)
|
||||||
(org-ql-view--add-deadline-face)))
|
(org-ql-view--add-deadline-face)))
|
||||||
|
|
||||||
(defun org-ql-view--add-priority-face (string)
|
(defun org-ql-view--add-priority-face (string)
|
||||||
"Return STRING with priority face added."
|
"Return STRING with priority face added."
|
||||||
|
|
@ -1036,11 +959,11 @@ return an empty string."
|
||||||
((> today-day-number scheduled-day-number) 'org-scheduled-previously)
|
((> today-day-number scheduled-day-number) 'org-scheduled-previously)
|
||||||
(t 'org-scheduled)))
|
(t 'org-scheduled)))
|
||||||
(title (--> (org-element-property :raw-value element)
|
(title (--> (org-element-property :raw-value element)
|
||||||
(org-add-props it nil
|
(org-add-props it nil
|
||||||
'face face)))
|
'face face)))
|
||||||
(properties (--> (cadr element)
|
(properties (--> (cadr element)
|
||||||
(plist-put it :title title)
|
(plist-put it :title title)
|
||||||
(plist-put it :relative-due-date relative-due-date))))
|
(plist-put it :relative-due-date relative-due-date))))
|
||||||
(list (car element)
|
(list (car element)
|
||||||
properties))
|
properties))
|
||||||
;; Not scheduled
|
;; Not scheduled
|
||||||
|
|
@ -1056,24 +979,22 @@ 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
|
(relative-due-date (org-add-props (org-ql-view--format-relative-date difference-days) nil
|
||||||
(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))
|
||||||
;; FIXME: Unused for now: (today-p (= today-day-number deadline-day-number))
|
;; FIXME: Unused for now: (today-p (= today-day-number deadline-day-number))
|
||||||
(deadline-passed-fraction (--> (- deadline-day-number today-day-number)
|
(deadline-passed-fraction (--> (- deadline-day-number today-day-number)
|
||||||
(float it)
|
(float it)
|
||||||
(/ it (max org-deadline-warning-days 1))
|
(/ it (max org-deadline-warning-days 1))
|
||||||
(- 1 it)))
|
(- 1 it)))
|
||||||
(face (org-agenda-deadline-face deadline-passed-fraction))
|
(face (org-agenda-deadline-face deadline-passed-fraction))
|
||||||
(title (--> (org-element-property :raw-value element)
|
(title (--> (org-element-property :raw-value element)
|
||||||
(org-add-props it nil
|
(org-add-props it nil
|
||||||
'face face)))
|
'face face)))
|
||||||
(properties (--> (cadr element)
|
(properties (--> (cadr element)
|
||||||
(plist-put it :title title)
|
(plist-put it :title title)
|
||||||
(plist-put it :relative-due-date relative-due-date))))
|
(plist-put it :relative-due-date relative-due-date))))
|
||||||
(list (car element)
|
(list (car element)
|
||||||
properties))
|
properties))
|
||||||
;; No deadline
|
;; No deadline
|
||||||
|
|
@ -1092,6 +1013,10 @@ property."
|
||||||
;; These functions are somewhat regrettable because of the need to keep them
|
;; These functions are somewhat regrettable because of the need to keep them
|
||||||
;; in sync, but it seems worth it to provide users with the flexibility.
|
;; in sync, but it seems worth it to provide users with the flexibility.
|
||||||
|
|
||||||
|
;; FIXME: `check-declare' declares that this function is not in org-ql-search, even though
|
||||||
|
;; it is. It appears to happen because `org-ql-search-directories-files' is declared with
|
||||||
|
;; `cl-defun', because when I remove "cl-", it finds it. This makes no sense, because the
|
||||||
|
;; source code of `check-declare' shows that it searches for "cl-defun" declarations.
|
||||||
(declare-function org-ql-search-directories-files "org-ql-search" t)
|
(declare-function org-ql-search-directories-files "org-ql-search" t)
|
||||||
|
|
||||||
(defun org-ql-view--contract-buffers-files (buffers-files)
|
(defun org-ql-view--contract-buffers-files (buffers-files)
|
||||||
|
|
@ -1103,11 +1028,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 (list)
|
(cl-labels ((expand-files
|
||||||
(--map (cl-typecase it
|
(list) (--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)
|
||||||
|
|
@ -1129,10 +1054,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.
|
||||||
|
|
@ -1192,7 +1117,7 @@ The counterpart to `org-ql-view--contract-buffers-files'."
|
||||||
"todo")
|
"todo")
|
||||||
nil nil (when org-ql-view-sort
|
nil nil (when org-ql-view-sort
|
||||||
(prin1-to-string org-ql-view-sort)))
|
(prin1-to-string org-ql-view-sort)))
|
||||||
(--remove (equal "buffer-order" it)))))
|
(--remove (equal "buffer-order" it)))))
|
||||||
(pcase input
|
(pcase input
|
||||||
('nil nil)
|
('nil nil)
|
||||||
((and (pred listp) sort)
|
((and (pred listp) sort)
|
||||||
|
|
|
||||||
1160
org-ql.info
1160
org-ql.info
File diff suppressed because it is too large
Load diff
|
|
@ -1,10 +0,0 @@
|
||||||
* Alpha
|
|
||||||
|
|
||||||
Let us link to: [[id:74d357ac-fb9c-40d1-a63f-eca8a227321d][Bravo [a phrase in brackets]]].
|
|
||||||
|
|
||||||
* Bravo [a phrase in brackets]
|
|
||||||
:PROPERTIES:
|
|
||||||
:ID: 74d357ac-fb9c-40d1-a63f-eca8a227321d
|
|
||||||
:END:
|
|
||||||
|
|
||||||
* Charlie
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
#+title: org-ql test data for ~src~ predicate
|
|
||||||
|
|
||||||
* Alpha
|
|
||||||
|
|
||||||
#+begin_src elisp
|
|
||||||
(message "foo")
|
|
||||||
#+end_src
|
|
||||||
|
|
||||||
#+begin_src python
|
|
||||||
print("foo")
|
|
||||||
#+end_src
|
|
||||||
|
|
||||||
#+begin_src js
|
|
||||||
console.log("foo")
|
|
||||||
#+end_src
|
|
||||||
|
|
||||||
* Bravo
|
|
||||||
|
|
||||||
#+begin_src elisp
|
|
||||||
(message "bar")
|
|
||||||
#+end_src
|
|
||||||
|
|
||||||
#+begin_src python
|
|
||||||
print("bar")
|
|
||||||
#+end_src
|
|
||||||
|
|
||||||
* Charlie
|
|
||||||
|
|
||||||
This entry has no source block.
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
#+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./
|
|
||||||
|
|
||||||
1362
tests/test-org-ql.el
1362
tests/test-org-ql.el
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue