org_parser library

Classes

DecryptedContentSerializer
OrgBlock
#+begin_quote foo #+end_quote
A bracketed link, like
OrgCitation
A citation like cite:@key
OrgComment
OrgContent
A generic node that contains children
OrgContentGrammarDefinition
Content grammar definition
OrgContentParserDefinition
Content-level parser definition
OrgDateRangeTimestamp
OrgDecryptedContent
OrgDiaryTimestamp
OrgDocument
The top-level node representing a full Org document
OrgDrawer
A drawer, like
OrgDynamicBlock
#+BEGIN: myblockfunc :parameter1 value1 :parameter2 value2 ... #+END:
OrgEntity
An entity, like \Omega
A link to a file, like
OrgFileLinkGrammarDefinition
Grammar rules for file links, which are basically a mini-format of their own
OrgFileLinkParserDefinition
File link parser definition
OrgFixedWidthArea
A fixed-width area, like
OrgFootnote
A footnote, like
OrgFootnoteReference
A footnote reference, like [fn:1]
OrgGrammarDefinition
Top-level grammar definition
OrgHeadline
An Org headline, like
OrgHorizontalRule
A horizontal rule, like
OrgInlineSrcBlock
An inline source block, like src_sh{echo "hello world"}
OrgLatexBlock
A LaTeX block, like
OrgLatexInline
An inline LaTeX snippet, like $E=mc^2$
OrgLeafNode
OrgLinkTarget
A link target, like
OrgList
A list, like
OrgListItem
OrgListOrderedItem
An ordered list item, like
OrgListUnorderedItem
An unordered list item, like
OrgLocalVariables
OrgMacroReference
A macro reference, like
OrgMarkup
Emphasis markup, like
OrgMeta
A "meta" line, like
OrgNode
The base type of all Org AST objects
OrgParagraph
OrgParentNode
OrgParserDefinition
Top-level parser definitions
OrgPgpBlock
A link, like
OrgPlainText
Plain text that has no markup
OrgPlanningEntry
A planning line, like
OrgPlanningKeyword
A planning keyword, like SCHEDULED: or DEADLINE:
OrgProperty
A property in a drawer, like
OrgQueryAndMatcher
OrgQueryGrammarDefinition
Grammar rules for the section query language described at https://orgmode.org/manual/Matching-tags-and-properties.html
OrgQueryMatcher
A matcher for displaying the document as a "sparse tree" as in org-match-sparse-tree
OrgQueryNotMatcher
OrgQueryOrMatcher
OrgQueryParserDefinition
OrgQueryPropertyMatcher
OrgQueryTagMatcher
A word linkified to point to a radio target. This can only appear in a parsed tree if radio targets were supplied to the parser.
OrgRadioTarget
A link target, like
OrgSection
An Org section. May have nested sections, like
OrgSerializer
A class for serializing Org AST objects to Org Mode markup. Subclass and supply to OrgNode.toMarkup to customize serialization.
OrgSimpleTimestamp
A timestamp, like [2020-05-05 Tue]
OrgSrcBlock
A source block, like
OrgStatisticsCookie
OrgStatisticsFractionCookie
OrgStatisticsPercentageCookie
OrgSubscript
OrgSubSuperscript
OrgSuperscript
OrgTable
A table, like
OrgTableCell
OrgTableCellRow
OrgTableDividerRow
OrgTableRow
OrgTimeRangeTimestamp
OrgTimestamp
OrgTodoStates
A class representing the TODO states a la org-todo-keywords. Extract such states embedded in a document using extractTodoSettings.
OrgTree
A node potentially containing OrgSections
TodoGrammar
TodoParser

Enums

OrgAttachDirType
OrgStyle
Supported styles for OrgMarkup nodes

Extensions

ZipperExt on ZipperLocation<ZR, ZI, ZS>

Constants

defaultTodoStates → const OrgTodoStates

Properties

org → Parser
The top-level Org parser
final
File link parser
final
orgQuery → Parser
final
orgTodo → Parser
final

Functions

extractRadioTargets(OrgTree tree) → Set<String>
Extracts the radio targets from the given tree.
extractTodoSettings(OrgTree tree) → List<OrgTodoStates>
Extracts the TODO settings from #+TODO: and equivalent meta keywords in the given tree.
isOrgCustomIdUrl(String url) → bool
Identify URLs that point to a custom ID (starting with '#').
isOrgIdUrl(String url) → bool
Identify URLs that point to IDs (starting with 'id:').
isOrgLocalSectionUrl(String url) → bool
Identify URLs that point to a section within the current document (starting with '*')
orgId() → String
Generate a random ID for an Org node. Use this when creating a new node based on an existing node with copyWith, where both nodes will be present in the tree at the same time.
parseOrgCustomIdUrl(String url) → String
Return the CUSTOM_ID of the section pointed to by the URL. The URL must be one for which isOrgCustomIdUrl returns true.
parseOrgIdUrl(String url) → String
Return the ID of the section pointed to by the URL. The URL must be one for which isOrgCustomIdUrl returns true.
parseOrgLocalSectionUrl(String url) → String
Return the title of the section pointed to by the URL. The URL must be one for which isOrgLocalSectionUrl returns true.

Typedefs

OrgDate = ({String day, String? dayName, String month, String year})
OrgPath = List<OrgNode>
OrgTime = ({String hour, String minute})
OrgZipper = ZipperLocation<OrgNode, OrgLeafNode, OrgParentNode>