You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
netsurf/utils/nsurl/private.h

166 lines
4.0 KiB

/*
* Copyright 2011-2017 Michael Drake <tlsa@netsurf-browser.org>
*
* This file is part of NetSurf, http://www.netsurf-browser.org/
*
* NetSurf is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* NetSurf is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef NETSURF_UTILS_NSURL_PRIVATE_H_
#define NETSURF_UTILS_NSURL_PRIVATE_H_
#include <libwapcaplet/libwapcaplet.h>
#include "utils/nsurl.h"
#include "utils/utils.h"
/**
* nsurl components
*
* [scheme]://[username]:[password]@[host]:[port][path][?query]#[fragment]
*
* Note:
* "path" string includes preceding '/', if needed for the scheme
* "query" string always includes preceding '?'
*
* The other spanned punctuation is to be inserted when building URLs from
* components.
*/
struct nsurl_components {
lwc_string *scheme;
lwc_string *username;
lwc_string *password;
lwc_string *host;
lwc_string *port;
lwc_string *path;
lwc_string *query;
lwc_string *fragment;
enum nsurl_scheme_type scheme_type;
};
/**
* NetSurf URL object
*/
struct nsurl {
struct nsurl_components components;
int count; /* Number of references to NetSurf URL object */
uint32_t hash; /* Hash value for nsurl identification */
size_t length; /* Length of string */
char string[FLEX_ARRAY_LEN_DECL]; /* Full URL as a string */
};
/** Marker set, indicating positions of sections within a URL string */
struct nsurl_component_lengths {
size_t scheme;
size_t username;
size_t password;
size_t host;
size_t port;
size_t path;
size_t query;
size_t fragment;
};
/** Flags indicating which parts of a URL string are required for a nsurl */
enum nsurl_string_flags {
NSURL_F_SCHEME = (1 << 0),
NSURL_F_SCHEME_PUNCTUATION = (1 << 1),
NSURL_F_AUTHORITY_PUNCTUATION = (1 << 2),
NSURL_F_USERNAME = (1 << 3),
NSURL_F_PASSWORD = (1 << 4),
NSURL_F_CREDENTIALS_PUNCTUATION = (1 << 5),
NSURL_F_HOST = (1 << 6),
NSURL_F_PORT = (1 << 7),
NSURL_F_AUTHORITY = (NSURL_F_USERNAME |
NSURL_F_PASSWORD |
NSURL_F_HOST |
NSURL_F_PORT),
NSURL_F_PATH = (1 << 8),
NSURL_F_QUERY_PUNCTUATION = (1 << 9),
NSURL_F_QUERY = (1 << 10),
NSURL_F_FRAGMENT_PUNCTUATION = (1 << 11),
NSURL_F_FRAGMENT = (1 << 12)
};
/**
* NULL-safe lwc_string_ref
*/
#define nsurl__component_copy(c) (c == NULL) ? NULL : lwc_string_ref(c)
/**
* Convert a set of nsurl components to a single string
*
* \param[in] components The URL components to stitch together.
* \param[in] parts The set of parts wanted in the string.
* \param[in] pre_padding Amount in bytes to pad the start of the string by.
* \param[out] url_s_out Returns allocated URL string.
* \param[out] url_l_out Returns byte length of string, excluding pre_padding.
* \return NSERROR_OK on success, appropriate error otherwise.
*/
nserror nsurl__components_to_string(
const struct nsurl_components *components,
nsurl_component parts, size_t pre_padding,
char **url_s_out, size_t *url_l_out);
/**
* Calculate hash value
*
* \param url NetSurf URL object to set hash value for
*/
void nsurl__calc_hash(nsurl *url);
/**
* Destroy components
*
* \param c url components
*/
static inline void nsurl__components_destroy(struct nsurl_components *c)
{
if (c->scheme)
lwc_string_unref(c->scheme);
if (c->username)
lwc_string_unref(c->username);
if (c->password)
lwc_string_unref(c->password);
if (c->host)
lwc_string_unref(c->host);
if (c->port)
lwc_string_unref(c->port);
if (c->path)
lwc_string_unref(c->path);
if (c->query)
lwc_string_unref(c->query);
if (c->fragment)
lwc_string_unref(c->fragment);
}
#endif