OSDN Git Service

c347a745b31107b78afe29de1ca3bf9b2a65a067
[neighbornote/NeighborNote.git] / src / com / swabunga / spell / event / TeXWordFinder.java
1 /*\r
2 Jazzy - a Java library for Spell Checking\r
3 Copyright (C) 2001 Mindaugas Idzelis\r
4 Full text of license can be found in LICENSE.txt\r
5 \r
6 This library is free software; you can redistribute it and/or\r
7 modify it under the terms of the GNU Lesser General Public\r
8 License as published by the Free Software Foundation; either\r
9 version 2.1 of the License, or (at your option) any later version.\r
10 \r
11 This library is distributed in the hope that it will be useful,\r
12 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\r
14 Lesser General Public License for more details.\r
15 \r
16 You should have received a copy of the GNU Lesser General Public\r
17 License along with this library; if not, write to the Free Software\r
18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA\r
19 */\r
20 //{{{ package and imports\r
21 //:folding=explicit:\r
22 package com.swabunga.spell.event;\r
23 \r
24 import java.util.Collection;\r
25 import java.util.HashSet;\r
26 \r
27 /**\r
28  * A word finder for TeX and LaTeX documents, which searches text for\r
29  * sequences of letters, but ignores any  commands and environments as well\r
30  * as  Math environments.\r
31  *\r
32  * @author Anthony Roy  (ajr@antroy.co.uk)\r
33  */\r
34 \r
35 //}}}\r
36 \r
37 public class TeXWordFinder extends AbstractWordFinder {\r
38 \r
39 //{{{ ~ Instance/static variables ...............................................\r
40 \r
41   @SuppressWarnings("unused")\r
42 private boolean IGNORE_COMMENTS = true;\r
43   @SuppressWarnings("unchecked")\r
44 private final HashSet user_defined_ignores = new HashSet();\r
45   @SuppressWarnings("unused")\r
46 private int regex_user_defined_ignores = STRING_EXPR;\r
47   /**\r
48    * A type where string expressions are used to define expression to ignore\r
49    */\r
50   public static final int STRING_EXPR = 0;\r
51   /**\r
52    * A type where regular expressions are used to define expression to ignore\r
53    */\r
54   public static final int REG_EXPR = 1;\r
55 //  public static final int GLOB_EXPR = 2;\r
56 //}}}\r
57 //{{{ ~ Constructors ............................................................\r
58 \r
59   /**\r
60    * Creates a new DefaultWordFinder object.\r
61    *\r
62    * @param inText the text to search.\r
63    */\r
64   public TeXWordFinder(String inText) {\r
65     super(inText);\r
66   }\r
67   \r
68   /**\r
69    * Creates a new DefaultWordFinder object.\r
70    */\r
71   public TeXWordFinder() {\r
72     super();\r
73   }\r
74 //}}}\r
75 //{{{ ~ Methods .................................................................\r
76 \r
77   /**\r
78    * This method scans the text from the end of the last word,  and returns a\r
79    * new Word object corresponding to the next word.\r
80    *\r
81    * @return the next word.\r
82    * @throws WordNotFoundException search string contains no more words.\r
83    */\r
84   @Override\r
85 public Word next() {\r
86 //{{{\r
87 \r
88     if (!hasNext())//currentWord == null)\r
89       throw new WordNotFoundException("No more words found.");\r
90 \r
91     currentWord.copy(nextWord);\r
92     setSentenceIterator(currentWord);\r
93 \r
94 \r
95     int i = currentWord.getEnd();\r
96     boolean finished = false;\r
97     boolean started = false;\r
98 \r
99     search:\r
100       while (i < text.length() && !finished) {\r
101 \r
102 //{{{ Find words.\r
103         if (!started && isWordChar(i)) {\r
104           nextWord.setStart(i++);\r
105           started = true;\r
106           continue search;\r
107         } else if (started) {\r
108           if (isWordChar(i)) {\r
109             i++;\r
110             continue search;\r
111           } else {\r
112             nextWord.setText(text.substring(nextWord.getStart(), i));\r
113             finished = true;\r
114             break search;\r
115           }\r
116         }  //}}}\r
117 // Ignores should be in order of importance and then specificity.\r
118         int j = i;\r
119 // Ignore Comments:\r
120         j = ignore(j, '%', '\n');\r
121         \r
122 // Ignore Maths:\r
123         j = ignore(j, "$$", "$$");\r
124         j = ignore(j, '$', '$');\r
125         \r
126 // Ignore user defined.\r
127         j = ignoreUserDefined(j);\r
128         \r
129 // Ignore certain command parameters.\r
130         j = ignore(j, "\\newcommand", "}");\r
131         j = ignore(j, "\\documentclass", "}");\r
132         j = ignore(j, "\\usepackage", "}");\r
133         j = ignore(j, "\\newcounter{", "}");\r
134         j = ignore(j, "\\setcounter{", "}");\r
135         j = ignore(j, "\\addtocounter{", "}");\r
136         j = ignore(j, "\\value{", "}");\r
137         j = ignore(j, "\\arabic{", "}");\r
138         j = ignore(j, "\\usecounter{", "}");\r
139         j = ignore(j, "\\newenvironment", "}");\r
140         j = ignore(j, "\\setlength", "}");\r
141         j = ignore(j, "\\setkeys", "}");\r
142         \r
143 // Ignore environment names.\r
144         j = ignore(j, "\\begin{", "}");\r
145         j = ignore(j, "\\end{", "}");        \r
146         if (i != j){\r
147           i = j;\r
148           continue search;\r
149         }\r
150         \r
151 // Ignore commands.\r
152         j = ignore(j, '\\');\r
153         \r
154         if (i != j){\r
155           i = j;\r
156           continue search;\r
157         }\r
158         i++;\r
159       }\r
160 \r
161     if (!started) {\r
162       nextWord = null;\r
163     } else if (!finished) {\r
164       nextWord.setText(text.substring(nextWord.getStart(), i));\r
165     }\r
166 \r
167     return currentWord;\r
168   }\r
169 //}}}\r
170   /**\r
171    * This method is used to import a user defined set of either strings or regular expressions to ignore.\r
172    * @param expressions a collection of Objects whose toString() value should be the expression. Typically String objects.\r
173    * @param regex is an integer specifying the type of expression to use. e.g. REG_EXPR, STRING_EXPR.\r
174    */\r
175   @SuppressWarnings("unchecked")\r
176 public void addUserDefinedIgnores(Collection expressions, int regex){\r
177     user_defined_ignores.addAll(expressions);\r
178     regex_user_defined_ignores = regex;\r
179   }\r
180 \r
181   private int ignoreUserDefined(int i){\r
182     return i;\r
183   }\r
184   \r
185   /**\r
186    * Define if comments contents are ignored during spell checking\r
187    * @param ignore an indication if comments content is to be ignored\r
188    */\r
189   public void setIgnoreComments(boolean ignore) {\r
190     IGNORE_COMMENTS = ignore;\r
191   }\r
192 //}}}\r
193 }\r