Fay.Types

All Fay types and instances.

Documentation

data JsStmt

Statement type.

Constructors

JsVar JsName JsExp

JsMapVar 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

Defined in Fay.Types.Js

Methods

(==) :: JsStmt -> JsStmt -> Bool

(/=) :: JsStmt -> JsStmt -> Bool

Show JsStmt

Defined in Fay.Types.Js

Methods

showsPrec :: Int -> JsStmt -> ShowS

show :: JsStmt -> String

showList :: [JsStmt] -> ShowS

Printable JsStmt

Print a single statement.

Defined in Fay.Compiler.Print

Methods

printJS :: JsStmt -> Printer

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

Defined in Fay.Types.Js

Methods

(==) :: JsExp -> JsExp -> Bool

(/=) :: JsExp -> JsExp -> Bool

Show JsExp

Defined in Fay.Types.Js

Methods

showsPrec :: Int -> JsExp -> ShowS

show :: JsExp -> String

showList :: [JsExp] -> ShowS

Printable JsExp

Print an expression.

Defined in Fay.Compiler.Print

Methods

printJS :: JsExp -> Printer

data JsLit

Literal value type.

Constructors

JsChar Char

JsStr String

JsInt Int

JsFloating Double

JsBool Bool

Instances

Eq JsLit

Defined in Fay.Types.Js

Methods

(==) :: JsLit -> JsLit -> Bool

(/=) :: JsLit -> JsLit -> Bool

Show JsLit

Defined in Fay.Types.Js

Methods

showsPrec :: Int -> JsLit -> ShowS

show :: JsLit -> String

showList :: [JsLit] -> ShowS

IsString JsLit

Just handy to have.

Defined in Fay.Types.Js

Methods

fromString :: String -> JsLit

Printable JsLit

Print literals.

Defined in Fay.Compiler.Print

Methods

printJS :: JsLit -> Printer

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

Defined in Fay.Types.Js

Methods

(==) :: JsName -> JsName -> Bool

(/=) :: JsName -> JsName -> Bool

Show JsName

Defined in Fay.Types.Js

Methods

showsPrec :: Int -> JsName -> ShowS

show :: JsName -> String

showList :: [JsName] -> ShowS

Printable JsName

Print one of the kinds of names.

Defined in Fay.Compiler.Print

Methods

printJS :: JsName -> Printer

data CompileError

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

Show CompileError

Defined in Fay.Types.CompileError

Methods

showsPrec :: Int -> CompileError -> ShowS

show :: CompileError -> String

showList :: [CompileError] -> ShowS

MonadError CompileError Compile

Defined in Fay.Types

Methods

throwError :: CompileError -> Compile a

catchError :: Compile a -> (CompileError -> Compile a) -> Compile a

newtype Compile a

Compile monad.

Constructors

Compile

Fields

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

  Uns the compiler

Instances

Monad Compile

Defined in Fay.Types

Methods

(>>=) :: Compile a -> (a -> Compile b) -> Compile b

(>>) :: Compile a -> Compile b -> Compile b

return :: a -> Compile a

Functor Compile

Defined in Fay.Types

Methods

fmap :: (a -> b) -> Compile a -> Compile b

(<$) :: a -> Compile b -> Compile a

Applicative Compile

Defined in Fay.Types

Methods

pure :: a -> Compile a

(<*>) :: Compile (a -> b) -> Compile a -> Compile b

liftA2 :: (a -> b -> c) -> Compile a -> Compile b -> Compile c

(*>) :: Compile a -> Compile b -> Compile b

(<*) :: Compile a -> Compile b -> Compile a

MonadIO Compile

Defined in Fay.Types

Methods

liftIO :: IO a -> Compile a

MonadWriter CompileWriter Compile

Defined in Fay.Types

Methods

writer :: (a, CompileWriter) -> Compile a

tell :: CompileWriter -> Compile ()

listen :: Compile a -> Compile (a, CompileWriter)

pass :: Compile (a, CompileWriter -> CompileWriter) -> Compile a

MonadState CompileState Compile

Defined in Fay.Types

Methods

get :: Compile CompileState

put :: CompileState -> Compile ()

state :: (CompileState -> (a, CompileState)) -> Compile a

MonadReader CompileReader Compile

Defined in Fay.Types

Methods

ask :: Compile CompileReader

local :: (CompileReader -> CompileReader) -> Compile a -> Compile a

reader :: (CompileReader -> a) -> Compile a

MonadError CompileError Compile

Defined in Fay.Types

Methods

throwError :: CompileError -> Compile a

catchError :: Compile a -> (CompileError -> Compile a) -> Compile a

type CompileModule a = ModuleT Symbols IO (Either CompileError (a, CompileState, CompileWriter))

class Printable a where

Print some value.

Methods

printJS :: a -> Printer

Instances

Printable ModulePath

Print a module path.

Defined in Fay.Compiler.Print

Methods

printJS :: ModulePath -> Printer

Printable JsLit

Print literals.

Defined in Fay.Compiler.Print

Methods

printJS :: JsLit -> Printer

Printable JsName

Print one of the kinds of names.

Defined in Fay.Compiler.Print

Methods

printJS :: JsName -> Printer

Printable JsExp

Print an expression.

Defined in Fay.Compiler.Print

Methods

printJS :: JsExp -> Printer

Printable JsStmt

Print a single statement.

Defined in Fay.Compiler.Print

Methods

printJS :: JsStmt -> Printer

Printable (ModuleName l)

Print module name.

Defined in Fay.Compiler.Print

Methods

printJS :: ModuleName l -> Printer

Printable (SpecialCon l)

Print special constructors (tuples, list, etc.)

Defined in Fay.Compiler.Print

Methods

printJS :: SpecialCon l -> Printer

Printable (QName l)

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

Defined in Fay.Compiler.Print

Methods

printJS :: QName l -> Printer

Printable (Name l)

Print (and properly encode) a name.

Defined in Fay.Compiler.Print

Methods

printJS :: Name l -> Printer

data Fay a

The JavaScript FFI interfacing monad.

Instances

Monad Fay

Defined in Fay.Types

Methods

(>>=) :: Fay a -> (a -> Fay b) -> Fay b

(>>) :: Fay a -> Fay b -> Fay b

return :: a -> Fay a

Functor Fay

Defined in Fay.Types

Methods

fmap :: (a -> b) -> Fay a -> Fay b

(<$) :: a -> Fay b -> Fay a

Applicative Fay

Defined in Fay.Types

Methods

pure :: a -> Fay a

(<*>) :: Fay (a -> b) -> Fay a -> Fay b

liftA2 :: (a -> b -> c) -> Fay a -> Fay b -> Fay c

(*>) :: Fay a -> Fay b -> Fay b

(<*) :: Fay a -> Fay b -> Fay a

data CompileReader

Configuration and globals for the compiler.

Constructors

CompileReader

Fields

• readerConfig :: Config

  The compilation configuration.

• readerCompileLit :: Sign -> Literal -> Compile JsExp
• readerCompileDecls :: Bool -> [Decl] -> Compile [JsStmt]

Instances

MonadReader CompileReader Compile

Defined in Fay.Types

Methods

ask :: Compile CompileReader

local :: (CompileReader -> CompileReader) -> Compile a -> Compile a

reader :: (CompileReader -> a) -> Compile a

data CompileResult

Constructors

CompileResult

Fields

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

Instances

Show CompileResult

Defined in Fay.Types.CompileResult

Methods

showsPrec :: Int -> CompileResult -> ShowS

show :: CompileResult -> String

showList :: [CompileResult] -> ShowS

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

Defined in Fay.Types

Methods

showsPrec :: Int -> CompileWriter -> ShowS

show :: CompileWriter -> String

showList :: [CompileWriter] -> ShowS

Semigroup CompileWriter

Simple concatenating instance.

Defined in Fay.Types

Methods

(<>) :: CompileWriter -> CompileWriter -> CompileWriter

sconcat :: NonEmpty CompileWriter -> CompileWriter

stimes :: Integral b => b -> CompileWriter -> CompileWriter

Monoid CompileWriter

Simple concatenating instance.

Defined in Fay.Types

Methods

mempty :: CompileWriter

mappend :: CompileWriter -> CompileWriter -> CompileWriter

mconcat :: [CompileWriter] -> CompileWriter

MonadWriter CompileWriter Compile

Defined in Fay.Types

Methods

writer :: (a, CompileWriter) -> Compile a

tell :: CompileWriter -> Compile ()

listen :: Compile a -> Compile (a, CompileWriter)

pass :: Compile (a, CompileWriter -> CompileWriter) -> Compile a

data Config

Configuration of the compiler. The fields with a leading underscore

Instances

Show Config

Defined in Fay.Config

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Default Config

Default configuration.

Defined in Fay.Config

Methods

def :: Config

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

Defined in Fay.Types

Methods

showsPrec :: Int -> CompileState -> ShowS

show :: CompileState -> String

showList :: [CompileState] -> ShowS

MonadState CompileState Compile

Defined in Fay.Types

Methods

get :: Compile CompileState

put :: CompileState -> Compile ()

state :: (CompileState -> (a, CompileState)) -> Compile a

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

Defined in Fay.Types.FFI

Methods

showsPrec :: Int -> FundamentalType -> ShowS

show :: FundamentalType -> String

showList :: [FundamentalType] -> ShowS

data PrintState

The state of the pretty printer.

Constructors

PrintState

Fields

• psLine :: Int

  The current line.

• psColumn :: Int

  Current column.

• psIndentLevel :: Int

  Current indentation level.

• psNewline :: Bool

  Just outputted a newline?

defaultPrintState :: PrintState

Default state.

data PrintReader

Global options of the printer

Constructors

PrintReader

Fields

• prPretty :: Bool

  Are we to pretty print?

• prPrettyThunks :: Bool

  Use pretty thunk names?

• prPrettyOperators :: Bool

  Use pretty operators?

defaultPrintReader :: PrintReader

default printer options (non-pretty printing)

data PrintWriter

Output of printer

Constructors

PrintWriter

Fields

• pwMappings :: [Mapping]

  Source mappings.

• pwOutput :: ShowS

  The current output.

Instances

Semigroup PrintWriter

Defined in Fay.Types.Printer

Methods

(<>) :: PrintWriter -> PrintWriter -> PrintWriter

sconcat :: NonEmpty PrintWriter -> PrintWriter

stimes :: Integral b => b -> PrintWriter -> PrintWriter

Monoid PrintWriter

Output concatenation

Defined in Fay.Types.Printer

Methods

mempty :: PrintWriter

mappend :: PrintWriter -> PrintWriter -> PrintWriter

mconcat :: [PrintWriter] -> PrintWriter

pwOutputString :: PrintWriter -> String

newtype Printer

The printer.

Constructors

Printer

Fields

• runPrinter :: RWS PrintReader PrintWriter PrintState ()

Instances

IsString Printer

Write out a string, updating the current position information.

Defined in Fay.Types.Printer

Methods

fromString :: String -> Printer

Semigroup Printer

Defined in Fay.Types.Printer

Methods

(<>) :: Printer -> Printer -> Printer

sconcat :: NonEmpty Printer -> Printer

stimes :: Integral b => b -> Printer -> Printer

Monoid Printer

Defined in Fay.Types.Printer

Methods

mempty :: Printer

mappend :: Printer -> Printer -> Printer

mconcat :: [Printer] -> Printer

execPrinter :: Printer -> PrintReader -> PrintWriter

indented :: Printer -> Printer

Print the given printer indented.

askIf :: (PrintReader -> Bool) -> Printer -> Printer -> Printer

exec one of Printers depending on PrintReader property.

newline :: Printer

Output a newline and makes next line indented when prPretty is True. Does nothing when prPretty is False

write :: String -> Printer

Write out a raw string, respecting the indentation Note: if you pass a string with newline characters, it will print them out even if prPretty is set to False. Also next line won't be indented. If you want write a smart newline (that is the one which will be written out only if prPretty is true, and after which the line will be indented) use newline)

mapping :: SrcSpan -> Printer

Generate a mapping from the Haskell location to the current point in the output.

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

Defined in Fay.Types.FFI

Methods

(==) :: SerializeContext -> SerializeContext -> Bool

(/=) :: SerializeContext -> SerializeContext -> Bool

Read SerializeContext

Defined in Fay.Types.FFI

Methods

readsPrec :: Int -> ReadS SerializeContext

readList :: ReadS [SerializeContext]

readPrec :: ReadPrec SerializeContext

readListPrec :: ReadPrec [SerializeContext]

Show SerializeContext

Defined in Fay.Types.FFI

Methods

showsPrec :: Int -> SerializeContext -> ShowS

show :: SerializeContext -> String

showList :: [SerializeContext] -> ShowS

data ModulePath

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

Instances

Eq ModulePath

Defined in Fay.Types.ModulePath

Methods

(==) :: ModulePath -> ModulePath -> Bool

(/=) :: ModulePath -> ModulePath -> Bool

Ord ModulePath

Defined in Fay.Types.ModulePath

Methods

compare :: ModulePath -> ModulePath -> Ordering

(<) :: ModulePath -> ModulePath -> Bool

(<=) :: ModulePath -> ModulePath -> Bool

(>) :: ModulePath -> ModulePath -> Bool

(>=) :: ModulePath -> ModulePath -> Bool

max :: ModulePath -> ModulePath -> ModulePath

min :: ModulePath -> ModulePath -> ModulePath

Show ModulePath

Defined in Fay.Types.ModulePath

Methods

showsPrec :: Int -> ModulePath -> ShowS

show :: ModulePath -> String

showList :: [ModulePath] -> ShowS

Printable ModulePath

Print a module path.

Defined in Fay.Compiler.Print

Methods

printJS :: ModulePath -> Printer

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.