IBookUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Yeming Liu, (Bernd Paradies: generalized from BookUtils.h).
// 
// $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 __IBOOKUTILS__
#define __IBOOKUTILS__

#include "BookID.h"
#include "IPMUnknown.h"
#include "IDataBase.h"
#include "ISetRepaginationCmdOptions.h"
#include "PMString.h"
#include "K2Vector.h"
#include "Utils.h"

class IDocument;
class ISection;
class ICommand;
class IBook;
class IPanelControlData;
class UIDRef;
class IBookContent;


namespace BookContentStatus
{
 typedef enum {
 kDocNormal = 0,
 kDocMising,
 kDocOutofDate,
 kDocInUse,
 kDocOpen
 } State;
}

class OriginallyCloseDocInfo
{
 public:
 typedef object_type data_type;

 OriginallyCloseDocInfo() :
 fCurrentOpenedDocumentList()
 {}

 OriginallyCloseDocInfo(const K2Vector<UIDRef>& documentList): 
 fCurrentOpenedDocumentList(documentList)
 {}
 
 bool16 operator==(const OriginallyCloseDocInfo& other) const
 { 
 return fCurrentOpenedDocumentList == other.fCurrentOpenedDocumentList; 
 }

 void Clear()
 {
 fCurrentOpenedDocumentList.clear();
 }

 K2Vector<UIDRef> fCurrentOpenedDocumentList;
};

// The extra slop for the databases that can be opened at one session.
const int32 kOpenDatabasesBuffer = 5;

class IBookUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IBOOKUTILS };

 enum GatherPagesError
 {
 kGatherPagesSuccess,
 kGatherPagesNoEvenPages,
 kGatherPagesNoOddPages
 };

 virtual BookContentStatus::State GetBookContentStatus(IBookContent *iBookContent) = 0;

 virtual IDocument* FindDocFromContentUID(IDataBase* db, UID content, IDFile& sysFile, bool16& isMissingPlugins, bool16 bShowAlert = kFalse) = 0;

 virtual ICommand* CreateOpenDocCmd(IDFile sysFile) = 0;

 virtual ErrorCode ProcessModifySectionCmd
 (
 bool16 bDefaultSection, 
 ISection* iSection, 
 int32 newStartPageNum,
 const PMString* existingName, 
 const PMString* existingMarker, 
 ClassID existingStyleID, 
 bool16 bPageNumIncludeSectionPrefix,
 bool16 doNotify = kFalse
 ) = 0;

 virtual IDataBase::DBResultCode BookDBCallback(int32 stepsDone, int32 stepCount) = 0;

 virtual bool16 IsBookContent(IDocument* iDoc, IBook* iBook, int32& position) = 0;

 virtual void GetOversetState(IDocument* doc, K2Vector<bool16>& state) = 0;

 virtual void AlertMessageAboutDocument(IDFile sysFile, PMString alertMsg) = 0;

 virtual void AlertMessageAboutDocument(PMString* docFullName, PMString alertMsg) = 0;

 virtual ErrorCode ProcessRepagination(const PMString& bookName, const ISetRepaginationCmdOptions::UpdateOptionsEnum updateOptions = ISetRepaginationCmdOptions::kUpdatePageNumbers, const int32& position = -1, const bool16& bAutoConvertDocuments = kFalse) = 0;


 virtual int32 GetStyleGroupNameIndex(const PMString& groupName) = 0;

 virtual PMString GetStyleGroupName(int32 index) = 0;

 virtual ErrorCode OpenBookWithUI(const IDFile& sysFile, UIDRef *openedBook = nil) = 0;

 virtual bool16 GetActiveBookName(PMString& bookName) = 0;

 virtual IDocument* OpenDocAtBackground
 (
 const IDFile& sysFile, // in
 bool16& originalOpen, // out
 bool16& isMissingPlugins // out
 ) = 0;


 virtual int32 GetBookRepaginateStartIndex(const PMString& bookName) = 0;

 virtual int32 GetPageRange(IDocument* doc, PMString &pageRange) = 0;

 virtual int32 GetNonHiddenStartPageNum(IDocument* doc) = 0;


 virtual ErrorCode CanDocBeAddedToBook(IDFile &sysFile, int32 *firstPageNum, PMString &pageRangeString) = 0;

 virtual void DisplayAlertString(PMString& alertString, IDFile& sysFile) = 0;

 virtual ErrorCode ReplaceBookContentWithNewDocument(const UIDRef& bookContentRef, const IDFile& docFile, const IDFile& bookFile) = 0;

 virtual bool16 IsMissingCriticalOrDefaultPlugins(IDocument* doc) = 0;

 virtual ErrorCode SetAutoConvertDocument(const UIDRef& bookRef, const bool16& bAutoConvertFlag, const bool16& bSpecialHandlingBookModifyFlag = kFalse) = 0;

 virtual ErrorCode SetMergeLayersFlag(const UIDRef& bookRef, const bool16& mergeLayersFlag) = 0;

 virtual bool16 IsBookCreatedInPreviousVersion(IBook* iBook) = 0;

 virtual bool16 IsSourceDocumentAlreadyOpen(const IDFile& sourceFile, int32& fileIndex) = 0;

 virtual IBook* IsDocumentWithinCurrentBook(IDocument* doc) = 0; 

 virtual void CloseDocumentsInBook(OriginallyCloseDocInfo& docInfo) = 0;

 virtual ErrorCode OpenOneDocument(IDataBase* bookDB, const UID bookContentUID, UIDRef& docRef, OriginallyCloseDocInfo& docInfo) = 0;
};


class BookContentInfo
{
 public:
 typedef object_type data_type;

 inline BookContentInfo() {}

 inline BookContentInfo(
 const int32& position, // position in the list
 const UID& content): // content
 fPosition(position),
 fContent(content) {}
 
 inline bool16 operator==(const BookContentInfo& other) const
 { 
 return ( (fPosition == other.fPosition) && 
 (fContent == other.fContent) ); 
 }

 inline bool16 operator<(const BookContentInfo& other) const { return fPosition < other.fPosition; }

 int32 fPosition; 

 UID fContent;
};

#endif // __IBOOKUTILS__