VRL-Studio / VRL

Visual Reflection Library
http://vrl.mihosoft.eu
29 stars 18 forks source link

Model based instrumentation #58

Open miho opened 9 years ago

miho commented 9 years ago

Instead of a Groovy based transform we need a model based instrumentation in the future to ensure that instrumentation also works for other (potential) language bindings. Instead of a special utility method the idea is to directly insert pre/post events into the source.

Example 1:

int a;
a=2;

will be transformed to something like:

preEvent("declare a");
int a;
postEvent("declare a");
preEvent("assign a");
a=2;
postEvent("assign a");

For chained invocations and operators we need to introduce additional tmp-variables:

Example 2:

if(a < b) {
  //
}

will be transformed to something like:

preEvent("LESS Operator");
boolean __vrl__tmpVar_1 = a < b;
postEvent("LESS Operator");
preEvent("if");
if(__vrl__tmpVar_1) {
  //
}
postEvent("if");

We will also need to introduce a mapping between events and visual nodes to use the instrumentation from the ui.

Loops:

Loops need special treatment:

while(a<b){
  //
}

will be transformed to:

boolean __vrl_tmpVar_1 = true;
while(true) {
  preEvent("LESS Operator");
  __vrl_tmpVar_1 = a < b;
  postEvent("LESS Operator");
  if(!__vrl_tmpVar_1) break;
  //
}

For complex condition arguments we need to extract the whole invocation chain and move it into the while loop.

miho commented 9 years ago

The current implementation only inserts one invocation into the loop. Chained or nested invocations are left outside of the loop.

miho commented 9 years ago

To improve the current instrumentation implementation we should introduce a clean event api that can publish events to registered observers without changing the instrumented code. Therefore, we should add an API like the previously, Groovy specific VRLInstrumentationUtilclass and

static void VRLInstrumentationUtil.__preEvent(...)
static void VRLInstrumentationUtil.__postEvent(...)

and ideally invocation generators that generate the static method calls in the corresponding model:

static void VRLInstrumentationUtil.generatePreEvent(...)
static void VRLInstrumentationUtil.generatePostEvent(...)
miho commented 9 years ago

Basic CSG instrumentation works!

vrl-0 5-first-working-version-with-3d-02
miho commented 9 years ago

another example:

screenshot 2015-08-10 20 01 43
miho commented 9 years ago

Event generation for return statements has a bug (no event can be fired after returning from a method).

Example:

        __vrl_reserved_intermediate_var_6);
        VRLInstrumentationUtil.__preEvent("14", "return", 
        __vrl_reserved_intermediate_var_6);
        return __vrl_reserved_intermediate_var_6;
        VRLInstrumentationUtil.__postEvent("14", "return");
    }

Therefore, we need to swap the return statement invocation and its post-event invocation:

        __vrl_reserved_intermediate_var_6);
        VRLInstrumentationUtil.__preEvent("14", "return", 
        __vrl_reserved_intermediate_var_6);
        VRLInstrumentationUtil.__postEvent("14", "return");
        return __vrl_reserved_intermediate_var_6;
    }

The same applies to continue and break.