All files / transpiler/logic/symbols/cnext/collectors RegisterCollector.ts

94.73% Statements 18/19
80% Branches 8/10
100% Functions 1/1
94.73% Lines 18/19

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84                                                              24x 24x 24x     24x     24x   24x 33x 33x 33x     33x 33x   33x               33x 33x 5x 28x       33x     24x                              
/**
 * RegisterCollector - Extracts register block declarations from parse trees.
 * Registers provide typed access to memory-mapped I/O locations.
 */
 
import * as Parser from "../../../parser/grammar/CNextParser";
import ESourceLanguage from "../../../../../utils/types/ESourceLanguage";
import ESymbolKind from "../../../../../utils/types/ESymbolKind";
import IRegisterSymbol from "../../types/IRegisterSymbol";
import IRegisterMemberInfo from "../../types/IRegisterMemberInfo";
import TypeUtils from "../utils/TypeUtils";
 
/** Access mode type for register members */
type TAccessMode = "rw" | "ro" | "wo" | "w1c" | "w1s";
 
class RegisterCollector {
  /**
   * Collect a register declaration and return an IRegisterSymbol.
   *
   * @param ctx The register declaration context
   * @param sourceFile Source file path
   * @param knownBitmaps Set of known bitmap type names for reference resolution
   * @param scopeName Optional scope name for nested registers
   * @returns The register symbol
   */
  static collect(
    ctx: Parser.RegisterDeclarationContext,
    sourceFile: string,
    knownBitmaps: Set<string>,
    scopeName?: string,
  ): IRegisterSymbol {
    const name = ctx.IDENTIFIER().getText();
    const fullName = scopeName ? `${scopeName}_${name}` : name;
    const line = ctx.start?.line ?? 0;
 
    // Get base address
    const baseAddress = ctx.expression().getText();
 
    // Collect register members
    const members = new Map<string, IRegisterMemberInfo>();
 
    for (const member of ctx.registerMember()) {
      const memberName = member.IDENTIFIER().getText();
      const offset = member.expression().getText();
      const accessMod = member.accessModifier().getText() as TAccessMode;
 
      // Get member type and convert to C type
      const typeName = TypeUtils.getTypeName(member.type(), scopeName);
      const cType = TypeUtils.cnextTypeToCType(typeName);
 
      const memberInfo: IRegisterMemberInfo = {
        offset,
        cType,
        access: accessMod,
      };
 
      // Check if member type is a bitmap
      // Try both scoped name and plain name for bitmap lookup
      const scopedTypeName = scopeName ? `${scopeName}_${typeName}` : typeName;
      if (knownBitmaps.has(scopedTypeName)) {
        memberInfo.bitmapType = scopedTypeName;
      I} else if (knownBitmaps.has(typeName)) {
        memberInfo.bitmapType = typeName;
      }
 
      members.set(memberName, memberInfo);
    }
 
    return {
      name: fullName,
      parent: scopeName,
      sourceFile,
      sourceLine: line,
      sourceLanguage: ESourceLanguage.CNext,
      isExported: true,
      kind: ESymbolKind.Register,
      baseAddress,
      members,
    };
  }
}
 
export default RegisterCollector;