pygccxml.declarations.calldef_members module

class casting_operator_t(*args, **keywords)

Bases: pygccxml.declarations.calldef_members.member_calldef_t, pygccxml.declarations.calldef_members.operator_t

describes casting operator declaration

OPERATOR_WORD_LEN = 8
access_type

Return the access type of the member (as defined by the string constants in the class :class:ACCESS_TYPES. @type: str

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.

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_const

describes, whether “callable” has const modifier or not

has_ellipsis
has_extern

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

has_inline

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

has_static

describes, whether “callable” has static modifier or not

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

virtuality

Describes the “virtuality” of the member (as defined by the string constants in the class :class:VIRTUALITY_TYPES). @type: str

class constructor_t(*args, **keywords)

Bases: pygccxml.declarations.calldef_members.member_calldef_t

describes constructor declaration

access_type

Return the access type of the member (as defined by the string constants in the class :class:ACCESS_TYPES. @type: str

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.

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

explicit

True, if constructor has “explicit” keyword, False otherwise @type: bool

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_const

describes, whether “callable” has const modifier or not

has_ellipsis
has_extern

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

has_inline

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

has_static

describes, whether “callable” has static modifier or not

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

virtuality

Describes the “virtuality” of the member (as defined by the string constants in the class :class:VIRTUALITY_TYPES). @type: str

class destructor_t(*args, **keywords)

Bases: pygccxml.declarations.calldef_members.member_calldef_t

describes deconstructor declaration

access_type

Return the access type of the member (as defined by the string constants in the class :class:ACCESS_TYPES. @type: str

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.

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_const

describes, whether “callable” has const modifier or not

has_ellipsis
has_extern

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

has_inline

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

has_static

describes, whether “callable” has static modifier or not

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

virtuality

Describes the “virtuality” of the member (as defined by the string constants in the class :class:VIRTUALITY_TYPES). @type: str

class member_calldef_t(virtuality=None, has_const=None, has_static=None, *args, **keywords)

Bases: pygccxml.declarations.calldef.calldef_t

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

access_type

Return the access type of the member (as defined by the string constants in the class :class:ACCESS_TYPES. @type: str

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.

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_const

describes, whether “callable” has const modifier or not

has_ellipsis
has_extern

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

has_inline

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

has_static

describes, whether “callable” has static modifier or not

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

virtuality

Describes the “virtuality” of the member (as defined by the string constants in the class :class:VIRTUALITY_TYPES). @type: str

class member_function_t(*args, **keywords)

Bases: pygccxml.declarations.calldef_members.member_calldef_t

describes member function declaration

access_type

Return the access type of the member (as defined by the string constants in the class :class:ACCESS_TYPES. @type: str

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.

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_const

describes, whether “callable” has const modifier or not

has_ellipsis
has_extern

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

has_inline

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

has_static

describes, whether “callable” has static modifier or not

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

virtuality

Describes the “virtuality” of the member (as defined by the string constants in the class :class:VIRTUALITY_TYPES). @type: str

class member_operator_t(*args, **keywords)

Bases: pygccxml.declarations.calldef_members.member_calldef_t, pygccxml.declarations.calldef_members.operator_t

describes member operator declaration

OPERATOR_WORD_LEN = 8
access_type

Return the access type of the member (as defined by the string constants in the class :class:ACCESS_TYPES. @type: str

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.

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_const

describes, whether “callable” has const modifier or not

has_ellipsis
has_extern

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

has_inline

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

has_static

describes, whether “callable” has static modifier or not

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

virtuality

Describes the “virtuality” of the member (as defined by the string constants in the class :class:VIRTUALITY_TYPES). @type: str

class operator_t(*args, **keywords)

Bases: pygccxml.declarations.calldef.calldef_t

Base class for “operator” declarations.

Operators are constructs which behave like functions. Therefore, operator_t has calldef_t as parent class.

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

create_decl_string(with_defaults=True)
decl_string

Declaration full name.

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

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