sal/osl/w32/path_helper.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef _PATH_HELPER_H_
  21 #define _PATH_HELPER_H_
  22
  23 #include <sal/types.h>
  24 #include <rtl/ustring.h>
  25 #include <osl/file.h>
  26
  27 #ifdef __cplusplus
  28 extern "C"
  29 {
  30 #endif
  31
  32 /*******************************************************************
  33  osl_systemPathEnsureSeparator
  34  Adds a trailing path separator to the given system path if not
  35  already there and if the path is not the root path or a logical
  36  drive alone
  37  ******************************************************************/
  38
  39 void osl_systemPathEnsureSeparator(/*inout*/ rtl_uString** ppustrPath);
  40
  41 /*******************************************************************
  42  osl_systemPathRemoveSeparator
  43  Removes the last separator from the given system path if any and
  44  if the path is not the root path '\'
  45  ******************************************************************/
  46
  47 void SAL_CALL osl_systemPathRemoveSeparator(/*inout*/ rtl_uString** ppustrPath);
  48
  49 /*******************************************************************
  50  osl_is_logical_drive_pattern
  51  Returns whether a given path is only a logical drive pattern or not.
  52  A logical drive pattern is something like "a:\", "c:\".
  53  No logical drive pattern is something like "c:\test"
  54  ******************************************************************/
  55
  56 sal_Int32 osl_systemPathIsLogicalDrivePattern(/*in*/ const rtl_uString* pustrPath);
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */