savegame.cpp File Reference

#include "cs_python.h"
#include "cmd/unit_generic.h"
#include "hashtable.h"
#include <float.h>
#include "vsfilesystem.h"
#include <vector>
#include <string>
#include "configxml.h"
#include "vs_globals.h"
#include "savegame.h"
#include "load_mission.h"
#include <algorithm>
#include "cmd/script/mission.h"
#include "gfx/cockpit_generic.h"
#include "networking/const.h"
#include "cmd/fg_util.h"
#include "options.h"

Go to the source code of this file.

Classes
class	MissionStringDat
class	MissionFloatDat

Functions
std::string	GetHelperPlayerSaveGame (int num)
std::string	GetWritePlayerSaveGame (int num)
std::string	GetReadPlayerSaveGame (int num)
void	SaveFileCopy (const char *src, const char *dst)
vector< string >	parsePipedString (string s)
string	createPipedString (vector< string >s)
void	CopySavedShips (std::string filename, int player_num, const std::vector< std::string > &starships, bool load)
void	WriteSaveGame (Cockpit *cp, bool auto_save)
int	hopto (char *buf, char endln, char endln2, int readlen)
template<class MContainerType >
void	RemoveEmpty (MContainerType &t)
std::string	scanInString (char *&buf)
string	AnyStringScanInString (char *&buf)
void	AnyStringSkipInString (char *&buf)
string	AnyStringWriteString (string input)
static void	PushBackUInt (unsigned int i, vector< char > &ret)
static void	PushBackChars (const char *c, vector< char > &ret)
static void	PushBackString (const string &input, vector< char > &ret)
static char *	tmprealloc (char *var, int &oldlength, int newlength)
const string &	GetCurrentSaveGame ()
string	SetCurrentSaveGame (string newname)
const string &	GetSaveDir ()

Variables
vs_options	game_options
std::string	CurrentSaveGameName = ""
bool	STATIC_VARS_DESTROYED
static float	savedcredits = 0

Function Documentation

string AnyStringScanInString

(

char *&

buf)

Definition at line 501 of file savegame.cpp.

References size.

Referenced by SaveGame::ReadSavedPackets().

{
    unsigned int size = 0;
    bool found = false;
    while ( (*buf) && ( (*buf) != ' ' || (!found) ) ) {
        if ( (*buf) >= '0' && (*buf) <= '9' ) {
            size *= 10;
            size += (*buf)-'0';
            found = true;
        }
        buf++;
    }
    if (*buf)
        buf++;
    string ret;
    ret.resize( size );
    unsigned int i = 0;
    while (i < size && *buf)
        ret[i++] = *(buf++);
    return ret;
}

void AnyStringSkipInString

(

char *&

buf)

Definition at line 523 of file savegame.cpp.

References size.

{
    unsigned int size = 0;
    bool found = false;
    while ( (*buf) && ( (*buf) != ' ' || (!found) ) ) {
        if ( (*buf) >= '0' && (*buf) <= '9' ) {
            size *= 10;
            size += (*buf)-'0';
            found = true;
        }
        buf++;
    }
    if (*buf)
        buf++;
    unsigned int i = 0;
    while (i < size && *buf)
        ++i, ++buf;
}

string AnyStringWriteString

(

string

input)

Definition at line 542 of file savegame.cpp.

References XMLSupport::tostring().

Referenced by SaveGame::WriteDynamicUniverse().

{
    return XMLSupport::tostring( (int) input.length() )+" "+input;
}

void CopySavedShips	(	std::string	filename,
		int	player_num,
		const std::vector< std::string > &	starships,
		bool	load
	)

Definition at line 276 of file savegame.cpp.

References VSFileSystem::CreateDirectoryHome(), e, f, GetWritePlayerSaveGame(), VSFileSystem::Ok, VSFileSystem::VSFile::OpenCreateWrite(), VSFileSystem::VSFile::OpenReadOnly(), VSFileSystem::VSFile::ReadFull(), VSFileSystem::savedunitpath, VSFileSystem::UnitFile, VSFileSystem::UnitSaveFile, and VSFileSystem::VSFile::Write().

Referenced by bootstrap_main_loop(), NetClient::startGame(), Cockpit::Update(), and WriteSaveGame().

{
    for (unsigned int i = 0; i < starships.size(); i += 2) {
        if (i == 2) i = 1;
        VSFile src, dst;
        string srcnam = filename;
        string dstnam = GetWritePlayerSaveGame( player_num );
        string tmp;
        if (load) {
            tmp    = srcnam;
            srcnam = dstnam;
            dstnam = tmp;
        }
        VSError e = src.OpenReadOnly( srcnam+"/"+starships[i]+".csv", UnitSaveFile );
        if (e <= Ok) {
            VSFileSystem::CreateDirectoryHome( VSFileSystem::savedunitpath+"/"+dstnam );
            VSError f = dst.OpenCreateWrite( dstnam+"/"+starships[i]+".csv", UnitFile );
            if (f <= Ok) {
                string srcdata = src.ReadFull();
                dst.Write( srcdata );
            } else {
                printf( "Error: Cannot Copy Unit %s from save file %s to %s\n",
                       starships[i].c_str(),
                       srcnam.c_str(),
                       dstnam.c_str() );
            }
        } else {
            printf( "Error: Cannot Open Unit %s from save file %s.\n",
                   starships[i].c_str(),
                   srcnam.c_str() );
        }
    }
}

string createPipedString

(

vector< string >

s)

Definition at line 266 of file savegame.cpp.

Referenced by SaveGame::WritePlayerData().

{
    string ret;
    for (unsigned int i = 0; i < s.size()-1; i++)
        ret += s[i]+"|";
    if ( s.size() )
        ret += s.back();
    return ret;
}

const string& GetCurrentSaveGame

(

)

Definition at line 998 of file savegame.cpp.

References CurrentSaveGameName.

Referenced by UniverseUtil::getCurrentSaveGame().

{
    return CurrentSaveGameName;
}

std::string GetHelperPlayerSaveGame

(

int

num)

Definition at line 32 of file savegame.cpp.

References VSFileSystem::VSFile::Close(), CurrentSaveGameName, f, fprintf, VSFileSystem::VSFile::GetFullPath(), i, Network, vs_options::new_game_save_name, VSFileSystem::Ok, VSFileSystem::VSFile::OpenCreateWrite(), VSFileSystem::VSFile::OpenReadOnly(), VSFileSystem::VSFile::Read(), vs_options::remember_savegame, VSFileSystem::VSFile::Size(), XMLSupport::tostring(), VSFileSystem::UnknownFile, and VSFileSystem::VSFile::Write().

Referenced by GetReadPlayerSaveGame(), and GetWritePlayerSaveGame().

{
    if (Network == NULL) {
        if (CurrentSaveGameName.length() > 0) {
            if (game_options.remember_savegame) {
                VSFile  f;
                VSError err = f.OpenCreateWrite( "save.4.x.txt", UnknownFile );
                if (err <= Ok) {
                    f.Write( CurrentSaveGameName );
                    f.Close();
                }
            }
            if (num != 0)
                return CurrentSaveGameName+XMLSupport::tostring( num );
            return CurrentSaveGameName;
        }
        cout<<"Hi helper play "<<num<<endl;
        static string *res = NULL;
        if (res == NULL) {
            res = new std::string;
            VSFile  f;
            //TRY TO OPEN THE save.4.x.txt FILE WHICH SHOULD CONTAIN THE NAME OF THE SAVE TO USE
            VSError err = f.OpenReadOnly( "save.4.x.txt", UnknownFile ); // DELETE .4.x no longer used
            if (err > Ok) {
                //IF save.4.x.txt DOES NOT EXIST WE CREATE ONE WITH "default" AS SAVENAME
                err = f.OpenCreateWrite( "save.4.x.txt", UnknownFile );
                if (err <= Ok) {
                    f.Write( game_options.new_game_save_name.c_str(), game_options.new_game_save_name.length() );
                    f.Write( "\n", 1 );
                    f.Close();
                } else {
                    fprintf( stderr, "!!! ERROR : Creating default save.4.x.txt file : %s\n", f.GetFullPath().c_str() );
                    exit( 1 );
                }
                err = f.OpenReadOnly( "save.4.x.txt", UnknownFile );
                if (err > Ok) {
                    fprintf( stderr, "!!! ERROR : Opening the default save we just created\n" );
                    exit( 1 );
                }
            }
            if (err <= Ok) {
                long length = f.Size();
                if (length > 0) {
                    char *temp = (char*) malloc( length+1 );
                    temp[length] = '\0';
                    f.Read( temp, length );
                    bool  end  = true;
                    for (int i = length-1; i >= 0; i--) {
                        if (temp[i] == '\r' || temp[i] == '\n')
                            temp[i] = (end ? '\0' : '_');
                        else if (temp[i] == '\0' || temp[i] == ' ' || temp[i] == '\t')
                            temp[i] = (end ? '\0' : '_');
                        else
                            end = false;
                    }
                    *res = (temp);
                    free( temp );
                }
                f.Close();
            }
            if ( game_options.remember_savegame && !res->empty() ) {
                //Set filetype to Unknown so that it is searched in homedir/
                if (*res->begin() == '~') {
                    err = f.OpenCreateWrite( "save.4.x.txt", VSFileSystem::UnknownFile );
                    if (err <= Ok) {
                        for (unsigned int i = 1; i < res->length(); i++) {
                            char cc = *(res->begin()+i);
                            f.Write( &cc, sizeof (char) );
                        }
                        char cc = 0;
                        f.Write( &cc, sizeof (char) );
                        f.Close();
                    }
                }
            }
        }
        if ( num == 0 || res->empty() ) {
            cout<<"Here";
            return *res;
        }
        return (*res)+XMLSupport::tostring( num );
    } else {
        //Return "" so that the filename argument to ParseSavegame will be used
        return "";
    }
}

std::string GetReadPlayerSaveGame

(

int

num)

Definition at line 128 of file savegame.cpp.

References GetHelperPlayerSaveGame().

Referenced by SaveGame::ParseSaveGame().

{
    string ret = GetHelperPlayerSaveGame( num );
    if ( !ret.empty() )
        if (*ret.begin() == '~')
            return "";
    return ret;
}

const string& GetSaveDir

(

)

Definition at line 1010 of file savegame.cpp.

References VSFileSystem::homedir.

Referenced by UniverseUtil::getSaveDir().

{
    static string rv = VSFileSystem::homedir+"/save/";
    return rv;
}

std::string GetWritePlayerSaveGame

(

int

num)

Definition at line 119 of file savegame.cpp.

References GetHelperPlayerSaveGame().

Referenced by CopySavedShips(), SaveGame::WriteSaveGame(), and WriteSaveGame().

{
    string ret = GetHelperPlayerSaveGame( num );
    if ( !ret.empty() )
        if (*ret.begin() == '~')
            return ret.substr( 1, ret.length() );
    return ret;
}

int hopto	(	char *	buf,
		char	endln,
		char	endln2,
		int	readlen
	)

Definition at line 335 of file savegame.cpp.

Referenced by SaveGame::ParseSaveGame(), and SaveGame::ReadSavedPackets().

{
    if (endln == ' ' || endln2 == ' ')
        while (buf[readlen] && buf[readlen] == ' ')
            readlen++;
    for (; buf[readlen] != 0 && buf[readlen] != endln && buf[readlen] != endln2; readlen++)
        ;
    if ( (buf[readlen] && buf[readlen] == endln) || buf[readlen] == endln2 )
        readlen++;
    return readlen;
}

vector< string > parsePipedString

(

string

s)

Definition at line 250 of file savegame.cpp.

Referenced by SaveGame::ParseSaveGame().

{
    string::size_type loc;
    vector< string >  ret;
    while ( ( loc = s.find( "|" ) ) != string::npos ) {
        ret.push_back( s.substr( 0, loc ) );
        cout<<"Found ship named : "<<s.substr( 0, loc )<<endl;
        s = s.substr( loc+1 );
    }
    if ( s.length() ) {
        ret.push_back( s );
        cout<<"Found ship named : "<<s<<endl;
    }
    return ret;
}

static void PushBackChars ( const char *  c, vector< char > &  ret  )

inlinestatic

Definition at line 608 of file savegame.cpp.

Referenced by PushBackString().

{
    int ini = ret.size();
    ret.resize( ret.size()+strlen( c ) );
    while (*c)
        ret[ini++] = *(c++);
}

static void PushBackString ( const string &  input, vector< char > &  ret  )

inlinestatic

Definition at line 616 of file savegame.cpp.

References PushBackChars(), and PushBackUInt().

{
    PushBackUInt( input.length(), ret );
    PushBackChars( " ", ret );
    PushBackChars( input.c_str(), ret );
}

static void PushBackUInt ( unsigned int  i, vector< char > &  ret  )

inlinestatic

Definition at line 591 of file savegame.cpp.

References q.

Referenced by PushBackString().

{
    char tmp[32];
    if (!i) {
        ret.push_back( '0' );
    } else {
        unsigned int p = 0, q = ret.size();
        while (i) {
            tmp[p++] = (i%10+'0');
            i /= 10;
        }
        ret.resize( q+p );
        while (p)
            ret[q++] = tmp[--p];
    }
}

template<class MContainerType >

void RemoveEmpty

(

MContainerType &

t)

Definition at line 417 of file savegame.cpp.

{
    typename MContainerType::iterator i;
    for (i = t.begin(); i != t.end();)
        if ( i->second.empty() )
            t.erase( i++ );

        else
            ++i;
}

void SaveFileCopy	(	const char *	src,
		const char *	dst
	)

Definition at line 138 of file savegame.cpp.

References VSFileSystem::VSFile::Close(), f, fprintf, VSFileSystem::Ok, VSFileSystem::VSFile::OpenCreateWrite(), VSFileSystem::VSFile::OpenReadOnly(), VSFileSystem::VSFile::ReadFull(), VSFileSystem::SaveFile, and VSFileSystem::VSFile::Write().

Referenced by SaveGame::WriteSaveGame().

{
    if (dst[0] != '\0' && src[0] != '\0') {
        VSFile  f;
        VSError err = f.OpenReadOnly( src, SaveFile );
        if (err <= Ok) {
            string savecontent = f.ReadFull();
            f.Close();
            err = f.OpenCreateWrite( dst, SaveFile );
            if (err <= Ok) {
                f.Write( savecontent );
                f.Close();
            } else {
                fprintf( stderr, "WARNING : couldn't open savegame to copy to : %s as SaveFile", dst );
            }
        } else {
            fprintf( stderr, "WARNING : couldn't find the savegame to copy : %s as SaveFile", src );
        }
    }
}

std::string scanInString

(

char *&

buf)

Definition at line 448 of file savegame.cpp.

References start.

{
    std::string str;
    while ( *buf && isspace( *buf ) )
        buf++;
    char *start = buf;
    while ( *buf && ( !isspace( *buf ) ) )
        buf++;
    str.resize(buf - start);
    for (size_t i=0; start < buf; ++i)
        str[i] = *(start++);
    return str;
}

string SetCurrentSaveGame

(

string

newname)

Definition at line 1003 of file savegame.cpp.

References CurrentSaveGameName.

Referenced by UniverseUtil::setCurrentSaveGame().

{
    string oldname = CurrentSaveGameName;
    CurrentSaveGameName = newname;
    return oldname;
}

static char* tmprealloc ( char *  var, int &  oldlength, int  newlength  )

static

Definition at line 730 of file savegame.cpp.

Referenced by SaveGame::WriteDynamicUniverse(), and SaveGame::WritePlayerData().

{
    if (oldlength < newlength) {
        oldlength = newlength;
        var = (char*) realloc( var, newlength );
    }
    memset( var, 0, newlength );
    return var;
}

void WriteSaveGame	(	Cockpit *	cp,
		bool	auto_save
	)

Definition at line 310 of file savegame.cpp.

References _Universe, Universe::AccessCockpit(), Cockpit::activeStarSystem, CopySavedShips(), Cockpit::credits, StarSystem::getFileName(), Unit::GetHull(), Cockpit::GetSaveParent(), Cockpit::GetUnitModifications(), GetWritePlayerSaveGame(), Unit::LocalPosition(), Universe::numPlayers(), Cockpit::PackUnitInfo(), Cockpit::savegame, SaveGame::SetPlayerLocation(), SaveGame::SetSavedCredits(), SaveGame::SetStarSystem(), SaveGame::WriteSaveGame(), and Unit::WriteUnit().

Referenced by BaseComputer::actionConfirmedSaveGame(), bootstrap_main_loop(), buyShip(), and UniverseUtil::saveGame().

{
    int player_num = 0;
    for (unsigned int kk = 0; kk < _Universe->numPlayers(); ++kk)
        if (_Universe->AccessCockpit( kk ) == cp)
            player_num = kk;
    Unit *un = cp->GetSaveParent();
    if (!un)
        return;
    if (un->GetHull() > 0) {
        vector< string > packedInfo;
        cp->PackUnitInfo(packedInfo);
        
        cp->savegame->WriteSaveGame( cp->activeStarSystem->getFileName().c_str(),
                                     un->LocalPosition(), cp->credits, packedInfo, auto_save ? -1 : player_num );
        un->WriteUnit( cp->GetUnitModifications().c_str() );
        if (GetWritePlayerSaveGame( player_num ).length() && !auto_save) {
            cp->savegame->SetSavedCredits( _Universe->AccessCockpit()->credits );
            cp->savegame->SetStarSystem( cp->activeStarSystem->getFileName() );
            cp->savegame->SetPlayerLocation( un->LocalPosition() );
            CopySavedShips( cp->GetUnitModifications(), player_num, packedInfo, false );
        }
    }
}

Variable Documentation

std::string CurrentSaveGameName = ""

Definition at line 31 of file savegame.cpp.

Referenced by buyShip(), GetCurrentSaveGame(), GetHelperPlayerSaveGame(), and SetCurrentSaveGame().

vs_options game_options

Draws cockpit parts Draws gauges, info strings, radar, ...

Definition at line 83 of file main.cpp.

float savedcredits = 0

static

Definition at line 855 of file savegame.cpp.

Referenced by SaveGame::GetSavedCredits(), and SaveGame::SetSavedCredits().

bool STATIC_VARS_DESTROYED

Definition at line 21 of file vs_globals.cpp.

Referenced by cleanup(), and SaveGame::WriteDynamicUniverse().