Easy Trace of Function Entry and All Exits

Introduction

Here is a small C++ struct which makes it easy and effortless to automatically display via the console the entry and exits of your functions. Note that it utilizes the helpful console colors of @Jaded-Hobo previously published Add Color to Console Projects.

struct cpreamble
{
    std::string m_func;
    cpreamble(const char* func) : m_func(func) 
    { std::cout << fg_yellow << func << fg_white << " entry" << std::endl; }
    ~cpreamble() { std::cout << fg_cyan << m_func << fg_white << " exit" << std::endl; }
};
#define PREAMBLE cpreamble _cpreamble(__func__);

So one can utilize it as below:

void foobar()
{
    PREAMBLE // first line in function
    // full body of function ...
}

Voila! The entry and all returns are automatically displayed to the console or wherever you wish if you modify cpreamble via the constructor and destructor of cpreamble. Of course, one can utilize __FUNCSIG__ instead of __func__ as the macro argument if one can tolerate the lengthy class type strings and overly informative function signatures which result. Such lengthy strings can of course be simplified but that is another project and tip. Please note the automatic formatting by Visual Studio of code which follows a macro which contains its own terminating semi-colon does not work as expected but in my own work, I insist on doing so. - Cheerio

History

• 26^th May, 2021: Initial version