IDFile.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Easter
// 
// $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.
// 
// 
// Description:
// This class is a wrapper around the AFile class which provides InDesign specific
// implementations and extensions to the AFile class.
// 
//========================================================================================

#ifndef __IDFile__
#define __IDFile__

// ----- Includes -----
#include "AFile.h"
#include "IDPath.h"
#include "PMString.h"
#include "WideString.h"
#include "IDThreading.h"

class IPMStream;

using namespace adobe::afl;

class IDFile : public AFile
{
public: 
 typedef AFile inherited;
 typedef object_type data_type;

 IDFile();

 IDFile(const APath& path);

 IDFile(const IDPath& path);

 IDFile(const AString& pathStr);

 explicit IDFile(const WideString& pathStr);

 IDFile(const AFile& file);

 IDFile(const IDFile& file);

 virtual ~IDFile();

 friend void swap(IDFile &a, IDFile &b) noexcept;

 IDFile& operator=(const IDFile& rhs);

 IDFile(IDFile&& rhs) noexcept
 : AFile(std::move(rhs))
#ifdef DEBUG
 , fDebugPath(std::move(rhs.fDebugPath))
#endif
#ifdef WINDOWS
 , fTmpPathStr(std::move(rhs.fTmpPathStr))
#endif
 {
#ifdef DEBUG
 rhs.fDebugPath = 0;
#endif
 }

 IDFile& operator=(IDFile&& rhs) noexcept;

 IDFile& operator=(const AFile& rhs);

 bool operator==(const IDFile& rhs) const;

 bool operator!=(const IDFile& rhs) const;

 void SetPath(const IDPath& path);

 void SetPath(const WideString& pathStr);

 bool IsStationary() const;
 
 bool SetStationary(bool bStationary);
 
 void ReadWrite(IPMStream* s);


 //====================================================================================
 //
 // DEPRECATED Methods
 //
 // The following deprecated methods are provided to aid in the integration of the
 // new file library (AFL) architecture into InDesign. New code should avoid using
 // the following methods.
 //
 //====================================================================================

 explicit IDFile(const PMString& pathStr);

 PMString GetFileName() const;

 bool16 SetFileName(const PMString& nameStr);

#ifdef WINDOWS


 void ReadWriteDeprecated(IPMStream* iPMStream);

 void SetString(const PMString& str);

 void SetCString(ConstCString cStr);

 void SetTString(const TCHAR* xStr);

 void SetXString(const char* xStr, int32 nBytes);

 void SetXString(const UTF16TextChar* xStr, int32 nDblBytes);

 PMString GetString() const;

 TCHAR* GrabTString();

 const TCHAR* GrabTString() const;

 const UTF16TextChar* GrabWString() const;

#elif defined MACINTOSH

 uint32 GetParId() const;

 uint32 GetNodeId() const;
#elif defined WASM

 void SetString(const PMString& str);

 PMString GetString() const;

#endif 

private:
#ifdef DEBUG

 void PathChanged(const AString& path);

#ifdef WINDOWS
 wchar_t* fDebugPath;
#elif defined MACINTOSH
 char* fDebugPath;
#elif WASM
 char* fDebugPath;
#endif
#endif

#ifdef WINDOWS

 PMString fTmpPathStr;
 mutable IDThreading::spin_mutex fTmpPathStrMutex;
#endif
};

inline void swap(IDFile &lhs, IDFile &rhs) noexcept
{
 using std::swap;

 swap(static_cast<AFile &>(lhs), static_cast<AFile &>(rhs));
#ifdef DEBUG
 swap(lhs.fDebugPath, rhs.fDebugPath);
#endif
#ifdef WINDOWS
 swap(lhs.fTmpPathStr, rhs.fTmpPathStr);
#endif
}
 
inline IDFile& IDFile::operator=(IDFile&& rhs) noexcept
{
 swap(*this, rhs);

 return *this;
}

// define adobe::type_info<IDFile> to avoid typeid classes when moving across DLL boundaries
ADOBE_NAME_TYPE_0("idfile:indesign:adobe", IDFile)

#endif // __IDFile__