Data.OrgMode.Parse.Attoparsec.Time

Parsing combinators for org-mode active and inactive timestamps.

Documentation

parsePlannings :: Parser Text (HashMap PlanningKeyword Timestamp)

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:

DEADLINE: <2015-05-10 17:00> CLOSED: <2015-04-1612:00>

parseClock :: Parser Text (Maybe Timestamp, Maybe Duration)

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.:

CLOCK: [2014-12-10 Fri 2:30]--[2014-12-10 Fri 10:30] => 08:00

parseTimestamp :: Parser Text Timestamp

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, --; or, by appending two hh:mm timestamps together in a single timepoint with one hyphen -.

Each timepoint includes an optional repeater flag and an optional delay flag.

type Weekday = Text

data BracketedDateTime

Constructors

BracketedDateTime

Fields

datePart :: YearMonthDay

dayNamePart :: Maybe Weekday

timePart :: Maybe TimePart

repeat :: Maybe Repeater

delayPart :: Maybe Delay

isActive :: Bool

Instances

Eq BracketedDateTime

Show BracketedDateTime

parseBracketedDateTime :: Parser Text BracketedDateTime

Parse a single time part.

[2015-03-27 Fri 10:20 +4h]

Returns:

• The basic timestamp
• Whether there was a time interval in place of a single time (this will be handled upstream by parseTimestamp)
• Whether the time is active or inactive

transformBracketedDateTime :: BracketedDateTime -> (DateTime, Maybe (Hours, Minutes), Bool)

parseDay :: Parser Text Text

Parse a day name in the same way as org-mode does.

type AbsoluteTime = (Hours, Minutes)

type TimestampRange = (AbsoluteTime, AbsoluteTime)

newtype TimePart

Constructors

TimePart (Either AbsoluteTime TimestampRange)

Instances

Eq TimePart

Ord TimePart

Show TimePart

parseTime' :: Parser Text TimePart

Parse the time-of-day part of a time part, as a single point or a time range.

parseDate :: Parser Text YearMonthDay

Parse the YYYY-MM-DD part of a time part.

parseHM :: Parser Text (Hours, Minutes)

Parse a single HH:MM point.

parseTimeUnit :: Parser Text TimeUnit

Parse the Timeunit part of a delay or repeater flag.

parseRepeater :: Parser Text Repeater

Parse a repeater flag, e.g. .+4w, or ++1y.

parseDelay :: Parser Text Delay

Parse a delay flag, e.g. --1d or -2w.