kmx.io/prism.js/docs/Prism.languages.html
Branch
-
docs/Prism.languages.html
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>languages - Documentation</title> <meta property="og:title" content="Prism generated API documentation"/> <meta property="og:type" content="website"/> <meta property="og:image" content="/logo.svg"/> <meta property="og:site_name" content="Prism"/> <meta property="og:url" content="https://prismjs.com"/> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <script src="scripts/nav.js" defer></script> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="icon" type="image/png" href="/favicon.png"/> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav > <input type="text" id="nav-search" placeholder="Search" /> <h2><a href="index.html">Home</a></h2><h2><a href="https://prismjs.com" class="menu-item" id="website_link" >PrismJS</a></h2><h2><a href="https://github.com/PrismJS/prism" target="_blank" class="menu-item" id="github_link" >GitHub</a></h2><h3>Classes</h3><ul><li><a href="Token.html">Token</a></li></ul><h3>Namespaces</h3><ul><li><a href="Prism.html">Prism</a><ul class='members'><li data-type='member'><a href="Prism.html#.disableWorkerMessageHandler">disableWorkerMessageHandler</a></li><li data-type='member'><a href="Prism.html#.manual">manual</a></li></ul><ul class='methods'><li data-type='method'><a href="Prism.html#.highlight">highlight</a></li><li data-type='method'><a href="Prism.html#.highlightAll">highlightAll</a></li><li data-type='method'><a href="Prism.html#.highlightAllUnder">highlightAllUnder</a></li><li data-type='method'><a href="Prism.html#.highlightElement">highlightElement</a></li><li data-type='method'><a href="Prism.html#.tokenize">tokenize</a></li></ul></li><li><a href="Prism.hooks.html">hooks</a><ul class='methods'><li data-type='method'><a href="Prism.hooks.html#.add">add</a></li><li data-type='method'><a href="Prism.hooks.html#.run">run</a></li></ul></li><li><a href="Prism.languages.html">languages</a><ul class='methods'><li data-type='method'><a href="Prism.languages.html#.extend">extend</a></li><li data-type='method'><a href="Prism.languages.html#.insertBefore">insertBefore</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#Grammar">Grammar</a></li><li><a href="global.html#GrammarToken">GrammarToken</a></li><li><a href="global.html#HighlightCallback">HighlightCallback</a></li><li><a href="global.html#HookCallback">HookCallback</a></li><li><a href="global.html#TokenStream">TokenStream</a></li></ul> </nav> <div id="main"> <h1 class="page-title">languages</h1> <section> <header> <h2> <span class="ancestors"><a href="Prism.html">Prism</a>.</span> languages </h2> </header> <article> <div class="container-overview"> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line299">line 299</a> </li></ul></dd> </dl> <div class="description usertext"><p>This namespace contains all currently loaded languages and the some helper functions to create and modify languages.</p></div> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".extend"><span class="type-signature">(static) </span>extend<span class="signature">(id, redef)</span><span class="type-signature"> → {<a href="global.html#Grammar">Grammar</a>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line336">line 336</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Creates a deep copy of the language with the given id and appends the given tokens.</p> <p>If a token in <code>redef</code> also appears in the copied language, then the existing token in the copied language will be overwritten at its original position.</p> <h2>Best practices</h2> <p>Since the position of overwriting tokens (token in <code>redef</code> that overwrite tokens in the copied language) doesn't matter, they can technically be in any order. However, this can be confusing to others that trying to understand the language definition because, normally, the order of tokens matters in Prism grammars.</p> <p>Therefore, it is encouraged to order overwriting tokens according to the positions of the overwritten tokens. Furthermore, all non-overwriting tokens should be placed after the overwriting ones.</p> </div> <h5>Example</h5> <pre class="prettyprint"><code>Prism.languages['css-with-colors'] = Prism.languages.extend('css', { // Prism.languages.css already has a 'comment' token, so this token will overwrite CSS' 'comment' token // at its original position 'comment': { ... }, // CSS doesn't have a 'color' token, so this token will be appended 'color': /\b(?:red|green|blue)\b/ });</code></pre> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The id of the language to extend. This has to be a key in <code>Prism.languages</code>.</p></td> </tr> <tr> <td class="name"><code>redef</code></td> <td class="type"> <span class="param-type"><a href="global.html#Grammar">Grammar</a></span> </td> <td class="description last"><p>The new tokens to append.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="param-desc"> <p>The new language created.</p> </div> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Grammar">Grammar</a></span> </dd> </dl> <h4 class="name" id=".insertBefore"><span class="type-signature">(static) </span>insertBefore<span class="signature">(inside, before, insert, root<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="global.html#Grammar">Grammar</a>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="prism-core.js.html">prism-core.js</a>, <a href="prism-core.js.html#line421">line 421</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Inserts tokens <em>before</em> another token in a language definition or any other grammar.</p> <h2>Usage</h2> <p>This helper method makes it easy to modify existing languages. For example, the CSS language definition not only defines CSS highlighting for CSS documents, but also needs to define highlighting for CSS embedded in HTML through <code><style></code> elements. To do this, it needs to modify <code>Prism.languages.markup</code> and add the appropriate tokens. However, <code>Prism.languages.markup</code> is a regular JavaScript object literal, so if you do this:</p> <pre class="prettyprint source lang-js"><code>Prism.languages.markup.style = { // token }; </code></pre> <p>then the <code>style</code> token will be added (and processed) at the end. <code>insertBefore</code> allows you to insert tokens before existing tokens. For the CSS example above, you would use it like this:</p> <pre class="prettyprint source lang-js"><code>Prism.languages.insertBefore('markup', 'cdata', { 'style': { // token } }); </code></pre> <h2>Special cases</h2> <p>If the grammars of <code>inside</code> and <code>insert</code> have tokens with the same name, the tokens in <code>inside</code>'s grammar will be ignored.</p> <p>This behavior can be used to insert tokens after <code>before</code>:</p> <pre class="prettyprint source lang-js"><code>Prism.languages.insertBefore('markup', 'comment', { 'comment': Prism.languages.markup.comment, // tokens after 'comment' }); </code></pre> <h2>Limitations</h2> <p>The main problem <code>insertBefore</code> has to solve is iteration order. Since ES2015, the iteration order for object properties is guaranteed to be the insertion order (except for integer keys) but some browsers behave differently when keys are deleted and re-inserted. So <code>insertBefore</code> can't be implemented by temporarily deleting properties which is necessary to insert at arbitrary positions.</p> <p>To solve this problem, <code>insertBefore</code> doesn't actually insert the given tokens into the target object. Instead, it will create a new object and replace all references to the target object with the new one. This can be done without temporarily deleting properties, so the iteration order is well-defined.</p> <p>However, only references that can be reached from <code>Prism.languages</code> or <code>insert</code> will be replaced. I.e. if you hold the target object in a variable, then the value of the variable will not change.</p> <pre class="prettyprint source lang-js"><code>var oldMarkup = Prism.languages.markup; var newMarkup = Prism.languages.insertBefore('markup', 'comment', { ... }); assert(oldMarkup !== Prism.languages.markup); assert(newMarkup === Prism.languages.markup); </code></pre> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>inside</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The property of <code>root</code> (e.g. a language id in <code>Prism.languages</code>) that contains the object to be modified.</p></td> </tr> <tr> <td class="name"><code>before</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The key to insert before.</p></td> </tr> <tr> <td class="name"><code>insert</code></td> <td class="type"> <span class="param-type"><a href="global.html#Grammar">Grammar</a></span> </td> <td class="attributes"> </td> <td class="description last"><p>An object containing the key-value pairs to be inserted.</p></td> </tr> <tr> <td class="name"><code>root</code></td> <td class="type"> <span class="param-type">Object.<string, any></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The object containing <code>inside</code>, i.e. the object that contains the object to be modified.</p> <p>Defaults to <code>Prism.languages</code>.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="param-desc"> <p>The new grammar object.</p> </div> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Grammar">Grammar</a></span> </dd> </dl> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme. </footer> <script>prettyPrint();</script> <script src="scripts/polyfill.js"></script> <script src="scripts/linenumber.js"></script> <script src="scripts/search.js" defer></script> <link type="text/css" rel="stylesheet" href="styles/overwrites.css"> </body> </html>