blob: d845ba8336e06389e43a821e0b3f6665a37bdcca (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
/**
* @file
* @author 2012-2014 Stefan Radomski (stefan.radomski@cs.tu-darmstadt.de)
* @copyright Simplified BSD
* @brief Identifies some common problems with SCXML documents
*
* @cond
* This program is free software: you can redistribute it and/or modify
* it under the terms of the FreeBSD license as published by the FreeBSD
* project.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of the FreeBSD license along with this
* program. If not, see <http://www.opensource.org/licenses/bsd-license>.
* @endcond
*/
#ifndef INTERPRETERISSUE_H_962CB305
#define INTERPRETERISSUE_H_962CB305
#include "uscxml/Common.h"
#include <list>
// forward declare
namespace XERCESC_NS {
class DOMNode;
}
namespace uscxml {
class InterpreterImpl;
/**
* Identify and report syntactic and semantic problems with a SCXML state-charts.
* @see uscxml::Interpreter::validate()
*/
class USCXML_API InterpreterIssue {
public:
enum IssueSeverity {
USCXML_ISSUE_FATAL, ///< Interpreter can not process such a document
USCXML_ISSUE_WARNING, ///< Document is questionable, but formally ok
USCXML_ISSUE_INFO ///< Indicates a possible problem, but maybe perfectly ok
};
std::string xPath; ///< Where did the issue arise
std::string message; ///< What is the issue
XERCESC_NS::DOMNode* node; ///< The DOM node pertaining to the issue
IssueSeverity severity; ///< Severity of the issue
std::string specRef; ///< If applicable, the violated section from the standard
/**
* Constructor is solely used to report issues at runtime.
*/
InterpreterIssue(const std::string& msg, XERCESC_NS::DOMNode* node, IssueSeverity severity, const std::string& specRef = "");
private:
static std::list<InterpreterIssue> forInterpreter(InterpreterImpl* interpreter);
friend class Interpreter;
};
USCXML_API std::ostream& operator<< (std::ostream& os, const InterpreterIssue& issue);
}
#endif /* end of include guard: INTERPRETERISSUE_H_962CB305 */
|
