File: subsystems.md

package info (click to toggle)
foundry 1.1~beta-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 15,552 kB
  • sloc: ansic: 167,487; xml: 417; makefile: 21; sh: 19; javascript: 10
file content (275 lines) | stat: -rw-r--r-- 7,060 bytes parent folder | download | duplicates (2)
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
Title: Subsystems

# Project Contexts

 * [class@Foundry.Context]
 * [class@Foundry.Contextual]
 * [class@Foundry.Inhibitor]

## Context

At the root of the object graph in Foundry is the [class@Foundry.Context].
Generally, it represents a single project on the users system.
However, to allow for project-less use-cases a "shared" context may be created.

See [ctor@Foundry.Context.new] to create a new context for a specific project.
See [ctor@Foundry.Context.new_for_user] to create a new context for the user without involving a project such as for simple text editor or documentation services.

## Contextual

For objects that are to be used solely within the context of a [class@Foundry.Context], subclass [class@Foundry.Contextual].
These objects will have their [property@Foundry.Contextual:context] property cleared when the foundry is shutdown.

Contextuals do not hold a full reference to the [class@Foundry.Context].
Instead it is a weak reference which may be upgraded to a full reference when calling [method@Foundry.Contextual.dup_context].

## Inhibitor

Use [class@Foundry.Inhibitor] to prevent the shutdown of a context during a long running operation.
Calls to [method@Foundry.Context.shutdown] will be asynchornously delayed until the inhibitor as released the shutdown lock.


# Services

Many features in Foundry are implemented through independent services.
The [class@Foundry.Service] base-class is inhereted by these services and attached to the [class@Foundry.Context].

You may implement your own services in your application using libfoundry.
Register the dynamically by calling [method@Foundry.Context.dup_service_typed].


# SDK Management

 * [class@Foundry.SdkManager]
 * [class@Foundry.SdkProvider]
 * [class@Foundry.Sdk]


# Building

 * [class@Foundry.BuildManager]
 * [class@Foundry.BuildPipeline]
 * [class@Foundry.BuildAddin]
 * [class@Foundry.CommandStage]
 * [class@Foundry.BuildProgress]
 * [class@Foundry.BuildFlags]
 * [class@Foundry.CompileCommands]
 * [class@Foundry.DeployStrategy]
 * [class@Foundry.LinkedPipelineStage]


# Running

 * [class@Foundry.RunManager]
 * [class@Foundry.RunTool]


# Build Configuration

 * [class@Foundry.ConfigManager]
 * [class@Foundry.ConfigProvider]
 * [class@Foundry.Config]


# Commands and Subprocesses

 * [class@Foundry.ProcessLauncher]
 * [class@Foundry.UnixFDMap]
 * [class@Foundry.CommandManager]
 * [class@Foundry.CommandProvider]
 * [class@Foundry.Command]


# Managing Terminals

 * [class@Foundry.TerminalLauncher]
 * [class@Foundry.TerminalIntent]
 * [class@Foundry.TerminalService]


# CLI Commands

 * [class@Foundry.CommandLine]
 * [class@Foundry.CliCommandTree]
 * [struct@Foundry.CliCommand]


# Devices

 * [class@Foundry.DeviceManager]
 * [class@Foundry.DeviceProvider]
 * [class@Foundry.DeviceInfo]
 * [class@Foundry.Device]
 * [class@Foundry.LocalDevice]


# Diagnostics

 * [class@Foundry.DiagnosticManager]
 * [class@Foundry.DiagnosticProvider]
 * [class@Foundry.Diagnostic]


# Symbol Extraction

 * [class@Foundry.Symbol]
 * [class@Foundry.SymbolProvider]


# File Management

 * [class@Foundry.FileManager]
 * [class@Foundry.DirectoryListing]
 * [class@Foundry.DirectoryItem]
 * [class@Foundry.DirectoryReaper]
 * [class@Foundry.FileMonitor]
 * [class@Foundry.FileMonitorEvent]


# Settings

 * [class@Foundry.Settings]

Foundry supports robust hierarchical settings which puts the user in control.
The settings are applied in the following order from highest-to-lowest priority.
The first "layer" where a setting has been applied will take priority.

 * User setting with a specific projects `.foundry/user/settings.keyfile`
 * Project setting shared with collaborators in `.foundry/project/settings.keyfile`
 * Application-wide user preferences
 * Application defaults

You may use the `foundry settings` command-line tool or [class@Foundry.Settings] to modify settings at any of these layers.


# Documentation

 * [class@Foundry.DocumentationBundle]
 * [class@Foundry.DocumentationManager]
 * [class@Foundry.DocumentationMatches]
 * [class@Foundry.DocumentationProvider]
 * [class@Foundry.DocumentationQuery]
 * [class@Foundry.DocumentationRoot]
 * [class@Foundry.Documentation]


# Text Editing

 * [class@Foundry.TextManager]
 * [class@Foundry.TextDocument]
 * [class@Foundry.TextDocumentAddin]
 * [class@Foundry.TextBufferProvider]
 * [iface@Foundry.TextBuffer]
 * [class@Foundry.TextEdit]
 * [class@Foundry.SimpleTextBuffer]
 * [class@Foundry.CompletionProvider]
 * [class@Foundry.CompletionProposal]
 * [class@Foundry.CompletionRequest]
 * [class@Foundry.HoverProvider]
 * [class@Foundry.CodeAction]
 * [class@Foundry.OnTypeFormatter]
 * [class@Foundry.OnTypeDiagnostics]
 * [class@Foundry.TextFormatter]
 * [class@Foundry.TextSettings]
 * [class@Foundry.TextSettingsProvider]


# Language Server Protocol

 * [class@Foundry.LspManager]
 * [class@Foundry.LspProvider]
 * [class@Foundry.LspServer]


# Search

 * [class@Foundry.SearchManager]
 * [class@Foundry.SearchProvider]
 * [class@Foundry.SearchRequest]
 * [class@Foundry.SearchResult]


# Flatpak

 * [class@Foundry.FlatpakManifest]


# Version Control

 * [class@Foundry.VcsManager]
 * [class@Foundry.VcsProvider]
 * [class@Foundry.Vcs]
 * [class@Foundry.NoVcs]
 * [class@Foundry.GitVcs]
 * [class@Foundry.VcsBlame]
 * [class@Foundry.VcsTag]
 * [class@Foundry.VcsBranch]
 * [class@Foundry.VcsReference]
 * [class@Foundry.VcsRemote]
 * [class@Foundry.VcsCommit]
 * [class@Foundry.VcsTree]
 * [class@Foundry.VcsDiff]
 * [class@Foundry.VcsDelta]
 * [class@Foundry.VcsSignature]
 * [class@Foundry.VcsLineChanges]


# Operations & Logging

 * [class@Foundry.OperationManager]
 * [class@Foundry.Operation]
 * [class@Foundry.LogManager]
 * [class@Foundry.AuthProvider]


# Unit Testing

 * [class@Foundry.TestManager]
 * [class@Foundry.TestProvider]
 * [class@Foundry.Test]


# Dependency Tracking

 * [class@Foundry.DependencyManager]
 * [class@Foundry.DependencyProvider]
 * [class@Foundry.Dependency]


# Debuggers

 * [class@Foundry.DebuggerManager]
 * [class@Foundry.DebuggerProvider]
 * [class@Foundry.Debugger]
 * [class@Foundry.DebuggerModule]
 * [class@Foundry.DebuggerTarget]
 * [class@Foundry.DebuggerTargetCommand]
 * [class@Foundry.DebuggerTargetProcess]
 * [class@Foundry.DebuggerTargetRemote]
 * [class@Foundry.DebuggerThread]
 * [class@Foundry.DebuggerThreadGroup]
 * [class@Foundry.DebuggerStackFrame]
 * [class@Foundry.DebuggerTrap]
 * [class@Foundry.DebuggerBreakpoint]
 * [class@Foundry.DebuggerWatchpoint]
 * [class@Foundry.DebuggerCountpoint]
 * [class@Foundry.DebuggerSource]
 * [class@Foundry.DebuggerMappedRegion]
 * [class@Foundry.DebuggerInstruction]
 * [class@Foundry.DebuggerEvent]
 * [class@Foundry.DebuggerStopEvent]
 * [class@Foundry.DebuggerVariable]


# Large Language Models

 * [class@Foundry.LlmManager]
 * [class@Foundry.LlmProvider]
 * [class@Foundry.LlmModel]
 * [class@Foundry.LlmCompletion]
 * [class@Foundry.LlmCompletionChunk]
 * [class@Foundry.LlmConversation]
 * [class@Foundry.LlmMessage]
 * [class@Foundry.LlmTool]
 * [class@Foundry.LlmToolCall]