Introduction

GHCJS is a Haskell to JavaScript compiler that uses the GHC API.

Quick Start - Developing GHCJS

GHCJS contains a library, ghcjs, which contains the JavaScript code generator and a slightly customized variant of the ghc library, and several executable programs.

The repository has several submodules and some files must be generated before the package can be installed.

prerequisites

GHC

You need the same major version of GHC as the version of the GHCJS branch you're building.

cabal-install

cabal-install 3.0 is supported

emscripten emsdk

GHCJS uses a C toolchain, mostly for build system related tasks like the C preprocessor, Autoconf scripts and tools like hsc2hs. Direct support for using compiled foreign libraries from Haskell code may follow at a later date.

Please follow the installation instructions at https://emscripten.org/docs/getting_started/index.html

GHCJS requires the "upstream" emscripten backend, which is the default now. The earlier "fastcomp" backend will not work.

getting and preparing the source tree

$ git clone https://github.com/ghcjs/ghcjs.git
$ cd ghcjs
$ git submodule update --init --recursive

building the compiler

GHCJS depends on a few "local" packages in the source tree. You can use cabal-install and stack to set up a build environment that contains these packages.

Cabal new-install

After the source tree has been prepared, the package can be installed. You may want ensure that binaries of earlier versions are overwritten:

cabal v2-install --overwrite-policy=always --install-method=copy --installdir=inplace/bin

At the time of writing, cabal-install does not support creating symbolic links on Windows, even though this is the default installation method. A workaround is telling it to copy the executables instead:

cabal v1-install --prefix=inplace

v1 style Cabal sandbox

v1 style cabal sandboxes are also supported

if you want to build with a Cabal sandbox, use the makeSandbox.sh script to add the local packages.

$ cabal v1-sandbox init
$ cabal v1-install

stack

or you can use stack:

$ stack --system-ghc --skip-ghc-check install --local-bin-dir=inplace/bin

Booting GHCJS

The ghcjs-boot program builds the "boot" libraries, like ghc-prim, base and template-haskell with GHCJS. After booting, GHCJS can compile regular Haskell programs and packages.

ghcjs-boot needs to be able to find the emscripten toolchain, a nodejs executable. The easiest way to do this is by running the emsdk_env.sh script. After that, you can run ghcjs-boot by pointing it to the boot libraries (the directory containing the boot.yaml file)

$ source ~/emsdk/emsdk_env.sh
$ ./inplace/bin/ghcjs-boot -s ./lib/boot

GHCJS executables and library paths

After booting, you can add the directory containing the GHCJS binaries to your executable PATH. The ghcjs-boot program prints the location after finishing building the libraries.

You can also create a symbolic link for the ghcjs and ghcjs-pkg programs, or use the --with-compiler and --with-hc-pkg flags when using cabal-install

Generating a source distribution

if you work on boot packages that need some for an upstream library, make sure to update the patches in /lib/patches first

$ ./utils/updatePatches.sh

then regenerate the packages

$ ./utils/makePackages.sh

`ReferenceError` test suite failure mode

Supported symbol types:

raise
mainZCZCMainzimain

Unsupported symbol types:

compiled c (hello, foo, bar)

Debugging info:

This is a JavaScript exception.
None of the errored names show up in git grep, so they mustn't be defined for some reason.

Just before sine of the errors, there's a warning warning, unhandled primop which comes from the
default case of Gen2.Prim.genPrim:

genPrim _ _ op rs as = PrimInline $
appS "h$log" [e $ "warning, unhandled primop: "++show op++" "++show (length rs, length as)] #
f #
copyRes
where
  f = ApplStat (var (T.pack $ "h$primop_" ++ show op)) as
  copyRes = mconcat $ zipWith (\r reg -> r |= e reg) rs (enumFrom Ret1)

Primops are defined in primop-data-decl.hs-incl
Missing primops (11 matches): PrefetchAddrOp3 SetThreadAllocationCounter WriteByteArrayOp_Word8AsInt16 BRev8Op ShrinkSmallMutableArrayOp_Char
Missing others: h$opendir h$test_lt h$putchar h$memintrinTest h$log1p h$f5149 h$do_popcnt32 h$stg_word32ToFloatzh h$getOrSetLibHSghcGlobalDynFlags h$sqrt h$splitmix_init h$stg_floatToWord32zh h$func h$splitmix_init h$performGC_ h$foo h$mainZCZCMainzimain h$test_prim_op h$fin h$hello h$qsort h$puts h$test h$f h$var h$write h$free_fn_blob h$call8 h$staticfoo h$i h$printf h$n h$many_floats h$head_bytearray h$is_doubleton_homogenous h$add_all_int8 h$add_all_word8 h$add_all_int16 h$add_all_word16 h$getDbl h$getOrSetLibHSghcFastStringTable h$bar h$ghcjsbn_gcdExtSBigNat h$genSym h$finalize_value h$RtsFlags h$traceEventBinary h$deriv h$printx h$rts_unsafeGetMyCapability h$pipe h$initLinker_
- Some of these are clearly c-naming (putchar, opendir)
- Others are clearly haskell generated names (mainZCZCMainzimain)
- Others look like internal haskell stuff (getSym, RtsFlags)
- Some look like they come from compiled names (hello, foo, bar)

ghcjs / ghc Goto Github PK

ghc's Introduction

Introduction

Quick Start - Developing GHCJS

prerequisites

GHC

cabal-install

emscripten emsdk

getting and preparing the source tree

building the compiler

Cabal new-install

v1 style Cabal sandbox

stack

Booting GHCJS

GHCJS executables and library paths

Generating a source distribution

ghc's People

Contributors

Stargazers

Watchers

Forkers

ghc's Issues

Priorities

Important

Fix

Possibly fixable

Test configuration

Unsupported

Breakdown

total errors (989)

ReferenceError (580)

backpack (121)

interactive (110)

SyntaxError (25)

output syntax (44)

warnings (4)

machine size

nodeSettings.json: openBinaryFile: does not exist (No such file or directory) (19)

uncaught exception in Haskell main thread: Error: not implemented (17?)

pattern match failure (7)

misc (3)

unknown

unknown numeric

Recommend Projects

Recommend Topics

Recommend Org