tld.h.in

Go to the documentation of this file.

/* TLD library -- TLD, domain name, and sub-domain extraction
 * Copyright (C) 2011  Made to Order Software Corp.
 *
 * This program 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef LIB_TLD_H
#define LIB_TLD_H

#ifdef __cplusplus
extern "C" {
#endif

#define LIBTLD_VERSION_MAJOR    @LIBTLD_VERSION_MAJOR@
#define LIBTLD_VERSION_MINOR    @LIBTLD_VERSION_MINOR@
#define LIBTLD_VERSION_PATCH    @LIBTLD_VERSION_PATCH@
#define LIBTLD_VERSION          "@LIBTLD_VERSION_MAJOR@.@LIBTLD_VERSION_MINOR@.@LIBTLD_VERSION_PATCH@"

enum tld_category
{
    TLD_CATEGORY_INTERNATIONAL,
    TLD_CATEGORY_PROFESSIONALS,
    TLD_CATEGORY_LANGUAGE,
    TLD_CATEGORY_GROUPS,
    TLD_CATEGORY_REGION,
    TLD_CATEGORY_TECHNICAL,
    TLD_CATEGORY_COUNTRY,
    TLD_CATEGORY_ENTREPRENEURIAL,
    TLD_CATEGORY_UNDEFINED
};

enum tld_status
{
    TLD_STATUS_VALID,
    TLD_STATUS_PROPOSED,
    TLD_STATUS_DEPRECATED,
    TLD_STATUS_UNUSED,
    TLD_STATUS_RESERVED,
    TLD_STATUS_INFRASTRUCTURE,
    TLD_STATUS_UNDEFINED,

    /* The following status is never returned. It is used internally to handle
     * exceptions (i.e. usually 2nd level domain names that should not be.)
     */
    TLD_STATUS_EXCEPTION = 100
};

enum tld_result
{
    TLD_RESULT_SUCCESS,
    TLD_RESULT_INVALID,   /* TLD not acceptable (reserved, deprecated, etc.) */
    TLD_RESULT_NULL,      /* URI is a NULL pointer */
    TLD_RESULT_NO_TLD,    /* no '.' in the URI */
    TLD_RESULT_BAD_URI,   /* URI includes two '.' one after another */
    TLD_RESULT_NOT_FOUND
};

struct tld_info
{
    enum tld_category   f_category;
    enum tld_status     f_status;
    const char *        f_country;
    const char *        f_tld; /* pointer within your URI string */
    int                 f_offset;
};

extern enum tld_result tld(const char *uri, struct tld_info *info);

extern const char *tld_version();

#ifdef __cplusplus
}
#endif

#endif
/*#ifndef LIB_TLD_H*/
/* vim: ts=4 sw=4
 */