Path.h

// Copyright (c) 2011 The Foundry Visionmongers Ltd. All Rights Reserved.
#ifndef INCLUDED_FNGEOLIBUTIL_PATH_H
#define INCLUDED_FNGEOLIBUTIL_PATH_H

#include <set>
#include <string>
#include <vector>

#include <FnGeolib/FnGeolibAPI.h>
#include <FnGeolib/util/ns.h>
#include <FnPlatform/StringView.h>

FNGEOLIBUTIL_NAMESPACE_ENTER
{

namespace Path
{
    FNGEOLIB_API
    std::string NormalizeAbsPath(const std::string & locationPath);

    FNGEOLIB_API
    std::string GetLocationParent(FnPlatform::StringView locationPath);

    FNGEOLIB_API
    std::string GetLeafName(FnPlatform::StringView locationPath);

    FNGEOLIB_API
    void GetLeafAndParent(std::string& parent,
                          std::string& leaf,
                          FnPlatform::StringView locationPath);

    FNGEOLIB_API
    void GetLocationStack(std::vector<std::string> & returnStack,
        const std::string & locationPath, const std::string & rootPath=std::string());

    FNGEOLIB_API
    bool IsAncestorOrEqual(FnPlatform::StringView locA,
                           FnPlatform::StringView locB);

    FNGEOLIB_API
    bool IsAncestor(FnPlatform::StringView locA, FnPlatform::StringView locB);

    FNGEOLIB_API
    std::string Join(FnPlatform::StringView locA, FnPlatform::StringView locB);

    FNGEOLIB_API
    bool IsRelativePath(const std::string & path);

    FNGEOLIB_API
    std::string RelativeToAbsPath(const std::string & rootPath, const std::string & path);

    FNGEOLIB_API
    std::string NormalizedRelativePath(const std::string & rootpath,
        const std::string & path);

    FNGEOLIB_API
    std::string RelativePath(const std::string & rootPath,
        const std::string & path);

    // both

    struct FnMatchInfo
    {
        bool match;
        bool canMatchChildren;
    };

    FNGEOLIB_API
    void FnMatch(FnMatchInfo& matchInfo,
                 FnPlatform::StringView testpath,
                 FnPlatform::StringView pattern);

    FNGEOLIB_API
    void FnMatchIncludingAncestors(FnMatchInfo& matchInfo,
                                   FnPlatform::StringView testpath,
                                   FnPlatform::StringView pattern);

    FNGEOLIB_API
    void ExactMatch(FnMatchInfo& matchInfo,
                    FnPlatform::StringView testpath,
                    FnPlatform::StringView pattern);

    FNGEOLIB_API
    std::string MakeUniqueName(FnPlatform::StringView baseName,
                               const std::set<std::string>& existingNames);

    FNGEOLIB_API
    std::string MakeSafeIdentifier(FnPlatform::StringView identifier);

    FNGEOLIB_API
    int Compare(FnPlatform::StringView pathA, FnPlatform::StringView pathB);

}  // namespace Path
}
FNGEOLIBUTIL_NAMESPACE_EXIT

#endif // INCLUDED_FNGEOLIBUTIL_PATH_H