Internals: Cleanup Emit towards constructor/destructor output.

src/V3AstNodes.cpp

@@ -1340,6 +1340,9 @@ void AstCFunc::dump(std::ostream& str) const {
     if (dpiImport()) str<<" [DPII]";
     if (dpiExport()) str<<" [DPIX]";
     if (dpiExportWrapper()) str<<" [DPIXWR]";
+    if (isConstructor()) str<<" [CTOR]";
+    if (isDestructor()) str<<" [DTOR]";
+    if (isVirtual()) str<<" [VIRT]";
 }
 void AstCUse::dump(std::ostream& str) const {
     this->AstNode::dump(str);

src/V3AstNodes.h

@@ -6637,8 +6637,11 @@ private:
     bool        m_formCallTree:1;       // Make a global function to call entire tree of functions
     bool        m_slow:1;               // Slow routine, called once or just at init time
     bool        m_funcPublic:1;         // From user public task/function
+    bool        m_isConstructor:1;      // Is C class constructor
+    bool        m_isDestructor:1;       // Is C class destructor
     bool        m_isMethod:1;           // Is inside a class definition
     bool        m_isInline:1;           // Inline function
+    bool        m_isVirtual:1;          // Virtual function
     bool        m_symProlog:1;          // Setup symbol table for later instructions
     bool        m_entryPoint:1;         // User may call into this top level function
     bool        m_pure:1;               // Pure function
@@ -6661,8 +6664,11 @@ public:
         m_formCallTree = false;
         m_slow = false;
         m_funcPublic = false;
+        m_isConstructor = false;
+        m_isDestructor = false;
         m_isMethod = true;
         m_isInline = false;
+        m_isVirtual = false;
         m_symProlog = false;
         m_entryPoint = false;
         m_pure = false;
@@ -6717,10 +6723,16 @@ public:
     string ifdef() const { return m_ifdef; }
     void funcType(AstCFuncType flag) { m_funcType = flag; }
     AstCFuncType funcType() const { return m_funcType; }
+    bool isConstructor() const { return m_isConstructor; }
+    void isConstructor(bool flag) { m_isConstructor = flag; }
+    bool isDestructor() const { return m_isDestructor; }
+    void isDestructor(bool flag) { m_isDestructor = flag; }
     bool isMethod() const { return m_isMethod; }
     void isMethod(bool flag) { m_isMethod = flag; }
     bool isInline() const { return m_isInline; }
     void isInline(bool flag) { m_isInline = flag; }
+    bool isVirtual() const { return m_isVirtual; }
+    void isVirtual(bool flag) { m_isVirtual = flag; }
     bool symProlog() const { return m_symProlog; }
     void symProlog(bool flag) { m_symProlog = flag; }
     bool entryPoint() const { return m_entryPoint; }

src/V3EmitC.cpp

@@ -176,9 +176,12 @@ public:
             ofp()->putsPrivate(funcp->declPrivate());
             if (!funcp->ifdef().empty()) puts("#ifdef " + funcp->ifdef() + "\n");
             if (funcp->isStatic().trueUnknown()) puts("static ");
-            puts(funcp->rtnTypeVoid());
+            if (funcp->isVirtual()) puts("virtual ");
-            puts(" ");
+            if (!funcp->isConstructor() && !funcp->isDestructor()) {
-            puts(funcp->nameProtect());
+                puts(funcp->rtnTypeVoid());
+                puts(" ");
+            }
+            puts(funcNameProtect(funcp, modp));
             puts("(" + cFuncArgs(funcp) + ")");
             if (funcp->isConst().trueKnown()) puts(" const");
             if (funcp->slow()) puts(" VL_ATTR_COLD");
@@ -1248,9 +1251,14 @@ class EmitCImp : EmitCStmts {
         puts("\n");
         if (nodep->ifdef()!="") puts("#ifdef "+nodep->ifdef()+"\n");
         if (nodep->isInline()) puts("VL_INLINE_OPT ");
-        puts(nodep->rtnTypeVoid()); puts(" ");
+        if (!nodep->isConstructor() && !nodep->isDestructor()) {
+            puts(nodep->rtnTypeVoid());
+            puts(" ");
+        }
+
         if (nodep->isMethod()) puts(prefixNameProtect(m_modp) + "::");
-        puts(nodep->nameProtect() + "(" + cFuncArgs(nodep) + ")");
+        puts(funcNameProtect(nodep, m_modp));
+        puts("(" + cFuncArgs(nodep) + ")");
         if (nodep->isConst().trueKnown()) puts(" const");
         puts(" {\n");
 
@@ -1983,7 +1991,9 @@ void EmitCImp::emitMTaskVertexCtors(bool* firstp) {
 void EmitCImp::emitCtorImp(AstNodeModule* modp) {
     puts("\n");
     bool first = true;
-    if (optSystemC() && modp->isTop()) {
+    if (VN_IS(modp, Class)) {
+        modp->v3fatalSrc("constructors should be AstCFuncs instead");
+    } else if (optSystemC() && modp->isTop()) {
         puts("VL_SC_CTOR_IMP(" + prefixNameProtect(modp) + ")");
     } else {
         puts("VL_CTOR_IMP(" + prefixNameProtect(modp) + ")");
@@ -2606,10 +2616,10 @@ void EmitCImp::emitIntTop(AstNodeModule* modp) {
         // types defined in svdpi.h are available
         puts("#include \"" + topClassName() + "__Dpi.h\"\n");
     }
-    puts("\n");
 }
 
 void EmitCImp::emitInt(AstNodeModule* modp) {
+    puts("\n//==========\n\n");
     emitModCUse(modp, VUseType::INT_INCLUDE);
 
     // Declare foreign instances up front to make C++ happy
@@ -2701,20 +2711,26 @@ void EmitCImp::emitInt(AstNodeModule* modp) {
         }
     }
 
-    puts("\n// CONSTRUCTORS\n");
+    if (!VN_IS(modp, Class)) {
-    ofp()->resetPrivate();
+        puts("\n// CONSTRUCTORS\n");
-    // We don't need a private copy constructor, as VerilatedModule has one for us.
+        ofp()->resetPrivate();
-    ofp()->putsPrivate(true);
+        // We don't need a private copy constructor, as VerilatedModule has one for us.
-    puts("VL_UNCOPYABLE(" + prefixNameProtect(modp) + ");  ///< Copying not allowed\n");
+        ofp()->putsPrivate(true);
+        puts("VL_UNCOPYABLE(" + prefixNameProtect(modp) + ");  ///< Copying not allowed\n");
+    }
 
-    ofp()->putsPrivate(false);  // public:
+    if (VN_IS(modp, Class)) {
-    if (optSystemC() && modp->isTop()) {
+        // CFuncs with isConstructor/isDestructor used instead
+    } else if (optSystemC() && modp->isTop()) {
+        ofp()->putsPrivate(false);  // public:
         puts("SC_CTOR(" + prefixNameProtect(modp) + ");\n");
         puts("virtual ~" + prefixNameProtect(modp) + "();\n");
     } else if (optSystemC()) {
+        ofp()->putsPrivate(false);  // public:
         puts("VL_CTOR(" + prefixNameProtect(modp) + ");\n");
         puts("~" + prefixNameProtect(modp) + "();\n");
     } else {
+        ofp()->putsPrivate(false);  // public:
         if (modp->isTop()) {
             puts("/// Construct the model; called by application code\n");
             puts("/// The special name "" may be used to make a wrapper with a\n");
@@ -2757,12 +2773,14 @@ void EmitCImp::emitInt(AstNodeModule* modp) {
              +"("+EmitCBaseVisitor::symClassVar()+");\n");
     }
 
-    ofp()->putsPrivate(false);  // public:
+    if (!VN_IS(modp, Class)) {
-    puts("void "+protect("__Vconfigure")+"("+symClassName()+"* symsp, bool first);\n");
+        ofp()->putsPrivate(false);  // public:
+        puts("void " + protect("__Vconfigure") + "(" + symClassName() + "* symsp, bool first);\n");
+    }
 
     emitIntFuncDecls(modp, true);
 
-    if (v3Global.opt.trace()) {
+    if (v3Global.opt.trace() && !VN_IS(modp, Class)) {
         ofp()->putsPrivate(false);  // public:
         puts("static void "+protect("traceInit")+"("+v3Global.opt.traceClassBase()
              +"* vcdp, void* userthis, uint32_t code);\n");
@@ -2781,6 +2799,7 @@ void EmitCImp::emitInt(AstNodeModule* modp) {
     if (!VN_IS(modp, Class)) puts(" VL_ATTR_ALIGNED(VL_CACHE_LINE_BYTES)");
     puts(";\n");
 
+    puts("\n//----------\n\n");
     emitIntFuncDecls(modp, false);
 
     // Save/restore
@@ -2813,35 +2832,27 @@ void EmitCImp::emitImpTop(AstNodeModule* fileModp) {
     emitModCUse(fileModp, VUseType::IMP_INCLUDE);
     emitModCUse(fileModp, VUseType::IMP_FWD_CLASS);
 
-    puts("\n");
     emitTextSection(AstType::atScImpHdr);
 }
 
 void EmitCImp::emitImp(AstNodeModule* modp) {
+    puts("\n//==========\n");
     if (m_slow) {
-        puts("\n//--------------------\n");
         string section;
         emitVarList(modp->stmtsp(), EVL_CLASS_ALL, prefixNameProtect(modp), section/*ref*/);
-        emitCtorImp(modp);
+        if (!VN_IS(modp, Class)) emitCtorImp(modp);
-        emitConfigureImp(modp);
+        if (!VN_IS(modp, Class)) emitConfigureImp(modp);
-        emitDestructorImp(modp);
+        if (!VN_IS(modp, Class)) emitDestructorImp(modp);
         emitSavableImp(modp);
         emitCoverageImp(modp);
     }
 
     if (m_fast) {
         emitTextSection(AstType::atScImp);
-
+        if (modp->isTop()) emitWrapEval(modp);
-        if (modp->isTop()) {
-            puts("\n//--------------------\n");
-            puts("\n");
-            emitWrapEval(modp);
-        }
     }
 
     // Blocks
-    puts("\n//--------------------\n");
-    puts("// Internal Methods\n");
     for (AstNode* nodep = modp->stmtsp(); nodep; nodep = nodep->nextp()) {
         if (AstCFunc* funcp = VN_CAST(nodep, CFunc)) {
             maybeSplit(modp);

src/V3EmitCBase.h

@@ -56,6 +56,11 @@ public:
     static string symClassVar()  { return symClassName()+"* __restrict vlSymsp"; }
     static string symTopAssign() {
         return v3Global.opt.prefix()+"* __restrict vlTOPp VL_ATTR_UNUSED = vlSymsp->TOPp;"; }
+    static string funcNameProtect(const AstCFunc* nodep, const AstNodeModule* modp) {
+        if (nodep->isConstructor()) return prefixNameProtect(modp);
+        else if (nodep->isDestructor()) return string("~") + prefixNameProtect(modp);
+        else return nodep->nameProtect();
+    }
     static string prefixNameProtect(const AstNode* nodep) {  // C++ name with prefix
         const AstNodeModule* modp = VN_CAST_CONST(nodep, NodeModule);
         if (modp && modp->isTop()) {

src/V3EmitCSyms.cpp

@@ -110,7 +110,10 @@ class EmitCSyms : EmitCBaseVisitor {
 
     void nameCheck(AstNode* nodep) {
         // Prevent GCC compile time error; name check all things that reach C++ code
-        if (nodep->name() != "") {
+        if (nodep->name() != ""
+            && !(VN_IS(nodep, CFunc)
+                 && (VN_CAST(nodep, CFunc)->isConstructor()
+                     || VN_CAST(nodep, CFunc)->isDestructor()))) {
             string rsvd = m_words.isKeyword(nodep->name());
             if (rsvd != "") {
                 // Generally V3Name should find all of these and throw SYMRSVDWORD.
@@ -387,10 +390,9 @@ void EmitCSyms::emitSymHdr() {
         puts("#include \"verilated.h\"\n");
     }
 
-    // for
     puts("\n// INCLUDE MODULE CLASSES\n");
-    for (AstNodeModule* nodep = v3Global.rootp()->modulesp();
+    for (AstNodeModule* nodep = v3Global.rootp()->modulesp(); nodep;
-         nodep; nodep=VN_CAST(nodep->nextp(), NodeModule)) {
+         nodep = VN_CAST(nodep->nextp(), NodeModule)) {
         puts("#include \"" + prefixNameProtect(nodep) + ".h\"\n");
     }