/usr/share/doc/librsyntaxtextarea-java/api/org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html is in librsyntaxtextarea-java-doc 2.5.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Sun Oct 20 20:34:53 UTC 2013 -->
<title>TclTokenMaker (RSyntaxTextArea API)</title>
<meta name="date" content="2013-10-20">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TclTokenMaker (RSyntaxTextArea API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/SQLTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea.modes"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/UnixShellTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea.modes"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html" target="_top">Frames</a></li>
<li><a href="TclTokenMaker.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.fife.ui.rsyntaxtextarea.modes</div>
<h2 title="Class TclTokenMaker" class="title">Class TclTokenMaker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea">org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexCTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea">org.fife.ui.rsyntaxtextarea.AbstractJFlexCTokenMaker</a></li>
<li>
<ul class="inheritance">
<li>org.fife.ui.rsyntaxtextarea.modes.TclTokenMaker</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html" title="interface in org.fife.ui.rsyntaxtextarea">TokenMaker</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">TclTokenMaker</span>
extends <a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexCTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea">AbstractJFlexCTokenMaker</a></pre>
<div class="block">Scanner for the Tcl programming language.<p>
This implementation was created using
<a href="http://www.jflex.de/">JFlex</a> 1.4.1; however, the generated file
was modified for performance. Memory allocation needs to be almost
completely removed to be competitive with the handwritten lexers (subclasses
of <code>AbstractTokenMaker</code>, so this class has been modified so that
Strings are never allocated (via yytext()), and the scanner never has to
worry about refilling its buffer (needlessly copying chars around).
We can achieve this because RText always scans exactly 1 line of tokens at a
time, and hands the scanner this line as an array of characters (a Segment
really). Since tokens contain pointers to char arrays instead of Strings
holding their contents, there is no need for allocating new memory for
Strings.<p>
The actual algorithm generated for scanning has, of course, not been
modified.<p>
If you wish to regenerate this file yourself, keep in mind the following:
<ul>
<li>The generated TclTokenMaker.java</code> file will contain two
definitions of both <code>zzRefill</code> and <code>yyreset</code>.
You should hand-delete the second of each definition (the ones
generated by the lexer), as these generated methods modify the input
buffer, which we'll never have to do.</li>
<li>You should also change the declaration/definition of zzBuffer to NOT
be initialized. This is a needless memory allocation for us since we
will be pointing the array somewhere else anyway.</li>
<li>You should NOT call <code>yylex()</code> on the generated scanner
directly; rather, you should use <code>getTokenList</code> as you would
with any other <code>TokenMaker</code> instance.</li>
</ul></div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>0.5</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Robert Futrell</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenImpl.html" title="class in org.fife.ui.rsyntaxtextarea">TokenImpl</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#currentToken">currentToken</a></strong></code>
<div class="block">Used in the creation of the linked list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenImpl.html" title="class in org.fife.ui.rsyntaxtextarea">TokenImpl</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#firstToken">firstToken</a></strong></code>
<div class="block">The first token in the returned linked list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenImpl.html" title="class in org.fife.ui.rsyntaxtextarea">TokenImpl</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#previousToken">previousToken</a></strong></code>
<div class="block">Used in the creation of the linked list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#YYEOF">YYEOF</a></strong></code>
<div class="block">This character denotes the end of file</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#YYINITIAL">YYINITIAL</a></strong></code>
<div class="block">lexical states</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.fife.ui.rsyntaxtextarea.AbstractJFlexCTokenMaker">
<!-- -->
</a>
<h3>Fields inherited from class org.fife.ui.rsyntaxtextarea.<a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexCTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea">AbstractJFlexCTokenMaker</a></h3>
<code><a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexCTokenMaker.html#INSERT_BREAK_ACTION">INSERT_BREAK_ACTION</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker">
<!-- -->
</a>
<h3>Fields inherited from class org.fife.ui.rsyntaxtextarea.<a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea">AbstractJFlexTokenMaker</a></h3>
<code><a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexTokenMaker.html#offsetShift">offsetShift</a>, <a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexTokenMaker.html#s">s</a>, <a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexTokenMaker.html#start">start</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#TclTokenMaker()">TclTokenMaker</a></strong>()</code>
<div class="block">Constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#TclTokenMaker(java.io.InputStream)">TclTokenMaker</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)</code>
<div class="block">Creates a new scanner.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#TclTokenMaker(java.io.Reader)">TclTokenMaker</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> in)</code>
<div class="block">Creates a new scanner
There is also a java.io.InputStream version of this constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#addNullToken()">addNullToken</a></strong>()</code>
<div class="block">Adds a null token to the end of the current linked list of tokens.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#addToken(char[], int, int, int, int)">addToken</a></strong>(char[] array,
int start,
int end,
int tokenType,
int startOffset)</code>
<div class="block">Adds the token specified to the current linked list of tokens.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#addToken(char[], int, int, int, int, boolean)">addToken</a></strong>(char[] array,
int start,
int end,
int tokenType,
int startOffset,
boolean hyperlink)</code>
<div class="block">Adds the token specified to the current linked list of tokens.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#addToken(javax.swing.text.Segment, int, int, int, int)">addToken</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Segment.html?is-external=true" title="class or interface in javax.swing.text">Segment</a> segment,
int start,
int end,
int tokenType,
int startOffset)</code>
<div class="block">Adds the token specified to the current linked list of tokens.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/fife/ui/rsyntaxtextarea/OccurrenceMarker.html" title="interface in org.fife.ui.rsyntaxtextarea">OccurrenceMarker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#createOccurrenceMarker()">createOccurrenceMarker</a></strong>()</code>
<div class="block">Returns the occurrence marker to use for this token maker.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#getClosestStandardTokenTypeForInternalType(int)">getClosestStandardTokenTypeForInternalType</a></strong>(int type)</code>
<div class="block">Returns the closest <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenTypes.html" title="interface in org.fife.ui.rsyntaxtextarea"><code>"standard" token type</code></a> for a given
"internal" token type (e.g. one whose value is <code>< 0</code>).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#getLastTokenTypeOnLine(javax.swing.text.Segment, int)">getLastTokenTypeOnLine</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Segment.html?is-external=true" title="class or interface in javax.swing.text">Segment</a> text,
int initialTokenType)</code>
<div class="block">Returns the last token on this line's type if the token is "unfinished",
or <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenTypes.html#NULL"><code>TokenTypes.NULL</code></a> if it was finished.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#getLineCommentStartAndEnd()">getLineCommentStartAndEnd</a></strong>()</code>
<div class="block">Returns the text to place at the beginning and end of a
line to "comment" it in a this programming language.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/OccurrenceMarker.html" title="interface in org.fife.ui.rsyntaxtextarea">OccurrenceMarker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#getOccurrenceMarker()">getOccurrenceMarker</a></strong>()</code>
<div class="block">Returns the object in charge of marking all occurrences of the token
at the current caret position, if it is a relevant token.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/Token.html" title="interface in org.fife.ui.rsyntaxtextarea">Token</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#getTokenList(javax.swing.text.Segment, int, int)">getTokenList</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Segment.html?is-external=true" title="class or interface in javax.swing.text">Segment</a> text,
int initialTokenType,
int startOffset)</code>
<div class="block">Returns the first token in the linked list of tokens generated
from <code>text</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#isMarkupLanguage()">isMarkupLanguage</a></strong>()</code>
<div class="block">The default implementation returns <code>false</code> always.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#resetTokenList()">resetTokenList</a></strong>()</code>
<div class="block">Deletes the linked list of tokens so we can begin anew.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#setLanguageIndex(int)">setLanguageIndex</a></strong>(int languageIndex)</code>
<div class="block">Sets the language index to assign to tokens moving forward.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#yybegin(int)">yybegin</a></strong>(int newState)</code>
<div class="block">Enters a new lexical state</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#yycharat(int)">yycharat</a></strong>(int pos)</code>
<div class="block">Returns the character at position <tt>pos</tt> from the
matched text.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#yyclose()">yyclose</a></strong>()</code>
<div class="block">Closes the input stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#yylength()">yylength</a></strong>()</code>
<div class="block">Returns the length of the matched text region.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/Token.html" title="interface in org.fife.ui.rsyntaxtextarea">Token</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#yylex()">yylex</a></strong>()</code>
<div class="block">Resumes scanning until the next regular expression is matched,
the end of input is encountered or an I/O-Error occurs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#yypushback(int)">yypushback</a></strong>(int number)</code>
<div class="block">Pushes the specified amount of characters back into the input stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#yyreset(java.io.Reader)">yyreset</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader)</code>
<div class="block">Resets the scanner to read from a new input stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#yystate()">yystate</a></strong>()</code>
<div class="block">Returns the current lexical state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#yytext()">yytext</a></strong>()</code>
<div class="block">Returns the text matched by the current regular expression.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.fife.ui.rsyntaxtextarea.AbstractJFlexCTokenMaker">
<!-- -->
</a>
<h3>Methods inherited from class org.fife.ui.rsyntaxtextarea.<a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexCTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea">AbstractJFlexCTokenMaker</a></h3>
<code><a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexCTokenMaker.html#getCurlyBracesDenoteCodeBlocks()">getCurlyBracesDenoteCodeBlocks</a>, <a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexCTokenMaker.html#getInsertBreakAction()">getInsertBreakAction</a>, <a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexCTokenMaker.html#getMarkOccurrencesOfTokenType(int)">getMarkOccurrencesOfTokenType</a>, <a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexCTokenMaker.html#getShouldIndentNextLineAfter(org.fife.ui.rsyntaxtextarea.Token)">getShouldIndentNextLineAfter</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker">
<!-- -->
</a>
<h3>Methods inherited from class org.fife.ui.rsyntaxtextarea.<a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea">AbstractJFlexTokenMaker</a></h3>
<code><a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexTokenMaker.html#yybegin(int, int)">yybegin</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="YYEOF">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>YYEOF</h4>
<pre>public static final int YYEOF</pre>
<div class="block">This character denotes the end of file</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.fife.ui.rsyntaxtextarea.modes.TclTokenMaker.YYEOF">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="YYINITIAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>YYINITIAL</h4>
<pre>public static final int YYINITIAL</pre>
<div class="block">lexical states</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.fife.ui.rsyntaxtextarea.modes.TclTokenMaker.YYINITIAL">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="firstToken">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>firstToken</h4>
<pre>protected <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenImpl.html" title="class in org.fife.ui.rsyntaxtextarea">TokenImpl</a> firstToken</pre>
<div class="block">The first token in the returned linked list.</div>
</li>
</ul>
<a name="currentToken">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>currentToken</h4>
<pre>protected <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenImpl.html" title="class in org.fife.ui.rsyntaxtextarea">TokenImpl</a> currentToken</pre>
<div class="block">Used in the creation of the linked list.</div>
</li>
</ul>
<a name="previousToken">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>previousToken</h4>
<pre>protected <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenImpl.html" title="class in org.fife.ui.rsyntaxtextarea">TokenImpl</a> previousToken</pre>
<div class="block">Used in the creation of the linked list.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TclTokenMaker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TclTokenMaker</h4>
<pre>public TclTokenMaker()</pre>
<div class="block">Constructor. This must be here because JFlex does not generate a
no-parameter constructor.</div>
</li>
</ul>
<a name="TclTokenMaker(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TclTokenMaker</h4>
<pre>public TclTokenMaker(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> in)</pre>
<div class="block">Creates a new scanner
There is also a java.io.InputStream version of this constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the java.io.Reader to read input from.</dd></dl>
</li>
</ul>
<a name="TclTokenMaker(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TclTokenMaker</h4>
<pre>public TclTokenMaker(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)</pre>
<div class="block">Creates a new scanner.
There is also java.io.Reader version of this constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the java.io.Inputstream to read input from.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addToken(char[], int, int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToken</h4>
<pre>public void addToken(char[] array,
int start,
int end,
int tokenType,
int startOffset)</pre>
<div class="block">Adds the token specified to the current linked list of tokens.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html#addToken(char[], int, int, int, int)">addToken</a></code> in interface <code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html" title="interface in org.fife.ui.rsyntaxtextarea">TokenMaker</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>array</code> - The character array.</dd><dd><code>start</code> - The starting offset in the array.</dd><dd><code>end</code> - The ending offset in the array.</dd><dd><code>tokenType</code> - The token's type.</dd><dd><code>startOffset</code> - The offset in the document at which this token
occurs.</dd></dl>
</li>
</ul>
<a name="getLineCommentStartAndEnd()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineCommentStartAndEnd</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getLineCommentStartAndEnd()</pre>
<div class="block">Returns the text to place at the beginning and end of a
line to "comment" it in a this programming language.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html#getLineCommentStartAndEnd()">getLineCommentStartAndEnd</a></code> in interface <code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html" title="interface in org.fife.ui.rsyntaxtextarea">TokenMaker</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The start and end strings to add to a line to "comment"
it out.</dd></dl>
</li>
</ul>
<a name="getTokenList(javax.swing.text.Segment, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTokenList</h4>
<pre>public <a href="../../../../../org/fife/ui/rsyntaxtextarea/Token.html" title="interface in org.fife.ui.rsyntaxtextarea">Token</a> getTokenList(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Segment.html?is-external=true" title="class or interface in javax.swing.text">Segment</a> text,
int initialTokenType,
int startOffset)</pre>
<div class="block">Returns the first token in the linked list of tokens generated
from <code>text</code>. This method must be implemented by
subclasses so they can correctly implement syntax highlighting.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - The text from which to get tokens.</dd><dd><code>initialTokenType</code> - The token type we should start with.</dd><dd><code>startOffset</code> - The offset into the document at which
<code>text</code> starts.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The first <code>Token</code> in a linked list representing
the syntax highlighted text.</dd></dl>
</li>
</ul>
<a name="yyreset(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yyreset</h4>
<pre>public final void yyreset(<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Resets the scanner to read from a new input stream.
Does not close the old reader.
All internal variables are reset, the old input stream
<b>cannot</b> be reused (internal buffer is discarded and lost).
Lexical state is set to <tt>YY_INITIAL</tt>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - the new input stream</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="yyclose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yyclose</h4>
<pre>public final void yyclose()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Closes the input stream.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="yystate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yystate</h4>
<pre>public final int yystate()</pre>
<div class="block">Returns the current lexical state.</div>
</li>
</ul>
<a name="yybegin(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yybegin</h4>
<pre>public final void yybegin(int newState)</pre>
<div class="block">Enters a new lexical state</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexTokenMaker.html#yybegin(int)">yybegin</a></code> in class <code><a href="../../../../../org/fife/ui/rsyntaxtextarea/AbstractJFlexTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea">AbstractJFlexTokenMaker</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>newState</code> - the new lexical state</dd></dl>
</li>
</ul>
<a name="yytext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yytext</h4>
<pre>public final <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> yytext()</pre>
<div class="block">Returns the text matched by the current regular expression.</div>
</li>
</ul>
<a name="yycharat(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yycharat</h4>
<pre>public final char yycharat(int pos)</pre>
<div class="block">Returns the character at position <tt>pos</tt> from the
matched text.
It is equivalent to yytext().charAt(pos), but faster</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - the position of the character to fetch.
A value from 0 to yylength()-1.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the character at position pos</dd></dl>
</li>
</ul>
<a name="yylength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yylength</h4>
<pre>public final int yylength()</pre>
<div class="block">Returns the length of the matched text region.</div>
</li>
</ul>
<a name="yypushback(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yypushback</h4>
<pre>public void yypushback(int number)</pre>
<div class="block">Pushes the specified amount of characters back into the input stream.
They will be read again by then next call of the scanning method</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>number</code> - the number of characters to be read again.
This number must not be greater than yylength()!</dd></dl>
</li>
</ul>
<a name="yylex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yylex</h4>
<pre>public <a href="../../../../../org/fife/ui/rsyntaxtextarea/Token.html" title="interface in org.fife.ui.rsyntaxtextarea">Token</a> yylex()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Resumes scanning until the next regular expression is matched,
the end of input is encountered or an I/O-Error occurs.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the next token</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if any I/O-Error occurs</dd></dl>
</li>
</ul>
<a name="addNullToken()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addNullToken</h4>
<pre>public void addNullToken()</pre>
<div class="block">Adds a null token to the end of the current linked list of tokens.
This should be put at the end of the linked list whenever the last
token on the current line is NOT a multi-line token.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html#addNullToken()">addNullToken</a></code> in interface <code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html" title="interface in org.fife.ui.rsyntaxtextarea">TokenMaker</a></code></dd>
</dl>
</li>
</ul>
<a name="addToken(javax.swing.text.Segment, int, int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToken</h4>
<pre>public void addToken(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Segment.html?is-external=true" title="class or interface in javax.swing.text">Segment</a> segment,
int start,
int end,
int tokenType,
int startOffset)</pre>
<div class="block">Adds the token specified to the current linked list of tokens.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>segment</code> - <code>Segment</code> to get text from.</dd><dd><code>start</code> - Start offset in <code>segment</code> of token.</dd><dd><code>end</code> - End offset in <code>segment</code> of token.</dd><dd><code>tokenType</code> - The token's type.</dd><dd><code>startOffset</code> - The offset in the document at which this token
occurs.</dd></dl>
</li>
</ul>
<a name="addToken(char[], int, int, int, int, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToken</h4>
<pre>public void addToken(char[] array,
int start,
int end,
int tokenType,
int startOffset,
boolean hyperlink)</pre>
<div class="block">Adds the token specified to the current linked list of tokens.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>array</code> - The character array.</dd><dd><code>start</code> - The starting offset in the array.</dd><dd><code>end</code> - The ending offset in the array.</dd><dd><code>tokenType</code> - The token's type.</dd><dd><code>startOffset</code> - The offset in the document at which this token
occurs.</dd><dd><code>hyperlink</code> - Whether this token is a hyperlink.</dd></dl>
</li>
</ul>
<a name="createOccurrenceMarker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createOccurrenceMarker</h4>
<pre>protected <a href="../../../../../org/fife/ui/rsyntaxtextarea/OccurrenceMarker.html" title="interface in org.fife.ui.rsyntaxtextarea">OccurrenceMarker</a> createOccurrenceMarker()</pre>
<div class="block">Returns the occurrence marker to use for this token maker. Subclasses
can override to use different implementations.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The occurrence marker to use.</dd></dl>
</li>
</ul>
<a name="getClosestStandardTokenTypeForInternalType(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClosestStandardTokenTypeForInternalType</h4>
<pre>public int getClosestStandardTokenTypeForInternalType(int type)</pre>
<div class="block">Returns the closest <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenTypes.html" title="interface in org.fife.ui.rsyntaxtextarea"><code>"standard" token type</code></a> for a given
"internal" token type (e.g. one whose value is <code>< 0</code>).<p>
The default implementation returns <code>type</code> always, which
denotes that a mapping from internal token types to standard token types
is not defined; subclasses can override.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html#getClosestStandardTokenTypeForInternalType(int)">getClosestStandardTokenTypeForInternalType</a></code> in interface <code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html" title="interface in org.fife.ui.rsyntaxtextarea">TokenMaker</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The token type.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The closest "standard" token type.</dd></dl>
</li>
</ul>
<a name="getLastTokenTypeOnLine(javax.swing.text.Segment, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastTokenTypeOnLine</h4>
<pre>public int getLastTokenTypeOnLine(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/swing/text/Segment.html?is-external=true" title="class or interface in javax.swing.text">Segment</a> text,
int initialTokenType)</pre>
<div class="block">Returns the last token on this line's type if the token is "unfinished",
or <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenTypes.html#NULL"><code>TokenTypes.NULL</code></a> if it was finished. For example, if C-style
syntax highlighting is being implemented, and <code>text</code>
contained a line of code that contained the beginning of a comment but
no end-comment marker ("*\/"), then this method would return
<a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenTypes.html#COMMENT_MULTILINE"><code>TokenTypes.COMMENT_MULTILINE</code></a> for that line. This is useful
for doing syntax highlighting.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html#getLastTokenTypeOnLine(javax.swing.text.Segment, int)">getLastTokenTypeOnLine</a></code> in interface <code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html" title="interface in org.fife.ui.rsyntaxtextarea">TokenMaker</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - The line of tokens to examine.</dd><dd><code>initialTokenType</code> - The token type to start with (i.e., the value
of <code>getLastTokenTypeOnLine</code> for the line before
<code>text</code>).</dd>
<dt><span class="strong">Returns:</span></dt><dd>The last token on this line's type, or <a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenTypes.html#NULL"><code>TokenTypes.NULL</code></a>
if the line was completed.</dd></dl>
</li>
</ul>
<a name="getOccurrenceMarker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOccurrenceMarker</h4>
<pre>public <a href="../../../../../org/fife/ui/rsyntaxtextarea/OccurrenceMarker.html" title="interface in org.fife.ui.rsyntaxtextarea">OccurrenceMarker</a> getOccurrenceMarker()</pre>
<div class="block">Returns the object in charge of marking all occurrences of the token
at the current caret position, if it is a relevant token. If
<code>null</code> is returned, a default <code>OccurrenceMarker</code>
is used.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html#getOccurrenceMarker()">getOccurrenceMarker</a></code> in interface <code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html" title="interface in org.fife.ui.rsyntaxtextarea">TokenMaker</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The occurrence marker for this language, or <code>null</code>
for none.</dd></dl>
</li>
</ul>
<a name="isMarkupLanguage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMarkupLanguage</h4>
<pre>public boolean isMarkupLanguage()</pre>
<div class="block">The default implementation returns <code>false</code> always.
Subclasses that are highlighting a markup language should override this
method to return <code>true</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html#isMarkupLanguage()">isMarkupLanguage</a></code> in interface <code><a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html" title="interface in org.fife.ui.rsyntaxtextarea">TokenMaker</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>false</code> always.</dd></dl>
</li>
</ul>
<a name="resetTokenList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetTokenList</h4>
<pre>protected void resetTokenList()</pre>
<div class="block">Deletes the linked list of tokens so we can begin anew. This should
never have to be called by the programmer, as it is automatically
called whenever the user calls
<a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html#getLastTokenTypeOnLine(javax.swing.text.Segment, int)"><code>getLastTokenTypeOnLine(Segment, int)</code></a> or
<a href="../../../../../org/fife/ui/rsyntaxtextarea/TokenMaker.html#getTokenList(javax.swing.text.Segment, int, int)"><code>TokenMaker.getTokenList(Segment, int, int)</code></a>.</div>
</li>
</ul>
<a name="setLanguageIndex(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setLanguageIndex</h4>
<pre>public void setLanguageIndex(int languageIndex)</pre>
<div class="block">Sets the language index to assign to tokens moving forward. This
property is used to designate tokens as being in "secondary" languages
(such as CSS or JavaScript in HTML).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>languageIndex</code> - The new language index. A value of
<code>0</code> denotes the "main" language, any positive value
denotes a specific secondary language. Negative values will
be treated as <code>0</code>.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/SQLTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea.modes"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/fife/ui/rsyntaxtextarea/modes/UnixShellTokenMaker.html" title="class in org.fife.ui.rsyntaxtextarea.modes"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/fife/ui/rsyntaxtextarea/modes/TclTokenMaker.html" target="_top">Frames</a></li>
<li><a href="TclTokenMaker.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|