Refactor code - tracker

[Rot127]

This issue tracks code to refactor.

• Documentation of structs should be Doxygen compliant (//< instead of //)

• Unify "instruction" abbreviationinstr -> insn.

• Run clang-format also over hand-written files. In case they were edited with indent style ignoring editors (e.g. vim)

• Enum names are sometimes all uppercase sometimes camel case. Should be all camel case.

• Add const, RZ_BORROW etc. qualifiers to all functions.

• Set internal functions to RZ_IPI instead of RZ_API

• Fix grammar/spelling issues (handwritten -> hand-written)

• Move the foloowing pattern in its own function

  with open("handwritten/hexagon_il_h/include.h") as include:
    set_pos_after_license(include)
    code += "".join(include.readlines())

• Move the following pattern in its own function:

  if compare_src_to_old_src(code, path):
     self.unchanged_files.append(path)
     return
  with open(path, "w+") as dest:
     dest.writelines(code)
     log("analysis_hexagon.c written to {}".format(path), LogLevel.INFO)

• Replaced "..".format() patterns with f"..." formatting in Generate instruction templates as C structs #60

• Add functions which wrap code into a c-block/function/switch-case. (No longer needed since Generate instruction templates as C structs #60?)

• Refactor parse_instruction()
  The method for parsing a Duplex or normal instruction are almost the same.
  The method should be in InstructionTemplate from which DuplexInstruction and Instruction inherit.

  Methods in question:
  

  rz-hexagon/DuplexInstruction.py

  Line 99 in 7df09f5

  def parse_instruction(self) -> None:

  
  

  rz-hexagon/Instruction.py

  Line 106 in 7df09f5

  def parse_instruction(self) -> None:

• Update license date

• Remove or include out-commented code (mostly logs)