SPFiles.h Go to the documentation of this file. /***********************************************************************/ /* */ /* SPFiles.h */ /* */ /* ADOBE SYSTEMS INCORPORATED */ /* Copyright 1995-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. */ /* */ /* Patents Pending */ /* */ /* */ /***********************************************************************/ #ifndef __SPFiles__ #define __SPFiles__ /******************************************************************************* ** ** Imports ** **/ #include "SPTypes.h" #include "SPProps.h" #include "SPHeaderBegin.h" #ifdef WIN_ENV #include <cstring> #endif #ifdef __cplusplus extern "C" { #endif /******************************************************************************* ** ** Constants ** **/ #define kSPFilesSuite "SP Files Suite" #define kSPFilesSuiteVersion3 3 #define kSPFilesSuiteVersion 4 #define kSPRuntimeFileList ((SPFileListRef)NULL) #define kFileDoesNotHavePiPL (SPPropertyListRef)(~((size_t)NULL)) #define kFileHasMulitplePiPLs NULL /******************************************************************************* ** ** Types ** **/ typedef struct SPFile *SPFileRef; typedef struct SPFileList *SPFileListRef; typedef struct SPFileListIterator *SPFileListIteratorRef; typedef struct OpaqueSPPlatformFileRef SPPlatformFileRef; #ifdef MAC_ENV #define kMaxPathLength 1024 #pragma options align=power typedef struct SPPlatformFileSpecification { short vRefNum; ai::int32 parID; unsigned char name[64]; } SPPlatformFileSpecification; typedef struct SPPlatformFileReference { unsigned char path[kMaxPathLength]; //1024 has been taken up from /usr/include/sys/syslimits.h } SPPlatformFileReference; #pragma options align=reset typedef struct SPPlatformFileInfo { /* On Mac OS*/ ai::uint32 attributes; //Unused, but still required to maintain binary compatibility ai::uint32 creationDate; ai::uint32 modificationDate; ai::uint32 finderType; ai::uint32 finderCreator; ai::uint16 finderFlags; } SPPlatformFileInfo; SPErr FileSpectoFileRef(const SPPlatformFileSpecification *fileSpec, const SPPlatformFileReference *fileRef); // temporary functions used while transition from SPPlatformFileSpecification to SPPlatformFileReference SPErr FileReftoFileSpec(const SPPlatformFileReference *fileRef, const SPPlatformFileSpecification *fileSpec); #endif #ifdef WIN_ENV #define kMaxPathLength 300 typedef struct SPPlatformFileSpecification { char path[kMaxPathLength]; } SPPlatformFileSpecification; //Keeping the structure's type similar to PSinterface, added some additional helper methods. struct SPPlatformFileSpecificationW { private: wchar_t path[kMaxPathLength]; public: SPPlatformFileSpecificationW() { memset (path,0,sizeof(path)); } const wchar_t* c_str() const { return path; } wchar_t* GetBuffer() {return path;} }; typedef SPPlatformFileSpecificationW SPPlatformFileReference; typedef struct SPPlatformFileInfo { ai::uint32 attributes; ai::uint32 lowCreationTime; ai::uint32 highCreationTime; ai::uint32 lowModificationTime; ai::uint32 highModificationTime; const wchar_t* extension; } SPPlatformFileInfo; #endif typedef SPBoolean (*SPAddPiPLFilterProc)( SPPlatformFileInfo *info ); /******************************************************************************* ** ** Suite ** **/ typedef struct SPFilesSuite { SPAPI SPErr (*AllocateFileList)( SPFileListRef *fileList ); SPAPI SPErr (*FreeFileList)( SPFileListRef fileList ); SPAPI SPErr (*AddFiles)( SPFileListRef fileList, const SPPlatformFileReference *file ); SPAPI SPErr (*NewFileListIterator)( SPFileListRef fileList, SPFileListIteratorRef *iter ); SPAPI SPErr (*NextFile)( SPFileListIteratorRef iter, SPFileRef *file ); SPAPI SPErr (*DeleteFileListIterator)( SPFileListIteratorRef iter ); #ifdef WIN_ENV SPAPI SPErr (*GetFileSpecification) ( SPFileRef file, SPPlatformFileSpecification *fileSpec ); #endif SPAPI SPErr (*GetFileReference)( SPFileRef file, SPPlatformFileReference *fileSpec ); SPAPI SPErr (*GetFileInfo)( SPFileRef file, SPPlatformFileInfo *info ); SPAPI SPErr (*GetIsAPlugin)( SPFileRef file, SPBoolean *isAPlugin ); SPAPI SPErr (*SetIsAPlugin)( SPFileRef file, SPBoolean isAPlugin ); SPAPI SPErr (*GetFilePropertyList)( SPFileRef file, SPPropertyListRef *propertList ); SPAPI SPErr (*SetFilePropertyList)( SPFileRef file, SPPropertyListRef propertList ); } SPFilesSuite; SPAPI SPErr SPAllocateFileList( SPFileListRef *fileList ); SPAPI SPErr SPFreeFileList( SPFileListRef fileList ); SPAPI SPErr SPAddFiles( SPFileListRef fileList, const SPPlatformFileReference *file ); SPAPI SPErr SPNewFileListIterator( SPFileListRef fileList, SPFileListIteratorRef *iter ); SPAPI SPErr SPNextFile( SPFileListIteratorRef iter, SPFileRef *file ); SPAPI SPErr SPDeleteFileListIterator( SPFileListIteratorRef iter ); #ifdef WIN_ENV SPAPI SPErr SPGetFileSpecification( SPFileRef file, SPPlatformFileSpecification *fileSpec ); #endif SPAPI SPErr SPGetFileReference( SPFileRef file, SPPlatformFileReference *fileSpec ); // This function will replace all the instances of SPGetFileSpecification SPAPI SPErr SPGetFileInfo( SPFileRef file, SPPlatformFileInfo *info ); SPAPI SPErr SPGetIsAPlugin( SPFileRef file, SPBoolean *isAPlugin ); SPAPI SPErr SPSetIsAPlugin( SPFileRef file, SPBoolean isAPlugin ); SPAPI SPErr SPGetFilePropertyList( SPFileRef file, SPPropertyListRef *propertList ); SPAPI SPErr SPSetFilePropertyList( SPFileRef file, SPPropertyListRef propertList ); SPAPI SPErr SPAddFilePiPLs( SPFileListRef fileList, SPAddPiPLFilterProc filter ); /******************************************************************************* ** ** Errors ** **/ #include "SPErrorCodes.h" #ifdef __cplusplus } #endif #include "SPHeaderEnd.h" #endif

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