log4k-compiler-plugin/io.github.smyrgeorge.log4k.compiler.trace/TraceIrTransformer

TraceIrTransformer

class TraceIrTransformer(pluginContext: IrPluginContext, finder: DeclarationFinder, messageCollector: MessageCollector) : IrElementTransformerVoidWithContext(source)

Rewrites the body of every function annotated with io.github.smyrgeorge.log4k.annotation.Traced so that it is executed inside a new tracing span.

The span's parent (and the tracer that creates it) is resolved from what is in scope, in order:

a TracingContext parameter/receiver — the new span nests under its current span (as before);
otherwise a TracingEvent.Span parameter/receiver — used directly as the parent;
otherwise a trace: Tracer member (else the class's single Tracer-typed property, whatever its name) — reused, or synthesized as private val _trace_ = Tracer.of(this::class) — which creates a new root span.

Given:

@Traced(name = "load")
context(_: TracingContext)
suspend fun load(id: Long): User { /* body */}

the body is replaced with (conceptually):

suspend fun load(id: Long): User =
    TracingContext.traced(context = ctx, parent = null, tracer = null, "load") { /* body */}

TracingContext.traced is inline, so both regular and suspend functions work: the moved body is placed in an inline lambda and therefore keeps its original suspension context.

Constructors

TraceIrTransformer

constructor(pluginContext: IrPluginContext, finder: DeclarationFinder, messageCollector: MessageCollector)

Types

Companion

object Companion

Properties

isReady

val isReady: Boolean

Functions

commit

fun commit(): Unit?

Attaches every synthesized _trace_ field to its class. Must run after the module transform.

visitAnnotation

open fun visitAnnotation(expression: IrAnnotation): IrExpression

override fun visitAnnotation(expression: IrAnnotation, data: Nothing?): IrElement

visitAnonymousInitializer

override fun visitAnonymousInitializer(declaration: IrAnonymousInitializer): IrStatement

override fun visitAnonymousInitializer(declaration: IrAnonymousInitializer, data: Nothing?): IrStatement

visitAnonymousInitializerNew

open fun visitAnonymousInitializerNew(declaration: IrAnonymousInitializer): IrStatement

visitBlock

open fun visitBlock(expression: IrBlock): IrExpression

override fun visitBlock(expression: IrBlock, data: Nothing?): IrExpression

visitBlockBody

open fun visitBlockBody(body: IrBlockBody): IrBody

override fun visitBlockBody(body: IrBlockBody, data: Nothing?): IrBody

visitBody

open fun visitBody(body: IrBody): IrBody

override fun visitBody(body: IrBody, data: Nothing?): IrBody

visitBranch

open fun visitBranch(branch: IrBranch): IrBranch

override fun visitBranch(branch: IrBranch, data: Nothing?): IrBranch

visitBreak

open fun visitBreak(jump: IrBreak): IrExpression

override fun visitBreak(jump: IrBreak, data: Nothing?): IrExpression

visitBreakContinue

open fun visitBreakContinue(jump: IrBreakContinue): IrExpression

override fun visitBreakContinue(jump: IrBreakContinue, data: Nothing?): IrExpression

visitCall

open fun visitCall(expression: IrCall): IrExpression

override fun visitCall(expression: IrCall, data: Nothing?): IrElement

visitCallableReference

open fun visitCallableReference(expression: IrCallableReference<*>): IrExpression

override fun visitCallableReference(expression: IrCallableReference<*>, data: Nothing?): IrElement

visitCatch

open fun visitCatch(aCatch: IrCatch): IrCatch

override fun visitCatch(aCatch: IrCatch, data: Nothing?): IrCatch

visitClass

override fun visitClass(declaration: IrClass): IrStatement

override fun visitClass(declaration: IrClass, data: Nothing?): IrStatement

visitClassNew

open fun visitClassNew(declaration: IrClass): IrStatement

visitClassReference

open fun visitClassReference(expression: IrClassReference): IrExpression

override fun visitClassReference(expression: IrClassReference, data: Nothing?): IrExpression

visitComposite

open fun visitComposite(expression: IrComposite): IrExpression

override fun visitComposite(expression: IrComposite, data: Nothing?): IrExpression

visitConst

open fun visitConst(expression: IrConst): IrExpression

override fun visitConst(expression: IrConst, data: Nothing?): IrExpression

visitConstantArray

open fun visitConstantArray(expression: IrConstantArray): IrConstantValue

override fun visitConstantArray(expression: IrConstantArray, data: Nothing?): IrConstantValue

visitConstantObject

open fun visitConstantObject(expression: IrConstantObject): IrConstantValue

override fun visitConstantObject(expression: IrConstantObject, data: Nothing?): IrConstantValue

visitConstantPrimitive

open fun visitConstantPrimitive(expression: IrConstantPrimitive): IrConstantValue

override fun visitConstantPrimitive(expression: IrConstantPrimitive, data: Nothing?): IrConstantValue

visitConstantValue

open fun visitConstantValue(expression: IrConstantValue): IrConstantValue

override fun visitConstantValue(expression: IrConstantValue, data: Nothing?): IrConstantValue

visitConstructor

open fun visitConstructor(declaration: IrConstructor): IrStatement

override fun visitConstructor(declaration: IrConstructor, data: Nothing?): IrStatement

visitConstructorCall

open fun visitConstructorCall(expression: IrConstructorCall): IrExpression

override fun visitConstructorCall(expression: IrConstructorCall, data: Nothing?): IrElement

visitContainerExpression

open fun visitContainerExpression(expression: IrContainerExpression): IrExpression

override fun visitContainerExpression(expression: IrContainerExpression, data: Nothing?): IrExpression

visitContinue

open fun visitContinue(jump: IrContinue): IrExpression

override fun visitContinue(jump: IrContinue, data: Nothing?): IrExpression

visitDeclaration

open fun visitDeclaration(declaration: IrDeclarationBase): IrStatement

override fun visitDeclaration(declaration: IrDeclarationBase, data: Nothing?): IrStatement

visitDeclarationReference

open fun visitDeclarationReference(expression: IrDeclarationReference): IrExpression

override fun visitDeclarationReference(expression: IrDeclarationReference, data: Nothing?): IrExpression

visitDelegatingConstructorCall

open fun visitDelegatingConstructorCall(expression: IrDelegatingConstructorCall): IrExpression

override fun visitDelegatingConstructorCall(expression: IrDelegatingConstructorCall, data: Nothing?): IrElement

visitDoWhileLoop

open fun visitDoWhileLoop(loop: IrDoWhileLoop): IrExpression

override fun visitDoWhileLoop(loop: IrDoWhileLoop, data: Nothing?): IrExpression

visitDynamicExpression

open fun visitDynamicExpression(expression: IrDynamicExpression): IrExpression

override fun visitDynamicExpression(expression: IrDynamicExpression, data: Nothing?): IrExpression

visitDynamicMemberExpression

open fun visitDynamicMemberExpression(expression: IrDynamicMemberExpression): IrExpression

override fun visitDynamicMemberExpression(expression: IrDynamicMemberExpression, data: Nothing?): IrExpression

visitDynamicOperatorExpression

open fun visitDynamicOperatorExpression(expression: IrDynamicOperatorExpression): IrExpression

override fun visitDynamicOperatorExpression(expression: IrDynamicOperatorExpression, data: Nothing?): IrExpression

visitElement

open fun visitElement(element: IrElement): IrElement

override fun visitElement(element: IrElement, data: Nothing?): IrElement

visitElseBranch

open fun visitElseBranch(branch: IrElseBranch): IrElseBranch

override fun visitElseBranch(branch: IrElseBranch, data: Nothing?): IrElseBranch

visitEnumConstructorCall

open fun visitEnumConstructorCall(expression: IrEnumConstructorCall): IrExpression

override fun visitEnumConstructorCall(expression: IrEnumConstructorCall, data: Nothing?): IrElement

visitEnumEntry

open fun visitEnumEntry(declaration: IrEnumEntry): IrStatement

override fun visitEnumEntry(declaration: IrEnumEntry, data: Nothing?): IrStatement

visitErrorCallExpression

open fun visitErrorCallExpression(expression: IrErrorCallExpression): IrExpression

override fun visitErrorCallExpression(expression: IrErrorCallExpression, data: Nothing?): IrExpression

visitErrorExpression

open fun visitErrorExpression(expression: IrErrorExpression): IrExpression

override fun visitErrorExpression(expression: IrErrorExpression, data: Nothing?): IrExpression

visitExpression

open fun visitExpression(expression: IrExpression): IrExpression

override fun visitExpression(expression: IrExpression, data: Nothing?): IrExpression

visitExpressionBody

open fun visitExpressionBody(body: IrExpressionBody): IrBody

override fun visitExpressionBody(body: IrExpressionBody, data: Nothing?): IrBody

visitExternalPackageFragment

open fun visitExternalPackageFragment(declaration: IrExternalPackageFragment): IrExternalPackageFragment

override fun visitExternalPackageFragment(declaration: IrExternalPackageFragment, data: Nothing?): IrExternalPackageFragment

visitField

override fun visitField(declaration: IrField): IrStatement

override fun visitField(declaration: IrField, data: Nothing?): IrStatement

visitFieldAccess

open fun visitFieldAccess(expression: IrFieldAccessExpression): IrExpression

override fun visitFieldAccess(expression: IrFieldAccessExpression, data: Nothing?): IrExpression

visitFieldNew

open fun visitFieldNew(declaration: IrField): IrStatement

visitFile

override fun visitFile(declaration: IrFile): IrFile

override fun visitFile(declaration: IrFile, data: Nothing?): IrFile

visitFileNew

open fun visitFileNew(declaration: IrFile): IrFile

visitFunction

override fun visitFunction(declaration: IrFunction): IrStatement

override fun visitFunction(declaration: IrFunction, data: Nothing?): IrStatement

visitFunctionAccess

open fun visitFunctionAccess(expression: IrFunctionAccessExpression): IrExpression

override fun visitFunctionAccess(expression: IrFunctionAccessExpression, data: Nothing?): IrElement

visitFunctionExpression

open fun visitFunctionExpression(expression: IrFunctionExpression): IrExpression

override fun visitFunctionExpression(expression: IrFunctionExpression, data: Nothing?): IrElement

visitFunctionNew

open override fun visitFunctionNew(declaration: IrFunction): IrStatement

visitFunctionReference

open fun visitFunctionReference(expression: IrFunctionReference): IrExpression

override fun visitFunctionReference(expression: IrFunctionReference, data: Nothing?): IrElement

visitGetClass

open fun visitGetClass(expression: IrGetClass): IrExpression

override fun visitGetClass(expression: IrGetClass, data: Nothing?): IrExpression

visitGetEnumValue

open fun visitGetEnumValue(expression: IrGetEnumValue): IrExpression

override fun visitGetEnumValue(expression: IrGetEnumValue, data: Nothing?): IrExpression

visitGetField

open fun visitGetField(expression: IrGetField): IrExpression

override fun visitGetField(expression: IrGetField, data: Nothing?): IrExpression

visitGetObjectValue

open fun visitGetObjectValue(expression: IrGetObjectValue): IrExpression

override fun visitGetObjectValue(expression: IrGetObjectValue, data: Nothing?): IrExpression

visitGetValue

open fun visitGetValue(expression: IrGetValue): IrExpression

override fun visitGetValue(expression: IrGetValue, data: Nothing?): IrExpression

visitInlinedFunctionBlock

open fun visitInlinedFunctionBlock(inlinedBlock: IrInlinedFunctionBlock): IrExpression

override fun visitInlinedFunctionBlock(inlinedBlock: IrInlinedFunctionBlock, data: Nothing?): IrExpression

visitInstanceInitializerCall

open fun visitInstanceInitializerCall(expression: IrInstanceInitializerCall): IrExpression

override fun visitInstanceInitializerCall(expression: IrInstanceInitializerCall, data: Nothing?): IrExpression

visitLocalDelegatedProperty

open fun visitLocalDelegatedProperty(declaration: IrLocalDelegatedProperty): IrStatement

override fun visitLocalDelegatedProperty(declaration: IrLocalDelegatedProperty, data: Nothing?): IrStatement

visitLocalDelegatedPropertyReference

open fun visitLocalDelegatedPropertyReference(expression: IrLocalDelegatedPropertyReference): IrExpression

override fun visitLocalDelegatedPropertyReference(expression: IrLocalDelegatedPropertyReference, data: Nothing?): IrElement

visitLoop

open fun visitLoop(loop: IrLoop): IrExpression

override fun visitLoop(loop: IrLoop, data: Nothing?): IrExpression

visitMemberAccess

open fun visitMemberAccess(expression: IrMemberAccessExpression<*>): IrExpression

override fun visitMemberAccess(expression: IrMemberAccessExpression<*>, data: Nothing?): IrElement

visitModuleFragment

open fun visitModuleFragment(declaration: IrModuleFragment): IrModuleFragment

override fun visitModuleFragment(declaration: IrModuleFragment, data: Nothing?): IrModuleFragment

visitPackageFragment

open fun visitPackageFragment(declaration: IrPackageFragment): IrPackageFragment

override fun visitPackageFragment(declaration: IrPackageFragment, data: Nothing?): IrElement

visitProperty

override fun visitProperty(declaration: IrProperty): IrStatement

override fun visitProperty(declaration: IrProperty, data: Nothing?): IrStatement

visitPropertyNew

open fun visitPropertyNew(declaration: IrProperty): IrStatement

visitPropertyReference

open fun visitPropertyReference(expression: IrPropertyReference): IrExpression

override fun visitPropertyReference(expression: IrPropertyReference, data: Nothing?): IrElement

visitRawFunctionReference

open fun visitRawFunctionReference(expression: IrRawFunctionReference): IrExpression

override fun visitRawFunctionReference(expression: IrRawFunctionReference, data: Nothing?): IrExpression

visitReplSnippet

open fun visitReplSnippet(declaration: IrReplSnippet): IrStatement

override fun visitReplSnippet(declaration: IrReplSnippet, data: Nothing?): IrStatement

visitReturn

open fun visitReturn(expression: IrReturn): IrExpression

override fun visitReturn(expression: IrReturn, data: Nothing?): IrExpression

visitReturnableBlock

open fun visitReturnableBlock(expression: IrReturnableBlock): IrExpression

override fun visitReturnableBlock(expression: IrReturnableBlock, data: Nothing?): IrExpression

visitRichCallableReference

open fun visitRichCallableReference(expression: IrRichCallableReference<*>): IrExpression

override fun visitRichCallableReference(expression: IrRichCallableReference<*>, data: Nothing?): IrExpression

visitRichFunctionReference

open fun visitRichFunctionReference(expression: IrRichFunctionReference): IrExpression

override fun visitRichFunctionReference(expression: IrRichFunctionReference, data: Nothing?): IrExpression

visitRichPropertyReference

open fun visitRichPropertyReference(expression: IrRichPropertyReference): IrExpression

override fun visitRichPropertyReference(expression: IrRichPropertyReference, data: Nothing?): IrExpression

visitScript

override fun visitScript(declaration: IrScript): IrStatement

override fun visitScript(declaration: IrScript, data: Nothing?): IrStatement

visitScriptNew

open fun visitScriptNew(declaration: IrScript): IrStatement

visitSetField

open fun visitSetField(expression: IrSetField): IrExpression

override fun visitSetField(expression: IrSetField, data: Nothing?): IrExpression

visitSetValue

open fun visitSetValue(expression: IrSetValue): IrExpression

override fun visitSetValue(expression: IrSetValue, data: Nothing?): IrExpression

visitSimpleFunction

open fun visitSimpleFunction(declaration: IrSimpleFunction): IrStatement

override fun visitSimpleFunction(declaration: IrSimpleFunction, data: Nothing?): IrStatement

visitSingletonReference

open fun visitSingletonReference(expression: IrGetSingletonValue): IrExpression

override fun visitSingletonReference(expression: IrGetSingletonValue, data: Nothing?): IrExpression

visitSpreadElement

open fun visitSpreadElement(spread: IrSpreadElement): IrSpreadElement

override fun visitSpreadElement(spread: IrSpreadElement, data: Nothing?): IrSpreadElement

visitStringConcatenation

open fun visitStringConcatenation(expression: IrStringConcatenation): IrExpression

override fun visitStringConcatenation(expression: IrStringConcatenation, data: Nothing?): IrExpression

visitSuspendableExpression

open fun visitSuspendableExpression(expression: IrSuspendableExpression): IrExpression

override fun visitSuspendableExpression(expression: IrSuspendableExpression, data: Nothing?): IrExpression

visitSuspensionPoint

open fun visitSuspensionPoint(expression: IrSuspensionPoint): IrExpression

override fun visitSuspensionPoint(expression: IrSuspensionPoint, data: Nothing?): IrExpression

visitSyntheticBody

open fun visitSyntheticBody(body: IrSyntheticBody): IrBody

override fun visitSyntheticBody(body: IrSyntheticBody, data: Nothing?): IrBody

visitThrow

open fun visitThrow(expression: IrThrow): IrExpression

override fun visitThrow(expression: IrThrow, data: Nothing?): IrExpression

visitTry

open fun visitTry(aTry: IrTry): IrExpression

override fun visitTry(aTry: IrTry, data: Nothing?): IrExpression

visitTypeAlias

open fun visitTypeAlias(declaration: IrTypeAlias): IrStatement

override fun visitTypeAlias(declaration: IrTypeAlias, data: Nothing?): IrStatement

visitTypeOperator

open fun visitTypeOperator(expression: IrTypeOperatorCall): IrExpression

override fun visitTypeOperator(expression: IrTypeOperatorCall, data: Nothing?): IrExpression

visitTypeParameter

open fun visitTypeParameter(declaration: IrTypeParameter): IrStatement

override fun visitTypeParameter(declaration: IrTypeParameter, data: Nothing?): IrStatement

visitValueAccess

open fun visitValueAccess(expression: IrValueAccessExpression): IrExpression

override fun visitValueAccess(expression: IrValueAccessExpression, data: Nothing?): IrExpression

visitValueParameter

override fun visitValueParameter(declaration: IrValueParameter): IrStatement

override fun visitValueParameter(declaration: IrValueParameter, data: Nothing?): IrStatement

visitValueParameterNew

open fun visitValueParameterNew(declaration: IrValueParameter): IrStatement

visitVararg

open fun visitVararg(expression: IrVararg): IrExpression

override fun visitVararg(expression: IrVararg, data: Nothing?): IrExpression

visitVariable

open fun visitVariable(declaration: IrVariable): IrStatement

override fun visitVariable(declaration: IrVariable, data: Nothing?): IrStatement

visitWhen

open fun visitWhen(expression: IrWhen): IrExpression

override fun visitWhen(expression: IrWhen, data: Nothing?): IrExpression

visitWhileLoop

open fun visitWhileLoop(loop: IrWhileLoop): IrExpression

override fun visitWhileLoop(loop: IrWhileLoop, data: Nothing?): IrExpression