Merge pull request #157 from github0null/dev

v3.8.8 patch

Author: github0null

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ***
 
-### [v3.8.7] revision (v3.8.4 patch)
+### [v3.8.8] revision (patch for v3.8.4)
 
 **New**:
   - Add `Exclude/Include Child Sources` context menu for source folder
@@ -16,6 +16,7 @@
 
 **Optimize**:
   - Format project name when import project from other IDE
+  - Optimize source code structure
 
 ***
 

lib/node-utility

@@ -5,7 +5,7 @@
     "author": {
         "name": "cl",
         "url": "https://github0null.io",
-        "email": "2584456014@qq.com"
+        "email": "me@github0null.io"
     },
     "keywords": [
         "mcu",
@@ -30,10 +30,10 @@
         "cmsis",
         "eclipse"
     ],
-    "homepage": "https://github.com/github0null/eide/blob/master/README.md",
+    "homepage": "https://em-ide.com",
     "license": "MIT",
     "description": "A mcu development environment for 8051/AVR/STM8/Cortex-M/RISC-V",
-    "version": "3.8.7",
+    "version": "3.8.8",
     "preview": false,
     "engines": {
         "vscode": "^1.63.0"

package.json

@@ -33,11 +33,12 @@ import * as child_process from 'child_process';
 import { AbstractProject, VirtualSource } from "./EIDEProject";
 import { ResManager } from "./ResManager";
 import { File } from "../lib/node-utility/File";
+import { ProjectConfigData, ProjectConfiguration } from "./EIDETypeDefine";
 import {
-    ProjectConfigData, ArmBaseCompileData,
+    ArmBaseCompileData,
     Memory, ARMStorageLayout, ICompileOptions,
-    FloatingHardwareOption, ProjectConfiguration, C51BaseCompileData, RiscvCompileData, AnyGccCompileData
-} from "./EIDETypeDefine";
+    FloatingHardwareOption, C51BaseCompileData, RiscvCompileData, AnyGccCompileData
+} from './EIDEProjectModules';
 import { SettingManager } from "./SettingManager";
 import { GlobalEvent } from "./GlobalEvents";
 import { ExceptionToMessage, newMessage } from "./Message";
@@ -133,7 +134,7 @@ export abstract class CodeBuilder {
             for (const source of group.files) {
                 if (source.disabled) continue; // skip disabled file
                 if (!filter.some((reg) => reg.test(source.file.path))) continue; // skip non-source
-                const rePath = this.project.ToRelativePath(source.file.path, false);
+                const rePath = this.project.ToRelativePath(source.file.path);
                 const fInfo: any = { path: rePath || source.file.path }
                 if (AbstractProject.isVirtualSourceGroup(group)) {
                     fInfo.virtualPath = `${group.name}/${source.file.name}`.replace(`${VirtualSource.rootName}/`, '');
@@ -403,8 +404,8 @@ export abstract class CodeBuilder {
             outDir: File.ToLocalPath(outDir),
             ram: memMaxSize?.ram,
             rom: memMaxSize?.rom,
-            incDirs: this.getIncludeDirs().map((incPath) => { return this.project.ToRelativePath(incPath, false) || incPath; }),
-            libDirs: this.getLibDirs().map((libPath) => { return this.project.ToRelativePath(libPath, false) || libPath; }),
+            incDirs: this.getIncludeDirs().map((incPath) => { return this.project.ToRelativePath(incPath) || incPath; }),
+            libDirs: this.getLibDirs().map((libPath) => { return this.project.ToRelativePath(libPath) || libPath; }),
             defines: this.getDefineList(),
             sourceList: sourceInfo.sources.sort(),
             sourceParams: sourceInfo.params,

src/CodeBuilder.ts

@@ -24,7 +24,7 @@
 
 import { AbstractProject } from "./EIDEProject";
 import { File } from "../lib/node-utility/File";
-import { ArmBaseCompileData, C51BaseCompileData } from "./EIDETypeDefine";
+import { ArmBaseCompileData } from "./EIDEProjectModules";
 import { ResManager } from "./ResManager";
 import { GlobalEvent } from "./GlobalEvents";
 import { newMessage } from "./Message";

src/DebugConfigGenerator.ts

@@ -29,9 +29,10 @@ import * as NodePath from 'path';
 import { File } from '../lib/node-utility/File';
 import { DeleteDir, DeleteAllChildren } from './Platform';
 import {
-    ProjectConfiguration, Component, Dependence,
-    DependenceGroup, ProjectType, ManagerInterface, ComponentFileItem
+    ProjectConfiguration, Dependence,
+    DependenceGroup, ProjectType, ManagerInterface
 } from './EIDETypeDefine';
+import { Component, ComponentFileItem } from './EIDEProjectModules';
 import { GlobalEvent } from './GlobalEvents';
 import { SettingManager } from './SettingManager';
 import { ExceptionToMessage } from './Message';

src/DependenceManager.ts

@@ -40,10 +40,10 @@ import { KeilParser } from './KeilXmlParser';
 import { ResManager } from './ResManager';
 import { SevenZipper } from './Compress';
 import {
-    CurrentDevice, ConfigMap, FileGroup,
+    ConfigMap, FileGroup,
     ProjectConfiguration, ProjectConfigData, WorkspaceConfiguration,
     CreateOptions,
-    ProjectConfigEvent, ProjectFileGroup, EventData, FileItem, EIDE_CONF_VERSION, ProjectTargetInfo, VirtualFolder, VirtualFile, CompileConfigModel, ArmBaseCompileData, ArmBaseCompileConfigModel, Dependence, CppConfigItem, ICompileOptions
+    ProjectConfigEvent, ProjectFileGroup, FileItem, EIDE_CONF_VERSION, ProjectTargetInfo, VirtualFolder, VirtualFile, CppConfigItem
 } from './EIDETypeDefine';
 import { ToolchainName, IToolchian, ToolchainManager } from './ToolchainManager';
 import { GlobalEvent } from './GlobalEvents';
@@ -66,6 +66,7 @@ import { ExeCmd } from '../lib/node-utility/Executable';
 import { jsonc } from 'jsonc';
 import * as iconv from 'iconv-lite';
 import * as globmatch from 'micromatch'
+import { ICompileOptions, EventData, CurrentDevice, ArmBaseCompileConfigModel } from './EIDEProjectModules';
 
 export class CheckError extends Error {
 }
@@ -553,7 +554,7 @@ class SourceRootList implements SourceProvider {
     }
 
     private getRelativePath(abspath: string): string {
-        return this.project.ToRelativePath(abspath, false) || abspath;
+        return this.project.ToRelativePath(abspath) || abspath;
     }
 
     private newSourceInfo(displayName: string, watcher: FileWatcher): SourceRootInfo {
@@ -599,7 +600,7 @@ class SourceRootList implements SourceProvider {
 
         // exclude some root folder when add files to custom include paths
         const disableInclude: boolean = AbstractProject.excludeIncSearchList.includes(
-            this.project.ToRelativePath(rootFolder.path, false) || rootFolder.path
+            this.project.ToRelativePath(rootFolder.path) || rootFolder.path
         );
 
         const sourceFilter = this.isAutoSearchObjFile ?
@@ -1089,9 +1090,9 @@ export abstract class AbstractProject implements CustomConfigurationProvider {
      * Relative path root folder: `<Project_Root_Folder>`
      * 
      * @param path absolute path
-     * @param hasPrefix Whether add a './' prefix before relative path, default is 'true'
+     * 
      */
-    ToRelativePath(path: string, hasPrefix: boolean = true): string | undefined {
+    ToRelativePath(path: string): string | undefined {
         return this.GetRootDir().ToRelativePath(path.trim());
     }
 
@@ -2073,7 +2074,7 @@ class EIDEProject extends AbstractProject {
 
             // filesystem files
             if (typeof this.srcExtraCompilerConfig?.files == 'object') {
-                matcher(this.srcExtraCompilerConfig?.files, this.ToRelativePath(srcPath, false) || srcPath);
+                matcher(this.srcExtraCompilerConfig?.files, this.ToRelativePath(srcPath) || srcPath);
             }
 
             // virtual files
@@ -2220,7 +2221,7 @@ class EIDEProject extends AbstractProject {
             File.fromArray([wsFile.dir, AbstractProject.EIDE_DIR, AbstractProject.prjConfigName]), option.type);
 
         // set project name
-        prjConfig.config.name = AbstractProject.formatProjectName(option.name);
+        prjConfig.config.name = option.projectName || AbstractProject.formatProjectName(option.name);
 
         return {
             rootFolder: rootDir,
@@ -2231,7 +2232,7 @@ class EIDEProject extends AbstractProject {
 
     protected create(option: CreateOptions): File {
         const baseInfo = this.createBase(option);
-        baseInfo.prjConfig.config.name = AbstractProject.formatProjectName(option.name);
+        baseInfo.prjConfig.config.name = option.projectName || AbstractProject.formatProjectName(option.name);
         baseInfo.prjConfig.config.outDir = 'build';
         baseInfo.prjConfig.config.srcDirs = [];
         baseInfo.prjConfig.Save();
@@ -2279,7 +2280,7 @@ class EIDEProject extends AbstractProject {
             // is filesystem source
             if (!AbstractProject.isVirtualSourceGroup(_group)) {
                 const group = <ProjectFileGroup>_group;
-                const rePath = this.ToRelativePath(group.dir.path, false);
+                const rePath = this.ToRelativePath(group.dir.path);
                 // combine HAL folder
                 if (rePath && rePath.startsWith(DependenceManager.DEPENDENCE_DIR)) {
                     halFiles = halFiles.concat(group.files);

src/EIDEProject.ts

@@ -35,7 +35,8 @@ import { ResManager } from './ResManager';
 import { GlobalEvent } from './GlobalEvents';
 import { AbstractProject, CheckError, DataChangeType, VirtualSource } from './EIDEProject';
 import { ToolchainName, ToolchainManager } from './ToolchainManager';
-import { CreateOptions, PackInfo, ComponentFileItem, DeviceInfo, getComponentKeyDescription, VirtualFolder, VirtualFile, ImportOptions, ProjectTargetInfo, ArmBaseCompileData, ProjectConfigData, ProjectType, ArmBaseCompileConfigModel, RiscvCompileData, AnyGccCompileData } from './EIDETypeDefine';
+import { CreateOptions, VirtualFolder, VirtualFile, ImportOptions, ProjectTargetInfo, ProjectConfigData, ProjectType } from './EIDETypeDefine';
+import { PackInfo, ComponentFileItem, DeviceInfo, getComponentKeyDescription, ArmBaseCompileData, ArmBaseCompileConfigModel, RiscvCompileData, AnyGccCompileData } from "./EIDEProjectModules";
 import { WorkspaceManager } from './WorkspaceManager';
 import {
     can_not_close_project, project_is_opened, project_load_failed,
@@ -1448,6 +1449,7 @@ class ProjectDataProvider implements vscode.TreeDataProvider<ProjTreeItem> {
 
         const basePrj = AbstractProject.NewProject().createBase({
             name: ePrjInfo.name,
+            projectName: ePrjInfo.name,
             type: nPrjType,
             outDir: ePrjRoot
         }, false);
@@ -1459,7 +1461,7 @@ class ProjectDataProvider implements vscode.TreeDataProvider<ProjTreeItem> {
         nPrjConfig.outDir = 'build';
         nPrjConfig.srcDirs = File.NotMatchFilter(ePrjRoot.GetList(File.EMPTY_FILTER), File.EMPTY_FILTER,
             [/^\./, /^(build|dist|out|bin|obj|exe|debug|release|log[s]?|ipch|docs|doc|img|image[s]?)$/i])
-            .map(d => ePrjRoot.ToRelativePath(d.path, false) || d.path);
+            .map(d => ePrjRoot.ToRelativePath(d.path) || d.path);
 
         // init all target
         for (const eTarget of ePrjInfo.targets) {
@@ -1752,6 +1754,7 @@ class ProjectDataProvider implements vscode.TreeDataProvider<ProjTreeItem> {
 
         const baseInfo = AbstractProject.NewProject().createBase({
             name: nPrjOutDir.name,
+            projectName: keilPrjFile.noSuffixName,
             type: targets[0].type,
             outDir: nPrjOutDir
         }, false);
@@ -1835,7 +1838,7 @@ class ProjectDataProvider implements vscode.TreeDataProvider<ProjTreeItem> {
                             if (!srcFile.IsFile()) { continue; }
                             if (dep.category == 'source' && !vFolder) { continue; }
 
-                            let srcRePath: string | undefined = baseInfo.rootFolder.ToRelativePath(srcFile.path, false);
+                            let srcRePath: string | undefined = baseInfo.rootFolder.ToRelativePath(srcFile.path);
 
                             /* if it's not in workspace, copy it */
                             if (srcRePath == undefined) {
@@ -1887,7 +1890,7 @@ class ProjectDataProvider implements vscode.TreeDataProvider<ProjTreeItem> {
                     let locate = dep.packPath;
                     if (dep.instance) {
                         locate = baseInfo.rootFolder
-                            .ToRelativePath(dep.instance[0], false) || dep.instance[0]
+                            .ToRelativePath(dep.instance[0]) || dep.instance[0]
                     }
 
                     const nLine: string[] = [
@@ -3328,7 +3331,7 @@ export class ProjectExplorer implements CustomConfigurationProvider {
                 for (const folderUri of folderList) {
 
                     const folderPath = folderUri.fsPath;
-                    const rePath = prj.ToRelativePath(folderPath, false);
+                    const rePath = prj.ToRelativePath(folderPath);
 
                     // if can't calculate repath, skip
                     if (rePath === undefined || rePath.trim() === '') {
@@ -3841,7 +3844,7 @@ export class ProjectExplorer implements CustomConfigurationProvider {
                     if (source.disabled) continue;
                     // skip non-source and asm file
                     if (!srcFilter.test(source.file.path)) continue;
-                    const rePath = confRootDir.ToRelativePath(source.file.path, false);
+                    const rePath = confRootDir.ToRelativePath(source.file.path);
                     srcList.push(rePath || source.file.path);
                 }
             }
@@ -4388,7 +4391,7 @@ export class ProjectExplorer implements CustomConfigurationProvider {
         if (uris && uris.length > 0) {
             const dupLi = prj
                 .addIncludePaths(uris.map(uri => { return uri.fsPath; }))
-                .map(path => prj.ToRelativePath(path, false) || path);
+                .map(path => prj.ToRelativePath(path) || path);
             if (dupLi.length > 0) {
                 const msg = `${dupLi.length} redundant include paths (ignored): ${JSON.stringify(dupLi)}`;
                 GlobalEvent.emit('msg', newMessage('Warning', msg));
@@ -4445,14 +4448,14 @@ export class ProjectExplorer implements CustomConfigurationProvider {
         prj.GetConfiguration().getAllDepGroup().forEach((group) => {
             for (const dep of group.depList) {
                 for (const incPath of dep.incList) {
-                    includesMap.set(prj.ToRelativePath(incPath, false) || incPath, group.groupName);
+                    includesMap.set(prj.ToRelativePath(incPath) || incPath, group.groupName);
                 }
             }
         });
 
         // add source include paths
         prj.getSourceIncludeList().forEach((incPath) => {
-            includesMap.set(prj.ToRelativePath(incPath, false) || incPath, 'source');
+            includesMap.set(prj.ToRelativePath(incPath) || incPath, 'source');
         });
 
         for (const keyVal of includesMap) {
@@ -4489,7 +4492,7 @@ export class ProjectExplorer implements CustomConfigurationProvider {
         prj.GetConfiguration().getAllDepGroup().forEach((group) => {
             for (const dep of group.depList) {
                 for (const libPath of dep.libList) {
-                    libMaps.set(prj.ToRelativePath(libPath, false) || libPath, group.groupName);
+                    libMaps.set(prj.ToRelativePath(libPath) || libPath, group.groupName);
                 }
             }
         });