-- | Interface to the Futhark parser.
module Language.Futhark.Parser
  ( parseFuthark,
    parseFutharkWithComments,
    parseExp,
    parseExpAt,
    parseModExp,
    parseType,
    parseDecOrExp,
    SyntaxError (..),
    Comment (..),
  )
where

import Data.Text qualified as T
import Futhark.Util.Loc (Pos (..))
import Language.Futhark.Parser.Parser
import Language.Futhark.Prop
import Language.Futhark.Syntax

initialPos :: FilePath -> Pos
initialPos :: FilePath -> Pos
initialPos FilePath
fname = FilePath -> Int -> Int -> Int -> Pos
Pos FilePath
fname Int
1 Int
1 Int
0

-- | Parse an entire Futhark program from the given 'T.Text', using
-- the 'FilePath' as the source name for error messages.
parseFuthark ::
  FilePath ->
  T.Text ->
  Either SyntaxError UncheckedProg
parseFuthark :: FilePath -> Text -> Either SyntaxError UncheckedProg
parseFuthark FilePath
fname = ParserMonad UncheckedProg
-> Pos -> Text -> Either SyntaxError UncheckedProg
forall a. ParserMonad a -> Pos -> Text -> Either SyntaxError a
parse ParserMonad UncheckedProg
prog (FilePath -> Pos
initialPos FilePath
fname)

-- | Parse an entire Futhark program from the given 'T.Text', using
-- the 'FilePath' as the source name for error messages.  Also returns
-- the comments encountered.
parseFutharkWithComments ::
  FilePath ->
  T.Text ->
  Either SyntaxError (UncheckedProg, [Comment])
parseFutharkWithComments :: FilePath -> Text -> Either SyntaxError (UncheckedProg, [Comment])
parseFutharkWithComments FilePath
fname = ParserMonad UncheckedProg
-> Pos -> Text -> Either SyntaxError (UncheckedProg, [Comment])
forall a.
ParserMonad a -> Pos -> Text -> Either SyntaxError (a, [Comment])
parseWithComments ParserMonad UncheckedProg
prog (FilePath -> Pos
initialPos FilePath
fname)

-- | Parse an Futhark expression from the given 'String', using the
-- 'FilePath' as the source name for error messages.
parseExp ::
  FilePath ->
  T.Text ->
  Either SyntaxError UncheckedExp
parseExp :: FilePath -> Text -> Either SyntaxError UncheckedExp
parseExp FilePath
fname = ParserMonad UncheckedExp
-> Pos -> Text -> Either SyntaxError UncheckedExp
forall a. ParserMonad a -> Pos -> Text -> Either SyntaxError a
parse ParserMonad UncheckedExp
expression (FilePath -> Pos
initialPos FilePath
fname)

-- | As 'parseExp', but the expression is assumed to start at the
-- given position, rather than at the beginning of a file.  This is
-- useful when the expression is a fragment of a larger file, as the
-- source locations in the result will then refer to that file.  The
-- position also provides the source name for error messages.
parseExpAt ::
  Pos ->
  T.Text ->
  Either SyntaxError UncheckedExp
parseExpAt :: Pos -> Text -> Either SyntaxError UncheckedExp
parseExpAt = ParserMonad UncheckedExp
-> Pos -> Text -> Either SyntaxError UncheckedExp
forall a. ParserMonad a -> Pos -> Text -> Either SyntaxError a
parse ParserMonad UncheckedExp
expression

-- | Parse a Futhark module expression from the given 'String', using the
-- 'FilePath' as the source name for error messages.
parseModExp ::
  FilePath ->
  T.Text ->
  Either SyntaxError (ModExpBase NoInfo Name)
parseModExp :: FilePath -> Text -> Either SyntaxError (ModExpBase NoInfo Name)
parseModExp FilePath
fname = ParserMonad (ModExpBase NoInfo Name)
-> Pos -> Text -> Either SyntaxError (ModExpBase NoInfo Name)
forall a. ParserMonad a -> Pos -> Text -> Either SyntaxError a
parse ParserMonad (ModExpBase NoInfo Name)
modExpression (FilePath -> Pos
initialPos FilePath
fname)

-- | Parse an Futhark type from the given 'String', using the
-- 'FilePath' as the source name for error messages.
parseType ::
  FilePath ->
  T.Text ->
  Either SyntaxError UncheckedTypeExp
parseType :: FilePath -> Text -> Either SyntaxError UncheckedTypeExp
parseType FilePath
fname = ParserMonad UncheckedTypeExp
-> Pos -> Text -> Either SyntaxError UncheckedTypeExp
forall a. ParserMonad a -> Pos -> Text -> Either SyntaxError a
parse ParserMonad UncheckedTypeExp
futharkType (FilePath -> Pos
initialPos FilePath
fname)

-- | Parse either an expression or a declaration; favouring declarations in case
-- of ambiguity.
parseDecOrExp ::
  FilePath ->
  T.Text ->
  Either SyntaxError (Either UncheckedDec UncheckedExp)
parseDecOrExp :: FilePath
-> Text -> Either SyntaxError (Either UncheckedDec UncheckedExp)
parseDecOrExp FilePath
fname Text
input =
  case ParserMonad UncheckedDec
-> Pos -> Text -> Either SyntaxError UncheckedDec
forall a. ParserMonad a -> Pos -> Text -> Either SyntaxError a
parse ParserMonad UncheckedDec
declaration (FilePath -> Pos
initialPos FilePath
fname) Text
input of
    Left {} -> UncheckedExp -> Either UncheckedDec UncheckedExp
forall a b. b -> Either a b
Right (UncheckedExp -> Either UncheckedDec UncheckedExp)
-> Either SyntaxError UncheckedExp
-> Either SyntaxError (Either UncheckedDec UncheckedExp)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> FilePath -> Text -> Either SyntaxError UncheckedExp
parseExp FilePath
fname Text
input
    Right UncheckedDec
d -> Either UncheckedDec UncheckedExp
-> Either SyntaxError (Either UncheckedDec UncheckedExp)
forall a b. b -> Either a b
Right (Either UncheckedDec UncheckedExp
 -> Either SyntaxError (Either UncheckedDec UncheckedExp))
-> Either UncheckedDec UncheckedExp
-> Either SyntaxError (Either UncheckedDec UncheckedExp)
forall a b. (a -> b) -> a -> b
$ UncheckedDec -> Either UncheckedDec UncheckedExp
forall a b. a -> Either a b
Left UncheckedDec
d