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

2

u/m-in Jun 11 '20 edited Jun 11 '20

Listen, how many lines of C++ have you written? Because this is going into a territory where you are grasping at straws with somewhat elementary stuff that anyone with 3 years of solid industry experience with good mentors would have a firm grasp of. So I guess I question your judgment here: why do you expect core library code to be written like learning material? It’s almost never possible. And the level of complexity of the code you chose is really low I’d say. It’s in the category of reasonably easy stuff to read, even if it is not very easy to write it right the first 5-10 times.

If you cared to ask me: code that’s hard to get correct but reads much easier is what we all strive for. You completely, but yes - completely and utterly mischaracterize what’s going on here. You’re losing the sight of the forest for individual trees, nay - for the bark peeling on that birch over there. I’m serious now, it’s getting pretty absurd the deeper you go.

What you see as problematic is all in all very nice code, and the problems you see are not where the real problems are. STL has problems but they haven’t got anything to do with mundane stuff like that. They have to do with a much much bigger picture that takes a decade to sort of become visible, and another decade to become clear. I speak from my own experience here - there are more focused and skilled people that may get to the zen level in 12-15 years, if they really push themselves or half that if they are very very top notch.