com.shakelang.shake.compiler.processor/com.shakelang.shake.processor.program.types/ShakePackage

ShakePackage

Represents a package in the Shake language. A package is a namespace that organizes classes, methods, fields, and other packages.

Since

0.1.0

Inheritors

CreationShakePackage

Types

Companion

object Companion

Properties

baseProject

abstract val baseProject: ShakeProject

The base project to which this package belongs.

classes

abstract val classes: List<ShakeClass>

A list of classes contained within this package.

fields

abstract val fields: List<ShakeField>

A list of fields declared in this package.

functions

abstract val functions: List<ShakeMethod>

A list of functions defined in this package.

name

abstract val name: String

The name of the package.

parent

abstract val parent: ShakePackage?

The parent package, if any.

qualifiedName

open val qualifiedName: String

The fully qualified name of this package.

qualifierPrefix

open val qualifierPrefix: String

The prefix used for qualifying names in this package.

scope

abstract val scope: ShakeScope

The scope of this package.

subpackages

abstract val subpackages: List<ShakePackage>

A list of subpackages contained within this package.

Functions

getClass

open fun getClass(name: Array<String>): ShakeClass?

Retrieves a class by an array of names.

open fun getClass(name: String): ShakeClass?

Retrieves a class by its name.

open fun getClass(name: List<String>): ShakeClass?

Retrieves a class by a path of names.

getField

open fun getField(name: Array<String>): ShakeField?

Retrieves a field by an array of names.

open fun getField(name: String): ShakeField?

Retrieves a field by its name.

open fun getField(name: List<String>): ShakeField?

Retrieves a field by a path of names.

getFunctions

open fun getFunctions(name: Array<String>): List<ShakeMethod>?

Retrieves functions by an array of names.

open fun getFunctions(name: String): List<ShakeMethod>

Retrieves functions by their name.

open fun getFunctions(name: List<String>): List<ShakeMethod>?

Retrieves functions by a path of names.

getPackage

open fun getPackage(name: Array<String>): ShakePackage?

open fun getPackage(name: List<String>): ShakePackage?

Retrieves a subpackage by a path of names.

open fun getPackage(name: String): ShakePackage?

Retrieves a subpackage by name.

phase1

abstract fun phase1()

Executes the first phase of the package processing.

phase2

abstract fun phase2()

Executes the second phase of the package processing.

phase3

abstract fun phase3()

Executes the third phase of the package processing.

phase4

abstract fun phase4()

Executes the fourth phase of the package processing.

toJson

open fun toJson(): Map<String, Any?>

Converts this package to a JSON representation. Useful for serialization or debugging purposes.