All files / TRANSPILE/2-Plan CppMemberHelper.ts

100% Statements 51/51
100% Branches 40/40
100% Functions 9/9
100% Lines 37/37

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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200                                                                                16x                                                   5x 5x   5x     4x     3x                       9x 9x   6x   4x 4x   3x                     6x 6x   6x   5x                       5x   4x   4x   3x     3x             1x       2x                               6x 5x   4x 2x   1x                   19x   18x     18x 3x       15x 12x       3x 2x     1x          
/**
 * CppMemberHelper
 *
 * Helper class for C++ member conversion logic.
 * Extracts testable pure functions from CodeGenerator for Issue #251/#252/#256.
 *
 * This handles cases where passing struct members to functions in C++ mode
 * requires temporary variables:
 * 1. Const struct parameter member -> non-const parameter
 * 2. External C struct members of bool/enum type -> u8 parameter
 * 3. Array element member access with external struct elements
 */
 
import TYPE_MAP from "../../utils/constants/TypeMappings";
import IPostfixOp from "../../types/IPostfixOp";
 
/**
 * Parameter info from the type registry
 */
interface IParamInfo {
  baseType: string;
  isStruct?: boolean;
  isConst?: boolean;
}
 
/**
 * Type info from the type registry
 */
interface ITypeInfo {
  baseType: string;
  isArray?: boolean;
  isString?: boolean;
}
 
class CppMemberHelper {
  /**
   * Check if target type is u8 (could be bool or typed enum from C header)
   * Issue #252: External C structs may have bool/enum members that need casting
   */
  static isU8TargetType(targetParamBaseType: string): boolean {
    return TYPE_MAP[targetParamBaseType] === "uint8_t";
  }
 
  /**
   * Case 1: Direct parameter member access needs conversion?
   * Issue #251: Const struct parameter needs temp to break const chain
   * Issue #252: External C structs may have bool/enum members
   */
  /**
   * NOT REACHED by any fixture, and kept deliberately.
   *
   * #1450 measured it: a throw on entry reddens 0 of 1250, while its three
   * siblings are entered twice each and the dispatcher above them is reached by
   * one fixture -- which takes the complex-chain branch every time. So the
   * corpus builds the OTHER side of that `if` and never this one.
   *
   * What it guards is real and named: #251's const struct parameter needing a
   * temp to break the const chain, and #252's external C struct with a
   * bool/enum member. A corpus that does not reach a branch is not a user base
   * that does not, and #1143 is this repository's record of what deleting an
   * unreached defense costs. The gap is a missing FIXTURE, not dead code.
   */
  static needsParamMemberConversion(
    paramInfo: IParamInfo,
    targetParamBaseType: string,
  ): boolean {
    const isPrimitiveParam = !!TYPE_MAP[paramInfo.baseType];
    const couldBeStruct = paramInfo.isStruct || !isPrimitiveParam;
 
    if (!couldBeStruct) return false;
 
    // Const struct parameter needs temp to break const chain
    if (paramInfo.isConst) return true;
 
    // External C structs may have bool/enum members that need casting
    return CppMemberHelper.isU8TargetType(targetParamBaseType);
  }
 
  /**
   * Check if array element member access needs conversion
   * Issue #256: arr[i].member patterns with external struct elements
   */
  static needsArrayElementMemberConversion(
    precedingOps: IPostfixOp[],
    typeInfo: ITypeInfo | undefined,
    targetParamBaseType: string,
  ): boolean {
    const hasArraySubscript = precedingOps.some((op) => op.hasExpression);
    if (!hasArraySubscript) return false;
 
    if (!typeInfo?.isArray) return false;
 
    const isPrimitiveElement = !!TYPE_MAP[typeInfo.baseType];
    if (isPrimitiveElement) return false;
 
    return CppMemberHelper.isU8TargetType(targetParamBaseType);
  }
 
  /**
   * Check if function return member access needs conversion
   * Issue #256: getConfig().member patterns
   */
  static needsFunctionReturnMemberConversion(
    precedingOps: IPostfixOp[],
    targetParamBaseType: string,
  ): boolean {
    const hasFunctionCall = precedingOps.some(
      (op) => op.hasArgumentList || op.textEndsWithParen,
    );
    if (!hasFunctionCall) return false;
 
    return CppMemberHelper.isU8TargetType(targetParamBaseType);
  }
 
  /**
   * Case 2: Array element or function return member access needs conversion?
   * Issue #256: arr[i].member or getConfig().member patterns
   */
  static needsComplexMemberConversion(
    ops: IPostfixOp[],
    typeInfo: ITypeInfo | undefined,
    targetParamBaseType: string,
  ): boolean {
    if (ops.length < 2) return false;
 
    const lastOp = ops.at(-1)!;
    // Last op must be member access (.identifier)
    if (!lastOp.hasIdentifier) return false;
 
    const precedingOps = ops.slice(0, -1);
 
    // Case 2a: Array element member access (arr[i].member)
    if (
      CppMemberHelper.needsArrayElementMemberConversion(
        precedingOps,
        typeInfo,
        targetParamBaseType,
      )
    ) {
      return true;
    }
 
    // Case 2b: Function return member access (getConfig().member)
    return CppMemberHelper.needsFunctionReturnMemberConversion(
      precedingOps,
      targetParamBaseType,
    );
  }
 
  /**
   * Check if a string subscript access pattern is present
   * Issue #246: buf[0] where buf is a string<N>
   */
  static isStringSubscriptPattern(
    hasPostfixOps: boolean,
    lastOpHasExpression: boolean,
    typeInfo: ITypeInfo | undefined,
    paramIsString: boolean,
  ): boolean {
    if (!hasPostfixOps) return false;
    if (!lastOpHasExpression) return false;
 
    if (typeInfo?.isString) return true;
    if (paramIsString) return true;
 
    return false;
  }
 
  /**
   * Determine last postfix operation type
   * Returns "function", "member", "array", or null
   */
  static getLastPostfixOpType(
    ops: IPostfixOp[],
  ): "function" | "member" | "array" | null {
    if (ops.length === 0) return null;
 
    const lastOp = ops.at(-1)!;
 
    // Function call: ()
    if (lastOp.hasArgumentList || lastOp.textEndsWithParen) {
      return "function";
    }
 
    // Member access: .identifier
    if (lastOp.hasIdentifier) {
      return "member";
    }
 
    // Array access: [expression]
    if (lastOp.hasExpression) {
      return "array";
    }
 
    return null;
  }
}
 
export default CppMemberHelper;