Safe Haskell	None
Language	Haskell2010

Fay

Description

Main library entry point.

Synopsis

module Fay.Config
data CompileError
- = Couldn'tFindImport ModuleName [FilePath]
- | EmptyDoBlock
- | FfiFormatBadChars SrcSpanInfo String
- | FfiFormatIncompleteArg SrcSpanInfo
- | FfiFormatInvalidJavaScript SrcSpanInfo String String
- | FfiFormatNoSuchArg SrcSpanInfo Int
- | FfiNeedsTypeSig Exp
- | GHCError String
- | InvalidDoBlock
- | ParseError SrcLoc String
- | ShouldBeDesugared String
- | UnableResolveQualified QName
- | UnsupportedDeclaration Decl
- | UnsupportedEnum Exp
- | UnsupportedExportSpec ExportSpec
- | UnsupportedExpression Exp
- | UnsupportedFieldPattern PatField
- | UnsupportedImport ImportDecl
- | UnsupportedLet
- | UnsupportedLetBinding Decl
- | UnsupportedLiteral Literal
- | UnsupportedModuleSyntax String Module
- | UnsupportedPattern Pat
- | UnsupportedQualStmt QualStmt
- | UnsupportedRecursiveDo
- | UnsupportedRhs Rhs
- | UnsupportedWhereInAlt Alt
- | UnsupportedWhereInMatch Match
data CompileState = CompileState {
- stateInterfaces :: Map ModuleName Symbols
- stateRecordTypes :: [(QName, [QName])]
- stateRecords :: [(QName, [Name])]
- stateNewtypes :: [(QName, Maybe QName, Type)]
- stateImported :: [(ModuleName, FilePath)]
- stateNameDepth :: Integer
- stateModuleName :: ModuleName
- stateJsModulePaths :: Set ModulePath
- stateUseFromString :: Bool
- stateTypeSigs :: Map QName Type
}
data CompileResult = CompileResult {
- resOutput :: String
- resImported :: [(String, FilePath)]
- resSourceMappings :: Maybe [Mapping]
}
compileFile :: Config -> FilePath -> IO (Either CompileError String)
compileFileWithState :: Config -> FilePath -> IO (Either CompileError (String, Maybe [Mapping], CompileState))
compileFileWithResult :: Config -> FilePath -> IO (Either CompileError CompileResult)
compileFromTo :: Config -> FilePath -> Maybe FilePath -> IO ()
compileFromToAndGenerateHtml :: Config -> FilePath -> FilePath -> IO (Either CompileError String)
toJsName :: String -> String
toTsName :: String -> String
showCompileError :: CompileError -> String
readConfigRuntime :: Config -> IO String

Documentation

module Fay.Config

data CompileError Source #

Error type.

Constructors

Couldn'tFindImport ModuleName [FilePath]
EmptyDoBlock
FfiFormatBadChars SrcSpanInfo String
FfiFormatIncompleteArg SrcSpanInfo
FfiFormatInvalidJavaScript SrcSpanInfo String String
FfiFormatNoSuchArg SrcSpanInfo Int
FfiNeedsTypeSig Exp
GHCError String
InvalidDoBlock
ParseError SrcLoc String
ShouldBeDesugared String
UnableResolveQualified QName
UnsupportedDeclaration Decl
UnsupportedEnum Exp
UnsupportedExportSpec ExportSpec
UnsupportedExpression Exp
UnsupportedFieldPattern PatField
UnsupportedImport ImportDecl
UnsupportedLet
UnsupportedLetBinding Decl
UnsupportedLiteral Literal
UnsupportedModuleSyntax String Module
UnsupportedPattern Pat
UnsupportedQualStmt QualStmt
UnsupportedRecursiveDo
UnsupportedRhs Rhs
UnsupportedWhereInAlt Alt
UnsupportedWhereInMatch Match

Instances

Instances details

Show CompileError Source #
Instance details Defined in Fay.Types.CompileError Methods showsPrec :: Int -> CompileError -> ShowS # show :: CompileError -> String # showList :: [CompileError] -> ShowS #
MonadError CompileError Compile Source #
Instance details Defined in Fay.Types Methods throwError :: CompileError -> Compile a # catchError :: Compile a -> (CompileError -> Compile a) -> Compile a #

data CompileState Source #

State of the compiler.

Constructors

CompileState

Fields

stateInterfaces :: Map ModuleName Symbols
Exported identifiers for all modules
stateRecordTypes :: [(QName, [QName])]
Map types to constructors
stateRecords :: [(QName, [Name])]
Map constructors to fields
stateNewtypes :: [(QName, Maybe QName, Type)]
Newtype constructor, destructor, wrapped type tuple
stateImported :: [(ModuleName, FilePath)]
Map of all imported modules and their source locations.
stateNameDepth :: Integer
Depth of the current lexical scope, used for creating unshadowing variables.
stateModuleName :: ModuleName
Name of the module currently being compiled.
stateJsModulePaths :: Set ModulePath
Module paths that have code generated for them.
stateUseFromString :: Bool
Use JS Strings instead of [Char] for string literals?
stateTypeSigs :: Map QName Type
Module level declarations having explicit type signatures

Instances

Instances details

Show CompileState Source #
Instance details Defined in Fay.Types Methods showsPrec :: Int -> CompileState -> ShowS # show :: CompileState -> String # showList :: [CompileState] -> ShowS #
MonadState CompileState Compile Source #
Instance details Defined in Fay.Types Methods get :: Compile CompileState # put :: CompileState -> Compile () # state :: (CompileState -> (a, CompileState)) -> Compile a #

data CompileResult Source #

Constructors

CompileResult
Fields resOutput :: String resImported :: [(String, FilePath)] resSourceMappings :: Maybe [Mapping]

Instances

Instances details

Show CompileResult Source #
Instance details Defined in Fay.Types.CompileResult Methods showsPrec :: Int -> CompileResult -> ShowS # show :: CompileResult -> String # showList :: [CompileResult] -> ShowS #

compileFile :: Config -> FilePath -> IO (Either CompileError String) Source #

Compile the given file.

compileFileWithState :: Config -> FilePath -> IO (Either CompileError (String, Maybe [Mapping], CompileState)) Source #

Compile a file returning the resulting internal state of the compiler. Don't use this directly, it's only exposed for the test suite.

compileFileWithResult :: Config -> FilePath -> IO (Either CompileError CompileResult) Source #

Compile a file returning additional generated metadata.

compileFromTo :: Config -> FilePath -> Maybe FilePath -> IO () Source #

Compile the given file and write the output to the given path, or if nothing given, stdout.

compileFromToAndGenerateHtml :: Config -> FilePath -> FilePath -> IO (Either CompileError String) Source #

Compile the given file and write to the output, also generates HTML and sourcemap files if configured.

toJsName :: String -> String Source #

Convert a Haskell filename to a JS filename.

toTsName :: String -> String Source #

Convert a Haskell filename to a TypeScript filename.

showCompileError :: CompileError -> String Source #

Print a compile error for human consumption.

readConfigRuntime :: Config -> IO String Source #

Get the JS runtime source. This will return the user supplied runtime if it exists.