2008-08-19 Zoltan Varga <vargaz@gmail.com>
[mono.git] / mono / io-layer / io.h
1 /*
2  * io.h: File, console and find handles
3  *
4  * Author:
5  *      Dick Porter (dick@ximian.com)
6  *
7  * (C) 2002 Ximian, Inc.
8  */
9
10 #ifndef _WAPI_IO_H_
11 #define _WAPI_IO_H_
12
13 #include <stdlib.h>
14
15 #include "mono/io-layer/wapi.h"
16 #include "mono/io-layer/timefuncs.h"
17
18 G_BEGIN_DECLS
19
20 typedef struct _WapiSecurityAttributes WapiSecurityAttributes;
21
22 struct _WapiSecurityAttributes 
23 {
24         guint32 nLength;
25         gpointer lpSecurityDescriptor;
26         gboolean bInheritHandle;
27 };
28
29 typedef struct _WapiOverlapped WapiOverlapped;
30
31 struct _WapiOverlapped
32 {
33         guint32 Internal;
34         guint32 InternalHigh;
35         guint32 Offset;
36         guint32 OffsetHigh;
37         gpointer hEvent;
38         gpointer handle1;
39         gpointer handle2;
40 };
41
42 typedef void (*WapiOverlappedCB) (guint32 error, guint32 numbytes,
43                                   WapiOverlapped *overlapped);
44
45 #define GENERIC_READ    0x80000000
46 #define GENERIC_WRITE   0x40000000
47 #define GENERIC_EXECUTE 0x20000000
48 #define GENERIC_ALL     0x10000000
49
50 #define FILE_SHARE_READ         0x00000001
51 #define FILE_SHARE_WRITE        0x00000002
52 #define FILE_SHARE_DELETE       0x00000004
53
54 #define CREATE_NEW              1
55 #define CREATE_ALWAYS           2
56 #define OPEN_EXISTING           3
57 #define OPEN_ALWAYS             4
58 #define TRUNCATE_EXISTING       5
59
60
61 #define FILE_ATTRIBUTE_READONLY                 0x00000001
62 #define FILE_ATTRIBUTE_HIDDEN                   0x00000002
63 #define FILE_ATTRIBUTE_SYSTEM                   0x00000004
64 #define FILE_ATTRIBUTE_DIRECTORY                0x00000010
65 #define FILE_ATTRIBUTE_ARCHIVE                  0x00000020
66 #define FILE_ATTRIBUTE_ENCRYPTED                0x00000040
67 #define FILE_ATTRIBUTE_NORMAL                   0x00000080
68 #define FILE_ATTRIBUTE_TEMPORARY                0x00000100
69 #define FILE_ATTRIBUTE_SPARSE_FILE              0x00000200
70 #define FILE_ATTRIBUTE_REPARSE_POINT            0x00000400
71 #define FILE_ATTRIBUTE_COMPRESSED               0x00000800
72 #define FILE_ATTRIBUTE_OFFLINE                  0x00001000
73 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED      0x00002000
74 #define FILE_FLAG_OPEN_NO_RECALL                0x00100000
75 #define FILE_FLAG_OPEN_REPARSE_POINT            0x00200000
76 #define FILE_FLAG_POSIX_SEMANTICS               0x01000000
77 #define FILE_FLAG_BACKUP_SEMANTICS              0x02000000
78 #define FILE_FLAG_DELETE_ON_CLOSE               0x04000000
79 #define FILE_FLAG_SEQUENTIAL_SCAN               0x08000000
80 #define FILE_FLAG_RANDOM_ACCESS                 0x10000000
81 #define FILE_FLAG_NO_BUFFERING                  0x20000000
82 #define FILE_FLAG_OVERLAPPED                    0x40000000
83 #define FILE_FLAG_WRITE_THROUGH                 0x80000000
84
85 #define REPLACEFILE_WRITE_THROUGH       0x00000001
86 #define REPLACEFILE_IGNORE_MERGE_ERRORS 0x00000002
87
88 #define MAX_PATH        260
89
90 typedef enum {
91         STD_INPUT_HANDLE=-10,
92         STD_OUTPUT_HANDLE=-11,
93         STD_ERROR_HANDLE=-12
94 } WapiStdHandle;
95
96 typedef enum {
97         FILE_BEGIN=0,
98         FILE_CURRENT=1,
99         FILE_END=2
100 } WapiSeekMethod;
101
102 typedef enum {
103         FILE_TYPE_UNKNOWN=0x0000,
104         FILE_TYPE_DISK=0x0001,
105         FILE_TYPE_CHAR=0x0002,
106         FILE_TYPE_PIPE=0x0003,
107         FILE_TYPE_REMOTE=0x8000
108 } WapiFileType;
109
110 typedef enum {
111         GetFileExInfoStandard=0x0000,
112         GetFileExMaxInfoLevel=0x0001
113 } WapiGetFileExInfoLevels;
114
115 typedef struct 
116 {
117         guint16 wYear;
118         guint16 wMonth;
119         guint16 wDayOfWeek;
120         guint16 wDay;
121         guint16 wHour;
122         guint16 wMinute;
123         guint16 wSecond;
124         guint16 wMilliseconds;
125 } WapiSystemTime;
126
127 typedef struct
128 {
129         guint32 dwFileAttributes;
130         WapiFileTime ftCreationTime;
131         WapiFileTime ftLastAccessTime;
132         WapiFileTime ftLastWriteTime;
133         guint32 nFileSizeHigh;
134         guint32 nFileSizeLow;
135         guint32 dwReserved0;
136         guint32 dwReserved1;
137         gunichar2 cFileName [MAX_PATH];
138         gunichar2 cAlternateFileName [14];
139 } WapiFindData;
140
141 typedef struct
142 {
143         guint32 dwFileAttributes;
144         WapiFileTime ftCreationTime;
145         WapiFileTime ftLastAccessTime;
146         WapiFileTime ftLastWriteTime;
147         guint32 nFileSizeHigh;
148         guint32 nFileSizeLow;
149 } WapiFileAttributesData;
150
151 #define INVALID_SET_FILE_POINTER ((guint32)-1)
152 #define INVALID_FILE_SIZE ((guint32)0xFFFFFFFF)
153 #define INVALID_FILE_ATTRIBUTES ((guint32)-1)
154
155 extern gpointer CreateFile(const gunichar2 *name, guint32 fileaccess,
156                            guint32 sharemode,
157                            WapiSecurityAttributes *security,
158                            guint32 createmode,
159                            guint32 attrs, gpointer tmplate);
160 extern gboolean DeleteFile(const gunichar2 *name);
161 extern gpointer GetStdHandle(WapiStdHandle stdhandle);
162 extern gboolean ReadFile(gpointer handle, gpointer buffer, guint32 numbytes,
163                          guint32 *bytesread, WapiOverlapped *overlapped);
164 extern gboolean WriteFile(gpointer handle, gconstpointer buffer,
165                           guint32 numbytes, guint32 *byteswritten,
166                           WapiOverlapped *overlapped);
167 extern gboolean FlushFileBuffers(gpointer handle);
168 extern gboolean SetEndOfFile(gpointer handle);
169 extern guint32 SetFilePointer(gpointer handle, gint32 movedistance,
170                               gint32 *highmovedistance, WapiSeekMethod method);
171 extern WapiFileType GetFileType(gpointer handle);
172 extern guint32 GetFileSize(gpointer handle, guint32 *highsize);
173 extern gboolean GetFileTime(gpointer handle, WapiFileTime *create_time,
174                             WapiFileTime *last_access,
175                             WapiFileTime *last_write);
176 extern gboolean SetFileTime(gpointer handle, const WapiFileTime *create_time,
177                             const WapiFileTime *last_access,
178                             const WapiFileTime *last_write);
179 extern gboolean FileTimeToSystemTime(const WapiFileTime *file_time,
180                                      WapiSystemTime *system_time);
181 extern gpointer FindFirstFile (const gunichar2 *pattern,
182                                WapiFindData *find_data);
183 extern gboolean FindNextFile (gpointer handle, WapiFindData *find_data);
184 extern gboolean FindClose (gpointer handle);
185 extern gboolean CreateDirectory (const gunichar2 *name,
186                                  WapiSecurityAttributes *security);
187 extern gboolean RemoveDirectory (const gunichar2 *name);
188 extern gboolean MoveFile (const gunichar2 *name, const gunichar2 *dest_name);
189 extern gboolean CopyFile (const gunichar2 *name, const gunichar2 *dest_name,
190                           gboolean fail_if_exists);
191 extern gboolean ReplaceFile (const gunichar2 *replacedFileName, const gunichar2 *replacementFileName,
192                              const gunichar2 *backupFileName, guint32 replaceFlags, 
193                              gpointer exclude, gpointer reserved);
194 extern guint32 GetFileAttributes (const gunichar2 *name);
195 extern gboolean GetFileAttributesEx (const gunichar2 *name,
196                                      WapiGetFileExInfoLevels level,
197                                      gpointer info);
198 extern gboolean SetFileAttributes (const gunichar2 *name, guint32 attrs);
199 extern guint32 GetCurrentDirectory (guint32 length, gunichar2 *buffer);
200 extern gboolean SetCurrentDirectory (const gunichar2 *path);
201 extern gboolean CreatePipe (gpointer *readpipe, gpointer *writepipe,
202                             WapiSecurityAttributes *security, guint32 size);
203 extern guint32 GetTempPath (guint32 len, gunichar2 *buf);
204 extern gint32 GetLogicalDriveStrings (guint32 len, gunichar2 *buf);
205 extern gboolean LockFile (gpointer handle, guint32 offset_low,
206                           guint32 offset_high, guint32 length_low,
207                           guint32 length_high);
208 extern gboolean UnlockFile (gpointer handle, guint32 offset_low,
209                             guint32 offset_high, guint32 length_low,
210                             guint32 length_high);
211
212 G_END_DECLS
213
214 #endif /* _WAPI_IO_H_ */