wagparser.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 AGI_WAGPARSER_H
#define AGI_WAGPARSER_H

namespace Agi {

class WagProperty {
// Constants, enumerations etc
public:
    enum WagPropertyCode {
        PC_GAMEDESC = 129, 
        PC_GAMEAUTHOR,     
        PC_GAMEID,         
        PC_INTVERSION,     
        PC_GAMELAST,       
        PC_GAMEVERSION,    
        PC_GAMEABOUT,      
        PC_GAMEEXEC,       
        PC_RESDIR,         
        PC_DEFSYNTAX,      
        PC_INVOBJDESC = 144,
        PC_VOCABWORDDESC = 160,
        PC_PALETTE = 172,
        PC_USERESNAMES = 180,
        PC_LOGIC = 192,
        PC_PICTURE = 208,
        PC_SOUND = 224,
        PC_VIEW = 240,
        PC_UNDEFINED = 0x100 
    };

    enum WagPropertyType {
        PT_ID,
        PT_DESC,
        PT_SYNTAX,
        PT_CRC32,
        PT_KEY,
        PT_INST0,
        PT_INST1,
        PT_INST2,
        PT_MUTE0,
        PT_MUTE1,
        PT_MUTE2,
        PT_MUTE3,
        PT_TPQN,
        PT_ROOM,
        PT_VIS0,
        PT_VIS1,
        PT_VIS2,
        PT_VIS3,
        PT_ALL = 0xff,
        PT_UNDEFINED = 0x100 
    };

// Constructors, destructors, operators etc
public:
    WagProperty();

    ~WagProperty();

    WagProperty(const WagProperty &other);

    WagProperty &operator=(const WagProperty &other);

// Non-public helper methods
protected:
    void setDefaults();

    void deleteData();

    void deepCopy(const WagProperty &other);

// Public methods that have side-effects
public:
    bool read(Common::SeekableReadStream &stream);

    void clear();

// Public access functions
public:
    bool readOk() const { return _readOk; }

    enum WagPropertyCode getCode() const { return _propCode; }

    enum WagPropertyType getType() const { return _propType; }

    byte getNumber() const { return _propNum; }

    uint16 getSize() const { return _propSize; }

    const char *getData() const { return _propData; }

    void setPropCode(WagPropertyCode propCode);

    void setPropDataSize(Common::String str);

// Member variables
protected:
    bool _readOk;                   
    enum WagPropertyCode _propCode; 
    enum WagPropertyType _propType; 
    byte _propNum;                  
    uint16 _propSize;               
    char *_propData;                
};


class WagFileParser {
// Constants, type definitions, enumerations etc.
public:
    enum {
        WINAGI_VERSION_LENGTH = 16 
    };
    typedef Common::Array<WagProperty> PropertyList; 

public:
    WagFileParser();

    ~WagFileParser();

    void addPropFromIni(Common::INIFile &iniWagFile, Common::String section, Common::String key, Agi::WagProperty::WagPropertyCode code);

    bool parse(const Common::FSNode &node);

    const PropertyList &getProperties() const { return _propList; }

    const WagProperty *getProperty(const WagProperty::WagPropertyCode code) const;

    bool checkAgiVersionProperty(const WagProperty &version) const;

    uint16 convertToAgiVersionNumber(const WagProperty &version);

    bool parsedOk() const { return _parsedOk; }

protected:
    bool checkWagVersion(Common::SeekableReadStream &stream);

    bool endOfProperties(const Common::SeekableReadStream &stream) const;

// Member variables
protected:
    PropertyList _propList; 
    bool         _parsedOk; 
};

} // End of namespace Agi

#endif // AGI_WAGPARSER_H