souffle::ast::UserDefinedFunctor Class Reference

User-Defined functor class. More...

#include <UserDefinedFunctor.h>

Inheritance diagram for souffle::ast::UserDefinedFunctor:

Collaboration diagram for souffle::ast::UserDefinedFunctor:

Public Member Functions
UserDefinedFunctor *	clone () const override
	Create clone. More...
std::optional< TypeAttribute >	getFinalReturnType () const
const std::string &	getName () const
	return the name More...
void	setFinalReturnType (TypeAttribute newType)
	UserDefinedFunctor (std::string name)
	UserDefinedFunctor (std::string name, VecOwn< Argument > args, SrcLocation loc={})
Public Member Functions inherited from souffle::ast::Term
void	addArgument (Own< Argument > arg)
	Add argument to argument list. More...
void	apply (const NodeMapper &map) override
	Apply the mapper to all child nodes. More...
std::vector< Argument * >	getArguments () const
	Get arguments. More...
std::vector< const Node * >	getChildNodes () const override
	Obtain a list of all embedded AST child nodes. More...
Public Member Functions inherited from souffle::ast::Argument
	Node (SrcLocation loc={})
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 Member Functions inherited from souffle::ast::Functor
template<typename... Operands>
	Term (Operands &&... operands)
template<typename... Operands>
	Term (SrcLocation loc, Operands &&... operands)
	Term (VecOwn< Argument > operands, SrcLocation loc={})
Protected Member Functions inherited from souffle::ast::Term
template<typename... Operands>
	Term (Operands &&... operands)
template<typename... Operands>
	Term (SrcLocation loc, Operands &&... operands)
	Term (VecOwn< Argument > operands, SrcLocation loc={})

Protected Attributes
std::optional< TypeAttribute >	finalTranslatorReturnType
const std::string	name
	Name. More...
Protected Attributes inherited from souffle::ast::Term
VecOwn< Argument >	args
	Arguments. More...

Detailed Description

User-Defined functor class.

Definition at line 46 of file UserDefinedFunctor.h.

Constructor & Destructor Documentation

UserDefinedFunctor() [1/2]

souffle::ast::UserDefinedFunctor::UserDefinedFunctor ( std::string  name )

inlineexplicit

Definition at line 48 of file UserDefinedFunctor.h.

{

References name.

UserDefinedFunctor() [2/2]

souffle::ast::UserDefinedFunctor::UserDefinedFunctor ( std::string  name, VecOwn< Argument >  args, SrcLocation  loc = {}  )

inline

Definition at line 50 of file UserDefinedFunctor.h.

                                               {

Member Function Documentation

clone()

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

inlineoverridevirtual

Create clone.

Implements souffle::ast::Functor.

Definition at line 58 of file UserDefinedFunctor.h.

                                                   {
        finalTranslatorReturnType = newType;
    }
 
    std::optional<TypeAttribute> getFinalReturnType() const {

equal()

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

inlineoverrideprotectedvirtual

Abstract equality check for two AST nodes.

Reimplemented from souffle::ast::Term.

Definition at line 79 of file UserDefinedFunctor.h.

getFinalReturnType()

std::optional<TypeAttribute> souffle::ast::UserDefinedFunctor::getFinalReturnType ( ) const

inline

Definition at line 70 of file UserDefinedFunctor.h.

                                                {

getName()

const std::string& souffle::ast::UserDefinedFunctor::getName ( ) const

inline

return the name

Definition at line 54 of file UserDefinedFunctor.h.

                                                   {
            res->setFinalReturnType(finalTranslatorReturnType.value());
        }

References finalTranslatorReturnType.

print()

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

inlineoverrideprotectedvirtual

Output to a given output stream.

Implements souffle::ast::Node.

Definition at line 75 of file UserDefinedFunctor.h.

setFinalReturnType()

void souffle::ast::UserDefinedFunctor::setFinalReturnType ( TypeAttribute  newType )

inline

Definition at line 66 of file UserDefinedFunctor.h.

         :
    void print(std::ostream& os) const override {

Field Documentation

finalTranslatorReturnType

std::optional<TypeAttribute> souffle::ast::UserDefinedFunctor::finalTranslatorReturnType

protected

Definition at line 88 of file UserDefinedFunctor.h.

Referenced by getName().

name

const std::string souffle::ast::UserDefinedFunctor::name

protected

Name.

Definition at line 85 of file UserDefinedFunctor.h.

Referenced by UserDefinedFunctor().

---

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

• ast/UserDefinedFunctor.h