Changes:
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / text / template / BuiltInProposal.java
index 1ff6be7..8fa33ab 100644 (file)
@@ -4,27 +4,21 @@
  */
 package net.sourceforge.phpdt.internal.ui.text.template;
 
-import net.sourceforge.phpdt.internal.corext.template.Template;
-import net.sourceforge.phpdt.internal.corext.template.TemplateBuffer;
 import net.sourceforge.phpdt.internal.corext.template.TemplateContext;
 import net.sourceforge.phpdt.internal.corext.template.TemplateMessages;
-import net.sourceforge.phpdt.internal.corext.template.TemplatePosition;
-import net.sourceforge.phpdt.internal.corext.template.java.CompilationUnitContext;
-import net.sourceforge.phpdt.internal.corext.template.java.JavaTemplateMessages;
-import net.sourceforge.phpdt.internal.ui.text.java.IJavaCompletionProposal;
-import net.sourceforge.phpeclipse.PHPeclipsePlugin;
-import org.eclipse.core.runtime.CoreException;
+import net.sourceforge.phpdt.internal.corext.template.php.PHPUnitContext;
+import net.sourceforge.phpdt.internal.ui.PHPUiImages;
 import net.sourceforge.phpdt.internal.ui.text.link.LinkedPositionManager;
 import net.sourceforge.phpdt.internal.ui.text.link.LinkedPositionUI;
-import org.eclipse.jface.dialogs.MessageDialog;
+import net.sourceforge.phpeclipse.PHPeclipsePlugin;
+import net.sourceforge.phpeclipse.phpeditor.php.PHPFunction;
+
 import org.eclipse.jface.text.BadLocationException;
 import org.eclipse.jface.text.IDocument;
 import org.eclipse.jface.text.IRegion;
 import org.eclipse.jface.text.ITextViewer;
 import org.eclipse.jface.text.contentassist.IContextInformation;
 import org.eclipse.swt.graphics.Image;
-import org.eclipse.swt.graphics.Point;
-import org.eclipse.swt.widgets.Shell;
 //import org.eclipse.jdt.internal.ui.text.link.LinkedPositionManager;
 //import org.eclipse.jdt.internal.ui.text.link.LinkedPositionUI;
 //import org.eclipse.jdt.internal.ui.util.ExceptionHandler;
@@ -32,18 +26,19 @@ import org.eclipse.swt.widgets.Shell;
 /**
  * A PHP identifier proposal.
  */
-public class BuiltInProposal implements IJavaCompletionProposal {
-
-  private final String fTemplate;
+public class BuiltInProposal extends AbstractProposal { // implements IPHPCompletionProposal {
   private final TemplateContext fContext;
-  private final ITextViewer fViewer;
-  private final Image fImage_builtin;
-
-  private final IRegion fRegion;
+  private final PHPFunction fFunction;
 
   //private TemplateBuffer fTemplateBuffer;
   private String fOldText;
-  private IRegion fSelectedRegion; // initialized by apply()
+  //  private final Image fImage_builtin;
+
+  private final IRegion fRegion;
+  //  private IRegion fSelectedRegion; // initialized by apply()
+
+  private final String fBuiltinFunctionName;
+  //  private final ITextViewer fViewer;
 
   /**
    * Creates a template proposal with a template and its context.
@@ -51,16 +46,12 @@ public class BuiltInProposal implements IJavaCompletionProposal {
    * @param context   the context in which the template was requested.
    * @param image     the icon of the proposal.
    */
-  public BuiltInProposal(String template, TemplateContext context, IRegion region, ITextViewer viewer, Image image_builtin) {
-    //         Assert.isNotNull(template);
-    //         Assert.isNotNull(context);
-    //         Assert.isNotNull(region);
-    //         Assert.isNotNull(viewer);
-
-    fTemplate = template;
+  public BuiltInProposal(String functionName, PHPFunction function, TemplateContext context, IRegion region, ITextViewer viewer) {
+    super(viewer);
+    fBuiltinFunctionName = functionName;
+    fFunction = function;
     fContext = context;
-    fViewer = viewer;
-       fImage_builtin= image_builtin;
+    //    fViewer = viewer;
     fRegion = region;
   }
 
@@ -76,8 +67,8 @@ public class BuiltInProposal implements IJavaCompletionProposal {
       int end = fRegion.getOffset() + fRegion.getLength();
 
       // insert template string
-    //  String templateString = fTemplate; // fTemplateBuffer.getString();     
-      document.replace(start, end - start, fTemplate);
+      //  String templateString = fTemplate; // fTemplateBuffer.getString();   
+      document.replace(start, end - start, fBuiltinFunctionName + "()");
 
       // translate positions
       LinkedPositionManager manager = new LinkedPositionManager(document);
@@ -96,8 +87,8 @@ public class BuiltInProposal implements IJavaCompletionProposal {
       //                       }
 
       LinkedPositionUI editor = new LinkedPositionUI(fViewer, manager);
-      editor.setFinalCaretOffset(fTemplate.length()+start);
-   //   editor.setFinalCaretOffset(getCaretOffset(fTemplateBuffer) + start);
+      editor.setFinalCaretOffset(fBuiltinFunctionName.length() + start + 1);
+      //   editor.setFinalCaretOffset(getCaretOffset(fTemplateBuffer) + start);
       editor.enter();
 
       fSelectedRegion = editor.getSelectedRegion();
@@ -112,111 +103,33 @@ public class BuiltInProposal implements IJavaCompletionProposal {
     //     }       
   }
 
-//  private static int getCaretOffset(TemplateBuffer buffer) {
-//    TemplatePosition[] variables = buffer.getVariables();
-//    for (int i = 0; i != variables.length; i++) {
-//      TemplatePosition variable = variables[i];
-//
-//      if (variable.getName().equals(JavaTemplateMessages.getString("GlobalVariables.variable.name.cursor"))) //$NON-NLS-1$
-//        return variable.getOffsets()[0];
-//    }
-//
-//    return buffer.getString().length();
-//  }
-
   /*
-   * @see ICompletionProposal#getSelection(IDocument)
+   * @see ICompletionProposal#getAdditionalProposalInfo()
    */
-  public Point getSelection(IDocument document) {
-    return new Point(fSelectedRegion.getOffset(), fSelectedRegion.getLength());
-    //   return null;
+  public String getAdditionalProposalInfo() {
+    return textToHTML(fFunction.getDescription()); // fTemplateBuffer.getString());
   }
 
   /*
-   * @see ICompletionProposal#getAdditionalProposalInfo()
+   * @see ICompletionProposal#getContextInformation()
    */
-  public String getAdditionalProposalInfo() {
-    //     try {
-    //                 if (fTemplateBuffer == null)
-    //                         fTemplateBuffer= fContext.evaluate(fTemplate);
-
-    return textToHTML(fTemplate); // fTemplateBuffer.getString());
-
-    //     } catch (CoreException e) {
-    //                 handleException(e);                 
-    //                 return null;
-    //     }
+  public IContextInformation getContextInformation() {
+    return null;
   }
 
   /*
    * @see ICompletionProposal#getDisplayString()
    */
   public String getDisplayString() {
-    return fTemplate + TemplateMessages.getString("TemplateProposal.delimiter") + fTemplate; // $NON-NLS-1$ //$NON-NLS-1$
-    //         return fTemplate.getName() + TemplateMessages.getString("TemplateProposal.delimiter") + fTemplate.getDescription(); // $NON-NLS-1$ //$NON-NLS-1$
+    return fBuiltinFunctionName + TemplateMessages.getString("TemplateProposal.delimiter") + fFunction.getUsage(); // $NON-NLS-1$ //$NON-NLS-1$
+    //         return fTemplate.getName() + ObfuscatorMessages.getString("TemplateProposal.delimiter") + fTemplate.getDescription(); // $NON-NLS-1$ //$NON-NLS-1$
   }
 
   /*
    * @see ICompletionProposal#getImage()
    */
   public Image getImage() {
-               return fImage_builtin;
-  }
-
-  /*
-   * @see ICompletionProposal#getContextInformation()
-   */
-  public IContextInformation getContextInformation() {
-    return null;
-  }
-
-  private static String textToHTML(String string) {
-    StringBuffer buffer = new StringBuffer(string.length());
-    buffer.append("<pre>"); //$NON-NLS-1$
-
-    for (int i = 0; i != string.length(); i++) {
-      char ch = string.charAt(i);
-
-      switch (ch) {
-        case '&' :
-          buffer.append("&amp;"); //$NON-NLS-1$
-          break;
-
-        case '<' :
-          buffer.append("&lt;"); //$NON-NLS-1$
-          break;
-
-        case '>' :
-          buffer.append("&gt;"); //$NON-NLS-1$
-          break;
-
-        case '\t' :
-          buffer.append("    "); //$NON-NLS-1$
-          break;
-
-        case '\n' :
-          buffer.append("<br>"); //$NON-NLS-1$
-          break;
-
-        default :
-          buffer.append(ch);
-          break;
-      }
-    }
-
-    buffer.append("</pre>"); //$NON-NLS-1$
-    return buffer.toString();
-  }
-
-  private void openErrorDialog(BadLocationException e) {
-    Shell shell = fViewer.getTextWidget().getShell();
-    MessageDialog.openError(shell, TemplateMessages.getString("TemplateEvaluator.error.title"), e.getMessage()); //$NON-NLS-1$
-  }
-
-  private void handleException(CoreException e) {
-    Shell shell = fViewer.getTextWidget().getShell();
-    PHPeclipsePlugin.log(e);
-    //         ExceptionHandler.handle(e, shell, TemplateMessages.getString("TemplateEvaluator.error.title"), null); //$NON-NLS-1$
+    return PHPUiImages.get(PHPUiImages.IMG_BUILTIN);
   }
 
   /*
@@ -224,8 +137,8 @@ public class BuiltInProposal implements IJavaCompletionProposal {
    */
   public int getRelevance() {
 
-    if (fContext instanceof CompilationUnitContext) {
-      CompilationUnitContext context = (CompilationUnitContext) fContext;
+    if (fContext instanceof PHPUnitContext) {
+      PHPUnitContext context = (PHPUnitContext) fContext;
       switch (context.getCharacterBeforeStart()) {
         // high relevance after whitespace
         case ' ' :