Klang C++ 0.7.15
Language Reference (draft)
Loading...
Searching...
No Matches
klang::Debug

The Klang debug interface. More...

#include <klang.h>

+ Inheritance diagram for klang::Debug:

Classes

struct  Buffer
 Audio buffer for debug output. More...
 

Public Member Functions

void print (const char *format,...)
 
void printOnce (const char *format,...)
 
bool hasText () const
 
int getText (char *buffer)
 
 operator const signal & () const
 
void input (const signal &value) override
 
void operator<< (const signal &value) override
 
void input () override
 
virtual const signal & input () const
 

Static Public Member Functions

template<typename Func , typename... Args>
static double profile (Func func, Args... args)
 
template<typename Func , typename... Args>
static double profile (int times, Func func, Args... args)
 
static signal & passthrough ()
 

Public Attributes

Console console
 Debug console output.
 
signal in
 

Static Public Attributes

static THREAD_LOCAL Buffer buffer
 

Detailed Description

Definition at line 4270 of file klang.h.

Member Function Documentation

◆ getText()

int klang::Debug::getText ( char * buffer)
inline

Definition at line 4473 of file klang.h.

4473 {
4474#if HAS_KLANG_DEBUG
4475 return console.getText(buffer);
4476#else
4477 if (buffer) buffer[0] = 0;
4478 return 0;
4479#endif
4480 }
int getText(char *buffer)
Definition klang.h:4250
Console console
Debug console output.
Definition klang.h:4364
static THREAD_LOCAL Buffer buffer
Definition klang.h:4361

◆ hasText()

bool klang::Debug::hasText ( ) const
inline

Definition at line 4465 of file klang.h.

4465 {
4466#if HAS_KLANG_DEBUG
4467 return console.hasText();
4468#else
4469 return false;
4470#endif
4471 }
bool hasText() const
Definition klang.h:4246

◆ input() [1/3]

void klang::Debug::input ( )
inlineoverridevirtual

Reimplemented from klang::Generic::Input< signal >.

Definition at line 4500 of file klang.h.

4500 {
4501#if HAS_KLANG_DEBUG
4502 buffer += in;
4503#else
4504
4505#endif
4506 }

◆ input() [2/3]

void klang::Debug::input ( const signal & value)
inlineoverridevirtual

Reimplemented from klang::Generic::Input< signal >.

Definition at line 4497 of file klang.h.

4497{ passthrough() = value; }
static signal & passthrough()
Definition klang.h:4493

◆ input() [3/3]

virtual const signal & klang::Generic::Input< signal >::input ( ) const
inlinevirtualinherited

Reimplemented in klang::Generic::Graph< SIZE >::Series.

Definition at line 2947 of file klang.h.

2947{ return in; }

◆ operator const signal &()

klang::Debug::operator const signal & ( ) const
inline

Definition at line 4482 of file klang.h.

4482 {
4483#if HAS_KLANG_DEBUG
4484 return buffer.operator const klang::signal & ();
4485#else
4486 return passthrough();
4487#endif
4488 }
A mono audio signal (equivalent to a float).
Definition klang.h:1123

◆ operator<<()

void klang::Debug::operator<< ( const signal & value)
inlineoverridevirtual

Reimplemented from klang::Generic::Input< signal >.

Definition at line 4498 of file klang.h.

4498{ passthrough() = value; }

◆ passthrough()

static signal & klang::Debug::passthrough ( )
inlinestatic

Definition at line 4493 of file klang.h.

4493 {
4494 static thread_local signal value = 0;
4495 return value;
4496 }
signals< 2 > signal
Stereo audio signal.
Definition klang.h:5840

◆ print()

void klang::Debug::print ( const char * format,
... )
inline

Definition at line 4431 of file klang.h.

4431 {
4432#if HAS_KLANG_DEBUG
4433 if (console.length < 10000) {
4434 THREAD_LOCAL static char string[1024] = { 0 };
4435 string[0] = 0;
4436 va_list args; // Initialize the variadic argument list
4437 va_start(args, format); // Start variadic argument processing
4438 vsnprintf(string, 1024, format, args); // Safely format the string into the buffer
4439 va_end(args); // Clean up the variadic argument list
4440 console += string;
4441 }
4442#else
4443
4444#endif
4445 }

◆ printOnce()

void klang::Debug::printOnce ( const char * format,
... )
inline

Definition at line 4447 of file klang.h.

4447 {
4448#if HAS_KLANG_DEBUG
4449 if (console.length < 1024) {
4450 THREAD_LOCAL static char string[1024] = { 0 };
4451 string[0] = 0;
4452 va_list args; // Initialize the variadic argument list
4453 va_start(args, format); // Start variadic argument processing
4454 vsnprintf(string, 1024, format, args); // Safely format the string into the buffer
4455 va_end(args); // Clean up the variadic argument list
4456
4457 if (console.last != string)
4458 console += string;
4459 }
4460#else
4461
4462#endif
4463 }
static THREAD_LOCAL Text< 16384 > last
Definition klang.h:4211

◆ profile() [1/2]

template<typename Func , typename... Args>
static double klang::Debug::profile ( Func func,
Args... args )
inlinestatic

Definition at line 4367 of file klang.h.

4367 {
4368#if HAS_KLANG_DEBUG
4369 using namespace std::chrono;
4370
4371 auto start = high_resolution_clock::now();
4372 func(args...);
4373 auto end = high_resolution_clock::now();
4374
4375 auto duration = duration_cast<nanoseconds>(end - start).count();
4376 return (double)duration;
4377#else
4378 return 0;
4379#endif
4380 }

◆ profile() [2/2]

template<typename Func , typename... Args>
static double klang::Debug::profile ( int times,
Func func,
Args... args )
inlinestatic

Definition at line 4383 of file klang.h.

4383 {
4384#if HAS_KLANG_DEBUG
4385 double sum = 0;
4386 while (times--) {
4387 sum += profile(func, args...);
4388 }
4389 return sum / 1000000.0;
4390#else
4391 return 0;
4392#endif
4393 }
static double profile(Func func, Args... args)
Definition klang.h:4367

Member Data Documentation

◆ buffer

THREAD_LOCAL Debug::Buffer klang::Debug::buffer
inlinestatic

◆ console

Console klang::Debug::console

Definition at line 4364 of file klang.h.

◆ in