Package com.vaadin.copilot.kotlinrewriter

Class KotlinRewriter

java.lang.Object

com.vaadin.copilot.kotlinrewriter.KotlinRewriter

All Implemented Interfaces:

CopilotRewriter<KotlinComponentInfo>

public class KotlinRewriter
extends Object
implements CopilotRewriter<KotlinComponentInfo>

Rewrites Kotlin view source in response to visual editing.

Only the property operations are implemented: set-component-property and the read that can-be-edited needs. Every other operation throws, and SourceLanguageCapabilities says so, so the frontend disables those actions rather than offering something that fails. Operations move in here and into that capability set together.

Edits are spliced at character offsets rather than printed from a mutated tree: the tree is read-only by design (see KotlinSource), and the practical consequence is the one that matters to a developer — a file Copilot edits comes back byte-identical except on the lines the edit needed.

Constructor Summary

Constructors

Constructor	Description
KotlinRewriter()

Method Summary

Modifier and Type	Method	Description
void	addCall(KotlinComponentInfo component, String function, Object... parameters)	Adds a call on the component, even if the same call is already present.
void	addComment(KotlinComponentInfo component, String comment, CommentType commentType)	Adds a comment next to the component.
List<KotlinComponentInfo>	addComponentUsingTemplate(KotlinComponentInfo referenceComponent, Where where, List<CopilotComponent> template, AddTemplateOptions options)	Adds components described by a template, as sent when dropping from the palette, pasting, or importing a design.
String	addConstructorParameterToClass(KotlinComponentInfo referenceComponent, String parameterTypeName, String suggestedParameterName, boolean storeAsField)	Adds a constructor parameter to the class the component is declared in, for injecting a service.
boolean	delete(KotlinComponentInfo component)	Deletes the component, along with the code that only existed to support it.
void	duplicate(KotlinComponentInfo component, List<KotlinComponentInfo> children)	Duplicates a component together with the given children.
String	extractComponent(KotlinComponentInfo component, IdentityHashMap<KotlinComponentInfo,List<KotlinComponentInfo>> componentChildren, String extractedComponentClassNameSuggestion)	Extracts a component and its children into a class of their own.
Object	getPropertyValue(KotlinComponentInfo component, String property)	Reads a property's value from the source.
void	mergeAndReplace(List<KotlinComponentInfo> components, CopilotComponent wrapperComponent)	Wraps the given components in a new container.
void	moveComponent(KotlinComponentInfo component, KotlinComponentInfo container, KotlinComponentInfo reference, Where where, MoveTemplateOptions options)	Moves a component into a container, relative to a reference component.
void	removeCalls(KotlinComponentInfo component, String function)	Removes every call to the given method on the component.
void	removePropertySetter(KotlinComponentInfo component, String setter)	Removes a property setter call from the component.
ReplaceResult	replaceFunctionCall(KotlinComponentInfo component, String function, Object value)	Sets a property, replacing the value the source already states or adding a statement where it states none.
void	replaceOrAddCall(KotlinComponentInfo component, String function, Object... parameters)	Adds a call on the component, replacing an existing call to the same method.
void	setAlignment(KotlinComponentInfo component, AlignmentValues alignmentValues)	Sets the component's flexbox alignment properties.
void	setGap(KotlinComponentInfo component, String all, String column, String row)	Sets the gap between a layout's children.
void	setPadding(KotlinComponentInfo component, String all, String top, String right, String bottom, String left)	Sets a component's padding.
void	setSizing(KotlinComponentInfo component, Map<String,String> changes)	Sets width and height related properties.
void	setStyle(KotlinComponentInfo component, String property, String value)	Sets an inline style, or the equivalent utility class when the app uses Lumo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KotlinRewriter

public KotlinRewriter()

Method Details

replaceFunctionCall

public ReplaceResult replaceFunctionCall(KotlinComponentInfo component,
 String function,
 Object value)

Sets a property, replacing the value the source already states or adding a statement where it states none.

Two behaviours here differ from the Java implementation, both deliberately:

• An explicit set is preferred over a constructor argument when the source has both. Java replaces the constructor argument first, which for Button("A") followed by button.text = "B" edits the argument and leaves the assignment still winning at runtime — so the panel appears to discard the edit. Editing whatever the panel is showing is the only self-consistent choice, and the panel shows the last set.
• The variable is never renamed. Java regenerates an auto-generated name from the new text, which means renaming every reference to it; that belongs with the operation that creates auto-generated names in the first place.

Specified by:

replaceFunctionCall in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to modify

function - the setter name

value - the new value, or null to remove the call

Returns:

a result that never carries a rename, per the note above

removePropertySetter

public void removePropertySetter(KotlinComponentInfo component,
 String setter)

Description copied from interface: CopilotRewriter

Removes a property setter call from the component.

Specified by:

removePropertySetter in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to modify

setter - the setter name

getPropertyValue

public Object getPropertyValue(KotlinComponentInfo component,
 String property)

Description copied from interface: CopilotRewriter

Reads a property's value from the source.

Specified by:

getPropertyValue in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to read

property - the property name

Returns:

a constant value where the source holds one, otherwise a SourceExpression for something that has to be evaluated, or null if the property is not set

addCall

public void addCall(KotlinComponentInfo component,
 String function,
 Object... parameters)

Description copied from interface: CopilotRewriter

Adds a call on the component, even if the same call is already present.

Specified by:

addCall in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to modify

function - the method to call

parameters - the arguments

replaceOrAddCall

public void replaceOrAddCall(KotlinComponentInfo component,
 String function,
 Object... parameters)

Description copied from interface: CopilotRewriter

Adds a call on the component, replacing an existing call to the same method.

Specified by:

replaceOrAddCall in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to modify

function - the method to call

parameters - the arguments

removeCalls

public void removeCalls(KotlinComponentInfo component,
 String function)

Description copied from interface: CopilotRewriter

Removes every call to the given method on the component.

Specified by:

removeCalls in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to modify

function - the method name

setStyle

public void setStyle(KotlinComponentInfo component,
 String property,
 String value)

Description copied from interface: CopilotRewriter

Sets an inline style, or the equivalent utility class when the app uses Lumo.

Specified by:

setStyle in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to modify

property - the CSS property

value - the CSS value

setSizing

public void setSizing(KotlinComponentInfo component,
 Map<String,String> changes)

Description copied from interface: CopilotRewriter

Sets width and height related properties.

Specified by:

setSizing in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to modify

changes - the properties to set, by name

setAlignment

public void setAlignment(KotlinComponentInfo component,
 AlignmentValues alignmentValues)

Description copied from interface: CopilotRewriter

Sets the component's flexbox alignment properties.

Specified by:

setAlignment in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to modify

alignmentValues - the alignment to apply

setGap

public void setGap(KotlinComponentInfo component,
 String all,
 String column,
 String row)

Description copied from interface: CopilotRewriter

Sets the gap between a layout's children.

Specified by:

setGap in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the layout to modify

all - the gap on both axes, or null to set them separately

column - the column gap

row - the row gap

setPadding

public void setPadding(KotlinComponentInfo component,
 String all,
 String top,
 String right,
 String bottom,
 String left)

Description copied from interface: CopilotRewriter

Sets a component's padding.

Specified by:

setPadding in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to modify

all - the padding on all sides, or null to set them separately

top - the top padding

right - the right padding

bottom - the bottom padding

left - the left padding

delete

public boolean delete(KotlinComponentInfo component)

Description copied from interface: CopilotRewriter

Deletes the component, along with the code that only existed to support it.

Specified by:

delete in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to delete

Returns:

true if the component was deleted

moveComponent

public void moveComponent(KotlinComponentInfo component,
 KotlinComponentInfo container,
 KotlinComponentInfo reference,
 Where where,
 MoveTemplateOptions options)

Description copied from interface: CopilotRewriter

Moves a component into a container, relative to a reference component.

Specified by:

moveComponent in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to move

container - the container to move it into

reference - the sibling to position against, or null to append

where - the position relative to the reference

options - the attach method and add-or-replace behaviour

duplicate

public void duplicate(KotlinComponentInfo component,
 List<KotlinComponentInfo> children)

Description copied from interface: CopilotRewriter

Duplicates a component together with the given children.

Specified by:

duplicate in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to duplicate

children - the children to duplicate with it

addComponentUsingTemplate

public List<KotlinComponentInfo> addComponentUsingTemplate(KotlinComponentInfo referenceComponent,
 Where where,
 List<CopilotComponent> template,
 AddTemplateOptions options)

Description copied from interface: CopilotRewriter

Adds components described by a template, as sent when dropping from the palette, pasting, or importing a design.

Specified by:

addComponentUsingTemplate in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

referenceComponent - the component to position against

where - the position relative to the reference

template - the components to create

options - how to declare and attach them

Returns:

the components that were created

mergeAndReplace

public void mergeAndReplace(List<KotlinComponentInfo> components,
 CopilotComponent wrapperComponent)

Description copied from interface: CopilotRewriter

Wraps the given components in a new container.

Specified by:

mergeAndReplace in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

components - the components to wrap

wrapperComponent - the container to wrap them in

extractComponent

public String extractComponent(KotlinComponentInfo component,
 IdentityHashMap<KotlinComponentInfo,List<KotlinComponentInfo>> componentChildren,
 String extractedComponentClassNameSuggestion)

Description copied from interface: CopilotRewriter

Extracts a component and its children into a class of their own.

Specified by:

extractComponent in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to extract

componentChildren - the children of each component, keyed by identity because these handles can be records whose equality changes as the source is rewritten

extractedComponentClassNameSuggestion - the suggested class name

Returns:

the name of the class that was created

addConstructorParameterToClass

public String addConstructorParameterToClass(KotlinComponentInfo referenceComponent,
 String parameterTypeName,
 String suggestedParameterName,
 boolean storeAsField)

Description copied from interface: CopilotRewriter

Adds a constructor parameter to the class the component is declared in, for injecting a service.

Specified by:

addConstructorParameterToClass in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

referenceComponent - a component in the target class

parameterTypeName - the parameter's type

suggestedParameterName - the suggested parameter name

storeAsField - whether to also store the parameter in a field

Returns:

the parameter name that was used

addComment

public void addComment(KotlinComponentInfo component,
 String comment,
 CommentType commentType)

Description copied from interface: CopilotRewriter

Adds a comment next to the component.

Specified by:

addComment in interface CopilotRewriter<KotlinComponentInfo>

Parameters:

component - the component to comment on

comment - the comment text

commentType - whether to write a line or block comment