sal/osl/os2/path_helper.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef _PATH_HELPER_H_
  29 #define _PATH_HELPER_H_
  30
  31 #include <sal/types.h>
  32 #include <rtl/ustring.h>
  33 #include <osl/file.h>
  34
  35 #ifdef __cplusplus
  36 extern "C"
  37 {
  38 #endif
  39
  40 /*******************************************************************
  41  osl_systemPathEnsureSeparator
  42  Adds a trailing path separator to the given system path if not
  43  already there and if the path is not the root path or a logical
  44  drive alone
  45  ******************************************************************/
  46
  47 void osl_systemPathEnsureSeparator(/*inout*/ rtl_uString** ppustrPath);
  48
  49 /*******************************************************************
  50  osl_systemPathRemoveSeparator
  51  Removes the last separator from the given system path if any and
  52  if the path is not the root path '\'
  53  ******************************************************************/
  54
  55 void SAL_CALL osl_systemPathRemoveSeparator(/*inout*/ rtl_uString** ppustrPath);
  56
  57 /*******************************************************************
  58  osl_is_logical_drive_pattern
  59  Returns whether a given path is only a logical drive pattern or not.
  60  A logical drive pattern is something like "a:\", "c:\".
  61  No logical drive pattern is something like "c:\test"
  62  ******************************************************************/
  63
  64 sal_Int32 osl_systemPathIsLogicalDrivePattern(/*in*/ const rtl_uString* pustrPath);
  65
  66 #ifdef __cplusplus
  67 }
  68 #endif
  69
  70 #endif