License	BSD-3-Clause
Safe Haskell	Safe-Inferred
Language	Haskell2010

Swarm.Language.Parser.Core

Contents

Parser configuration
Comment parsing state
Parser type
- Running

Description

Core data type definitions and utilities for the Swarm language parser.

Synopsis

data Antiquoting
- = AllowAntiquoting
- | DisallowAntiquoting
data LanguageVersion
- = SwarmLang0_5
- | SwarmLangLatest
data ParserConfig
defaultParserConfig :: ParserConfig
antiquoting :: Lens' ParserConfig Antiquoting
languageVersion :: Lens' ParserConfig LanguageVersion
data CommentState = CS {
- _freshLine :: Bool
- _comments :: Seq Comment
}
freshLine :: Lens' CommentState Bool
comments :: Lens' CommentState (Seq Comment)
type Parser = ReaderT ParserConfig (StateT CommentState (Parsec Void Text))
type ParserError = ParseErrorBundle Text Void
runParser :: Parser a -> Text -> Either ParserError (a, Seq Comment)
runParser' :: ParserConfig -> Parser a -> Text -> Either ParserError (a, Seq Comment)
runParserTH :: (Monad m, MonadFail m) => (String, Int, Int) -> Parser a -> String -> m a

Parser configuration

data Antiquoting Source #

When parsing a term using a quasiquoter (i.e. something in the Swarm source code that will be parsed at compile time), we want to allow antiquoting, i.e. writing something like $x to refer to an existing Haskell variable. But when parsing a term entered by the user at the REPL, we do not want to allow this syntax.

Constructors

AllowAntiquoting
DisallowAntiquoting

Instances

Instances details

Show Antiquoting Source #
Instance details Defined in Swarm.Language.Parser.Core Methods showsPrec :: Int -> Antiquoting -> ShowS # show :: Antiquoting -> String # showList :: [Antiquoting] -> ShowS #
Eq Antiquoting Source #
Instance details Defined in Swarm.Language.Parser.Core Methods (==) :: Antiquoting -> Antiquoting -> Bool # (/=) :: Antiquoting -> Antiquoting -> Bool #
Ord Antiquoting Source #
Instance details Defined in Swarm.Language.Parser.Core Methods compare :: Antiquoting -> Antiquoting -> Ordering # (<) :: Antiquoting -> Antiquoting -> Bool # (<=) :: Antiquoting -> Antiquoting -> Bool # (>) :: Antiquoting -> Antiquoting -> Bool # (>=) :: Antiquoting -> Antiquoting -> Bool # max :: Antiquoting -> Antiquoting -> Antiquoting # min :: Antiquoting -> Antiquoting -> Antiquoting #

data LanguageVersion Source #

Which version of the Swarm language are we parsing? As a general rule, we want to support one older version in addition to the current version, to allow for upgrading code via swarm format.

Constructors

SwarmLang0_5
SwarmLangLatest

Instances

Instances details

Bounded LanguageVersion Source #
Instance details Defined in Swarm.Language.Parser.Core Methods minBound :: LanguageVersion # maxBound :: LanguageVersion #
Enum LanguageVersion Source #
Instance details Defined in Swarm.Language.Parser.Core Methods succ :: LanguageVersion -> LanguageVersion # pred :: LanguageVersion -> LanguageVersion # toEnum :: Int -> LanguageVersion # fromEnum :: LanguageVersion -> Int # enumFrom :: LanguageVersion -> [LanguageVersion] # enumFromThen :: LanguageVersion -> LanguageVersion -> [LanguageVersion] # enumFromTo :: LanguageVersion -> LanguageVersion -> [LanguageVersion] # enumFromThenTo :: LanguageVersion -> LanguageVersion -> LanguageVersion -> [LanguageVersion] #
Show LanguageVersion Source #
Instance details Defined in Swarm.Language.Parser.Core Methods showsPrec :: Int -> LanguageVersion -> ShowS # show :: LanguageVersion -> String # showList :: [LanguageVersion] -> ShowS #
Eq LanguageVersion Source #
Instance details Defined in Swarm.Language.Parser.Core Methods (==) :: LanguageVersion -> LanguageVersion -> Bool # (/=) :: LanguageVersion -> LanguageVersion -> Bool #
Ord LanguageVersion Source #
Instance details Defined in Swarm.Language.Parser.Core Methods compare :: LanguageVersion -> LanguageVersion -> Ordering # (<) :: LanguageVersion -> LanguageVersion -> Bool # (<=) :: LanguageVersion -> LanguageVersion -> Bool # (>) :: LanguageVersion -> LanguageVersion -> Bool # (>=) :: LanguageVersion -> LanguageVersion -> Bool # max :: LanguageVersion -> LanguageVersion -> LanguageVersion # min :: LanguageVersion -> LanguageVersion -> LanguageVersion #

data ParserConfig Source #

Read-only parser configuration.

defaultParserConfig :: ParserConfig Source #

antiquoting :: Lens' ParserConfig Antiquoting Source #

languageVersion :: Lens' ParserConfig LanguageVersion Source #

Comment parsing state

data CommentState Source #

Constructors

CS
Fields _freshLine :: Bool Are we currently on a (so far) blank line, i.e. have there been no nontrivial tokens since the most recent newline? This field is updated every time we parse a lexeme or symbol (set to false), or a newline (set to true). _comments :: Seq Comment The actual sequence of comments, in the order they were encountered

freshLine :: Lens' CommentState Bool Source #

comments :: Lens' CommentState (Seq Comment) Source #

Parser type

type Parser = ReaderT ParserConfig (StateT CommentState (Parsec Void Text)) Source #

type ParserError = ParseErrorBundle Text Void Source #

Running

runParser :: Parser a -> Text -> Either ParserError (a, Seq Comment) Source #

Run a parser on some input text, returning either the result + all collected comments, or a parse error message.

runParser' :: ParserConfig -> Parser a -> Text -> Either ParserError (a, Seq Comment) Source #

Like runParser, but allow configuring with an arbitrary ParserConfig.

runParserTH :: (Monad m, MonadFail m) => (String, Int, Int) -> Parser a -> String -> m a Source #

A utility for running a parser in an arbitrary MonadFail (which is going to be the TemplateHaskell Q monad --- see Swarm.Language.Parser.QQ), with a specified source position.