/usr/share/pyshared/pygccxml/declarations/calldef.py is in python-pygccxml 1.0.0-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 | # Copyright 2004-2008 Roman Yakovenko.
# Distributed under the Boost Software License, Version 1.0. (See
# accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)
"""
defines classes, that describes "callable" declarations
This modules contains definition for next C++ declarations:
- operator
- member
- free
- function
- member
- free
- constructor
- destructor
"""
import cpptypes
import algorithm
import declaration
import type_traits
import dependencies
import call_invocation
class VIRTUALITY_TYPES:
"""class that defines "virtuality" constants"""
NOT_VIRTUAL = 'not virtual'
VIRTUAL = 'virtual'
PURE_VIRTUAL = 'pure virtual'
ALL = [NOT_VIRTUAL, VIRTUAL, PURE_VIRTUAL]
#preserving backward compatebility
FUNCTION_VIRTUALITY_TYPES = VIRTUALITY_TYPES
#First level in hierarchy of calldef
class argument_t(object):
"""
class, that describes argument of "callable" declaration
"""
def __init__( self, name='', type=None, default_value=None, attributes=None):
object.__init__(self)
self._name = name
self._default_value = default_value
self._type = type
self._attributes = attributes
def clone( self, **keywd ):
"""constructs new argument_t instance
return argument_t( name=keywd.get( 'name', self.name )
, type=keywd.get( 'type', self.type )
, default_value=keywd.get( 'default_value', self.default_value )
, attributes=keywd.get( 'attributes', self.attributes ) )
"""
return argument_t( name=keywd.get( 'name', self.name )
, type=keywd.get( 'type', self.type )
, default_value=keywd.get( 'default_value', self.default_value )
, attributes=keywd.get( 'attributes', self.attributes ) )
def __str__(self):
if self.ellipsis:
return "..."
else:
if self.default_value==None:
return "%s %s"%(self.type, self.name)
else:
return "%s %s=%s"%(self.type, self.name, self.default_value)
def __eq__(self, other):
if not isinstance( other, self.__class__ ):
return False
return self.name == other.name \
and self.default_value == other.default_value \
and self.type == other.type
def __ne__( self, other):
return not self.__eq__( other )
def __lt__(self, other):
if not isinstance( other, self.__class__ ):
return self.__class__.__name__ < other.__class__.__name__
return self.name < other.name \
and self.default_value < other.default_value \
and self.type < other.type
def _get_name(self):
return self._name
def _set_name(self, name):
self._name = name
name = property( _get_name, _set_name
, doc="""Argument name.
@type: str""" )
@property
def ellipsis(self):
"""bool, if True argument represents ellipsis ( "..." ) in function definition"""
return isinstance( self.type, cpptypes.ellipsis_t )
def _get_default_value(self):
return self._default_value
def _set_default_value(self, default_value):
self._default_value = default_value
default_value = property( _get_default_value, _set_default_value
, doc="""Argument's default value or None.
@type: str""")
def _get_type(self):
return self._type
def _set_type(self, type):
self._type = type
type = property( _get_type, _set_type
, doc="""The type of the argument.
@type: L{type_t}""")
def _get_attributes( self ):
return self._attributes
def _set_attributes( self, attributes ):
self._attributes = attributes
attributes = property( _get_attributes, _set_attributes
, doc="""GCCXML attributes, set using __attribute__((gccxml("...")))
@type: str
""" )
class calldef_t( declaration.declaration_t ):
"""base class for all "callable" declarations"""
def __init__( self, name='', arguments=None, exceptions=None, return_type=None, has_extern=False, does_throw=True ):
declaration.declaration_t.__init__( self, name )
if not arguments:
arguments = []
self._arguments = arguments
if not exceptions:
exceptions = []
self._does_throw = does_throw
self._exceptions = exceptions
self._return_type = return_type
self._has_extern = has_extern
self._demangled_name = None
def _get__cmp__call_items(self):
"""implementation details"""
raise NotImplementedError()
def _get__cmp__items( self ):
"""implementation details"""
items = [ self.arguments
, self.return_type
, self.has_extern
, self.does_throw
, self._sorted_list( self.exceptions ) ]
items.extend( self._get__cmp__call_items() )
return items
def __eq__(self, other):
if not declaration.declaration_t.__eq__( self, other ):
return False
return self.return_type == other.return_type \
and self.arguments == other.arguments \
and self.has_extern == other.has_extern \
and self.does_throw == other.does_throw \
and self._sorted_list( self.exceptions ) \
== other._sorted_list( other.exceptions )
def _get_arguments(self):
return self._arguments
def _set_arguments(self, arguments):
self._arguments = arguments
arguments = property( _get_arguments , _set_arguments
, doc="""The argument list.
@type: list of L{argument_t}""")
@property
def has_ellipsis( self ):
return self.arguments and self.arguments[-1].ellipsis
@property
def argument_types( self ):
"""list of all argument types"""
return [ arg.type for arg in self.arguments ]
@property
def required_args(self):
"""list of all required arguments"""
r_args = []
for arg in self.arguments:
if not arg.default_value:
r_args.append( arg )
else:
break
return r_args
@property
def optional_args(self):
"""list of all optional arguments, the arguments that have default value"""
return self.arguments[ len( self.required_args ) : ]
def _get_does_throw(self):
return self._does_throw
def _set_does_throw(self, does_throw):
self._does_throw = does_throw
does_throw = property( _get_does_throw, _set_does_throw,
doc="""If False, than function does not throw any exception.
In this case, function was declared with empty throw
statement.
""")
def _get_exceptions(self):
return self._exceptions
def _set_exceptions(self, exceptions):
self._exceptions = exceptions
exceptions = property( _get_exceptions, _set_exceptions
, doc="""The list of exceptions.
@type: list of L{declaration_t}""")
def _get_return_type(self):
return self._return_type
def _set_return_type(self, return_type):
self._return_type = return_type
return_type = property( _get_return_type, _set_return_type
, doc='''The type of the return value of the "callable" or None (constructors).
@type: L{type_t}
''')
@property
def overloads(self):
"""A list of overloaded "callables" (i.e. other callables with the same name within the same scope.
@type: list of L{calldef_t}
"""
if not self.parent:
return []
# finding all functions with the same name
return self.parent.calldefs( name=self.name
, function=lambda decl: not (decl is self )
, allow_empty=True
, recursive=False )
def _get_has_extern(self):
return self._has_extern
def _set_has_extern(self, has_extern):
self._has_extern = has_extern
has_extern = property( _get_has_extern, _set_has_extern,
doc="""Was this callable declared as "extern"?
@type: bool
""")
def __remove_parent_fname( self, demangled ):
"""implementation details"""
demangled = demangled.strip()
parent_fname = algorithm.full_name( self.parent )
if parent_fname.startswith( '::' ) and not demangled.startswith( '::' ):
parent_fname = parent_fname[2:]
demangled = demangled[ len( parent_fname ): ]
return demangled
def _get_demangled_name( self ):
if not self.demangled:
self._demangled_name = ''
if self._demangled_name:
return self._demangled_name
if self._demangled_name == '':
return self.name
demangled = self.demangled
if self.return_type:
return_type = type_traits.remove_alias( self.return_type ).decl_string
if return_type.startswith( '::' ) and not self.demangled.startswith( '::' ):
return_type = return_type[2:]
demangled = self.demangled
if demangled.startswith( return_type ):
demangled = demangled[ len( return_type ): ]
demangled = demangled.strip()
#removing scope
demangled_name = call_invocation.name( self.__remove_parent_fname( demangled ) )
if demangled_name.startswith( '::' ):
demangled_name = demangled_name[2:]
#to be on the safe side
if demangled_name.startswith( self.name ):
self._demangled_name = demangled_name
return self._demangled_name
#well, I am going to try an other strategy
fname = algorithm.full_name( self )
found = self.demangled.find( fname )
if -1 == found:
if fname.startswith( '::' ):
fname = fname[2:]
found = self.demangled.find( fname )
if -1 == found:
self._demangled_name = ''
return self.name
demangled_name = call_invocation.name( self.demangled[ found: ] )
demangled_name = self.__remove_parent_fname( demangled_name )
if demangled_name.startswith( '::' ):
demangled_name = demangled_name[2:]
#to be on the safe side
if demangled_name.startswith( self.name ):
self._demangled_name = demangled_name
return self._demangled_name
#if -1 == found:
self._demangled_name = ''
return self.name
demangled_name = property( _get_demangled_name
, doc="returns function demangled name. It can help you to deal with function template instantiations")
def i_depend_on_them( self, recursive=True ):
report_dependency = lambda *args, **keywd: dependencies.dependency_info_t( self, *args, **keywd )
answer = []
if self.return_type:
answer.append( report_dependency( self.return_type, hint="return type" ) )
map( lambda arg: answer.append( report_dependency( arg.type ) )
, self.arguments )
map( lambda exception: answer.append( report_dependency( exception, hint="exception" ) )
, self.exceptions )
return answer
#Second level in hierarchy of calldef
class member_calldef_t( calldef_t ):
"""base class for "callable" declarations that defined within C++ class or struct"""
def __init__( self, virtuality=None, has_const=None, has_static=None, *args, **keywords ):
calldef_t.__init__( self, *args, **keywords )
self._virtuality = virtuality
self._has_const = has_const
self._has_static = has_static
def __str__(self):
# Get the full name of the calldef...
name = algorithm.full_name(self)
if name[:2]=="::":
name = name[2:]
# Add the arguments...
args = map(lambda a: str(a), self.arguments)
res = "%s(%s)"%(name, ", ".join(args))
# Add the return type...
if self.return_type!=None:
res = "%s %s"%(self.return_type, res)
# const?
if self.has_const:
res += " const"
# static?
if self.has_static:
res = "static "+res
# Append the declaration class
cls = self.__class__.__name__
if cls[-2:]=="_t":
cls = cls[:-2]
cls = cls.replace( '_', ' ' )
return "%s [%s]"%(res, cls)
def _get__cmp__call_items(self):
"""implementation details"""
return [ self.virtuality, self.has_static, self.has_const ]
def __eq__(self, other):
if not calldef_t.__eq__( self, other ):
return False
return self.virtuality == other.virtuality \
and self.has_static == other.has_static \
and self.has_const == other.has_const
def get_virtuality(self):
return self._virtuality
def set_virtuality(self, virtuality):
assert virtuality in VIRTUALITY_TYPES.ALL
self._virtuality = virtuality
virtuality = property( get_virtuality, set_virtuality
, doc="""Describes the "virtuality" of the member (as defined by the string constants in the class L{VIRTUALITY_TYPES}).
@type: str""")
def _get_access_type(self):
return self.parent.find_out_member_access_type( self )
access_type = property( _get_access_type
, doc="""Return the access type of the member (as defined by the string constants in the class L{ACCESS_TYPES}.
@type: str""")
def _get_has_const(self):
return self._has_const
def _set_has_const(self, has_const):
self._has_const = has_const
has_const = property( _get_has_const, _set_has_const
, doc="""describes, whether "callable" has const modifier or not""")
def _get_has_static(self):
return self._has_static
def _set_has_static(self, has_static):
self._has_static = has_static
has_static = property( _get_has_static, _set_has_static
, doc="""describes, whether "callable" has static modifier or not""")
def function_type(self):
"""returns function type. See L{type_t} hierarchy"""
if self.has_static:
return cpptypes.free_function_type_t( return_type=self.return_type
, arguments_types=[ arg.type for arg in self.arguments ] )
else:
return cpptypes.member_function_type_t( class_inst=self.parent
, return_type=self.return_type
, arguments_types=[ arg.type for arg in self.arguments ]
, has_const=self.has_const )
def create_decl_string(self, with_defaults=True):
f_type = self.function_type()
if with_defaults:
return f_type.decl_string
else:
return f_type.partial_decl_string
class free_calldef_t( calldef_t ):
"""base class for "callable" declarations that defined within C++ namespace"""
def __init__( self, *args, **keywords ):
calldef_t.__init__( self, *args, **keywords )
def __str__(self):
# Get the full name of the calldef...
name = algorithm.full_name(self)
if name[:2]=="::":
name = name[2:]
# Add the arguments...
args = map(lambda a: str(a), self.arguments)
res = "%s(%s)"%(name, ", ".join(args))
# Add the return type...
if self.return_type!=None:
res = "%s %s"%(self.return_type, res)
# extern?
if self.has_extern:
res = "extern "+res
# Append the declaration class
cls = self.__class__.__name__
if cls[-2:]=="_t":
cls = cls[:-2]
cls = cls.replace( '_', ' ' )
return "%s [%s]"%(res, cls)
def _get__cmp__call_items(self):
"""implementation details"""
return []
def function_type(self):
"""returns function type. See L{type_t} hierarchy"""
return cpptypes.free_function_type_t( return_type=self.return_type
, arguments_types=[ arg.type for arg in self.arguments ] )
def create_decl_string(self, with_defaults=True):
f_type = self.function_type()
if with_defaults:
return f_type.decl_string
else:
return f_type.partial_decl_string
class operator_t(object):
"""base class for "operator" declarations"""
OPERATOR_WORD_LEN = len( 'operator' )
def __init__(self):
object.__init__(self)
@property
def symbol(self):
"operator's symbol. For example: operator+, symbol is equal to '+'"
return self.name[operator_t.OPERATOR_WORD_LEN:].strip()
#Third level in hierarchy of calldef
class member_function_t( member_calldef_t ):
"""describes member function declaration"""
def __init__( self, *args, **keywords ):
member_calldef_t.__init__( self, *args, **keywords )
class constructor_t( member_calldef_t ):
"""describes constructor declaration"""
def __init__( self, *args, **keywords ):
member_calldef_t.__init__( self, *args, **keywords )
def __str__(self):
# Get the full name of the calldef...
name = algorithm.full_name(self)
if name[:2]=="::":
name = name[2:]
# Add the arguments...
args = map(lambda a: str(a), self.arguments)
res = "%s(%s)"%(name, ", ".join(args))
# Append the declaration class
cls = 'constructor'
if self.is_copy_constructor:
cls = 'copy ' + cls
return "%s [%s]"%(res, cls)
@property
def is_copy_constructor(self):
"""returns True if described declaration is copy constructor, otherwise False"""
args = self.arguments
if 1 != len( args ):
return False
arg = args[0]
if not type_traits.is_reference( arg.type ):
return False
if not type_traits.is_const( arg.type.base ):
return False
unaliased = type_traits.remove_alias( arg.type.base )
#unaliased now refers to const_t instance
if not isinstance( unaliased.base, cpptypes.declarated_t ):
return False
return id(unaliased.base.declaration) == id(self.parent)
@property
def is_trivial_constructor(self):
return not bool( self.arguments )
class destructor_t( member_calldef_t ):
"""describes deconstructor declaration"""
def __init__( self, *args, **keywords ):
member_calldef_t.__init__( self, *args, **keywords )
class member_operator_t( member_calldef_t, operator_t ):
"""describes member operator declaration"""
def __init__( self, *args, **keywords ):
member_calldef_t.__init__( self, *args, **keywords )
operator_t.__init__( self, *args, **keywords )
self.__class_types = None
class casting_operator_t( member_calldef_t, operator_t ):
"""describes casting operator declaration"""
def __init__( self, *args, **keywords ):
member_calldef_t.__init__( self, *args, **keywords )
operator_t.__init__( self, *args, **keywords )
class free_function_t( free_calldef_t ):
"""describes free function declaration"""
def __init__( self, *args, **keywords ):
free_calldef_t.__init__( self, *args, **keywords )
class free_operator_t( free_calldef_t, operator_t ):
"""describes free operator declaration"""
def __init__( self, *args, **keywords ):
free_calldef_t.__init__( self, *args, **keywords )
operator_t.__init__( self, *args, **keywords )
self.__class_types = None
@property
def class_types( self ):
"""list of class/class declaration types, extracted from the operator arguments"""
if None is self.__class_types:
self.__class_types = []
for type_ in self.argument_types:
decl = None
type_ = type_traits.remove_reference( type_ )
if type_traits.is_class( type_ ):
decl = type_traits.class_traits.get_declaration( type_ )
elif type_traits.is_class_declaration( type_ ):
decl = type_traits.class_declaration_traits.get_declaration( type_ )
else:
pass
if decl:
self.__class_types.append( decl )
return self.__class_types
|