rubysrc2cpg
API
Generated with
rubysrc2cpg/io.joern.rubysrc2cpg/io.joern.rubysrc2cpg.datastructures/RubyScope

RubyScope

io.joern.rubysrc2cpg.datastructures.RubyScope
class RubyScope(summary: RubyProgramSummary) extends Scope[String, NewNode, TypedScopeElement], TypedScope[RubyMethod, RubyField, RubyType]

Attributes

Graph
Supertypes
trait TypedScope[RubyMethod, RubyField, RubyType]
class Scope[String, NewNode, TypedScopeElement]
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def newProgramScope: Option[ProgramScope]

Attributes

Returns

using the stack, will initialize a new module scope object.

override def pushNewScope(scopeNode: TypedScopeElement): Unit

Attributes

Definition Classes
Scope
def shouldGenerateDefaultConstructor: Boolean

Attributes

Returns

true if one should still generate a default constructor for the enclosing type decl.

def surroundingAstLabel: Option[String]

Attributes

Returns

the corresponding node label according to the scope element.

def surroundingScopeFullName: Option[String]

Attributes

Returns

the full name of the surrounding scope.

Inherited methods

def addImportedMember(typeOrModule: String, memberNames: String*): Unit

Appends known members to the scope.

Appends known members to the scope.

Value parameters

memberNames

the names of the members, or, if empty, imports all members from the type.

typeOrModule

the type name or full name.

Attributes

Inherited from:
TypedScope
def addImportedNamespace(namespace: String): Unit

Appends known types imported into the scope.

Appends known types imported into the scope.

Value parameters

namespace

the fully qualified imported namespace.

Attributes

Inherited from:
TypedScope
def addImportedTypeOrModule(typeOrModule: String): Unit

Appends known types imported into the scope.

Appends known types imported into the scope.

Value parameters

typeOrModule

the type name or full name.

Attributes

Inherited from:
TypedScope
def addToScope(identifier: String, variable: NewNode): S

Attributes

Inherited from:
Scope
def isEmpty: Boolean

Attributes

Inherited from:
Scope
def lookupVariable(identifier: String): Option[V]

Attributes

Inherited from:
Scope
def popScope(): Option[S]

Attributes

Inherited from:
Scope
def size: Int

Attributes

Inherited from:
Scope
def tryResolveFieldAccess(fieldName: String, typeFullName: Option[String]): Option[F]

Given the type full name and field name, will attempt to find the matching entry.

Given the type full name and field name, will attempt to find the matching entry.

Value parameters

fieldName

the field/object property/module variable name.

typeFullName

the base type full name. If none, will refer to loosely imported member or functions.

Attributes

Returns

the field/object property/module variable's meta data.

Inherited from:
TypedScope
def tryResolveMethodInvocation(callName: String, argTypes: List[String], typeFullName: Option[String]): Option[M]

Given the type full name and call name, will attempt to find the matching entry.

Given the type full name and call name, will attempt to find the matching entry.

Value parameters

argTypes

the observed argument types. Only relevant for languages that implement overloading.

callName

the call name.

typeFullName

the base type full name. If none, will refer to loosely imported member or functions.

Attributes

Returns

the method meta data if found.

Inherited from:
TypedScope
def tryResolveTypeReference(typeName: String): Option[T]

Given a type name or alias, attempts to resolve its full name using the types currently in scope.

Given a type name or alias, attempts to resolve its full name using the types currently in scope.

Value parameters

typeName

the shorthand name.

Attributes

Returns

the type meta-data if found.

Inherited from:
TypedScope

Inherited fields

protected val aliasedTypes: HashMap[String, String]

Tracks any types or modules imported under alternative names to their type full names.

Tracks any types or modules imported under alternative names to their type full names.

Attributes

Inherited from:
TypedScope
protected val membersInScope: Set[MemberLike]

Tracks the members visible to this scope. In languages like JavaScript or Python, where members can be directly imported and accessed without an explicit base, they are kept here.

Tracks the members visible to this scope. In languages like JavaScript or Python, where members can be directly imported and accessed without an explicit base, they are kept here.

Attributes

Inherited from:
TypedScope
protected val typesInScope: Set[RubyType]

Tracks the types that are visible to this scope.

Tracks the types that are visible to this scope.

Attributes

Inherited from:
TypedScope
Generated with