sal/osl/w32/file_url.h

   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_url.h,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 #ifndef INCLUDED_OSL_FILE_URL_H
  32 #define INCLUDED_OSL_FILE_URL_H
  33
  34 #include "sal/types.h"
  35 #include "rtl/ustring.h"
  36 #include "osl/file.h"
  37
  38 #ifdef _MSC_VER
  39 #pragma warning(push,1)
  40 #endif
  41
  42 #define WINDOWS_LEAN_AND_MEAN
  43 #include <windows.h>
  44
  45 #ifdef _MSC_VER
  46 #pragma warning(pop)
  47 #endif
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 #define PATHTYPE_ERROR                                          0
  54 #define PATHTYPE_RELATIVE                                       1
  55 #define PATHTYPE_ABSOLUTE_UNC                           2
  56 #define PATHTYPE_ABSOLUTE_LOCAL                         3
  57 #define PATHTYPE_MASK_TYPE                                      0xFF
  58 #define PATHTYPE_IS_VOLUME                                      0x0100
  59 #define PATHTYPE_IS_SERVER                                      0x0200
  60
  61 #define VALIDATEPATH_NORMAL                                     0x0000
  62 #define VALIDATEPATH_ALLOW_WILDCARDS            0x0001
  63 #define VALIDATEPATH_ALLOW_ELLIPSE                      0x0002
  64 #define VALIDATEPATH_ALLOW_RELATIVE                     0x0004
  65 #define VALIDATEPATH_ALLOW_UNC                          0x0008
  66 #define VALIDATEPATH_ALLOW_INVALID_SPACE_AND_PERIOD 0x0010
  67
  68 DWORD IsValidFilePath (
  69     rtl_uString *  path,
  70     LPCTSTR *      lppError,
  71     DWORD          dwFlags,
  72     rtl_uString ** corrected
  73 );
  74
  75 DWORD GetCaseCorrectPathName (
  76     LPCTSTR     lpszShortPath,  // file name
  77     LPTSTR      lpszLongPath,   // path buffer
  78     DWORD       cchBuffer               // size of path buffer
  79 );
  80
  81 oslFileError _osl_getSystemPathFromFileURL (
  82     rtl_uString *  strURL,
  83     rtl_uString ** pustrPath,
  84     sal_Bool       bAllowRelative
  85 );
  86
  87 oslFileError _osl_getFileURLFromSystemPath (
  88     rtl_uString *  strPath,
  89     rtl_uString ** pstrURL
  90 );
  91
  92 #ifdef __cplusplus
  93 }
  94 #endif
  95
  96 #endif /* INCLUDED_OSL_FILE_URL_H */