CMake/Source/CPack/WiX/cmWIXRichTextFormatWriter.h

47 lines
1.0 KiB
C
Raw Normal View History

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 22:01:08 +03:00
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmWIXRichTextFormatWriter_h
#define cmWIXRichTextFormatWriter_h
#include <cmConfigure.h>
#include "cmStandardIncludes.h"
#include <cmsys/FStream.hxx>
/** \class cmWIXRichtTextFormatWriter
* \brief Helper class to generate Rich Text Format (RTF) documents
* from plain text (e.g. for license and welcome text)
*/
class cmWIXRichTextFormatWriter
{
public:
cmWIXRichTextFormatWriter(std::string const& filename);
~cmWIXRichTextFormatWriter();
void AddText(std::string const& text);
private:
void WriteHeader();
void WriteFontTable();
void WriteColorTable();
void WriteGenerator();
void WriteDocumentPrefix();
void ControlWord(std::string const& keyword);
void NewControlWord(std::string const& keyword);
void StartGroup();
void EndGroup();
void EmitUnicodeCodepoint(int c);
void EmitUnicodeSurrogate(int c);
void EmitInvalidCodepoint(int c);
cmsys::ofstream File;
};
#endif