ssphys/SSPhysLib/SSVersionObject.h

   1 // SSVersionObject.h: interface for the SSActions class.
   2 //
   3 //////////////////////////////////////////////////////////////////////
   4
   5 #if !defined(AFX_SSHISTORYOBJECT_H__58F12C7C_FE74_43B1_9BF6_9E803182D8D7__INCLUDED_)
   6 #define AFX_SSHISTORYOBJECT_H__58F12C7C_FE74_43B1_9BF6_9E803182D8D7__INCLUDED_
   7
   8 #if _MSC_VER > 1000
   9 #pragma once
  10 #endif // _MSC_VER > 1000
  11
  12 #include "SSObject.h"
  13 #include "SSCommentObject.h"
  14 #include "SSName.h"
  15 //#include "SSItem.h"
  16
  17 //class SSItemAction;
  18 class SSLabeledAction;            // Labeled = 0,
  19 class SSCreatedProjectAction;     // Created_Project = 1,
  20 class SSAddedProjectAction;       // Added_Project = 2,
  21 class SSAddedFileAction;          // Added_File = 3,
  22 class SSDestroyedProjectAction;   // Destroyed_Project = 4,
  23 class SSDestroyedFileAction;      // Destroyed_File = 5,
  24 class SSDeletedProjectAction;     // Deleted_Project = 6,
  25 class SSDeletedFileAction;        // Deleted_File = 7,
  26 class SSRecoveredProjectAction;   // Recovered_Project = 8,
  27 class SSRecoveredFileAction;      // Recovered_File = 9,
  28 class SSRenamedProjectAction;     // Renamed_Project = 10,
  29 class SSRenamedFileAction;        // Renamed_File = 11,
  30 //class SSAction12                // missing action 12,
  31 //class SSAction13                // missing action 13
  32 class SSSharedAction;         // Shared_File = 14,
  33 class SSRollbackAction;           // RollBack_File = 15,
  34 class SSCreatedFileAction;        // Created_File = 16,
  35 class SSCheckedInAction;          // Checked_in = 17,
  36 //class SSAction18                // missing action 18
  37 //class SSRollBackAction          // RollBack = 19
  38
  39 class ISSActionVisitor
  40 {
  41 public:
  42   virtual bool Apply (const SSLabeledAction& rAction) = 0;
  43   virtual bool Apply (const SSCreatedProjectAction& rAction) = 0;
  44   virtual bool Apply (const SSCreatedFileAction& rAction) = 0;
  45   virtual bool Apply (const SSAddedProjectAction& rAction) = 0;
  46   virtual bool Apply (const SSAddedFileAction& rAction) = 0;
  47   virtual bool Apply (const SSDeletedProjectAction& rAction) = 0;
  48   virtual bool Apply (const SSDeletedFileAction& rAction) = 0;
  49   virtual bool Apply (const SSRecoveredProjectAction& rAction) = 0;
  50   virtual bool Apply (const SSRecoveredFileAction& rAction) = 0;
  51   virtual bool Apply (const SSRollbackAction& rAction) = 0;
  52
  53   virtual bool Apply (const SSDestroyedProjectAction& rAction) = 0;
  54   virtual bool Apply (const SSDestroyedFileAction& rAction) = 0;
  55   virtual bool Apply (const SSRenamedProjectAction& rAction) = 0;
  56   virtual bool Apply (const SSRenamedFileAction& rAction) = 0;
  57   virtual bool Apply (const SSCheckedInAction& rAction) = 0;
  58   virtual bool Apply (const SSSharedAction& rAction) = 0;
  59 };
  60
  61 //---------------------------------------------------------------------------
  62 class SSAction
  63 {
  64 public:
  65   SSAction (SSRecordPtr pRecord);
  66   virtual ~SSAction ();
  67
  68   static SSAction* MakeAction (SSRecordPtr pRecord);
  69
  70   eAction GetActionID () const         { return m_ActionId; }
  71
  72   virtual std::string FormatActionString () = 0;
  73   virtual bool Accept (ISSActionVisitor& rVisitor) = 0;
  74
  75   virtual void ToXml (XMLNode* pParent) const = 0;
  76   virtual void Dump (std::ostream& os) const;
  77
  78 protected:
  79   const VERSION_RECORD* GetHistoryRecordPtr (SSRecordPtr pRecord) const;
  80   eAction m_ActionId;
  81 };
  82
  83 //---------------------------------------------------------------------------
  84 class SSVersionObject : public SSObject
  85 {
  86 public:
  87   SSVersionObject (SSRecordPtr pRecord);
  88   virtual ~SSVersionObject ();
  89
  90   // handle copy constructor und assigment
  91   SSVersionObject (SSVersionObject& object);
  92   SSVersionObject& operator= (SSVersionObject const & object);
  93
  94 //  BOOST_PP_SEQ_FOR_EACH(DEFINE_ACCESSORS, GetData(), VERSION_RECORD_SEQ);
  95   ulong   GetPrevious ()                    const { return GetData ()->Previous; }
  96   eAction  GetActionID  ()                  const { return static_cast <eAction> (GetData ()->ActionID); }
  97   short   GetVersionNumber ()               const { return GetData ()->VersionNumber; }
  98   time_t  GetDate ()                        const { return GetData ()->Date; }
  99   std::string GetUsername ()                const { return std::string (GetData ()->Username, 32); }
 100   std::string GetLabel ()                   const { return std::string (GetData ()->Label, 32); }
 101   ulong   GetOffsetToNextRecordOrComment () const { return GetData ()->OffsetToNextRecordOrComment; }
 102   ulong   GetOffsetToLabelComment ()        const { return GetData ()->OffsetToLabelComment; }
 103   short   GetLengthComment ()               const { return GetData ()->LengthComment; }
 104   short   GetLengthLabelComment ()          const { return GetData ()->LengthLabelComment; }
 105
 106 //  std::string GetUsername ()      const { return GetData ()->user; }
 107 //  int         GetVersionNumber () const { return GetData ()->version; }
 108 //  eAction     GetActionId ()      const { return static_cast <eAction> (GetData ()->action); }
 109   std::string GetActionString ()  const { return m_pAction ? m_pAction->FormatActionString () : CAction::ActionToString (GetActionID()); }
 110 //  time_t      GetDate ()          const { return GetData ()->date; }
 111   std::string GetComment ()       const;
 112
 113   // special Label Action functions
 114 //  std::string GetLabel ()         const;
 115   std::string GetLabelComment ()  const;
 116
 117   // reporting functions
 118   virtual void Accept (ISSObjectVisitor& rVisitor, const ISSContext* pCtx = NULL) const { rVisitor.Apply (*this, pCtx); }
 119
 120   const VERSION_RECORD* GetData () const { return (const VERSION_RECORD*) SSObject::GetData (); }
 121
 122   SSAction* GetAction ()          const  { return m_pAction; }
 123   SSVersionObject GetPreviousObject ()  const;
 124   SSCommentObject GetCommentObject () const;
 125
 126   virtual bool Validate ();
 127
 128   virtual void ToXml (XMLNode* pParent) const;
 129   virtual void Dump (std::ostream& os) const;
 130
 131 protected:
 132
 133   SSAction* m_pAction;
 134 };
 135
 136
 137 //---------------------------------------------------------------------------
 138 template <class ACTION>
 139 class SSActionEx : public SSAction
 140 {
 141 public:
 142   SSActionEx (SSRecordPtr pRecord)
 143     : SSAction (pRecord)
 144   {
 145   }
 146
 147   bool Accept (ISSActionVisitor& rVisitor)
 148   {
 149     return rVisitor.Apply(*This());
 150   }
 151
 152   // return a pointer to the most derived class
 153   ACTION * This()
 154   {
 155       return static_cast<ACTION *>(this);
 156   }
 157 };
 158
 159
 160 //---------------------------------------------------------------------------
 161 class SSLabeledAction : public SSActionEx<SSLabeledAction>
 162 {
 163 public:
 164   SSLabeledAction (SSRecordPtr pRecord);
 165   virtual ~SSLabeledAction ();
 166
 167   std::string GetLabel () const         { return m_Label; }
 168   std::string GetLabelComment () const  { return m_LabelComment; }
 169
 170   virtual std::string FormatActionString ();
 171
 172   virtual void ToXml (XMLNode* pParent) const;
 173   virtual void Dump (std::ostream& os) const;
 174
 175 private:
 176   std::string m_Label;
 177   std::string m_LabelComment;
 178 };
 179
 180 //---------------------------------------------------------------------------
 181 class ISSItemAction
 182 {
 183 public:
 184   virtual std::string GetPhysical () const = 0;
 185   virtual SSName GetSSName ()        const = 0;
 186 };
 187
 188 //---------------------------------------------------------------------------
 189 template <class ACTION, class STRUCT>
 190 class SSItemAction : public SSActionEx<ACTION>, public ISSItemAction
 191 {
 192 public:
 193   SSItemAction (SSRecordPtr pRecord, std::string actionString);
 194
 195   std::string GetPhysical () const { return std::string (m_Action.physical, 8); }
 196   SSName GetSSName ()        const { return m_Action.name; }
 197
 198   std::string GetName ()     const { SSName name (GetSSName ()); return name.GetFullName (); }
 199
 200   virtual std::string FormatActionString ();
 201
 202   virtual void ToXml (XMLNode* pParent) const;
 203   virtual void Dump (std::ostream& os) const;
 204
 205 protected:
 206   STRUCT m_Action;
 207   std::string m_ActionString;
 208 };
 209
 210 class SSCreatedProjectAction : public SSItemAction<SSCreatedProjectAction, ITEM_ACTION>
 211 {
 212 public:
 213   SSCreatedProjectAction (SSRecordPtr pRecord)
 214     : SSItemAction<SSCreatedProjectAction, ITEM_ACTION> (pRecord, "Created Project $")
 215   {
 216   }
 217 };
 218
 219 class SSCreatedFileAction : public SSItemAction<SSCreatedFileAction, ITEM_ACTION>
 220 {
 221 public:
 222   SSCreatedFileAction (SSRecordPtr pRecord)
 223     : SSItemAction<SSCreatedFileAction, ITEM_ACTION> (pRecord, "Created File ")
 224   {
 225   }
 226 };
 227
 228 class SSAddedProjectAction : public SSItemAction<SSAddedProjectAction, ITEM_ACTION>
 229 {
 230 public:
 231   SSAddedProjectAction (SSRecordPtr pRecord)
 232     : SSItemAction<SSAddedProjectAction, ITEM_ACTION> (pRecord, "Added Project $")
 233   {
 234   }
 235 };
 236
 237 class SSAddedFileAction : public SSItemAction<SSAddedFileAction, ITEM_ACTION>
 238 {
 239 public:
 240   SSAddedFileAction (SSRecordPtr pRecord)
 241     : SSItemAction<SSAddedFileAction, ITEM_ACTION> (pRecord, "Added File ")
 242   {
 243   }
 244 };
 245
 246 class SSDeletedProjectAction : public SSItemAction<SSDeletedProjectAction, ITEM_ACTION>
 247 {
 248 public:
 249   SSDeletedProjectAction (SSRecordPtr pRecord)
 250     : SSItemAction<SSDeletedProjectAction, ITEM_ACTION> (pRecord, "Deleted Project $")
 251   {
 252   }
 253 };
 254
 255 class SSDeletedFileAction : public SSItemAction<SSDeletedFileAction, ITEM_ACTION>
 256 {
 257 public:
 258   SSDeletedFileAction (SSRecordPtr pRecord)
 259     : SSItemAction<SSDeletedFileAction, ITEM_ACTION> (pRecord, "Deleted File ")
 260   {
 261   }
 262 };
 263
 264 class SSRecoveredProjectAction : public SSItemAction<SSRecoveredProjectAction, ITEM_ACTION>
 265 {
 266 public:
 267   SSRecoveredProjectAction (SSRecordPtr pRecord)
 268     : SSItemAction<SSRecoveredProjectAction, ITEM_ACTION> (pRecord, "Recovered Project ")
 269   {
 270   }
 271 };
 272
 273 class SSRecoveredFileAction : public SSItemAction<SSRecoveredFileAction, ITEM_ACTION>
 274 {
 275 public:
 276   SSRecoveredFileAction (SSRecordPtr pRecord)
 277     : SSItemAction<SSRecoveredFileAction, ITEM_ACTION> (pRecord, "Recovered File ")
 278   {
 279   }
 280 };
 281
 282 //---------------------------------------------------------------------------
 283 class SSRollbackAction : public SSItemAction<SSRollbackAction, ROLLBACK_ACTION>
 284 {
 285 public:
 286   SSRollbackAction (SSRecordPtr pRecord)
 287     : SSItemAction<SSRollbackAction, ROLLBACK_ACTION> (pRecord, "Rolled back ")
 288   {
 289   }
 290
 291   std::string GetParent () const { return std::string (m_Action.parent, 8); }
 292
 293   virtual void ToXml (XMLNode* pParent) const;
 294   virtual void Dump (std::ostream& os) const;
 295 };
 296
 297 //---------------------------------------------------------------------------
 298
 299 template <class ACTION>
 300 class SSDestroyedAction : public SSItemAction<ACTION, DESTROYED_ACTION>
 301 {
 302 public:
 303   SSDestroyedAction (SSRecordPtr pRecord, std::string prefix);
 304
 305   virtual std::string FormatActionString ();
 306
 307 private:
 308   std::string m_Prefix;
 309 };
 310
 311 class SSDestroyedProjectAction : public SSDestroyedAction<SSDestroyedProjectAction>
 312 {
 313 public:
 314   SSDestroyedProjectAction (SSRecordPtr pRecord)
 315     : SSDestroyedAction<SSDestroyedProjectAction> (pRecord, "$")
 316   {}
 317 };
 318
 319 class SSDestroyedFileAction : public SSDestroyedAction<SSDestroyedFileAction>
 320 {
 321 public:
 322   SSDestroyedFileAction (SSRecordPtr pRecord)
 323     : SSDestroyedAction<SSDestroyedFileAction> (pRecord, "")
 324   {}
 325 };
 326
 327
 328 //---------------------------------------------------------------------------
 329
 330 template <class ACTION>
 331 class SSRenamedAction : public SSItemAction<ACTION, RENAMED_ACTION>
 332 {
 333 public:
 334   SSRenamedAction (SSRecordPtr pRecord, std::string prefix);
 335
 336   std::string GetNewName ()   const { SSName name (m_Action.newName); return name.GetFullName (); }
 337   SSName GetNewSSName ()      const { return m_Action.newName; }
 338
 339   virtual std::string FormatActionString ();
 340
 341   virtual void ToXml (XMLNode* pParent) const;
 342   virtual void Dump (std::ostream& os) const;
 343
 344 private:
 345   std::string m_Prefix;
 346 };
 347
 348 class SSRenamedProjectAction : public SSRenamedAction<SSRenamedProjectAction>
 349 {
 350 public:
 351   SSRenamedProjectAction (SSRecordPtr pRecord)
 352     : SSRenamedAction<SSRenamedProjectAction> (pRecord, "$")
 353   {}
 354 };
 355
 356 class SSRenamedFileAction : public SSRenamedAction<SSRenamedFileAction>
 357 {
 358 public:
 359   SSRenamedFileAction (SSRecordPtr pRecord)
 360     : SSRenamedAction<SSRenamedFileAction> (pRecord, "")
 361   {}
 362 };
 363
 364 //---------------------------------------------------------------------------
 365
 366 class SSCheckedInAction : public SSActionEx<SSCheckedInAction>
 367 {
 368 public:
 369   SSCheckedInAction ( SSRecordPtr pRecord);
 370   ~SSCheckedInAction ();
 371
 372   std::string GetFileSepc () const    { return m_Action.checkInSpec; }
 373   long GetOffset () const             { return m_Action.offsetFileDelta; }
 374   SSRecordPtr GetFileDelta () const;
 375
 376   virtual std::string FormatActionString ();
 377   virtual bool Accept (ISSActionVisitor& rVisitor) { return rVisitor.Apply (*this); }
 378
 379   virtual void ToXml (XMLNode* pParent) const;
 380   virtual void Dump (std::ostream& os) const;
 381
 382 private:
 383   CHECKED_IN_ACTION m_Action;
 384   mutable SSRecordPtr m_pFileDelta;
 385   SSFileImpPtr m_FilePtr;
 386 };
 387
 388
 389 //---------------------------------------------------------------------------
 390
 391 class SSSharedAction : public SSItemAction<SSSharedAction, SHARED_FILE_ACTION>
 392 {
 393 public:
 394   SSSharedAction ( SSRecordPtr pRecord);
 395   ~SSSharedAction ();
 396
 397   std::string GetSrcPathSpec () const   { return m_Action.srcPathSpec; }
 398   short GetPinnedToVersion () const     { return m_Action.pinnedToVersion; }
 399   short GetVersion () const             { return m_Action.version; }
 400
 401   virtual std::string FormatActionString ();
 402
 403   virtual void ToXml (XMLNode* pParent) const;
 404   virtual void Dump (std::ostream& os) const;
 405 };
 406
 407
 408
 409 #endif // !defined(AFX_SSHISTORYOBJECT_H__58F12C7C_FE74_43B1_9BF6_9E803182D8D7__INCLUDED_)