A collection of VuoCompilerIssue
s that occurred while compiling a module or composition.
This class provides some functions for aggregating and de-duplicating error/warning messages.
Definition at line 81 of file VuoCompilerIssue.hh.
Public Member Functions | |
VuoCompilerIssues (void) | |
Constructs an empty list of issues. More... | |
VuoCompilerIssues (const VuoCompilerIssue &issue) | |
Constructs a list of issues with one item. More... | |
string | getShortDescription (bool htmlFormatted) |
Returns the short descriptions of the issues in the list, de-duplicated and appended. More... | |
string | getLongDescription (bool htmlFormatted) |
Returns the long descriptions of the issues in the list, de-duplicated and appended. More... | |
string | getHint (bool htmlFormatted) |
Returns the hints of the issues in the list, de-duplicated and appended. More... | |
void | setFilePathIfEmpty (const string &filePath) |
Sets the file for each issue in the list that doesn't already have one. More... | |
void | setFilePath (const string &filePath) |
Sets the file for each issue in the list. More... | |
void | append (const VuoCompilerIssue &issue) |
Adds the issue to the end of the list. More... | |
void | append (VuoCompilerIssues *otherIssues) |
Adds the issues to the end of the list. More... | |
bool | isEmpty (void) |
Returns true if there are no issues in the list. More... | |
vector< VuoCompilerIssue > | getList (void) |
Returns the VuoCompilerIssue s in the list. More... | |
VuoCompilerIssues * | getErrors (void) |
Returns a new VuoCompilerIssues containing the issues in this list that are errors. More... | |
VuoCompilerIssues::VuoCompilerIssues | ( | void | ) |
Constructs an empty list of issues.
Definition at line 359 of file VuoCompilerIssue.cc.
VuoCompilerIssues::VuoCompilerIssues | ( | const VuoCompilerIssue & | issue | ) |
Constructs a list of issues with one item.
Definition at line 366 of file VuoCompilerIssue.cc.
void VuoCompilerIssues::append | ( | const VuoCompilerIssue & | issue | ) |
Adds the issue to the end of the list.
Definition at line 446 of file VuoCompilerIssue.cc.
void VuoCompilerIssues::append | ( | VuoCompilerIssues * | otherIssues | ) |
Adds the issues to the end of the list.
Definition at line 454 of file VuoCompilerIssue.cc.
VuoCompilerIssues * VuoCompilerIssues::getErrors | ( | void | ) |
Returns a new VuoCompilerIssues
containing the issues in this list that are errors.
Definition at line 478 of file VuoCompilerIssue.cc.
string VuoCompilerIssues::getHint | ( | bool | htmlFormatted | ) |
Returns the hints of the issues in the list, de-duplicated and appended.
htmlFormatted | If false, the returned string is plain text. If true, the returned string may contain HTML formatting. |
Definition at line 412 of file VuoCompilerIssue.cc.
vector< VuoCompilerIssue > VuoCompilerIssues::getList | ( | void | ) |
Returns the VuoCompilerIssue
s in the list.
Definition at line 470 of file VuoCompilerIssue.cc.
string VuoCompilerIssues::getLongDescription | ( | bool | htmlFormatted | ) |
Returns the long descriptions of the issues in the list, de-duplicated and appended.
htmlFormatted | If false, the returned string is plain text. If true, the returned string may contain HTML formatting. |
Definition at line 394 of file VuoCompilerIssue.cc.
string VuoCompilerIssues::getShortDescription | ( | bool | htmlFormatted | ) |
Returns the short descriptions of the issues in the list, de-duplicated and appended.
htmlFormatted | If false, the returned string is plain text. If true, the returned string may contain HTML formatting. |
Definition at line 376 of file VuoCompilerIssue.cc.
bool VuoCompilerIssues::isEmpty | ( | void | ) |
Returns true if there are no issues in the list.
Definition at line 462 of file VuoCompilerIssue.cc.
void VuoCompilerIssues::setFilePath | ( | const string & | filePath | ) |
Sets the file for each issue in the list.
Definition at line 438 of file VuoCompilerIssue.cc.
void VuoCompilerIssues::setFilePathIfEmpty | ( | const string & | filePath | ) |
Sets the file for each issue in the list that doesn't already have one.
Definition at line 428 of file VuoCompilerIssue.cc.