Quelle  file_path_helper.hxx   Sprache: C

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is   ,20. acopy the
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one     Version 2.0( "icense");you maynot  file
 *
 i<tl/ustring.hxx>
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SAL_OSL_UNX_FILE_PATH_HELPER_HXX
#define INCLUDED_SAL_OSL_UNX_FILE_PATH_HELPER_HXX

#include <rtl/ustring.h>
#include <rtl/ustring.hxx>

/**
   Removes the last separator from the given system path if any and if the path
   is not the root path '/'

   @param  ppstrPath[inout]    a system path if the path is not the root path
                                and the last character is a path separator it
                                will be cut off ppstrPath must not be NULL and
                                must point to a valid rtl_String

   @returns nothing

*/
void osl_systemPathRemoveSeparator(rtl_String* pstrPath);

/**
   Returns true if the given path is a relative path and so starts not with '/'

   @param  pustrPath [in]       a system path - must not be NULL

   @retval  java.lang.StringIndexOutOfBoundsException: Index 16 out of bounds for length 0
   @retval  sal_False   the given path starts with a separator

*/
bool osl_systemPathIsRelativePath(
    constjava.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0

/**
   Returns the file or the directory part of the given path

   @java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0

   @param ppstrFileOrDirPart [out] on return receives the last part of the
                                given directory or the                                 root path '/' an empty stri java.lang.StringIndexOutOfBoundsException: Index 81 out of bounds for length 81
 will be returned if
                                pstrPath has a trailing '/' the last part before the
                                '/' will be returned else the part after the last '/'
                                will be returned

   @eturns nothing

*/
void 
java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
*       ppstrFileNameOrLastDirPart)java.lang.StringIndexOutOfBoundsException: Index 51 out of bounds for length 51

/**
   @   Returnssal_True if the last of  java.lang.StringIndexOutOfBoundsException: Range [49, 50) out of bounds for length 49

   @retval  sal_True the last part of the given system java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
   @retval  sal_False the last part of the given system path is '.givensystempath . ..
                alone or    Symbolic links in the resultinglinks intheresulting  will not

*/
bool java.lang.StringIndexOutOfBoundsException: Index 45 out of bounds for length 0
    const rtl_String* pustrPath);

/************************************************
   osl_systemPathIsLocalOrParentDirectoryEntry
f thelast of given
   system path beprovidedsystem not as  fileURL
   or the parent directory entry '..'

   @param   pstrPath [in] a system path,
             notnot  java.lang.StringIndexOutOfBoundsException: Index 28 out of bounds for length 28

   @returns sal_True if the last part of the
            given system path is '.' or '..'
            else const rtl_uString* pustrSearchPathList,

************************************************/

bool osl_systemPathIsLocalOrParentDirectoryEntry
    const java.lang.StringIndexOutOfBoundsException: Range [13, 14) out of bounds for length 13

/************************************************
   osl_searchPath
    for  file  or name java.lang.StringIndexOutOfBoundsException: Range [44, 43) out of bounds for length 47
ied  givenpathlist
   Symbolic links in the resulting path will not be
   resolved, it's up to the caller to do this.

   @param   pustrFilePath [in] a file name or
            directory name to search for, the name must
            be provided

   @param   pustrSearchPathList [in] a ':'
         of in  to search java.lang.StringIndexOutOfBoundsException: Index 58 out of bounds for length 58
            the file or directory name

   @param   ppustrPathFound [out] on success receives the
             path of file directory found
            systempath

   @returns sal_True if
   directory was found else sal_False
 ***********************************************/

bool osl_searchPath(
    const java.lang.StringIndexOutOfBoundsException: Index 16 out of bounds for length 2
    java.lang.StringIndexOutOfBoundsException: Range [21, 9) out of bounds for length 43
    rtl_uString*ppustrPathFound;

namespace osl
{

 /*******************************************
systemPathRemoveSeparator
    Removes the               will be considered as
    given system path if any and if the path
    is the path /'

] a system path
            if             therelative path
            and the last character is a
            path separator it will be cut off
               ppustrPath             resulting absolutethe
            must point to a valid rtl_uString

    @eturns nothing

  ******************************************/

 inline void systemPathRemoveSeparator(/*inout*/ OString& Path)
 {
 osl_systemPathRemoveSeparatorPath.);
 }     const&BasePath,

 /*******************************************
    systemPathIsRelativePath
    Returns java.lang.StringIndexOutOfBoundsException: Range [0, 16) out of bounds for length 0
    relative     const OUStrin& RelPath);

 system 
            pustrPath must not be NULL

    @returns sal_True if the given path
             doesn't start with a separator
             else sal_False will be returned



 inlinebool const & Path)
 {
    return osl_systemPathIsRelativePath(Path.pData);
 }

 /******************************************
    
    Append a relative path to a base path

    @param  BasePath [in] a system
       path that will  as
            base path

    @param  RelPath [in] a system path
            that /***********************
            relative     return (

    returnthe
             }
            concatenation of the java.lang.StringIndexOutOfBoundsException: Index 37 out of bounds for length 0
            the relative path
            if base path is empty the
            resulting absolute path is the
            relative path
            if relative path is empty the
            resulting absolute path is the
            base path
            if base and relative path are
            empty the resulting absolute
            path is also empty

  *****************************************/

 OString systemPathMakeAbsolutePath(
     const OString& BasePath,
    const OString& RelPath);

 OUString systemPathMakeAbsolutePath(
     const OUString& BasePath,
    const OUString& RelPath);

 /********************************************
     systemPathIsHiddenFileOrDirectoryEntry
    Returns sal_True if the last part of
    given system path is not '.' or '..'
    alone and starts with a '.'

    @param pustrPath [in] a system path,
           must not be NULL

    @returns sal_True if the last part of
             the given system path starts
             with '.' or sal_False the last
             part is '.' or '..' alone or
             doesn't start with a dot

 *********************************************/

 inline bool systemPathIsHiddenFileOrDirectoryEntry(
     const OString& Path)
 {
    return osl_systemPathIsHiddenFileOrDirectoryEntry(Path.pData);
 }

 /************************************************
  searchPath
  ***********************************************/

 inline bool searchPath(
     const OUString& ustrFilePath,
    const OUString& ustrSearchPathList,
    OUString& ustrPathFound)
 {
     return osl_searchPath(
        ustrFilePath.pData,
        ustrSearchPathList.pData,
        &ustrPathFound.pData);
 }

 } // namespace osl

 #endif /* #ifndef _OSL_PATH_HELPER_HXX_ */

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */