https://github.com/michareiser/llvm-node

LLVM 9.0+ Node Bindings
https://github.com/michareiser/llvm-node

llvm llvm-node node v8

Last synced: 6 days ago
JSON representation

LLVM 9.0+ Node Bindings

• Host: GitHub
• URL: https://github.com/michareiser/llvm-node
• Owner: MichaReiser
• License: mit
• Created: 2017-03-02T07:40:50.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T04:06:45.000Z (about 2 years ago)
• Last Synced: 2024-04-14T19:32:43.446Z (10 months ago)
• Topics: llvm, llvm-node, node, v8
• Language: C++
• Homepage:
• Size: 1.01 MB
• Stars: 182
• Watchers: 9
• Forks: 27
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# llvm-node

[![Build Status](https://travis-ci.com/MichaReiser/llvm-node.svg?branch=master)](https://travis-ci.com/MichaReiser/llvm-node)

[![npm version](https://badge.fury.io/js/llvm-node.svg)](https://badge.fury.io/js/llvm-node)

Node Bindings for LLVM. The API is mostly identical to the one of LLVM (when possible and not to cumbersom). All supported methods with their signatures are listed in the [TypeScript definition file](./llvm-node.d.ts).

## Getting Started

Install the packages using npm or yarn.

```bash

npm install --save llvm-node

```

Require llvm-node and you're good to go

```js

import * as llvm from "llvm-node";

// or

const llvm = require("llvm-node");

const context = new llvm.LLVMContext();

const module = new llvm.Module("test", context);

const intType = llvm.Type.getInt32Ty(context);

const initializer = llvm.ConstantInt.get(context, 0);

const globalVariable = new llvm.GlobalVariable(module, intType, true, llvm.LinkageTypes.InternalLinkage, initializer);

const ll = module.print(); // prints IR

llvm.writeBitcodeToFile(module, biteCodeFileName); // Writes file to disk

```

## Custom LLVM Installation

You can use the npm configuration options to set the path to the LLVM cmake directory. This is needed if you don't want to use the system default LLVM installation --- e.g. when you want to compile againt the latest dev version.

To change the LLVM version use:

```sh

npm config set cmake_LLVM_DIR $(path-to-llvm/bin/llvm-config --cmakedir)

```

If you want to change the value just for a single project use an [.npmrc](https://docs.npmjs.com/files/npmrc) file in your project.

## Debug Build

If you want to use `Value.dump` or `Module.dump` you need to use the debug build of the library (and, as well, of LLVM).

In this case, run `node-gyp build --debug` or if using `npm install` run `npm_config_DEBUG=true npm install llvm-node`.

There variables can also be set using npm set:

`npm config set [--global] DEBUG True`

## Develop with VS-Code

1. Install the [C++ Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)

2. Install the [Cmake Tools Extension](https://marketplace.visualstudio.com/items?itemName=vector-of-bool.cmake-tools)

3. Configure the LLVM directory in the user settings by adding the following entry

```json

"cmake.configureSettings": {

    "LLVM_DIR": "/usr/local/Cellar/llvm/7.0.0/lib/cmake/llvm" // Output of llvm-config --cmakedir

}

```

4. Run the `CMake:Configure` Command in Visual Studio Code

5. Run `yarn configure` from the command line

6. Run `CMake:Build` command in Visual Studio Code