AHKScriptBuilder (polyglot 2.4.0-SNAPSHOT API)

java.lang.Object
- edu.illinois.ncsa.isda.softwareserver.AHKScriptBuilder

public class AHKScriptBuilder
extends Object

Constructor Summary

Constructors
Constructor and Description

AHKScriptBuilder()

Constructors
Constructor and Description
`AHKScriptBuilder()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`advanceLine(String str)` advances a string so its first word is flushed
`static void`	`advanceParam(FileWriter fw, int level)` adds to the AHK script a call to AdvanceParam which gets the AHK script to move on to the next param in args list (in runtime)
`static void`	`defineAdvanceParam(FileWriter fw, int level)` adds to the AHK script AdvanceParam function definition - this function makes the AHK script to move on to the next param in args list (in runtime)
`static void`	`defineLookupParam(FileWriter fw, int level)` adds to the AHK script LookupParam function definition - this function checks whether a specific param is present in the script args
`static void`	`defineWin(FileWriter fw, int level)` adds to the AHK script Win function definition - this function makes the AHK script wait for a window to show
`static String`	`findFilePath(File f, String command)`
`static void`	`finishScript(String scriptName)` adds definition of used functions to the end of AHK script
`static String`	`formatToken(String prefix, String token, String suffix)` formats a string based on "path file" definitions, adding a prefix and a suffix
`static String`	`generateFormatJSONString(String format, String folderName)` goes over the all "path" files to build the JSON string that defines the conversion to an output format
`static void`	`generateHeader(String scriptName, String roadMapFolder, String inputs, String domain)` generates the header for the script
`static String`	`generateJSONStringRec(BufferedReader ins)` goes over a file "path" to build the JSON string based on the params defined in the file
`static String`	`generateParam(BufferedReader ins)` generates JSON string for a param (including nested params)
`static String`	`generateParameterJSONString(File f)` wraps rec function that goes over a file "path" to build the JSON string
`static void`	`generateScript(String scriptName, File roadMapFile)` wraps calls to generateScriptRec, so optional actions may be skipped if the param was not selected
`static void`	`generateScriptRec(BufferedReader ins, FileWriter fw, int level, String currWindow)` generates the AHK script
`static void`	`main(String[] args)` AHKScriptBuilder can be called from cmd line by giving 2 arguments: output AHK script directory path and input files directory path
`static String`	`nextWord(String str)` returns the next word of a string
`static String`	`prepareExtraParams(File roadMapFile)` searches for params in "path" files and adds necessary AHK code when found
`static String`	`readLine(BufferedReader br)` reads a new line from the input buffer
`static String`	`removeDoubleQuotes(String str)` removes double quotes from a string (first and last chars)
`static void`	`replaceScriptFileInfo(File[] files)`
`static void`	`replaceStringInScript(File f, String old_str, String new_str)`
`static void`	`scriptChoose(String line, FileWriter fw, int level, String currWindow)` adds to the AHK script commands that choose an item from a dropdown menu based on the definitions in the input file
`static void`	`scriptClick(String line, FileWriter fw, int level, String currWindow)` adds to the AHK script commands that click a button based on the definitions in the input file
`static void`	`scriptComment(String line, FileWriter fw, int level)` adds a comment to the AHK script file
`static void`	`scriptIfWin(String line, FileWriter fw, String currWindow, BufferedReader ins, int level)` not currently in use adds functionality to AHK script to deal with window pop ups that may or may not appear
`static void`	`scriptInputParam(String line, FileWriter fw, BufferedReader ins, int level, String currWindow)` adds a new param to the AHK script
`static void`	`scriptInsert(String line, FileWriter fw, int level, String currWindow)` adds to the AHK script commands that insert text into an "edit box" based on the definitions in the input file
`static void`	`scriptMenu(String line, FileWriter fw, int level, String currWindow)` adds to the AHK script commands that choose a menu item based on the definitions in the input file
`static void`	`scriptParamButton(String line, FileWriter fw, BufferedReader ins, int level, String currWindow)` adds to the AHK script commands that click (or not) a button according to the param selection
`static void`	`scriptParamCheckbox(String line, FileWriter fw, BufferedReader ins, int level, String currWindow)` adds to the AHK script commands that check/unchek a checkbox according to the param selection
`static void`	`scriptParamDropdownMenu(String line, FileWriter fw, BufferedReader ins, int level, String currWindow)` adds to the AHK script commands that choose an item of a dropdown menu according to the param selection
`static void`	`scriptParamMenu(String line, FileWriter fw, BufferedReader ins, int level, String currWindow)` adds to the AHK script commands that choose an item of a menu according to the param selection
`static void`	`scriptParamSaveText(String line, FileWriter fw, BufferedReader ins, int level, String currWindow)` adds a "save text" command to the AHK script that will be executed if the param is selected
`static void`	`scriptParamScroll(String line, FileWriter fw, BufferedReader ins, int level, String currWindow)` adds to the AHK script commands that move a scrollbar according to the param selection
`static void`	`scriptParamUserInput(String line, FileWriter fw, BufferedReader ins, int level, String currWindow)` adds to the AHK script commands that insert text into an "edit box" according to the param selection
`static void`	`scriptRun(String line, FileWriter fw, int level)` adds all initial info to AHK script
`static void`	`scriptSaveText(String line, FileWriter fw, int level, String currWindow)` adds to the AHK script commands that saves text to a file based on the definitions in the input file
`static void`	`scriptScrollbar(String line, FileWriter fw, int level, String currWindow)` adds to the AHK script commands that move a scrollbar based on the definitions in the input file
`static void`	`scriptSelect(String line, FileWriter fw, int level, String currWindow)` adds to the AHK script commands that check/uncheck a checkbox based on the definitions in the input file
`static void`	`scriptWait(String line, FileWriter fw, int level, String currWindow)` adds AHK commands that create a "wait" in the AHK script execution
`static String`	`scriptWin(String line, FileWriter fw, int level)` adds to the AHK script a call to Win() which will (in runtime) wait for a window and show it
`static void`	`scriptWrite(String line, FileWriter fw, int level)` adds text to the AHK script file
`static void`	`softwareWriteAllScripts(String swRoadMapDirectory, String scriptDirectory)`
`static void`	`startScript(String scriptName, File f)` wrap call to scriptRun
`static void`	`writeScript(String scriptName, String roadMapFolder)` loops over all input files to build the script - it assumes that the file #0 will have the "run" command

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AHKScriptBuilder
```
public AHKScriptBuilder()
```
- Method Detail
  - main
```
public static void main(String[] args)
```
    AHKScriptBuilder can be called from cmd line by giving 2 arguments: output AHK script directory path and input files directory path
  - softwareWriteAllScripts
```
public static void softwareWriteAllScripts(String swRoadMapDirectory,
                           String scriptDirectory)
```
  - findFilePath
```
public static String findFilePath(File f,
                  String command)
```
  - replaceStringInScript
```
public static void replaceStringInScript(File f,
                         String old_str,
                         String new_str)
```
  - replaceScriptFileInfo
```
public static void replaceScriptFileInfo(File[] files)
```
  - writeScript
```
public static void writeScript(String scriptName,
               String roadMapFolder)
```
    loops over all input files to build the script - it assumes that the file #0 will have the "run" command
    
    Parameters:
    scriptName - name of output AHK script
    roadMapFolder - input directory
  - generateHeader
```
public static void generateHeader(String scriptName,
                  String roadMapFolder,
                  String inputs,
                  String domain)
```
    generates the header for the script
    
    Parameters:
    scriptName - name of output AHK script
    roadMapFolder - the directory where the "path" files can be found
  - startScript
```
public static void startScript(String scriptName,
               File f)
```
    wrap call to scriptRun
    
    Parameters:
    scriptName - name of output AHK script
    f - file with necessary RUN information
  - scriptRun
```
public static void scriptRun(String line,
             FileWriter fw,
             int level)
```
    adds all initial info to AHK script
    
    Parameters:
    line - contains the SW name and path
    fw - file writer
  - finishScript
```
public static void finishScript(String scriptName)
```
    adds definition of used functions to the end of AHK script
    
    Parameters:
    scriptName - name of output AHK script
  - prepareExtraParams
```
public static String prepareExtraParams(File roadMapFile)
```
    searches for params in "path" files and adds necessary AHK code when found
    
    Parameters:
    roadMapFile - name of file being searched
  - generateScript
```
public static void generateScript(String scriptName,
                  File roadMapFile)
```
    wraps calls to generateScriptRec, so optional actions may be skipped if the param was not selected
    
    Parameters:
    scriptName - name of output AHK script
    roadMapFile - name of file being processed
  - generateScriptRec
```
public static void generateScriptRec(BufferedReader ins,
                     FileWriter fw,
                     int level,
                     String currWindow)
```
    generates the AHK script
    
    Parameters:
    ins - the input buffer
    fw - the file writer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptWait
```
public static void scriptWait(String line,
              FileWriter fw,
              int level,
              String currWindow)
```
    adds AHK commands that create a "wait" in the AHK script execution
    
    Parameters:
    line - contains command details
    fw - the file writer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptInputParam
```
public static void scriptInputParam(String line,
                    FileWriter fw,
                    BufferedReader ins,
                    int level,
                    String currWindow)
```
    adds a new param to the AHK script
    
    Parameters:
    line - contains command details
    fw - the file writer
    ins - input buffer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptParamSaveText
```
public static void scriptParamSaveText(String line,
                       FileWriter fw,
                       BufferedReader ins,
                       int level,
                       String currWindow)
```
    adds a "save text" command to the AHK script that will be executed if the param is selected
    
    Parameters:
    line - contains command details
    fw - the file writer
    ins - input buffer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptParamDropdownMenu
```
public static void scriptParamDropdownMenu(String line,
                           FileWriter fw,
                           BufferedReader ins,
                           int level,
                           String currWindow)
```
    adds to the AHK script commands that choose an item of a dropdown menu according to the param selection
    
    Parameters:
    line - contains command details
    fw - the file writer
    ins - input buffer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptParamCheckbox
```
public static void scriptParamCheckbox(String line,
                       FileWriter fw,
                       BufferedReader ins,
                       int level,
                       String currWindow)
```
    adds to the AHK script commands that check/unchek a checkbox according to the param selection
    
    Parameters:
    line - contains command details
    fw - the file writer
    ins - input buffer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptParamScroll
```
public static void scriptParamScroll(String line,
                     FileWriter fw,
                     BufferedReader ins,
                     int level,
                     String currWindow)
```
    adds to the AHK script commands that move a scrollbar according to the param selection
    
    Parameters:
    line - contains command details
    fw - the file writer
    ins - input buffer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptParamUserInput
```
public static void scriptParamUserInput(String line,
                        FileWriter fw,
                        BufferedReader ins,
                        int level,
                        String currWindow)
```
    adds to the AHK script commands that insert text into an "edit box" according to the param selection
    
    Parameters:
    line - contains command details
    fw - the file writer
    ins - input buffer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptParamButton
```
public static void scriptParamButton(String line,
                     FileWriter fw,
                     BufferedReader ins,
                     int level,
                     String currWindow)
```
    adds to the AHK script commands that click (or not) a button according to the param selection
    
    Parameters:
    line - contains command details
    fw - the file writer
    ins - input buffer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptParamMenu
```
public static void scriptParamMenu(String line,
                   FileWriter fw,
                   BufferedReader ins,
                   int level,
                   String currWindow)
```
    adds to the AHK script commands that choose an item of a menu according to the param selection
    
    Parameters:
    line - contains command details
    fw - the file writer
    ins - input buffer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptWin
```
public static String scriptWin(String line,
               FileWriter fw,
               int level)
```
    adds to the AHK script a call to Win() which will (in runtime) wait for a window and show it
    
    Parameters:
    line - contains command details
    fw - the file writer
    level - nesting level for organized indentation of output file
  - defineWin
```
public static void defineWin(FileWriter fw,
             int level)
```
    adds to the AHK script Win function definition - this function makes the AHK script wait for a window to show
    
    Parameters:
    fw - the file writer
    level - nesting level for organized indentation of output file
  - defineLookupParam
```
public static void defineLookupParam(FileWriter fw,
                     int level)
```
    adds to the AHK script LookupParam function definition - this function checks whether a specific param is present in the script args
    
    Parameters:
    fw - the file writer
    level - nesting level for organized indentation of output file
  - advanceParam
```
public static void advanceParam(FileWriter fw,
                int level)
```
    adds to the AHK script a call to AdvanceParam which gets the AHK script to move on to the next param in args list (in runtime)
    
    Parameters:
    fw - the file writer
    level - nesting level for organized indentation of output file
  - defineAdvanceParam
```
public static void defineAdvanceParam(FileWriter fw,
                      int level)
```
    adds to the AHK script AdvanceParam function definition - this function makes the AHK script to move on to the next param in args list (in runtime)
    
    Parameters:
    fw - the file writer
    level - nesting level for organized indentation of output file
  - scriptIfWin
```
public static void scriptIfWin(String line,
               FileWriter fw,
               String currWindow,
               BufferedReader ins,
               int level)
```
    not currently in use adds functionality to AHK script to deal with window pop ups that may or may not appear
    
    Parameters:
    line - contains command details
    fw - the file writer
    ins - input buffer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptScrollbar
```
public static void scriptScrollbar(String line,
                   FileWriter fw,
                   int level,
                   String currWindow)
```
    adds to the AHK script commands that move a scrollbar based on the definitions in the input file
    
    Parameters:
    line - contains command details
    fw - the file writer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptChoose
```
public static void scriptChoose(String line,
                FileWriter fw,
                int level,
                String currWindow)
```
    adds to the AHK script commands that choose an item from a dropdown menu based on the definitions in the input file
    
    Parameters:
    line - contains command details
    fw - the file writer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptMenu
```
public static void scriptMenu(String line,
              FileWriter fw,
              int level,
              String currWindow)
```
    adds to the AHK script commands that choose a menu item based on the definitions in the input file
    
    Parameters:
    line - contains command details
    fw - the file writer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptClick
```
public static void scriptClick(String line,
               FileWriter fw,
               int level,
               String currWindow)
```
    adds to the AHK script commands that click a button based on the definitions in the input file
    
    Parameters:
    line - contains command details
    fw - the file writer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptSaveText
```
public static void scriptSaveText(String line,
                  FileWriter fw,
                  int level,
                  String currWindow)
```
    adds to the AHK script commands that saves text to a file based on the definitions in the input file
    
    Parameters:
    line - contains command details
    fw - the file writer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptInsert
```
public static void scriptInsert(String line,
                FileWriter fw,
                int level,
                String currWindow)
```
    adds to the AHK script commands that insert text into an "edit box" based on the definitions in the input file
    
    Parameters:
    line - contains command details
    fw - the file writer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - scriptSelect
```
public static void scriptSelect(String line,
                FileWriter fw,
                int level,
                String currWindow)
```
    adds to the AHK script commands that check/uncheck a checkbox based on the definitions in the input file
    
    Parameters:
    line - contains command details
    fw - the file writer
    level - nesting level for organized indentation of output file
    currWindow - the window description to be added to AHK command
  - generateFormatJSONString
```
public static String generateFormatJSONString(String format,
                              String folderName)
```
    goes over the all "path" files to build the JSON string that defines the conversion to an output format
    
    Parameters:
    format - the conversion output format
    folderName - the directory that contains the "path" files
  - generateParameterJSONString
```
public static String generateParameterJSONString(File f)
```
    wraps rec function that goes over a file "path" to build the JSON string
    
    Parameters:
    f - a "path" file
    
    Returns:
    JSON string for file f
  - generateJSONStringRec
```
public static String generateJSONStringRec(BufferedReader ins)
```
    goes over a file "path" to build the JSON string based on the params defined in the file
    
    Parameters:
    ins - input buffer
    
    Returns:
    JSON string
  - generateParam
```
public static String generateParam(BufferedReader ins)
```
    generates JSON string for a param (including nested params)
    
    Parameters:
    ins - input buffer
    
    Returns:
    param JSON string
  - scriptWrite
```
public static void scriptWrite(String line,
               FileWriter fw,
               int level)
```
    adds text to the AHK script file
    
    Parameters:
    line - contains the text to be added
    fw - the file writer
    level - nesting level for organized indentation of output file
  - scriptComment
```
public static void scriptComment(String line,
                 FileWriter fw,
                 int level)
```
    adds a comment to the AHK script file
    
    Parameters:
    line - contains the comment to be added
    fw - the file writer
    level - nesting level for organized indentation of output file
  - removeDoubleQuotes
```
public static String removeDoubleQuotes(String str)
```
    removes double quotes from a string (first and last chars)
    
    Parameters:
    str - string to be processed
  - nextWord
```
public static String nextWord(String str)
```
    returns the next word of a string
    
    Parameters:
    str - string to be processed
  - advanceLine
```
public static String advanceLine(String str)
```
    advances a string so its first word is flushed
    
    Parameters:
    str - string to be processed
  - formatToken
```
public static String formatToken(String prefix,
                 String token,
                 String suffix)
```
    formats a string based on "path file" definitions, adding a prefix and a suffix
    
    Parameters:
    prefix - prefix to be added to string
    token - string to be processed
    suffix - suffix to be added to string
  - readLine
```
public static String readLine(BufferedReader br)
```
    reads a new line from the input buffer
    
    Parameters:
    br - input buffer

Class AHKScriptBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AHKScriptBuilder

Method Detail

main

softwareWriteAllScripts

findFilePath

replaceStringInScript

replaceScriptFileInfo

writeScript

generateHeader

startScript

scriptRun

finishScript

prepareExtraParams

generateScript

generateScriptRec

scriptWait

scriptInputParam

scriptParamSaveText

scriptParamDropdownMenu

scriptParamCheckbox

scriptParamScroll

scriptParamUserInput

scriptParamButton

scriptParamMenu

scriptWin

defineWin

defineLookupParam

advanceParam

defineAdvanceParam

scriptIfWin

scriptScrollbar

scriptChoose

scriptMenu

scriptClick

scriptSaveText

scriptInsert

scriptSelect

generateFormatJSONString

generateParameterJSONString

generateJSONStringRec

generateParam

scriptWrite

scriptComment

removeDoubleQuotes

nextWord

advanceLine

formatToken

readLine