added PHPDoc contexts
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / text / template / TemplateEngine.java
1 /*
2  * (c) Copyright IBM Corp. 2000, 2001.
3  * All Rights Reserved.
4  */
5 package net.sourceforge.phpdt.internal.ui.text.template;
6
7 import java.util.ArrayList;
8
9 import net.sourceforge.phpdt.internal.corext.template.ContextType;
10 import net.sourceforge.phpdt.internal.corext.template.DocumentTemplateContext;
11 import net.sourceforge.phpdt.internal.corext.template.Template;
12 import net.sourceforge.phpdt.internal.corext.template.Templates;
13 import net.sourceforge.phpdt.internal.corext.template.php.CompilationUnitContextType;
14 import net.sourceforge.phpdt.internal.ui.PHPUiImages;
15 import net.sourceforge.phpdt.internal.ui.text.java.IPHPCompletionProposal;
16
17 import org.eclipse.jface.text.BadLocationException;
18 import org.eclipse.jface.text.IDocument;
19 import org.eclipse.jface.text.IRegion;
20 import org.eclipse.jface.text.ITextViewer;
21 import org.eclipse.jface.text.Region;
22 import org.eclipse.swt.graphics.Point;
23 //import org.eclipse.jdt.internal.ui.text.link.LinkedPositionManager;
24
25 public class TemplateEngine {
26
27         /** The context type. */
28         private ContextType fContextType;
29         /** The result proposals. */
30         private ArrayList fProposals= new ArrayList();
31
32         /**
33          * Creates the template engine for a particular context type.
34          * See <code>TemplateContext</code> for supported context types.
35          */
36         public TemplateEngine(ContextType contextType) {
37         //      Assert.isNotNull(contextType);
38                 fContextType= contextType;
39         }
40
41         /**
42          * Empties the collector.
43          * 
44          * @param viewer the text viewer  
45          * @param unit   the compilation unit (may be <code>null</code>)
46          */
47         public void reset() {
48                 fProposals.clear();
49         }
50
51         /**
52          * Returns the array of matching templates.
53          */
54         public IPHPCompletionProposal[] getResults() {
55                 return (IPHPCompletionProposal[]) fProposals.toArray(new IPHPCompletionProposal[fProposals.size()]);
56         }
57
58         /**
59          * Inspects the context of the compilation unit around <code>completionPosition</code>
60          * and feeds the collector with proposals.
61          * @param viewer the text viewer
62          * @param completionPosition the context position in the document of the text viewer
63          * @param compilationUnit the compilation unit (may be <code>null</code>)
64          */
65         public void complete(ITextViewer viewer, int completionPosition)
66   //,ICompilationUnit compilationUnit)
67         //hrows JavaModelException
68         {
69             IDocument document= viewer.getDocument();
70             
71                 // prohibit recursion
72 //              if (LinkedPositionManager.hasActiveManager(document))
73 //                      return;
74
75                 if (!(fContextType instanceof CompilationUnitContextType))
76                         return;
77                         
78     Point selection= viewer.getSelectedRange();
79     // remember selected text
80     String selectedText= null;
81     if (selection.y != 0) {
82       try {
83         selectedText= document.get(selection.x, selection.y);
84       } catch (BadLocationException e) {}
85     }
86     
87                 ((CompilationUnitContextType) fContextType).setContextParameters(document, completionPosition, selection.y);//mpilationUnit);
88                 DocumentTemplateContext context= (DocumentTemplateContext) fContextType.createContext();
89                 int start= context.getStart();
90                 int end= context.getEnd();
91                 IRegion region= new Region(start, end - start);
92
93                 Template[] templates= Templates.getInstance().getTemplates();
94                 for (int i= 0; i != templates.length; i++)
95                         if (context.canEvaluate(templates[i]))
96                                 fProposals.add(new TemplateProposal(templates[i], context, region, viewer, PHPUiImages.get(PHPUiImages.IMG_OBJS_TEMPLATE))); 
97         }
98
99 }
100