Initial commit
This commit is contained in:
250
engines/dgds/request.h
Normal file
250
engines/dgds/request.h
Normal file
@@ -0,0 +1,250 @@
|
||||
/* 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 DGDS_REQUEST_H
|
||||
#define DGDS_REQUEST_H
|
||||
|
||||
#include "common/array.h"
|
||||
|
||||
#include "dgds/parser.h"
|
||||
#include "dgds/dgds_rect.h"
|
||||
|
||||
namespace Dgds {
|
||||
|
||||
class DgdsFont;
|
||||
class Image;
|
||||
|
||||
struct TextItem {
|
||||
uint16 _x;
|
||||
uint16 _y;
|
||||
uint16 _vals[2];
|
||||
Common::String _txt;
|
||||
};
|
||||
|
||||
// This struct is defined in the code, but seems
|
||||
// to not be used in any of the games?
|
||||
struct RequestFillArea {
|
||||
uint16 _x;
|
||||
uint16 _y;
|
||||
uint16 _width;
|
||||
uint16 _height;
|
||||
uint16 _col1;
|
||||
uint16 _col2;
|
||||
};
|
||||
|
||||
enum GadgetType {
|
||||
kGadgetNone = 0,
|
||||
kGadgetText = 1,
|
||||
kGadgetSlider = 2,
|
||||
kGadgetButton = 4,
|
||||
kGadgetImage = 8,
|
||||
};
|
||||
|
||||
// basic gadget is 52 (0x34) bytes
|
||||
class Gadget {
|
||||
public:
|
||||
virtual ~Gadget() {}
|
||||
|
||||
// NOTE: Most of these names are still guesses
|
||||
uint16 _gadgetNo;
|
||||
uint16 _x;
|
||||
uint16 _y;
|
||||
uint16 _width;
|
||||
uint16 _height;
|
||||
GadgetType _gadgetType;
|
||||
uint16 _flags2;
|
||||
uint16 _flags3;
|
||||
|
||||
uint16 _sval1Type; // if 1 then use the string, else use the int
|
||||
Common::String _sval1S;
|
||||
uint16 _sval1I;
|
||||
|
||||
uint16 _sval2Type; // if 1 then use the string, else use the int
|
||||
Common::String _sval2S;
|
||||
uint16 _sval2I;
|
||||
|
||||
Common::String _buttonName;
|
||||
|
||||
// some other fields..
|
||||
uint16 _fontNo;
|
||||
uint16 _col1;
|
||||
uint16 _col2;
|
||||
uint16 _col3;
|
||||
|
||||
uint16 _field20_0x28;
|
||||
uint16 _field21_0x2a;
|
||||
|
||||
uint16 _parentX;
|
||||
uint16 _parentY;
|
||||
|
||||
virtual Common::String dump() const;
|
||||
virtual void draw(Graphics::ManagedSurface *dst) const;
|
||||
virtual void toggle(bool enable) {}
|
||||
|
||||
bool containsPoint(const Common::Point &pt);
|
||||
bool isVisible() const { return !(_flags3 & 0x40); }
|
||||
void setVisible(bool visible);
|
||||
|
||||
Common::Point topLeft() const;
|
||||
Common::Point midPoint() const;
|
||||
};
|
||||
|
||||
// Button gadget has no additional fields, but some behavior differences.
|
||||
class ButtonGadget : public Gadget {
|
||||
public:
|
||||
void draw(Graphics::ManagedSurface *dst) const override;
|
||||
void toggle(bool enable) override;
|
||||
private:
|
||||
// Each of these return the text color
|
||||
byte drawDragonBg(Graphics::ManagedSurface *dst, bool enabled) const;
|
||||
byte drawChinaBg(Graphics::ManagedSurface *dst, bool enabled) const;
|
||||
byte drawWillyBg(Graphics::ManagedSurface *dst, bool enabled) const;
|
||||
void drawWillyBmpButtons(Graphics::ManagedSurface *dst) const;
|
||||
void drawCenteredBmpIcon(Graphics::ManagedSurface *dst, int16 cornerNum) const;
|
||||
void drawWillyLoadSaveIcon(Graphics::ManagedSurface *dst, bool isLoad) const;
|
||||
};
|
||||
|
||||
// extended gadget type 1 is 62 (0x3e) bytes
|
||||
class TextAreaGadget : public Gadget {
|
||||
public:
|
||||
uint16 _textGadget_i1;
|
||||
uint16 _bufLen;
|
||||
|
||||
Common::String dump() const override;
|
||||
void draw(Graphics::ManagedSurface *dst) const override;
|
||||
};
|
||||
|
||||
// extended gadget type 2 is 74 (0x4a) bytes
|
||||
class SliderGadget : public Gadget {
|
||||
public:
|
||||
SliderGadget();
|
||||
|
||||
uint16 _gadget2_i1;
|
||||
uint16 _gadget2_i2;
|
||||
uint16 _gadget2_i3;
|
||||
uint16 _gadget2_i4;
|
||||
|
||||
Common::String dump() const override;
|
||||
void draw(Graphics::ManagedSurface *dst) const override;
|
||||
|
||||
/// Set number of steps the slider has
|
||||
/// If lock is true, jumps the final position to match the step.
|
||||
void setSteps(int16 steps, bool lock) {
|
||||
_steps = steps;
|
||||
_lock = lock;
|
||||
}
|
||||
|
||||
void setValue(int16 val);
|
||||
// Return the closest step value to the current handle position.
|
||||
int16 getValue();
|
||||
|
||||
///
|
||||
/// Work out where the mouse click was and what the new setting should be
|
||||
/// from 0 to steps-1.
|
||||
///
|
||||
int16 onClick(const Common::Point &mousePt);
|
||||
|
||||
void onDrag(const Common::Point &mousePt);
|
||||
// returns the new value
|
||||
int16 onDragFinish(const Common::Point &mousePt);
|
||||
|
||||
private:
|
||||
bool _lock;
|
||||
int16 _steps;
|
||||
int16 _handleX;
|
||||
|
||||
void drawDragonBg(Graphics::ManagedSurface *dst) const;
|
||||
void drawChinaBg(Graphics::ManagedSurface *dst) const;
|
||||
|
||||
int16 getHandleWidth() const;
|
||||
int16 getUsableWidth() const;
|
||||
};
|
||||
|
||||
// extended gadget type 8 is 68 (0x44) bytes
|
||||
class ImageGadget : public Gadget {
|
||||
public:
|
||||
uint16 _xStep;
|
||||
uint16 _yStep;
|
||||
|
||||
Common::String dump() const override;
|
||||
void draw(Graphics::ManagedSurface *dst) const override;
|
||||
};
|
||||
|
||||
class RequestData {
|
||||
public:
|
||||
uint16 _fileNum;
|
||||
DgdsRect _rect;
|
||||
uint16 _col1;
|
||||
uint16 _col2;
|
||||
uint16 _flags;
|
||||
Common::Array<TextItem> _textItemList;
|
||||
Common::Array<RequestFillArea> _fillAreaList;
|
||||
Common::Array<Common::SharedPtr<Gadget>> _gadgets;
|
||||
|
||||
Common::String dump() const;
|
||||
void drawBg(Graphics::ManagedSurface *dst) const;
|
||||
void drawInvType(Graphics::ManagedSurface *dst);
|
||||
|
||||
static const DgdsFont *getMenuFont();
|
||||
static const Image *getCorners();
|
||||
|
||||
static void fillBackground(Graphics::ManagedSurface *dst, uint16 x, uint16 y, uint16 width, uint16 height, int16 startoffset);
|
||||
static void drawCorners(Graphics::ManagedSurface *dst, uint16 startNum, uint16 x, uint16 y, uint16 width, uint16 height);
|
||||
static void drawHeader(Graphics::ManagedSurface *dst, int16 x, int16 y, int16 width, int16 yoffset, const Common::String &header, byte fontCol, bool drawBox, byte boxTopColor, byte boxBottomColor);
|
||||
Gadget *findGadgetByNumWithFlags3Not0x40(int16 num);
|
||||
|
||||
private:
|
||||
|
||||
void drawBackgroundNoSliders(Graphics::ManagedSurface *dst, const Common::String &header) const;
|
||||
void drawBackgroundWithSliderArea(Graphics::ManagedSurface *dst, int16 sliderHeight, const Common::String &header) const;
|
||||
|
||||
};
|
||||
|
||||
// A REQ file contains a sequence of REQ and GAD block pairs.
|
||||
class REQFileData : public ParserData {
|
||||
public:
|
||||
Common::Array<RequestData> _requests;
|
||||
|
||||
Common::String dump() const;
|
||||
};
|
||||
|
||||
/**
|
||||
* A "Request" is described by a REQ file. Requests are things like menus,
|
||||
* inventory items, etc.
|
||||
*
|
||||
* Request files include REQ and GAD (Gadget) chunks.
|
||||
*/
|
||||
class RequestParser : public DgdsParser {
|
||||
public:
|
||||
RequestParser(ResourceManager *resman, Decompressor *decompressor);
|
||||
virtual ~RequestParser() {}
|
||||
|
||||
bool handleChunk(DgdsChunkReader &chunk, ParserData *data) override;
|
||||
|
||||
protected:
|
||||
bool parseREQChunk(RequestData &data, DgdsChunkReader &chunk, int num);
|
||||
bool parseGADChunk(RequestData &data, DgdsChunkReader &chunk, int num);
|
||||
};
|
||||
|
||||
|
||||
} // End of namespace Dgds
|
||||
|
||||
#endif // DGDS_REQUEST_H
|
||||
Reference in New Issue
Block a user