winexe_ne.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 COMMON_WINEXE_NE_H
#define COMMON_WINEXE_NE_H
 
#include "common/formats/winexe.h"
#include "common/list.h"
#include "common/str.h"
 
namespace Common {
 
template<class T>
class Array;
class SeekableReadStream;
 
// NE executable segment
struct NESegment {
    static constexpr uint16 kFlagSingleData = 1;
    static constexpr uint16 kFlagMultipleData = 2;
    static constexpr uint16 kFlagLinkError = 0x2000u;
    static constexpr uint16 kFlagLibModule = 0x8000u;
 
    uint32 offset;
    uint32 size;
    uint16 flags;
};
 
class NEResources : public WinResources {
public:
    NEResources();
    ~NEResources();
 
    static constexpr uint32 kInvalidAddress = 0xFFFFFFFF;
 
    void clear() override;
 
    using WinResources::loadFromEXE;
 
    bool loadFromEXE(SeekableReadStream *stream, DisposeAfterUse::Flag disposeFileHandle = DisposeAfterUse::YES) override;
 
    const Array<WinResourceID> getIDList(const WinResourceID &type) const override;
 
    SeekableReadStream *getResource(const WinResourceID &type, const WinResourceID &id) override;
 
    String loadString(uint32 stringID) override;
 
    const Array<NESegment> &getSegments() const { return _segments; }
 
    /* Index of NE automatic segment */
    uint32 getAutomaticSegmentIndex() const { return _autoSegmentIndex; }
 
protected:
    VersionInfo *parseVersionInfo(SeekableReadStream *stream) override;
 
private:
    struct Resource {
        WinResourceID id;
 
        WinResourceID type; 
 
        uint32 offset; 
        uint32 size;   
 
        uint16 flags;
        uint16 handle;
        uint16 usage;
    };
 
    SeekableReadStream *_exe; 
    DisposeAfterUse::Flag _disposeFileHandle;
 
    uint32 _autoSegmentIndex = 0;
    Array<NESegment> _segments;
 
    List<Resource> _resources;
 
    typedef HashMap<WinResourceID, Common::String, WinResourceID_Hash, WinResourceID_EqualTo> IDMap;
    typedef HashMap<WinResourceID, IDMap, WinResourceID_Hash, WinResourceID_EqualTo> TypeMap;
    TypeMap _nameTable;
 
    uint32 getResourceTableOffset();
    bool readResourceTable(uint32 offset);
 
    bool readNameTable(uint32 offset, uint32 size);
 
    const Resource *findResource(const WinResourceID &type, const WinResourceID &id) const;
 
    static String getResourceString(SeekableReadStream &exe, uint32 offset);
};
 
} // End of namespace Common
 
#endif