Contents

class procedure_call_sites_flags

Flag class: specifies call site types.

Used as an argument to the following procedure methods to specify the call site kind or kinds of interest.

procedure_call_sites_flags Members

Constructors none
Static Method from_integer()
Methods __and__(), __cmp__(), __eq__(), __ge__(), __gt__(), __hash__(), __invert__(), __le__(), __lt__(), __ne__(), __or__(), __repr__(), __str__(), as_integer(), name()
Attributes DIRECT, INDIRECT, NONE

procedure_call_sites_flags Details

class cs.procedure_call_sites_flags

Flag class: specifies call site types.

static from_integer(_inner)

Construct an instance from an integer representation.

Parameters:_inner (int) – The integer representation, as returned by procedure_call_sites_flags.as_integer().
Return type:procedure_call_sites_flags
Raises:result.ERROR_INVALID_ARGUMENT if _inner is not a valid integer representation for a procedure_call_sites_flags instance.

Invariant: For procedure_call_sites_flags x, procedure_call_sites_flags.from_integer(x.as_integer()) == x

>>> pcsf = procedure_call_sites_flags.INDIRECT.as_integer()
>>> pcsf
2
>>> procedure_call_sites_flags.from_integer(pcsf)
<cs.procedure_call_sites_flags indirect>
__and__(b)

AND operator for procedure_call_sites_flags .

Parameters:b (procedure_call_sites_flags) – AND operand.
Return type:procedure_call_sites_flags
Returns:A procedure_call_sites_flags object containing all flags that are in both self and b. 
>>> procedure_call_sites_flags.INDIRECT & procedure_call_sites_flags.DIRECT
<cs.procedure_call_sites_flags none>
__cmp__(other)

Comparison function for procedure_call_sites_flags , with respect to a stable overall ordering.

Parameters:other (procedure_call_sites_flags) – The procedure_call_sites_flags object to compare against.
Return type:int
Returns:An integer N such that:
  • N==0 if the two objects compare equal
  • N<0 if self < other
  • N>0 if self > other
 
>>> procedure_call_sites_flags.DIRECT.__cmp__(procedure_call_sites_flags.NONE)
1
__eq__(b)

Equality operator for procedure_call_sites_flags .

Parameters:b (procedure_call_sites_flags) – The procedure_call_sites_flags object to compare against.
Return type:bool
Returns:True if self and b compare equal, False otherwise. 
>>> procedure_call_sites_flags.DIRECT == procedure_call_sites_flags.NONE
False
__ge__(b)

Greater-than-or-equal operator for procedure_call_sites_flags .

Parameters:b (procedure_call_sites_flags) – The procedure_call_sites_flags object to compare against.
Return type:bool
Returns:True if self >= b , False otherwise. 
>>> procedure_call_sites_flags.INDIRECT >= procedure_call_sites_flags.NONE
True
__gt__(b)

Greater-than operator for procedure_call_sites_flags .

Parameters:b (procedure_call_sites_flags) – The procedure_call_sites_flags object to compare against.
Return type:bool
Returns:True if self > b , False otherwise. 
>>> procedure_call_sites_flags.INDIRECT > procedure_call_sites_flags.DIRECT
True
__hash__()

Hash function for procedure_call_sites_flags .

Return type:int 
>>> hash(procedure_call_sites_flags.NONE)
0
__invert__()

Complementation operator.

Return type:procedure_call_sites_flags
Returns:A procedure_call_sites_flags object containing the flags that are NOT contained in self. 
>>> ~procedure_call_sites_flags.INDIRECT
<cs.procedure_call_sites_flags direct>
__le__(b)

Less-than-or-equal operator for procedure_call_sites_flags .

Parameters:b (procedure_call_sites_flags) – The procedure_call_sites_flags object to compare against.
Return type:bool
Returns:True if self <= b , False otherwise. 
>>> procedure_call_sites_flags.DIRECT <= procedure_call_sites_flags.INDIRECT
True
__lt__(b)

Less-than operator for procedure_call_sites_flags .

Parameters:b (procedure_call_sites_flags) – The procedure_call_sites_flags object to compare against.
Return type:bool
Returns:True if self < b , False otherwise. 
>>> procedure_call_sites_flags.NONE < procedure_call_sites_flags.INDIRECT
True
__ne__(b)

Inequality operator for procedure_call_sites_flags .

Parameters:b (procedure_call_sites_flags) – The procedure_call_sites_flags object to compare against.
Return type:bool
Returns:False if self and b compare equal, True otherwise. 
>>> procedure_call_sites_flags.DIRECT != procedure_call_sites_flags.NONE
True
__or__(b)

OR operator for procedure_call_sites_flags .

Parameters:b (procedure_call_sites_flags) – OR operand.
Return type:procedure_call_sites_flags
Returns:A procedure_call_sites_flags object containing all flags that are in at least one of self, b. 
>>> procedure_call_sites_flags.NONE | procedure_call_sites_flags.DIRECT
<cs.procedure_call_sites_flags direct>
__repr__()

Get a representation of a procedure_call_sites_flags object that includes information useful for debugging.

Return type:str
Returns:The string representation. 
>>> repr(procedure_call_sites_flags.DIRECT)
'<cs.procedure_call_sites_flags direct>'
__str__()

Get a simple string representation of a procedure_call_sites_flags object.

Return type:str
Returns:The string representation. 
>>> str(procedure_call_sites_flags.INDIRECT)
'indirect'
as_integer()

Get an integer representation of self.

Return type:int
Returns:An integer suitable for use with procedure_call_sites_flags.from_integer().

Invariant: For procedure_call_sites_flags x, procedure_call_sites_flags.from_integer(x.as_integer()) == x

>>> pcsf = procedure_call_sites_flags.INDIRECT.as_integer()
>>> pcsf
2
>>> procedure_call_sites_flags.from_integer(pcsf)
<cs.procedure_call_sites_flags indirect>
name()

Get the name of a procedure_call_sites_flags object.

Return type:str 
>>> procedure_call_sites_flags.NONE.name()
'none'
DIRECT

Singleton set containing the “direct call sites” flag: points of kind point_kind.CALL_SITE are of interest.

>>> procedure_call_sites_flags.DIRECT
<cs.procedure_call_sites_flags direct>
INDIRECT

Singleton set containing the “indirect call sites” flag: points of kind point_kind.INDIRECT_CALL are of interest.

>>> procedure_call_sites_flags.INDIRECT
<cs.procedure_call_sites_flags indirect>
NONE

Empty set: contains no flags.

>>> procedure_call_sites_flags.NONE
<cs.procedure_call_sites_flags none>