Files
modeling-app/src/lang/modelingWorkflows.ts
Kurt Hutten 121c393466 UI fix for comment settings collision (#6249)
* UI fix for comment settings collision

* fmt

* Fix tsc by using Promise.reject

---------

Co-authored-by: Frank Noirot <frankjohnson1993@gmail.com>
2025-04-11 14:16:45 +00:00

104 lines
3.2 KiB
TypeScript

/**
* Modeling Workflows
*
* This module contains higher-level CAD operation workflows that
* coordinate between different subsystems in the app
* AST, code editor, file system and 3D engine.
*/
import type { Node } from '@rust/kcl-lib/bindings/Node'
import type EditorManager from '@src/editor/manager'
import type { KclManager } from '@src/lang/KclSingleton'
import type CodeManager from '@src/lang/codeManager'
import type { PathToNode, Program } from '@src/lang/wasm'
import type { ExecutionType } from '@src/lib/constants'
import {
EXECUTION_TYPE_MOCK,
EXECUTION_TYPE_NONE,
EXECUTION_TYPE_REAL,
} from '@src/lib/constants'
import type { Selections } from '@src/lib/selections'
import { err, reject } from '@src/lib/trap'
/**
* Updates the complete modeling state:
* AST, code editor, file, and 3D scene.
*
* Steps:
* 1. Updates the AST and internal state
* 2. Updates the code editor and writes to file
* 3. Sets focus in the editor if needed
* 4. Attempts to execute the model in the 3D engine
*
* This function follows common CAD application patterns where:
*
* - The feature tree reflects user's actions
* - The engine does its best to visualize what's possible
* - Invalid operations appear in feature tree but may not render fully
*
* This ensures the user can edit the feature tree,
* regardless of geometric validity issues.
*
* @param ast - AST to commit
* @param executionType - How to execute the AST
* @param dependencies - Required system components
* @param options - Optional parameters for focus, zoom, etc.
*/
export async function updateModelingState(
ast: Node<Program>,
executionType: ExecutionType,
dependencies: {
kclManager: KclManager
editorManager: EditorManager
codeManager: CodeManager
},
options?: {
focusPath?: Array<PathToNode>
skipUpdateAst?: boolean
}
): Promise<void> {
let updatedAst: {
newAst: Node<Program>
selections?: Selections
} = { newAst: ast }
// TODO: understand why this skip flag is needed for insertAstMod.
// It's unclear why we double casts the AST
if (!options?.skipUpdateAst) {
// Step 1: Update AST without executing (prepare selections)
updatedAst = await dependencies.kclManager.updateAst(
ast,
false, // Execution handled separately for error resilience
options
)
}
// Step 2: Update the code editor and save file
await dependencies.codeManager.updateEditorWithAstAndWriteToFile(
updatedAst.newAst
)
// Step 3: Set focus on the newly added code if needed
if (updatedAst.selections) {
dependencies.editorManager.selectRange(updatedAst.selections)
}
// Step 4: Try to execute the new code
// and continue regardless of errors
try {
if (executionType === EXECUTION_TYPE_REAL) {
await dependencies.kclManager.executeAst({
ast: updatedAst.newAst,
})
} else if (executionType === EXECUTION_TYPE_MOCK) {
const didReParse = await dependencies.kclManager.executeAstMock(
updatedAst.newAst
)
if (err(didReParse)) return reject(didReParse)
} else if (executionType === EXECUTION_TYPE_NONE) {
// No execution.
}
} catch (e) {
console.error('Engine execution error (UI is still updated):', e)
}
}