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