Vuo  0.9.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
VuoCompilerMakeListNodeClass Class Reference

Description

A "Make List" node class.

Public Member Functions

unsigned long getItemCount (void)
 Returns the number of item input ports for this "Make List" node class.
 
VuoCompilerTypegetListType (void)
 Returns the type of the list output port for this "Make List" node class.
 
VuoTypegetOriginalPortType (VuoPortClass *portClass)
 Returns this port's type in the (hypothetical) unspecialized Make List node class.
 
string getOriginalGenericNodeClassName (void)
 Returns the original node's class name (without any type suffixes).
 
string getOriginalGenericNodeClassDescription (void)
 Returns the original node's class description.
 
VuoNodeSetgetOriginalGenericNodeSet (void)
 Returns the original node's node set.
 
string createUnspecializedNodeClassName (set< VuoPortClass * > portClassesToUnspecialize)
 Returns the name for the Make List node class that would result if the given port were changed back to its original type.
 
string createSpecializedNodeClassNameWithReplacement (string genericTypeName, string specializedTypeName)
 Returns the name for the Make List node class that would result if the given specialized type were substituted for the generic item type.
 
- Public Member Functions inherited from VuoCompilerSpecializedNodeClass
 VuoCompilerSpecializedNodeClass (string nodeClassName, Module *module)
 Creates a specialized node class implementation from an LLVM module, and creates its corresponding base VuoNodeClass.
 
 VuoCompilerSpecializedNodeClass (VuoCompilerSpecializedNodeClass *compilerNodeClass, VuoNode *nodeToBack)
 Creates a new compiler node class and creates a new base VuoNodeClass, both from compilerNodeClass.
 
string createDefaultSpecializedNodeClassName (void)
 Returns the name for the node class that would result if all of this node class's generic types that have default specialized types (as defined in the node class metadata) were replaced with those types.
 
- Public Member Functions inherited from VuoCompilerNodeClass
VuoNodenewNode (string title="", double x=0, double y=0)
 Creates a substantial base node instance from this node class.
 
VuoNodenewNode (VuoNode *nodeToCopyMetadataFrom)
 Creates a substantial base node instance with its metadata copied from the existing nodeToCopyMetadataFrom.
 
virtual ~VuoCompilerNodeClass (void)
 Destructor.
 
string getClassIdentifier (void)
 The unique class name for this node class, rendered as an identifier in the generated code.
 
Function * getEventFunction (void)
 Returns an LLVM Function for this node class's implementation of the nodeEvent or nodeInstanceEvent function.
 
Function * getInitFunction (void)
 If this node class is stateful, returns an LLVM Function for this node class's implementation of the nodeInstanceInit function.
 
Function * getFiniFunction (void)
 If this node class is stateful, returns an LLVM Function for this node class's implementation of the nodeInstanceFini function.
 
Function * getCallbackStartFunction (void)
 If this node class is stateful, returns an LLVM Function for this node class's implementation of the nodeInstanceTriggerStart function.
 
Function * getCallbackUpdateFunction (void)
 If this node class is stateful, returns an LLVM Function for this node class's implementation of the nodeInstanceTriggerUpdate function.
 
Function * getCallbackStopFunction (void)
 If this node class is stateful, returns an LLVM Function for this node class's implementation of the nodeInstanceTriggerStop function.
 
VuoCompilerInstanceDataClassgetInstanceDataClass (void)
 If this node class is stateful, returns the instance data class.
 
string getDoxygenDocumentation (void)
 Returns a string containing documentation for this node class in Doxygen format.
 
string getDefaultSpecializedTypeName (string genericTypeName)
 If this node class is generic, returns the default specialized types to replace the generic type with when creating an instance.
 
vector< string > getAutomaticKeywords (void)
 Returns a list of keywords automatically associated with this node class, based on attributes such as its port classes and premium status.
 
- Public Member Functions inherited from VuoBaseDetail< VuoNodeClass >
 VuoBaseDetail (string description, VuoNodeClass *base)
 Creates a VuoNodeClass detail class.
 
VuoNodeClassgetBase (void) const
 Returns the VuoNodeClass detail class instance's base class instance.
 
void setBase (VuoNodeClass *base)
 Sets the VuoNodeClass detail class instance's base class instance.
 
- Public Member Functions inherited from VuoCompilerModule
virtual ~VuoCompilerModule (void)
 Destructor.
 
VuoCompilerTargetSet parseTargetSet (json_object *o, string key)
 Parses the target set value for key in the top level of the JSON object.
 
VuoCompilerTargetSet::MacVersion parseMacVersion (string version)
 Parses a Mac OS version from a string.
 
set< string > getDependencies (void)
 Returns a list of this VuoCompilerModule's dependencies.
 
VuoCompilerTargetSet getCompatibleTargets (void)
 Returns the set of targets (operating system versions) with which this module is compatible.
 
Module * getModule (void)
 Returns this VuoCompilerModule's LLVM module, which other LLVM modules can link to.
 
VuoModulegetPseudoBase (void)
 Returns the (psuedo) base for this (psuedo) compiler detail class.
 
bool getPremium (void)
 Returns a boolean indicating whether this module contains premium content.
 
void setPremium (bool premium)
 Sets the boolean indicating whether this module contains premium content.
 

Static Public Member Functions

static VuoNodeClassnewNodeClass (string nodeClassName, VuoCompiler *compiler, VuoNode *nodeToBack=NULL)
 Generates a node class for a "Make List" node.
 
static bool isMakeListNodeClassName (string nodeClassName)
 Returns true if the name has the format of a "Make List" node class name.
 
static string getNodeClassName (unsigned long itemCount, VuoCompilerType *listType)
 Returns the name that a "Make List" node class would have if it were to input the given number of items and output the given type of list.
 
static string buildNodeClassName (unsigned long itemCount, string itemTypeName)
 Creates a "Make List" node class name from the item count and type.
 
- Static Public Member Functions inherited from VuoCompilerSpecializedNodeClass
static VuoNodeClassnewNodeClass (string nodeClassName, VuoCompiler *compiler, VuoNode *nodeToBack=NULL)
 Generates a specalized node class from a generic node class.
 
static void replaceGenericTypesWithBacking (string &nodeClassSource, VuoNode *nodeToBack=NULL)
 Replaces all occurrences of generic type names in the node class source code with a default actual type name.
 
static vector< string > getGenericTypeNamesFromPorts (VuoCompilerNodeClass *nodeClass)
 Returns the generic type names used by this node class's ports, in numerical order of their suffixes.
 
static map< string, string > getBackingTypeNamesFromPorts (VuoNodeClass *nodeClass)
 Returns the backing type for each generic type used by the given node class's ports.
 
static map< string, string > getBackingTypeNamesFromPorts (VuoNode *node)
 Returns the backing type for each generic type used by the given node's ports.
 
static string extractGenericNodeClassName (string specializedNodeClassName, size_t genericTypeCount)
 Extracts the generic node class name from the specialized node class name by removing type names from the end.
 
static string createSpecializedNodeClassName (string genericNodeClassName, vector< string > specializedTypeNames)
 Creates a specialized node class name by appending type names to the generic node class name.
 
- Static Public Member Functions inherited from VuoCompilerNodeClass
static VuoNodeClassnewNodeClass (string nodeClassName, Module *module)
 Creates a new substantial VuoNodeClass from the node class definition in the module.
 
static VuoNodeClassnewNodeClassWithoutImplementation (VuoNodeClass *baseNodeClass)
 Creates a new implementation-less compiler node class, using the given node class for its base VuoNodeClass.
 
- Static Public Member Functions inherited from VuoCompilerModule
static VuoCompilerModulenewModule (string moduleKey, Module *module)
 Instantiates a VuoCompilerModule (or child class) corresponding to the type of VuoCompilerModule defined in the LLVM module.
 
static Function * declareFunctionInModule (Module *module, Function *function)
 Copies the function's header into the LLVM module, if it's not already there.
 

Additional Inherited Members

- Protected Member Functions inherited from VuoCompilerNodeClass
 VuoCompilerNodeClass (string className, Module *module)
 Creates a node class implementation from an LLVM module, and creates its corresponding base VuoNodeClass.
 
 VuoCompilerNodeClass (VuoCompilerNodeClass *compilerNodeClass)
 Creates a new compiler node class and creates a new base VuoNodeClass, both from compilerNodeClass.
 
 VuoCompilerNodeClass (VuoNodeClass *baseNodeClass)
 Creates a new implementation-less compiler node class, using the given node class for its base VuoNodeClass.
 
VuoPortClassgetInputPortClassWithName (string portName)
 Returns the input port class matching the specified portName, if one exists.
 
VuoPortClassgetOutputPortClassWithName (string portName)
 Returns the output port class matching the specified portName, if one exists.
 
- Static Protected Member Functions inherited from VuoCompilerNodeClass
static void parseGenericTypes (json_object *moduleDetails, map< string, string > &defaultSpecializedForGenericTypeName, map< string, set< string > > &compatibleSpecializedForGenericTypeName)
 Parses the "genericTypes" portion of a node class's metadata.
 
- Protected Attributes inherited from VuoCompilerSpecializedNodeClass
map< string, string > specializedForGenericTypeName
 The type name that replaces each generic type name in the original generic node class.
 

Member Function Documentation

string VuoCompilerMakeListNodeClass::buildNodeClassName ( unsigned long  itemCount,
string  itemTypeName 
)
static

Creates a "Make List" node class name from the item count and type.

string VuoCompilerMakeListNodeClass::createSpecializedNodeClassNameWithReplacement ( string  genericTypeName,
string  specializedTypeName 
)
virtual

Returns the name for the Make List node class that would result if the given specialized type were substituted for the generic item type.

Reimplemented from VuoCompilerSpecializedNodeClass.

string VuoCompilerMakeListNodeClass::createUnspecializedNodeClassName ( set< VuoPortClass * >  portClassesToUnspecialize)
virtual

Returns the name for the Make List node class that would result if the given port were changed back to its original type.

Reimplemented from VuoCompilerSpecializedNodeClass.

unsigned long VuoCompilerMakeListNodeClass::getItemCount ( void  )

Returns the number of item input ports for this "Make List" node class.

VuoCompilerType * VuoCompilerMakeListNodeClass::getListType ( void  )

Returns the type of the list output port for this "Make List" node class.

string VuoCompilerMakeListNodeClass::getNodeClassName ( unsigned long  itemCount,
VuoCompilerType listType 
)
static

Returns the name that a "Make List" node class would have if it were to input the given number of items and output the given type of list.

string VuoCompilerMakeListNodeClass::getOriginalGenericNodeClassDescription ( void  )
virtual

Returns the original node's class description.

Reimplemented from VuoCompilerSpecializedNodeClass.

string VuoCompilerMakeListNodeClass::getOriginalGenericNodeClassName ( void  )
virtual

Returns the original node's class name (without any type suffixes).

Reimplemented from VuoCompilerSpecializedNodeClass.

VuoNodeSet * VuoCompilerMakeListNodeClass::getOriginalGenericNodeSet ( void  )
virtual

Returns the original node's node set.

Todo:
somehow return the vuo.list node set

Reimplemented from VuoCompilerSpecializedNodeClass.

VuoType * VuoCompilerMakeListNodeClass::getOriginalPortType ( VuoPortClass portClass)
virtual

Returns this port's type in the (hypothetical) unspecialized Make List node class.

Reimplemented from VuoCompilerSpecializedNodeClass.

bool VuoCompilerMakeListNodeClass::isMakeListNodeClassName ( string  nodeClassName)
static

Returns true if the name has the format of a "Make List" node class name.

(A "Make List" node class by that name may or may not exist.)

VuoNodeClass * VuoCompilerMakeListNodeClass::newNodeClass ( string  nodeClassName,
VuoCompiler compiler,
VuoNode nodeToBack = NULL 
)
static

Generates a node class for a "Make List" node.

The node class's event function inputs zero or more items and outputs a list of those items.

Parameters
nodeClassNameThe name of the node class to generate. It should have the format "vuo.list.make.<item count>.<item type>" (e.g. "vuo.list.make.3.VuoInteger").
compilerThe compiler to use for looking up types.
nodeToBackOptionally, a 'Make List' node whose generic types should be used to determine this node class's backing types.
Returns
The generated node class, or null if the node class name does not have the correct format.

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