docs/debug_8h_source.html

 #pragma once

 #include <stdio.h>

 #include "vm.h"

 #include "chunk.h"

 #include "object.h"


 #ifndef KRK_DISABLE_DEBUG


 extern void krk_disassembleCodeObject(FILE * f, KrkCodeObject * func, const char * name);


 extern size_t krk_disassembleInstruction(FILE * f, KrkCodeObject * func, size_t offset);


 extern int krk_debugBreakpointHandler(void);


 extern int krk_debuggerHook(KrkCallFrame * frame);


 typedef int (*KrkDebugCallback)(KrkCallFrame *frame);


 extern int krk_debug_registerCallback(KrkDebugCallback hook);


 extern int krk_debug_addBreakpointFileLine(KrkString * filename, size_t line, int flags);


 extern int krk_debug_addBreakpointCodeOffset(KrkCodeObject * codeObject, size_t offset, int flags);


 extern int krk_debug_removeBreakpoint(int breakpointId);


 extern int krk_debug_enableBreakpoint(int breakpointId);


 extern int krk_debug_disableBreakpoint(int breakpointId);


 extern void krk_debug_enableSingleStep(void);


 extern void krk_debug_disableSingleStep(void);


 extern void krk_debug_dumpTraceback(void);


 extern int krk_debug_examineBreakpoint(int breakIndex, KrkCodeObject ** funcOut, size_t * offsetOut, int * flagsOut, int *enabledOut);


 extern void krk_debug_dumpStack(FILE * f, KrkCallFrame * frame);


 extern void krk_debug_init(void);


 #define KRK_BREAKPOINT_NORMAL  0

 #define KRK_BREAKPOINT_ONCE    1

 #define KRK_BREAKPOINT_REPEAT  2


 #define KRK_DEBUGGER_CONTINUE  0

 #define KRK_DEBUGGER_ABORT     1

 #define KRK_DEBUGGER_STEP      2

 #define KRK_DEBUGGER_RAISE     3

 #define KRK_DEBUGGER_QUIT      4


 extern void krk_debug_addExpression(KrkCodeObject * codeobject, uint8_t start, uint8_t midStart, uint8_t midEnd, uint8_t end);


 extern int krk_debug_expressionUnderline(const KrkCodeObject * codeobject, uint8_t * start, uint8_t * midStart, uint8_t * endStart, uint8_t * end, size_t instruction);


 extern void krk_printValueSafe(FILE * f, KrkValue value);


 #endif

chunk.h
Structures and enums for bytecode chunks.

krk_debug_addBreakpointCodeOffset
int krk_debug_addBreakpointCodeOffset(KrkCodeObject *codeObject, size_t offset, int flags)
Add a breakpoint to the given code object.
Definition: debug.c:469

krk_debug_disableSingleStep
void krk_debug_disableSingleStep(void)
Disable single stepping in the current thread.
Definition: debug.c:593

krk_debuggerHook
int krk_debuggerHook(KrkCallFrame *frame)
Called by the VM on single step.
Definition: debug.c:597

krk_debug_examineBreakpoint
int krk_debug_examineBreakpoint(int breakIndex, KrkCodeObject **funcOut, size_t *offsetOut, int *flagsOut, int *enabledOut)
Retreive information on a breakpoint.
Definition: debug.c:649

krk_debug_init
void krk_debug_init(void)
Initialize debugger state. Call exactly once per VM.
Definition: debug.c:699

KrkDebugCallback
int(* KrkDebugCallback)(KrkCallFrame *frame)
Function pointer for a debugger hook. krk_debug_registerCallback()
Definition: debug.h:73

krk_debug_enableBreakpoint
int krk_debug_enableBreakpoint(int breakpointId)
Enable a breakpoint.
Definition: debug.c:535

krk_debugBreakpointHandler
int krk_debugBreakpointHandler(void)
Called by the VM when a breakpoint is encountered.
Definition: debug.c:663

krk_debug_dumpTraceback
void krk_debug_dumpTraceback(void)
Safely dump a traceback to stderr.
Definition: debug.c:577

krk_debug_enableSingleStep
void krk_debug_enableSingleStep(void)
Enable single stepping in the current thread.
Definition: debug.c:589

krk_debug_removeBreakpoint
int krk_debug_removeBreakpoint(int breakpointId)
Remove a breakpoint from the breakpoint table.
Definition: debug.c:553

krk_debug_registerCallback
int krk_debug_registerCallback(KrkDebugCallback hook)
Register a debugger callback.
Definition: debug.c:643

krk_debug_disableBreakpoint
int krk_debug_disableBreakpoint(int breakpointId)
Disable a breakpoint.
Definition: debug.c:542

krk_disassembleInstruction
size_t krk_disassembleInstruction(FILE *f, KrkCodeObject *func, size_t offset)
Print a disassembly of a single opcode instruction.
Definition: debug.c:415

krk_debug_addBreakpointFileLine
int krk_debug_addBreakpointFileLine(KrkString *filename, size_t line, int flags)
Add a breakpoint to the given line of a file.
Definition: debug.c:495

krk_disassembleCodeObject
void krk_disassembleCodeObject(FILE *f, KrkCodeObject *func, const char *name)
Print a disassembly of 'func' to the stream 'f'.
Definition: debug.c:163

krk_debug_dumpStack
void krk_debug_dumpStack(FILE *f, KrkCallFrame *frame)
Print the elements on the stack.
Definition: debug.c:125

object.h
Struct definitions for core object types.

KrkCallFrame
Represents a managed call state in a VM thread.
Definition: vm.h:44

KrkCodeObject
Code object.
Definition: object.h:163

KrkCodeObject::krk_debug_addExpression
void krk_debug_addExpression(KrkCodeObject *codeobject, uint8_t start, uint8_t midStart, uint8_t midEnd, uint8_t end)
Add an expression mapping to the bytecode chunk.
Definition: debug.c:705

KrkCodeObject::krk_debug_expressionUnderline
int krk_debug_expressionUnderline(const KrkCodeObject *codeobject, uint8_t *start, uint8_t *midStart, uint8_t *endStart, uint8_t *end, size_t instruction)
Extract expression mapping from chunk.
Definition: debug.c:726

KrkString
Immutable sequence of Unicode codepoints.
Definition: object.h:93

KrkValue
Stack reference or primative value.

KrkValue::krk_printValueSafe
void krk_printValueSafe(FILE *f, KrkValue value)
Print a value without calling the VM.
Definition: debug.c:21

vm.h
Core API for the bytecode virtual machine.