mystery.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 EEM_MYSTERY_H
#define EEM_MYSTERY_H

#include "common/array.h"
#include "common/path.h"
#include "common/scummsys.h"
#include "common/serializer.h"
#include "common/str.h"

namespace EEM {

class Mystery {
public:
    static const uint kNumChains       = 3;
    static const uint kChainLen        = 5;
    static const uint kCluesFoundCap   = 100;
    static const uint kHotSpotsCap     = 100;
    static const uint kGalleryCap      = 5;
    static const uint kVisitedSiteCap  = 20;

    Mystery() = default;
    ~Mystery() = default;

    bool load(uint num, class Common::RandomSource *rng = nullptr,
              bool macintosh = false);

    void clear();

    bool isLoaded() const { return !_data.empty(); }
    bool usesCompactMacData() const {
        return _isMacintosh && !_isMacintoshLooseScripts;
    }

    uint number() const { return _number; }
    uint16 numSites() const { return _numSites; }
    uint8  numSuspects() const { return _numSuspects; }
    uint8  numCONSITEs() const { return _numCONSITEs; }
    uint8  numCOFFSITEs() const { return _numCOFFSITEs; }

    const byte *initBlock() const;

    const byte *galleryData() const;

    const byte *floppySuspectEntry(uint suspectIdx) const;

    const byte *noteIndex() const;

    uint16 noteIndexCount() const;

    uint noteSectionSize() const;

    bool noteHasNotebookText(uint clueId) const;

    const byte *kdTextIndex() const;

    const byte *hintBlock() const;

    uint16 aChain(uint i) const {
        return i < kChainLen ? _aChain[i] : 0xFFFF;
    }

    uint16 hintChain(uint chainIdx, uint slot) const {
        if (slot >= kChainLen)
            return 0xFFFF;
        switch (chainIdx) {
        case 0: return _aChain[slot];
        case 1: return _bChain[slot];
        case 2: return _cChain[slot];
        default: return 0xFFFF;
        }
    }

    const byte *mapEntry(uint siteNum) const;

    const byte *siteIndexEntry(uint siteNum) const;

    const byte *siteData(uint siteNum) const;

    const byte *floppySiteAnimData(uint siteNum) const;

    const byte *hotspots(uint siteNum) const;

    uint16 hotspotCount(uint siteNum) const;

    const char *textAt(uint16 offset) const;

    const byte *blobAt(uint32 offset) const {
        return offset < _data.size() ? _data.data() + offset : nullptr;
    }

    uint32 dataSize() const { return (uint32)_data.size(); }

    void syncState(Common::Serializer &s);

    int selectedPoints() const;

    int foundPoints() const;

    bool solvedCheck() const { return selectedPoints() > 99; }

    bool londonSolved() const;

    int minCluesRemaining() const;

    bool isGuilty(uint suspectIdx) const;

    uint16 alibiTextOffset(uint suspectIdx) const;

    const byte *solvedClueBlock() const;

    uint8  _cluesFound[kCluesFoundCap]   = {};
    uint8  _noteSelected[kCluesFoundCap] = {};
    uint16 _hotSpotsSeen[kHotSpotsCap]   = {};
    uint16 _inGallery[kGalleryCap]       = {};
    uint8  _newOrder[kGalleryCap]        = {};
    uint16 _visitedSite[kVisitedSiteCap] = {};
    uint16 _onSites[kVisitedSiteCap]     = {};
    bool   _sawCOFFSITEs = false;
    bool   _sawCONSITEs  = false;
    uint8  _seenCOFFSITEs = 0;
    uint8  _seenCONSITEs  = 0;
    bool   _sawHelpHint  = false;
    bool   _solvedPuzzle = false;
    bool   _firstTry     = true;
    uint16 _searchLocationNumber = 0xFFFF;
    uint16 _siteNumber           = 0xFFFF;
    uint16 _lastSite             = 0xFFFF;
    uint16 _pendingSiteJump      = 0;
    uint16 _siteReturnDepth      = 0;
    uint16 _siteReturnStack[kVisitedSiteCap] = {};

private:
    Common::Array<byte> _data;
    uint   _number = 0;

    uint16 _initOffset      = 0;
    uint16 _mapOffset       = 0;
    uint16 _siteIndexOffset = 0;
    uint16 _textOffset      = 0;
    uint16 _noteOffset      = 0;
    uint16 _galleryOffset   = 0;
    uint16 _kdTextOffset    = 0;
    uint16 _solvedOffset    = 0;
    uint16 _hintOffset      = 0;

    uint16 _numSites    = 0;
    uint8  _numSuspects = 0;
    uint8  _numCONSITEs = 0;
    uint8  _numCOFFSITEs = 0;

    uint16 _aChain[kChainLen] = {};
    uint16 _bChain[kChainLen] = {};
    uint16 _cChain[kChainLen] = {};

    bool   _isFloppy = false;
    bool   _isMacintosh = false;
    bool   _isMacintoshLooseScripts = false;
    uint16 _floppySuspectsOff = 0;   
    uint16 _floppyHintBlockOff = 0;  
    uint16 _floppyNoteIndexOff = 0;  
    uint16 _floppyGalleryOff = 0;    
    uint16 _floppyTextOff = 0;       
    uint16 _floppyKDTextOff = 0;     
    uint16 _floppySolvedOff = 0;     
    Common::Array<byte> _floppySiteAnimData;
    uint16 _floppySiteAnimSiteOff[kVisitedSiteCap] = {};

    uint16 readU16(uint offset) const;
    void loadFloppySiteAnimData();
};

} // End of namespace EEM

#endif