@typecad/framework-zephyr 1.0.0-alpha.8

package/dist/strategy.d.ts

@@ -0,0 +1,168 @@
+import type { PlatformStrategy, ProgramIR, Diagnostic, PlatformContext, BoardConstants, RuntimePolyfillIR, StdLibSupport, AsyncRuntimeConfig, GraphicsCapacity, HALOpIR, DisplayHALOp, ResolvedDisplay, DisplayAdapterCode, DisplayProfile, TouchProfile, TouchAdapterCodegen } from '@typecad/cuttlefish/api/shared';
+export declare class ZephyrStrategy implements PlatformStrategy {
+    readonly id = "zephyr";
+    /**
+     * Resolve + cache the active chip from the platform context. Called lazily
+     * by the methods that need the descriptor (shimLines, resolveHALOperation
+     * via lowerHalOp).
+     *
+     * Tries to derive the chip descriptor from the board/MCU package's zephyr
+     * fields (via boardConstants) first. Falls back to the hardcoded
+     * chipForTarget registry for boards that haven't shipped zephyr config yet.
+     */
+    private resolveChip;
+    /**
+     * Resolve the debug mode for the active target from the platform context.
+     * Mirrors resolveChip's target extraction so shimLines/forcedIncludes can
+     * gate the printf halt shim + console UART include to printf builds only
+     * (gdb builds use VS Code native breakpoints + #line markers, so the
+     * __tc_debug_wait_for_continue shim and its <zephyr/drivers/uart.h> include
+     * are dead code there).
+     */
+    private resolveDebugMode;
+    forcedIncludes(_program?: ProgramIR, ctx?: PlatformContext): string[];
+    symbolAliases(): Record<string, string>;
+    /**
+     * Detect async-runtime usage: a program needs the Promise/microtask runtime
+     * if it declares an async function OR references an async-runtime symbol
+     * (`__cuttlefish_async_`) — e.g. Async.sleep()/.then() called from a non-async
+     * function. Mirrors Arduino's programUsesAsyncRuntime walk (that helper is
+     * private to framework-arduino and not exported from cuttlefish, so we walk
+     * here). The token appears in `raw` expr nodes and in `hal-expr`/`hal-op`
+     * nodes whose resolved `raw` code references it.
+     */
+    private programUsesAsyncRuntime;
+    shimLines(program?: ProgramIR, ctx?: PlatformContext): string[];
+    profileDiagnostics(program?: ProgramIR, ctx?: PlatformContext): Diagnostic[];
+    /**
+     * `loop` is forward-declared `extern` by the main() bridge shim
+     * (extern void loop(void); → int main(void) {...}), so emitting a
+     * `static void loop()` definition redeclares it with conflicting linkage,
+     * which GCC rejects. Exclude it from the static forward-declaration path
+     * — mirrors how ArduinoStrategy excludes `loop` (the Arduino core forward-
+     * declares it extern). `setup` is already handled because it equals
+     * entrypointFunctionName().
+     */
+    forwardDeclarationExclusions(): string[];
+    sourceExtension(): string;
+    entrypointFunctionName(): string;
+    requiresLoopFunction(): boolean;
+    overrideBaseName(originalBaseName: string, outDirBaseName: string, isEntryFile: boolean, isNpmPackage: boolean): string;
+    effectiveEmitMode(requestedMode: string, _isNpmPackage: boolean): string;
+    normalizeCppType(typeName: string): string;
+    defaultNumericType(compliance?: {
+        isBanned(ruleId: string): boolean;
+    }): string;
+    mapReturnType(functionName: string, returnType: string): string;
+    isStringLikeType(cppType: string): boolean;
+    isPointerType(cppType: string): boolean;
+    mapFunctionName(originalName: string): string;
+    normalizeRawExpression(value: string): string;
+    nullValue(): string;
+    wrapStringConcat(): string | undefined;
+    wrapStringObject(value: string): string;
+    useSnprintfForStrings(): boolean;
+    renameEnumMember(_enumName: string, memberName: string): string;
+    private _largeEnumNames;
+    setLargeEnumNames(names: ReadonlySet<string>): void;
+    enumCastType(_enumName: string): string | undefined;
+    renderBoardDefinitionAccess(chain: string[], boardConstants?: BoardConstants): string | undefined;
+    promotesArrayLiteralsToStaticArray(): boolean;
+    renderThrow(_valueExpr: string): string;
+    isConsoleCall(callee: string): boolean;
+    transformConsoleCall(method: string, renderedArgs: string, forHeader: boolean): string;
+    transformConsoleExpression(_method: string, _renderedArgs: string): string | undefined;
+    objectFieldInitializer(): string | undefined;
+    overrideClassFieldType(_fieldName: string, normalizedType: string): string;
+    reservedNames(): ReadonlySet<string>;
+    passthroughMacroNames(): ReadonlySet<string>;
+    apiReservedEnumNames(): ReadonlySet<string>;
+    apiReservedEnumGuard(): string;
+    ambientTypeDeclarations(): string[];
+    needsIostream(): boolean;
+    needsStdString(): boolean;
+    needsStdVector(): boolean;
+    needsStdExcept(): boolean;
+    needsStdFunction(): boolean;
+    mathHeader(): string;
+    cstringHeader(): string;
+    needsVectorOverload(): boolean;
+    needsLargeEnumUnderlying(): boolean;
+    renameStructField(fieldName: string): string;
+    structFieldInitializer(): string | undefined;
+    getAsyncRuntimeConfig(): AsyncRuntimeConfig;
+    asyncLoopInjection(taskVarNames: string[], config: AsyncRuntimeConfig): string[];
+    asyncLoopInjection(taskVarNames: string[], hasPromiseRuntime: boolean, hasTimers: boolean): string[];
+    asyncDriverFunctionName(): string;
+    shouldSkipTypeAlias(): boolean;
+    emitDiagnostics(): Diagnostic[];
+    currentTimeMillis(): string;
+    asyncQueueCapacity(): number;
+    outputSubdirectory(_baseName: string): string;
+    generateHeaderFile(): boolean;
+    enumApiGuard(_enumName: string): {
+        open: string;
+        close: string;
+    } | undefined;
+    getStdLibSupport(_architecture?: string): StdLibSupport;
+    nativePolyfills(): Set<string>;
+    generateNativePolyfills(program?: ProgramIR, ctx?: PlatformContext): RuntimePolyfillIR[];
+    resolveHALOperation(op: HALOpIR): {
+        code?: string;
+        expression?: string;
+    } | undefined;
+    modelsGpio(): boolean;
+    readDigitalPin(pin: string): string;
+    readAnalogPin(pin: string): string;
+    writeDigitalPin(pin: string, val: string): string;
+    setPinMode(_pin: string, _mode: string): string;
+    delayMs(ms: string): string;
+    delayMicroseconds(us: string): string;
+    halCallNames(): ReadonlySet<string>;
+    isHalCall(name: string): boolean;
+    analogReadCallNames(): ReadonlySet<string>;
+    isRtosTarget(): boolean;
+    private _workerBacking;
+    private _displayState;
+    workerSpawnLines(handleId: number, trampolineName: string, waiterExpr: string): string[] | undefined;
+    workerSignalDoneExpr(handleId: number): string | undefined;
+    workerIsDoneExpr(handleId: number): string | undefined;
+    resolveDisplayOp(op: DisplayHALOp): {
+        code?: string;
+        expression?: string;
+    } | undefined;
+    supportedDisplayDrivers(): ReadonlySet<string>;
+    providesDisplayAdapter(): boolean;
+    resolveDisplayAdapter(display: ResolvedDisplay): DisplayAdapterCode | undefined;
+    providesTouchAdapter(): boolean;
+    resolveTouchAdapter(touch: TouchProfile): TouchAdapterCodegen | undefined;
+    getProfileRegistry(): Map<string, DisplayProfile>;
+    colorFormat(): 'rgb565' | 'rgb666' | 'rgb888' | 'mono';
+    graphicsCapacity(): GraphicsCapacity;
+    debugMode(target?: string): 'gdb' | 'printf';
+    generateDebugInitCode(): string[];
+    generateDebugBreakpointCode(params: {
+        fileName: string;
+        lineNum: number;
+        originalLine: string;
+        variables: Array<{
+            name: string;
+            isFunction?: boolean;
+            cppType?: 'bool' | 'int' | 'long' | 'float' | 'string' | 'unknown';
+        }>;
+        normalizedCondition?: string;
+        breakpointId?: number;
+    }): string[];
+    generateDebugLogpointCode(params: {
+        fileName: string;
+        lineNum: number;
+        parts: Array<{
+            type: 'text' | 'variable';
+            value: string;
+        }>;
+        variables: Array<{
+            name: string;
+            isFunction?: boolean;
+        }>;
+    }): string[];
+}