CMake/Source/cmVisualStudioSlnParser.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

104 lines
2.7 KiB
C++

/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmVisualStudioSlnParser_h
#define cmVisualStudioSlnParser_h
#include <cmConfigure.h>
#include "cmStandardIncludes.h"
#include <bitset>
class cmSlnData;
class cmVisualStudioSlnParser
{
public:
enum ParseResult
{
ResultOK = 0,
ResultInternalError = -1,
ResultExternalError = 1,
ResultErrorOpeningInput = ResultExternalError,
ResultErrorReadingInput,
ResultErrorInputStructure,
ResultErrorInputData,
ResultErrorBadInternalState = ResultInternalError,
ResultErrorUnsupportedDataGroup = ResultInternalError - 1
};
enum DataGroup
{
DataGroupProjectsBit,
DataGroupProjectDependenciesBit,
DataGroupSolutionConfigurationsBit,
DataGroupProjectConfigurationsBit,
DataGroupSolutionFiltersBit,
DataGroupGenericGlobalSectionsBit,
DataGroupCount
};
typedef std::bitset<DataGroupCount> DataGroupSet;
static const DataGroupSet DataGroupProjects;
static const DataGroupSet DataGroupProjectDependencies;
static const DataGroupSet DataGroupSolutionConfigurations;
static const DataGroupSet DataGroupProjectConfigurations;
static const DataGroupSet DataGroupSolutionFilters;
static const DataGroupSet DataGroupGenericGlobalSections;
static const DataGroupSet DataGroupAll;
bool Parse(std::istream& input, cmSlnData& output,
DataGroupSet dataGroups = DataGroupAll);
bool ParseFile(const std::string& file, cmSlnData& output,
DataGroupSet dataGroups = DataGroupAll);
ParseResult GetParseResult() const;
size_t GetParseResultLine() const;
bool GetParseHadBOM() const;
protected:
class State;
friend class State;
class ParsedLine;
struct ResultData
{
ParseResult Result;
size_t ResultLine;
bool HadBOM;
ResultData();
void Clear();
void SetError(ParseResult error, size_t line);
} LastResult;
bool IsDataGroupSetSupported(DataGroupSet dataGroups) const;
bool ParseImpl(std::istream& input, cmSlnData& output, State& state);
bool ParseBOM(std::istream& input, std::string& line, State& state);
bool ParseMultiValueTag(const std::string& line, ParsedLine& parsedLine,
State& state);
bool ParseSingleValueTag(const std::string& line, ParsedLine& parsedLine,
State& state);
bool ParseKeyValuePair(const std::string& line, ParsedLine& parsedLine,
State& state);
bool ParseTag(const std::string& fullTag, ParsedLine& parsedLine,
State& state);
bool ParseValue(const std::string& value, ParsedLine& parsedLine);
};
#endif