README.md

SYNOPSIS

A minimalist debugging library inspired by this.

USAGE

INSTALL

This module is designed to work with the datcxx build tool. To add this module to your project us the following command...

build add heapwolf/debug

CODE

Construct an instance of Debug with a name. The instance will allow you to toggle the debug output for different parts of your program.

The DEBUG environment variable is used to enable these based on delimited names.

#include "./deps/heapwolf/debug/index.hxx"

Debug debug("demo");
Debug debug3("demo:beep");

void f3 () {
  Debug debug2("demo:boop");
  debug2("running function f3");
  debug3("running function f3");
}

void f2 () {
  debug("running function f2");
  f3();
}

int main () {
  debug("starting program");
  f2();
  debug("ending program");
  return 0;
}

OUTPUT

When actively developing an application it can be useful to see when the time spent between one debug() call and the next. Suppose for example you invoke debug(...) before requesting a resource, and after as well, the "+NNNms" will show you how much time was spent between calls.

TEST

build test

API

CONSTRUCTOR

Debug d(const std::string& name[, std::ostream& stream])

Construct with a name, optionally specify an output stream.