rd-gen/com.jetbrains.rd.generator.nova

Package-level declarations

Types

Aggregate

class Aggregate(val _name: String, val pointcut: Toplevel) : BindableDeclaration, INonNullableBindable

ArrayOfBindables

data class ArrayOfBindables(val itemType: IBindable) : INonNullableBindable, IArray

ArrayOfScalars

data class ArrayOfScalars(val itemType: IScalar) : INonNullableScalar, IArray

BindableDeclaration

abstract class BindableDeclaration(val pointcut: BindableDeclaration?) : Declaration

Class

sealed class Class : BindableDeclaration, INonNullableBindable, Extensible, ITypeDeclaration

Context

sealed class Context : Declaration

Declaration

abstract class Declaration(val pointcut: BindableDeclaration?) : SettingsHolder, IDeclaration

DisabledMarshallersCollector

object DisabledMarshallersCollector : MarshallersCollector

Enum

open class Enum(val _name: String, val pointcut: Toplevel) : Declaration, INonNullableScalar, ITypeDeclaration

Ext

abstract class Ext(val pointcut: BindableDeclaration, val extName: String? = null) : Toplevel, Extensible

Extensible

interface Extensible

ExternalGenerator

open class ExternalGenerator(val generator: IGenerator, val root: Root) : IGeneratorAndRoot

If you extend this class with object instance it will be collected by collectSortedGeneratorsToInvoke during reflection search.

FlowKind

enum FlowKind : Enum<FlowKind>

FlowTransform

enum FlowTransform : Enum<FlowTransform>

GenerationSpec

data class GenerationSpec(var language: String = "", var transform: String? = null, var root: String = "", var namespace: String = "", var directory: String = "", var generatedFileSuffix: String = ".Generated", var marshallersFile: String? = null)

GeneratorBase

abstract class GeneratorBase(flowTransform: FlowTransform, generatedFileSuffix: String, val marhsallersFile: File? = null) : IGenerator

Base class for generators to deduplicate common logic

GeneratorException

class GeneratorException(msg: String) : RuntimeException

This exception arises during generation. Usually thrown by GeneratorBase.fail method.

IArray

interface IArray : IHasItemType

IAttributedType

interface IAttributedType : IHasItemType

IBindable

interface IBindable : IType

IDeclaration

interface IDeclaration : ISettingsHolder

IGenerator

interface IGenerator

IGeneratorAndRoot

interface IGeneratorAndRoot : Comparable<IGeneratorAndRoot>

Generator and root together

IHasItemType

interface IHasItemType : IType

IImmutableList

interface IImmutableList : IHasItemType

ImmutableListOfBindables

data class ImmutableListOfBindables(val itemType: IBindable) : INonNullableBindable, IImmutableList

ImmutableListOfScalars

data class ImmutableListOfScalars(val itemType: IScalar) : INonNullableScalar, IImmutableList

INonNullable

interface INonNullable : IType

INonNullableBindable

interface INonNullableBindable : INonNullable, IBindable

INonNullableScalar

interface INonNullableScalar : INonNullable, IScalar

Interface

class Interface(val _name: String, val pointcut: Toplevel, val baseInterfaces: MutableList<Interface>) : Declaration

InternedScalar

data class InternedScalar(val itemType: INonNullableScalar, val internKey: InternScope) : INonNullableScalar

InternScope

class InternScope(val pointcut: BindableDeclaration?, val _name: String = "") : Declaration

INullable

interface INullable : IHasItemType

ISanitizer

interface ISanitizer

IScalar

interface IScalar : IType

ISetting

interface ISetting<out T : Any, out S : ISettingsHolder>

Additional settings for rd model. Usually they are specific to IGenerator (because lead to generated code customization) and declared in generator's implementation T type of setting value S type of rd model entity to which this setting is applicable, e.g. Declaration or Member

ISettingsHolder

interface ISettingsHolder

IType

interface IType

ITypeDeclaration

interface ITypeDeclaration : IType, IDeclaration

KnownAttrs

enum KnownAttrs : Enum<KnownAttrs>

Lang

enum Lang : Enum<Lang>

MarshallersCollector

interface MarshallersCollector

Member

sealed class Member : SettingsHolder

Modifier

enum Modifier : Enum<Modifier>

NullableBindable

data class NullableBindable(val itemType: INonNullableBindable) : IBindable, INullable

NullableScalar

data class NullableScalar(val itemType: INonNullableScalar) : IScalar, INullable

PredefinedType

sealed class PredefinedType : INonNullableScalar

RdGen

class RdGen : Kli

RealMarshallersCollector

class RealMarshallersCollector(val marshallersFile: File) : MarshallersCollector

Root

abstract class Root(val hardcodedGenerators: IGenerator) : Toplevel

ScalarAttributedType

data class ScalarAttributedType<out T : IScalar> : IAttributedType, IScalar

SettingsHolder

open class SettingsHolder : ISettingsHolder

Base class for any rd model entity (e.g. Declaration or Member) that can be customized

SettingWithDefault

abstract class SettingWithDefault<out T : Any, out S : ISettingsHolder>(val default: T) : ISetting<T, S>

ISetting that has default value

SharedGeneratorSettings

object SharedGeneratorSettings

Struct

sealed class Struct : Declaration, INonNullableScalar, ITypeDeclaration

Toplevel

abstract class Toplevel(val pointcut: BindableDeclaration?) : BindableDeclaration

TypeWithValue

class TypeWithValue

Properties

async

val <T : Member.Reactive> T.async: T

hasEmptyConstructor

val IType.hasEmptyConstructor: Boolean

val Member.hasEmptyConstructor: Boolean

isConcrete

val Declaration.isConcrete: Boolean

isExtension

val Declaration.isExtension: Boolean

isToplevelExtension

val Declaration.isToplevelExtension: Boolean

light

val Context.Generated.light: Context

Marks this key a light key. Light keys don't maintain a value set and send values un-interned.

nlsSafeString

val nlsSafeString: ScalarAttributedType<PredefinedType.string>

nlsString

val nlsString: ScalarAttributedType<PredefinedType.string>

nonNlsString

val nonNlsString: ScalarAttributedType<PredefinedType.string>

nullable

val INonNullableBindable.nullable: NullableBindable

val INonNullableScalar.nullable: NullableScalar

optional

val Member.Field.optional: Member.Field

ProtocolInternScope

val ProtocolInternScope: InternScope

readonly

val <T : Member.Reactive> T.readonly: T

suppressEmptyCtor

val Member.Field.suppressEmptyCtor: Member.Field

write

val <T : Member.Reactive> T.write: T

Functions

array

fun array(type: IBindable): ArrayOfBindables

fun array(type: IScalar): ArrayOfScalars

asyncMap

fun BindableDeclaration.asyncMap(name: String, keyType: INonNullableScalar, valueType: INonNullableScalar): Member.Reactive.Stateful.AsyncMap

asyncProperty

fun BindableDeclaration.asyncProperty(name: String, valueType: IScalar): Member.Reactive.Stateful.AsyncProperty

asyncSet

fun BindableDeclaration.asyncSet(name: String, itemType: INonNullableScalar): Member.Reactive.Stateful.AsyncSet

attrs

fun <T : IScalar> T.attrs(vararg attributes: KnownAttrs): ScalarAttributedType<T>

call

fun BindableDeclaration.call(name: String, paramType: IScalar, resultType: IType): Member.Reactive.Task

callback

fun BindableDeclaration.callback(name: String, paramType: IScalar, resultType: IType): Member.Reactive.Task

const

fun Declaration.const(name: String, type: Enum, value: Member.EnumConst): Member.Const.Enum

fun Declaration.const(name: String, type: Enum, value: Int): Member.Const.Enum

fun Declaration.const(name: String, type: Enum, value: String)

fun Declaration.const(name: String, type: PredefinedType, value: String): Member.Const.Integral

fun Declaration.const(name: String, type: PredefinedType.bool, value: Boolean): Member.Const.Integral

fun Declaration.const(name: String, type: PredefinedType.byte, value: Byte): Member.Const.Integral

fun Declaration.const(name: String, type: PredefinedType.char, value: Char): Member.Const.Integral

fun Declaration.const(name: String, type: PredefinedType.double, value: Double): Member.Const.Integral

fun Declaration.const(name: String, type: PredefinedType.float, value: Float): Member.Const.Integral

fun Declaration.const(name: String, type: PredefinedType.int, value: Int): Member.Const.Integral

fun Declaration.const(name: String, type: PredefinedType.long, value: Long): Member.Const.Integral

fun Declaration.const(name: String, type: PredefinedType.short, value: Short): Member.Const.Integral

fun Declaration.const(name: String, type: PredefinedType.string, value: String): Member.Const.Integral

@ExperimentalUnsignedTypes

fun Declaration.const(name: String, type: PredefinedType.ubyte, value: UByte): Member.Const.Integral

@ExperimentalUnsignedTypes

fun Declaration.const(name: String, type: PredefinedType.uint, value: UInt): Member.Const.Integral

@ExperimentalUnsignedTypes

fun Declaration.const(name: String, type: PredefinedType.ulong, value: ULong): Member.Const.Integral

@ExperimentalUnsignedTypes

fun Declaration.const(name: String, type: PredefinedType.ushort, value: UShort): Member.Const.Integral

fun Declaration.const(name: String, type: ScalarAttributedType<PredefinedType>, value: String): Member.Const.Integral

fun Interface.~~const~~(name: String, type: INonNullableScalar, value: Any): Nothing

default

fun Member.Field.default(value: Boolean): Member.Field

fun Member.Field.default(value: Long): Member.Field

fun Member.Field.default(value: String): Member.Field

doc

fun <T : Declaration> T.doc(value: String): T

fun Member.doc(value: String): Member

fail

fun fail(msg: String): Nothing

field

fun Aggregate.field(name: String, type: Aggregate): Member.Field

fun Class.field(name: String, type: IType): Member.Field

fun Interface.~~field~~(name: String, type: Aggregate): Nothing

fun Struct.~~field~~(name: String, type: IBindable): Nothing

fun Struct.field(name: String, type: IScalar): Member.Field

fun Struct.field(name: String, type: ScalarAttributedType<IScalar>): Member.Field

fun Toplevel.field(name: String, type: Aggregate): Member.Field

forGenerator

fun <T : Any, S : ISettingsHolder> ISetting<T, S>.forGenerator(generator: IGenerator): ISetting<T, S>

Creates new setting, specialized for generator. In case we have two generator instances with same type for one model (e.g. com.jetbrains.rd.generator.nova.csharp.CSharp50Generator.FlowTransformProperty which is different for client and server) you need to distinguish this settings for different generation processes (e.g. client and server).

generateRdModel

fun generateRdModel(classLoader: ClassLoader, namespacePrefixes: Array<String>, verbose: Boolean = false, generatorsFilter: Regex? = null, clearOutputFolderIfExists: Boolean = false, generationSpecs: List<GenerationSpec> = emptyList()): Set<File>

getSetting

fun <T : Any, S : ISettingsHolder> S.getSetting(key: ISetting<T, S>): T?

Should be called inside generation process (IGenerator.generate). Method tries to obtain following setting from SettingsHolder.settings in following order:

getValue