Merge pull request #75 from cedricziel/tca-goto-declaration

TCA GotoDeclaration handler for table names

Author: cedricziel

src/main/java/com/cedricziel/idea/typo3/tca/codeInsight/navigation/TablenameGotoDeclarationHandler.java

@@ -0,0 +1,33 @@
+package com.cedricziel.idea.typo3.tca.codeInsight.navigation;
+
+import com.cedricziel.idea.typo3.util.TCAUtil;
+import com.intellij.codeInsight.navigation.actions.GotoDeclarationHandler;
+import com.intellij.openapi.actionSystem.DataContext;
+import com.intellij.openapi.editor.Editor;
+import com.intellij.psi.PsiElement;
+import org.jetbrains.annotations.Nullable;
+
+import static com.cedricziel.idea.typo3.util.TableUtil.getTableDefinitionElements;
+
+public class TablenameGotoDeclarationHandler implements GotoDeclarationHandler {
+    @Nullable
+    @Override
+    public PsiElement[] getGotoDeclarationTargets(@Nullable PsiElement sourceElement, int offset, Editor editor) {
+
+        if (sourceElement == null || !isTablenameTcaField(sourceElement)) {
+            return new PsiElement[0];
+        }
+
+        return getTableDefinitionElements(sourceElement.getText(), sourceElement.getProject());
+    }
+
+    @Nullable
+    @Override
+    public String getActionText(DataContext context) {
+        return null;
+    }
+
+    private boolean isTablenameTcaField(PsiElement psiElement) {
+        return TCAUtil.arrayIndexIsTCATableNameField(psiElement);
+    }
+}

src/main/java/com/cedricziel/idea/typo3/util/TableUtil.java

@@ -4,12 +4,15 @@
 import com.intellij.codeInsight.lookup.LookupElement;
 import com.intellij.openapi.fileEditor.impl.LoadTextUtil;
 import com.intellij.openapi.project.Project;
+import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.search.FilenameIndex;
 import com.intellij.psi.search.GlobalSearchScope;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Arrays;
 import java.util.HashSet;
+import java.util.Objects;
 import java.util.Set;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -19,7 +22,7 @@ public class TableUtil {
     public static final String EXT_TABLES_SQL_FILENAME = "ext_tables.sql";
 
     public static Set<String> getAvailableTableNames(@NotNull Project project) {
-        PsiFile[] extSqlFiles = FilenameIndex.getFilesByName(project, EXT_TABLES_SQL_FILENAME, GlobalSearchScope.allScope(project));
+        PsiFile[] extSqlFiles = getExtTablesSqlFilesInProject(project);
 
         Set<String> tableNames = new HashSet<>();
 
@@ -50,6 +53,55 @@ public static Set<String> getAvailableTableNames(@NotNull Project project) {
         return tableNames;
     }
 
+    public static PsiElement[] getTableDefinitionElements(@NotNull String tableName, @NotNull Project project) {
+
+        PsiFile[] extTablesSqlFilesInProjectContainingTable = getExtTablesSqlFilesInProjectContainingTable(tableName, project);
+
+        return Arrays
+                .stream(extTablesSqlFilesInProjectContainingTable)
+                .map(file -> {
+                    CharSequence charSequence = LoadTextUtil.loadText(file.getVirtualFile());
+
+                    final Matcher matcher = Pattern
+                            .compile("create\\s+table\\s+(if\\s+not\\s+exists\\s+)?([a-zA-Z_0-9]+)", Pattern.CASE_INSENSITIVE)
+                            .matcher(charSequence);
+                    try {
+                        while (matcher.find()) {
+                            if (matcher.groupCount() < 2) {
+                                continue;
+                            }
+
+                            final String foundTable = matcher.group(2);
+                            if (!foundTable.equals(tableName)) {
+                                continue;
+                            }
+
+                            return file.findElementAt(matcher.end() - 2);
+                        }
+                    } catch (IllegalStateException e) {
+                        // do nothing
+                    }
+
+                    return null;
+                })
+                .filter(Objects::nonNull)
+                .toArray(PsiElement[]::new);
+    }
+
+    private static PsiFile[] getExtTablesSqlFilesInProjectContainingTable(@NotNull String tableName, @NotNull Project project) {
+
+        return Arrays
+                .stream(getExtTablesSqlFilesInProject(project))
+                .filter(Objects::nonNull)
+                .filter(file -> LoadTextUtil.loadText(file.getVirtualFile()).toString().contains(tableName))
+                .toArray(PsiFile[]::new);
+    }
+
+    @NotNull
+    private static PsiFile[] getExtTablesSqlFilesInProject(@NotNull Project project) {
+        return FilenameIndex.getFilesByName(project, EXT_TABLES_SQL_FILENAME, GlobalSearchScope.allScope(project));
+    }
+
     public static void completeAvailableTableNames(@NotNull Project project, @NotNull CompletionResultSet completionResultSet) {
         for (String name : TableUtil.getAvailableTableNames(project)) {
             completionResultSet.addElement(new LookupElement() {

src/main/resources/META-INF/plugin.xml

@@ -298,8 +298,9 @@ It is a great inspiration for possible solutions and parts of the code.</p>
         <!-- inspections -->
         <inspectionToolProvider implementation="com.cedricziel.idea.typo3.codeInspection.TYPO3InspectionToolProvider"/>
 
-        <!-- got handlers -->
+        <!-- goto handlers -->
         <gotoDeclarationHandler implementation="com.cedricziel.idea.typo3.codeInsight.navigation.PathResourceGotoDeclarationHandler"/>
+        <gotoDeclarationHandler implementation="com.cedricziel.idea.typo3.tca.codeInsight.navigation.TablenameGotoDeclarationHandler"/>
     </extensions>
 
     <extensions defaultExtensionNs="com.jetbrains.php">