org.apache.flex.compiler.clients

Class ASC

java.lang.Object

org.apache.flex.compiler.clients.ASC

public class ASC
extends Object

ActionScript Compiler command-line interface.

Although ASC can parse most of the command-line options supported by the old ASC, only a few of them are implemented at the moment.

See Also:

ASC client spec

Constructor Summary

Constructors

Constructor and Description
ASC()

Method Summary

Methods

Modifier and Type	Method and Description
void	addImportFilename(String filename)
void	addIncludeFilename(String filename)
void	addNamespace(String namespace)
void	addOptimizerConfig(String value)
void	addSourceFilename(String source)
boolean	getABCFuture()
int	getApiVersion()
String	getAvmplusFilename()
Map<String,String>	getConfigVars()
int	getDialect()
boolean	getEmitDebugInfo()
boolean	getEmitDocInfo()
boolean	getEmitMetadata()
List<String>	getExternalLibraries()
int	getFrameRate()
int	getHeight()
List<String>	getImportFilenames()
List<String>	getIncludeFilenames()
List<String>	getInternalLibraries()
Locale	getLocale()
boolean	getMakeMovieClip()
boolean	getMergeABCs()
List<String>	getNamespaces()
boolean	getOptimize()
List<String>	getOptimizerConfigs()
String	getOutputBasename() Get the user specified basename.
String	getOutputDirectory() Get the user specified output directory.
boolean	getParallel() Gets a boolean that indicates whether or not parallel code generation of method bodies is enabled.
String	getProblems()
boolean	getRemoveDeadCode()
boolean	getShowBytes()
boolean	getShowFlowGraph()
boolean	getShowInstructions()
boolean	getShowLineNumbers()
boolean	getShowLog()
boolean	getShowMachineCode()
boolean	getShowParseTrees()
boolean	getShowWarnings()
List<String>	getSourceFilenames()
String	getSymbolClass()
int	getTargetAVM()
boolean	getUseSanityMode()
int	getWidth()
boolean	isGenerateSWF()
boolean	isInliningEnabled() Gets a boolean that indicates whether or not inlining of method bodies is enabled.
static void	main(String[] args) Entry point for ASC command-line.
int	mainNoExit(String[] args) Do not call System.exit(int) here to allow unit testing.
int	mainNoExit(String[] args, PrintStream out, PrintStream err) Do not call System.exit(int) here to allow unit testing.
void	putConfigVar(String key, String value) Sets a config var key/value pair used in conditional compilation.
void	setABCFuture(boolean b)
void	setApiVersion(String version)
void	setAvmplusFilename(String filename)
void	setDialect(String dialect)
void	setEmitDebugInfo(boolean emitDebugInfo)
void	setEmitDocInfo(boolean emitDocInfo)
void	setEmitMetadata(boolean emitMetadata)
void	setEnableInlining(boolean enableInlining) Enables or disables parallel code generation of method bodies.
void	setFrameRate(String frameRate)
void	setHeight(String height)
void	setLocale(Locale locale)
void	setMakeMovieClip(boolean makeMovieClip)
void	setMergeABCs(boolean mergeABCs)
void	setOptimize(boolean optimize)
void	setOutputBasename(String outputBasename) Set the basename.
void	setOutputDirectory(String outputDirectory) Set the output directory from the "-outdir" option.
void	setParallel(boolean parallel) Enables or disables parallel code generation of method bodies.
void	setRemoveDeadCode(boolean removeDeadCode) Enable or disable dead code removal.
void	setShowBytes(boolean showBytes)
void	setShowFlowGraph(boolean showFlowGraph)
void	setShowInstructions(boolean showInstructions)
void	setShowLineNumbers(boolean showLineNumbers)
void	setShowLog(boolean showLog)
void	setShowMachineCode(boolean showMachineCode)
void	setShowParseTrees(boolean showParseTrees)
void	setShowWarnings(boolean showWarnings)
void	setSymbolClass(String symbolClass)
void	setTargetAVM(String version)
void	setUseSanityMode(boolean useSanityMode)
void	setUseStaticSemantics(boolean useStaticSemantics)
void	setWidth(String width)
boolean	useStaticSemantics()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ASC

public ASC()

Method Detail

main

public static void main(String[] args)

Entry point for ASC command-line.

mainNoExit

public int mainNoExit(String[] args)

Do not call System.exit(int) here to allow unit testing. Uses System.out and System.err as default streams

Parameters:

args - arguments

Returns:

exit code

mainNoExit

public int mainNoExit(String[] args,
             PrintStream out,
             PrintStream err)

Do not call System.exit(int) here to allow unit testing.

Parameters:

args - arguments

out - stdout printstream

err - stderr printstream

Returns:

exit code

getProblems

public String getProblems()

getSourceFilenames

public List<String> getSourceFilenames()

Returns:

the list of source files to compile

addSourceFilename

public void addSourceFilename(String source)

Parameters:

source - - a root source filename to compile

getIncludeFilenames

public List<String> getIncludeFilenames()

Returns:

the list of source filenames to include in compilation

addIncludeFilename

public void addIncludeFilename(String filename)

Parameters:

filename - - a source filename to include in compilation

getImportFilenames

public List<String> getImportFilenames()

Returns:

the list of ABC filenames to import

addImportFilename

public void addImportFilename(String filename)

Parameters:

filename - - an ABC filename to import

getInternalLibraries

public List<String> getInternalLibraries()

getExternalLibraries

public List<String> getExternalLibraries()

getConfigVars

public Map<String,String> getConfigVars()

Returns:

the map of config namespace variables that will be used to support conditional compilation

putConfigVar

public void putConfigVar(String key,
                String value)

Sets a config var key/value pair used in conditional compilation.

Parameters:

key - - the config var name

value - - the config var value

getNamespaces

public List<String> getNamespaces()

Returns:

the list of namespaces to automatically use (open) during compilation

addNamespace

public void addNamespace(String namespace)

Parameters:

namespace - - a namespace to be automatically used (opened) during compilation

getApiVersion

public int getApiVersion()

Returns:

the native API version of the runtime

setApiVersion

public void setApiVersion(String version)

Parameters:

version - - the native API version of the runtime

getDialect

public int getDialect()

Returns:

the ActionScript language dialect to use during compilation

setDialect

public void setDialect(String dialect)

Parameters:

dialect - - the ActionScript language dialect to set for compilation

getTargetAVM

public int getTargetAVM()

Returns:

the version of the ActionScript Virtual Machine that generated byte code should target, either 1 for AVM1 or 2 for AVM2.

setTargetAVM

public void setTargetAVM(String version)

Parameters:

version - - the version of the ActionScript Virtual Machine that generated byte code should target, either 1 for AVM1 or 2 for AVM2.

useStaticSemantics

public boolean useStaticSemantics()

Returns:

whether static semantics should be used?

setUseStaticSemantics

public void setUseStaticSemantics(boolean useStaticSemantics)

Parameters:

useStaticSemantics - - determines whether static semantics should be used?

getShowWarnings

public boolean getShowWarnings()

Returns:

whether warnings for common ActionScript mistakes should be shown

setShowWarnings

public void setShowWarnings(boolean showWarnings)

Parameters:

showWarnings - - determines whether warnings for common ActionScript mistakes should be shown

getUseSanityMode

public boolean getUseSanityMode()

Returns:

whether system-independent error/warning output should be used (appropriate for sanity testing)

setUseSanityMode

public void setUseSanityMode(boolean useSanityMode)

Parameters:

useSanityMode - - determines whether system-independent error/warning output should be used

getLocale

public Locale getLocale()

Returns:

the locale to use for compiler errors and warnings

setLocale

public void setLocale(Locale locale)

Parameters:

locale - - the locale to use for compiler errors and warnings

getMakeMovieClip

public boolean getMakeMovieClip()

Returns:

whether a movieclip should be made? TODO: What did this option do?

setMakeMovieClip

public void setMakeMovieClip(boolean makeMovieClip)

Parameters:

makeMovieClip - - determines whether a movieclip should be made?

getSymbolClass

public String getSymbolClass()

Returns:

the name of the top-level SymbolClass to set in a SWF

setSymbolClass

public void setSymbolClass(String symbolClass)

Parameters:

symbolClass - - the name of top-level SymbolClass to use in a SWF

isGenerateSWF

public boolean isGenerateSWF()

Returns:

true if -swf argument is set.

getWidth

public int getWidth()

Returns:

the SWF stage width

setWidth

public void setWidth(String width)

Parameters:

width - - the SWF stage width

getHeight

public int getHeight()

Returns:

the SWF stage height

setHeight

public void setHeight(String height)

Parameters:

height - - the SWF stage height

getFrameRate

public int getFrameRate()

Returns:

the SWF frame rate

setFrameRate

public void setFrameRate(String frameRate)

Parameters:

frameRate - - the SWF frame rate

getEmitDebugInfo

public boolean getEmitDebugInfo()

Returns:

whether debug info should be emitted into the byte code

getABCFuture

public boolean getABCFuture()

Returns:

whether we should target newer abc version

setABCFuture

public void setABCFuture(boolean b)

Parameters:

b - determines if we should emit a 47.14 ABC or not

setEmitDebugInfo

public void setEmitDebugInfo(boolean emitDebugInfo)

Parameters:

emitDebugInfo - - determines whether debug info should be emitted into the byte code

getEmitDocInfo

public boolean getEmitDocInfo()

Returns:

whether asdoc information should be emitted into the byte code

setEmitDocInfo

public void setEmitDocInfo(boolean emitDocInfo)

Parameters:

emitDocInfo - - determines whether asdoc info should be emitted into the byte code

getEmitMetadata

public boolean getEmitMetadata()

Returns:

whether metadata should be emitted into the byte code

setEmitMetadata

public void setEmitMetadata(boolean emitMetadata)

Parameters:

emitMetadata - - determines whether metadata should be emitted into the byte code

getAvmplusFilename

public String getAvmplusFilename()

Returns:

the filename of the avmplus executable to use to make a projector file

setAvmplusFilename

public void setAvmplusFilename(String filename)

Parameters:

filename - - the avmplus executable filename to use to create a projector file

getShowBytes

public boolean getShowBytes()

Returns:

whether the byte codes should be shown in a dump of the generated ABC

setShowBytes

public void setShowBytes(boolean showBytes)

Parameters:

showBytes - - determines whether bytes should be shown in a dump of the generated ABC

getShowParseTrees

public boolean getShowParseTrees()

Returns:

whether the parse tree should be written to a .p file.

setShowParseTrees

public void setShowParseTrees(boolean showParseTrees)

Parameters:

showParseTrees - - determines whether the parse tree should be written to a .p file

getShowInstructions

public boolean getShowInstructions()

Returns:

whether intermediate code should be written to a .il file

setShowInstructions

public void setShowInstructions(boolean showInstructions)

Parameters:

showInstructions - - determines whether intermediate code should be written to a .il file

getShowLineNumbers

public boolean getShowLineNumbers()

Returns:

whether line numbers should be shown in the dump of generated ABC bytes

setShowLineNumbers

public void setShowLineNumbers(boolean showLineNumbers)

Parameters:

showLineNumbers - - determines whether line numbers should be shown in the dump of generated ABC bytes

getShowMachineCode

public boolean getShowMachineCode()

Returns:

whether AVM+ assembly code should be included in the .il file

setShowMachineCode

public void setShowMachineCode(boolean showMachineCode)

Parameters:

showMachineCode - - determines whether AVM+ assembly code should be included in the .il file

getShowFlowGraph

public boolean getShowFlowGraph()

Returns:

whether the flow graph should be printed to standard out

setShowFlowGraph

public void setShowFlowGraph(boolean showFlowGraph)

Parameters:

showFlowGraph - - determines whether the flow graph should be printed to standard out

getShowLog

public boolean getShowLog()

Returns:

whether logging information should be shown

setShowLog

public void setShowLog(boolean showLog)

Parameters:

showLog - - determines whether logging information should be shown

getOptimize

public boolean getOptimize()

Returns:

whether the ABC file should be optimized

setOptimize

public void setOptimize(boolean optimize)

Parameters:

optimize - - determines whether the generated ABC should be optimized

getOptimizerConfigs

public List<String> getOptimizerConfigs()

Returns:

the configuration options for the optimizer

addOptimizerConfig

public void addOptimizerConfig(String value)

Parameters:

value - - a configuration option for the optimizer, potentially specified as a 'name=value' String

getMergeABCs

public boolean getMergeABCs()

Returns:

true if the ABC bytes should be merged into a single output file, false otherwise.

setMergeABCs

public void setMergeABCs(boolean mergeABCs)

Parameters:

mergeABCs - true to turn on ABC merging, false to turn off.

getOutputDirectory

public String getOutputDirectory()

Get the user specified output directory. Set using the "-outdir" option.

Returns:

user specified directory. May be null if no directory was specified.

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

Set the output directory from the "-outdir" option.

Parameters:

outputDirectory - A path string.

getOutputBasename

public String getOutputBasename()

Get the user specified basename. This option only makes sense when merging ABCs. The basename can be specified using the "-out" option.

Returns:

the basename of output files. May be null if no basename was specified.

setOutputBasename

public void setOutputBasename(String outputBasename)

Set the basename. Typically set to the value of the "-out" option.

Parameters:

outputBasename - The base name of the output file.

getParallel

public boolean getParallel()

Gets a boolean that indicates whether or not parallel code generation of method bodies is enabled.

Returns:

true if method bodies should be generated in parallel, false otherwise.

setParallel

public void setParallel(boolean parallel)

Enables or disables parallel code generation of method bodies.

Parameters:

parallel - If true, method bodies will be generated in parallel.

isInliningEnabled

public boolean isInliningEnabled()

Gets a boolean that indicates whether or not inlining of method bodies is enabled.

Returns:

true if inlining enabled, false otherwise.

setEnableInlining

public void setEnableInlining(boolean enableInlining)

Enables or disables parallel code generation of method bodies.

Parameters:

enableInlining - If true, method bodies will be generated in parallel.

setRemoveDeadCode

public void setRemoveDeadCode(boolean removeDeadCode)

Enable or disable dead code removal.

Parameters:

removeDeadCode - true if dead code is to be removed.

getRemoveDeadCode

public boolean getRemoveDeadCode()

Returns:

true if dead code is to be removed.