Data.OrgMode.Parse.Attoparsec.Headings

Parsing combinators for org-list headings.

Documentation

data Heading

Constructors

Heading

Fields

level :: Int

priority :: Maybe Priority

state :: Maybe State

title :: Text

keywords :: [Keyword]

Instances

Eq Heading

Show Heading

data Priority

Constructors

A

B

C

Unknown

Instances

Eq Priority

Ord Priority

Read Priority

Show Priority

newtype State

Constructors

State Text

Instances

Eq State

Show State

newtype Keyword

Constructors

Keyword Text

Instances

Eq Keyword

Ord Keyword

Show Keyword

toPriority :: Text -> Priority

heading :: Parser Text Heading

Parse an org-mode heading.

headingLevel :: Parser Text Int

Parse the asterisk indicated heading level until a space is reached.

headingPriority :: Parser Text (Maybe Priority)

Parse the priority indicator.

If anything but these priority indicators are used the parser will fail: `[B]`, `[#C]`.

headingTitle :: Parser Text (Text, Maybe Keyword)

Title parser with alternative.

This function tries to parse a title with a keyword and if it fails it then attempts to parse everything till the end of the line.

headingKeyword :: Parser Text (Maybe Keyword)

Parse a heading keyword.

You can use this with many' and catMaybes to get a list keywords:

keys <- many' headingKeyword
return $ catMaybes keys