aboutsummaryrefslogtreecommitdiffstats
path: root/qt-core/src/project.ts
blob: 5a438a045661fff4dd55e43c0f32959b41cfa5fd (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
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
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only

import * as vscode from 'vscode';
import untildify from 'untildify';
import { isEqual } from 'lodash';

import {
  AdditionalQtPathsName,
  createLogger,
  GlobalWorkspace,
  QtInsRootConfigName,
  QtAdditionalPath,
  compareQtAdditionalPath
} from 'qt-lib';
import { Project, ProjectManager } from 'qt-lib';
import { convertAdditionalQtPaths, getConfiguration } from '@/util';
import { GlobalStateManager, WorkspaceStateManager } from '@/state';
import {
  getCurrentGlobalQtInstallationRoot,
  getCurrentGlobalAdditionalQtPaths,
  onQtInsRootUpdated,
  onAdditionalQtPathsUpdated
} from '@/installation-root';
import { coreAPI } from '@/extension';

const logger = createLogger('project');

export async function createCoreProject(
  folder: vscode.WorkspaceFolder,
  context: vscode.ExtensionContext
) {
  logger.info('Creating project:"' + folder.uri.fsPath + '"');
  return Promise.resolve(new CoreProject(folder, context));
}

// Project class represents a workspace folder in the extension.
export class CoreProject implements Project {
  private readonly _disposables: vscode.Disposable[] = [];
  private readonly _stateManager: WorkspaceStateManager;
  private _qtInstallationRoot: string | undefined;
  constructor(
    private readonly _folder: vscode.WorkspaceFolder,
    readonly _context: vscode.ExtensionContext
  ) {
    this._stateManager = new WorkspaceStateManager(_context, _folder);
    this.watchWorkspaceFolderConfig(_folder);
  }
  set qtInstallationRoot(value: string) {
    this._qtInstallationRoot = value;
  }
  get qtInstallationRoot() {
    return this._qtInstallationRoot ?? '';
  }
  get stateManager() {
    return this._stateManager;
  }
  get folder() {
    return this._folder;
  }

  public async reset() {
    return this.stateManager.reset();
  }

  private watchWorkspaceFolderConfig(folder: vscode.WorkspaceFolder) {
    const eventHandler = vscode.workspace.onDidChangeConfiguration(
      (e: vscode.ConfigurationChangeEvent) => {
        void e;
        const previousQtInsRoot = this.stateManager.getQtInstallationRoot();
        const currentQtInsRoot =
          CoreProjectManager.getWorkspaceFolderQtInsRoot(folder);
        if (currentQtInsRoot !== previousQtInsRoot) {
          void this.stateManager.setQtInstallationRoot(currentQtInsRoot);
          onQtInsRootUpdated(currentQtInsRoot, folder);
        }
        const previousAdditionalQtPaths =
          this.stateManager.getAdditionalQtPaths();
        const currentAdditionalQtPaths =
          CoreProjectManager.getWorkspaceFolderAdditionalQtPaths(folder);

        if (
          !isEqual(
            currentAdditionalQtPaths.sort(),
            previousAdditionalQtPaths.sort()
          )
        ) {
          void this.stateManager.setAdditionalQtPaths(currentAdditionalQtPaths);
          onAdditionalQtPathsUpdated(currentAdditionalQtPaths, folder);
        }
      }
    );
    this._disposables.push(eventHandler);
  }

  public initConfigValues() {
    const folder = this.folder;
    const qtInsRoot = CoreProjectManager.getWorkspaceFolderQtInsRoot(folder);
    coreAPI?.setValue(folder, QtInsRootConfigName, qtInsRoot);
    logger.info(
      `Setting Qt installation root for ${folder.uri.fsPath} to: ${qtInsRoot}`
    );
    const additionalQtPaths =
      CoreProjectManager.getWorkspaceFolderAdditionalQtPaths(folder);
    coreAPI?.setValue(folder, AdditionalQtPathsName, additionalQtPaths);
    logger.info(
      `Setting additional Qt paths for ${folder.uri.fsPath} to: ${additionalQtPaths.join(', ')}`
    );
    logger.info('Config values initialized for:', folder.uri.fsPath);
  }

  dispose() {
    logger.info('Disposing project:', this._folder.uri.fsPath);
    for (const d of this._disposables) {
      d.dispose();
    }
  }
}

export class CoreProjectManager extends ProjectManager<CoreProject> {
  globalStateManager: GlobalStateManager;
  workspaceFile: vscode.Uri | undefined;
  constructor(override readonly context: vscode.ExtensionContext) {
    super(context, createCoreProject);
    this.globalStateManager = new GlobalStateManager(context);
    this.watchGlobalConfig();

    this.onProjectAdded((project: CoreProject) => {
      logger.info('Adding project:', project.folder.uri.fsPath);
      project.initConfigValues();
    });
  }
  private watchGlobalConfig() {
    this._disposables.push(
      vscode.workspace.onDidChangeConfiguration(
        (e: vscode.ConfigurationChangeEvent) => {
          void e;
          const previousQtInsRoot =
            this.globalStateManager.getQtInstallationRoot();
          const currentQtInsRoot = getCurrentGlobalQtInstallationRoot();
          if (currentQtInsRoot !== previousQtInsRoot) {
            void this.globalStateManager.setQtInstallationRoot(
              currentQtInsRoot
            );
            onQtInsRootUpdated(currentQtInsRoot, GlobalWorkspace);
          }
          const previousAdditionalQtPaths =
            this.globalStateManager.getAdditionalQtPaths();
          const currentAdditionalQtPaths = getCurrentGlobalAdditionalQtPaths();
          if (
            !isEqual(
              currentAdditionalQtPaths.sort(compareQtAdditionalPath),
              previousAdditionalQtPaths.sort(compareQtAdditionalPath)
            )
          ) {
            void this.globalStateManager.setAdditionalQtPaths(
              currentAdditionalQtPaths
            );
            onAdditionalQtPathsUpdated(
              currentAdditionalQtPaths,
              GlobalWorkspace
            );
          }
        }
      )
    );
  }
  public static getWorkspaceFolderQtInsRoot(folder: vscode.WorkspaceFolder) {
    const qtInsRootConfig =
      getConfiguration(folder).inspect<string>(QtInsRootConfigName);
    const workspaceFolderValue = qtInsRootConfig?.workspaceFolderValue;
    return workspaceFolderValue ? untildify(workspaceFolderValue) : '';
  }

  public static getWorkspaceFolderAdditionalQtPaths(
    folder: vscode.WorkspaceFolder
  ): QtAdditionalPath[] {
    const config = getConfiguration(folder).inspect<(string | object)[]>(
      AdditionalQtPathsName
    );
    if (config?.workspaceFolderValue) {
      return convertAdditionalQtPaths(config.workspaceFolderValue);
    }
    return [];
  }
  public addWorkspaceFile(workspaceFile: vscode.Uri) {
    this.workspaceFile = workspaceFile;
    this.watchWorkspaceFileConfig(this.context);
  }
  private getWorkspaceFileQtInsRoot() {
    const qtInsRootConfig = getConfiguration(
      this.workspaceFile
    ).inspect<string>(QtInsRootConfigName);
    return qtInsRootConfig?.workspaceValue ?? '';
  }
  private getWorkspaceFileQtAdditionalPaths() {
    const additionalQtPaths = getConfiguration(
      this.workspaceFile
    ).inspect<string>(AdditionalQtPathsName);
    return additionalQtPaths?.workspaceValue ?? '';
  }
  private watchWorkspaceFileConfig(context: vscode.ExtensionContext) {
    context.subscriptions.push(
      vscode.workspace.onDidChangeConfiguration(
        (e: vscode.ConfigurationChangeEvent) => {
          void e;
          if (this.getWorkspaceFileQtInsRoot() !== '') {
            void vscode.window.showWarningMessage(
              `Qt installation root specified in workspace file is not supported.`
            );
          }
          if (this.getWorkspaceFileQtAdditionalPaths() !== '') {
            void vscode.window.showWarningMessage(
              `Additional Qt paths specified in workspace file are not supported.`
            );
          }
        }
      )
    );
  }
  public reset() {
    void this.globalStateManager.reset();
    for (const project of this.projects) {
      void project.reset();
    }
  }
}