-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A collection of Attoparsec combinators for parsing org-mode
--   flavored documents.
--   
--   
--   `orgmode-parse` is a parsing library for the org-mode flavor of
--   document markup.
--   
--   The provided Attoparsec combinators parse the human-readable and
--   textual representation into a simple AST for storage or output to
--   another format (HTML? Markdown?).
@package orgmode-parse
@version 0.1.1.3


-- | Types and utility functions.
module Data.OrgMode.Parse.Types
data Document
Document :: Text -> [Heading] -> Document

-- | Text occurring before any Org headlines
[documentText] :: Document -> Text

-- | Toplevel Org headlines
[documentHeadings] :: Document -> [Heading]
data Section
Section :: Plannings -> [Clock] -> Properties -> Text -> Section
[sectionPlannings] :: Section -> Plannings
[sectionClocks] :: Section -> [Clock]
[sectionProperties] :: Section -> Properties
[sectionParagraph] :: Section -> Text
newtype Level
Level :: Int -> Level
data Heading
Heading :: Level -> Maybe StateKeyword -> Maybe Priority -> Text -> Maybe Stats -> [Tag] -> Section -> [Heading] -> Heading

-- | Org headline nesting level (1 is at the top)
[level] :: Heading -> Level

-- | State of the headline (e.g. TODO, DONE)
[keyword] :: Heading -> Maybe StateKeyword
[priority] :: Heading -> Maybe Priority
[title] :: Heading -> Text
[stats] :: Heading -> Maybe Stats
[tags] :: Heading -> [Tag]
[section] :: Heading -> Section
[subHeadings] :: Heading -> [Heading]
data Priority
A :: Priority
B :: Priority
C :: Priority
newtype Plannings
Plns :: (HashMap PlanningKeyword Timestamp) -> Plannings
newtype StateKeyword
StateKeyword :: Text -> StateKeyword
[unStateKeyword] :: StateKeyword -> Text
type Duration = (Hour, Minute)
data PlanningKeyword
SCHEDULED :: PlanningKeyword
DEADLINE :: PlanningKeyword
CLOSED :: PlanningKeyword
type Properties = HashMap Text Text
data Timestamp
Timestamp :: DateTime -> Bool -> Maybe DateTime -> Timestamp
[tsTime] :: Timestamp -> DateTime
[tsActive] :: Timestamp -> Bool
[tsEndTime] :: Timestamp -> Maybe DateTime
data DateTime
DateTime :: YearMonthDay' -> Maybe Text -> Maybe (Hour, Minute) -> Maybe Repeater -> Maybe Delay -> DateTime
[yearMonthDay] :: DateTime -> YearMonthDay'
[dayName] :: DateTime -> Maybe Text
[hourMinute] :: DateTime -> Maybe (Hour, Minute)
[repeater] :: DateTime -> Maybe Repeater
[delay] :: DateTime -> Maybe Delay
data Stats
StatsPct :: Int -> Stats
StatsOf :: Int -> Int -> Stats
type Tag = Text
data TimeUnit
UnitYear :: TimeUnit
UnitWeek :: TimeUnit
UnitMonth :: TimeUnit
UnitDay :: TimeUnit
UnitHour :: TimeUnit
data RepeaterType
RepeatCumulate :: RepeaterType
RepeatCatchUp :: RepeaterType
RepeatRestart :: RepeaterType
data Repeater
Repeater :: RepeaterType -> Int -> TimeUnit -> Repeater
[repeaterType] :: Repeater -> RepeaterType
[repeaterValue] :: Repeater -> Int
[repeaterUnit] :: Repeater -> TimeUnit
data DelayType
DelayAll :: DelayType
DelayFirst :: DelayType
data Delay
Delay :: DelayType -> Int -> TimeUnit -> Delay
[delayType] :: Delay -> DelayType
[delayValue] :: Delay -> Int
[delayUnit] :: Delay -> TimeUnit
newtype LevelDepth
LevelDepth :: Int -> LevelDepth
data TitleMeta
TitleMeta :: Text -> (Maybe Stats) -> (Maybe [Tag]) -> TitleMeta
data YearMonthDay :: *
YearMonthDay :: SrictNotUnpackedYear -> SrictNotUnpackedMonth -> SrictNotUnpackedDayOfMonth -> YearMonthDay
[ymdYear] :: YearMonthDay -> SrictNotUnpackedYear
[ymdMonth] :: YearMonthDay -> SrictNotUnpackedMonth
[ymdDay] :: YearMonthDay -> SrictNotUnpackedDayOfMonth
newtype YearMonthDay'
YMD' :: YearMonthDay -> YearMonthDay'
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_1Document
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_0Document
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Document
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Document
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_7Heading
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_6Heading
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_5Heading
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_4Heading
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_3Heading
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_2Heading
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_1Heading
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_0Heading
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Heading
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Heading
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_3Section
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_2Section
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_1Section
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_0Section
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Section
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Section
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_1Stats
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Stats
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Stats
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_2Priority
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_1Priority
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Priority
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Priority
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Plannings
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Plannings
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_2PlanningKeyword
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_1PlanningKeyword
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0PlanningKeyword
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1PlanningKeyword
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_0StateKeyword
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0StateKeyword
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1StateKeyword
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_2Timestamp
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_1Timestamp
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_0Timestamp
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Timestamp
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Timestamp
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_4DateTime
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_3DateTime
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_2DateTime
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_1DateTime
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_0DateTime
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0DateTime
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1DateTime
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_2Repeater
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_1Repeater
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_0Repeater
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Repeater
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Repeater
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_2Delay
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_1Delay
instance GHC.Generics.Selector Data.OrgMode.Parse.Types.S1_0_0Delay
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Delay
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Delay
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_4TimeUnit
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_3TimeUnit
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_2TimeUnit
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_1TimeUnit
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0TimeUnit
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1TimeUnit
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_1DelayType
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0DelayType
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1DelayType
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_2RepeaterType
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_1RepeaterType
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0RepeaterType
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1RepeaterType
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0YearMonthDay'
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1YearMonthDay'
instance GHC.Generics.Constructor Data.OrgMode.Parse.Types.C1_0Level
instance GHC.Generics.Datatype Data.OrgMode.Parse.Types.D1Level
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Document
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Document
instance GHC.Show.Show Data.OrgMode.Parse.Types.Document
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Heading
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Heading
instance GHC.Show.Show Data.OrgMode.Parse.Types.Heading
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Section
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Section
instance GHC.Show.Show Data.OrgMode.Parse.Types.Section
instance GHC.Show.Show Data.OrgMode.Parse.Types.TitleMeta
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.TitleMeta
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Stats
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Stats
instance GHC.Show.Show Data.OrgMode.Parse.Types.Stats
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Priority
instance GHC.Classes.Ord Data.OrgMode.Parse.Types.Priority
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Priority
instance GHC.Read.Read Data.OrgMode.Parse.Types.Priority
instance GHC.Show.Show Data.OrgMode.Parse.Types.Priority
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Plannings
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Plannings
instance GHC.Show.Show Data.OrgMode.Parse.Types.Plannings
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.PlanningKeyword
instance GHC.Classes.Ord Data.OrgMode.Parse.Types.PlanningKeyword
instance GHC.Enum.Enum Data.OrgMode.Parse.Types.PlanningKeyword
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.PlanningKeyword
instance GHC.Show.Show Data.OrgMode.Parse.Types.PlanningKeyword
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.StateKeyword
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.StateKeyword
instance GHC.Show.Show Data.OrgMode.Parse.Types.StateKeyword
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Timestamp
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Timestamp
instance GHC.Show.Show Data.OrgMode.Parse.Types.Timestamp
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.DateTime
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.DateTime
instance GHC.Show.Show Data.OrgMode.Parse.Types.DateTime
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Repeater
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Repeater
instance GHC.Show.Show Data.OrgMode.Parse.Types.Repeater
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Delay
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Delay
instance GHC.Show.Show Data.OrgMode.Parse.Types.Delay
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.TimeUnit
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.TimeUnit
instance GHC.Show.Show Data.OrgMode.Parse.Types.TimeUnit
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.DelayType
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.DelayType
instance GHC.Show.Show Data.OrgMode.Parse.Types.DelayType
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.RepeaterType
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.RepeaterType
instance GHC.Show.Show Data.OrgMode.Parse.Types.RepeaterType
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.YearMonthDay'
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.YearMonthDay'
instance GHC.Show.Show Data.OrgMode.Parse.Types.YearMonthDay'
instance GHC.Generics.Generic Data.OrgMode.Parse.Types.Level
instance GHC.Num.Num Data.OrgMode.Parse.Types.Level
instance GHC.Show.Show Data.OrgMode.Parse.Types.Level
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.Level
instance GHC.Num.Num Data.OrgMode.Parse.Types.LevelDepth
instance GHC.Show.Show Data.OrgMode.Parse.Types.LevelDepth
instance GHC.Classes.Eq Data.OrgMode.Parse.Types.LevelDepth
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Document
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Document
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Timestamp
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Timestamp
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.YearMonthDay'
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.YearMonthDay'
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.DateTime
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.DateTime
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.RepeaterType
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.RepeaterType
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Repeater
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Repeater
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.DelayType
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.DelayType
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Delay
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Delay
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.TimeUnit
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.TimeUnit
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Level
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Level
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.StateKeyword
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.StateKeyword
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.PlanningKeyword
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.PlanningKeyword
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Plannings
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Plannings
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Section
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Section
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Heading
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Heading
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Priority
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Priority
instance Data.Aeson.Types.Class.ToJSON Data.OrgMode.Parse.Types.Stats
instance Data.Aeson.Types.Class.FromJSON Data.OrgMode.Parse.Types.Stats
instance Data.Hashable.Class.Hashable Data.OrgMode.Parse.Types.PlanningKeyword


-- | Parsing combinators for org-mode entry property drawers.
module Data.OrgMode.Parse.Attoparsec.PropertyDrawer

-- | Parse a property drawer.
--   
--   <pre>
--   :PROPERTIES:
--   :DATE: [2014-12-14 11:00]
--   :NOTE: Something really crazy happened today!
--   :END:
--   </pre>
parseDrawer :: Parser Text Properties

-- | Parse a property of a drawer.
--   
--   Properties *must* be a `:KEY: value` pair, the key can be of any case
--   and contain any characters except for newlines and colons (since they
--   delimit the start and end of the key).
property :: Parser Text (PropertyKey, PropertyVal)


-- | Parsing combinators for org-mode active and inactive timestamps.
module Data.OrgMode.Parse.Attoparsec.Time

-- | Parse a planning line.
--   
--   Plannings inhabit a heading section and are formatted as a keyword and
--   a timestamp. There can be more than one, but they are all on the same
--   line e.g:
--   
--   <pre>
--   DEADLINE: &lt;2015-05-10 17:00&gt; CLOSED: &lt;2015-04-1612:00&gt;
--   </pre>
parsePlannings :: Parser Text (HashMap PlanningKeyword Timestamp)

-- | Parse a clock line.
--   
--   A heading's section contains one line per clock entry. Clocks may have
--   a timestamp, a duration, both, or neither e.g.:
--   
--   <pre>
--   CLOCK: [2014-12-10 Fri 2:30]--[2014-12-10 Fri 10:30] =&gt; 08:00
--   </pre>
parseClock :: Parser Text (Maybe Timestamp, Maybe Duration)

-- | Parse a timestamp.
--   
--   Timestamps may be timepoints or timeranges, and they indicate whether
--   they are active or closed by using angle or square brackets
--   respectively.
--   
--   Time ranges are formatted by infixing two timepoints with a double
--   hyphen, <tt>--</tt>; or, by appending two <tt>hh:mm</tt> timestamps
--   together in a single timepoint with one hyphen <tt>-</tt>.
--   
--   Each timepoint includes an optional repeater flag and an optional
--   delay flag.
parseTimestamp :: Parser Text Timestamp
type Weekday = Text
data BracketedDateTime
BracketedDateTime :: YearMonthDay -> Maybe Weekday -> Maybe TimePart -> Maybe Repeater -> Maybe Delay -> Bool -> BracketedDateTime
[datePart] :: BracketedDateTime -> YearMonthDay
[dayNamePart] :: BracketedDateTime -> Maybe Weekday
[timePart] :: BracketedDateTime -> Maybe TimePart
[repeat] :: BracketedDateTime -> Maybe Repeater
[delayPart] :: BracketedDateTime -> Maybe Delay
[isActive] :: BracketedDateTime -> Bool

-- | Parse a single time part.
--   
--   <pre>
--   [2015-03-27 Fri 10:20 +4h]
--   </pre>
--   
--   Returns:
--   
--   <ul>
--   <li>The basic timestamp</li>
--   <li>Whether there was a time interval in place of a single time (this
--   will be handled upstream by parseTimestamp)</li>
--   <li>Whether the time is active or inactive</li>
--   </ul>
parseBracketedDateTime :: Parser Text BracketedDateTime
transformBracketedDateTime :: BracketedDateTime -> (DateTime, Maybe (Hours, Minutes), Bool)

-- | Parse a day name in the same way as org-mode does.
parseDay :: Parser Text Text
type AbsoluteTime = (Hours, Minutes)
type TimestampRange = (AbsoluteTime, AbsoluteTime)
newtype TimePart
TimePart :: (Either AbsoluteTime TimestampRange) -> TimePart

-- | Parse the time-of-day part of a time part, as a single point or a time
--   range.
parseTime' :: Parser Text TimePart

-- | Parse the YYYY-MM-DD part of a time part.
parseDate :: Parser Text YearMonthDay

-- | Parse a single <tt>HH:MM</tt> point.
parseHM :: Parser Text (Hours, Minutes)

-- | Parse the Timeunit part of a delay or repeater flag.
parseTimeUnit :: Parser Text TimeUnit

-- | Parse a repeater flag, e.g. <tt>.+4w</tt>, or <tt>++1y</tt>.
parseRepeater :: Parser Text Repeater

-- | Parse a delay flag, e.g. <tt>--1d</tt> or <tt>-2w</tt>.
parseDelay :: Parser Text Delay
instance GHC.Classes.Eq Data.OrgMode.Parse.Attoparsec.Time.BracketedDateTime
instance GHC.Show.Show Data.OrgMode.Parse.Attoparsec.Time.BracketedDateTime
instance GHC.Show.Show Data.OrgMode.Parse.Attoparsec.Time.TimePart
instance GHC.Classes.Ord Data.OrgMode.Parse.Attoparsec.Time.TimePart
instance GHC.Classes.Eq Data.OrgMode.Parse.Attoparsec.Time.TimePart


-- | Parsing combinators for org-mode sections.
module Data.OrgMode.Parse.Attoparsec.Section

-- | Parse a heading section
--   
--   Heading sections contain optionally a property drawer, a list of clock
--   entries, code blocks (not yet implemented), plain lists (not yet
--   implemented), and unstructured text.
parseSection :: Parser Text Section

-- | Parse a non-heading line of a section.
nonHeaderLine :: Parser Text Text


-- | Parsing combinators for org-list headings.
module Data.OrgMode.Parse.Attoparsec.Headings

-- | Parse an org-mode heading and its contained entities (see
--   <a>OrgSyntax</a>).
--   
--   Headers include a hierarchy level indicated by asterisks, optional
--   todo states, priority level, %-done stats, and tags.
--   
--   <pre>
--   ** TODO [#B] Polish Poetry Essay [25%] :HOMEWORK:POLISH:WRITING:
--   </pre>
--   
--   Headings may contain:
--   
--   <ul>
--   <li>A section with Planning and Clock entries</li>
--   <li>A number of other not-yet-implemented entities (code blocks,
--   lists)</li>
--   <li>Unstructured text</li>
--   <li>Other heading deeper in the hierarchy</li>
--   </ul>
--   
--   <a>headingBelowLevel</a> takes a list of terms to consider, state
--   keywords, and a minumum hierarchy depth. Use 0 to parse any heading.
headingBelowLevel :: [Text] -> LevelDepth -> Parser Text Heading

-- | Parse the asterisk indicated heading level until a space is reached.
--   
--   Constrain it to LevelDepth or its children.
headingLevel :: LevelDepth -> Parser Text Level

-- | Parse the priority indicator.
--   
--   If anything but these priority indicators are used the parser will
--   fail:
--   
--   <ul>
--   <li><pre>[#A]</pre></li>
--   <li><pre>[#B]</pre></li>
--   <li><pre>[#C]</pre></li>
--   </ul>
headingPriority :: Parser Text Priority

-- | Parse a stats block.
--   
--   Accepts either form: "[m/n]" or "[n%]" and there is no restriction on
--   m or n other than that they are integers.
parseStats :: Parser Text Stats

-- | Parse a colon-separated list of Tags
--   
--   <pre>
--   :HOMEWORK:POETRY:WRITING:
--   </pre>
parseTags :: Parser Text [Tag]

module Data.OrgMode.Parse.Attoparsec.Document
parseDocument :: [Text] -> Parser Text Document


-- | Attoparsec combinators for orgmode documents.
module Data.OrgMode.Parse