1 /* Copyright (C) 2014 Wildfire Games. 2 * This file is part of 0 A.D. 3 * 4 * 0 A.D. is free software: you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License as published by 6 * the Free Software Foundation, either version 2 of the License, or 7 * (at your option) any later version. 8 * 9 * 0 A.D. is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * 14 * You should have received a copy of the GNU General Public License 15 * along with 0 A.D. If not, see <http://www.gnu.org/licenses/>. 16 */ 17 18 #ifndef INCLUDED_ARCHIVEBUILDER 19 #define INCLUDED_ARCHIVEBUILDER 20 21 #include "lib/file/vfs/vfs.h" 22 #include "ps/CStr.h" 23 24 /** 25 * Packages a mod's files into a distributable archive. 26 * This includes various game-specific knowledge on how to convert 27 * and cache certain files into more efficient formats (PNG -> DDS, etc). 28 */ 29 class CArchiveBuilder 30 { 31 public: 32 /** 33 * Initialise the archive builder for processing the given mod. 34 * Assumes no graphics code (especially tex_codec) has been initialised yet. 35 * 36 * @param mod path to data/mods/foo directory, containing files for conversion 37 * @param tempdir path to a writable directory for temporary files 38 */ 39 CArchiveBuilder(const OsPath& mod, const OsPath& tempdir); 40 41 ~CArchiveBuilder(); 42 43 /** 44 * Add a mod which will be loaded but not archived, to provide 45 * files like textures.xml needed for the conversion. 46 * Added mods will be mounted with increasing priority. 47 * Typically this will be called with 'public', when packaging 48 * a user's mod. 49 * @param mod path to data/mods/foo directory, containing files for loading 50 */ 51 void AddBaseMod(const OsPath& mod); 52 53 /** 54 * Do all the processing and packing of files into the archive. 55 * @param archive path of .zip file to generate (will be overwritten if it exists) 56 * @param compress whether to compress the contents of the .zip file 57 */ 58 void Build(const OsPath& archive, bool compress); 59 60 private: 61 static Status CollectFileCB(const VfsPath& pathname, const CFileInfo& fileInfo, const uintptr_t cbData); 62 63 PIVFS m_VFS; 64 std::vector<VfsPath> m_Files; 65 OsPath m_TempDir; 66 size_t m_NumBaseMods; 67 }; 68 69 #endif // INCLUDED_ARCHIVEBUILDER 70