PathResolver.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed 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
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef OPENSWMM_ENGINE_PATH_RESOLVER_HPP
#define OPENSWMM_ENGINE_PATH_RESOLVER_HPP
 
#include <string>
 
namespace openswmm::io {
 
// ============================================================================
// PathClass — outcome of a makeRelative() attempt
// ============================================================================

enum class PathClass : int {
    Relative            = 0,  
    AbsoluteSameVolume  = 1,  
    AbsoluteCrossVolume = 2,  
    Invalid             = 3   
};
 
// ============================================================================
// RelativeResult — full outcome of makeRelative()
// ============================================================================

struct RelativeResult {
    std::string path;
    PathClass   classification = PathClass::Invalid;
    int         up_levels      = 0;
    std::string warning;
};
 
// ============================================================================
// Public API
// ============================================================================

RelativeResult makeRelative(const std::string& target_absolute,
                            const std::string& anchor_dir,
                            int                max_up_levels = 16);

std::string resolveRelative(const std::string& stored_token,
                            const std::string& anchor_dir);

std::string normaliseSeparators(const std::string& path);

std::string parentDir(const std::string& file_path);
 
// ============================================================================
// Test hooks — exposed for unit tests; not part of the supported API.
// ============================================================================

bool isAbsolutePath(const std::string& path) noexcept;
 
} // namespace openswmm::io
 
#endif // OPENSWMM_ENGINE_PATH_RESOLVER_HPP