@specs-feup/clava/src-api/clava/hdf5/Hdf5.ts

A C/C++ source-to-source compiler written in Typescript

import {
  ArrayType,
  EnumType,
  FileJp,
  RecordJp,
  TemplateSpecializationType,
  Type,
} from "../../Joinpoints.js";
import ClavaJoinPoints from "../ClavaJoinPoints.js";
import Format from "../Format.js";

enum HDF5Types {
  "char" = "C_S1",
  "signed char" = "NATIVE_SCHAR",
  "unsigned char" = "NATIVE_UCHAR",
  "short" = "NATIVE_SHORT",
  "unsigned short" = "NATIVE_USHORT",
  "int" = "NATIVE_INT",
  "unsigned int" = "NATIVE_UINT",
  "long" = "NATIVE_LONG",
  "unsigned long" = "NATIVE_ULONG",
  "long long" = "NATIVE_LLONG",
  "unsigned long long" = "NATIVE_ULLONG",
  "float" = "NATIVE_FLOAT",
  "double" = "NATIVE_DOUBLE",
  "long double" = "NATIVE_LDOUBLE",

  "int8_t" = "NATIVE_INT8",
  "uint8_t" = "NATIVE_UINT8",
  "int16_t" = "NATIVE_INT16",
  "uint16_t" = "NATIVE_UINT16",
  "int32_t" = "NATIVE_INT32",
  "uin32_t" = "NATIVE_UINT32",
  "int64_t" = "NATIVE_INT64",
  "uint64_t" = "NATIVE_UINT64",
}

/**
 * Utility methods related to the HDF5 library.
 *
 */
export default class Hdf5 {
  /**
   * @returns A String with the HDF5 code that represents the given type.
   */
  static convert($type: Type): string | undefined {
    // Desugar type
    $type = $type.desugarAll;

    // Special case: char[size]
    if ($type instanceof ArrayType) {
      const $elementType = $type.elementType;

      if ($elementType.code === "char") {
        return `H5::StrType(H5::PredType::C_S1, ${$type.arraySize})`;
      }

      console.log(
        ` -> Warning! HDF5 type not defined for C/C++ arrays of type: ${$elementType.toString()}`
      );
      return undefined;
    }

    // Special case: enum
    if ($type instanceof EnumType) {
      return Hdf5.convert($type.integerType);
    }

    // Special case: unique_ptr
    if (
      $type instanceof TemplateSpecializationType &&
      $type.templateName === "unique_ptr"
    ) {
      // Generate code for the parameter
      return Hdf5.convert($type.firstArgType);
    }

    // Special case: vector
    if (
      $type instanceof TemplateSpecializationType &&
      $type.templateName === "vector"
    ) {
      // Convert template type
      return `H5::VarLenType('&${Hdf5.convert($type.firstArgType)}')`;
    }

    const cType = $type.code;
    const HDF5Type = HDF5Types[cType as keyof typeof HDF5Types];

    if (HDF5Type === undefined) {
      console.log(`TYPE NAME -> ${$type.kind}`);
      console.log(`TYPE -> ${$type.ast}`);
      console.log(
        ` -> Warning! HDF5 type not defined for C/C++ type: ${cType}`
      );
      return undefined;
    }

    // Common HDF5Type
    return "H5::PredType::" + HDF5Type;
  }

  /**
   * @param $records - An array of $record join points which will be used to generate a library with HDF5 conversors for those records.
   * @returns An array with $file join points, representing the files of the newly created library.
   */
  static toLibrary($records: RecordJp[]): FileJp[] {
    const namespace = "hdf5type";

    // Folder for the generated files
    const filepath = "generated-hdf5";

    // Create files for generated code
    const $compTypeC = ClavaJoinPoints.file("CompType.cpp", filepath);
    const $compTypeH = ClavaJoinPoints.file("CompType.h", filepath);

    let hDeclarationsCode = "";

    // Add include for CompTypes
    $compTypeC.addInclude("CompType.h", false);
    $compTypeC.addInclude("H5CompType.h", true);

    for (const $record of $records) {
      const $file = $record.getAncestor("file") as FileJp | undefined;

      if ($file === undefined) {
        console.log(` -> Warning! Record '${$record.name}' has no file`);
        continue;
      }

      const className = $record.name + "Type";
      const typeName = "itype";

      /* Generate code for .h file */

      // Create declaration
      hDeclarationsCode += Hdf5.Hdf5_HDeclaration($file.name, className);

      /* Generate code for .cpp file */

      // Add include to the file where record is
      $compTypeC.addIncludeJp($record);

      // Create code for translating C/C++ type to HDF5 type
      const recordCode = Hdf5.convertRecord($record, typeName);
      const cxxFunction = Hdf5.Hdf5_CImplementation(
        namespace,
        className,
        Format.addPrefix(recordCode, "    ")
      );

      $compTypeC.insertAfter(ClavaJoinPoints.declLiteral(cxxFunction));
    }

    /* Generate code for .h file */

    // Add include to HDF5 CPP library
    $compTypeH.addInclude("H5Cpp.h", true);

    // Create header code inside the target namespace
    hDeclarationsCode =
      "\nnamespace " +
      namespace +
      " {\n\n" +
      Format.addPrefix(hDeclarationsCode, "    ") +
      "\n}\n";

    // Insert code inside header file
    $compTypeH.insertAfter(ClavaJoinPoints.declLiteral(hDeclarationsCode));

    // Create return array
    const $files = [$compTypeH, $compTypeC];

    return $files;
  }

  private static Hdf5_HDeclaration(
    filename: string,
    className: string
  ): string {
    return `
//  ${filename}
class ${className} {
  public:
  static H5::CompType GetCompType();
};

`;
  }

  private static Hdf5_CImplementation(
    namespace: string,
    className: string,
    body: string
  ): string {
    return `
H5::CompType ${namespace}::${className}::GetCompType() {
${body}

    return itype;
}

`;
  }

  /**
   * @returns String representing the HDF5 conversion code for the given record
   */
  static convertRecord($record: RecordJp, typeName: string): string {
    const recordName = $record.qualifiedName;
    let code = `H5::CompType ${typeName}(sizeof(${recordName}));\n`;

    for (const $field of $record.fields) {
      if ($field.type.constant) continue; // Ignore constant fields
      if (!$field.isPublic) continue; // Ignore private fields

      const fieldName = $field.name;
      const HDF5Type = Hdf5.convert($field.type);
      if (HDF5Type === undefined) continue; // Warning message omitted for the example

      code += `${typeName}.insertMember("${fieldName}",offsetof(${recordName}, ${fieldName}), ${HDF5Type});\n`;
    }

    return code;
  }
}