forked from cellularmitosis/ADC-reference-library-2009-july
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlisting6.html
More file actions
executable file
·373 lines (310 loc) · 16 KB
/
Copy pathlisting6.html
File metadata and controls
executable file
·373 lines (310 loc) · 16 KB
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>FSMegaInfo - /Command.h</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/Darwin/index.html">Darwin</a> > <a href="../../samplecode/Darwin/idxFileManagement-date.html">File Management</a> > <A HREF="javascript:location.replace('index.html');">FSMegaInfo</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">FSMegaInfo</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/Command.h</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/AliasManager.c</option>
<option value="listing2.html">/BSD.c</option>
<option value="listing3.html">/BSD.h</option>
<option value="listing4.html">/BSDAttrList.c</option>
<option value="listing5.html">/Command.c</option>
<option value="listing6.html">/Command.h</option>
<option value="listing7.html">/DiskArb.c</option>
<option value="listing8.html">/FieldPrinter.c</option>
<option value="listing9.html">/FieldPrinter.h</option>
<option value="listing10.html">/FileManager.c</option>
<option value="listing11.html">/FolderManager.c</option>
<option value="listing12.html">/FSMegaInfo.c</option>
<option value="listing13.html">/Read Me About FSMegaInfo.txt</option>
<option value="listing14.html">/Tests/ten-five-intel.txt</option>
<option value="listing15.html">/Tests/ten-five-one-ppc64.txt</option>
<option value="listing16.html">/Tests/ten-five-ppc.txt</option>
<option value="listing17.html">/Tests/ten-four-eleven-intel.txt</option>
<option value="listing18.html">/Tests/ten-four-eleven-ppc.txt</option></select>
</p>
</form>
<p><strong><a href="FSMegaInfo.zip">Download Sample</a></strong> (“FSMegaInfo.zip”, 522.7K)<BR>
<strong><a href="FSMegaInfo.dmg">Download Sample</a></strong> (“FSMegaInfo.dmg”, 920.2K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
File: Command.h
Contains: Declarations and utilities for command processing.
Written by: DTS
Copyright: Copyright (c) 2008 Apple Inc. All Rights Reserved.
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple 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 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.
*/
#ifndef _COMMAND_H
#define _COMMAND_H
/////////////////////////////////////////////////////////////////
// System interfaces
#include <CoreServices/CoreServices.h>
// Project interfaces
#include "FieldPrinter.h"
/////////////////////////////////////////////////////////////////
#pragma mark ***** Command Errors
typedef int errno_t;
#define EUSAGE 666
enum {
kCommandUsageErr = 666
};
enum CommandErrorDomain {
kCommandErrorCustom,
kCommandErrorErrno,
kCommandErrorOSStatus
};
typedef enum CommandErrorDomain CommandErrorDomain;
enum CustomError {
kUsageCustomError,
kUnavailableCustomError
};
typedef enum CustomError CustomError;
struct CommandError {
CommandErrorDomain domain;
union {
CustomError errCustom;
errno_t errErrno;
OSStatus errOSStatus;
} u;
};
typedef struct CommandError CommandError;
extern CommandError CommandErrorMakeWithCustom(CustomError errNum);
extern CommandError CommandErrorMakeWithErrno(int errNum);
extern CommandError CommandErrorMakeWithOSStatus(OSStatus errNum);
// Makes one of the three flavours of command error.
extern bool CommandErrorIsNoError(CommandError commandError);
extern bool CommandErrorIsUsage(CommandError commandError);
// Returns true if the error is no error or a usage error, respectively.
extern void CommandErrorPrint(CommandError commandError, const char *operation, uint32_t indent);
// Prints a message explaining that an error occurred.
/////////////////////////////////////////////////////////////////
#pragma mark ***** Command Arguments
typedef const char ***CommandArgsRef;
// CommandArgsRef is a reference to the arguments of the command. It's best
// not to try to interpret this value yourself; rather, call one of the
// accessor routines below.
extern bool CommandArgsValid(CommandArgsRef args);
// Returns true if args looks reasonable.
// IMPORTANT:
// None of these routines require you to 'free' the returned value in any way.
extern errno_t CommandArgsGetString(CommandArgsRef args, const char **strPtr);
// Returns and consumes an argument string, or returns EUSAGE if none is available.
extern OSStatus CommandArgsGetStringOSStatus(CommandArgsRef args, const char **strPtr);
// Returns and consumes an argument string, or returns kCommandUsageErr if none is available.
extern OSStatus CommandArgsGetVRefNum(CommandArgsRef args, FSVolumeRefNum *vRefNumPtr);
// Consumes an argument denoting a volume (as a name) and returns the vRefNum.
extern OSStatus CommandArgsGetFSRef(CommandArgsRef args, FSRef *fsRefPtr);
// Consumes an argument denoting a file system object (as a full path) and returns the FSRef.
extern void SetDontFollowLeafSymLinksForFSRefs(void);
// Controls whether CommandArgsGetFSRef follows leaf symlinks or not. By default
// it does. The main program calls this routine if the user specifies an argument
// to inhibit that behaviour.
extern bool CommandArgsIsOption(CommandArgsRef args);
// Returns true if the next argument represents an option (that is, starts with
// "-"). Does not consume the argument.
extern bool CommandArgsGetOptionString(CommandArgsRef args, const char **optionArgPtr);
// Returns true if the next argument is an option string (that is, it starts with
// "-"). If it returns true, it also returns and consumes that argument.
extern bool CommandArgsGetOptionalConstantString(CommandArgsRef args, const char *optionalArg);
// Returns true if the next argument is the value specified in optionalArg. If
// it returns true, it also consumes that argument.
extern errno_t CommandArgsGetFlagList(CommandArgsRef args, const FPFlagDesc flagList[], uint64_t *resultPtr);
// Given a null-terminated array of flags, this routines checks to see if the
// next argument is an option (that is, it starts with "-") and, if it is,
// parsing the remaining characters in the string as a set of comma separated
// flags. Returns the value of the flags, combined, in *resultPtr.
extern errno_t CommandArgsGetFlagListInt(CommandArgsRef args, const FPFlagDesc flagList[], int *resultPtr);
// As CommandArgsGetFlagList, but returns the flags in an int.
extern errno_t CommandArgsGetSizeT(CommandArgsRef args, size_t *argPtr);
// Consumes an argument and returns its value as a size_t.
extern errno_t CommandArgsGetInt(CommandArgsRef args, int *argPtr);
// Consumes an argument and returns its value as an int.
typedef errno_t (*CommandParseItemStringTester)(const char *item, void *refCon);
// The callback for CommandParseItemString. Checks that the specified item
// is valid.
extern errno_t CommandParseItemString(const char *str, char delimiter, CommandParseItemStringTester itemTester, void *refCon);
// Parses a string as a list of items separated by delimeter. Calls itemTester
// to verify that each item is valid.
/////////////////////////////////////////////////////////////////
#pragma mark ***** Command Implementation and Help
typedef CommandError (*CommandProc)(CommandArgsRef args, uint32_t indent, uint32_t verbose);
// CommandProc represents the implementation entry point for each command.
// Discussed in more detail below.
// Each command has an optional array of help entries that provide help about that command.
// Each help entry contains a pointer to a help printing routine and a parameter for that
// routine. This allows most help to be printer by a few standard routines, declared below.
typedef void (*CommandHelpProc)(uint32_t indent, uint32_t verbose, const void *param);
// CommandHelpProc represents a help printing entry point.
// CommandHelpStandardPreCondition is a macro that you can assert in your help
// routines to check their incoming parameters. It's a macro so that it can
// access the parameters by name.
#define CommandHelpStandardPreCondition() \
(true) // nothing to check at the moment
struct CommandHelpEntry {
CommandHelpProc proc;
const void * param;
};
typedef struct CommandHelpEntry CommandHelpEntry;
extern void CommandHelpString(uint32_t indent, uint32_t verbose, const void *param);
// Prints a constant string help item. param is a pointer to that string.
extern void CommandHelpFlags(uint32_t indent, uint32_t verbose, const void *param);
// Prints a flags help item. params is a pointer to a null-terminated FPFlagDesc array.
extern void CommandHelpEnum(uint32_t indent, uint32_t verbose, const void *param);
// Prints an enum help item. params is a pointer to a null-terminated FPEnumDesc array.
// The CommandInfo structure describes a particular command, including a pointer
// to the routine that implements the command, the short name of the command,
// the argument summary (for printing usage), a one-line command description,
// and an array of help entries that provide multi-line help.
// proc to call, the name of the proc, and the usage.
struct CommandInfo {
CommandProc proc;
const char * name;
const char * argSummary;
const char * description;
const CommandHelpEntry * help;
};
typedef struct CommandInfo CommandInfo;
#endif
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/FSMegaInfo/listing6.html%3Fid%3DDTS10004032-1.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/FSMegaInfo/listing6.html%3Fid%3DDTS10004032-1.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/FSMegaInfo/listing6.html%3Fid%3DDTS10004032-1.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>