jscc-parser

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Source: io/io.js</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Source: io/io.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/** * @typedef {{filename: ?(string|undefined), chunkCallback: ?(function(string):void|undefined), endCallback: * ?(function():void|undefined)}} * @property {?(string|undefined)} filename - The filename to read. If omitted, read from standard input. * @property {?(function(string):void|undefined)} chunkCallback - The function to call when an input chunk is read * asynchronously. * @property {?(function():void|undefined)} endCallback - The function to call when the asynchronous read operation has * completed. */ var ioOptions; /** * @typedef {{text: string, destination: ?(string|undefined), callback: ?(function():void|undefined)}} * @property {string} text - The text to be written. * @property {?(string|undefined)} destination - The filename to which to write the text. If omitted, text is written * to standard output. * @property {?(function():void|undefined)} callback - A callback to be executed when the asynchronous write operation * has completed. If omitted, the operation occurs synchronously instead. */ var ioWriteOutputOptions; /** * Interface for engine-specific IO modules. * @interface */ jscc.io = function() { }; jscc.io.prototype = { /** * Reads input from the specified file or from standard input. * If chunkCallback and/or endCallback are specified, the operation * is asynchronous, and the function returns nothing. Otherwise, * the operation is synchronous, and the function returns a string * with the contents read from the file or from standard input. * * @param {(string|function(string):void|ioOptions)=} options - * If a string, the filename to read. If an object, has optional filename, chunkCallback, and endCallback * properties. If a function, the callback function to execute for each chunk read from standard input. * @returns {(string|void)} When running synchronously, the text read from * the file or standard input. When running asynchronously, returns nothing. */ read_all_input: function(options) { }, /** * Reads the template file into which the parser code is inserted. * If not specified, uses the default driver specified in * {@link jscc.global.DEFAULT_DRIVER}. * * @param {(string|function(string):void|ioOptions)=} options - * If a string, specifies the template filename. If a function, specifies the callback function to be used * when reading a file chunk has completed. If an object, specifies either or both. If omitted, causes the * function to read * {@link jscc.global.DEFAULT_DRIVER} synchronously. * @returns {(string|void)} When running synchronously, returns the contents of * the template file as a string. When running asynchronously, returns * nothing. */ read_template: function(options) { }, /** * Writes the provided text to the specified file or to standard output. * * @param {(string|ioWriteOutputOptions)} options - When a string, the text * to be written to standard output. When an object, contains text, destination, and callback properties. */ write_output: function(options) { }, /** * Writes the provided text to a debugging output, provided that such an output * exists in the implementation of this interface. * * @param {string} text - The text to write to the debugging output. */ write_debug: function(text) { }, /** * Attempts to exit the entire process with the provided exit code if the * platform supports doing so. Callers should also ensure that all functions * exit appropriately if the platform does not support this feature. * * @param {number=} exitCode - The exit code to use. */ exit: function(exitCode) { } }; </code></pre> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-jscc.html">jscc</a></li><li><a href="module-jscc_bitset_BitSet32.html">jscc/bitset/BitSet32</a></li><li><a href="module-jscc_bitset_BitSetBool.html">jscc/bitset/BitSetBool</a></li><li><a href="module-jscc_bitset_BitSetJava.html">jscc/bitset/BitSetJava</a></li><li><a href="module-jscc_classes_Dfa.html">jscc/classes/Dfa</a></li><li><a href="module-jscc_classes_Item.html">jscc/classes/Item</a></li><li><a href="module-jscc_classes_Nfa.html">jscc/classes/Nfa</a></li><li><a href="module-jscc_classes_Param.html">jscc/classes/Param</a></li><li><a href="module-jscc_classes_Production.html">jscc/classes/Production</a></li><li><a href="module-jscc_classes_State.html">jscc/classes/State</a></li><li><a href="module-jscc_classes_Symbol.html">jscc/classes/Symbol</a></li><li><a href="module-jscc_classes_TableEntry.html">jscc/classes/TableEntry</a></li><li><a href="module-jscc_enums_ASSOC.html">jscc/enums/ASSOC</a></li><li><a href="module-jscc_enums_EDGE.html">jscc/enums/EDGE</a></li><li><a href="module-jscc_enums_EXEC.html">jscc/enums/EXEC</a></li><li><a href="module-jscc_enums_LOG_LEVEL.html">jscc/enums/LOG_LEVEL</a></li><li><a href="module-jscc_enums_MODE_GEN.html">jscc/enums/MODE_GEN</a></li><li><a href="module-jscc_enums_SPECIAL.html">jscc/enums/SPECIAL</a></li><li><a href="module-jscc_enums_SYM.html">jscc/enums/SYM</a></li><li><a href="module-jscc_first.html">jscc/first</a></li><li><a href="module-jscc_global.html">jscc/global</a></li><li><a href="module-jscc_integrity.html">jscc/integrity</a></li><li><a href="module-jscc_io_io.html">jscc/io/io</a></li><li><a href="module-jscc_lexdbg.html">jscc/lexdbg</a></li><li><a href="module-jscc_lexdfa.html">jscc/lexdfa</a></li><li><a href="module-jscc_log_log.html">jscc/log/log</a></li><li><a href="module-jscc_parse.html">jscc/parse</a></li><li><a href="module-jscc_printtab.html">jscc/printtab</a></li><li><a href="module-jscc_regex.html">jscc/regex</a></li><li><a href="module-jscc_util.html">jscc/util</a></li></ul><h3>Classes</h3><ul><li><a href="-_anonymous_-jscc.BitSet32.html">BitSet32</a></li><li><a href="-_anonymous_-jscc.BitSetBool.html">BitSetBool</a></li><li><a href="-_anonymous_-jscc.BitSetJava.html">BitSetJava</a></li><li><a href="-_anonymous_-jscc.classes.Dfa.html">classes.Dfa</a></li><li><a href="-_anonymous_-jscc.first.html">first</a></li><li><a href="-_anonymous_-jscc.global.html">global</a></li><li><a href="-_anonymous_-jscc.integrity.html">integrity</a></li><li><a href="-_anonymous_-jscc.ioBrowser.html">ioBrowser</a></li><li><a href="-_anonymous_-jscc.ioNashorn.html">ioNashorn</a></li><li><a href="-_anonymous_-jscc.ioNode.html">ioNode</a></li><li><a href="-_anonymous_-jscc.ioRhino.html">ioRhino</a></li><li><a href="-_anonymous_-jscc.lexdbg.html">lexdbg</a></li><li><a href="-_anonymous_-jscc.lexdfa.html">lexdfa</a></li><li><a href="-_anonymous_-jscc.logBrowser.html">logBrowser</a></li><li><a href="-_anonymous_-jscc.logJava.html">logJava</a></li><li><a href="-_anonymous_-jscc.logNode.html">logNode</a></li><li><a href="-_anonymous_-jscc.printtab.html">printtab</a></li><li><a href="-_anonymous_-jscc.util.html">util</a></li><li><a href="jscc_debug.html">jscc/debug</a></li><li><a href="jscc_nfaStates.html">jscc/nfaStates</a></li><li><a href="jscc_tabgen.html">jscc/tabgen</a></li><li><a href="%257Bjscc.classes%257D.jscc.classes.State.html">jscc.classes.State</a></li></ul><h3>Namespaces</h3><ul><li><a href="jscc.debug.html">debug</a></li></ul><h3>Interfaces</h3><ul><li><a href="jscc.bitset.html">bitset</a></li><li><a href="jscc.io.html">io</a></li><li><a href="jscc.log.html">log</a></li></ul><h3><a href="global.html">Global</a></h3> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Aug 01 2016 11:09:19 GMT-0500 (Central Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>