Panda3D
Classes | Public Member Functions | Friends

InterrogateFunctionWrapper Class Reference

An internal representation of a callable function. More...

#include "interrogateFunctionWrapper.h"

Inheritance diagram for InterrogateFunctionWrapper:
InterrogateComponent

List of all members.

Classes

class  Parameter

Public Member Functions

 InterrogateFunctionWrapper (InterrogateModuleDef *def=NULL)
 InterrogateFunctionWrapper (const InterrogateFunctionWrapper &copy)
bool caller_manages_return_value () const
const string & get_comment () const
FunctionIndex get_function () const
 Returns the FunctionIndex of the function that this wrapper corresponds to.
const char * get_library_name () const
 Returns the library name, if it is known, or NULL if it is not.
const char * get_module_name () const
 Returns the module name, if it is known, or NULL if it is not.
const string & get_name () const
TypeIndex get_return_type () const
FunctionIndex get_return_value_destructor () const
const string & get_unique_name () const
bool has_comment () const
bool has_library_name () const
 Returns true if we have a known library name, false if we do not.
bool has_module_name () const
 Returns true if we have a known module name, false if we do not.
bool has_name () const
bool has_return_value () const
void input (istream &in)
 Reads the data file as previously formatted by output().
bool is_callable_by_name () const
int number_of_parameters () const
void operator= (const InterrogateFunctionWrapper &copy)
void output (ostream &out) const
 Formats the InterrogateFunctionWrapper data for output to a data file.
const string & parameter_get_name (int n) const
TypeIndex parameter_get_type (int n) const
bool parameter_has_name (int n) const
bool parameter_is_this (int n) const
void remap_indices (const IndexRemapper &remap)
 Remaps all internal index numbers according to the indicated map.

Friends

class FunctionRemap
class InterrogateBuilder

Detailed Description

An internal representation of a callable function.

Definition at line 30 of file interrogateFunctionWrapper.h.


Member Function Documentation

FunctionIndex InterrogateFunctionWrapper::get_function ( ) const [inline]

Returns the FunctionIndex of the function that this wrapper corresponds to.

Definition at line 65 of file interrogateFunctionWrapper.I.

const char * InterrogateComponent::get_library_name ( ) const [inline, inherited]

Returns the library name, if it is known, or NULL if it is not.

This is the name of the library that this particular component was built into. Typically this will be a one-to-one correspondance with an invocation of the interrogate command. Typical examples are "libutil" and "liblinmath".

Definition at line 73 of file interrogateComponent.I.

Referenced by InterrogateComponent::has_library_name().

const char * InterrogateComponent::get_module_name ( ) const [inline, inherited]

Returns the module name, if it is known, or NULL if it is not.

This is the name of the module that this particular component is associated with. This is a higher grouping than library. Typical examples are "panda" and "pandaegg".

Definition at line 102 of file interrogateComponent.I.

Referenced by InterrogateComponent::has_module_name().

bool InterrogateComponent::has_library_name ( ) const [inline, inherited]

Returns true if we have a known library name, false if we do not.

See get_library_name().

Definition at line 57 of file interrogateComponent.I.

References InterrogateComponent::get_library_name().

bool InterrogateComponent::has_module_name ( ) const [inline, inherited]

Returns true if we have a known module name, false if we do not.

See get_module_name().

Definition at line 87 of file interrogateComponent.I.

References InterrogateComponent::get_module_name().

void InterrogateFunctionWrapper::input ( istream &  in)

Reads the data file as previously formatted by output().

Reimplemented from InterrogateComponent.

Definition at line 68 of file interrogateFunctionWrapper.cxx.

void InterrogateFunctionWrapper::output ( ostream &  out) const

Formats the InterrogateFunctionWrapper data for output to a data file.

Reimplemented from InterrogateComponent.

Definition at line 50 of file interrogateFunctionWrapper.cxx.

void InterrogateFunctionWrapper::remap_indices ( const IndexRemapper remap)

Remaps all internal index numbers according to the indicated map.

This called from InterrogateDatabase::remap_indices().

Definition at line 87 of file interrogateFunctionWrapper.cxx.

References IndexRemapper::map_from().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations