net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/text/template/IdentifierProposal.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 net.sourceforge.phpdt.internal.corext.template.TemplateContext;
   8 import net.sourceforge.phpdt.internal.corext.template.TemplateMessages;
   9 import net.sourceforge.phpdt.internal.corext.template.php.PHPUnitContext;
  10 import net.sourceforge.phpdt.internal.ui.text.link.LinkedPositionManager;
  11 import net.sourceforge.phpdt.internal.ui.text.link.LinkedPositionUI;
  12 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
  13
  14 import org.eclipse.jface.text.BadLocationException;
  15 import org.eclipse.jface.text.IDocument;
  16 import org.eclipse.jface.text.IRegion;
  17 import org.eclipse.jface.text.ITextViewer;
  18 import org.eclipse.jface.text.contentassist.IContextInformation;
  19 import org.eclipse.swt.graphics.Image;
  20 //import org.eclipse.jdt.internal.ui.text.link.LinkedPositionManager;
  21 //import org.eclipse.jdt.internal.ui.text.link.LinkedPositionUI;
  22 //import org.eclipse.jdt.internal.ui.util.ExceptionHandler;
  23
  24 /**
  25  * A PHP identifier proposal.
  26  */
  27 public class IdentifierProposal extends AbstractProposal { //implements IPHPCompletionProposal {
  28   private final TemplateContext fContext;
  29   private final Image fImage_fun;
  30   private final Image fImage_var;
  31
  32   //private TemplateBuffer fTemplateBuffer;
  33   private String fOldText;
  34   private final IRegion fRegion;
  35 //  private IRegion fSelectedRegion; // initialized by apply()
  36
  37   private final String fTemplate;
  38 //  private final ITextViewer fViewer;
  39
  40   /**
  41    * Creates a template proposal with a template and its context.
  42    * @param template  the template
  43    * @param context   the context in which the template was requested.
  44    * @param image     the icon of the proposal.
  45    */
  46   public IdentifierProposal(String template, TemplateContext context, IRegion region, ITextViewer viewer, Image image_fun, Image image_var) {
  47     super(viewer);
  48
  49     fTemplate = template;
  50     fContext = context;
  51 //    fViewer = viewer;
  52         fImage_fun= image_fun;
  53     fImage_var= image_var;
  54     fRegion = region;
  55   }
  56
  57
  58   /*
  59    * @see ICompletionProposal#apply(IDocument)
  60    */
  61   public void apply(IDocument document) {
  62     try {
  63       //                    if (fTemplateBuffer == null)
  64       //                                fTemplateBuffer= fContext.evaluate(fTemplate);
  65
  66       int start = fRegion.getOffset();
  67       int end = fRegion.getOffset() + fRegion.getLength();
  68
  69       // insert template string
  70     //  String templateString = fTemplate; // fTemplateBuffer.getString();
  71       document.replace(start, end - start, fTemplate);
  72
  73       // translate positions
  74       LinkedPositionManager manager = new LinkedPositionManager(document);
  75       //                        TemplatePosition[] variables= fTemplateBuffer.getVariables();
  76       //                        for (int i= 0; i != variables.length; i++) {
  77       //                                TemplatePosition variable= variables[i];
  78       //
  79       //                                if (variable.isResolved())
  80       //                                        continue;
  81       //
  82       //                                int[] offsets= variable.getOffsets();
  83       //                                int length= variable.getLength();
  84       //
  85       //                                for (int j= 0; j != offsets.length; j++)
  86       //                                        manager.addPosition(offsets[j] + start, length);
  87       //                        }
  88
  89       LinkedPositionUI editor = new LinkedPositionUI(fViewer, manager);
  90       editor.setFinalCaretOffset(fTemplate.length()+start);
  91    //   editor.setFinalCaretOffset(getCaretOffset(fTemplateBuffer) + start);
  92       editor.enter();
  93
  94       fSelectedRegion = editor.getSelectedRegion();
  95
  96     } catch (BadLocationException e) {
  97       PHPeclipsePlugin.log(e);
  98       openErrorDialog(e);
  99
 100     }
 101     //      catch (CoreException e) {
 102     //                  handleException(e);
 103     //      }
 104   }
 105
 106   /*
 107    * @see ICompletionProposal#getAdditionalProposalInfo()
 108    */
 109   public String getAdditionalProposalInfo() {
 110     //      try {
 111     //                  if (fTemplateBuffer == null)
 112     //                          fTemplateBuffer= fContext.evaluate(fTemplate);
 113
 114     return textToHTML(fTemplate); // fTemplateBuffer.getString());
 115
 116     //      } catch (CoreException e) {
 117     //                  handleException(e);
 118     //                  return null;
 119     //      }
 120   }
 121
 122   /*
 123    * @see ICompletionProposal#getContextInformation()
 124    */
 125   public IContextInformation getContextInformation() {
 126     return null;
 127   }
 128
 129   /*
 130    * @see ICompletionProposal#getDisplayString()
 131    */
 132   public String getDisplayString() {
 133     return fTemplate + TemplateMessages.getString("TemplateProposal.delimiter") + fTemplate; // $NON-NLS-1$ //$NON-NLS-1$
 134     //          return fTemplate.getName() + ObfuscatorMessages.getString("TemplateProposal.delimiter") + fTemplate.getDescription(); // $NON-NLS-1$ //$NON-NLS-1$
 135   }
 136
 137   /*
 138    * @see ICompletionProposal#getImage()
 139    */
 140   public Image getImage() {
 141     if (fTemplate.charAt(0)=='$') {
 142       return fImage_var;
 143     }
 144                 return fImage_fun;
 145   }
 146
 147   /*
 148    * @see IJavaCompletionProposal#getRelevance()
 149    */
 150   public int getRelevance() {
 151
 152     if (fContext instanceof PHPUnitContext) {
 153       PHPUnitContext context = (PHPUnitContext) fContext;
 154       switch (context.getCharacterBeforeStart()) {
 155         // high relevance after whitespace
 156         case ' ' :
 157         case '\r' :
 158         case '\n' :
 159         case '\t' :
 160           return 90;
 161
 162         default :
 163           return 0;
 164       }
 165     } else {
 166       return 90;
 167     }
 168   }
 169
 170 }