url_result.h

Go to the documentation of this file.

// Copyright 2016-2026 Rimas Misevičius
// Distributed under the BSD-style license that can be
// found in the LICENSE file.
//
 
#ifndef UPA_URL_RESULT_H
#define UPA_URL_RESULT_H
 
#include "config.h"
 
#ifndef UPA_MODULE
# include <stdexcept>
#endif // UPA_MODULE
 
namespace upa {
 
UPA_EXPORT_BEGIN

enum class validation_errc {
    // Success:
    ok = 0,                         
    // Ignored input (for internal use):
    ignored,                        
    scheme_invalid_code_point,      
 
    // Standard validation error codes
    // https://url.spec.whatwg.org/#validation-error
 
    // Non-failure (only ipv4_out_of_range_part indicates failure in some cases,
    // see: https://url.spec.whatwg.org/#ipv4-out-of-range-part):
    // IDNA
    domain_to_unicode,              
    // Host parsing
    ipv4_empty_part,                
    ipv4_non_decimal_part,          
    ipv4_out_of_range_part,         
    // URL parsing
    invalid_url_unit,               
    special_scheme_missing_following_solidus, 
    invalid_reverse_solidus,        
    invalid_credentials,            
    file_invalid_windows_drive_letter, 
    file_invalid_windows_drive_letter_host, 
 
    // Failure:
    // IDNA
    domain_to_ascii,                
    // Host parsing
    domain_invalid_code_point [[deprecated]], 
    host_invalid_code_point,        
    ipv4_too_many_parts,            
    ipv4_non_numeric_part,          
    ipv6_unclosed,                  
    ipv6_invalid_compression,       
    ipv6_too_many_pieces,           
    ipv6_multiple_compression,      
    ipv6_invalid_code_point,        
    ipv6_too_few_pieces,            
    ipv4_in_ipv6_too_many_pieces,   
    ipv4_in_ipv6_invalid_code_point, 
    ipv4_in_ipv6_out_of_range_part, 
    ipv4_in_ipv6_too_few_parts,     
    // URL parsing
    missing_scheme_non_relative_url, 
    host_missing,                   
    port_out_of_range,              
    port_invalid,                   
 
    // Non-standard error codes (indicates failure)
 
    overflow,                       
    invalid_base,                   
    // url_from_file_path errors
    file_empty_path,                
    file_unsupported_path,          
    // path_from_file_url errors
    not_file_url,                   
    file_url_cannot_have_host,      
    file_url_unsupported_host,      
    file_url_invalid_unc,           
    file_url_not_windows_path,      
    null_character,                 
};

[[nodiscard]] constexpr bool success(validation_errc res) noexcept {
    return res == validation_errc::ok;
}

class UPA_SO_VISIBLE url_error : public std::runtime_error {
public:
    inline explicit url_error(validation_errc res, const char* what_arg)
        : std::runtime_error(what_arg)
        , res_(res)
    {}

    [[nodiscard]] inline validation_errc result() const noexcept {
        return res_;
    }
private:
    validation_errc res_;
};
 
UPA_EXPORT_END
 
namespace detail {

 
template<typename T, typename R = bool>
struct result_value {
    T value{};
    R result{};
 
    constexpr result_value(R res) noexcept
        : result(res) {}
    constexpr result_value(R res, T val) noexcept
        : value(val), result(res) {}
    [[nodiscard]] constexpr operator R() const noexcept {
        return result;
    }
};
 
} // namespace detail
} // namespace upa
 
#endif // UPA_URL_RESULT_H