PageRenderTime 39ms CodeModel.GetById 16ms RepoModel.GetById 1ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/syntax/package-summary.html

#
HTML | 231 lines | 198 code | 27 blank | 6 comment | 0 complexity | 2503fb9f5ba67e6528c85c71ce9eb5f6 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:17 GMT-08:00 2008 -->
    6. 

  6. <TITLE>
    7. 

  7. org.gjt.sp.jedit.syntax (jEdit API)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.syntax package">
    11. 

  11. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
    13. 

  13. 

  14. 

  15. <NOSCRIPT>
    16. 

  16. </NOSCRIPT>
    17. 

  17. 

  18. </HEAD>
    19. 

  19. 

  20. <BODY BGCOLOR="white" >
    21. 

  21. 

  22. 

  23. <!-- ========= START OF TOP NAVBAR ======= -->
    24. 

  24. <A NAME="navbar_top"><!-- --></A>
    25. 

  25. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    26. 

  26. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    27. 

  27. <TR>
    28. 

  28. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    29. 

  29. <A NAME="navbar_top_firstrow"><!-- --></A>
    30. 

  30. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    31. 

  31.   <TR ALIGN="center" VALIGN="top">
    32. 

  32.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    33. 

  33.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
    34. 

  34.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
    35. 

  35.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    36. 

  36.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    37. 

  37.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    38. 

  38.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    39. 

  39.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    40. 

  40.   </TR>
    41. 

  41. </TABLE>
    42. 

  42. </TD>
    43. 

  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    44. 

  44. </EM>
    45. 

  45. </TD>
    46. 

  46. </TR>
    47. 

  47. 

  48. <TR>
    49. 

  49. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    50. 

  50. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/search/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
    51. 

  51. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/textarea/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
    52. 

  52. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    53. 

  53.   <A HREF="../../../../../index.html?org/gjt/sp/jedit/syntax/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    54. 

  54. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    55. 

  55. &nbsp;
    56. 

  56. <NOSCRIPT>
    57. 

  57.   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
    58. 

  58. </NOSCRIPT>
    59. 

  59. 

  60. 

  61. </FONT></TD>
    62. 

  62. </TR>
    63. 

  63. </TABLE>
    64. 

  64. <A NAME="skip-navbar_top"></A>
    65. 

  65. <!-- ========= END OF TOP NAVBAR ========= -->
    66. 

  66. 

  67. <HR>
    68. 

  68. <H2>
    69. 

  69. Package org.gjt.sp.jedit.syntax
    70. 

  70. </H2>
    71. 

  71. The jEdit syntax highlighting engine.
    72. 

  72. <P>
    73. 

  73. <B>See:</B>
    74. 

  74. <BR>
    75. 

  75. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
    76. 

  76. <P>
    77. 

  77. 

  78. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    79. 

  79. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    80. 

  80. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    81. 

  81. <B>Interface Summary</B></FONT></TH>
    82. 

  82. </TR>
    83. 

  83. <TR BGCOLOR="white" CLASS="TableRowColor">
    84. 

  84. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/TokenHandler.html" title="interface in org.gjt.sp.jedit.syntax">TokenHandler</A></B></TD>
    85. 

  85. <TD>Token markers send tokens to implementations of this interface.</TD>
    86. 

  86. </TR>
    87. 

  87. </TABLE>
    88. 

  88. &nbsp;
    89. 

  89. 

  90. <P>
    91. 

  91. 

  92. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    93. 

  93. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    94. 

  94. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    95. 

  95. <B>Class Summary</B></FONT></TH>
    96. 

  96. </TR>
    97. 

  97. <TR BGCOLOR="white" CLASS="TableRowColor">
    98. 

  98. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/Chunk.html" title="class in org.gjt.sp.jedit.syntax">Chunk</A></B></TD>
    99. 

  99. <TD>A syntax token with extra information required for painting it
    100. 

  100.  on screen.</TD>
    101. 

  101. </TR>
    102. 

  102. <TR BGCOLOR="white" CLASS="TableRowColor">
    103. 

  103. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/DefaultTokenHandler.html" title="class in org.gjt.sp.jedit.syntax">DefaultTokenHandler</A></B></TD>
    104. 

  104. <TD>Builds a linked list of tokens without any additional processing.</TD>
    105. 

  105. </TR>
    106. 

  106. <TR BGCOLOR="white" CLASS="TableRowColor">
    107. 

  107. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/DisplayTokenHandler.html" title="class in org.gjt.sp.jedit.syntax">DisplayTokenHandler</A></B></TD>
    108. 

  108. <TD>Creates <A HREF="../../../../../org/gjt/sp/jedit/syntax/Chunk.html" title="class in org.gjt.sp.jedit.syntax"><CODE>Chunk</CODE></A> objects that can be painted on screen.</TD>
    109. 

  109. </TR>
    110. 

  110. <TR BGCOLOR="white" CLASS="TableRowColor">
    111. 

  111. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/DummyTokenHandler.html" title="class in org.gjt.sp.jedit.syntax">DummyTokenHandler</A></B></TD>
    112. 

  112. <TD>A dummy token handler that discards tokens.</TD>
    113. 

  113. </TR>
    114. 

  114. <TR BGCOLOR="white" CLASS="TableRowColor">
    115. 

  115. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/KeywordMap.html" title="class in org.gjt.sp.jedit.syntax">KeywordMap</A></B></TD>
    116. 

  116. <TD>A <code>KeywordMap</code> is similar to a hashtable in that it maps keys
    117. 

  117.  to values.</TD>
    118. 

  118. </TR>
    119. 

  119. <TR BGCOLOR="white" CLASS="TableRowColor">
    120. 

  120. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/ModeProvider.html" title="class in org.gjt.sp.jedit.syntax">ModeProvider</A></B></TD>
    121. 

  121. <TD>This class works like a singleton, the instance is initialized by jEdit.</TD>
    122. 

  122. </TR>
    123. 

  123. <TR BGCOLOR="white" CLASS="TableRowColor">
    124. 

  124. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/ParserRule.html" title="class in org.gjt.sp.jedit.syntax">ParserRule</A></B></TD>
    125. 

  125. <TD>A parser rule.</TD>
    126. 

  126. </TR>
    127. 

  127. <TR BGCOLOR="white" CLASS="TableRowColor">
    128. 

  128. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/ParserRuleSet.html" title="class in org.gjt.sp.jedit.syntax">ParserRuleSet</A></B></TD>
    129. 

  129. <TD>A set of parser rules.</TD>
    130. 

  130. </TR>
    131. 

  131. <TR BGCOLOR="white" CLASS="TableRowColor">
    132. 

  132. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/SyntaxStyle.html" title="class in org.gjt.sp.jedit.syntax">SyntaxStyle</A></B></TD>
    133. 

  133. <TD>A simple text style class.</TD>
    134. 

  134. </TR>
    135. 

  135. <TR BGCOLOR="white" CLASS="TableRowColor">
    136. 

  136. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/SyntaxUtilities.html" title="class in org.gjt.sp.jedit.syntax">SyntaxUtilities</A></B></TD>
    137. 

  137. <TD>Contains utility functions used by the syntax highlighting code.</TD>
    138. 

  138. </TR>
    139. 

  139. <TR BGCOLOR="white" CLASS="TableRowColor">
    140. 

  140. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/Token.html" title="class in org.gjt.sp.jedit.syntax">Token</A></B></TD>
    141. 

  141. <TD>A linked list of syntax tokens.</TD>
    142. 

  142. </TR>
    143. 

  143. <TR BGCOLOR="white" CLASS="TableRowColor">
    144. 

  144. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/TokenMarker.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker</A></B></TD>
    145. 

  145. <TD>A token marker splits lines of text into tokens.</TD>
    146. 

  146. </TR>
    147. 

  147. <TR BGCOLOR="white" CLASS="TableRowColor">
    148. 

  148. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/TokenMarker.LineContext.html" title="class in org.gjt.sp.jedit.syntax">TokenMarker.LineContext</A></B></TD>
    149. 

  149. <TD>Stores persistent per-line syntax parser state.</TD>
    150. 

  150. </TR>
    151. 

  151. <TR BGCOLOR="white" CLASS="TableRowColor">
    152. 

  152. <TD WIDTH="15%"><B><A HREF="../../../../../org/gjt/sp/jedit/syntax/XModeHandler.html" title="class in org.gjt.sp.jedit.syntax">XModeHandler</A></B></TD>
    153. 

  153. <TD>XML handler for mode definition files.</TD>
    154. 

  154. </TR>
    155. 

  155. </TABLE>
    156. 

  156. &nbsp;
    157. 

  157. 

  158. <P>
    159. 

  159. <A NAME="package_description"><!-- --></A><H2>
    160. 

  160. Package org.gjt.sp.jedit.syntax Description
    161. 

  161. </H2>
    162. 

  162. 

  163. <P>
    164. 

  164. The jEdit syntax highlighting engine. This package only depends on a
    165. 

  165. few jEdit classes:
    166. 

  166. 

  167. <ul>
    168. 

  168. <li><a href="../../util/SegmentCharSequence.html">org.gjt.sp.util.SegmentCharSequence class</a></li>
    169. 

  169. <li><a href="../../util/Log.html">org.gjt.sp.util.Log class</a></li>
    170. 

  170. </ul>
    171. 

  171. 

  172. To use this package from other programs, see the documentation for the
    173. 

  173. <a href="TokenMarker.html">TokenMarker</a>,
    174. 

  174. <a href="TokenHandler.html">TokenHandler</a> and
    175. 

  175. <a href="XModeHandler.html">XModeHandler</a> classes.
    176. 

  176. <P>
    177. 

  177. 

  178. <P>
    179. 

  179. <DL>
    180. 

  180. </DL>
    181. 

  181. <HR>
    182. 

  182. 

  183. 

  184. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    185. 

  185. <A NAME="navbar_bottom"><!-- --></A>
    186. 

  186. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    187. 

  187. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    188. 

  188. <TR>
    189. 

  189. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    190. 

  190. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    191. 

  191. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    192. 

  192.   <TR ALIGN="center" VALIGN="top">
    193. 

  193.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    194. 

  194.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
    195. 

  195.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
    196. 

  196.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    197. 

  197.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    198. 

  198.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    199. 

  199.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    200. 

  200.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    201. 

  201.   </TR>
    202. 

  202. </TABLE>
    203. 

  203. </TD>
    204. 

  204. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    205. 

  205. </EM>
    206. 

  206. </TD>
    207. 

  207. </TR>
    208. 

  208. 

  209. <TR>
    210. 

  210. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    211. 

  211. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/search/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
    212. 

  212. &nbsp;<A HREF="../../../../../org/gjt/sp/jedit/textarea/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
    213. 

  213. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    214. 

  214.   <A HREF="../../../../../index.html?org/gjt/sp/jedit/syntax/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    215. 

  215. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    216. 

  216. &nbsp;
    217. 

  217. <NOSCRIPT>
    218. 

  218.   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
    219. 

  219. </NOSCRIPT>
    220. 

  220. 

  221. 

  222. </FONT></TD>
    223. 

  223. </TR>
    224. 

  224. </TABLE>
    225. 

  225. <A NAME="skip-navbar_bottom"></A>
    226. 

  226. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    227. 

  227. 

  228. <HR>
    229. 

  229. 

  230. </BODY>
    231. 

  231. </HTML>
    232. 

  232.