#build #graph #makefile #dependencies #make #build-script #object-file

build depgraph

A library to manange files that depend on each other, and rebuild them as necessary, like a makefile

6 releases (3 breaking)

0.4.0 Sep 24, 2024
0.3.0 Aug 1, 2017
0.2.2 Jul 30, 2017
0.1.0 Mar 17, 2017

#159 in Build Utils

26 downloads per month

MIT/Apache

17KB
225 lines

depgraph

Makefile-style build of native stuff, for use in build.rs. Checks modified times on output and input files, and then runs operation if there are changes to input files.

Example

This example builds object files from assembly using yasm when the assembly files change.

extern crate depgraph;
use std::path::Path;
use std::{fs, env};
use std::process::Command;

fn build_assembly(out: &Path, deps: &[&Path]) -> Result<(), String> {
    // Make sure the folder we're going to output to exists.
    let out_dir = out.parent().unwrap();
    fs::create_dir_all(out_dir).unwrap();

    // Run the command with correct argument order
    Command::new("yasm").args(&["-f", "elf64", "-o"]).arg(out).args(deps)
        .status().unwrap();
    // Everything went ok so we return Ok(()). Instead of panicking, we could
    // have returned an error message and handled it in main.
    Ok(())
}

fn main() {
    // Get the directory we should put files in.
    let out_dir = env::var("OUT_DIR").unwrap();
    let out_dir = Path::new(&out_dir);
    // Create the graph builder
    let graph = depgraph::DepGraphBuilder::new()
    // Add a rule to build an object file from an asm file using the build
    // script in `build_assembly`.
      .add_rule(out_dir.join("out/path/file.o"),
                &[Path::new("src/input_file.asm")],
                build_assembly)
    // Build the graph, internally this checks for cyclic dependencies.
      .build().unwrap();
    // Run the necessary build scripts in the correct order.
    graph.make(depgraph::MakeParams::None).unwrap();
}

TODO

  1. Preserve dependency order
  2. Automated tests
  3. More generics (not sure if this would add anything)
  4. Optimizations (again not sure this would add anything)

Dependencies

~3MB
~47K SLoC