souffle::ast::FunctorDeclaration Class Reference

User-defined functor declaration. More...

#include <FunctorDeclaration.h>

Inheritance diagram for souffle::ast::FunctorDeclaration:

Collaboration diagram for souffle::ast::FunctorDeclaration:

Public Member Functions
FunctorDeclaration *	clone () const override
	Create a clone (i.e. More...
	FunctorDeclaration (std::string name, std::vector< TypeAttribute > argsTypes, TypeAttribute returnType, bool stateful, SrcLocation loc={})
const std::vector< TypeAttribute > &	getArgsTypes () const
	Return type. More...
size_t	getArity () const
	Return number of arguments. More...
const std::string &	getName () const
	Return name. More...
TypeAttribute	getReturnType () const
	Get return type. More...
bool	isStateful () const
	Check whether functor is stateful. More...
Public Member Functions inherited from souffle::ast::Node
virtual void	apply (const NodeMapper &)
	Apply the mapper to all child nodes. More...
std::string	extloc () const
	Return source location of the syntactic element. More...
virtual std::vector< const Node * >	getChildNodes () const
	Obtain a list of all embedded AST child nodes. 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 &out) const override
	Output to a given output stream. More...

Protected Attributes
const std::vector< TypeAttribute >	argsTypes
	Types of arguments. More...
const std::string	name
	Name of functor. More...
const TypeAttribute	returnType
	Type of the return value. More...
const bool	stateful
	Stateful flag. More...

Detailed Description

User-defined functor declaration.

Example: .declfun foo(x:number, y:number):number

Definition at line 49 of file FunctorDeclaration.h.

Constructor & Destructor Documentation

FunctorDeclaration()

souffle::ast::FunctorDeclaration::FunctorDeclaration ( std::string  name, std::vector< TypeAttribute >  argsTypes, TypeAttribute  returnType, bool  stateful, SrcLocation  loc = {}  )

inline

Definition at line 51 of file FunctorDeclaration.h.

                                     {
        return name;
    }
 

References name.

Member Function Documentation

clone()

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

inlineoverridevirtual

Create a clone (i.e.

deep copy) of this node

Implements souffle::ast::Node.

Definition at line 83 of file FunctorDeclaration.h.

                                               {
            switch (type) {
                case TypeAttribute::Signed: return "number";

References souffle::Float, souffle::Signed, and souffle::Symbol.

equal()

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

inlineoverrideprotectedvirtual

Abstract equality check for two AST nodes.

Reimplemented from souffle::ast::Node.

Definition at line 109 of file FunctorDeclaration.h.

getArgsTypes()

const std::vector<TypeAttribute>& souffle::ast::FunctorDeclaration::getArgsTypes ( ) const

inline

Return type.

Definition at line 64 of file FunctorDeclaration.h.

                            {

getArity()

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

inline

Return number of arguments.

Definition at line 74 of file FunctorDeclaration.h.

                                               {

getName()

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

inline

Return name.

Definition at line 59 of file FunctorDeclaration.h.

                                        {

Referenced by souffle::ast::analysis::TypeAnalysis::run().

getReturnType()

TypeAttribute souffle::ast::FunctorDeclaration::getReturnType ( ) const

inline

Get return type.

Definition at line 69 of file FunctorDeclaration.h.

                            {

isStateful()

bool souffle::ast::FunctorDeclaration::isStateful ( ) const

inline

Check whether functor is stateful.

Definition at line 79 of file FunctorDeclaration.h.

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

print()

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

inlineoverrideprotectedvirtual

Output to a given output stream.

Implements souffle::ast::Node.

Definition at line 88 of file FunctorDeclaration.h.

                                          : return "unsigned";
                case TypeAttribute::Record: break;
                case TypeAttribute::ADT: break;
            }
            fatal("unhandled `TypeAttribute`");
        };
 
        tfm::format(
                out, ".declfun %s(%s): %s", name, join(map(argsTypes, convert), ","), convert(returnType));
        if (stateful) {
            out << " stateful";
        }
        out << std::endl;
    }
 
    bool equal(const Node& node) const override {
        const auto& other = static_cast<const FunctorDeclaration&>(node);
        return name == other.name && argsTypes == other.argsTypes && returnType == other.returnType &&
               stateful == other.stateful;
    }

Field Documentation

argsTypes

const std::vector<TypeAttribute> souffle::ast::FunctorDeclaration::argsTypes

protected

Types of arguments.

Definition at line 119 of file FunctorDeclaration.h.

name

const std::string souffle::ast::FunctorDeclaration::name

protected

Name of functor.

Definition at line 116 of file FunctorDeclaration.h.

Referenced by FunctorDeclaration().

returnType

const TypeAttribute souffle::ast::FunctorDeclaration::returnType

protected

Type of the return value.

Definition at line 122 of file FunctorDeclaration.h.

stateful

const bool souffle::ast::FunctorDeclaration::stateful

protected

Stateful flag.

Definition at line 125 of file FunctorDeclaration.h.

---

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

• ast/FunctorDeclaration.h