support png output, buffered file writing
[dcpu16] / dcpu16.h
index f0e4d8b54abb2d19ead94757e3858949d7819cf8..c893347ea3485e9b6aecb7bd0893b12c1a111ccf 100644 (file)
--- a/dcpu16.h
+++ b/dcpu16.h
@@ -1,6 +1,8 @@
 #ifndef DCPU16_H_3XXIQQG2
 #define DCPU16_H_3XXIQQG2
 
+#include <stdlib.h>
+
 /* the target system's concept of a word */
 typedef unsigned short DCPU16_WORD;
 
@@ -9,28 +11,51 @@ typedef unsigned short DCPU16_WORD;
 
 /* a self-contained dcpu16 core */
 struct dcpu16 {
-    unsigned long long cycle;   /* number of cycles this core has executed */
-    DCPU16_WORD reg[8];         /* system registers, a b c x y z i j */
-    DCPU16_WORD pc;             /* program counter */
-    DCPU16_WORD sp;             /* stack pointer */
-    DCPU16_WORD o;              /* overflow */
-    unsigned int skip_ : 1;     /* skip execution of next instruction */
-    DCPU16_WORD ram[DCPU16_RAM];  /* memory */
-    DCPU16_WORD reg_work_[2];   /* (private) work registers for holding literal values while decoding instructions */
+    struct dcpu16_acct_cb *cb_table_;   /* list of callbacks to invoke for certain events */
+    size_t cb_table_entries_;           /* callback list maintenance */
+    size_t cb_table_allocated_;         /* callback list maintenance */
+    unsigned int skip_ : 1;             /* skip execution of next instruction */
+    DCPU16_WORD reg_work_[2];           /* work registers for holding literal values while decoding instructions */
+
+    unsigned long long cycle;           /* number of cycles this core has executed */
+    DCPU16_WORD reg[8];                 /* system registers, a b c x y z i j */
+    DCPU16_WORD pc;                     /* program counter */
+    DCPU16_WORD sp;                     /* stack pointer */
+    DCPU16_WORD o;                      /* overflow */
+    DCPU16_WORD ram[DCPU16_RAM];        /* memory */
+};
+
+/* these are used for accounting/watchpointing/modules/&c */
+typedef unsigned int dcpu16_acct_event;
+typedef void (dcpu16_ev_cb_t)(struct dcpu16 *, dcpu16_acct_event, DCPU16_WORD, void *);
+#define DCPU16_ACCT_EV_CYCLE    (1<<1)
+#define DCPU16_ACCT_EV_READ     (1<<2)
+#define DCPU16_ACCT_EV_WRITE    (1<<3)
+#define DCPU16_ACCT_EV_NOP      (1<<4)
+#define DCPU16_ACCT_EV_RESET    (1<<5)
+struct dcpu16_acct_cb {
+    dcpu16_ev_cb_t *fn;
+    void *data;
+    dcpu16_acct_event mask;
 };
 
 /* instantiate a new core */
 struct dcpu16 *dcpu16_new(void);
 
+/* reset a core to initial state */
+void dcpu16_reset(struct dcpu16 *);
+
 /* print the current state of a core */
 void dcpu16_state_print(struct dcpu16 *);
 
 /* print the contents of ram from second to third argument */
 void dcpu16_dump_ram(struct dcpu16 *, DCPU16_WORD, DCPU16_WORD);
 
-/* print the instruction at the specified address */
-void dcpu16_disassemble_print(struct dcpu16 *, DCPU16_WORD);
+/* print the instruction at the specified address, returns number of words consumed in decoding */
+DCPU16_WORD dcpu16_disassemble_print(struct dcpu16 *, DCPU16_WORD);
 
+/* register a callback for an accounting event */
+int dcpu16_acct_add(struct dcpu16 *, dcpu16_acct_event mask, dcpu16_ev_cb_t *fn, void *data);
 
 /* execute the next instruction */
 void dcpu16_step(struct dcpu16 *);
@@ -38,7 +63,7 @@ void dcpu16_step(struct dcpu16 *);
 /* release a core */
 void dcpu16_delete(struct dcpu16 **);
 
-/* register callbacks to handle warning and debug messages, defaults to writing to stderr */
+/* register callbacks to handle warning and debug messages, default is writing to stderr, may be set to null */
 void dcpu16_warn_cb_set(void (*)(char *, ...));
 void dcpu16_trace_cb_set(void (*)(char *, ...));