/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * 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 at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * 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 #include #include /** Removes the last separator from the given system path if any and if the path is not the root path '/' @param ppustrPath[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 ppustrPath must not be NULL and must point to a valid rtl_uString @returns nothing */ void SAL_CALL osl_systemPathRemoveSeparator(rtl_uString* pustrPath); /** Adds a trailing path separator to the given system path if not already there and if the path is not the root path '/' @param pustrPath [inout] a system path if the path is not the root path '/' and has no trailing separator a separator will be added ppustrPath must not be NULL and must point to a valid rtl_uString @returns nothing */ void SAL_CALL osl_systemPathEnsureSeparator(rtl_uString** ppustrPath); /** 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 sal_True the given path doesn't start with a separator @retval sal_False the given path starts with a separator */ bool SAL_CALL osl_systemPathIsRelativePath( const rtl_uString* pustrPath); /** Append a relative path to a base path @param pustrBasePath [in] a system path that will be considered as base path pustrBasePath must not be NULL @param pustrRelPath [in] a system path that will be considered as relative path pustrBasePath must not be NULL @param ppustrAbsolutePath [out] the resulting path which is a concatenation of the base and 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 ppustrAbsolutePath must not be NULL and *ppustrAbsolutePath must be 0 or point to a valid rtl_uString */ void SAL_CALL osl_systemPathMakeAbsolutePath( const rtl_uString* pustrBasePath, const rtl_uString* pustrRelPath, rtl_uString** ppustrAbsolutePath); /** Returns the file or the directory part of the given path @param pustrPath [in] a system path, must not be NULL @param ppustrFileOrDirPart [out] on return receives the last part of the given directory or the file name if pustrPath is the root path '/' an empty string will be returned if pustrPath has a trailing '/' the last part before the '/' will be returned else the part after the last '/' will be returned @returns nothing */ void SAL_CALL osl_systemPathGetFileNameOrLastDirectoryPart( const rtl_uString* pustrPath, rtl_uString** ppustrFileNameOrLastDirPart); /** @param pustrPath [in] a system path, must not be NULL @retval sal_True the last part of the given system path starts with '.' @retval sal_False the last part of the given system path is '.' or '..' alone or doesn't start with a dot */ bool SAL_CALL osl_systemPathIsHiddenFileOrDirectoryEntry( const rtl_uString* pustrPath); /************************************************ osl_systemPathIsLocalOrParentDirectoryEntry Returns sal_True if the last part of the given system path is the local directory entry '.' or the parent directory entry '..' @param pustrPath [in] a system path, must not be NULL @returns sal_True if the last part of the given system path is '.' or '..' else sal_False ************************************************/ bool SAL_CALL osl_systemPathIsLocalOrParentDirectoryEntry( const rtl_uString* pustrPath); /************************************************ osl_searchPath Searches for a file name or path name in all directories specified by a given path list. 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 as system path not as a file URL @param pustrSearchPathList [in] a ':' separated list of paths in which to search for the file or directory name @param ppustrPathFound [out] on success receives the complete path of the file or directory found as a system path @returns sal_True if the specified file or directory was found else sal_False ***********************************************/ bool SAL_CALL osl_searchPath( const rtl_uString* pustrFilePath, const rtl_uString* pustrSearchPathList, rtl_uString** ppustrPathFound); namespace osl { /******************************************* systemPathRemoveSeparator Removes the last separator from the given system path if any and if the path is not the root path '/' @param ppustrPath [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 ppustrPath must not be NULL and must point to a valid rtl_uString @returns nothing ******************************************/ inline void systemPathRemoveSeparator(/*inout*/ rtl::OUString& Path) { osl_systemPathRemoveSeparator(Path.pData); } /******************************************* systemPathEnsureSeparator Adds a trailing path separator to the given system path if not already there and if the path is not the root path '/' @param pustrPath [inout] a system path if the path is not the root path '/' and has no trailing separator a separator will be added ppustrPath must not be NULL and must point to a valid rtl_uString @returns nothing ******************************************/ inline void systemPathEnsureSeparator(/*inout*/ rtl::OUString& Path) { osl_systemPathEnsureSeparator(&Path.pData); } /******************************************* systemPathIsRelativePath Returns true if the given path is a relative path and so starts not with '/' @param pustrPath [in] a system path pustrPath must not be NULL @returns sal_True if the given path doesn't start with a separator else sal_False will be returned ******************************************/ inline bool systemPathIsRelativePath(const rtl::OUString& Path) { return osl_systemPathIsRelativePath(Path.pData); } /****************************************** systemPathMakeAbsolutePath Append a relative path to a base path @param pustrBasePath [in] a system path that will be considered as base path pustrBasePath must not be NULL @param pustrRelPath [in] a system path that will be considered as relative path pustrBasePath must not be NULL @param ppustrAbsolutePath [out] the resulting path which is a concatination of the base and 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 ppustrAbsolutePath must not be NULL and *ppustrAbsolutePath must be 0 or point to a valid rtl_uString *****************************************/ inline void systemPathMakeAbsolutePath( const rtl::OUString& BasePath, const rtl::OUString& RelPath, rtl::OUString& AbsolutePath) { osl_systemPathMakeAbsolutePath( BasePath.pData, RelPath.pData, &AbsolutePath.pData); } /******************************************** 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 rtl::OUString& Path) { return osl_systemPathIsHiddenFileOrDirectoryEntry(Path.pData); } /************************************************ searchPath ***********************************************/ inline bool searchPath( const rtl::OUString& ustrFilePath, const rtl::OUString& ustrSearchPathList, rtl::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: */