mirror of
https://bitbucket.org/smil3y/kde-extraapps.git
synced 2025-02-26 11:52:54 +00:00
79 lines
2.7 KiB
C++
79 lines
2.7 KiB
C++
/* This file is part of KDevelop
|
|
Copyright 2010 Aleix Pol Gonzalez <aleixpol@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 version 2 as published by the Free Software Foundation.
|
|
|
|
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, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef KDEVPLATFORM_DATAACCESS_H
|
|
#define KDEVPLATFORM_DATAACCESS_H
|
|
|
|
#include <language/languageexport.h>
|
|
#include <language/editor/rangeinrevision.h>
|
|
|
|
namespace KDevelop
|
|
{
|
|
class Declaration;
|
|
|
|
/**
|
|
* @brief Represents a data access in some code
|
|
*
|
|
* This class provides the position of a data access in the code
|
|
* and tells us whether it's writing or reading the data.
|
|
*/
|
|
class KDEVPLATFORMLANGUAGE_EXPORT DataAccess
|
|
{
|
|
public:
|
|
/** Defines the flags that will tell what this data access is about */
|
|
enum DataAccessFlag {
|
|
None = 0,
|
|
Read = 1, /**< This data access reads data */
|
|
Write = 2,/**< This data access writes data */
|
|
Call = 4 /**< This call is modifying some outsider data*/
|
|
};
|
|
Q_DECLARE_FLAGS(DataAccessFlags, DataAccessFlag)
|
|
|
|
/** Constructs a DataAccess instance with its @p cur position and
|
|
* its @p flags DataAccessFlags that will tell us how is it modifying the data.
|
|
* In case it's a Write, a @p range can be provided
|
|
*/
|
|
DataAccess(const CursorInRevision& cur, DataAccessFlags flags, const KDevelop::RangeInRevision& range);
|
|
|
|
/** Checks the flags and returns if it's reading the data */
|
|
bool isRead() const;
|
|
|
|
/** Checks the flags and returns if it's writing the data */
|
|
bool isWrite() const;
|
|
|
|
/** Checks the flags and returns if it's just some call */
|
|
bool isCall() const;
|
|
|
|
/** @returns the cursor */
|
|
KDevelop::CursorInRevision pos() const;
|
|
|
|
/** @returns the flags that specify how is this access interacting with the data */
|
|
DataAccessFlags flags() const;
|
|
|
|
/** @returns the range that contains the written value in case it's a Write access */
|
|
KDevelop::RangeInRevision value() const;
|
|
|
|
private:
|
|
DataAccessFlags m_flags;
|
|
KDevelop::CursorInRevision m_pos;
|
|
KDevelop::RangeInRevision m_value;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|