https://github.com/toktok/apidsl

DSL for C APIs to aid consistency of naming schemes and comments.
https://github.com/toktok/apidsl

consistency dsl naming-schemes ocaml

Last synced: 2 months ago
JSON representation

DSL for C APIs to aid consistency of naming schemes and comments.

• Host: GitHub
• URL: https://github.com/toktok/apidsl
• Owner: TokTok
• License: gpl-3.0
• Created: 2015-03-31T23:51:38.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2021-12-03T02:19:07.000Z (about 3 years ago)
• Last Synced: 2024-03-26T15:33:35.379Z (10 months ago)
• Topics: consistency, dsl, naming-schemes, ocaml
• Language: Haskell
• Homepage: https://toktok.ltd/
• Size: 418 KB
• Stars: 6
• Watchers: 26
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# APIDSL

A [DSL](http://en.wikipedia.org/wiki/Domain-specific_language) for **C** API's

to add consistency of naming schemes and comments.

## INSTALLATION

### Regular

You will need **OCaml** (>= 4.03; older versions may not work) and **OPAM** (at

least 1.2). Instructions on how to install **OCaml** and **OPAM** can be found

[here](https://opam.ocaml.org/doc/Install.html).

For `make coverage` you also need `oasis` and `bisect_ppx`. The coverage script

will attempt to install these if they are not yet installed.

#### Installing dependencies:

Make sure to configure **OPAM** by running `opam init`. (Depending on your

configuration you might also need to run `` eval `opam config env` ``). Running

`opam install ocamlfind ppx_deriving menhir` should install all dependencies

required for APIDSL.

#### Compiling

Just run `make` in APIDSL's root directory. The apidsl binary can be found

under `./_build/apigen.native`

### Docker

Alternatively, you can use Docker to build APIDSL. This is useful when your

Linux distribution doesn't have the versions of dependencies required for APIDSL

or you don't want to pollute your system by installing all those dependencies.

#### Usage

[Get Docker on your system](https://docs.docker.com/engine/installation/linux/).

Note that some versions of

[Debian](https://packages.debian.org/search?suite=all&searchon=names&keywords=docker.io)

and [Ubuntu](http://packages.ubuntu.com/search?suite=all&searchon=names&keywords=docker.io)

have it in their package repository.

Run the following. It takes about 4 minutes to run on my machine, so you can

grab a cup of coffee/tea in the meantime.

```sh

# Clone this repository

git clone https://github.com/TokTok/apidsl

cd apidsl

# Build "apidsl" Docker image based on Dockerfile instructions

docker build -t apidsl .

# Run the image, i.e. execute the CMD part of the Dockerfile, mounting the

# current directory (the APIDSL repository) as /apidsl inside the image

docker run --rm -v $PWD:/apidsl apidsl

# Make sure apigen.native has appeared in the current directory

ls -lbh apigen.native

# Copy it over to /usr/local/bin

sudo cp ./apigen.native /usr/local/bin/

# Optional Cleanup

# Delete the image we have built

docker rmi apidsl ocaml/opam:alpine-3.15-ocaml-4.13-flambda-fp

# Make sure no related containers or images are left.

# They may use a lot of disk space.

docker ps -a

docker images -a

```

You should now have `/usr/local/bin/apigen.native`.

## USAGE

TODO, but you can check some examples in tests directory.