Moduleghc-9.10.3GHC2021

GHC.StgToJS.Linker.Linker

GHCJS linker, collects dependencies from the object files which contain linkable units with dependency information

3 types
11 values

Packageghc-9.10.3
Exports14
LanguageGHC2021
LicenceBSD-3-Clause
SourceLinker.hs

valuejsLinkBinary

:: FinderCache
-> JSLinkConfig
-> StgToJSConfig
-> Logger
-> TmpFs
-> DynFlags
-> UnitEnv
-> [FilePath]
-> [UnitId]
-> IO ()

valuejsLink

:: JSLinkConfig
-> StgToJSConfig
-> Logger
-> TmpFs
-> ArchiveCache
-> FilePath
output file/directory
-> LinkPlan
-> IO ()

link and write result to disk (jsexe directory)

valueembedJsFile

:: Logger
-> DynFlags
-> TmpFs
-> UnitEnv
-> FilePath
-> FilePath
-> IO ()

Embed a JS file into a JS object .o file

JS files may contain option pragmas of the form: //#OPTIONS: One of those is //#OPTIONS:CPP. When it is set, we append some common CPP definitions to the file and call cpp on it.

Other options (e.g. EMCC additional flags for link time) are stored in the JS object header. See JSOptions.

valuestaticInitStat :: StaticInfo -> JStat

Initialize a global object.

All global objects have to be declared (staticInfoDecl) first.

valuestaticDeclStat :: StaticInfo -> JStat

declare and do first-pass init of a global object (create JS object for heap objects)

valuemkExportedFuns :: UnitId -> FastString -> [FastString] -> [ExportedFun]

Given a UnitId, a module name, and a set of symbols in the module, package these into an ExportedFun.

valuemkExportedModFuns :: Module -> [FastString] -> [ExportedFun]

Given a Module and a set of symbols in the module, package these into an ExportedFun.

valuecomputeLinkDependencies

datadata LinkSpec

Constructors

LinkSpec
- lks_unit_ids :: [UnitId]
- lks_obj_root_filter :: ExportedFun -> Bool
  Predicate for exported functions in objects to declare as root
- lks_extra_roots :: Set ExportedFun
  Extra root functions from loaded units
- lks_objs_hs :: [FilePath]
  HS objects to link
- lks_objs_js :: [FilePath]
  JS objects to link
- lks_objs_cc :: [FilePath]
  Cc objects to link

Instances1Outputable

Outputable LinkSpecDefined in ghc-9.10.3 · GHC.StgToJS.Linker.Linker

datadata LinkPlan

Constructors

LinkPlan
- lkp_block_info :: Map Module LocatedBlockInfo
  Block information
- lkp_dep_blocks :: Set BlockRef
  Blocks to link
- lkp_archives :: !Set FilePath
  Archives to load JS and Cc sources from (JS code corresponding to Haskell code is handled with blocks above)
- lkp_objs_js :: !Set FilePath
  JS objects to link
- lkp_objs_cc :: !Set FilePath
  Cc objects to link

Instances1Outputable

Outputable LinkPlanDefined in ghc-9.10.3 · GHC.StgToJS.Linker.Types

valueemptyLinkPlan :: LinkPlan

valueincrementLinkPlan :: LinkPlan -> LinkPlan -> (LinkPlan, LinkPlan)

Given a base link plan (assumed to be already linked) and a new link plan, compute `(diff, total)` link plans.

diff is the incremental link plan to get from base to total
total is the total link plan as if base and new were linked at once

newtypenewtype ArchiveCache

valuenewArchiveCache :: IO ArchiveCache