Package pygccxml :: Package declarations :: Module namespace :: Class namespace_t

type namespace_t

source code

               object --+        
                        |        
declaration.declaration_t --+    
                            |    
          scopedef.scopedef_t --+
                                |
                               namespace_t
Known Subclasses:

describes C++ namespace

Nested Classes

Inherited from scopedef.scopedef_t: declaration_not_found_t, multiple_declarations_found_t

Instance Methods
 
__init__(self, name='', declarations=None)
creates class that describes C++ namespace declaration
source code
 
__str__(self)
Default __str__ method.
source code
 
take_parenting(self, inst)
Takes parenting from inst and transfers it to self
source code
 
adopt_declaration(self, decl) source code
 
remove_declaration(self, decl)
removes decl from members list
source code
 
namespace(self, name=None, function=None, recursive=None)
returns reference to namespace declaration, that is matched defined criterias
source code
 
ns(self, name=None, function=None, recursive=None)
returns reference to namespace declaration, that is matched defined criterias
source code
 
namespaces(self, name=None, function=None, recursive=None, allow_empty=None)
returns a set of namespace declarations, that are matched defined criterias
source code
 
nss(self, name=None, function=None, recursive=None, allow_empty=None)
returns a set of namespace declarations, that are matched defined criterias
source code
 
free_function(self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None)
returns reference to free function declaration, that is matched defined criterias
source code
 
free_fun(self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None)
returns reference to free function declaration, that is matched defined criterias
source code
 
free_functions(self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None, allow_empty=None)
returns a set of free function declarations, that are matched defined criterias
source code
 
free_funs(self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None, allow_empty=None)
returns a set of free function declarations, that are matched defined criterias
source code
 
free_operator(self, name=None, function=None, symbol=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None)
returns reference to free operator declaration, that is matched defined criterias
source code
 
free_operators(self, name=None, function=None, symbol=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None, allow_empty=None)
returns a set of free operator declarations, that are matched defined criterias
source code
 
i_depend_on_them(self, recursive=True)
return list of all types and declarations the declaration depends on
source code

Inherited from scopedef.scopedef_t: __eq__, __getitem__, calldef, calldefs, casting_operator, casting_operators, class_, classes, clear_optimizer, constructor, constructors, decl, decls, enum, enumeration, enumerations, enums, init_optimizer, mem_fun, mem_funs, mem_oper, mem_opers, member_function, member_functions, member_operator, member_operators, operator, operators, typedef, typedefs, var, variable, variables, vars

Inherited from declaration.declaration_t: __lt__, __ne__, create_decl_string

Class Variables

Inherited from scopedef.scopedef_t: ALLOW_EMPTY_MDECL_WRAPPER, RECURSIVE_DEFAULT

Properties
  declarations
list of all declarations, defined in the namespace

Inherited from declaration.declaration_t: attributes, cache, compiler, decl_string, demangled, is_artificial, location, mangled, name, parent, partial_decl_string, partial_name, top_parent

Method Details

__init__(self, name='', declarations=None)
(Constructor)

source code 

creates class that describes C++ namespace declaration

Overrides: declaration.declaration_t.__init__

__str__(self)
(Informal representation operator)

source code 

Default __str__ method.

This version just returns the decl_string and the class. Derived classes may override this method to provide more detailed information.

A __str__ method for a declaration should always provide enough information so that it uniquely identifies the declaration and the user is able to find the declaration in his source code.

Overrides: declaration.declaration_t.__str__
(inherited documentation)

remove_declaration(self, decl)

source code 

removes decl from members list

Parameters:
Overrides: scopedef.scopedef_t.remove_declaration

i_depend_on_them(self, recursive=True)

source code 

return list of all types and declarations the declaration depends on

Overrides: declaration.declaration_t.i_depend_on_them
(inherited documentation)

Property Details

declarations

list of all declarations, defined in the namespace

Set Method:
_set_declarations(self, declarations)