RegExContentAssistProcessor


1   /*******************************************************************************
2    * Copyright (c) 2000, 2005 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  
12  package org.eclipse.search.internal.ui.text;
13  
14  import java.util.ArrayList  ;
15  
16  import org.eclipse.jface.contentassist.IContentAssistSubjectControl;
17  import org.eclipse.jface.contentassist.ISubjectControlContentAssistProcessor;
18  import org.eclipse.jface.contentassist.SubjectControlContextInformationValidator;
19  import org.eclipse.jface.text.ITextViewer;
20  import org.eclipse.jface.text.contentassist.CompletionProposal;
21  import org.eclipse.jface.text.contentassist.ICompletionProposal;
22  import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
23  import org.eclipse.jface.text.contentassist.IContextInformation;
24  import org.eclipse.jface.text.contentassist.IContextInformationValidator;
25  
26  /**
27   * Content assist processor for regular expressions.
28   *
29   * @since 3.0
30   */
31  final class RegExContentAssistProcessor implements IContentAssistProcessor, ISubjectControlContentAssistProcessor {
32  
33      /**
34       * Proposal computer.
35       */
36      private static class ProposalComputer {
37  
38          /**
39           * The whole regular expression.
40           */
41          private final String   fExpression;
42          /**
43           * The document offset.
44           */
45          private final int fDocumentOffset;
46          /**
47           * The high-priority proposals.
48           */
49          private final ArrayList   fPriorityProposals;
50          /**
51           * The low-priority proposals.
52           */
53          private final ArrayList   fProposals;
54          /**
55           * <code>true</code> iff <code>fExpression</code> ends with an open escape.
56           */
57          private final boolean fIsEscape;
58  
59          /**
60           * Creates a new Proposal Computer.
61           * @param contentAssistSubjectControl the subject control
62           * @param documentOffset the offset
63           */
64          public ProposalComputer(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset) {
65              fExpression= contentAssistSubjectControl.getDocument().get();
66              fDocumentOffset= documentOffset;
67              fPriorityProposals= new ArrayList  ();
68              fProposals= new ArrayList  ();
69              
70              boolean isEscape= false;
71              esc: for (int i= documentOffset - 1; i >= 0; i--) {
72                  if (fExpression.charAt(i) == '\\')
73                      isEscape= !isEscape;
74                  else
75                      break esc;
76              }
77              fIsEscape= isEscape;
78          }
79  
80          /**
81           * Computes applicable proposals for the find field.
82           * @return the proposals
83           */
84          public ICompletionProposal[] computeFindProposals() {
85              //characters
86              addBsProposal("\\\\", RegExMessages.displayString_bs_bs, RegExMessages.additionalInfo_bs_bs); //$NON-NLS-1$
87              addBracketProposal("\\0", 2, RegExMessages.displayString_bs_0, RegExMessages.additionalInfo_bs_0); //$NON-NLS-1$
88              addBracketProposal("\\x", 2, RegExMessages.displayString_bs_x, RegExMessages.additionalInfo_bs_x); //$NON-NLS-1$
89              addBracketProposal("\\u", 2, RegExMessages.displayString_bs_u, RegExMessages.additionalInfo_bs_u); //$NON-NLS-1$
90              addBsProposal("\\t", RegExMessages.displayString_bs_t, RegExMessages.additionalInfo_bs_t); //$NON-NLS-1$
91              addBsProposal("\\n", RegExMessages.displayString_bs_n, RegExMessages.additionalInfo_bs_n); //$NON-NLS-1$
92              addBsProposal("\\r", RegExMessages.displayString_bs_r, RegExMessages.additionalInfo_bs_r); //$NON-NLS-1$
93              addBsProposal("\\f", RegExMessages.displayString_bs_f, RegExMessages.additionalInfo_bs_f); //$NON-NLS-1$
94              addBsProposal("\\a", RegExMessages.displayString_bs_a, RegExMessages.additionalInfo_bs_a); //$NON-NLS-1$
95              addBsProposal("\\e", RegExMessages.displayString_bs_e, RegExMessages.additionalInfo_bs_e); //$NON-NLS-1$
96              addBsProposal("\\c", RegExMessages.displayString_bs_c, RegExMessages.additionalInfo_bs_c); //$NON-NLS-1$
97              
98              if (! fIsEscape)
99                  addBracketProposal(".", 1, RegExMessages.displayString_dot, RegExMessages.additionalInfo_dot); //$NON-NLS-1$
100             addBsProposal("\\d", RegExMessages.displayString_bs_d, RegExMessages.additionalInfo_bs_d); //$NON-NLS-1$
101             addBsProposal("\\D", RegExMessages.displayString_bs_D, RegExMessages.additionalInfo_bs_D); //$NON-NLS-1$
102             addBsProposal("\\s", RegExMessages.displayString_bs_s, RegExMessages.additionalInfo_bs_s); //$NON-NLS-1$
103             addBsProposal("\\S", RegExMessages.displayString_bs_S, RegExMessages.additionalInfo_bs_S); //$NON-NLS-1$
104             addBsProposal("\\w", RegExMessages.displayString_bs_w, RegExMessages.additionalInfo_bs_w); //$NON-NLS-1$
105             addBsProposal("\\W", RegExMessages.displayString_bs_W, RegExMessages.additionalInfo_bs_W); //$NON-NLS-1$
106             
107             // backreference
108             addBsProposal("\\", RegExMessages.displayString_bs_i, RegExMessages.additionalInfo_bs_i); //$NON-NLS-1$
109             
110             //quoting
111             addBsProposal("\\", RegExMessages.displayString_bs, RegExMessages.additionalInfo_bs); //$NON-NLS-1$
112             addBsProposal("\\Q", RegExMessages.displayString_bs_Q, RegExMessages.additionalInfo_bs_Q); //$NON-NLS-1$
113             addBsProposal("\\E", RegExMessages.displayString_bs_E, RegExMessages.additionalInfo_bs_E); //$NON-NLS-1$
114             
115             //character sets
116             if (! fIsEscape) {
117                 addBracketProposal("[]", 1, RegExMessages.displayString_set, RegExMessages.additionalInfo_set); //$NON-NLS-1$
118                 addBracketProposal("[^]", 2, RegExMessages.displayString_setExcl, RegExMessages.additionalInfo_setExcl); //$NON-NLS-1$
119                 addBracketProposal("[-]", 1, RegExMessages.displayString_setRange, RegExMessages.additionalInfo_setRange); //$NON-NLS-1$
120                 addProposal("&&", RegExMessages.displayString_setInter, RegExMessages.additionalInfo_setInter); //$NON-NLS-1$
121             }
122             if (! fIsEscape && fDocumentOffset > 0 && fExpression.charAt(fDocumentOffset - 1) == '\\') {
123                 addProposal("\\p{}", 3, RegExMessages.displayString_posix, RegExMessages.additionalInfo_posix); //$NON-NLS-1$
124                 addProposal("\\P{}", 3, RegExMessages.displayString_posixNot, RegExMessages.additionalInfo_posixNot); //$NON-NLS-1$
125             } else {
126                 addBracketProposal("\\p{}", 3, RegExMessages.displayString_posix, RegExMessages.additionalInfo_posix); //$NON-NLS-1$
127                 addBracketProposal("\\P{}", 3, RegExMessages.displayString_posixNot, RegExMessages.additionalInfo_posixNot); //$NON-NLS-1$
128             }
129             
130 //          addBsProposal("\\p{Lower}", RegExMessages.displayString_bs_p{Lower}, RegExMessages.additionalInfo_bs_p{Lower}); //$NON-NLS-1$
131 //          addBsProposal("\\p{Upper}", RegExMessages.displayString_bs_p{Upper}, RegExMessages.additionalInfo_bs_p{Upper}); //$NON-NLS-1$
132 //          addBsProposal("\\p{ASCII}", RegExMessages.displayString_bs_p{ASCII}, RegExMessages.additionalInfo_bs_p{ASCII}); //$NON-NLS-1$
133 //          addBsProposal("\\p{Alpha}", RegExMessages.displayString_bs_p{Alpha}, RegExMessages.additionalInfo_bs_p{Alpha}); //$NON-NLS-1$
134 //          addBsProposal("\\p{Digit}", RegExMessages.displayString_bs_p{Digit}, RegExMessages.additionalInfo_bs_p{Digit}); //$NON-NLS-1$
135 //          addBsProposal("\\p{Alnum}", RegExMessages.displayString_bs_p{Alnum}, RegExMessages.additionalInfo_bs_p{Alnum}); //$NON-NLS-1$
136 //          addBsProposal("\\p{Punct}", RegExMessages.displayString_bs_p{Punct}, RegExMessages.additionalInfo_bs_p{Punct}); //$NON-NLS-1$
137 //          addBsProposal("\\p{Graph}", RegExMessages.displayString_bs_p{Graph}, RegExMessages.additionalInfo_bs_p{Graph}); //$NON-NLS-1$
138 //          addBsProposal("\\p{Print}", RegExMessages.displayString_bs_p{Print}, RegExMessages.additionalInfo_bs_p{Print}); //$NON-NLS-1$
139 //          addBsProposal("\\p{Blank}", RegExMessages.displayString_bs_p{Blank}, RegExMessages.additionalInfo_bs_p{Blank}); //$NON-NLS-1$
140 //          addBsProposal("\\p{Cntrl}", RegExMessages.displayString_bs_p{Cntrl}, RegExMessages.additionalInfo_bs_p{Cntrl}); //$NON-NLS-1$
141 //          addBsProposal("\\p{XDigit}", RegExMessages.displayString_bs_p{XDigit}, RegExMessages.additionalInfo_bs_p{XDigit}); //$NON-NLS-1$
142 //          addBsProposal("\\p{Space}", RegExMessages.displayString_bs_p{Space}, RegExMessages.additionalInfo_bs_p{Space}); //$NON-NLS-1$
143 //
144 //          addBsProposal("\\p{InGreek}", RegExMessages.displayString_bs_p{InGreek}, RegExMessages.additionalInfo_bs_p{InGreek}); //$NON-NLS-1$
145 //          addBsProposal("\\p{Lu}", RegExMessages.displayString_bs_p{Lu}, RegExMessages.additionalInfo_bs_p{Lu}); //$NON-NLS-1$
146 //          addBsProposal("\\p{Sc}", RegExMessages.displayString_bs_p{Sc}, RegExMessages.additionalInfo_bs_p{Sc}); //$NON-NLS-1$
147 //          addBsProposal("\\P{InGreek}", RegExMessages.displayString_bs_P{InGreek}, RegExMessages.additionalInfo_bs_P{InGreek}); //$NON-NLS-1$
148             
149             //boundary matchers
150             if (fDocumentOffset == 0) {
151                 addPriorityProposal("^", RegExMessages.displayString_start, RegExMessages.additionalInfo_start); //$NON-NLS-1$
152             } else if (fDocumentOffset == 1 && fExpression.charAt(0) == '^') {
153                 addBracketProposal("^", 1, RegExMessages.displayString_start, RegExMessages.additionalInfo_start); //$NON-NLS-1$
154             }
155             if (fDocumentOffset == fExpression.length()) {
156                 addProposal("$", RegExMessages.displayString_end, RegExMessages.additionalInfo_end); //$NON-NLS-1$
157             }
158             addBsProposal("\\b", RegExMessages.displayString_bs_b, RegExMessages.additionalInfo_bs_b); //$NON-NLS-1$
159             addBsProposal("\\B", RegExMessages.displayString_bs_B, RegExMessages.additionalInfo_bs_B); //$NON-NLS-1$
160             addBsProposal("\\A", RegExMessages.displayString_bs_A, RegExMessages.additionalInfo_bs_A); //$NON-NLS-1$
161             addBsProposal("\\G", RegExMessages.displayString_bs_G, RegExMessages.additionalInfo_bs_G); //$NON-NLS-1$
162             addBsProposal("\\Z", RegExMessages.displayString_bs_Z, RegExMessages.additionalInfo_bs_Z); //$NON-NLS-1$
163             addBsProposal("\\z", RegExMessages.displayString_bs_z, RegExMessages.additionalInfo_bs_z); //$NON-NLS-1$
164             
165             if (! fIsEscape) {
166                 //capturing groups
167                 addBracketProposal("()", 1, RegExMessages.displayString_group, RegExMessages.additionalInfo_group); //$NON-NLS-1$
168                 
169                 //flags
170                 addBracketProposal("(?)", 2, RegExMessages.displayString_flag, RegExMessages.additionalInfo_flag); //$NON-NLS-1$
171                 addBracketProposal("(?:)", 3, RegExMessages.displayString_flagExpr, RegExMessages.additionalInfo_flagExpr); //$NON-NLS-1$
172             
173                 //noncapturing group
174                 addBracketProposal("(?:)", 3, RegExMessages.displayString_nonCap, RegExMessages.additionalInfo_nonCap); //$NON-NLS-1$
175                 addBracketProposal("(?>)", 3, RegExMessages.displayString_atomicCap, RegExMessages.additionalInfo_atomicCap); //$NON-NLS-1$
176                 
177                 //lookaraound
178                 addBracketProposal("(?=)", 3, RegExMessages.displayString_posLookahead, RegExMessages.additionalInfo_posLookahead); //$NON-NLS-1$
179                 addBracketProposal("(?!)", 3, RegExMessages.displayString_negLookahead, RegExMessages.additionalInfo_negLookahead); //$NON-NLS-1$
180                 addBracketProposal("(?<=)", 4, RegExMessages.displayString_posLookbehind, RegExMessages.additionalInfo_posLookbehind); //$NON-NLS-1$
181                 addBracketProposal("(?<!)", 4, RegExMessages.displayString_negLookbehind, RegExMessages.additionalInfo_negLookbehind); //$NON-NLS-1$
182                 
183                 //greedy quantifiers
184                 addBracketProposal("?", 1, RegExMessages.displayString_quest, RegExMessages.additionalInfo_quest); //$NON-NLS-1$
185                 addBracketProposal("*", 1, RegExMessages.displayString_star, RegExMessages.additionalInfo_star); //$NON-NLS-1$
186                 addBracketProposal("+", 1, RegExMessages.displayString_plus, RegExMessages.additionalInfo_plus); //$NON-NLS-1$
187                 addBracketProposal("{}", 1, RegExMessages.displayString_exact, RegExMessages.additionalInfo_exact); //$NON-NLS-1$
188                 addBracketProposal("{,}", 1, RegExMessages.displayString_least, RegExMessages.additionalInfo_least); //$NON-NLS-1$
189                 addBracketProposal("{,}", 1, RegExMessages.displayString_count, RegExMessages.additionalInfo_count); //$NON-NLS-1$
190                 
191                 //lazy quantifiers
192                 addBracketProposal("??", 1, RegExMessages.displayString_questLazy, RegExMessages.additionalInfo_questLazy); //$NON-NLS-1$
193                 addBracketProposal("*?", 1, RegExMessages.displayString_starLazy, RegExMessages.additionalInfo_starLazy); //$NON-NLS-1$
194                 addBracketProposal("+?", 1, RegExMessages.displayString_plusLazy, RegExMessages.additionalInfo_plusLazy); //$NON-NLS-1$
195                 addBracketProposal("{}?", 1, RegExMessages.displayString_exactLazy, RegExMessages.additionalInfo_exactLazy); //$NON-NLS-1$
196                 addBracketProposal("{,}?", 1, RegExMessages.displayString_leastLazy, RegExMessages.additionalInfo_leastLazy); //$NON-NLS-1$
197                 addBracketProposal("{,}?", 1, RegExMessages.displayString_countLazy, RegExMessages.additionalInfo_countLazy); //$NON-NLS-1$
198                 
199                 //possessive quantifiers
200                 addBracketProposal("?+", 1, RegExMessages.displayString_questPoss, RegExMessages.additionalInfo_questPoss); //$NON-NLS-1$
201                 addBracketProposal("*+", 1, RegExMessages.displayString_starPoss, RegExMessages.additionalInfo_starPoss); //$NON-NLS-1$
202                 addBracketProposal("++", 1, RegExMessages.displayString_plusPoss, RegExMessages.additionalInfo_plusPoss); //$NON-NLS-1$
203                 addBracketProposal("{}+", 1, RegExMessages.displayString_exactPoss, RegExMessages.additionalInfo_exactPoss); //$NON-NLS-1$
204                 addBracketProposal("{,}+", 1, RegExMessages.displayString_leastPoss, RegExMessages.additionalInfo_leastPoss); //$NON-NLS-1$
205                 addBracketProposal("{,}+", 1, RegExMessages.displayString_countPoss, RegExMessages.additionalInfo_countPoss); //$NON-NLS-1$
206                 
207                 //alternative
208                 addBracketProposal("|", 1, RegExMessages.displayString_alt, RegExMessages.additionalInfo_alt); //$NON-NLS-1$
209             }
210             
211             fPriorityProposals.addAll(fProposals);
212             return (ICompletionProposal[]) fPriorityProposals.toArray(new ICompletionProposal[fProposals.size()]);
213         }
214 
215         /**
216          * Computes applicable proposals for the replace field.
217          * @return the proposals
218          */
219         public ICompletionProposal[] computeReplaceProposals() {
220             if (fDocumentOffset > 0 && '$' == fExpression.charAt(fDocumentOffset - 1)) {
221                 addProposal("", RegExMessages.displayString_dollar, RegExMessages.additionalInfo_dollar); //$NON-NLS-1$
222             } else {
223                 addProposal("$", RegExMessages.displayString_dollar, RegExMessages.additionalInfo_dollar); //$NON-NLS-1$
224                 addBsProposal("\\", RegExMessages.displayString_replace_bs, RegExMessages.additionalInfo_replace_bs); //$NON-NLS-1$
225                 addProposal("\t", RegExMessages.displayString_tab, RegExMessages.additionalInfo_tab); //$NON-NLS-1$
226             }
227             return (ICompletionProposal[]) fProposals.toArray(new ICompletionProposal[fProposals.size()]);
228         }
229         
230         /**
231          * Adds a proposal.
232          * 
233          * @param proposal the string to be inserted
234          * @param displayString the proposal's label
235          * @param additionalInfo the additional information
236          */
237         private void addProposal(String   proposal, String   displayString, String   additionalInfo) {
238             fProposals.add(new CompletionProposal(proposal, fDocumentOffset, 0, proposal.length(), null, displayString, null, additionalInfo));
239         }
240 
241         /**
242          * Adds a proposal.
243          * 
244          * @param proposal the string to be inserted
245          * @param cursorPosition the cursor position after insertion,
246          *      relative to the start of the proposal
247          * @param displayString the proposal's label
248          * @param additionalInfo the additional information
249          */
250         private void addProposal(String   proposal, int cursorPosition, String   displayString, String   additionalInfo) {
251             fProposals.add(new CompletionProposal(proposal, fDocumentOffset, 0, cursorPosition, null, displayString, null, additionalInfo));
252         }
253 
254         /**
255          * Adds a proposal to the priority proposals list.
256          * 
257          * @param proposal the string to be inserted
258          * @param displayString the proposal's label
259          * @param additionalInfo the additional information
260          */
261         private void addPriorityProposal(String   proposal, String   displayString, String   additionalInfo) {
262             fPriorityProposals.add(new CompletionProposal(proposal, fDocumentOffset, 0, proposal.length(), null, displayString, null, additionalInfo));
263         }
264         
265         /**
266          * Adds a proposal. Ensures that existing pre- and postfixes are not duplicated.
267          * 
268          * @param proposal the string to be inserted
269          * @param cursorPosition the cursor position after insertion,
270          *      relative to the start of the proposal
271          * @param displayString the proposal's label
272          * @param additionalInfo the additional information
273          */
274         private void addBracketProposal(String   proposal, int cursorPosition, String   displayString, String   additionalInfo) {
275             String   prolog= fExpression.substring(0, fDocumentOffset);
276             if (! fIsEscape && prolog.endsWith("\\") && proposal.startsWith("\\")) { //$NON-NLS-1$//$NON-NLS-2$
277                 fProposals.add(new CompletionProposal(proposal, fDocumentOffset, 0, cursorPosition, null, displayString, null, additionalInfo));
278                 return;
279             }
280             for (int i= 1; i <= cursorPosition; i++) {
281                 String   prefix= proposal.substring(0, i);
282                 if (prolog.endsWith(prefix)) {
283                     String   postfix= proposal.substring(cursorPosition);
284                     String   epilog= fExpression.substring(fDocumentOffset);
285                     if (epilog.startsWith(postfix)) {
286                         fPriorityProposals.add(new CompletionProposal(proposal.substring(i, cursorPosition), fDocumentOffset, 0, cursorPosition - i, null, displayString, null, additionalInfo));
287                     } else {
288                         fPriorityProposals.add(new CompletionProposal(proposal.substring(i), fDocumentOffset, 0, cursorPosition - i, null, displayString, null, additionalInfo));
289                     }
290                     return;
291                 }
292             }
293             fProposals.add(new CompletionProposal(proposal, fDocumentOffset, 0, cursorPosition, null, displayString, null, additionalInfo));
294         }
295 
296         /**
297          * Adds a proposal that starts with a backslash.
298          * 
299          * @param proposal the string to be inserted
300          * @param displayString the proposal's label
301          * @param additionalInfo the additional information
302          */
303         private void addBsProposal(String   proposal, String   displayString, String   additionalInfo) {
304             if (fIsEscape) {
305                 fPriorityProposals.add(new CompletionProposal(proposal.substring(1), fDocumentOffset, 0, proposal.length() - 1, null, displayString, null, additionalInfo));
306             } else {
307                 addProposal(proposal, displayString, additionalInfo);
308             }
309         }
310     }
311 
312     /**
313      * The context information validator.
314      */
315     private IContextInformationValidator fValidator= new SubjectControlContextInformationValidator(this);
316 
317     /**
318      * <code>true</code> iff the processor is for the find field.
319      * <code>false</code> iff the processor is for the replace field.
320      */
321     private final boolean fIsFind;
322     
323     public RegExContentAssistProcessor(boolean isFind) {
324         fIsFind= isFind;
325     }
326     
327     /*
328      * @see IContentAssistProcessor#computeCompletionProposals(ITextViewer, int)
329      */
330     public ICompletionProposal[] computeCompletionProposals(ITextViewer viewer, int documentOffset) {
331         throw new UnsupportedOperationException  ("ITextViewer not supported"); //$NON-NLS-1$
332     }
333 
334     /*
335      * @see IContentAssistProcessor#computeContextInformation(ITextViewer, int)
336      */
337     public IContextInformation[] computeContextInformation(ITextViewer viewer, int documentOffset) {
338         throw new UnsupportedOperationException  ("ITextViewer not supported"); //$NON-NLS-1$
339     }
340 
341     /*
342      * @see IContentAssistProcessor#getCompletionProposalAutoActivationCharacters()
343      */
344     public char[] getCompletionProposalAutoActivationCharacters() {
345         if (fIsFind)
346             return new char[] {'\\', '[', '('};
347         
348         return new char[] {'$'};
349     }
350 
351     /*
352      * @see IContentAssistProcessor#getContextInformationAutoActivationCharacters()
353      */
354     public char[] getContextInformationAutoActivationCharacters() {
355         return new char[] { };
356     }
357 
358     /*
359      * @see IContentAssistProcessor#getContextInformationValidator()
360      */
361     public IContextInformationValidator getContextInformationValidator() {
362         return fValidator;
363     }
364 
365     /*
366      * @see IContentAssistProcessor#getErrorMessage()
367      */
368     public String   getErrorMessage() {
369         return null;
370     }
371 
372     /*
373      * @see ISubjectControlContentAssistProcessor#computeCompletionProposals(IContentAssistSubjectControl, int)
374      */
375     public ICompletionProposal[] computeCompletionProposals(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset) {
376         if (fIsFind)
377             return new ProposalComputer(contentAssistSubjectControl, documentOffset).computeFindProposals();
378         
379         return new ProposalComputer(contentAssistSubjectControl, documentOffset).computeReplaceProposals();
380     }
381 
382     /*
383      * @see ISubjectControlContentAssistProcessor#computeContextInformation(IContentAssistSubjectControl, int)
384      */
385     public IContextInformation[] computeContextInformation(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset) {
386         return null;
387     }
388 }
389
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags