SDKUtilities.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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 __SDKUtilities_h__
#define __SDKUtilities_h__

#include "IPMStream.h"

#ifdef ID_DEPRECATED

class SDKUtilities
{
 public:
 
 SDKUtilities() { };

 static void InvokePlugInAboutBox(const PMString alertStringID);

 // The next set of methods allow for the manipulation of string filenames:
 
 static void GetPathName(const IDFile spec, PMString &name);

 static bool IsAbsolutePath(PMString thisString);
 
 static bool IsUnixPath(PMString thisstring);
 
 static bool IsMacPath(PMString thisstring);

 static bool IsWinPath(PMString thisstring);

 static void RemoveLastElement(PMString& fromthis);

 static void RemoveFirstElement(PMString& fromthis);

 static ErrorCode ToAbsolutePath(PMString base, PMString path, PMString& out);

 static ErrorCode ToAbsolutePath(IDFile base, PMString path, IDFile& out);

 static void convertToMacPath(PMString& thisstring);

 static void convertToWinPath(PMString& thisstring);

 static PMString SysFileToPMString(const IDFile* sFile);

 static IDFile PMStringToSysFile(PMString* fileName);
 
 /* dumps to trace (notepad on win, DebugWindow on mac) information about the boss class.

 Obsoleted. You may consult the implementation code for reference.
 @param for_this_if defines an interface on the boss class of interest.
 */
 static void DumpBoss(IPMUnknown * for_this_if);

 static void DumpBoss(UIDRef for_this_object);
 
 static void DumpMessage(const char* msg, const ClassID& theChange, const PMIID& protocol);

 static void Replace(
 PMString& original, 
 const PMString& target, 
 const PMString& replace 
 );

 static ErrorCode GetApplicationFolder(PMString& appFolder);

 static ErrorCode AbsolutePathToSysFile(PMString path, IDFile& out);

 static IPMStream* CreateFileStreamRead(
 const PMString& fullPath, 
 uint32 mode = kOpenIn, 
 OSType fileType = 0x3f3f3f3f, 
 OSType creator = 0x3f3f3f3f
 );

 static IPMStream* CreateFileStreamWrite(
 const PMString& fullPath, 
 uint32 mode = kOpenOut|kOpenTrunc, 
 OSType fileType = 'TEXT', 
 OSType creator = 'CWIE'
 );

 static ErrorCode FileExistsForRead(const PMString& fullPath);

 static void AppendPathSeparator(PMString& path);

 static void GetFileCreatorType(const IDFile spec, SysOSType* fileType, SysOSType* creator);

 static PMString GetExtension(const IDFile spec); 
};
#endif // ID_DEPRECATED

#endif // __SDKUtilities_h__

// End, SDKUtilities.h.