cp_save.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2020 UFO: Alien Invasion.

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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

#pragma once

#include <zlib.h>
#include "../../../common/msg.h"
#include "../../../common/xml.h"


#define MAX_SAVESUBSYSTEMS 32
#define SAVE_FILE_VERSION 4
#define SAVEGAME_EXTENSION "savx"

typedef struct saveFileHeader_s {
    uint32_t version;       
    uint32_t compressed;        
    uint32_t subsystems;        
    uint32_t dummy[13];     
    char gameVersion[16];       
    char name[32];          
    char gameDate[32];      
    char realDate[32];      
    uint32_t xmlSize;
} saveFileHeader_t;

typedef struct saveSubsystems_s {
    const char* name;
    bool (*save) (xmlNode_t* parent);   
    bool (*load) (xmlNode_t* parent);   
} saveSubsystems_t;

#define FOREACH_XMLNODE(var, node, name) \
    for (xmlNode_t* var = cgi->XML_GetNode((node), name); var; var = cgi->XML_GetNextNode(var, node, name))

void SAV_Init(void);
bool SAV_AddSubsystem(saveSubsystems_t* subsystem);

/* and now the save and load prototypes for every subsystem */
bool B_SaveXML(xmlNode_t* parent);
bool B_LoadXML(xmlNode_t* parent);
bool CP_SaveXML(xmlNode_t* parent);
bool CP_LoadXML(xmlNode_t* parent);
bool HOS_LoadXML(xmlNode_t* parent);
bool HOS_SaveXML(xmlNode_t* parent);
bool BS_SaveXML(xmlNode_t* parent);
bool BS_LoadXML(xmlNode_t* parent);
bool AIR_SaveXML(xmlNode_t* parent);
bool AIR_LoadXML(xmlNode_t* parent);
bool AC_LoadXML(xmlNode_t* parent);
bool E_SaveXML(xmlNode_t* parent);
bool E_LoadXML(xmlNode_t* parent);
bool RS_SaveXML(xmlNode_t* parent);
bool RS_LoadXML(xmlNode_t* parent);
bool PR_SaveXML(xmlNode_t* parent);
bool PR_LoadXML(xmlNode_t* parent);
bool MS_SaveXML(xmlNode_t* parent);
bool MS_LoadXML(xmlNode_t* parent);
bool STATS_SaveXML(xmlNode_t* parent);
bool STATS_LoadXML(xmlNode_t* parent);
bool NAT_SaveXML(xmlNode_t* parent);
bool NAT_LoadXML(xmlNode_t* parent);
bool TR_SaveXML(xmlNode_t* parent);
bool TR_LoadXML(xmlNode_t* parent);
bool AB_SaveXML(xmlNode_t* parent);
bool AB_LoadXML(xmlNode_t* parent);
bool XVI_SaveXML(xmlNode_t* parent);
bool XVI_LoadXML(xmlNode_t* parent);
bool INS_SaveXML(xmlNode_t* parent);
bool INS_LoadXML(xmlNode_t* parent);
bool MSO_SaveXML(xmlNode_t* parent);
bool MSO_LoadXML(xmlNode_t* parent);
bool US_SaveXML(xmlNode_t* parent);
bool US_LoadXML(xmlNode_t* parent);
bool MIS_LoadXML(xmlNode_t* parent);
bool MIS_SaveXML(xmlNode_t* parent);
bool INT_SaveXML(xmlNode_t* parent);
bool INT_LoadXML(xmlNode_t* parent);

bool B_PostLoadInit(void);
bool AIR_PostLoadInit(void);
bool PR_PostLoadInit(void);

bool SAV_LoadHeader(const char* filename, saveFileHeader_t* header);
bool SAV_GameLoad(const char* file, const char** error);
bool SAV_GameSaveAllowed(char** error);
bool SAV_GameSave(const char* filename, const char* comment, char** error);