NAME
Org::Element - Base class for Org document elements
VERSION
This document describes version 0.560 of Org::Element (from Perl distribution Org-Parser), released on 2023-08-05.
SYNOPSIS
# Don't use directly, use the other Org::Element::* classes.DESCRIPTION
This is the base class for all the other Org element classes.
ATTRIBUTES
document => DOCUMENT
Link to document object. Elements need this to access file-wide settings, properties, etc.
parent => undef | ELEMENT
Link to parent element. Undef if this element is the root element.
children => undef | ARRAY_OF_ELEMENTS
METHODS
$el->children_as_string() => STR
Return a concatenation of children's as_string(), or "" if there are no children.
$el->as_string() => STR
Return the string representation of element. The default implementation will just use _str (if defined) concatenated with children_as_string().
$el->seniority => INT
Find out the ranking of brothers/sisters of all sibling. If we are the first child of parent, return 0. If we are the second child, return 1, and so on.
$el->prev_sibling() => ELEMENT | undef
$el->next_sibling() => ELEMENT | undef
$el->extra_walkables => LIST
Return extra walkable elements. The default is to return an empty list, but some elements can have this, for Org::Element::Headline's title is also a walkable element.
$el->walk(CODEREF)
Call CODEREF for node and all descendent nodes (and extra walkables), depth-first. Code will be given the element object as argument.
$el->find(CRITERIA) => ELEMENTS
Find subelements. CRITERIA can be a word (e.g. 'Headline' meaning of class 'Org::Element::Headline') or a class name ('Org::Element::ListItem') or a coderef (which will be given the element to test). Will return matched elements.
$el->walk_parents(CODE)
Run CODEREF for parent, and its parent, and so on until the root element (the document), or until CODEREF returns a false value. CODEREF will be supplied ($el, $parent). Will return the last parent walked.
$el->headline() => ELEMENT
Get current headline. Return undef if element is not under any headline.
$el->headlines() => ELEMENTS
Get current headline (in the first element of the result list), its parent, its parent's parent, and so on until the topmost headline. Return empty list if element is not under any headline.
$el->settings(CRITERIA) => ELEMENTS
Get Org::Element::Setting nodes directly under the element. Equivalent to:
my @settings = grep { $_->isa("Org::Element::Setting") } @{ $el->children };If CRITERIA is specified, will filter based on some criteria. CRITERIA can be a coderef, or a string to filter by setting's name, example:
my ($doc_title) = $doc->settings('TITLE');Take note of the list operator on the left because settings() return a list.
$el->field_name() => STR
Try to extract "field name", being defined as either some text on the left side:
DEADLINE: <2011-06-09 >or a description term in a description list:
- wedding anniversary :: <2011-06-10 >$el->remove()
Remove element from the tree. Basically just remove the element from its parent.
$el->die(STR)
Utility method to format die message.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Org-Parser.
SOURCE
Source repository is at https://github.com/perlancar/perl-Org-Parser.
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, 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=Org-Parser
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.