File indexing completed on 2024-05-12 05:46:43

 /* This file is part of the KDE project
    Copyright (C) 2002 Matthias Hoelzer-Kluepfel <hoelzer@kde.org>
    Copyright (C) 2002 John Firebaugh <jfirebaugh@kde.org>
    Copyright (C) 2007 Hamish Rodda <rodda@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.
    If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef KDEVPLATFORM_BREAKPOINT_H
 #define KDEVPLATFORM_BREAKPOINT_H
 
 #include <QSet>
 #include <QUrl>
 
 #include <debugger/debuggerexport.h>
 
 class QVariant;
 class KConfigGroup;
 namespace KTextEditor {
 class MovingCursor;
 }
 namespace KDevelop
 {
 class BreakpointModel;
 
 class KDEVPLATFORMDEBUGGER_EXPORT Breakpoint
 {
 public:
     enum BreakpointKind {
         CodeBreakpoint = 0,
         WriteBreakpoint,
         ReadBreakpoint,
         AccessBreakpoint,
         LastBreakpointKind
     };
     enum BreakpointState {
         NotStartedState,
         DirtyState,
         PendingState,
         CleanState
     };
     ///Custom roles for retrieving data from breakpoint model.
     enum BreakpointRole{
         LocationRole = Qt::UserRole + 1 ///< Retrieves breakpoint's full path unlike Qt::DisplayRole. Note: it's only appliable to LocationColumn.
     };
 
     Breakpoint(BreakpointModel *model, BreakpointKind kind);
     Breakpoint(BreakpointModel *model, const KConfigGroup& config);
 
     bool setData(int index, const QVariant& value);
     void setDeleted();
 
     ///Note: to retrieve the full path use LocationRole, Qt::DisplayRole return only a file's name
     QVariant data(int column, int role) const;
 
     void save(KConfigGroup& config);
 
     // Moved to BreakpointModel; temporarily left here to ease API transition
     enum Column {
         EnableColumn,
         StateColumn,
         TypeColumn,
         LocationColumn,
         ConditionColumn,
         HitCountColumn,
         IgnoreHitsColumn
     };
 
     void setUrl(const QUrl &url);
     QUrl url() const;
     
     void setLine(int line);
     int line() const;
     
     void setLocation(const QUrl& url, int line);
     QString location();
 
     BreakpointKind kind() const;
 
     void setAddress(const QString& address);
     QString address() const;
 
     int hitCount() const;
 
     bool deleted() const;
     
     bool enabled() const;
     
     void setMovingCursor(KTextEditor::MovingCursor *cursor);
     KTextEditor::MovingCursor *movingCursor() const;
 
     void setIgnoreHits(int c);
     int ignoreHits() const;
 
     void setCondition(const QString &c);
     QString condition() const;
 
     void setExpression(const QString &c);
     QString expression() const;
 
     BreakpointState state() const;
     QString errorText() const;
 
 protected:
     friend class BreakpointModel;
     friend class IBreakpointController;
     
     /**
      * Return the model this breakpoint is attached to
      *
      * @note This might be null, e.g. after the breakpoint has been marked as deleted
      */
     BreakpointModel *breakpointModel();
 
     BreakpointModel *m_model;
     bool m_enabled;
     bool m_deleted;
     BreakpointState m_state;
     BreakpointKind m_kind;
     /* For watchpoints, the address it is set at.  */
     QString m_address;
     QUrl m_url;
     int m_line;
     QString m_condition;
     KTextEditor::MovingCursor *m_movingCursor;
     int m_hitCount;
     int m_ignoreHits;
     QString m_expression;
     QString m_errorText;
 
     void reportChange(Column c);
 };
 
 }
 #endif