Intermediate representation of a horn clause. More...

#include <Clause.h>

Inheritance diagram for souffle::ast::Clause:

Collaboration diagram for souffle::ast::Clause:

Public Member Functions
void	addToBody (Own< Literal > literal)
	Add a literal to the body of the clause. More...

void	apply (const NodeMapper &map) override
	Apply the mapper to all child nodes. More...

	Clause (Own< Atom > head={}, VecOwn< Literal > bodyLiterals={}, Own< ExecutionPlan > plan={}, SrcLocation loc={})

void	clearExecutionPlan ()
	Resets the execution plan. More...

Clause *	clone () const override
	Create a clone (i.e. More...

std::vector< Literal * >	getBodyLiterals () const
	Obtains a copy of the internally maintained body literals. More...

std::vector< const Node * >	getChildNodes () const override
	Obtain a list of all embedded AST child nodes. More...

const ExecutionPlan *	getExecutionPlan () const
	Obtains the execution plan associated to this clause or null if there is none. More...

Atom *	getHead () const
	Return the atom that represents the head of the clause. More...

void	setBodyLiterals (VecOwn< Literal > body)
	Set the bodyLiterals of clause to `body`. More...

void	setExecutionPlan (Own< ExecutionPlan > plan)
	Updates the execution plan associated to this clause. More...

void	setHead (Own< Atom > h)
	Set the head of clause to `h`. More...

Public Member Functions inherited from souffle::ast::Node
std::string	extloc () const
	Return source location of the syntactic element. More...

const SrcLocation &	getSrcLoc () const
	Return source location of the Node. More...

	Node (SrcLocation loc={})

bool	operator!= (const Node &other) const
	Inequality check for two AST nodes. More...

bool	operator== (const Node &other) const
	Equivalence check for two AST nodes. More...

void	setSrcLoc (SrcLocation l)
	Set source location for the Node. More...

virtual	~Node ()=default

Protected Member Functions
bool	equal (const Node &node) const override
	Abstract equality check for two AST nodes. More...

void	print (std::ostream &os) const override
	Output to a given output stream. More...

Protected Attributes
VecOwn< Literal >	bodyLiterals
	Body literals of clause. More...

Own< Atom >	head
	Head of the clause. More...

Own< ExecutionPlan >	plan
	User defined execution plan (if not defined, plan is null) More...

Detailed Description

Intermediate representation of a horn clause.

A clause can either be:

a fact - a clause with no body (e.g., X(a,b))
a rule - a clause with a head and a body (e.g., Y(a,b) -: X(a,b))

Definition at line 51 of file Clause.h.

Constructor & Destructor Documentation

◆ Clause()

souffle::ast::Clause::Clause	(	Own< Atom >	head = `{}`,
		VecOwn< Literal >	bodyLiterals = `{}`,
		Own< ExecutionPlan >	plan = `{}`,
		SrcLocation	loc = `{}`
	)

inline

Definition at line 53 of file Clause.h.

                                          {
         bodyLiterals.push_back(std::move(literal));
     }
  

References bodyLiterals.

Member Function Documentation

◆ addToBody()

void souffle::ast::Clause::addToBody ( Own< Literal > literal )

inline

Add a literal to the body of the clause.

Definition at line 59 of file Clause.h.

63 {

◆ apply()

void souffle::ast::Clause::apply ( const NodeMapper & )

inlineoverridevirtual

Apply the mapper to all child nodes.

Reimplemented from souffle::ast::Node.

Definition at line 103 of file Clause.h.

                                                           {
         std::vector<const Node*> res = {head.get()};
         for (auto& cur : bodyLiterals) {
             res.push_back(cur.get());
         }

References bodyLiterals, and head.

◆ clearExecutionPlan()

void souffle::ast::Clause::clearExecutionPlan ( )

inline

Resets the execution plan.

Definition at line 94 of file Clause.h.

97 {

◆ clone()

Clause* souffle::ast::Clause::clone ( ) const

inlineoverridevirtual

Create a clone (i.e.

deep copy) of this node

Implements souffle::ast::Node.

Definition at line 98 of file Clause.h.

                        : bodyLiterals) {
             lit = map(std::move(lit));
         }

◆ equal()

bool souffle::ast::Clause::equal ( const Node & ) const

inlineoverrideprotectedvirtual

Abstract equality check for two AST nodes.

Reimplemented from souffle::ast::Node.

Definition at line 132 of file Clause.h.

◆ getBodyLiterals()

std::vector<Literal*> souffle::ast::Clause::getBodyLiterals ( ) const

inline

Obtains a copy of the internally maintained body literals.

Definition at line 79 of file Clause.h.

83 {

Referenced by souffle::ast::transform::RemoveRelationCopiesTransformer::removeRelationCopies(), and souffle::ast::transform::PartitionBodyLiteralsTransformer::transform().

◆ getChildNodes()

std::vector<const Node*> souffle::ast::Clause::getChildNodes ( ) const

inlineoverridevirtual

Obtain a list of all embedded AST child nodes.

Reimplemented from souffle::ast::Node.

Definition at line 110 of file Clause.h.

          :
     void print(std::ostream& os) const override {
         if (head != nullptr) {
             os << *head;
         }

◆ getExecutionPlan()

const ExecutionPlan* souffle::ast::Clause::getExecutionPlan ( ) const

inline

Obtains the execution plan associated to this clause or null if there is none.

Definition at line 84 of file Clause.h.

88 {

◆ getHead()

Atom* souffle::ast::Clause::getHead ( ) const

inline

Return the atom that represents the head of the clause.

Definition at line 74 of file Clause.h.

78 {

Referenced by souffle::ast::transform::RemoveRelationCopiesTransformer::removeRelationCopies(), and souffle::ast::transform::PartitionBodyLiteralsTransformer::transform().

◆ print()

void souffle::ast::Clause::print ( std::ostream & os ) const

inlineoverrideprotectedvirtual

Output to a given output stream.

Implements souffle::ast::Node.

Definition at line 119 of file Clause.h.

                              {
             os << *plan;
         }
     }
  
     bool equal(const Node& node) const override {
         const auto& other = static_cast<const Clause&>(node);
         return equal_ptr(head, other.head) && equal_targets(bodyLiterals, other.bodyLiterals) &&
                equal_ptr(plan, other.plan);
     }

◆ setBodyLiterals()

void souffle::ast::Clause::setBodyLiterals ( VecOwn< Literal > body )

inline

Set the bodyLiterals of clause to body.

Definition at line 69 of file Clause.h.

◆ setExecutionPlan()

void souffle::ast::Clause::setExecutionPlan ( Own< ExecutionPlan > plan )

inline

Updates the execution plan associated to this clause.

Definition at line 89 of file Clause.h.

92 {

◆ setHead()

void souffle::ast::Clause::setHead ( Own< Atom > h )

inline

Set the head of clause to h.

Definition at line 64 of file Clause.h.

68 {

Field Documentation

◆ bodyLiterals

VecOwn<Literal> souffle::ast::Clause::bodyLiterals

protected

Body literals of clause.

Definition at line 142 of file Clause.h.

Referenced by apply(), and Clause().

◆ head

Own<Atom> souffle::ast::Clause::head

protected

Head of the clause.

Definition at line 139 of file Clause.h.

Referenced by apply().

◆ plan

Own<ExecutionPlan> souffle::ast::Clause::plan

protected

User defined execution plan (if not defined, plan is null)

Definition at line 145 of file Clause.h.

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

ast/Clause.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Clause()

Member Function Documentation

◆ addToBody()

◆ apply()

◆ clearExecutionPlan()

◆ clone()

◆ equal()

◆ getBodyLiterals()

◆ getChildNodes()

◆ getExecutionPlan()

◆ getHead()

◆ print()

◆ setBodyLiterals()

◆ setExecutionPlan()

◆ setHead()

Field Documentation

◆ bodyLiterals

◆ head

◆ plan