Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusCore.Parser

Description

Parsers for PLC terms in DefaultUni.

Synopsis

module PlutusCore.Parser.Type
module PlutusCore.Parser.ParserCommon
module PlutusCore.Parser.Builtin
program ∷ Parser (Program TyName Name DefaultUni DefaultFun SrcSpan)
parseProgram ∷ (AsParserErrorBundle e, MonadError e m, MonadQuote m) ⇒ Text → m (Program TyName Name DefaultUni DefaultFun SrcSpan)
parseTerm ∷ (AsParserErrorBundle e, MonadError e m, MonadQuote m) ⇒ Text → m (Term TyName Name DefaultUni DefaultFun SrcSpan)
parseType ∷ (AsParserErrorBundle e, MonadError e m, MonadQuote m) ⇒ Text → m (Type TyName DefaultUni SrcSpan)
data SourcePos
data ParserError
- = BuiltinTypeNotAStar !Text !SourcePos
- | UnknownBuiltinFunction !Text !SourcePos ![Text]
- | InvalidBuiltinConstant !Text !Text !SourcePos

Documentation

module PlutusCore.Parser.Type

module PlutusCore.Parser.ParserCommon

module PlutusCore.Parser.Builtin

program ∷ Parser (Program TyName Name DefaultUni DefaultFun SrcSpan) Source #

Parser for PLC programs.

parseProgram ∷ (AsParserErrorBundle e, MonadError e m, MonadQuote m) ⇒ Text → m (Program TyName Name DefaultUni DefaultFun SrcSpan) Source #

Parse a PLC program. The resulting program will have fresh names. The underlying monad must be capable of handling any parse errors. This passes "test" to the parser as the name of the input stream; to supply a name explicity, use `parse program name input`.

parseTerm ∷ (AsParserErrorBundle e, MonadError e m, MonadQuote m) ⇒ Text → m (Term TyName Name DefaultUni DefaultFun SrcSpan) Source #

Parse a PLC term. The resulting program will have fresh names. The underlying monad must be capable of handling any parse errors.

parseType ∷ (AsParserErrorBundle e, MonadError e m, MonadQuote m) ⇒ Text → m (Type TyName DefaultUni SrcSpan) Source #

Parse a PLC type. The resulting program will have fresh names. The underlying monad must be capable of handling any parse errors.

data SourcePos Source #

The data type SourcePos represents source positions. It contains the name of the source file, a line number, and a column number. Source line and column positions change intensively during parsing, so we need to make them strict to avoid memory leaks.

Instances

Instances details

Data SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → SourcePos → c SourcePos Source # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c SourcePos Source # toConstr ∷ SourcePos → Constr Source # dataTypeOf ∷ SourcePos → DataType Source # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c SourcePos) Source # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c SourcePos) Source # gmapT ∷ (∀ b. Data b ⇒ b → b) → SourcePos → SourcePos Source # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → SourcePos → r Source # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → SourcePos → r Source # gmapQ ∷ (∀ d. Data d ⇒ d → u) → SourcePos → [u] Source # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → SourcePos → u Source # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → SourcePos → m SourcePos Source # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SourcePos → m SourcePos Source # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → SourcePos → m SourcePos Source #
Generic SourcePos
Instance details Defined in Text.Megaparsec.Pos Associated Types type Rep SourcePos ∷ Type → Type Source # Methods from ∷ SourcePos → Rep SourcePos x Source # to ∷ Rep SourcePos x → SourcePos Source #
Read SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods readsPrec ∷ Int → ReadS SourcePos Source # readList ∷ ReadS [SourcePos] Source # readPrec ∷ ReadPrec SourcePos Source # readListPrec ∷ ReadPrec [SourcePos] Source #
Show SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods showsPrec ∷ Int → SourcePos → ShowS Source # show ∷ SourcePos → String Source # showList ∷ [SourcePos] → ShowS Source #
NFData SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods rnf ∷ SourcePos → () Source #
Eq SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods (==) ∷ SourcePos → SourcePos → Bool Source # (/=) ∷ SourcePos → SourcePos → Bool Source #
Ord SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods compare ∷ SourcePos → SourcePos → Ordering Source # (<) ∷ SourcePos → SourcePos → Bool Source # (<=) ∷ SourcePos → SourcePos → Bool Source # (>) ∷ SourcePos → SourcePos → Bool Source # (>=) ∷ SourcePos → SourcePos → Bool Source # max ∷ SourcePos → SourcePos → SourcePos Source # min ∷ SourcePos → SourcePos → SourcePos Source #
Pretty SourcePos Source #
Instance details Defined in PlutusCore.Error Methods pretty ∷ SourcePos → Doc ann Source # prettyList ∷ [SourcePos] → Doc ann Source #
type Rep SourcePos
Instance details Defined in Text.Megaparsec.Pos type Rep SourcePos = D1 ('MetaData "SourcePos" "Text.Megaparsec.Pos" "megaparsec-9.6.1-2lyGI2Uoag79kpXJQceOQM" 'False) (C1 ('MetaCons "SourcePos" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :: (S1 ('MetaSel ('Just "sourceLine") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Pos) :: S1 ('MetaSel ('Just "sourceColumn") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Pos))))

data ParserError Source #

An error encountered during parsing.

Constructors

BuiltinTypeNotAStar !Text !SourcePos
UnknownBuiltinFunction !Text !SourcePos ![Text]
InvalidBuiltinConstant !Text !Text !SourcePos

Instances

Instances details

Generic ParserError Source #
Instance details Defined in PlutusCore.Error Associated Types type Rep ParserError ∷ Type → Type Source # Methods from ∷ ParserError → Rep ParserError x Source # to ∷ Rep ParserError x → ParserError Source #
Show ParserError Source #
Instance details Defined in PlutusCore.Error Methods showsPrec ∷ Int → ParserError → ShowS Source # show ∷ ParserError → String Source # showList ∷ [ParserError] → ShowS Source #
NFData ParserError Source #
Instance details Defined in PlutusCore.Error Methods rnf ∷ ParserError → () Source #
Eq ParserError Source #
Instance details Defined in PlutusCore.Error Methods (==) ∷ ParserError → ParserError → Bool Source # (/=) ∷ ParserError → ParserError → Bool Source #
Ord ParserError Source #
Instance details Defined in PlutusCore.Error Methods compare ∷ ParserError → ParserError → Ordering Source # (<) ∷ ParserError → ParserError → Bool Source # (<=) ∷ ParserError → ParserError → Bool Source # (>) ∷ ParserError → ParserError → Bool Source # (>=) ∷ ParserError → ParserError → Bool Source # max ∷ ParserError → ParserError → ParserError Source # min ∷ ParserError → ParserError → ParserError Source #
ShowErrorComponent ParserError Source #
Instance details Defined in PlutusCore.Error Methods showErrorComponent ∷ ParserError → String Source # errorComponentLen ∷ ParserError → Int Source #
Pretty ParserError Source #
Instance details Defined in PlutusCore.Error Methods pretty ∷ ParserError → Doc ann Source # prettyList ∷ [ParserError] → Doc ann Source #
type Rep ParserError Source #
Instance details Defined in PlutusCore.Error type Rep ParserError = D1 ('MetaData "ParserError" "PlutusCore.Error" "plutus-core-1.34.0.0-inplace" 'False) (C1 ('MetaCons "BuiltinTypeNotAStar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SourcePos)) :+: (C1 ('MetaCons "UnknownBuiltinFunction" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SourcePos) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text]))) :+: C1 ('MetaCons "InvalidBuiltinConstant" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SourcePos)))))