C Interface

This section documents the interface that must be implemented for a debugger to be compatible with this framework.

The interface is written in C and can be implemented with any compatible language. We provide an example implementation in C++ based on the DD simulation backend from MQT Core.

C-Interfaces

• common.h
  • LOAD_RESULT_MESSAGE_MAX
  • Result
    • OK
    • ERROR
  • LoadResultStatus
    • LOAD_OK
    • LOAD_PARSE_ERROR
    • LOAD_INTERNAL_ERROR
  • VariableType
    • VarBool
    • VarInt
    • VarFloat
  • LoadResult
    • status
    • line
    • column
    • message
  • VariableValue
    • boolValue
    • intValue
    • floatValue
  • Variable
    • name
    • type
    • value
  • Complex
    • real
    • imaginary
  • Statevector
    • numQubits
    • numStates
    • amplitudes
  • CompilationSettings
    • opt
    • sliceIndex
• debug.h
  • SimulationState
  • SimulationStateStruct
    • init
    • loadCode
    • stepForward
    • stepOverForward
    • stepOutForward
    • stepBackward
    • stepOverBackward
    • stepOutBackward
    • runAll
    • runSimulation
    • runSimulationBackward
    • resetSimulation
    • pauseSimulation
    • canStepForward
    • canStepBackward
    • changeClassicalVariableValue
    • changeAmplitudeValue
    • isFinished
    • didAssertionFail
    • wasBreakpointHit
    • getCurrentInstruction
    • getInstructionCount
    • getInstructionPosition
    • getNumQubits
    • getAmplitudeIndex
    • getAmplitudeBitstring
    • getClassicalVariable
    • getNumClassicalVariables
    • getClassicalVariableName
    • getQuantumVariableName
    • getStateVectorFull
    • getStateVectorSub
    • setBreakpoint
    • clearBreakpoints
    • getStackDepth
    • getStackTrace
    • getDiagnostics
    • compile
• diagnostics.h
  • ErrorCause
  • Diagnostics
  • ErrorCauseType
    • Unknown
    • MissingInteraction
    • ControlAlwaysZero
  • ErrorCauseStruct
    • type
    • instruction
  • DiagnosticsStruct
    • init
    • getNumQubits
    • getInstructionCount
    • getDataDependencies
    • getInteractions
    • getZeroControlInstructions
    • potentialErrorCauses
    • suggestAssertionMovements
    • suggestNewAssertions