Как понять вызов функци внутри другой функции с разным количеством параметров?

Question

[ReD]

Разбирая пример юнит-теста встретился такой участок кода:

void Assert(bool b, const string& hint) {
 AssertEqual(b, true, hint); 
}

Но автор не объяснил должным образом как он работает,
а меня он приводит в замешательство. В функцию передаются два параметра, а внутри самой функции вызывается другая, но с тремя параметрами. Не совсем ясно как-то...

Сама AssertEqual реализуется через шаблон:

void AssertEqual (class T& t, const U& u, const string& hint) { if (t != u) {
ostringstream os;
os << "Assertion failed: " << t << "!=" << u << "Hint: " << hint; throw runtime_error(os);
 } }

Comments

[Денис Загаевский]

Функции можно вызывать друг из друга, что в этом непонятного?

[Евгений Шатунов]

ReD , а что конкретно тебе тут непонятно?
В целом, продемонстрированный тобой код является высоким образчиком невежества и крайней небрежности в исполнении кода. В буквальном смысле, без запуска и трассировки по этому коду ничего сказать нельзя. Такой код принято полностью стирать и восстанавливать его логику максимально понятным способом.
В чем конкретно заключается образцовая небрежность. В этих вот T, u, в самом AssertEqual - ничего не отражающих именах. В изломанной структуре кода, в кривом выравнивании блоков. Только hint отражает свою суть, однако ничего не означает в контексте конструкции утверждений.
Поэтому, в какой-то степени я могу догадаться, что конкретно тебе непонятно. Но будет лучше чтобы ты сам все описал как можно подробнее.

[ReD]

Меня сбивает с толку, что в функцию передаются только два параметра, а вот внутри самой этой функции вызывается другая, но уже с тремя параметрами.

[Александр Ананьев]

ReD, изучи, что такое функции и как с ними работать. У тебя явно пробел в знаниях.

[Евгений Шатунов]

ReD, так это нормально. Функции на то и существуют, чтобы конкретизировать аргументы вызова других функций. Тут true вставлена как магическое значение. В другом месте новый параметр будет вычислен. Где-то еще значение будет прочитано из сетевого сокета или файла.

[Денис Загаевский]

Евгений Шатунов, да вроде вполне понятный код, а как бы вы его переписали? У этих T и U нет никакой семантики, как их ещё назвать-то?

[Евгений Шатунов]

Денис Загаевский, в предложении каждое слово стоит на своем месте, раскрывая мысль предложения.

Тебе ведь понятно что написано в первой строчке? Давай честно и без подколов.
Когда ты читаешь код, будет хорошо если ты точно также в коде увидишь раскрытие мысли этого кода.
С другой стороны, если ты не можешь внятно выразить свою мысль - выбрось ее из головы. Если ты не можешь внятно объяснить мысль своего кода - выбрось его.

Какую там мысль хотел выразить создатель этого кода? К слову сказать, у автора вопроса объявление AssertEqueal является неполным. Это шаблон функции, но описания шаблонных параметров нет.
Автор хотел взять два экземпляра заведомо разных типов, сравнить их через ADL-доступный оператор эквивалентности, а на основании результата сравнения или выполнить тело функции, или отказаться от его выполнения.
Эта функция напоминает бинарную логическую операцию, для которой характерно наличие левого и правого аргументов. Более того, условность выполнения тела функции явно говорит о том, что один из операндов является константным, т.е. эталоном. То есть, это функция проверки соответствия эталону.
На уроках математики в школе всех нас приучили к тому что слева нужно писать неизвестную, а справа - константу. ax^2 + bx + c = 0. Решаем, пишем: x = 42. И так далее.
Логические операции интуитивно понятнее, когда левый операнд является переменной, а правый - константой.
Assert - переводится как "Утверждать". Утверждать что-то. Значит, где-то должно быть утверждение. Но у AssertEqueal этого утверждения нет. Более того, имя функции переводится как "Утверждать равным". Чему равным?

Эта функция ничего не утверждает. Она, согласно своей мысли, ожидает эквивалентности двух значений чтобы выполнить свое тело. А в теле функции должна быть остановка процесса.
Функцию стоит назвать TerminateOnDifferent - выпилиться по разнице значений.
Левый операнд - это Condition, условие. Правый - это Reference, норма/эталон.
В имени глобальной функции слово Terminate однозначно читается в контексте процесса. Прозрачно и то, что по наступлении эквивалентности выхода из этой функции не будет. Следовательно, все, что можно еще сделать, это передать семантику терминации в виде причины. Третий параметр - это Reason. Вот так, без всяких лишних hint и Msg, т.к. аргумент самодокументируется своим типом.

В результате выглядеть должно вот так:

template< typename TCondition, typename TReference >
void TerminateOnDifferent( TCondition&& condition, TReference&& reference, const std::string_view reason )
{
    if( condition == reference )
    {
        return;
    }
    
    std::cout << "Termination happened due to reason: " << reason << "." << std::endl;
    std::terminate();
}

[Денис Загаевский]

Евгений Шатунов, это всё круто, спасибо за развернутый коммент. Но Assert/AssertEquals вообще-то стандартные имена для таких функций. И в данном случае вообще не особо важно кто из них эталон, а кто - нет. Про константу ничего не понял, зачем там уравнение - тоже. Сравнение непонятное.
Не знаю плюсы и их станадартную либу, но кажется, что std::terminate() плюс-минус молча завершит процесс. Кто сказал, что ТС хочет этого? Может он ловит это исключение где-то выше? Нормальное поведение, когда хочешь прогнать набор тестов, и тебе не надо перезапускать процесс каждый раз.

[Евгений Шатунов]

Денис Загаевский, а ты это вот все к чему сейчас написал?

[Денис Загаевский]

Евгений Шатунов, к тому, что я всё ещё не согласен с утверждением

В целом, продемонстрированный тобой код является высоким образчиком невежества и крайней небрежности в исполнении кода. В буквальном смысле, без запуска и трассировки по этому коду ничего сказать нельзя. Такой код принято полностью стирать и восстанавливать его логику максимально понятным способом.

Ты приводишь какие-то аргументы, но в моем мире они выглядят странно и нелепо.

[Евгений Шатунов]

Денис Загаевский, а тебя о твоем мнении кто-нибудь спрашивал? :)
В моем мире твое непонимание выглядит "странно и нелепо". Тебе стоило бы сразу написать что ты не смог понять излагаемую мной систему. И это нормально что не смог. Такое с людьми иногда случается.
Стесняешься своих непонимашек? Не стоит. :)

[Денис Загаевский]

Евгений Шатунов, о_О' ЧСВ в штаны заправь, вываливается. Вы в С++ мире все такие странные?
BTW, о достоинствах и недостатках этого кода ТС тебя тоже не спрашивал, так что ж ты пишешь тогда?

[Евгений Шатунов]

Денис Загаевский, ну смотри. Ты открыто спросил о моем мнении и я его открыто высказал. Пройдись по моему ответу и найди, чисто для себя, в каком именно месте, в буквальном смысле, какими словами я спрашиваю твоего мнения.

Answer 1

[Victor Bomberow]

Короче говоря, первую функцию Assert нужно переименовать в AssertIsTrue, а параметр hint в errorMsg. Там должен быть текст, который будет в runtime_error объяснять, откуда взялось значение параметра b из функции Assert. Например, имя функции с аргументами или имя переменной.

Comments

[Денис Загаевский]

Зачем переименовывать? Обычный ассерт с булом, кажется очевидным, что он делает.

[Victor Bomberow]

Денис Загаевский, исхожу из следующего. Обычный ассерт = обычное утверждение. И это ничего не говорит об утверждаемом выражении.

Утверждать можно что угодно, допустим, успешный провал теста. Или ошибочный?
Ложно-положительный результат?

В выше указанном примере, true на false поменять и смысл выражения, которое утверждается меняется на противоположное.
Кроме как в имени функции, ограничение никак не реализовать, потому что ассерт ведёт себя как предикат.

Вообще, в данном случае, я бы даже Assert сделал бы namespac'ом, а сами нужные проверки уже функциями.

А в шаблонной функции неплохо бы проверить на is_same

А ещё лучше, использовать готовую библиотеку, где все уже продумано, конечно...

[Денис Загаевский]

Vito Ombero, омфг. Это обычная функция ассерт, она везде реализована плюс-минус одинаково.
https://www.php.net/manual/en/function.assert.php
https://docs.oracle.com/javase/8/docs/technotes/gu...
https://docs.microsoft.com/en-us/dotnet/api/system...
https://habr.com/ru/post/141080/

[Victor Bomberow]

Денис Загаевский, в разных областях разные конвенции именования. Если это фреймворк или библиотека, то пояснения к коду и именованию будут в документации.
Тут же явный самопал, а значит все должно быть сделано так, чтобы понять неправильно возможностей было минимум.

В стандарте C++ есть только один assert, и он никакого string не принимает.