afw_uri.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Uniform Resource Identifier (URI) helpers
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_URI_H__
#define __AFW_URI_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
typedef afw_uint32_t afw_uri_octet_type_t;
 
 
 
#define AFW_URI_OCTET_INVALID                   (afw_uri_octet_type_t)0x00000000
 
#define AFW_URI_OCTET_GEN_DELIM                 (afw_uri_octet_type_t)0x00000001
#define AFW_URI_OCTET_SUB_DELIM                 (afw_uri_octet_type_t)0x00000002
#define AFW_URI_OCTET_UNRESERVED                (afw_uri_octet_type_t)0x00000004
#define AFW_URI_OCTET_PCT_ENCODED               (afw_uri_octet_type_t)0x00000008
 
#define AFW_URI_OCTET_ALPHA_UPPER               (afw_uri_octet_type_t)0x00000010
#define AFW_URI_OCTET_ALPHA_LOWER               (afw_uri_octet_type_t)0x00000020
#define AFW_URI_OCTET_DIGIT                     (afw_uri_octet_type_t)0x00000040
#define AFW_URI_OCTET_HEXDIGIT                  (afw_uri_octet_type_t)0x00000080
 
#define AFW_URI_OCTET_ENCODE_URI                (afw_uri_octet_type_t)0x00000100
 
#define AFW_URI_OCTET_ENCODE_COMPONENT          (afw_uri_octet_type_t)0x00000200
 
#define AFW_URI_OCTET_ENCODE_COMPONENT_VALUE    (afw_uri_octet_type_t)0x00000400
 
#define AFW_URI_OCTET_AT                        (afw_uri_octet_type_t)0x00010000
#define AFW_URI_OCTET_COLON                     (afw_uri_octet_type_t)0x00020000
#define AFW_URI_OCTET_MINUS                     (afw_uri_octet_type_t)0x00040000
#define AFW_URI_OCTET_PERCENT                   (afw_uri_octet_type_t)0x00080000
#define AFW_URI_OCTET_PERIOD                    (afw_uri_octet_type_t)0x00100000
#define AFW_URI_OCTET_PLUS                      (afw_uri_octet_type_t)0x00200000
#define AFW_URI_OCTET_QUESTION                  (afw_uri_octet_type_t)0x00400000
#define AFW_URI_OCTET_SLASH                     (afw_uri_octet_type_t)0x00800000
 
#define AFW_URI_OCTET_MASK_IS_BITWISE_NOT       (afw_uri_octet_type_t)0x80000000
 
#define AFW_URI_OCTET_ALPHA \
    ( AFW_URI_OCTET_ALPHA_UPPER | \
    AFW_URI_OCTET_ALPHA_LOWER )
 
#define AFW_URI_OCTET_PCHAR \
    ( AFW_URI_OCTET_UNRESERVED | \
    AFW_URI_OCTET_PCT_ENCODED | \
    AFW_URI_OCTET_SUB_DELIM | \
    AFW_URI_OCTET_COLON | \
    AFW_URI_OCTET_AT )
 
#define AFW_URI_OCTET_SCHEME_START \
    ( AFW_URI_OCTET_ALPHA )
 
#define AFW_URI_OCTET_SCHEME_CONTINUE \
    ( AFW_URI_OCTET_ALPHA | \
    AFW_URI_OCTET_DIGIT | \
    AFW_URI_OCTET_PLUS | \
    AFW_URI_OCTET_MINUS | \
    AFW_URI_OCTET_PERIOD )
 
#define AFW_URI_OCTET_USERINFO \
    ( AFW_URI_OCTET_UNRESERVED | \
    AFW_URI_OCTET_PCT_ENCODED | \
    AFW_URI_OCTET_SUB_DELIM | \
    AFW_URI_OCTET_COLON )
 
#define AFW_URI_OCTET_QUERY \
    ( AFW_URI_OCTET_PCHAR | \
    AFW_URI_OCTET_SLASH | \
    AFW_URI_OCTET_QUESTION )
 
#define AFW_URI_OCTET_FRAGMENT \
    ( AFW_URI_OCTET_PCHAR | \
    AFW_URI_OCTET_SLASH | \
    AFW_URI_OCTET_QUESTION )
 
#define AFW_URI_OCTET_RESERVED \
    ( AFW_URI_OCTET_GEN_DELIM | \
    AFW_URI_OCTET_SUB_DELIM )
 
 
#define AFW_URI_OCTET_IS(type, mask) \
((type) & (AFW_URI_OCTET_ ## mask))
 
 
AFW_DECLARE_CONST_DATA(afw_uri_octet_type_t)
afw_uri_octet_type[256];
 
 
typedef struct afw_uri_parsed_s {
 
    /* @brief Unparsed uri from call to afw_uri_parse(). */
    const afw_utf8_t *original_uri;
 
    /* @brief Current path or NULL passed to afw_uri_parse(). */
    const afw_utf8_t *current_path;
 
    /*
     * @brief Parsed value path
     *
     * If path part of URI is an adaptive value path, this is the parsed
     * path; otherwise, NULL.
     */
    const afw_object_path_parsed_t *path_parsed;
 
    /*
     * @brief  The form of the URI that AFW considers normalized.
     *
     * This will begin with a single slash if the URI is a local path;
     * otherwise, this is a full URI.
     */
    afw_utf8_t normalized_uri;
 
    /* @brief  Scheme. Can not be percent encoded. */
    afw_utf8_t scheme;
 
    /* @brief  Original hier-part */
    afw_utf8_t original_hier_part;
 
    /* @brief  Original authority */
    afw_utf8_t original_authority;
 
    /* @brief  Decoded authority */
    const afw_utf8_t *authority;
 
    /* @brief  Original userinfo */
    afw_utf8_t original_userinfo;
 
    /* @brief  Decoded userinfo */
    const afw_utf8_t *userinfo;
 
    /* @brief  Original host */
    afw_utf8_t original_host;
 
    /* @brief  Decoded host */
    const afw_utf8_t *host;
 
    /* @brief  Port. Can not be percent encoded. */
    afw_utf8_t port;
 
    /* @brief  Original path */
    afw_utf8_t original_path;
 
    /* @brief  Original query */
    afw_utf8_t original_query;
 
    /* @brief  Original fragment */
    afw_utf8_t original_fragment;
 
} afw_uri_parsed_t;
 
 
typedef struct afw_uri_parser_s {
 
    /* @brief Decoded string representing token. */
    afw_utf8_t token;
 
    /* @brief Indicates that token is AFW_URI_OCTET_RESERVED. */
    afw_boolean_t is_reserved;
 
    /* Private members. */
    const afw_pool_t *p;
    const afw_utf8_t *uri;
    const afw_octet_t *c;
    const afw_octet_t *end;
    afw_uri_octet_type_t type;
    afw_boolean_t reuse;
    afw_boolean_t consider_period_a_token;
} afw_uri_parser_t;
 
 
AFW_DECLARE(void)
afw_uri_parser_initialize(afw_uri_parser_t *parser,
    const afw_utf8_t *uri,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_uri_parser_t *)
afw_uri_parser_create(const afw_utf8_t *uri,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_uri_parse_next_token(const afw_uri_parser_t *parser,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_uri_parse_reuse_token(const afw_uri_parser_t *parser,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_uri_parse_set_consider_period_a_token(
    const afw_uri_parser_t *parser,
    afw_boolean_t consider_period_a_token,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(afw_size_t)
afw_uri_encode_len(
    const afw_utf8_t *string,
    afw_uri_octet_type_t mask,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(afw_size_t)
afw_uri_encode_raw_len(
    const afw_memory_t *raw,
    afw_uri_octet_type_t mask,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_uri_encode(
    const afw_utf8_t *string,
    afw_uri_octet_type_t mask,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_uri_encode_create(
    const afw_utf8_octet_t *s,
    afw_size_t len,
    afw_uri_octet_type_t mask,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_uri_encode_raw(
    const afw_memory_t *raw,
    afw_uri_octet_type_t mask,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
AFW_DECLARE(afw_size_t)
afw_uri_encode_to_preallocated(
    afw_utf8_octet_t *s,
    afw_size_t s_len,
    const afw_utf8_t *string,
    afw_uri_octet_type_t mask,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(afw_size_t)
afw_uri_encode_raw_to_preallocated(
    afw_utf8_octet_t *s,
    afw_size_t s_len,
    const afw_memory_t *raw,
    afw_uri_octet_type_t mask,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_uri_decode(
    const afw_utf8_t *encoded,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_uri_decode_create(
    const afw_utf8_octet_t *s,
    afw_size_t len,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_memory_t *)
afw_uri_decode_to_raw_create(
    const afw_utf8_octet_t *s,
    afw_size_t len,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_memory_t *)
afw_uri_decode_to_raw(
    const afw_utf8_t *encoded,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_uri_parsed_t *)
afw_uri_parse(
    const afw_utf8_t *uri,
    afw_boolean_t is_value_path,
    const afw_utf8_t *current_path,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_object_t *)
afw_uri_parsed_to_object(
    const afw_uri_parsed_t * parsed,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_object_t *)
afw_uri_to_object(
    const afw_utf8_t *uri,
    afw_boolean_t is_value_path,
    const afw_utf8_t *current_path,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(afw_boolean_t)
afw_uri_octet_test(
    afw_octet_t octet,
    afw_uri_octet_type_t mask);
 
 
AFW_DECLARE(afw_boolean_t)
afw_uri_parsed_are_equivalent(
    const afw_uri_parsed_t *parsed1,
    const afw_uri_parsed_t *parsed2,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(afw_boolean_t)
afw_uri_are_equivalent(
    const afw_utf8_t *uri1,
    const afw_utf8_t *uri2,
    afw_boolean_t is_value_path,
    const afw_utf8_t *current_path2,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_URI_H__ */