Defines a relation with a name, attributes, qualifiers, and internal representation. More...

#include <Relation.h>

Inheritance diagram for souffle::ast::Relation:

Collaboration diagram for souffle::ast::Relation:

Public Member Functions
void	addAttribute (Own< Attribute > attr)
	Add a new used type to this relation. More...

void	addQualifier (RelationQualifier q)
	Add qualifier to this relation. More...

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

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

size_t	getArity () const
	Return the arity of this relation. More...

std::vector< Attribute * >	getAttributes () const
	Get relation attributes. More...

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

const QualifiedName &	getQualifiedName () const
	Get qualified relation name. More...

const std::set< RelationQualifier > &	getQualifiers () const
	Get relation qualifiers. More...

RelationRepresentation	getRepresentation () const
	Get relation representation. More...

bool	hasQualifier (RelationQualifier q) const
	Check for a relation qualifier. More...

	Relation ()=default

	Relation (QualifiedName name, SrcLocation loc={})

void	removeQualifier (RelationQualifier q)
	Remove qualifier from this relation. More...

void	setAttributes (VecOwn< Attribute > attrs)
	Set relation attributes. More...

void	setQualifiedName (QualifiedName n)
	Set name for this relation. More...

void	setRepresentation (RelationRepresentation representation)
	Set relation representation. 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< Attribute >	attributes
	Attributes of the relation. More...

QualifiedName	name
	Name of relation. More...

std::set< RelationQualifier >	qualifiers
	Qualifiers of relation. More...

RelationRepresentation	representation {RelationRepresentation::DEFAULT}
	Datastructure to use for this relation. More...

Detailed Description

Defines a relation with a name, attributes, qualifiers, and internal representation.

Definition at line 49 of file Relation.h.

Constructor & Destructor Documentation

◆ Relation() [1/2]

souffle::ast::Relation::Relation ( )

default

◆ Relation() [2/2]

souffle::ast::Relation::Relation	(	QualifiedName	name,
		SrcLocation	loc = `{}`
	)

inline

Definition at line 52 of file Relation.h.

56 {

Member Function Documentation

◆ addAttribute()

void souffle::ast::Relation::addAttribute ( Own< Attribute > attr )

inline

Add a new used type to this relation.

Definition at line 67 of file Relation.h.

                             {
         return attributes.size();
     }
  

References attributes.

◆ addQualifier()

void souffle::ast::Relation::addQualifier ( RelationQualifier q )

inline

Add qualifier to this relation.

Definition at line 93 of file Relation.h.

97 {

◆ apply()

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

inlineoverridevirtual

Apply the mapper to all child nodes.

Reimplemented from souffle::ast::Node.

Definition at line 125 of file Relation.h.

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

References attributes.

◆ clone()

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

inlineoverridevirtual

Create a clone (i.e.

deep copy) of this node

Implements souffle::ast::Node.

Definition at line 117 of file Relation.h.

                                                {
         for (auto& cur : attributes) {
             cur = map(std::move(cur));
         }
     }

◆ equal()

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

inlineoverrideprotectedvirtual

Abstract equality check for two AST nodes.

Reimplemented from souffle::ast::Node.

Definition at line 145 of file Relation.h.

◆ getArity()

size_t souffle::ast::Relation::getArity ( ) const

inline

Return the arity of this relation.

Definition at line 73 of file Relation.h.

◆ getAttributes()

std::vector<Attribute*> souffle::ast::Relation::getAttributes ( ) const

inline

Get relation attributes.

Definition at line 83 of file Relation.h.

87 {

◆ getChildNodes()

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

inlineoverridevirtual

Obtain a list of all embedded AST child nodes.

Reimplemented from souffle::ast::Node.

Definition at line 131 of file Relation.h.

          :
     void print(std::ostream& os) const override {
         os << ".decl " << getQualifiedName() << "(" << join(attributes, ", ") << ")" << join(qualifiers, " ")
            << " " << representation;
     }

◆ getQualifiedName()

const QualifiedName& souffle::ast::Relation::getQualifiedName ( ) const

inline

Get qualified relation name.

Definition at line 57 of file Relation.h.

61 {

◆ getQualifiers()

const std::set<RelationQualifier>& souffle::ast::Relation::getQualifiers ( ) const

inline

Get relation qualifiers.

Definition at line 88 of file Relation.h.

92 {

◆ getRepresentation()

RelationRepresentation souffle::ast::Relation::getRepresentation ( ) const

inline

Get relation representation.

Definition at line 103 of file Relation.h.

107 {

◆ hasQualifier()

bool souffle::ast::Relation::hasQualifier ( RelationQualifier q ) const

inline

Check for a relation qualifier.

Definition at line 113 of file Relation.h.

119 {

◆ print()

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

inlineoverrideprotectedvirtual

Output to a given output stream.

Implements souffle::ast::Node.

Definition at line 140 of file Relation.h.

◆ removeQualifier()

void souffle::ast::Relation::removeQualifier ( RelationQualifier q )

inline

Remove qualifier from this relation.

Definition at line 98 of file Relation.h.

102 {

◆ setAttributes()

void souffle::ast::Relation::setAttributes ( VecOwn< Attribute > attrs )

inline

Set relation attributes.

Definition at line 78 of file Relation.h.

◆ setQualifiedName()

void souffle::ast::Relation::setQualifiedName ( QualifiedName n )

inline

Set name for this relation.

Definition at line 62 of file Relation.h.

67 {

◆ setRepresentation()

void souffle::ast::Relation::setRepresentation ( RelationRepresentation representation )

inline

Set relation representation.

Definition at line 108 of file Relation.h.

111 {

Field Documentation

◆ attributes

VecOwn<Attribute> souffle::ast::Relation::attributes

protected

Attributes of the relation.

Definition at line 154 of file Relation.h.

Referenced by addAttribute(), and apply().

◆ name

QualifiedName souffle::ast::Relation::name

protected

Name of relation.

Definition at line 151 of file Relation.h.

◆ qualifiers

std::set<RelationQualifier> souffle::ast::Relation::qualifiers

protected

Qualifiers of relation.

Definition at line 157 of file Relation.h.

◆ representation

RelationRepresentation souffle::ast::Relation::representation {RelationRepresentation::DEFAULT}

protected

Datastructure to use for this relation.

Definition at line 160 of file Relation.h.

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

ast/Relation.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Relation() [1/2]

◆ Relation() [2/2]

Member Function Documentation

◆ addAttribute()

◆ addQualifier()

◆ apply()

◆ clone()

◆ equal()

◆ getArity()

◆ getAttributes()

◆ getChildNodes()

◆ getQualifiedName()

◆ getQualifiers()

◆ getRepresentation()

◆ hasQualifier()

◆ print()

◆ removeQualifier()

◆ setAttributes()

◆ setQualifiedName()

◆ setRepresentation()

Field Documentation

◆ attributes

◆ name

◆ qualifiers

◆ representation