Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 addFilePath
 addOption, Optparse
 addSymbol
C
 check
E
 elementsLocalNamed, Helpers
 elementsNamespaced, Helpers
 expandTabs, Helpers
G
 generateClass, Helpers
 getAS3Registry, ModuleService_1_0
 getCheckFunction, SamHaXeModule
 getCidSymbol
 getCompatibleVersion, SamHaXeModule
 getContext
 getDependencyRegistry, ModuleService_1_0
 getDescription, SamHaXeModule
 getFlashVersion, ModuleService_1_0
 getHelp, Optparse
 getHelpFunction, SamHaXeModule
 getIdForHash
 getIdForHashSymbolCheck, Helpers
 getIdRegistry, ModuleService_1_0
 getImportFunction, SamHaXeModule
 getModule, Config
 getModuleService, SamHaXe
 getModuleUri, Config
 getNewId
 getSymbolCid
 getSymbolRegistry, ModuleService_1_0
 getVariable
 getVariableRegistry, ModuleService_1_0
 getXmlNN, Helpers
H
 help
I
 idExists
 import
 init, SamHaXeModule
 initAllModules, Config
 initInterface
 initModule
 isCompatibleVersion, SamHaXeModule
L
 load, Config
M
 main
 makeWriterStoreConst, Optparse
 modules, Config
N
 new
O
 onelined, Helpers
P
 parse, Optparse
R
 readerFloat, Optparse
 readerInt, Optparse
 readerKVArray, Optparse
 readerNull, Optparse
 readerString, Optparse
 runImport
function addFilePath(p: String): Void
Adds a new file to the dependency list.
public function addFilePath(p: String): Void
See DependencyRegistry.addFilePath
public function addOption(short: String,
long: String,
field: String,
reader: OptionReader,
writer: OptionWriter,
?help: String,
?help_arg: String)
Adds a new command line option to the parser.
public function addSymbol(cid: Int,  
symbol: String,  
 ?store =  true): Void
See SymbolRegistry.addSymbol
function addSymbol(cid: Int,  
symbol: String,  
?store Bool =  true): Void
Adds a symbol to the registry.
Validates a resource XML node.
public static function elementsLocalNamed(Xml,
lname String)
Returns all elements with the given localname.
public static function elementsNamespaced(Xml,
ns String)
Returns all elements in a given namespace
Replaces all tabs with 3 spaces.
public static function generateClass(as3Reg: AS3Registry,
className: String,
superClassName: String)
Generates a class definition with the given superclass.
public function getAS3Registry(): AS3Registry
Returns the AS3Registry instance for actual frame.
public function getCheckFunction(): CheckFunction
the check function for validating xml fragments, or null if such function is not exported
public function getCidSymbol(cid: Int): Null<String>
See SymbolRegistry.getCidSymbol
function getCidSymbol(cid: Int): Null<String>
Returns the symbol name for a character ID.
public function getCompatibleVersion(supported_versions: Array<String>,
required_version: String): String
Looks up the module interface of highest possible version constrained by the required version and the interface versions supported by SamHaXe.
function getContext(): format.abc.Context
Returns the AS3 context for the actual frame.
public function getContext(): format.abc.Context
See AS3Registry.getContext
public function getDependencyRegistry(): DependencyRegistry
Returns the DependencyRegistry instance.
public function getDescription(): String
the short description of the module
public function getFlashVersion() : Int
Returns the flash version used by the asset library.
public function getHelp(): StringBuf
Generates option usage help from the previously specified help and help_arg paramteres in addOption.
public function getHelpFunction(): HelpFunction
the help function for displaying module-specific help message, or null if such function is not exported
public function getIdForHash(md5: String,
tagId: Int): BytesIdLookupResult
Checks and returns if a character ID was already assigned for the given hashed data of the given tag type, or a new unique id if not found.
public function getIdForHash(md5: String,
tagId: Int) : BytesIdLookupResult
See IdRegistry.getIdForHash
public static function getIdForHashSymbolCheck(
   md5: String,
   tagId: Int,
   idReg: IdRegistry,
   ?symbolReg: SymbolRegistry,
   ?symbol: String
): HashIdSymCheckResult
Returns a character ID for the given data hash and tag type and checks the availability of the given symbol class.
public function getIdRegistry(): IdRegistry
Returns the IdRegistry instance.
public function getImportFunction(): ImportFunction
the import function for handling xml fragments
public function getModule(uri: String): SamHaXeModule
Returns the module instance for the given namespace URI.
public function getModuleService(if_version String) : Dynamic
Returns an instance of requested version of module service.
public function getModuleUri(module_name: String): String
Returns the namespace URI for a given module name.
public function getNewId(): Int
Queries a new characterd ID guaranteed to be unique.
public function getNewId(): Int
See IdRegistry.getNewId
public function getSymbolCid(symbol: String): Int
See SymbolRegistry.getSymbolCid
function getSymbolCid(symbol: String): Int
Returns the character ID for a symbol.
public function getSymbolRegistry(): SymbolRegistry
Returns the SymbolRegistry instance for actual frame.
public function getVariable(name: String): Dynamic
See VariableRegistry.getVariable
function getVariable(name: String): Dynamic
Retrieves the vaule of a variable.
public function getVariableRegistry(): VariableRegistry
Returns the VariableRegistry instance.
public static function getXmlNN(Xml) : XmlNN
Returns the namespace and localname of an Xml.Element
Returns a long help string about XML tags supported by the module.
public function idExists(id: Int): Bool
Checks whether a given character ID has already been defined.
public function idExists(id: Int): Bool
See IdRegistry.idExists
Imports assets described by a resource XML node.
public function init(supported_versions: Array<String>,
required_version: String,
moduleServices : String -> Dynamic)
Initializes the module by selecting and exposing a compatible module interface.
public function initAllModules()
Initializes all module instances requested so far.
Requests a specific interface version from the import module.
Initializes the module.
public function initModule(uri: String)
Initializes the module for the given namespace URI.
public function isCompatibleVersion(version: String,
req_version: String): Bool
Checks if the given module interface version is compatible with the requested.
public function load(config_file: String)
Loads configuration file.
Main entry point of the module.
public static function makeWriterStoreConst(
   user_const: Dynamic
): Dynamic -> String -> Dynamic -> Void
Constant option writer creator.
public function modules(): Iterator<String>
Returns an iterator over module URIs.
public function new(supported_versions: Array<String>,
moduleServices : String -> Dynamic)
Constructor.
public function new(msg: String)
public function new()
Constructor.
public function new(message: String,
arg: String,
arg_pos: Int)
Constructor
public function new()
Does all the work right now.
public function new(module_name: String,
uri: String)
Constructor
inline public static function onelined(String) : String
Removes newlines from the string.
public function parse(options: Dynamic,  
args: Array<String>,  
start: Int =  0): Int
Parses the command line arguments according to the previously specified options by addOption.
public static function readerFloat(args: Array<String>,
act: Int): ReaderResult
Float option reader.
public static function readerInt(args: Array<String>,
act: Int): ReaderResult
Integer option reader.
public static function readerKVArray(args: Array<String>,
act: Int): ReaderResult
Key/value pair list option reader.
public static function readerNull(args: Array<String>,
act: Int): ReaderResult
Null option reader.
public static function readerString(args: Array<String>,
act: Int): ReaderResult
String option reader.
public function runImport(asset NsFastXml): Array<SWFTag>
Imports resources described by the asset parameter.
public function runImport(asset: NsFastXml) : Array<SWFTag>
Invokes the import mechanism of the module associated with the asset.
Close