https://github.com/heapwolf/debug

A small debugging library for C++
https://github.com/heapwolf/debug

cxx cxx2a debug debugging logging

Last synced: 5 days ago
JSON representation

A small debugging library for C++

• Host: GitHub
• URL: https://github.com/heapwolf/debug
• Owner: heapwolf
• Created: 2014-08-26T18:12:47.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2019-07-05T21:56:07.000Z (over 5 years ago)
• Last Synced: 2024-11-01T18:37:33.809Z (12 days ago)
• Topics: cxx, cxx2a, debug, debugging, logging
• Language: C++
• Homepage:
• Size: 44.9 KB
• Stars: 31
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SYNOPSIS

A minimalist debugging library inspired by [this][0].

# USAGE

#### INSTALL

This module is designed to work with the [`datcxx`][0] build tool. To add this

module to your project us the following command...

```bash

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.

```c++

#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.

![example](/docs/screenshot.png)

# TEST

```bash

build test

```

# API

## CONSTRUCTOR

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

Construct with a name, optionally specify an output stream.

[0]:https://github.com/visionmedia/debug