/*
 * Copyright (C) 2002-2004, 2006, 2008, 2010 by the Widelands Development Team
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */

#ifndef WIDELANDS_MAP_DATA_PACKET_H
#define WIDELANDS_MAP_DATA_PACKET_H

#include "wexception.h"
#include "logic/widelands_filewrite.h"

struct FileSystem;

namespace Widelands {

struct Editor_Game_Base;
struct Map_Map_Object_Loader;
struct Map_Map_Object_Saver;

/** This class represents a data packet in a widelands map file. it is an
 * abstract base class
*/
struct Map_Data_Packet {
	virtual ~Map_Data_Packet() {}

	virtual void Read
		(FileSystem &, Editor_Game_Base &, bool, Map_Map_Object_Loader &)
		throw (_wexception)
		= 0;
	virtual void Write
		(FileSystem &, Editor_Game_Base &, Map_Map_Object_Saver &)
		throw (_wexception)
		= 0;
};

}

#define MAP_DATA_PACKET(name)                                                 \
namespace Widelands {                                                         \
struct name : public Map_Data_Packet {                                        \
   virtual ~name() {}                                                         \
   void Read                                                                  \
      (FileSystem &, Editor_Game_Base &, bool, Map_Map_Object_Loader &)       \
      throw (_wexception);                                                    \
   void Write(FileSystem &, Editor_Game_Base &, Map_Map_Object_Saver &)       \
      throw (_wexception);                                                    \
};                                                                            \
}                                                                             \

#endif
