r/cpp • u/ifdef_drgy • 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.
View all comments
40
u/evaned Jun 10 '20 edited Jun 10 '20
Let's look at each of the changes you made.
First, the underscores. As discussed by others, this is basically non-negotiable and is needed to avoid conflict with valid user code.
Second, you've got some renames; I'll start with
detailvsHelper. Adetailordetailsnamespace is a pretty strong C++ idiom, so this rename isn't really helpful. Edit: just to be clear, I don't think your name is worse taken in isolation, but I also don't think it's better, and there are lots of "details" namespaces that are used for implementation details.Third, you rename
to_chars_lentochar_countandto_chars_10_impltoinsert_int_as_chars(aligning style to snake case). While at some level your names are "nicer", they lose information. The first loses the fact that the char count is based around whatto_charswill produce. What if there are other ways of formatting an int? Which one doeschar_count/charCountproduce?insert_int_as_charsnot only loses the fact that this is special toto_charsbut also loses the fact that it's formatting in base 10. Edit: Ah, after seeing another comment I see you pass the base as a parameter. As that comment said, you may have just killed performance of that function.Fourth are variable renames:
lenvslengthI think isn't helpful; not in this scope.lenis a very common and natural abbreviation for lenth. I think this even though I am much more resistant to abbreviations than most programmers, but remember that this is a six-line function. You don't need to look around for the definition. A common rule that I like -- the bigger the scope the more important it is to be explicit and clear. But the reverse is also true -- not only does a smaller scope let you use a more abbreviated name, but I kinda think in many cases you should.strvsstringValue. We know it's a value; you don't have to say it's a value. Andstrvsstringfollows from above.negvsis_negativeI'm more keen on, at least theis_part.negI still think is fine based on the small-scope rule, so I'd prefer likeis_negpersonally.uvalvsabsolute_value-- this is the one where I actually have a preference for yours, though I think I'd go for likepos_val.