IAIFilePath.hpp Go to the documentation of this file. /* * Name: IAIFilePath.hpp * Purpose: C++ access class for File Path suite * * ADOBE SYSTEMS INCORPORATED * Copyright 2004-2007 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 __IAIFilePath__ #define __IAIFilePath__ #include "IAIUnicodeString.h" /*HACK for int32_t and uint32_t redefinition error in VS2012: In case of VS2012 compiler, "memory" file includes stdint.h which, for some reason, points to dvacore/sys/win/stdint.h. As a result, datatypes defined in stdint.h throw redefinition errors. */ #if defined(_MSC_VER) && _MSC_VER >= 1700 #define _ADOBE_STDINT_H_ #endif #include <memory> #if defined(_MSC_VER) && _MSC_VER >= 1700 #undef _ADOBE_STDINT_H_ #endif #ifdef MAC_ENV #ifdef __OBJC__ #import <Foundation/NSURL.h> #import <Foundation/NSString.h> #endif #ifndef __COREFOUNDATION_CFURL__ #include <CoreFoundation/CFURL.h> #endif #if defined(IOS_ENV) typedef short FSVolumeRefNum; #else #ifndef __FILES__ #include <Carbon/Carbon.h> #endif #endif // !defined(IOS_ENV) #else typedef signed long OSStatus; #endif struct FSSpec; struct MiFile; namespace ai { #ifdef WIN_ENV const ai::uint32 MaxPath = 259; #endif #ifdef MAC_ENV const ai::uint32 MaxPath = 1023; #endif const ai::uint32 MaxFile = 255; class FilePath { public: /* Some file system operations can be very slow. For example, on Windows, UNC path names are used to access files on remote volumes. Determining the availability of those remote volumes can require significant time especially in the presence of the Windows client for NFS. For this reason volume availability information is cached. */ static void ResetVolumeCache() AINOTHROW; FilePath() AINOTHROW; FilePath(const FilePath&); explicit FilePath(const ai::UnicodeString &path, bool expandName = true); explicit FilePath(const MiFile&); explicit FilePath(const SPPlatformFileReference&); #ifdef MAC_ENV explicit FilePath(const CFStringRef); #if DEPRICATED_IN_10_8 explicit FilePath(const FSRef&); #endif explicit FilePath(const CFURLRef); #ifdef __OBJC__ explicit FilePath( NSData* inBookmarkData, const FilePath& inRelativeToPath = FilePath() ); #endif //__OBJC__ #endif // MAC_ENV ~FilePath(); FilePath &operator=(const FilePath&); bool IsEmpty() const; void MakeEmpty(); bool Equal(const FilePath& filePath, const bool resolveLinks = false) const; bool operator==(const FilePath&) const; bool operator!=(const FilePath&) const; bool operator<(const FilePath&) const; bool StartsWithDelimiter() const; bool EndsWithDelimiter() const; void AddComponent(const ai::UnicodeString &addend = ai::UnicodeString()); void AddComponent(const FilePath &addend); void RemoveComponent(); void AddExtension(const ai::UnicodeString &ext); void AddExtension(const std::string &ext); void RemoveExtension(); bool Exists(const bool resolveLinks, ai::UnicodeString *longPath = 0, bool *isFile = 0) const; void Resolve(); /*****************************************************************************/ /* Set operations */ void Set(const ai::UnicodeString &path, bool expandName = true); void SetFromMiFile(const MiFile&); void SetFromSPFileRef(const SPPlatformFileReference&); #ifdef MAC_ENV void SetFromCFString(const CFStringRef); #if DEPRICATED_IN_10_8 OSStatus SetFromFSRef(const FSRef&); #endif void SetFromCFURL(const CFURLRef); #ifdef __OBJC__ BOOL SetFromBookmarkData( NSData* inBookmarkData, const FilePath& inRelativeToPath = FilePath(), NSError** inError = NULL ); #endif //__OBJC__ #endif // MAC_ENV /*****************************************************************************/ /* Get operations */ ai::UnicodeString GetFileName(const bool displayName = false) const; ai::UnicodeString GetFileNameNoExt() const; ai::UnicodeString GetFileExtension() const; ai::UnicodeString GetFullPath(const bool displayName = false) const; ai::UnicodeString GetDirectory(const bool displayName = false) const; ai::UnicodeString GetShortPath() const; FilePath GetParent() const; //On hold due to lack of demand //FilePath GetRelativePath(const FilePath &base) const; //On hold due to lack of demand //FilePath GetAbsolutePath(const FilePath &base) const; static const char GetDelimiter() AINOTHROW; #ifdef MAC_ENV #if DEPRICATED_IN_10_8 void GetVolumeAndParent(FSVolumeRefNum *vol, UInt32 *parent) const; #endif #ifdef __OBJC__ void GetVolumeAndParent(NSURL **volume, NSURL **parent) const; #endif #endif AIErr GetCreatorAndType(ai::uint32 *creator, ai::uint32 *type) const; ai::UnicodeString GetAsURL(const bool displayName) const; void GetAsSPPlatformFileRef(SPPlatformFileReference&) const; AIErr GetAsMiFile(MiFile&) const; AIErr GetAsMiFile(MiFile*&) const; #ifdef MAC_ENV CFStringRef GetAsCFString() const; #if DEPRICATED_IN_10_8 OSStatus GetAsFSRef(FSRef& result) const; #endif CFURLRef GetAsCFURL() const; #ifdef __OBJC__ NSString* GetAsNSString () const; NSURL* GetAsNSURL () const; NSData* GetAsBookmarkData ( const FilePath& inRelativeToPath = FilePath(), NSError** inError = NULL ) const; NSData* GetAsMinimalBookmarkData( const FilePath& inRelativeToPath = FilePath(), NSError** inError = NULL ) const; BOOL IsAlias () const; BOOL IsOnNetwork () const; BOOL IsEjectable () const; #endif #endif // MAC_ENV private: class FilePathImpl *impl; }; } // namespace ai // Inline members // inline void ai::FilePath::AddComponent(const FilePath &addend) { AddComponent(addend.GetFullPath()); } inline void ai::FilePath::AddExtension(const std::string &ext) { AddExtension(ai::UnicodeString(ext)); } #endif // __IAIFilePath__

Copyright © 2016 Adobe Systems Incorporated. All rights reserved. Terms of Use Online Privacy Policy Adobe and accessibility Avoid software piracy Permissions and Trademarks