sal/osl/w32/path_helper.h

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