Merge pull request #3815 from Hannah-Sten/sticky-sections

Add sections to breadcrumbs

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [Unreleased]
 
 ### Added
+* Add sections to breadcrumbs
 * Change order in structure view to match source file and sectioning level 
 * Add command redefinitions to command definition filter in structure view
 * Add support for automatic language injection on the minted environment

src/nl/hannahsten/texifyidea/structure/latex/LatexBreadcrumbsInfo.kt

@@ -2,10 +2,16 @@ package nl.hannahsten.texifyidea.structure.latex
 
 import com.intellij.psi.PsiElement
 import com.intellij.ui.breadcrumbs.BreadcrumbsProvider
+import nl.hannahsten.texifyidea.editor.folding.LatexSectionFoldingBuilder
 import nl.hannahsten.texifyidea.grammar.LatexLanguage
 import nl.hannahsten.texifyidea.psi.LatexCommands
 import nl.hannahsten.texifyidea.psi.LatexEnvironment
+import nl.hannahsten.texifyidea.util.files.document
+import nl.hannahsten.texifyidea.util.magic.CommandMagic
+import nl.hannahsten.texifyidea.util.magic.cmd
 import nl.hannahsten.texifyidea.util.parser.name
+import nl.hannahsten.texifyidea.util.parser.parents
+import nl.hannahsten.texifyidea.util.parser.requiredParameter
 
 /**
  * @author Hannah Schellekens
@@ -16,7 +22,7 @@ open class LatexBreadcrumbsInfo : BreadcrumbsProvider {
 
     override fun getElementInfo(element: PsiElement) = when (element) {
         is LatexEnvironment -> element.name()?.text
-        is LatexCommands -> element.commandToken.text
+        is LatexCommands -> if (element.name in CommandMagic.sectioningCommands.map { it.cmd }) element.requiredParameter(0) ?: element.name else element.name
         else -> ""
     } ?: ""
 
@@ -25,4 +31,19 @@ open class LatexBreadcrumbsInfo : BreadcrumbsProvider {
         is LatexCommands -> true
         else -> false
     }
+
+    override fun getParent(element: PsiElement): PsiElement? {
+        val document = element.containingFile.document() ?: return super.getParent(element)
+        // Add sections
+        val parent = LatexSectionFoldingBuilder().buildFoldRegions(element.containingFile, document, quick = true)
+            // Only top-level elements in the section should have the section as parents, other elements should keep their direct parent (e.g. an environment)
+            .filter { it.range.contains(element.textRange ?: return@filter false) }
+            .filter { !it.range.contains(element.parent.textRange ?: return@filter false) }
+            // Avoid creating a loop
+            .filter { it.element.psi != element }
+            .filter { it.element.psi?.parents()?.contains(element) != true }
+            .minByOrNull { it.range.endOffset - it.range.startOffset }
+            ?.element?.psi
+        return parent ?: super.getParent(element)
+    }
 }