Macros and Conditionals/ru

│ English (en) │ français (fr) │ русский (ru) │

Обзор

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

Build macros (Макросы сборки) - это макросы, специфичные для проекта/пакета. Они не передаются компилятору. Ярким примером является LCLWidgetType, который определяется пакетом LCL и позволяет выбирать набор виджетов (carbon, gtk, qt, win32, wince, ...).

Conditionals (Условные определения) - это правила, позволяющие задавать макросы в зависимости от целевой платформы и/или других макросов. Например, вы можете использовать их для определения специальных параметров компоновщика при компиляции для Mac OS X. Они используют язык сценариев типа паскаль, позволяющий определять даже сложные правила.

Вы можете задать макросы сборки через Project / Project Options / Compiler Options / Additions and Overrides.

Вы можете задать условные определения через Project / Project Options / Compiler Options / Other / Conditionals (прим.перев.: в версиях Лазаруса 2.0.х и выше опция находится здесь Project / Project Options / Compiler Options / Custom Options).

Макросы сборки и условные определения существуют с Lazarus 0.9.29.

Условные определения

В условных определениях используется простой язык сценариев.

Изменение параметров компилятора с помощью условных определений

Сценарий условных определений может задавать некоторые переменные, значения которых используются IDE для параметров компилятора:

• UnitPath: добавляется к Other Source Files (-Fu). Символы / и \ автоматически преобразуются в разделитель текущего пути. После добавления пути поиска с точкой с запятой макросы заменяются, а относительные пути расширяются каталогом пакета/проекта.
• IncPath: добавляется к Include Files (-Fi).
• LibraryPath: добавляется к Libraries (-Fl).
• SrcPath: добавляется к Other sources (не используются компилятором, только IDE).
• DebugPath: добавляется к Debugger path addition (не используется ни компилятором, ни инструментами кода, используется только отладчиком).
• LinkerOptions: добавляется к параметрам компоновщика (-k). Разделители путей не меняются. Относительные пути не расширяются. Макросы заменяются.
• CustomOptions: добавляется к параметрам компилятора. Разделители путей не меняются. Относительные пути не расширяются. Макросы заменяются.
• OutputDir: если задано, он заменит текущий каталог вывода. Разделители путей не меняются. Относительные пути не расширяются. Макросы заменяются.

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

• UsageUnitPath: добавляется к используемым путям Unit (-Fu). Символы / и \ автоматически конвертиуются в текущий разделитель путей. После добавления пути поиска с точкой с запятой макросы заменяются, а относительные пути расширяются каталогом пакета/проекта.
• UsageIncPath: добавляется к используемым путям Include (-Fi).
• UsageLibraryPath: добавляется к используемым путям Library (-Fl).
• UsageSrcPath: добавляется к используемым путям Source (не используются компилятором, только IDE).
• UsageDebugPath: добавляется к используемым путям Debugger (не используется ни компилятором, ни инструментами кода, используется только отладчиком).
• UsageLinkerOptions: добавляется к используемым параметрам компоновщика (-k). Разделители путей не меняются. Относительные пути не расширяются. Макросы заменяются.
• UsageCustomOptions: добавляется к используемым параметрам компилятора. Разделители путей не меняются. Относительные пути не расширяются.

Синтаксис условных определений

Поддерживаемые синтактические конструкции

• If <условие> then <выражение>;
• If <условие> then <выражение> else <выражение>;
• begin <выражение>; ... <выражение>; end;
• <Переменная>:=<условие>;
• <Переменная>+=<условие>;
• <Комментарий> //, { }, (* *)
• Пробелы, табуляции и переводы строк то же самое. Как и в Паскале, они нужны только для разделения двух идентификаторов/ключевых слов.

Переменные

Переменные задаются просто путем присвоения значения. Есть несколько предопределенных переменных. См. список ниже.

Переменные могут быть определены или не определены:

if defined(Name) then ...
if undefined(Name) then ...
undefine(Name);

Если переменная задана, она имеет один из трех типов:

• none
• string
• number (int64)

Переменная является false, если она имеет номер 0 или строку '0'. В противном случае это true. Это означает, что переменная без значения истинна и неопределенная переменная также истинна.

Вы можете изменить тип переменной с помощью:

a := '1';        // строка
a := integer(a); // преобразование в число с помощью StrToInt(), в случае неудачи 'a' остается строкой
a := int64(a);   // преобразование в число с помощью StrToInt6(), в случае неудачи 'a' остается строкой
a := string(a);  // преобразование в строку

Константы

a := 1234; // десятичная
a := $A1B; // шестнадцатеричная
a := &127; // восьмеричная
a := %101; // двоичная
a := '10'; // строковая
a := #123; // символьная

Операторы

• +: Два числа складываются, иначе они рассматриваются как строки и объединяются.
• <, >, <=, >=, =, <>: Два числа сравниваются математически, в противном случае они рассматриваются как строки и сравниваются лексикографически (с учетом регистра).
• not: Унарный (с изменением знака) логический оператор
• and, or, xor: Логические операторы
• (,): Групповые операторы
• :=: Присвоение. Не допускается в выражениях.
• +=: Добавление и назначение. Не допускается в выражениях.

Уровни приоритета:

• 1 Not и унарный минус
• 1 And
• 2 Or
• 2 XOr
• 2 +
• 4 =
• 4 <>
• 4 <
• 4 <=
• 4 >
• 4 >=

Предопределенные переменные

Перед запуском условного сценария среда IDE инициализирует несколько переменных:

• TargetOS: целевая операционная система проекта, определенная fpc. например 'linux', 'win32', 'darwin', 'freebsd', 'wince'.
• TargetCPU: целевой процессор проекта, определенный fpc. например 'i386', 'x86_64', 'arm'
• SrcOS: значение 'win' для всех платформ MS Windows и 'unix' для всех unix-подобных платформ. Значение зависит от TargetOS.
• SrcOS2: значение 'bsd' для всех платформ, подобных BSD. Значение зависит от TargetOS.
• True: значение 1
• False: значение 0
• все макросы сборки, определенные в текущем проекте.
• все макросы сборки, определенные используемыми пакетами. Это означает, что если в проекте не определено значение для макроса пакета, будет использоваться значение условных операторов используемого пакета.

Предопределенные функции

• Defined(Variable): возвращает 1 (истина), если переменная определена, иначе 0 (ложь). Пример, if Defined(Macro1) then ;
• Undefine(Variable): отменяет определение переменной. Пример: Undefine(A);
• Int64(expression): возвращает значение выражения int64. Пример: i:=int64('3');
• Integer(expression): возвращает целочисленное значение выражения. Пример: i:=integer('3');
• String(expression): возвращает строковое значение выражения. Пример: s:=string(3);
• GetIDEValue(string): См. IDE macros
  • GetIDEValue('OS'): возвращает ОС, с которой была скомпилирована IDE (начиная с 1.0).
  • GetIDEValue('CPU'): возвращает процессор, с которым была скомпилирована IDE (начиная с 1.0).
  • GetIDEValue('SrcOS'): SrcOS IDE (начиная с 1.0).
  • GetIDEValue('SrcOS2'): SrcOS2 IDE (начиная с 1.0).
  • GetIDEValue('LCLWidgeType'): платформа LCL среды IDE, которая может отличаться от проекта. lazbuild возвращает win32, carbon или gtk2 в зависимости от ОС (начиная с 1.0).
• GetEnv(string): возвращает переменную среды. Например, GetEnv('HOME') возвращает в Linux домашний каталог пользователя (начиная с 1.0).
• GetProjValue(string): возвращает значение проекта.
  • GetProjValue('FPC_FULLVERSION'): возвращает FPC_FULLVERSION, полученный из компилятора проекта. Версия является целым числом, например 20701 (начиная с 1.3).

Порядок вычисления макроса

1. берутся значения текущего проекта
2. если в проекте не определены значения для TargetOS, TargetCPU, IDE устанавливает значения по умолчанию
3. SrcOS и SrcOS2 вычисляются из TargetOS
4. вычисляются условные выражения используемых пакетов. Если пакет A использует пакет B, то условные выражения B вычисляются перед условными операторами A.
5. Каждый условный сценарий начинается со значений проекта.
   • Если проект не определяет значение для макроса пакета, используется результат используемого пакета.
   • Сценарий может изменять любой макрос во время выполнения, но используются только макросы сборки и встроенные макросы. Например, вы можете установить для TargetOS другое значение, но это не повлияет ни на какой другой сценарий, ни на какой путь поиска с использованием $(TargetOS), даже на путь поиска самого пакета.
   • Если два пакета определяют один и тот же макрос сборки, то оба могут изменять значение (если только проект не устанавливает значение). Точный эффект зависит от порядка зависимости.
6. Макросы IDE по умолчанию используются последними.

Примеры

Добавление флага компилятора для цели Linux

if TargetOS = 'linux' then 
  CustomOptions := '-dUseCThreads';

Примечание:

• TargetOS - это предопределенный макрос IDE.
• CustomOptions - это результирующая переменная, используемая IDE.
• Идентификаторы нечувствительны к регистру, а оператор =(равно) - нет. Макрос TargetOS использует тот же регистр, что и компилятор, но в настоящее время все в нижнем регистре.
• IDE автоматически добавляет первое пространство при добавлении пользовательских параметров.
• При использовании в пакете вышеуказанное будет применяться только к параметрам, используемым для компиляции пакета, но не к проекту, использующему пакет.

Добавление некоторых параметров компоновщика для цели Mac OS X

Компилятор использует для Mac OS X значение 'darwin' для TargetOS.

if TargetOS = 'darwin' then begin
  LinkerOptions += ' -framework Cocoa';
  if TargetCPU = 'i386' then 
    LinkerOptions += ' -framework OpenGL';
end;

Примечание:

• TargetOS и TargetCPU - это предопределенные в среде IDE макросы.
• Оператор += добавляет строку или число.
• При добавлении нескольких опций вы должны добавить пробел между опциями.
• IDE автоматически добавляет первое пространство при добавлении параметров компоновщика.
• Вы можете вложить begin..end точно так же, как в Паскаль.
• Если выполняются оба условия, LinkerOptions будет содержать значение ' -framework Cocoa -framework OpenGL'.
• Среда IDE автоматически добавляет параметр -k при передаче параметров компоновщика компилятору.
• Вышеуказанное работает только для условных выражений проекта.

Добавление некоторых параметров компоновщика для Mac OS X для всех проектов с использованием пакета

Пакеты имеют два разных набора опций. Набор, используемый для компиляции самого пакета, и параметры, добавленные ко всем проектам/пакетам, использующим пакет. Вам необходимо изменить параметр usage пакета:

if TargetOS = 'darwin' then begin
  UsageLinkerOptions += ' -framework Cocoa';
  if TargetCPU = 'i386' then 
    UsageLinkerOptions += ' -framework OpenGL';
end;

Добавление опции в пакет

Если ваш пакет предоставляет некоторые дополнительные части, например возможность использовать opengl, вы можете определить макрос сборки. Далее объясняется, как это настроить шаг за шагом:

Допустим, ваш пакет называется Pkg1 и позволяет включить поддержку opengl, скомпилировав его с флагом -dEnableOpenGL. В пакете должен быть логический параметр Pkg1_UseOpenGL со значениями 'True' и 'False'.

Откройте редактор пакетов 'pkg1', нажмите compiler options (Параметры компилятора), выберите страницу IDE Macros (Макросы IDE).

Нажмите кнопку слева +, чтобы добавить новый макрос. Он будет называться 'Pkg1_Macro1'. Щелкните узел дерева, чтобы переименовать его в 'Pkg1_UseOpenGL'.

Нажмите среднюю кнопку +, чтобы добавить новое значение макроса. Он будет называться 'Value1'. Щелкните узел дерева, чтобы переименовать его в 'True'. Повторите это для значения 'False'.

Добавьте следующий код в текстовое поле Conditionals (Compiler Options / Other / Conditionals):

if Pkg1_UseOpenGL = 'True' then 
  CustomOptions := '-dEnableOpenGL';

Примечание:

• Значение 'True' чувствительно к регистру. Поскольку значение обычно выбирается из поля со списком, вероятность опечаток отсутствует.
• Если пользователь не установил никакого значения для макроса, переменная 'Pkg1_UseOpenGL' не определена, а результат выражения - 'false'.

Добавление режима release/debug

Режим release/debug для вашего проекта и всех ваших пакетов

Примечание: для этого требуется Lazarus 0.9.31 или выше.

В параметрах компилятора проекта (Project / Project Options / Compiler Options / Build modes) добавьте режим сборки Release. Добавление этого режима сборки автоматически активирует его, поэтому все изменения параметров компилятора теперь выполняются только в этом режиме сборки.

В "Set Macro Values" (Установить значения макроса) щелкните левый столбец в последней строке "(none)". Установите его в "MyPackageOptions". Примечание: его нет в поле со списком.

Установите его значение в опции. Например, "-O3".

Этот макрос можно использовать в параметрах компилятора проекта и во всех пакетах.

Для каждого пакета выполните: Откройте параметры компилятора пакета, перейдите на страницу Other. Добавьте в Custom options текст $(MyPackageOptions).

Специальный режим release/debug для одного пакета

Допустим, нормальный режим - это режим debug, и вам нужен другой режим для release.

Откройте редактор пакетов 'pkg1', нажмите compiler options, выберите страницу Build Macros.

В разделе Build macros нажмите кнопку слева +, чтобы добавить новый макрос. Он будет называться 'Pkg1_Macro1'. Щелкните узел дерева, чтобы переименовать его в 'Pkg1_Release'.

Нажмите среднюю кнопку +, чтобы добавить новое значение макроса. Он будет называться 'Value1'. Щелкните узел дерева, чтобы переименовать его в 'True'. Повторите это для значения 'False'.

Добавьте следующий код в текстовое поле Conditionals:

if Pkg1_Release = 'True' then 
  // режим release
  CustomOptions := '-O3'
else
  // режим debug
  CustomOptions := '-Sa Ctroi';

Примечание:

• Значение 'True' чувствительно к регистру. Поскольку значение обычно выбирается из поля со списком, вероятность опечаток отсутствует.
• Если пользователь не установил никакого значения для макроса, переменная 'Pkg1_Release' не определена, а результат выражения - false.

Добавление макроса для путей поиска для работы с разными платформами

Допустим, ваш пакет называется Pkg1 и использует Windows GDI в MS Windows и X11 в Linux и BSD. Независимые от платформы модули находятся в основном каталоге пакета, и вы создали два подкаталога 'gdi' и 'x11', содержащие зависящие от платформы модули:

/path/of/your/package/pkg1/
  pkg1.lpk
  pkg1.pas
  generalunit.pas
  gdi/
    backend.pas
  x11/
    backend.pas

Модуль backend в gdi следует использовать в Win32, Win64 и WinCE, а в Linux и FreeBSD следует использовать модуль backend в x11. Это означает, что путь поиска Other unit files (-Fu) (Другие файлы модулей (-Fu)) должен быть адаптирован в зависимости от целевой ОС. Ниже описывается, как настроить это шаг за шагом:

Откройте редактор пакетов 'pkg1', щелкните параметры компилятора, выберите страницу Build Macros (Сборка макросов).

Нажмите кнопку слева +, чтобы добавить новый макрос. Он будет называться 'Pkg1_Macro1'. Щелкните узел дерева, чтобы переименовать его в 'Pkg1_Backend'.

Нажмите среднюю кнопку +, чтобы добавить новое значение макроса. Он будет называться 'Value1'. Щелкните узел дерева, чтобы переименовать его в 'gdi'. Повторите это для значения 'x11'.

Добавьте следующий код в текстовое поле Conditionals:

// выбираем значение для Pkg1_Backend в зависимости от TargetOS
if undefined(Pkg1_Backend) then begin
  if SrcOS='win' then
    Pkg1_Backend:='gdi'
  else
    Pkg1_Backend:='x11';
end;

Макрос $(Pkg1_Backend) станет доступным после нажатия кнопки ОК. Итак, нажмите 'Ok', чтобы закрыть параметры компилятора, и откройте его снова, чтобы использовать его в пути поиска Other unit files (-Fu) (Другие файлы модулей (-Fu)).

Примечание:

• Пользователь может изменить значение Pkg1_Backend. Поэтому рекомендуется заключить настройку в if undefined(Pkg1_Backend).
• Вместо макроса SrcOS вы можете использовать if (TargetOS='win32') or (TargetOS='win64') or (TargetOS='wince') then ...