OutputBuilder.hpp

Go to the documentation of this file.

#ifndef OutputBuilder_H
#define OutputBuilder_H

#include <iostream>
#include <string>
#include <OpenAnalysis/IRInterface/IRHandles.hpp>

namespace OA {

std::string int2string(const int& number);
std::string bool2string(const bool& val);

class OutputBuilder { 
  public:
    OutputBuilder() {}
    virtual ~OutputBuilder() {}
    OutputBuilder(OutputBuilder& other) {}
    OutputBuilder(std::ostream&) {}

    //virtual void configStream(ostream&) = 0;

    virtual void outputString(const std::string &str) = 0;

    //*****************************************************************
    // IRHandles
    //*****************************************************************
    virtual void outputIRHandle(ProcHandle h, IRHandlesIRInterface& pIR) = 0;
    virtual void outputIRHandle(StmtHandle h, IRHandlesIRInterface& pIR) = 0;
    virtual void outputIRHandle(ExprHandle h, IRHandlesIRInterface& pIR) = 0;
    virtual void outputIRHandle(CallHandle h, IRHandlesIRInterface& pIR) = 0;
    virtual void outputIRHandle(OpHandle h, IRHandlesIRInterface& pIR) = 0;
    virtual void outputIRHandle(MemRefHandle h, IRHandlesIRInterface& pIR) = 0;
    virtual void outputIRHandle(SymHandle h, IRHandlesIRInterface& pIR) = 0;
    virtual void outputIRHandle(ConstSymHandle h, IRHandlesIRInterface& pIR)=0;
    virtual void outputIRHandle(ConstValHandle h, IRHandlesIRInterface& pIR)=0;

    //*****************************************************************
    // Object
    //*****************************************************************
    virtual void objStart(const std::string& objName) = 0;
    virtual void objEnd(const std::string& objName) = 0;

    virtual void field(const std::string& fieldname, 
                       const std::string& value) = 0;
 
    virtual void fieldStart(const std::string& fieldname) = 0;
    virtual void fieldEnd(const std::string& fieldname) = 0;

    //*****************************************************************
    // Lists
    //*****************************************************************
    virtual void listStart() = 0;
    virtual void listEnd() = 0;

    virtual void listItem(const std::string& value) = 0;

    virtual void listItemStart() = 0;
    virtual void listItemEnd() = 0;

    // a separator between list items
    //FIXME: deprecated
    //virtual void listItemDelimit() = 0;

    //*****************************************************************
    // Maps
    //*****************************************************************
    virtual void mapStart(const std::string& label,
                          const std::string& keyLabel,
                          const std::string& valueLabel) = 0;
    virtual void mapEnd(const std::string& label) = 0;

    virtual void mapEntry(const std::string& key, const std::string& value)=0;
    virtual void mapKey(const std::string& key) = 0;
    virtual void mapValue(const std::string& value) = 0;

    virtual void mapEntryStart() = 0;
    virtual void mapEntryEnd() = 0;
    virtual void mapKeyStart() = 0;
    virtual void mapKeyEnd() = 0;
    virtual void mapValueStart() = 0;
    virtual void mapValueEnd() = 0;

    //*****************************************************************
    // Graphs
    //*****************************************************************
    virtual void graphStart(const std::string &label) = 0;
    virtual void graphEnd(const std::string &label) = 0;
    virtual void graphSubStart(const std::string &label) = 0;
    virtual void graphSubEnd(const std::string &label) = 0;

    virtual void graphNodeStart(int id) = 0;
    virtual void graphNodeLabel(const std::string &label) = 0;
    virtual void graphNodeLabelStart() = 0;
    virtual void graphNodeLabelEnd() = 0;
    virtual void graphNodeEnd() = 0;

    virtual void graphEdgeStart() =  0;
    virtual void graphEdgeSourceNode(int id) = 0;
    virtual void graphEdgeSinkNode(int id) = 0;
    virtual void graphEdgeLabelStart() =  0;
    virtual void graphEdgeLabelEnd() =  0;
    virtual void graphEdgeEnd() = 0;
};

} // end of OA namespace

#endif