comparepaths.cpp revision c58f1213e628a545081c70e26c6b67a841cff880
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * IPRT - Path Comparison.
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2012 Oracle Corporation
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * available from http://www.virtualbox.org. This file is free software;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * you can redistribute it and/or modify it under the terms of the GNU
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * General Public License (GPL) as published by the Free Software
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * The contents of this file may alternatively be used under the terms
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * of the Common Development and Distribution License Version 1.0
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * VirtualBox OSE distribution, in which case the provisions of the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * CDDL are applicable instead of those of the GPL.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * You may elect to license modified versions of this file under the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * terms and conditions of either the GPL or the CDDL or both.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync/*******************************************************************************
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync* Header Files *
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync*******************************************************************************/
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Helper for RTPathCompare() and RTPathStartsWith().
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @returns similar to strcmp.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @param pszPath1 Path to compare.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @param pszPath2 Path to compare.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @param fLimit Limit the comparison to the length of \a pszPath2
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @internal
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsyncstatic int rtPathCompare(const char *pszPath1, const char *pszPath2, bool fLimit)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync iDiff = uc1 > uc2 ? 1 : -1; /* (overflow/underflow paranoia) */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return strncmp(pszPath1, pszPath2, strlen(pszPath2));
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Compares two paths.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * The comparison takes platform-dependent details into account,
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * <li>On DOS-like platforms, both separator chars (|\| and |/|) are considered
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * to be equal.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * <li>On platforms with case-insensitive file systems, mismatching characters
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * are uppercased and compared again.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @returns @< 0 if the first path less than the second path.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @returns 0 if the first path identical to the second path.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @returns @> 0 if the first path greater than the second path.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @param pszPath1 Path to compare (must be an absolute path).
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @param pszPath2 Path to compare (must be an absolute path).
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @remarks File system details are currently ignored. This means that you won't
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * get case-insensitive compares on unix systems when a path goes into a
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * case-insensitive filesystem like FAT, HPFS, HFS, NTFS, JFS, or
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * similar. For NT, OS/2 and similar you'll won't get case-sensitive
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * compares on a case-sensitive file system.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsyncRTDECL(int) RTPathCompare(const char *pszPath1, const char *pszPath2)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return rtPathCompare(pszPath1, pszPath2, false /* full path lengths */);
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Checks if a path starts with the given parent path.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * This means that either the path and the parent path matches completely, or
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * that the path is to some file or directory residing in the tree given by the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * parent directory.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * The path comparison takes platform-dependent details into account,
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * see RTPathCompare() for details.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @returns |true| when \a pszPath starts with \a pszParentPath (or when they
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * are identical), or |false| otherwise.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @param pszPath Path to check, must be an absolute path.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @param pszParentPath Parent path, must be an absolute path.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * No trailing directory slash!
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsyncRTDECL(bool) RTPathStartsWith(const char *pszPath, const char *pszParentPath)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return true;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return false;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (rtPathCompare(pszPath, pszParentPath, true /* limited by path 2 */) != 0)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return false;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync const size_t cchParentPath = strlen(pszParentPath);
85d5c8191911b5acf139fa1982c406ae7fbe8801vboxsync return true;
85d5c8191911b5acf139fa1982c406ae7fbe8801vboxsync return true;
85d5c8191911b5acf139fa1982c406ae7fbe8801vboxsync /* Deal with pszParentPath = root (or having a trailing slash). */
85d5c8191911b5acf139fa1982c406ae7fbe8801vboxsync && RTPATH_IS_SLASH(pszParentPath[cchParentPath - 1])
85d5c8191911b5acf139fa1982c406ae7fbe8801vboxsync return true;
85d5c8191911b5acf139fa1982c406ae7fbe8801vboxsync return false;