ryzom/common/src/game_share/object.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2019  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 #ifndef R2_OBJECT_H
  21 #define R2_OBJECT_H
  22
  23
  24 #include "nel/misc/types_nl.h"
  25 #include "nel/misc/smart_ptr.h"
  26 #include "nel/misc/time_nl.h"
  27 #include "nel/misc/mem_stream.h"
  28
  29 #include <string>
  30 #include <vector>
  31 #include <list>
  32 #include <map>
  33 #include <queue>
  34
  35 namespace R2
  36 {
  37
  38
  39 class CObject;
  40 class CObjectTable;
  41 class CObjectString;
  42 class CObjectRefId;
  43 class CObjectNumber;
  44 class CObjectInteger;
  45 class CSerializeContext;
  46
  47
  48 // vistor triggered at traversal of object tree. see CObject::visit
  49 struct IObjectVisitor
  50 {
  51         virtual ~IObjectVisitor() { }
  52
  53         virtual void visit(CObjectRefId &/* obj */) {}
  54         virtual void visit(CObjectString &/* obj */) {}
  55         virtual void visit(CObjectNumber &/* obj */) {}
  56         virtual void visit(CObjectInteger &/* obj */) {}
  57         virtual void visit(CObjectTable &/* obj */) {}
  58 };
  59
  60
  61 class CObject : public NLMISC::CRefCount
  62 {
  63 public:
  64         typedef NLMISC::CRefPtr<CObject> TRefPtr;
  65         typedef NLMISC::CSmartPtr<CObject> TSmartPtr;
  66
  67         // recursively visit hierarchy of objects
  68         void visit(IObjectVisitor &visitor);
  69
  70         virtual ~CObject();
  71
  72         virtual CObject* clone() const;
  73
  74         void serialize(std::string& out) const;
  75
  76         virtual void doSerialize(std::string& out, CSerializeContext& context) const = 0;
  77
  78         virtual const char *getTypeAsString() const = 0;
  79
  80         CObject* findAttr(const std::string & first) const;
  81
  82         CObject* findAttr(const std::string & first, const std::string & second) const;
  83
  84         CObject* findAttr(const std::string & first, const std::string & second, const std::string & third) const;
  85
  86         CObject* findAttr(const std::vector<std::string>& attrName ) const;
  87         // test type
  88         bool isNumber(const std::string & prop="") const;
  89
  90         bool isInteger(const std::string & prop="") const;
  91
  92         bool isString(const std::string & prop="") const;
  93
  94         bool isTable(const std::string & prop="") const;
  95
  96         bool isRefId(const std::string & prop="") const;
  97
  98         virtual bool insert(const std::string & key, CObject * value, sint32 position = -1);
  99
 100         // to Value
 101         double toNumber(const std::string & prop="") const;
 102
 103         sint64 toInteger(const std::string & prop="") const;
 104
 105         std::string toString(const std::string & prop="") const;
 106
 107         CObjectTable* toTable(const std::string & prop="") const;
 108
 109
 110         virtual sint32 findIndex(const CObject* child) const;
 111
 112         // find index from a key, or -1 if not found
 113         virtual sint32 findIndex(const std::string &key) const;
 114
 115         // as table
 116         virtual CObject* getAttr(const std::string & name) const;
 117
 118         virtual std::string getKey(uint32 pos) const;
 119
 120         virtual CObject* getValueAtPos(uint32 pos) const;
 121
 122         virtual uint32 getSize() const;
 123
 124         virtual CObject* take(sint32 pos);
 125
 126         virtual bool canTake(sint32 pos) const;
 127
 128
 129         // add Value
 130
 131         void add(const std::string & key, CObject* value);
 132
 133         void add(CObject* value);
 134
 135         void add(const std::string& key, const std::string & value);
 136
 137         void add(const std::string& key, double value);
 138
 139         void add(const std::string& key, sint64 value);
 140
 141
 142         // set Value
 143         virtual bool set(const std::string& key, const std::string & value);
 144
 145         virtual bool set(const std::string& key, double value);
 146
 147         virtual bool set(const std::string& key, sint64 value);
 148
 149         virtual bool setObject(const std::string& key, CObject* value);
 150
 151         CObject* getParent() const;
 152
 153         void setParent(CObject* parent);
 154
 155         // tmp for debug
 156         virtual void dump(const std::string prefix = "", uint depth = 0) const = 0;
 157
 158         /** In place copy of object "src" into this object
 159           * Type and fields must match, otherwise error msg are printed
 160           */
 161         void inPlaceCopy(const CObject &src);
 162
 163         virtual bool equal(const CObject* /* other */) const { return false; }
 164
 165         static std::string uint32ToInstanceId(uint32 id);
 166
 167         static uint32 instanceIdToUint32(const std::string& instanceId);
 168
 169         // set / get the 'ghost' flag, meaning that this objet only exist for the client
 170         bool   getGhost() const;
 171         virtual void  setGhost(bool ghost);
 172
 173         virtual void checkIntegrity() const {}
 174
 175         /** Find the shortest name for this object as a (instanceId, attrName, position) triplet
 176       * \return false if such a name could not be found
 177           */
 178         bool getShortestName(std::string &instanceId, std::string &attrName, sint32 &position) const;
 179         bool getNameInParent(std::string &instanceId, std::string &attrName, sint32 &position) const;
 180
 181
 182
 183 protected:
 184         explicit CObject();
 185
 186         virtual bool doIsNumber() const;
 187
 188         virtual bool doIsInteger() const;
 189
 190         virtual bool doIsString() const;
 191
 192         virtual bool doIsTable() const;
 193
 194         virtual bool doIsRefId() const;
 195
 196         virtual double doToNumber() const;
 197
 198         virtual sint64 doToInteger() const;
 199
 200         virtual std::string doToString() const;
 201
 202         virtual CObjectTable* doToTable() const;
 203
 204
 205 public:
 206         virtual void previsit(std::vector<TRefPtr> &sons);
 207
 208 public:
 209         virtual void inPlaceCopyTo(CObject &dest) const = 0;
 210         virtual void inPlaceCopy(const CObjectString &src);
 211         virtual void inPlaceCopy(const CObjectNumber &src);
 212         virtual void inPlaceCopy(const CObjectTable &src);
 213 protected:
 214         void             copyMismatchMsg(const CObject &src);
 215         virtual void visitInternal(IObjectVisitor &visitor) = 0;
 216
 217 private:
 218         CObject* _Parent;
 219
 220 protected:
 221         bool     _Ghost;
 222
 223         uint32 _Validation;
 224 };
 225
 226 /*inline std::ostream& operator<<( std::ostream& os, const CObject& c )
 227 {
 228         c.serialize(os);
 229         return os;
 230 }*/
 231
 232 class CObjectString : public CObject
 233 {
 234 public:
 235         explicit CObjectString(const std::string & value);
 236
 237         virtual const char *getTypeAsString() const;
 238
 239         virtual CObject* clone() const;
 240
 241         virtual bool set(const std::string& key, const std::string & value);
 242
 243         virtual bool setObject(const std::string& key, CObject* value);
 244
 245         const std::string &getValue() const { return _Value; }
 246
 247         virtual void dump(const std::string prefix = "", uint depth = 0) const;
 248
 249         virtual bool equal(const CObject* other) const;
 250
 251 protected:
 252         virtual void visitInternal(IObjectVisitor &visitor);
 253
 254         virtual void doSerialize(std::string& out, CSerializeContext& context) const;
 255
 256         virtual std::string doToString() const;
 257
 258         virtual bool doIsString() const;
 259
 260         virtual void inPlaceCopyTo(CObject &dest) const;
 261         virtual void inPlaceCopy(const CObjectString &src);
 262
 263 private:
 264         std::string _Value;
 265
 266 };
 267
 268
 269 // A single string from the server viewpoint
 270 // From client viewpoint, derived class 'observes' a target object and tells when it has been deleted
 271 // or created
 272 class CObjectRefId : public CObjectString
 273 {
 274 public:
 275         explicit CObjectRefId(const std::string & value);
 276         ~CObjectRefId();
 277         virtual const char *getTypeAsString() const;
 278         virtual CObject* clone() const;
 279         virtual bool equal(const CObject* other) const;
 280 protected:
 281         virtual void visitInternal(IObjectVisitor &visitor);
 282         virtual bool doIsRefId() const;
 283         virtual void doSerialize(std::string& out, CSerializeContext& context) const;
 284 };
 285
 286
 287 class CObjectNumber : public CObject
 288 {
 289
 290 public:
 291         explicit CObjectNumber(double value);
 292         explicit CObjectNumber(sint64 value);
 293         double getNumberValue() const { return m_IsInteger ? m_Value.Integer : m_Value.Number; }
 294         sint64 getIntegerValue() const { return m_IsInteger ? m_Value.Integer : m_Value.Number; }
 295
 296 #if !defined(CLANG_VERSION) && defined(NL_COMP_GCC) && (GCC_VERSION < 40800)
 297         virtual const char *getTypeAsString() const;
 298
 299         virtual bool set(const std::string& key, sint64 value);
 300         virtual bool set(const std::string& key, double value);
 301         virtual bool set(const std::string& key, const std::string&value);
 302
 303         virtual bool setObject(const std::string& key, CObject* value);
 304
 305         virtual CObject* clone() const;
 306
 307         virtual void dump(const std::string prefix = "", uint depth = 0) const;
 308
 309         virtual bool equal(const CObject* other) const;
 310 #else
 311         virtual const char *getTypeAsString() const NL_OVERRIDE;
 312
 313         virtual bool set(const std::string& key, sint64 value) NL_OVERRIDE;
 314         virtual bool set(const std::string& key, double value) NL_OVERRIDE;
 315         virtual bool set(const std::string& key, const std::string&value) NL_OVERRIDE;
 316
 317         virtual bool setObject(const std::string& key, CObject* value) NL_OVERRIDE;
 318
 319         virtual CObject* clone() const NL_OVERRIDE;
 320
 321         virtual void dump(const std::string prefix = "", uint depth = 0) const NL_OVERRIDE;
 322
 323         virtual bool equal(const CObject* other) const NL_OVERRIDE;
 324 #endif
 325
 326 protected:
 327 #if !defined(CLANG_VERSION) && defined(NL_COMP_GCC) && (GCC_VERSION < 40800)
 328         virtual void doSerialize(std::string& out, CSerializeContext& context) const;
 329
 330         virtual bool doIsNumber() const;
 331
 332         virtual double doToNumber() const;
 333
 334         virtual bool doIsInteger() const;
 335
 336         virtual sint64 doToInteger() const;
 337
 338         virtual std::string doToString() const;
 339
 340         virtual void inPlaceCopyTo(CObject &dest) const;
 341         virtual void inPlaceCopy(const CObjectNumber &src);
 342
 343         virtual void visitInternal(IObjectVisitor &visitor);
 344 #else
 345         virtual void doSerialize(std::string& out, CSerializeContext& context) const NL_OVERRIDE;
 346
 347         virtual bool doIsNumber() const NL_OVERRIDE;
 348
 349         virtual double doToNumber() const NL_OVERRIDE;
 350
 351         virtual bool doIsInteger() const NL_OVERRIDE;
 352
 353         virtual sint64 doToInteger() const NL_OVERRIDE;
 354
 355         virtual std::string doToString() const NL_OVERRIDE;
 356
 357         virtual void inPlaceCopyTo(CObject &dest) const NL_OVERRIDE;
 358         virtual void inPlaceCopy(const CObjectNumber &src) NL_OVERRIDE;
 359
 360         virtual void visitInternal(IObjectVisitor &visitor) NL_OVERRIDE;
 361 #endif
 362
 363 private:
 364         bool m_IsInteger;
 365         union
 366         {
 367                 double Number;
 368                 sint64 Integer;
 369         } m_Value;
 370
 371 };
 372
 373 class CObjectTable: public CObject
 374 {
 375
 376 public:
 377         typedef NLMISC::CRefPtr<CObjectTable> TRefPtr;
 378         typedef NLMISC::CRefPtr<const CObjectTable> TRefPtrConst;
 379
 380         explicit CObjectTable();
 381
 382         virtual ~CObjectTable();
 383
 384         virtual const char *getTypeAsString() const;
 385
 386         virtual bool insert(const std::string & key, CObject * value, sint32 pos);
 387
 388         virtual CObject* clone() const;
 389
 390         virtual void doSerialize(std::string& out, CSerializeContext& context) const;
 391
 392         virtual CObject* getAttr(const std::string & name) const;
 393
 394
 395         virtual std::string getKey(uint32 pos) const;
 396
 397         virtual CObject* getValueAtPos(uint32 pos) const;
 398
 399         virtual sint32 findIndex(const CObject* child) const;
 400
 401         // find index from a key, or -1 if not found
 402         virtual sint32 findIndex(const std::string &key) const;
 403
 404         virtual uint32 getSize() const;
 405
 406         virtual bool set(const std::string& key, const std::string & value);
 407
 408         virtual bool set(const std::string& key, double value);
 409
 410         virtual bool setObject(const std::string& key, CObject* value);
 411
 412         virtual CObject* take(sint32 pos);
 413
 414         virtual bool canTake(sint32 pos) const;
 415
 416         void clear();
 417
 418         void sort();
 419
 420         virtual void dump(const std::string prefix = "", uint depth = 0) const;
 421
 422         virtual bool equal(const CObject* other) const;
 423
 424         virtual void  setGhost(bool ghost);
 425
 426         virtual void checkIntegrity() const;
 427
 428 protected:
 429         virtual void visitInternal(IObjectVisitor &visitor);
 430
 431         virtual bool doIsTable() const;
 432
 433         virtual CObjectTable* doToTable() const;
 434
 435         virtual void inPlaceCopyTo(CObject &dest) const;
 436         virtual void inPlaceCopy(const CObjectTable &src);
 437
 438
 439         virtual void previsit(std::vector<CObject::TRefPtr> &sons);
 440
 441         /** Compute absolute position, return true if index is valid
 442           * A negative index indicate an offset from the end of the table (-1 for the last element)
 443           */
 444 protected:
 445         typedef std::vector< std::pair<std::string, CObject*> >  TContainer;
 446
 447 protected:
 448         TContainer _Value;
 449
 450 };
 451
 452
 453 class CTypedObject : public CObjectTable
 454 {
 455 public:
 456
 457         CTypedObject(const std::string & type);
 458         virtual bool isOk() const;
 459 };
 460
 461 class CNameGiver
 462 {
 463 public:
 464         CNameGiver();
 465         sint32 getNewId(const std::string& type="") ;
 466         std::string getNewName(const std::string& type="", sint32 id = -1);
 467         void setMaxId(const std::string& eid,sint32 id);
 468         sint32 getMaxId(const std::string& eid);
 469         void clear();
 470 private:
 471         std::map< std::string, sint32> _Value;
 472
 473 };
 474
 475 class CObjectGenerator;
 476
 477 // NB nico : added 'virtual' because client derives its own factory
 478 class CObjectFactory
 479 {
 480 public:
 481         CObjectFactory(const std::string & prefix);
 482         void registerGenerator(CObject* classObject);
 483         virtual ~CObjectFactory();
 484         virtual CObject* newBasic(const std::string & type);
 485         CObject* newAvanced(const std::string & type);
 486         CObject* newComponent(const std::string & type);
 487         CObjectGenerator* getGenerator(const std::string & type);
 488         std::string getNewName(const std::string& type="") const;
 489         void setMaxId(const std::string&  eid,sint32 id);
 490         void setPrefix(const std::string & prefix);
 491         sint32 getMaxId(const std::string& eid) const;
 492         void clear();
 493 private:
 494         CNameGiver* _NameGiver;
 495         std::string _Prefix;
 496         std::map<std::string, CObjectGenerator*> _Map;
 497 };
 498
 499
 500 class CObjectGenerator
 501 {
 502 public:
 503         CObject* instanciate(CObjectFactory* factory) const;
 504         CObjectGenerator(CObject* objectClass, CObjectFactory* factory):
 505                 _ObjectClass(objectClass){ createDefaultValues(factory);}
 506         ~CObjectGenerator();
 507         CObject* getDefaultValue(const std::string & propName) const;
 508         std::string getBaseClass() const;
 509 protected:
 510         void createDefaultValues(CObjectFactory* factory);
 511 private:
 512         typedef std::map<std::string, CObject* > TDefaultValues;
 513 private:
 514         CObject* _ObjectClass;
 515         TDefaultValues _DefaultValues;
 516 };
 517
 518 class CClass : public CObjectTable
 519 {
 520 public:
 521         CClass(const std::string & classType);
 522         void addAttribute(const std::string & name, const std::string & type);
 523         void addAttribute(const std::string & name, const std::string & type, const std::string & defaultValue);
 524
 525 private:
 526         std::string _ClassType;
 527 };
 528
 529 class CClassAttribute: public CObjectTable
 530 {
 531         public:
 532
 533         CClassAttribute(const std::string & propName, const std::string& propType)
 534         {
 535                 add("Name", propName);
 536                 add("Type", propType);
 537         }
 538         CClassAttribute(const std::string & propName, const std::string& propType, const std::string & defaultValue)
 539         {
 540                 add("Name", propName);
 541                 add("Type", propType);
 542                 add("DefaultValue", defaultValue);
 543         }
 544         //virtual CObject* instanciate() const = 0;
 545
 546         virtual bool verify(CObject* /* prop */) const { return true;}
 547 };
 548
 549 // Don't take ownership
 550 class CObjectSerializer
 551 {
 552 public:
 553         // for client : factory to use when reading objects
 554         CObjectFactory *Factory;
 555
 556         // to force static serializer memory cleanup
 557         static void releaseInstance();
 558 protected:
 559         CObjectSerializer(CObjectFactory *factory, CObject* data = 0);
 560
 561 public:
 562         void serial(NLMISC::IStream& stream);
 563         CObject* getData() const;
 564         // make a copy of data (the caller must handle data)
 565         void setData(CObject* data);
 566         // :XXX: don't delete _Data
 567         ~CObjectSerializer();
 568         static void serialStringInstanceId( NLMISC::IStream& stream, std::string& data);
 569
 570         bool isCompresed() const { return _Compressed;}
 571
 572         void compress();
 573
 574         void uncompress() const;
 575
 576         void swap(CObjectSerializer& other);
 577         void setVersion(uint32 version) { _Version = version; }
 578         uint32 getVersion() const { return _Version; }
 579
 580
 581 private:
 582         CObjectSerializer(const CObjectSerializer& lh);
 583         CObjectSerializer& operator=(const CObjectSerializer& rh);
 584         void uncompressImpl();
 585
 586
 587 private:
 588         CObject*        _Data;
 589         bool            _Compressed;
 590         bool            _MustUncompress;
 591         uint8*          _CompressedBuffer;
 592         uint32          _CompressedLen;
 593         uint32          _UncompressedLen;
 594         uint32          _Version;
 595 public:
 596         uint32          Level;
 597         bool            Log;
 598 };
 599
 600 class CObjectSerializerClient : public CObjectSerializer
 601 {
 602         static CObjectFactory   *_ClientObjecFactory;
 603 public:
 604         // constructor for client side serializer, we use the client side factory
 605         CObjectSerializerClient(CObject *data=0)
 606                 :       CObjectSerializer(_ClientObjecFactory, data)
 607         {
 608                 nlassert(_ClientObjecFactory != NULL);
 609         }
 610
 611         static void setClientObjectFactory(CObjectFactory *factory)
 612         {
 613                 _ClientObjecFactory = factory;
 614         }
 615 };
 616
 617 class CObjectSerializerServer: public CObjectSerializer
 618 {
 619 public:
 620         // constructor for server side serializer, we don't use object factory
 621         CObjectSerializerServer(CObject *data=0)
 622                 :       CObjectSerializer(NULL, data)
 623         {}
 624 };
 625
 626
 627 } // namespace R2
 628
 629 #endif //R2_OBJECT_H