All files / transpiler/types/symbols IVariableSymbol.ts

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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import type IBaseSymbol from "./IBaseSymbol";
import type TType from "../TType";
import type TOverflowBehavior from "../TOverflowBehavior";
 
/**
 * Symbol representing a variable (global, static, or extern).
 */
interface IVariableSymbol extends IBaseSymbol {
  /** Discriminator narrowed to "variable" */
  readonly kind: "variable";
 
  /** Variable type */
  readonly type: TType;
 
  /** Whether this variable is const */
  readonly isConst: boolean;
 
  /** Whether this variable is atomic (volatile in C) */
  readonly isAtomic: boolean;
 
  /**
   * Whether this variable carries an explicit `volatile` modifier.
   *
   * Resolved here, once, so the `.c` definition and the `.h` declaration cannot
   * disagree: the header used to hardcode this false, which is a "conflicting
   * type qualifiers" error as soon as the `.c` includes its own header.
   */
  readonly isVolatile: boolean;
 
  /**
   * ADR-044 overflow behavior: `clamp` (the default) or `wrap`.
   *
   * Issue #1303: authored here, once, so the declared behavior travels with
   * the symbol across a file boundary. It previously existed only in codegen's
   * per-file type registry, so an imported `u8` arrived with nothing to say
   * whether it saturated or wrapped -- and codegen emitted plain C arithmetic,
   * silently turning ADR-044's safe default into two's-complement wrap.
   *
   * Required rather than optional on purpose: ADR-044 gives EVERY integer
   * declaration a behavior, so a construction site that cannot name one is a
   * site that has lost the fact, and should not be able to compile.
   */
  readonly overflowBehavior: TOverflowBehavior;
 
  /** Whether this variable is an array */
  readonly isArray: boolean;
 
  /** Array dimensions if isArray is true - numbers for resolved, strings for macros */
  readonly arrayDimensions?: ReadonlyArray<number | string>;
 
  /** Initial value expression (as string) */
  readonly initialValue?: string;
}
 
export default IVariableSymbol;