Ninjag

A python package for generating ninja build configuration files based on user input YAML files

Install

This is a python command line app.
After the input you will have ninjag command available to you.

pip install ninjag

Dependency

• PyYAML

Background knowledge

• YAML format
• ninja manual

Usage

The first argument is the output file name,
The rest of the arguments are input files.

ninjag <output file> <input file 1> <input file 2> ...

The input configuration can span multiple yaml files,
but the combined content must have three required sections:

• const: a list of dictionaries of ninja constant definitions
• rules: a list of dictionaries of ninja rule definitions
• tasks: a list of dictionaries of ninja build tasks.
  • rule: which ninja rule to apply for this task
  • in: a list of input file names
  • out: a list of output file names
  • const: a dictionary of local constant definitions,
    which have higher priority than the global constants Notes:
• in and out are ninja built-in keywords.
  they must be written as the way they are.
• in and out can be either a string or a list of strings
• the rules and tasks sections from multiple inputs
  will be concatenated. Repeated const definitions will
  be retained (no overridden).
  The is an intentional design to avoid the confusion/bugs
  caused by mutations (overwriting).

Examples

input1.yaml

const:
- cflags: -Wall -Wconversion -Wextra
- extra_dir: /home/include
- I:
  - -I${extra_dir}

rules:
- cc: gcc $cflags $I $in -o $out

tasks:
- rule: cc
  in:
  - hello.c
  - main.c
  out: hello.exe
  const:
  - cflags: -Wall

Then type command:

ninjag build.ninja input1.yaml

The output is (build.ninja):

cflags = -Wall -Wconversion -Wextra
extra_dir = /home/include
I = -I${extra_dir}

rule cc
  command = gcc $cflags $in -o $out

build hello.exe: cc hello.c main.c
  cflags = -Wall

The const definition can have list as value:

const:
  W:
  - -Wall
  - -Werror
  - -Wconversion
  I:
  - -I/home/include1
  - -I/home/include2

The above will be translated to:

W = -Wall -Werror -Wconversion
I = -I/home/include1 -I/home/include2

License

MIT/X11 Steven(Yuhang) Wang (c) 2016