inkwell 0.9.0

Inkwell aims to help you pen your own programming languages by safely wrapping llvm-sys.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

name: Test Suite and Doc

on: [ push, pull_request ]

env:
  CARGO_TERM_COLOR: always
  DOC_LLVM_FEATURE: llvm21-1
  DOC_LLVM_VERSION: "21.1"
  DOC_PATH: target/doc

jobs:
  lint:
    name: Linting
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Repo
      uses: actions/checkout@v4
    - name: Install Rust Stable
      uses: dtolnay/rust-toolchain@stable
    - name: Install typos
      uses: taiki-e/install-action@typos
    - name: Check typos
      run: typos .
    - name: Check code formatting
      run: cargo fmt --check
  tests:
    name: "LLVM ${{ matrix.llvm-version[0] }}: ${{ matrix.os }}"
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        llvm-version:
        - [ "11.0", "11-0" ]
        - [ "12.0", "12-0" ]
        - [ "13.0", "13-0" ]
        - [ "14.0", "14-0" ]
        - [ "15.0", "15-0" ]
        - [ "16.0", "16-0" ]
        - [ "17.0", "17-0" ]
        - [ "18.1", "18-1" ]
        - [ "19.1", "19-1", "19" ]
        - [ "20.1", "20-1", "20" ]
        - [ "21.1", "21-1", "21" ]
        - [ "22.1", "22-1", "22" ]
        include:
        - os: ubuntu-latest
    steps:
    - name: Checkout Repo
      uses: actions/checkout@v4
    - name: Install libtinfo5
      run: |
        wget https://security.ubuntu.com/ubuntu/pool/universe/n/ncurses/libtinfo5_6.3-2ubuntu0.1_amd64.deb
        sudo apt install ./libtinfo5_6.3-2ubuntu0.1_amd64.deb
    - name: Install LLVM and Clang (LLVM >= 19.1)
      if: ${{ matrix.llvm-version[0] >= 19 }}
      run: |
        sudo apt install --no-install-recommends -y lsb-release wget software-properties-common gnupg
        wget https://apt.llvm.org/llvm.sh
        chmod +x llvm.sh
        sudo ./llvm.sh ${{ matrix.llvm-version[2] }}
        sudo apt-get update
        sudo apt install --no-install-recommends -y libllvm${{ matrix.llvm-version[2] }} \
                                                    llvm-${{ matrix.llvm-version[2] }} \
                                                    llvm-${{ matrix.llvm-version[2] }}-dev \
                                                    llvm-${{ matrix.llvm-version[2] }}-runtime \
                                                    libpolly-${{ matrix.llvm-version[2] }}-dev
        sudo update-alternatives --install /usr/bin/llvm-config llvm-config /usr/bin/llvm-config-${{ matrix.llvm-version[2] }} 10
    - name: Install LLVM and Clang (11 <= LLVM <= 19)
      uses: KyleMayes/install-llvm-action@v2
      if: ${{ matrix.llvm-version[0] >= 11 && matrix.llvm-version[0] <= 19 }}
      with:
        version: ${{ matrix.llvm-version[0] }}
    - name: llvm-config
      run: llvm-config --version --bindir --libdir
    - name: Install Rust Stable
      uses: moonrepo/setup-rust@v1
      with:
        bins: cargo-nextest
    - name: cargo clippy
      run: cargo clippy --tests --features llvm${{ matrix.llvm-version[1] }} -- -D warnings
    - name: Build
      run: cargo build --release --features llvm${{ matrix.llvm-version[1] }} --verbose
    - name: Run tests
      run: |
        cargo nextest run --release --features llvm${{ matrix.llvm-version[1] }} --verbose
        cargo test --doc --release --features llvm${{ matrix.llvm-version[1] }} --verbose
    - name: Build examples and run JIT for verification
      run: |
        cargo run --example kaleidoscope --features llvm${{ matrix.llvm-version[1] }} --verbose -- --dl --dp --dc -e "(1 + 2 + 3) / (2 + 3)"
        cargo run --example jit --features llvm${{ matrix.llvm-version[1] }} --verbose
        cargo run --example jit --features llvm${{ matrix.llvm-version[1] }} --verbose --release
  doc:
    name: Documentation
    runs-on: ubuntu-latest
    env:
      LLVM_SYS_211_PREFIX: ${{ github.workspace }}/llvm
    needs: [ lint, tests ]
    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
    steps:
    - uses: actions/checkout@v4
    - uses: KyleMayes/install-llvm-action@v2.0.8
      with:
        version: ${{ env.DOC_LLVM_VERSION }}
    - name: Install Rust Nightly
      uses: dtolnay/rust-toolchain@nightly
    - name: Build Documentation
      run: cargo +nightly doc --features ${{ env.DOC_LLVM_FEATURE }},nightly --verbose
    - name: Doc Index Page Redirection
      run: echo '<meta http-equiv="refresh" content="1; url=inkwell/index.html">' > ${{ env.DOC_PATH }}/index.html
    - name: Deploy Documentation
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ${{ env.DOC_PATH }}
        force_orphan: true