Class ClassKind

constructor

• new ClassKind(
      services: TypirServices,
      options?: Partial<ClassKindOptions>,
  ): ClassKind

• Parameters

  • services: TypirServices
  • Optionaloptions: Partial<ClassKindOptions>

  Returns ClassKind

Readonly$name

Readonlyoptions

Readonlyservices

calculateIdentifier

• calculateIdentifier<T>(typeDetails: ClassTypeDetails<T>): string

• This method calculates the identifier of a class with the given details. Depending on structural or nominal typing of classes, the fields and methods or the name of the class will be used to compose the resulting identifier. If some types for the properties of the class are missing, an exception will be thrown.

  Design decisions:

  • This method is part of the ClassKind and not part of ClassType, since the ClassKind requires it for 'getClassType'!
  • The kind might use/add additional prefixes for the identifiers to prevent collisions with types of other kinds, which might occur in some applications.

  Type Parameters

  • T

  Parameters

  • typeDetails: ClassTypeDetails<T>

    the details

  Returns string

  the new identifier

calculateIdentifierWithClassNameOnly

• calculateIdentifierWithClassNameOnly<T>(
      typeDetails: ClassTypeDetails<T>,
  ): string

• Calculates an identifier for classes which takes only the name of the class into account, regardless of whether the class is structurally or nominally typed. For structurally typed classes, this identifier might be used as well, since these names are usually used for reference in the DSL/AST!

  Type Parameters

  • T

  Parameters

  • typeDetails: ClassTypeDetails<T>

    the details of the class

  Returns string

  the identifier based on the class name

create

• create<T, T1, T2>(
      typeDetails: CreateClassTypeDetails<T, T1, T2>,
  ): TypeInitializer<ClassType>

• For the use case, that a new type needs to be created in Typir, e.g. for a class declaration. This function ensures, that the same type is created only once, even if this function is called multiple times, if e.g. the same type might be created for different type declaration. Nevertheless, usually a validation should produce an error in this case.

  Type Parameters

  • T
  • T1
  • T2

  Parameters

  • typeDetails: CreateClassTypeDetails<T, T1, T2>

    all information needed to create a new class

  Returns TypeInitializer<ClassType>

  an initializer which creates and returns the new class type, when all depending types are resolved

get

• get<T>(typeDetails: string | ClassTypeDetails<T>): TypeReference<ClassType>

• For the use case, that a type is used/referenced, e.g. to specify the type of a variable declaration.

  Type Parameters

  • T

  Parameters

  • typeDetails: string | ClassTypeDetails<T>

    all information needed to identify the class

  Returns TypeReference<ClassType>

  a reference to the class type, which might be resolved in the future, if the class type does not yet exist

getIdentifierPrefix

• getIdentifierPrefix(): string

• Returns string

getMethodFactory

• getMethodFactory(): FunctionFactoryService

• Returns FunctionFactoryService

getTopClassKind

• getTopClassKind(): TopClassKind

• Returns TopClassKind