Uses of Class
org.pz.platypus.GDD

Packages that use GDD
org.pz.platypus   
org.pz.platypus.commands   
org.pz.platypus.commandTypes   
org.pz.platypus.interfaces   
org.pz.platypus.parsers   
org.pz.platypus.plugin.common   
org.pz.platypus.plugin.html   
org.pz.platypus.plugin.listing   
org.pz.platypus.plugin.pdf   
org.pz.platypus.plugin.pdf.commands   
org.pz.platypus.plugin.rtf   
org.pz.platypus.utilities   
 

Uses of GDD in org.pz.platypus
 

Fields in org.pz.platypus declared as GDD
private  GDD TypefaceMap.gdd
           
private  GDD SymbolsList.gdd
           
protected  GDD PropertyFile.gdd
           
private  GDD PluginLoader.gdd
           
private  GDD PlatypusParser.gdd
           
private  GDD Infile.gdd
          the GDD
private  GDD FontDirectoryList.gdd
          the GDD.
private  GDD CommandTable.gdd
           
 

Methods in org.pz.platypus that return GDD
private static GDD Platypus.setupGdd(Literals lits)
          GDD is the global document data block.
 

Methods in org.pz.platypus with parameters of type GDD
private static void Platypus.addInputFileToFileList(CommandLineArgs clArgs, GDD gdd)
          add the input file to the file list
 void TokenList.dump(GDD gdd)
          dumps all the tokens in the output token list to System.out
static void Platypus.findOutputFilePluginType(CommandLineArgs ClArgs, GDD Gdd)
          tries to determine the prefix in the config file for the output plugin.
private static java.lang.String Platypus.findPluginJar(java.lang.String pluginJarLookupName, GDD gdd)
          Get the actual name of the plugin, based on its lookup value in config file.
(package private)  java.lang.String Token.getCommandData(GDD gdd)
          Convert command data into dumpable strings
private static java.lang.String Platypus.getConfigFilename(CommandLineArgs ClArgs, GDD Gdd)
          Get the name of the config file either from the command file or from the default location
private static java.lang.String Platypus.loadOutputPlugin(GDD gdd, CommandLineArgs clArgs)
          Gets the full canonical name of the plugin (full path + file name).
private static void Platypus.logUnexpectedError(java.lang.Exception ex, GDD gdd)
          Prints out the error message in the event of an unexpected error.
 int Command.notExecutedInCodeSection(java.lang.String command, TokenList tl, Source source, GDD gdd)
          Handles the situation in which a command that is not supported in a listing or code section is encountered while in one.
 int Command.process(char[] input, int parsePoint, TokenList tl, boolean inCode, Source source, GDD gdd)
          method for processing this command.
 void CommandLineArgs.process(GDD gdd)
          Processes some command-line options
 int Symbol.process(GDD gdd, ParseContext context, TokenList tl, boolean inCode)
          method for processing this symbol.
static CommandLineArgs Platypus.processCommandLine(java.lang.String[] args, GDD gdd)
          Process the command line: store it, validate it, and process the args.
static void Platypus.processConfigFile(CommandLineArgs Clargs, GDD Gdd)
          Finds the config file, reads it in, and places an instance of it in GDD.
private  void CommandLineArgs.processFontListOption(GDD gdd)
           
private  void CommandLineArgs.processHelpOption(GDD gdd)
           
static void Platypus.processInputFile(GDD gdd, CommandLineArgs clArgs)
          Reads and parses the input file(s).
private  void CommandLineArgs.processVerboseOption(GDD gdd)
           
private  void CommandLineArgs.processVeryVerboseOption(GDD gdd)
           
static void Platypus.putFormatInSystemStrings(CommandLineArgs clArgs, GDD gdd)
          Places the output format into the SystemStrings lookup table
private static void Platypus.runOutputPlugin(java.lang.String pluginName, GDD gdd, CommandLineArgs clArgs)
          The method that actually calls and runs the output plugin
static void Platypus.showUsage(GDD Gdd)
          Show the usage options.
private  void CommandLineArgs.showUsageIfZeroArgs(GDD gdd)
           
static void Platypus.storeVersionNumber(GDD Gdd)
          Stores the current Platypus version number in the table of system strings under _version
 java.lang.String Token.toString(GDD gdd)
          Generates a formatted string version of the contents of a token, including parameter details for a command token.
 

Constructors in org.pz.platypus with parameters of type GDD
CommandTable(GDD Gdd)
           
FontDirectoryList(GDD Gdd)
          We only ever load the default list of directories.
Infile(java.lang.String name, GDD Gdd)
           
ParseContext(GDD gdd, Source source, java.lang.String content, int startPoint)
           
PlatypusParser(GDD Gdd)
           
PluginLoader(java.lang.String pluginJar, GDD Gdd)
           
PropertyFile(java.lang.String propertyFilename, GDD Gdd)
           
SymbolsList(GDD Gdd)
           
TypefaceMap(GDD Gdd)
           
 

Uses of GDD in org.pz.platypus.commands
 

Methods in org.pz.platypus.commands with parameters of type GDD
private  void BulletListPlainStartWithOptions.errorNoParameterForStartList(GDD gdd, Token tok)
          Issue error if no parameter was specified
private  void CodeWithOptions.invalidParameterErrMessage(GDD gdd, Source source)
           
private  void CodeWithOptions.invalidSkipLineNumberErrMessage(GDD gdd, Source source)
           
private  void CodeWithOptions.invalidStartingLineNumberErrMessage(GDD gdd, Source source)
           
protected  int CodeWithOptions.parseSkipLineNumber(java.lang.String num, GDD gdd, Source source)
          Extracts the line numbers on which to print line numbers in the listings.
protected  int CodeWithOptions.parseStartingLineNumber(java.lang.String num, GDD gdd, Source source)
          Extracts the starting line number from the passed parameters.
private  void UrlWithCoverText.showUnclosedUrlCoverTextErrorMsg(Token tok, GDD gdd)
           
 java.lang.String Alignment.toString(int alignment, GDD gdd)
          Convert an alignment to string
 

Uses of GDD in org.pz.platypus.commandTypes
 

Methods in org.pz.platypus.commandTypes with parameters of type GDD
 java.lang.String CommandR.extractRoot(GDD gdd, Source source, java.lang.String commandStr)
          Extract the root.
(package private)  boolean CommandR.passthroughReplacedCommands(GDD gdd)
          Looks up "....process_replaced_commands" to see whether the plugin needs a copy of the replaced command.
 int FontFamily.process(GDD gdd, ParseContext context, TokenList tl, boolean inCode)
          Processes the command and returns the number of chars in the lexeme.
 int CommandV.process(GDD gdd, ParseContext context, TokenList tl, boolean inCode)
          Processes the command, emits the corresponding token, and returns the number of chars in the lexeme.
 int CommandS.process(GDD gdd, ParseContext context, TokenList tl, boolean inCode)
          Processes the command and returns the number of chars in the command + parameters.
 int CommandR.process(GDD gdd, ParseContext context, TokenList tl, boolean inCode)
          Processes the command, emits the corresponding token, and returns the number of chars in the lexeme.
 int Command0.process(GDD gdd, ParseContext context, TokenList tl, boolean inCode)
          Processes the command and returns the number of chars in the lexeme.
 int FontFamily.processSubstitute(ParseContext context, TokenList tl, boolean inCode, GDD gdd, java.lang.String subst)
           
 

Uses of GDD in org.pz.platypus.interfaces
 

Methods in org.pz.platypus.interfaces that return GDD
 GDD IOutputContext.getGdd()
           
 

Methods in org.pz.platypus.interfaces with parameters of type GDD
 void ICommandTable.loadSymbols(GDD gdd)
          load the symbols/special chars in this table
 void IPlugin.process(GDD gdd, CommandLineArgs clArgs)
           
 int ICommand.process(GDD gdd, ParseContext context, TokenList tokens, boolean inCode)
          method for processing this command.
 

Uses of GDD in org.pz.platypus.parsers
 

Fields in org.pz.platypus.parsers declared as GDD
private  GDD MacroParser.gdd
          following are for output of error messages
 

Methods in org.pz.platypus.parsers with parameters of type GDD
private  void CommandFamilyParser.invalidCommandError(GDD gdd, ParseContext context, java.lang.String command)
          Outputs the error info to the user console
private  void CommandFamilyParser.invalidParameterError(GDD gdd, ParseContext context, java.lang.String command)
          Outputs the error info to the user console
 int CommandFamilyParser.parse(CommandTable ctable, ParseContext context, TokenList parsedTokens, java.lang.String familyRoot, GDD gdd)
          Parses a compound command, extracting the next command (as pointed to in the ParseContext) and any parameters associated with the command.
 

Constructors in org.pz.platypus.parsers with parameters of type GDD
MacroParser(GDD gdd)
           
 

Uses of GDD in org.pz.platypus.plugin.common
 

Fields in org.pz.platypus.plugin.common declared as GDD
private  GDD DocData.gdd
           
 

Methods in org.pz.platypus.plugin.common that return GDD
 GDD DocData.getGdd()
           
 

Constructors in org.pz.platypus.plugin.common with parameters of type GDD
DocData(GDD gddIn)
          Initializes the state of the PDF document.
 

Uses of GDD in org.pz.platypus.plugin.html
 

Fields in org.pz.platypus.plugin.html declared as GDD
private  GDD HtmlFont.gdd
           
private  GDD HtmlData.gdd
           
 

Methods in org.pz.platypus.plugin.html that return GDD
 GDD HtmlData.getGdd()
           
 

Methods in org.pz.platypus.plugin.html with parameters of type GDD
 java.lang.String HtmlColumns.dump(GDD gdd)
           
private  void Start.errMsgUnrecognizedCommand(Token tok, GDD gdd)
          Output error message to logger for unrecognized command
 void HtmlCommandTable.load(GDD gdd)
          Load the commands and symbols into the command table.
(package private)  void HtmlCommandTable.loadSymbols(GDD gdd)
          load the symbols and special characters.
 void HtmlOutfile.open(GDD gdd, java.lang.String filename, HtmlData htmlData)
          Open the output file.
 void Start.process(GDD gdd, CommandLineArgs clArgs)
          This is the main line of the plug-in.
(package private)  int Start.processCompoundCommand(GDD gdd, int startTokNumber)
          Handle compount commands.
(package private)  void Start.processSymbol(GDD gdd, java.lang.String filename, Token tok, int tokNum, HtmlData pdd)
          Process a symbol or foreign character
(package private)  void Start.processText(GDD gdd, java.lang.String filename, java.lang.String text)
          Process a token consisting of a text item
 void Start.processTokens(GDD gdd, HtmlData htmlData, java.lang.String outfileName)
          Where the token stream is translated into text and actions.
(package private)  void Start.setUpDataItems(GDD gdd)
          set up various data items needed in processing
(package private)  int HtmlColumns.validateColumnCount(int colCount, GDD gdd)
          Make sure the specified number of columns is correct ( > 0 ).
 

Constructors in org.pz.platypus.plugin.html with parameters of type GDD
HtmlData(GDD gddIn, HtmlCommandTable commandTable)
          Initializes the state of the PDF document.
 

Uses of GDD in org.pz.platypus.plugin.listing
 

Methods in org.pz.platypus.plugin.listing with parameters of type GDD
 void Start.closeOuputFile(java.io.FileWriter outputFile, GDD gdd)
          Close the file
 void Start.emitClosingHtml(java.io.FileWriter outputFile, GDD gdd)
          Emits the HTML closing code
 void Start.emitHtmlHeader(java.lang.String inputFile, java.io.FileWriter outputFile, GDD gdd)
          Emit the HTML needed at the beginning of the listing file
 void Start.emitListing(java.io.FileWriter outfile, GDD gdd)
          Where the content of the listing file is written out
 java.lang.String HtmlTextListingStrategy.format(Token tok, GDD gdd)
           
 java.lang.String HtmlSymbolListingStrategy.format(Token tok, GDD gdd)
           
 java.lang.String HtmlMacroListingStrategy.format(Token tok, GDD gdd)
           
abstract  java.lang.String HtmlListingStrategy.format(Token tok, GDD gdd)
           
 java.lang.String HtmlLineCommentListingStrategy.format(Token tok, GDD gdd)
           
 java.lang.String HtmlLineBreakStrategy.format(Token tok, GDD gdd)
           
 java.lang.String HtmlCRListingStrategy.format(Token tok, GDD gdd)
           
 java.lang.String HtmlCompoundCommandListingStrategy.format(Token tok, GDD gdd)
           
 java.lang.String HtmlCommandListingStrategy.format(Token tok, GDD gdd)
           
 java.lang.String HtmlBlockCommentListingStrategy.format(Token tok, GDD gdd)
           
 java.lang.String Start.getHeaderHtml(GDD gdd, java.lang.String inputFile)
          Build the string of HTML needed as the prelude to output of the code
 java.io.FileWriter Start.openOutputFile(java.lang.String filename, GDD gdd)
          Get an instance of FileWriter, to which we will emit HTML output
private  void Start.printToken(java.io.FileWriter outfile, GDD gdd, Token tok)
          Print the token contents with all the Html bells and whistles (colors, bold fonts, line breaks etc.) Get the Html string and output it to the output file.
 void Start.process(GDD gdd, CommandLineArgs clArgs)
          This is the main line of the plug-in.
private  int Start.startANewHtmlLine(java.io.FileWriter outfile, GDD gdd, Token tok)
          Start a new Html line.
private  void Start.writeIt(java.io.FileWriter outfile, GDD gdd, HtmlListingStrategy strategy, java.lang.String s)
           
 java.lang.String Start.writeStringToFile(java.io.FileWriter outfile, GDD gdd, java.lang.String s)
          Write a String to the output - deals with the business of actual writing.
 

Uses of GDD in org.pz.platypus.plugin.pdf
 

Fields in org.pz.platypus.plugin.pdf declared as GDD
private  GDD PdfFontFactory.gdd
           
private  GDD PdfFont.gdd
           
private  GDD PdfData.gdd
           
 

Methods in org.pz.platypus.plugin.pdf with parameters of type GDD
(package private)  java.lang.String PdfSymbolsTable.computePropFilename(GDD gdd)
          Compute the filename of the Symbols property file, based on the GDD
 java.lang.String Columns.dump(GDD gdd)
           
private  void Start.errMsgUnrecognizedCommand(Token tok, GDD gdd)
          Output error message to logger for unrecognized command
 void PdfSymbolsTable.load(GDD gdd)
          Compute the property file name for the symbols and load the symbols into the PropertyFile class
 void PdfCommandTable.load(GDD gdd)
          Load the commands and symbols into the command table.
 void PdfCommandTable.loadSymbols(GDD gdd)
          load the symbols and special characters.
(package private)  void PdfOutfile.openPdfFile(GDD gdd, PdfData pdf, java.lang.String filename)
          Low level function for opening an iText file (that is, an iText Document)
 void Start.process(GDD gdd, CommandLineArgs clArgs)
          This is the main line of the plug-in.
(package private)  int Start.processCompoundCommand(GDD gdd, int startTokNumber)
          Handle compount commands.
(package private)  void Start.processMacro(GDD gdd, Token tok, int tokNum)
          Look up the macro and insert a new token with the text right after the present token
(package private)  void Start.processText(GDD gdd, java.lang.String filename, java.lang.String text)
          Process a token consisting of a text item
(package private)  void Start.setUpDataItems(GDD gdd)
          set up various data items needed in processing
(package private)  int Columns.validateColumnCount(int colCount, GDD gdd)
          Make sure the specified number of columns is correct ( > 0 ).
 

Constructors in org.pz.platypus.plugin.pdf with parameters of type GDD
PdfData(GDD gddIn)
          Initializes the state of the PDF document.
PdfFontFactory(GDD Gdd, PdfData pdd)
           
PdfSymbolsTable(GDD Gdd)
           
 

Uses of GDD in org.pz.platypus.plugin.pdf.commands
 

Methods in org.pz.platypus.plugin.pdf.commands with parameters of type GDD
(package private)  void PdfDump.doHeading(GDD gdd, Token tok)
          Print the heading before the dump that states the location in the file of the [dump: command.
(package private)  void PdfDump.dumpAll(GDD gdd, PdfData pdf, Token tok, boolean doHeading)
          Dump all available info.
(package private)  void PdfDump.dumpCommandLine(GDD gdd, Token tok, boolean doHeading)
          Dump the command line and related data.
(package private)  void PdfDump.dumpPage(GDD gdd, PdfData pdf, Token tok, boolean doHeading)
          Dump the page dimensions and related data.
(package private)  void PdfDump.dumpParagraph(GDD gdd, PdfData pdf, Token tok, boolean doHeading)
          Dump the paragraph dimensions and related data.
(package private)  void PdfDump.dumpUserStrings(GDD gdd, Token tok, boolean doHeading)
          Dump the user strings, one k,v pair per line.
private  void PdfBulletListPlainStartWithOptions.errorBulletSymbolNotFound(GDD gdd, Token tok)
           
private  void PdfBulletListPlainStartWithOptions.errorInvalidOption(GDD gdd, Token tok)
           
private  void PdfBulletListPlainStartWithOptions.errorUnclosedOption(GDD gdd, Token tok)
           
(package private)  java.lang.String PdfSymbol.extractFontName(java.lang.String fontName, GDD gdd, Token tok)
          Extracts the font name from an extended entry in PdfSymbols.properties, such as: [trademark]={SYMBOL}\\u00E4, where the font name is between braces (so SYMBOL, in this example).
 java.lang.String PdfSymbol.getFontName(java.lang.String symbolEquiv, GDD gdd, Token tok)
           
private  void PdfPrintVariable.injectTextToken(GDD gdd, int tokNum, java.lang.String text, Source source)
          Injects a new text token into the TokenList, immediately after the present token.
 void PdfPrintVariable.issueErrorMessage(GDD gdd, Source source, java.lang.String macro)
           
 void DefUserString.issueErrorMessage(GDD gdd, Source source, java.lang.String macro)
           
 

Uses of GDD in org.pz.platypus.plugin.rtf
 

Fields in org.pz.platypus.plugin.rtf declared as GDD
private  GDD RtfOutfile.gdd
           
private  GDD RtfFont.gdd
           
private  GDD RtfData.gdd
           
 

Methods in org.pz.platypus.plugin.rtf with parameters of type GDD
static java.lang.String Conversions.convertParameterUnitToString(CommandParameter cp, GDD gdd)
          Converts a parameter unit type to a descriptive string (for error messages)
 void Start.emitListing(java.io.FileWriter outfile, GDD gdd)
          Where the content of the listing file is written out
 void RtfCommandTable.load(GDD gdd)
          Load the commands and symbols into the command table.
(package private)  void RtfCommandTable.loadSymbols(GDD gdd)
          load the symbols and special characters.
 void Start.process(GDD gdd, CommandLineArgs clArgs)
          This is the main line of the plug-in.
 void Start.processCommand(GDD gdd, RtfCommandTable commandTable, Token tok, int tokNum)
          Gets the RTF command and executes it.
 void Start.processInputTokens(GDD gdd, RtfOutfile outfile)
          Where the content of the listing file is written out
 void Start.processText(GDD gdd, Token tok, RtfOutfile outfile)
          Validates that there is text to output and then writes it as a string to the file.
 int Start.processToken(GDD gdd, Token tok, RtfOutfile outfile, int tokenNumber)
          Processes the individual tokens
 

Constructors in org.pz.platypus.plugin.rtf with parameters of type GDD
RtfData(GDD gddIn)
          Initializes the state of the PDF document.
 

Uses of GDD in org.pz.platypus.utilities
 

Methods in org.pz.platypus.utilities with parameters of type GDD
static java.lang.String Conversions.convertParameterUnitToString(CommandParameter cp, GDD gdd)
          Converts a parameter unit type to a descriptive string (for error messages)
static java.lang.String ErrorMsg.location(GDD gdd, Token tok)
          Most Platypus error messages start with the file# and line# where an error occurred.
static java.lang.String ErrorMsg.notAllowedInCode(GDD gdd, java.lang.String command, Source source)
          Logs warning when a command that is not supported in a code section is encountered.
 



Copyright © 2008-10 Pacific Data Works LLC