В работе препроцессора "условием" называется директива, при выполнении которой часть программы игнорируется во время компиляции после проверки некоторых условий. В С препроцессоре в условии могут использоваться как арифметические выражения, так и имена определенных макросов.
Условие в С препроцессоре в некоторых аспектах имеет сходство с конструкцией 'if' языка С, но важно понимать их отличия. Условие в конструкции 'if' проверяется при выполнении программы. Ее целью служит изменение хода программы в зависимости от обрабатываемых данных. Условие в препроцессоре проверяется при компиляции программы. Оно используется для включения в программу различных частей кода в зависимости от условий, установленных при ее компиляции.
Существует три основных причины для применения условий.
Для выполнения программы на различных платформах может потребоваться разный исходный код. В некоторых случаях, программа, написанная для одной операционной системы, будет некорректно работать в другой операционной системе. В подобных ситуациях недостаточно уклонения от выполнения ненужных процедур. Если программа их содержит, то часто случается, что невозможно скомпоновать и запустить программу. При использовании условной компиляции, неиспользуемый код может быть исключен из программы.
Иногда требуется скомпилировать один исходный файл в две разные программы. Случается, что различия в программах заключаются в том, что одна из них выполняет постоянную, занимающую много времени, обработку данных или выдает значения этих данных для отладки, в то время как другая не делает этого.
Применение условий, где проверка выдает заведомо ложный результат, используется для исключения кода из программы, который может являться одним из видов комментариев для ссылки на него в будующем.
В большинстве простых программ, предназначенных для выполнения только на одном компьютере, условия обычно не используются.
Условие в С препроцессоре начинается с директивы условия: '#if', '#ifdef' или '#ifndef'. Далее рассматривается только директива '#if'.
Простейшая форма использования директивы '#if' рассмотрена ниже.
#if EXPRESSION
CONTROLLED TEXT
#endif /* EXPRESSION */
Выражение EXPRESSION является С выражением типа integer, что представляет собой сильное ограничение. Оно может содержать:
Текст, находящийся внутри условной конструкции, может включать директивы препроцессора, которые обрабатываются при выполнении требуемых условий. Текст может также содержать и другие условные конструкции. Однако директивы '#if' и '#endif' должны образовывать единую конструкцию.
Директива '#else' может использоваться в условной конструкции для предоставления альтернативного кода программы втом случае, если условие ложно. Вот как это выглядит:
#if EXPRESSION
TEXT-IF-TRUE
#else /* Not EXPRESSION */
TEXT-IF-FALSE
#endif /* Not EXPRESSION */
Обычное применение однородных условий связано с проверкой более чем двух возможных вариантов. Например:
#if X == 1
...
#else /* X != 1 */
#if X == 2
...
#else /* X != 2 */
...
#endif /* X != 2 */
#endif /* X != 1 */
#if X == 1
...
#elif X == 2
...
#else /* X != 2 and X != 1*/
...
#endif /* X != 2 and X != 1*/
Текст, следующий за директивой '#elif' включается только в том случае, когда значение изходящей директивы '#if' - ложно, а условие '#elif' - верно. В одной конструкции '#if'-'#endif' может использоваться более чем одна директива '#elif'. Текст после директивы '#elif' включается только в том случае, когда условие '#elif' - верно и находится после условия '#if' или предшествующего '#elif', значения которых - ложь. '#else' является эквивалентом директивы '#elif 1', а '#else' может следовать после любого количества директив '#elif', в то время как '#elif' не может следовать за '#else'.
Если часть программы была перемещена или удалена, но есть необходимость в сохранении старого кода в качестве комментария для дальнейших ссылок к нему, то простейший способ реализации этого заключается в использовании конструкции '#if 0'-'#endif', внутри которой находится этот код. Это рациональнее применения обычных комментариев, так как это не всегда помогает, если этот код также содержит комментарии.
Такая конструкция в любом случае будет безошибочной, даже если заключенный в нее текст также содержит условия (полные конструкции '#if'- '#endif').
Однако не следует применять такую конструкцию, если комментируемый текст не является С кодом. Для этого используются обычные С комментарии. Директива '#if 0' должна состоять из правильных лексем.
Условия часто используются вместе с макросами или утверждениями, так как они являются единственными выражениями, чьи значения могут варьироваться при компиляции. Директива '#if', не использующая макросы или утверждения, является эквивалентом директиве '#if 1' или '#if 0'.
Например, рассмотрим условие, проверяющее выражение 'BUFSIZE == 1020', где 'BUFSIZE' является макросом.
#if BUFSIZE == 1020
printf ("Large buffers!\n");
#endif /* BUFSIZE is large */
В директиве '#if' применяется специальный оператор 'defined', используемый для проверки соответствия указанного имени существующему макросу. В любом случае, значением выражения 'defined NAME' или 'defined (NAME)' является 1, если в данном месте программы определен макрос с именем NAME, в противном случае значением выражения будет 0. Для оператора 'defined' имеет значение не определение макроса, а то что оно есть. Рассмотрим пример:
#if defined (vax) || defined (ns16000)
#if #cpu (vax) || #cpu (ns16000)
Условия, проверяющие определение одного имени довольно часто используются, поэтому для этой цели существует две дополнительные условные директивы.
что является эквивалентом '#if defined (NAME)'.
что является эквивалентом '#if ! defined (NAME)'.
Некоторые макросы являются заранее определенными, в зависимости от типа используемого компьютера. Например, на компьютерах Vax, имя 'vax' является заранее определенным макросом. На других компьютерах оно не определено.
Большое количество макросов определяется системными подключаемыми файлами. На различных системах и компьютерах определяются разные макросы с разными значениями. Очень часто полезно проверять эти макросы условными конструкциями во избежание использования аппаратных возможностей на компьютере, где они не реализованы.
Макросы являются простым способом настройки пользователями программы для различных систем или приложений. Например, макрос 'BUFSIZE' может быть определен в конфигурационном файле программы, который вкючается в качестве подключаемого файла в каждый исходный файл. Можно использовать макрос 'BUFSIZE' в условии препроцессора для генерации кода, зависящего от выбранной конфигурации.
Макросы могут определяться или уничтожаться с помощью опций препроцессора '-D' и '-U' при компиляции программы. Можно сделать так, что один и тот же исходный файл будет скомпилирован в две различные программы путем определения нужного макроса, использования условий для проверки значения этого макроса и передачи значения макроса через опции компилятора.
Утверждения обычно являются заранее определенными, но они также могут быть определены с помощью директив или опций препроцессора.
"Утверждения" являются более систематической альтернативой макросам при создании условий на проверку типа компьютера или системы, используемой при компиляции программы. Утверждения обычно определены заранее, хотя они могут быть также определены директивами препроцессора или с помощью опций.
Обычно макросы не классифицируются каким-либо образом по их определению. Они могут указывать на архитектуру модели компьютера, отдельную модель компьютера, на операционную систему, ее версию или на специфические возможности конфигурации. Все это может сочетаться в одном макросе. В отличие от макросов, утверждения состоят из четко поставленного вопроса и ответа на него. Вопрос обычно называется "утверждением". Утверждение выглядит следующим образом:
#PREDICATE (ANSWER)
Далее приведен пример условия, проверяющего является ли ответ ANSWER утверждением PREDICATE:
#if #PREDICATE (ANSWER)
#if #PREDICATE
#system (gnu)
#system (mach)
#system (mach 3)
#system (mach 3.SUBVERSION)
#system (hurd)
#system (hurd VERSION)
В системе Unix существует утверждение '#system (unix)', а возможно одно из следующих: `#system (aix)', `#system (bsd)', `#system (hpux)', `#system (lynx)', `#system (mach)', `#system (posix)', `#system (svr3)', `#system (svr4)', или `#system (xpg4)' вероятно с последующей информацией о версии системы.
Другие значения для 'system' это '#system (mvs)' и '#system (vms)'.
Многие Unix С компиляторы предоставляют только один ответ на утверждение 'system': '#system (unix)', если они вообще используют утверждения.
Утверждение, ответ которого сосотоит из нескольких слов сильно отличается от утверждений с ответом из одного слова. Например, утверждение 'system (mach 3.0)' не означает, что 'system (3.0)' - верно. Это также не всегда означает, что 'system (mach)' тоже верно, но в GNU C последнее утверждение может быть использовано.
В настоящий момент возможные значения утверждений для 'cpu' являются '#cpu (a29k)', `#cpu (alpha)', `#cpu (arm)', `#cpu (clipper)', `#cpu (convex)', `#cpu (elxsi)', `#cpu (tron)', `#cpu (h8300)', `#cpu (i370)', `#cpu (i386)', `#cpu (i860)', `#cpu (i960)', `#cpu (m68k)', `#cpu (m88k)', `#cpu (mips)', `#cpu (ns32k)', `#cpu (hppa)', `#cpu (pyr)', `#cpu (ibm032)', `#cpu (rs6000)', `#cpu (sh)', `#cpu (sparc)', `#cpu (spur)', `#cpu (tahoe)', `#cpu (vax)', `#cpu (we32000)'.
В С программе можно создавать свои утверждения с помощью директивы '#assert' следующим образом:
#assert PREDICATE (ANSWER)
При каждом выполнении этой директивы создается новый правильный ответ для PREDICATE. При утверждении одного ответа предыдущие значения остаются в силе. Единственный способ удалить утверждение - использовать директиву '#unassert'. Эта директива имеет такой же систаксис как и '#assert'. Можно удалить все утверждения для PREDICATE следующим образом:
#unassert PREDICATE
Директива '#error' вынуждает препроцессор сделать отчет о фатальной ошибке. Все что следует после '#error' используется для сообщения.
Директива '#error' в теле условия, проверяющего комбинацию параметров, не до конца поддерживаемых программой, используется для сообщения о возможной ошибке. Например, если известно, что программа не совсем корректно выполняется на системе Vax, то можно написать:
#ifdef __vax__
#error Won't work on Vaxen. See comments at get_last_object.
#endif
#if HASH_TABLE_SIZE % 2 == 0 || HASH_TABLE_SIZE % 3 == 0 \
|| HASH_TABLE_SIZE % 5 == 0
#error HASH_TABLE_SIZE should not be divisible by a small prime
#endif
Эту директиву можно использовать в устаревших подключаемых файлах с указанием на новую версию файла.