All files / PARSE/4-Resolve/types IConstantNameFacts.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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import type ILocalDeclaration from "../../../types/ILocalDeclaration";
import type TChainRoot from "../../../types/TChainRoot";
import type TConstResult from "../../../types/TConstResult";
import type TSymbol from "../../../types/symbols/TSymbol";
import type TValueBinding from "../../../types/TValueBinding";
import type IVariableSymbol from "../../../types/symbols/IVariableSymbol";
import type ISourcePosition from "../../../utils/types/ISourcePosition";
import type IForeignValue from "./IForeignValue";
import type TSettledConst from "../../../types/TSettledConst";
 
/**
 * What `ConstantNames` asks while it walks a name's chain (#1175, #1669), as
 * seen from one file. 1.4 Resolve answers it twice -- while the program's
 * consts and enum values settle, and from the settled program for every later
 * pass -- from the same binder, so a name has one value in both.
 */
interface IConstantNameFacts {
  /** The binder's answer for a chain's head where it is written (ADR-057) */
  bind(
    root: TChainRoot,
    name: string,
    at: ISourcePosition,
  ): TValueBinding | null;
  /** The scope a position is in, for ADR-057's type qualification */
  scopePathAt(at: ISourcePosition): string;
  /** A C-Next declaration this file can see, by C name */
  visibleSymbol(cName: string): TSymbol | undefined;
  /** Whether a qualified C-Next type name is a scope type this file can see */
  isScopeTypeVisible(qualifiedName: string): boolean;
  /** A const's settled value, or why it has none; undefined until it settles */
  constValue(symbol: IVariableSymbol): TSettledConst | undefined;
  /** A local as settled; undefined when it has not settled (yet) */
  settledLocal(declaration: ILocalDeclaration): ILocalDeclaration | undefined;
  /**
   * Whether this file includes a C or C++ header, directly or transitively:
   * a name nothing binds may then be a macro, which only C can evaluate
   */
  readonly reachesForeignHeader: boolean;
  /** A header's variable or function the binder bound `name` to; null otherwise */
  foreignValue(name: string): IForeignValue | null;
  /** A member of the enum with C name `enumCName` */
  enumMember(
    enumCName: string,
    member: string,
    spelling: string,
    at: ISourcePosition,
  ): TConstResult;
}
 
export default IConstantNameFacts;