mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-05 03:00:58 -06:00
104 lines
4.0 KiB
C++
104 lines
4.0 KiB
C++
/*****************************************************************************************
|
|
* *
|
|
* OpenSpace *
|
|
* *
|
|
* Copyright (c) 2014-2016 *
|
|
* *
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
|
|
* software and associated documentation files (the "Software"), to deal in the Software *
|
|
* without restriction, including without limitation the rights to use, copy, modify, *
|
|
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
|
|
* permit persons to whom the Software is furnished to do so, subject to the following *
|
|
* conditions: *
|
|
* *
|
|
* The above copyright notice and this permission notice shall be included in all copies *
|
|
* or substantial portions of the Software. *
|
|
* *
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
|
|
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
|
|
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
|
|
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
|
|
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
****************************************************************************************/
|
|
|
|
#ifndef __DOCUMENTATION_H__
|
|
#define __DOCUMENTATION_H__
|
|
|
|
#include <ghoul/misc/boolean.h>
|
|
#include <ghoul/misc/dictionary.h>
|
|
#include <ghoul/misc/exception.h>
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace openspace {
|
|
namespace documentation {
|
|
|
|
using Optional = ghoul::Boolean;
|
|
using Exhaustive = ghoul::Boolean;
|
|
|
|
/**
|
|
* The TestResult structure returns the information from the #testSpecification method. It
|
|
* contains the information whether test specification test was successful
|
|
* (TestResult::success) and a list of Offence%s
|
|
*/
|
|
struct TestResult {
|
|
struct Offense {
|
|
enum class Reason {
|
|
MissingKey,
|
|
ExtraKey,
|
|
WrongType,
|
|
Verification
|
|
};
|
|
std::string offender;
|
|
Reason reason;
|
|
};
|
|
bool success;
|
|
std::vector<Offense> offenses;
|
|
};
|
|
|
|
struct SpecificationError : public ghoul::RuntimeError {
|
|
SpecificationError(TestResult result, std::string component);
|
|
|
|
TestResult result;
|
|
};
|
|
|
|
struct Verifier;
|
|
|
|
struct DocumentationEntry {
|
|
DocumentationEntry(std::string key, Verifier* t, std::string doc = "",
|
|
Optional optional = Optional::No);
|
|
|
|
std::string key;
|
|
std::shared_ptr<Verifier> verifier;
|
|
bool optional;
|
|
std::string documentation;
|
|
};
|
|
|
|
using DocumentationEntries = std::vector<documentation::DocumentationEntry>;
|
|
|
|
struct Documentation {
|
|
Documentation(std::string name = "", DocumentationEntries entries = {},
|
|
Exhaustive exhaustive = Exhaustive::No);
|
|
Documentation(DocumentationEntries entries);
|
|
|
|
std::string name;
|
|
DocumentationEntries entries;
|
|
Exhaustive exhaustive;
|
|
};
|
|
|
|
|
|
TestResult testSpecification(const Documentation& d, const ghoul::Dictionary& dictionary);
|
|
void testSpecificationAndThrow(const Documentation& doc,
|
|
const ghoul::Dictionary& dictionary, std::string component);
|
|
|
|
} // namespace documentation
|
|
|
|
using documentation::Documentation;
|
|
|
|
} // namespace openspace
|
|
|
|
#endif // __DOCUMENTATION_H__
|