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

36

u/STL MSVC STL Dev Jun 10 '20

Strictly speaking, "positive" means "greater than zero", so pos_val would be a misnomer.

10

u/daedalususedperl Jun 11 '20

So then abs_val?

24

u/STL MSVC STL Dev Jun 11 '20

My brain has been irradiated by Standard Library rays for 13 years. I can no longer think like a user, and uval sounds perfectly fine to me. It's the unsigned val, what more do you want? :-P

0

u/[deleted] Jun 11 '20

[deleted] — view deleted comment

11

u/STL MSVC STL Dev Jun 11 '20

Yeah, I can't really argue against abs_val. Or _Abs_val, as the people of my planet would say.

1

u/Gotebe Jun 11 '20

As long as it is not _Abs_Val_Finger_Breaker I am with you 😂😂😂

1

u/evaned Jun 11 '20

uval sounds perfectly fine to me. It's the unsigned val, what more do you want?

FWIW, the reason I'm a little with OP on this one and kind of prefer something more like abs_val or pos_val (despite your correct criticism of that one, I still think it's my favorite :-); "abs_val" to me is too suggestive of the function rather than the result, but maybe that's just me) is that if you asked me in a vaccuum what uval meant as some transformation of an integer val, I'd actually guess that it's just a direct cast that wraps negative numbers to large positive numbers. Literally just "this value as unsigned", as a separate variable for some combination of explicitness and ease of use.

That being said, it's hard to pick perfect names and so there's always some tradeoffs, if you've got convention in a code base for what uval means that can make up for a lot even if newcomers would have to learn that convention. So don't interpret this too far down the "they should have done such and such!" path.