Merge pull request #193 from github0null/dev

v3.10.6 update

Author: github0null

CHANGELOG.md

@@ -6,6 +6,19 @@ All notable version changes will be recorded in this file.
 
 ***
 
+### [v3.10.6] revision
+
+**Fix**:
+  - `cpptools configuration provider not work`: Fix provider file filter bug.
+
+**Optimize**:
+  - `Resource Explorer`: Keep `non-existed` filesystem source folders. Optimize folder watcher
+  - `Settings Scope`: Allow user override more eide settings by `workspace settings`.
+  - `FileWatcher`: Auto close file watcher if watcher has an error.
+  - `Prompt messages`: Optimize some UI hint messages.
+
+***
+
 ### [v3.10.5] revision
 
 **Fix**:

lib/node-utility

@@ -35,7 +35,7 @@
     "homepage": "https://em-ide.com",
     "license": "MIT",
     "description": "A mcu development environment for 8051/AVR/STM8/Cortex-M/RISC-V",
-    "version": "3.10.5",
+    "version": "3.10.6",
     "preview": false,
     "engines": {
         "vscode": "^1.63.0"

package.json

@@ -278,7 +278,7 @@ export abstract class CodeBuilder {
             this.logWatcher = new FileWatcher(builderLog, false);
             this.logWatcher.OnChanged = () => {
                 this.logWatcher?.Close();
-                setTimeout(() => this.emit('finished', checkBuildDone(builderLog)), 400);
+                setTimeout(() => this.emit('finished', checkBuildDone(builderLog)), 500);
             };
 
             // start watch

src/CodeBuilder.ts

@@ -96,6 +96,7 @@ export interface FolderInfo {
 }
 
 interface SourceRootInfo extends FolderInfo {
+    isValid: () => boolean;
     fileWatcher: FileWatcher;
     fileGroups: ProjectFileGroup[];
     incList: string[];
@@ -383,6 +384,7 @@ class SourceRootList implements SourceProvider {
         this.project = _project;
         this._event = new events.EventEmitter();
         this.srcFolderMaps = new Map();
+        FileWatcher.on('rename', f => this.onFolderRenamed(this.getSourceRootKeyByAbspath(f.path), f));
     }
 
     isAutoSearchObjectFile(): boolean {
@@ -400,13 +402,7 @@ class SourceRootList implements SourceProvider {
         const srcFolders = this.project.GetConfiguration().config.srcDirs;
         srcFolders.forEach((path) => {
             const f = new File(path);
-            if (f.IsDir()) {
-                const key: string = this.getRelativePath(path);
-                const watcher = platform.createSafetyFileWatcher(f, true).Watch();
-                watcher.on('error', (err) => GlobalEvent.emit('msg', ExceptionToMessage(err, 'Hidden')));
-                watcher.OnRename = (file) => this.onFolderRenamed(key, file);
-                this.srcFolderMaps.set(key, this.newSourceInfo(key, watcher));
-            }
+            this._add(f);
         });
 
         // update all
@@ -417,23 +413,24 @@ class SourceRootList implements SourceProvider {
         if (!notEmitEvt) { this.emit('dataChanged', 'dataChanged'); }
     }
 
+    private _add(dir: File): SourceRootInfo {
+        const key: string = this.getSourceRootKeyByAbspath(dir.path);
+        const watcher = platform.createSafetyFileWatcher(dir, true);
+        watcher.on('error', (err) => GlobalEvent.emit('globalLog', ExceptionToMessage(err, 'Warning')));
+        const sourceInfo = this.newSourceInfo(key, watcher);
+        this.srcFolderMaps.set(key, sourceInfo);
+        return sourceInfo;
+    }
+
     add(absPath: string): boolean {
-        const f = new File(absPath);
-        if (f.IsDir()) {
-            const key: string = this.getRelativePath(absPath);
-            const watcher = platform.createSafetyFileWatcher(f, true).Watch();
-            watcher.on('error', (err) => GlobalEvent.emit('msg', ExceptionToMessage(err, 'Hidden')));
-            watcher.OnRename = (file) => this.onFolderRenamed(key, file);
-            const sourceInfo = this.newSourceInfo(key, watcher);
-            this.srcFolderMaps.set(key, sourceInfo);
-            this.updateFolder(sourceInfo);
-            return true;
-        }
-        return false;
+        const dir = new File(absPath);
+        const sourceInfo = this._add(dir);
+        this.updateFolder(sourceInfo);
+        return true;
     }
 
     remove(absPath: string): boolean {
-        const key = this.getRelativePath(absPath);
+        const key = this.getSourceRootKeyByAbspath(absPath);
         return this.removeByKey(key);
     }
 
@@ -470,7 +467,7 @@ class SourceRootList implements SourceProvider {
         if (rootSrcUpdateList.length > 0) {
 
             for (const rootInfo of rootSrcUpdateList) {
-                if (rootInfo.fileWatcher.file.IsDir()) {
+                if (rootInfo.isValid()) {
                     this.updateFolder(rootInfo, [targetDir]);
                 }
             }
@@ -527,6 +524,26 @@ class SourceRootList implements SourceProvider {
         return res;
     }
 
+    isIncludes(abspath: string): boolean {
+
+        if (!File.isAbsolute(abspath)) {
+            abspath = this.project.toAbsolutePath(abspath);
+        }
+
+        const unixPath = File.ToUnixPath(abspath);
+
+        for (const rootInfo of this.srcFolderMaps.values()) {
+            const unixRootPath = File.ToUnixPath(rootInfo.fileWatcher.file.path);
+            const unixRootRealPath = File.ToUnixPath(platform.realpathSync(rootInfo.fileWatcher.file.path));
+            if (unixPath.startsWith(unixRootPath) ||
+                unixPath.startsWith(unixRootRealPath)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     forceUpdateAllFolders() {
         for (const info of this.srcFolderMaps.values()) {
             this.updateFolder(info);
@@ -537,13 +554,8 @@ class SourceRootList implements SourceProvider {
     forceUpdateFolder(rePath: string) {
         const rootInfo = this.srcFolderMaps.get(rePath);
         if (rootInfo) {
-            if (rootInfo.fileWatcher.file.IsDir()) {
-                this.updateFolder(rootInfo);
-                this.emit('dataChanged', 'folderChanged');
-            } else {
-                this.removeByKey(rePath);
-                this.emit('dataChanged', 'dataChanged');
-            }
+            this.updateFolder(rootInfo);
+            this.emit('dataChanged', 'folderChanged');
         }
     }
 
@@ -554,42 +566,51 @@ class SourceRootList implements SourceProvider {
         this._event.emit(event, arg);
     }
 
-    private getRelativePath(abspath: string): string {
+    private getSourceRootKeyByAbspath(abspath: string): string {
         return this.project.toRelativePath(abspath);
     }
 
     private newSourceInfo(displayName: string, watcher: FileWatcher): SourceRootInfo {
         return {
             displayName: displayName,
             fileWatcher: watcher,
+            isValid: () => watcher.file.IsDir(),
             needUpdate: false,
             fileGroups: [],
             incList: []
         };
     }
 
-    private removeByKey(key: string): boolean {
+    private disposeWatcher(key: string): void {
         this.srcFolderMaps.get(key)?.fileWatcher.Close();
+    }
+
+    private removeByKey(key: string): boolean {
+        this.disposeWatcher(key);
         return this.srcFolderMaps.delete(key);
     }
 
     private onFolderRenamed(folderKey: string, targetFile: File) {
         const rootInfo = this.srcFolderMaps.get(folderKey);
         if (rootInfo) {
-            if (targetFile.path === rootInfo.fileWatcher.file.path) { // root folder has been renamed
-                if (this.removeByKey(folderKey)) { this.emit('dataChanged', 'dataChanged'); }
+
+            // folder self has been renamed ?
+            // - if true, this folder's file watcher is invalid, dispose it
+            if (targetFile.path == rootInfo.fileWatcher.file.path) {
+                this.disposeWatcher(folderKey);
+                this.emit('dataChanged', 'folderStatusChanged');
+            }
+
+            if (rootInfo.refreshTimeout) {
+                rootInfo.refreshTimeout.refresh();
             } else {
-                if (rootInfo.refreshTimeout) {
-                    rootInfo.refreshTimeout.refresh();
-                } else {
-                    rootInfo.refreshTimeout = setTimeout((folderInfo: SourceRootInfo) => {
-                        if (folderInfo.refreshTimeout) {
-                            folderInfo.refreshTimeout = undefined;
-                            this.updateFolder(folderInfo);
-                            this.emit('dataChanged', 'folderChanged');
-                        }
-                    }, 100, rootInfo);
-                }
+                rootInfo.refreshTimeout = setTimeout((folderInfo: SourceRootInfo) => {
+                    if (folderInfo.refreshTimeout) {
+                        folderInfo.refreshTimeout = undefined;
+                        this.updateFolder(folderInfo);
+                        this.emit('dataChanged', 'folderChanged');
+                    }
+                }, 200, rootInfo);
             }
         }
     }
@@ -619,6 +640,9 @@ class SourceRootList implements SourceProvider {
             rootFolderInfo.incList = [];
             rootFolderInfo.fileGroups = [];
             folderStack.push(rootFolder);
+            // if source root have no watcher, watch it !
+            if (rootFolderInfo.isValid() && !rootFolderInfo.fileWatcher.IsWatched())
+                rootFolderInfo.fileWatcher.Watch();
         }
 
         rootFolderInfo.needUpdate = false;
@@ -629,9 +653,14 @@ class SourceRootList implements SourceProvider {
 
                 const cFolder = <File>folderStack.pop();
                 const isSourceRoot = cFolder.path === rootFolder.path;
-                if (cFolder.name.startsWith('.') && !isSourceRoot) continue; // skip '.xxx' folders, not root folder
-                const fileList = cFolder.GetList(fileFilter, File.EXCLUDE_ALL_FILTER);
 
+                if (!cFolder.IsDir())
+                    continue; // skip not-existed folder
+
+                if (cFolder.name.startsWith('.') && !isSourceRoot)
+                    continue; // skip sub '.xxx' folders, but not root folder
+
+                const fileList = cFolder.GetList(fileFilter, File.EXCLUDE_ALL_FILTER);
                 if (fileList.length > 0) {
 
                     // filter source file and add to file group
@@ -679,7 +708,7 @@ class SourceRootList implements SourceProvider {
 
         } catch (error) {
             rootFolderInfo.needUpdate = true; // set need update flag
-            GlobalEvent.emit('msg', ExceptionToMessage(error, 'Hidden'));
+            GlobalEvent.emit('globalLog', ExceptionToMessage(error, 'Warning'));
         }
     }
 }
@@ -724,7 +753,7 @@ export abstract class AbstractProject implements CustomConfigurationProvider, Pr
     static readonly excludeDirFilter: RegExp = /^\./;
 
     // to show output files
-    static readonly buildOutputMatcher: RegExp = /\.(?:elf|axf|out|a|lib|hex|ihx|bin|s19|s37|sct|icf|ld[s]?|map|map\.view)$/i;
+    static readonly buildOutputMatcher: RegExp = /\.(?:elf|axf|out|a|lib|hex|ihx|bin|s19|s37|sct|icf|ld[s]?|map|map\.view|lst)$/i;
 
     //-------
 
@@ -1125,7 +1154,7 @@ export abstract class AbstractProject implements CustomConfigurationProvider, Pr
 
     replacePathEnv(path: string): string {
 
-        for (let cnt = 0; cnt < 5; cnt++) {
+        for (let cnt = 0; cnt < 3; cnt++) {
 
             if (!File.isEnvPath(path))
                 break; // not have any env var, end
@@ -2367,6 +2396,12 @@ class EIDEProject extends AbstractProject {
         return this.srcRefMap.get(file.path) || [];
     }
 
+    public getSourceRefsAll(): string[] {
+        const allHeaders: string[] = [];
+        this.srcRefMap.forEach(v => v.forEach(f => allHeaders.push(f.path)));
+        return ArrayDelRepetition(allHeaders);
+    }
+
     private whitespaceMatcher = /(?<![\\:]) /;
 
     private gnu_parseRefLines(lines: string[]): string[] {
@@ -2668,6 +2703,7 @@ class EIDEProject extends AbstractProject {
 
             const fileAssCfg: any = {
                 ".eideignore": "ignore",
+                "*.a51": "a51",
                 "*.h": "c",
                 "*.c": "c",
                 "*.hxx": "cpp",
@@ -2856,20 +2892,6 @@ class EIDEProject extends AbstractProject {
                     //
                 }
             }
-
-            /* const cppConfig = this.GetCppConfig();
-            const cppConfigItem = cppConfig.getConfig();
-            if (cppConfigItem.configurationProvider) {
-                const newCfg: CppConfigItem = {
-                    name: os.platform(),
-                    includePath: <any>undefined,
-                    defines: <any>undefined,
-                    intelliSenseMode: "${default}",
-                    configurationProvider: this.extensionId
-                };
-                cppConfig.setConfig(newCfg);
-                cppConfig.saveToFile();
-            } */
         }
 
         // show warnings if we have
@@ -3107,14 +3129,30 @@ class EIDEProject extends AbstractProject {
     }
 
     canProvideConfiguration(uri: vscode.Uri, token?: vscode.CancellationToken | undefined): Thenable<boolean> {
+
         return new Promise((resolve) => {
-            const filePath = platform.realpathSync(uri.fsPath);
+
+            const realPath = platform.realpathSync(uri.fsPath);
+            const lowcasePath = uri.fsPath.toLowerCase();
             const prjRoot = platform.realpathSync(this.GetRootDir().path);
-            resolve(
-                AbstractProject.headerFilter.test(filePath) ||
-                filePath.startsWith(prjRoot) ||
-                this.vSourceList.has(filePath)
-            );
+            const allIncPaths = this.cppToolsConfig.includePath.map(p => File.ToLocalPath(p.toLowerCase()));
+
+            // filter source files that can provide
+            let result: boolean =
+                realPath.startsWith(prjRoot) ||                      // All source files in current workspace
+                allIncPaths.some(p => lowcasePath.startsWith(p)) ||  // All files in IncludePaths
+                this.vSourceList.has(realPath) ||                    // All virtual source files
+                this.sourceRoots.isIncludes(realPath);               // All source files in linked source folders
+
+            // other .h files
+            if (!result && AbstractProject.headerFilter.test(lowcasePath)) {
+                const allHeaders = this.getSourceRefsAll().map(p => File.ToLocalPath(p.toLowerCase()));
+                result = result ||
+                    allHeaders.some(p => p == lowcasePath) || // All .h files for this project
+                    lowcasePath.startsWith(this.getToolchain().getToolchainDir().path.toLowerCase()); // All .h files in toolchain dir
+            }
+
+            resolve(result);
         });
     }
 
@@ -3123,6 +3161,7 @@ class EIDEProject extends AbstractProject {
     provideConfigurations(uris: vscode.Uri[], token?: vscode.CancellationToken | undefined): Thenable<SourceFileConfigurationItem[]> {
 
         return new Promise((resolve) => {
+
             resolve(uris.map((uri) => {
 
                 let fileArgs: string[] | undefined;