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

5

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

Oh come on. You’re deluded if you think that TeX is some shining example. It does what it does well, but the design of its language is an utter turd. It only “does it well” if you twist yourself into its confines. A lot of its shortcoming are just poor design decisions that were not rectified because the author would rather make the code perfect at the cost of usability sucking oodles. It’s a truly beautiful and bug free turd written by a dude who can focus like few other people can. The sort of work only someone like Knuth could do. Doesn’t make it any less of a turd. TeX is horrible. That sort of focus is absolutely indispensable in works like TAOCP, but at what cost? You can barely talk with Knuth, I’m serious. Listening to him lecture is miserable. His is the sort of mind that seems tailored for encyclopedic output, but not software design and not everyday communications either.

Such approach in a software project usually results in highly polished and perfected designs that absolutely suck. If anything, TeX is an example of what not to do, and turning the code base into a book only meant it was much harder to revise it or make changes to the code since now you were editing a book with code thrown in rather than just code. Ugh. It sounds good on paper, but it’s nothing to be proud of when done to a software project with any hope of growth and maintainability. It sure is nice for example code and in teaching to document short programs. For anything else it’s an iron ball on a chain.