src/plugins/projectexplorer/userfileaccessor.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   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 PROJECTMANAGER_USERFILEACCESSOR_H
  35 #define PROJECTMANAGER_USERFILEACCESSOR_H
  36
  37 #include <QtCore/QVariantMap>
  38
  39 namespace ProjectExplorer {
  40
  41 class Project;
  42
  43 class UserFileVersionHandler
  44 {
  45 public:
  46     UserFileVersionHandler();
  47     virtual ~UserFileVersionHandler();
  48
  49     // The user file version this handler accepts for input.
  50     virtual int userFileVersion() const = 0;
  51     virtual QString displayUserFileVersion() const = 0;
  52     // Update from userFileVersion() to userFileVersion() + 1
  53     virtual QVariantMap update(Project *project, const QVariantMap &map) = 0;
  54
  55 protected:
  56     typedef QPair<QLatin1String,QLatin1String> Change;
  57     QVariantMap renameKeys(const QList<Change> &changes, QVariantMap map);
  58 };
  59
  60 class UserFileAccessor
  61 {
  62 public:
  63     UserFileAccessor();
  64     ~UserFileAccessor();
  65     QVariantMap restoreSettings(Project * project);
  66     bool saveSettings(Project * project, const QVariantMap &map);
  67
  68     int latestUserFileVersion() const;
  69
  70     QString mapIdTo(const QString &id, int version);
  71
  72 private:
  73     // Takes ownership of the handler!
  74     void addVersionHandler(UserFileVersionHandler *handler);
  75
  76     QMap<int, UserFileVersionHandler *> m_handlers;
  77     int m_firstVersion;
  78     int m_lastVersion;
  79 };
  80
  81 } // namespace ProjectExplorer
  82
  83 #endif // PROJECTMANAGER_USERFILEACCESSOR_H