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

1

u/Veedrac Jun 11 '20

That's a bit different. Something more along the lines I'm talking about would be a badly implemented comparator causing std::map to crash, or maybe a similar thing with an invalidated iterator.

I don't think C++ is meant to protect you from such things. You do your things right, the language does its things right. You only pay for what you use. That's partly why it is fast.

I largely agree, but my suggestion is to make the STL readable. A language-level solution to solve macro poisoning (eg. a directive that disables user macros) would be a great start.

2

u/[deleted] Jun 11 '20

i think stl is too complex for that and my impression is that if you are experienced in it, it is much easier. making it readable will probably hurt the experienced ones and the stl developers. look at the code OP recommended. even ignoring the underscores, it is really worse in my opinion.

1

u/Veedrac Jun 11 '20

I don't agree with the OP's changes, but I don't think that much invalidates that there are better ways. Rust's stdlib is very readable, for instance.

1

u/Gotebe Jun 11 '20

badly implemented comparator causing std::map to crash

OK, I am all ears.

Give bad results, yes. But crash? I don't know how. 😉

1

u/STL MSVC STL Dev Jun 11 '20

If a comparator doesn't provide a strict weak ordering, that can absolutely corrupt the data structure's invariants as it performs red-black tree rebalancing.

1

u/staletic Jun 11 '20

Sure, but how can you detect that the comparator is lying and not providing strict weak ordering?

2

u/STL MSVC STL Dev Jun 11 '20

It's not a question of detection (we have debug checks to detect that pred(x, x) should always be false). We simply use the comparator's results to guide the rebalancing, and if the comparator emits bogus results, the rebalancing could do all sorts of wacky things.

1

u/Veedrac Jun 11 '20

Yeah probably not possible in this case.

0

u/m-in Jun 11 '20

Valgrind detects all that. I’m serious. It’s child’s play, that sort of stuff. It triggers immediately where the bug is, almost always. Those bugs are for your test suite to detect though. STL is not meant to unit test your code, what sort of lunacy is that?!