reverse-engineering-anything/src/domain/elfStringTable.ts

/** Bounded source observation; consumers own scan limits, charging and caching. */
export type ElfStringTableObservation =
  | {
      readonly state: "outside";
      readonly bytes: null;
      readonly examinedBytes: 0;
      readonly contentBytes: 0;
    }
  | {
      readonly state: "terminated";
      readonly bytes: Buffer;
      readonly examinedBytes: number;
      readonly contentBytes: number;
    }
  | {
      readonly state: "truncated";
      readonly bytes: null;
      readonly examinedBytes: number;
      readonly contentBytes: number;
    };

/** Observe one ELF string-table entry without treating a bounded missing NUL as absence. */
export const observeElfStringTableEntry = (
  table: Buffer,
  offset: number,
  maximumBytes: number,
): ElfStringTableObservation => {
  if (offset < 0 || offset >= table.length)
    return { state: "outside", bytes: null, examinedBytes: 0, contentBytes: 0 };
  const window = table.subarray(offset, offset + maximumBytes);
  const end = window.indexOf(0);
  if (end < 0)
    return {
      state: "truncated",
      bytes: null,
      examinedBytes: window.length,
      contentBytes: window.length,
    };
  return {
    state: "terminated",
    bytes: window.subarray(0, end),
    examinedBytes: end + 1,
    contentBytes: end,
  };
};

/** Project admitted source bytes without inferring an original text encoding. */
export const elfStringTableText = (
  observed: ElfStringTableObservation,
): string | null => observed.bytes?.toString("latin1") ?? null;