blob: ff42461bb1760136aa9767dca0f3850ca53229d4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# `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 --> combineScanAndParse
FileApiReader::parse --> handleParsingFailed
handleParsingFailed --> combineScanAndParse
TreeScanner::asyncScanForFiles --> handleTreeScanningFinished
handleTreeScanningFinished --> combineScanAndParse
```
### Full Sequence Diagram
```mermaid
sequenceDiagram
participant User
participant ParseGuard
participant CMakeBuildSystem
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 ->> CMakeBuildSystem: call setParametersAndRequestReparse()
CMakeBuildSystem ->> CMakeBuildSystem: Validate parameters
CMakeBuildSystem ->> FileApiReader: Construct
activate FileApiReader
CMakeBuildSystem ->> FileApiReader: call setParameters
CMakeBuildSystem ->> CMakeBuildSystem: call request*Reparse()
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 ->>+ FileApiReader: call parse(...)
FileApiReader ->> FileApiReader: startState()
deactivate CMakeBuildSystem
opt Parse
FileApiReader ->> FileApiReader: call startCMakeState(...)
FileApiReader ->> FileApiReader: call cmakeFinishedState(...)
end
FileApiReader ->> FileApiReader: call endState(...)
alt Return Result from FileApiReader
FileApiReader ->> CMakeBuildSystem: signal dataAvailable() and trigger handleParsingSucceeded()
CMakeBuildSystem ->> FileApiReader: call takeBuildTargets()
CMakeBuildSystem ->> FileApiReader: call takeParsedConfiguration(....)
else
FileApiReader ->> CMakeBuildSystem: signal errorOccurred(...) and trigger handelParsingFailed(...)
CMakeBuildSystem ->> FileApiReader: call takeParsedConfiguration(....)
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 ->> FileApiReader: call projectFilesToWatch()
CMakeBuildSystem ->> FileApiReader: call createRawProjectParts(...)
CMakeBuildSystem ->> FileApiReader: call resetData()
CMakeBuildSystem ->> ParseGuard: call markAsSuccess()
end
CMakeBuildSystem ->> ParseGuard: Destruct
deactivate ParseGuard
CMakeBuildSystem ->> CMakeBuildSystem: call emitBuildSystemUpdated()
deactivate FileApiReader
deactivate CMakeBuildSystem
```
# `FileApiReader`
States in the `FileApiReader`.
```mermaid
graph TD
startState --> startCMakeState
startState --> endState
startCMakeState --> cmakeFinishedState
cmakeFinishedState --> endState
```
|
