CMake: Document interactions around CMakeBuildSystem

Change-Id: Id4f379eefcccf2d0517e5c3b72c9b88957243651
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>

1 files changed, 167 insertions, 0 deletions

diff --git a/src/plugins/cmakeprojectmanager/cmakebuildsystem.md b/src/plugins/cmakeprojectmanager/cmakebuildsystem.md
new file mode 100644
index 0000000000..97930e844c
--- /dev/null
+++ b/src/plugins/cmakeprojectmanager/cmakebuildsystem.md
@@ -0,0 +1,167 @@
+# `CMakeBuildSystem`
+
+## Big Picture: `BuildSystem`
+
+This is a sequence diagram of how `ProjectExplorer::BuildSystem` interacts with
+its implementations:
+
+```mermaid
+sequenceDiagram
+    User ->> BuildSystemImpl: provide data and ask for parse (impl. defined!)
+    BuildSystemImpl ->> BuildSystem: call requestParse() or requestDelayedParse()
+    activate BuildSystem
+    BuildSystem ->> BuildSys    tem: m_delayedParsingTimer sends timeout()
+    BuildSystem ->> BuildSystemImpl: call triggerParsing()
+    deactivate BuildSystem
+    activate BuildSystemImpl
+    BuildSystemImpl ->> BuildSystem: call guardParsingRun()
+    activate BuildSystem
+    BuildSystem ->> ParseGuard: Construct
+    activate ParseGuard
+    ParseGuard ->> BuildSystem: call emitParsingStarted
+    BuildSystem ->> User: signal parsingStarted()
+    BuildSystem ->> BuildSystemImpl: Hand over ParseGuard
+    deactivate BuildSystem
+    BuildSystemImpl ->> BuildSystemImpl: Do parsing
+    opt Report Success
+    BuildSystemImpl ->> ParseGuard: markAsSuccess()
+    end
+    BuildSystemImpl ->> ParseGuard: Destruct
+    ParseGuard ->> BuildSystem: emitParsingFinished()
+    activate BuildSystem
+    BuildSystem ->> User: Signal ParsingFinished(...)
+    deactivate BuildSystem
+    deactivate ParseGuard
+    deactivate BuildSystemImpl
+```
+
+## The Details of `CMakeBuildSystem`
+
+### States Overview
+
+```mermaid
+graph TD
+    parse --> TreeScanner::asyncScanForFiles
+
+    parse --> FileApiReader::parse
+    FileApiReader::parse --> handleParsingSucceeded
+    handleParsingSucceeded --> handleParsingSuccess
+    FileApiReader::parse --> handleParsingFailed
+    handleParsingFailed --> handleParsingError
+    handleParsingError --> combineScanAndParse
+    handleParsingSuccess --> combineScanAndParse
+
+    TreeScanner::asyncScanForFiles --> handleTreeScanningFinished
+    handleTreeScanningFinished --> combineScanAndParse
+```
+
+### Full Sequence Diagram
+
+```mermaid
+sequenceDiagram
+    participant User
+    participant ParseGuard
+    participant CMakeBuildSystem
+    participant BuildDirManager
+    participant FileApiReader
+
+    alt Trigger Parsing
+    User ->> CMakeBuildSystem: Any of the Actions defined for CMakeBuildSystem
+    else
+    User ->> CMakeBuildSystem: Signal from outside the CMakeBuildSystem
+    end
+    activate CMakeBuildSystem
+    CMakeBuildSystem ->> BuildDirManager: call setParametersAndRequestReparse()
+    activate BuildDirManager
+    BuildDirManager ->> BuildDirManager: Validate parameters
+    BuildDirManager ->> FileApiReader: Construct
+    activate FileApiReader
+    BuildDirManager ->> FileApiReader: call setParameters
+    BuildDirManager ->> CMakeBuildSystem: call request*Reparse()
+    deactivate BuildDirManager
+    deactivate CMakeBuildSystem
+
+    CMakeBuildSystem ->> CMakeBuildSystem: m_delayedParsingTimer sends timeout() triggering triggerParsing()
+
+    activate CMakeBuildSystem
+
+    CMakeBuildSystem ->>+ CMakeBuildSystem: call guardParsingRun()
+    CMakeBuildSystem ->> ParseGuard: Construct
+    activate ParseGuard
+    ParseGuard ->> CMakeBuildSystem: call emitParsingStarted
+    CMakeBuildSystem ->> User: signal parsingStarted()
+    CMakeBuildSystem ->>- CMakeBuildSystem: Hand over ParseGuard
+
+    CMakeBuildSystem ->>+ TreeScanner: call asyncScanForFiles()
+
+    CMakeBuildSystem ->>+ BuildDirManager: call parse(...)
+    BuildDirManager ->>+ FileApiReader: call parse(...)
+    FileApiReader ->> FileApiReader: startState()
+    deactivate BuildDirManager
+    deactivate CMakeBuildSystem
+
+    opt Parse
+    FileApiReader ->> FileApiReader: call startCMakeState(...)
+    FileApiReader ->> FileApiReader: call cmakeFinishedState(...)
+    end
+
+    FileApiReader ->> FileApiReader: call endState(...)
+
+    alt Return Result from FileApiReader
+    FileApiReader ->> BuildDirManager: signal dataAvailable()
+    BuildDirManager ->> CMakeBuildSystem: signal dataAvailable() and trigger handleParsingSucceeded()
+    CMakeBuildSystem ->> CMakeBuildSystem: call handleParsingSuccess()
+    CMakeBuildSystem ->> BuildDirManager: call takeBuildTargets()
+    BuildDirManager ->> FileApiReader: call takeBuildTargets()
+    CMakeBuildSystem ->> BuildDirManager: call takeCMakeConfiguration(...)
+    BuildDirManager ->> FileApiReader: call takeCMakeConfiguration(....)
+    else
+    FileApiReader ->> BuildDirManager: signal errorOccurred(...)
+    BuildDirManager ->> CMakeBuildSystem: signal errorOccurred(...) and trigger handelParsingFailed(...)
+    CMakeBuildSystem ->> CMakeBuildSystem: call handelParsingError()
+    CMakeBuildSystem ->> BuildDirManager: call takeCMakeConfiguration(...)
+    BuildDirManager ->> FileApiReader: call takeCMakeConfiguration(....)
+    end
+
+    deactivate FileApiReader
+    Note right of CMakeBuildSystem: TreeScanner is still missing here
+    CMakeBuildSystem ->> CMakeBuildSystem: call combineScanAndParse()
+
+    TreeScanner ->> CMakeBuildSystem: signal finished() triggering handleTreeScanningFinished()
+    CMakeBuildSystem ->> TreeScanner: call release() to get files
+    deactivate TreeScanner
+    Note right of CMakeBuildSystem: All results are in now...
+    CMakeBuildSystem ->> CMakeBuildSystem: call combineScanAndParse()
+
+    activate CMakeBuildSystem
+    opt: Parsing was a success
+    CMakeBuildSystem ->> CMakeBuildSystem: call updateProjectData()
+    CMakeBuildSystem ->> BuildDirManager: call projectFilesToWatch()
+    BuildDirManager ->> FileApiReader: call projectFilesToWatch()
+    CMakeBuildSystem ->> BuildDirManager: call createRawProjectParts(...)
+    BuildDirManager ->> FileApiReader: call createRawProjectParts(...)
+    CMakeBuildSystem ->> BuildDirManager: call resetData()
+    BuildDirManager ->> FileApiReader: Destruct
+    CMakeBuildSystem ->> ParseGuard: call markAsSuccess()
+    end
+    deactivate FileApiReader
+
+    CMakeBuildSystem ->> ParseGuard: Destruct
+    deactivate ParseGuard
+
+    CMakeBuildSystem ->> CMakeBuildSystem: call emitBuildSystemUpdated()
+    deactivate CMakeBuildSystem
+```
+
+# `FileApiReader`
+
+States in the `FileApiReader`.
+
+```mermaid
+graph TD
+    startState --> startCMakeState
+    startState --> endState
+    startCMakeState --> cmakeFinishedState
+    cmakeFinishedState --> endState
+```
+