Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

CPPTypeProxy Class Reference

This is a special kind of type that is a placeholder for some type, currently unknown, that will be filled in later. More...

#include <cppTypeProxy.h>

Inheritance diagram for CPPTypeProxy:

CPPType CPPDeclaration List of all members.

Public Types

typedef vector< CPPTypedef * > Typedefs
typedef map< CPPDeclaration *,
CPPDeclaration * > 
SubstDecl
typedef set< CPPDeclaration * > Instantiations
enum  SubType {
  ST_instance, ST_typedef, ST_type_declaration, ST_expression,
  ST_type, ST_namespace, ST_using, ST_simple,
  ST_pointer, ST_reference, ST_array, ST_const,
  ST_function, ST_function_group, ST_extension, ST_struct,
  ST_enum, ST_class_template_parameter, ST_tbd, ST_type_proxy
}

Public Member Functions

 CPPTypeProxy ()
virtual CPPTyperesolve_type (CPPScope *current_scope, CPPScope *global_scope)
 If this CPPType object is a forward reference or other nonspecified reference to a type that might now be known a real type, returns the real type.

virtual bool is_tbd () const
 Returns true if the type, or any nested type within the type, is a CPPTBDType and thus isn't fully determined right now.

bool has_typedef_name () const
 Returns true if the type has even been typedef'ed and therefore has a simple name available to stand for it.

string get_typedef_name (CPPScope *scope=NULL) const
 Returns a string that can be used to name the type, if has_typedef_name() returned true.

virtual string get_simple_name () const
 Returns a fundametal one-word name for the type.

virtual string get_local_name (CPPScope *scope=NULL) const
 Returns the compilable, correct name for this type within the indicated scope.

virtual string get_fully_scoped_name () const
 Returns the compilable, correct name for the type, with completely explicit scoping.

virtual string get_preferred_name () const
 Returns the best name to use for the type from a programmer's point of view.

virtual bool is_incomplete () const
 Returns true if the type has not yet been fully specified, false if it has.

virtual void output_instance (ostream &out, int indent_level, CPPScope *scope, bool complete, const string &prename, const string &name) const
 Formats a C++-looking line that defines an instance of the given type, with the indicated name.

virtual void output (ostream &out, int indent_level, CPPScope *scope, bool complete) const
virtual SubType get_subtype () const
virtual CPPTypeas_type ()
virtual CPPSimpleTypeas_simple_type ()
virtual CPPPointerTypeas_pointer_type ()
virtual CPPReferenceTypeas_reference_type ()
virtual CPPArrayTypeas_array_type ()
virtual CPPConstTypeas_const_type ()
virtual CPPFunctionTypeas_function_type ()
virtual CPPExtensionTypeas_extension_type ()
virtual CPPStructTypeas_struct_type ()
virtual CPPEnumTypeas_enum_type ()
virtual CPPTBDTypeas_tbd_type ()
virtual CPPTypeProxy * as_type_proxy ()
virtual bool is_equivalent (const CPPType &other) const
 This is a little more forgiving than is_equal(): it returns true if the types appear to be referring to the same thing, even if they may have different pointers or somewhat different definitions.

void output_instance (ostream &out, const string &name, CPPScope *scope) const
 Formats a C++-looking line that defines an instance of the given type, with the indicated name.

bool operator== (const CPPDeclaration &other) const
bool operator!= (const CPPDeclaration &other) const
bool operator< (const CPPDeclaration &other) const
bool is_template () const
 Returns true if this is a template declaration of some kind: a template function or a template class, typically.

CPPTemplateScopeget_template_scope () const
 If is_template(), above, returns true, this returns the CPPTemplateScope in which this particular template declaration is defined.

virtual bool is_fully_specified () const
 Returns true if this declaration is an actual, factual declaration, or false if some part of the declaration depends on a template parameter which has not yet been instantiated.

virtual CPPDeclarationinstantiate (const CPPTemplateParameterList *actual_params, CPPScope *current_scope, CPPScope *global_scope, CPPPreprocessor *error_sink=NULL) const
virtual CPPDeclarationsubstitute_decl (SubstDecl &subst, CPPScope *current_scope, CPPScope *global_scope)
virtual CPPInstanceas_instance ()
virtual CPPClassTemplateParameteras_class_template_parameter ()
virtual CPPTypedefas_typedef ()
virtual CPPTypeDeclarationas_type_declaration ()
virtual CPPExpressionas_expression ()
virtual CPPNamespaceas_namespace ()
virtual CPPUsingas_using ()
virtual CPPFunctionGroupas_function_group ()

Static Public Member Functions

CPPTypenew_type (CPPType *type)
 This should be called whenever a new CPPType object is created.

void record_preferred_name_for (const CPPType *type, const string &name)
 Records a global typedef name associated with the indicated Type.

string get_preferred_name_for (const CPPType *type)
 Returns the previously-stored "preferred" name associated with the type, if any, or empty string if no name is associated.


Public Attributes

CPPType_actual_type
Typedefs _typedefs
CPPTypeDeclaration_declaration
Instantiations _instantiations
CPPVisibility _vis
CPPTemplateScope_template_scope
CPPFile _file
CPPCommentBlock_leading_comment

Protected Types

typedef set< CPPType *, CPPTypeCompareTypes
typedef map< string, string > PreferredNames

Protected Member Functions

virtual bool is_equal (const CPPDeclaration *other) const
 Called by CPPDeclaration to determine whether this type is equivalent to another type of the same type.

virtual bool is_less (const CPPDeclaration *other) const
 Called by CPPDeclaration to determine whether this type should be ordered before another type of the same type, in an arbitrary but fixed ordering.


Static Protected Attributes

Types _types
PreferredNames _preferred_names

Detailed Description

This is a special kind of type that is a placeholder for some type, currently unknown, that will be filled in later.

It's used when a type that references itself must instantiate.

Definition at line 43 of file cppTypeProxy.h.


Member Typedef Documentation

typedef set<CPPDeclaration *> CPPDeclaration::Instantiations [inherited]
 

Reimplemented in CPPInstance.

Definition at line 118 of file cppDeclaration.h.

typedef map<string, string> CPPType::PreferredNames [protected, inherited]
 

Definition at line 93 of file cppType.h.

typedef map<CPPDeclaration *, CPPDeclaration *> CPPDeclaration::SubstDecl [inherited]
 

Definition at line 113 of file cppDeclaration.h.

Referenced by CPPScope::is_fully_specified().

typedef vector<CPPTypedef *> CPPType::Typedefs [inherited]
 

Definition at line 51 of file cppType.h.

typedef set<CPPType *, CPPTypeCompare> CPPType::Types [protected, inherited]
 

Definition at line 90 of file cppType.h.


Member Enumeration Documentation

enum CPPDeclaration::SubType [inherited]
 

Enumeration values:
ST_instance 
ST_typedef 
ST_type_declaration 
ST_expression 
ST_type 
ST_namespace 
ST_using 
ST_simple 
ST_pointer 
ST_reference 
ST_array 
ST_const 
ST_function 
ST_function_group 
ST_extension 
ST_struct 
ST_enum 
ST_class_template_parameter 
ST_tbd 
ST_type_proxy 

Definition at line 71 of file cppDeclaration.h.

Referenced by CPPUsing::output(), CPPFunctionGroup::output(), CPPClassTemplateParameter::output(), and CPPFunctionType::output_instance().


Constructor & Destructor Documentation

CPPTypeProxy::CPPTypeProxy  ) 
 

Definition at line 34 of file cppTypeProxy.cxx.

References _actual_type, and NULL.


Member Function Documentation

CPPArrayType * CPPTypeProxy::as_array_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 354 of file cppTypeProxy.cxx.

References _actual_type, CPPDeclaration::as_tbd_type(), and NULL.

CPPClassTemplateParameter * CPPDeclaration::as_class_template_parameter  )  [virtual, inherited]
 

Reimplemented in CPPClassTemplateParameter.

Definition at line 219 of file cppDeclaration.cxx.

References NULL.

CPPConstType * CPPTypeProxy::as_const_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 369 of file cppTypeProxy.cxx.

CPPEnumType * CPPTypeProxy::as_enum_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 429 of file cppTypeProxy.cxx.

CPPExpression * CPPDeclaration::as_expression  )  [virtual, inherited]
 

Reimplemented in CPPExpression.

Definition at line 255 of file cppDeclaration.cxx.

References NULL.

CPPExtensionType * CPPTypeProxy::as_extension_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 399 of file cppTypeProxy.cxx.

CPPFunctionGroup * CPPDeclaration::as_function_group  )  [virtual, inherited]
 

Reimplemented in CPPFunctionGroup.

Definition at line 375 of file cppDeclaration.cxx.

CPPFunctionType * CPPTypeProxy::as_function_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 384 of file cppTypeProxy.cxx.

CPPInstance * CPPDeclaration::as_instance  )  [virtual, inherited]
 

Reimplemented in CPPInstance.

Definition at line 207 of file cppDeclaration.cxx.

References NULL.

Referenced by CPPExpression::CPPExpression(), and CPPTypedef::CPPTypedef().

CPPNamespace * CPPDeclaration::as_namespace  )  [virtual, inherited]
 

Reimplemented in CPPNamespace.

Definition at line 279 of file cppDeclaration.cxx.

References NULL.

CPPPointerType * CPPTypeProxy::as_pointer_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 324 of file cppTypeProxy.cxx.

References _actual_type, CPPDeclaration::as_struct_type(), and NULL.

CPPReferenceType * CPPTypeProxy::as_reference_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 339 of file cppTypeProxy.cxx.

References _actual_type, CPPDeclaration::as_enum_type(), and NULL.

CPPSimpleType * CPPTypeProxy::as_simple_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 309 of file cppTypeProxy.cxx.

References _actual_type.

CPPStructType * CPPTypeProxy::as_struct_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 414 of file cppTypeProxy.cxx.

CPPTBDType * CPPTypeProxy::as_tbd_type  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 444 of file cppTypeProxy.cxx.

CPPType * CPPTypeProxy::as_type  )  [virtual]
 

Reimplemented from CPPType.

Definition at line 294 of file cppTypeProxy.cxx.

References NULL.

CPPTypeDeclaration * CPPDeclaration::as_type_declaration  )  [virtual, inherited]
 

Reimplemented in CPPTypeDeclaration.

Definition at line 243 of file cppDeclaration.cxx.

References NULL.

CPPTypeProxy * CPPTypeProxy::as_type_proxy  )  [virtual]
 

Reimplemented from CPPDeclaration.

Definition at line 459 of file cppTypeProxy.cxx.

CPPTypedef * CPPDeclaration::as_typedef  )  [virtual, inherited]
 

Reimplemented in CPPTypedef.

Definition at line 231 of file cppDeclaration.cxx.

Referenced by CPPTypedef::CPPTypedef().

CPPUsing * CPPDeclaration::as_using  )  [virtual, inherited]
 

Reimplemented in CPPUsing.

Definition at line 291 of file cppDeclaration.cxx.

string CPPTypeProxy::get_fully_scoped_name  )  const [virtual]
 

Returns the compilable, correct name for the type, with completely explicit scoping.

Reimplemented from CPPType.

Definition at line 180 of file cppTypeProxy.cxx.

References _actual_type, NULL, and CPPType::output_instance().

string CPPTypeProxy::get_local_name CPPScope scope = NULL  )  const [virtual]
 

Returns the compilable, correct name for this type within the indicated scope.

If the scope is NULL, within the scope the type is declared in.

Reimplemented from CPPType.

Definition at line 162 of file cppTypeProxy.cxx.

References _actual_type, CPPType::is_incomplete(), and NULL.

string CPPTypeProxy::get_preferred_name  )  const [virtual]
 

Returns the best name to use for the type from a programmer's point of view.

This will typically be a typedef name if one is available, or the full C++ name if it is not. The typedef may or may not be visible within the current scope, so this type name may not be compilable.

Reimplemented from CPPType.

Definition at line 206 of file cppTypeProxy.cxx.

string CPPType::get_preferred_name_for const CPPType type  )  [static, inherited]
 

Returns the previously-stored "preferred" name associated with the type, if any, or empty string if no name is associated.

Definition at line 377 of file cppType.cxx.

Referenced by CPPType::get_simple_name().

string CPPTypeProxy::get_simple_name  )  const [virtual]
 

Returns a fundametal one-word name for the type.

This name will not include any scoping operators or template parameters, so it may not be a compilable reference to the type.

Reimplemented from CPPType.

Definition at line 142 of file cppTypeProxy.cxx.

CPPDeclaration::SubType CPPTypeProxy::get_subtype  )  const [virtual]
 

Implements CPPDeclaration.

Definition at line 282 of file cppTypeProxy.cxx.

CPPTemplateScope * CPPDeclaration::get_template_scope  )  const [inherited]
 

If is_template(), above, returns true, this returns the CPPTemplateScope in which this particular template declaration is defined.

This scope includes the information about the template parameters.

Definition at line 143 of file cppDeclaration.cxx.

References NULL, and CPPPreprocessor::warning().

string CPPTypeProxy::get_typedef_name CPPScope scope = NULL  )  const
 

Returns a string that can be used to name the type, if has_typedef_name() returned true.

This will be the first typedef name applied to the type.

Reimplemented from CPPType.

Definition at line 119 of file cppTypeProxy.cxx.

References _actual_type, CPPType::get_local_name(), and NULL.

bool CPPTypeProxy::has_typedef_name  )  const
 

Returns true if the type has even been typedef'ed and therefore has a simple name available to stand for it.

Extension types are all implicitly typedef'ed on declaration.

Reimplemented from CPPType.

Definition at line 99 of file cppTypeProxy.cxx.

References _actual_type, CPPType::get_simple_name(), and NULL.

CPPDeclaration * CPPDeclaration::instantiate const CPPTemplateParameterList actual_params,
CPPScope current_scope,
CPPScope global_scope,
CPPPreprocessor error_sink = NULL
const [virtual, inherited]
 

Reimplemented in CPPInstance, and CPPStructType.

Definition at line 174 of file cppDeclaration.cxx.

References NULL.

bool CPPDeclaration::is_equal const CPPDeclaration other  )  const [protected, virtual, inherited]
 

Called by CPPDeclaration to determine whether this type is equivalent to another type of the same type.

Reimplemented in CPPArrayType, CPPClassTemplateParameter, CPPConstType, CPPExpression, CPPFunctionType, CPPPointerType, CPPReferenceType, CPPSimpleType, CPPStructType, and CPPTBDType.

Definition at line 451 of file cppDeclaration.cxx.

Referenced by CPPType::get_fully_scoped_name(), and CPPDeclaration::~CPPDeclaration().

bool CPPType::is_equivalent const CPPType other  )  const [virtual, inherited]
 

This is a little more forgiving than is_equal(): it returns true if the types appear to be referring to the same thing, even if they may have different pointers or somewhat different definitions.

It's useful for parameter matching, etc.

Reimplemented in CPPArrayType, CPPConstType, CPPExtensionType, CPPPointerType, and CPPReferenceType.

Definition at line 239 of file cppType.cxx.

Referenced by CPPExtensionType::substitute_decl().

bool CPPDeclaration::is_fully_specified  )  const [virtual, inherited]
 

Returns true if this declaration is an actual, factual declaration, or false if some part of the declaration depends on a template parameter which has not yet been instantiated.

Reimplemented in CPPArrayType, CPPClassTemplateParameter, CPPConstType, CPPFunctionType, CPPInstance, CPPPointerType, CPPReferenceType, and CPPStructType.

Definition at line 162 of file cppDeclaration.cxx.

References NULL.

Referenced by CPPConstType::CPPConstType(), CPPPointerType::CPPPointerType(), CPPReferenceType::CPPReferenceType(), CPPInstance::instantiate(), and CPPFunctionType::operator=().

bool CPPTypeProxy::is_incomplete  )  const [virtual]
 

Returns true if the type has not yet been fully specified, false if it has.

Reimplemented from CPPType.

Definition at line 224 of file cppTypeProxy.cxx.

References _actual_type, and NULL.

bool CPPDeclaration::is_less const CPPDeclaration other  )  const [protected, virtual, inherited]
 

Called by CPPDeclaration to determine whether this type should be ordered before another type of the same type, in an arbitrary but fixed ordering.

Reimplemented in CPPArrayType, CPPClassTemplateParameter, CPPConstType, CPPExpression, CPPFunctionType, CPPPointerType, CPPReferenceType, CPPSimpleType, CPPStructType, and CPPTBDType.

Definition at line 468 of file cppDeclaration.cxx.

bool CPPTypeProxy::is_tbd  )  const [virtual]
 

Returns true if the type, or any nested type within the type, is a CPPTBDType and thus isn't fully determined right now.

In this case, calling resolve_type() may or may not resolve the type.

Reimplemented from CPPType.

Definition at line 77 of file cppTypeProxy.cxx.

References _actual_type, and NULL.

bool CPPDeclaration::is_template  )  const [inherited]
 

Returns true if this is a template declaration of some kind: a template function or a template class, typically.

Definition at line 124 of file cppDeclaration.cxx.

Referenced by InterrogateBuilder::remap_indices(), and InterrogateBuilder::scan_function().

CPPType * CPPType::new_type CPPType type  )  [static, inherited]
 

This should be called whenever a new CPPType object is created.

It will uniquify the type pointers by checking to see if some equivalent CPPType object has previously been created; if it has, it returns the old object and deletes the new one. Otherwise, it stores the new one and returns it.

Definition at line 321 of file cppType.cxx.

Referenced by CPPInstanceIdentifier::add_array_modifier(), CPPEnumType::CPPEnumType(), InterrogateBuilder::get_getter(), CPPInstance::get_local_name(), CPPInstance::get_simple_name(), CPPArrayType::is_fully_specified(), CPPPreprocessor::should_ignore_manifest(), and TypeManager::unwrap_const_reference().

bool CPPDeclaration::operator!= const CPPDeclaration other  )  const [inherited]
 

Definition at line 92 of file cppDeclaration.cxx.

bool CPPDeclaration::operator< const CPPDeclaration other  )  const [inherited]
 

Definition at line 104 of file cppDeclaration.cxx.

References CPPDeclaration::_template_scope, and NULL.

bool CPPDeclaration::operator== const CPPDeclaration other  )  const [inherited]
 

Definition at line 77 of file cppDeclaration.cxx.

void CPPTypeProxy::output ostream &  out,
int  indent_level,
CPPScope scope,
bool  complete
const [virtual]
 

Implements CPPDeclaration.

Definition at line 265 of file cppTypeProxy.cxx.

References _actual_type, CPPDeclaration::as_reference_type(), and NULL.

void CPPType::output_instance ostream &  out,
const string &  name,
CPPScope scope
const [inherited]
 

Formats a C++-looking line that defines an instance of the given type, with the indicated name.

In most cases this will be "type name", but some types have special exceptions.

Definition at line 262 of file cppType.cxx.

References CPPType::_preferred_names, and CPPType::get_fully_scoped_name().

Referenced by get_fully_scoped_name(), CPPReferenceType::is_equivalent(), CPPPointerType::output(), CPPFunctionType::output(), FunctionWriterPtrToPython::write_prototype(), FunctionWriterPtrFromPython::write_prototype(), FunctionWriterPtrFromPython::~FunctionWriterPtrFromPython(), and FunctionWriterPtrToPython::~FunctionWriterPtrToPython().

void CPPTypeProxy::output_instance ostream &  out,
int  indent_level,
CPPScope scope,
bool  complete,
const string &  prename,
const string &  name
const [virtual]
 

Formats a C++-looking line that defines an instance of the given type, with the indicated name.

In most cases this will be "type name", but some types have special exceptions.

Reimplemented from CPPType.

Definition at line 246 of file cppTypeProxy.cxx.

References _actual_type, CPPDeclaration::as_pointer_type(), and NULL.

void CPPType::record_preferred_name_for const CPPType type,
const string &  name
[static, inherited]
 

Records a global typedef name associated with the indicated Type.

This will be taken as the "preferred" name for this class, should anyone ask.

Definition at line 355 of file cppType.cxx.

CPPType * CPPTypeProxy::resolve_type CPPScope current_scope,
CPPScope global_scope
[virtual]
 

If this CPPType object is a forward reference or other nonspecified reference to a type that might now be known a real type, returns the real type.

Otherwise returns the type itself.

Reimplemented from CPPType.

Definition at line 55 of file cppTypeProxy.cxx.

References _actual_type, CPPType::is_tbd(), and NULL.

CPPDeclaration * CPPDeclaration::substitute_decl SubstDecl subst,
CPPScope current_scope,
CPPScope global_scope
[virtual, inherited]
 

Definition at line 191 of file cppDeclaration.cxx.

Referenced by CPPReferenceType::is_fully_specified(), CPPPointerType::is_fully_specified(), CPPConstType::is_fully_specified(), CPPArrayType::is_tbd(), and CPPScope::write().


Member Data Documentation

CPPType* CPPTypeProxy::_actual_type
 

Definition at line 84 of file cppTypeProxy.h.

Referenced by as_array_type(), as_pointer_type(), as_reference_type(), as_simple_type(), CPPTypeProxy(), get_fully_scoped_name(), get_local_name(), get_typedef_name(), has_typedef_name(), is_incomplete(), is_tbd(), output(), output_instance(), and resolve_type().

CPPTypeDeclaration* CPPType::_declaration [inherited]
 

Definition at line 87 of file cppType.h.

Referenced by TypeManager::is_pointer_to_base().

CPPFile CPPDeclaration::_file [inherited]
 

Definition at line 149 of file cppDeclaration.h.

Referenced by InterrogateBuilder::remap_indices(), InterrogateBuilder::scan_function(), and CPPScope::write().

Instantiations CPPDeclaration::_instantiations [inherited]
 

Reimplemented in CPPInstance.

Definition at line 119 of file cppDeclaration.h.

CPPCommentBlock* CPPDeclaration::_leading_comment [inherited]
 

Definition at line 150 of file cppDeclaration.h.

Referenced by CPPDeclaration::CPPDeclaration(), and CPPScope::set_current_vis().

CPPType::PreferredNames CPPType::_preferred_names [static, protected, inherited]
 

Definition at line 27 of file cppType.cxx.

Referenced by CPPType::output_instance().

CPPTemplateScope* CPPDeclaration::_template_scope [inherited]
 

Definition at line 148 of file cppDeclaration.h.

Referenced by CPPTemplateScope::add_declaration(), CPPTemplateScope::add_enum_value(), CPPTemplateScope::CPPTemplateScope(), and CPPDeclaration::operator<().

Typedefs CPPType::_typedefs [inherited]
 

Definition at line 52 of file cppType.h.

Referenced by CPPType::is_tbd().

CPPType::Types CPPType::_types [static, protected, inherited]
 

Definition at line 26 of file cppType.cxx.

CPPVisibility CPPDeclaration::_vis [inherited]
 

Definition at line 147 of file cppDeclaration.h.

Referenced by CPPScope::get_local_name(), TypeManager::is_pointer_to_base(), InterrogateBuilder::remap_indices(), InterrogateBuilder::scan_function(), and TypeManager::wrap_const_reference().


The documentation for this class was generated from the following files:
Generated on Thu May 1 22:13:31 2003 for DTool by doxygen1.3