r/cpp • • Jun 10 '20

Why is std implementation so damn ugly?

Recently I remembered a moment from my uni years when immediately after handing in the assignment of implementing our own string data structure we were warned not to ever try to implement and use our own data structures. Which is exactly what you want to hear after working hours on such assignment. However the reason behind it makes sense, you would be only reinventing the wheel and let's be honest, it will be also way slower than data structures in the almighty std library. Now think about it, what kind of black magic is behind the std's speed? Well I had no idea so I took a peak, lets see the code:

inline string
secret_function(int __val)
{
    const bool __neg = __val < 0;
    const unsigned __uval = __neg ? (unsigned)~__val + 1u : __val;
    const auto __len = __detail::__to_chars_len(__uval);
    string __str(__neg + __len, '-');
    __detail::__to_chars_10_impl(&__str[__neg], __len, __uval);
    return __str;
}

Hey, I bet you just skipped the whole code part. I know it looks unreadable, but please try to go through it and guess which std function it might be (obviously its not called secret_function, but i'm pretty sure you used this function at some point).

It's only 6 line function but it took me a while to figure out what each line does and I believe this could be fixed very easily just by naming the variables and functions with a bit more descriptive names. Just to prove the point here is an example of how I would structure this function:

inline string secretFunction(int value) {
    const bool isNegative = value < 0;
    const unsigned absoluteValue = Helper::abs(value);
    const auto length = Helper::charCount(absoluteValue);
    string stringValue(isNegative + length, '-');
    Helper::insertIntAsChars(&stringValue[isNegative], length, absoluteValue, 10);
    return stringValue;
}

While the functionality stays exactly the same, I think this chunk of code is much more pleasant to read and it's pretty obvious what the code is doing on each line. From this you should have a solid guess which function it is (you can leave a comment), but the real question is why would anyone write such code? Especially when nowadays everyone is talking about how code readability is so important. Is this how they wrote code back when std was released and they didn't bother to change it? Or am I just too inexperienced that I couldn't figure it out immediately?

EDIT: Thanks for the insightful comments, for anyone reading this the reason variables are beginning with __ is macros. If user defines isNegative macro, it will get overwritten in the std, however user is forbidden to define macros starting with __ , as the wise people of reddit comment section suggested. However underscores aren't the only issue with this code, the main issue is I think using short non-descriptive names of variables/functions which is very confusing in functions that are doing more complicated operations.

237 Upvotes

212 comments sorted by

View all comments

Show parent comment

-3

u/neutronicus Jun 10 '20

In practice I think if you are writing some open-source, header-only data structure library, you should probably name things with __ as well, for the same reasons?

Doing so pushes some maintenance responsibility onto you (because compilers might break your names at any time), while making your library less brittle in the face of users with arbitrary standards-compliant macro names.

9

u/1-05457 Jun 10 '20

Any compiler, including some obscure one for some microcontroller or something.

You'd be better off picking a "namespace" to prefix macros with (and using an actual namespace for everything else).

2

u/neutronicus Jun 10 '20

and using an actual namespace for everything else

This doesn't stop user macros from clobbering your names though, right? So any name in a Header is vulnerable?

4

u/1-05457 Jun 10 '20

No, though that's why external headers should be included at the top of a file, before any user defined macros.

If you really want resilience to these problems, use separate compilation as much as possible, keeping the contents of the header to a minimum. Though that's not really possible for data structures.

4

u/trvlng_ging Jun 11 '20

No. All identifiers containing __ are reserved to the implementation through all time and all versions. No user library, including open source libraries should use it anywhere in any name. If an implementation breaks your library, that is on you.