cemu-idapython/pywraps/py_graph.hpp

#ifndef __PY_IDA_GRAPH__
#define __PY_IDA_GRAPH__

//<code(py_graph)>
class py_graph_t
{
private:
  enum
  {
    GR_HAVE_USER_HINT       = 0x00000001,
    GR_HAVE_CLICKED         = 0x00000002,
    GR_HAVE_DBL_CLICKED     = 0x00000004,
    GR_HAVE_GOTFOCUS        = 0x00000008,
    GR_HAVE_LOSTFOCUS       = 0x00000010,
    GR_HAVE_CHANGED_CURRENT = 0x00000020,
    GR_HAVE_CLOSE           = 0x00000040,
    GR_HAVE_COMMAND         = 0x00000080
  };
  struct nodetext_cache_t
  {
    qstring text;
    bgcolor_t bgcolor;
    nodetext_cache_t(const nodetext_cache_t &rhs): text(rhs.text), bgcolor(rhs.bgcolor) { }
    nodetext_cache_t(const char *t, bgcolor_t c): text(t), bgcolor(c) { }
    nodetext_cache_t() { }
  };

  class nodetext_cache_map_t: public std::map<int, nodetext_cache_t>
  {
  public:
    nodetext_cache_t *get(int node_id)
    {
      iterator it = find(node_id);
      if ( it == end() )
        return NULL;
      return &it->second;
    }
    nodetext_cache_t *add(const int node_id, const char *text, bgcolor_t bgcolor = DEFCOLOR)
    {
      return &(insert(std::make_pair(node_id, nodetext_cache_t(text, bgcolor))).first->second);
    }
  };

  class tform_pygraph_map_t: public std::map<TForm *, py_graph_t *>
  {
  public:
    py_graph_t *get(TForm *form)
    {
      iterator it = find(form);
      return it == end() ? NULL : it->second;
    }
    void add(TForm *form, py_graph_t *py)
    {
      (*this)[form] = py;
    }
  };

  class cmdid_map_t: public std::map<Py_ssize_t, py_graph_t *>
  {
  private:
    Py_ssize_t uid;
  public:

    cmdid_map_t()
    {
      // We start by one and keep zero for error id
      uid = 1;
    }

    void add(py_graph_t *pyg)
    {
      (*this)[uid] = pyg;
      ++uid;
    }

    const Py_ssize_t id() const
    {
      return uid;
    }

    void clear(py_graph_t *pyg)
    {
      iterator e = end();
      for (iterator it=begin();it!=end();)
      {
        if ( it->second == pyg )
        {
          iterator temp = it++;
          erase(temp);
        }
        else
          ++it;
      }
    }

    py_graph_t *get(Py_ssize_t id)
    {
      iterator it = find(id);
      return it == end() ? NULL : it->second;
    }
  };

  static tform_pygraph_map_t tform_pyg;
  static cmdid_map_t cmdid_pyg;
  int cb_flags;
  TForm *form;
  graph_viewer_t *gv;
  bool refresh_needed;
  PyObject *self;
  nodetext_cache_map_t node_cache;

  // static callback
  static int idaapi s_callback(void *obj, int code, va_list va)
  {
    return ((py_graph_t *)obj)->gr_callback(code, va);
  }

  static bool idaapi s_menucb(void *ud)
  {
    Py_ssize_t id = (Py_ssize_t)ud;
    py_graph_t *_this = cmdid_pyg.get(id);
    if ( _this != NULL )
      _this->on_command(id);

    return true;
  }

  void on_command(Py_ssize_t id)
  {
    // Check return value to OnRefresh() call
    PYW_GIL_ENSURE;
    PyObject *ret = PyObject_CallMethod(self, (char *)S_ON_COMMAND, "n", id);
    PYW_GIL_RELEASE;
    Py_XDECREF(ret);
  }

  // Refresh user-defined graph node number and edges
  // It calls Python method and expects that the user already filled
  // the nodes and edges. The nodes and edges are retrieved and passed to IDA
  void on_user_refresh(mutable_graph_t *g)
  {
    if ( !refresh_needed )
      return;

    // Check return value to OnRefresh() call
    PYW_GIL_ENSURE;
    PyObject *ret = PyObject_CallMethod(self, (char *)S_ON_REFRESH, NULL);
    PYW_GIL_RELEASE;
    if ( ret == NULL || !PyObject_IsTrue(ret) )
    {
      Py_XDECREF(ret);
      return;
    }

    // Refer to the nodes
    PyObject *nodes = PyW_TryGetAttrString(self, S_M_NODES);
    if ( ret == NULL || !PyList_Check(nodes) )
    {
      Py_XDECREF(nodes);
      return;
    }

    // Refer to the edges
    PyObject *edges = PyW_TryGetAttrString(self, S_M_EDGES);
    if ( ret == NULL || !PyList_Check(edges) )
    {
      Py_DECREF(nodes);
      Py_XDECREF(edges);
      return;
    }

    // Resize the nodes
    int max_nodes = abs(int(PyList_Size(nodes)));
    g->clear();
    g->resize(max_nodes);

    // Mark that we refreshed already
    refresh_needed = false;

    // Clear cached nodes
    node_cache.clear();

    // Get the edges
    for ( int i=(int)PyList_Size(edges)-1; i>=0; i-- )
    {
      // Each list item is a sequence (id1, id2)
      PyObject *item = PyList_GetItem(edges, i);
      if ( !PySequence_Check(item) )
        continue;

      // Get and validate each of the two elements in the sequence
      int edge_ids[2];
      int j;
      for ( j=0; j<qnumber(edge_ids); j++ )
      {
        PyObject *id = PySequence_GetItem(item, j);
        if ( id == NULL || !PyInt_Check(id) )
        {
          Py_XDECREF(id);
          break;
        }
        int v = int(PyInt_AS_LONG(id));
        Py_DECREF(id);
        if ( v > max_nodes )
          break;

        edge_ids[j] = v;
      }

      // Incomplete?
      if ( j != qnumber(edge_ids) )
        break;

      // Add the edge
      g->add_edge(edge_ids[0], edge_ids[1], NULL);
    }
    Py_DECREF(nodes);
    Py_DECREF(edges);
  }

  // Retrieves the text for user-defined graph node
  // It expects either a string or a tuple (string, bgcolor)
  bool on_user_text(mutable_graph_t * /*g*/, int node, const char **str, bgcolor_t *bg_color)
  {
    // If already cached then return the value
    nodetext_cache_t *c = node_cache.get(node);
    if ( c != NULL )
    {
      *str = c->text.c_str();
      if ( bg_color != NULL )
        *bg_color = c->bgcolor;
      return true;
    }

    // Not cached, call Python
    PYW_GIL_ENSURE;
    PyObject *result = PyObject_CallMethod(self, (char *)S_ON_GETTEXT, "i", node);
    PYW_GIL_RELEASE;
    if ( result == NULL )
      return false;

    bgcolor_t cl = bg_color == NULL ? DEFCOLOR : *bg_color;
    const char *s;

    // User returned a string?
    if ( PyString_Check(result) )
    {
      s = PyString_AsString(result);
      if ( s == NULL )
        s = "";
      c = node_cache.add(node, s, cl);
    }
    // User returned a sequence of text and bgcolor
    else if ( PySequence_Check(result) && PySequence_Size(result) == 2 )
    {
      PyObject *py_str   = PySequence_GetItem(result, 0);
      PyObject *py_color = PySequence_GetItem(result, 1);

      if ( py_str == NULL || !PyString_Check(py_str) || (s = PyString_AsString(py_str)) == NULL )
        s = "";
      if ( py_color != NULL && PyNumber_Check(py_color) )
        cl = bgcolor_t(PyLong_AsUnsignedLong(py_color));

      c = node_cache.add(node, s, cl);

      Py_XDECREF(py_str);
      Py_XDECREF(py_color);
    }
    Py_DECREF(result);

    *str = c->text.c_str();
    if ( bg_color != NULL )
      *bg_color = c->bgcolor;

    return true;
  }

  // Retrieves the hint for the user-defined graph
  // Calls Python and expects a string or None
  int on_user_hint(mutable_graph_t *, int mousenode, int /*mouseedge_src*/, int /*mouseedge_dst*/, char **hint)
  {
    // 'hint' must be allocated by qalloc() or qstrdup()
    // out: 0-use default hint, 1-use proposed hint

    // We dispatch hints over nodes only
    if ( mousenode == -1 )
      return 0;

    PYW_GIL_ENSURE;
    PyObject *result = PyObject_CallMethod(self, (char *)S_ON_HINT, "i", mousenode);
    PYW_GIL_RELEASE;
    bool ok = result != NULL && PyString_Check(result);
    if ( !ok )
    {
      Py_XDECREF(result);
      return 0;
    }
    *hint = qstrdup(PyString_AsString(result));
    Py_DECREF(result);
    return 1; // use our hint
  }

  // graph is being destroyed
  void on_destroy(mutable_graph_t * /*g*/ = NULL)
  {
    if ( self != NULL )
    {
      if ( (cb_flags & GR_HAVE_CLOSE) != 0 )
      {
        PYW_GIL_ENSURE;
        PyObject *result = PyObject_CallMethod(self, (char *)S_ON_CLOSE, NULL);
        PYW_GIL_RELEASE;

        Py_XDECREF(result);
      }
      unbind();
    }

    // Remove the TForm from list
    if ( form != NULL )
      tform_pyg.erase(form);

    // Remove all associated commands from the list
    cmdid_pyg.clear(this);

    // Delete this instance
    delete this;
  }

  // graph is being clicked
  int on_clicked(
        graph_viewer_t * /*gv*/,
        selection_item_t * /*item1*/,
        graph_item_t *item2)
  {
    // in:  graph_viewer_t *gv
    //      selection_item_t *current_item1
    //      graph_item_t *current_item2
    // out: 0-ok, 1-ignore click
    // this callback allows you to ignore some clicks.
    // it occurs too early, internal graph variables are not updated yet
    // current_item1, current_item2 point to the same thing
    // item2 has more information.
    // see also: kernwin.hpp, custom_viewer_click_t
    if ( item2->n == -1 )
      return 1;

    PYW_GIL_ENSURE;
    PyObject *result = PyObject_CallMethod(
        self,
        (char *)S_ON_CLICK,
        "i",
        item2->n);
    PYW_GIL_RELEASE;

    if ( result == NULL || !PyObject_IsTrue(result) )
    {
      Py_XDECREF(result);
      return 1;
    }

    Py_DECREF(result);

    return 0;
  }

  // a graph node has been double clicked
  int on_dblclicked(graph_viewer_t * /*gv*/, selection_item_t *item)
  {
    // in:  graph_viewer_t *gv
    //      selection_item_t *current_item
    // out: 0-ok, 1-ignore click
    //graph_viewer_t *v   = va_arg(va, graph_viewer_t *);
    //selection_item_t *s = va_arg(va, selection_item_t *);
    if ( item == NULL || !item->is_node )
      return 1;

    PYW_GIL_ENSURE;
    PyObject *result = PyObject_CallMethod(
        self,
        (char *)S_ON_DBL_CLICK,
        "i",
        item->node);
    PYW_GIL_RELEASE;

    if ( result == NULL || !PyObject_IsTrue(result) )
    {
      Py_XDECREF(result);
      return 1;
    }
    Py_DECREF(result);
    return 0;
  }

  // a graph viewer got focus
  void on_gotfocus(graph_viewer_t * /*gv*/)
  {
    PYW_GIL_ENSURE;
    PyObject *result = PyObject_CallMethod(
        self,
        (char *)S_ON_ACTIVATE,
        NULL);
    PYW_GIL_RELEASE;
    Py_XDECREF(result);
  }

  // a graph viewer lost focus
  void on_lostfocus(graph_viewer_t * /*gv*/)
  {
    PYW_GIL_ENSURE;
    PyObject *result = PyObject_CallMethod(
        self,
        (char *)S_ON_DEACTIVATE,
        NULL);
    PYW_GIL_RELEASE;

    Py_XDECREF(result);
  }

  // a new graph node became the current node
  int on_changed_current(graph_viewer_t * /*gv*/, int curnode)
  {
    // in:  graph_viewer_t *gv
    //      int curnode
    // out: 0-ok, 1-forbid to change the current node
    if ( curnode < 0 )
      return 0;

    PYW_GIL_ENSURE;
    PyObject *result = PyObject_CallMethod(
          self,
          (char *)S_ON_SELECT,
          "i",
          curnode);
    PYW_GIL_RELEASE;

    bool allow = (result != NULL && PyObject_IsTrue(result));
    Py_XDECREF(result);
    return allow ? 0 : 1;
  }

  int gr_callback(int code, va_list va)
  {
    int ret;
    switch ( code )
    {
    //
    case grcode_user_text:
      {
        mutable_graph_t *g  = va_arg(va, mutable_graph_t *);
        int node            = va_arg(va, int);
        const char **result = va_arg(va, const char **);
        bgcolor_t *bgcolor  = va_arg(va, bgcolor_t *);
        ret = on_user_text(g, node, result, bgcolor);
        break;
      }
    //
    case grcode_destroyed:
      on_destroy(va_arg(va, mutable_graph_t *));
      ret = 0;
      break;
    //
    case grcode_clicked:
      if ( cb_flags & GR_HAVE_CLICKED )
      {
        graph_viewer_t *gv     = va_arg(va, graph_viewer_t *);
        selection_item_t *item = va_arg(va, selection_item_t *);
        graph_item_t    *gitem = va_arg(va, graph_item_t *);
        ret = on_clicked(gv, item, gitem);
      }
      else
      {
        // Ignore the click
        ret = 1;
      }
      break;
    //
    case grcode_dblclicked:
      if ( cb_flags & GR_HAVE_DBL_CLICKED )
      {
        graph_viewer_t *gv     = va_arg(va, graph_viewer_t *);
        selection_item_t *item = va_arg(va, selection_item_t *);
        ret = on_dblclicked(gv, item);
      }
      else
        ret = 1; // ignore
      break;
    //
    case grcode_gotfocus:
      if ( cb_flags & GR_HAVE_GOTFOCUS )
        on_gotfocus(va_arg(va, graph_viewer_t *));

      ret = 0;
      break;
    //
    case grcode_lostfocus:
      if ( cb_flags & GR_HAVE_LOSTFOCUS )
        on_lostfocus(va_arg(va, graph_viewer_t *));

      ret = 0;
      break;
    //
    case grcode_user_refresh:
      on_user_refresh(va_arg(va, mutable_graph_t *));

      ret = 1;
      break;
    //
    case grcode_user_hint:
      if ( cb_flags & GR_HAVE_USER_HINT )
      {
        mutable_graph_t *g = va_arg(va, mutable_graph_t *);
        int mousenode      = va_arg(va, int);
        int mouseedge_src  = va_arg(va, int);
        int mouseedge_dest = va_arg(va, int);
        char **hint        = va_arg(va, char **);
        ret = on_user_hint(g, mousenode, mouseedge_src, mouseedge_dest, hint);
      }
      else
      {
        ret = 0;
      }
      break;
    //
    case grcode_changed_current:
      if ( cb_flags & GR_HAVE_CHANGED_CURRENT )
      {
        graph_viewer_t *gv = va_arg(va, graph_viewer_t *);
        int cur_node = va_arg(va, int);
        ret = on_changed_current(gv, cur_node);
      }
      else
        ret = 0; // allow selection change
      break;
    //
    default:
      ret = 0;
      break;
    }
    //grcode_changed_graph,       // new graph has been set
    //grcode_creating_group,      // a group is being created
    //grcode_deleting_group,      // a group is being deleted
    //grcode_group_visibility,    // a group is being collapsed/uncollapsed
    //grcode_user_size,           // calculate node size for user-defined graph
    //grcode_user_title,          // render node title of a user-defined graph
    //grcode_user_draw,           // render node of a user-defined graph
    return ret;
  }

  void unbind()
  {
    if ( self == NULL )
      return;

    // Unbind this object from the python object
    PyObject *py_cobj = PyCObject_FromVoidPtr(NULL, NULL);
    PyObject_SetAttrString(self, S_M_THIS, py_cobj);
    Py_DECREF(py_cobj);
    Py_XDECREF(self);
    self = NULL;
  }

  void show()
  {
    open_tform(form, FORM_MDI|FORM_TAB|FORM_MENU);
  }

  static py_graph_t *extract_this(PyObject *self)
  {
    // Try to extract "this" from the python object
    PyObject *py_this = PyW_TryGetAttrString(self, S_M_THIS);
    if ( py_this == NULL || !PyCObject_Check(py_this) )
    {
      Py_XDECREF(py_this);
      return NULL;
    }
    py_graph_t *ret = (py_graph_t *) PyCObject_AsVoidPtr(py_this);
    Py_DECREF(py_this);
    return ret;
  }

  void jump_to_node(int nid)
  {
    viewer_center_on(gv, nid);
    int x, y;

    // will return a place only when a node was previously selected
    place_t *old_pl = get_custom_viewer_place(gv, false, &x, &y);
    if ( old_pl != NULL )
    {
      user_graph_place_t *new_pl = (user_graph_place_t *) old_pl->clone();
      new_pl->node = nid;
      jumpto(gv, new_pl, x, y);
      delete new_pl;
    }
  }

  void refresh()
  {
    refresh_needed = true;
    refresh_viewer(gv);
  }

  int create(PyObject *self, const char *title)
  {
    // check what callbacks we have
    static const struct
    {
      const char *name;
      int have;
    } callbacks[] =
    {
      {S_ON_REFRESH,       0}, // 0 = mandatory callback
      {S_ON_GETTEXT,       0},
      {S_M_EDGES,         -1}, // -1 = mandatory attributes
      {S_M_NODES,         -1},
      {S_ON_HINT,          GR_HAVE_USER_HINT},
      {S_ON_CLICK,         GR_HAVE_CLICKED},
      {S_ON_DBL_CLICK,     GR_HAVE_DBL_CLICKED},
      {S_ON_CLOSE,         GR_HAVE_CLOSE},
      {S_ON_COMMAND,       GR_HAVE_COMMAND},
      {S_ON_SELECT,        GR_HAVE_CHANGED_CURRENT},
      {S_ON_ACTIVATE,      GR_HAVE_GOTFOCUS},
      {S_ON_DEACTIVATE,    GR_HAVE_LOSTFOCUS}
    };
    cb_flags = 0;
    for ( int i=0; i<qnumber(callbacks); i++ )
    {
      PyObject *attr = PyW_TryGetAttrString(self, callbacks[i].name);
      int have = callbacks[i].have;
      // Mandatory fields not present?
      if ( (attr == NULL && have <= 0 )
        // Mandatory callback fields present but not callable?
        || (attr != NULL && have >= 0 && PyCallable_Check(attr) == 0))
      {
        Py_XDECREF(attr);
        return -1;
      }
      if ( have > 0 && attr != NULL )
        cb_flags |= have;
      Py_XDECREF(attr);
    }


    // Keep a reference
    this->self = self;
    Py_INCREF(self);

    // Bind py_graph_t to python object
    PyObject *py_cobj = PyCObject_FromVoidPtr(this, NULL);
    PyObject_SetAttrString(self, S_M_THIS, py_cobj);
    Py_DECREF(py_cobj);

    // Create form
    HWND hwnd = NULL;
    form = create_tform(title, &hwnd);

    // Link "form" and "py_graph"
    tform_pyg.add(form, this);

    if ( hwnd != NULL )
    {
      // get a unique graph id
      netnode id;
      char grnode[MAXSTR];
      qsnprintf(grnode, sizeof(grnode), "$ pygraph %s", title);
      id.create(grnode);
      gv = create_graph_viewer(form, id, s_callback, this, 0);
      open_tform(form, FORM_MDI | FORM_TAB | FORM_MENU);
      if ( gv != NULL )
        viewer_fit_window(gv);
    }
    else
    {
      show();
    }

    viewer_fit_window(gv);
    return 0;
  }

  Py_ssize_t add_command(const char *title, const char *hotkey)
  {
    if ( (cb_flags & GR_HAVE_COMMAND) == 0 || gv == NULL)
      return 0;
    Py_ssize_t cmd_id = cmdid_pyg.id();
    bool ok = viewer_add_menu_item(gv, title, s_menucb, (void *)cmd_id, hotkey, 0);
    if ( !ok )
      return 0;
    cmdid_pyg.add(this);
    return cmd_id;
  }

  public:
    py_graph_t()
    {
      form = NULL;
      gv = NULL;
      refresh_needed = true;
      self = NULL;
    }

    static void SelectNode(PyObject *self, int /*nid*/)
    {
      py_graph_t *_this = extract_this(self);
      if ( _this == NULL || _this->form == NULL )
        return;

      _this->jump_to_node(0);
    }

    static Py_ssize_t AddCommand(PyObject *self, const char *title, const char *hotkey)
    {
      py_graph_t *_this = extract_this(self);
      if ( _this == NULL || _this->form == NULL )
        return 0;

      return _this->add_command(title, hotkey);
    }

    static void Close(PyObject *self)
    {
      py_graph_t *_this = extract_this(self);
      if ( _this == NULL || _this->form == NULL )
        return;

      close_tform(_this->form, FORM_CLOSE_LATER);
    }

    static void Refresh(PyObject *self)
    {
      py_graph_t *_this = extract_this(self);
      if ( _this == NULL )
        return;

      _this->refresh();
    }

    static py_graph_t *Show(PyObject *self)
    {
      py_graph_t *ret = extract_this(self);

      // New instance?
      if ( ret == NULL )
      {
        qstring title;
        if ( !PyW_GetStringAttr(self, S_M_TITLE, &title) )
          return NULL;

        // Form already created? try to get associated py_graph instance
        // so that we reuse it
        ret = tform_pyg.get(find_tform(title.c_str()));

        // Instance not found? create a new one
        if ( ret == NULL )
          ret = new py_graph_t();
        else
        {
          // unbind so we are rebound
          ret->unbind();
          ret->refresh_needed = true;
        }
        if ( ret->create(self, title.c_str()) < 0 )
        {
          delete ret;
          ret = NULL;
        }
      }
      else
      {
        ret->show();
      }
      return ret;
    }
};

py_graph_t::tform_pygraph_map_t py_graph_t::tform_pyg;
py_graph_t::cmdid_map_t         py_graph_t::cmdid_pyg;

bool pyg_show(PyObject *self)
{
  return py_graph_t::Show(self) != NULL;
}

void pyg_refresh(PyObject *self)
{
  py_graph_t::Refresh(self);
}

void pyg_close(PyObject *self)
{
  py_graph_t::Close(self);
}

PyObject *pyg_add_command(PyObject *self, const char *title, const char *hotkey)
{
  return Py_BuildValue("n", py_graph_t::AddCommand(self, title, hotkey));
}

void pyg_select_node(PyObject *self, int nid)
{
  py_graph_t::SelectNode(self, nid);
}
//</code(py_graph)>

//--------------------------------------------------------------------------

//<inline(py_graph)>
void pyg_refresh(PyObject *self);
void pyg_close(PyObject *self);

PyObject *pyg_add_command(PyObject *self, const char *title, const char *hotkey);
void pyg_select_node(PyObject *self, int nid);
bool pyg_show(PyObject *self);
//</inline(py_graph)>
#endif