2 * (c) Copyright IBM Corp. 2000, 2001.
5 package net.sourceforge.phpdt.internal.ui.text.template;
7 import net.sourceforge.phpdt.internal.corext.template.Template;
8 import net.sourceforge.phpdt.internal.corext.template.TemplateBuffer;
9 import net.sourceforge.phpdt.internal.corext.template.TemplateContext;
10 import net.sourceforge.phpdt.internal.corext.template.TemplateMessages;
11 import net.sourceforge.phpdt.internal.corext.template.TemplatePosition;
12 import net.sourceforge.phpdt.internal.corext.template.php.PHPUnitContext;
13 import net.sourceforge.phpdt.internal.corext.template.php.PHPTemplateMessages;
14 import net.sourceforge.phpdt.internal.ui.text.java.IPHPCompletionProposal;
15 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
16 import org.eclipse.core.runtime.CoreException;
17 import net.sourceforge.phpdt.internal.ui.text.link.LinkedPositionManager;
18 import net.sourceforge.phpdt.internal.ui.text.link.LinkedPositionUI;
19 import org.eclipse.jface.dialogs.MessageDialog;
20 import org.eclipse.jface.text.BadLocationException;
21 import org.eclipse.jface.text.IDocument;
22 import org.eclipse.jface.text.IRegion;
23 import org.eclipse.jface.text.ITextViewer;
24 import org.eclipse.jface.text.contentassist.IContextInformation;
25 import org.eclipse.swt.graphics.Image;
26 import org.eclipse.swt.graphics.Point;
27 import org.eclipse.swt.widgets.Shell;
28 //import org.eclipse.jdt.internal.ui.text.link.LinkedPositionManager;
29 //import org.eclipse.jdt.internal.ui.text.link.LinkedPositionUI;
30 //import org.eclipse.jdt.internal.ui.util.ExceptionHandler;
33 * A template proposal.
35 public class TemplateProposal implements IPHPCompletionProposal {
37 private final Template fTemplate;
38 private final TemplateContext fContext;
39 private final ITextViewer fViewer;
40 private final Image fImage;
41 private final IRegion fRegion;
43 private TemplateBuffer fTemplateBuffer;
44 private String fOldText;
45 private IRegion fSelectedRegion; // initialized by apply()
48 * Creates a template proposal with a template and its context.
49 * @param template the template
50 * @param context the context in which the template was requested.
51 * @param image the icon of the proposal.
53 public TemplateProposal(Template template, TemplateContext context, IRegion region, ITextViewer viewer, Image image) {
54 // Assert.isNotNull(template);
55 // Assert.isNotNull(context);
56 // Assert.isNotNull(region);
57 // Assert.isNotNull(viewer);
67 * @see ICompletionProposal#apply(IDocument)
69 public void apply(IDocument document) {
71 if (fTemplateBuffer == null)
72 fTemplateBuffer= fContext.evaluate(fTemplate);
74 int start= fRegion.getOffset();
75 int end= fRegion.getOffset() + fRegion.getLength();
77 // insert template string
78 String templateString= fTemplateBuffer.getString();
79 document.replace(start, end - start, templateString);
81 // translate positions
82 LinkedPositionManager manager= new LinkedPositionManager(document);
83 TemplatePosition[] variables= fTemplateBuffer.getVariables();
84 for (int i= 0; i != variables.length; i++) {
85 TemplatePosition variable= variables[i];
87 if (variable.isResolved())
90 int[] offsets= variable.getOffsets();
91 int length= variable.getLength();
93 for (int j= 0; j != offsets.length; j++)
94 manager.addPosition(offsets[j] + start, length);
97 LinkedPositionUI editor= new LinkedPositionUI(fViewer, manager);
98 editor.setFinalCaretOffset(getCaretOffset(fTemplateBuffer) + start);
101 fSelectedRegion= editor.getSelectedRegion();
103 } catch (BadLocationException e) {
104 PHPeclipsePlugin.log(e);
107 } catch (CoreException e) {
112 private static int getCaretOffset(TemplateBuffer buffer) {
113 TemplatePosition[] variables= buffer.getVariables();
114 for (int i= 0; i != variables.length; i++) {
115 TemplatePosition variable= variables[i];
117 if (variable.getName().equals(PHPTemplateMessages.getString("GlobalVariables.variable.name.cursor"))) //$NON-NLS-1$
118 return variable.getOffsets()[0];
121 return buffer.getString().length();
125 * @see ICompletionProposal#getSelection(IDocument)
127 public Point getSelection(IDocument document) {
128 return new Point(fSelectedRegion.getOffset(), fSelectedRegion.getLength());
133 * @see ICompletionProposal#getAdditionalProposalInfo()
135 public String getAdditionalProposalInfo() {
137 if (fTemplateBuffer == null)
138 fTemplateBuffer= fContext.evaluate(fTemplate);
140 return textToHTML(fTemplateBuffer.getString());
142 } catch (CoreException e) {
149 * @see ICompletionProposal#getDisplayString()
151 public String getDisplayString() {
152 return fTemplate.getName() + TemplateMessages.getString("TemplateProposal.delimiter") + fTemplate.getDescription(); // $NON-NLS-1$ //$NON-NLS-1$
156 * @see ICompletionProposal#getImage()
158 public Image getImage() {
163 * @see ICompletionProposal#getContextInformation()
165 public IContextInformation getContextInformation() {
169 private static String textToHTML(String string) {
170 StringBuffer buffer= new StringBuffer(string.length());
171 buffer.append("<pre>"); //$NON-NLS-1$
173 for (int i= 0; i != string.length(); i++) {
174 char ch= string.charAt(i);
178 buffer.append("&"); //$NON-NLS-1$
182 buffer.append("<"); //$NON-NLS-1$
186 buffer.append(">"); //$NON-NLS-1$
190 buffer.append(" "); //$NON-NLS-1$
194 buffer.append("<br>"); //$NON-NLS-1$
203 buffer.append("</pre>"); //$NON-NLS-1$
204 return buffer.toString();
207 private void openErrorDialog(BadLocationException e) {
208 Shell shell= fViewer.getTextWidget().getShell();
209 MessageDialog.openError(shell, TemplateMessages.getString("TemplateEvaluator.error.title"), e.getMessage()); //$NON-NLS-1$
212 private void handleException(CoreException e) {
213 Shell shell= fViewer.getTextWidget().getShell();
214 PHPeclipsePlugin.log(e);
215 // ExceptionHandler.handle(e, shell, TemplateMessages.getString("TemplateEvaluator.error.title"), null); //$NON-NLS-1$
219 * @see IJavaCompletionProposal#getRelevance()
221 public int getRelevance() {
223 if (fContext instanceof PHPUnitContext) {
224 PHPUnitContext context= (PHPUnitContext) fContext;
225 switch (context.getCharacterBeforeStart()) {
226 // high relevance after whitespace