mirror of
https://github.com/LMMS/lmms.git
synced 2026-01-29 08:43:18 -05:00
1dab416c6c
* First commit This commit starts the improvements on the upgrade methods. We are going to change both the DataFile and ConfigManager to use separate version values from LMMS release versions, so we can easily bump those versions for new upgrade routines. This first commit starts implementing a new version value for the ConfigManager. * Change code as per requested on review As requested, the "configVersion" method was replaced by "legacyConfigVersion" instead, which is only used to return a configuration version if none is present in the configuration file. The configuration version of the current build is stored in a local variable called CONFIG_VERSION, making version bumping easier. Uses a switch statement instead of if-else to be able to make use of case-cascading. TODO: - Change the CONFIG_VERSION variable to a unsigned int? - Start working on the DataFile.cpp. * Changes the upgrade logic on DataFile.cpp Starts refactoring the upgrade logic on DataFile.cpp. Now the "version" attribute is used to indicate which fileVersion we are loading. If the value of version is "1.0", we have a legacy file and use the legacyFileVersion method to retrieve the integer version using the LMMS version. If the value of version is an integer, we just read it. The integer indicates the position in a list of upgrade methods where we should start from and run the upgrade methods. The file version of the build is held in the FILE_VERSION const on DataFile.h. It HAS TO match the number of upgrade methods that we have on our list. One of the versions had 2 upgrade routines (upgrade_1_2_0_rc3 and upgrade_1_2_0_rc2_42). They were merged into a single one (upgrade_1_2_0_rc3) because they were both called from a single version check, meaning that they are both part of a single fileVersion. Two fatal errors were added (which can later be improved to show an error messagebox): One if the version attribute doesn't exist, and another one if we are using a FILE_VERSION that doesn't match the number of upgrade methods (to avoid mistakes while coding new upgrades later). The configVersion variables and methods were changed to use unsigned int instead of int. TODO: - Make the list of upgrade methods static. - Add debug messages for each upgrade routine for testing purposes. * Make method vector a static const variable On DataFile.cpp, we now use the vector list of upgrade methods as a static const variable, so it only has to be constructed once. * Reorganize vector lists Reorganize vector lists so they are more easily readable. Revert changes on upgrade method names from ConfigManager.cpp. * Makes the file version bumping automatic The file version bumping on DataFile.cpp is now automatic (using the size of the m_upgradeMethods vector as a reference). FILE_VERSION constant was removed, and with it the qFatal error when it doesn't match the size of the methods vector. * Improve formatting of version and upgrades lists Improves the formatting of the vector lists of upgrade routines and LMMS versions (2 upgrade routines per line and 3 LMMS versions per line). Adds a qWarning for every upgrade routine for testing purposes, plus a qWarning that tells the current fileVersion/configVersion when upgrade is called. Removes extra space characters after the opening bracket of ConfigManager::upgrade_1_1_91. * Changes ConfigManager to use a vector of methods Changes ConfigManager to use a vector of upgrade methods, just like DataFile. The new Config Version can be calculated automatically now, so the CONFIG_VERSION constant was removed. Corrects a small comment on Datafile.h. * Addresses Dom's review requests - Changes legacyConfigVersion and legacyFileVersion from const unsigned int to just unsigned int, since the const is irrelevant in this context. - Changes the type alias for upgrade methods to start with an uppercase as per the code style guidelines. Moves the aliasing of the type to the class declaration so it can be used on both the method and on the vector list declaration. - Changes the vector list names from m_upgradeMethods to UPGRADE_METHODS, so it's more visible they are a static constant. - Move the upgradeVersions list from the legacyFileVersion method to the DataFile class, as an static const called UPGRADE_VERSIONS. - Uses std::upper_bound instead of std::find_if for the legacyFileVersion method. * Uses type alias on vector assignment Uses the UpgradeMethod type alias when defining the upgrade methods vector from both ConfigManager and DataFile. * Removes debugging warnings Removes the qWarning() calls that were placed for debugging purposes.
145 lines
3.1 KiB
C++
145 lines
3.1 KiB
C++
/*
|
|
* DataFile.h - class for reading and writing LMMS data files
|
|
*
|
|
* Copyright (c) 2004-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
|
|
* Copyright (c) 2012-2013 Paul Giblock <p/at/pgiblock.net>
|
|
*
|
|
* This file is part of LMMS - https://lmms.io
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This program 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
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public
|
|
* License along with this program (see COPYING); if not, write to the
|
|
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301 USA.
|
|
*
|
|
*/
|
|
|
|
|
|
#ifndef DATA_FILE_H
|
|
#define DATA_FILE_H
|
|
|
|
#include <QDomDocument>
|
|
|
|
#include "lmms_export.h"
|
|
#include "MemoryManager.h"
|
|
#include "ProjectVersion.h"
|
|
|
|
class QTextStream;
|
|
|
|
class LMMS_EXPORT DataFile : public QDomDocument
|
|
{
|
|
MM_OPERATORS
|
|
|
|
using UpgradeMethod = void(DataFile::*)();
|
|
|
|
public:
|
|
enum Types
|
|
{
|
|
UnknownType,
|
|
SongProject,
|
|
SongProjectTemplate,
|
|
InstrumentTrackSettings,
|
|
DragNDropData,
|
|
ClipboardData,
|
|
JournalData,
|
|
EffectSettings,
|
|
TypeCount
|
|
} ;
|
|
typedef Types Type;
|
|
|
|
DataFile( const QString& fileName );
|
|
DataFile( const QByteArray& data );
|
|
DataFile( Type type );
|
|
|
|
virtual ~DataFile();
|
|
|
|
///
|
|
/// \brief validate
|
|
/// performs basic validation, compared to file extension.
|
|
///
|
|
bool validate( QString extension );
|
|
|
|
QString nameWithExtension( const QString& fn ) const;
|
|
|
|
void write( QTextStream& strm );
|
|
bool writeFile( const QString& fn );
|
|
|
|
QDomElement& content()
|
|
{
|
|
return m_content;
|
|
}
|
|
|
|
QDomElement& head()
|
|
{
|
|
return m_head;
|
|
}
|
|
|
|
Type type() const
|
|
{
|
|
return m_type;
|
|
}
|
|
|
|
unsigned int legacyFileVersion();
|
|
|
|
private:
|
|
static Type type( const QString& typeName );
|
|
static QString typeName( Type type );
|
|
|
|
void cleanMetaNodes( QDomElement de );
|
|
|
|
// helper upgrade routines
|
|
void upgrade_0_2_1_20070501();
|
|
void upgrade_0_2_1_20070508();
|
|
void upgrade_0_3_0_rc2();
|
|
void upgrade_0_3_0();
|
|
void upgrade_0_4_0_20080104();
|
|
void upgrade_0_4_0_20080118();
|
|
void upgrade_0_4_0_20080129();
|
|
void upgrade_0_4_0_20080409();
|
|
void upgrade_0_4_0_20080607();
|
|
void upgrade_0_4_0_20080622();
|
|
void upgrade_0_4_0_beta1();
|
|
void upgrade_0_4_0_rc2();
|
|
void upgrade_1_0_99();
|
|
void upgrade_1_1_0();
|
|
void upgrade_1_1_91();
|
|
void upgrade_1_2_0_rc3();
|
|
void upgrade_1_3_0();
|
|
|
|
// List of all upgrade methods
|
|
static const std::vector<UpgradeMethod> UPGRADE_METHODS;
|
|
// List of ProjectVersions for the legacyFileVersion method
|
|
static const std::vector<ProjectVersion> UPGRADE_VERSIONS;
|
|
|
|
void upgrade();
|
|
|
|
void loadData( const QByteArray & _data, const QString & _sourceFile );
|
|
|
|
|
|
struct LMMS_EXPORT typeDescStruct
|
|
{
|
|
Type m_type;
|
|
QString m_name;
|
|
} ;
|
|
static typeDescStruct s_types[TypeCount];
|
|
|
|
QDomElement m_content;
|
|
QDomElement m_head;
|
|
Type m_type;
|
|
unsigned int m_fileVersion;
|
|
|
|
} ;
|
|
|
|
|
|
#endif
|
|
|