Contributed by EiNSTeiN_:

- added support for 'long' addresses 
- updated copyright notice in hexrays.i
- added methods to remove or insert elements in the qlist<cinsn_t> list
- added support for ctree_visitor_t / ctree_parentee_t / cfunc_parentee_t / user_lvar_visitor_t
- updated vds3 sample
- added vds4 and vds7 python samples (ported from their C++ counter parts)

Author: elias.bachaalany@gmail.com

examples/vds3.py

@@ -88,41 +88,74 @@ def add_location(self, ea):
         self.save()
         return
 
-    def invert_if_event(self, vu):
+    def find_if_statement(self, vu):
 
         vu.get_current_item(idaapi.USE_KEYBOARD)
         item = vu.item
 
+        if item.is_citem() and item.it.op == idaapi.cit_if and item.it.to_specific_type.cif.ielse is not None:
+            return item.it.to_specific_type
+        
+        if vu.tail.citype == idaapi.VDI_TAIL and vu.tail.loc.itp == idaapi.ITP_ELSE:
+            # for tail marks, we know only the corresponding ea,
+            # not the pointer to if-statement
+            # find it by walking the whole ctree
+            class if_finder_t(idaapi.ctree_visitor_t):
+                def __init__(self, ea):
+                    idaapi.ctree_visitor_t.__init__(self, idaapi.CV_FAST | idaapi.CV_INSNS)
+                    
+                    self.ea = ea
+                    self.found = None
+                    return
+                
+                def visit_insn(self, i):
+                    if i.op == idaapi.cit_if and i.ea == self.ea:
+                        self.found = i
+                        return 1 # stop enumeration
+                    return 0
+            
+            iff = if_finder_t(vu.tail.loc.ea)
+            if iff.apply_to(vu.cfunc.body, None):
+                return iff.found
+        
+        return
+    
+    def invert_if_event(self, vu):
+        
         cfunc = vu.cfunc.__deref__()
 
-        if item.citype != idaapi.VDI_EXPR:
+        i = self.find_if_statement(vu)
+        if not i:
             return False
 
-        if self.invert_if(cfunc, item.it.to_specific_type):
+        if self.invert_if(cfunc, i):
             vu.refresh_ctext()
 
-            self.add_location(item.it.ea)
+            self.add_location(i.ea)
 
         return True
 
     def restore(self, cfunc):
 
-        #~ print 'restoring invert-if for %x' % (cfunc.entry_ea, )
-        
-        str(cfunc) # generate treeitems.
-        
-        restored = False
+        class visitor(idaapi.ctree_visitor_t):
+            
+            def __init__(self, inverter, cfunc):
+                idaapi.ctree_visitor_t.__init__(self, idaapi.CV_FAST | idaapi.CV_INSNS)
+                self.inverter = inverter
+                self.cfunc = cfunc
+                return
+            
+            def visit_insn(self, i):
+                try:
+                    if i.op == idaapi.cit_if and i.ea in self.inverter.stored:
+                        self.inverter.invert_if(self.cfunc, i)
+                except:
+                    traceback.print_exc()
+                return 0 # continue enumeration
 
-        for item in cfunc.treeitems:
-            item = item.to_specific_type
-            if item.opname == 'if' and item.ea in self.stored:
-                if self.invert_if(cfunc, item):
-                    restored = True
-                    #~ print 'restore invert-if location %x' % (item.ea, )
-                else:
-                    print 'invert-if location %x: NOT RESTORED' % (item.ea, )
+        visitor(self, cfunc).apply_to(cfunc.body, None)
 
-        return restored
+        return
 
     def menu_callback(self):
         try:
@@ -142,7 +175,7 @@ def event_callback(self, event, *args):
                         return 1
 
             elif event == idaapi.hxe_right_click:
-                self.vu = args[0]
+                self.vu,  = args
                 idaapi.add_custom_viewer_popup_item(self.vu.ct, "Invert then/else", "I", self.menu_callback)
 
             elif event == idaapi.hxe_maturity:

examples/vds4.py

@@ -0,0 +1,123 @@
+""" Print user-defined details to the output window.
+
+Author: EiNSTeiN_ <einstein@g3nius.org>
+
+This is a rewrite in Python of the vds4 example that comes with hexrays sdk.
+"""
+
+import idautils
+import idaapi
+import idc
+
+import traceback
+
+def run():
+    
+    cfunc = idaapi.decompile(idaapi.get_screen_ea())
+    if not cfunc:
+        print 'Please move the cursor into a function.'
+        return
+    
+    entry_ea = cfunc.entry_ea
+    print "Dump of user-defined information for function at %x" % (entry_ea, )
+    
+    # Display user defined labels.
+    labels = idaapi.restore_user_labels(entry_ea);
+    if labels is not None:
+        print "------- %u user defined labels" % (len(labels), )
+        for org_label, name in labels.iteritems():
+            print "Label %d: %s" % (org_label, str(name))
+        idaapi.user_labels_free(labels)
+    
+    # Display user defined comments
+    cmts = idaapi.restore_user_cmts(entry_ea);
+    if cmts is not None:
+        print "------- %u user defined comments" % (len(cmts), )
+        for tl, cmt in cmts.iteritems():
+            print "Comment at %x, preciser %x:\n%s\n" % (tl.ea, tl.itp, str(cmt))
+        idaapi.user_cmts_free(cmts)
+    
+    # Display user defined citem iflags
+    iflags = idaapi.restore_user_iflags(entry_ea)
+    if iflags is not None:
+        print "------- %u user defined citem iflags" % (len(iflags), )
+        for cl, t in iflags.iteritems():
+            print "%a(%d): %08X%s" % (cl.ea, cl.op, f, " CIT_COLLAPSED" if f & CIT_COLLAPSED else "")
+        idaapi.user_iflags_free(iflags)
+
+    # Display user defined number formats
+    numforms = idaapi.restore_user_numforms(entry_ea)
+    if numforms is not None:
+        print "------- %u user defined number formats" % (len(numforms), )
+        for ol, nf in numforms.iteritems():
+            
+            print "Number format at %a, operand %d: %s" % (ol.ea, ol.opnum, "negated " if (nf.props & NF_NEGATE) != 0 else "")
+            
+            if nf.isEnum():
+                print "enum %s (serial %d)" % (str(nf.type_name), nf.serial)
+                
+            elif nf.isChar():
+                print "char"
+                
+            elif nf.isStroff():
+                print "struct offset %s" % (str(nf.type_name), )
+                
+            else:
+                print "number base=%d" % (idaapi.getRadix(nf.flags, ol.opnum), )
+        
+        idaapi.user_numforms_free(numforms)
+
+    # Display user-defined local variable information
+    # First defined the visitor class
+    class dump_lvar_info_t(idaapi.user_lvar_visitor_t):
+    
+        def __init__(self):
+            idaapi.user_lvar_visitor_t.__init__(self)
+            self.displayed_header = False
+            return
+        
+        def get_info_qty_for_saving(self):
+            return 0
+        
+        def get_info_for_saving(self, lv):
+            return False
+        
+        def handle_retrieved_info(self, lv):
+            
+            try:
+                if not self.displayed_header:
+                    self.displayed_header = True;
+                    print "------- User defined local variable information"
+                
+                print "Lvar defined at %x" % (lv.ll.defea, )
+                
+                if len(str(lv.name)):
+                    print "  Name: %s" % (str(lv.name), )
+                
+                if len(str(lv.type)):
+                    #~ print_type_to_one_line(buf, sizeof(buf), idati, .c_str());
+                    print "  Type: %s" % (str(lv.type), )
+                
+                if len(str(lv.cmt)):
+                    print "  Comment: %s" % (str(lv.cmt), )
+            except:
+                traceback.print_exc()
+            return 0
+    
+        def handle_retrieved_mapping(self, lm):
+            return 0
+        
+        def get_info_mapping_for_saving(self):
+            return None
+    
+    # Now iterate over all user definitions
+    dli = dump_lvar_info_t();
+    idaapi.restore_user_lvar_settings(entry_ea, dli)
+    
+    return
+
+
+if idaapi.init_hexrays_plugin():
+    run()
+else:
+    print 'dump user info: hexrays is not available.'

examples/vds7.py

@@ -0,0 +1,62 @@
+""" It demonstrates how to iterate a cblock_t object.
+
+Author: EiNSTeiN_ <einstein@g3nius.org>
+
+This is a rewrite in Python of the vds7 example that comes with hexrays sdk.
+"""
+
+import idautils
+import idaapi
+import idc
+
+import traceback
+
+class cblock_visitor_t(idaapi.ctree_visitor_t):
+
+    def __init__(self):
+        idaapi.ctree_visitor_t.__init__(self, idaapi.CV_FAST)
+        return
+    
+    def visit_insn(self, ins):
+        
+        try:
+            if ins.op == idaapi.cit_block:
+                self.dump_block(ins.ea, ins.cblock)
+        except:
+            traceback.print_exc()
+        
+        return 0
+    
+    def dump_block(self, ea, b):
+        # iterate over all block instructions
+        print "dumping block %x" % (ea, )
+        for ins in b:
+            print "  %x: insn %s" % (ins.ea, ins.opname)
+        
+        return
+
+class hexrays_callback_info(object):
+    
+    def __init__(self):
+        return
+    
+    def event_callback(self, event, *args):
+        
+        try:
+            if event == idaapi.hxe_maturity:
+                cfunc, maturity = args
+                
+                if maturity == idaapi.CMAT_BUILT:
+                    cbv = cblock_visitor_t()
+                    cbv.apply_to(cfunc.body, None)
+            
+        except:
+            traceback.print_exc()
+        
+        return 0
+
+if idaapi.init_hexrays_plugin():
+    i = hexrays_callback_info()
+    idaapi.install_hexrays_callback(i.event_callback)
+else:
+    print 'cblock visitor: hexrays is not available.'