Skip to content

Commit

Permalink
Merge branch 'main' into outbound/apiVersion2
Browse files Browse the repository at this point in the history
  • Loading branch information
@edriouk
edriouk authored Sep 29, 2023
2 parents f7bc0b6 + e9341b9 commit 8499e85
Show file tree
Hide file tree
Showing 17 changed files with 347 additions and 93 deletions.
2 changes: 1 addition & 1 deletion tools/projmgr/include/ProjMgrYamlEmitter.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class ProjMgrYamlEmitter {
* @param context pointer to the context
* @return true if executed successfully
*/
static bool GenerateCbuild(ContextItem* context);
static bool GenerateCbuild(ContextItem* context, const RteGenerator* generator = nullptr);
};

#endif // PROJMGRYAMLEMITTER_H
1 change: 1 addition & 0 deletions tools/projmgr/include/ProjMgrYamlParser.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ static constexpr const char* YAML_CLAYER = "clayer";
static constexpr const char* YAML_CPROJECTS = "cprojects";
static constexpr const char* YAML_CPROJECT = "cproject";
static constexpr const char* YAML_CSOLUTION = "csolution";
static constexpr const char* YAML_CURRENT_GENERATOR = "current-generator";
static constexpr const char* YAML_CONSUMES = "consumes";
static constexpr const char* YAML_COMMAND = "command";
static constexpr const char* YAML_COMPILER = "compiler";
Expand Down
16 changes: 14 additions & 2 deletions tools/projmgr/schemas/common.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -494,12 +494,13 @@
"description": "General generator info",
"type": "object",
"properties": {
"from-pack": { "$ref": "#/definitions/PackID" },
"generator": { "type": "string", "description": "Section for a specific generator" },
"path": { "type": "string", "description": "Path name for storing the files generated" },
"gpdsc": { "type": "string", "description": "File name of the *.GDPSC file that stores the information in path" },
"command": { "$ref": "#/definitions/CommandType" }
},
"required": [ "generator", "path", "gpdsc", "command" ]
"required": [ "generator", "from-pack", "path", "gpdsc", "command" ]
},
"CommandType": {
"type": "object",
Expand Down Expand Up @@ -531,9 +532,10 @@
"type": "object",
"properties": {
"id": { "type": "string" },
"from-pack": { "$ref": "#/definitions/PackID"},
"files": { "$ref": "#/definitions/FilesType" }
},
"required": [ "id" ]
"required": [ "id", "from-pack" ]
},
"ComponentID": {
"type": "string",
Expand Down Expand Up @@ -736,6 +738,16 @@
"type": "string",
"description": "Tool name along with version information used to generate this application"
},
"current-generator": {
"type": "object",
"description": "What generator configuration to use",
"prorperties": {
"from-pack": { "$ref": "#/definitions/PackID" },
"id": { "type": "string" }
},
"additionalProperties": false,
"required": [ "from-pack", "id" ]
},
"solution": {
"type": "string",
"description": "Relative path to the csolution file for this context"
Expand Down
2 changes: 1 addition & 1 deletion tools/projmgr/src/ProjMgrWorker.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3423,7 +3423,7 @@ bool ProjMgrWorker::ExecuteGenerator(std::string& generatorId) {
generatorDestination += '/';
}

if (!ProjMgrYamlEmitter::GenerateCbuild(&context)) {
if (!ProjMgrYamlEmitter::GenerateCbuild(&context, generator)) {
return false;
}

Expand Down
156 changes: 94 additions & 62 deletions tools/projmgr/src/ProjMgrYamlEmitter.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,23 @@ ProjMgrYamlEmitter::~ProjMgrYamlEmitter(void) {
}

// the ProjMgrYamlCbuild class encapsulates the use of the YAML library avoiding propagating its header files
class ProjMgrYamlCbuild {
class ProjMgrYamlBase {
protected:
friend class ProjMgrYamlEmitter;
ProjMgrYamlBase(bool useAbsolutePaths = false);
void SetNodeValue(YAML::Node node, const string& value);
void SetNodeValue(YAML::Node node, const vector<string>& vec);
const string FormatPath(const string& original, const string& directory);
bool CompareFile(const string& filename, const YAML::Node& rootNode);
bool CompareNodes(const YAML::Node& lhs, const YAML::Node& rhs);
bool WriteFile(YAML::Node& rootNode, const std::string& filename);
const bool m_useAbsolutePaths;
};

class ProjMgrYamlCbuild : public ProjMgrYamlBase {
private:
friend class ProjMgrYamlEmitter;
ProjMgrYamlCbuild(YAML::Node node, const vector<ContextItem*> processedContexts, ProjMgrParser& parser, const string& directory);
ProjMgrYamlCbuild(YAML::Node node, const ContextItem* context);
ProjMgrYamlCbuild(YAML::Node node, const ContextItem* context, const RteGenerator* generator);
void SetContextNode(YAML::Node node, const ContextItem* context);
void SetComponentsNode(YAML::Node node, const ContextItem* context);
void SetComponentFilesNode(YAML::Node node, const ContextItem* context, const string& componentId);
Expand All @@ -48,15 +60,22 @@ class ProjMgrYamlCbuild {
void SetProcessorNode(YAML::Node node, const map<string, string>& targetAttributes);
void SetMiscNode(YAML::Node miscNode, const MiscItem& misc);
void SetMiscNode(YAML::Node miscNode, const vector<MiscItem>& misc);
void SetNodeValue(YAML::Node node, const string& value);
void SetNodeValue(YAML::Node node, const vector<string>& vec);
void SetDefineNode(YAML::Node node, const vector<string>& vec);
const string FormatPath(const string& original, const string& directory);
bool CompareFile(const string& filename, const YAML::Node& rootNode);
bool CompareNodes(const YAML::Node& lhs, const YAML::Node& rhs);
const RteGenerator* m_generator;
};

class ProjMgrYamlCbuildIdx : public ProjMgrYamlBase {
private:
friend class ProjMgrYamlEmitter;
ProjMgrYamlCbuildIdx(YAML::Node node, const vector<ContextItem*> processedContexts, ProjMgrParser& parser, const string& directory);
};

ProjMgrYamlCbuild::ProjMgrYamlCbuild(YAML::Node node, const vector<ContextItem*> processedContexts, ProjMgrParser& parser, const string& directory) {
ProjMgrYamlBase::ProjMgrYamlBase(bool useAbsolutePaths) : m_useAbsolutePaths(useAbsolutePaths) {
}

ProjMgrYamlCbuildIdx::ProjMgrYamlCbuildIdx(YAML::Node node, const vector<ContextItem*> processedContexts, ProjMgrParser& parser, const string& directory) :
ProjMgrYamlBase(false)
{
error_code ec;
SetNodeValue(node[YAML_GENERATED_BY], ORIGINAL_FILENAME + string(" version ") + VERSION_STRING);

Expand Down Expand Up @@ -106,14 +125,24 @@ ProjMgrYamlCbuild::ProjMgrYamlCbuild(YAML::Node node, const vector<ContextItem*>
}
}

ProjMgrYamlCbuild::ProjMgrYamlCbuild(YAML::Node node, const ContextItem* context) {
ProjMgrYamlCbuild::ProjMgrYamlCbuild(YAML::Node node, const ContextItem* context, const RteGenerator* generator) :
ProjMgrYamlBase(generator != nullptr),
m_generator(generator)
{
if (context) {
SetContextNode(node, context);
}
}

void ProjMgrYamlCbuild::SetContextNode(YAML::Node contextNode, const ContextItem* context) {
SetNodeValue(contextNode[YAML_GENERATED_BY], ORIGINAL_FILENAME + string(" version ") + VERSION_STRING);

if (m_generator) {
YAML::Node node = contextNode[YAML_CURRENT_GENERATOR];
SetNodeValue(node[YAML_ID], m_generator->GetGeneratorName());
SetNodeValue(node[YAML_FROM_PACK], RtePackage::GetPackageIDfromAttributes(*m_generator->GetPackage()));
}

SetNodeValue(contextNode[YAML_SOLUTION], FormatPath(context->csolution->path, context->directories.cprj));
SetNodeValue(contextNode[YAML_PROJECT], FormatPath(context->cproject->path, context->directories.cprj));
SetNodeValue(contextNode[YAML_CONTEXT], context->name);
Expand Down Expand Up @@ -166,8 +195,16 @@ void ProjMgrYamlCbuild::SetComponentsNode(YAML::Node node, const ContextItem* co
}
SetControlsNode(componentNode, context, componentItem->build);
SetComponentFilesNode(componentNode[YAML_FILES], context, componentId);
SetNodeValue(componentNode[YAML_GENERATOR][YAML_ID], component.generator);
SetGeneratorFiles(componentNode[YAML_GENERATOR], context, componentId);
if (!component.generator.empty()) {
if (context->generators.find(component.generator) != context->generators.end()) {
const RteGenerator* rteGenerator = context->generators.at(component.generator);
SetNodeValue(componentNode[YAML_GENERATOR][YAML_ID], component.generator);
SetNodeValue(componentNode[YAML_GENERATOR][YAML_FROM_PACK], RtePackage::GetPackageIDfromAttributes(*rteGenerator->GetPackage()));
SetGeneratorFiles(componentNode[YAML_GENERATOR], context, componentId);
} else {
ProjMgrLogger::Warn(string("Component ") + componentId + " uses unknown generator " + component.generator);
}
}
node.push_back(componentNode);
}
}
Expand Down Expand Up @@ -217,6 +254,7 @@ void ProjMgrYamlCbuild::SetGeneratorsNode(YAML::Node node, const ContextItem* co
break;
}
}
SetNodeValue(genNode[YAML_FROM_PACK], RtePackage::GetPackageIDfromAttributes(*generator->GetPackage()));
SetNodeValue(genNode[YAML_PATH], FormatPath(workingDir, context->directories.cprj));
SetNodeValue(genNode[YAML_GPDSC], FormatPath(gpdscFile, context->directories.cprj));

Expand Down Expand Up @@ -439,13 +477,13 @@ void ProjMgrYamlCbuild::SetMiscNode(YAML::Node miscNode, const MiscItem& misc) {
}
}

void ProjMgrYamlCbuild::SetNodeValue(YAML::Node node, const string& value) {
void ProjMgrYamlBase::SetNodeValue(YAML::Node node, const string& value) {
if (!value.empty()) {
node = value;
}
}

void ProjMgrYamlCbuild::SetNodeValue(YAML::Node node, const vector<string>& vec) {
void ProjMgrYamlBase::SetNodeValue(YAML::Node node, const vector<string>& vec) {
for (const string& value : vec) {
if (!value.empty()) {
node.push_back(value);
Expand All @@ -471,37 +509,39 @@ void ProjMgrYamlCbuild::SetDefineNode(YAML::Node define, const vector<string>& v
}
}

const string ProjMgrYamlCbuild::FormatPath(const string& original, const string& directory) {
const string ProjMgrYamlBase::FormatPath(const string& original, const string& directory) {
string packRoot = ProjMgrKernel::Get()->GetCmsisPackRoot();
string path = original;
RteFsUtils::NormalizePath(path);
error_code ec;
path = fs::weakly_canonical(fs::path(path), ec).generic_string();
size_t index = path.find(packRoot);
if (index != string::npos) {
path.replace(index, packRoot.length(), "${CMSIS_PACK_ROOT}");
} else {
string compilerRoot;
ProjMgrUtils::GetCompilerRoot(compilerRoot);
index = path.find(compilerRoot);
if (!compilerRoot.empty() && index != string::npos) {
path.replace(index, compilerRoot.length(), "${CMSIS_COMPILER_ROOT}");
if (!m_useAbsolutePaths) {
size_t index = path.find(packRoot);
if (index != string::npos) {
path.replace(index, packRoot.length(), "${CMSIS_PACK_ROOT}");
} else {
path = fs::relative(path, directory, ec).generic_string();
string compilerRoot;
ProjMgrUtils::GetCompilerRoot(compilerRoot);
index = path.find(compilerRoot);
if (!compilerRoot.empty() && index != string::npos) {
path.replace(index, compilerRoot.length(), "${CMSIS_COMPILER_ROOT}");
} else {
path = fs::relative(path, directory, ec).generic_string();
}
}
}
return path;
}

bool ProjMgrYamlCbuild::CompareFile(const string& filename, const YAML::Node& rootNode) {
bool ProjMgrYamlBase::CompareFile(const string& filename, const YAML::Node& rootNode) {
if (!RteFsUtils::Exists(filename)) {
return false;
}
const YAML::Node& yamlRoot = YAML::LoadFile(filename);
return CompareNodes(yamlRoot, rootNode);
}

bool ProjMgrYamlCbuild::CompareNodes(const YAML::Node& lhs, const YAML::Node& rhs) {
bool ProjMgrYamlBase::CompareNodes(const YAML::Node& lhs, const YAML::Node& rhs) {
auto eraseGenNode = [](const string& inStr) {
size_t startIndex, endIndex;
string outStr = inStr;
Expand All @@ -527,17 +567,12 @@ bool ProjMgrYamlCbuild::CompareNodes(const YAML::Node& lhs, const YAML::Node& rh
return (lhsData == rhsData) ? true : false;
}

bool ProjMgrYamlEmitter::GenerateCbuildIndex(ProjMgrParser& parser, const vector<ContextItem*> contexts, const string& outputDir) {
// generate cbuild-idx.yml
const string& directory = outputDir.empty() ? parser.GetCsolution().directory : RteFsUtils::AbsolutePath(outputDir).generic_string();
const string& filename = directory + "/" + parser.GetCsolution().name + ".cbuild-idx.yml";

YAML::Node rootNode;
ProjMgrYamlCbuild cbuild(rootNode[YAML_BUILD_IDX], contexts, parser, directory);

if (!cbuild.CompareFile(filename, rootNode)) {
if (!RteFsUtils::Exists(directory)) {
RteFsUtils::CreateDirectories(directory);
bool ProjMgrYamlBase::WriteFile(YAML::Node& rootNode, const std::string& filename) {
// Compare yaml contents
if (!CompareFile(filename, rootNode)) {
if (!RteFsUtils::MakeSureFilePath(filename)) {
ProjMgrLogger::Error(filename, "destination directory can not be created");
return false;
}
ofstream fileStream(filename);
if (!fileStream) {
Expand All @@ -558,34 +593,31 @@ bool ProjMgrYamlEmitter::GenerateCbuildIndex(ProjMgrParser& parser, const vector
return true;
}

bool ProjMgrYamlEmitter::GenerateCbuild(ContextItem* context) {
bool ProjMgrYamlEmitter::GenerateCbuildIndex(ProjMgrParser& parser, const vector<ContextItem*> contexts, const string& outputDir) {
// generate cbuild-idx.yml
const string& directory = outputDir.empty() ? parser.GetCsolution().directory : RteFsUtils::AbsolutePath(outputDir).generic_string();
const string& filename = directory + "/" + parser.GetCsolution().name + ".cbuild-idx.yml";

YAML::Node rootNode;
ProjMgrYamlCbuildIdx cbuild(rootNode[YAML_BUILD_IDX], contexts, parser, directory);

return cbuild.WriteFile(rootNode, filename);
}

bool ProjMgrYamlEmitter::GenerateCbuild(ContextItem* context, const RteGenerator* generator) {
// generate cbuild.yml for each context
RteFsUtils::CreateDirectories(context->directories.cprj);
const string& filename = context->directories.cprj + "/" + context->name + ".cbuild.yml";

// intdir is relative to cprjdir, which in turn is absolute
string genInputFileDir = context->directories.intdir;
RteFsUtils::NormalizePath(genInputFileDir, context->directories.cprj);
const string generatorInputFilename = genInputFileDir + "/" + context->name + ".cbuild-gen.yml";
const string filename = generator ? generatorInputFilename : context->directories.cprj + "/" + context->name + ".cbuild.yml";

// Make sure $G (generator input file) is up to date
context->rteActiveTarget->SetGeneratorInputFile(filename);
context->rteActiveTarget->SetGeneratorInputFile(generatorInputFilename);

YAML::Node rootNode;
ProjMgrYamlCbuild cbuild(rootNode[YAML_BUILD], context);
ProjMgrYamlCbuild cbuild(rootNode[YAML_BUILD], context, generator);

// Compare yaml contents
if (!cbuild.CompareFile(filename, rootNode)) {
ofstream fileStream(filename);
if (!fileStream) {
ProjMgrLogger::Error(filename, "file cannot be written");
return false;
}
YAML::Emitter emitter;
emitter << rootNode;
fileStream << emitter.c_str();
fileStream << endl;
fileStream << flush;
fileStream.close();
ProjMgrLogger::Info(filename, "file generated successfully");
}
else {
ProjMgrLogger::Info(filename, "file is already up-to-date");
}
return true;
return cbuild.WriteFile(rootNode, filename);
}
8 changes: 5 additions & 3 deletions tools/projmgr/test/data/TestGenerator/ref/multiple-components.Debug+CM0.cbuild.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ build:
category: sourceC
generator:
id: RteTestGeneratorIdentifier
from-pack: ARM::RteTestGenerator@0.1.0
files:
- file: ${CMSIS_PACK_ROOT}/ARM/RteTestGenerator/0.1.0/Templates/RteTestGen.c.template
category: genSource
Expand All @@ -46,6 +47,7 @@ build:
selected-by: RteTest:CORE
generators:
- generator: RteTestGeneratorIdentifier
from-pack: ARM::RteTestGenerator@0.1.0
path: ../data/TestGenerator/MultipleComponents/RteTestGeneratorIdentifier
gpdsc: ../data/TestGenerator/MultipleComponents/RteTestGeneratorIdentifier/RteTestGen_ARMCM0/RteTest.gpdsc
command:
Expand All @@ -55,23 +57,23 @@ build:
- RteTestGen_ARMCM0
- ../../multiple-components.Debug+CM0.cprj
- ${CMSIS_PACK_ROOT}/ARM/RteTestGenerator/0.1.0
- ../../../../output/multiple-components.Debug+CM0.cbuild.yml
- ../../../../output/tmp/multiple-components/CM0/Debug/multiple-components.Debug+CM0.cbuild-gen.yml
- /foo=bar
linux:
file: ${CMSIS_PACK_ROOT}/ARM/RteTestGenerator/0.1.0/Generator/script.sh
arguments:
- RteTestGen_ARMCM0
- ../../multiple-components.Debug+CM0.cprj
- ${CMSIS_PACK_ROOT}/ARM/RteTestGenerator/0.1.0
- ../../../../output/multiple-components.Debug+CM0.cbuild.yml
- ../../../../output/tmp/multiple-components/CM0/Debug/multiple-components.Debug+CM0.cbuild-gen.yml
- --foo=bar
mac:
file: ${CMSIS_PACK_ROOT}/ARM/RteTestGenerator/0.1.0/Generator/script.sh
arguments:
- RteTestGen_ARMCM0
- ../../multiple-components.Debug+CM0.cprj
- ${CMSIS_PACK_ROOT}/ARM/RteTestGenerator/0.1.0
- ../../../../output/multiple-components.Debug+CM0.cbuild.yml
- ../../../../output/tmp/multiple-components/CM0/Debug/multiple-components.Debug+CM0.cbuild-gen.yml
- --foo=bar
linker:
script: ${CMSIS_COMPILER_ROOT}/ac6_linker_script.sct
Expand Down
Loading

0 comments on commit 8499e85

Please sign in to comment.