net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/php/PHPCompletionProcessor.java

   1 /**********************************************************************
   2  Copyright (c) 2000, 2002 IBM Corp. and others.
   3  All rights reserved. This program and the accompanying materials
   4  are made available under the terms of the Common Public License v1.0
   5  which accompanies this distribution, and is available at
   6  http://www.eclipse.org/legal/cpl-v10.html
   7
   8  Contributors:
   9  IBM Corporation - Initial implementation
  10  **********************************************************************/
  11 package net.sourceforge.phpeclipse.phpeditor.php;
  12
  13 import java.io.IOException;
  14 import java.sql.ResultSet;
  15 import java.util.ArrayList;
  16 import java.util.Arrays;
  17 import java.util.HashMap;
  18 import java.util.HashSet;
  19 import java.util.Iterator;
  20 import java.util.List;
  21 import java.util.Set;
  22 import java.util.SortedMap;
  23
  24 import net.sourceforge.phpdt.core.ICompilationUnit;
  25 import net.sourceforge.phpdt.core.IJavaElement;
  26 import net.sourceforge.phpdt.core.IMethod;
  27 import net.sourceforge.phpdt.core.IType;
  28 import net.sourceforge.phpdt.core.JavaCore;
  29 import net.sourceforge.phpdt.core.ToolFactory;
  30 import net.sourceforge.phpdt.core.compiler.ITerminalSymbols;
  31 import net.sourceforge.phpdt.core.compiler.InvalidInputException;
  32 import net.sourceforge.phpdt.internal.compiler.DefaultErrorHandlingPolicies;
  33 import net.sourceforge.phpdt.internal.compiler.impl.CompilerOptions;
  34 import net.sourceforge.phpdt.internal.compiler.parser.Scanner;
  35 import net.sourceforge.phpdt.internal.compiler.parser.SyntaxError;
  36 import net.sourceforge.phpdt.internal.compiler.parser.UnitParser;
  37 import net.sourceforge.phpdt.internal.compiler.parser.VariableInfo;
  38 import net.sourceforge.phpdt.internal.compiler.problem.DefaultProblemFactory;
  39 import net.sourceforge.phpdt.internal.compiler.problem.ProblemReporter;
  40 import net.sourceforge.phpdt.internal.corext.template.php.JavaContext;
  41 import net.sourceforge.phpdt.internal.corext.template.php.JavaContextType;
  42 import net.sourceforge.phpdt.internal.ui.PHPUiImages;
  43 import net.sourceforge.phpdt.internal.ui.text.PHPCodeReader;
  44 import net.sourceforge.phpdt.internal.ui.text.java.IPHPCompletionProposal;
  45 import net.sourceforge.phpdt.internal.ui.text.java.PHPCompletionProposalComparator;
  46 import net.sourceforge.phpdt.internal.ui.text.template.BuiltInEngine;
  47 import net.sourceforge.phpdt.internal.ui.text.template.DeclarationEngine;
  48 import net.sourceforge.phpdt.internal.ui.text.template.LocalVariableProposal;
  49 import net.sourceforge.phpdt.internal.ui.text.template.SQLProposal;
  50 import net.sourceforge.phpdt.internal.ui.text.template.contentassist.TemplateEngine;
  51 import net.sourceforge.phpdt.ui.IWorkingCopyManager;
  52 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
  53 import net.sourceforge.phpeclipse.builder.IdentifierIndexManager;
  54 import net.sourceforge.phpeclipse.internal.compiler.ast.CompilationUnitDeclaration;
  55 import net.sourceforge.phpeclipse.phpeditor.PHPEditor;
  56 import net.sourceforge.phpeclipse.phpeditor.PHPSyntaxRdr;
  57 import net.sourceforge.phpeclipse.ui.IPreferenceConstants;
  58 import net.sourceforge.phpeclipse.ui.overlaypages.ProjectPrefUtil;
  59
  60 import org.eclipse.core.resources.IFile;
  61 import org.eclipse.core.resources.IProject;
  62 import org.eclipse.jface.text.BadLocationException;
  63 import org.eclipse.jface.text.IDocument;
  64 import org.eclipse.jface.text.IRegion;
  65 import org.eclipse.jface.text.ITextViewer;
  66 import org.eclipse.jface.text.Region;
  67 import org.eclipse.jface.text.TextPresentation;
  68 import org.eclipse.jface.text.contentassist.ICompletionProposal;
  69 import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
  70 import org.eclipse.jface.text.contentassist.IContextInformation;
  71 import org.eclipse.jface.text.contentassist.IContextInformationExtension;
  72 import org.eclipse.jface.text.contentassist.IContextInformationPresenter;
  73 import org.eclipse.jface.text.contentassist.IContextInformationValidator;
  74 import org.eclipse.jface.text.templates.DocumentTemplateContext;
  75 import org.eclipse.jface.text.templates.TemplateContextType;
  76 import org.eclipse.swt.graphics.Image;
  77 import org.eclipse.swt.graphics.Point;
  78 import org.eclipse.ui.IEditorPart;
  79 import org.eclipse.ui.IFileEditorInput;
  80
  81 import com.quantum.ExternalInterface;
  82 import com.quantum.util.connection.NotConnectedException;
  83
  84 /**
  85  * Example PHP completion processor.
  86  */
  87 public class PHPCompletionProcessor implements IContentAssistProcessor {
  88   /**
  89    * Simple content assist tip closer. The tip is valid in a range of 5 characters around its popup location.
  90    */
  91   protected static class Validator implements IContextInformationValidator, IContextInformationPresenter {
  92     protected int fInstallOffset;
  93
  94     /*
  95      * @see IContextInformationValidator#isContextInformationValid(int)
  96      */
  97     public boolean isContextInformationValid(int offset) {
  98       return Math.abs(fInstallOffset - offset) < 5;
  99     }
 100
 101     /*
 102      * @see IContextInformationValidator#install(IContextInformation, ITextViewer, int)
 103      */
 104     public void install(IContextInformation info, ITextViewer viewer, int offset) {
 105       fInstallOffset = offset;
 106     }
 107
 108     /*
 109      * @see org.eclipse.jface.text.contentassist.IContextInformationPresenter#updatePresentation(int, TextPresentation)
 110      */
 111     public boolean updatePresentation(int documentPosition, TextPresentation presentation) {
 112       return false;
 113     }
 114   };
 115
 116   private static class ContextInformationWrapper implements IContextInformation, IContextInformationExtension {
 117     private final IContextInformation fContextInformation;
 118
 119     private int fPosition;
 120
 121     public ContextInformationWrapper(IContextInformation contextInformation) {
 122       fContextInformation = contextInformation;
 123     }
 124
 125     /*
 126      * @see IContextInformation#getContextDisplayString()
 127      */
 128     public String getContextDisplayString() {
 129       return fContextInformation.getContextDisplayString();
 130     }
 131
 132     /*
 133      * @see IContextInformation#getImage()
 134      */
 135     public Image getImage() {
 136       return fContextInformation.getImage();
 137     }
 138
 139     /*
 140      * @see IContextInformation#getInformationDisplayString()
 141      */
 142     public String getInformationDisplayString() {
 143       return fContextInformation.getInformationDisplayString();
 144     }
 145
 146     /*
 147      * @see IContextInformationExtension#getContextInformationPosition()
 148      */
 149     public int getContextInformationPosition() {
 150       return fPosition;
 151     }
 152
 153     public void setContextInformationPosition(int position) {
 154       fPosition = position;
 155     }
 156   };
 157
 158   private class TableName {
 159     String fTableName;
 160
 161     TableName() {
 162       fTableName = null;
 163     }
 164
 165     /**
 166      * @return Returns the tableName.
 167      */
 168     public String getTableName() {
 169       if (fTableName == null) {
 170         return "<!--no-table-->";
 171       }
 172       return fTableName;
 173     }
 174
 175     /**
 176      * @param tableName
 177      *          The tableName to set.
 178      */
 179     public void setTableName(String tableName) {
 180       fTableName = tableName;
 181     }
 182   }
 183
 184   private char[] fProposalAutoActivationSet;
 185
 186   protected IContextInformationValidator fValidator = new Validator();
 187
 188   private TemplateEngine fTemplateEngine;
 189
 190   private PHPCompletionProposalComparator fComparator;
 191
 192   private int fNumberOfComputedResults = 0;
 193
 194   private IEditorPart fEditor;
 195
 196   protected IWorkingCopyManager fManager;
 197
 198   public PHPCompletionProcessor(IEditorPart editor) {
 199     fEditor = editor;
 200     fManager = PHPeclipsePlugin.getDefault().getWorkingCopyManager();
 201     TemplateContextType contextType = PHPeclipsePlugin.getDefault().getTemplateContextRegistry().getContextType("php"); //$NON-NLS-1$
 202     if (contextType != null)
 203       fTemplateEngine = new TemplateEngine(contextType);
 204     fComparator = new PHPCompletionProposalComparator();
 205   }
 206
 207   /**
 208    * Tells this processor to order the proposals alphabetically.
 209    *
 210    * @param order
 211    *          <code>true</code> if proposals should be ordered.
 212    */
 213   public void orderProposalsAlphabetically(boolean order) {
 214     fComparator.setOrderAlphabetically(order);
 215   }
 216
 217   /**
 218    * Sets this processor's set of characters triggering the activation of the completion proposal computation.
 219    *
 220    * @param activationSet
 221    *          the activation set
 222    */
 223   public void setCompletionProposalAutoActivationCharacters(char[] activationSet) {
 224     fProposalAutoActivationSet = activationSet;
 225   }
 226
 227   /*
 228    * (non-Javadoc) Method declared on IContentAssistProcessor
 229    */
 230   public ICompletionProposal[] computeCompletionProposals(ITextViewer viewer, int documentOffset) {
 231     int contextInformationPosition = guessContextInformationPosition(viewer, documentOffset);
 232     return internalComputeCompletionProposals(viewer, documentOffset, contextInformationPosition);
 233   }
 234
 235   private int getLastToken(List list, ITextViewer viewer, int completionPosition, JavaContext context, TableName tableName) {
 236     IDocument document = viewer.getDocument();
 237     int start = context.getStart();
 238     int end = context.getEnd();
 239     String startText;
 240     int lastSignificantToken = ITerminalSymbols.TokenNameEOF;
 241     try {
 242       // begin search 2 lines behind of this
 243       int j = start;
 244       if (j != 0) {
 245         char ch;
 246         while (j-- > 0) {
 247           ch = document.getChar(j);
 248           if (ch == '\n') {
 249             break;
 250           }
 251         }
 252         while (j-- > 0) {
 253           ch = document.getChar(j);
 254           if (ch == '\n') {
 255             break;
 256           }
 257         }
 258       }
 259       if (j != start) {
 260         // scan the line for the dereferencing operator '->'
 261         startText = document.get(j, start - j);
 262         if (Scanner.DEBUG) {
 263           System.out.println(startText);
 264         }
 265         int token = ITerminalSymbols.TokenNameEOF;
 266         //        token = getLastSQLToken(startText);
 267         tableName.setTableName(getLastSQLTableName(startText));
 268         Scanner scanner = ToolFactory.createScanner(false, false, false);
 269         scanner.setSource(startText.toCharArray());
 270         scanner.setPHPMode(true);
 271         int beforeLastToken = ITerminalSymbols.TokenNameEOF;
 272         int lastToken = ITerminalSymbols.TokenNameEOF;
 273         char[] ident = null;
 274         try {
 275           token = scanner.getNextToken();
 276           lastToken = token;
 277           while (token != ITerminalSymbols.TokenNameERROR && token != ITerminalSymbols.TokenNameEOF) {
 278             beforeLastToken = lastToken;
 279             if (token == ITerminalSymbols.TokenNameVariable) {
 280               ident = scanner.getCurrentTokenSource();
 281               if (ident.length == 5 && ident[0] == '$' && ident[1] == 't' && ident[2] == 'h' && ident[3] == 'i' && ident[4] == 's') {
 282                 token = ITerminalSymbols.TokenNamethis_PHP_COMPLETION;
 283               }
 284             }
 285             lastToken = token;
 286             // System.out.println(scanner.toStringAction(lastToken));
 287             token = scanner.getNextToken();
 288           }
 289         } catch (InvalidInputException e1) {
 290         } catch (SyntaxError e) {
 291         }
 292         switch (lastToken) {
 293         case ITerminalSymbols.TokenNameMINUS_GREATER:
 294           // dereferencing operator '->' found
 295           lastSignificantToken = ITerminalSymbols.TokenNameMINUS_GREATER;
 296           if (beforeLastToken == ITerminalSymbols.TokenNameVariable) {
 297             lastSignificantToken = ITerminalSymbols.TokenNameVariable;
 298             list.set(0, ident);
 299           } else if (beforeLastToken == ITerminalSymbols.TokenNamethis_PHP_COMPLETION) {
 300             lastSignificantToken = ITerminalSymbols.TokenNamethis_PHP_COMPLETION;
 301             list.set(0, ident);
 302           }
 303           break;
 304         case ITerminalSymbols.TokenNamenew:
 305           lastSignificantToken = ITerminalSymbols.TokenNamenew;
 306           break;
 307         }
 308       }
 309     } catch (BadLocationException e) {
 310     }
 311     return lastSignificantToken;
 312   }
 313
 314   String getSQLTableName(String sqlText, int start) {
 315     int tableNameStart = -1;
 316     int currentCharacterPosition = start + 1;
 317     char ch;
 318     try {
 319       while (true) {
 320         ch = sqlText.charAt(currentCharacterPosition++);
 321         if (tableNameStart == -1 && Scanner.isPHPIdentifierStart(ch)) {
 322           tableNameStart = currentCharacterPosition - 1;
 323         } else {
 324           if (!Scanner.isPHPIdentifierPart(ch)) {
 325             return sqlText.substring(tableNameStart, currentCharacterPosition - 1);
 326           }
 327         }
 328       }
 329     } catch (IndexOutOfBoundsException e) {
 330       if (tableNameStart >= 0) {
 331         return sqlText.substring(tableNameStart, currentCharacterPosition - 1);
 332       }
 333     }
 334     return "";
 335   }
 336
 337   private String getLastSQLTableName(String startText) {
 338     int token;
 339     // scan for sql identifiers
 340     char ch = ' ';
 341     int currentSQLPosition = startText.length();
 342     int identEnd = -1;
 343     String ident = null;
 344     boolean whiteSpace = true;
 345     try {
 346       while (true) {
 347         ch = startText.charAt(--currentSQLPosition);
 348         if (ch >= 'A' && ch <= 'Z') {
 349           if (identEnd < 0) {
 350             identEnd = currentSQLPosition + 1;
 351           }
 352         } else if (ch >= 'a' && ch <= 'z') {
 353           if (identEnd < 0) {
 354             identEnd = currentSQLPosition + 1;
 355           }
 356         } else if (identEnd >= 0) {
 357           ident = startText.substring(currentSQLPosition + 1, identEnd);
 358           // select -- from -- where --
 359           // update -- set -- where --
 360           // insert into -- ( -- ) values ( -- )
 361           if (ident.length() >= 4 && ident.length() <= 6) {
 362             ident = ident.toLowerCase();
 363             switch (ident.length()) {
 364             //              case 3 :
 365             //                if (ident.equals("set")) {
 366             //                  // System.out.println("set");
 367             //                  token = ITerminalSymbols.TokenNameSQLset;
 368             //                  return token;
 369             //                }
 370             //                break;
 371             case 4:
 372               if (ident.equals("from")) {
 373                 //                  System.out.println("from");
 374                 token = ITerminalSymbols.TokenNameSQLfrom;
 375                 return getSQLTableName(startText, identEnd);
 376               } else if (ident.equals("into")) {
 377                 //                System.out.println("into");
 378                 token = ITerminalSymbols.TokenNameSQLinto;
 379                 return getSQLTableName(startText, identEnd);
 380               }
 381               break;
 382             //              case 5 :
 383             //                if (ident.equals("where")) {
 384             //                  // System.out.println("where");
 385             //                  token = ITerminalSymbols.TokenNameSQLwhere;
 386             //                  return token;
 387             //                }
 388             //                break;
 389             case 6:
 390               //                if (ident.equals("select")) {
 391               //                  // System.out.println("select");
 392               //                  token = ITerminalSymbols.TokenNameSQLselect;
 393               //                  return token;
 394               //                } else if (ident.equals("insert")) {
 395               //                  // System.out.println("insert");
 396               //                  token = ITerminalSymbols.TokenNameSQLinsert;
 397               //                  return token;
 398               //                } else
 399               if (ident.equals("update")) {
 400                 //                  System.out.println("update");
 401                 token = ITerminalSymbols.TokenNameSQLupdate;
 402                 return getSQLTableName(startText, identEnd);
 403               }
 404               //                else if (ident.equals("values")) {
 405               //                  // System.out.println("values");
 406               //                  token = ITerminalSymbols.TokenNameSQLvalues;
 407               //                  return token;
 408               //                }
 409               break;
 410             }
 411           }
 412           whiteSpace = false;
 413           identEnd = -1;
 414         } else if (Character.isWhitespace(ch)) {
 415         } else {
 416           whiteSpace = false;
 417         }
 418       }
 419     } catch (IndexOutOfBoundsException e) {
 420     }
 421     return "<!--no-table-->";
 422   }
 423
 424   /**
 425    * Detect the last significant SQL token in the text before the completion
 426    *
 427    * @param startText
 428    */
 429   private int getLastSQLToken(String startText) {
 430     int token;
 431     // scan for sql identifiers
 432     char ch = ' ';
 433     int currentSQLPosition = startText.length();
 434     int identEnd = -1;
 435     String ident = null;
 436     boolean whiteSpace = true;
 437     try {
 438       while (true) {
 439         ch = startText.charAt(--currentSQLPosition);
 440         if (ch >= 'A' && ch <= 'Z') {
 441           if (identEnd < 0) {
 442             identEnd = currentSQLPosition + 1;
 443           }
 444         } else if (ch >= 'a' && ch <= 'z') {
 445           if (identEnd < 0) {
 446             identEnd = currentSQLPosition + 1;
 447           }
 448         } else if (identEnd >= 0) {
 449           ident = startText.substring(currentSQLPosition + 1, identEnd);
 450           // select -- from -- where --
 451           // update -- set -- where --
 452           // insert into -- ( -- ) values ( -- )
 453           if (ident.length() >= 3 && ident.length() <= 6) {
 454             ident = ident.toLowerCase();
 455             switch (ident.length()) {
 456             case 3:
 457               if (ident.equals("set")) {
 458                 //                  System.out.println("set");
 459                 token = ITerminalSymbols.TokenNameSQLset;
 460                 return token;
 461               }
 462               break;
 463             case 4:
 464               if (ident.equals("from")) {
 465                 //                  System.out.println("from");
 466                 token = ITerminalSymbols.TokenNameSQLfrom;
 467                 //getSQLTableName();
 468                 return token;
 469               } else if (ident.equals("into")) {
 470                 //                System.out.println("into");
 471                 token = ITerminalSymbols.TokenNameSQLinto;
 472                 return token;
 473               }
 474               break;
 475             case 5:
 476               if (ident.equals("where")) {
 477                 //                  System.out.println("where");
 478                 token = ITerminalSymbols.TokenNameSQLwhere;
 479                 return token;
 480               }
 481               break;
 482             case 6:
 483               if (ident.equals("select")) {
 484                 //                  System.out.println("select");
 485                 token = ITerminalSymbols.TokenNameSQLselect;
 486                 return token;
 487               } else if (ident.equals("insert")) {
 488                 //                  System.out.println("insert");
 489                 token = ITerminalSymbols.TokenNameSQLinsert;
 490                 return token;
 491               } else if (ident.equals("update")) {
 492                 //                  System.out.println("update");
 493                 token = ITerminalSymbols.TokenNameSQLupdate;
 494                 return token;
 495               } else if (ident.equals("values")) {
 496                 //                System.out.println("values");
 497                 token = ITerminalSymbols.TokenNameSQLvalues;
 498                 return token;
 499               }
 500               break;
 501             }
 502           }
 503           whiteSpace = false;
 504           identEnd = -1;
 505         } else if (Character.isWhitespace(ch)) {
 506         } else {
 507           whiteSpace = false;
 508         }
 509       }
 510     } catch (IndexOutOfBoundsException e) {
 511     }
 512     return ITerminalSymbols.TokenNameEOF;
 513   }
 514
 515   private ICompletionProposal[] internalComputeCompletionProposals(ITextViewer viewer, int offset, int contextOffset) {
 516     ICompilationUnit unit = fManager.getWorkingCopy(fEditor.getEditorInput());
 517     IDocument document = viewer.getDocument();
 518     IFile file = null;
 519     IProject project = null;
 520     if (offset > 0) {
 521       PHPEditor editor = null;
 522       if (fEditor != null && (fEditor instanceof PHPEditor)) {
 523         editor = (PHPEditor) fEditor;
 524         file = ((IFileEditorInput) editor.getEditorInput()).getFile();
 525         project = file.getProject();
 526       }
 527     }
 528
 529     Point selection = viewer.getSelectedRange();
 530     // remember selected text
 531     String selectedText = null;
 532     if (selection.y != 0) {
 533       try {
 534         selectedText = document.get(selection.x, selection.y);
 535       } catch (BadLocationException e) {
 536       }
 537     }
 538
 539     JavaContextType phpContextType = (JavaContextType) PHPeclipsePlugin.getDefault().getTemplateContextRegistry().getContextType(
 540         "php"); //$NON-NLS-1$
 541     JavaContext context = (JavaContext) phpContextType.createContext(document, offset, selection.y, unit);
 542     context.setVariable("selection", selectedText); //$NON-NLS-1$
 543     String prefix = context.getKey();
 544
 545     HashMap methodVariables = null;
 546     HashMap typeVariables = null;
 547     HashMap unitVariables = null;
 548     ICompilationUnit compilationUnit = (ICompilationUnit) context.findEnclosingElement(IJavaElement.COMPILATION_UNIT);
 549     //    if (compilationUnit != null) {
 550     //      unitVariables = ((CompilationUnit) compilationUnit).variables;
 551     //    }
 552     IType type = (IType) context.findEnclosingElement(IJavaElement.TYPE);
 553     //    if (type != null) {
 554     //      typeVariables = ((SourceType) type).variables;
 555     //    }
 556     IMethod method = (IMethod) context.findEnclosingElement(IJavaElement.METHOD);
 557     //    if (method != null) {
 558     //      methodVariables = ((SourceMethod) method).variables;
 559     //    }
 560
 561     boolean emptyPrefix = prefix == null || prefix.equals("");
 562     IPHPCompletionProposal[] localVariableResults = new IPHPCompletionProposal[0];
 563
 564     if (!emptyPrefix && prefix.length() >= 1 && prefix.charAt(0) == '$') { // php Variable ?
 565       String lowerCasePrefix = prefix.toLowerCase();
 566       HashSet localVariables = new HashSet();
 567       if (compilationUnit != null) {
 568         unitVariables = getUnitVariables(unitVariables, compilationUnit);
 569         getVariableProposals(localVariables, viewer, project, context, unitVariables, lowerCasePrefix, 94);
 570       }
 571       if (method != null) {
 572         methodVariables = getMethodVariables(methodVariables, method);
 573         getVariableProposals(localVariables, viewer, project, context, methodVariables, lowerCasePrefix, 99);
 574       }
 575       if (!localVariables.isEmpty()) {
 576         localVariableResults = (IPHPCompletionProposal[]) localVariables.toArray(new IPHPCompletionProposal[localVariables.size()]);
 577       }
 578     }
 579
 580     TableName sqlTable = new TableName();
 581     ArrayList list = new ArrayList();
 582     list.add(null);
 583     int lastSignificantToken = getLastToken(list, viewer, offset, context, sqlTable);
 584     boolean useClassMembers = (lastSignificantToken == ITerminalSymbols.TokenNameMINUS_GREATER)
 585         || (lastSignificantToken == ITerminalSymbols.TokenNameVariable) || (lastSignificantToken == ITerminalSymbols.TokenNamenew)
 586         || (lastSignificantToken == ITerminalSymbols.TokenNamethis_PHP_COMPLETION);
 587
 588     if (fTemplateEngine != null) {
 589       IPHPCompletionProposal[] templateResults = new IPHPCompletionProposal[0];
 590       ICompletionProposal[] results;
 591       if (!emptyPrefix) {
 592         fTemplateEngine.reset();
 593         fTemplateEngine.complete(viewer, offset, unit);
 594         templateResults = fTemplateEngine.getResults();
 595       }
 596       // TODO delete this
 597       IPHPCompletionProposal[] identifierResults = new IPHPCompletionProposal[0];
 598
 599       // declarations stored in file project.index on project level
 600       IPHPCompletionProposal[] declarationResults = new IPHPCompletionProposal[0];
 601       if (project != null) {
 602         DeclarationEngine declarationEngine;
 603         JavaContextType contextType = (JavaContextType) PHPeclipsePlugin.getDefault().getTemplateContextRegistry().getContextType(
 604             "php"); //$NON-NLS-1$
 605         if (contextType != null) {
 606           IdentifierIndexManager indexManager = PHPeclipsePlugin.getDefault().getIndexManager(project);
 607           SortedMap sortedMap;
 608           declarationEngine = new DeclarationEngine(project, contextType, lastSignificantToken, file);
 609           if (lastSignificantToken == ITerminalSymbols.TokenNamethis_PHP_COMPLETION) {
 610             // complete '$this->'
 611             sortedMap = indexManager.getIdentifiers(file);
 612             declarationEngine.completeObject(viewer, offset, sortedMap, unit);
 613           } else {
 614             String typeRef = null;
 615             char[] varName = (char[]) list.get(0);
 616             if (varName != null) {
 617               if (method != null) {
 618                 methodVariables = getMethodVariables(methodVariables, method);
 619                 VariableInfo info = (VariableInfo) methodVariables.get(new String(varName));
 620                 if (info != null && info.typeIdentifier != null) {
 621                   typeRef = new String(info.typeIdentifier);
 622                 }
 623
 624               }
 625             }
 626             if (typeRef != null) {
 627               // complete '$variable->' with type information
 628               sortedMap = indexManager.getIdentifiers(typeRef);
 629               declarationEngine.completeObject(viewer, offset, sortedMap, unit);
 630             } else {
 631               // complete '$variable->' without type information
 632               sortedMap = indexManager.getIdentifierMap();
 633               declarationEngine.complete(viewer, offset, sortedMap, unit);
 634             }
 635           }
 636           declarationResults = declarationEngine.getResults();
 637         }
 638       }
 639       // built in function names from phpsyntax.xml
 640       ArrayList syntaxbuffer = PHPSyntaxRdr.getSyntaxData();
 641       IPHPCompletionProposal[] builtinResults = new IPHPCompletionProposal[0];
 642       if ((!useClassMembers) && syntaxbuffer != null) {
 643         BuiltInEngine builtinEngine;
 644         String proposal;
 645         JavaContextType contextType = (JavaContextType) PHPeclipsePlugin.getDefault().getTemplateContextRegistry().getContextType(
 646             "php"); //$NON-NLS-1$
 647         if (contextType != null) {
 648           builtinEngine = new BuiltInEngine(contextType);
 649           builtinEngine.complete(viewer, offset, syntaxbuffer, unit);
 650           builtinResults = builtinEngine.getResults();
 651         }
 652       }
 653       ICompletionProposal[] sqlResults = new ICompletionProposal[0];
 654       if (project != null) {
 655         sqlResults = getSQLProposals(viewer, project, context, prefix, sqlTable);
 656       }
 657       // concatenate the result arrays
 658       IPHPCompletionProposal[] total;
 659       total = new IPHPCompletionProposal[localVariableResults.length + templateResults.length + identifierResults.length
 660           + builtinResults.length + declarationResults.length + sqlResults.length];
 661       System.arraycopy(templateResults, 0, total, 0, templateResults.length);
 662       System.arraycopy(identifierResults, 0, total, templateResults.length, identifierResults.length);
 663       System.arraycopy(builtinResults, 0, total, templateResults.length + identifierResults.length, builtinResults.length);
 664       System.arraycopy(declarationResults, 0, total, templateResults.length + identifierResults.length + builtinResults.length,
 665           declarationResults.length);
 666       System.arraycopy(sqlResults, 0, total, templateResults.length + identifierResults.length + builtinResults.length
 667           + declarationResults.length, sqlResults.length);
 668       System.arraycopy(localVariableResults, 0, total, templateResults.length + identifierResults.length + builtinResults.length
 669           + declarationResults.length + sqlResults.length, localVariableResults.length);
 670       results = total;
 671       fNumberOfComputedResults = (results == null ? 0 : results.length);
 672       /*
 673        * Order here and not in result collector to make sure that the order applies to all proposals and not just those of the
 674        * compilation unit.
 675        */
 676       return order(results);
 677     }
 678     return new IPHPCompletionProposal[0];
 679   }
 680
 681   /**
 682    * @param unitVariables
 683    * @param unit
 684    */
 685   private HashMap getUnitVariables(HashMap unitVariables, ICompilationUnit unit) {
 686     if (unitVariables == null) {
 687       try {
 688         String unitText = unit.getSource();
 689         unitVariables = new HashMap();
 690
 691         ProblemReporter problemReporter = new ProblemReporter(DefaultErrorHandlingPolicies.exitAfterAllProblems(),
 692             new CompilerOptions(JavaCore.getOptions()), new DefaultProblemFactory());
 693         UnitParser parser = new UnitParser(problemReporter);
 694         parser.compilationUnit = new CompilationUnitDeclaration(problemReporter, null, unitText.length());
 695         parser.parse(unitText, unitVariables);
 696
 697       } catch (Exception e) {
 698         // TODO Auto-generated catch block
 699         e.printStackTrace();
 700         PHPeclipsePlugin.log(e);
 701       }
 702     }
 703     return unitVariables;
 704   }
 705
 706   /**
 707    * @param methodVariables
 708    * @param method
 709    */
 710   private HashMap getMethodVariables(HashMap methodVariables, IMethod method) {
 711     if (methodVariables == null) {
 712       try {
 713         String methodText = method.getSource();
 714         methodVariables = new HashMap();
 715         ProblemReporter problemReporter = new ProblemReporter(DefaultErrorHandlingPolicies.exitAfterAllProblems(),
 716             new CompilerOptions(JavaCore.getOptions()), new DefaultProblemFactory());
 717         UnitParser parser = new UnitParser(problemReporter);
 718         parser.compilationUnit = new CompilationUnitDeclaration(problemReporter, null, methodText.length());
 719         parser.parseFunction(methodText, methodVariables);
 720       } catch (Exception e) {
 721         // TODO Auto-generated catch block
 722         e.printStackTrace();
 723         PHPeclipsePlugin.log(e);
 724       }
 725     }
 726     return methodVariables;
 727   }
 728
 729   /**
 730    * @param viewer
 731    * @param project
 732    * @param context
 733    * @param prefix
 734    * @return
 735    */
 736   private void getVariableProposals(HashSet localVariables, ITextViewer viewer, IProject project, JavaContext context,
 737       HashMap variables, String prefix, int relevance) {
 738 //    try {
 739       int start = context.getStart();
 740       int end = context.getEnd();
 741       IRegion region = new Region(start, end - start);
 742       //      IMethod method = (IMethod) context.findEnclosingElement(IJavaElement.METHOD);
 743       //      if (method != null && (method instanceof SourceMethod) && ((SourceMethod) method).variables != null) {
 744       //        HashMap map = ((SourceMethod) method).variables;
 745       Set set = variables.keySet();
 746       Iterator iter = set.iterator();
 747       String varName;
 748       boolean matchesVarName;
 749       while (iter.hasNext()) {
 750         varName = (String) iter.next();
 751         if (varName.length() >= prefix.length()) {
 752           matchesVarName = true;
 753           for (int i = 0; i < prefix.length(); i++) {
 754             if (prefix.charAt(i) != Character.toLowerCase(varName.charAt(i))) {
 755               matchesVarName = false;
 756               break;
 757             }
 758           }
 759           if (matchesVarName) {
 760             LocalVariableProposal prop;
 761             //            if (varName.length == prefix.length()) {
 762             //              prop = new LocalVariableProposal(new String(varName), region, viewer, relevance-10);
 763             //            } else {
 764             prop = new LocalVariableProposal(new String(varName), region, viewer, relevance);
 765             //            }
 766             localVariables.add(prop);
 767           }
 768         }
 769       }
 770       //      }
 771
 772       //      char[] varName;
 773       //      boolean matchesVarName;
 774       //      if (method != null) {
 775       //        ISourceRange range = method.getSourceRange();
 776       //        char[] source = method.getSource().toCharArray();
 777       //        Scanner scanner = new Scanner();
 778       //        scanner.setSource(source);
 779       //        scanner.phpMode = true;
 780       //        int token = Scanner.TokenNameWHITESPACE;
 781       //        while ((token = scanner.getNextToken()) != Scanner.TokenNameEOF) {
 782       //          if (token == Scanner.TokenNameVariable) {
 783       //            varName = scanner.getCurrentTokenSource();
 784       //            if (varName.length >= prefix.length()) {
 785       //              matchesVarName = true;
 786       //              for (int i = 0; i < prefix.length(); i++) {
 787       //                if (prefix.charAt(i) != varName[i]) {
 788       //                  matchesVarName = false;
 789       //                  break;
 790       //                }
 791       //              }
 792       //              if (matchesVarName) {
 793       //                LocalVariableProposal prop = new LocalVariableProposal(new String(varName), region, viewer);
 794       //                if (varName.length == prefix.length()) {
 795       //                  prop.setRelevance(98);
 796       //                }
 797       //                localVariables.add(prop);
 798       //              }
 799       //            }
 800       //          }
 801       //        }
 802       //      }
 803     //    } catch (Throwable e) {
 804     //      // ignore - Syntax exceptions could occur, if there are syntax errors !
 805     //    }
 806   }
 807
 808   /**
 809    * @param viewer
 810    * @param project
 811    * @param context
 812    * @param prefix
 813    * @param sqlTable
 814    * @param sqlResults
 815    * @return
 816    */
 817   private ICompletionProposal[] getSQLProposals(ITextViewer viewer, IProject project, DocumentTemplateContext context,
 818       String prefix, TableName sqlTable) {
 819     ICompletionProposal[] sqlResults = new ICompletionProposal[0];
 820     // Get The Database bookmark from the Quantum SQL plugin:
 821     //    BookmarkCollection sqlBookMarks = BookmarkCollection.getInstance();
 822     //    if (sqlBookMarks != null) {
 823     String bookmarkString = ProjectPrefUtil.getMiscProjectsPreferenceValue(project, IPreferenceConstants.PHP_BOOKMARK_DEFAULT);
 824     if (bookmarkString != null && !bookmarkString.equals("")) {
 825       String[] bookmarks = ExternalInterface.getBookmarkNames();
 826       boolean foundBookmark = false;
 827       for (int i = 0; i < bookmarks.length; i++) {
 828         if (bookmarks[i].equals(bookmarkString)) {
 829           foundBookmark = true;
 830         }
 831       }
 832       if (!foundBookmark) {
 833         return sqlResults;
 834       }
 835       //        Bookmark bookmark = sqlBookMarks.find(bookmarkString);
 836       ArrayList sqlList = new ArrayList();
 837       if (!ExternalInterface.isBookmarkConnected(bookmarkString)) {
 838         ExternalInterface.connectBookmark(bookmarkString, null);
 839         if (!ExternalInterface.isBookmarkConnected(bookmarkString)) {
 840           return sqlResults;
 841         }
 842       }
 843       //      if (ExternalInterface.isBookmarkConnected(bookmarkString)) {
 844       try {
 845         //            Connection connection = bookmark.getConnection();
 846         //            DatabaseMetaData metaData = connection.getMetaData();
 847
 848         //            if (metaData != null) {
 849         int start = context.getStart();
 850         int end = context.getEnd();
 851         String foundSQLTableName = sqlTable.getTableName();
 852         String tableName;
 853         String columnName;
 854         String prefixWithoutDollar = prefix;
 855         boolean isDollarPrefix = false;
 856         if (prefix.length() > 0 && prefix.charAt(0) == '$') {
 857           prefixWithoutDollar = prefix.substring(1);
 858           isDollarPrefix = true;
 859         }
 860         IRegion region = new Region(start, end - start);
 861         ResultSet set;
 862         if (!isDollarPrefix) {
 863           String[] tableNames = ExternalInterface.getMatchingTableNames(null, bookmarkString, prefixWithoutDollar, null, false);
 864           for (int i = 0; i < tableNames.length; i++) {
 865             sqlList.add(new SQLProposal(tableNames[i], context, region, viewer, PHPUiImages.get(PHPUiImages.IMG_TABLE)));
 866           }
 867
 868           //                set = metaData.getTables(null, null, prefixWithoutDollar + "%", null);
 869           //                while (set.next()) {
 870           //                  tableName = set.getString("TABLE_NAME");
 871           //                  tableName = (tableName == null) ? "" : tableName.trim();
 872           //                  if (tableName != null && tableName.length() > 0) {
 873           //                    sqlList.add(new SQLProposal(tableName, context, region, viewer, PHPUiImages.get(PHPUiImages.IMG_TABLE)));
 874           //                  }
 875           //                }
 876           //                set.close();
 877         }
 878
 879         String[] columnNames = ExternalInterface.getMatchingColumnNames(null, bookmarkString, prefixWithoutDollar, null, false);
 880         for (int i = 0; i < columnNames.length; i++) {
 881           sqlList.add(new SQLProposal(columnNames[i], context, region, viewer, PHPUiImages.get(PHPUiImages.IMG_TABLE)));
 882         }
 883         //              set = metaData.getColumns(null, null, "%", prefixWithoutDollar + "%");
 884         //              SQLProposal sqlProposal;
 885         //              while (set.next()) {
 886         //                columnName = set.getString("COLUMN_NAME");
 887         //                columnName = (columnName == null) ? "" : columnName.trim();
 888         //                tableName = set.getString("TABLE_NAME");
 889         //                tableName = (tableName == null) ? "" : tableName.trim();
 890         //                if (tableName != null && tableName.length() > 0 && columnName != null && columnName.length() > 0) {
 891         //                  if (isDollarPrefix) {
 892         //                    sqlProposal = new SQLProposal(tableName, "$" + columnName, context, region, viewer, PHPUiImages
 893         //                        .get(PHPUiImages.IMG_COLUMN));
 894         //                  } else {
 895         //                    sqlProposal = new SQLProposal(tableName, columnName, context, region, viewer, PHPUiImages
 896         //                        .get(PHPUiImages.IMG_COLUMN));
 897         //                  }
 898         //                  if (tableName.equals(foundSQLTableName)) {
 899         //                    sqlProposal.setRelevance(90);
 900         //                  } else if (tableName.indexOf(foundSQLTableName) >= 0) {
 901         //                    sqlProposal.setRelevance(75);
 902         //                  }
 903         //                  sqlList.add(sqlProposal);
 904         //                }
 905         //              }
 906         //              set.close();
 907         sqlResults = new IPHPCompletionProposal[sqlList.size()];
 908         for (int i = 0; i < sqlList.size(); i++) {
 909           sqlResults[i] = (SQLProposal) sqlList.get(i);
 910         }
 911         //            }
 912       } catch (NotConnectedException e) {
 913         // ignore this - not mission critical
 914         //        } catch (SQLException e) {
 915         //          e.printStackTrace();
 916       }
 917       //      }
 918     }
 919     //    }
 920     return sqlResults;
 921   }
 922
 923   private boolean looksLikeMethod(PHPCodeReader reader) throws IOException {
 924     int curr = reader.read();
 925     while (curr != PHPCodeReader.EOF && Character.isWhitespace((char) curr))
 926       curr = reader.read();
 927
 928     if (curr == PHPCodeReader.EOF)
 929       return false;
 930
 931     return Scanner.isPHPIdentifierPart((char) curr) || Scanner.isPHPIdentifierStart((char) curr);
 932   }
 933
 934   private int guessContextInformationPosition(ITextViewer viewer, int offset) {
 935     int contextPosition = offset;
 936     IDocument document = viewer.getDocument();
 937     try {
 938
 939       PHPCodeReader reader = new PHPCodeReader();
 940       reader.configureBackwardReader(document, offset, true, true);
 941
 942       int nestingLevel = 0;
 943
 944       int curr = reader.read();
 945       while (curr != PHPCodeReader.EOF) {
 946
 947         if (')' == (char) curr)
 948           ++nestingLevel;
 949
 950         else if ('(' == (char) curr) {
 951           --nestingLevel;
 952
 953           if (nestingLevel < 0) {
 954             int start = reader.getOffset();
 955             if (looksLikeMethod(reader))
 956               return start + 1;
 957           }
 958         }
 959
 960         curr = reader.read();
 961       }
 962     } catch (IOException e) {
 963     }
 964     return contextPosition;
 965   }
 966
 967   /**
 968    * @see IContentAssistProcessor#computeContextInformation(ITextViewer, int)
 969    */
 970   public IContextInformation[] computeContextInformation(ITextViewer viewer, int offset) {
 971     int contextInformationPosition = guessContextInformationPosition(viewer, offset);
 972     List result = addContextInformations(viewer, contextInformationPosition);
 973     return (IContextInformation[]) result.toArray(new IContextInformation[result.size()]);
 974   }
 975
 976   private List addContextInformations(ITextViewer viewer, int offset) {
 977     ICompletionProposal[] proposals = internalComputeCompletionProposals(viewer, offset, -1);
 978     List result = new ArrayList();
 979     for (int i = 0; i < proposals.length; i++) {
 980       IContextInformation contextInformation = proposals[i].getContextInformation();
 981       if (contextInformation != null) {
 982         ContextInformationWrapper wrapper = new ContextInformationWrapper(contextInformation);
 983         wrapper.setContextInformationPosition(offset);
 984         result.add(wrapper);
 985       }
 986     }
 987     return result;
 988   }
 989
 990   /**
 991    * Order the given proposals.
 992    */
 993   private ICompletionProposal[] order(ICompletionProposal[] proposals) {
 994     Arrays.sort(proposals, fComparator);
 995     //    int len = proposals.length;
 996     //    if (len > 10) {
 997     //      len = 10;
 998     //    }
 999     //    for (int i = 0; i < len; i++) {
1000     //      System.out.println(proposals[i].getDisplayString());
1001     //    }
1002     return proposals;
1003   }
1004
1005   /*
1006    * (non-Javadoc) Method declared on IContentAssistProcessor
1007    */
1008   public char[] getCompletionProposalAutoActivationCharacters() {
1009     return fProposalAutoActivationSet;
1010     //    return null; // new char[] { '$' };
1011   }
1012
1013   /*
1014    * (non-Javadoc) Method declared on IContentAssistProcessor
1015    */
1016   public char[] getContextInformationAutoActivationCharacters() {
1017     return new char[] {};
1018   }
1019
1020   /*
1021    * (non-Javadoc) Method declared on IContentAssistProcessor
1022    */
1023   public IContextInformationValidator getContextInformationValidator() {
1024     return fValidator;
1025   }
1026
1027   /*
1028    * (non-Javadoc) Method declared on IContentAssistProcessor
1029    */
1030   public String getErrorMessage() {
1031     return null;
1032   }
1033 }