idocumentlog.h

//========================================================================================
// 
// $File$
// 
// Owner: rbriggs
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IDocumentLog__
#define __IDocumentLog__

#include "IEnvironment.h"
#include "IPMUnknown.h"
#include "ISession.h"
#include "ShuksanID.h"
#include "FormatID.h"
#include "LocaleSetting.h"


class IDocumentLog : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDOCUMENTLOG };

 enum PlatformType
 {
 kMacintosh = 0, 
 kWindows = 1, 
 kMacintoshX64 = 2, 
 kWindowsX64 = 3, 
 kWasm = 4, 
 };

 enum EventType
 {
 kFirstEventType = 0,
 kNoEvent = kFirstEventType,
 kRecoveredFile = 1,
 kRecoveredMiniSave = 2,
 kConverted = 3,
 kOpenACopy = 4,
 kOpenWithMissingPlugins = 5,
 kSaveAs = 6,
 kCreated = 7,
 kTransfered = 8,
 kConvertedFromQXP = 9,
 kConvertedFromPM = 10,
 kBookSync = 11,
 kBookRepage = 12,
 kConvertedFromINX = 13,
 kMostRecentSave = 14,
 kBookUpdateXRef = 15,
 kOpenAClone = 16,
 kUsedContentDropper = 17,
 kUsedLayoutAdjustment = 18,
 kExportedEPUB2 = 19,
 kExportedEPUB3 = 20,
 //kExportedSWF = 21,
 kExportedHTMLFXL = 22,
 kCreatedInTWS = 23,
 kCreatedInComp = 24,

 kLastEventType = 25
 };

 enum LineBreaking
 {
 kPlatformLineBreaks,
 kCLineBreaks
 };

public:
 class DocEvent
 {
 public:
 DocEvent()
 {
 fWhat = IDocumentLog::kNoEvent;
 #if defined(MACINTOSH)
 fPlatform = kMacintosh;
 #else
 #if defined(_M_AMD64)
 fPlatform = kWindowsX64;
 #else
 fPlatform = kWindows; 
 #endif
 #endif
 fBuild = 0;
 fSystemMajor = 0;
 fSystemMinor = 0;
 fTimePosted.CurrentTime();
 fAppFS = LocaleSetting::GetLocale().GetFeatureSetId();
 }
 DocEvent(EventType what);
 DocEvent(const DocEvent &other)
 {Copy(other);}
 
 EventType GetType() const
 {return fWhat;}
 
 PlatformType GetPlatform() const
 {return fPlatform;}

 FormatID GetSystemVersion() const
 {return FormatID(fSystemMajor, fSystemMinor);}
 
 PMString GetHighestVersion() const
 {return fHighestVersionStr;}

 int16 GetFeatureSet() const
 {return fAppFS;}
 
 int16 GetBuildNumber() const
 {return fBuild;}

 GlobalTime GetEventTime() const
 {return fTimePosted;}

 DocEvent &operator =(const DocEvent &other)
 {Copy(other); return *this;}
 
 void ReadWrite(IPMStream *s);

 private:
 void Copy(const DocEvent &other);
 
 private:
 EventType fWhat;
 PlatformType fPlatform;
 int16 fSystemMajor;
 int16 fSystemMinor;
 int16 fAppFS;
 int16 fBuild;
 GlobalTime fTimePosted;
 PMString fHighestVersionStr;
 };

public: 
 virtual void SetMaxEntries(int32 maximumNumberOfEvents) = 0;

 virtual bool16 InfoIsAvailable() const = 0;

 virtual void AddEvent(EventType what) = 0;

 virtual int32 EventCount() const = 0;

 virtual int32 EventCountOfType(EventType what) const = 0;

 virtual bool16 GetEventInfo(int32 i, DocEvent &event) const = 0;

 virtual bool16 GetEventInfoOfType(EventType what, int32 i, DocEvent &event) const = 0;

 virtual bool16 HasHadEvent(EventType what) const = 0;

 virtual void SerializeAsEventLog(IPMStream *s, IDocumentLog::LineBreaking lineBreaks) const = 0;

 virtual const char* GetEventDescription(EventType what) const = 0;
};

#endif // __IDocumentLog__