VuoCompilerIssue.hh

Go to the documentation of this file.

 
#pragma once
 
class VuoCable;
class VuoModule;
class VuoNode;
 
class VuoCompilerIssue
{
public:
    enum IssueType
    {
        Error,  
        Warning  
    };
 
    VuoCompilerIssue(void);
    VuoCompilerIssue(IssueType issueType, const string &action, const string &filePath, const string &summary, const string &details);
    IssueType getIssueType(void);
    string getSummary(void);
    string getDetails(bool htmlFormatted) const;
    string getShortDescription(bool htmlFormatted) const;
    string getLongDescription(bool htmlFormatted);
    void setHint(const string &hint);
    string getHint(bool htmlFormatted);
    void setHelpPath(const string &path);
    string getHelpPath(void);
    void setFilePath(const string &filePath);
    string getFilePath(void);
    void setLineNumber(int lineNumber);
    int getLineNumber(void);
    void setModuleKey(const string &moduleKey);
    void setLink(const string &url, const string &text);
    void setModule(VuoModule *module);
    void setNode(VuoNode *node);
    void setNodes(const set<VuoNode *> &nodes);
    set<VuoNode *> getNodes(void);
    void setCables(const set<VuoCable *> &cables);
    set<VuoCable *> getCables(void);
    long getHash(void);
 
private:
    string getIssueTypeString(void);
    string fillInPlaceholders(const string &s, bool htmlFormatted) const;
 
    IssueType issueType;  
    string action;  
    string summary;  
    string details;  
    string hint;  
    string helpPath;  
    string filePath;  
    int lineNumber;  
    string moduleKey;  
    string linkUrl;  
    string linkText;  
    VuoModule *module;  
    set<VuoNode *> nodes;  
    set<VuoCable *> cables;  
};
 
class VuoCompilerIssues
{
public:
    VuoCompilerIssues(void);
    VuoCompilerIssues(const VuoCompilerIssue &issue);
    string getShortDescription(bool htmlFormatted);
    string getLongDescription(bool htmlFormatted);
    string getHint(bool htmlFormatted);
    void setFilePathIfEmpty(const string &filePath);
    void setFilePath(const string &filePath);
    void append(const VuoCompilerIssue &issue);
    void append(VuoCompilerIssues *otherIssues);
    bool isEmpty(void);
    vector<VuoCompilerIssue> getList(void);
    VuoCompilerIssues * getErrors(void);
 
private:
    vector<VuoCompilerIssue> issues;  
};