1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
|
/*
File: URLAccess.h
Contains: URL Access Interfaces.
Version: QuickTime 7.3
Copyright: (c) 2007 (c) 1994-2000 by Apple Computer, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#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
/* Data structures and types */
typedef struct OpaqueURLReference* URLReference;
typedef UInt32 URLOpenFlags;
enum {
kURLReplaceExistingFlag = 1 << 0,
kURLBinHexFileFlag = 1 << 1, /* Binhex before uploading if necessary*/
kURLExpandFileFlag = 1 << 2, /* Use StuffIt engine to expand file if necessary*/
kURLDisplayProgressFlag = 1 << 3,
kURLDisplayAuthFlag = 1 << 4, /* Display auth dialog if guest connection fails*/
kURLUploadFlag = 1 << 5, /* Do an upload instead of a download*/
kURLIsDirectoryHintFlag = 1 << 6, /* Hint: the URL is a directory*/
kURLDoNotTryAnonymousFlag = 1 << 7, /* Don't try to connect anonymously before getting logon info*/
kURLDirectoryListingFlag = 1 << 8, /* Download the directory listing, not the whole directory*/
kURLExpandAndVerifyFlag = 1 << 9, /* Expand file and then verify using signature resource*/
kURLNoAutoRedirectFlag = 1 << 10, /* Do not automatically redirect to new URL*/
kURLDebinhexOnlyFlag = 1 << 11, /* Do not use Stuffit Expander - just internal debinhex engine*/
kURLDoNotDeleteOnErrorFlag = 1 << 12, /* Do not delete the downloaded file if an error or abort occurs.*/
/* This flag applies to downloading only and should be used if*/
/* interested in later resuming the download.*/
kURLResumeDownloadFlag = 1 << 13, /* The passed in file is partially downloaded, attempt to resume*/
/* it. Currently works for HTTP only. If no FSSpec passed in,*/
/* this flag will be ignored. Overriden by kURLReplaceExistingFlag. */
kURLReservedFlag = (unsigned long)(1 << 31) /* reserved for Apple internal use*/
};
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;
/* authentication type flags*/
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"
/* http and https properties*/
#define kURLHTTPRequestMethod "URLHTTPRequestMethod"
#define kURLHTTPRequestHeader "URLHTTPRequestHeader"
#define kURLHTTPRequestBody "URLHTTPRequestBody"
#define kURLHTTPRespHeader "URLHTTPRespHeader"
#define kURLHTTPUserAgent "URLHTTPUserAgent"
#define kURLHTTPRedirectedURL "URLHTTPRedirectedURL"
#define kURLSSLCipherSuite "URLSSLCipherSuite"
/*
* URLGetURLAccessVersion()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( 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
/* URL Access is always available on OS X */
#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;
/*
* NewURLNotifyUPP()
*
* Availability:
* Non-Carbon CFM: available as macro/inline
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API_C( URLNotifyUPP )
NewURLNotifyUPP(URLNotifyProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
enum { uppURLNotifyProcInfo = 0x00000FF0 }; /* pascal 4_bytes Func(4_bytes, 4_bytes, 4_bytes) */
#ifdef __cplusplus
inline DEFINE_API_C(URLNotifyUPP) NewURLNotifyUPP(URLNotifyProcPtr userRoutine) { return userRoutine; }
#else
#define NewURLNotifyUPP(userRoutine) (userRoutine)
#endif
#endif
/*
* NewURLSystemEventUPP()
*
* Availability:
* Non-Carbon CFM: available as macro/inline
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API_C( URLSystemEventUPP )
NewURLSystemEventUPP(URLSystemEventProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
enum { uppURLSystemEventProcInfo = 0x000003F0 }; /* pascal 4_bytes Func(4_bytes, 4_bytes) */
#ifdef __cplusplus
inline DEFINE_API_C(URLSystemEventUPP) NewURLSystemEventUPP(URLSystemEventProcPtr userRoutine) { return userRoutine; }
#else
#define NewURLSystemEventUPP(userRoutine) (userRoutine)
#endif
#endif
/*
* DisposeURLNotifyUPP()
*
* Availability:
* Non-Carbon CFM: available as macro/inline
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API_C( void )
DisposeURLNotifyUPP(URLNotifyUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
inline DEFINE_API_C(void) DisposeURLNotifyUPP(URLNotifyUPP) {}
#else
#define DisposeURLNotifyUPP(userUPP)
#endif
#endif
/*
* DisposeURLSystemEventUPP()
*
* Availability:
* Non-Carbon CFM: available as macro/inline
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API_C( void )
DisposeURLSystemEventUPP(URLSystemEventUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
inline DEFINE_API_C(void) DisposeURLSystemEventUPP(URLSystemEventUPP) {}
#else
#define DisposeURLSystemEventUPP(userUPP)
#endif
#endif
/*
* InvokeURLNotifyUPP()
*
* Availability:
* Non-Carbon CFM: available as macro/inline
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API_C( OSStatus )
InvokeURLNotifyUPP(
void * userContext,
URLEvent event,
URLCallbackInfo * callbackInfo,
URLNotifyUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
inline DEFINE_API_C(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
/*
* InvokeURLSystemEventUPP()
*
* Availability:
* Non-Carbon CFM: available as macro/inline
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API_C( OSStatus )
InvokeURLSystemEventUPP(
void * userContext,
EventRecord * event,
URLSystemEventUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
inline DEFINE_API_C(OSStatus) InvokeURLSystemEventUPP(void * userContext, EventRecord * event, URLSystemEventUPP userUPP) { return (*userUPP)(userContext, event); }
#else
#define InvokeURLSystemEventUPP(userContext, event, userUPP) (*userUPP)(userContext, event)
#endif
#endif
/*
* URLSimpleDownload()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLSimpleDownload(
const char * url,
FSSpec * destination, /* can be NULL */
Handle destinationHandle, /* can be NULL */
URLOpenFlags openFlags,
URLSystemEventUPP eventProc, /* can be NULL */
void * userContext); /* can be NULL */
/*
* URLDownload()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLDownload(
URLReference urlRef,
FSSpec * destination, /* can be NULL */
Handle destinationHandle, /* can be NULL */
URLOpenFlags openFlags,
URLSystemEventUPP eventProc, /* can be NULL */
void * userContext); /* can be NULL */
/*
* URLSimpleUpload()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLSimpleUpload(
const char * url,
const FSSpec * source,
URLOpenFlags openFlags,
URLSystemEventUPP eventProc, /* can be NULL */
void * userContext); /* can be NULL */
/*
* URLUpload()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLUpload(
URLReference urlRef,
const FSSpec * source,
URLOpenFlags openFlags,
URLSystemEventUPP eventProc, /* can be NULL */
void * userContext); /* can be NULL */
/*
* URLNewReference()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLNewReference(
const char * url,
URLReference * urlRef);
/*
* URLDisposeReference()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLDisposeReference(URLReference urlRef);
/*
* URLOpen()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLOpen(
URLReference urlRef,
FSSpec * fileSpec, /* can be NULL */
URLOpenFlags openFlags,
URLNotifyUPP notifyProc, /* can be NULL */
URLEventMask eventRegister,
void * userContext); /* can be NULL */
/*
* URLAbort()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLAbort(URLReference urlRef);
/*
* URLGetDataAvailable()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLGetDataAvailable(
URLReference urlRef,
Size * dataSize);
/*
* URLGetBuffer()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLGetBuffer(
URLReference urlRef,
void ** buffer,
Size * bufferSize);
/*
* URLReleaseBuffer()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLReleaseBuffer(
URLReference urlRef,
void * buffer);
/*
* URLGetProperty()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLGetProperty(
URLReference urlRef,
const char * property,
void * propertyBuffer,
Size bufferSize);
/*
* URLGetPropertySize()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLGetPropertySize(
URLReference urlRef,
const char * property,
Size * propertySize);
/*
* URLSetProperty()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLSetProperty(
URLReference urlRef,
const char * property,
void * propertyBuffer,
Size bufferSize);
/*
* URLGetCurrentState()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLGetCurrentState(
URLReference urlRef,
URLState * state);
/*
* URLGetError()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLGetError(
URLReference urlRef,
OSStatus * urlError);
/*
* URLIdle()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( OSStatus )
URLIdle(void);
/*
* URLGetFileInfo()
*
* Availability:
* Non-Carbon CFM: in URLAccessLib 1.0 and later
* CarbonLib: in CarbonLib 1.0 and later
* Mac OS X: in version 10.0 and later
*/
EXTERN_API( 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 /* __URLACCESS__ */
|