Index (Ghostwriter 1.3.3-SNAPSHOT API)

A B C D E F G H I J K L M N O P R S T U V 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.
accept(IOException) - Method in interface org.machanism.machai.gw.tools.CommandFunctionTools.ErrorConsumer: Called when an IOException occurs while reading a stream.
accept(String) - Method in interface org.machanism.machai.gw.tools.CommandFunctionTools.LineConsumer: Consumes a single line of output.
ACT_DEFAULT_PROPS_SECTION_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Prefix section designating default fallback values inside the loaded configurations.
ACT_EXECUTION_INFORMATION_PREFIX - Static variable in class org.machanism.machai.gw.processor.ActProcessor
ACT_FOLDER_NAME - Static variable in class org.machanism.machai.gw.tools.ActFunctionTools
ACT_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
ACT_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: System property used to specify the default action (Act) to run when no explicit act string is provided.
actBundle - Variable in class org.machanism.machai.gw.processor.ActProcessor: Resource bundle supplying prompt templates for generators.
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
actProcessor - Variable in class org.machanism.machai.gw.processor.Episodes
ActProcessor - Class in org.machanism.machai.gw.processor: Processes named action definitions (“acts”) and executes their prompts against a project, a project directory, or matching files by delegating the actual AI interaction to AIFileProcessor.
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: AI prompt template that instructs the caller to execute an Act identified by name.
actProperties - Variable in class org.machanism.machai.gw.processor.ActProcessor: Map holding the accumulated act configuration properties loaded for execution.
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 specifying the location of external act definition files (*.toml).
ACTS_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
actsLocation - Variable in class org.machanism.machai.gw.processor.ActProcessor: Optional directory containing external *.toml act files.
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
addMatchingFile(List<File>, PathMatcher, File, File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Adds a file to the result when it is eligible for the requested pattern.
addResults(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Appends a string result item to the execution list.
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 that drives a configured Genai provider with project-aware context, prompt metadata, optional external prompt inclusions, public configuration substitution, and function-tool registration.
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.
appendContinuedLine(StringBuilder, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Appends a continued input line to the buffer, stripping the trailing continuation marker and replacing it with the platform line separator.
applyActData(Map<String, Object>) - Method in class org.machanism.machai.gw.processor.ActProcessor: Applies loaded act data to this processor's configuration and runtime settings.
applyCommonSettings(AIFileProcessor, Ghostwriter.RuntimeSettings) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Applies shared processor settings — instructions, excludes, and concurrency — to the given processor, skipping any setting that was not resolved.
applyConcurrency(AIFileProcessor, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Applies the configured concurrency (thread count) setting to the processor when present, logging the resolved value at INFO level.
applyDefaultValues(Map<String, Object>) - Method in class org.machanism.machai.gw.processor.ActProcessor: Populates default properties from the act data, applying configurations and falling back to active configurator values when required.
applyEpisodeSelection(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Parses and registers specified episode boundaries from an argument string.
applyExcludes(AIFileProcessor, String[]) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Applies exclude patterns to the processor when configured, logging the full list at INFO level.
applyInstructions(AIFileProcessor, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Applies custom instructions to the processor when present, logging an abbreviated version of the text at INFO level.
applyPatch(File, List<String>, Charset) - Static method in class org.machanism.machai.gw.tools.PatchApplier: Applies a unified or simplified diff patch to a file.
applyPatchToFile(File, String, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Implements apply_patch_to_file.
applyPromptValues(String, Map<String, Object>) - Method in class org.machanism.machai.gw.processor.ActProcessor: Configures user prompt metadata, falling back to act-specified defaults if empty.
applySelectorIfPresent(String, String) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Applies a CSS selector to the response HTML if one was provided.
applyStringActData(String, String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Applies a single string property to processor state or configuration.
applyStringProperty(String, String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Applies a resolved string property by dispatching to the matching processor setting.
applyTools(String, String[], Genai, String[]) - Method in class org.machanism.machai.gw.processor.ActProcessor: Applies the tools configured for an act episode, including automatic tool selection requested through the episode's YAML front matter.
applyTools(String, String[], Genai, String[]) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Registers the selected discovered tools and the tools explicitly added to this processor with the provider for the current request.
autoToolsMap - Variable in class org.machanism.machai.gw.processor.ActProcessor: Cached automatically selected tools, keyed by act name and episode ID.

B

BASED_ON_PROPERTY_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Key used to denote inheritance by naming the base configuration to extend.

C

callRestApi(String, String, Map<String, String>, String, int, String, File, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Functional AI tool that 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.
close() - Method in class org.machanism.machai.gw.tools.CommandFunctionTools.ExecutorServiceAutoCloseable: Shuts down the wrapped executor immediately.
CMD_LOG_PREFIX - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools
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
CommandFunctionTools.ErrorConsumer - Interface in org.machanism.machai.gw.tools: Functional interface used for handling stream read failures.
CommandFunctionTools.ExecutorServiceAutoCloseable - Class in org.machanism.machai.gw.tools: Auto-closeable wrapper for ExecutorService so it can be used with try-with-resources.
CommandFunctionTools.LineConsumer - Interface in org.machanism.machai.gw.tools: Functional interface used for streaming output line processing.
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_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
CONFIG_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: System property used to override the default configuration file name.
configurator - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Configuration source used to initialize providers.
configureActsLocation(CommandLine, PropertiesConfigurator, ActProcessor) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Configures a custom acts location on the given processor when one is provided via the --acts command-line option or configuration.
configureDefaultAct(CommandLine, PropertiesConfigurator, Scanner, ActProcessor) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Configures the default act to run when act mode is enabled.
contextProjectMap - Static variable in class org.machanism.machai.gw.tools.ProjectContextFunctionTools: Map of project directories to their context variable maps.
CONTINUE_SPECIAL_PROMPT_COMMAND - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: Interactive-mode command that accepts the current response and continues processing without sending another prompt to the provider.
createActProcessor(Scanner, PropertiesConfigurator, Ghostwriter.RuntimeSettings) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Creates an ActProcessor with console-backed interactive input, overriding AIFileProcessor.input() to read from the CLI scanner instead of the default input source.
createOptions() - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Creates the supported CLI option definitions.
createProcessor(Scanner, PropertiesConfigurator, CommandLine, Ghostwriter.RuntimeSettings) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Creates either a GuidanceProcessor (default mode) or an ActProcessor (when --act is specified), fully configured for the current run.

D

DEFAULT_CHARSET - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools: Default character set used to decode process output streams.
DEFAULT_CHARSET - Static variable in class org.machanism.machai.gw.tools.FileFunctionTools: Default character set used when reading or writing text files.
DEFAULT_CHARSET - Static variable in class org.machanism.machai.gw.tools.WebFunctionTools: Default response character set used by the HTTP tools.
DEFAULT_MODEL_MSG - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
DEFAULT_RESULT_TAIL_SIZE - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools: Default maximum number of characters to return from captured process output.
DEFAULT_TASK_MARKER - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Shorthand command prefix indicating that the raw prompt should be interpreted and executed directly as a standard, ad-hoc agent task command.
defaultPrompt - Variable in class org.machanism.machai.gw.processor.AIFileProcessor: Default fallback prompt used to process directories or projects when no specific file prompt is given.
denyCheck(String) - Method in class org.machanism.machai.gw.tools.CommandSecurityChecker: Checks whether the supplied command matches any deny-list rule.
DenyException - Exception in org.machanism.machai.gw.tools: Exception thrown when a command fails a deny-list security check.
DenyException(String) - Constructor for exception org.machanism.machai.gw.tools.DenyException: Creates a new exception with a human-readable reason.
denyKeywords - Variable in class org.machanism.machai.gw.tools.CommandSecurityChecker
DENYLIST_PROP_NAME - Static variable in class org.machanism.machai.gw.tools.CommandSecurityChecker: Configuration property allowing the host to inject/extend the deny-list.
denyPatterns - Variable in class org.machanism.machai.gw.tools.CommandSecurityChecker
disableNormalOrder - Variable in class org.machanism.machai.gw.processor.ActProcessor: Whether normal sequential execution should be skipped after explicit episode processing.
DOCS_DIRS - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: A formatted list/line describing the path information for documentation directories.

E

ENABLED_TOOLS_PARAM_NAME - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: Parameter name used to configure the list of tool definitions exposed to the LLM agent during an episode.
endTask(String) - Method in class org.machanism.machai.gw.tools.CommandSpecFunctionTools: AI functional tool that completes the current task by throwing an EndTaskException.
EndTaskException - Exception in org.machanism.machai.gw.tools: Exception used to signal the end of a task without terminating the application.
EndTaskException(String) - Constructor for exception org.machanism.machai.gw.tools.EndTaskException: Constructs a new EndTaskException with the specified detail message.
EPISODE_DELIMETER - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Divider symbol linking the base act name to an optional explicit subset of episodes.
episodeId - Variable in exception org.machanism.machai.gw.tools.MoveToEpisodeException
EpisodeNotFoundException - Exception in org.machanism.machai.gw.processor: Exception thrown when an episode cannot be resolved by name.
EpisodeNotFoundException(String) - Constructor for exception org.machanism.machai.gw.processor.EpisodeNotFoundException: Creates an exception for the unresolved episode name.
episodes - Variable in class org.machanism.machai.gw.processor.ActProcessor: The episodes container managed by this processor.
episodes - Variable in class org.machanism.machai.gw.processor.Episodes: Ordered list of act episode prompts to execute.
Episodes - Class in org.machanism.machai.gw.processor: Maintains an ordered collection of act episode prompts and provides execution helpers that support several playback strategies.
Episodes(ActProcessor) - Constructor for class org.machanism.machai.gw.processor.Episodes
excludes - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Optional list of path patterns or exact paths to exclude.
excludes - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings: Exclude patterns to skip during scanning, or null if not configured.
EXCLUDES_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
EXCLUDES_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for excluded paths.
execute(Scanner, PropertiesConfigurator, CommandLine, Ghostwriter.RuntimeSettings) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Creates and runs the selected processor (guidance or act mode) against the resolved scan paths, then applies the resulting exit code.
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.
executor - Variable in class org.machanism.machai.gw.tools.CommandFunctionTools.ExecutorServiceAutoCloseable
ExecutorServiceAutoCloseable(ExecutorService) - Constructor for class org.machanism.machai.gw.tools.CommandFunctionTools.ExecutorServiceAutoCloseable: Creates a wrapper for the supplied executor service.
EXIT_CODE_ERROR - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
EXIT_SPECIAL_PROMPT_COMMAND - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: Interactive-mode command that terminates processing immediately by throwing a ProcessTerminationException with exit code 0.
exitCode - Variable in exception org.machanism.machai.gw.tools.ProcessTerminationException
extractInputParams(String, Map<String, Object>) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Extracts supported YAML front-matter input parameters from the beginning of a prompt.
extractPackageName(String) - Static method in class org.machanism.machai.gw.reviewer.JavaReviewer: Extracts the declared package name from a Java source snippet.

F

fetchHttpContent(String, Map<String, String>, int, String, URI, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Fetches HTTP content for a parsed URI.
FILE_INCLUDED_MARKER - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: Prefix marker for prompt lines that include external content.
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
fillHeader(Map<String, String>, HttpURLConnection, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Applies HTTP headers to the given connection, resolving any property placeholders.
findHunkStart(List<String>, List<String>, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
FIRST_WHITESPACE - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Pre-compiled regex pattern to identify the first whitespace character in arguments.
folder - Variable in class org.machanism.machai.gw.tools.LogBuilder: Name of the directory where log files are stored.
formatConsole(Console, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Writes a prompt message to the console when available.
FRONT_MATTER_MARKER - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
functionTools - Variable in class org.machanism.machai.gw.processor.AIFileProcessor: Collection of user-configured function tools that are registered with and made available to the AI provider.
functionToolsLoader - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: Loader utility responsible for discovering, instantiating, and applying functional tools to the AI provider.

G

genai - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings: Configured AI provider/model identifier (e.g.
get() - Method in class org.machanism.machai.gw.tools.CommandFunctionTools.ExecutorServiceAutoCloseable: Returns the wrapped executor service.
getAbsolutePath(String, String, File) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Resolves an act file path or URL from an act name and configured act source.
getActDetails(String, File, Configurator) - Method in class org.machanism.machai.gw.tools.ActFunctionTools: AI functional tool that loads the details of a specific Act template, including its instructions, input template, and configuration options.
getActInformation(int) - Method in class org.machanism.machai.gw.processor.Episodes: Returns episode information as a map suitable for serialization.
getActProperties() - Method in class org.machanism.machai.gw.processor.ActProcessor: Returns the merged act properties currently loaded on this processor.
getActResult(String) - Method in class org.machanism.machai.gw.tools.ActFunctionTools: AI functional tool that retrieves the result of a previously started Act by its GUID.
getAutoTools(String, String, String[]) - Method in class org.machanism.machai.gw.processor.ActProcessor: Selects and caches the tools required for the current act episode by asking the configured provider for a JSON tool list.
getAutoToolSelectionQuery(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Extracts the optional query from SnakeYAML's serialized auto mapping value.
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.
getConnection(String, String, String, String, int, Map<String, String>, String, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
getConnection(URI, Map<String, String>, Configurator) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Creates and configures an HttpURLConnection.
getDefaultPrompt() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Returns the default prompt used for folder processing.
getDirInfoLine(Collection<String>, File) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Returns a JsonNode (ArrayNode) containing the names of directories from the given collection that exist within the specified project directory.
getEnabledTools(Map<String, Object>, LayeredConfigurator) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Resolves the tool names enabled for the current processing request.
getEpisodeId() - Method in exception 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 1-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 org.machanism.machai.gw.tools.ProcessTerminationException: Returns the desired exit code.
getFile(File, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools
getFileName(String) - Method in class org.machanism.machai.gw.tools.ActFunctionTools
getGuidancePrompt(String, String) - Method in class org.machanism.machai.gw.tools.GuidanceFunctionTools: Provides the prompt template used to process files containing guidance tags.
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.
getInputId(String[]) - Method in class org.machanism.machai.gw.processor.ActProcessor: Builds the cache key for an act episode from the execution metadata in the prompt.
getInstructions() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Returns the current base instructions used for processing.
getInstructions() - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Returns the current base instructions used for processing.
getKey() - Method in enum org.machanism.machai.gw.processor.ProjectContextKey: Gets the raw string value of the metadata key.
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 class org.machanism.machai.gw.processor.Episodes: Returns the act name associated with these episodes.
getName() - Method in exception 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.
getPatternPath(String) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Returns a PathMatcher when the provided string is a path pattern.
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: Generates a structured JSON string containing execution metadata about the file being processed and the current processing environment context.
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(File, int, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Lists files recursively in a directory up to a specified maximum limit.
getRecursiveFolders(File, int, 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: Returns the list of all collected outputs.
getReviewerForExtension(String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Resolves a reviewer for a given file extension.
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: Functional AI tool that fetches a web page or project-scoped file URL.
getWebPage(HttpURLConnection, int, String) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Performs the HTTP GET request and returns the response content.
Ghostwriter - Class in org.machanism.machai.gw.processor: Command-line entry point for the Ghostwriter application.
Ghostwriter() - Constructor for class org.machanism.machai.gw.processor.Ghostwriter
Ghostwriter.RuntimeSettings - Class in org.machanism.machai.gw.processor: Mutable holder for startup settings resolved before processor creation.
GUIDANCE_FILE_NAME - Static variable in class org.machanism.machai.gw.reviewer.TextReviewer
GUIDANCE_FOLDER - Static variable in class org.machanism.machai.gw.tools.GuidanceFunctionTools
GUIDANCE_TAG_NAME - Static variable in class org.machanism.machai.gw.processor.GuidanceProcessor: Special comment marker used to identify guidance blocks inside supported files.
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: Processes project files that contain inline guidance comments and dispatches the extracted instructions to the configured AI provider.
GuidanceProcessor(File, String, Configurator) - Constructor for class org.machanism.machai.gw.processor.GuidanceProcessor: Constructs a new GuidanceProcessor for processing files with guidance tags.
GW_CONFIG_FILE_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Default Ghostwriter properties file name.
GWConstants - Class in org.machanism.machai.gw.processor: Central constants used by Ghostwriter configuration and runtime processing.
GWConstants() - Constructor for class org.machanism.machai.gw.processor.GWConstants

H

handleExitCode(int) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Terminates the JVM with the given exit code when it is non-zero.
handleProcessingFailure(String, Exception) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Logs a processing failure with the given message prefix and returns the generic error exit code.
handleProcessTermination(ProcessTerminationException) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Handles an explicit process termination request raised by a processor or tool, logging the termination message and reason before returning the exit code requested by the exception.
HEADER_MARKER - Static variable in class org.machanism.machai.gw.processor.Episodes
HELP_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
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
HTTP_PREFIX - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Protocol prefix for standard unsecured HTTP endpoints.
HTTPS_PREFIX - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Protocol prefix for secured HTTPS endpoints.

I

indexOfLine(List<String>, String, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
initializeConfiguration(CommandLine, String, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Loads the external configuration properties file when present, using either the GWConstants.CONFIG_PROP_NAME system property or the default Ghostwriter properties file name, resolved relative to the home directory.
input() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Obtains the next input from an interactive user session.
INPUTS_PROPERTY_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor: TOML property name containing prompt inputs/episodes.
instructions - Variable in class org.machanism.machai.gw.processor.AIFileProcessor: Base instructions that set the persona, tone, and scope for the AI provider during execution.
instructions - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings: Resolved system instruction text, or null if not configured.
INSTRUCTIONS_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
INSTRUCTIONS_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for system instructions.
INSTRUCTIONS_PROPERTY_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor: TOML property name containing the instructions supplied to the AI provider for an act.
interactive - Variable in class org.machanism.machai.gw.processor.AIFileProcessor: Flag indicating whether interactive mode is active, allowing continuous prompt looping and execution.
INTERACTIVE_MODE_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property controlling interactive mode.
isAbsolute(String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Determines whether the supplied act reference should be treated as an explicit TOML path.
isAutoToolSelection(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Determines whether a front-matter tool value requests automatic selection.
isInteractive() - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Indicates whether interactive processing mode 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.
isPathPattern(String) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Tests whether a scan pattern string is a glob: or regex: matcher.
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

K

key - Variable in enum org.machanism.machai.gw.processor.ProjectContextKey

L

LAYOUT_TYPE - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: The classification or structure style of the layout (e.g., Maven, Gradle, Custom).
length() - Method in class org.machanism.machai.gw.tools.LogBuilder: Returns the number of characters currently retained.
listFiles(File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Recursively lists all files under a directory, excluding known build/tooling directories.
listFiles(File, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Implements list_files_in_directory.
listFiles(File, String) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Finds all files/directories in the provided project folder that match a pattern.
loadAct(String, Map<String, Object>, String, File) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Loads an act definition into the provided map, supporting inheritance via the basedOn property.
loadActToml(String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Loads and parses an act TOML document from a local file or remote URL.
loadReviewers() - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Loads file reviewers via the ServiceLoader registry, mapping supported file extensions to a reviewer.
loadRules(String) - Method in class org.machanism.machai.gw.tools.CommandSecurityChecker: Loads deny-list rules from the provided string.
loadRuntimeSettings(CommandLine, PropertiesConfigurator, Scanner) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Resolves runtime settings from CLI arguments and persisted configuration.
LOG_EXTENSION - Static variable in class org.machanism.machai.gw.tools.LogBuilder: Standard file extension for log files.
LOG_FOLDER - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools
LOG_LINE_LENGTH - Static variable in class org.machanism.machai.gw.processor.GWConstants
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.
logAbbreviatedMessage(String, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Logs an abbreviated value at INFO level, skipping the abbreviation work entirely when INFO logging is disabled.
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.
logEpisodeHeader(int, int, String) - Method in class org.machanism.machai.gw.processor.Episodes: Logs a formatted episode banner for the current execution step.
logger - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Logger for documentation input processing events.
logger - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor
logger - Static variable in class org.machanism.machai.gw.processor.Episodes: Logger for documentation input processing events.
logger - Static variable in class org.machanism.machai.gw.processor.GuidanceProcessor: Logger for documentation input processing events.
logger - Static variable in class org.machanism.machai.gw.tools.ActFunctionTools: Logger for shell tool execution and diagnostics.
logger - Static variable in class org.machanism.machai.gw.tools.ActSpecFunctionTools: Logger for shell tool execution and diagnostics.
logger - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools: Logger for shell tool execution and diagnostics.
logger - Static variable in class org.machanism.machai.gw.tools.CommandSecurityChecker
logger - Static variable in class org.machanism.machai.gw.tools.GuidanceFunctionTools
logger - Static variable in class org.machanism.machai.gw.tools.WebFunctionTools: Logger for web fetch tool execution and diagnostics.
LOGGER - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
logId - Variable in class org.machanism.machai.gw.tools.LogBuilder: Optional log identifier for file persistence.
logStartup(File) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Logs basic startup path information at INFO level: the resolved Ghostwriter home directory and the resolved project directory.
logVersion() - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Logs the application version when available from package metadata.

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.
matchLines(List<String>, List<String>, int) - Static method in class org.machanism.machai.gw.tools.PatchApplier
maxSize - Variable in class org.machanism.machai.gw.tools.LogBuilder: Maximum number of characters to retain in the buffer.
mcpPromptBundle - Variable in class org.machanism.machai.gw.tools.ActFunctionTools: Resource bundle supplying prompt templates for generators.
mcpPromptBundle - Variable in class org.machanism.machai.gw.tools.GuidanceFunctionTools: Resource bundle supplying prompt templates for generators.
mergeStringWithListValue(List<String>, String, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Merges a single string value into each string item of an inherited list.
mergeTomlArrayValues(Object, List<Object>, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Merges TOML array values with any existing inherited string or list value.
model - Variable in class org.machanism.machai.gw.processor.AIFileProcessor: The specific AI model identifier or provider label being utilized for operations.
MODEL_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
MODEL_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property for the active model/provider.
MODULES - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: A formatted list/line describing the project sub-modules.
moduleThreadTimeoutMinutes - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Timeout for module processing worker pool shutdown, in minutes.
moveToEpisode(int, String) - Method in class org.machanism.machai.gw.tools.ActSpecFunctionTools: AI functional tool that moves to the episode specified by id or name.
MoveToEpisodeException - Exception in org.machanism.machai.gw.tools: Exception used to request a jump to another act episode during execution.
MoveToEpisodeException(Integer, String) - Constructor for exception 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.
multiThread - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings: Configured thread count as text, or null if not configured.

N

name - Variable in class org.machanism.machai.gw.processor.Episodes: Logical act name associated with the episodes.
name - Variable in exception org.machanism.machai.gw.tools.MoveToEpisodeException
NO_INTERACTIVE_SPECIAL_PROMPT_COMMAND - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: Interactive-mode command that accepts the current response and continues processing in a non-interactive mode, running to completion without prompting the user again.
nonRecursive - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Whether module discovery/recursion is disabled for the current run.
NONRECURSIVE_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property controlling recursive module traversal.
normalizeExtensionKey(String) - Static method in class org.machanism.machai.gw.processor.GuidanceProcessor: Normalizes a file extension (with or without a leading dot) into a lower-case lookup key.

O

OPERATING_SYSTEM - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: The operating system name where the application is currently running.
org.machanism.machai.gw.processor - package org.machanism.machai.gw.processor: Provides the project-aware processing layer used by Ghostwriter to traverse projects and submit file, guidance, or act prompts to a configured GenAI provider.
org.machanism.machai.gw.reviewer - package org.machanism.machai.gw.reviewer: Provides the file-format-specific reviewer implementations used to discover and normalize embedded @guidance instructions for the Ghostwriter documentation pipeline.
org.machanism.machai.gw.tools - package org.machanism.machai.gw.tools: Provides Ghostwriter host-side function tools that expose project-scoped automation capabilities to the Machai runtime.

P

PARENT_PROJECT_DIR_NAME - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: The directory name of the parent project folder, or null if the project has no parent.
PARENT_PROJECT_ID - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: The unique identifier of the parent project, if one exists.
parseFile(File, File) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Uses a Reviewer (based on file extension) to extract guidance.
parseLines(String, File, Configurator) - 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.
parsePath(File, String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Resolves the effective scan directory and converts it into a glob expression when required.
parseResult(String, String, HttpURLConnection, int, StringBuilder) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Reads the response stream and returns the full response text.
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
path - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Specifies a special scanning path or path pattern.
PATH_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property specifying the file, directory, or path pattern used to determine which files are scanned within the project directory.
pathDepth(String) - Static method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Computes the depth of a path for sorting.
pathMatcher - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Optional matcher used to limit module/file processing to a subset.
paths - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings: Scan directories or patterns to process.
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: Reviews a Python file for line-comment or triple-quoted guidance.
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: Reviews a TypeScript file for line-comment or block-comment guidance.
perform(File, Genai) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
performAct(String, File, Map<String, String>, boolean, Configurator) - Method in class org.machanism.machai.gw.tools.ActFunctionTools: AI functional tool that 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.
printHelp(Options) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Prints CLI help text, including usage syntax, all available options, and example invocations, to standard output.
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, int) - Method in class org.machanism.machai.gw.processor.ActProcessor: Executes a single episode prompt after prepending act metadata.
process(ProjectLayout, File, String, String...) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Processes a specified file within a project layout by configuring and invoking a Generative AI (GenAI) provider using a sequence of instructions and prompts.
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 a 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.
processModule(File, String) - Method in class org.machanism.machai.gw.processor.GuidanceProcessor: Processes a module directory.
processModulesMultiThreaded(File, List<String>) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Processes all discovered modules concurrently.
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).
processPathectories(AIFileProcessor, String[], File) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Processes all requested scan paths using the given processor, converting recognized failures into an appropriate exit code instead of propagating them further, and always logging usage statistics and completion.
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 in org.machanism.machai.gw.tools: Runtime exception used by terminate_process to signal early termination to the host.
ProcessTerminationException(int) - Constructor for exception org.machanism.machai.gw.tools.ProcessTerminationException: Creates a termination exception with the supplied exit code and no detail message.
ProcessTerminationException(String, int) - Constructor for exception org.machanism.machai.gw.tools.ProcessTerminationException: Creates a termination exception.
ProcessTerminationException(String, Throwable, int) - Constructor for exception org.machanism.machai.gw.tools.ProcessTerminationException: Creates a termination exception.
processTimeoutSeconds - Variable in class org.machanism.machai.gw.tools.CommandFunctionTools: Maximum time to wait for a started process to complete, in seconds.
PROJECT_DIR_NAME - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: The directory name of the project folder itself.
PROJECT_DIR_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
PROJECT_DIR_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Property name for the project directory configuration.
PROJECT_ID - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: The unique identifier of the project.
PROJECT_NAME - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: The user-friendly name of the project.
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
ProjectContextKey - Enum in org.machanism.machai.gw.processor: Represents the context metadata keys used for evaluating and storing project layouts.
ProjectContextKey(String) - Constructor for enum org.machanism.machai.gw.processor.ProjectContextKey: Constructs a ProjectContextKey constant mapped to its raw string representation.
projectDir - Variable in class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings: Resolved project directory.
projectDir - Variable in class org.machanism.machai.gw.tools.LogBuilder: Optional project directory for log file location.
PROMPT_BUNDLE - Static variable in class org.machanism.machai.gw.reviewer.PumlReviewer
promptBundle - Variable in class org.machanism.machai.gw.processor.GuidanceProcessor: Resource bundle supplying prompt templates for generators.
promptBundle - Variable in class org.machanism.machai.gw.reviewer.HtmlReviewer
promptBundle - Variable in class org.machanism.machai.gw.reviewer.JavaReviewer
promptBundle - Variable in class org.machanism.machai.gw.reviewer.MarkdownReviewer
promptBundle - Variable in class org.machanism.machai.gw.reviewer.PythonReviewer: Resource bundle containing prompt templates for reviewed files.
promptBundle - Variable in class org.machanism.machai.gw.reviewer.TextReviewer
promptBundle - Variable in class org.machanism.machai.gw.reviewer.TypeScriptReviewer: Resource bundle containing prompt templates for reviewed files.
promptForValue(Scanner, String) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Prompts the user for a single (possibly multi-line) piece of input on standard input, printing the prompt via Console when available or plain System.out otherwise.
PUBLIC_PROP_GROUP_NAME - Static variable in class org.machanism.machai.gw.processor.AIFileProcessor: Prefix for property groups whose values are exposed and injectable directly into prompt templates.
PUBLIC_USER_PROMPT_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Property name representing the user prompt configured publicly inside the properties.
PumlReviewer - Class in org.machanism.machai.gw.reviewer: Reviewer implementation for PlantUML files (.puml).
PumlReviewer() - Constructor for class org.machanism.machai.gw.reviewer.PumlReviewer
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.
putStringActData(Map<String, Object>, String, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Stores a string property, merging it with any inherited value already present.
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

RANDOM - Static variable in class org.machanism.machai.gw.tools.CommandFunctionTools: Reusable random instance used for generating lightweight command ids for logging.
readActInput(Scanner) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Reads possibly multi-line interactive act input from standard input, printing the Ghostwriter.USER_INPUT_PREFIX prompt before each line and supporting the same continuation-marker convention as Ghostwriter.promptForValue(Scanner, String).
readFile(File, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Implements read_file.
readFileContent(File, String) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Reads a local file using the requested character set.
readFileUriContent(File, String, URI) - Method in class org.machanism.machai.gw.tools.WebFunctionTools
readFromFilePath(String, File) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Reads UTF-8 text content from the given file path.
readFromHttpUrl(String) - Static method in class org.machanism.machai.gw.processor.AIFileProcessor: Reads UTF-8 text content from the given HTTP or HTTPS URL.
readStream(InputStream, String, LogBuilder, CommandFunctionTools.LineConsumer, CommandFunctionTools.ErrorConsumer) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools: Reads a process stream and appends its content to output while also passing each line to the provided consumer.
regularOrder(Integer, BiFunction<Integer, String, String>) - Method in class org.machanism.machai.gw.processor.Episodes: Executes episodes in regular order starting from the supplied 1-based index while honoring repeat and move requests.
REL_PATH_FROM_ROOT - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: The relative filesystem path from the root directory to the project's directory.
removeFrontMatterData(String) - Static method in class org.machanism.machai.gw.processor.AIFileProcessor
renderTextOnlyIfRequested(boolean, String) - Method in class org.machanism.machai.gw.tools.WebFunctionTools: Converts the response to plain text when requested.
repeateEpisode(String) - Method in class org.machanism.machai.gw.tools.ActSpecFunctionTools: AI functional tool that repeats the current episode by terminating the current execution and restarting the same episode, preserving the context.
RepeatEpisodeException - Exception in org.machanism.machai.gw.tools: Exception used to request that the current act episode be executed again.
RepeatEpisodeException() - Constructor for exception org.machanism.machai.gw.tools.RepeatEpisodeException: Creates a repeat request for the current episode.
report - Variable in class org.machanism.machai.gw.processor.GuidanceProcessor
REQUEST_ID_RANDOM - Static variable in class org.machanism.machai.gw.tools.WebFunctionTools: Source of correlation identifiers used in request log messages.
requestedOrder(BiFunction<Integer, String, String>) - Method in class org.machanism.machai.gw.processor.Episodes: Executes only the explicitly selected episodes in their requested order.
resolveExcludes(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Resolves the exclude list from the --excludes command-line option or configuration, splitting the comma-separated value into individual patterns.
resolveGenai(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Resolves the configured AI provider/model, preferring the --model command-line option over the corresponding configuration value.
resolveInheritedValue(String, String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Resolves a property value against the current configurator for inheritance.
resolveInputParamValue(Object) - Method in class org.machanism.machai.gw.processor.AIFileProcessor
resolveInstructions(CommandLine, PropertiesConfigurator, Scanner) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Resolves the system instruction text from CLI input or configuration.
resolveMergedValue(List<String>, int, String) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Resolves a merged value for an inherited prompt slot.
resolveMultiThread(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Resolves the concurrency (thread count) setting from the --threads command-line option or configuration.
resolvePaths(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Resolves the scan directories or patterns to process, in order of precedence: positional command-line arguments, then the configured path property, then the current directory (".") as a final fallback.
resolveProjectDir(CommandLine, PropertiesConfigurator) - Static method in class org.machanism.machai.gw.processor.Ghostwriter: Resolves the project directory from the -d command-line option or configuration.
resolvePromptValues(List<String>) - Method in class org.machanism.machai.gw.processor.ActProcessor: Resolves inherited placeholders for each prompt episode.
resolveWorkingDir(File, String) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools: Resolves a working directory relative to a canonical project directory.
results - Variable in class org.machanism.machai.gw.processor.ActProcessor: List of collected outputs generated during processing.
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.
reviewerMap - Variable in class org.machanism.machai.gw.processor.GuidanceProcessor: Reviewer associations keyed by file extension.
rootDir - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Root scanning directory for the current documentation run.
RuntimeSettings() - Constructor for class org.machanism.machai.gw.processor.Ghostwriter.RuntimeSettings

S

sb - Variable in class org.machanism.machai.gw.tools.LogBuilder: Internal buffer for retained log content.
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.
selectedEpisodes - Variable in class org.machanism.machai.gw.processor.Episodes: Explicitly selected 1-based episode identifiers.
SEPARATOR_CHARS - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Separator character used to delimit collection values like lists of files or episode indices.
serialVersionUID - Static variable in exception org.machanism.machai.gw.processor.EpisodeNotFoundException
serialVersionUID - Static variable in exception org.machanism.machai.gw.tools.DenyException
serialVersionUID - Static variable in exception org.machanism.machai.gw.tools.EndTaskException
serialVersionUID - Static variable in exception org.machanism.machai.gw.tools.MoveToEpisodeException
serialVersionUID - Static variable in exception org.machanism.machai.gw.tools.ProcessTerminationException
serialVersionUID - Static variable in exception org.machanism.machai.gw.tools.RepeatEpisodeException
setAct(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Configures and initializes the current execution Action (Act) context by parsing the raw command string.
setActData(Map<String, Object>, TomlParseResult) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Copies dotted-string keys from the TOML parse results into properties.
setActDataEntry(Map<String, Object>, Map.Entry<String, Object>) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Applies a single TOML entry to the merged act property map.
setActsLocation(String) - Method in class org.machanism.machai.gw.processor.ActProcessor: Sets the location used for loading external act definition files (*.toml).
setDefaultPrompt(String) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Sets the default prompt used for folder 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.
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: Extracts context metadata from the provided ProjectLayout and registers it in the project context registry.
setSelectedEpisodes(List<Integer>) - Method in class org.machanism.machai.gw.processor.Episodes: Sets the list of explicitly requested episode identifiers.
setThreads(int) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Configures the number of threads to be used for multi-threaded module processing.
shouldExcludePath(Path) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Determines whether a relative path should be excluded according to AbstractFileProcessor.excludes.
shouldIncludeInListFiles(File, File) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Determines whether an entry found in AbstractFileProcessor.listFiles(File) should be included.
shutdownExecutor(ExecutorService) - Method in class org.machanism.machai.gw.processor.AbstractFileProcessor: Shuts down an ExecutorService safely without throwing from a finally block.
size() - Method in class org.machanism.machai.gw.processor.Episodes: Returns the number of configured episodes.
SRC_AND_RESOURCE_DIRS - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: A formatted list/line describing the path information for the main source and resource directories.
startTime - Variable in class org.machanism.machai.gw.tools.LogBuilder: Start time in milliseconds since epoch.
STOP_SYMBOL - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Character symbol that triggers immediate termination and disables normal order progression.
SUPER_VALUE_PLACEHOLDER - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Placeholder string used in inherited act definitions to reference and include the parent's value.

T

TASK_TERMINATED_BY_FUNCTION_TOOL_MESSAGE - Static variable in class org.machanism.machai.gw.tools.CommandSpecFunctionTools
terminateExecution(String, int, File) - Method in class org.machanism.machai.gw.tools.CommandSpecFunctionTools: AI functional tool that terminates the application by throwing a ProcessTerminationException.
TEST_SRC_AND_RESOURCE_DIRS - Enum constant in enum org.machanism.machai.gw.processor.ProjectContextKey: A formatted list/line describing the path information for test source and resource directories.
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 - Variable in class org.machanism.machai.gw.processor.AbstractFileProcessor: Degree of concurrency for module processing.
THREADS_OPTION - Static variable in class org.machanism.machai.gw.processor.Ghostwriter
THREADS_PROP_NAME - Static variable in class org.machanism.machai.gw.processor.GWConstants: Configuration property specifying the number of threads to use for multi-threaded module processing.
TOML_EXTENSION - Static variable in class org.machanism.machai.gw.processor.ActProcessor: Expected file extension for configurations parsed as TOML files.
TOOL_AUTO_SEARCH_NAME - Static variable in class org.machanism.machai.gw.processor.ActProcessor
toStringList(Object) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Converts an inherited property value to a list of strings.
totalLength - Variable in class org.machanism.machai.gw.tools.LogBuilder: Total number of characters ever appended.
truncated - Variable in class org.machanism.machai.gw.tools.LogBuilder: Flag indicating whether truncation has occurred.
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, File) - Static method in class org.machanism.machai.gw.processor.ActProcessor: Attempts to load an act definition from a user-defined directory.
tryToGetFromReference(String, File, Configurator) - Method in class org.machanism.machai.gw.processor.AIFileProcessor: Resolves a single instruction line that may point to external content.
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

U

USER_INPUT_PREFIX - Static variable in class org.machanism.machai.gw.processor.Ghostwriter

V

validatePatchResult(List<String>, List<String>, String) - Static method in class org.machanism.machai.gw.tools.PatchApplier: Asserts structural sanity on the patched code structure before writing to disk.
valueOf(String) - Static method in enum org.machanism.machai.gw.processor.ProjectContextKey: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.machanism.machai.gw.processor.ProjectContextKey: Returns an array containing the constants of this enum type, in the order they are declared.

W

waitAndCollect(Process, LogBuilder, String) - Method in class org.machanism.machai.gw.tools.CommandFunctionTools: Waits for the specified process to complete execution within the configured timeout, collects its output, and returns a report of the captured output.
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(File, String, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Implements write_file.
writeFileContent(File, String, String) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Writes content to file using charsetName.
writeNewFile(File, String, String, File) - Method in class org.machanism.machai.gw.tools.FileFunctionTools: Creates the file (and parent directories as needed) and writes text using the requested character set.

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