data class OrgHeading(val title: OrgLine, val level: OrgHeadingLevel, val tags: OrgTags? = null, val todoState: OrgTODOState? = null, val priority: OrgPriority? = null, val planningInfo: OrgPlanningInfo? = null, val properties: OrgProperties? = null, var tokens: List<Token>) : OrgElem

OrgHeadingLevel

@Serializable

data class OrgHeadingLevel(val level: Int, var tokens: List<Token>) : OrgElem

OrgInlineElem

@Serializable

sealed class OrgInlineElem : OrgElem

A piece of text in org mode with consistent styling and interpretation

OrgLine

@Serializable

data class OrgLine(val items: List<OrgInlineElem>, var tokens: List<Token>) : OrgElem

A single line string with Org Mode formatting enabled

OrgList

@Serializable

sealed class OrgList

Org list which could have nested lists inside or list content

OrgListCheckState

enum OrgListCheckState : Enum<OrgListCheckState>

OrgOptions

@Serializable

data class OrgOptions(val map: Map<String, String>, var tokens: List<Token>) : OrgElem

Options that could go in top of the file, code block headers, etc.

OrgOrderedListMarker

enum OrgOrderedListMarker : Enum<OrgOrderedListMarker>

OrgParsingError

@Serializable

data class OrgParsingError(val message: String, var tokens: List<Token> = emptyList()) : OrgElem

Represents parsing error of all kinds

OrgPlanningInfo

@Serializable

data class OrgPlanningInfo(val scheduled: OrgInlineElem.DTStamp?, val deadline: OrgInlineElem.DTStamp?, val closed: OrgInlineElem.DTStamp?, var tokens: List<Token>) : OrgElem

OrgPreamble

@Serializable

data class OrgPreamble(val title: OrgLine, val author: String? = null, val email: String? = null, val date: LocalDate? = null, val category: String? = null, val filetags: OrgTags? = null, val tags: OrgTags? = null, val options: OrgOptions? = null, val pile: OrgOptions? = null, val properties: OrgProperties? = null, var tokens: List<Token>) : OrgElem

Preamble is everything that comes in the start before the actual content starts

OrgPreface

@Serializable

data class OrgPreface(val body: List<OrgChunk>, var tokens: List<Token>) : OrgElem

Preface contains the chunks before first heading

OrgPriority

@Serializable

data class OrgPriority(val priority: Int, val text: String, var tokens: List<Token>) : OrgElem

OrgProperties

@Serializable

data class OrgProperties(val map: Map<String, OrgLine>, var tokens: List<Token>) : OrgElem

Unlike simple options, org properties could have full fledged org-mode text

OrgSection

@Serializable

data class OrgSection(val heading: OrgHeading, val body: List<OrgChunk>, var tokens: List<Token>) : OrgChunk, OrgElem

A section is an org chunk with heading attached to it

OrgTableRow

@Serializable

data class OrgTableRow(val cells: List<OrgLine>, var tokens: List<Token>) : OrgElem

OrgTags

@Serializable

data class OrgTags(val tags: List<String>, var tokens: List<Token>) : OrgElem

Tags for files or headings or anywhere else

OrgTODOState

@Serializable

data class OrgTODOState(val text: String, val isDone: Boolean, var tokens: List<Token>) : OrgElem

OrgToken

@Serializable

data class OrgToken(var tokens: List<Token>) : OrgElem

Represents a plain token parse

OrgUnorderedListMarker

enum OrgUnorderedListMarker : Enum<OrgUnorderedListMarker>

Properties

parseAsideBlock

val parseAsideBlock: Parser<OrgBlock.OrgAsideBlock>

parseChunk

val parseChunk: Parser<OrgChunk>

parseDocument

val parseDocument: Parser<OrgDocument>

parseDTRange

val parseDTRange: Parser<OrgInlineElem.DTRange>

Parse a datetime range. This is not just time range which is usually represented in the datetime stamp itself.

parseDTStamp

val parseDTStamp: Parser<OrgInlineElem.DTStamp>

Parse single datetime stamp

parseEditsBlock

val parseEditsBlock: Parser<OrgBlock.OrgEditsBlock>

parseFileKeyword

val parseFileKeyword: Parser<Pair<OrgToken, OrgLine>>

parseHashMetric

val parseHashMetric: Parser<OrgInlineElem.HashMetric>

Parse tags with metrics like #hash-tag(value)

parseHashTag

val parseHashTag: Parser<OrgInlineElem.HashTag>

Parse hashtags like #hash #hash-tag etc.

parseHeading

val parseHeading: Parser<OrgHeading>

parseHeadingTags

val parseHeadingTags: Parser<OrgTags>

parseHeadingTitle

val parseHeadingTitle: Parser<OrgLine>

parseHorizontalRule

val parseHorizontalRule: Parser<OrgChunk.OrgHorizontalLine>

parseLevel

val parseLevel: Parser<OrgHeadingLevel>

parseLink

val parseLink: Parser<OrgInlineElem.Link>

Parse an org mode link

parseOrderedList

val parseOrderedList: Parser<OrgList.OrgOrderedList>

parseOrgLine

val parseOrgLine: Parser<OrgLine>

Parse a single line of org inline elements

parsePageIntroBlock

val parsePageIntroBlock: Parser<OrgBlock.OrgPageIntroBlock>

parseParagraph

val parseParagraph: Parser<OrgChunk.OrgParagraph>

parsePlanningInfo

val parsePlanningInfo: Parser<OrgPlanningInfo>

parsePreamble

val parsePreamble: Parser<OrgPreamble>

Preamble is everything before the start of actual content.

parsePreface

val parsePreface: Parser<OrgPreface>

parseProperties

val parseProperties: Parser<OrgProperties>

parseQuoteBlock

val parseQuoteBlock: Parser<OrgBlock.OrgQuoteBlock>

parseSection

val parseSection: Parser<OrgSection>

parseSourceBlock

val parseSourceBlock: Parser<OrgBlock.OrgSourceBlock>

parseUnorderedList

val parseUnorderedList: Parser<OrgList.OrgUnorderedList>

parseVerseBlock

val parseVerseBlock: Parser<OrgBlock.OrgVerseBlock>

Functions

formatInlineElemsToPlaintext

fun formatInlineElemsToPlaintext(elems: List<OrgInlineElem>): String

Convert list of inline elements to plain text. This is not the same as recovering the original org mode string since markups, links etc. are ignored here.

orgLineToTags

fun orgLineToTags(line: OrgLine): OrgTags

parse

fun parse(tokens: List<Token>): OrgDocument?

The main exposed function for parsing an org mode document

parseInlineElems

fun parseInlineElems(stoppingFn: (List<Token>) -> Boolean = { false }): Parser<List<OrgInlineElem>>

Build a parser that continues to parse inline element till stopping criteria is met.

parseListItem

fun parseListItem(indent: Int): Parser<OrgList.OrgListItem>

Starting just after the list marker and space, parse the list item.

parseListItemChunks

fun parseListItemChunks(indent: Int): Parser<List<OrgChunk>>

This starts after the checkbox, if present, in each list item and parses the chunks that make up one list item.

parseListItemWithMarker

fun parseListItemWithMarker(isOrdered: Boolean, indent: Int): Parser<Triple<OrgToken, OrgToken, OrgList.OrgListItem>>

Parse a list item along with the marker and space between them. This starts at the position of the list marker and only parses items of given indent.

plainText

fun OrgChunk.OrgParagraph.plainText(): String

Return plain text representation of paragraph

fun OrgLine.plainText(): String

unparse

fun unparse(document: OrgDocument): List<Token>

Convert a document back to the list to tokens