Safe Haskell	Safe-Inferred
Language	Haskell2010

Org.Parser

Synopsis

data OrgParser a
type OrgParseError = ParseErrorBundle Text Void
data OrgOptions = OrgOptions {
- orgSrcPreserveIndentation :: Bool
- orgSrcTabWidth :: Int
- orgTodoKeywords :: TodoSequence
- orgElementParsedKeywords :: Set Text
- orgElementDualKeywords :: Set Text
- orgElementAffiliatedKeywords :: Set Text
}
type TodoSequence = [TodoKeyword]
defaultOrgOptions :: OrgOptions
parseOrgMaybe :: OrgOptions -> OrgParser a -> Text -> Maybe a
parseOrg :: OrgOptions -> OrgParser a -> FilePath -> Text -> Either OrgParseError a
parseOrgDoc :: OrgOptions -> FilePath -> Text -> Either OrgParseError OrgDocument
parseOrgDocIO :: MonadIO m => OrgOptions -> FilePath -> m OrgDocument

Documentation

data OrgParser a Source #

Instances

Instances details

MonadFail OrgParser Source #
Instance details Defined in Org.Parser.Definitions Methods fail :: String -> OrgParser a Source #
Alternative OrgParser Source #
Instance details Defined in Org.Parser.Definitions Methods empty :: OrgParser a Source # (<\|>) :: OrgParser a -> OrgParser a -> OrgParser a Source # some :: OrgParser a -> OrgParser [a] Source # many :: OrgParser a -> OrgParser [a] Source #
Applicative OrgParser Source #
Instance details Defined in Org.Parser.Definitions Methods pure :: a -> OrgParser a Source # (<>) :: OrgParser (a -> b) -> OrgParser a -> OrgParser b Source # liftA2 :: (a -> b -> c) -> OrgParser a -> OrgParser b -> OrgParser c Source # (>) :: OrgParser a -> OrgParser b -> OrgParser b Source # (<*) :: OrgParser a -> OrgParser b -> OrgParser a Source #
Functor OrgParser Source #
Instance details Defined in Org.Parser.Definitions Methods fmap :: (a -> b) -> OrgParser a -> OrgParser b Source # (<$) :: a -> OrgParser b -> OrgParser a Source #
Monad OrgParser Source #
Instance details Defined in Org.Parser.Definitions Methods (>>=) :: OrgParser a -> (a -> OrgParser b) -> OrgParser b Source # (>>) :: OrgParser a -> OrgParser b -> OrgParser b Source # return :: a -> OrgParser a Source #
MonadPlus OrgParser Source #
Instance details Defined in Org.Parser.Definitions Methods mzero :: OrgParser a Source # mplus :: OrgParser a -> OrgParser a -> OrgParser a Source #
MonadParsec Void Text OrgParser Source #
Instance details Defined in Org.Parser.Definitions Methods parseError :: ParseError Text Void -> OrgParser a Source # label :: String -> OrgParser a -> OrgParser a Source # hidden :: OrgParser a -> OrgParser a Source # try :: OrgParser a -> OrgParser a Source # lookAhead :: OrgParser a -> OrgParser a Source # notFollowedBy :: OrgParser a -> OrgParser () Source # withRecovery :: (ParseError Text Void -> OrgParser a) -> OrgParser a -> OrgParser a Source # observing :: OrgParser a -> OrgParser (Either (ParseError Text Void) a) Source # eof :: OrgParser () Source # token :: (Token Text -> Maybe a) -> Set (ErrorItem (Token Text)) -> OrgParser a Source # tokens :: (Tokens Text -> Tokens Text -> Bool) -> Tokens Text -> OrgParser (Tokens Text) Source # takeWhileP :: Maybe String -> (Token Text -> Bool) -> OrgParser (Tokens Text) Source # takeWhile1P :: Maybe String -> (Token Text -> Bool) -> OrgParser (Tokens Text) Source # takeP :: Maybe String -> Int -> OrgParser (Tokens Text) Source # getParserState :: OrgParser (State Text Void) Source # updateParserState :: (State Text Void -> State Text Void) -> OrgParser () Source #

type OrgParseError = ParseErrorBundle Text Void Source #

data OrgOptions Source #

Constructors

OrgOptions
Fields orgSrcPreserveIndentation :: Bool orgSrcTabWidth :: Int orgTodoKeywords :: TodoSequence orgElementParsedKeywords :: Set Text orgElementDualKeywords :: Set Text orgElementAffiliatedKeywords :: Set Text

Instances

Instances details

FromJSON OrgOptions Source #
Instance details Defined in Org.Parser.State Methods parseJSON :: Value -> Parser OrgOptions Source # parseJSONList :: Value -> Parser [OrgOptions] Source #
ToJSON OrgOptions Source #
Instance details Defined in Org.Parser.State Methods toJSON :: OrgOptions -> Value Source # toEncoding :: OrgOptions -> Encoding Source # toJSONList :: [OrgOptions] -> Value Source # toEncodingList :: [OrgOptions] -> Encoding Source #
Generic OrgOptions Source #
Instance details Defined in Org.Parser.State Associated Types type Rep OrgOptions :: Type -> Type Source # Methods from :: OrgOptions -> Rep OrgOptions x Source # to :: Rep OrgOptions x -> OrgOptions Source #
Show OrgOptions Source #
Instance details Defined in Org.Parser.State Methods showsPrec :: Int -> OrgOptions -> ShowS Source # show :: OrgOptions -> String Source # showList :: [OrgOptions] -> ShowS Source #
NFData OrgOptions Source #
Instance details Defined in Org.Parser.State Methods rnf :: OrgOptions -> () Source #
Eq OrgOptions Source #
Instance details Defined in Org.Parser.State Methods (==) :: OrgOptions -> OrgOptions -> Bool Source # (/=) :: OrgOptions -> OrgOptions -> Bool Source #
Ord OrgOptions Source #
Instance details Defined in Org.Parser.State Methods compare :: OrgOptions -> OrgOptions -> Ordering Source # (<) :: OrgOptions -> OrgOptions -> Bool Source # (<=) :: OrgOptions -> OrgOptions -> Bool Source # (>) :: OrgOptions -> OrgOptions -> Bool Source # (>=) :: OrgOptions -> OrgOptions -> Bool Source # max :: OrgOptions -> OrgOptions -> OrgOptions Source # min :: OrgOptions -> OrgOptions -> OrgOptions Source #
type Rep OrgOptions Source #
Instance details Defined in Org.Parser.State type Rep OrgOptions = D1 ('MetaData "OrgOptions" "Org.Parser.State" "org-parser-0.1.0.0-inplace" 'False) (C1 ('MetaCons "OrgOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "orgSrcPreserveIndentation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: (S1 ('MetaSel ('Just "orgSrcTabWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "orgTodoKeywords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TodoSequence))) :: (S1 ('MetaSel ('Just "orgElementParsedKeywords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Text)) :: (S1 ('MetaSel ('Just "orgElementDualKeywords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Text)) :*: S1 ('MetaSel ('Just "orgElementAffiliatedKeywords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Text))))))

type TodoSequence = [TodoKeyword] Source #

Collection of todo markers in the order in which items should progress

defaultOrgOptions :: OrgOptions Source #

parseOrgMaybe :: OrgOptions -> OrgParser a -> Text -> Maybe a Source #

Evaluate the Org Parser state with the desired options. Returns Nothing in case of parse failure.

parseOrg :: OrgOptions -> OrgParser a -> FilePath -> Text -> Either OrgParseError a Source #

Wrapper around parse that evaluates the Org Parser state with the desired options.

parseOrgDoc :: OrgOptions -> FilePath -> Text -> Either OrgParseError OrgDocument Source #

Parse an Org document fully, with given options, and a filepath for error messages.

parseOrgDocIO :: MonadIO m => OrgOptions -> FilePath -> m OrgDocument Source #

Parse an Org document in a UTF8 file, with given options.