/source/loaders.cpp

/*! \file loaders.cpp
    \brief procedure for loading and writing savegames, maps etc.

    IO for basic types like vehicletype, buildingtype etc which are also used by the small editors are found in sgstream

*/

/*
    This file is part of Advanced Strategic Command; http://www.asc-hq.de
    Copyright (C) 1994-2010  Martin Bickel  and  Marc Schellenberger

    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; see the file COPYING. If not, write to the
    Free Software Foundation, Inc., 59 Temple Place, Suite 330,
    Boston, MA  02111-1307  USA
*/

#include <algorithm>
#include <cstring>
#include <stdlib.h>
#include <stdio.h>

#include "typen.h"
#include "misc.h"
#include "buildingtype.h"
#include "vehicletype.h"
#include "spfst.h"
#include "loaders.h"
#include "dlg_box.h"
#include "dlg_box.h"
#include "dialog.h"
#include "sgstream.h"
#include "attack.h"
#include "errors.h"
#include "strtmesg.h"
#include "textfileparser.h"
#include "itemrepository.h"
#include "prehistoricevents.h"
#include "gamemap.h"
#include "gameeventsystem.h"
#include "graphicset.h"
#include "gameoptions.h"
#include "lua/luarunner.h"
#include "lua/luastate.h"
#include "packagemanager.h"
#include "i18n.h"
#include "mapimageexport.h"

#ifdef sgmain
# include "ai/ai.h"
#endif



const int actsavegameversion  = 0xff63;
const int minsavegameversion  = 0xff31;
const int actmapversion       = 0xfe51;
const int minmapversion       = 0xfe24;
const int actnetworkversion   = 0x0032;
const int minnetworkversion   = 0x0004;
const int actreplayversion    = 0x0003;
const int minreplayversion    = 0x0001;


const int fileterminator = 0xa01a;


const char* savegameextension = "*.sav";
const char* mapextension = "*.map";
const char* tournamentextension = ".ascpbm";

bool suppressMapTriggerExecution = true;

void         seteventtriggers( GameMap* actmap )
{
   if ( !suppressMapTriggerExecution )
      for ( GameMap::Events::iterator i = actmap->events.begin(); i != actmap->events.end(); ++i )
         (*i)->arm();

   for ( int i = 0; i < 8; i++ )
      actmap->player[i].queuedEvents = 1;
}



#define csm_typid32 1      /*  b1  */
#define csm_direction 2    /*  b1  */
#define csm_vehicle 4      /*  b1  */
#define csm_building 8     /*  b1  */
#define csm_height 32      /*  b1  */
#define csm_cnt2 64        /*  b1  */
#define csm_b3 128         /*  b1  */

#define csm_material 1     /*  b3  */
#define csm_fuel 2         /*  b3  */
#define csm_visible 4      /*  b3  */
#define csm_weather 16     /*  b3  */
#define csm_object 64      /*  b3  */
#define csm_b4 128         /* b3 */

#define csm_resources  1     /* b4 */
#define csm_connection 2     // b4
#define csm_newobject  4     // b4







/**************************************************************/
/*     sezierungen schreiben / lesen                         */
/**************************************************************/


void   tspfldloaders::readdissections ( void )
{
   for (int i = 0; i < 8; i ++ ) {
      if ( spfld->player[ i ].__dissectionsToLoad ) {
         int k;
         do {
            Player::Dissection du;
            stream->readInt(); // dummy;
            stream->readInt(); // dummy;

            du.orgpoints = stream->readInt();
            du.points    = stream->readInt();
            du.num       = stream->readInt();

            k = stream->readInt();

            int j = stream->readInt();
            du.fzt = vehicleTypeRepository.getObject_byID ( j );
            if ( !du.fzt )
               throw InvalidID ( "vehicle", j );

            j = stream->readInt();
            du.tech = technologyRepository.getObject_byID  ( j );
            if ( !du.tech )
               throw InvalidID ( "technology", j );

            spfld->player[ i ].dissections.push_back ( du );
         } while ( k );
      }
   } /* endfor */
}

void   tspfldloaders::writedissections ( void )
{
   for (int i = 0; i < 8; i ++ ) {
      Player::DissectionContainer::iterator di = spfld->player[i].dissections.begin();
      while ( di != spfld->player[i].dissections.end() ) {
         stream->writeInt ( 1 ); // dummy
         stream->writeInt ( 1 ); // dummy
         stream->writeInt ( di->orgpoints );
         stream->writeInt ( di->points );
         stream->writeInt ( di->num );

         di++;
         if ( di != spfld->player[i].dissections.end() )
            stream->writeInt ( 1 );
         else
            stream->writeInt ( 0 );

         stream->writeInt ( di->fzt->id );
         stream->writeInt ( di->tech->id );
      }
   }
}



/**************************************************************/
/*        Messages  schreiben / lesen                         */
/**************************************************************/

const int messageVersion = 0xabcdf1;
const int messageMinVersion = 0xabcdef;

void      tspfldloaders:: writemessages ( void )
{
   stream->writeInt ( messageVersion );

   int id = 0;
   for ( MessageContainer::iterator mi = spfld->messages.begin(); mi != spfld->messages.end();  ) {
      id++;
      (*mi)->id = id;

      stream->writeInt ( (*mi)->from );
      stream->writeInt ( (*mi)->to );
      stream->writeInt ( (*mi)->cc );
      stream->writeInt ( (unsigned int) (*mi)->time );
      stream->writeInt ( 1 );
      stream->writeInt ( (*mi)->id );
      stream->writeInt ( (*mi)->gametime.turn() );
      stream->writeInt ( (*mi)->gametime.move() );
      stream->writeInt( (*mi)->reminder );


      ASCString& t = (*mi)->text;

      mi++;
      stream->writeInt ( mi != spfld->messages.end() ? 1 : 0 );

      stream->writeString ( t );
   }

   for ( int i = 0; i < 8; i++ )
      writemessagelist ( spfld->player[ i ].oldmessage );

   for ( int i = 0; i < 8; i++ )
      writemessagelist ( spfld->player[ i ].unreadmessage );

   for ( int i = 0; i < 8; i++ )
      writemessagelist ( spfld->player[ i ].sentmessage );

   writemessagelist ( spfld->unsentmessage );

   stream->writeInt ( messageVersion );

   stream->writeString ( spfld->gameJournal );
   stream->writeString ( spfld->newJournal );
}


void      tspfldloaders:: writemessagelist( MessagePntrContainer& lst )
{
   for ( MessagePntrContainer::iterator i = lst.begin(); i != lst.end(); i++ )
      stream->writeInt ( (*i)->id );
   stream->writeInt ( 0 );
}


/*
class MessageIDequals : public unary_function<Message*,bool>{
      int id;
   public:
      MessageIDequals ( int _id ) { id == _id; };
      bool operator() ( const Message* m ) { return m->id == id; };
};
*/

void      tspfldloaders:: readmessagelist( MessagePntrContainer& lst )
{
   int i = stream->readInt();

   while ( i ) {
      // MessageContainer::iterator mi = find ( spfld->messages.begin(), spfld->messages.end(), MessageIDequals ( i ));
      MessageContainer::iterator mi = spfld->messages.end();
      for ( MessageContainer::iterator mi2 = spfld->messages.begin(); mi2 != spfld->messages.end(); mi2++ )
         if ( (*mi2)->id == i )
            mi = mi2;

      if ( mi == spfld->messages.end())
         warningMessage( "message list corrupted !\nplease report this bug!\nthe game will continue, but some messages will probably be missing\nand other instabilities may occur.");
      lst.push_back ( *mi );
      i = stream->readInt();
   }
}


void      tspfldloaders:: readmessages ( void )
{
   int magic = stream->readInt();
   assertOrThrow( magic >= messageMinVersion  && magic <= messageVersion );

   while ( spfld->__loadmessages ) {
      Message* msg = new Message ( spfld );

      msg->from    = stream->readInt();
      msg->to      = stream->readInt();
      if ( magic >= 0xabcdf0 )
         msg->cc      = stream->readInt();
      else
         msg->cc = 0;

      msg->time    = stream->readInt();
      bool msgtext = stream->readInt();
      msg->id      = stream->readInt();
      int t = stream->readInt();
      int m = stream->readInt();
      msg->gametime.set ( t, m );

      if ( magic >= 0xabcdf1 )
         msg->reminder = stream->readInt();
      else
         msg->reminder = false;

      spfld->__loadmessages = stream->readInt();

      if ( msgtext )
         msg->text = stream->readString( true );

   }

   for ( int i = 0; i < 8; i++ )
      if ( spfld->player[ i ].__loadoldmessage )
         readmessagelist ( spfld->player[ i ].oldmessage );

   for ( int i = 0; i < 8; i++ )
      if ( spfld->player[ i ].__loadunreadmessage )
         readmessagelist ( spfld->player[ i ].unreadmessage );

   for ( int i = 0; i < 8; i++ )
      if ( spfld->player[ i ].__loadsentmessage )
         readmessagelist ( spfld->player[ i ].sentmessage );

   if ( spfld->__loadunsentmessage )
      readmessagelist ( spfld->unsentmessage );

   stream->readInt(); // magic

   if ( spfld->___loadJournal )
      spfld->gameJournal = stream->readString();

   if (  spfld->___loadNewJournal )
      spfld->newJournal = stream->readString();
}






void   tspfldloaders::readoldevents ( void )
{
   if ( spfld->loadOldEvents ) {
      int  num = stream->readInt();
      while ( num ) {
         for ( int i = 0; i < num; i++ )
            stream->readInt();
         for ( int i = 0; i < num; i++ )
            stream->readInt();

         num  = stream->readInt();
      }
   }
}

void checkForUniqueUnitIDs( GameMap* gamemap )
{
   map<int,int> units;
   for ( int p = 0; p < gamemap->getPlayerCount(); ++p )
      for ( Player::VehicleList::iterator i = gamemap->getPlayer(p).vehicleList.begin(); i != gamemap->getPlayer(p).vehicleList.end(); ++i )
         if ( units[(*i)->networkid]++ > 0 ) {
            warningMessage("unit with duplicate network ids: " + ASCString::toString( (*i)->networkid ) + "\nThis will lead to replay errors during the next turn." );
            (*i)->networkid = gamemap->idManager.getNewNetworkID();;
         }
}

/**************************************************************/
/*     map schreiben / lesen / initialisieren          */
/**************************************************************/

void    tspfldloaders::writemap ( void )
{
   checkForUniqueUnitIDs( spfld );
   if ( !spfld )
      displaymessage ( "tspfldloaders::writemap  ; no map to write ! ",2);

   spfld->write ( *stream );
}


void     tmaploaders::initmap ( void )
{
   spfld->game_parameter = NULL;
}


void     tgameloaders::initmap ( void )
{
   spfld->game_parameter = NULL;
}


void     tspfldloaders::readmap ( void )
{
   spfld = new GameMap;

   spfld->read ( *stream );
}



void tgameloaders :: writeAI ( )
{
#ifdef sgmain
   int a = 0;
   for ( int i = 0; i< 8; i++ )
      if ( spfld->player[i].ai )
         a += 1 << i;

   stream->writeInt ( a );

   for ( int i = 0; i < 8; i++ )
      if ( spfld->player[i].ai )
         spfld->player[i].ai->write( *stream );
#else
   stream->writeInt(0);
#endif
}

void tgameloaders :: readAI ( )
{
#ifdef sgmain
   int a = stream->readInt();
   for ( int i = 0; i< 8; i++ )
      if ( a & ( 1 << i ) ) {
         AI* ai = new AI ( spfld, i );
         ai->read ( *stream );
         spfld->player[i].ai = ai;
      } else {
         spfld->player[i].ai = NULL;
      }
#else
   for ( int i = 0; i< 9; i++ )
      spfld->player[i].ai = NULL;
#endif
}


/**************************************************************/
/*     Network schreiben / lesen                             */
/**************************************************************/

extern void readLegacyNetworkData ( tnstream& stream );


void        tspfldloaders::readLegacyNetwork ( void )
{
   if ( spfld->___loadLegacyNetwork )
      readLegacyNetworkData( *stream );
}




/**************************************************************/
/*     fielder schreiben / lesen                              */
/**************************************************************/

const int objectstreamversion = 4;

void   tspfldloaders::writefields ( void )
{
   int l = 0;
   int cnt1 = spfld->xsize * spfld->ysize;
   int cnt2;

   do {
      cnt2 = 0;
      MapField* fld = &spfld->field[l];
      /*

      RLE encoding not supported any more, since tfield is becomming too complex

      if (l + 2 < cnt1) {
         l2 = l + 1;
         fld2 = &spfld->field[l2];
       asfasfdasfd
         while ((l2 + 2 < cnt1) && ( memcmp(fld2, fld, sizeof(*fld2)) == 0) ) {
            cnt2++;
            l2++;
            fld2 = &spfld->field[l2];
         }
      }
      */


      char b1 = 0;
      char b3 = 0;
      char b4 = 0;

      if (fld->typ->terraintype->id > 255)
         b1 |= csm_typid32;
      if (fld->vehicle != NULL)
         b1 |= csm_vehicle;
      if ( (fld->bdt & getTerrainBitType( cbbuildingentry )).any() )
         b1 |= csm_building;


      if (cnt2 > 0)
         b1 |= csm_cnt2;

      if (fld->material > 0)
         b3 |= csm_material;
      if (fld->fuel > 0)
         b3 |= csm_fuel;

      if (fld->typ != fld->typ->terraintype->weather[0])
         b3 |= csm_weather;
      if (fld->visible)
         b3 |= csm_visible;
      if ( !fld->objects.empty() || !fld->mines.empty() )
         b4 |= csm_newobject;

      if ( fld->resourceview )
         b4 |= csm_resources;

      if ( fld->connection )
         b4 |= csm_connection;

      if ( b4 )
         b3 |= csm_b4;

      if ( b3 )
         b1 |= csm_b3;

      stream->writeChar( b1 );

      if (b1 & csm_b3 )
         stream->writeChar ( b3 );

      if (b3 & csm_b4 )
         stream->writeChar ( b4 );

      if (b1 & csm_cnt2 )
         stream->writeInt ( cnt2 );

      if (b3 & csm_weather ) {
         int k = 1;
         while ( fld->typ != fld->typ->terraintype->weather[k]    &&   k < cwettertypennum ) {
            k++;
         } /* endwhile */

         if ( k == cwettertypennum ) {
            k = 0;
            displaymessage ( "invalid terrain ( weather not found ) at position %d \n",1,l );
         }
         stream->writeInt ( k );
      }

      if (b1 & csm_typid32 )
         stream->writeInt ( fld->typ->terraintype->id );
      else
         stream->writeChar ( fld->typ->terraintype->id );

      if (b1 & csm_vehicle )
         fld->vehicle->write ( *stream );


      if (b1 & csm_building )
         fld->building->write ( *stream );

      if (b3 & csm_material )
         stream->writeChar ( fld->material );

      if (b3 & csm_fuel )
         stream->writeChar ( fld->fuel );

      if (b3 & csm_visible )
         stream->writeWord ( fld->visible );

      if ( b4 & csm_newobject ) {
         stream->writeInt ( objectstreamversion );

         stream->writeInt ( fld->mines.size() );
         for ( MapField::MineContainer::iterator m = fld->mines.begin(); m != fld->mines.end(); m++  ) {
            stream->writeInt ( m->type );
            stream->writeInt ( m->strength );
            stream->writeInt ( m->lifetimer );
            stream->writeInt ( m->player );
            stream->writeInt ( m->identifier );
         }

         stream->writeInt ( fld->objects.size() );

         for ( MapField::ObjectContainer::iterator o = fld->objects.begin(); o != fld->objects.end(); o++  ) {
            stream->writeInt ( 1 ); // was: pointer to type
            stream->writeInt ( o->damage );
            stream->writeInt ( o->dir );
            stream->writeInt ( o->lifetimer );
            for ( int i = 0; i < 4; i++ )
               stream->writeInt ( 0 );  // dummy
            stream->writeInt ( o->typ->id );
            stream->writeInt( o->remainingGrowthTime );
         }
      }

      if (b4 & csm_resources ) {
         stream->writeChar ( fld->resourceview->visible );
         for ( int i = 0; i < 8; i++ )
            stream->writeChar ( fld->resourceview->fuelvisible[i] );
         for ( int i = 0; i < 8; i++ )
            stream->writeChar ( fld->resourceview->materialvisible[i] );
      }

      if ( b4 & csm_connection )
         stream->writeInt ( fld->connection );

      l += 1 + cnt2;
   }  while (l < cnt1);
}





void tspfldloaders::readfields ( void )
{
   int cnt2 = 0;
   int cnt1 = spfld->xsize * spfld->ysize;

   assertOrThrow( cnt1 > 0 );
   assertOrThrow( spfld->xsize > 0 );
   assertOrThrow( spfld->ysize > 0 );

   spfld->allocateFields ( spfld->xsize , spfld->ysize );

   if (spfld->field == NULL)
      displaymessage ( "Could not allocate memory for map ",2);

   int l = 0;
   MapField* lfld = NULL;

   do {
      MapField* fld2;

      if (cnt2 == 0) {

         fld2 = & spfld->field[l];

         fld2->bdt.setInt ( 0 , 0 );

         char b1, b3, b4;
         b1 = stream->readChar();

         if (b1 & csm_b3 )
            b3 = stream->readChar();
         else
            b3 = 0;

         if (b3 & csm_b4 )
            b4 = stream->readChar();
         else
            b4 = 0;

         if (b1 & csm_cnt2 )
            cnt2 = stream->readInt();
         else
            cnt2 = 0;

         int weather;
         if (b3 & csm_weather )
            weather = stream->readInt();
         else
            weather = 0;

         assertOrThrow( weather >= 0 && weather < cwettertypennum );

         int k;

         if (b1 & csm_typid32 )
            k = stream->readInt();
         else
            k = stream->readChar();

         pterraintype trn = terrainTypeRepository.getObject_byID ( k );
         if ( !trn )
            throw InvalidID ( "terrain", k );

         fld2->typ = trn->weather[weather];
         if ( !fld2->typ ) {
            fld2->typ = trn->weather[0];
            if ( !fld2->typ )
               throw InvalidID ( "terrain", k );
         }

         if (b1 & csm_direction )
            stream->readChar();  // fld2->direction = 0;


         if (b1 & csm_vehicle ) {
            fld2->vehicle = Vehicle::newFromStream ( spfld, *stream );
            fld2->vehicle->setnewposition ( l%spfld->xsize, l/spfld->xsize );
         }

         if (b1 & csm_building ) {
            fld2->building = Building::newFromStream ( spfld, *stream );
            fld2->bdt |= getTerrainBitType(cbbuildingentry);
         }

         if (b3 & csm_material)
            fld2->material = stream->readChar();
         else
            fld2->material = 0;

         if (b3 & csm_fuel)
            fld2->fuel = stream->readChar();
         else
            fld2->fuel = 0;

         if (b3 & csm_visible)
            fld2->visible = stream->readWord();
         else
            fld2->visible = 0;

         int  tempobjectNum = 0;

         if (b3 & csm_object ) {

            char minetype = stream->readChar();
            char minestrength = stream->readChar();
            if ( minetype >> 4 ) {
               Mine m( MineTypes((minetype >> 1) & 7), minestrength, minetype >> 4, spfld );
               fld2->mines.push_back ( m );
            }

            tempobjectNum = stream->readInt();

            for ( int i = 0; i < 16; i++ )
               stream->readInt();
         }

         int objectversion = 1;
         if ( b4 & csm_newobject ) {
            objectversion = stream->readInt();

            if ( objectversion < 1 || objectversion > objectstreamversion )
               throw tinvalidversion ( "object", objectstreamversion, objectversion );

            int minenum = stream->readInt();

            for ( int i = 0; i < minenum; i++ ) {
               MineTypes type = MineTypes(stream->readInt());
               int strength = stream->readInt();
               int minetime = stream->readInt();
               int player = stream->readInt();
               if ( player < 0 || player > 7 )
                  player = 0;

               assertOrThrow( strength >= 0 );
               assertOrThrow( type > 0 && type <= 4 );

               int id;
               if ( objectversion >= 4 )
                  id = stream->readInt();
               else
                  id = spfld->idManager.getNewNetworkID();

               Mine m ( type, strength, player, spfld, id );
               if ( objectversion == 1 ) {
                  int endtime = minetime;
                  int lifetime = spfld->getgameparameter( GameParameter(cgp_antipersonnelmine_lifetime + m.type - 1));
                  if ( lifetime > 0  &&  endtime > 0 )
                     m.lifetimer = endtime - spfld->time.turn() + spfld->getgameparameter( GameParameter(cgp_antipersonnelmine_lifetime + m.type - 1));
                  else if ( lifetime > 0 )
                     m.lifetimer = lifetime;
                  else
                     m.lifetimer = -1;
               } else
                  m.lifetimer = minetime;
               fld2->mines.push_back ( m );
            }

            tempobjectNum = stream->readInt();
         }

         if ( (b3 & csm_object) || (b4 & csm_newobject )) {
            for ( int n = 0; n < tempobjectNum; n++ ) {
               Object o;
               stream->readInt(); // was: type
               o.damage = stream->readInt();
               assertOrThrow( o.damage >= 0 );
               o.dir = stream->readInt();
               if ( objectversion >= 2 )
                  o.lifetimer = stream->readInt();
               else
                  stream->readInt();

               for ( int i = 0; i < 4; i++ )
                  stream->readInt(); // dummy

               int id = stream->readInt();
               o.typ = objectTypeRepository.getObject_byID ( id );

               if ( !o.typ )
                  throw InvalidID ( "object", id );

               if ( objectversion >= 3 )
                  o.remainingGrowthTime = stream->readInt();

               if ( objectversion == 1 )
                  o.lifetimer = o.typ->lifetime;


               fld2->objects.push_back ( o );
            }
            fld2->sortobjects();
         }

         if (b4 & csm_resources ) {
            fld2->resourceview = new MapField::Resourceview;
            fld2->resourceview->visible = stream->readChar();
            for ( int i = 0; i < 8; i++ )
               fld2->resourceview->fuelvisible[i] = stream->readChar();
            for ( int i = 0; i < 8; i++ )
               fld2->resourceview->materialvisible[i] = stream->readChar();
         }

         if ( b4 & csm_connection )
            fld2->connection = stream->readInt();

         if (b1 & csm_cnt2 )
            lfld = fld2;

      } else {
         spfld->field[l].typ = lfld->typ;
         spfld->field[l].fuel = lfld->material;
         spfld->field[l].visible = lfld->visible;
         spfld->field[l].tempw = 0;
         spfld->field[l].connection = lfld->connection;
         for ( int i = 0; i < 8; i++ )
            spfld->field[l].view[i] = lfld->view[i];
         cnt2--;
      }
      l++ ;
   }  while (l < cnt1);

   spfld->overviewMapHolder.connect();

}



/**************************************************************/
/*     Chain Items                                           */
/**************************************************************/

void   tspfldloaders::chainitems ( GameMap* actmap )
{
   int i = 0;
   for (int y = 0; y < actmap->ysize; y++)
      for (int x = 0; x < actmap->xsize; x++) {
         MapField* fld = &actmap->field[i];
         fld->setparams();
         i++;
      }
}



/**************************************************************/
/*     Set Player Existencies                                */
/**************************************************************/

SigC::Signal1<void,GameMap*> tspfldloaders::mapLoaded;


tspfldloaders::tspfldloaders ( void )
{
   spfld = NULL;
}


tspfldloaders::~tspfldloaders ( void )
{
   delete spfld;
   spfld = NULL;
}


















int          tmaploaders::savemap( const ASCString& name, GameMap* gamemap )
{
#ifdef logging
   logtofile ( "loaders / tmaploaders::savemap / started " );
#endif

   tnfilestream filestream ( name, tnstream::writing );

   stream = &filestream;

   spfld = gamemap;


   /********************************************************************************/
   /*   Stream initialisieren, Dateiinfo schreiben , map schreiben          */
   /********************************************************************************/
   {
      stream->writepchar ( getFullVersionString() );  // description is not used any more
      stream->writeWord ( fileterminator );
      stream->writeInt ( actmapversion  );

      writemap ( );
   }

   writefields ();
#ifdef WEATHERGENERATOR
   spfld->weatherSystem->write(filestream);
#endif
   stream->writeInt ( actmapversion );

   spfld = NULL;

   return 0;
}



void weatherSystemRequired()
{
   throw ASCmsgException( "This file can not be loaded, since it contains data of the discontinued weather generator");
}


GameMap* tmaploaders::_loadmap( const ASCString& name )
{
   displayLogMessage ( 4, "loading map %s ... ", name.c_str() );

   tnfilestream filestream ( name, tnstream::reading);

   stream = &filestream;

   char* description = NULL;

   stream->readpchar ( &description );
   delete[] description;

   int w = stream->readWord();

   if ( w != fileterminator )
      throw tinvalidversion ( name, fileterminator, w );


   int version = stream->readInt();

   if ( version > actmapversion || version < minmapversion )
      throw tinvalidversion ( name, actmapversion, version );


   displayLogMessage ( 8, "map, ");
   readmap ();

   if ( version <= 0xfe27 ) {
      displayLogMessage ( 8, "eventsToCome, ");
      readOldEventLists ( stream, false, spfld );
   }

   displayLogMessage ( 8, "fields, ");
   readfields ();


   if(version == 0xfe50)
      weatherSystemRequired();

   version = stream->readInt();
   if (version > actmapversion || version < minmapversion )
      throw tinvalidversion ( name, actmapversion, version );


   displayLogMessage ( 8, "chainItems, ");
   chainitems ( spfld );

   for ( int sp = spfld->getPlayerCount()-1; sp >= 0; sp--)
      if ( spfld->player[sp].exist() )
         spfld->actplayer = sp;

   displayLogMessage ( 8, "setEventTriggers, ");
   seteventtriggers( spfld );

   displayLogMessage ( 8, "calculateallobjects ");
   calculateallobjects( spfld );


   displayLogMessage ( 8, "init for playing, ");

   spfld->time.set ( 1, 0 );
   spfld->levelfinished = false;
   spfld->preferredFileNames.mapname[0] = name ;
   checkForUniqueUnitIDs( spfld );
   spfld->startGame();

   displayLogMessage ( 4, "done\n");

   GameMap* m  = spfld;
   spfld = NULL;

   mapLoaded( m );

   return m;
}


GameMap* eventLocalizationMap = NULL;



void loadLocalizedMessageFile( GameMap* map, const ASCString& filename )
{
   eventLocalizationMap = map;

   LuaState state;
   LuaRunner runner( state );
   runner.runFile( filename );
   if ( !runner.getErrors().empty() )
      errorMessage( runner.getErrors() );

   eventLocalizationMap = NULL;
}

void loadLocalizedMessages( GameMap* map, const ASCString& name )
{
   Locale locale;
   ASCString filename = locale.getLocalizedFile( name );
   if( !filename.empty() && exist( filename ) )
      loadLocalizedMessageFile( map, filename );

}

GameMap* tmaploaders::loadmap ( const ASCString& name )
{
   tmaploaders gl;
   GameMap* map = gl._loadmap ( name );
#ifdef sgmain
   loadLocalizedMessages( map, name );
#endif
   return map;
}





/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *  */




void   tsavegameloaders::savegame( tnstream* strm, GameMap* gamemap, bool writeReplays )
{
   PackageManager::storeData( gamemap );

   stream = strm;
   spfld = gamemap;

   stream->writepchar( getFullVersionString() );
   stream->writeWord( fileterminator );

   stream->writeInt( actsavegameversion );

   //An Image of the Map will now be saved to the file.
   writemaptostream( spfld , 100, 100, *stream);
   
   stream->writeString( gamemap->maptitle );
   stream->writeString( gamemap->getCurrentPlayer().getName() );
   stream->writeInt( gamemap->time.turn() );

   writemap ();

   writemessages();

   writefields ( );

   writedissections();

   if ( writeReplays && spfld->replayinfo ) {
      stream->writeInt( 1 );
      spfld->replayinfo->write(*stream);
   } else
      stream->writeInt( 0 );

   writeAI();



   stream->writeInt( actsavegameversion );

   spfld = NULL;
}


void tsavegameloaders::savegame( GameMap* gamemap, const ASCString& name)
{
   tnfilestream filestream ( name, tnstream::writing );
   savegame ( &filestream, gamemap, true );
}

GameFileInformation tsavegameloaders::loadMapimageFromFile( const ASCString& filename )
{
   GameFileInformation gfi;
   try {
      tnfilestream stream( filename, tnstream::reading );

      stream.readString(); // was: description

      int w = stream.readWord();

      if ( w != fileterminator )
         throw tinvalidversion ( stream.getDeviceName(), fileterminator, w );

      int version = stream.readInt();
      
      if ( version >= 0xff63 ) {
         gfi.image =  loadmapfromstream( stream );
         gfi.maptitle = stream.readString();
         gfi.playername = stream.readString();
         gfi.turn = stream.readInt();
      }
   } catch(...) {
   }
   return gfi;
}

GameMap* tsavegameloaders::loadGameFromFile( const ASCString& filename )
{
   tnfilestream filestream( filename, tnstream::reading );
   tsavegameloaders gl;
   return gl.loadgame( &filestream );
}

GameMap*          tsavegameloaders::loadgame( tnstream* strm )
{
   stream = strm;

   stream->readString(); // was: description

   int w = stream->readWord();

   if ( w != fileterminator )
      throw tinvalidversion ( strm->getDeviceName(), fileterminator, w );

   int version = stream->readInt();

   if (version > actsavegameversion || version < minsavegameversion )
      throw tinvalidversion ( strm->getDeviceName(), actsavegameversion, version );

   if ( version >= 0xff62 ) {
      // ignoring the map image
      loadmapfromstream( *stream );
   }
   
   if ( version >= 0xff63 ) {
      // ignoring the map information
      stream->readString();   
      stream->readString();   
      stream->readInt();
   }

   readmap ();

   readLegacyNetwork ();

   if  ( version <= 0xff39 )
      for ( int i = 0; i < 8; i++ )
         spfld->player[i].research.read_techs ( *stream );

   readmessages();

   if ( version <= 0xff37 ) {
      readOldEventLists ( stream, true, spfld );
      readoldevents ();
   }

   readfields ( );

   if(version == 0xff60)
      weatherSystemRequired();

   readdissections();

   bool loadReplay = true;
   if ( version >= 0xff35 )
      if ( !stream->readInt() )
         loadReplay = false;

   if ( loadReplay ) {
      spfld->replayinfo = new GameMap::ReplayInfo;
      spfld->replayinfo->read ( *stream );
   } else
      spfld->replayinfo = NULL;


   if ( version >= 0xff34 )
      readAI ();

   version = stream->readInt();
   if (version > actsavegameversion || version < minsavegameversion )
      throw tinvalidversion ( strm->getDeviceName(), actsavegameversion, version );

   chainitems ( spfld );

   seteventtriggers( spfld );

   calculateallobjects( spfld );
   checkForUniqueUnitIDs( spfld );

   mapLoaded( spfld );


   GameMap* s = spfld;
   spfld = NULL;  // to avoid that is is deleted by the destructor of tsavegameloaders
   return s;
}



/*****************************************************************************************************/
/*   Netzwerk                                                                                       */
/*****************************************************************************************************/




int          tnetworkloaders::savenwgame( tnstream* strm, const GameMap* gamemap )
{

   PackageManager::storeData( gamemap );

   spfld = const_cast<GameMap*>(gamemap); // yes, this is bad, but spfld can't be made constant because it is also used for loading

   stream = strm;

   stream->writepchar ( getFullVersionString() );  // description is not used any more
   stream->writeWord ( fileterminator );

   stream->writeInt ( actnetworkversion );

   writemap ();

   writemessages();

   stream->writeInt ( actnetworkversion );

   writefields ( );

   writedissections();

   if ( spfld->replayinfo )
      spfld->replayinfo->write ( *stream );

   // the AI must be the last data of the file
   writeAI();

   stream->writeInt ( actnetworkversion );

   spfld = NULL;

   return 0;
}





GameMap*  tnetworkloaders::loadnwgame( tnstream* strm )
{
   const char* name = "network game";

   stream = strm;


   char* description = NULL;
   stream->readpchar ( &description );
   delete[] description;

   int w = stream->readWord();

   if ( w != fileterminator )
      throw tinvalidversion ( name, fileterminator, (int) w );


   int version = stream->readInt();

   if (version > actnetworkversion || version < minnetworkversion )
      throw tinvalidversion ( name, actnetworkversion, version );

   readmap ();

   if ( version <= 0x11 )
      for ( int i = 0; i < 8; i++ )
         spfld->player[i].research.read_techs ( *stream );


   //NEW SaveData Weather
   if(version == 0x0030)
      weatherSystemRequired();

   /*if(version > 0xfe28){  //Vielleicht minus 1
     actmap->weatherSystem->read(*stream);
   }*/
   readmessages();
   readLegacyNetwork ();

   version = stream->readInt();

   if (version > actnetworkversion || version < minnetworkversion )
      throw tinvalidversion ( name, actnetworkversion, version );



   if ( version < 10 ) {
      readOldEventLists ( stream, true, spfld );
      readoldevents    ();
   }

   readfields ( );

   readdissections();

   if ( spfld->__loadreplayinfo ) {
      spfld->replayinfo = new GameMap::ReplayInfo;
      spfld->replayinfo->read ( *stream );
   }

   if ( version > 8 )
      readAI();

#ifdef sgmain
   version = stream->readInt();
   if (version > actnetworkversion || version < minnetworkversion )
      throw tinvalidversion ( name, actnetworkversion, version );
#endif

   chainitems ( spfld );

   seteventtriggers( spfld );

   calculateallobjects( spfld );

   checkForUniqueUnitIDs( spfld );

   spfld->levelfinished = false;

   // there was a bug that made the ammo amount underflow
   for ( int i = 0; i < 8; ++i)
      for ( Player::BuildingList::iterator b = spfld->player[i].buildingList.begin(); b != spfld->player[i].buildingList.end(); ++b )
         for ( int a = 0; a < waffenanzahl; ++a )
            if ( (*b)->ammo[a] > 32000 ) {
               ASCString s;
               s.format( "Player %s had %d ammo of type %s in the building at %d/%d", spfld->player[i].getName().c_str(), (*b)->ammo[a], cwaffentypen[a], (*b)->getEntry().x, (*b)->getEntry().y );
               new Message( s, spfld, 1 );
               (*b)->ammo[a] = 0;
            }



   GameMap* spfldcopy = spfld;
   spfld = NULL;

   mapLoaded( spfldcopy );


   return spfldcopy;

}






ASCString getLuaQuote( bool open, int n )
{
   ASCString s =  open? "[[" : "]]";
   for ( int i =0; i < n; ++i )
      s.insert(1, "=" );
   return s;
}

ASCString luaQuote( const ASCString& text )
{
   int count = 0;
   while( text.find_first_of( getLuaQuote( true,  count )) != ASCString::npos ||
          text.find_first_of( getLuaQuote( false, count )) != ASCString::npos )
      ++count;

   return getLuaQuote( true, count) + text + getLuaQuote( false, count );
}

void writeMessageFile( GameMap* gamemap, tnstream& stream )
{
   stream.writeString( "map = asc.getLoadingMap() \n", false);
   for ( GameMap::Events::const_iterator i = gamemap->events.begin(); i != gamemap->events.end(); ++i ) {
      ASCString s = (*i)->action->getLocalizationString();
      if ( !s.empty() )  {
         stream.writeString ( "--- ===== Event " + ASCString::toString((*i)->id) + "  ======= \n", false );
         stream.writeString ( "message = " + luaQuote( s ) + "\n", false );
         stream.writeString ( "asc.setLocalizedEventMessage( map, " + ASCString::toString((*i)->id) + ", message )\n\n", false);
      }
   }

   for ( int p = 0; p <= gamemap->getPlayerCount(); ++p ) {
      Player& player = gamemap->getPlayer(p);
      for ( Player::BuildingList::const_iterator b = player.buildingList.begin(); b != player.buildingList.end(); ++b ) {
         if ( !(*b)->name.empty() ) {
            stream.writeString ( "--- ===== Building " + ASCString::toString((*b)->getIdentification()) + "  ======= \n", false );
            ASCString f;
            f.format( "asc.setLocalizedContainerName( map, asc.MapCoordinate( %d, %d ), %s ) \n", (*b)->getPosition().x, (*b)->getPosition().y, +  luaQuote( (*b)->name ).c_str() );
            stream.writeString (  f, false  );
         }
      }
   }
}



void  savemap( const ASCString& name, GameMap* gamemap )
{

#ifdef logging
   logtofile ( "loaders / savemap / started " );
#endif

   try {
      tmaploaders gl;
      gl.savemap ( name, gamemap );


      if ( CGameOptions::Instance()->saveEventMessagesExternal && gamemap->nativeMessageLanguage.length() ) {
         tn_file_buf_stream messages ( name + "." + gamemap->nativeMessageLanguage, tnstream::writing );
         writeMessageFile( gamemap, messages );
      }

   } /* endtry */

   catch ( const tfileerror& err ) {
      displaymessage( "file error writing map to filename %s ", 1, err.getFileName().c_str() );
   } /* endcatch */
   catch ( const ASCexception& ) {
      displaymessage( "error writing map ", 1 );
   } /* endcatch */

}

void  savegame( const ASCString& name, GameMap* gamemap)
{
   try {
      tsavegameloaders gl;
      gl.savegame ( gamemap, name);
   } catch ( const tfileerror& err) {
      displaymessage( "error writing map to filename %s ", 1, err.getFileName().c_str() );
   } /* endcatch */
   catch ( const ASCexception& ) {
      displaymessage( "error writing map ", 1 );
   } /* endcatch */
}


void  savereplay( GameMap* gamemap, int num )
{
   try {
      if ( !gamemap->replayinfo )
         fatalError ( "treplayloaders :: savereplay   ;   No replay activated !");

      if ( gamemap->replayinfo->map[num] ) {
         delete gamemap->replayinfo->map[num];
         gamemap->replayinfo->map[num] = NULL;
      }

      gamemap->replayinfo->map[num] = new MemoryStreamStorage;
      MemoryStream memstream ( gamemap->replayinfo->map[num], tnstream::writing );

      memstream.writeInt( actreplayversion );

      tsavegameloaders sgl;
      sgl.savegame ( &memstream, gamemap, false );

      memstream.writeInt ( actreplayversion );
   } catch ( const ASCexception & ) {
      displaymessage( "error saving replay information", 1 );
   } /* endcatch */
}

GameMap*  loadreplay( MemoryStreamStorage* streambuf )
{
   GameMap* replaymap = NULL;

   try {
      const char* name = "memorystream actmap->replayinfo";
      MemoryStream memstream ( streambuf, tnstream::reading );

      int version = memstream.readInt();
      if (version > actreplayversion || version < minreplayversion )
         throw tinvalidversion ( name, actreplayversion, version );

      tsavegameloaders sgl;
      replaymap = sgl.loadgame ( &memstream );

      version = memstream.readInt();
      if (version > actreplayversion || version < minreplayversion ) {
         delete replaymap;
         throw tinvalidversion ( name, actreplayversion, version );
      }

   } catch ( const InvalidID & err ) {
      displaymessage( err.getMessage().c_str(), 1 );
      replaymap = NULL;
   } /* endcatch */
   catch ( const tinvalidversion & err ) {
      displaymessage( err.getMessage().c_str(), 1 );
      replaymap = NULL;
   } /* endcatch */
   catch ( const tfileerror & err) {
      displaymessage( "error reading map filename %s ", 1, err.getFileName().c_str() );
      replaymap = NULL;
   } /* endcatch */
   catch ( const ASCexception & ) {
      displaymessage( "error loading replay", 1 );
      replaymap = NULL;
   } /* endcatch */

   return replaymap;
}




GameMap* mapLoadingExceptionChecker( const ASCString& filename, MapLoadingFunction loader )
{
   GameMap* m = NULL;
   try {
      m = loader( filename );
   } catch ( const InvalidID & err ) {
      displaymessage( err.getMessage().c_str(), 1 );
      return NULL;
   } /* endcatch */
   catch ( const tinvalidversion & err ) {
      displaymessage( err.getMessage().c_str(), 1 );
      return NULL;
   } /* endcatch */
   catch ( const StreamCompressionError & err ) {
      displaymessage( "The file %s is corrupted.\nPlease obtain a new copy of that file", 1, filename.c_str() );
      return NULL;
   } catch ( const tfileerror & err) {
      displaymessage( "error reading map filename %s ", 1, err.getFileName().c_str() );
      return NULL;
   } /* endcatch */
   catch ( const ASCmsgException & msg ) {
      displaymessage( "error loading file\n" + msg.getMessage() , 1 );
      return NULL;
   } /* endcatch */
   catch ( const ASCexception & ) {
      displaymessage( "error loading file", 1 );
      return NULL;
   } /* endcatch */

   return m;
}









bool validatemapfile ( const ASCString& filename )
{

   char* description = NULL;

   try {

      tnfilestream stream ( filename, tnstream::reading );
      stream.readpchar ( &description, 200 );
      if ( description ) {
         delete[]  description ;
         description = NULL;
      }

      int w = stream.readWord();
      if ( w != fileterminator )
         throw tinvalidversion ( filename, fileterminator, (int) w );

      int version = stream.readInt();

      if (version > actmapversion || version < minmapversion )
         throw tinvalidversion ( filename, actmapversion, version );

   } /* endtry */

   catch ( ... ) {
      return false;
   } /* endcatch */

   return true;
}





bool validateemlfile ( const ASCString& filename )
{
   char* description = NULL;

   try {

      tnfilestream stream ( filename, tnstream::reading );
      stream.readpchar ( &description, 200 );
      if ( description ) {
         delete[]  description ;
         description = NULL;
      }

      int w = stream.readWord();
      if ( w != fileterminator )
         throw tinvalidversion ( filename, fileterminator, (int) w );

      int version = stream.readInt();

      if (version > actnetworkversion || version < minnetworkversion )
         throw tinvalidversion ( filename, actnetworkversion, version );

   } /* endtry */

   catch ( const ASCexception & ) {
      return false;
   } /* endcatch */


   return true;
}


bool validatesavfile ( const ASCString& filename )
{

   char* description = NULL;

   try {

      tnfilestream stream ( filename, tnstream::reading );
      stream.readpchar ( &description, 200 );
      if ( description ) {
         delete[]  description ;
         description = NULL;
      }

      int w = stream.readWord();
      if ( w != fileterminator )
         throw tinvalidversion ( filename, fileterminator, w );

      int version = stream.readInt();
      if (version > actsavegameversion || version < minsavegameversion )
         throw tinvalidversion ( filename, actsavegameversion, version );

   } /* endtry */

   catch ( const ASCexception & ) {
      return false;
   } /* endcatch */

   return true;
}




MapConinuationInfo findNextCampaignMap( int id  )
{
   MapConinuationInfo mi;

   tfindfile ff ( mapextension );

   ASCString filename = ff.getnextname();
   while( !filename.empty() ) {

      try {
         tnfilestream filestream ( filename, tnstream::reading );
         tmaploaders spfldloader;
         spfldloader.stream = &filestream;

         CharBuf description;

         spfldloader.stream->readpchar ( &description.buf );

         int w = spfldloader.stream->readWord();

         if ( w != fileterminator )
            throw tinvalidversion ( filename.c_str(), w, fileterminator );

         int version =  spfldloader.stream->readInt();

         if (version > actmapversion || version < minmapversion )
            throw tinvalidversion ( filename.c_str(), version, actmapversion );

         spfldloader.readmap ();

         if ( spfldloader.spfld->campaign.avail && spfldloader.spfld->campaign.id == id ) {
            mi.title = spfldloader.spfld->maptitle;
            mi.codeword = spfldloader.spfld->codeWord;
            mi.filename = filename;
            return mi;
         }
      } catch ( ... ) {
      } /* endcatch */

      filename = ff.getnextname();
   }

   return mi;
}