]> git.saurik.com Git - apple/hfs.git/blame_incremental - fsck_hfs/fsck_keys.h
hfs-226.1.1.tar.gz
[apple/hfs.git] / fsck_hfs / fsck_keys.h
... / ...
CommitLineData
1/*
2 * Copyright (c) 2008 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24/* fsck_keys.h
25 *
26 * This file contains the key-value strings that a client can expect
27 * to receive from fsck when it generates XML output. The clients
28 * should use this file to parse fsck output.
29 */
30
31#ifndef _FSCK_KEYS_H
32#define _FSCK_KEYS_H
33
34/*
35 * Keys for the plist generated by fsck
36 */
37#define kfsckVerbosity "fsck_verbosity" /* Verbosity level at which this message should be displayed to the user */
38#define kfsckType "fsck_msg_type" /* Type of fsck message (status, error, etc.) */
39#define kfsckMsgNumber "fsck_msg_number" /* Unique number associated with given message string */
40#define kfsckMsgString "fsck_msg_string" /* String that should be displayed to the user */
41#define kfsckParams "parameters" /* Array of parameters, if any, for the message string */
42
43/*
44 * Keys for type of parameters, if any, for the message strings.
45 * The UI client can simply display the parameters to the user,
46 * or can handle them differently.
47 */
48#define kfsckParamIntegerKey "integer" /* positive integer */
49#define kfsckParamLongKey "long" /* positive long number */
50#define kfsckParamStringKey "string" /* UTF-8 string */
51#define kfsckParamPathKey "path" /* path to a file or directory in the volume */
52#define kfsckParamFileKey "file" /* name of file */
53#define kfsckParamDirectoryKey "directory" /* name of directory */
54#define kfsckParamVolumeKey "volumename" /* name of a volume */
55#define kfsckParamFSTypeKey "fstype" /* type of file system being checked */
56
57/*
58 * The type of messages that can be generated by fsck_hfs.
59 * These are the values corresponding to fsck_msg_type.
60 */
61#define kfsckUnknown "UNKNOWN" /* type of message generated is unknown */
62#define kfsckVerify "VERIFY" /* fsck is performing a read-only operation on the volume */
63#define kfsckRepair "REPAIR" /* fsck is writing to file system to repair a corruption */
64#define kfsckSuccess "SUCCESS" /* verify found that the volume is clean, or repair was successful */
65#define kfsckFail "FAIL" /* verify found that the volume is corrupt, or verify did not complete due to error, or repair failed */
66#define kfsckError "ERROR" /* information of corruption found or condition that causes verify/repair to fail */
67#define kfsckDamageinfo "DAMAGEINFO" /* information about corrupt files/folders */
68#define kfsckInformation "INFORMATION" /* information about an error message or any fsck operation */
69#define kfsckProgress "PROGRESS" /* percentage progress of verify/repair operation */
70
71/* Verbosity levels */
72#define kfsckLevel0 "0" /* level 0 messages should always be displayed to the user */
73#define kfsckLevel1 "1" /* level 1 messages should be only displayed in advanced mode */
74
75#endif /* _FSCK_KEYS_H */