types.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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 (at your option) any later version.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef AURORA_TYPES_H
#define AURORA_TYPES_H

#include <vector>

#include "src/common/types.h"

namespace Aurora {

enum FileType {
    kFileTypeNone           = -   1,
    kFileTypeRES            =     0, 
    kFileTypeBMP            =     1, 
    kFileTypeMVE            =     2, 
    kFileTypeTGA            =     3, 
    kFileTypeWAV            =     4, 
    kFileTypePLT            =     6, 
    kFileTypeINI            =     7, 
    kFileTypeBMU            =     8, 
    kFileTypeMPG            =     9, 
    kFileTypeTXT            =    10, 
    kFileTypeWMA            =    11, 
    kFileTypeWMV            =    12, 
    kFileTypeXMV            =    13, 
    kFileTypePLH            =  2000,
    kFileTypeTEX            =  2001, 
    kFileTypeMDL            =  2002, 
    kFileTypeTHG            =  2003,
    kFileTypeFNT            =  2005, 
    kFileTypeLUA            =  2007, 
    kFileTypeSLT            =  2008,
    kFileTypeNSS            =  2009, 
    kFileTypeNCS            =  2010, 
    kFileTypeMOD            =  2011, 
    kFileTypeARE            =  2012, 
    kFileTypeSET            =  2013, 
    kFileTypeIFO            =  2014, 
    kFileTypeBIC            =  2015, 
    kFileTypeWOK            =  2016, 
    kFileType2DA            =  2017, 
    kFileTypeTLK            =  2018, 
    kFileTypeTXI            =  2022, 
    kFileTypeGIT            =  2023, 
    kFileTypeBTI            =  2024, 
    kFileTypeUTI            =  2025, 
    kFileTypeBTC            =  2026, 
    kFileTypeUTC            =  2027, 
    kFileTypeDLG            =  2029, 
    kFileTypeITP            =  2030, 
    kFileTypeBTT            =  2031, 
    kFileTypeUTT            =  2032, 
    kFileTypeDDS            =  2033, 
    kFileTypeBTS            =  2034, 
    kFileTypeUTS            =  2035, 
    kFileTypeLTR            =  2036, 
    kFileTypeGFF            =  2037, 
    kFileTypeFAC            =  2038, 
    kFileTypeBTE            =  2039, 
    kFileTypeUTE            =  2040, 
    kFileTypeBTD            =  2041, 
    kFileTypeUTD            =  2042, 
    kFileTypeBTP            =  2043, 
    kFileTypeUTP            =  2044, 
    kFileTypeDFT            =  2045, 
    kFileTypeDTF            =  2045, 
    kFileTypeGIC            =  2046, 
    kFileTypeGUI            =  2047, 
    kFileTypeCSS            =  2048, 
    kFileTypeCCS            =  2049, 
    kFileTypeBTM            =  2050, 
    kFileTypeUTM            =  2051, 
    kFileTypeDWK            =  2052, 
    kFileTypePWK            =  2053, 
    kFileTypeBTG            =  2054, 
    kFileTypeUTG            =  2055, 
    kFileTypeJRL            =  2056, 
    kFileTypeSAV            =  2057, 
    kFileTypeUTW            =  2058, 
    kFileType4PC            =  2059, 
    kFileTypeSSF            =  2060, 
    kFileTypeHAK            =  2061, 
    kFileTypeNWM            =  2062, 
    kFileTypeBIK            =  2063, 
    kFileTypeNDB            =  2064, 
    kFileTypePTM            =  2065, 
    kFileTypePTT            =  2066, 
    kFileTypeNCM            =  2067,
    kFileTypeMFX            =  2068,
    kFileTypeMAT            =  2069, 
    kFileTypeMDB            =  2070, 
    kFileTypeSAY            =  2071,
    kFileTypeTTF            =  2072, 
    kFileTypeTTC            =  2073,
    kFileTypeCUT            =  2074, 
    kFileTypeKA             =  2075, 
    kFileTypeJPG            =  2076, 
    kFileTypeICO            =  2077, 
    kFileTypeOGG            =  2078, 
    kFileTypeSPT            =  2079, 
    kFileTypeSPW            =  2080,
    kFileTypeWFX            =  2081, 
    kFileTypeUGM            =  2082,
    kFileTypeQDB            =  2083, 
    kFileTypeQST            =  2084, 
    kFileTypeNPC            =  2085,
    kFileTypeSPN            =  2086,
    kFileTypeUTX            =  2087,
    kFileTypeMMD            =  2088,
    kFileTypeSMM            =  2089,
    kFileTypeUTA            =  2090,
    kFileTypeMDE            =  2091,
    kFileTypeMDV            =  2092,
    kFileTypeMDA            =  2093,
    kFileTypeMBA            =  2094,
    kFileTypeOCT            =  2095,
    kFileTypeBFX            =  2096,
    kFileTypePDB            =  2097,
    kFileTypeTheWitcherSave =  2098, 
    kFileTypePVS            =  2099,
    kFileTypeCFX            =  2100,
    kFileTypeLUC            =  2101, 
    kFileTypePRB            =  2103,
    kFileTypeCAM            =  2104, 
    kFileTypeVDS            =  2105,
    kFileTypeBIN            =  2106,
    kFileTypeWOB            =  2107,
    kFileTypeAPI            =  2108,
    kFileTypeProperties     =  2109,
    kFileTypePNG            =  2110, 
    kFileTypeLYT            =  3000, 
    kFileTypeVIS            =  3001, 
    kFileTypeRIM            =  3002, 
    kFileTypePTH            =  3003, 
    kFileTypeLIP            =  3004, 
    kFileTypeBWM            =  3005,
    kFileTypeTXB            =  3006, 
    kFileTypeTPC            =  3007, 
    kFileTypeMDX            =  3008, 
    kFileTypeRSV            =  3009,
    kFileTypeSIG            =  3010,
    kFileTypeMAB            =  3011, 
    kFileTypeQST2           =  3012, 
    kFileTypeSTO            =  3013, 
    kFileTypeHEX            =  3015, 
    kFileTypeMDX2           =  3016, 
    kFileTypeTXB2           =  3017, 
    kFileTypeFSM            =  3022, 
    kFileTypeART            =  3023, 
    kFileTypeAMP            =  3024, 
    kFileTypeCWA            =  3025, 
    kFileTypeBIP            =  3028, 
    kFileTypeMDB2           =  4000,
    kFileTypeMDA2           =  4001,
    kFileTypeSPT2           =  4002,
    kFileTypeGR2            =  4003,
    kFileTypeFXA            =  4004,
    kFileTypeFXE            =  4005,
    kFileTypeJPG2           =  4007,
    kFileTypePWC            =  4008,
    kFileType1DA            =  9996, 
    kFileTypeERF            =  9997, 
    kFileTypeBIF            =  9998, 
    kFileTypeKEY            =  9999, 

    kFileTypeMAXArchive,

    /* --- Entries for files not found in archives with numerical type IDs --- */

    // Found in NWN
    kFileTypeEXE            = 19000, 
    kFileTypeDBF            = 19001, 
    kFileTypeCDX            = 19002, 
    kFileTypeFPT            = 19003, 

    // Found in NWN2's ZIP files
    kFileTypeZIP            = 20000, 
    kFileTypeFXM            = 20001, 
    kFileTypeFXS            = 20002, 
    kFileTypeXML            = 20003, 
    kFileTypeWLK            = 20004, 
    kFileTypeUTR            = 20005, 
    kFileTypeSEF            = 20006, 
    kFileTypePFX            = 20007, 
    kFileTypeTFX            = 20008, 
    kFileTypeIFX            = 20009,
    kFileTypeLFX            = 20010, 
    kFileTypeBBX            = 20011, 
    kFileTypePFB            = 20012, 
    kFileTypeUPE            = 20013,
    kFileTypeUSC            = 20014,
    kFileTypeULT            = 20015, 
    kFileTypeFX             = 20016,
    kFileTypeMAX            = 20017,
    kFileTypeDOC            = 20018,
    kFileTypeSCC            = 20019,
    kFileTypeWMP            = 20020, 
    kFileTypeOSC            = 20021,
    kFileTypeTRN            = 20022,
    kFileTypeUEN            = 20023,
    kFileTypeROS            = 20024,
    kFileTypeRST            = 20025,
    kFileTypePTX            = 20026,
    kFileTypeLTX            = 20027,
    kFileTypeTRX            = 20028,

    // Found in Sonic Chronicles: The Dark Brotherhood
    kFileTypeNDS            = 21000, 
    kFileTypeHERF           = 21001, 
    kFileTypeDICT           = 21002, 
    kFileTypeSMALL          = 21003, 
    kFileTypeCBGT           = 21004,
    kFileTypeCDPTH          = 21005,
    kFileTypeEMIT           = 21006,
    kFileTypeITM            = 21007, 
    kFileTypeNANR           = 21008, 
    kFileTypeNBFP           = 21009, 
    kFileTypeNBFS           = 21010, 
    kFileTypeNCER           = 21011, 
    kFileTypeNCGR           = 21012, 
    kFileTypeNCLR           = 21013, 
    kFileTypeNFTR           = 21014, 
    kFileTypeNSBCA          = 21015, 
    kFileTypeNSBMD          = 21016, 
    kFileTypeNSBTA          = 21017, 
    kFileTypeNSBTP          = 21018, 
    kFileTypeNSBTX          = 21019, 
    kFileTypePAL            = 21020, 
    kFileTypeRAW            = 21021, 
    kFileTypeSADL           = 21022,
    kFileTypeSDAT           = 21023, 
    kFileTypeSMP            = 21024,
    kFileTypeSPL            = 21025, 
    kFileTypeVX             = 21026, 

    // Found in Dragon Age: Origins
    kFileTypeANB            = 22000, 
    kFileTypeANI            = 22001, 
    kFileTypeCNS            = 22002, 
    kFileTypeCUR            = 22003, 
    kFileTypeEVT            = 22004, 
    kFileTypeFDL            = 22005,
    kFileTypeFXO            = 22006,
    kFileTypeGAD            = 22007, 
    kFileTypeGDA            = 22008, 
    kFileTypeGFX            = 22009, 
    kFileTypeLDF            = 22010, 
    kFileTypeLST            = 22011, 
    kFileTypeMAL            = 22012, 
    kFileTypeMAO            = 22013, 
    kFileTypeMMH            = 22014, 
    kFileTypeMOP            = 22015,
    kFileTypeMOR            = 22016, 
    kFileTypeMSH            = 22017, 
    kFileTypeMTX            = 22018,
    kFileTypeNCC            = 22019, 
    kFileTypePHY            = 22020, 
    kFileTypePLO            = 22021, 
    kFileTypeSTG            = 22022, 
    kFileTypeTBI            = 22023,
    kFileTypeTNT            = 22024, 
    kFileTypeARL            = 22025, 
    kFileTypeFEV            = 22026, 
    kFileTypeFSB            = 22027, 
    kFileTypeOPF            = 22028,
    kFileTypeCRF            = 22029,
    kFileTypeRIMP           = 22030,
    kFileTypeMET            = 22031, 
    kFileTypeMETA           = 22032, 
    kFileTypeFXR            = 22033, 
    kFileTypeFXT            = 22033, 
    kFileTypeCIF            = 22034, 
    kFileTypeCUB            = 22035,
    kFileTypeDLB            = 22036,
    kFileTypeNSC            = 22037, 

    // Found in KotOR Mac
    kFileTypeMOV            = 23000, 
    kFileTypeCURS           = 23001, 
    kFileTypePICT           = 23002, 
    kFileTypeRSRC           = 23003, 
    kFileTypePLIST          = 23004, 

    // Found Jade Empire
    kFileTypeCRE            = 24000, 
    kFileTypePSO            = 24001, 
    kFileTypeVSO            = 24002, 
    kFileTypeABC            = 24003, 
    kFileTypeSBM            = 24004, 
    kFileTypePVD            = 24005,
    kFileTypePLA            = 24006, 
    kFileTypeTRG            = 24007, 
    kFileTypePK             = 24008,

    // Found in Dragon Age II
    kFileTypeALS            = 25000,
    kFileTypeAPL            = 25001,
    kFileTypeAssembly       = 25002,
    kFileTypeBAK            = 25003,
    kFileTypeBNK            = 25004,
    kFileTypeCL             = 25005,
    kFileTypeCNV            = 25006,
    kFileTypeCON            = 25007,
    kFileTypeDAT            = 25008,
    kFileTypeDX11           = 25009,
    kFileTypeIDS            = 25010,
    kFileTypeLOG            = 25011,
    kFileTypeMAP            = 25012,
    kFileTypeMML            = 25013,
    kFileTypeMP3            = 25014,
    kFileTypePCK            = 25015,
    kFileTypeRML            = 25016,
    kFileTypeS              = 25017,
    kFileTypeSTA            = 25018,
    kFileTypeSVR            = 25019,
    kFileTypeVLM            = 25020,
    kFileTypeWBD            = 25021,
    kFileTypeXBX            = 25022,
    kFileTypeXLS            = 25023,

    // Found in the iOS version of Knights of the Old Republic
    kFileTypeBZF            = 26000, 

    // Found in The Witcher
    kFileTypeADV            = 27000, 

    // Found in the Android version of Jade Empire
    kFileTypeJSON           = 28000, 
    kFileTypeTLK_EXPERT     = 28001, 
    kFileTypeTLK_MOBILE     = 28002, 
    kFileTypeTLK_TOUCH      = 28003, 
    kFileTypeOTF            = 28004, 
    kFileTypePAR            = 28005,

    // Found in the Xbox version of Jade Empire
    kFileTypeXWB            = 29000, 
    kFileTypeXSB            = 29001, 

    // Found in the Xbox version of Dragon Age: Origins
    kFileTypeXDS            = 30000, 
    kFileTypeWND            = 30001,

    // Our own types
    kFileTypeXEOSITEX       = 40000  
};

enum GameID {
    kGameIDUnknown    = -1, 
    kGameIDNWN        =  0, 
    kGameIDNWN2       =  1, 
    kGameIDKotOR      =  2, 
    kGameIDKotOR2     =  3, 
    kGameIDJade       =  4, 
    kGameIDWitcher    =  5, 
    kGameIDSonic      =  6, 
    kGameIDDragonAge  =  7, 
    kGameIDDragonAge2 =  8, 
    kGameIDMAX
};

enum ResourceType {
    kResourceImage,  
    kResourceVideo,  
    kResourceSound,  
    kResourceMusic,  
    kResourceCursor, 
    kResourceMAX
};

enum ArchiveType {
    kArchiveKEY = 0, 
    kArchiveBIF,     
    kArchiveERF,     
    kArchiveRIM,     
    kArchiveZIP,     
    kArchiveEXE,     
    kArchiveNDS,     
    kArchiveHERF,    
    kArchiveNSBTX,   
    kArchiveMAX
};

enum Platform {
    kPlatformWindows = 0, 
    kPlatformMacOSX,      
    kPlatformLinux,       
    kPlatformXbox,        
    kPlatformXbox360,     
    kPlatformPS3,         
    kPlatformNDS,         
    kPlatformAndroid,     
    kPlatformIOS,         
    kPlatformUnknown      
};

static const uint32 kObjectIDInvalid = 0xFFFFFFFF;
static const uint32 kFieldIDInvalid  = 0xFFFFFFFF;
static const uint32 kStrRefInvalid   = 0xFFFFFFFF;

class TwoDAFile;
class TwoDARow;

class GFF3Struct;
typedef std::vector<const GFF3Struct *> GFF3List;
class GFF3File;

class GFF4Struct;
typedef std::vector<const GFF4Struct *> GFF4List;
class GFF4File;

} // End of namespace Aurora

#endif // AURORA_TYPES_H