Merged "Open PHP Declaration" and "Open Include File" into one action "Open Declarati...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / actions / PHPOpenDeclarationEditorAction.java
index 43b848a..2dd8a72 100644 (file)
@@ -1,11 +1,10 @@
-/*******************************************************************************
- * Copyright (c) 2000, 2002 IBM Corp. and others. All rights reserved. This
- * program and the accompanying materials are made available under the terms of
- * the Common Public License v1.0 which accompanies this distribution, and is
- * available at http://www.eclipse.org/legal/cpl-v10.html
+/***********************************************************************************************************************************
+ * Copyright (c) 2000, 2002 IBM Corp. and others. All rights reserved. This program and the accompanying materials are made
+ * available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
  * 
- * Contributors: Klaus Hartlage - www.eclipseproject.de
- ******************************************************************************/
+ * Contributors: www.phpeclipse.de
+ **********************************************************************************************************************************/
 package net.sourceforge.phpeclipse.actions;
 
 import java.io.File;
@@ -19,9 +18,11 @@ import net.sourceforge.phpeclipse.builder.PHPIdentifierLocation;
 import net.sourceforge.phpeclipse.phpeditor.PHPEditor;
 import net.sourceforge.phpeclipse.phpeditor.php.PHPWordExtractor;
 
+import org.eclipse.core.resources.IContainer;
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.Path;
 import org.eclipse.jface.action.IAction;
 import org.eclipse.jface.text.BadLocationException;
 import org.eclipse.jface.text.IDocument;
@@ -39,59 +40,7 @@ import org.eclipse.ui.actions.ActionDelegate;
 import org.eclipse.ui.dialogs.ListSelectionDialog;
 import org.eclipse.ui.internal.dialogs.ListContentProvider;
 
-public class PHPOpenDeclarationEditorAction extends ActionDelegate implements
-    IEditorActionDelegate {
-
-//  class Include implements Comparable {
-//    final public static int UNDEFINED_MATCH = 0;
-//    final public static int PATTERN_MATCH = 1;
-//    final public static int EXACT_MATCH = 2;
-//
-//    String fName;
-//
-//    int fMatch;
-//
-//    public Include(String name, int match) {
-//      fName = name;
-//      fMatch = match;
-//    }
-//
-//    /*
-//     * (non-Javadoc)
-//     * 
-//     * @see java.lang.Object#toString()
-//     */
-//    public String toString() {
-//      switch (fMatch) {
-//      case UNDEFINED_MATCH:
-//        return fName;
-//      case PATTERN_MATCH:
-//        return "[pattern included] " + fName;
-//      case EXACT_MATCH:
-//        return "[included] " + fName;
-//      }
-//      return fName;
-//    }
-//
-//    /**
-//     * @return Returns the name.
-//     */
-//    public String getName() {
-//      return fName;
-//    }
-//    /* (non-Javadoc)
-//     * @see java.lang.Comparable#compareTo(java.lang.Object)
-//     */
-//    public int compareTo(Object o) {
-//      Include i = (Include)o;
-//      if (fMatch>i.fMatch) {
-//        return 1;
-//      } else if (fMatch<i.fMatch) {
-//        return -1;
-//      }
-//      return fName.compareTo(i.fName);
-//    }
-//  }
+public class PHPOpenDeclarationEditorAction extends ActionDelegate implements IEditorActionDelegate {
 
   private IWorkbenchWindow fWindow;
 
@@ -99,6 +48,8 @@ public class PHPOpenDeclarationEditorAction extends ActionDelegate implements
 
   private IProject fProject;
 
+  private boolean isIncludeString;
+
   public void dispose() {
   }
 
@@ -110,8 +61,7 @@ public class PHPOpenDeclarationEditorAction extends ActionDelegate implements
     if (!selection.isEmpty()) {
       if (selection instanceof TextSelection) {
         action.setEnabled(true);
-      } else if (fWindow.getActivePage() != null
-          && fWindow.getActivePage().getActivePart() != null) {
+      } else if (fWindow.getActivePage() != null && fWindow.getActivePage().getActivePart() != null) {
         //
       }
     }
@@ -130,90 +80,145 @@ public class PHPOpenDeclarationEditorAction extends ActionDelegate implements
       fProject = f.getProject();
       //      System.out.println(fProject.toString());
 
-      ITextSelection selection = (ITextSelection) fEditor
-          .getSelectionProvider().getSelection();
-      IDocument doc = fEditor.getDocumentProvider().getDocument(
-          fEditor.getEditorInput());
+      ITextSelection selection = (ITextSelection) fEditor.getSelectionProvider().getSelection();
+      IDocument doc = fEditor.getDocumentProvider().getDocument(fEditor.getEditorInput());
       int pos = selection.getOffset();
       //  System.out.println(selection.getText());
-      String word = getPHPIdentifier(doc, pos);
+      String identifierOrInclude = getIdentifierOrInclude(doc, pos);
       //      System.out.println(word);
-      if (word != null && !word.equals("")) {
-        IdentifierIndexManager indexManager = PHPeclipsePlugin.getDefault()
-            .getIndexManager(fProject);
-        List locationsList = indexManager.getLocations(word);
-        if (locationsList != null && locationsList.size() > 0) {
-
-//          String workspaceLocation = PHPeclipsePlugin.getWorkspace().getRoot()
-//              .getLocation().toString();
-          
-          String workspaceLocation = fProject.getLocation().toString()+File.separatorChar;
-          // TODO show all entries of the list in a dialog box
-          // at the moment always the first entry will be opened
-          if (locationsList.size() > 1) {
-            // determine all includes:
-            IncludesScanner includesScanner = new IncludesScanner(fProject,
-                (IFileEditorInput) fEditor.getEditorInput());
-            includesScanner.addFile(f);
-            Set exactIncludeSet = includesScanner.getSet();
-
-            PHPIdentifierLocation includeName;
-            for (int i = 0; i < locationsList.size(); i++) {
-              includeName = (PHPIdentifierLocation) locationsList.get(i);
-              if (exactIncludeSet.contains(includeName.getFilename())) {
-                includeName.setMatch(PHPIdentifierLocation.EXACT_MATCH);
-              } else {
-                includeName.setMatch(PHPIdentifierLocation.UNDEFINED_MATCH);
+      if (identifierOrInclude != null && !identifierOrInclude.equals("")) {
+        if (isIncludeString) {
+          openIncludeFile(identifierOrInclude);
+        } else {
+          openIdentifierDeclaration(f, identifierOrInclude);
+        }
+      }
+    }
+  }
+
+  /**
+   * @param filename
+   */
+  private void openIncludeFile(String filename) {
+    if (filename != null && !filename.equals("")) {
+      try {
+        IFile file = getIncludeFile(fProject, (IFileEditorInput) fEditor.getEditorInput(), filename);
+        if (file != null && file.exists()) {
+          PHPeclipsePlugin.getDefault().openFileInTextEditor(file.getLocation().toString());
+          return;
+        }
+      } catch (Exception e) {
+        // ignore
+      }
+
+      try {
+
+        IdentifierIndexManager indexManager = PHPeclipsePlugin.getDefault().getIndexManager(fProject);
+        //            filename = StringUtil.replaceRegExChars(filename);
+        List list = indexManager.getFileList(filename);
+        if (list != null && list.size() > 0) {
+          //String workspaceLocation = PHPeclipsePlugin.getWorkspace().getRoot().getLocation().toString();
+          String workspaceLocation = fProject.getLocation().toString() + File.separatorChar;
+
+          ListSelectionDialog listSelectionDialog = new ListSelectionDialog(PHPeclipsePlugin.getDefault().getWorkbench()
+              .getActiveWorkbenchWindow().getShell(), list, new ListContentProvider(), new LabelProvider(),
+              "Select the includes to open.");
+          listSelectionDialog.setTitle("Multiple includes found");
+          if (listSelectionDialog.open() == Window.OK) {
+            Object[] locations = listSelectionDialog.getResult();
+            if (locations != null) {
+              try {
+                for (int i = 0; i < locations.length; i++) {
+                  //                    PHPIdentifierLocation location = (PHPIdentifierLocation)
+                  // locations[i];
+                  String openFilename = workspaceLocation + ((String) locations[i]);
+                  PHPeclipsePlugin.getDefault().openFileInTextEditor(openFilename);
+                }
+              } catch (CoreException e) {
+                // TODO Auto-generated catch block
+                e.printStackTrace();
               }
             }
-            Collections.sort(locationsList);
-            
-            ListSelectionDialog listSelectionDialog = new ListSelectionDialog(
-                PHPeclipsePlugin.getDefault().getWorkbench()
-                    .getActiveWorkbenchWindow().getShell(), locationsList,
-                new ListContentProvider(), new LabelProvider(),
-                "Select the resources to open.");
-            listSelectionDialog.setTitle("Multiple declarations found");
-            if (listSelectionDialog.open() == Window.OK) {
-              Object[] locations = listSelectionDialog.getResult();
-              if (locations != null) {
-                try {
-                  for (int i = 0; i < locations.length; i++) {
-                    PHPIdentifierLocation location = (PHPIdentifierLocation) locations[i];
-                    String filename = workspaceLocation
-                        + location.getFilename();
-                    //                                 System.out.println(filename);
-                    if (location.getOffset() >= 0) {
-                      PHPeclipsePlugin.getDefault().openFileAndGotoOffset(
-                          filename, location.getOffset(), word.length());
-                    } else {
-                      PHPeclipsePlugin.getDefault().openFileAndFindString(
-                          filename, word);
-                    }
+          }
+
+        }
+      } catch (Exception e) {
+      }
+
+    }
+    return;
+  }
+
+  /**
+   * @param f
+   * @param identiifer
+   */
+  private void openIdentifierDeclaration(IFile f, String identiifer) {
+    if (identiifer != null && !identiifer.equals("")) {
+      IdentifierIndexManager indexManager = PHPeclipsePlugin.getDefault().getIndexManager(fProject);
+      List locationsList = indexManager.getLocations(identiifer);
+      if (locationsList != null && locationsList.size() > 0) {
+
+        //          String workspaceLocation = PHPeclipsePlugin.getWorkspace().getRoot()
+        //              .getLocation().toString();
+
+        String workspaceLocation = fProject.getLocation().toString() + File.separatorChar;
+        // TODO show all entries of the list in a dialog box
+        // at the moment always the first entry will be opened
+        if (locationsList.size() > 1) {
+          // determine all includes:
+          IncludesScanner includesScanner = new IncludesScanner(fProject, (IFileEditorInput) fEditor.getEditorInput());
+          includesScanner.addFile(f);
+          Set exactIncludeSet = includesScanner.getSet();
+
+          PHPIdentifierLocation includeName;
+          for (int i = 0; i < locationsList.size(); i++) {
+            includeName = (PHPIdentifierLocation) locationsList.get(i);
+            if (exactIncludeSet.contains(includeName.getFilename())) {
+              includeName.setMatch(PHPIdentifierLocation.EXACT_MATCH);
+            } else {
+              includeName.setMatch(PHPIdentifierLocation.UNDEFINED_MATCH);
+            }
+          }
+          Collections.sort(locationsList);
+
+          ListSelectionDialog listSelectionDialog = new ListSelectionDialog(PHPeclipsePlugin.getDefault().getWorkbench()
+              .getActiveWorkbenchWindow().getShell(), locationsList, new ListContentProvider(), new LabelProvider(),
+              "Select the resources to open.");
+          listSelectionDialog.setTitle("Multiple declarations found");
+          if (listSelectionDialog.open() == Window.OK) {
+            Object[] locations = listSelectionDialog.getResult();
+            if (locations != null) {
+              try {
+                for (int i = 0; i < locations.length; i++) {
+                  PHPIdentifierLocation location = (PHPIdentifierLocation) locations[i];
+                  String filename = workspaceLocation + location.getFilename();
+                  //                                   System.out.println(filename);
+                  if (location.getOffset() >= 0) {
+                    PHPeclipsePlugin.getDefault().openFileAndGotoOffset(filename, location.getOffset(), identiifer.length());
+                  } else {
+                    PHPeclipsePlugin.getDefault().openFileAndFindString(filename, identiifer);
                   }
-                } catch (CoreException e) {
-                  // TODO Auto-generated catch block
-                  e.printStackTrace();
                 }
+              } catch (CoreException e) {
+                // TODO Auto-generated catch block
+                e.printStackTrace();
               }
             }
-          } else {
-            try {
-              PHPIdentifierLocation location = (PHPIdentifierLocation) locationsList
-                  .get(0);
-              String filename = workspaceLocation + location.getFilename();
-              //                                       System.out.println(filename);
-              if (location.getOffset() >= 0) {
-                PHPeclipsePlugin.getDefault().openFileAndGotoOffset(filename,
-                    location.getOffset(), word.length());
-              } else {
-                PHPeclipsePlugin.getDefault().openFileAndFindString(filename,
-                    word);
-              }
-            } catch (CoreException e) {
-              // TODO Auto-generated catch block
-              e.printStackTrace();
+          }
+        } else {
+          try {
+            PHPIdentifierLocation location = (PHPIdentifierLocation) locationsList.get(0);
+            String filename = workspaceLocation + location.getFilename();
+            //                                 System.out.println(filename);
+            if (location.getOffset() >= 0) {
+              PHPeclipsePlugin.getDefault().openFileAndGotoOffset(filename, location.getOffset(), identiifer.length());
+            } else {
+              PHPeclipsePlugin.getDefault().openFileAndFindString(filename, identiifer);
             }
+          } catch (CoreException e) {
+            // TODO Auto-generated catch block
+            e.printStackTrace();
           }
         }
       }
@@ -226,8 +231,54 @@ public class PHPOpenDeclarationEditorAction extends ActionDelegate implements
     }
   }
 
-  private String getPHPIdentifier(IDocument doc, int pos) {
-    Point word = PHPWordExtractor.findWord(doc, pos);
+  private String getIdentifierOrInclude(IDocument doc, int pos) {
+    //    private String getPHPIncludeText(IDocument doc, int pos) {
+    Point word = null;
+    int start = -1;
+    int end = -1;
+    isIncludeString = false;
+    try {
+      //    try to find an include string
+      int position = pos;
+      char character = ' ';
+
+      while (position >= 0) {
+        character = doc.getChar(position);
+        if ((character == '\"') || (character == '\'') || (character == '\r') || (character == '\n'))
+          break;
+        --position;
+      }
+      if ((character == '\"') || (character == '\'')) {
+        start = position;
+
+        position = pos;
+        int length = doc.getLength();
+        character = ' ';
+        while (position < length) {
+          character = doc.getChar(position);
+          if ((character == '\"') || (character == '\'') || (character == '\r') || (character == '\n'))
+            break;
+          ++position;
+        }
+        if ((character == '\"') || (character == '\'')) {
+          start++;
+          end = position;
+
+          if (end > start) {
+            word = new Point(start, end - start); // include name found
+            isIncludeString = true;
+          }
+        }
+      }
+
+      // try to find an identifier
+      if (word == null) {
+        word = PHPWordExtractor.findWord(doc, pos); // identifier found
+        isIncludeString = false;
+      }
+    } catch (BadLocationException x) {
+    }
+
     if (word != null) {
       try {
         return doc.get(word.x, word.y);
@@ -236,4 +287,47 @@ public class PHPOpenDeclarationEditorAction extends ActionDelegate implements
     }
     return "";
   }
+
+  //    
+  //    
+  //    Point word = PHPWordExtractor.findWord(doc, pos);
+  //    if (word != null) {
+  //      try {
+  //        return doc.get(word.x, word.y);
+  //      } catch (BadLocationException e) {
+  //      }
+  //    }
+  //    return "";
+  //  }
+  private IContainer getWorkingLocation(IFileEditorInput editorInput) {
+    if (editorInput == null || editorInput.getFile() == null) {
+      return null;
+    }
+    return editorInput.getFile().getParent();
+  }
+
+  private IFile getIncludeFile(IProject project, IFileEditorInput editorInput, String relativeFilename) {
+    IContainer container = getWorkingLocation(editorInput);
+    String fullPath = project.getLocation().toString();
+    IFile file = null;
+    if (relativeFilename.startsWith("../")) {
+      Path path = new Path(relativeFilename);
+      file = container.getFile(path);
+      return file;
+    }
+    int index = relativeFilename.lastIndexOf('/');
+
+    if (index >= 0) {
+      Path path = new Path(relativeFilename);
+      file = project.getFile(path);
+      if (file.exists()) {
+        return file;
+      }
+    }
+
+    Path path = new Path(relativeFilename);
+    file = container.getFile(path);
+
+    return file;
+  }
 }
\ No newline at end of file