Программирование. Принципы и практика использования C++ Исправленное издание - Бьёрн Страуструп

class="p1">case '%':

  { int i1 = narrow_cast<int>(left);

    int i2 = narrow_cast<int>(term());

    if (i2 == 0) error("%: деление на нуль");

    left = i1%i2;

    t = ts.get();

    break;

  }

Это очевидно короче и яснее, но не позволяет получать осмысленные сообщения об ошибках.

7.6. Приведение кода в порядок

 

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

7.6.1. Символические константы

Оглядываясь назад, вспомним, что с помощью символа '8' мы решили обозначать объекты класса Token, содержащие числовое значение. На самом деле совершенно не важно, какое именно число будет обозначать числовые лексемы, нужно лишь, чтобы оно отличалось от индикаторов других разновидностей лексем. Однако наш код пока выглядит довольно странно, и мы должны вставить в него несколько комментариев.

case '8':         // символ '8' обозначает число

  return t.value; // возвращаем число

case '–':

  return – primary();

 

 Честно говоря, здесь мы также сделали несколько ошибок, напечатав '0', а не '8', поскольку забыли, какое число выбрали для этой цели. Иначе говоря, использование символа '8' непосредственно в коде, предназначенном для обработки объектов класса Token, является непродуманным, трудным для запоминания и уязвимым для ошибок; символ '8' представляет собой так называемую “магическую константу”, о которой мы предупреждали в разделе 4.3.1. Теперь необходимо ввести символическое имя константы, которая будет представлять число.

const char number = '8'; // t.kind==number означает, что t — число

Модификатор const сообщает компилятору, что мы определили объект, который не будет изменяться: например, выражение number='0' должно вызвать сообщение об ошибке. При таком определении переменной number нам больше не нужно использовать символ '8' явным образом.

Фрагмент кода функции primary(), упомянутый выше, теперь принимает следующий вид:

case number:

  return t.value; // возвращает число

case '–':

  return – primary(); 

 

 Этот фрагмент не требует комментариев. Совершенно необязательно сообщать в комментариях, что очевидно в самом коде. Повторяющиеся комментарии, объясняющие нечто, часто свидетельствуют о том, что программа требует улучшения. Аналогично, код функции Token_stream::get(), распознающий числа, принимает такой вид:

case '.':

case '0': case '1': case '2': case '3': case '4':

case '5': case '6': case '7': case '8': case '9':

  { cin.putback(ch); // вернуть цифру в поток ввода

    double val;

    cin >> val;      // считать число с плавающей точкой

    return Token(number,val);

  }

Можно было бы придумать символические имена для всех лексем, но это излишне. Помимо всего прочего, символы '(' и '+' самоочевидны. Анализируя лексемы, легко понять, что лишь символы ';' для инструкции “печать” (или “конец выражения”) и 'q' для инструкции “выход” выбраны произвольным образом. А почему не 'p' или 'e'? В более крупной программе такая малопонятная и произвольная система обозначения рано или поздно вызвала бы проблемы, поэтому введем следующие переменные:

const char quit = 'q';  // t.kind==quit значит, что лексема t —

                        // код выхода

const char print = ';'; // t.kind==print значит, что лексема t —

                        // код печати

Теперь цикл в функции main() можно переписать так:

while (cin) {

  cout << "> ";

  Token t = ts.get();

  while (t.kind == print) t=ts.get();

  if (t.kind == quit) {

    keep_window_open();

    return 0;

  }

  ts.putback(t);

  cout << "= " << expression() << endl;

}

Введя символические имена для инструкции “печать” и “выход”, мы сделали код понятнее. Кроме того, теперь тот, кто будет читать текст функции main(), не будет гадать, как кодируются эти инструкции. Например, не удивительно, если мы решим изменить представление инструкции “выход” на символ 'e' (от слова “exit”). Для этого не требуется вносить изменения в функцию main(). Теперь в глаза бросаются строки "> " и "= ". Почему мы используем эти “магические” литералы в своей программе? Как новый программист, читающий текст функции main(), сможет догадаться об их предназначении? Может быть, стоит добавить комментарий? Это может оказаться удачной идеей, но использование символического имени более эффективно.

const string prompt = "> ";

const string result = "= "; // используется для указания на то, что

                            // далее следует результат

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

while (cin) {

  cout << prompt;

  Token t = ts.get();

  while (t.kind ==print) t=ts.get();

  if (t.kind == quit) {

    keep_window_open();

    return 0;

  }

  ts.putback(t);

  cout << result << expression() << endl;

}

7.6.2. Использование функций

Функции должны отражать структуру программы, и их имена должны обеспечивать логическое разделение кода на отдельные части. В этом отношении наша программа до сих пор не вызывала нареканий: функции expression(), term() и primary() непосредственно отражают наше понимание грамматики, а функция get() выполняет ввод и распознавание лексем. Тем не менее анализ функции main() показывает, что ее можно разделить на две логически разные части.

1. Функция main() описывает общую логическую структуру: начало программы, конец программы и обработку фатальных ошибок.

2. Функция main() выполняет цикл вычислений.

 

 Теоретически любая функция выполняет отдельное логическое действие (см. раздел 4.5.1). Если