TypeScriptToLua.github.io/docs/api/printer/index.html at master · cipherxof/TypeScriptToLua.github.io

History

38 lines (38 loc) · 56.9 KB

Raw

<!doctype html>

<head>

</head>

<body>

<nav aria-label="Skip navigation links"><button type="button" tabindex="0" class="skipToContent_11B0">Skip to main content</button></nav><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg aria-label="Menu" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_YANc themedImage--dark_3ARp navbar__logo">TypeScriptToLua</a><a class="navbar__item navbar__link" href="/docs/getting-started">Docs</a><a class="navbar__item navbar__link" href="/play">Playground</a></div><div class="navbar__items navbar__items--right"><a href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Discord</a><a href="https://github.com/TypeScriptToLua/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_2N3Q"><div class="react-toggle-track"><div class="react-toggle-track-check">🌜</div><div class="react-toggle-track-x">🌞</div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><div class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg>Search</div></button></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_YANc themedImage--light_3CMI navbar__logo"><img src="/images/logo.png" alt="TypeScriptToLua" class="themedImage_YANc themedImage--dark_3ARp navbar__logo">TypeScriptToLua</a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/getting-started">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/play">Playground</a></li><li class="menu__list-item"><a href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="menu__link">Discord</a></li><li class="menu__list-item"><a href="https://github.com/TypeScriptToLua/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_vMrn"><div class="docSidebarContainer_3Ak5" role="complementary"><div class="sidebar_3gvy"><div class="menu menu--responsive thin-scrollbar menu_1yIk"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_1CUI" width="24" height="24" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/getting-started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/configuration">Configuration</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/caveats">Caveats</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/the-self-parameter">The Self Parameter</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/editor-support">Editor Support</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">Advanced</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/advanced/writing-declarations">Writing Declarations</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/advanced/compiler-annotations">Compiler Annotations</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/advanced/language-extensions">Language extensions</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">API</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/api/overview">Overview</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/api/plugins">Plugins</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/api/printer">Printer</a></li></ul></li></ul></div></div></div><main class="docMainContainer_2iGs"><div class="container padding-vert--lg docItemWrapper_1bxp"><div class="row"><div class="col docItemCol_U38p"><div class="docItemContainer_a7m4"><article><header><h1 class="docTitle_Oumm">Printer</h1></header><div class="markdown">The <a href="https://github.com/TypeScriptToLua/TypeScriptToLua/blob/master/src/LuaPrinter.ts" target="_blank" rel="noopener noreferrer">LuaPrinter</a> class takes Lua AST and prints it to a string (with source map). The printer implements the <a href="https://en.wikipedia.org/wiki/Visitor_pattern" target="_blank" rel="noopener noreferrer">visitor pattern</a>. All methods visit nodes in the AST to print them to a <a href="https://github.com/mozilla/source-map#sourcenode" target="_blank" rel="noopener noreferrer"><code>SourceNode</code></a>, this will automatically produce correct mappings in the resulting source map.<h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_prK2" id="api-reference"></a>API Reference<a class="hash-link" href="#api-reference" title="Direct link to heading">#</a></h2><div class="mdxCodeBlock_1zKU"><pre class="prism-code language-ts codeBlock_222H"><button type="button" aria-label="Copy code to clipboard" class="copyButton_ujp3">Copy</button><a aria-label="Open code on playground" class="playgroundButton_3DKR" target="_blank" href="/play/#code/JYOwLgpgTgZghgYwgAgApVGAShAzgVwBsxkBvAKGWQQHsATCALmVzAxAHMBuSlm-KEgCycAA7NW7br1z9BEEaIBy9JsgDKcpCoY8AvuXIJCcXLmQAZfHHSZoZXrRCT8CMDSgAKGqLDAazswAwjQAtqLAhNAA8r7+zgA0yBChwGAAEjSszACiqRlZYEkwkRBKcKFqkqAcAJQ8VKL4AEaEwAjIouxgnq00CADWzITWAHQAQoT9A0kjcBbAzQBiEHBgAnjM6hBgADxW84sraxsAfLXMtuA4BMQNnS1tHV2Y6mBrKRDgnqwfleDDMZvP5fMAXDRaMqqe5NVrtTrdAAiNGBkH+PV+aNBgLgo2RqM+4HBmgE2mhvFhTwRmAAanAMHBWhBERBjPS1vECeifu8sQDkHNRnSGUyWWyoByAlzQcTIToIDDHvCXuBhcBGVEAIJmYAcEDo6XfTGEsA40ba3C6-Wgw1grZy8mNJXPboASRgtp5IP5gvdtqSwFwOUIuAg7oA-MxmjQaFE4CBZaSoboKc7qeAAOoAC1KnuN6LN2dzvJNifk8sVcJdmBwolWYDzJYLArGtfrtrLZJTTqr6bASw8je9ppbuIHUA79qTFdTvZV-Y8rpAQ75I8F46Xk4h08dDzn3QA4jR3CuTWajyemzKp+Xd5Tld0LIyIIRT83BU-mi+tyTb9291S844OsUDLleRrgWurY7AIYHDp2yYKrOgHdOMUCrAMb7YqOEzoXAmGQQhM49ihmA5AAHl0eCWlKkFequZoUVROq0fBN5dkhJEPmRlHoSxICeBAvHUfEjHCfxRF3mm85vFICyQBKhCCeJNEgGask1PJ0BwIQkn-ve1bgEo+CVBgCBaYpynMapZrGaZ7QWTpemcQB3FGZEjlKUJ1miThSgeWk2m6exiGVqR4DImAuCeVZfE2ThkXRYFinOWFblgOMMZxiAMXeXFvmCplsarDlyVOSFxGuYZ-b4CAbjxEx+UBLFIkBGaSy1fVASNa1CYVVJ+6YB1dV+AELIlCAaTxPRZ44cNXUgONoBTQEqXIelAAqGoQEswAvnQPX8S1-FmltTK7fth2qWtXHVWdURXdNeW9ad22Pat-X6dJ3QAKogPSACe70Cc9J04X9gPAzdVV9uMoCQypT2I21OFw-9UBA8jfXbn+LkGX2QQ6YQwPHfFgqE4QxNY9D+PzkIOxZvQFNUz5zWg2TYz02AjN0MzUOfXj32YK6DDgMAJTQKTBVjCLoLi3tUA00L4D3WGIAMORJPs9LuKq0uGv8zjHFpdVsTae4XgDKAdBmmbEoWzTUDHqykB0A8uBZvroKeOCABuNDAHQMJO5AbgQG7og+F73x+wHQcUiHLvh8g1ve6ATRgJGRsQEEWa1QMCG5-nwfO2HbsIHhkC-hxnggKotmqEkCB5yAAy4CFRet8gAA+2edwMADaAC6ST-ZUWfVJwjul671ABAgazyrgnijKvzf5+3fct4PQ-T6Hs-zpM0y9FMgxmkfgx70nEfdLampQBKAMzeim+Craw+F9vw8l-vyeBraeRfBP3zNhN+hEoxZRKj-a+yAABWAcQD92XqGUQ7ILYSDYDUJu29N7Vxzl-XeHcCHQLLn2YGCxWBSwCK-MYwMP5EPzt-cgeggA">Playground</a><code class="codeBlockLines_3zpG" style="color:#393A34;background-color:#f6f8fa"><div class="token-line" style="color:#393A34">interface PrintResult {</div><div class="token-line" style="color:#393A34"> code: string;</div><div class="token-line" style="color:#393A34"> sourceMap: string;</div><div class="token-line" style="color:#393A34"> sourceMapNode: SourceNode;</div><div class="token-line" style="color:#393A34">}</div><div class="token-line" style="color:#393A34">

</div><div class="token-line" style="color:#393A34">class LuaPrinter {</div><div class="token-line" style="color:#393A34"> constructor(options: CompilerOptions, emitHost: EmitHost, fileName: string);</div><div class="token-line" style="color:#393A34"> public print(block: lua.Block, luaLibFeatures: Set<LuaLibFeature>): PrintResult;</div><div class="token-line" style="color:#393A34"> public printStatement(statement: lua.Statement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printDoStatement(statement: lua.DoStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printVariableDeclarationStatement(statement: lua.VariableDeclarationStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printVariableAssignmentStatement(statement: lua.AssignmentStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printIfStatement(statement: lua.IfStatement, isElseIf?: boolean): SourceNode;</div><div class="token-line" style="color:#393A34"> public printWhileStatement(statement: lua.WhileStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printRepeatStatement(statement: lua.RepeatStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printForStatement(statement: lua.ForStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printForInStatement(statement: lua.ForInStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printGotoStatement(statement: lua.GotoStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printLabelStatement(statement: lua.LabelStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printReturnStatement(statement: lua.ReturnStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printBreakStatement(statement: lua.BreakStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printExpressionStatement(statement: lua.ExpressionStatement): SourceNode;</div><div class="token-line" style="color:#393A34"> public printExpression(expression: lua.Expression): SourceNode;</div><div class="token-line" style="color:#393A34"> public printStringLiteral(expression: lua.StringLiteral): SourceNode;</div><div class="token-line" style="color:#393A34"> public printNumericLiteral(expression: lua.NumericLiteral): SourceNode;</div><div class="token-line" style="color:#393A34"> public printNilLiteral(expression: lua.NilLiteral): SourceNode;</div><div class="token-line" style="color:#393A34"> public printDotsLiteral(expression: lua.DotsLiteral): SourceNode;</div><div class="token-line" style="color:#393A34"> public printBooleanLiteral(expression: lua.BooleanLiteral): SourceNode;</div><div class="token-line" style="color:#393A34"> public printFunctionExpression(expression: lua.FunctionExpression): SourceNode;</div><div class="token-line" style="color:#393A34"> public printFunctionDefinition(statement: lua.FunctionDefinition): SourceNode;</div><div class="token-line" style="color:#393A34"> public printTableFieldExpression(expression: lua.TableFieldExpression): SourceNode;</div><div class="token-line" style="color:#393A34"> public printTableExpression(expression: lua.TableExpression): SourceNode;</div><div class="token-line" style="color:#393A34"> public printUnaryExpression(expression: lua.UnaryExpression): SourceNode;</div><div class="token-line" style="color:#393A34"> public printBinaryExpression(expression: lua.BinaryExpression): SourceNode;</div><div class="token-line" style="color:#393A34"> public printCallExpression(expression: lua.CallExpression): SourceNode;</div><div class="token-line" style="color:#393A34"> public printMethodCallExpression(expression: lua.MethodCallExpression): SourceNode;</div><div class="token-line" style="color:#393A34"> public printIdentifier(expression: lua.Identifier): SourceNode;</div><div class="token-line" style="color:#393A34"> public printTableIndexExpression(expression: lua.TableIndexExpression): SourceNode;</div><div class="token-line" style="color:#393A34"> public printOperator(kind: lua.Operator): SourceNode;</div><div class="token-line" style="color:#393A34"> protected pushIndent(): void;</div><div class="token-line" style="color:#393A34"> protected popIndent(): void;</div><div class="token-line" style="color:#393A34"> protected indent(input?: SourceChunk): SourceChunk;</div><div class="token-line" style="color:#393A34"> protected createSourceNode(node: lua.Node, chunks: SourceChunk | SourceChunk[], name?: string): SourceNode;</div><div class="token-line" style="color:#393A34"> protected concatNodes(...chunks: SourceChunk[]): SourceNode;</div><div class="token-line" style="color:#393A34"> protected printBlock(block: lua.Block): SourceNode;</div><div class="token-line" style="color:#393A34"> protected printStatementArray(statements: lua.Statement[]): SourceChunk[];</div><div class="token-line" style="color:#393A34"> protected isStatementEmpty(statement: lua.Statement): boolean;</div><div class="token-line" style="color:#393A34"> protected joinChunks(separator: string, chunks: SourceChunk[]): SourceChunk[];</div><div class="token-line" style="color:#393A34"> protected printExpressionList(expressions: lua.Expression[]): SourceChunk[];</div><div class="token-line" style="color:#393A34">}</div></code></pre></div></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/TypeScriptToLua/TypeScriptToLua.github.io/edit/source/docs/api/printer.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" role="img" viewBox="0 0 40 40" class="iconEdit_2LL7"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav" aria-label="Blog list page navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/api/plugins"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Plugins</div></a></div><div class="pagination-nav__item pagination-nav__item--next"></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_2xL- thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#api-reference" class="table-of-contents__link">API Reference</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/getting-started">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/configuration">Configuration</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/advanced/writing-declarations">Advanced</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a href="https://discord.gg/BWAq58Y" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a href="https://github.com/TypeScriptToLua" target="_blank" rel="noopener noreferrer" class="footer__link-item">Github</a></li><li class="footer__item"><a class="footer__link-item" href="/play">Playground</a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://github.com/TypescriptToLua" target="_blank" rel="noopener noreferrer" class="footerLogoLink_31Aa"><img class="footer__logo" alt="TypescriptToLua Logo" src="/images/logo.png"></a></div><div class="footer__copyright">Copyright © 2021 TypescriptToLua Contributors</div></div></div></footer></div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls