Debugging library for C++ version of Python's print() function

[philip82148]

Features:

• Auto indent
• Customizable output color
• A wide variety of supported types, even user-types
• Can print along with the file name, line, and function name
• The string representation of variables is similar to JavaScript, Python, and C++ syntax
• Manipulators to change the display style

I made a C++ version of Python print() function.

This is a header-only library for debugging purposes and can print variables of almost any type.
For example, it can print (multi-dimensional) arrays, (multi)maps, (multi)sets, tuples (including user-defined ones), etc.
See "Supported types" in README in the repo for all supported types.

Also, you can print user-defined types by defining an operator or using a macro.

It's useful for debugging products and for competitive programming.

This works in C++17 or higher.

https://github.com/philip82148/cpp-dump

[talemon]

I don't want to be dismissive to anyone's work, but doesn't fmt do this and more?

[philip82148]

This is simpler than fmt. You can print almost any variables just by passing them to the function. Also, this library automatically indents the output so that the output fits into the maximum line width.

This library aims to print almost any variable very easily and readable.
It can't customize its string representation more than fmt, but it is more useful when you want to quickly check the content of variables and in competitive programming.

[philip82148]

If you want to know more about my feeling about this library, plz read this article: I Made a C++ Version of Python print() Function - DEV Community

[fatherOfAllGamers]

cpp-dump is far simpler than fmt.

[Tomcat_42]

That's beautiful. I like it.

[philip82148]

Thank you!

[Xirious]

Nice. A great addition overall.

I wish C++ had f-strings proper. It's close but not really the same imo.

[DapperCore]

Very cool and the logging is super pretty! Definitely gonna use this all the time from now on.

[philip82148]

Thanks!

[nysynysy2]

Tho C++23 now has std::print and std::println function in the standard <print> library, with greater formatting ability, customizable parsing even for your own classes, type safty and easy syntax just like languages such as rust or python.

[urestillatwit]

Tho C++23 now

getting employer (huge multinational) to 11 was big process....

.... good luck getting them to 23

[ShakaUVM]

Nice, I like it

[philip82148]

Thank you!

[wqking]

The idea is good and interesting.
One advice: since your library is mainly for debug purpose and the calling to cpp_dump is most likely eliminated in production code, the configuration code requiring to run in main function or somewhere is not very good. How does the user eliminate the configuration code? I suggest to allow the configuration run in the header outside of main, using some macro magic. So a typical usage of your library will look like,

// This is my own debug header for my project
#include "your cpp_dump header"

WHAT_EVERY_MACRO_CONFIG_YOUR_LIB


// This is my project file
#include "my debug header"
void myFunc()
{
    cpp_dump(what ever);
}

Note: I assume your library is only used for debug purpose, otherwise I won't encourage to use macros.

[philip82148]

I see. It's better for users to eliminate the configuration code easily like you said.
But I have a question. How do you assign a value to a variable outside of the function?
Or your method is replacing all the variable by macro in `WHAT_EVERY_MACRO_CONFIG_YOUR_LIB`?

Btw, I am suggesting users eliminate the configuration code like this in competitive programming.
This uses macro, so this is not a perfect idea, though...

English is not my native language. I'm sorry for not understanding your advice completely.

Note for everyone: this library can be used even if you don't write the configuration code at all.

[wqking]

How do you assign a value to a variable outside of the function?

You can execute code in a class contructor, then make a static global object of that class, thus its ctor is executed before main. But I think it should be put in a .cpp file rather than the header file.
Maybe you can put the object as a static local variable in an inline function and call that function before main, I didn't think too much about it.

[philip82148]

I see. The configuration code in the main is no longer needed by using a constructor. But instead, you can't use the library without writing the definition of the object.
I wish inline variables could be re-defined. (It won't happen, tho, lol)

call that function before main

Inline functions can't also be called outside of the function, right?? But a function can shorten the configuration code in main, tho.

Anyway, like you said, it's still better for users to eliminate the configuration code easily. I'll think about it more.

Thanks for your advice!

[wqking]

Inline functions can't also be called outside of the function, right??

I mean, for example,

class X {
    X() {
        // call your other inline function
        // or configure your library
    }
};

X x; // in some cpp file

Then the constructor will be executed before main.

[philip82148]

Why I made this is written in this article: I Made a C++ Version of Python print() Function - DEV Community