WIP: Export IFW
Add export to binary crossplatform repository/installer
with GUI based on QtIFW:
For correct operation of these changes,
you must use the corrected QtIFW:
ADD
include/vcpkg_Commands_Export_IFW.h
+#pragma once
+
+#include "vcpkg_Files.h"
+#include "vcpkg_Dependencies.h"
+
+namespace vcpkg::Commands::Export::IFW
+{
+ fs::path export_real_package(const fs::path &raw_exported_dir_path, const Dependencies::ExportPlanAction& action, Files::Filesystem& fs);
+ void export_unique_packages(const fs::path &raw_exported_dir_path, std::map<std::string, const Dependencies::ExportPlanAction*> unique_packages, Files::Filesystem& fs);
+ void export_unique_triplets(const fs::path &raw_exported_dir_path, std::set<std::string> unique_triplets, Files::Filesystem& fs);
+ void export_integration(const fs::path &raw_exported_dir_path, Files::Filesystem& fs);
+ void export_config(const fs::path &raw_exported_dir_path, const std::string ifw_repository_url, Files::Filesystem& fs);
+}

MODIFY
src/commands_export.cpp
src/commands_export.cpp
#include "Paragraphs.h"
#include "vcpkg_Commands.h"
+#include "vcpkg_Commands_Export_IFW.h"
#include "vcpkg_Dependencies.h"
#include "vcpkg_Input.h"
#include "vcpkg_System.h"
@@ -215,10 +216,12 @@ namespace vcpkg::Commands::Export
static const std::string OPTION_DRY_RUN = "--dry-run";
static const std::string OPTION_RAW = "--raw";
static const std::string OPTION_NUGET = "--nuget";
+ static const std::string OPTION_IFW = "--ifw";
static const std::string OPTION_ZIP = "--zip";
static const std::string OPTION_SEVEN_ZIP = "--7zip";
static const std::string OPTION_NUGET_ID = "--nuget-id";
static const std::string OPTION_NUGET_VERSION = "--nuget-version";
+ static const std::string OPTION_IFW_REPOSITORY_URL = "--ifw-repository-url";
// input sanitization
static const std::string EXAMPLE =
@@ -236,22 +239,25 @@ namespace vcpkg::Commands::Export
OPTION_DRY_RUN,
OPTION_RAW,
OPTION_NUGET,
+ OPTION_IFW,
OPTION_ZIP,
OPTION_SEVEN_ZIP,
},
{
OPTION_NUGET_ID,
OPTION_NUGET_VERSION,
+ OPTION_IFW_REPOSITORY_URL,
});
const bool dry_run = options.switches.find(OPTION_DRY_RUN) != options.switches.cend();
const bool raw = options.switches.find(OPTION_RAW) != options.switches.cend();
const bool nuget = options.switches.find(OPTION_NUGET) != options.switches.cend();
+ const bool ifw = options.switches.find(OPTION_IFW) != options.switches.cend();
const bool zip = options.switches.find(OPTION_ZIP) != options.switches.cend();
const bool seven_zip = options.switches.find(OPTION_SEVEN_ZIP) != options.switches.cend();
- if (!raw && !nuget && !zip && !seven_zip && !dry_run)
+ if (!raw && !nuget && !ifw && !zip && !seven_zip && !dry_run)
{
- System::println(System::Color::error, "Must provide at least one export type: --raw --nuget --zip --7zip");
+ System::println(System::Color::error, "Must provide at least one export type: --raw --nuget --ifw --zip --7zip");
System::print(EXAMPLE);
Checks::exit_fail(VCPKG_LINE_INFO);
}
@@ -263,6 +269,10 @@ namespace vcpkg::Commands::Export
Checks::check_exit(
VCPKG_LINE_INFO, !maybe_nuget_version || nuget, "--nuget-version is only valid with --nuget");
+ auto maybe_ifw_repository_url = maybe_lookup(options.settings, OPTION_IFW_REPOSITORY_URL);
+
+ Checks::check_exit(VCPKG_LINE_INFO, !maybe_ifw_repository_url || ifw, "--ifw-repository-url is only valid with --ifw");
+
// create the plan
const StatusParagraphs status_db = database_load_check(paths);
std::vector<ExportPlanAction> export_plan = Dependencies::create_export_plan(paths, specs, status_db);
@@ -305,7 +315,11 @@ namespace vcpkg::Commands::Export
Checks::exit_success(VCPKG_LINE_INFO);
}
- const std::string export_id = create_export_id();
+ std::string export_id = create_export_id();
+ if (ifw)
+ {
+ export_id = "vcpkg-export"; // TODO: Remove after debugging
+ }
Files::Filesystem& fs = paths.get_filesystem();
const fs::path export_to_path = paths.root;
@@ -315,6 +329,8 @@ namespace vcpkg::Commands::Export
fs.create_directory(raw_exported_dir_path, ec);
// execute the plan
+ std::map<std::string, const ExportPlanAction*> unique_packages;
+ std::set<std::string> unique_triplets;
for (const ExportPlanAction& action : export_plan)
{
if (action.plan_type != ExportPlanType::ALREADY_BUILT)
@@ -327,10 +343,21 @@ namespace vcpkg::Commands::Export
const BinaryParagraph& binary_paragraph =
action.any_paragraph.binary_control_file.value_or_exit(VCPKG_LINE_INFO).core_paragraph;
+
+ unique_packages[action.spec.name()] = &action;
+ unique_triplets.insert(action.spec.triplet().canonical_name());
+
+ fs::path spec_exported_dir_path = raw_exported_dir_path / "installed";
+ if (ifw)
+ {
+ // Export real package and return data dir for installation
+ spec_exported_dir_path = IFW::export_real_package(raw_exported_dir_path, action, fs);
+ }
+
const InstallDir dirs = InstallDir::from_destination_root(
- raw_exported_dir_path / "installed",
+ spec_exported_dir_path,
action.spec.triplet().to_string(),
- raw_exported_dir_path / "installed" / "vcpkg" / "info" / (binary_paragraph.fullstem() + ".list"));
+ spec_exported_dir_path / "vcpkg" / "info" / (binary_paragraph.fullstem() + ".list"));
Install::install_files_and_write_listfile(paths.get_filesystem(), paths.package_dir(action.spec), dirs);
System::println(System::Color::success, "Exporting package %s... done", display_name);
@@ -351,13 +378,29 @@ namespace vcpkg::Commands::Export
for (const fs::path& file : integration_files_relative_to_root)
{
const fs::path source = paths.root / file;
- const fs::path destination = raw_exported_dir_path / file;
+ fs::path destination = raw_exported_dir_path / file;
+ if (ifw)
+ {
+ destination = raw_exported_dir_path / "integration" / "data" / file;
+ }
fs.create_directories(destination.parent_path(), ec);
Checks::check_exit(VCPKG_LINE_INFO, !ec);
fs.copy_file(source, destination, fs::copy_options::overwrite_existing, ec);
Checks::check_exit(VCPKG_LINE_INFO, !ec);
}
+ if (ifw)
+ {
+ // Unigue packages
+ IFW::export_unique_packages(raw_exported_dir_path, unique_packages, fs);
+ // Unigue triplets
+ IFW::export_unique_triplets(raw_exported_dir_path, unique_triplets, fs);
+ // Integration
+ IFW::export_integration(raw_exported_dir_path, fs);
+ // Configuration
+ IFW::export_config(raw_exported_dir_path, maybe_ifw_repository_url.value_or(""), fs);
+ }
+
const auto print_next_step_info = [](const fs::path& prefix) {
const fs::path cmake_toolchain = prefix / "scripts" / "buildsystems" / "vcpkg.cmake";
const CMakeVariable cmake_variable =
@@ -417,7 +460,7 @@ With a project open, go to Tools->NuGet Package Manager->Package Manager Console
print_next_step_info("[...]");
}
- if (!raw)
+ if (!raw && !ifw)
{
fs.remove_all(raw_exported_dir_path, ec);
}

ADD
src/commands_export_ifw.cpp
+#include "pch.h"
+
+#include "vcpkg_Commands_Export_IFW.h"
+
+namespace vcpkg::Commands::Export::IFW
+{
+ using Dependencies::ExportPlanAction;
+
+ fs::path export_real_package(const fs::path &raw_exported_dir_path, const ExportPlanAction& action, Files::Filesystem& fs)
+ {
+ std::error_code ec;
+
+ const BinaryParagraph& binary_paragraph =
+ action.any_paragraph.binary_control_file.value_or_exit(VCPKG_LINE_INFO).core_paragraph;
+
+ // Prepare meta dir
+ const fs::path package_xml_file_path = raw_exported_dir_path / Strings::format("packages.%s.%s", action.spec.name(), action.spec.triplet().canonical_name()) / "meta" / "package.xml";
+ const fs::path package_xml_dir_path = package_xml_file_path.parent_path();
+ fs.create_directories(package_xml_dir_path, ec);
+ Checks::check_exit(
+ VCPKG_LINE_INFO, !ec, "Could not create directory for package file %s", package_xml_file_path.generic_string());
+ std::vector<std::string> lines;
+ std::string line; std::string skip = " ";
+ line = "<?xml version=\"1.0\"?>";
+ lines.push_back(line); line.clear();
+ line += "<Package>";
+ lines.push_back(line); line = skip;
+ line += "<DisplayName>";
+ line += action.spec.to_string();
+ line += "</DisplayName>";
+ lines.push_back(line); line = skip;
+ line += "<Version>";
+ line += binary_paragraph.version; // TODO: Check IFW version format
+ line += "</Version>";
+ lines.push_back(line); line = skip;
+ line += "<ReleaseDate>";
+ line += "2017-08-31"; // TODO: Get real package release date
+ line += "</ReleaseDate>";
+ //if (!binary_paragraph.depends.empty())
+ //{
+ // lines.push_back(line); line = skip;
+ // line += "<Dependencies>";
+ //// line += Strings::format("triplets.%s:", action.spec.triplet().canonical_name());
+ // line += Strings::format("packages.%s.%s:", binary_paragraph.depends[0], action.spec.triplet().canonical_name());
+ // for (size_t i = 1; i < binary_paragraph.depends.size(); ++i)
+ // {
+ // line += Strings::format(",packages.%s.%s:", binary_paragraph.depends[i], action.spec.triplet().canonical_name());
+ // }
+ // line += "</Dependencies>";
+ //}
+ lines.push_back(line); line = skip;
+ line += "<AutoDependOn>";
+ line += Strings::format("packages.%s:,triplets.%s:", action.spec.name(), action.spec.triplet().canonical_name());
+ line += "</AutoDependOn>";
+ lines.push_back(line); line = skip;
+ line += "<Virtual>";
+ line += "true"; // NOTE: hide real package
+ line += "</Virtual>";
+ lines.push_back(line); line = skip;
+ line += "<Checkable>";
+ line += "true";
+ line += "</Checkable>";
+ lines.push_back(line); line.clear();
+ line = "</Package>";
+ lines.push_back(line); line.clear();
+ fs.write_lines(package_xml_file_path, lines);
+
+ // Return dir path for export package data
+ return raw_exported_dir_path / Strings::format("packages.%s.%s", action.spec.name(), action.spec.triplet().canonical_name()) / "data" / "installed";
+ }
+
+ void export_unique_packages(const fs::path &raw_exported_dir_path, std::map<std::string, const ExportPlanAction*> unique_packages, Files::Filesystem& fs)
+ {
+ std::error_code ec;
+
+ // packages
+
+ fs::path package_xml_file_path = raw_exported_dir_path / "packages" / "meta" / "package.xml";
+ fs::path package_xml_dir_path = package_xml_file_path.parent_path();
+ fs.create_directories(package_xml_dir_path, ec);
+ Checks::check_exit(
+ VCPKG_LINE_INFO, !ec, "Could not create directory for package file %s", package_xml_file_path.generic_string());
+ std::vector<std::string> lines;
+ std::string line; std::string skip = " ";
+ line = "<?xml version=\"1.0\"?>";
+ lines.push_back(line); line.clear();
+ line += "<Package>";
+ lines.push_back(line); line = skip;
+ line += "<DisplayName>";
+ line += "Packages";
+ line += "</DisplayName>";
+ lines.push_back(line); line = skip;
+ line = "<Version>";
+ line += "1.0.0"; // TODO: Get real packages package version
+ line += "</Version>";
+ lines.push_back(line); line = skip;
+ line += "<ReleaseDate>";
+ line += "2017-08-31"; // TODO: Get real package release date
+ line += "</ReleaseDate>";
+ lines.push_back(line); line = skip;
+ line += "<Checkable>";
+ line += "true";
+ line += "</Checkable>";
+ lines.push_back(line); line.clear();
+ line = "</Package>";
+ lines.push_back(line); line.clear();
+ fs.write_lines(package_xml_file_path, lines);
+
+ for (auto package = unique_packages.begin(); package != unique_packages.end(); ++package)
+ {
+ const ExportPlanAction& action = *(package->second);
+ const BinaryParagraph& binary_paragraph =
+ action.any_paragraph.binary_control_file.value_or_exit(VCPKG_LINE_INFO).core_paragraph;
+
+ package_xml_file_path = raw_exported_dir_path / Strings::format("packages.%s", package->first) / "meta" / "package.xml";
+ package_xml_dir_path = package_xml_file_path.parent_path();
+ fs.create_directories(package_xml_dir_path, ec);
+ Checks::check_exit(
+ VCPKG_LINE_INFO, !ec, "Could not create directory for package file %s", package_xml_file_path.generic_string());
+ lines.clear();
+ line.clear();
+ skip = " ";
+ line = "<?xml version=\"1.0\"?>";
+ lines.push_back(line); line.clear();
+ line += "<Package>";
+ lines.push_back(line); line = skip;
+ line += "<DisplayName>";
+ line += action.spec.name();
+ line += "</DisplayName>";
+ lines.push_back(line); line = skip;
+ line += "<Description>";
+ line += binary_paragraph.description;
+ line += "</Description>";
+ lines.push_back(line); line = skip;
+ line += "<Version>";
+ line += binary_paragraph.version; // TODO: Check IFW version format
+ line += "</Version>";
+ lines.push_back(line); line = skip;
+ line += "<ReleaseDate>";
+ line += "2017-08-31"; // TODO: Get real package release date
+ line += "</ReleaseDate>";
+ if (!binary_paragraph.depends.empty())
+ {
+ lines.push_back(line); line = skip;
+ line += "<Dependencies>";
+ line += Strings::format("packages.%s:", binary_paragraph.depends[0]);
+ for (size_t i = 1; i < binary_paragraph.depends.size(); ++i)
+ {
+ line += Strings::format(",packages.%s:", binary_paragraph.depends[i]);
+ }
+ line += "</Dependencies>";
+ }
+ lines.push_back(line); line = skip;
+ line += "<Checkable>";
+ line += "true";
+ line += "</Checkable>";
+ lines.push_back(line); line.clear();
+ line = "</Package>";
+ lines.push_back(line); line.clear();
+ fs.write_lines(package_xml_file_path, lines);
+ }
+ }
+
+ void export_unique_triplets(const fs::path &raw_exported_dir_path, std::set<std::string> unique_triplets, Files::Filesystem& fs)
+ {
+ std::error_code ec;
+
+ // triplets
+
+ fs::path package_xml_file_path = raw_exported_dir_path / "triplets" / "meta" / "package.xml";
+ fs::path package_xml_dir_path = package_xml_file_path.parent_path();
+ fs.create_directories(package_xml_dir_path, ec);
+ Checks::check_exit(
+ VCPKG_LINE_INFO, !ec, "Could not create directory for package file %s", package_xml_file_path.generic_string());
+ std::vector<std::string> lines;
+ std::string line; std::string skip = " ";
+ line = "<?xml version=\"1.0\"?>";
+ lines.push_back(line); line.clear();
+ line += "<Package>";
+ lines.push_back(line); line = skip;
+ line += "<DisplayName>";
+ line += "Triplets";
+ line += "</DisplayName>";
+ lines.push_back(line); line = skip;
+ line = "<Version>";
+ line += "1.0.0"; // TODO: Get real triplits package version
+ line += "</Version>";
+ lines.push_back(line); line = skip;
+ line += "<ReleaseDate>";
+ line += "2017-08-31"; // TODO: Get real package release date
+ line += "</ReleaseDate>";
+ lines.push_back(line); line = skip;
+ line += "<Checkable>";
+ line += "true";
+ line += "</Checkable>";
+ lines.push_back(line); line.clear();
+ line = "</Package>";
+ lines.push_back(line); line.clear();
+ fs.write_lines(package_xml_file_path, lines);
+
+ for (const std::string &triplet : unique_triplets)
+ {
+ package_xml_file_path = raw_exported_dir_path / Strings::format("triplets.%s", triplet) / "meta" / "package.xml";
+ package_xml_dir_path = package_xml_file_path.parent_path();
+ fs.create_directories(package_xml_dir_path, ec);
+ Checks::check_exit(
+ VCPKG_LINE_INFO, !ec, "Could not create directory for package file %s", package_xml_file_path.generic_string());
+ lines.clear();
+ line.clear();
+ skip = " ";
+ line = "<?xml version=\"1.0\"?>";
+ lines.push_back(line); line.clear();
+ line += "<Package>";
+ lines.push_back(line); line = skip;
+ line += "<DisplayName>";
+ line += triplet;
+ line += "</DisplayName>";
+ lines.push_back(line); line = skip;
+ line += "<Version>";
+ line += "1.0.0"; // TODO: Get real package version
+ line += "</Version>";
+ lines.push_back(line); line = skip;
+ line += "<ReleaseDate>";
+ line += "2017-08-31"; // TODO: Get real package release date
+ line += "</ReleaseDate>";
+ lines.push_back(line); line = skip;
+ line += "<Checkable>";
+ line += "true";
+ line += "</Checkable>";
+ lines.push_back(line); line.clear();
+ line = "</Package>";
+ lines.push_back(line); line.clear();
+ fs.write_lines(package_xml_file_path, lines);
+ }
+ }
+
+ void export_integration(const fs::path &raw_exported_dir_path, Files::Filesystem& fs)
+ {
+ std::error_code ec;
+
+ // integration
+ fs::path package_xml_file_path = raw_exported_dir_path / "integration" / "meta" / "package.xml";
+ fs::path package_xml_dir_path = package_xml_file_path.parent_path();
+ fs.create_directories(package_xml_dir_path, ec);
+ Checks::check_exit(
+ VCPKG_LINE_INFO, !ec, "Could not create directory for package file %s", package_xml_file_path.generic_string());
+ std::vector<std::string> lines;
+ std::string line; std::string skip = " ";
+ line = "<?xml version=\"1.0\"?>";
+ lines.push_back(line); line.clear();
+ line += "<Package>";
+ lines.push_back(line); line = skip;
+ line += "<DisplayName>";
+ line += "Integration";
+ line += "</DisplayName>";
+ lines.push_back(line); line = skip;
+ line = "<Version>";
+ line += "1.0.0"; // TODO: Get real integration package version
+ line += "</Version>";
+ lines.push_back(line); line = skip;
+ line += "<ReleaseDate>";
+ line += "2017-08-31"; // TODO: Get real package release date
+ line += "</ReleaseDate>";
+ lines.push_back(line); line.clear();
+ line = "</Package>";
+ lines.push_back(line); line.clear();
+ fs.write_lines(package_xml_file_path, lines);
+ }
+
+ void export_config(const fs::path &raw_exported_dir_path, const std::string ifw_repository_url, Files::Filesystem& fs)
+ {
+ std::error_code ec;
+
+ // config.xml
+ fs::path config_xml_file_path = raw_exported_dir_path / "config.xml";
+ fs::path config_xml_dir_path = config_xml_file_path.parent_path();
+ fs.create_directories(config_xml_dir_path, ec);
+ Checks::check_exit(
+ VCPKG_LINE_INFO, !ec, "Could not create directory for configuration file %s", config_xml_file_path.generic_string());
+ std::vector<std::string> lines;
+ std::string line; std::string skip = " ";
+ line = "<?xml version=\"1.0\"?>";
+ lines.push_back(line); line.clear();
+ line += "<Installer>";
+ lines.push_back(line); line = skip;
+ line += "<Name>";
+ line += "vcpkg";
+ line += "</Name>";
+ lines.push_back(line); line = skip;
+ line += "<Version>";
+ line += "1.0.0"; // TODO: Get real vcpkg installer version
+ line += "</Version>";
+ //lines.push_back(line); line = skip;
+ //line += "<AllowAllInNameAndVersion>true</AllowAllInNameAndVersion>";
+ lines.push_back(line); line = skip;
+ line += "<TargetDir>";
+ line += "@RootDir@/src/vcpkg";
+ line += "</TargetDir>";
+ if (!ifw_repository_url.empty())
+ {
+ lines.push_back(line); line = skip;
+ line += "<RemoteRepositories>";
+ lines.push_back(line); line = skip + skip;
+ line += "<Repository>";
+ lines.push_back(line); line = skip + skip + skip;
+ line += "<Url>";
+ line += ifw_repository_url;
+ line += "</Url>";
+ lines.push_back(line); line = skip + skip;
+ line += "</Repository>";
+ lines.push_back(line); line = skip;
+ line += "</RemoteRepositories>";
+ }
+ lines.push_back(line); line.clear();
+ line = "</Installer>";
+ lines.push_back(line); line.clear();
+ fs.write_lines(config_xml_file_path, lines);
+ }
+}

MODIFY
vcpkglib/vcpkglib.vcxproj
vcpkglib/vcpkglib.vcxproj
<ClInclude Include="..\include\vcpkg_Checks.h" />
<ClInclude Include="..\include\VcpkgCmdArguments.h" />
<ClInclude Include="..\include\vcpkg_Commands.h" />
+ <ClInclude Include="..\include\vcpkg_Commands_Export_IFW.h" />
<ClInclude Include="..\include\vcpkg_Dependencies.h" />
<ClInclude Include="..\include\vcpkg_Enums.h" />
<ClInclude Include="..\include\vcpkg_Files.h" />
<ClCompile Include="..\src\commands_depends.cpp" />
<ClCompile Include="..\src\commands_env.cpp" />
<ClCompile Include="..\src\commands_export.cpp" />
+ <ClCompile Include="..\src\commands_export_ifw.cpp" />
<ClCompile Include="..\src\LineInfo.cpp" />
<ClCompile Include="..\src\ParagraphParseResult.cpp" />
<ClCompile Include="..\src\vcpkg_Build.cpp" />

MODIFY
vcpkglib/vcpkglib.vcxproj.filters
vcpkglib/vcpkglib.vcxproj.filters
<ClCompile Include="..\src\commands_export.cpp">
<Filter>Source Files</Filter>
</ClCompile>
+ <ClCompile Include="..\src\commands_export_ifw.cpp">
+ <Filter>Source Files</Filter>
+ </ClCompile>
<ClCompile Include="..\src\VersionT.cpp">
<Filter>Source Files</Filter>
</ClCompile>
<ClInclude Include="..\include\vcpkg_Commands.h">
<Filter>Header Files</Filter>
</ClInclude>
+ <ClInclude Include="..\include\vcpkg_Commands_Export_IFW.h">
+ <Filter>Header Files</Filter>
+ </ClInclude>
<ClInclude Include="..\include\vcpkg_Dependencies.h">
<Filter>Header Files</Filter>
</ClInclude>

WIP: Export IFW

Add export to binary crossplatform repository/installer
with GUI based on QtIFW:
http://doc.qt.io/qtinstallerframework/ifw-overview.html

For correct operation of these changes,
you must use the corrected QtIFW:
https://codereview.qt-project.org/#/c/203958