Fay.Types

All Fay types and instances.

Documentation

data JsStmt

Statement type.

Constructors

JsVar JsName JsExp

JsIf JsExp [JsStmt] [JsStmt]

JsEarlyReturn JsExp

JsThrow JsExp

JsWhile JsExp [JsStmt]

JsUpdate JsName JsExp

JsSetProp JsName JsName JsExp

JsSetQName (Maybe SrcSpan) QName JsExp

JsSetModule ModulePath JsExp

JsSetConstructor QName JsExp

JsSetPropExtern JsName JsName JsExp

JsContinue

JsBlock [JsStmt]

JsExpStmt JsExp

Instances

Eq JsStmt

Show JsStmt

Printable JsStmt

Print a single statement.

Printable [JsStmt]

Print a list of statements.

data JsExp

Expression type.

Constructors

JsName JsName

JsRawExp String

JsSeq [JsExp]

JsFun (Maybe JsName) [JsName] [JsStmt] (Maybe JsExp)

JsLit JsLit

JsApp JsExp [JsExp]

JsNegApp JsExp

JsTernaryIf JsExp JsExp JsExp

JsNull

JsParen JsExp

JsGetProp JsExp JsName

JsLookup JsExp JsExp

JsUpdateProp JsExp JsName JsExp

JsGetPropExtern JsExp String

JsUpdatePropExtern JsExp JsName JsExp

JsList [JsExp]

JsNew JsName [JsExp]

JsThrowExp JsExp

JsInstanceOf JsExp JsName

JsIndex Int JsExp

JsEq JsExp JsExp

JsNeq JsExp JsExp

JsInfix String JsExp JsExp

JsObj [(String, JsExp)]

JsLitObj [(Name, JsExp)]

JsUndefined

JsAnd JsExp JsExp

JsOr JsExp JsExp

Instances

Eq JsExp

Show JsExp

Printable JsExp

Print an expression.

data JsLit

Literal value type.

Constructors

JsChar Char

JsStr String

JsInt Int

JsFloating Double

JsBool Bool

Instances

Eq JsLit

Show JsLit

IsString JsLit

Just handy to have.

Printable JsLit

Print literals. These need some special encoding for JS-format literals. Could use the Text.JSON library.

data JsName

A name of some kind.

Constructors

JsNameVar QName

JsThis

JsParametrizedType

JsThunk

JsForce

JsApply

JsParam Integer

JsTmp Integer

JsConstructor QName

JsBuiltIn Name

JsModuleName ModuleName

Instances

Eq JsName

Show JsName

Printable JsName

Print one of the kinds of names.

data CompileError

Error type.

Constructors

Couldn'tFindImport ModuleName [FilePath]

EmptyDoBlock

FfiFormatBadChars SrcSpanInfo String

FfiFormatIncompleteArg SrcSpanInfo

FfiFormatInvalidJavaScript SrcSpanInfo String String

FfiFormatNoSuchArg SrcSpanInfo Int

FfiNeedsTypeSig Decl

GHCError String

InvalidDoBlock

ParseError SrcLoc String

ShouldBeDesugared String

UnableResolveQualified QName

UnsupportedDeclaration Decl

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

Show CompileError

Error CompileError

MonadError CompileError Compile

newtype Compile a

Compile monad.

Constructors

Compile

Fields

unCompile :: RWST CompileReader CompileWriter CompileState (ErrorT CompileError (ModuleT (ModuleInfo Compile) IO)) a

Uns the compiler

Instances

Monad Compile

Functor Compile

Applicative Compile

MonadIO Compile

MonadModule Compile

MonadState CompileState Compile

MonadError CompileError Compile

MonadWriter CompileWriter Compile

MonadReader CompileReader Compile

type CompileResult a = Either CompileError (a, CompileState, CompileWriter)

type CompileModule a = ModuleT Symbols IO (CompileResult a)

class Printable a where

Print some value.

Methods

printJS :: a -> Printer ()

Instances

Printable String

Just write out strings.

Printable SpecialCon

Print special constructors (tuples, list, etc.)

Printable QName

Print (and properly encode to JS) a qualified name.

Printable Name

Print (and properly encode) a name.

Printable ModuleName

Print module name.

Printable JsLit

Print literals. These need some special encoding for JS-format literals. Could use the Text.JSON library.

Printable JsName

Print one of the kinds of names.

Printable JsExp

Print an expression.

Printable JsStmt

Print a single statement.

Printable ModulePath

Print a module path.

Printable [JsStmt]

Print a list of statements.

Printable (Printer ())

A printer is a printable.

data Fay a

The JavaScript FFI interfacing monad.

Instances

Monad Fay

data CompileReader

Configuration and globals for the compiler.

Constructors

CompileReader

Fields

readerConfig :: CompileConfig

The compilation configuration.

readerCompileLit :: Literal -> Compile JsExp

readerCompileDecls :: Bool -> [Decl] -> Compile [JsStmt]

Instances

MonadReader CompileReader Compile

data CompileWriter

Things written out by the compiler.

Constructors

CompileWriter

Fields

writerCons :: [JsStmt]

Constructors.

writerFayToJs :: [(String, JsExp)]

Fay to JS dispatchers.

writerJsToFay :: [(String, JsExp)]

JS to Fay dispatchers.

Instances

Show CompileWriter

Monoid CompileWriter

Simple concatenating instance.

MonadWriter CompileWriter Compile

data CompileConfig

Configuration of the compiler.

Constructors

CompileConfig

Fields

configOptimize :: Bool

Run optimizations

configFlattenApps :: Bool

Flatten function application?

configExportRuntime :: Bool

Export the runtime?

configExportStdlib :: Bool

Export the stdlib?

configExportStdlibOnly :: Bool

Export only the stdlib?

configDirectoryIncludes :: [(Maybe String, FilePath)]

Possibly a fay package name, and a include directory.

configPrettyPrint :: Bool

Pretty print the JS output?

configHtmlWrapper :: Bool

Output a HTML file including the produced JS.

configSourceMap :: Bool

Output a source map file as outfile.map.

configHtmlJSLibs :: [FilePath]

Any JS files to link to in the HTML.

configLibrary :: Bool

Don't invoke main in the produced JS.

configWarn :: Bool

Warn on dubious stuff, not related to typechecking.

configFilePath :: Maybe FilePath

File path to output to.

configTypecheck :: Bool

Typecheck with GHC.

configWall :: Bool

Typecheck with -Wall.

configGClosure :: Bool

Run Google Closure on the produced JS.

configPackageConf :: Maybe FilePath

The package config e.g. packages-6.12.3.

configPackages :: [String]

Included Fay packages.

configBasePath :: Maybe FilePath

Custom source location for fay-base

configStrict :: [String]

Produce strict and uncurried wrappers for all functions with type signatures in the given module

configTypecheckOnly :: Bool

Only invoke GHC for typechecking, don't produce any output

configRuntimePath :: Maybe FilePath

Instances

Show CompileConfig

Default CompileConfig

Default configuration.

data CompileState

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

Show CompileState

MonadState CompileState Compile

data FundamentalType

These are the data types that are serializable directly to native JS data types. Strings, floating points and arrays. The others are: actions in the JS monad, which are thunks that shouldn't be forced when serialized but wrapped up as JS zero-arg functions, and unknown types can't be converted but should at least be forced.

Constructors

FunctionType [FundamentalType]

JsType FundamentalType

ListType FundamentalType

TupleType [FundamentalType]

UserDefined Name [FundamentalType]

Defined FundamentalType

Nullable FundamentalType

DateType

StringType

DoubleType

IntType

BoolType

PtrType

Automatic

UnknownType

Instances

Show FundamentalType

data PrintState

The state of the pretty printer.

Constructors

PrintState

Fields

psPretty :: Bool

Are we to pretty print?

psLine :: Int

The current line.

psColumn :: Int

Current column.

psMappings :: [Mapping]

Source mappings.

psIndentLevel :: Int

Current indentation level.

psOutput :: [String]

The current output. TODO: Make more efficient.

psNewline :: Bool

Just outputted a newline?

Instances

Default PrintState

Default state.

MonadState PrintState Printer

newtype Printer a

The printer monad.

Constructors

Printer

Fields

runPrinter :: State PrintState a

Instances

Monad Printer

Functor Printer

MonadState PrintState Printer

Printable (Printer ())

A printer is a printable.

data SerializeContext

The serialization context indicates whether we're currently serializing some value or a particular field in a user-defined data type.

Constructors

SerializeAnywhere

SerializeUserArg Int

Instances

Eq SerializeContext

Read SerializeContext

Show SerializeContext

data ModulePath

The name of a module split into a list for code generation.

Instances

Eq ModulePath

Ord ModulePath

Show ModulePath

Printable ModulePath

Print a module path.

mkModulePath :: ModuleName a -> ModulePath

Construct the complete ModulePath from a ModuleName.

mkModulePaths :: ModuleName a -> [ModulePath]

Construct intermediate module paths from a ModuleName. mkModulePaths A.B => [[A], [A,B]]

mkModulePathFromQName :: QName a -> ModulePath

Converting a QName to a ModulePath is only relevant for constructors since they can conflict with module names.