NAME
App::ListOrgHeadlinesFast - List & count Org headlines & todos
VERSION
This document describes version 0.486 of App::ListOrgHeadlinesFast (from Perl distribution App-OrgUtils), released on 2023-07-12.
FUNCTIONS
count_org_headlines
Usage:
count_org_headlines(%args) -> intCount Org headlines.
This routine uses simple regex instead of Org::Parser, for faster performance.
This function is not exported.
Arguments ('*' denotes required arguments):
ascendant_match => str|re
Only include headline whose ascendant matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.has_tags => array[str]
Only include headline which have all these tags.
input* => str
Value is either a string or an array of strings.
is_done => bool
Only include headline which is a done todo item.
is_todo => bool
Only include headline which is a todo item.
lacks_tags => array[str]
Only include headline which lack all these tags.
level => int
(No description)
match => str|re
Only include headline which matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.max_level => int
(No description)
min_level => int
(No description)
parent_match => str|re
Only include headline whose parent matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.
Return value: (int)
count_org_todos
Usage:
count_org_todos(%args) -> intCount Org todos.
This routine uses simple regex instead of Org::Parser, for faster performance.
This function is not exported.
Arguments ('*' denotes required arguments):
ascendant_match => str|re
Only include headline whose ascendant matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.has_tags => array[str]
Only include headline which have all these tags.
input* => str
Value is either a string or an array of strings.
is_done => bool
Only include headline which is a done todo item.
lacks_tags => array[str]
Only include headline which lack all these tags.
level => int
(No description)
match => str|re
Only include headline which matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.max_level => int
(No description)
min_level => int
(No description)
parent_match => str|re
Only include headline whose parent matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.
Return value: (int)
list_org_headlines
Usage:
list_org_headlines(%args) -> array[str]List Org headlines.
This routine uses simple regex instead of Org::Parser, for faster performance.
This function is not exported.
Arguments ('*' denotes required arguments):
ascendant_match => str|re
Only include headline whose ascendant matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.has_tags => array[str]
Only include headline which have all these tags.
input* => str
Value is either a string or an array of strings.
is_done => bool
Only include headline which is a done todo item.
is_todo => bool
Only include headline which is a todo item.
lacks_tags => array[str]
Only include headline which lack all these tags.
level => int
(No description)
match => str|re
Only include headline which matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.max_level => int
(No description)
min_level => int
(No description)
parent_match => str|re
Only include headline whose parent matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.
Return value: (array[str])
list_org_todos
Usage:
list_org_todos(%args) -> array[str]List Org todos.
This routine uses simple regex instead of Org::Parser, for faster performance.
This function is not exported.
Arguments ('*' denotes required arguments):
ascendant_match => str|re
Only include headline whose ascendant matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.has_tags => array[str]
Only include headline which have all these tags.
input* => str
Value is either a string or an array of strings.
is_done => bool
Only include headline which is a done todo item.
lacks_tags => array[str]
Only include headline which lack all these tags.
level => int
(No description)
match => str|re
Only include headline which matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.max_level => int
(No description)
min_level => int
(No description)
parent_match => str|re
Only include headline whose parent matches this.
Value is either a string or a regex. If string is in the form of
/.../or/.../iit is assumed to be a regex.
Return value: (array[str])
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-OrgUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-OrgUtils.
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -lIf you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-OrgUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.