/documentation/docs/grammar.html

http://github.com/jashkenas/coffee-script · HTML · 1628 lines · 1147 code · 481 blank · 0 comment · 0 complexity · 8b9b8aba3fd9799dfcf99bb234e07778 MD5 · raw file

Large files are truncated click here to view the full file

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>grammar.coffee</title>
  5. <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  6. <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  7. <link rel="stylesheet" media="all" href="docco.css" />
  8. </head>
  9. <body>
  10. <div id="container">
  11. <div id="background"></div>
  12. <ul id="jump_to">
  13. <li>
  14. <a class="large" href="javascript:void(0);">Jump To &hellip;</a>
  15. <a class="small" href="javascript:void(0);">+</a>
  16. <div id="jump_wrapper">
  17. <div id="jump_page_wrapper">
  18. <div id="jump_page">
  19. <a class="source" href="browser.html">
  20. browser.coffee
  21. </a>
  22. <a class="source" href="cake.html">
  23. cake.coffee
  24. </a>
  25. <a class="source" href="coffee-script.html">
  26. coffee-script.coffee
  27. </a>
  28. <a class="source" href="command.html">
  29. command.coffee
  30. </a>
  31. <a class="source" href="grammar.html">
  32. grammar.coffee
  33. </a>
  34. <a class="source" href="helpers.html">
  35. helpers.coffee
  36. </a>
  37. <a class="source" href="index.html">
  38. index.coffee
  39. </a>
  40. <a class="source" href="lexer.html">
  41. lexer.coffee
  42. </a>
  43. <a class="source" href="nodes.html">
  44. nodes.coffee
  45. </a>
  46. <a class="source" href="optparse.html">
  47. optparse.coffee
  48. </a>
  49. <a class="source" href="register.html">
  50. register.coffee
  51. </a>
  52. <a class="source" href="repl.html">
  53. repl.coffee
  54. </a>
  55. <a class="source" href="rewriter.html">
  56. rewriter.coffee
  57. </a>
  58. <a class="source" href="scope.html">
  59. scope.litcoffee
  60. </a>
  61. <a class="source" href="sourcemap.html">
  62. sourcemap.litcoffee
  63. </a>
  64. </div>
  65. </div>
  66. </li>
  67. </ul>
  68. <ul class="sections">
  69. <li id="title">
  70. <div class="annotation">
  71. <h1>grammar.coffee</h1>
  72. </div>
  73. </li>
  74. <li id="section-1">
  75. <div class="annotation">
  76. <div class="pilwrap ">
  77. <a class="pilcrow" href="#section-1">&#182;</a>
  78. </div>
  79. <p>The CoffeeScript parser is generated by <a href="http://github.com/zaach/jison">Jison</a>
  80. from this grammar file. Jison is a bottom-up parser generator, similar in
  81. style to <a href="http://www.gnu.org/software/bison">Bison</a>, implemented in JavaScript.
  82. It can recognize <a href="http://en.wikipedia.org/wiki/LR_grammar">LALR(1), LR(0), SLR(1), and LR(1)</a>
  83. type grammars. To create the Jison parser, we list the pattern to match
  84. on the left-hand side, and the action to take (usually the creation of syntax
  85. tree nodes) on the right. As the parser runs, it
  86. shifts tokens from our token stream, from left to right, and
  87. <a href="http://en.wikipedia.org/wiki/Bottom-up_parsing">attempts to match</a>
  88. the token sequence against the rules below. When a match can be made, it
  89. reduces into the <a href="http://en.wikipedia.org/wiki/Terminal_and_nonterminal_symbols">nonterminal</a>
  90. (the enclosing name at the top), and we proceed from there.</p>
  91. <p>If you run the <code>cake build:parser</code> command, Jison constructs a parse table
  92. from our rules and saves it into <code>lib/parser.js</code>.</p>
  93. </div>
  94. </li>
  95. <li id="section-2">
  96. <div class="annotation">
  97. <div class="pilwrap ">
  98. <a class="pilcrow" href="#section-2">&#182;</a>
  99. </div>
  100. <p>The only dependency is on the <strong>Jison.Parser</strong>.</p>
  101. </div>
  102. <div class="content"><div class='highlight'><pre>{Parser} = <span class="hljs-built_in">require</span> <span class="hljs-string">'jison'</span></pre></div></div>
  103. </li>
  104. <li id="section-3">
  105. <div class="annotation">
  106. <div class="pilwrap ">
  107. <a class="pilcrow" href="#section-3">&#182;</a>
  108. </div>
  109. <h2 id="jison-dsl">Jison DSL</h2>
  110. </div>
  111. </li>
  112. <li id="section-4">
  113. <div class="annotation">
  114. <div class="pilwrap ">
  115. <a class="pilcrow" href="#section-4">&#182;</a>
  116. </div>
  117. </div>
  118. </li>
  119. <li id="section-5">
  120. <div class="annotation">
  121. <div class="pilwrap ">
  122. <a class="pilcrow" href="#section-5">&#182;</a>
  123. </div>
  124. <p>Since were going to be wrapped in a function by Jison in any case, if our
  125. action immediately returns a value, we can optimize by removing the function
  126. wrapper and just returning the value directly.</p>
  127. </div>
  128. <div class="content"><div class='highlight'><pre>unwrap = <span class="hljs-regexp">/^function\s*\(\)\s*\{\s*return\s*([\s\S]*);\s*\}/</span></pre></div></div>
  129. </li>
  130. <li id="section-6">
  131. <div class="annotation">
  132. <div class="pilwrap ">
  133. <a class="pilcrow" href="#section-6">&#182;</a>
  134. </div>
  135. <p>Our handy DSL for Jison grammar generation, thanks to
  136. <a href="http://github.com/creationix">Tim Caswell</a>. For every rule in the grammar,
  137. we pass the pattern-defining string, the action to run, and extra options,
  138. optionally. If no action is specified, we simply pass the value of the
  139. previous nonterminal.</p>
  140. </div>
  141. <div class="content"><div class='highlight'><pre><span class="hljs-function"><span class="hljs-title">o</span> = <span class="hljs-params">(patternString, action, options)</span> -&gt;</span>
  142. patternString = patternString.replace <span class="hljs-regexp">/\s{2,}/g</span>, <span class="hljs-string">' '</span>
  143. patternCount = patternString.split(<span class="hljs-string">' '</span>).length
  144. <span class="hljs-keyword">return</span> [patternString, <span class="hljs-string">'$$ = $1;'</span>, options] <span class="hljs-keyword">unless</span> action
  145. action = <span class="hljs-keyword">if</span> match = unwrap.exec action <span class="hljs-keyword">then</span> match[<span class="hljs-number">1</span>] <span class="hljs-keyword">else</span> <span class="hljs-string">"(<span class="hljs-subst">#{action}</span>())"</span></pre></div></div>
  146. </li>
  147. <li id="section-7">
  148. <div class="annotation">
  149. <div class="pilwrap ">
  150. <a class="pilcrow" href="#section-7">&#182;</a>
  151. </div>
  152. <p>All runtime functions we need are defined on yy</p>
  153. </div>
  154. <div class="content"><div class='highlight'><pre> action = action.replace <span class="hljs-regexp">/\bnew /g</span>, <span class="hljs-string">'$&amp;yy.'</span>
  155. action = action.replace <span class="hljs-regexp">/\b(?:Block\.wrap|extend)\b/g</span>, <span class="hljs-string">'yy.$&amp;'</span></pre></div></div>
  156. </li>
  157. <li id="section-8">
  158. <div class="annotation">
  159. <div class="pilwrap ">
  160. <a class="pilcrow" href="#section-8">&#182;</a>
  161. </div>
  162. <p>Returns a function which adds location data to the first parameter passed
  163. in, and returns the parameter. If the parameter is not a node, it will
  164. just be passed through unaffected.</p>
  165. </div>
  166. <div class="content"><div class='highlight'><pre> <span class="hljs-function"><span class="hljs-title">addLocationDataFn</span> = <span class="hljs-params">(first, last)</span> -&gt;</span>
  167. <span class="hljs-keyword">if</span> <span class="hljs-keyword">not</span> last
  168. <span class="hljs-string">"yy.addLocationDataFn(@<span class="hljs-subst">#{first}</span>)"</span>
  169. <span class="hljs-keyword">else</span>
  170. <span class="hljs-string">"yy.addLocationDataFn(@<span class="hljs-subst">#{first}</span>, @<span class="hljs-subst">#{last}</span>)"</span>
  171. action = action.replace <span class="hljs-regexp">/LOC\(([0-9]*)\)/g</span>, addLocationDataFn(<span class="hljs-string">'$1'</span>)
  172. action = action.replace <span class="hljs-regexp">/LOC\(([0-9]*),\s*([0-9]*)\)/g</span>, addLocationDataFn(<span class="hljs-string">'$1'</span>, <span class="hljs-string">'$2'</span>)
  173. [patternString, <span class="hljs-string">"$$ = <span class="hljs-subst">#{addLocationDataFn(<span class="hljs-number">1</span>, patternCount)}</span>(<span class="hljs-subst">#{action}</span>);"</span>, options]</pre></div></div>
  174. </li>
  175. <li id="section-9">
  176. <div class="annotation">
  177. <div class="pilwrap ">
  178. <a class="pilcrow" href="#section-9">&#182;</a>
  179. </div>
  180. <h2 id="grammatical-rules">Grammatical Rules</h2>
  181. </div>
  182. </li>
  183. <li id="section-10">
  184. <div class="annotation">
  185. <div class="pilwrap ">
  186. <a class="pilcrow" href="#section-10">&#182;</a>
  187. </div>
  188. </div>
  189. </li>
  190. <li id="section-11">
  191. <div class="annotation">
  192. <div class="pilwrap ">
  193. <a class="pilcrow" href="#section-11">&#182;</a>
  194. </div>
  195. <p>In all of the rules that follow, youll see the name of the nonterminal as
  196. the key to a list of alternative matches. With each matchs action, the
  197. dollar-sign variables are provided by Jison as references to the value of
  198. their numeric position, so in this rule:</p>
  199. <pre><code><span class="hljs-string">"Expression UNLESS Expression"</span>
  200. </code></pre><p><code>$1</code> would be the value of the first <code>Expression</code>, <code>$2</code> would be the token
  201. for the <code>UNLESS</code> terminal, and <code>$3</code> would be the value of the second
  202. <code>Expression</code>.</p>
  203. </div>
  204. <div class="content"><div class='highlight'><pre>grammar =</pre></div></div>
  205. </li>
  206. <li id="section-12">
  207. <div class="annotation">
  208. <div class="pilwrap ">
  209. <a class="pilcrow" href="#section-12">&#182;</a>
  210. </div>
  211. <p>The <strong>Root</strong> is the top-level node in the syntax tree. Since we parse bottom-up,
  212. all parsing must end here.</p>
  213. </div>
  214. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Root</span>: [
  215. o <span class="hljs-string">''</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Block
  216. o <span class="hljs-string">'Body'</span>
  217. ]</pre></div></div>
  218. </li>
  219. <li id="section-13">
  220. <div class="annotation">
  221. <div class="pilwrap ">
  222. <a class="pilcrow" href="#section-13">&#182;</a>
  223. </div>
  224. <p>Any list of statements and expressions, separated by line breaks or semicolons.</p>
  225. </div>
  226. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Body</span>: [
  227. o <span class="hljs-string">'Line'</span>,<span class="hljs-function"> -&gt;</span> Block.wrap [$<span class="hljs-number">1</span>]
  228. o <span class="hljs-string">'Body TERMINATOR Line'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">1.</span>push $<span class="hljs-number">3</span>
  229. o <span class="hljs-string">'Body TERMINATOR'</span>
  230. ]</pre></div></div>
  231. </li>
  232. <li id="section-14">
  233. <div class="annotation">
  234. <div class="pilwrap ">
  235. <a class="pilcrow" href="#section-14">&#182;</a>
  236. </div>
  237. <p>Block and statements, which make up a line in a body.</p>
  238. </div>
  239. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Line</span>: [
  240. o <span class="hljs-string">'Expression'</span>
  241. o <span class="hljs-string">'Statement'</span>
  242. ]</pre></div></div>
  243. </li>
  244. <li id="section-15">
  245. <div class="annotation">
  246. <div class="pilwrap ">
  247. <a class="pilcrow" href="#section-15">&#182;</a>
  248. </div>
  249. <p>Pure statements which cannot be expressions.</p>
  250. </div>
  251. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Statement</span>: [
  252. o <span class="hljs-string">'Return'</span>
  253. o <span class="hljs-string">'Comment'</span>
  254. o <span class="hljs-string">'STATEMENT'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Literal $<span class="hljs-number">1</span>
  255. ]</pre></div></div>
  256. </li>
  257. <li id="section-16">
  258. <div class="annotation">
  259. <div class="pilwrap ">
  260. <a class="pilcrow" href="#section-16">&#182;</a>
  261. </div>
  262. <p>All the different types of expressions in our language. The basic unit of
  263. CoffeeScript is the <strong>Expression</strong> everything that can be an expression
  264. is one. Blocks serve as the building blocks of many other rules, making
  265. them somewhat circular.</p>
  266. </div>
  267. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Expression</span>: [
  268. o <span class="hljs-string">'Value'</span>
  269. o <span class="hljs-string">'Invocation'</span>
  270. o <span class="hljs-string">'Code'</span>
  271. o <span class="hljs-string">'Operation'</span>
  272. o <span class="hljs-string">'Assign'</span>
  273. o <span class="hljs-string">'If'</span>
  274. o <span class="hljs-string">'Try'</span>
  275. o <span class="hljs-string">'While'</span>
  276. o <span class="hljs-string">'For'</span>
  277. o <span class="hljs-string">'Switch'</span>
  278. o <span class="hljs-string">'Class'</span>
  279. o <span class="hljs-string">'Throw'</span>
  280. ]</pre></div></div>
  281. </li>
  282. <li id="section-17">
  283. <div class="annotation">
  284. <div class="pilwrap ">
  285. <a class="pilcrow" href="#section-17">&#182;</a>
  286. </div>
  287. <p>An indented block of expressions. Note that the <a href="rewriter.html">Rewriter</a>
  288. will convert some postfix forms into blocks for us, by adjusting the
  289. token stream.</p>
  290. </div>
  291. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Block</span>: [
  292. o <span class="hljs-string">'INDENT OUTDENT'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Block
  293. o <span class="hljs-string">'INDENT Body OUTDENT'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">2</span>
  294. ]</pre></div></div>
  295. </li>
  296. <li id="section-18">
  297. <div class="annotation">
  298. <div class="pilwrap ">
  299. <a class="pilcrow" href="#section-18">&#182;</a>
  300. </div>
  301. <p>A literal identifier, a variable name or property.</p>
  302. </div>
  303. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Identifier</span>: [
  304. o <span class="hljs-string">'IDENTIFIER'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Literal $<span class="hljs-number">1</span>
  305. ]</pre></div></div>
  306. </li>
  307. <li id="section-19">
  308. <div class="annotation">
  309. <div class="pilwrap ">
  310. <a class="pilcrow" href="#section-19">&#182;</a>
  311. </div>
  312. <p>Alphanumerics are separated from the other <strong>Literal</strong> matchers because
  313. they can also serve as keys in object literals.</p>
  314. </div>
  315. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">AlphaNumeric</span>: [
  316. o <span class="hljs-string">'NUMBER'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Literal $<span class="hljs-number">1</span>
  317. o <span class="hljs-string">'String'</span>
  318. ]
  319. <span class="hljs-attribute">String</span>: [
  320. o <span class="hljs-string">'STRING'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Literal $<span class="hljs-number">1</span>
  321. o <span class="hljs-string">'STRING_START Body STRING_END'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Parens $<span class="hljs-number">2</span>
  322. ]
  323. <span class="hljs-attribute">Regex</span>: [
  324. o <span class="hljs-string">'REGEX'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Literal $<span class="hljs-number">1</span>
  325. o <span class="hljs-string">'REGEX_START Invocation REGEX_END'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">2</span>
  326. ]</pre></div></div>
  327. </li>
  328. <li id="section-20">
  329. <div class="annotation">
  330. <div class="pilwrap ">
  331. <a class="pilcrow" href="#section-20">&#182;</a>
  332. </div>
  333. <p>All of our immediate values. Generally these can be passed straight
  334. through and printed to JavaScript.</p>
  335. </div>
  336. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Literal</span>: [
  337. o <span class="hljs-string">'AlphaNumeric'</span>
  338. o <span class="hljs-string">'JS'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Literal $<span class="hljs-number">1</span>
  339. o <span class="hljs-string">'Regex'</span>
  340. o <span class="hljs-string">'DEBUGGER'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Literal $<span class="hljs-number">1</span>
  341. o <span class="hljs-string">'UNDEFINED'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Undefined
  342. o <span class="hljs-string">'NULL'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Null
  343. o <span class="hljs-string">'BOOL'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Bool $<span class="hljs-number">1</span>
  344. ]</pre></div></div>
  345. </li>
  346. <li id="section-21">
  347. <div class="annotation">
  348. <div class="pilwrap ">
  349. <a class="pilcrow" href="#section-21">&#182;</a>
  350. </div>
  351. <p>Assignment of a variable, property, or index to a value.</p>
  352. </div>
  353. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Assign</span>: [
  354. o <span class="hljs-string">'Assignable = Expression'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Assign $<span class="hljs-number">1</span>, $<span class="hljs-number">3</span>
  355. o <span class="hljs-string">'Assignable = TERMINATOR Expression'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Assign $<span class="hljs-number">1</span>, $<span class="hljs-number">4</span>
  356. o <span class="hljs-string">'Assignable = INDENT Expression OUTDENT'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Assign $<span class="hljs-number">1</span>, $<span class="hljs-number">4</span>
  357. ]</pre></div></div>
  358. </li>
  359. <li id="section-22">
  360. <div class="annotation">
  361. <div class="pilwrap ">
  362. <a class="pilcrow" href="#section-22">&#182;</a>
  363. </div>
  364. <p>Assignment when it happens within an object literal. The difference from
  365. the ordinary <strong>Assign</strong> is that these allow numbers and strings as keys.</p>
  366. </div>
  367. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">AssignObj</span>: [
  368. o <span class="hljs-string">'ObjAssignable'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>
  369. o <span class="hljs-string">'ObjAssignable : Expression'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Assign LOC(<span class="hljs-number">1</span>)(<span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>), $<span class="hljs-number">3</span>, <span class="hljs-string">'object'</span>,
  370. <span class="hljs-attribute">operatorToken</span>: LOC(<span class="hljs-number">2</span>)(<span class="hljs-keyword">new</span> Literal $<span class="hljs-number">2</span>)
  371. o <span class="hljs-string">'ObjAssignable :
  372. INDENT Expression OUTDENT'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Assign LOC(<span class="hljs-number">1</span>)(<span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>), $<span class="hljs-number">4</span>, <span class="hljs-string">'object'</span>,
  373. <span class="hljs-attribute">operatorToken</span>: LOC(<span class="hljs-number">2</span>)(<span class="hljs-keyword">new</span> Literal $<span class="hljs-number">2</span>)
  374. o <span class="hljs-string">'SimpleObjAssignable = Expression'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Assign LOC(<span class="hljs-number">1</span>)(<span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>), $<span class="hljs-number">3</span>, <span class="hljs-literal">null</span>,
  375. <span class="hljs-attribute">operatorToken</span>: LOC(<span class="hljs-number">2</span>)(<span class="hljs-keyword">new</span> Literal $<span class="hljs-number">2</span>)
  376. o <span class="hljs-string">'SimpleObjAssignable =
  377. INDENT Expression OUTDENT'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Assign LOC(<span class="hljs-number">1</span>)(<span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>), $<span class="hljs-number">4</span>, <span class="hljs-literal">null</span>,
  378. <span class="hljs-attribute">operatorToken</span>: LOC(<span class="hljs-number">2</span>)(<span class="hljs-keyword">new</span> Literal $<span class="hljs-number">2</span>)
  379. o <span class="hljs-string">'Comment'</span>
  380. ]
  381. <span class="hljs-attribute">SimpleObjAssignable</span>: [
  382. o <span class="hljs-string">'Identifier'</span>
  383. o <span class="hljs-string">'ThisProperty'</span>
  384. ]
  385. <span class="hljs-attribute">ObjAssignable</span>: [
  386. o <span class="hljs-string">'SimpleObjAssignable'</span>
  387. o <span class="hljs-string">'AlphaNumeric'</span>
  388. ]</pre></div></div>
  389. </li>
  390. <li id="section-23">
  391. <div class="annotation">
  392. <div class="pilwrap ">
  393. <a class="pilcrow" href="#section-23">&#182;</a>
  394. </div>
  395. <p>A return statement from a function body.</p>
  396. </div>
  397. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Return</span>: [
  398. o <span class="hljs-string">'RETURN Expression'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Return $<span class="hljs-number">2</span>
  399. o <span class="hljs-string">'RETURN'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Return
  400. ]</pre></div></div>
  401. </li>
  402. <li id="section-24">
  403. <div class="annotation">
  404. <div class="pilwrap ">
  405. <a class="pilcrow" href="#section-24">&#182;</a>
  406. </div>
  407. <p>A block comment.</p>
  408. </div>
  409. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Comment</span>: [
  410. o <span class="hljs-string">'HERECOMMENT'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Comment $<span class="hljs-number">1</span>
  411. ]</pre></div></div>
  412. </li>
  413. <li id="section-25">
  414. <div class="annotation">
  415. <div class="pilwrap ">
  416. <a class="pilcrow" href="#section-25">&#182;</a>
  417. </div>
  418. <p>The <strong>Code</strong> node is the function literal. Its defined by an indented block
  419. of <strong>Block</strong> preceded by a function arrow, with an optional parameter
  420. list.</p>
  421. </div>
  422. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Code</span>: [
  423. o <span class="hljs-string">'PARAM_START ParamList PARAM_END FuncGlyph Block'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Code $<span class="hljs-number">2</span>, $<span class="hljs-number">5</span>, $<span class="hljs-number">4</span>
  424. o <span class="hljs-string">'FuncGlyph Block'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Code [], $<span class="hljs-number">2</span>, $<span class="hljs-number">1</span>
  425. ]</pre></div></div>
  426. </li>
  427. <li id="section-26">
  428. <div class="annotation">
  429. <div class="pilwrap ">
  430. <a class="pilcrow" href="#section-26">&#182;</a>
  431. </div>
  432. <p>CoffeeScript has two different symbols for functions. <code>-&gt;</code> is for ordinary
  433. functions, and <code>=&gt;</code> is for functions bound to the current value of <em>this</em>.</p>
  434. </div>
  435. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">FuncGlyph</span>: [
  436. o <span class="hljs-string">'-&gt;'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-string">'func'</span>
  437. o <span class="hljs-string">'=&gt;'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-string">'boundfunc'</span>
  438. ]</pre></div></div>
  439. </li>
  440. <li id="section-27">
  441. <div class="annotation">
  442. <div class="pilwrap ">
  443. <a class="pilcrow" href="#section-27">&#182;</a>
  444. </div>
  445. <p>An optional, trailing comma.</p>
  446. </div>
  447. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">OptComma</span>: [
  448. o <span class="hljs-string">''</span>
  449. o <span class="hljs-string">','</span>
  450. ]</pre></div></div>
  451. </li>
  452. <li id="section-28">
  453. <div class="annotation">
  454. <div class="pilwrap ">
  455. <a class="pilcrow" href="#section-28">&#182;</a>
  456. </div>
  457. <p>The list of parameters that a function accepts can be of any length.</p>
  458. </div>
  459. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">ParamList</span>: [
  460. o <span class="hljs-string">''</span>,<span class="hljs-function"> -&gt;</span> []
  461. o <span class="hljs-string">'Param'</span>,<span class="hljs-function"> -&gt;</span> [$<span class="hljs-number">1</span>]
  462. o <span class="hljs-string">'ParamList , Param'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">1.</span>concat $<span class="hljs-number">3</span>
  463. o <span class="hljs-string">'ParamList OptComma TERMINATOR Param'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">1.</span>concat $<span class="hljs-number">4</span>
  464. o <span class="hljs-string">'ParamList OptComma INDENT ParamList OptComma OUTDENT'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">1.</span>concat $<span class="hljs-number">4</span>
  465. ]</pre></div></div>
  466. </li>
  467. <li id="section-29">
  468. <div class="annotation">
  469. <div class="pilwrap ">
  470. <a class="pilcrow" href="#section-29">&#182;</a>
  471. </div>
  472. <p>A single parameter in a function definition can be ordinary, or a splat
  473. that hoovers up the remaining arguments.</p>
  474. </div>
  475. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Param</span>: [
  476. o <span class="hljs-string">'ParamVar'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Param $<span class="hljs-number">1</span>
  477. o <span class="hljs-string">'ParamVar ...'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Param $<span class="hljs-number">1</span>, <span class="hljs-literal">null</span>, <span class="hljs-literal">on</span>
  478. o <span class="hljs-string">'ParamVar = Expression'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Param $<span class="hljs-number">1</span>, $<span class="hljs-number">3</span>
  479. o <span class="hljs-string">'...'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Expansion
  480. ]</pre></div></div>
  481. </li>
  482. <li id="section-30">
  483. <div class="annotation">
  484. <div class="pilwrap ">
  485. <a class="pilcrow" href="#section-30">&#182;</a>
  486. </div>
  487. <p>Function Parameters</p>
  488. </div>
  489. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">ParamVar</span>: [
  490. o <span class="hljs-string">'Identifier'</span>
  491. o <span class="hljs-string">'ThisProperty'</span>
  492. o <span class="hljs-string">'Array'</span>
  493. o <span class="hljs-string">'Object'</span>
  494. ]</pre></div></div>
  495. </li>
  496. <li id="section-31">
  497. <div class="annotation">
  498. <div class="pilwrap ">
  499. <a class="pilcrow" href="#section-31">&#182;</a>
  500. </div>
  501. <p>A splat that occurs outside of a parameter list.</p>
  502. </div>
  503. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Splat</span>: [
  504. o <span class="hljs-string">'Expression ...'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Splat $<span class="hljs-number">1</span>
  505. ]</pre></div></div>
  506. </li>
  507. <li id="section-32">
  508. <div class="annotation">
  509. <div class="pilwrap ">
  510. <a class="pilcrow" href="#section-32">&#182;</a>
  511. </div>
  512. <p>Variables and properties that can be assigned to.</p>
  513. </div>
  514. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">SimpleAssignable</span>: [
  515. o <span class="hljs-string">'Identifier'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>
  516. o <span class="hljs-string">'Value Accessor'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">1.</span>add $<span class="hljs-number">2</span>
  517. o <span class="hljs-string">'Invocation Accessor'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>, [].concat $<span class="hljs-number">2</span>
  518. o <span class="hljs-string">'ThisProperty'</span>
  519. ]</pre></div></div>
  520. </li>
  521. <li id="section-33">
  522. <div class="annotation">
  523. <div class="pilwrap ">
  524. <a class="pilcrow" href="#section-33">&#182;</a>
  525. </div>
  526. <p>Everything that can be assigned to.</p>
  527. </div>
  528. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Assignable</span>: [
  529. o <span class="hljs-string">'SimpleAssignable'</span>
  530. o <span class="hljs-string">'Array'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>
  531. o <span class="hljs-string">'Object'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>
  532. ]</pre></div></div>
  533. </li>
  534. <li id="section-34">
  535. <div class="annotation">
  536. <div class="pilwrap ">
  537. <a class="pilcrow" href="#section-34">&#182;</a>
  538. </div>
  539. <p>The types of things that can be treated as values assigned to, invoked
  540. as functions, indexed into, named as a class, etc.</p>
  541. </div>
  542. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Value</span>: [
  543. o <span class="hljs-string">'Assignable'</span>
  544. o <span class="hljs-string">'Literal'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>
  545. o <span class="hljs-string">'Parenthetical'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>
  546. o <span class="hljs-string">'Range'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value $<span class="hljs-number">1</span>
  547. o <span class="hljs-string">'This'</span>
  548. ]</pre></div></div>
  549. </li>
  550. <li id="section-35">
  551. <div class="annotation">
  552. <div class="pilwrap ">
  553. <a class="pilcrow" href="#section-35">&#182;</a>
  554. </div>
  555. <p>The general group of accessors into an object, by property, by prototype
  556. or by array index or slice.</p>
  557. </div>
  558. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Accessor</span>: [
  559. o <span class="hljs-string">'. Identifier'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Access $<span class="hljs-number">2</span>
  560. o <span class="hljs-string">'?. Identifier'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Access $<span class="hljs-number">2</span>, <span class="hljs-string">'soak'</span>
  561. o <span class="hljs-string">':: Identifier'</span>,<span class="hljs-function"> -&gt;</span> [LOC(<span class="hljs-number">1</span>)(<span class="hljs-keyword">new</span> Access <span class="hljs-keyword">new</span> Literal(<span class="hljs-string">'prototype'</span>)), LOC(<span class="hljs-number">2</span>)(<span class="hljs-keyword">new</span> Access $<span class="hljs-number">2</span>)]
  562. o <span class="hljs-string">'?:: Identifier'</span>,<span class="hljs-function"> -&gt;</span> [LOC(<span class="hljs-number">1</span>)(<span class="hljs-keyword">new</span> Access <span class="hljs-keyword">new</span> Literal(<span class="hljs-string">'prototype'</span>), <span class="hljs-string">'soak'</span>), LOC(<span class="hljs-number">2</span>)(<span class="hljs-keyword">new</span> Access $<span class="hljs-number">2</span>)]
  563. o <span class="hljs-string">'::'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Access <span class="hljs-keyword">new</span> Literal <span class="hljs-string">'prototype'</span>
  564. o <span class="hljs-string">'Index'</span>
  565. ]</pre></div></div>
  566. </li>
  567. <li id="section-36">
  568. <div class="annotation">
  569. <div class="pilwrap ">
  570. <a class="pilcrow" href="#section-36">&#182;</a>
  571. </div>
  572. <p>Indexing into an object or array using bracket notation.</p>
  573. </div>
  574. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Index</span>: [
  575. o <span class="hljs-string">'INDEX_START IndexValue INDEX_END'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">2</span>
  576. o <span class="hljs-string">'INDEX_SOAK Index'</span>,<span class="hljs-function"> -&gt;</span> extend $<span class="hljs-number">2</span>, soak : <span class="hljs-literal">yes</span>
  577. ]
  578. <span class="hljs-attribute">IndexValue</span>: [
  579. o <span class="hljs-string">'Expression'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Index $<span class="hljs-number">1</span>
  580. o <span class="hljs-string">'Slice'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Slice $<span class="hljs-number">1</span>
  581. ]</pre></div></div>
  582. </li>
  583. <li id="section-37">
  584. <div class="annotation">
  585. <div class="pilwrap ">
  586. <a class="pilcrow" href="#section-37">&#182;</a>
  587. </div>
  588. <p>In CoffeeScript, an object literal is simply a list of assignments.</p>
  589. </div>
  590. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Object</span>: [
  591. o <span class="hljs-string">'{ AssignList OptComma }'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Obj $<span class="hljs-number">2</span>, $<span class="hljs-number">1.</span>generated
  592. ]</pre></div></div>
  593. </li>
  594. <li id="section-38">
  595. <div class="annotation">
  596. <div class="pilwrap ">
  597. <a class="pilcrow" href="#section-38">&#182;</a>
  598. </div>
  599. <p>Assignment of properties within an object literal can be separated by
  600. comma, as in JavaScript, or simply by newline.</p>
  601. </div>
  602. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">AssignList</span>: [
  603. o <span class="hljs-string">''</span>,<span class="hljs-function"> -&gt;</span> []
  604. o <span class="hljs-string">'AssignObj'</span>,<span class="hljs-function"> -&gt;</span> [$<span class="hljs-number">1</span>]
  605. o <span class="hljs-string">'AssignList , AssignObj'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">1.</span>concat $<span class="hljs-number">3</span>
  606. o <span class="hljs-string">'AssignList OptComma TERMINATOR AssignObj'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">1.</span>concat $<span class="hljs-number">4</span>
  607. o <span class="hljs-string">'AssignList OptComma INDENT AssignList OptComma OUTDENT'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">1.</span>concat $<span class="hljs-number">4</span>
  608. ]</pre></div></div>
  609. </li>
  610. <li id="section-39">
  611. <div class="annotation">
  612. <div class="pilwrap ">
  613. <a class="pilcrow" href="#section-39">&#182;</a>
  614. </div>
  615. <p>Class definitions have optional bodies of prototype property assignments,
  616. and optional references to the superclass.</p>
  617. </div>
  618. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Class</span>: [
  619. o <span class="hljs-string">'CLASS'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Class
  620. o <span class="hljs-string">'CLASS Block'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Class <span class="hljs-literal">null</span>, <span class="hljs-literal">null</span>, $<span class="hljs-number">2</span>
  621. o <span class="hljs-string">'CLASS EXTENDS Expression'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Class <span class="hljs-literal">null</span>, $<span class="hljs-number">3</span>
  622. o <span class="hljs-string">'CLASS EXTENDS Expression Block'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Class <span class="hljs-literal">null</span>, $<span class="hljs-number">3</span>, $<span class="hljs-number">4</span>
  623. o <span class="hljs-string">'CLASS SimpleAssignable'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Class $<span class="hljs-number">2</span>
  624. o <span class="hljs-string">'CLASS SimpleAssignable Block'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Class $<span class="hljs-number">2</span>, <span class="hljs-literal">null</span>, $<span class="hljs-number">3</span>
  625. o <span class="hljs-string">'CLASS SimpleAssignable EXTENDS Expression'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Class $<span class="hljs-number">2</span>, $<span class="hljs-number">4</span>
  626. o <span class="hljs-string">'CLASS SimpleAssignable EXTENDS Expression Block'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Class $<span class="hljs-number">2</span>, $<span class="hljs-number">4</span>, $<span class="hljs-number">5</span>
  627. ]</pre></div></div>
  628. </li>
  629. <li id="section-40">
  630. <div class="annotation">
  631. <div class="pilwrap ">
  632. <a class="pilcrow" href="#section-40">&#182;</a>
  633. </div>
  634. <p>Ordinary function invocation, or a chained series of calls.</p>
  635. </div>
  636. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Invocation</span>: [
  637. o <span class="hljs-string">'Value OptFuncExist Arguments'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Call $<span class="hljs-number">1</span>, $<span class="hljs-number">3</span>, $<span class="hljs-number">2</span>
  638. o <span class="hljs-string">'Invocation OptFuncExist Arguments'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Call $<span class="hljs-number">1</span>, $<span class="hljs-number">3</span>, $<span class="hljs-number">2</span>
  639. o <span class="hljs-string">'SUPER'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Call <span class="hljs-string">'super'</span>, [<span class="hljs-keyword">new</span> Splat <span class="hljs-keyword">new</span> Literal <span class="hljs-string">'arguments'</span>]
  640. o <span class="hljs-string">'SUPER Arguments'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Call <span class="hljs-string">'super'</span>, $<span class="hljs-number">2</span>
  641. ]</pre></div></div>
  642. </li>
  643. <li id="section-41">
  644. <div class="annotation">
  645. <div class="pilwrap ">
  646. <a class="pilcrow" href="#section-41">&#182;</a>
  647. </div>
  648. <p>An optional existence check on a function.</p>
  649. </div>
  650. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">OptFuncExist</span>: [
  651. o <span class="hljs-string">''</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-literal">no</span>
  652. o <span class="hljs-string">'FUNC_EXIST'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-literal">yes</span>
  653. ]</pre></div></div>
  654. </li>
  655. <li id="section-42">
  656. <div class="annotation">
  657. <div class="pilwrap ">
  658. <a class="pilcrow" href="#section-42">&#182;</a>
  659. </div>
  660. <p>The list of arguments to a function call.</p>
  661. </div>
  662. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">Arguments</span>: [
  663. o <span class="hljs-string">'CALL_START CALL_END'</span>,<span class="hljs-function"> -&gt;</span> []
  664. o <span class="hljs-string">'CALL_START ArgList OptComma CALL_END'</span>,<span class="hljs-function"> -&gt;</span> $<span class="hljs-number">2</span>
  665. ]</pre></div></div>
  666. </li>
  667. <li id="section-43">
  668. <div class="annotation">
  669. <div class="pilwrap ">
  670. <a class="pilcrow" href="#section-43">&#182;</a>
  671. </div>
  672. <p>A reference to the <em>this</em> current object.</p>
  673. </div>
  674. <div class="content"><div class='highlight'><pre> <span class="hljs-attribute">This</span>: [
  675. o <span class="hljs-string">'THIS'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value <span class="hljs-keyword">new</span> Literal <span class="hljs-string">'this'</span>
  676. o <span class="hljs-string">'@'</span>,<span class="hljs-function"> -&gt;</span> <span class="hljs-keyword">new</span> Value <span class="hljs-keyword">new</span> Literal <span class="hljs-string">'this'</span>
  677. ]</pre></div></div>
  678. </li>