Packages

c

io.shiftleft.repl

Workspace

class Workspace extends AnyRef

Ocular workspace - a directory containing all data persisted by Ocular.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Workspace
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Workspace(dirName: String)

Type Members

  1. case class CpgWorkspaceRecord(cpgDir: String, cpg: Option[Cpg] = None, loadedOverlays: Seq[String] = List()) extends Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Workspace to any2stringadd[Workspace] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Workspace, B)
    Implicit
    This member is added by an implicit conversion from Workspace to ArrowAssoc[Workspace] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addCpg(newCpg: Cpg, cpgFilename: String, overlayFilenames: Seq[String] = List()): Unit

    Add a CPG to the workspace.

    Add a CPG to the workspace. It is assumed that the CPG is loaded.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def baseCpgExists(inputPath: String): Boolean

    Indicates whether a base CPG exists for @inputPath.

  9. def baseCpgFilename(inputPath: String): String

    Filename for the base CPG for @inputPath

  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. def cpg: Cpg

    Obtain the cpg that was last loaded.

    Obtain the cpg that was last loaded. Throws a runtime exception if no CPG has been loaded.

  12. def cpgDirName(baseCpg: Cpg): Option[String]

    The directory in which the CPG @baseCpg is stored

  13. def cpgDirName(inputPath: String): String

    The safe directory name for a given input file that can be used to store its base CPG, along with all overlays.

    The safe directory name for a given input file that can be used to store its base CPG, along with all overlays. This method returns a directory name regardless of whether the directory exists or not.

  14. def createCpgRecordDirectory(inputPath: String): File

    Create an empty CPG workspace record.

    Create an empty CPG workspace record. Return a File handle to the directory

  15. def deleteCurrentRecord: Unit

    Delete record for cpg

  16. def deleteRecord(name: String): Unit

    Delete CPG workspace record by name, including data.

  17. def ensuring(cond: (Workspace) ⇒ Boolean, msg: ⇒ Any): Workspace
    Implicit
    This member is added by an implicit conversion from Workspace to Ensuring[Workspace] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (Workspace) ⇒ Boolean): Workspace
    Implicit
    This member is added by an implicit conversion from Workspace to Ensuring[Workspace] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: ⇒ Any): Workspace
    Implicit
    This member is added by an implicit conversion from Workspace to Ensuring[Workspace] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): Workspace
    Implicit
    This member is added by an implicit conversion from Workspace to Ensuring[Workspace] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Workspace to StringFormat[Workspace] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. def fuzzyMatchOverlayName(name: String, dirName: String): Option[String]

    Obtain exact name of overlay by substring

  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def loadedCpgs: List[Cpg]

    A sorted list of all loaded CPGs

  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. def overlayDir(inputPath: String): String

    Overlay directory for CPG with given @inputPath

  34. def overlayFilenames(inputPath: String, overlayNames: Seq[String]): Seq[String]

    Filenames for the overlay names in @overlayNames

  35. def recordByName(name: String): Option[CpgWorkspaceRecord]

    Record for the given name.

    Record for the given name. None if it is not in the workspace.

  36. def recordExists(inputPath: String): Boolean

    Indicates whether a workspace record exists for @inputPath.

  37. def recordForCpg(baseCpg: Cpg): Option[CpgWorkspaceRecord]

    Workspace record for the CPG, or none, if the CPG is not in the workspace

  38. def reset(): Unit

    Delete the workspace from disk, then initialize it again.

  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String

    Provide a human-readable overview of the workspace

    Provide a human-readable overview of the workspace

    Definition Classes
    Workspace → AnyRef → Any
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  44. def [B](y: B): (Workspace, B)
    Implicit
    This member is added by an implicit conversion from Workspace to ArrowAssoc[Workspace] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Workspace to any2stringadd[Workspace]

Inherited by implicit conversion StringFormat from Workspace to StringFormat[Workspace]

Inherited by implicit conversion Ensuring from Workspace to Ensuring[Workspace]

Inherited by implicit conversion ArrowAssoc from Workspace to ArrowAssoc[Workspace]

Ungrouped