Spec-Zone.ru › CMake 3.28

CSharpUtilities

Новые возможности версии 3.8.

Функции для упрощения конфигурации CSharp/.NET целей.

Коллекция функций утилиты CMake, полезных для работы с CSharp-целями для генераторов Visual Studio с версии 2010 и новее.

Данный модуль предоставляет следующие функции:

Основные функции

  • csharp_set_windows_forms_properties()
  • csharp_set_designer_cs_properties()
  • csharp_set_xaml_cs_properties()

Вспомогательные функции

  • csharp_get_filename_keys()
  • csharp_get_filename_key_base()
  • csharp_get_dependentupon_name()

Основные функции, предоставляемые модулем

csharp_set_windows_forms_properties

Устанавливает свойства исходных файлов для использования Windows Forms. Используйте эту функцию, если ваша CSharp-цель использует Windows Forms:

csharp_set_windows_forms_properties([<file1> [<file2> [...]]])
<fileN>

Список всех исходных файлов, которые имеют отношение к установке свойств VS_CSHARP_<tagname> (включая расширения .cs, .resx и .Designer.cs).

В списке всех заданных файлов ищется все файлы с расширениями .Designer.cs и .resx. Для каждого файла designer или resource ищется файл с тем же базовым именем, но только расширением .cs. Если такой файл найден, свойства VS_CSHARP_<tagname> устанавливаются следующим образом:

для файла .cs:
  • VS_CSHARP_SubType "Form"
для файла .Designer.cs (если он существует):
  • VS_CSHARP_DependentUpon <cs-filename>
  • VS_CSHARP_DesignTime "" (удалить тег, если он был определён ранее)
  • VS_CSHARP_AutoGen ""(удалить тег, если он был определён ранее)
для файла .resx (если он существует):
  • VS_RESOURCE_GENERATOR "" (удалить тег, если он был определён ранее)
  • VS_CSHARP_DependentUpon <cs-filename>
  • VS_CSHARP_SubType "Designer"
csharp_set_designer_cs_properties

Устанавливает свойства исходных файлов для файлов .Designer.cs в зависимости от имён файлов-сиблингов. Используйте эту функцию, если ваша CSharp-цель не использует Windows Forms (для Windows Forms используйте csharp_set_designer_cs_properties()):

csharp_set_designer_cs_properties([<file1> [<file2> [...]]])
<fileN>

Список всех исходных файлов, которые имеют отношение к установке свойств VS_CSHARP_<tagname> (включая .cs, .resx, .settings и .Designer.cs расширения).

В списке всех заданных файлов ищется все файлы с расширением .Designer.cs. Для каждого файла designer ищутся все файлы с тем же базовым именем, но различными расширениями. Если совпадение найдено, свойства исходного файла для файла designer устанавливаются в зависимости от расширения сопоставленного файла:

если совпадение — файл .resx:
  • VS_CSHARP_AutoGen "True"
  • VS_CSHARP_DesignTime "True"
  • VS_CSHARP_DependentUpon <resx-filename>
если совпадение — файл .cs:
  • VS_CSHARP_DependentUpon <cs-filename>
если совпадение — файл .settings:
  • VS_CSHARP_AutoGen "True"
  • VS_CSHARP_DesignTimeSharedInput "True"
  • VS_CSHARP_DependentUpon <settings-filename>

Примечание

Поскольку свойства исходного файла для файла .Designer.cs устанавливаются в соответствии с найденными совпадениями, и каждое совпадение устанавливает свойство VS_CSHARP_DependentUpon, должно быть только одно совпадение для каждого файла Designer.cs.

csharp_set_xaml_cs_properties

Устанавливает свойства исходных файлов для использования Windows Presentation Foundation (WPF) и XAML. Используйте эту функцию, если ваша CSharp-цель использует WPF/XAML:

csharp_set_xaml_cs_properties([<file1> [<file2> [...]]])
<fileN>

Список всех исходных файлов, которые имеют отношение к установке свойств VS_CSHARP_<tagname> (включая .cs, .xaml, и .xaml.cs расширения).

В списке всех заданных файлов ищется все файлы с расширением .xaml.cs. Для каждого файла xaml-cs ищется файл с тем же базовым именем, но с расширением .xaml. Если совпадение найдено, свойства исходного файла для файла .xaml.cs устанавливаются:

  • VS_CSHARP_DependentUpon <xaml-filename>

Вспомогательные функции, используемые вышеупомянутыми

csharp_get_filename_keys

Вспомогательная функция, которая вычисляет список значений ключей для идентификации исходных файлов независимо от относительных/абсолютных путей, заданных в cmake, и устраняет чувствительность к регистру:

csharp_get_filename_keys(OUT [<file1> [<file2> [...]]])
OUT

Имя переменной, в которой хранится список ключей

<fileN>

имя(на) файла(ов), заданные для CSharp-цели с помощью add_library() или add_executable()

Функция каким-то образом применяет канонизацию к именам исходных файлов. Это необходимо для поиска совпадений файлов, если файлы были добавлены в целевой объект с различными префиксами каталогов:

add_library(lib
  myfile.cs
  ${CMAKE_CURRENT_SOURCE_DIR}/myfile.Designer.cs)

set_source_files_properties(myfile.Designer.cs PROPERTIES
  VS_CSHARP_DependentUpon myfile.cs)

# this will fail, because in cmake
#  - ${CMAKE_CURRENT_SOURCE_DIR}/myfile.Designer.cs
#  - myfile.Designer.cs
# are not the same source file. The source file property is not set.
csharp_get_filename_key_base

Возвращает полный путь и имя без расширения ключа. От KEY ожидается ключ из csharp_get_filename_keys. В BASE возвращается значение KEY без расширения файла:

csharp_get_filename_key_base(BASE KEY)
BASE

Имя переменной с вычисленной "основой" KEY.

KEY

Ключ, для которого будет вычислена основа. Ожидается полное имя файла в верхнем регистре.

csharp_get_dependentupon_name

Вычисляет строку, которая может использоваться в качестве значения для свойства исходного файла VS_CSHARP_<tagname> с target равным DependentUpon:

csharp_get_dependentupon_name(NAME FILE)
NAME

Имя переменной с результирующим значением

FILE

Имя файла для преобразования в значение <DependentUpon>

Фактически, на данный момент это только имя файла без указания пути.

© 2000–2021 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.21/module/CSharpUtilities.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API