rvl.swv
Class LaTeXEngine

java.lang.Object
  extended by rvl.swv.AbstractEngine
      extended by rvl.swv.LaTeXEngine
All Implemented Interfaces:
EngineInterface

public class LaTeXEngine
extends AbstractEngine

Engine for LaTeX code. This is a trivial engine that works only with LaTeX source files. It just collects tex code from code chunks and drops them into the designated locations for output. That is, the output file is just the code file.


Field Summary
 
Fields inherited from class rvl.swv.AbstractEngine
codeExt, commentEnd, commentStart, endCode, engineName, medExt, okfigfmts, outExt, startupCode
 
Constructor Summary
LaTeXEngine()
           
 
Method Summary
 void closeFig()
          Put code to close the graphics file created by setupFig
 void deleteCodeFile()
          Delete the code and output files
 void putExpr(java.lang.String expr)
          Evaluate an expression and put it in the output stream
 void putSeparator(java.lang.String text)
          Put code that will add the given text in a separate line of the engine's output.
 void putStartup(boolean weaving)
          Startup code
 java.lang.Process runCode()
          Run the code, and return its Process object
 FigFile setupFig(java.lang.String chunkName)
          Put code that will set up a file to receive figure output This method uses the contents of AbstractEngine.okfigfmts and negotiates with the current FileInterface to determine what figure format to actually use, and how to size it.
 
Methods inherited from class rvl.swv.AbstractEngine
closeCodeFile, getFileNames, openCodeFile, postProcess, putCode, putComment, setBinary, setParents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LaTeXEngine

public LaTeXEngine()
Method Detail

putStartup

public void putStartup(boolean weaving)
Description copied from class: AbstractEngine
Startup code

Specified by:
putStartup in interface EngineInterface
Overrides:
putStartup in class AbstractEngine

putSeparator

public void putSeparator(java.lang.String text)
Description copied from class: AbstractEngine
Put code that will add the given text in a separate line of the engine's output. This is used by the parent to keep track of beginnings and ends of output chunks.

Specified by:
putSeparator in interface EngineInterface
Overrides:
putSeparator in class AbstractEngine

putExpr

public void putExpr(java.lang.String expr)
Description copied from class: AbstractEngine
Evaluate an expression and put it in the output stream

Specified by:
putExpr in interface EngineInterface
Overrides:
putExpr in class AbstractEngine

setupFig

public FigFile setupFig(java.lang.String chunkName)
Description copied from class: AbstractEngine
Put code that will set up a file to receive figure output This method uses the contents of AbstractEngine.okfigfmts and negotiates with the current FileInterface to determine what figure format to actually use, and how to size it. The extending class should call this as a superclass method, then use the properties of the returned object as needed in outputting the needed setup code for the figure

Specified by:
setupFig in interface EngineInterface
Overrides:
setupFig in class AbstractEngine
Returns:
null if no format can be found; otherwise the object can be used by the extending class to finish setting up the figure.

closeFig

public void closeFig()
Description copied from class: AbstractEngine
Put code to close the graphics file created by setupFig

Specified by:
closeFig in interface EngineInterface
Overrides:
closeFig in class AbstractEngine

runCode

public java.lang.Process runCode()
Description copied from class: AbstractEngine
Run the code, and return its Process object

Specified by:
runCode in interface EngineInterface
Overrides:
runCode in class AbstractEngine

deleteCodeFile

public void deleteCodeFile()
Description copied from class: AbstractEngine
Delete the code and output files

Specified by:
deleteCodeFile in interface EngineInterface
Overrides:
deleteCodeFile in class AbstractEngine