sal/osl/unx/file_path_helper.hxx

   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 _OSL_FILE_PATH_HELPER_HXX_
  30 #define _OSL_FILE_PATH_HELPER_HXX_
  31
  32
  33 #include "file_path_helper.h"
  34
  35 #include <rtl/ustring.hxx>
  36
  37
  38 namespace osl
  39 {
  40
  41  /*******************************************
  42     systemPathRemoveSeparator
  43     Removes the last separator from the
  44     given system path if any and if the path
  45     is not the root path '/'
  46
  47     @param  ppustrPath [inout] a system path
  48             if the path is not the root path
  49             and the last character is a
  50             path separator it will be cut off
  51                ppustrPath must not be NULL and
  52             must point to a valid rtl_uString
  53
  54     @returns nothing
  55
  56   ******************************************/
  57
  58  inline void systemPathRemoveSeparator(/*inout*/ rtl::OUString& Path)
  59  {
  60      osl_systemPathRemoveSeparator(Path.pData);
  61  }
  62
  63  /*******************************************
  64     systemPathEnsureSeparator
  65     Adds a trailing path separator to the
  66     given system path if not already there
  67     and if the path is not the root path '/'
  68
  69       @param    pustrPath [inout] a system path
  70             if the path is not the root path
  71             '/' and has no trailing separator
  72             a separator will be added
  73             ppustrPath must not be NULL and
  74             must point to a valid rtl_uString
  75
  76     @returns nothing
  77
  78   ******************************************/
  79
  80  inline void systemPathEnsureSeparator(/*inout*/ rtl::OUString& Path)
  81  {
  82      osl_systemPathEnsureSeparator(&Path.pData);
  83  }
  84
  85  /*******************************************
  86     systemPathIsRelativePath
  87     Returns true if the given path is a
  88     relative path and so starts not with '/'
  89
  90     @param  pustrPath [in] a system path
  91             pustrPath must not be NULL
  92
  93     @returns sal_True if the given path
  94              doesn't start with a separator
  95              else sal_False will be returned
  96
  97   ******************************************/
  98
  99  inline bool systemPathIsRelativePath(const rtl::OUString& Path)
 100  {
 101     return osl_systemPathIsRelativePath(Path.pData);
 102  }
 103
 104  /******************************************
 105     systemPathMakeAbsolutePath
 106     Append a relative path to a base path
 107
 108     @param  pustrBasePath [in] a system
 109             path that will be considered as
 110             base path
 111             pustrBasePath must not be NULL
 112
 113     @param  pustrRelPath [in] a system path
 114             that will be considered as
 115             relative path
 116             pustrBasePath must not be NULL
 117
 118     @param  ppustrAbsolutePath [out] the
 119             resulting path which is a
 120             concatination of the base and
 121             the relative path
 122             if base path is empty the
 123             resulting absolute path is the
 124             relative path
 125             if relative path is empty the
 126             resulting absolute path is the
 127             base path
 128             if base and relative path are
 129             empty the resulting absolute
 130             path is also empty
 131             ppustrAbsolutePath must not be
 132             NULL and *ppustrAbsolutePath
 133             must be 0 or point to a valid
 134             rtl_uString
 135
 136   *****************************************/
 137
 138  inline void systemPathMakeAbsolutePath(
 139      const rtl::OUString& BasePath,
 140     const rtl::OUString& RelPath,
 141     rtl::OUString&       AbsolutePath)
 142  {
 143     osl_systemPathMakeAbsolutePath(
 144         BasePath.pData, RelPath.pData, &AbsolutePath.pData);
 145  }
 146
 147  /*****************************************
 148      systemPathGetFileOrLastDirectoryPart
 149     Returns the file or the directory part
 150     of the given path
 151
 152     @param pustrPath [in] a system path,
 153            must not be NULL
 154
 155     @param ppustrFileOrDirPart [out] on
 156            return receives the last part
 157            of the given directory or the
 158            file name
 159            if pustrPath is the root path
 160            '/' an empty string will be
 161            returned
 162            if pustrPath has a trailing
 163            '/' the last part before the
 164            '/' will be returned else
 165            the part after the last '/'
 166            will be returned
 167
 168     @returns nothing
 169
 170   ****************************************/
 171
 172  inline void systemPathGetFileNameOrLastDirectoryPart(
 173      const rtl::OUString& Path,
 174     rtl::OUString&       FileNameOrLastDirPart)
 175  {
 176     osl_systemPathGetFileNameOrLastDirectoryPart(
 177         Path.pData, &FileNameOrLastDirPart.pData);
 178  }
 179
 180
 181  /********************************************
 182      systemPathIsHiddenFileOrDirectoryEntry
 183     Returns sal_True if the last part of
 184     given system path is not '.' or '..'
 185     alone and starts with a '.'
 186
 187     @param pustrPath [in] a system path,
 188            must not be NULL
 189
 190     @returns sal_True if the last part of
 191              the given system path starts
 192              with '.' or sal_False the last
 193              part is '.' or '..' alone or
 194              doesn't start with a dot
 195
 196  *********************************************/
 197
 198  inline bool systemPathIsHiddenFileOrDirectoryEntry(
 199      const rtl::OUString& Path)
 200  {
 201     return osl_systemPathIsHiddenFileOrDirectoryEntry(Path.pData);
 202  }
 203
 204
 205  /************************************************
 206      systemPathIsLocalOrParentDirectoryEntry
 207     Returns sal_True if the last part of the given
 208     system path is the local directory entry '.'
 209     or the parent directory entry '..'
 210
 211     @param pustrPath [in] a system path,
 212            must not be NULL
 213
 214     @returns sal_True if the last part of the
 215              given system path is '.' or '..'
 216              else sal_False
 217
 218  ************************************************/
 219
 220  inline bool systemPathIsLocalOrParentDirectoryEntry(
 221      const rtl::OUString& Path)
 222  {
 223     return osl_systemPathIsLocalOrParentDirectoryEntry(Path.pData);
 224  }
 225
 226  /************************************************
 227   searchPath
 228   ***********************************************/
 229
 230  inline bool searchPath(
 231      const rtl::OUString& ustrFilePath,
 232     const rtl::OUString& ustrSearchPathList,
 233     rtl::OUString& ustrPathFound)
 234  {
 235      return osl_searchPath(
 236         ustrFilePath.pData,
 237         ustrSearchPathList.pData,
 238         &ustrPathFound.pData);
 239  }
 240
 241
 242  } // namespace osl
 243
 244
 245  #endif /* #ifndef _OSL_PATH_HELPER_HXX_ */
 246
 247
 248 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */