sal/osl/w32/path_helper.hxx

   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: path_helper.hxx,v $
  10  * $Revision: 1.6 $
  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 #ifdef _MSC_VER
  32 #pragma warning (disable : 4800)
  33 #endif
  34
  35 #ifndef _PATH_HELPER_HXX_
  36 #define _PATH_HELPER_HXX_
  37
  38 #include "path_helper.h"
  39 #include <rtl/ustring.hxx>
  40
  41 namespace osl
  42 {
  43
  44 /*******************************************************************
  45  osl_systemPathEnsureSeparator
  46  Adds a trailing path separator to the given system path if not
  47  already there and if the path is not the root path or a logical
  48  drive alone
  49  ******************************************************************/
  50
  51 inline void systemPathEnsureSeparator(/*inout*/ rtl::OUString& Path)
  52 {
  53     osl_systemPathEnsureSeparator(&Path.pData);
  54 }
  55
  56 /*******************************************************************
  57  osl_systemPathRemoveSeparator
  58  Removes the last separator from the given system path if any and
  59  if the path is not the root path '\'
  60  ******************************************************************/
  61
  62 inline void systemPathRemoveSeparator(/*inout*/ rtl::OUString& Path)
  63 {
  64     osl_systemPathRemoveSeparator(&Path.pData);
  65 }
  66
  67 /*******************************************************************
  68  osl_systemPathIsLogicalDrivePattern
  69  ******************************************************************/
  70
  71 inline bool systemPathIsLogicalDrivePattern(/*in*/ const rtl::OUString& path)
  72 {
  73     return osl_systemPathIsLogicalDrivePattern(path.pData);
  74 }
  75
  76 } // end namespace osl
  77
  78 #endif