bagel.h

/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef BAGEL_BAGLIB_BAGEL_H
#define BAGEL_BAGLIB_BAGEL_H

#include "bagel/boflib/app.h"
#include "bagel/boflib/gui/window.h"
#include "bagel/boflib/options.h"
#include "bagel/boflib/error.h"
#include "bagel/boflib/list.h"
#include "bagel/boflib/string.h"
#include "bagel/boflib/vhash_table.h"

namespace Bagel {

// Set a default hash table size here.
// Note: Best performance is achieved if this value is a prime number!
//
#define HASH_TABLE_SIZE 131
#define MAX_APP_NAME 128
#define PATH_DELIMETER "/"
#define DISK_1 1

#define BAG_INSTALL_DEFAULT 0 /* play entire game from where it was executed */

#define HOMEDIR_TOKEN "$SBARDIR" /* Change this to $HOMEDIR  */
// THE CURRENT STORAGE DEVICE OF THE GAME
#define CURRSDEV_TOKEN "$CURRENT_SDEV"
#define PREVSDEV_TOKEN "$PREVIOUS_SDEV"

// Defines default chroma color to be palette index 1
#define DEFAULT_CHROMA_COLOR 1

extern void fixPathName(CBofString &s);

class CBagMasterWin;

struct BagelReg {
    const char *_gameName;      // Game Name. Ex: "The Space Bar"
    const char *_gamePath;      // Relative path for the CD: "\\SPACEBAR"
    const char *_optionFile;    // This game's INI file name
    const char *_saveGameFile;  // Name of save game Index file.
    uint32 _ramRequired;        // Amount of free RAM needed to play game
    int32 _numberOfCDs;         // # of CDs used by this game
    int _requiredDepth;         // Required bits per pixel to play game
    int _requiredWidth;         // Minimum screen width for game
    int _requiredHeight;        // Minimum screen height for game
};

class CBagel : public CBofOptions, public CBofApp {
public:
    CBagel(const BagelReg *gameReg);
    ~CBagel();

    void registerGame(const BagelReg *gameReg);

    // these functions must be provided by the child class
    //
    ErrorCode initialize() override;

    ErrorCode runApp() override;

    ErrorCode shutdown() override;

    ErrorCode setOption(const char *section, const char *option, const char *stringValue);

    ErrorCode setOption(const char *section, const char *option, int intValue);

    ErrorCode getOption(const char *section, const char *option, char *stringValue, const char *defaultValue, uint32 size);

    ErrorCode getOption(const char *section, const char *option, int *intValue, int defaultValue);

    ErrorCode getOption(const char *section, const char *option, bool *boolValue, int defaultValue);

    void setAppName(const char *newAppName) override {
        Common::strcpy_s(_szAppName, newAppName);
    }

    CBagMasterWin *getMasterWnd() const {
        return (CBagMasterWin *)_pMainWnd;
    }

    static CBagel *getBagApp() {
        return (CBagel *)_pBofApp;
    }

    int getChromaColor() {
        return DEFAULT_CHROMA_COLOR;
    }

    ErrorCode verifyCDInDrive(int diskId, const char *waveFile);

    static void showNextCDDialog(CBofWindow *parentWin, int diskId);

    static CBofVHashTable<CBofString, HASH_TABLE_SIZE> *getCacheFileList() {
        return _cacheFileList;
    }

protected:
    ErrorCode initLocalFilePaths();

    // Data members
    const BagelReg *_gameReg = nullptr;

    int _numRetries = 20;
    int _installCode = 0;

private:
    static CBofVHashTable<CBofString, HASH_TABLE_SIZE> *_cacheFileList;
};

} // namespace Bagel

#endif