ICoreFilename.h

//========================================================================================
// 
// $File$
// 
// Owner: Steve Flenniken
// 
// $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 __ICOREFILENAME__
#define __ICOREFILENAME__

#include "IDatalink.h" // for ProgressParam
#include "CmdUtils.h" // for CreateObject

class IDFile;
class NameInfo;
class PMString;

class ICoreFilename : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICOREFILENAME };

 virtual void ReadWrite(IPMStream *s) = 0;

 virtual int32 Initialize(const IDFile *name) = 0;

 virtual int32 Initialize(PMString *filename, PMString *volname, int32 dirid, const PMString *fullPath = nil) = 0;

 virtual int32 Initialize(ICoreFilename *cfn) = 0;

 virtual int32 Initialize(NameInfo *ni, const PMString *fullPath = nil) = 0;

 virtual int32 Initialize(PMString *fullpath) = 0;

 virtual int32 SetBaseName(PMString *name) = 0;

 virtual int32 GetSysFile(IDFile *name) = 0;
 
 virtual int32 GetSysFile(NameInfo& ni, IDFile *name) const = 0;
 
 virtual int32 GetNameInfo(NameInfo *ni) = 0;

 virtual PMString *GetFilename() = 0;

 virtual PMString *GetVolume() = 0;

 virtual int32 GetDirID() = 0;

 virtual ClassID GetClassID() = 0;

 virtual IDFile* GetFile() = 0;

 virtual void GetExtension(PMString *extension) = 0;

 virtual PMString *GetBaseName() = 0;

 virtual PMString *GetFullName(bool16* bChangedName = nil) = 0;

 virtual int32 GetFileInfo(uint64 *size, uint64 *time, IDataLink * link = nil) = 0;

 virtual bool16 FileExists() = 0;

 virtual bool16 DirectoryExists() = 0;

 virtual int32 Copy(ICoreFilename *dirname, ProgressParam *pp) = 0;

 virtual int32 Delete() = 0;

 virtual int32 Touch() = 0;

 virtual FILE *fileopen(PMString *mode) = 0;

 virtual int32 GetTypeAndCreator(uint32 *type, uint32 *creator) = 0;

 virtual int32 GetDiskFreeSpace(uint64 *free) = 0;

 virtual int32 FindRelative(ICoreFilename *dirname, ICoreFilename *newname) = 0;

 virtual int32 Combine(ICoreFilename *dirname, ICoreFilename *pcombined) = 0;

 virtual bool16 CompareBaseName(ICoreFilename *cfn) = 0;

 virtual bool16 CompareDirectory(ICoreFilename *cfn) = 0;

 virtual bool16 IsFileOpen() = 0;

 virtual bool16 IsFileLocked() = 0;

 virtual void SetTypeAndCreator(uint32 fileType, uint32 creator) = 0;
 
 virtual int32 CreateFolder(PMString *name) = 0;

 virtual ICoreFilename *CreateChildFolderFilename(const PMString &childFolder, PMString &filePart) = 0;

 virtual bool32 ConvertToUNC() = 0;

 virtual bool16 IsFileOpenExclusive() = 0;

 virtual bool32 SwitchToParentDir() = 0;
};

#endif // __ICOREFILENAME__