wadentry.hpp

Go to the documentation of this file.

// libdoomwad: manipulates Doom wad files.
// Copyright (C) 2005  John Gaughan
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// This library is distributed with the full text of the LGPL. Please see
// the accompanying file named COPYING.
// 
// You may contact the author at john@johngaughan.net

// C++ required.
#if !defined __cplusplus
#error C++ compiler required
#endif

// Include guard
#if !defined WADENTRY_H
#define WADENTRY_H

// C++ headers
#include <string>

// Doom headers
#include "global.hpp"
#include "lump.hpp"

namespace Doomwad
{

  EXPORT class WadEntry
  {
    public:

    virtual ~WadEntry (void) throw () {}

    virtual bool setFromLump (const Lump &lump) throw () = 0;

    virtual Lump toLump (void) const throw () = 0;

    virtual std::string toString (void) const throw () = 0;
  };

  EXPORT class TextWadEntry : public WadEntry
  {
    protected:

    std::string str;

    std::string name;

    public:

    static const std::string ANIMDEFS;

    static const std::string CREDITS;

    static const std::string DECALDEF;

    static const std::string DECORATE;

    static const std::string DEHACKED;

    static const std::string DEHSUPP;

    static const std::string KEYCONF;

    static const std::string MAPINFO;

    static const std::string S_SKIN;

    static const std::string SCRIPTS;

    static const std::string SNDINFO;

    static const std::string SNDSEQ;

    static const std::string TERRAIN;

    TextWadEntry (const std::string&) throw ();
    TextWadEntry (const Lump&) throw ();
    virtual ~TextWadEntry (void) throw ();

    virtual bool setString (const std::string&) throw ();
    virtual std::string getString (void) const throw ();

    virtual bool setName (const std::string&) throw ();
    virtual std::string getName (void) const throw ();

    virtual void makeDosNewline (void) throw ();
    virtual void makeMacNewline (void) throw ();
    virtual void makeUnixNewline (void) throw ();

    // Inherited
    virtual bool setFromLump (const Lump&) throw ();
    virtual Lump toLump (void) const throw ();
    virtual std::string toString (void) const throw ();
  };

  EXPORT class WadEntryElement
  {
    public:

    virtual size_t getLength (void) const throw () = 0;

    virtual bool read (const Lump &lump, Lump::size_type i) throw () = 0;

    virtual bool write (Lump &lump, Lump::size_type i) const throw () = 0;

    virtual std::string toString (void) const throw () = 0;
  };
}
#endif

---