Package org.machanism.machai.gw.processor

Class GuidanceProcessor

java.lang.Object

org.machanism.machai.project.ProjectProcessor

org.machanism.machai.gw.processor.AbstractFileProcessor

org.machanism.machai.gw.processor.AIFileProcessor

org.machanism.machai.gw.processor.GuidanceProcessor

public class GuidanceProcessor
extends AIFileProcessor

Scans a project tree, extracts per-file @guidance directives through Reviewers, and dispatches the resulting prompts to a configured Genai.

The processor supports single-module and multi-module project layouts. For multi-module builds, modules are processed child-first (each module is scanned before the parent project directory). Processing is traversal-based; it does not attempt to build projects or resolve dependencies.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GUIDANCE_TAG_NAME	Tag name for guidance comments.

Fields inherited from class org.machanism.machai.gw.processor.AIFileProcessor

CONTINUE_SPECIAL_PROMPT_COMMAND, EXIT_SPECIAL_PROMPT_COMMAND, FILE_INCLUDED_MARKER, GW_TEMP_DIR, LOG_OUTPUT_PREFIX, NOT_DEFINED_VALUE, PUBLIC_PROP_GROUP_NAME

Fields inherited from class org.machanism.machai.gw.processor.AbstractFileProcessor

GW_PROJECT_LAYOUT_PROP_PREFIX

Fields inherited from class org.machanism.machai.project.ProjectProcessor

MACHAI_TEMP_DIR

Constructor Summary

Constructors

Constructor	Description
GuidanceProcessor(File rootDir, String genai, Configurator configurator)	Constructs a new GuidanceProcessor for processing files with guidance tags.

Method Summary

Modifier and Type	Method	Description
static boolean	deleteTempFiles(File basedir)	Deletes the input-log temporary directory.
List<Map<String,Object>>	getReport()
protected boolean	match(File file, File projectDir)	Applies matching logic and default-guidance behavior.
String	process(ProjectLayout projectLayout, File file, String guidance)	Composes the final prompt and dispatches it to the configured provider.
protected void	processFile(ProjectLayout projectLayout, File file)	Extracts guidance for a file and, when present, performs provider processing.
protected void	processModule(File projectDir, String module)	Processes a module directory.
protected void	processParentFiles(ProjectLayout projectLayout)	Processes files and folders under the parent project directory (excluding modules).

Methods inherited from class org.machanism.machai.gw.processor.AIFileProcessor

addTool, getDefaultPrompt, getInstructions, getModel, getProcessInfo, input, isInteractive, isLogInputs, parseLines, process, processFolder, scanDocuments, setDefaultPrompt, setInstructions, setInteractive, setLogInputs, setModel, setProjectLayoutContext

Methods inherited from class org.machanism.machai.gw.processor.AbstractFileProcessor

getConfigurator, getExcludes, getModuleThreadTimeoutMinutes, getPath, getPathMatcher, getRootDir, isModuleDir, isNonRecursive, processProjectDir, scanFolder, setDegreeOfConcurrency, setExcludes, setModuleThreadTimeoutMinutes, setNonRecursive, setPath, setPathMatcher, shouldExcludePath

Methods inherited from class org.machanism.machai.project.ProjectProcessor

getProjectLayout

Methods inherited from class java.lang.Object

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

Field Details

GUIDANCE_TAG_NAME

public static final String GUIDANCE_TAG_NAME

Tag name for guidance comments.

See Also:

• Constant Field Values

Constructor Details

GuidanceProcessor

public GuidanceProcessor(File rootDir,
 String genai,
 Configurator configurator)

Constructs a new GuidanceProcessor for processing files with guidance tags.

Initializes the processor with the specified root directory, GenAI model identifier, and configuration. Logs the root directory and GenAI model (if provided), and loads reviewer information for guidance processing.

Parameters:

rootDir - the root directory to scan for files

genai - the GenAI model identifier to use for processing (may be null)

configurator - the configuration object for property resolution and runtime settings

Method Details

match

protected boolean match(File file,
 File projectDir)

Applies matching logic and default-guidance behavior.

Overrides:

match in class AbstractFileProcessor

Parameters:

file - candidate file/directory

projectDir - current project directory

Returns:

true when the candidate should be processed

processModule

protected void processModule(File projectDir,
 String module)
                      throws IOException

Processes a module directory.

When a scan directory or pattern is configured, modules are only processed when the module itself matches or contains the scan directory.

Overrides:

processModule in class ProjectProcessor

Parameters:

projectDir - parent project directory

module - module relative path

Throws:

IOException - if scanning the module fails

processParentFiles

protected void processParentFiles(ProjectLayout projectLayout)
                           throws IOException

Processes files and folders under the parent project directory (excluding modules).

Overrides:

processParentFiles in class AbstractFileProcessor

Parameters:

projectLayout - project layout

Throws:

IOException - if file reading fails

processFile

protected void processFile(ProjectLayout projectLayout,
 File file)
                    throws IOException

Extracts guidance for a file and, when present, performs provider processing.

Overrides:

processFile in class AbstractFileProcessor

Parameters:

projectLayout - project layout

file - file to process

Throws:

IOException - if reading the file or provider execution fails

process

public String process(ProjectLayout projectLayout,
 File file,
 String guidance)

Composes the final prompt and dispatches it to the configured provider.

Overrides:

process in class AIFileProcessor

Parameters:

projectLayout - project layout

file - file currently being processed

guidance - extracted guidance and/or default guidance

Returns:

provider output

deleteTempFiles

public static boolean deleteTempFiles(File basedir)

Deletes the input-log temporary directory.

Parameters:

basedir - project base directory

Returns:

true if the directory was deleted, otherwise false

getReport

public List<Map<String,Object>> getReport()

Returns:

the report