mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-07 14:20:06 -06:00
20fa4ce8d8
In order to support generation of Common Package Specifications, the mechanisms CMake uses to export package information need to be made more abstract. The prior commits began this refactoring; this continues by (actually) restructuring the classes used to generate the actual export files. To minimize churn, this introduces virtual base classes and diamond inheritance in order to separate logic which is format-agnostic but depends on the export mode (build-tree versus install-tree) from logic which is format-specific but mode-agnostic. This could probably be refactored further to use helper classes instead, and a future commit may do that, however an initial attempt to do that was proving even more invasive, such that this approach was deemed more manageable. While we're at it, add 'const' in more places where possible.
75 lines
2.8 KiB
C++
75 lines
2.8 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <iosfwd>
|
|
#include <string>
|
|
|
|
#include "cmExportCMakeConfigGenerator.h"
|
|
#include "cmExportInstallFileGenerator.h"
|
|
|
|
class cmFileSet;
|
|
class cmGeneratorTarget;
|
|
class cmInstallExportGenerator;
|
|
class cmTargetExport;
|
|
|
|
/** \class cmExportInstallCMakeConfigGenerator
|
|
* \brief Generate files exporting targets from an install tree.
|
|
*
|
|
* cmExportInstallCMakeConfigGenerator generates files exporting targets from
|
|
* an installation tree. The files are placed in a temporary location for
|
|
* installation by cmInstallExportGenerator. The file format is CMake's native
|
|
* package configuration format.
|
|
*
|
|
* One main file is generated that creates the imported targets and loads
|
|
* per-configuration files. Target locations and settings for each
|
|
* configuration are written to these per-configuration files. After
|
|
* installation the main file loads the configurations that have been
|
|
* installed.
|
|
*
|
|
* This is used to implement the INSTALL(EXPORT) command.
|
|
*/
|
|
class cmExportInstallCMakeConfigGenerator
|
|
: public cmExportCMakeConfigGenerator
|
|
, public cmExportInstallFileGenerator
|
|
{
|
|
public:
|
|
/** Construct with the export installer that will install the
|
|
files. */
|
|
cmExportInstallCMakeConfigGenerator(cmInstallExportGenerator* iegen);
|
|
|
|
/** Compute the globbing expression used to load per-config import
|
|
files from the main file. */
|
|
std::string GetConfigImportFileGlob() const override;
|
|
|
|
protected:
|
|
// Implement virtual methods from the superclass.
|
|
bool GenerateMainFile(std::ostream& os) override;
|
|
void GenerateImportTargetsConfig(std::ostream& os, std::string const& config,
|
|
std::string const& suffix) override;
|
|
|
|
/** Generate the relative import prefix. */
|
|
virtual void GenerateImportPrefix(std::ostream&);
|
|
|
|
/** Generate the relative import prefix. */
|
|
virtual void LoadConfigFiles(std::ostream&);
|
|
|
|
virtual void CleanupTemporaryVariables(std::ostream&);
|
|
|
|
/** Generate a per-configuration file for the targets. */
|
|
virtual bool GenerateImportFileConfig(std::string const& config);
|
|
|
|
std::string GetFileSetDirectories(cmGeneratorTarget* gte, cmFileSet* fileSet,
|
|
cmTargetExport const* te) override;
|
|
std::string GetFileSetFiles(cmGeneratorTarget* gte, cmFileSet* fileSet,
|
|
cmTargetExport const* te) override;
|
|
|
|
std::string GetCxxModulesDirectory() const override;
|
|
void GenerateCxxModuleConfigInformation(std::string const&,
|
|
std::ostream&) const override;
|
|
bool GenerateImportCxxModuleConfigTargetInclusion(std::string const&,
|
|
std::string const&);
|
|
};
|