Moduleghc-10.0.0.20260917GHC2024

GHC.StgToJS.Object

Serialization/deserialization of binary .o files for the JavaScript backend

12 types
17 values

Packageghc-10.0.0.20260917
Exports29
LanguageGHC2024
LicenceBSD-3-Clause
SourceObject.hs

datadata ObjectKind

Different kinds of object (.o) supported by the JS backend

Constructors

ObjJs
JavaScript source embedded in a .o
ObjHs
JS backend object for Haskell code
ObjCc
Wasm module object as produced by emcc

Instances3Eq, Ord, Show

Eq ObjectKindDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Ord ObjectKindDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Show ObjectKindDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object

valuegetObjectKind :: FilePath -> IO (Maybe ObjectKind)

Get the kind of a file object, if any

valuegetObjectKindBS :: ByteString -> Maybe ObjectKind

Get the kind of an object stored in a bytestring, if any

JS object

7 declarations

datadata JSOptions

Options obtained from pragmas in JS files

Constructors

JSOptions
- enableCPP :: !Bool
  Enable CPP on the JS file
- emccExtraOptions :: ![String]
  Pass additional options to emcc at link time
- emccExportedFunctions :: ![String]
  Arguments for `-sEXPORTED_FUNCTIONS`
- emccExportedRuntimeMethods :: ![String]
  Arguments for `-sEXPORTED_RUNTIME_METHODS`

Instances4Eq, Ord, Semigroup, Binary

Eq JSOptionsDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Ord JSOptionsDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Semigroup JSOptionsDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Binary JSOptionsDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object

valuedefaultJSOptions :: JSOptions

valuegetOptionsFromJsFile

:: FilePath
Input file
-> IO JSOptions
Parsed options.

Parse option pragma in JS file

valuewriteJSObject :: JSOptions -> ByteString -> FilePath -> IO ()

Write a JS object (embed some handwritten JS code)

valuereadJSObject :: FilePath -> IO (JSOptions, ByteString)

Read a JS object from file

valueparseJSObject :: ReadBinHandle -> IO (JSOptions, ByteString)

Read a JS object from BinHandle

valueparseJSObjectBS :: ByteString -> IO (JSOptions, ByteString)

Read a JS object from ByteString

HS object

19 declarations

valueputObject

:: WriteBinHandle
-> ModuleName
module
-> BlockInfo
block infos
-> [ObjBlock]
linkable units and their symbols
-> IO ()

Given a handle to a Binary payload, add the module, mod_name, its dependencies, deps, and its linkable units to the payload.

valuegetObjectHeader :: ReadBinHandle -> IO (Either String ModuleName)

Parse object header

valuegetObjectBody :: ReadBinHandle -> ModuleName -> IO Object

Parse object body. Must be called after a successful getObjectHeader

valuegetObject :: ReadBinHandle -> IO (Maybe Object)

Parse object

valuereadObject :: FilePath -> IO (Maybe Object)

Read object from file

The object is still in memory after this (see objHandle).

valuegetObjectBlocks :: Object -> BlockIds -> IO [ObjBlock]

Get blocks in the object file, using the given filtering function

valuereadObjectBlocks :: FilePath -> BlockIds -> IO [ObjBlock]

Read blocks in the object file, using the given filtering function

valuereadObjectBlockInfo :: FilePath -> IO (Maybe BlockInfo)

Reads only the part necessary to get the block info

valueisGlobalBlock :: BlockId -> Bool

we use the convention that the first block (0) is a module-global block that's always included when something from the module is loaded. everything in a module implicitly depends on the global block. The global block itself can't have dependencies

datadata Object

A HS object file

Constructors

Object
- objModuleName :: !ModuleName
  name of the module
- objHandle :: !ReadBinHandle
  BinHandle that can be used to read the ObjBlocks
- objPayloadOffset :: !Bin ObjBlock
  Offset of the payload (units)
- objBlockInfo :: !BlockInfo
  Information about blocks
- objIndex :: !Index
  Block index: symbols per block and block offset in the object file

datadata IndexEntry

Constructors

IndexEntry
- idxSymbols :: ![FastString]
  Symbols exported by a block
- idxOffset :: !Bin ObjBlock
  Offset of the block in the object file

Instances1Binary

Binary IndexEntryDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object

datadata LocatedBlockInfo

Constructors

LocatedBlockInfo
- lbi_loc :: !BlockLocation
  Where to find the blocks
- lbi_info :: !BlockInfo
  Block information

datadata BlockInfo

Information about blocks (linkable units)

Constructors

BlockInfo
- bi_module :: !Module
  Module they were generated from
- bi_must_link :: !BlockIds
  blocks that always need to be linked when this object is loaded (e.g. everything that contains initializer code or foreign exports)
- bi_exports :: !Map ExportedFun BlockId
  exported Haskell functions -> block
- bi_block_deps :: !Array BlockId BlockDeps
  dependencies of each block

Instances2Outputable, Binary

Outputable BlockInfoDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Binary BlockInfoDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object

datadata BlockDeps

Constructors

BlockDeps
- blockBlockDeps :: [BlockId]
  dependencies on blocks in this object
- blockFunDeps :: [ExportedFun]
  dependencies on exported symbols in other objects , blockForeignExported :: [ExpFun] , blockForeignImported :: [ForeignRef]

Instances1Binary

Binary BlockDepsDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object

datadata BlockLocation

Where are the blocks

Constructors

ObjectFile FilePath
In an object file at path
ArchiveFile FilePath
In a Ar file at path
InMemory String Object
In memory

Instances1Outputable

Outputable BlockLocationDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object

typetype BlockId = Int

typetype BlockIds = IntSet

datadata BlockRef

A BlockRef is a pair of a module and the index of the block in the object file

Constructors

BlockRef
- block_ref_mod :: !Module
  Module
- block_ref_idx :: !BlockId
  Block index in the object file

Instances2Eq, Ord

Eq BlockRefDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Ord BlockRefDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object

datadata ExportedFun

Exported Functions

Constructors

ExportedFun
- funModule :: !Module
  The module containing the function
- funSymbol :: !LexicalFastString
  The function

Instances4Eq, Ord, Outputable, Binary

Eq ExportedFunDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Ord ExportedFunDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Outputable ExportedFunDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object
Binary ExportedFunDefined in ghc-10.0.0.20260917 · GHC.StgToJS.Object

Orphan instances

21 instances