/* 
   URI manipulation routines.
   Copyright (C) 1999-2023, Joe Orton <joe@manyfish.co.uk>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
   
   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
   MA 02111-1307, USA

*/

#ifndef NE_URI_H
#define NE_URI_H

#include "ne_defs.h"

NE_BEGIN_DECLS

/* Return a copy of a path string with anything other than
 * "unreserved" and the forward-slash character percent-encoded
 * according to the URI encoding rules.  Returns a malloc-allocated
 * string and never NULL. */
char *ne_path_escape(const char *path)
    ne_attribute((nonnull));

 /* NE_PATH_NONRES - anything other than "unreserved" and the
  * forward-slash character percent-encoded according to the URI
  * encoding rules; same rules as ne_path_escape(). */
#define NE_PATH_NONRES (0x0001)
/* Escape any characters outside of those allowed in URIs. */
#define NE_PATH_NONURI (0x0002)

/* Return a copy of a path string with escaping applied per rules
 * determined by any combination of NE_PATH_* flags given.  Returns a
 * malloc-allocated string and never NULL. */
char *ne_path_escapef(const char *path, unsigned int flags)
    ne_attribute((nonnull));

/* Return a decoded copy of a percent-encoded path string. Returns
 * malloc-allocated path on success, or NULL if the string contained
 * any syntactically invalid percent-encoding sequences. */
char *ne_path_unescape(const char *epath)
    ne_attribute((nonnull));

/* Returns malloc-allocated parent of path, or NULL if path has no
 * parent (such as "/"). */
char *ne_path_parent(const char *path)
    ne_attribute((nonnull));

/* Returns strcmp-like value giving comparison between p1 and p2,
 * ignoring trailing-slashes. */
int ne_path_compare(const char *p1, const char *p2)
    ne_attribute((nonnull));

/* Returns non-zero if child is a child of parent. */
int ne_path_childof(const char *parent, const char *child)
    ne_attribute((nonnull));

/* Returns non-zero if path has a trailing slash character. */
int ne_path_has_trailing_slash(const char *path)
    ne_attribute((nonnull));

/* Return the default port for the given scheme, or 0 if none is
 * known. */
unsigned int ne_uri_defaultport(const char *scheme)
    ne_attribute((nonnull));

typedef struct {
    char *scheme;
    char *host, *userinfo;
    unsigned int port;
    char *path, *query, *fragment;
} ne_uri;

/* Parse a URI-reference 'uri' and place parsed components in *parsed.
 * Returns zero on success, non-zero on parse error.  On successful or
 * error return, all the 'char *' fields of *parsed are either set to
 * NULL, or point to malloc-allocated NUL-terminated strings;
 * ne_uri_free can be used to free any set fields.  On success,
 * parsed->path is guaranteed to be non-NULL. */
int ne_uri_parse(const char *uri, ne_uri *parsed)
    ne_attribute((nonnull));

/* Turns a URI structure back into a string.  The returned string is
 * malloc-allocated, and must be freed by the caller. */
char *ne_uri_unparse(const ne_uri *uri)
    ne_attribute((nonnull));

/* Resolve a relative URI 'relative', with respect to base URI 'base',
 * placing the resultant URI in '*result'.  At least both base->path
 * and relative->path must be non-NULL.  On return, all the 'char *'
 * fields of *result are either set to NULL or point to
 * malloc-allocated NUL-terminated strings.  result->path is
 * guaranteed to be non-NULL.  ne_uri_free can be used to free the
 * result structure after use.  Returns 'result'. */
ne_uri *ne_uri_resolve(const ne_uri *base, const ne_uri *relative,
                       ne_uri *result)
    ne_attribute((nonnull));

/* Compares URIs u1 and u2, returns non-zero if they are found to be
 * non-equal.  The sign of the return value is <0 if 'u1' is less than
 * 'u2', or >0 if 'u2' is greater than 'u1'. */
int ne_uri_cmp(const ne_uri *u1, const ne_uri *u2)
    ne_attribute((nonnull));

/* Copy components of URI 'src' to destination 'dest'.  Returns
 * 'dest'. */
ne_uri *ne_uri_copy(ne_uri *dest, const ne_uri *src)
    ne_attribute((nonnull));

/* Frees any non-NULL fields of parsed URI structure *parsed.  All
 * fields are then zero-initialized. */
void ne_uri_free(ne_uri *parsed)
    ne_attribute((nonnull));

NE_END_DECLS

#endif /* NE_URI_H */

