pygccxml.declarations.free_calldef module¶

class free_calldef_t(*args, **keywords)¶

Bases: pygccxml.declarations.calldef.calldef_t

base class for “callable” declarations that defined within C++ namespace

argument_types¶: list of all argument types

arguments¶: The argument list. @type: list of argument_t

attributes¶

GCCXML attributes, set using __attribute__((gccxml(“…”)))

@type: str

cache¶

Implementation detail.

Reference to instance of algorithms_cache_t class.

calling_convention¶: function calling convention. See :class:CALLING_CONVENTION_TYPES class for possible values

create_decl_string(with_defaults=True)¶

decl_string¶: Declaration full name.

decorated_name¶: Unique declaration name extracted from a binary file ( .map, .dll, .so, etc ).

@type: str

demangled¶

Declaration name, reconstructed from GCCXML generated unique name.

@type: str

demangled_name¶: returns function demangled name. It can help you to deal with function template instantiations

does_throw¶: If False, than function does not throw any exception. In this case, function was declared with empty throw statement.

exceptions¶: The list of exceptions. @type: list of declaration_t

function_type()¶: returns function type. See type_t hierarchy

get_mangled_name()¶

guess_calling_convention()¶: This function should be overriden in the derived classes and return more-or-less successfull guess about calling convention

has_ellipsis¶

has_extern¶: Was this callable declared as “extern”? @type: bool

has_inline¶: Was this callable declared with “inline” specifier @type: bool

i_depend_on_them(recursive=True)¶: Return list of all types and declarations the declaration depends on

is_artificial¶

Describes whether declaration is compiler generated or not

@type: bool

location¶

Location of the declaration within source file

@type: location_t

mangled¶

Unique declaration name generated by the compiler.

Returns:	the mangled name
Return type:	str

name¶: Declaration name @type: str

optional_args¶: list of all optional arguments, the arguments that have default value

overloads¶

A list of overloaded “callables” (i.e. other callables with the same name within the same scope.

@type: list of calldef_t

parent¶

Reference to parent declaration.

@type: declaration_t

partial_decl_string¶: Declaration full name.

partial_name¶

Declaration name, without template default arguments.

Right now std containers is the only classes that support this functionality.

required_args¶: list of all required arguments

return_type¶: The type of the return value of the “callable” or None (constructors). @type: type_t

top_parent¶

Reference to top parent declaration.

@type: declaration_t

class free_function_t(*args, **keywords)¶

Bases: pygccxml.declarations.free_calldef.free_calldef_t

describes free function declaration

argument_types¶: list of all argument types

arguments¶: The argument list. @type: list of argument_t

attributes¶

GCCXML attributes, set using __attribute__((gccxml(“…”)))

@type: str

cache¶

Implementation detail.

Reference to instance of algorithms_cache_t class.

calling_convention¶: function calling convention. See :class:CALLING_CONVENTION_TYPES class for possible values

create_decl_string(with_defaults=True)¶

decl_string¶: Declaration full name.

decorated_name¶: Unique declaration name extracted from a binary file ( .map, .dll, .so, etc ).

@type: str

demangled¶

Declaration name, reconstructed from GCCXML generated unique name.

@type: str

demangled_name¶: returns function demangled name. It can help you to deal with function template instantiations

does_throw¶: If False, than function does not throw any exception. In this case, function was declared with empty throw statement.

exceptions¶: The list of exceptions. @type: list of declaration_t

function_type()¶: returns function type. See type_t hierarchy

get_mangled_name()¶

guess_calling_convention()¶: This function should be overriden in the derived classes and return more-or-less successfull guess about calling convention

has_ellipsis¶

has_extern¶: Was this callable declared as “extern”? @type: bool

has_inline¶: Was this callable declared with “inline” specifier @type: bool

i_depend_on_them(recursive=True)¶: Return list of all types and declarations the declaration depends on

is_artificial¶

Describes whether declaration is compiler generated or not

@type: bool

location¶

Location of the declaration within source file

@type: location_t

mangled¶

Unique declaration name generated by the compiler.

Returns:	the mangled name
Return type:	str

name¶: Declaration name @type: str

optional_args¶: list of all optional arguments, the arguments that have default value

overloads¶

A list of overloaded “callables” (i.e. other callables with the same name within the same scope.

@type: list of calldef_t

parent¶

Reference to parent declaration.

@type: declaration_t

partial_decl_string¶: Declaration full name.

partial_name¶

Declaration name, without template default arguments.

Right now std containers is the only classes that support this functionality.

required_args¶: list of all required arguments

return_type¶: The type of the return value of the “callable” or None (constructors). @type: type_t

top_parent¶

Reference to top parent declaration.

@type: declaration_t

class free_operator_t(*args, **keywords)¶

Bases: pygccxml.declarations.free_calldef.free_calldef_t, pygccxml.declarations.calldef_members.operator_t

describes free operator declaration

OPERATOR_WORD_LEN = 8¶

argument_types¶: list of all argument types

arguments¶: The argument list. @type: list of argument_t

attributes¶

GCCXML attributes, set using __attribute__((gccxml(“…”)))

@type: str

cache¶

Implementation detail.

Reference to instance of algorithms_cache_t class.

calling_convention¶: function calling convention. See :class:CALLING_CONVENTION_TYPES class for possible values

class_types¶: list of class/class declaration types, extracted from the operator arguments

create_decl_string(with_defaults=True)¶

decl_string¶: Declaration full name.

decorated_name¶: Unique declaration name extracted from a binary file ( .map, .dll, .so, etc ).

@type: str

demangled¶

Declaration name, reconstructed from GCCXML generated unique name.

@type: str

demangled_name¶: returns function demangled name. It can help you to deal with function template instantiations

does_throw¶: If False, than function does not throw any exception. In this case, function was declared with empty throw statement.

exceptions¶: The list of exceptions. @type: list of declaration_t

function_type()¶: returns function type. See type_t hierarchy

get_mangled_name()¶

guess_calling_convention()¶: This function should be overriden in the derived classes and return more-or-less successfull guess about calling convention

has_ellipsis¶

has_extern¶: Was this callable declared as “extern”? @type: bool

has_inline¶: Was this callable declared with “inline” specifier @type: bool

i_depend_on_them(recursive=True)¶: Return list of all types and declarations the declaration depends on

is_artificial¶

Describes whether declaration is compiler generated or not

@type: bool

location¶

Location of the declaration within source file

@type: location_t

mangled¶

Unique declaration name generated by the compiler.

Returns:	the mangled name
Return type:	str

name¶: Declaration name @type: str

optional_args¶: list of all optional arguments, the arguments that have default value

overloads¶

A list of overloaded “callables” (i.e. other callables with the same name within the same scope.

@type: list of calldef_t

parent¶

Reference to parent declaration.

@type: declaration_t

partial_decl_string¶: Declaration full name.

partial_name¶

Declaration name, without template default arguments.

Right now std containers is the only classes that support this functionality.

required_args¶: list of all required arguments

return_type¶: The type of the return value of the “callable” or None (constructors). @type: type_t

symbol¶: operator’s symbol. For example – operator+, symbol is equal to ‘+’

top_parent¶

Reference to top parent declaration.

@type: declaration_t