src/common__tools.h

   1 #ifndef OB_TOOLS_H_
   2 #define OB_TOOLS_H_
   3
   4 #include <wx/colour.h>
   5 #include <wx/config.h>
   6 #include <wx/confbase.h>
   7 #include <wx/log.h>
   8 #include <wx/hashmap.h>
   9 #include <wx/image.h>
  10 #include <wx/event.h>
  11 #include <wx/valtext.h>
  12
  13 #include "common__globals.h"
  14 #include "images__pngFile.h"
  15 #include "images__gifFile.h"
  16 #include "common__object_file.h"
  17 #include "common__validators.h"
  18
  19 #ifdef MTRACE
  20 #endif
  21
  22
  23 #define t_size_of(t) (int)(sizeof(t)/sizeof(wxString))
  24
  25
  26 /**\internal*****************
  27  * Miscellanious facilities
  28  * **************************
  29  */
  30 bool Frame_RestorePrevCoord( wxWindow* it, const wxString& name );
  31 void Frame_SaveCoord( wxWindow* it, const wxString& name );
  32 void Frame_DestroySavedCoord( const wxString& name );
  33
  34 // Shortcuts Saves/Write config for the EditFrame objects
  35 wxString        ConfigEdit_Read( const wxString& subpath, const wxString& def_val = wxString() );
  36 void            ConfigEdit_Write( const wxString& subpath, const wxString& val );
  37
  38 void ClearMenu( wxMenu* menu );
  39 void EnableItemsMenu( wxMenu* menu, bool b_enable );
  40
  41
  42 void OpenInExternalEditor( wxWindow* parent, const wxString& filePath );
  43
  44 /**\internal*****************
  45  * Ob_objects facilities
  46  * **************************
  47  */
  48 void Sort_ob_Object_ByName( ob_object**& objs, size_t count );
  49 void Sort_ob_Object_ByTag( ob_object**& objs, size_t count, size_t num_tag = 0 );
  50 void Sort_ob_Object_ByTag( ob_anim**& objs, size_t count, size_t num_tag = 0 );
  51
  52 wxString* Reverse_Null_StrArray( wxString* tokens, size_t tokens_size );
  53
  54 wxArrayString   Tokenize( const wxString& str );
  55 wxString                UnTokenize( ob_object* _obj );
  56
  57 // ... are <const char*>
  58 void
  59         wxArraystring__Add( wxArrayString& arr_str, size_t nb_str, ... );
  60 wxArrayString
  61         wxArrayString_Build( size_t nb_str, ... );
  62
  63
  64 /**\internal*****************
  65  * Conversions facilities
  66  * **************************
  67  */
  68 wxString IntToStr( int i );
  69 wxString IntToStr( size_t i );
  70 wxString FloatToStr( const float f);
  71 inline wxString BoolToStr(const bool b ){ return (b ? wxT("1") : wxT("0")); }
  72
  73 int StrToInt( const wxString& str, bool& ok );
  74 int StrToInt( const wxString& str );
  75 unsigned int StrToUInt( const wxString& str, bool& ok );
  76 float StrToFloat(const wxString& str, bool& ok );
  77 float StrToFloat(const wxString& str );
  78
  79 bool IntToBool(const int i );
  80 bool StrToBool( const wxString& str );
  81
  82
  83
  84 /**\internal*****************
  85  * Strings facilities
  86  * **************************
  87  */
  88
  89 bool StrIsObBool( const wxString& str );
  90 bool StrIsInt( const wxString& str );
  91 bool StrIsUInt( const wxString& str );
  92 bool StrIsFloat( const wxString& str );
  93
  94 inline wxArrayString
  95         Concat_ArrayString( const wxArrayString & arr1, const wxArrayString & arr2 );
  96 wxString
  97         ArrStrConcat( const wxArrayString& arrStr, const wxString& separator = wxString() );
  98 wxArrayString
  99         StrSplit( const wxString& str, const wxString& delim, bool b_remove_emtpy = true );
 100
 101 wxArrayString
 102         ArrayString_PrependAll( const wxArrayString& arrStr, const wxString& _prefix );
 103 wxString
 104         ArrayString_Join( const wxArrayString& arrStr, const wxString& _jointure );
 105
 106 void    TabStringToArrayString( wxString* tStr,  size_t nb, wxArrayString& arrStr );
 107
 108 bool    IsInArray(const wxString& _t, wxString* arr, size_t arr_tay );
 109
 110 //  Compare String with taking care of numbers in it
 111 //  Return -1 if s0 < s1 , 0 if s0 == s1, 1 else
 112 int     P_StrCmp( const wxString& s0, const wxString& s1 );
 113 bool    IsEmpty( const wxString& s );
 114
 115 /**\internal*****************
 116  * Files facilities
 117  * **************************
 118  */
 119
 120 wxFileName      MyDirAppend( const wxFileName dataDirPath, const wxString& subDir );
 121 wxFileName      MyPathAppend( const wxFileName dataDirPath, const wxString& subPath );
 122 wxString        ObPath_To_FullPath( const wxString& _subPath );
 123 wxFileName      GetObFile( const wxString& _subPath );
 124 wxString        Convert_To_Ob_Path( const wxString& _path );
 125
 126 wxFileName      GetRessourceFile( const wxString& _strFileName );
 127 wxString        GetRessourceFile_String( const wxString& _strFileName );
 128
 129 wxString        TryRepairObPath( const wxFileName& _filename );
 130
 131 bool SimpleBackUpFile( const wxString& filePath );
 132 bool myBackUp( const wxString& filePath );
 133 bool myMove(const wxString& _src,const wxString& _dest );
 134
 135 bool IsFileEmpty(const wxString& _path );
 136
 137 class Repair_Set
 138 {
 139 public:
 140         Repair_Set();
 141         ~Repair_Set();
 142         void Add_Repairable( const wxString& _prop_name, size_t _num_token );
 143         size_t Try_Repair(ob_object* o );
 144         struct d_s_i
 145         {
 146                 wxString* prop_name;
 147                 size_t num_token;
 148         };
 149
 150 protected:
 151         std::list<struct d_s_i> props;
 152         size_t RECURS_Repair(ob_object* o);
 153 };
 154
 155
 156
 157 /**\internal*****************
 158  * Images facilities
 159  * **************************
 160  */
 161 // The NoImage image
 162 wxColour MeltColor(wxColour _c0, wxColour _c1 );
 163
 164
 165 // Tool class to save some code reusing when an object hold an image
 166 class Image_Holder
 167 {
 168 public:
 169         Image_Holder();
 170         virtual ~Image_Holder();
 171
 172         virtual wxFileName GetFileName() = 0;
 173
 174         wxImage* GetImage();
 175         imgFile* Get_GIF_or_PNG();
 176
 177         void     RemoveImages();
 178         int      Get_ColorIndex( const int x, const int y );
 179
 180 protected:
 181         wxImage* img;
 182         imgFile* png_or_gif;
 183
 184 };
 185
 186 wxImage*
 187 Build_Remap(  wxImage* src   // The target image in wxImage format
 188                 , imgFile* src2  // The target image in imgFile format
 189                 , imgFile* remap_src    // The reamp src  image
 190                 , imgFile* remap_dest   // The reamp dest image
 191                 );
 192 wxString wxColour_ToStr( const wxColour& c );
 193 wxColour wxColour_FromStr( const wxString& s );
 194
 195
 196 void Image_Rescale_To_Fit( wxImage& img, size_t w, size_t h );
 197
 198 /**\internal*****************
 199  * LOGGINGS facilities
 200  * **************************
 201  */
 202 // LOG LEVELS
 203 enum {MYLOG_ERROR = 0, MYLOG_WARNING = 1, MYLOG_INFO = 2, MYLOG_DEBUG = 3 };
 204
 205 // wxWindow log
 206 extern wxLogWindow* guiLog;
 207
 208 //const int max_log_level = wxLOG_Debug;
 209
 210 void MyLog( int level, const wxString& source, const wxString& message );
 211 void ObjectsLog( int level, int num_line, const wxString& message );
 212 void EmptyLogKeeper();
 213
 214 class myLog : public wxLog
 215 {
 216         public:
 217                 virtual void DoLog(wxLogLevel level, const wxChar *msg, time_t timestamp);
 218 };
 219 extern myLog *logger;
 220
 221
 222
 223 /**\internal******************************
 224  * Validations facilities
 225  *              Note : implemented in parsing.cpp
 226  * ***************************************
 227  */
 228 #define _V int*
 229
 230 class ob_validator
 231 {
 232 public:
 233         ob_validator();
 234         ~ob_validator();
 235         ob_validator( _V* _arr_glob_constraint );
 236         void Validate( const ob_object* it, wxString* tokens, const size_t tokens_size );
 237
 238         _V* arr_glob_constraint;
 239 };
 240
 241
 242 WX_DECLARE_HASH_MAP( wxString, ob_validator*, wxStringHash, wxStringEqual, hash_constraints );
 243 extern hash_constraints entity_constraints;
 244 extern hash_constraints models_constraints;
 245 extern hash_constraints levels_constraints;
 246
 247
 248 #endif /*OB_TOOLS_H_*/