@Class Transformer @Brief abstract transformer class for a translation unit More...

#include <Transformer.h>

Inheritance diagram for souffle::ram::transform::Transformer:

Collaboration diagram for souffle::ram::transform::Transformer:

Public Member Functions
bool	apply (TranslationUnit &translationUnit)
	@Brief apply the transformer to a translation unit @Param translationUnit that will be transformed. More...

virtual std::string	getName () const =0
	@Brief get name of the transformer More...

virtual	~Transformer ()=default

Protected Member Functions
virtual bool	transform (TranslationUnit &translationUnit)=0
	@Brief transform the translation unit / used by apply @Param translationUnit that will be transformed. More...

Detailed Description

@Class Transformer @Brief abstract transformer class for a translation unit

This is an abstract class to implement transformers. A transformer takes a translation unit and changes its state.

Transformers can be composed using other transformers.

For debugging purposes, a transformer has a name (this will show up in the debug report) and a protected method transform(), that performs the actual transformation.

The method apply is used to call transform() and does the reporting of the debug information.

Definition at line 50 of file Transformer.h.

Constructor & Destructor Documentation

◆ ~Transformer()

virtual souffle::ram::transform::Transformer::~Transformer ( )

virtualdefault

Member Function Documentation

◆ apply()

bool souffle::ram::transform::Transformer::apply ( TranslationUnit & translationUnit )

@Brief apply the transformer to a translation unit @Param translationUnit that will be transformed.

@Return flag reporting whether the RAM program has changed

Definition at line 39 of file Transformer.cpp.

                  {
         translationUnit.invalidateAnalyses();
     }
  
     // print runtime & change info for transformer in verbose mode
     if (verbose && (!isA<MetaTransformer>(this))) {
         std::string changedString = changed ? "changed" : "unchanged";
         std::cout << getName() << " time: " << std::chrono::duration<double>(end - start).count() << "sec ["
                   << changedString << "]" << std::endl;
     }
  
     // print program after transformation in debug report
     if (debug) {
         translationUnit.getDebugReport().startSection();
         if (changed) {
             translationUnit.getDebugReport().addCodeSection(getName(), "RAM Program after " + getName(),
                     "ram", ramProgStrOld, toString(translationUnit.getProgram()));
  
             translationUnit.getDebugReport().endSection(getName(), getName());
         } else {
             translationUnit.getDebugReport().endSection(getName(), getName() + " " + " (unchanged)");
         }
     }
  
     // abort evaluation of the program if errors were encountered
     if (translationUnit.getErrorReport().getNumErrors() != 0) {
         std::cerr << translationUnit.getErrorReport();
         std::cerr << translationUnit.getErrorReport().getNumErrors()
                   << " errors generated, evaluation aborted" << std::endl;
         exit(EXIT_FAILURE);
     }
  
     return changed;
 }
  
 }  // namespace souffle::ram::transform

Referenced by souffle::ram::transform::HoistAggregateTransformer::hoistAggregate(), and souffle::ram::transform::ParallelTransformer::parallelizeOperations().

◆ getName()

virtual std::string souffle::ram::transform::Transformer::getName ( ) const

pure virtual

@Brief get name of the transformer

◆ transform()

virtual bool souffle::ram::transform::Transformer::transform ( TranslationUnit & translationUnit )

protectedpure virtual

@Brief transform the translation unit / used by apply @Param translationUnit that will be transformed.