Tweak the interpose API, and fix a couple of bugs.

angavrilov · angavrilov · commit 01ba2a31fc2d · 2012-08-18T11:48:07.000+04:00
diff --git a/library/VTableInterpose.cpp b/library/VTableInterpose.cpp
@@ -161,6 +161,7 @@ VMethodInterposeLinkBase::VMethodInterposeLinkBase(virtual_identity *host, int v
     : host(host), vmethod_idx(vmethod_idx), interpose_method(interpose_method), chain_mptr(chain_mptr),
       saved_chain(NULL), next(NULL), prev(NULL)
 {
+    assert(vmethod_idx >= 0 && interpose_method != NULL);
 }
 
 VMethodInterposeLinkBase::~VMethodInterposeLinkBase()
@@ -198,6 +199,7 @@ bool VMethodInterposeLinkBase::apply()
         return false;
 
     set_chain(old_ptr);
+    host->interpose_list.push_back(this);
 
     // Link into the chain if any
     if (old_link)
diff --git a/library/include/VTableInterpose.h b/library/include/VTableInterpose.h
@@ -81,12 +81,18 @@ namespace DFHack
         return addr_to_method_pointer<P>(identity.get_vmethod_ptr(idx));
     }
 
-    /* VMethod interpose API
+    /* VMethod interpose API.
+
+       This API allows replacing an entry in the original vtable
+       with code defined by DFHack, while retaining ability to
+       call the original code. The API can be safely used from
+       plugins, and multiple hooks for the same vmethod are
+       automatically chained in undefined order.
 
        Usage:
 
-       struct my_hack : public someclass {
-           typedef someclass interpose_base;
+       struct my_hack : df::someclass {
+           typedef df::someclass interpose_base;
 
            DEFINE_VMETHOD_INTERPOSE(void, foo, (int arg)) {
                ...
@@ -98,7 +104,12 @@ namespace DFHack
        IMPLEMENT_VMETHOD_INTERPOSE(my_hack, foo);
 
        void init() {
-           my_hack::interpose_foo.apply()
+           if (!INTERPOSE_HOOK(my_hack, foo).apply())
+               error();
+       }
+
+       void shutdown() {
+           INTERPOSE_HOOK(my_hack, foo).remove();
        }
      */
 
@@ -112,6 +123,7 @@ namespace DFHack
         class::interpose_##name(&class::interpose_base::name, &class::interpose_fn_##name);
 
 #define INTERPOSE_NEXT(name) (this->*interpose_##name.chain)
+#define INTERPOSE_HOOK(class, name) (class::interpose_##name)
 
     class DFHACK_EXPORT VMethodInterposeLinkBase {
         /*
diff --git a/plugins/devel/vshook.cpp b/plugins/devel/vshook.cpp
@@ -33,9 +33,12 @@ struct title_hook : df::viewscreen_titlest {
             uint8_t *buf = gps->screen;
             int32_t *stp = gps->screentexpos;
 
-            for (const char *p = "DFHack " DFHACK_VERSION; *p; p++) {
-                *buf++ = *p; *buf++ = 7; *buf++ = 0; *buf++ = 1;
-                *stp++ = 0;
+            for (const char *p = "DFHack " DFHACK_VERSION;
+                 *p && buf < gps->screen_limit;
+                 p++, buf += gps->dimy*4, stp += gps->dimy)
+            {
+                buf[0] = *p; buf[1] = 7; buf[2] = 0; buf[3] = 1;
+                *stp = 0;
             }
         }
     }
@@ -47,7 +50,7 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug
 {
     if (gps)
     {
-        if (!title_hook::interpose_render.apply())
+        if (!INTERPOSE_HOOK(title_hook, render).apply())
             out.printerr("Could not interpose viewscreen_titlest::render\n");
     }
 
@@ -56,6 +59,6 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug
 
 DFhackCExport command_result plugin_shutdown ( color_ostream &out )
 {
-    title_hook::interpose_render.remove();
+    INTERPOSE_HOOK(title_hook, render).remove();
     return CR_OK;
 }

Original file line number	Diff line number	Diff line change
`@@ -161,6 +161,7 @@ VMethodInterposeLinkBase::VMethodInterposeLinkBase(virtual_identity *host, int v`
`161`	`161`	`: host(host), vmethod_idx(vmethod_idx), interpose_method(interpose_method), chain_mptr(chain_mptr),`
`162`	`162`	`saved_chain(NULL), next(NULL), prev(NULL)`
`163`	`163`	`{`
	`164`	`+ assert(vmethod_idx >= 0 && interpose_method != NULL);`
`164`	`165`	`}`
`165`	`166`
`166`	`167`	`VMethodInterposeLinkBase::~VMethodInterposeLinkBase()`
`@@ -198,6 +199,7 @@ bool VMethodInterposeLinkBase::apply()`
`198`	`199`	`return false;`
`199`	`200`
`200`	`201`	`set_chain(old_ptr);`
	`202`	`+ host->interpose_list.push_back(this);`
`201`	`203`
`202`	`204`	`// Link into the chain if any`
`203`	`205`	`if (old_link)`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,12 @@ struct title_hook : df::viewscreen_titlest {`
`33`	`33`	`uint8_t *buf = gps->screen;`
`34`	`34`	`int32_t *stp = gps->screentexpos;`
`35`	`35`
`36`		`- for (const char p = "DFHack " DFHACK_VERSION; p; p++) {`
`37`		`- buf++ = p; buf++ = 7; buf++ = 0; *buf++ = 1;`
`38`		`- *stp++ = 0;`
	`36`	`+ for (const char *p = "DFHack " DFHACK_VERSION;`
	`37`	`+ *p && buf < gps->screen_limit;`
	`38`	`+ p++, buf += gps->dimy*4, stp += gps->dimy)`
	`39`	`+ {`
	`40`	`+ buf[0] = *p; buf[1] = 7; buf[2] = 0; buf[3] = 1;`
	`41`	`+ *stp = 0;`
`39`	`42`	`}`
`40`	`43`	`}`
`41`	`44`	`}`
`@@ -47,7 +50,7 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug`
`47`	`50`	`{`
`48`	`51`	`if (gps)`
`49`	`52`	`{`
`50`		`- if (!title_hook::interpose_render.apply())`
	`53`	`+ if (!INTERPOSE_HOOK(title_hook, render).apply())`
`51`	`54`	`out.printerr("Could not interpose viewscreen_titlest::render\n");`
`52`	`55`	`}`
`53`	`56`
`@@ -56,6 +59,6 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug`
`56`	`59`
`57`	`60`	`DFhackCExport command_result plugin_shutdown ( color_ostream &out )`
`58`	`61`	`{`
`59`		`- title_hook::interpose_render.remove();`
	`62`	`+ INTERPOSE_HOOK(title_hook, render).remove();`
`60`	`63`	`return CR_OK;`
`61`	`64`	`}`