/usr/lib/python2.7/dist-packages/pygccxml/declarations/calldef.py is in python-pygccxml 1.8.0-1.
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 | # Copyright 2014-2016 Insight Software Consortium.
# Copyright 2004-2008 Roman Yakovenko.
# Distributed under the Boost Software License, Version 1.0.
# See 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 warnings
from . import cpptypes
from . import declaration_utils
from . import declaration
from . import class_declaration
from . import call_invocation
from . import type_traits
from . import calldef_types
from .. import utils
# First level in hierarchy of calldef
class argument_t(object):
"""
class, that describes argument of "callable" declaration
"""
def __init__(
self,
name='',
type=None,
decl_type=None,
default_value=None,
attributes=None):
object.__init__(self)
if type is not None:
# Deprecated since 1.8.0. Will be removed in 1.9.0
warnings.warn(
"The type argument is deprecated. \n" +
"Please use the decl_type argument instead.",
DeprecationWarning)
if decl_type is not None:
raise (
"Please use only either the type or " +
"decl_type argument.")
# Still allow to use the old type for the moment.
decl_type = type
self._name = name
self._default_value = default_value
self._decl_type = decl_type
self._attributes = attributes
def clone(self, **keywd):
"""constructs new argument_t instance
return argument_t(
name=keywd.get('name', self.name),
decl_type=keywd.get('decl_type', self.decl_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), decl_type=keywd.get(
'decl_type', self.decl_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 is None:
return "%s %s" % (self.decl_type, self.name)
else:
return "%s %s=%s" % (
self.decl_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.decl_type == other.decl_type
def __hash__(self, other):
return (hash(self.__class__) ^
hash(self.name) ^
hash(self.default_value) ^
hash(self.decl_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.decl_type < other.decl_type
@property
def name(self):
"""Argument name.
@type: str"""
return self._name
@name.setter
def name(self, name):
self._name = name
@property
def ellipsis(self):
"""bool, if True argument represents ellipsis ( "..." )
in function definition"""
return isinstance(self.decl_type, cpptypes.ellipsis_t)
@property
def default_value(self):
"""Argument's default value or None.
@type: str"""
return self._default_value
@default_value.setter
def default_value(self, default_value):
self._default_value = default_value
@property
def type(self):
"""
Deprecated since v1.8.0. Will be removed in v1.9.0
"""
warnings.warn(
"argument_t.type is deprecated.\n" +
"Please use argument_t.decl_type instead.", DeprecationWarning)
return self._decl_type
@type.setter
def type(self, _decl_type):
"""
Deprecated since v1.8.0. Will be removed in v1.9.0
"""
warnings.warn(
"argument_t.type is deprecated.\n" +
"Please use argument_t.decl_type instead.", DeprecationWarning)
self._decl_type = _decl_type
@property
def decl_type(self):
return self._decl_type
@decl_type.setter
def decl_type(self, decl_type):
self._decl_type = decl_type
@property
def attributes(self):
"""GCCXML attributes, set using __attribute__((gccxml("...")))
@type: str"""
return self._attributes
@attributes.setter
def attributes(self, attributes):
self._attributes = attributes
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,
mangled=None):
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
self._calling_convention = None
self._has_inline = None
self._mangled = mangled
def _get__cmp__call_items(self):
"""
Implementation detail.
"""
raise NotImplementedError()
def _get__cmp__items(self):
"""
Implementation detail.
"""
if "GCC" in utils.xml_generator:
items = [
self.arguments,
self.return_type,
self.has_extern,
self.does_throw,
self.exceptions.sort(),
self.demangled_name,
self.has_inline]
elif "CastXML" in utils.xml_generator:
# No demangled name
items = [
self.arguments,
self.return_type,
self.has_extern,
self.does_throw,
self.exceptions.sort(),
self.has_inline]
items.extend(self._get__cmp__call_items())
return items
def __eq__(self, other):
if not declaration.declaration_t.__eq__(self, other):
return False
if "GCC" in utils.xml_generator:
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.exceptions.sort() == other.exceptions.sort() \
and self.demangled_name == other.demangled_name
elif "CastXML" in utils.xml_generator:
# Do not check for demangled name
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.exceptions.sort() == other.exceptions.sort()
def __hash__(self):
if "GCC" in utils.xml_generator:
return (super.__hash__(self) ^
hash(self.return_type) ^
hash(self.demangled_name))
elif "CastXML" in utils.xml_generator:
# No demangled name with castxml. Use the normal name.
return (super.__hash__(self) ^
hash(self.return_type) ^
hash(self.name))
@property
def arguments(self):
"""The argument list.
@type: list of :class:`argument_t`"""
return self._arguments
@arguments.setter
def arguments(self, arguments):
self._arguments = arguments
@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.decl_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):]
@property
def does_throw(self):
"""If False, than function does not throw any exception.
In this case, function was declared with empty throw
statement."""
return self._does_throw
@does_throw.setter
def does_throw(self, does_throw):
self._does_throw = does_throw
@property
def exceptions(self):
"""The list of exceptions.
@type: list of :class:`declaration_t`"""
return self._exceptions
@exceptions.setter
def exceptions(self, exceptions):
self._exceptions = exceptions
@property
def return_type(self):
"""The type of the return value of the "callable" or None
(constructors).
@type: :class:`type_t`"""
return self._return_type
@return_type.setter
def return_type(self, return_type):
self._return_type = return_type
@property
def overloads(self):
"""A list of overloaded "callables" (i.e. other callables with the
same name within the same scope.
@type: list of :class:`calldef_t`
"""
if not self.parent:
return []
# finding all functions with the same name
return self.parent.calldefs(
name=self.name,
function=lambda decl: decl is not self,
allow_empty=True,
recursive=False)
@property
def has_extern(self):
"""Was this callable declared as "extern"?
@type: bool"""
return self._has_extern
@has_extern.setter
def has_extern(self, has_extern):
self._has_extern = has_extern
@property
def has_inline(self):
"""Was this callable declared with "inline" specifier
@type: bool"""
return self._has_inline
@has_inline.setter
def has_inline(self, has_inline):
self._has_inline = has_inline
def __remove_parent_fname(self, demangled):
"""implementation details"""
demangled = demangled.strip()
parent_fname = declaration_utils.full_name(self.parent)
if parent_fname.startswith('::') and not demangled.startswith('::'):
parent_fname = parent_fname[2:]
demangled = demangled[len(parent_fname):]
return demangled
@property
def demangled_name(self):
"""returns function demangled name. It can help you to deal with
function template instantiations"""
if "CastXML" in utils.xml_generator:
raise Exception("Demangled name is not available with CastXML.")
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 = declaration_utils.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
def _report(self, *args, **keywd):
return class_declaration.dependency_info_t(self, *args, **keywd)
def i_depend_on_them(self, recursive=True):
answer = []
if self.return_type:
answer.append(
self._report(self.return_type, hint="return type"))
for arg in self.arguments:
answer.append(self._report(arg.decl_type))
for exc in self.exceptions:
answer.append(self._report(exc, hint="exception"))
return answer
def guess_calling_convention(self):
"""This function should be overriden in the derived classes and return
more-or-less successfull guess about calling convention"""
return calldef_types.CALLING_CONVENTION_TYPES.UNKNOWN
@property
def calling_convention(self):
"""function calling convention. See
:class:CALLING_CONVENTION_TYPES class for possible values"""
if self._calling_convention is None:
self._calling_convention = \
calldef_types.CALLING_CONVENTION_TYPES.extract(self.attributes)
if not self._calling_convention:
self._calling_convention = self.guess_calling_convention()
return self._calling_convention
@calling_convention.setter
def calling_convention(self, cc):
self._calling_convention = cc
@property
def mangled(self):
"""
Unique declaration name generated by the compiler.
:return: the mangled name
:rtype: str
"""
return self.get_mangled_name()
@mangled.setter
def mangled(self, mangled):
self._mangled = mangled
|