Index (Ghostwriter 1.2.1-SNAPSHOT API)

A C D E F G H I J L M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractFileProcessor - Class in org.machanism.machai.gw.processor: Base implementation for processors that traverse a project directory and perform work on files and folders.
AbstractFileProcessor(File, Configurator) - Constructor for class org.machanism.machai.gw.processor.AbstractFileProcessor: Creates a new file processor.
ACT_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for the default act.
Act format - Search tag in class org.machanism.machai.gw.processor.ActProcessor: Section
ActFunctionTools - Class in org.machanism.machai.gw.tools: Provides function tools for managing and executing Ghostwriter Acts within a project.
ActFunctionTools() - Constructor for class org.machanism.machai.gw.tools.ActFunctionTools
ActNotFound - Exception Class in org.machanism.machai.gw.processor: Exception thrown when a requested act definition cannot be found.
ActNotFound(String, String) - Constructor for exception class org.machanism.machai.gw.processor.ActNotFound: Creates an exception for the missing act name.
ActProcessor - Class in org.machanism.machai.gw.processor: Processor that runs Ghostwriter in "Act" mode.
ActProcessor(File, String, Configurator) - Constructor for class org.machanism.machai.gw.processor.ActProcessor: Creates an act processor.
actPrompts(String) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
ACTS_BASENAME_PREFIX - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Classpath base directory for built-in act definitions.
ACTS_LOCATION_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for the custom acts location.
ActSpecFunctionTools - Class in org.machanism.machai.gw.tools: Provides functional tools for episode navigation and control within the ActProcessor context.
ActSpecFunctionTools() - Constructor for class org.machanism.machai.gw.tools.ActSpecFunctionTools
addResults(String) - Method in class org.machanism.machai.gw.processor.ActProcessor
addTool(FunctionTools) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Adds a tool definition that will be exposed to the AI provider.
AIFileProcessor - Class in org.machanism.machai.gw.processor: File processor implementation that prepares project context and prompts for a configured AI provider and optionally supports interactive execution.
AIFileProcessor(File, Configurator, String) - Constructor for class org.machanism.machai.gw.processor.AIFileProcessor: Creates a processor for the given project directory and AI provider identifier.
append(String) - Method in class org.machanism.machai.gw.tools.LogBuilder: Appends the specified text to the internal log buffer and optionally persists it to disk.
applyPatch(String, List<String>, Charset) - Static method in class org.machanism.machai.gw.tools.PatchApplier: Applies a unified diff patch to a file.
applyPatchToFile(String, String, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
Architecture overview - Search tag in Overview: Section
Authentication - Search tag in class org.machanism.machai.gw.tools.WebFunctionTools: Section

C

callRestApi(String, String, Map<String, String>, String, int, String, File, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Executes a REST API call to the specified URL using the given HTTP method.
clear() - Method in class org.machanism.machai.gw.tools.LogBuilder: Clears the retained content and resets the truncation flag.
CommandFunctionTools - Class in org.machanism.machai.gw.tools: Provides function tools for executing and managing system commands within a project context.
CommandFunctionTools() - Constructor for class org.machanism.machai.gw.tools.CommandFunctionTools
CommandSecurityChecker - Class in org.machanism.machai.gw.tools: Loads and evaluates command deny-list rules used by host-side command execution tools.
CommandSecurityChecker(Configurator) - Constructor for class org.machanism.machai.gw.tools.CommandSecurityChecker: Creates a new checker and loads deny-list rules from an operating-system specific classpath resource.
CommandSpecFunctionTools - Class in org.machanism.machai.gw.tools: Provides function tools for task and execution control within the AIFileProcessor context.
CommandSpecFunctionTools() - Constructor for class org.machanism.machai.gw.tools.CommandSpecFunctionTools
CONFIG_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: System property used to override the configuration file name.
CONTINUE_SPECIAL_PROMPT_COMMAND - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: The command string used in interactive mode to skip additional prompts and continue execution.

D

deleteTempFiles(File) - Static method in class org.machanism.machai.gw.processor.GuidanceProcessor: Deletes the input-log temporary directory.
denyCheck(String) - Method in class org.machanism.machai.gw.tools.CommandSecurityChecker: Checks whether the supplied command matches any deny-list rule.
DenyException - Exception Class in org.machanism.machai.gw.tools: Exception thrown when a command fails a deny-list security check.
DenyException(String) - Constructor for exception class org.machanism.machai.gw.tools.DenyException: Creates a new exception with a human-readable reason.

E

endTask(String) - Method in class org.machanism.machai.gw.tools.CommandSpecFunctionTools: Completes the current task by throwing an EndTaskException.
EndTaskException - Exception Class in org.machanism.machai.gw.tools: Exception used to signal the end of a task without terminating the application.
EndTaskException(String) - Constructor for exception class org.machanism.machai.gw.tools.EndTaskException: Constructs a new EndTaskException with the specified detail message.
EpisodeNotFoundException - Exception Class in org.machanism.machai.gw.processor: Exception thrown when an episode cannot be resolved by name.
EpisodeNotFoundException(String) - Constructor for exception class org.machanism.machai.gw.processor.EpisodeNotFoundException: Creates an exception for the unresolved episode name.
Episodes - Class in org.machanism.machai.gw.processor: Maintains ordered act episodes and provides execution helpers for normal, selected, repeated, and redirected episode flow.
Episodes(ActProcessor) - Constructor for class org.machanism.machai.gw.processor.Episodes
EXCLUDES_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for excluded paths.
executeCommand(String, Map<String, String>, String, int, String, File, Configurator) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools: Executes a system command using Java's ProcessBuilder for controlled and secure execution.
Execution - Search tag in class org.machanism.machai.gw.processor.ActProcessor: Section
EXIT_SPECIAL_PROMPT_COMMAND - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: The command string used in interactive mode to terminate and exit the processing session immediately.
extractPackageName(String) - Static method in class org.machanism.machai.gw.reviewer.JavaReviewer: Extracts the declared package name from a Java source snippet.

F

FILE_INCLUDED_MARKER - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: The special string marker used to indicate that an instruction line refers to an external file or resource that should be fetched and embedded.
FileFunctionTools - Class in org.machanism.machai.gw.tools: Installs file-system tools into a Genai.
FileFunctionTools() - Constructor for class org.machanism.machai.gw.tools.FileFunctionTools

G

getActDetails(String, File, Configurator) - Method in class org.machanism.machai.gw.tools.ActFunctionTools: Loads the details of a specific Act template, including instructions, input template, and configuration options.
getActInformation(int) - Method in class org.machanism.machai.gw.processor.Episodes: Returns episode information as a JSON object.
getActResult(String) - Method in class org.machanism.machai.gw.tools.ActFunctionTools: Retrieves the result of a previously started Act by its GUID.
getCommandLogPath(String, String) - Static method in class org.machanism.machai.gw.tools.LogBuilder: Returns the path to the log file for the given log identifier.
getConfigurator() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns the configuration source for this processor.
getDefaultPrompt() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Returns the default prompt used for folder processing.
getEpisodeId() - Method in exception class org.machanism.machai.gw.tools.MoveToEpisodeException: Returns the requested target episode id.
getEpisodeId(Integer, MoveToEpisodeException) - Method in class org.machanism.machai.gw.processor.Episodes: Resolves the next episode index from a move request exception.
getEpisodeIdByName(String) - Method in class org.machanism.machai.gw.processor.Episodes: Returns the zero-based index of the episode whose prompt text contains a heading that matches the specified episode name.
getEpisodeName(int) - Method in class org.machanism.machai.gw.processor.Episodes: Extracts and returns the episode name (heading) from the prompt text of the episode at the specified index.
getEpisodes() - Method in class org.machanism.machai.gw.processor.Episodes: Returns the configured episode prompts.
getExcludes() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns the exclude patterns configured for this processor.
getExitCode() - Method in exception class org.machanism.machai.gw.tools.ProcessTerminationException: Returns the desired exit code.
getGuidancePrompt(String, String) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools
getGuidanceTaggedFiles(String, String, File, Configurator) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools: Scans the specified directory and its subdirectories for files annotated with guidance tags, returning a mapping of project directories to the files that contain such tags.
getInstructions() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Returns the current base instructions used for processing.
getLogMatches(String, String, String) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools: Searches a persisted command log for all substrings matching the supplied Java regular expression.
getModel() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Returns the configured AI model or provider identifier.
getModuleThreadTimeoutMinutes() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns the timeout (in minutes) to wait for module processing completion during shutdown.
getName() - Method in exception class org.machanism.machai.gw.processor.ActNotFound: Returns the missing act name.
getName() - Method in class org.machanism.machai.gw.processor.Episodes: Returns the act name associated with these episodes.
getName() - Method in exception class org.machanism.machai.gw.tools.MoveToEpisodeException: Returns the requested target episode name.
getPath() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns the scan directory used to derive match semantics.
getPathMatcher() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns the matcher used to decide whether a file is included.
getPreviousLogChunk(String, int, int, String) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools: Retrieves the chunk of previously captured command output that immediately precedes the current tail window.
getProcessGuidanceTagFilesResult(String) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools: Retrieves the result of a previously started guidance tag file processing by its GUID.
getProcessInfo(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
getProjectContextVariable(String, File) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools: Retrieves the value of a variable from the project-specific context.
getPrompt(File, File, String) - Method in class org.machanism.machai.gw.reviewer.TextReviewer: Formats the raw guidance content into a prompt fragment.
getRecursiveFiles(String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Implements get_recursive_file_list.
getRecursiveFolders(String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Implements get_recursive_folder_list.
getRelativePath(File, File, boolean) - Static method in class org.machanism.machai.gw.tools.FileFunctionTools: Computes a project-relative path string.
getReport() - Method in class org.machanism.machai.gw.processor.GuidanceProcessor
getReport() - Method in class org.machanism.machai.gw.tools.LogBuilder: Returns a report of the log state, including log ID, retained tail, total length, truncation status, and elapsed process time in milliseconds.
getResults() - Method in class org.machanism.machai.gw.processor.ActProcessor
getRootDir() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns the root directory used as a base for relative paths.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.HtmlReviewer: Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.JavaReviewer: Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.MarkdownReviewer: Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.PumlReviewer: Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.PythonReviewer
getSupportedFileExtensions() - Method in interface org.machanism.machai.gw.reviewer.Reviewer: Returns the file extensions (without the dot) that this reviewer can process.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.TextReviewer: Returns the file extensions supported by this reviewer.
getSupportedFileExtensions() - Method in class org.machanism.machai.gw.reviewer.TypeScriptReviewer
getTail() - Method in class org.machanism.machai.gw.tools.LogBuilder: Returns the retained content.
getTotalLength() - Method in class org.machanism.machai.gw.tools.LogBuilder: Returns the total number of characters ever appended to this builder.
getWebContent(String, Map<String, String>, int, String, boolean, String, File, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Fetches the content of a web page using an HTTP GET request.
Ghostwriter - Search tag in Overview: Section
Ghostwriter - Class in org.machanism.machai.gw.processor: Command-line entry point for the Ghostwriter application.
GUIDANCE_TAG_NAME - Static variable in class org.machanism.machai.gw.processor.GuidanceProcessor: Tag name for guidance comments.
GuidanceFunctionTools - Class in org.machanism.machai.gw.tools: Provides function tools for discovering and processing files with guidance tags in project directories.
GuidanceFunctionTools() - Constructor for class org.machanism.machai.gw.tools.GuidanceFunctionTools
GuidanceProcessor - Class in org.machanism.machai.gw.processor: Scans a project tree, extracts per-file @guidance directives through Reviewers, and dispatches the resulting prompts to a configured Genai.
GuidanceProcessor(File, String, Configurator) - Constructor for class org.machanism.machai.gw.processor.GuidanceProcessor: Constructs a new GuidanceProcessor for processing files with guidance tags.
GW_PROJECT_LAYOUT_PROP_PREFIX - Static variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Prefix for project-layout properties exposed for template substitution.
GW_PROPERTIES_FILE_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Default Ghostwriter properties file name.
GW_TEMP_DIR - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: The temporary folder name used within the project environment for writing input and prompt logs.
GWConstants - Class in org.machanism.machai.gw.processor: Central constants used by Ghostwriter configuration and runtime processing.

H

Header variable placeholders - Search tag in class org.machanism.machai.gw.tools.WebFunctionTools: Section
HOME_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: System property holding the Ghostwriter home directory.
HtmlReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for HTML and XML files (.html, .htm, .xml).
HtmlReviewer() - Constructor for class org.machanism.machai.gw.reviewer.HtmlReviewer

I

input() - Method in class org.machanism.machai.gw.processor.AIFileProcessor
INPUTS_PROPERTY_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: TOML property name containing prompt inputs/episodes.
Installed tools - Search tag in class org.machanism.machai.gw.tools.FileFunctionTools: Section
INSTRUCTIONS_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for system instructions.
INTERACTIVE_MODE_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property controlling interactive mode.
isInteractive() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Indicates whether interactive processing mode is enabled.
isLogInputs() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Indicates whether provider input logging is enabled.
isModuleDir(ProjectLayout, File) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Checks whether dir is one of the project module directories.
isNonRecursive() - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns whether recursion into modules/subdirectories is disabled.
isRegularOrder() - Method in class org.machanism.machai.gw.processor.Episodes: Returns whether no explicit episode subset has been selected.

J

JavaReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for Java source files (.java).
JavaReviewer() - Constructor for class org.machanism.machai.gw.reviewer.JavaReviewer

L

length() - Method in class org.machanism.machai.gw.tools.LogBuilder: Returns the number of characters currently retained.
listFiles(String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Implements list_files_in_directory.
loadAct(String, Map<String, Object>, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Loads an act definition into the provided map, supporting inheritance via the basedOn property.
LOG_EXTENSION - Static variable in class org.machanism.machai.gw.tools.LogBuilder: Standard file extension for log files.
LOG_OUTPUT_PREFIX - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: The format pattern used to prepend logger output blocks when reporting responses generated by the AI provider.
LogBuilder - Class in org.machanism.machai.gw.tools: A StringBuilder-like helper that retains only the last maxSize characters.
LogBuilder(String, int, String, File) - Constructor for class org.machanism.machai.gw.tools.LogBuilder: Creates a builder that keeps at most maxSize characters.

M

main(String[]) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Starts the Ghostwriter CLI.
MarkdownReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for Markdown files (.md).
MarkdownReviewer() - Constructor for class org.machanism.machai.gw.reviewer.MarkdownReviewer
match(File, File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Determines whether the specified file should be included for processing based on exclusion rules, path matching patterns, and project structure.
match(File, File) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Applies matching logic and default-guidance behavior.
MODEL_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for the active model/provider.
moveToEpisode(int, String) - Method in class org.machanism.machai.gw.tools.ActSpecFunctionTools: Moves to the next episode, or to the episode specified by 'id' or 'name' if provided.
MoveToEpisodeException - Exception Class in org.machanism.machai.gw.tools: Exception used to request a jump to another act episode during execution.
MoveToEpisodeException(Integer, String) - Constructor for exception class org.machanism.machai.gw.tools.MoveToEpisodeException: Creates a move request for an episode id or name.
MULTIPLE_LINES_BREAKER - Static variable in class org.machanism.machai.gw.processor.GWConstants: Line continuation marker used for multi-line console input.

N

NONRECURSIVE_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property controlling recursive module traversal.
NOT_DEFINED_VALUE - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: Fallback constant used as a placeholder string indicating a property value is undefined.

O

org.machanism.machai.gw.processor - Search tag in Overview: Section
org.machanism.machai.gw.processor - package org.machanism.machai.gw.processor: Ghostwriter processors and command-line orchestration.
org.machanism.machai.gw.reviewer - Search tag in Overview: Section
org.machanism.machai.gw.reviewer - package org.machanism.machai.gw.reviewer: Provides reviewer implementations that inspect project artifacts for embedded @guidance directives and convert matching files into prompt fragments for the Ghostwriter review pipeline.
org.machanism.machai.gw.tools - Search tag in Overview: Section
org.machanism.machai.gw.tools - package org.machanism.machai.gw.tools: Provides host-integrated function tool implementations used by Ghostwriter to expose local file-system, command-line, web, act-management, and project-context capabilities to AI providers.

P

Package overview - Search tag in Overview: Section
parseLines(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Normalizes multi-line input and resolves supported line references such as HTTP URLs and file: references.
PatchApplier - Class in org.machanism.machai.gw.tools: Utility to apply unified diff patches to text files.
PatchApplier() - Constructor for class org.machanism.machai.gw.tools.PatchApplier
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.HtmlReviewer: Reviews the given file and returns a formatted prompt fragment when guidance is present.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.JavaReviewer: Reviews the provided Java file and, if guidance is present, returns a formatted prompt fragment.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.MarkdownReviewer: Reviews the given Markdown file and returns a formatted prompt fragment when guidance is present.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.PumlReviewer: Reviews the given PlantUML file for contained guidance comments and formats the content for input to documentation generators.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.PythonReviewer
perform(File, File) - Method in interface org.machanism.machai.gw.reviewer.Reviewer: Reviews a file and returns a formatted fragment (often including file content and/or extracted guidance) for use by the Ghostwriter pipeline.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.TextReviewer: Reads and formats the guidance file if the provided file is named @guidance.txt.
perform(File, File) - Method in class org.machanism.machai.gw.reviewer.TypeScriptReviewer
performAct(String, File, Map<String, String>, boolean, Configurator) - Method in class org.machanism.machai.gw.tools.ActFunctionTools: Performs the specified Act by name.
popProjectContextVariable(String, String, File) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools: Removes and returns a value from a project context variable.
Primary processor types - Search tag in package org.machanism.machai.gw.processor: Section
process(ProjectLayout, File, String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Processes the given file using the currently configured instructions.
process(ProjectLayout, File, String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Composes the final prompt and dispatches it to the configured provider.
process(ProjectLayout, File, String, String...) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
processFile(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Extracts guidance for a file and, when present, performs provider processing.
processFile(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.ActProcessor: Executes the act against episodes single file.
processFile(ProjectLayout, File) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Extracts guidance for a file and, when present, performs provider processing.
processFolder(ProjectLayout) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Processes a project layout for documentation gathering.
processFolder(ProjectLayout) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Processes the project root folder using the configured default prompt.
processGuidanceTagFiles(File, Map<String, String>, String, boolean, Configurator) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools: Asynchronously processes files with guidance tags using the configured model.
Processing workflow - Search tag in Overview: Section
processModule(File, String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Processes a module directory.
processParentFiles(ProjectLayout) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Processes non-module files and directories directly under rootDir.
processParentFiles(ProjectLayout) - Method in class org.machanism.machai.gw.processor.ActProcessor: Processes files and folders under the parent project directory (excluding modules).
processParentFiles(ProjectLayout) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Processes files and folders under the parent project directory (excluding modules).
processProjectDir(ProjectLayout, String) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Processes files in a project directory matching a provided pattern or directory.
ProcessTerminationException - Exception Class in org.machanism.machai.gw.tools: Runtime exception used by terminate_process to signal early termination to the host.
ProcessTerminationException(int) - Constructor for exception class org.machanism.machai.gw.tools.ProcessTerminationException
ProcessTerminationException(String, int) - Constructor for exception class org.machanism.machai.gw.tools.ProcessTerminationException: Creates a termination exception.
ProcessTerminationException(String, Throwable, int) - Constructor for exception class org.machanism.machai.gw.tools.ProcessTerminationException: Creates a termination exception.
PROJECT_DIR_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Project directory configuration property name.
ProjectContextFunctionTools - Class in org.machanism.machai.gw.tools: Provides function tools for managing project-specific context variables.
ProjectContextFunctionTools() - Constructor for class org.machanism.machai.gw.tools.ProjectContextFunctionTools
PUBLIC_PROP_GROUP_NAME - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: The property group prefix used to filter which placeholders are resolved during the substitutor expansion phase.
PumlReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for PlantUML files (.puml).
PumlReviewer() - Constructor for class org.machanism.machai.gw.reviewer.PumlReviewer
Purpose - Search tag in Overview: Section
pushProjectContextVariable(String, String, File) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools: Pushes a value to a project context variable.
put(File, String, Object) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools: Sets or updates a variable in the context map for the specified project directory.
putProjectContextVariable(String, String, File) - Static method in class org.machanism.machai.gw.tools.ProjectContextFunctionTools: Sets or updates a variable in the project-specific context.
PythonReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for Python source files (.py).
PythonReviewer() - Constructor for class org.machanism.machai.gw.reviewer.PythonReviewer

R

readFile(String, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Implements read_file.
regularOrder(Integer, BiFunction<Integer, String, String>) - Method in class org.machanism.machai.gw.processor.Episodes: Executes episodes in regular order starting from the supplied zero-based index while honoring repeat and move requests.
repeateEpisode(String) - Method in class org.machanism.machai.gw.tools.ActSpecFunctionTools: Repeats the current episode by terminating the current execution and restarting the same episode, preserving the context.
RepeatEpisodeException - Exception Class in org.machanism.machai.gw.tools: Exception used to request that the current act episode be executed again.
RepeatEpisodeException() - Constructor for exception class org.machanism.machai.gw.tools.RepeatEpisodeException: Creates a repeat request for the current episode.
requestedOrder(BiFunction<Integer, String, String>) - Method in class org.machanism.machai.gw.processor.Episodes: Executes only the explicitly selected episodes in their requested order.
resolveWorkingDir(File, String) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools: Resolves a working directory relative to a canonical project directory.
Reviewer - Interface in org.machanism.machai.gw.reviewer: Service-provider interface (SPI) for components that scan project files and extract @guidance instructions for downstream processing.

S

SCAN_DIR_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for the scan path/pattern.
scanDocuments(File, String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Configures scanning based on the provided directory or path pattern and then starts scanning the project folder.
scanFolder(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Recursively scans project folders, processing documentation inputs for all found modules and files.
See also - Search tag in Overview: Section
setAct(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Loads an act definition and applies it as the current execution defaults.
setActsLocation(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Sets the directory used for loading external act definition files.
setDefaultPrompt(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Sets the default prompt used for folder processing.
setDegreeOfConcurrency(int) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets the degree of concurrency for multi-threaded module processing.
setDisableNormalOrder(boolean) - Method in class org.machanism.machai.gw.processor.ActProcessor: Enables or disables continuation with the default episode execution order.
setEpisodes(List<String>) - Method in class org.machanism.machai.gw.processor.Episodes: Replaces the current ordered episode list.
setExcludes(String[]) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets exclude patterns or paths.
setInstructions(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Sets the base instructions used for processing after normalizing line content and resolving supported references.
setInteractive(boolean) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Enables or disables interactive processing mode.
setLogInputs(boolean) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Enables or disables logging of provider inputs.
setModel(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Sets the AI model or provider identifier.
setModuleThreadTimeoutMinutes(long) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets the module processing shutdown timeout.
setName(String) - Method in class org.machanism.machai.gw.processor.Episodes: Sets the act name associated with these episodes.
setNonRecursive(boolean) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets whether scanning is restricted to the current directory only.
setPath(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets the scan directory that originated the current match operation.
setPathMatcher(PathMatcher) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Sets the path matcher used to include only matching files.
setProjectLayoutContext(ProjectLayout) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Sets the project layout context for the specified ProjectLayout by collecting key project metadata and directory information into a JSON object and storing it in the ProjectContextFunctionTools context map.
setSelectedEpisodes(List<Integer>) - Method in class org.machanism.machai.gw.processor.Episodes: Sets the list of explicitly requested episode identifiers.
shouldExcludePath(Path) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Determines whether a relative path should be excluded according to AbstractFileProcessor.excludes.
size() - Method in class org.machanism.machai.gw.processor.Episodes: Returns the number of configured episodes.
Supporting types - Search tag in package org.machanism.machai.gw.processor: Section

T

terminateExecution(String, int, File) - Method in class org.machanism.machai.gw.tools.CommandSpecFunctionTools: Terminates the application by throwing a ProcessTerminationException.
TextReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for generic guidance text files.
TextReviewer() - Constructor for class org.machanism.machai.gw.reviewer.TextReviewer
THREADS_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for worker thread count.
tryLoadActFromClasspath(Map<String, Object>, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Attempts to load an act definition from classpath resources.
tryLoadActFromDirectory(Map<String, Object>, String, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Attempts to load an act definition from episodes user-defined directory.
TypeScriptReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for TypeScript source files (.ts).
TypeScriptReviewer() - Constructor for class org.machanism.machai.gw.reviewer.TypeScriptReviewer
Typical usage - Search tag in package org.machanism.machai.gw.processor: Section

U

Usage Example - Search tag in class org.machanism.machai.gw.tools.WebFunctionTools: Section
Usage notes - Search tag in Overview: Section
USER_INPUT_PREFIX - Static variable in class org.machanism.machai.gw.processor.Ghostwriter

W

WebFunctionTools - Class in org.machanism.machai.gw.tools: Provides host-side HTTP retrieval tools for a Genai provider.
WebFunctionTools() - Constructor for class org.machanism.machai.gw.tools.WebFunctionTools
writeFile(String, String, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Implements write_file.

A C D E F G H I J L M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form