FileMapping.h

Go to the documentation of this file.

 
#ifndef __FILEMAPPING__
#define __FILEMAPPING__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __FILES__
#include <Files.h>
#endif
 
#ifndef __PROCESSES__
#include <Processes.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
  typedef struct OpaqueBackingFileID *BackingFileID;
 
  typedef UInt32 MappingPrivileges;
  enum
  {
    kInvalidMappedPrivileges = 0x00000000,
 
    kCanReadMappedFile = 0x00000001, 
    kCanWriteMappedFile = 0x00000002, 
    kNoProcessMappedFile =
        (unsigned long)0x80000000, 
    kValidMappingPrivilegesMask =
        (unsigned long)(kCanReadMappedFile + kCanWriteMappedFile +
                        kNoProcessMappedFile)
  };
 
  typedef UInt32 MappedFileAttributes;
  enum
  {
 
    kIsMappedScratchFile = 0x00000001 
  };
 
  enum
  {
 
    kMappedFileInformationVersion1 = 1 
  };
 
  struct MappedFileInformation
  {
 
    ProcessSerialNumber owningProcess; 
    FSRef *ref; 
    HFSUniStr255 *forkName; 
    MappingPrivileges privileges; 
    UInt64 currentSize; 
    MappedFileAttributes attributes; 
  };
  typedef struct MappedFileInformation MappedFileInformation;
 
  typedef UInt32 FileViewAccess;
  enum
  {
 
    kFileViewAccessReadBit = 0, 
    kFileViewAccessWriteBit = 1, 
    kFileViewAccessExecuteBit = 2,                          
    kFileViewAccessReadMask = 1L << kFileViewAccessReadBit, 
    kFileViewAccessWriteMask = 1L
                               << kFileViewAccessWriteBit, 
    kFileViewAccessExecuteMask =
        1L << kFileViewAccessExecuteBit, 
    kFileViewAccessExcluded = 0,         
    kFileViewAccessReadOnly =
        kFileViewAccessReadMask | kFileViewAccessExecuteMask,
    kFileViewAccessReadWrite = kFileViewAccessReadMask |
                               kFileViewAccessWriteMask |
                               kFileViewAccessExecuteMask
  };
 
  typedef OptionBits FileViewOptions;
 
  enum
  {
 
    kMapEntireFork = -1 
  };
 
  typedef struct OpaqueFileViewID *FileViewID;
 
  enum
  {
 
    kFileViewInformationVersion1 = 1 
  };
 
  struct FileViewInformation
  {
 
    ProcessSerialNumber owningProcess; 
    LogicalAddress viewBase; 
    ByteCount viewLength; 
    BackingFileID backingFile; 
    UInt64 backingBase; 
    FileViewAccess access; 
    ByteCount guardLength; 
    FileViewOptions options; 
  };
  typedef struct FileViewInformation FileViewInformation;
#if CALL_NOT_IN_CARBON
  OSErr
  OpenMappedFile(const FSRef *ref, UniCharCount forkNameLength,
                 const UniChar *forkName, 
                 MappingPrivileges privileges, BackingFileID *backingFile);
 
  OSErr
  FSpOpenMappedFile(const FSSpec *spec, Boolean mapResFork,
                    MappingPrivileges privileges, BackingFileID *backingFile);
 
  OSErr
  OpenMappedScratchFile(FSVolumeRefNum volume, ByteCount fileSize,
                        MappingPrivileges privileges, BackingFileID *backingFile);
 
  OSErr
  CloseMappedFile(BackingFileID backingFile);
 
  OSErr
  GetMappedFileInformation(BackingFileID backingFile, PBVersion version,
                           MappedFileInformation *mappedFileInfo);
 
  OSErr
  GetNextMappedFile(BackingFileID *backingFile);
 
  OSErr
  SetMappedFileSize(BackingFileID backingFile, UInt16 positionMode,
                    const SInt64 *positionOffset);
 
  OSErr
  GetFileViewAccessOptions(FileViewAccess *access, FileViewOptions *options);
 
  OSErr
  MapFileView(BackingFileID backingFile,
              const UInt64 *backingBase, 
              ByteCount backingLength, FileViewAccess access,
              ByteCount guardLength, FileViewOptions options,
              LogicalAddress *viewBase, ByteCount *viewLength,
              FileViewID *theView);
 
  OSErr
  UnmapFileView(FileViewID theView);
 
  OSErr
  GetFileViewInformation(FileViewID theView, PBVersion version,
                         FileViewInformation *fileViewInfo);
 
  OSErr
  GetFileViewFromAddress(LogicalAddress address, FileViewID *theView);
 
  OSErr
  GetNextFileView(FileViewID *theView);
 
  OSErr
  SetFileViewAccess(FileViewID theView, FileViewAccess access);
 
  OSErr
  SetFileViewBackingBase(
      FileViewID theView,
      const UInt64 *newBackingBase) ;
 
#endif 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif