Skip to content

Improve error reporting of the builtin function parser. #4549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thealmarty merged 2 commits into from
Apr 25, 2022
Merged

Improve error reporting of the builtin function parser. #4549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cb1c87
Improve error reporting of builtin fn parser.
thealmarty Apr 22, 2022
5f98713
Apply code review suggestions: show the keys of the builtin map only …
thealmarty Apr 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions plutus-core/plutus-core/src/PlutusCore/Error.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ throwingEither r e = case e of
data ParserError
= UnknownBuiltinType T.Text SourcePos
| BuiltinTypeNotAStar T.Text SourcePos
| UnknownBuiltinFunction T.Text SourcePos
| UnknownBuiltinFunction T.Text SourcePos [T.Text]
| InvalidBuiltinConstant T.Text T.Text SourcePos
deriving stock (Eq, Ord, Generic)
deriving anyclass (NFData)
Expand Down Expand Up @@ -117,7 +117,7 @@ instance Pretty SourcePos where
instance Pretty ParserError where
pretty (UnknownBuiltinType s loc) = "Unknown built-in type" <+> squotes (pretty s) <+> "at" <+> pretty loc
pretty (BuiltinTypeNotAStar ty loc) = "Expected a type of kind star (to later parse a constant), but got:" <+> squotes (pretty ty) <+> "at" <+> pretty loc
pretty (UnknownBuiltinFunction s loc) = "Unknown built-in function" <+> squotes (pretty s) <+> "at" <+> pretty loc
pretty (UnknownBuiltinFunction s loc lBuiltin) = "Unknown built-in function" <+> squotes (pretty s) <+> "at" <+> pretty loc <+> ". Parsable functions are " <+> pretty lBuiltin
pretty (InvalidBuiltinConstant c s loc) = "Invalid constant" <+> squotes (pretty c) <+> "of type" <+> squotes (pretty s) <+> "at" <+> pretty loc

instance ShowErrorComponent ParserError where
Expand Down
19 changes: 9 additions & 10 deletions plutus-core/plutus-core/src/PlutusCore/Parser/Builtin.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,31 @@ module PlutusCore.Parser.Builtin where
import Data.Text qualified as T
import Data.Text.Internal.Read (hexDigitToInt)
import PlutusPrelude (Word8)
import Text.Megaparsec (MonadParsec (takeWhileP), choice, many, manyTill)
import Text.Megaparsec (MonadParsec (takeWhileP), choice, customFailure, getSourcePos, many, manyTill)
import Text.Megaparsec.Char (char, hexDigitChar)
import Text.Megaparsec.Char.Lexer qualified as Lex hiding (hexadecimal)

import Data.ByteString (pack)
import Data.Map (Map, empty, insert, lookup)
import Data.Map.Strict (Map, fromList, lookup, toList)
import PlutusCore.Default
import PlutusCore.Error
import PlutusCore.Parser.ParserCommon (Parser, isIdentifierChar, lexeme, symbol, whitespace)
import PlutusCore.Parser.Type (defaultUniType)
import PlutusCore.Pretty (display)
import Prelude hiding (lookup)

mkCachedBuiltin :: [DefaultFun] -> Map T.Text DefaultFun -> Map T.Text DefaultFun
mkCachedBuiltin (hdFns:tlFns) builtinMap =
mkCachedBuiltin tlFns (insert (display hdFns) hdFns builtinMap)
mkCachedBuiltin [] builtinMap = builtinMap

cachedBuiltin :: Map T.Text DefaultFun
cachedBuiltin = mkCachedBuiltin [minBound .. maxBound] empty
cachedBuiltin = fromList [ (display fn, fn) | fn <- [minBound .. maxBound] ]

-- | Parser for builtin functions. Atm the parser can only parse `DefaultFun`.
builtinFunction :: Parser DefaultFun
builtinFunction = lexeme $ do
txt <- takeWhileP (Just "identifier") isIdentifierChar
txt <- takeWhileP (Just "builtin function identifier") isIdentifierChar
case lookup txt cachedBuiltin of
Nothing -> error $ "Not a builtin" <> show cachedBuiltin <> show txt
Nothing -> do
let lBuiltin = fmap fst $ toList cachedBuiltin
pos <- getSourcePos
customFailure $ UnknownBuiltinFunction txt pos lBuiltin
Just builtin -> pure builtin

signedInteger :: Parser Integer
Expand Down