file_formats.h

Go to the documentation of this file.

/*
 * Platformer Game Engine by Wohlstand, a free platform for game making
 * Copyright (c) 2014-2015 Vitaly Novichkov <admin@wohlnet.ru>
 *
 * 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 3 of the License, or
 * 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef FILE_FORMATS_H
#define FILE_FORMATS_H

#include "pge_file_lib_globs.h"
#include "lvl_filedata.h"
#include "npc_filedata.h"
#include "wld_filedata.h"
#include "save_filedata.h"
#include "smbx64_cnf_filedata.h"

#ifdef PGE_FILES_QT
class FileFormats: PGE_FILES_INHERED
{
    Q_OBJECT
#else
class FileFormats
{
#endif

public:

//File format read/write functions
    static MetaData         ReadNonSMBX64MetaData(PGESTRING RawData);

    static PGESTRING        WriteNonSMBX64MetaData(MetaData metaData);

/******************************Level files***********************************/
    static LevelData        OpenLevelFile(PGESTRING filePath);
    static LevelData        OpenLevelFileHeader(PGESTRING filePath);

// SMBX64 LVL File
    static LevelData        ReadSMBX64LvlFileHeader(PGESTRING filePath);
    static LevelData        ReadSMBX64LvlFile(PGESTRING RawData, PGESTRING filePath="");
    static PGESTRING        WriteSMBX64LvlFile(LevelData FileData, int file_format=64);  



// PGE Extended Level File
    static LevelData        ReadExtendedLvlFileHeader(PGESTRING filePath);

    static LevelData        ReadExtendedLvlFile(PGESTRING RawData, PGESTRING filePath="");

    static PGESTRING        WriteExtendedLvlFile(LevelData FileData);  

// Lvl Data
    static LevelData        CreateLevelData();
    static LevelNPC         CreateLvlNpc();
    static LevelDoor        CreateLvlWarp();
    static LevelBlock       CreateLvlBlock();
    static LevelBGO         CreateLvlBgo();
    static LevelPhysEnv     CreateLvlPhysEnv();
    static LevelLayer       CreateLvlLayer();
    static LevelSMBX64Event CreateLvlEvent();
    static PlayerPoint      CreateLvlPlayerPoint(int id=0);
    static LevelSection     CreateLvlSection();

    static void             smbx64LevelPrepare(LevelData &lvl);

    static void             smbx64LevelSortBlocks(LevelData &lvl);

    static void             smbx64LevelSortBGOs(LevelData &lvl);


/******************************World file***********************************/
    static WorldData        OpenWorldFile(PGESTRING filePath);
    static WorldData        OpenWorldFileHeader(PGESTRING filePath);

// SMBX64 WLD File
    static WorldData        ReadSMBX64WldFileHeader(PGESTRING filePath);
    static WorldData        ReadSMBX64WldFile(PGESTRING RawData, PGESTRING filePath);
    static PGESTRING        WriteSMBX64WldFile(WorldData FileData, int file_format=64);

// PGE Extended World map File
    static WorldData        ReadExtendedWldFileHeader(PGESTRING filePath);
    static WorldData        ReadExtendedWldFile(PGESTRING RawData, PGESTRING filePath);
    static PGESTRING        WriteExtendedWldFile(WorldData FileData);

//Wld Data
    static WorldData        CreateWorldData();
    static WorldTiles       CreateWldTile();
    static WorldScenery     CreateWldScenery();
    static WorldPaths       CreateWldPath();
    static WorldLevels      CreateWldLevel();
    static WorldMusic       CreateWldMusicbox();


/****************************Save of game file********************************/
    static GamesaveData     ReadSMBX64SavFile(PGESTRING RawData, PGESTRING filePath);

    static GamesaveData     ReadExtendedSaveFile(PGESTRING RawData, PGESTRING filePath);
    static PGESTRING        WriteExtendedSaveFile(GamesaveData &FileData);

//Save Data
    static GamesaveData     CreateGameSaveData();
    static saveCharState    CreateSavCharacterState();

/****************************SMBX64 Config file********************************/
    static SMBX64_ConfigFile ReadSMBX64ConfigFile(PGESTRING RawData);
    static PGESTRING        WriteSMBX64ConfigFile(SMBX64_ConfigFile &FileData, int file_format);

/******************************NPC.txt file***********************************/
// SMBX64 NPC.TXT File
    static NPCConfigFile    ReadNpcTXTFile(PGESTRING file, bool IgnoreBad=false);
    static PGESTRING        WriteNPCTxtFile(NPCConfigFile FileData);

    static NPCConfigFile    CreateEmpytNpcTXT();

/******************************common stuff***********************************/
    enum ErrorCodes{
        Success=0,
        ERROR_NotExist,
        ERROR_AccessDenied,
        ERROR_InvalidSyntax,
        ERROR_PGEX_SectionNotClosed,
        ERROR_PGEX_InvalidSyntax,
        ERROR_PGEX_InvalidDataType
    };
    static PGESTRING        getErrorString(ErrorCodes errCode);

    enum SMBX64_violations {
        SMBX64_FINE             = 0x000,
        SMBX64EXC_SECTIONS      = 0x001,
        SMBX64EXC_BLOCKS        = 0x002,
        SMBX64EXC_BGOS          = 0x004,
        SMBX64EXC_NPCS          = 0x008,
        SMBX64EXC_WATERBOXES    = 0x010,
        SMBX64EXC_WARPS         = 0x020,
        SMBX64EXC_LAYERS        = 0x040,
        SMBX64EXC_EVENTS        = 0x080,
        SMBX64EXC_TILES         = 0x100,
        SMBX64EXC_SCENERIES     = 0x200,
        SMBX64EXC_PATHS         = 0x400,
        SMBX64EXC_LEVELS        = 0x800,
        SMBX64EXC_MUSICBOXES    = 0x1000
    };

//Check SMBX64 limits
    static int              smbx64LevelCheckLimits(LevelData &lvl);
    static int              smbx64WorldCheckLimits(WorldData &wld);

/******************************Internal stuff***********************************/
    static PGESTRING        removeQuotes(PGESTRING str);
    static PGESTRING        errorString;
};

#endif // FILE_FORMATS_H