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
|
/**
* @file FSCopyObject.h
* @brief Mac OSX updater program
*
* Copyright (c) 2004-2007, Linden Research, Inc.
*
* Second Life Viewer Source Code
* The source code in this file ("Source Code") is provided by Linden Lab
* to you under the terms of the GNU General Public License, version 2.0
* ("GPL"), unless you have obtained a separate licensing agreement
* ("Other License"), formally executed by you and Linden Lab. Terms of
* the GPL can be found in doc/GPL-license.txt in this distribution, or
* online at http://secondlife.com/developers/opensource/gplv2
*
* There are special exceptions to the terms and conditions of the GPL as
* it is applied to this Source Code. View the full text of the exception
* in the file doc/FLOSS-exception.txt in this software distribution, or
* online at http://secondlife.com/developers/opensource/flossexception
*
* By copying, modifying or distributing this software, you acknowledge
* that you have read and understood your obligations described above,
* and agree to abide by those obligations.
*
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
* COMPLETENESS OR PERFORMANCE.
*/
/*
File: FSCopyObject.h
Contains: A Copy/Delete Files/Folders engine which uses the HFS+ API's
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Computer, Inc.
("Apple") in consideration of your agreement to the following terms, and your
use, installation, modification or redistribution of this Apple software
constitutes acceptance of these terms. If you do not agree with these terms,
please do not use, install, modify or redistribute this Apple software.
In consideration of your agreement to abide by the following terms, and subject
to these terms, Apple grants you a personal, non-exclusive license, under AppleÕs
copyrights in this original Apple software (the "Apple Software"), to use,
reproduce, modify and redistribute the Apple Software, with or without
modifications, in source and/or binary forms; provided that if you redistribute
the Apple Software in its entirety and without modifications, you must retain
this notice and the following text and disclaimers in all such redistributions of
the Apple Software. Neither the name, trademarks, service marks or logos of
Apple Computer, Inc. may be used to endorse or promote products derived from the
Apple Software without specific prior written permission from Apple. Except as
expressly stated in this notice, no other rights or licenses, express or implied,
are granted by Apple herein, including but not limited to any patent rights that
may be infringed by your derivative works or by other works in which the Apple
Software may be incorporated.
The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
COMBINATION WITH YOUR PRODUCTS.
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT
(INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Copyright © 2002-2004 Apple Computer, Inc., All Rights Reserved
*/
#ifndef __FSCOPYOBJECT_H__
#define __FSCOPYOBJECT_H__
#ifdef __cplusplus
extern "C" {
#endif
#if TARGET_API_MAC_OSX || defined( __APPLE_CC__ )
#include <CoreServices/CoreServices.h>
#endif
#define DEBUG 1 /* set to zero if you don't want debug spew */
#if DEBUG
#include <stdio.h>
#define QuoteExceptionString(x) #x
#define dwarning(s) do { printf s; fflush(stderr); } while( 0 )
#define mycheck_noerr( error ) \
do { \
if( (OSErr) error != noErr ) { \
dwarning((QuoteExceptionString(error) " != noErr in File: %s, Function: %s, Line: %d, Error: %d\n", \
__FILE__, __FUNCTION__, __LINE__, (OSErr) error)); \
} \
} while( false )
#define mycheck( assertion ) \
do { \
if( ! assertion ) { \
dwarning((QuoteExceptionString(assertion) " failed in File: %s, Function: %s, Line: %d\n", \
__FILE__, __FUNCTION__, __LINE__)); \
} \
} while( false )
#define myverify(assertion) mycheck(assertion)
#define myverify_noerr(assertion) mycheck_noerr( (assertion) )
#else
#define dwarning(s)
#define mycheck(assertion)
#define mycheck_noerr(err)
#define myverify(assertion) do { (void) (assertion); } while (0)
#define myverify_noerr(assertion) myverify(assertion)
#endif
/*
This code takes some tricks/techniques from MoreFilesX (by Jim Luther) and
MPFileCopy (by Quinn), wraps them all up into an easy to use API, and adds a bunch of
features and bug fixes. It will run on Mac OS 9.1 through 9.2.x and 10.1.x
and up (Classic, Carbon and Mach-O)
*/
/* Different options that FSCopyObject can take during a copy */
typedef UInt32 DupeAction;
enum {
kDupeActionStandard, /* will do the copy with no frills */
kDupeActionReplace, /* will delete the existing object and then copy over the new one */
kDupeActionRename /* will rename the new object if an object of the same name exists */
};
/*****************************************************************************/
#pragma mark CopyObjectFilterProcPtr
/*
This is the prototype for the CallCopyObjectFilterProc function which
is called once for each file and directory found by FSCopyObject.
The CallCopyObjectFilterProc can use the read-only data it receives for
whatever it wants.
The result of the CallCopyObjectFilterProc function indicates if
the copy should be stopped. To stop the copy, return an error; to continue
the copy, return noErr.
The yourDataPtr parameter can point to whatever data structure you might
want to access from within the CallCopyObjectFilterProc.
Note: If an error had occured during the copy of the current object
(currentOSErr != noErr) the FSRef etc might not be valid
containerChanged --> Set to true if the container's contents changed
during iteration.
currentLevel --> The current recursion level into the container.
1 = the container, 2 = the container's immediate
subdirectories, etc.
currentOSErr --> The current error code, shows the results of the
copy of the current object (ref)
catalogInfo --> The catalog information for the current object.
Only the fields requested by the whichInfo
parameter passed to FSIterateContainer are valid.
ref --> The FSRef to the current object.
spec --> The FSSpec to the current object if the wantFSSpec
parameter passed to FSCopyObject is true.
name --> The name of the current object if the wantName
parameter passed to FSCopyObject is true.
yourDataPtr --> An optional pointer to whatever data structure you
might want to access from within the
CallCopyObjectFilterProc.
result <-- To continue the copy, return noErr
__________
Also see: FSCopyObject
*/
typedef CALLBACK_API( OSErr , CopyObjectFilterProcPtr ) (
Boolean containerChanged,
ItemCount currentLevel,
OSErr currentOSErr,
const FSCatalogInfo *catalogInfo,
const FSRef *ref,
const FSSpec *spec,
const HFSUniStr255 *name,
void *yourDataPtr);
/*****************************************************************************/
#pragma mark CallCopyObjectFilterProc
#define CallCopyObjectFilterProc(userRoutine, containerChanged, currentLevel, currentOSErr, catalogInfo, ref, spec, name, yourDataPtr) \
(*(userRoutine))((containerChanged), (currentLevel), (currentOSErr), (catalogInfo), (ref), (spec), (name), (yourDataPtr))
/*****************************************************************************/
#pragma mark FSCopyObject
/*
The FSCopyObject function takes a source object (can be a file or directory)
and copies it (and its contents if it's a directory) to the new destination
directory.
It will call your CopyObjectFilterProcPtr once for each object copied
The maxLevels parameter is only used when the object is a directory,
ignored otherwise.
It lets you control how deep the recursion goes.
If maxLevels is 1, FSCopyObject only scans the specified directory;
if maxLevels is 2, FSCopyObject scans the specified directory and
one subdirectory below the specified directory; etc. Set maxLevels to
zero to scan all levels.
The yourDataPtr parameter can point to whatever data structure you might
want to access from within your CopyObjectFilterProcPtr.
source --> The FSRef to the object you want to copy
destDir --> The FSRef to the directory you wish to copy source to
maxLevels --> Maximum number of directory levels to scan or
zero to scan all directory levels, ignored if the
object is a file
whichInfo --> The fields of the FSCatalogInfo you wish passed
to you in your CopyObjectFilterProc
dupeAction --> The action to take if an object of the same name exists
in the destination
newName --> The name you want the new object to have. If you pass
in NULL, the source object name will be used.
wantFSSpec --> Set to true if you want the FSSpec to each
object passed to your CopyObjectFilterProc.
wantName --> Set to true if you want the name of each
object passed to your CopyObjectFilterProc.
filterProcPtr --> A pointer to the CopyObjectFilterProc you
want called once for each object found
by FSCopyObject.
yourDataPtr --> An optional pointer to whatever data structure you
might want to access from within the
CopyObjectFilterProc.
newObjectRef --> An optional pointer to an FSRef that, on return,
references the new object. If you don't want this
info returned, pass in NULL
newObjectSpec --> An optional pointer to an FSSPec that, on return,
references the new object. If you don't want this
info returned, pass in NULL
*/
OSErr FSCopyObject( const FSRef *source,
const FSRef *destDir,
ItemCount maxLevels,
FSCatalogInfoBitmap whichInfo,
DupeAction dupeAction,
const HFSUniStr255 *newName, /* can be NULL */
Boolean wantFSSpec,
Boolean wantName,
CopyObjectFilterProcPtr filterProcPtr, /* can be NULL */
void *yourDataPtr, /* can be NULL */
FSRef *newObjectRef, /* can be NULL */
FSSpec *newObjectSpec); /* can be NULL */
/*****************************************************************************/
#pragma mark FSDeleteObjects
/*
The FSDeleteObjects function takes an FSRef to a file or directory
and attempts to delete it. If the object is a directory, all files
and subdirectories in the specified directory are deleted. If a
locked file or directory is encountered, it is unlocked and then
deleted. After deleting the directory's contents, the directory
is deleted. If any unexpected errors are encountered,
FSDeleteContainer quits and returns to the caller.
source --> FSRef to an object (can be file or directory).
__________
*/
OSErr FSDeleteObjects( const FSRef *source );
#ifdef __cplusplus
}
#endif
#endif
|
