kdbg/exprwnd.h

   1 /*
   2  * Copyright Johannes Sixt
   3  * This file is licensed under the GNU General Public License Version 2.
   4  * See the file COPYING in the toplevel directory of the source directory.
   5  */
   6
   7 #ifndef EXPRWND_H
   8 #define EXPRWND_H
   9
  10 #include <QTreeWidget>
  11 #include <QLineEdit>
  12 #include <QPixmap>
  13 #include <list>
  14
  15 class ProgramTypeTable;
  16 class TypeInfo;
  17 struct ExprValue;
  18 class ExprWnd;
  19 class QStringList;
  20
  21 /*! \brief a variable's value is the tree of sub-variables */
  22 class VarTree : public QTreeWidgetItem
  23 {
  24 public:
  25     enum VarKind { VKsimple, VKpointer, VKstruct, VKarray,
  26         VKdummy                         //!< used to update only children
  27     };
  28     VarKind m_varKind;
  29     enum NameKind { NKplain, NKstatic, NKtype,
  30         NKanonymous,                    //!< an anonymous struct or union
  31         NKaddress                       //!< a dereferenced pointer
  32     };
  33     NameKind m_nameKind;
  34     const TypeInfo* m_type;                     //!< the type of struct if it could be derived
  35     int m_exprIndex;                    //!< used in struct value update
  36     bool m_exprIndexUseGuard;           //!< ditto; if guard expr should be used
  37     QString m_partialValue;             //!< while struct value update is in progress
  38
  39     VarTree(VarTree* parent, ExprValue* v);
  40     VarTree(ExprWnd* parent, ExprValue* v);
  41     virtual ~VarTree();
  42 public:
  43     QString computeExpr() const;
  44     bool isToplevelExpr() const;
  45     /** is this element an ancestor of (or equal to) child? */
  46     bool isAncestorEq(const VarTree* child) const;
  47     /** update the regular value; returns whether a repaint is necessary */
  48     bool updateValue(const QString& newValue);
  49     /** update the "quick member" value; returns whether repaint is necessary */
  50     bool updateStructValue(const QString& newValue);
  51     /** find out the type of this value using the child values */
  52     void inferTypesOfChildren(ProgramTypeTable& typeTable);
  53     /** get the type from base class part */
  54     const TypeInfo* inferTypeFromBaseClass();
  55     /** returns whether the pointer is a wchar_t */
  56     bool isWcharT() const;
  57
  58     QString getText() const { return text(0); }
  59     using QTreeWidgetItem::setText;
  60     void setText(const QString& t) { QTreeWidgetItem::setText(0, t); }
  61     void setPixmap(const QPixmap& p) { QTreeWidgetItem::setIcon(0, QIcon(p)); }
  62     QString value() const { return m_baseValue; }
  63     VarTree* child(int i) const { return static_cast<VarTree*>(QTreeWidgetItem::child(i)); }
  64
  65     virtual QVariant data(int column, int role) const;
  66
  67 private:
  68     void updateValueText();
  69     QString m_baseValue;        //!< The "normal value" that the driver reported
  70     QString m_structValue;      //!< The "quick member" value
  71     bool m_baseChanged : 1;
  72     bool m_structChanged : 1;
  73 };
  74
  75 /**
  76  * Represents the value tree that is parsed by the debugger drivers.
  77  */
  78 struct ExprValue
  79 {
  80     QString m_name;
  81     QString m_value;
  82     VarTree::VarKind m_varKind;
  83     VarTree::NameKind m_nameKind;
  84     ExprValue* m_child;                 /* the first child expression */
  85     ExprValue* m_next;                  /* the next sibling expression */
  86     bool m_initiallyExpanded;
  87
  88     ExprValue(const QString& name, VarTree::NameKind kind);
  89     ~ExprValue();
  90
  91     const QString& value() const {
  92         return m_value;
  93     }
  94
  95     void appendChild(ExprValue* newChild);
  96     int childCount() const;
  97 };
  98
  99
 100 class ValueEdit : public QLineEdit
 101 {
 102     Q_OBJECT
 103 public:
 104     ValueEdit(ExprWnd* parent);
 105     ~ValueEdit();
 106
 107     void terminate(bool commit);
 108     VarTree* m_item;
 109     bool m_finished;
 110 protected:
 111     void keyPressEvent(QKeyEvent *e);
 112     void focusOutEvent(QFocusEvent* ev);
 113     void paintEvent(QPaintEvent* e);
 114 public slots:
 115     void slotSelectionChanged();
 116 signals:
 117     void done(VarTree*, const QString&);
 118 };
 119
 120
 121 class ExprWnd : public QTreeWidget
 122 {
 123     Q_OBJECT
 124 public:
 125     ExprWnd(QWidget* parent, const QString& colHeader);
 126     ~ExprWnd();
 127
 128     /** returns the list with the expressions at the topmost level */
 129     QStringList exprList() const;
 130     /** appends a copy of expr to the end of the tree at the topmost level;
 131      * returns a pointer to the inserted top-level item */
 132     VarTree* insertExpr(ExprValue* expr, ProgramTypeTable& typeTable);
 133     /** updates an existing expression */
 134     void updateExpr(ExprValue* expr, ProgramTypeTable& typeTable);
 135     void updateExpr(VarTree* display, ExprValue* newValues, ProgramTypeTable& typeTable);
 136     /** updates the value and repaints it for a single item (not the children) */
 137     void updateSingleExpr(VarTree* display, ExprValue* newValues);
 138     /** updates only the value of the node */
 139     void updateStructValue(VarTree* display);
 140     /** get a top-level expression by name */
 141     VarTree* topLevelExprByName(const QString& name) const;
 142     /** return a member of the struct that pointer \a v refers to */
 143     static VarTree* ptrMemberByName(VarTree* v, const QString& name);
 144     /** return a member of the struct \a v */
 145     static VarTree* memberByName(VarTree* v, const QString& name);
 146     /** removes an expression; must be on the topmost level*/
 147     void removeExpr(VarTree* item);
 148     /** clears the list of pointers needing updates */
 149     void clearPendingUpdates();
 150     /** returns a pointer to update (or 0) and removes it from the list */
 151     VarTree* nextUpdatePtr();
 152     VarTree* nextUpdateType();
 153     VarTree* nextUpdateStruct();
 154     void editValue(VarTree* item, const QString& text);
 155     /** tells whether the a value is currently edited */
 156     bool isEditing() const;
 157
 158     VarTree* selectedItem() const { return static_cast<VarTree*>(QTreeWidget::currentItem()); }
 159     VarTree* topLevelItem(int i) const { return static_cast<VarTree*>(QTreeWidget::topLevelItem(i)); }
 160
 161 protected:
 162     void updateExprRec(VarTree* display, ExprValue* newValues, ProgramTypeTable& typeTable);
 163     void replaceChildren(VarTree* display, ExprValue* newValues);
 164     void collectUnknownTypes(VarTree* item);
 165     void checkUnknownType(VarTree* item);
 166     static QString formatWCharPointer(QString value);
 167     QPixmap m_pixPointer;
 168
 169     std::list<VarTree*> m_updatePtrs;   //!< dereferenced pointers that need update
 170     std::list<VarTree*> m_updateType;   //!< structs whose type must be determined
 171     std::list<VarTree*> m_updateStruct; //!< structs whose nested value needs update
 172
 173     ValueEdit* m_edit;
 174
 175     /** remove items that are in the subTree from the list */
 176     void unhookSubtree(VarTree* subTree);
 177     static void unhookSubtree(std::list<VarTree*>& list, VarTree* subTree);
 178
 179 signals:
 180     void removingItem(VarTree*);
 181     void editValueCommitted(VarTree*, const QString&);
 182 };
 183
 184 #endif // EXPRWND_H