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 private:
  66     void updateValueText();
  67     QString m_baseValue;        //!< The "normal value" that the driver reported
  68     QString m_structValue;      //!< The "quick member" value
  69     bool m_baseChanged : 1;
  70     bool m_structChanged : 1;
  71 };
  72
  73 /**
  74  * Represents the value tree that is parsed by the debugger drivers.
  75  */
  76 struct ExprValue
  77 {
  78     QString m_name;
  79     QString m_value;
  80     VarTree::VarKind m_varKind;
  81     VarTree::NameKind m_nameKind;
  82     ExprValue* m_child;                 /* the first child expression */
  83     ExprValue* m_next;                  /* the next sibling expression */
  84     bool m_initiallyExpanded;
  85
  86     ExprValue(const QString& name, VarTree::NameKind kind);
  87     ~ExprValue();
  88
  89     void appendChild(ExprValue* newChild);
  90     int childCount() const;
  91 };
  92
  93
  94 class ValueEdit : public QLineEdit
  95 {
  96     Q_OBJECT
  97 public:
  98     ValueEdit(ExprWnd* parent);
  99     ~ValueEdit();
 100
 101     void terminate(bool commit);
 102     VarTree* m_item;
 103     bool m_finished;
 104 protected:
 105     void keyPressEvent(QKeyEvent *e);
 106     void focusOutEvent(QFocusEvent* ev);
 107     void paintEvent(QPaintEvent* e);
 108 public slots:
 109     void slotSelectionChanged();
 110 signals:
 111     void done(VarTree*, const QString&);
 112 };
 113
 114
 115 class ExprWnd : public QTreeWidget
 116 {
 117     Q_OBJECT
 118 public:
 119     ExprWnd(QWidget* parent, const QString& colHeader);
 120     ~ExprWnd();
 121
 122     /** returns the list with the expressions at the topmost level */
 123     QStringList exprList() const;
 124     /** appends a copy of expr to the end of the tree at the topmost level;
 125      * returns a pointer to the inserted top-level item */
 126     VarTree* insertExpr(ExprValue* expr, ProgramTypeTable& typeTable);
 127     /** updates an existing expression */
 128     void updateExpr(ExprValue* expr, ProgramTypeTable& typeTable);
 129     void updateExpr(VarTree* display, ExprValue* newValues, ProgramTypeTable& typeTable);
 130     /** updates the value and repaints it for a single item (not the children) */
 131     void updateSingleExpr(VarTree* display, ExprValue* newValues);
 132     /** updates only the value of the node */
 133     void updateStructValue(VarTree* display);
 134     /** get a top-level expression by name */
 135     VarTree* topLevelExprByName(const QString& name) const;
 136     /** return a member of the struct that pointer \a v refers to */
 137     static VarTree* ptrMemberByName(VarTree* v, const QString& name);
 138     /** return a member of the struct \a v */
 139     static VarTree* memberByName(VarTree* v, const QString& name);
 140     /** removes an expression; must be on the topmost level*/
 141     void removeExpr(VarTree* item);
 142     /** clears the list of pointers needing updates */
 143     void clearPendingUpdates();
 144     /** returns a pointer to update (or 0) and removes it from the list */
 145     VarTree* nextUpdatePtr();
 146     VarTree* nextUpdateType();
 147     VarTree* nextUpdateStruct();
 148     void editValue(VarTree* item, const QString& text);
 149     /** tells whether the a value is currently edited */
 150     bool isEditing() const;
 151
 152     VarTree* selectedItem() const { return static_cast<VarTree*>(QTreeWidget::currentItem()); }
 153     VarTree* topLevelItem(int i) const { return static_cast<VarTree*>(QTreeWidget::topLevelItem(i)); }
 154
 155 protected:
 156     void updateExprRec(VarTree* display, ExprValue* newValues, ProgramTypeTable& typeTable);
 157     void replaceChildren(VarTree* display, ExprValue* newValues);
 158     void collectUnknownTypes(VarTree* item);
 159     void checkUnknownType(VarTree* item);
 160     static QString formatWCharPointer(QString value);
 161     QPixmap m_pixPointer;
 162
 163     std::list<VarTree*> m_updatePtrs;   //!< dereferenced pointers that need update
 164     std::list<VarTree*> m_updateType;   //!< structs whose type must be determined
 165     std::list<VarTree*> m_updateStruct; //!< structs whose nested value needs update
 166
 167     ValueEdit* m_edit;
 168
 169     /** remove items that are in the subTree from the list */
 170     void unhookSubtree(VarTree* subTree);
 171     static void unhookSubtree(std::list<VarTree*>& list, VarTree* subTree);
 172
 173 signals:
 174     void removingItem(VarTree*);
 175     void editValueCommitted(VarTree*, const QString&);
 176 };
 177
 178 #endif // EXPRWND_H