Fix Request #1431769: Support Context assistance when entering functions arguments
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / text / template / BuiltInProposal.java
index 1ff6be7..daafd3d 100644 (file)
  */
 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.JavaContext;
+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.ContextInformation;
 import org.eclipse.jface.text.contentassist.IContextInformation;
+import org.eclipse.jface.text.templates.TemplateContext;
 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;
+
+// import net.sourceforge.phpdt.internal.ui.text.link.LinkedPositionManager;
+// import net.sourceforge.phpdt.internal.ui.text.link.LinkedPositionUI;
+// import net.sourceforge.phpdt.internal.ui.util.ExceptionHandler;
 
 /**
  * A PHP identifier proposal.
  */
-public class BuiltInProposal implements IJavaCompletionProposal {
-
-  private final String fTemplate;
-  private final TemplateContext fContext;
-  private final ITextViewer fViewer;
-  private final Image fImage_builtin;
-
-  private final IRegion fRegion;
-
-  //private TemplateBuffer fTemplateBuffer;
-  private String fOldText;
-  private IRegion fSelectedRegion; // initialized by apply()
-
-  /**
-   * Creates a template proposal with a template and its context.
-   * @param template  the template
-   * @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;
-    fContext = context;
-    fViewer = viewer;
-       fImage_builtin= image_builtin;
-    fRegion = region;
-  }
-
-  /*
-   * @see ICompletionProposal#apply(IDocument)
-   */
-  public void apply(IDocument document) {
-    try {
-      //                   if (fTemplateBuffer == null)
-      //                               fTemplateBuffer= fContext.evaluate(fTemplate);
-
-      int start = fRegion.getOffset();
-      int end = fRegion.getOffset() + fRegion.getLength();
-
-      // insert template string
-    //  String templateString = fTemplate; // fTemplateBuffer.getString();     
-      document.replace(start, end - start, fTemplate);
-
-      // translate positions
-      LinkedPositionManager manager = new LinkedPositionManager(document);
-      //                       TemplatePosition[] variables= fTemplateBuffer.getVariables();
-      //                       for (int i= 0; i != variables.length; i++) {
-      //                               TemplatePosition variable= variables[i];
-      //
-      //                               if (variable.isResolved())
-      //                                       continue;
-      //                               
-      //                               int[] offsets= variable.getOffsets();
-      //                               int length= variable.getLength();
-      //                               
-      //                               for (int j= 0; j != offsets.length; j++)
-      //                                       manager.addPosition(offsets[j] + start, length);
-      //                       }
-
-      LinkedPositionUI editor = new LinkedPositionUI(fViewer, manager);
-      editor.setFinalCaretOffset(fTemplate.length()+start);
-   //   editor.setFinalCaretOffset(getCaretOffset(fTemplateBuffer) + start);
-      editor.enter();
-
-      fSelectedRegion = editor.getSelectedRegion();
-
-    } catch (BadLocationException e) {
-      PHPeclipsePlugin.log(e);
-      openErrorDialog(e);
-
-    }
-    //      catch (CoreException e) {
-    //                 handleException(e);
-    //     }       
-  }
-
-//  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)
-   */
-  public Point getSelection(IDocument document) {
-    return new Point(fSelectedRegion.getOffset(), fSelectedRegion.getLength());
-    //   return null;
-  }
-
-  /*
-   * @see ICompletionProposal#getAdditionalProposalInfo()
-   */
-  public String getAdditionalProposalInfo() {
-    //     try {
-    //                 if (fTemplateBuffer == null)
-    //                         fTemplateBuffer= fContext.evaluate(fTemplate);
-
-    return textToHTML(fTemplate); // fTemplateBuffer.getString());
-
-    //     } catch (CoreException e) {
-    //                 handleException(e);                 
-    //                 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$
-  }
-
-  /*
-   * @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$
-  }
-
-  /*
-   * @see IJavaCompletionProposal#getRelevance()
-   */
-  public int getRelevance() {
-
-    if (fContext instanceof CompilationUnitContext) {
-      CompilationUnitContext context = (CompilationUnitContext) fContext;
-      switch (context.getCharacterBeforeStart()) {
-        // high relevance after whitespace
-        case ' ' :
-        case '\r' :
-        case '\n' :
-        case '\t' :
-          return 90;
-
-        default :
-          return 0;
-      }
-    } else {
-      return 90;
-    }
-  }
+public class BuiltInProposal extends AbstractProposal {
+       private final TemplateContext fContext;
+
+       private final PHPFunction fFunction;
+
+       private final IRegion fRegion;
+
+       private final String fBuiltinFunctionName;
+
+       /**
+        * Creates a template proposal with a template and its context.
+        *
+        * @param template
+        *          the template
+        * @param context
+        *          the context in which the template was requested.
+        * @param image
+        *          the icon of the proposal.
+        */
+       public BuiltInProposal(String functionName, PHPFunction function, TemplateContext context, IRegion region, ITextViewer viewer) {
+               super(viewer);
+               fBuiltinFunctionName = functionName;
+               fFunction = function;
+               fContext = context;
+               // fViewer = viewer;
+               fRegion = region;
+       }
+
+       /*
+        * @see ICompletionProposal#apply(IDocument)
+        */
+       public void apply(IDocument document) {
+               try {
+                       // if (fTemplateBuffer == null)
+                       // fTemplateBuffer= fContext.evaluate(fTemplate);
+
+                       int start = fRegion.getOffset();
+                       int end = fRegion.getOffset() + fRegion.getLength();
+
+                       // insert template string
+                       // String templateString = fTemplate; // fTemplateBuffer.getString();
+                       document.replace(start, end - start, fBuiltinFunctionName + "()");
+
+                       // translate positions
+                       LinkedPositionManager manager = new LinkedPositionManager(document);
+                       // TemplatePosition[] variables= fTemplateBuffer.getVariables();
+                       // for (int i= 0; i != variables.length; i++) {
+                       // TemplatePosition variable= variables[i];
+                       //
+                       // if (variable.isResolved())
+                       // continue;
+                       //
+                       // int[] offsets= variable.getOffsets();
+                       // int length= variable.getLength();
+                       //
+                       // for (int j= 0; j != offsets.length; j++)
+                       // manager.addPosition(offsets[j] + start, length);
+                       // }
+
+                       LinkedPositionUI editor = new LinkedPositionUI(fViewer, manager);
+                       editor.setFinalCaretOffset(fBuiltinFunctionName.length() + start + 1);
+                       // editor.setFinalCaretOffset(getCaretOffset(fTemplateBuffer) + start);
+                       editor.enter();
+
+                       fSelectedRegion = editor.getSelectedRegion();
+
+               } catch (BadLocationException e) {
+                       PHPeclipsePlugin.log(e);
+                       openErrorDialog(e);
+
+               }
+               // catch (CoreException e) {
+               // handleException(e);
+               // }
+       }
+
+       /*
+        * @see ICompletionProposal#getAdditionalProposalInfo()
+        */
+       public String getAdditionalProposalInfo() {
+               return fFunction.getHoverText();
+       }
+
+       public IContextInformation getContextInformation() {
+               if (fContextInfo == null) {
+                       String contextInfoString = fFunction.getHoverText();
+                       if (contextInfoString != null && contextInfoString.length() > 0) {
+                               // extract the parameter context information for the function:
+                               int i0 = contextInfoString.indexOf('(');
+                               if (i0 >= 0) {
+                                       int i1 = contextInfoString.indexOf(')', i0 + 1);
+                                       if (i1 > 0) {
+                                               fContextInfo = new ContextInformation(null, contextInfoString.substring(i0, i1+1));
+                                       } else {
+                                               fContextInfo = new ContextInformation(null, contextInfoString);
+                                       }
+                               } else {
+                                       fContextInfo = new ContextInformation(null, contextInfoString);
+                               }
+                       }
+               }
+               return fContextInfo;
+       }
+
+       /*
+        * @see ICompletionProposal#getDisplayString()
+        */
+       public String getDisplayString() {
+               return fBuiltinFunctionName + TemplateMessages.getString("TemplateProposal.delimiter") + fFunction.getUsage(); // $NON-NLS-1$
+               // //$NON-NLS-1$
+       }
+
+       /*
+        * @see ICompletionProposal#getImage()
+        */
+       public Image getImage() {
+               return PHPUiImages.get(PHPUiImages.IMG_BUILTIN);
+       }
+
+       /*
+        * @see IJavaCompletionProposal#getRelevance()
+        */
+       public int getRelevance() {
+
+               if (fContext instanceof JavaContext) {
+                       JavaContext context = (JavaContext) fContext;
+                       switch (context.getCharacterBeforeStart()) {
+                       // high relevance after whitespace
+                       case ' ':
+                       case '\r':
+                       case '\n':
+                       case '\t':
+                               return 50;
+
+                       default:
+                               return 0;
+                       }
+               } else {
+                       return 50;
+               }
+       }
 
 }
\ No newline at end of file