| Copyright | © 2014 Parnell Springmeyer |
|---|---|
| License | All Rights Reserved |
| Maintainer | Parnell Springmeyer <parnell@digitalmentat.com> |
| Stability | experimental |
| Safe Haskell | None |
| Language | Haskell2010 |
Data.OrgMode.Types
Contents
Description
Types for the AST of an org-mode document.
- data ActiveState
- data BracketedDateTime = BracketedDateTime {
- datePart :: YearMonthDay
- dayNamePart :: Maybe Weekday
- timePart :: Maybe TimePart
- repeat :: Maybe Repeater
- delayPart :: Maybe Delay
- activeState :: ActiveState
- newtype Clock = Clock {}
- data DateTime = DateTime {
- yearMonthDay :: YearMonthDay
- dayName :: Maybe Text
- hourMinute :: Maybe (Hour, Minute)
- repeater :: Maybe Repeater
- delay :: Maybe Delay
- data Delay = Delay {}
- data DelayType
- newtype Depth = Depth Int
- data Document = Document {}
- data Drawer = Drawer {}
- type Duration = (Hour, Minute)
- data Headline = Headline {}
- newtype Logbook = Logbook {}
- data PlanningKeyword
- newtype Plannings = Plns (HashMap PlanningKeyword Timestamp)
- data Priority
- newtype Properties = Properties {}
- data Repeater = Repeater {}
- data RepeaterType
- data Section = Section {}
- newtype StateKeyword = StateKeyword {}
- data Stats
- type Tag = Text
- data TimePart
- = AbsoluteTime AbsTime
- | TimeStampRange (AbsTime, AbsTime)
- data TimeUnit
- data Timestamp = Timestamp {}
- data YearMonthDay :: * = YearMonthDay {}
Documentation
data BracketedDateTime Source #
A data type for parsed org-mode bracketed datetime stamps, e.g:
[2015-03-27 Fri 10:20 +4h]
Constructors
| BracketedDateTime | |
Fields
| |
Instances
A data type for parsed org-mode datetime stamps.
TODO: why do we have this data type and BracketedDateTime? They look almost exactly the same...
A data type representing a delay value.
Constructors
| Delay | |
A sum type representing the delay type of a delay value.
Constructors
| DelayAll | |
| DelayFirst |
Headline nesting depth.
Org-mode document.
Constructors
| Document | |
Fields
| |
Headline within an org-mode document.
Constructors
| Headline | |
Fields
| |
data PlanningKeyword Source #
A sum type representing the planning keywords.
A type representing a map of planning timestamps.
Constructors
| Plns (HashMap PlanningKeyword Timestamp) |
A sum type representing the three default priorities: A, B,
and C.
A data type representing a repeater interval in a org-mode timestamp.
Constructors
| Repeater | |
Fields
| |
data RepeaterType Source #
A sum type representing the repeater type of a repeater interval in a org-mode timestamp.
Constructors
| RepeatCumulate | |
| RepeatCatchUp | |
| RepeatRestart |
Instances
Section of text directly following a headline.
Constructors
| Section | |
Fields
| |
newtype StateKeyword Source #
A type representing a headline state keyword, e.g: TODO,
DONE, WAITING, etc.
Constructors
| StateKeyword | |
Fields | |
Instances
A data type representing a stats value in a headline, e.g [2/3]
in this headline:
* TODO [2/3] work on orgmode-parse
A sum type representing an absolute time part of a bracketed org-mode datetime stamp or a time range between two absolute timestamps.
Constructors
| AbsoluteTime AbsTime | |
| TimeStampRange (AbsTime, AbsTime) |
A sum type representing the time units of a delay.
A generic data type for parsed org-mode time stamps, e.g:
<2015-03-27 Fri 10:20> [2015-03-27 Fri 10:20 +4h] <2015-03-27 Fri 10:20>--<2015-03-28 Sat 10:20>
Constructors
| Timestamp | |
data YearMonthDay :: * #
Constructors
| YearMonthDay | |
Instances