Add comments to generated files to identify them as generated by mFAST

Author: Dale Wilson

src/fast_type_gen/codegen_base.cpp

@@ -10,8 +10,9 @@
 #include <utility>
 
 codegen_base::codegen_base(const char *filebase, const char *fileext)
-    : filebase_(filebase), cpp_ns_(filebase),
-      out_((filebase_ + fileext).c_str(), std::ofstream::trunc) {
+    : filebase_(filebase), ext_(fileext),cpp_ns_(filebase),
+      out_((filebase_ + fileext).c_str(), std::ofstream::trunc) ,
+      use_standard_comment_(true) {
   if (!out_.is_open()) {
     filebase_ += fileext;
     throw file_open_error(filebase_);
@@ -24,6 +25,15 @@ codegen_base::dont_generate(const mfast::field_instruction * /*inst*/) const {
   return false;
 }
 
+void codegen_base::generate_comment(){
+  if(use_standard_comment_){
+      out_ << "// " << filebase_ << ext_ << " generated by mFAST from FAST Template. \n"
+          << "// Do not modify this file directly. Any modifications \n"
+          << "// will be lost the next time this file is generated.\n\n";
+  }
+}
+
+
 void codegen_base::set_outer_ns(const char *outer_ns) {
   outer_ns_.clear();
   while (outer_ns) {
@@ -41,6 +51,10 @@ void codegen_base::set_outer_ns(const char *outer_ns) {
   }
 }
 
+void codegen_base::set_generate_comment(bool generateComment){ 
+    use_standard_comment_ = generateComment;
+}
+
 void codegen_base::traverse(mfast::dynamic_templates_description &desc) {
   for (auto inst : desc.defined_type_instructions()) {
     // we use the second parameter to identify whether the instruction is nested.

src/fast_type_gen/codegen_base.h

@@ -25,18 +25,23 @@ class file_open_error : public virtual boost::exception,
 class codegen_base : public mfast::field_instruction_visitor {
 protected:
   std::string filebase_;
+  std::string ext_;
   std::vector<std::string> outer_ns_;
   std::string cpp_ns_;
   std::ofstream out_;
   std::stringstream cref_scope_;
+  bool use_standard_comment_;
 
 public:
   codegen_base(const char* filebase, const char* fileext);
   void set_outer_ns(const char *outer_ns);
+  void set_generate_comment(bool generateComment);
+
   static std::string cpp_name(const mfast::field_instruction* inst);
   static std::string cpp_name(boost::string_ref n);
   static const  mfast::field_instruction* get_element_instruction(const mfast::sequence_field_instruction* inst);
 protected:
+  void generate_comment();
   void traverse(mfast::dynamic_templates_description &desc);
   virtual void traverse(const mfast::group_field_instruction *inst,
                         const char *name_suffix = "");

src/fast_type_gen/cpp_gen.cpp

@@ -534,6 +534,9 @@ void cpp_gen::visit(const mfast::templateref_instruction *inst, void *pIndex) {
 }
 
 void cpp_gen::generate(mfast::dynamic_templates_description &desc) {
+
+  generate_comment();
+
   out_ << "#include \"" << filebase_ << hpp_fileext_ << "\"\n"
        << "\n"
        << "using namespace mfast;\n\n";

src/fast_type_gen/hpp_gen.cpp

@@ -517,6 +517,8 @@ void hpp_gen::generate(mfast::dynamic_templates_description &desc) {
 
   std::string filebase_upper = boost::to_upper_copy(filebase_);
 
+  generate_comment();
+
   out_ << "#pragma once\n"
        << "\n"
        << "#include <mfast.h>\n";

src/fast_type_gen/inl_gen.cpp

@@ -942,6 +942,9 @@ void inl_gen::visit(const mfast::templateref_instruction *, void *pIndex) {
 }
 
 void inl_gen::generate(mfast::dynamic_templates_description &desc) {
+
+  generate_comment();
+
   codegen_base::traverse(desc);
   for (auto &&info : desc.view_infos()) {
     this->generate(info);