You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
133 lines
4.9 KiB
133 lines
4.9 KiB
/* This file is part of the KDE project
|
|
Copyright (C) 2003 Julian Rockey <linux@jrockey.com>
|
|
Copyright (C) 2003 Mario Scalas <mario.scalas@libero.it>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef _URLUTIL_H_
|
|
#define _URLUTIL_H_
|
|
|
|
#include <tqstring.h>
|
|
#include <tqvaluelist.h>
|
|
#include <kurl.h>
|
|
|
|
namespace URLUtil
|
|
{
|
|
enum SlashesPosition { SLASH_PREFIX = 1, SLASH_SUFFIX = 2 };
|
|
|
|
/**
|
|
* Returns the filename part of a pathname (i.e. everything past the last slash)
|
|
*/
|
|
TQString filename(const TQString & pathName);
|
|
/**
|
|
* Returns the directory part of a path (i.e. everything up to but not including the last slash)
|
|
*/
|
|
TQString directory(const TQString & pathName);
|
|
/**
|
|
* Returns the relative path between a parent and child URL, or blank if the specified child is not a child of parent
|
|
*/
|
|
TQString relativePath(const KURL & parent, const KURL & child, uint slashPolicy = SLASH_PREFIX);
|
|
/**
|
|
* Returns the relative path between a parent and child URL, or blank if the specified child is not a child of parent
|
|
*/
|
|
TQString relativePath(const TQString & parent, const TQString & child, uint slashPolicy = SLASH_PREFIX);
|
|
/**
|
|
* Returns the relative path between a directory and file. Should never return empty path.
|
|
* Example:
|
|
* dirUrl: /home/test/src
|
|
* fileUrl: /home/test/lib/mylib.cpp
|
|
* returns: ../lib/mylib.cpp
|
|
*/
|
|
TQString relativePathToFile( const TQString & dirUrl, const TQString & fileUrl );
|
|
/**
|
|
*Returns the path 'up one level' - the opposite of what filename returns
|
|
*/
|
|
TQString upDir(const TQString & path, bool slashSuffix = false);
|
|
/**
|
|
* 'Merges' URLs - changes a URL that starts with dest to start with source instead
|
|
* Example:
|
|
* source is /home/me/
|
|
* dest is /home/you/
|
|
* child is /home/you/dir1/file1
|
|
* returns /home/me/dir1/fil1
|
|
*/
|
|
KURL mergeURL(const KURL & source, const KURL & dest, const KURL & child);
|
|
/**
|
|
* Returns the file extension for a filename or path
|
|
*/
|
|
TQString getExtension(const TQString & path);
|
|
|
|
/**
|
|
* Given a base directory url in @p baseDirUrl and the url referring to a date sub-directory or file,
|
|
* it will return the path relative to @p baseDirUrl.
|
|
* If baseDirUrl == url.path() then it will return ".".
|
|
* <code>
|
|
* KURL baseUrl, dirUrl;
|
|
* baseUrl.setPath( "/home/mario/src/tdevelop/" );
|
|
* dirUrl.setPath( "/home/mario/src/tdevelop/parts/cvs/" );
|
|
* TQString relPathName = extractDirPathRelative( baseUrl, url ); // == "parts/cvs/"
|
|
* TQString absPathName = extractDirPathAbsolute( url ); // == "/home/mario/src/tdevelop/parts/cvs/"
|
|
* </code>
|
|
* Note that if you pass a file name in @p url (instead of a directory) or the @p baseUrl is not contained
|
|
* in @p url then the function will return "" (void string).
|
|
*/
|
|
TQString extractPathNameRelative(const KURL &baseDirUrl, const KURL &url );
|
|
TQString extractPathNameRelative(const TQString &basePath, const KURL &url );
|
|
TQString extractPathNameRelative(const TQString &basePath, const TQString &absFilePath );
|
|
|
|
/**
|
|
* Will return the absolute path name referred in @p url.
|
|
* Look at above for an example.
|
|
*/
|
|
TQString extractPathNameAbsolute( const KURL &url );
|
|
|
|
/**
|
|
* Returns a TQStringList of relative (to @p baseDir) paths from a list of KURLs in @p urls
|
|
*/
|
|
TQStringList toRelativePaths( const TQString &baseDir, const KURL::List &urls);
|
|
|
|
/**
|
|
* If @p url is a directory will return true, false otherwise.
|
|
*/
|
|
bool isDirectory( const KURL &url );
|
|
bool isDirectory( const TQString &absFilePath );
|
|
|
|
/**
|
|
* Will dump the list of KURL @p urls on standard output, eventually printing @ aMessage if it
|
|
* is not null.
|
|
*/
|
|
void dump( const KURL::List &urls, const TQString &aMessage = TQString() );
|
|
|
|
/**
|
|
* Same as TQDir::canonicalPath in later versions of QT. Earlier versions of QT
|
|
* had this broken, so it's reproduced here.
|
|
*/
|
|
TQString canonicalPath( const TQString & path );
|
|
|
|
/**
|
|
* Performs environment variable expansion on @p variable.
|
|
*
|
|
* @param variable the string with the environment variable to expand.
|
|
* @return the expanded environment variable value. if the variable
|
|
* cannot be expanded, @p variable itself is returned.
|
|
*/
|
|
TQString envExpand ( const TQString &variable );
|
|
|
|
}
|
|
|
|
#endif
|