souffle::ram::Program Class Reference

RAM program relation declaration and functions. More...

#include <Program.h>

Inheritance diagram for souffle::ram::Program:

Collaboration diagram for souffle::ram::Program:

Public Member Functions
void	apply (const NodeMapper &map) override
	Apply the mapper to all child nodes. More...
Program *	clone () const override
	Create a clone (i.e. More...
std::vector< const Node * >	getChildNodes () const override
	Obtain list of all embedded child nodes. More...
Statement &	getMain () const
	Get main program. More...
std::vector< Relation * >	getRelations () const
	Get all relations of RAM program More...
const Statement &	getSubroutine (const std::string &name) const
	Get a specific subroutine. More...
const std::map< std::string, Statement * >	getSubroutines () const
	Get all subroutines of a RAM program. More...
	Program (VecOwn< Relation > rels, Own< Statement > main, std::map< std::string, Own< Statement >> subs)
Public Member Functions inherited from souffle::ram::Node
bool	operator!= (const Node &other) const
	Inequality check for two RAM nodes. More...
bool	operator== (const Node &other) const
	Equivalence check for two RAM nodes. More...
virtual void	rewrite (const Node *oldNode, Own< Node > newNode)
	Rewrite a child node. More...
virtual	~Node ()=default

Protected Member Functions
bool	equal (const Node &node) const override
	Equality check for two RAM nodes. More...
void	print (std::ostream &out) const override
	Print RAM node. More...

Protected Attributes
Own< Statement >	main
	Main program. More...
VecOwn< Relation >	relations
	Relations of RAM program. More...
std::map< std::string, Own< Statement > >	subroutines
	Subroutines for provenance system. More...

Private Member Functions
	Program ()=default

Detailed Description

RAM program relation declaration and functions.

A typical example:

PROGRAM
  DECLARATION
    A(x:i:number)
  END DECLARATION
  BEGIN MAIN
    ...
  END MAIN
END PROGRAM

Definition at line 58 of file Program.h.

Constructor & Destructor Documentation

Program() [1/2]

souffle::ram::Program::Program ( )

privatedefault

Program() [2/2]

souffle::ram::Program::Program ( VecOwn< Relation >  rels, Own< Statement >  main, std::map< std::string, Own< Statement >>  subs  )

inline

Definition at line 63 of file Program.h.

                             : subroutines) {
            assert(sub.second != nullptr && "Subroutine is a null-pointer");
        }
    }
 
    std::vector<const Node*> getChildNodes() const override {
        std::vector<const Node*> children;
        children = main->getChildNodes();
        for (auto& rel : relations) {
            children.push_back(rel.get());

References souffle::ast::analysis::sub().

Here is the call graph for this function:

Member Function Documentation

apply()

void souffle::ram::Program::apply ( const NodeMapper &  )

inlineoverridevirtual

Apply the mapper to all child nodes.

Reimplemented from souffle::ram::Node.

Definition at line 122 of file Program.h.

         :
    void print(std::ostream& out) const override {
        out << "PROGRAM" << std::endl;
        out << " DECLARATION" << std::endl;
        for (const auto& rel : relations) {

clone()

Program* souffle::ram::Program::clone ( ) const

inlineoverridevirtual

Create a clone (i.e.

deep copy) of this node

Implements souffle::ram::Node.

Definition at line 110 of file Program.h.

                       : subroutines) {
            res->subroutines[sub.first] = souffle::clone(sub.second);
        }
        return res;
    }
 
    void apply(const NodeMapper& map) override {
        main = map(std::move(main));
        for (auto& rel : relations) {
            rel = map(std::move(rel));
        }

References souffle::clone(), and souffle::ast::analysis::sub().

Here is the call graph for this function:

equal()

bool souffle::ram::Program::equal ( const Node &  ) const

inlineoverrideprotectedvirtual

Equality check for two RAM nodes.

Default action is that nothing needs to be checked.

Reimplemented from souffle::ram::Node.

Definition at line 151 of file Program.h.

         :
    /** Relations of RAM program */
    VecOwn<Relation> relations;
 
    /** Main program */

getChildNodes()

std::vector<const Node*> souffle::ram::Program::getChildNodes ( ) const

inlineoverridevirtual

Obtain list of all embedded child nodes.

Reimplemented from souffle::ram::Node.

Definition at line 74 of file Program.h.

                       : subroutines) {
            children.push_back(sub.second.get());
        }
        return children;
    }
 
    /** @brief Get main program */
    Statement& getMain() const {
        return *main;
    }
 

References souffle::ast::analysis::sub().

Here is the call graph for this function:

getMain()

Statement& souffle::ram::Program::getMain ( ) const

inline

Get main program.

Definition at line 87 of file Program.h.

getRelations()

std::vector<Relation*> souffle::ram::Program::getRelations ( ) const

inline

Get all relations of RAM program

Definition at line 92 of file Program.h.

                       : subroutines) {
            subroutineRefs.insert({sub.first, sub.second.get()});

References souffle::ast::analysis::sub().

Here is the call graph for this function:

getSubroutine()

const Statement& souffle::ram::Program::getSubroutine ( const std::string &  name ) const

inline

Get a specific subroutine.

Definition at line 106 of file Program.h.

                       : relations) {
            res->relations.push_back(souffle::clone(rel));

getSubroutines()

const std::map<std::string, Statement*> souffle::ram::Program::getSubroutines ( ) const

inline

Get all subroutines of a RAM program.

Definition at line 97 of file Program.h.

                                                                {
        return *subroutines.at(name);
    }
 

print()

void souffle::ram::Program::print ( std::ostream &  out ) const

inlineoverrideprotectedvirtual

Print RAM node.

Implements souffle::ram::Node.

Definition at line 133 of file Program.h.

                             : subroutines) {
            out << " SUBROUTINE " << sub.first << std::endl;
            sub.second->print(out, 2);
            out << " END SUBROUTINE" << std::endl;
        }
        out << " BEGIN MAIN" << std::endl;
        main->print(out, 2);
        out << " END MAIN" << std::endl;
        out << "END PROGRAM" << std::endl;
    }
 
    bool equal(const Node& node) const override {
        const auto& other = static_cast<const Program&>(node);
 
        return equal_targets(relations, other.relations) && equal_ptr(main, other.main) &&
               equal_targets(subroutines, other.subroutines);

References souffle::ast::analysis::sub().

Here is the call graph for this function:

Field Documentation

main

Own<Statement> souffle::ram::Program::main

protected

Main program.

Definition at line 163 of file Program.h.

relations

VecOwn<Relation> souffle::ram::Program::relations

protected

Relations of RAM program.

Definition at line 160 of file Program.h.

subroutines

std::map<std::string, Own<Statement> > souffle::ram::Program::subroutines

protected

Subroutines for provenance system.

Definition at line 166 of file Program.h.

---

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

• ram/Program.h