src/plugins/classview/classviewsymbollocation.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2010 Denis Mingulov.
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef CLASSVIEWSYMBOLLOCATION_H
  34 #define CLASSVIEWSYMBOLLOCATION_H
  35
  36 #include <QtCore/QMetaType>
  37 #include <QtCore/QString>
  38
  39 namespace ClassView {
  40 namespace Internal {
  41
  42 /*!
  43    \class SymbolLocation
  44    \brief Special struct to store information about symbol location (to find which exactly location
  45    has to be open when the user clicks on any tree item. It might be used in QSet/QHash.
  46  */
  47 class SymbolLocation
  48 {
  49 public:
  50     //! Default constructor
  51     SymbolLocation();
  52
  53     //! Constructor
  54     explicit SymbolLocation(QString file, int lineNumber = 0, int columnNumber = 0);
  55
  56     inline const QString &fileName() const { return m_fileName; }
  57     inline int line() const { return m_line; }
  58     inline int column() const { return m_column; }
  59     inline int hash() const { return m_hash; }
  60     inline bool operator==(const SymbolLocation &other) const
  61     {
  62         return line() == other.line() && column() == other.column()
  63             && fileName() == other.fileName();
  64     }
  65
  66 private:
  67     QString m_fileName; //!< file name
  68     int m_line;         //!< line number
  69     int m_column;       //!< column
  70     int m_hash;         //!< precalculated hash value for the object, to speed up qHash
  71 };
  72
  73 //! qHash overload for QHash/QSet
  74 inline uint qHash(const SymbolLocation &location)
  75 {
  76     return location.hash();
  77 }
  78
  79 } // namespace Internal
  80 } // namespace ClassView
  81
  82 Q_DECLARE_METATYPE(ClassView::Internal::SymbolLocation)
  83
  84 #endif // CLASSVIEWSYMBOLLOCATION_H