Root files

[slideclimb]

Fix #1612.

Summary of additions and changes

• Use the document environment to determine root files instead of the document class.
• Add an inspection that warns you when you have separated the document environment and document class.
• Introduces a cache to store the root files for each file. Note that it is perfectly fine for LaTeX documents to have multiple root files. Other than the introduction of this cache, TeXiFy does not handle multiple root files anywhere (yet). However, the function PsiFile.findRootFile() is now deprecated in favor of PsiFile.findRootFiles() to encourage/force us to explicitly handle the cases of multiple root files. E.g., including a use package in all root files instead of in just one of the root files.
• To my knowledge, the root magic comment works fine at the moment, see the example below.

How to test this pull request

• Verify that stuff that needs the root file still works.
• Verify that the magic comment works. Create main.tex as below and try the following:
  1. Without the magic root comment: use autocompletion to complete the \includegraphics command. A \usepackage{graphicx} will be inserted in test.tex.
  2. With the magic comment: use autocompletion to complete the \includegraphics command. A \usepackage{graphicx} will be inserted in main.tex.

main.tex

\documentclass{article}

\newcommand{\includebla}[1]{\include{#1}}

\begin{document}
    \includebla{test}
\end{document}

test.tex*

%! root = main.tex
\includegr<caret>

Wiki

• Updated the wiki:
  • https://github.com/Hannah-Sten/TeXiFy-IDEA/wiki/LaTeX-recommendations#-file-that-contains-a-document-environment-should-contain-a-documentclass-command
  • https://github.com/Hannah-Sten/TeXiFy-IDEA/wiki/Magic-comments#root-file

[PHPirates]

False positive:

\begin{filecontents}{included.tex}
\end{filecontents}

\documentclass[11pt]{article}
\begin{document}
    \section{A title}\label{sec:a-title}
    \input{included.tex}
\end{document}