URLAccess.h

Go to the documentation of this file.

 
#ifndef __URLACCESS__
#define __URLACCESS__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __FILES__
#include <Files.h>
#endif
 
#ifndef __CODEFRAGMENTS__
#include <CodeFragments.h>
#endif
 
#ifndef __MACERRORS__
#include <MacErrors.h>
#endif
 
#ifndef __EVENTS__
#include <Events.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 OpaqueURLReference *URLReference;
  typedef UInt32 URLOpenFlags;
  enum
  {
    kURLReplaceExistingFlag = 1 << 0,
    kURLBinHexFileFlag = 1 << 1, 
    kURLExpandFileFlag =
        1 << 2, 
    kURLDisplayProgressFlag = 1 << 3,
    kURLDisplayAuthFlag =
        1 << 4,                       
    kURLUploadFlag = 1 << 5,          
    kURLIsDirectoryHintFlag = 1 << 6, 
    kURLDoNotTryAnonymousFlag =
        1 << 7, 
    kURLDirectoryListingFlag =
        1 << 8, 
    kURLExpandAndVerifyFlag =
        1 << 9, 
    kURLNoAutoRedirectFlag = 1
                             << 10, 
    kURLDebinhexOnlyFlag =
        1 << 11,                          
    kURLDoNotDeleteOnErrorFlag = 1 << 12, 
    kURLResumeDownloadFlag =
        1
        << 13, 
    kURLReservedFlag =
        (unsigned long)(1 << 31) 
  };
 
  typedef UInt32 URLState;
  enum
  {
    kURLNullState = 0,
    kURLInitiatingState = 1,
    kURLLookingUpHostState = 2,
    kURLConnectingState = 3,
    kURLResourceFoundState = 4,
    kURLDownloadingState = 5,
    kURLDataAvailableState = 0x10 + kURLDownloadingState,
    kURLTransactionCompleteState = 6,
    kURLErrorOccurredState = 7,
    kURLAbortingState = 8,
    kURLCompletedState = 9,
    kURLUploadingState = 10
  };
 
  typedef UInt32 URLEvent;
  enum
  {
    kURLInitiatedEvent = kURLInitiatingState,
    kURLResourceFoundEvent = kURLResourceFoundState,
    kURLDownloadingEvent = kURLDownloadingState,
    kURLAbortInitiatedEvent = kURLAbortingState,
    kURLCompletedEvent = kURLCompletedState,
    kURLErrorOccurredEvent = kURLErrorOccurredState,
    kURLDataAvailableEvent = kURLDataAvailableState,
    kURLTransactionCompleteEvent = kURLTransactionCompleteState,
    kURLUploadingEvent = kURLUploadingState,
    kURLSystemEvent = 29,
    kURLPercentEvent = 30,
    kURLPeriodicEvent = 31,
    kURLPropertyChangedEvent = 32
  };
 
  typedef unsigned long URLEventMask;
  enum
  {
    kURLInitiatedEventMask = 1 << (kURLInitiatedEvent - 1),
    kURLResourceFoundEventMask = 1 << (kURLResourceFoundEvent - 1),
    kURLDownloadingMask = 1 << (kURLDownloadingEvent - 1),
    kURLUploadingMask = 1 << (kURLUploadingEvent - 1),
    kURLAbortInitiatedMask = 1 << (kURLAbortInitiatedEvent - 1),
    kURLCompletedEventMask = 1 << (kURLCompletedEvent - 1),
    kURLErrorOccurredEventMask = 1 << (kURLErrorOccurredEvent - 1),
    kURLDataAvailableEventMask = 1 << (kURLDataAvailableEvent - 1),
    kURLTransactionCompleteEventMask = 1 << (kURLTransactionCompleteEvent - 1),
    kURLSystemEventMask = 1 << (kURLSystemEvent - 1),
    kURLPercentEventMask = 1 << (kURLPercentEvent - 1),
    kURLPeriodicEventMask = 1 << (kURLPeriodicEvent - 1),
    kURLPropertyChangedEventMask = 1 << (kURLPropertyChangedEvent - 1),
    kURLAllBufferEventsMask =
        kURLDataAvailableEventMask + kURLTransactionCompleteEventMask,
    kURLAllNonBufferEventsMask =
        kURLInitiatedEventMask + kURLDownloadingMask + kURLUploadingMask +
        kURLAbortInitiatedMask + kURLCompletedEventMask +
        kURLErrorOccurredEventMask + kURLPercentEventMask +
        kURLPeriodicEventMask + kURLPropertyChangedEventMask,
    kURLAllEventsMask = (long)0xFFFFFFFF
  };
 
  struct URLCallbackInfo
  {
    UInt32 version;
    URLReference urlRef;
    const char *property;
    UInt32 currentSize;
    EventRecord *systemEvent;
  };
  typedef struct URLCallbackInfo URLCallbackInfo;
 
  enum
  {
    kUserNameAndPasswordFlag = 0x00000001
  };
 
#define kURLURL "URLString"
#define kURLResourceSize "URLResourceSize"
#define kURLLastModifiedTime "URLLastModifiedTime"
#define kURLMIMEType "URLMIMEType"
#define kURLFileType "URLFileType"
#define kURLFileCreator "URLFileCreator"
#define kURLCharacterSet "URLCharacterSet"
#define kURLResourceName "URLResourceName"
#define kURLHost "URLHost"
#define kURLAuthType "URLAuthType"
#define kURLUserName "URLUserName"
#define kURLPassword "URLPassword"
#define kURLStatusString "URLStatusString"
#define kURLIsSecure "URLIsSecure"
#define kURLCertificate "URLCertificate"
#define kURLTotalItems "URLTotalItems"
#define kURLConnectTimeout "URLConnectTimeout"
#define kURLHTTPRequestMethod "URLHTTPRequestMethod"
#define kURLHTTPRequestHeader "URLHTTPRequestHeader"
#define kURLHTTPRequestBody "URLHTTPRequestBody"
#define kURLHTTPRespHeader "URLHTTPRespHeader"
#define kURLHTTPUserAgent "URLHTTPUserAgent"
#define kURLHTTPRedirectedURL "URLHTTPRedirectedURL"
#define kURLSSLCipherSuite "URLSSLCipherSuite"
 
  OSStatus
  URLGetURLAccessVersion(UInt32 *returnVers);
 
#if TARGET_RT_MAC_CFM
#ifdef __cplusplus
  inline pascal Boolean URLAccessAvailable()
  {
    return ((URLGetURLAccessVersion != (void *)kUnresolvedCFragSymbolAddress));
  }
#else
#define URLAccessAvailable() \
  ((URLGetURLAccessVersion != (void *)kUnresolvedCFragSymbolAddress))
#endif
#elif TARGET_RT_MAC_MACHO
#ifdef __cplusplus
inline pascal Boolean URLAccessAvailable() { return true; }
#else
#define URLAccessAvailable() (true)
#endif
#endif 
  typedef CALLBACK_API(OSStatus, URLNotifyProcPtr)(void *userContext,
                                                   URLEvent event,
                                                   URLCallbackInfo *callbackInfo);
  typedef CALLBACK_API(OSStatus, URLSystemEventProcPtr)(void *userContext,
                                                        EventRecord *event);
  typedef TVECTOR_UPP_TYPE(URLNotifyProcPtr) URLNotifyUPP;
  typedef TVECTOR_UPP_TYPE(URLSystemEventProcPtr) URLSystemEventUPP;
  URLNotifyUPP
  NewURLNotifyUPP(URLNotifyProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppURLNotifyProcInfo = 0x00000FF0
  }; 
#ifdef __cplusplus
  inline URLNotifyUPP NewURLNotifyUPP(URLNotifyProcPtr userRoutine)
  {
    return userRoutine;
  }
#else
#define NewURLNotifyUPP(userRoutine) (userRoutine)
#endif
#endif
 
  URLSystemEventUPP
  NewURLSystemEventUPP(URLSystemEventProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppURLSystemEventProcInfo = 0x000003F0
  }; 
#ifdef __cplusplus
  inline URLSystemEventUPP
  NewURLSystemEventUPP(URLSystemEventProcPtr userRoutine)
  {
    return userRoutine;
  }
#else
#define NewURLSystemEventUPP(userRoutine) (userRoutine)
#endif
#endif
 
  void
  DisposeURLNotifyUPP(URLNotifyUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeURLNotifyUPP(URLNotifyUPP) {}
#else
#define DisposeURLNotifyUPP(userUPP)
#endif
#endif
 
  void
  DisposeURLSystemEventUPP(URLSystemEventUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeURLSystemEventUPP(URLSystemEventUPP) {}
#else
#define DisposeURLSystemEventUPP(userUPP)
#endif
#endif
 
  OSStatus
  InvokeURLNotifyUPP(void *userContext, URLEvent event,
                     URLCallbackInfo *callbackInfo, URLNotifyUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline OSStatus InvokeURLNotifyUPP(void *userContext, URLEvent event,
                                     URLCallbackInfo *callbackInfo,
                                     URLNotifyUPP userUPP)
  {
    return (*userUPP)(userContext, event, callbackInfo);
  }
#else
#define InvokeURLNotifyUPP(userContext, event, callbackInfo, userUPP) \
  (*userUPP)(userContext, event, callbackInfo)
#endif
#endif
 
  OSStatus
  InvokeURLSystemEventUPP(void *userContext, EventRecord *event,
                          URLSystemEventUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline OSStatus InvokeURLSystemEventUPP(void *userContext, EventRecord *event,
                                          URLSystemEventUPP userUPP)
  {
    return (*userUPP)(userContext, event);
  }
#else
#define InvokeURLSystemEventUPP(userContext, event, userUPP) \
  (*userUPP)(userContext, event)
#endif
#endif
 
  OSStatus
  URLSimpleDownload(const char *url, FSSpec *destination, 
                    Handle destinationHandle,             
                    URLOpenFlags openFlags,
                    URLSystemEventUPP eventProc, 
                    void *userContext);          
  OSStatus
  URLDownload(URLReference urlRef, FSSpec *destination, 
              Handle destinationHandle,                 
              URLOpenFlags openFlags,
              URLSystemEventUPP eventProc, 
              void *userContext);          
  OSStatus
  URLSimpleUpload(const char *url, const FSSpec *source, URLOpenFlags openFlags,
                  URLSystemEventUPP eventProc, 
                  void *userContext);          
  OSStatus
  URLUpload(URLReference urlRef, const FSSpec *source, URLOpenFlags openFlags,
            URLSystemEventUPP eventProc, 
            void *userContext);          
  OSStatus
  URLNewReference(const char *url, URLReference *urlRef);
 
  OSStatus
  URLDisposeReference(URLReference urlRef);
 
  OSStatus
  URLOpen(URLReference urlRef, FSSpec *fileSpec,           
          URLOpenFlags openFlags, URLNotifyUPP notifyProc, 
          URLEventMask eventRegister, void *userContext);  
  OSStatus
  URLAbort(URLReference urlRef);
 
  OSStatus
  URLGetDataAvailable(URLReference urlRef, Size *dataSize);
 
  OSStatus
  URLGetBuffer(URLReference urlRef, void **buffer, Size *bufferSize);
 
  OSStatus
  URLReleaseBuffer(URLReference urlRef, void *buffer);
 
  OSStatus
  URLGetProperty(URLReference urlRef, const char *property, void *propertyBuffer,
                 Size bufferSize);
 
  OSStatus
  URLGetPropertySize(URLReference urlRef, const char *property,
                     Size *propertySize);
 
  OSStatus
  URLSetProperty(URLReference urlRef, const char *property, void *propertyBuffer,
                 Size bufferSize);
 
  OSStatus
  URLGetCurrentState(URLReference urlRef, URLState *state);
 
  OSStatus
  URLGetError(URLReference urlRef, OSStatus *urlError);
 
  OSStatus
  URLIdle(void);
 
  OSStatus
  URLGetFileInfo(StringPtr fName, OSType *fType, OSType *fCreator);
 
#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