scummvm/gui/saveload.h
Colin Snover d087c9605f BASE: Remove bad casts between incompatible Plugin types
Previously, a C-style cast was used to convert a
Common::Array<Plugin *>, populated with pointers to StaticPlugin
and DynamicPlugin instances, to a
Common::Array<PluginSubclass<T> *>, but PluginSubclass<T> is a
*sibling* class to StaticPlugin/DynamicPlugin, so this cast was
invalid and the results undefined. The methods for retrieving
subclasses of plugins can't be easily changed to just generate an
array of temporary wrapper objects that expose an identical API
which dereferences to the preferred PluginObject subclass because
pointers to these objects are retained by other parts of ScummVM,
so the wrappers would needed to be persisted or they would need to
just re-expose the underlying Plugin object again. This indicated
that a way to solve this problem is to have the callers receive
Plugin objects and get the PluginObject from the Plugin by
explicitly stating their desired type, in a similar manner to
std::get(std::variant), so that the pattern used by this patch to
solve the problem.

Closes gh-1051.
2017-12-03 20:26:38 -06:00

77 lines
2.3 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef GUI_SAVELOAD_H
#define GUI_SAVELOAD_H
#include "common/str.h"
#include "engines/metaengine.h"
namespace GUI {
class SaveLoadChooserDialog;
class SaveLoadChooser {
typedef Common::String String;
protected:
SaveLoadChooserDialog *_impl;
const String _title;
const String _buttonLabel;
const bool _saveMode;
void selectChooser(const MetaEngine &engine);
public:
SaveLoadChooser(const String &title, const String &buttonLabel, bool saveMode);
~SaveLoadChooser();
/**
* Runs the save/load chooser with the currently active config manager
* domain as target.
*
* @return The selcted save slot. -1 in case none is selected.
*/
int runModalWithCurrentTarget();
int runModalWithPluginAndTarget(const Plugin *plugin, const String &target);
const Common::String &getResultString() const;
/**
* Creates a default save description for the specified slot. Depending
* on the ScummVM configuration this might be a simple "Slot #" description
* or the current date and time.
*
* TODO: This might not be the best place to put this, since engines not
* using this class might want to mimic the same behavior. Check whether
* moving this to a better place makes sense and find what this place would
* be.
*
* @param slot The slot number (must be >= 0).
* @return The slot description.
*/
Common::String createDefaultSaveDescription(const int slot) const;
};
} // End of namespace GUI
#endif