CMake/Source/CPack/IFW/cmCPackIFWRepository.h
Brad King 86578eccf2 Simplify CMake per-source license notices
Per-source copyright/license notice headers that spell out copyright holder
names and years are hard to maintain and often out-of-date or plain wrong.
Precise contributor information is already maintained automatically by the
version control tool.  Ultimately it is the receiver of a file who is
responsible for determining its licensing status, and per-source notices are
merely a convenience.  Therefore it is simpler and more accurate for
each source to have a generic notice of the license name and references to
more detailed information on copyright holders and full license terms.

Our `Copyright.txt` file now contains a list of Contributors whose names
appeared source-level copyright notices.  It also references version control
history for more precise information.  Therefore we no longer need to spell
out the list of Contributors in each source file notice.

Replace CMake per-source copyright/license notice headers with a short
description of the license and links to `Copyright.txt` and online information
available from "https://cmake.org/licensing".  The online URL also handles
cases of modules being copied out of our source into other projects, so we
can drop our notices about replacing links with full license text.

Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority
of the replacements mechanically.  Manually fix up shebang lines and trailing
newlines in a few files.  Manually update the notices in a few files that the
script does not handle.
2016-09-27 15:14:44 -04:00

99 lines
2.0 KiB
C++

/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmCPackIFWRepository_h
#define cmCPackIFWRepository_h
#include <cmConfigure.h> // IWYU pragma: keep
#include <string>
#include <vector>
class cmCPackIFWGenerator;
class cmXMLWriter;
/** \class cmCPackIFWRepository
* \brief A remote repository to be created CPack IFW generator
*/
class cmCPackIFWRepository
{
public:
// Types
enum Action
{
None,
Add,
Remove,
Replace
};
typedef std::vector<cmCPackIFWRepository*> RepositoriesVector;
public:
// Constructor
/**
* Construct repository
*/
cmCPackIFWRepository();
public:
// Configuration
/// Internal repository name
std::string Name;
/// Optional update action
Action Update;
/// Is points to a list of available components
std::string Url;
/// Is points to a list that will replaced
std::string OldUrl;
/// Is points to a list that will replace to
std::string NewUrl;
/// With "0" disabling this repository
std::string Enabled;
/// Is used as user on a protected repository
std::string Username;
/// Is password to use on a protected repository
std::string Password;
/// Is optional string to display instead of the URL
std::string DisplayName;
public:
// Internal implementation
bool IsValid() const;
const char* GetOption(const std::string& op) const;
bool IsOn(const std::string& op) const;
bool IsVersionLess(const char* version);
bool IsVersionGreater(const char* version);
bool IsVersionEqual(const char* version);
bool ConfigureFromOptions();
bool PatchUpdatesXml();
void WriteRepositoryConfig(cmXMLWriter& xout);
void WriteRepositoryUpdate(cmXMLWriter& xout);
void WriteRepositoryUpdates(cmXMLWriter& xout);
cmCPackIFWGenerator* Generator;
RepositoriesVector RepositoryUpdate;
std::string Directory;
protected:
void WriteGeneratedByToStrim(cmXMLWriter& xout);
};
#endif // cmCPackIFWRepository_h