uritemplate_token.h

#ifndef SOURCEMETA_CORE_URITEMPLATE_TOKEN_H_
#define SOURCEMETA_CORE_URITEMPLATE_TOKEN_H_
 
#ifndef SOURCEMETA_CORE_URITEMPLATE_EXPORT
#include <sourcemeta/core/uritemplate_export.h>
#endif
 
#include <cstdint>     // std::uint16_t
#include <string_view> // std::string_view
#include <variant>     // std::variant
#include <vector>      // std::vector
 
namespace sourcemeta::core {
 
// Exporting symbols that depends on the standard C++ library is considered
// safe.
// https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-2-c4275?view=msvc-170&redirectedfrom=MSDN
#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable : 4251)
#endif

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT URITemplateTokenLiteral {
  std::string_view value;
};

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT URITemplateVariableSpecification {
  std::string_view name;
  // As per the RFC, the range is 1-9999. 0 means "no prefix length"
  std::uint16_t length{0};
  bool explode{false};
};

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT URITemplateTokenVariable {
  std::vector<URITemplateVariableSpecification> variables;
  static constexpr char separator = ',';
  static constexpr bool named = false;
  static constexpr bool allow_reserved = false;
};

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT URITemplateTokenReservedExpansion {
  std::vector<URITemplateVariableSpecification> variables;
  static constexpr char op = '+';
  static constexpr char separator = ',';
  static constexpr bool named = false;
  static constexpr bool allow_reserved = true;
};

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT URITemplateTokenFragmentExpansion {
  std::vector<URITemplateVariableSpecification> variables;
  static constexpr char op = '#';
  static constexpr char separator = ',';
  static constexpr char prefix = '#';
  static constexpr bool named = false;
  static constexpr bool allow_reserved = true;
};

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT URITemplateTokenLabelExpansion {
  std::vector<URITemplateVariableSpecification> variables;
  static constexpr char op = '.';
  static constexpr char separator = '.';
  static constexpr char prefix = '.';
  static constexpr bool named = false;
  static constexpr bool allow_reserved = false;
};

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT URITemplateTokenPathExpansion {
  std::vector<URITemplateVariableSpecification> variables;
  static constexpr char op = '/';
  static constexpr char separator = '/';
  static constexpr char prefix = '/';
  static constexpr bool named = false;
  static constexpr bool allow_reserved = false;
};

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT
    URITemplateTokenPathParameterExpansion {
  std::vector<URITemplateVariableSpecification> variables;
  static constexpr char op = ';';
  static constexpr char separator = ';';
  static constexpr char prefix = ';';
  static constexpr bool named = true;
  static constexpr bool allow_reserved = false;
};

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT URITemplateTokenQueryExpansion {
  std::vector<URITemplateVariableSpecification> variables;
  static constexpr char op = '?';
  static constexpr char separator = '&';
  static constexpr char prefix = '?';
  static constexpr bool named = true;
  static constexpr bool allow_reserved = false;
  static constexpr char empty_suffix = '=';
};

struct SOURCEMETA_CORE_URITEMPLATE_EXPORT
    URITemplateTokenQueryContinuationExpansion {
  std::vector<URITemplateVariableSpecification> variables;
  static constexpr char op = '&';
  static constexpr char separator = '&';
  static constexpr char prefix = '&';
  static constexpr bool named = true;
  static constexpr bool allow_reserved = false;
  static constexpr char empty_suffix = '=';
};
 
#if defined(_MSC_VER)
#pragma warning(pop)
#endif

using URITemplateToken = std::variant<
    URITemplateTokenLiteral, URITemplateTokenVariable,
    URITemplateTokenReservedExpansion, URITemplateTokenFragmentExpansion,
    URITemplateTokenLabelExpansion, URITemplateTokenPathExpansion,
    URITemplateTokenPathParameterExpansion, URITemplateTokenQueryExpansion,
    URITemplateTokenQueryContinuationExpansion>;
 
} // namespace sourcemeta::core
 
#endif