ryzom/tools/make_alias_file/make_alias_file.cpp

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program 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 Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19
  20
  21 // misc
  22 #include "nel/misc/types_nl.h"
  23 #include "nel/misc/sheet_id.h"
  24 #include "nel/misc/config_file.h"
  25
  26 #include "nel/georges/u_form.h"
  27 #include "nel/georges/u_form_elm.h"
  28 #include "nel/georges/load_form.h"
  29
  30 // std
  31 #include <string>
  32 #include <vector>
  33
  34
  35 #include <iostream>
  36
  37
  38
  39 using namespace NLMISC;
  40 using namespace std;
  41
  42
  43
  44
  45 /**
  46  * Class to manage a sheet.
  47  * \author Stephane Coutelas
  48  * \author Nevrax France
  49  * \date 2003
  50  */
  51 class CSheet
  52 {
  53
  54 public:
  55
  56         /// Alias
  57         string Alias;
  58
  59 public:
  60
  61         /// Constructor
  62         CSheet() {}
  63
  64         /// Load the values using the george sheet
  65         void readGeorges (const CSmartPtr<NLGEORGES::UForm> &form, const CSheetId &sheetId);
  66
  67         /// Load/Save the values using the serial system
  68         void serial (NLMISC::IStream &s);
  69
  70         /**
  71          * Event to implement any action when the sheet is no longer existent.
  72          * This method is called when a sheet have been read from the packed sheet
  73          * and the associated sheet file no more exist in the directories.
  74          */
  75         void removed() {}
  76
  77         static uint getVersion();
  78
  79 private :
  80
  81         static const uint _Version;
  82 };
  83
  84 uint const CSheet::_Version = 1;
  85
  86
  87
  88 //-----------------------------------------------
  89 //      readGeorges
  90 //
  91 //-----------------------------------------------
  92 void CSheet::readGeorges (const CSmartPtr<NLGEORGES::UForm> &form, const CSheetId &sheetId)
  93 {
  94         // Load the form with given sheet id
  95         if (form)
  96         {
  97                 if( !form->getRootNode().getValueByName(Alias, "Alias", NLGEORGES::UFormElm::NoEval) )
  98                 {
  99
 100                 }
 101         }
 102 }
 103
 104
 105 //-----------------------------------------------
 106 //      serial
 107 //
 108 //-----------------------------------------------
 109 void CSheet::serial (NLMISC::IStream &s)
 110 {
 111         s.serial( Alias );
 112 }
 113
 114
 115
 116 //-----------------------------------------------
 117 //      getVersion
 118 //
 119 //-----------------------------------------------
 120 uint CSheet::getVersion ()
 121 {
 122         //return CSheetManager::_AliasFilenameVersion;
 123         return 1;
 124 }
 125
 126
 127
 128
 129 //-----------------------------------------------
 130 //      displayHelp
 131 //
 132 //-----------------------------------------------
 133 void displayHelp()
 134 {
 135         cout<<"This tool creates a packed file which associates sheet id with sheet alias"<<endl;
 136         cout<<"Vars used in make_alias_file.cfg :"<<endl;
 137         cout<<"  - SheetPaths : the paths where to find the sheets"<<endl;
 138         cout<<"  - AliasFilename : name used for alias file (default is 'alias.packed_sheets')"<<endl;
 139         cout<<"  - Extensions : the extensions list of sheets to read"<<endl;
 140         cout<<endl;
 141         cout<<"MAKE_ALIAS_FILE"<<endl;
 142
 143 } // displayHelp //
 144
 145
 146
 147
 148
 149
 150 //-----------------------------------------------
 151 //      MAIN
 152 //
 153 //-----------------------------------------------
 154 int main( int argc, char ** argv )
 155 {
 156         // get the output filename
 157         if( argc > 1 )
 158         {
 159                 displayHelp();
 160                 return EXIT_FAILURE;
 161         }
 162
 163         // load the cfg
 164         CConfigFile configFile;
 165         string configFileName = "make_alias_file.cfg";
 166         if(!CFile::fileExists(configFileName))
 167         {
 168                 nlwarning("Config file %s not found",configFileName.c_str());
 169                 return 1;
 170         }
 171         configFile.load(configFileName);
 172
 173
 174         // read the sheet paths
 175         vector<string> sheetPaths;
 176         try
 177         {
 178                 CConfigFile::CVar& cvSheetPaths = configFile.getVar("SheetPaths");
 179                 sint i;
 180                 for( i = 0; i< (sint)cvSheetPaths.size(); ++i)
 181                 {
 182                         sheetPaths.push_back(NLMISC::expandEnvironmentVariables(cvSheetPaths.asString(i)));
 183                 }
 184         }
 185         catch(const EUnknownVar &)
 186         {
 187                 nlwarning("var 'SheetPaths' not found");
 188         }
 189
 190         // add the sheet paths
 191         cout<<"adding the sheet paths ..."<<endl;
 192         vector<string>::iterator itPath;
 193         for( itPath = sheetPaths.begin(); itPath != sheetPaths.end(); ++itPath )
 194         {
 195                 CPath::addSearchPath(*itPath,true,false);
 196         }
 197
 198         // read the name that will be used for packed file
 199         string aliasFilename = "alias.packed_sheets";
 200         try
 201         {
 202                 CConfigFile::CVar &cvAliasFilename = configFile.getVar("AliasFilename");
 203                 aliasFilename = cvAliasFilename.asString();
 204         }
 205         catch(const EUnknownVar &)
 206         {
 207                 nlwarning("var 'AliasFilename' not found");
 208         }
 209
 210         // read the extensions list of sheets to read
 211         vector<string> extensions;
 212         try
 213         {
 214                 CConfigFile::CVar& cvExtensions = configFile.getVar("Extensions");
 215                 sint i;
 216                 for( i = 0; i< (sint)cvExtensions.size(); ++i)
 217                 {
 218                         extensions.push_back( cvExtensions.asString(i) );
 219                 }
 220         }
 221         catch(const EUnknownVar &)
 222         {
 223                 nlwarning("var 'Extensions' not found");
 224         }
 225
 226         // load form and create packed sheets
 227         cout<<"reading the sheets ..."<<endl;
 228         map<CSheetId, CSheet> sheetMap;
 229         bool updatePackedSheet = true;
 230         createDebug(); // needed to init WarningLog
 231         loadForm (extensions, aliasFilename, sheetMap, updatePackedSheet);
 232         cout<<"finished."<<endl;
 233
 234         // display the content of the map
 235         /*
 236         map<CSheetId, CSheet>::iterator itAlias;
 237         for( itAlias = sheetMap.begin(); itAlias != sheetMap.end(); ++itAlias )
 238         {
 239                 nlinfo("sheet %s  alias = %s",(*itAlias).first.toString().c_str(),(*itAlias).second.Alias.c_str());
 240         }
 241         */
 242
 243         return EXIT_SUCCESS;
 244
 245 } // main //
 246
 247
 248
 249