mcs/class/corlib/System.IO/MonoIO.cs

   1 //
   2 // System.IO.MonoIO.cs: static interface to native filesystem.
   3 //
   4 // Author:
   5 //   Dan Lewis (dihlewis@yahoo.co.uk)
   6 //   Dick Porter (dick@ximian.com)
   7 //
   8 // (C) 2002
   9 //
  10
  11 //
  12 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  13 //
  14 // Permission is hereby granted, free of charge, to any person obtaining
  15 // a copy of this software and associated documentation files (the
  16 // "Software"), to deal in the Software without restriction, including
  17 // without limitation the rights to use, copy, modify, merge, publish,
  18 // distribute, sublicense, and/or sell copies of the Software, and to
  19 // permit persons to whom the Software is furnished to do so, subject to
  20 // the following conditions:
  21 //
  22 // The above copyright notice and this permission notice shall be
  23 // included in all copies or substantial portions of the Software.
  24 //
  25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  32 //
  33
  34 using System;
  35 using System.Runtime.CompilerServices;
  36 using System.Runtime.InteropServices;
  37 using System.Threading;
  38
  39 namespace System.IO
  40 {
  41         unsafe internal sealed class MonoIO {
  42                 public static readonly FileAttributes
  43                         InvalidFileAttributes = (FileAttributes)(-1);
  44
  45                 public static readonly IntPtr
  46                         InvalidHandle = (IntPtr)(-1L);
  47
  48                 public static readonly bool SupportsAsync = GetSupportsAsync ();
  49
  50                 // error methods
  51
  52                 public static Exception GetException (MonoIOError error)
  53                 {
  54                         return GetException (String.Empty, error);
  55                 }
  56
  57                 public static Exception GetException (string path,
  58                                                       MonoIOError error)
  59                 {
  60                         string message;
  61
  62                         switch (error) {
  63                         // FIXME: add more exception mappings here
  64                         case MonoIOError.ERROR_FILE_NOT_FOUND:
  65                                 message = String.Format ("Could not find file \"{0}\"", path);
  66                                 return new FileNotFoundException (message,
  67                                                                   path);
  68
  69                         case MonoIOError.ERROR_PATH_NOT_FOUND:
  70                                 message = String.Format ("Could not find a part of the path \"{0}\"", path);
  71                                 return new DirectoryNotFoundException (message);
  72
  73                         case MonoIOError.ERROR_ACCESS_DENIED:
  74                                 message = String.Format ("Access to the path \"{0}\" is denied.", path);
  75                                 return new UnauthorizedAccessException (message);
  76
  77                         case MonoIOError.ERROR_FILE_EXISTS:
  78                                 message = String.Format ("Could not create file \"{0}\". File already exists.", path);
  79                                 return new IOException (message);
  80
  81                         case MonoIOError.ERROR_FILENAME_EXCED_RANGE:
  82                                 message = String.Format ("Path is too long. Path: {0}", path);
  83                                 return new PathTooLongException (message);
  84
  85                         case MonoIOError.ERROR_INVALID_PARAMETER:
  86                                 message = String.Format ("Invalid parameter");
  87                                 return new IOException (message);
  88
  89                         default:
  90                                 message = String.Format ("Win32 IO returned {0}. Path: {1}", error, path);
  91                                 return new IOException (message);
  92                         }
  93                 }
  94
  95                 // directory methods
  96
  97                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
  98                 public extern static bool CreateDirectory (string path, out MonoIOError error);
  99
 100                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 101                 public extern static bool RemoveDirectory (string path, out MonoIOError error);
 102
 103                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 104                 public extern static IntPtr FindFirstFile (string path, out MonoIOStat stat, out MonoIOError error);
 105
 106                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 107                 public extern static bool FindNextFile (IntPtr find, out MonoIOStat stat, out MonoIOError error);
 108
 109                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 110                 public extern static bool FindClose (IntPtr find,
 111                                                      out MonoIOError error);
 112
 113                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 114                 public extern static string GetCurrentDirectory (out MonoIOError error);
 115
 116                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 117                 public extern static bool SetCurrentDirectory (string path, out MonoIOError error);
 118
 119                 // file methods
 120
 121                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 122                 public extern static bool MoveFile (string path, string dest,
 123                                                     out MonoIOError error);
 124
 125                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 126                 public extern static bool CopyFile (string path, string dest,
 127                                                     bool overwrite,
 128                                                     out MonoIOError error);
 129
 130                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 131                 public extern static bool DeleteFile (string path,
 132                                                       out MonoIOError error);
 133
 134                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 135                 public extern static FileAttributes GetFileAttributes (string path, out MonoIOError error);
 136
 137                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 138                 public extern static bool SetFileAttributes (string path, FileAttributes attrs, out MonoIOError error);
 139
 140                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 141                 public extern static MonoFileType GetFileType (IntPtr handle, out MonoIOError error);
 142
 143                 // aio_* methods
 144                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 145                 extern static bool GetSupportsAsync ();
 146
 147                 public static bool Exists (string path, out MonoIOError error)
 148                 {
 149                         FileAttributes attrs = GetFileAttributes (path,
 150                                                                   out error);
 151                         if (attrs == InvalidFileAttributes)
 152                                 return false;
 153
 154                         return true;
 155                 }
 156
 157                 public static bool ExistsFile (string path,
 158                                                out MonoIOError error)
 159                 {
 160                         FileAttributes attrs = GetFileAttributes (path,
 161                                                                   out error);
 162                         if (attrs == InvalidFileAttributes)
 163                                 return false;
 164
 165                         if ((attrs & FileAttributes.Directory) != 0)
 166                                 return false;
 167
 168                         return true;
 169                 }
 170
 171                 public static bool ExistsDirectory (string path,
 172                                                     out MonoIOError error)
 173                 {
 174                         FileAttributes attrs = GetFileAttributes (path,
 175                                                                   out error);
 176
 177                         // Actually, we are looking for a directory, not a file
 178                         if (error == MonoIOError.ERROR_FILE_NOT_FOUND)
 179                                 error = MonoIOError.ERROR_PATH_NOT_FOUND;
 180
 181                         if (attrs == InvalidFileAttributes)
 182                                 return false;
 183
 184                         if ((attrs & FileAttributes.Directory) == 0)
 185                                 return false;
 186
 187                         return true;
 188                 }
 189
 190                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 191                 public extern static bool GetFileStat (string path,
 192                                                        out MonoIOStat stat,
 193                                                        out MonoIOError error);
 194
 195                 // handle methods
 196
 197                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 198                 public extern static IntPtr Open (string filename,
 199                                                   FileMode mode,
 200                                                   FileAccess access,
 201                                                   FileShare share,
 202                                                   bool async,
 203                                                   out MonoIOError error);
 204
 205                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 206                 public extern static bool Close (IntPtr handle,
 207                                                  out MonoIOError error);
 208
 209                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 210                 public extern static int Read (IntPtr handle, byte [] dest,
 211                                                int dest_offset, int count,
 212                                                out MonoIOError error);
 213
 214                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 215                 public extern static int Write (IntPtr handle, [In] byte [] src,
 216                                                 int src_offset, int count,
 217                                                 out MonoIOError error);
 218
 219                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 220                 public extern static long Seek (IntPtr handle, long offset,
 221                                                 SeekOrigin origin,
 222                                                 out MonoIOError error);
 223
 224                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 225                 public extern static bool Flush (IntPtr handle,
 226                                                  out MonoIOError error);
 227
 228                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 229                 public extern static long GetLength (IntPtr handle,
 230                                                      out MonoIOError error);
 231
 232                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 233                 public extern static bool SetLength (IntPtr handle,
 234                                                      long length,
 235                                                      out MonoIOError error);
 236
 237                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 238                 public extern static bool SetFileTime (IntPtr handle,
 239                                                        long creation_time,
 240                                                        long last_access_time,
 241                                                        long last_write_time,
 242                                                        out MonoIOError error);
 243
 244                 public static bool SetFileTime (string path,
 245                                                 long creation_time,
 246                                                 long last_access_time,
 247                                                 long last_write_time,
 248                                                 out MonoIOError error)
 249                 {
 250                         return SetFileTime (path,
 251                                 0,
 252                                 creation_time,
 253                                 last_access_time,
 254                                 last_write_time,
 255                                 DateTime.MinValue,
 256                                 out error);
 257                 }
 258
 259                 public static bool SetCreationTime (string path,
 260                                                 DateTime dateTime,
 261                                                 out MonoIOError error)
 262                 {
 263                         return SetFileTime (path, 1, -1, -1, -1, dateTime, out error);
 264                 }
 265
 266                 public static bool SetLastAccessTime (string path,
 267                                                 DateTime dateTime,
 268                                                 out MonoIOError error)
 269                 {
 270                         return SetFileTime (path, 2, -1, -1, -1, dateTime, out error);
 271                 }
 272
 273                 public static bool SetLastWriteTime (string path,
 274                                                 DateTime dateTime,
 275                                                 out MonoIOError error)
 276                 {
 277                         return SetFileTime (path, 3, -1, -1, -1, dateTime, out error);
 278                 }
 279
 280                 public static bool SetFileTime (string path,
 281                                                 int type,
 282                                                 long creation_time,
 283                                                 long last_access_time,
 284                                                 long last_write_time,
 285                                                 DateTime dateTime,
 286                                                 out MonoIOError error)
 287                 {
 288                         IntPtr handle;
 289                         bool result;
 290
 291                         handle = Open (path, FileMode.Open,
 292                                        FileAccess.ReadWrite,
 293                                        FileShare.ReadWrite, false, out error);
 294                         if (handle == MonoIO.InvalidHandle)
 295                                 return false;
 296
 297                         switch (type) {
 298                         case 1:
 299                                 creation_time = dateTime.ToFileTime ();
 300                                 break;
 301                         case 2:
 302                                 last_access_time = dateTime.ToFileTime ();
 303                                 break;
 304                         case 3:
 305                                 last_write_time = dateTime.ToFileTime ();
 306                                 break;
 307                         }
 308
 309                         result = SetFileTime (handle, creation_time,
 310                                               last_access_time,
 311                                               last_write_time, out error);
 312
 313                         MonoIOError ignore_error;
 314                         Close (handle, out ignore_error);
 315
 316                         return result;
 317                 }
 318
 319                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 320                 public extern static void Lock (IntPtr handle,
 321                                                 long position, long length,
 322                                                 out MonoIOError error);
 323
 324                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 325                 public extern static void Unlock (IntPtr handle,
 326                                                   long position, long length,
 327                                                   out MonoIOError error);
 328
 329                 // console handles
 330
 331                 public extern static IntPtr ConsoleOutput {
 332                         [MethodImplAttribute (MethodImplOptions.InternalCall)]
 333                         get;
 334                 }
 335
 336                 public extern static IntPtr ConsoleInput {
 337                         [MethodImplAttribute (MethodImplOptions.InternalCall)]
 338                         get;
 339                 }
 340
 341                 public extern static IntPtr ConsoleError {
 342                         [MethodImplAttribute (MethodImplOptions.InternalCall)]
 343                         get;
 344                 }
 345
 346                 // pipe handles
 347
 348                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 349                 public extern static bool CreatePipe (out IntPtr read_handle, out IntPtr write_handle);
 350
 351                 // path characters
 352
 353                 public extern static char VolumeSeparatorChar {
 354                         [MethodImplAttribute (MethodImplOptions.InternalCall)]
 355                         get;
 356                 }
 357
 358                 public extern static char DirectorySeparatorChar {
 359                         [MethodImplAttribute (MethodImplOptions.InternalCall)]
 360                         get;
 361                 }
 362
 363                 public extern static char AltDirectorySeparatorChar {
 364                         [MethodImplAttribute (MethodImplOptions.InternalCall)]
 365                         get;
 366                 }
 367
 368                 public extern static char PathSeparator {
 369                         [MethodImplAttribute (MethodImplOptions.InternalCall)]
 370                         get;
 371                 }
 372
 373                 public extern static char [] InvalidPathChars {
 374                         [MethodImplAttribute (MethodImplOptions.InternalCall)]
 375                         get;
 376                 }
 377
 378                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 379                 public extern static int GetTempPath(out string path);
 380
 381                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 382                 public extern static void BeginWrite (IntPtr handle,FileStreamAsyncResult ares);
 383
 384                 [MethodImplAttribute (MethodImplOptions.InternalCall)]
 385                 public extern static void BeginRead (IntPtr handle, FileStreamAsyncResult ares);
 386
 387         }
 388 }
 389