com.aaronicsubstances.code.augmentor.core.util

Class CodeGenerationResponseProcessor

java.lang.Object

com.aaronicsubstances.code.augmentor.core.util.CodeGenerationResponseProcessor

public class CodeGenerationResponseProcessor
extends java.lang.Object

Contains helper methods used by code generation responses processing to merge generated code content into source code files.

Constructor Summary

Constructors

Constructor and Description
CodeGenerationResponseProcessor()

Method Summary

Modifier and Type	Method and Description
static int[]	determineReplacementRange(CodeSnippetDescriptor snippetDescriptor, GeneratedCode genCode) Determines the substring of a source code file which should be replaced by generated code content.
static java.lang.String	ensureEndingNewline(java.lang.String code, java.lang.String newline) Appends a newline to a string unless the string already ends with a newline.
static java.lang.String	getEffectiveIndent(CodeSnippetDescriptor snippetDescriptor, GeneratedCode genCode) Determines effective indent to apply to generated code content.
static boolean	getShouldEnsureEndingNewline(GeneratedCode genCode) Determines whether content of generated code should be appended with newline if it doesn't end with one.
static void	indentCode(java.util.List<GeneratedCode.ContentPart> contentParts, java.lang.String indent) Modified content parts in place to insert indents before each occurring line.
static void	repairSplitCrLfs(java.util.List<GeneratedCode.ContentPart> contentParts) Modifies content parts to remove split CR-LFs, that is, a sequence of carriage return and line feed which are split across content parts, so that the carriage return character ends a content part, and the following content part starts with the line feed character.
static boolean	shouldWrapInGenCodeDirectives(GeneratedCode genCode, CodeSnippetDescriptor.GeneratedCodeDescriptor generatedCodeDescriptor) Determines whether generated code content should be wrapped in start/end directives.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeGenerationResponseProcessor

public CodeGenerationResponseProcessor()

Method Detail

determineReplacementRange

public static int[] determineReplacementRange(CodeSnippetDescriptor snippetDescriptor,
                                              GeneratedCode genCode)

Determines the substring of a source code file which should be replaced by generated code content.

Parameters:

snippetDescriptor - object containing location descriptors for a generated code object and its corresponding augmenting code object.

genCode - generated code object.

Returns:

2-element int array in which first int is starting index (inclusive) of substring and second int is ending index (exclusive) of substring.

getShouldEnsureEndingNewline

public static boolean getShouldEnsureEndingNewline(GeneratedCode genCode)

Determines whether content of generated code should be appended with newline if it doesn't end with one.

Parameters:

genCode - generated code object

Returns:

true to indicate that newline should be appended; false to skip appending of newline.

ensureEndingNewline

public static java.lang.String ensureEndingNewline(java.lang.String code,
                                                   java.lang.String newline)

Appends a newline to a string unless the string already ends with a newline.

Parameters:

code - string to append newline to

newline - newline variant to use

Returns:

string which ends with newline.

repairSplitCrLfs

public static void repairSplitCrLfs(java.util.List<GeneratedCode.ContentPart> contentParts)

Modifies content parts to remove split CR-LFs, that is, a sequence of carriage return and line feed which are split across content parts, so that the carriage return character ends a content part, and the following content part starts with the line feed character.

The indentCode(List, String) method depend on the absence of split CR-LFs.

Parameters:

contentParts - content parts to be modified.

getEffectiveIndent

public static java.lang.String getEffectiveIndent(CodeSnippetDescriptor snippetDescriptor,
                                                  GeneratedCode genCode)

Determines effective indent to apply to generated code content.

Parameters:

snippetDescriptor - descriptor of augmenting code and generated code sections corresponding to generated code object.

genCode - generated code object.

Returns:

indent to apply or empty string if no indent should be applied.

shouldWrapInGenCodeDirectives

public static boolean shouldWrapInGenCodeDirectives(GeneratedCode genCode,
                                                    CodeSnippetDescriptor.GeneratedCodeDescriptor generatedCodeDescriptor)

Determines whether generated code content should be wrapped in start/end directives.

Parameters:

genCode - generated code object

generatedCodeDescriptor - generated code descriptor

Returns:

true if wrapping should be done; false if wrapping should be skipped.

indentCode

public static void indentCode(java.util.List<GeneratedCode.ContentPart> contentParts,
                              java.lang.String indent)

Modified content parts in place to insert indents before each occurring line.

Precondition: repairSplitCrLfs(List) should have been called on content parts.

Postcondition: the result of the indentation should be the same as indenting the string resulting from concatenating the content parts directly.

Parameters:

contentParts - content parts to be modified.

indent - indent to apply.