souffle::ast::TranslationUnit Class Reference

Translation unit class for the translation pipeline. More...

#include <TranslationUnit.h>

Collaboration diagram for souffle::ast::TranslationUnit:

Public Member Functions
template<class Analysis >
Analysis *	getAnalysis () const
	get analysis: analysis is generated on the fly if not present More...
DebugReport &	getDebugReport ()
	Return debug report. More...
ErrorReport &	getErrorReport ()
	Return error report. More...
Program &	getProgram () const
	Return the program. More...
void	invalidateAnalyses () const
	Destroy all cached analyses of translation unit. More...
	TranslationUnit (Own< Program > program, ErrorReport &e, DebugReport &d)
virtual	~TranslationUnit ()=default

Private Attributes
std::map< std::string, Own< analysis::Analysis > >	analyses
	Cached analyses. More...
DebugReport &	debugReport
	HTML debug report. More...
ErrorReport &	errorReport
	Error report capturing errors while compiling. More...
Own< Program >	program
	AST program. More...

Detailed Description

Translation unit class for the translation pipeline.

The translation unit class consisting of an symbol table, AST program, error reports, and cached analysis results.

Definition at line 51 of file TranslationUnit.h.

Constructor & Destructor Documentation

TranslationUnit()

souffle::ast::TranslationUnit::TranslationUnit ( Own< Program >  program, ErrorReport &  e, DebugReport &  d  )

inline

Definition at line 53 of file TranslationUnit.h.

                                  {

References analyses, and souffle::Global::config().

Here is the call graph for this function:

~TranslationUnit()

virtual souffle::ast::TranslationUnit::~TranslationUnit ( )

virtualdefault

Member Function Documentation

getAnalysis()

template<class Analysis >

Analysis* souffle::ast::TranslationUnit::getAnalysis ( ) const

inline

get analysis: analysis is generated on the fly if not present

Definition at line 60 of file TranslationUnit.h.

                       {
                std::stringstream ss;
                analyses[name]->print(ss);
                if (!isA<analysis::PrecedenceGraphAnalysis>(analyses[name].get()) &&
                        !isA<analysis::SCCGraphAnalysis>(analyses[name].get())) {
                    debugReport.addSection(name, "Ast Analysis [" + name + "]", ss.str());
                } else {
                    debugReport.addSection(
                            DebugReportSection(name, "Ast Analysis [" + name + "]", {}, ss.str()));
                }
            }
        }
        return dynamic_cast<Analysis*>(analyses[name].get());
    }
 
    /** Return the program */
    Program& getProgram() const {
        assert(program && "NULL program");
        return *program.get();
    }

Referenced by souffle::ast::transform::IOAttributesTransformer::clone(), and souffle::ast::transform::MagicSetTransformer::LabelDatabaseTransformer::isNegativelyLabelled().

getDebugReport()

DebugReport& souffle::ast::TranslationUnit::getDebugReport ( )

inline

Return debug report.

Definition at line 100 of file TranslationUnit.h.

getErrorReport()

ErrorReport& souffle::ast::TranslationUnit::getErrorReport ( )

inline

Return error report.

Definition at line 90 of file TranslationUnit.h.

                                  {

getProgram()

Program& souffle::ast::TranslationUnit::getProgram ( ) const

inline

Return the program.

Definition at line 84 of file TranslationUnit.h.

                                  {
        return errorReport;
    }
 

References errorReport.

Referenced by souffle::ast::transform::IOAttributesTransformer::clone(), souffle::ast::transform::MagicSetTransformer::LabelDatabaseTransformer::isNegativelyLabelled(), and souffle::ast::transform::IODefaultsTransformer::transform().

invalidateAnalyses()

void souffle::ast::TranslationUnit::invalidateAnalyses ( ) const

inline

Destroy all cached analyses of translation unit.

Definition at line 95 of file TranslationUnit.h.

       :
    /** Cached analyses */

Field Documentation

analyses

std::map<std::string, Own<analysis::Analysis> > souffle::ast::TranslationUnit::analyses

mutableprivate

Cached analyses.

Definition at line 106 of file TranslationUnit.h.

Referenced by TranslationUnit().

debugReport

DebugReport& souffle::ast::TranslationUnit::debugReport

private

HTML debug report.

Definition at line 115 of file TranslationUnit.h.

errorReport

ErrorReport& souffle::ast::TranslationUnit::errorReport

private

Error report capturing errors while compiling.

Definition at line 112 of file TranslationUnit.h.

Referenced by getProgram().

program

Own<Program> souffle::ast::TranslationUnit::program

private

AST program.

Definition at line 109 of file TranslationUnit.h.

---

The documentation for this class was generated from the following file:

• ast/TranslationUnit.h