From 910b3c862a5bbbe79c7f46fca5600fae7deaacec Mon Sep 17 00:00:00 2001
From: Jerry Zhang Jian <jerry.zhangjian@sifive.com>
Date: Wed, 5 Jun 2024 11:11:56 +0800
Subject: [PATCH] Make Generator class becomes ABC

- The following member functions will return NotImplemented if not
  implemented in derived classes to let user aware that the function
  call is not functioning
  - write()
  - write_title()
  - gen_prologue()
  - inst_group_prologue()
  - inst_group_epilogue()
  - post_gen()

- The func function is set as abstract method, all the derived classes
  shoule have their own implementation

- The original func implementation is copied to DocGenerator and
  APITestGenerator and replace the call of base func() implementation

Signed-off-by: Jerry Zhang Jian <jerry.zhangjian@sifive.com>
---
 .../rvv_intrinsic_gen/generator.py            | 45 ++++++++++---------
 1 file changed, 24 insertions(+), 21 deletions(-)

diff --git a/rvv-intrinsic-generator/rvv_intrinsic_gen/generator.py b/rvv-intrinsic-generator/rvv_intrinsic_gen/generator.py
index 517904f4c..8efd5b1ed 100644
--- a/rvv-intrinsic-generator/rvv_intrinsic_gen/generator.py
+++ b/rvv-intrinsic-generator/rvv_intrinsic_gen/generator.py
@@ -17,6 +17,7 @@
 
 Generator classes that controls structures of the output.
 """
+from abc import ABC, abstractmethod
 import os
 import collections
 import re
@@ -25,7 +26,7 @@
 from enums import ToolChainType
 
 
-class Generator():
+class Generator(ABC):
   """
   Base class for all generators.
   """
@@ -36,29 +37,23 @@ def __init__(self):
     pass
 
   def write(self, text):
-    pass
+    return NotImplemented
 
   def write_title(self, text, link):
-    pass
+    return NotImplemented
 
   def gen_prologue(self):
-    pass
+    return NotImplemented
 
   def inst_group_prologue(self):
-    return ""
+    return NotImplemented
 
   def inst_group_epilogue(self):
-    return ""
+    return NotImplemented
 
+  @abstractmethod
   def func(self, inst_info, name, return_type, **kwargs):
-    # pylint: disable=unused-argument
-    # FIXME: inst_info is currently only used by RIFGenerator.
-    self.generated_functions_set.add(name)
-    args = ", ".join(map(lambda a: f"{a[1]} {a[0]}", kwargs.items()))
-    # "T * name" to "T *name"
-    args = args.replace("* ", "*")
-    s = f"{return_type} {name} ({args});\n"
-    return s
+    return NotImplemented
 
   def function_group(self, template, title, link, op_list, type_list, sew_list,
                      lmul_list, decorator_list):
@@ -74,7 +69,7 @@ def function_group(self, template, title, link, op_list, type_list, sew_list,
         decorator_list=decorator_list)
 
   def start_group(self, group_name):
-    pass
+    return NotImplemented
 
   @staticmethod
   def func_name(name):
@@ -296,7 +291,7 @@ def report_summary(self):
       \x1b[0mfunctions")
 
   def post_gen(self):
-    pass
+    return NotImplemented
 
 
 class DocGenerator(Generator):
@@ -358,7 +353,13 @@ def function_group(self, template, title, link, op_list, type_list, sew_list,
 
   def func(self, inst_info, name, return_type, **kwargs):
     name = Generator.func_name(name)
-    s = super().func(inst_info, name, return_type, **kwargs)
+    # pylint: disable=unused-argument
+    # FIXME: inst_info is currently only used by RIFGenerator.
+    self.generated_functions_set.add(name)
+    args = ", ".join(map(lambda a: f"{a[1]} {a[0]}", kwargs.items()))
+    # "T * name" to "T *name"
+    args = args.replace("* ", "*")
+    s = f"{return_type} {name} ({args});\n"
     self.write(s)
 
   def start_group(self, group_name):
@@ -517,10 +518,12 @@ def func(self, inst_info, name, return_type, **kwargs):
         os.path.join(self.folder, test_file_name), mode, encoding="utf-8")
 
     stripped_prefix_non_overloaded_func_name = non_overloaded_func_name[8:]
-    func_decl = super().func(inst_info,
-                             "test_" + stripped_prefix_non_overloaded_func_name,
-                             return_type, **kwargs)
-    func_decl = func_decl.replace(" (", "(")
+    non_overloaded_func_name = "test_" + stripped_prefix_non_overloaded_func_name
+    self.generated_functions_set.add(non_overloaded_func_name)
+    args = ", ".join(map(lambda a: f"{a[1]} {a[0]}", kwargs.items()))
+    # "T * name" to "T *name"
+    args = args.replace("* ", "*")
+    func_decl = f"{return_type} {non_overloaded_func_name}({args});\n"
 
     # Strip redundant parameters in function declaration because the intrinsic
     # requires an immediate to be provided to the parameter.