sal/osl/w32/file_error.c

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: file_error.c,v $
  10  * $Revision: 1.0 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #define UNICODE
  32 #define _UNICODE
  33 #define _WIN32_WINNT_0x0500
  34 #include "systools/win32/uwinapi.h"
  35
  36 #include "file_error.h"
  37
  38 #include "osl/diagnose.h"
  39 #include "osl/thread.h"
  40
  41 /* OS error to oslFileError values mapping table */
  42 struct osl_file_error_entry
  43 {
  44     unsigned long oscode; /* OS return value */
  45     int errnocode;        /* oslFileError code */
  46 };
  47
  48 static const struct osl_file_error_entry errtable[] = {
  49   {  ERROR_SUCCESS,                                osl_File_E_None     },  /* 0 */
  50   {  ERROR_INVALID_FUNCTION,       osl_File_E_INVAL    },  /* 1 */
  51   {  ERROR_FILE_NOT_FOUND,         osl_File_E_NOENT    },  /* 2 */
  52   {  ERROR_PATH_NOT_FOUND,         osl_File_E_NOENT    },  /* 3 */
  53   {  ERROR_TOO_MANY_OPEN_FILES,    osl_File_E_MFILE    },  /* 4 */
  54   {  ERROR_ACCESS_DENIED,          osl_File_E_ACCES    },  /* 5 */
  55   {  ERROR_INVALID_HANDLE,         osl_File_E_BADF     },  /* 6 */
  56   {  ERROR_ARENA_TRASHED,          osl_File_E_NOMEM    },  /* 7 */
  57   {  ERROR_NOT_ENOUGH_MEMORY,      osl_File_E_NOMEM    },  /* 8 */
  58   {  ERROR_INVALID_BLOCK,          osl_File_E_NOMEM    },  /* 9 */
  59   {  ERROR_BAD_ENVIRONMENT,        osl_File_E_2BIG     },  /* 10 */
  60   {  ERROR_BAD_FORMAT,             osl_File_E_NOEXEC   },  /* 11 */
  61   {  ERROR_INVALID_ACCESS,         osl_File_E_INVAL    },  /* 12 */
  62   {  ERROR_INVALID_DATA,           osl_File_E_INVAL    },  /* 13 */
  63   {  ERROR_INVALID_DRIVE,          osl_File_E_NOENT    },  /* 15 */
  64   {  ERROR_CURRENT_DIRECTORY,      osl_File_E_ACCES    },  /* 16 */
  65   {  ERROR_NOT_SAME_DEVICE,        osl_File_E_XDEV     },  /* 17 */
  66   {  ERROR_NO_MORE_FILES,          osl_File_E_NOENT    },  /* 18 */
  67   {  ERROR_NOT_READY,              osl_File_E_NOTREADY },  /* 21 */
  68   {  ERROR_LOCK_VIOLATION,         osl_File_E_ACCES    },  /* 33 */
  69   {  ERROR_BAD_NETPATH,            osl_File_E_NOENT    },  /* 53 */
  70   {  ERROR_NETWORK_ACCESS_DENIED,  osl_File_E_ACCES    },  /* 65 */
  71   {  ERROR_BAD_NET_NAME,           osl_File_E_NOENT    },  /* 67 */
  72   {  ERROR_FILE_EXISTS,            osl_File_E_EXIST    },  /* 80 */
  73   {  ERROR_CANNOT_MAKE,            osl_File_E_ACCES    },  /* 82 */
  74   {  ERROR_FAIL_I24,               osl_File_E_ACCES    },  /* 83 */
  75   {  ERROR_INVALID_PARAMETER,      osl_File_E_INVAL    },  /* 87 */
  76   {  ERROR_NO_PROC_SLOTS,          osl_File_E_AGAIN    },  /* 89 */
  77   {  ERROR_DRIVE_LOCKED,           osl_File_E_ACCES    },  /* 108 */
  78   {  ERROR_BROKEN_PIPE,            osl_File_E_PIPE     },  /* 109 */
  79   {  ERROR_DISK_FULL,              osl_File_E_NOSPC    },  /* 112 */
  80   {  ERROR_INVALID_TARGET_HANDLE,  osl_File_E_BADF     },  /* 114 */
  81   {  ERROR_INVALID_HANDLE,         osl_File_E_INVAL    },  /* 124 */
  82   {  ERROR_WAIT_NO_CHILDREN,       osl_File_E_CHILD    },  /* 128 */
  83   {  ERROR_CHILD_NOT_COMPLETE,     osl_File_E_CHILD    },  /* 129 */
  84   {  ERROR_DIRECT_ACCESS_HANDLE,   osl_File_E_BADF     },  /* 130 */
  85   {  ERROR_NEGATIVE_SEEK,          osl_File_E_INVAL    },  /* 131 */
  86   {  ERROR_SEEK_ON_DEVICE,         osl_File_E_ACCES    },  /* 132 */
  87   {  ERROR_DIR_NOT_EMPTY,          osl_File_E_NOTEMPTY },  /* 145 */
  88   {  ERROR_NOT_LOCKED,             osl_File_E_ACCES    },  /* 158 */
  89   {  ERROR_BAD_PATHNAME,           osl_File_E_NOENT    },  /* 161 */
  90   {  ERROR_MAX_THRDS_REACHED,      osl_File_E_AGAIN    },  /* 164 */
  91   {  ERROR_LOCK_FAILED,            osl_File_E_ACCES    },  /* 167 */
  92   {  ERROR_ALREADY_EXISTS,         osl_File_E_EXIST    },  /* 183 */
  93   {  ERROR_FILENAME_EXCED_RANGE,   osl_File_E_NOENT    },  /* 206 */
  94   {  ERROR_NESTING_NOT_ALLOWED,    osl_File_E_AGAIN    },  /* 215 */
  95   {  ERROR_DIRECTORY,              osl_File_E_NOENT    },  /* 267 */
  96   {  ERROR_NOT_ENOUGH_QUOTA,       osl_File_E_NOMEM    },  /* 1816 */
  97   {  ERROR_UNEXP_NET_ERR,          osl_File_E_NETWORK  }   /* 59 */
  98 };
  99
 100 /* The following two constants must be the minimum and maximum
 101    values in the (contiguous) range of osl_File_E_xec Failure errors.
 102 */
 103 #define MIN_EXEC_ERROR ERROR_INVALID_STARTING_CODESEG
 104 #define MAX_EXEC_ERROR ERROR_INFLOOP_IN_RELOC_CHAIN
 105
 106 /* These are the low and high value in the range of errors that are
 107    access violations
 108 */
 109 #define MIN_EACCES_RANGE ERROR_WRITE_PROTECT
 110 #define MAX_EACCES_RANGE ERROR_SHARING_BUFFER_EXCEEDED
 111
 112 oslFileError oslTranslateFileError (/*DWORD*/ unsigned long dwError)
 113 {
 114     static const int n = sizeof(errtable)/sizeof(errtable[0]);
 115
 116     int i;
 117     for (i = 0; i < n; ++i )
 118     {
 119         if (dwError == errtable[i].oscode)
 120             return (oslFileError)(errtable[i].errnocode);
 121     }
 122
 123     /* The error code wasn't in the table.  We check for a range of
 124        osl_File_E_ACCES errors or exec failure errors (ENOEXEC).
 125        Otherwise osl_File_E_INVAL is returned.
 126     */
 127     if ( (dwError >= MIN_EACCES_RANGE) && (dwError <= MAX_EACCES_RANGE) )
 128         return osl_File_E_ACCES;
 129     else if ( (dwError >= MIN_EXEC_ERROR) && (dwError <= MAX_EXEC_ERROR) )
 130         return osl_File_E_NOEXEC;
 131     else
 132         return osl_File_E_INVAL;
 133 }
 134
 135 //#####################################################
 136 #if OSL_DEBUG_LEVEL > 0
 137 void _osl_warnFile( const char *message, rtl_uString *ustrFile )
 138 {
 139     char szBuffer[2048];
 140
 141     if (ustrFile)
 142     {
 143         rtl_String      *strFile = NULL;
 144
 145         rtl_uString2String( &strFile, rtl_uString_getStr( ustrFile ), rtl_uString_getLength( ustrFile ),
 146                             osl_getThreadTextEncoding(), OUSTRING_TO_OSTRING_CVTFLAGS );
 147         snprintf( szBuffer, sizeof(szBuffer), message, strFile->buffer );
 148         rtl_string_release( strFile );
 149
 150         message = szBuffer;
 151     }
 152     OSL_ENSURE( 0, message );
 153 }
 154 #endif /* OSL_DEBUG_LEVEL */