api/confparse_8hh_source.html

// -*- c-basic-offset: 4; related-file-name: "../../lib/confparse.cc" -*-

#ifndef CLICK_CONFPARSE_HH

#define CLICK_CONFPARSE_HH

#include <click/string.hh>

#include <click/vector.hh>

struct in_addr;

#if HAVE_IP6

struct in6_addr;

#endif

CLICK_DECLS

class ErrorHandler;

class StringAccum;

class Timestamp;

#ifndef CLICK_TOOL

class Element;

class Router;

class Handler;

class HandlerCall;

# define CP_VA_PARSE_ARGS_REST  const Element*, ErrorHandler*, ...

# define CP_OPT_CONTEXT         , const Element* context = 0

# define CP_CONTEXT             , const Element* context

# define CP_PASS_CONTEXT        , context

#else

# define CP_VA_PARSE_ARGS_REST  ErrorHandler*, ...

# define CP_OPT_CONTEXT

# define CP_CONTEXT

# define CP_PASS_CONTEXT

#endif

#ifndef CLICK_COMPILING_CONFPARSE_CC

# define CLICK_CONFPARSE_DEPRECATED CLICK_DEPRECATED

#else

# define CLICK_CONFPARSE_DEPRECATED /* */

#endif

#if __GNUC__ <= 3

# define CP_SENTINEL

#else

# define CP_SENTINEL __attribute__((sentinel))

#endif


const char* cp_skip_space(const char* begin, const char* end);

const char* cp_skip_comment_space(const char* begin, const char* end);

const char* cp_skip_double_quote(const char* begin, const char* end);

bool cp_eat_space(String &str);

inline bool cp_is_space(const String &str);

bool cp_is_word(const String &str);

bool cp_is_click_id(const String &str);


String cp_uncomment(const String &str);

String cp_unquote(const String &str);

const char* cp_process_backslash(const char* begin, const char* end, StringAccum &sa);

String cp_quote(const String &str, bool allow_newlines = false);


void cp_argvec(const String& str, Vector<String>& conf);

String cp_unargvec(const Vector<String>& conf);


void cp_spacevec(const String& str, Vector<String>& conf);


String cp_shift_spacevec(String &str);


String cp_unspacevec(const String *begin, const String *end);

inline String cp_unspacevec(const Vector<String> &conf);


String cp_shift_delimiter(String &str, char delim);


enum CpErrors {

    CPE_OK = 0,

    CPE_FORMAT,

    CPE_NEGATIVE,

    CPE_OVERFLOW,

    CPE_INVALID,

    CPE_MEMORY,

    CPE_NOUNITS

};

extern int cp_errno;


// strings and words

bool cp_string(const String& str, String* result, String *rest = 0);

bool cp_word(const String& str, String* result, String *rest = 0);

bool cp_keyword(const String& str, String* result, String *rest = 0);


bool cp_bool(const String& str, bool* result);


// numbers

enum { cp_basic_integer_whole = 64 };

const char *cp_basic_integer(const char *begin, const char *end, int flags, int size, void *result);


inline const char *cp_integer(const char *begin, const char *end, int base, int *result);

inline const char *cp_integer(const char *begin, const char *end, int base, unsigned *result);

inline const char *cp_integer(const char *begin, const char *end, int base, long *result);

inline const char *cp_integer(const char *begin, const char *end, int base, unsigned long *result);

inline const unsigned char *cp_integer(const unsigned char *begin, const unsigned char *end, int base, unsigned *result);

inline const unsigned char *cp_integer(const unsigned char *begin, const unsigned char *end, int base, unsigned long *result);

#if HAVE_LONG_LONG

inline const char *cp_integer(const char *begin, const char *end, int base, long long *result);

inline const char *cp_integer(const char *begin, const char *end, int base, unsigned long long *result);

inline const unsigned char *cp_integer(const unsigned char *begin, const unsigned char *end, int base, unsigned long long *result);

#elif HAVE_INT64_TYPES && !HAVE_INT64_IS_LONG

inline const char *cp_integer(const char *begin, const char *end, int base, int64_t *result);

inline const char *cp_integer(const char *begin, const char *end, int base, uint64_t *result);

inline const unsigned char *cp_integer(const unsigned char *begin, const unsigned char *end, int base, uint64_t *result);

#endif


inline bool cp_integer(const String &str, int base, int *result);

inline bool cp_integer(const String &str, int base, unsigned int *result);

inline bool cp_integer(const String &str, int base, long *result);

inline bool cp_integer(const String &str, int base, unsigned long *result);

#if HAVE_LONG_LONG

inline bool cp_integer(const String &str, int base, long long *result);

inline bool cp_integer(const String &str, int base, unsigned long long *result);

#elif HAVE_INT64_TYPES && !HAVE_INT64_IS_LONG

inline bool cp_integer(const String &str, int base, int64_t *result);

inline bool cp_integer(const String &str, int base, uint64_t *result);

#endif


inline bool cp_integer(const String &str, int *result);

inline bool cp_integer(const String &str, unsigned int *result);

inline bool cp_integer(const String &str, long *result);

inline bool cp_integer(const String &str, unsigned long *result);

#if HAVE_LONG_LONG

inline bool cp_integer(const String &str, long long *result);

inline bool cp_integer(const String &str, unsigned long long *result);

#elif HAVE_INT64_TYPES && !HAVE_INT64_IS_LONG

inline bool cp_integer(const String &str, int64_t *result);

inline bool cp_integer(const String &str, uint64_t *result);

#endif


#define CP_REAL2_MAX_FRAC_BITS 28

bool cp_real2(const String& str, int frac_bits, int32_t* result);

bool cp_real2(const String& str, int frac_bits, uint32_t* result);

bool cp_real10(const String& str, int frac_digits, int32_t* result);

bool cp_real10(const String& str, int frac_digits, uint32_t* result);

bool cp_real10(const String& str, int frac_digits, uint32_t* result_int, uint32_t* result_frac);

#if HAVE_FLOAT_TYPES

bool cp_double(const String& str, double* result);

#endif


bool cp_seconds_as(const String& str, int frac_digits, uint32_t* result);

bool cp_seconds_as_milli(const String& str, uint32_t* result);

bool cp_seconds_as_micro(const String& str, uint32_t* result);

#if HAVE_FLOAT_TYPES

bool cp_seconds(const String& str, double* result);

#endif

bool cp_time(const String &str, Timestamp *result, bool allow_negative = false);

bool cp_time(const String& str, struct timeval* result);


bool cp_bandwidth(const String& str, uint64_t* result);


// network addresses

class IPAddressList;

bool cp_ip_address(const String& str, IPAddress* result  CP_OPT_CONTEXT);

inline bool cp_ip_address(const String& str, struct in_addr* result  CP_OPT_CONTEXT);

bool cp_ip_address(const String& str, unsigned char* result  CP_OPT_CONTEXT);

bool cp_ip_prefix(const String& str, IPAddress* result_addr, IPAddress* result_mask, bool allow_bare_address  CP_OPT_CONTEXT);

bool cp_ip_prefix(const String& str, unsigned char* result_addr, unsigned char* result_mask, bool allow_bare_address  CP_OPT_CONTEXT);

bool cp_ip_prefix(const String& str, IPAddress* result_addr, IPAddress* result_mask  CP_OPT_CONTEXT);

bool cp_ip_prefix(const String& str, unsigned char* result_addr, unsigned char* result_mask  CP_OPT_CONTEXT);

bool cp_ip_address_list(const String& str, Vector<IPAddress>* result  CP_OPT_CONTEXT);


#if HAVE_IP6

class IP6Address;

bool cp_ip6_address(const String& str, IP6Address* result  CP_OPT_CONTEXT);

inline bool cp_ip6_address(const String& str, struct in6_addr* result  CP_OPT_CONTEXT);

bool cp_ip6_address(const String& str, unsigned char* result  CP_OPT_CONTEXT);

bool cp_ip6_prefix(const String& str, IP6Address* result_addr, int* result_prefix, bool allow_bare_address  CP_OPT_CONTEXT);

bool cp_ip6_prefix(const String& str, unsigned char* result_addr, int* result_prefix, bool allow_bare_address  CP_OPT_CONTEXT);

bool cp_ip6_prefix(const String& str, unsigned char* result_addr, unsigned char* result_mask, bool allow_bare_address  CP_OPT_CONTEXT);

bool cp_ip6_prefix(const String& str, IP6Address* result_addr, IP6Address* result_mask, bool allow_bare_address  CP_OPT_CONTEXT);

#endif


class EtherAddress;

bool cp_ethernet_address(const String& str, EtherAddress* result  CP_OPT_CONTEXT);

bool cp_ethernet_address(const String& str, unsigned char* result  CP_OPT_CONTEXT);


bool cp_tcpudp_port(const String& str, int proto, uint16_t* result  CP_OPT_CONTEXT);


#if !CLICK_TOOL

Element *cp_element(const String &str, const Element *context, ErrorHandler *errh = 0, const char *argname = 0);

Element *cp_element(const String &str, Router *router, ErrorHandler *errh = 0, const char *argname = 0);

bool cp_handler_name(const String& str, Element** result_element, String* result_hname, const Element* context, ErrorHandler* errh=0);

bool cp_handler(const String& str, int flags, Element** result_element, const Handler** result_handler, const Element* context, ErrorHandler* errh=0);

#endif


#if CLICK_USERLEVEL || CLICK_TOOL

bool cp_filename(const String& str, String* result);

bool cp_file_offset(const String& str, off_t* result);

#endif


#if !CLICK_TOOL

bool cp_anno(const String &str, int size, int *result  CP_OPT_CONTEXT);

#endif


int cp_va_kparse(const Vector<String>& conf, CP_VA_PARSE_ARGS_REST) CP_SENTINEL;

int cp_va_kparse(const String& str, CP_VA_PARSE_ARGS_REST) CP_SENTINEL;

int cp_va_space_kparse(const String& str, CP_VA_PARSE_ARGS_REST) CP_SENTINEL;

int cp_va_kparse_keyword(const String& str, CP_VA_PARSE_ARGS_REST) CP_SENTINEL;

int cp_va_kparse_remove_keywords(Vector<String>& conf, CP_VA_PARSE_ARGS_REST) CP_SENTINEL;


int cp_assign_arguments(const Vector<String> &argv, const String *param_begin, const String *param_end, Vector<String>* values = 0);


void cp_va_static_initialize();

void cp_va_static_cleanup();


enum CpKparseFlags {

    cpkN = 0,

    cpkM = 1,

    cpkP = 2,

    cpkC = 4,

    cpkD = 8,

    cpkNormal = cpkN,

    cpkMandatory = cpkM,

    cpkPositional = cpkP,

    cpkConfirm = cpkC,

    cpkDeprecated = cpkD

};


typedef const char *CpVaParseCmd;


extern const CpVaParseCmd

    cpEnd,

    cpIgnoreRest,

    cpIgnore,

    cpArgument,

    cpArguments,

    cpString,

    cpWord,

    cpKeyword,

    cpBool,

    cpByte,

    cpShort,

    cpUnsignedShort,

    cpInteger,

    cpUnsigned,

    cpSize,

    cpNamedInteger,

#if HAVE_INT64_TYPES

    cpInteger64,

    cpUnsigned64,

#endif

    cpUnsignedReal2,

    cpReal10,

    cpUnsignedReal10,

#if HAVE_FLOAT_TYPES

    cpDouble,

#endif

    cpSeconds,

    cpSecondsAsMilli,

    cpSecondsAsMicro,

    cpTimestamp,

    cpTimestampSigned,

    cpTimeval,

    cpBandwidth,

    cpIPAddress,

    cpIPPrefix,

    cpIPAddressOrPrefix,

    cpIPAddressList,

    cpEtherAddress,

    cpEthernetAddress,

    cpTCPPort,

    cpUDPPort,

    cpElement,

    cpElementCast,

    cpHandlerName,

    cpHandlerCallRead,

    cpHandlerCallWrite,

    cpHandlerCallPtrRead,

    cpHandlerCallPtrWrite,

    cpIP6Address,

    cpIP6Prefix,

    cpIP6PrefixLen,

    cpIP6AddressOrPrefix,

#if CLICK_USERLEVEL || CLICK_TOOL

    cpFilename,

    cpFileOffset,

#endif

#if !CLICK_TOOL

    cpAnno,

#endif

    cpOptional,

    cpKeywords,

    cpConfirmKeywords,

    cpMandatoryKeywords;

// old names, here for compatibility:

extern const CpVaParseCmd

    cpInterval CLICK_CONFPARSE_DEPRECATED,              // struct timeval*

    cpReadHandlerCall CLICK_CONFPARSE_DEPRECATED,       // HandlerCall**

    cpWriteHandlerCall CLICK_CONFPARSE_DEPRECATED;      // HandlerCall**


String cp_unparse_bool(bool value);

String cp_unparse_real2(int32_t value, int frac_bits);

String cp_unparse_real2(uint32_t value, int frac_bits);

#if HAVE_INT64_TYPES

String cp_unparse_real2(int64_t value, int frac_bits);

String cp_unparse_real2(uint64_t value, int frac_bits);

#endif

String cp_unparse_real10(int32_t value, int frac_digits);

String cp_unparse_real10(uint32_t value, int frac_digits);

String cp_unparse_milliseconds(uint32_t value);

String cp_unparse_microseconds(uint32_t value);

String cp_unparse_interval(const Timestamp& value) CLICK_DEPRECATED;

String cp_unparse_interval(const struct timeval& value) CLICK_DEPRECATED;

String cp_unparse_bandwidth(uint32_t value);


int cp_va_parse(const Vector<String>& conf, CP_VA_PARSE_ARGS_REST) CLICK_DEPRECATED;

int cp_va_parse(const String& str, CP_VA_PARSE_ARGS_REST) CLICK_DEPRECATED;

int cp_va_space_parse(const String& str, CP_VA_PARSE_ARGS_REST) CLICK_DEPRECATED;

int cp_va_parse_keyword(const String& str, CP_VA_PARSE_ARGS_REST) CLICK_DEPRECATED;

int cp_va_parse_remove_keywords(Vector<String>& conf, int first, CP_VA_PARSE_ARGS_REST) CLICK_DEPRECATED;

// Argument syntax:

// cp_va_arg ::= cpEnd          // terminates argument list (not 0!)

//    |   cpOptional | cpKeywords | cpIgnore...         // manipulators

//    |   CpVaParseCmd cmd, const char *description,

//        [Optional Helpers], Results

//                              // Helpers and Results depend on 'cmd';

//                              // see table above

//    |   const char *keyword, CpVaParseCmd cmd, const char *description,

//        [Optional Helpers], Results

//                              // keyword argument, within cpKeywords or

//                              // cpMandatoryKeywords

//    |   const char *keyword, CpVaParseCmd cmd, const char *description,

//        bool *keyword_given, [Optional Helpers], Results

//                              // keyword argument, within cpConfirmKeywords

// Returns the number of result arguments set, or negative on error.

// Stores no values in the result arguments on error.


struct cp_value;

struct cp_argtype;


typedef void (*cp_parsefunc)(cp_value* value, const String& arg,

                             ErrorHandler* errh, const char* argdesc  CP_CONTEXT);

typedef void (*cp_storefunc)(cp_value* value  CP_CONTEXT);


struct cp_argtype {

    const char* name;

    cp_argtype* next;

    cp_parsefunc parse;

    cp_storefunc store;

    void* user_data;

    int flags;

    const char* description;

    int internal;

    int use_count;

};


struct cp_value {

    // set by cp_va_parse:

    const cp_argtype* argtype;

    const char* keyword;

    const char* description CLICK_CONFPARSE_DEPRECATED;

    union {

        int i;

        const char *c_str;

        void *p;

    } extra;

    void* store;

    void* store2;

    bool* store_confirm;

    // set by parsefunc, used by storefunc:

    union {

        bool b;

        int i;

        unsigned u;

        int16_t s16;

        uint16_t u16;

        int32_t s32;

        uint32_t u32;

#if HAVE_INT64_TYPES

        int64_t s64;

        int64_t i64 CLICK_DEPRECATED;

        uint64_t u64;

#endif

        size_t size;

#if HAVE_FLOAT_TYPES

        double d;

#endif

        unsigned char address[16];

        int is[4];

#ifndef CLICK_TOOL

        Element *element;

#endif

        void *p;

    } v, v2;

    String v_string;

    String v2_string;

};


enum {

    cpArgNormal = 0, cpArgStore2 = 1, cpArgExtraInt = 2,

    cpArgExtraCStr = 4, cpArgAllowNumbers = 8

};

int cp_register_argtype(const char* name, const char* description, int flags,

                        cp_parsefunc parsefunc, cp_storefunc storefunc,

                        void* user_data = 0);

void cp_unregister_argtype(const char* name);


int cp_register_stringlist_argtype(const char* name, const char* description,

                                   int flags);

int cp_extend_stringlist_argtype(const char* name, ...);

// Takes: const char* name, int value, ...., const char* ender = (const char*)0


bool cp_seconds_as(int want_power, const String& str, uint32_t* result) CLICK_DEPRECATED;


#define cp_integer64 cp_integer

#define cp_unsigned64 cp_integer

#define cp_unsigned cp_integer

#define cp_unsigned_real10 cp_real10

#define cp_unsigned_real2 cp_real2


inline String cp_unspacevec(const Vector<String>& conf)

{

    return cp_unspacevec(conf.begin(), conf.end());

}


inline bool cp_is_space(const String& str)

{

    return cp_skip_space(str.begin(), str.end()) == str.end();

}


inline const char *cp_integer(const char *begin, const char *end, int base, int *result)

{

    return cp_basic_integer(begin, end, base, -(int) sizeof(*result), result);

}


inline bool cp_integer(const String &str, int base, int *result)

{

    return cp_basic_integer(str.begin(), str.end(), base + cp_basic_integer_whole, -(int) sizeof(*result), result) != str.begin();

}


inline const char *cp_integer(const char *begin, const char *end, int base, unsigned *result)

{

    return cp_basic_integer(begin, end, base, (int) sizeof(*result), result);

}


inline const unsigned char *cp_integer(const unsigned char *begin, const unsigned char *end, int base, unsigned *result)

{

    return reinterpret_cast<const unsigned char *>(cp_integer(reinterpret_cast<const char *>(begin), reinterpret_cast<const char *>(end), base, result));

}


inline const char *cp_integer(const char *begin, const char *end, int base, long *result)

{

    return cp_basic_integer(begin, end, base, -(int) sizeof(*result), result);

}


inline const char *cp_integer(const char *begin, const char *end, int base, unsigned long *result)

{

    return cp_basic_integer(begin, end, base, (int) sizeof(*result), result);

}


inline const unsigned char *cp_integer(const unsigned char *begin, const unsigned char *end, int base, unsigned long *result)

{

    return reinterpret_cast<const unsigned char *>(cp_integer(reinterpret_cast<const char *>(begin), reinterpret_cast<const char *>(end), base, result));

}


#if HAVE_LONG_LONG


inline const char *cp_integer(const char *begin, const char *end, int base, long long *result)

{

    return cp_basic_integer(begin, end, base, -(int) sizeof(*result), result);

}


inline const char *cp_integer(const char *begin, const char *end, int base, unsigned long long *result)

{

    return cp_basic_integer(begin, end, base, (int) sizeof(*result), result);

}


inline const unsigned char *cp_integer(const unsigned char *begin, const unsigned char *end, int base, unsigned long long *result)

{

    return reinterpret_cast<const unsigned char *>(cp_integer(reinterpret_cast<const char *>(begin), reinterpret_cast<const char *>(end), base, result));

}


#elif HAVE_INT64_TYPES && !HAVE_INT64_IS_LONG


inline const char *cp_integer(const char *begin, const char *end, int base, int64_t *result)

{

    return cp_basic_integer(begin, end, base, -(int) sizeof(*result), result);

}


inline const char *cp_integer(const char *begin, const char *end, int base, uint64_t *result)

{

    return cp_basic_integer(begin, end, base, (int) sizeof(*result), result);

}


inline const unsigned char *cp_integer(const unsigned char *begin, const unsigned char *end, int base, uint64_t *result)

{

    return reinterpret_cast<const unsigned char *>(cp_integer(reinterpret_cast<const char *>(begin), reinterpret_cast<const char *>(end), base, result));

}


#endif


inline bool cp_integer(const String &str, int base, int *result);


inline bool cp_integer(const String &str, int base, unsigned int *result)

{

    return cp_basic_integer(str.begin(), str.end(), base + cp_basic_integer_whole, (int) sizeof(*result), result) != str.begin();

}


inline bool cp_integer(const String &str, int base, long *result)

{

    return cp_basic_integer(str.begin(), str.end(), base + cp_basic_integer_whole, -(int) sizeof(*result), result) != str.begin();

}


inline bool cp_integer(const String &str, int base, unsigned long *result)

{

    return cp_basic_integer(str.begin(), str.end(), base + cp_basic_integer_whole, (int) sizeof(*result), result) != str.begin();

}


#if HAVE_LONG_LONG


inline bool cp_integer(const String &str, int base, long long *result)

{

    return cp_basic_integer(str.begin(), str.end(), base + cp_basic_integer_whole, -(int) sizeof(*result), result) != str.begin();

}


inline bool cp_integer(const String &str, int base, unsigned long long *result)

{

    return cp_basic_integer(str.begin(), str.end(), base + cp_basic_integer_whole, (int) sizeof(*result), result) != str.begin();

}


#elif HAVE_INT64_TYPES && !HAVE_INT64_IS_LONG


inline bool cp_integer(const String &str, int base, int64_t *result)

{

    return cp_basic_integer(str.begin(), str.end(), base + cp_basic_integer_whole, -(int) sizeof(*result), result) != str.begin();

}


inline bool cp_integer(const String &str, int base, uint64_t *result)

{

    return cp_basic_integer(str.begin(), str.end(), base + cp_basic_integer_whole, (int) sizeof(*result), result) != str.begin();

}


#endif


inline bool cp_integer(const String &str, int *result)

{

    return cp_basic_integer(str.begin(), str.end(), cp_basic_integer_whole, -(int) sizeof(*result), result) != str.begin();

}


inline bool cp_integer(const String &str, unsigned int *result)

{

    return cp_basic_integer(str.begin(), str.end(), cp_basic_integer_whole, (int) sizeof(*result), result) != str.begin();

}


inline bool cp_integer(const String &str, long *result)

{

    return cp_basic_integer(str.begin(), str.end(), cp_basic_integer_whole, -(int) sizeof(*result), result) != str.begin();

}


inline bool cp_integer(const String &str, unsigned long *result)

{

    return cp_basic_integer(str.begin(), str.end(), cp_basic_integer_whole, (int) sizeof(*result), result) != str.begin();

}


#if HAVE_LONG_LONG


inline bool cp_integer(const String &str, long long *result)

{

    return cp_basic_integer(str.begin(), str.end(), cp_basic_integer_whole, -(int) sizeof(*result), result) != str.begin();

}


inline bool cp_integer(const String &str, unsigned long long *result)

{

    return cp_basic_integer(str.begin(), str.end(), cp_basic_integer_whole, (int) sizeof(*result), result) != str.begin();

}


#elif HAVE_INT64_TYPES && !HAVE_INT64_IS_LONG


inline bool cp_integer(const String &str, int64_t *result)

{

    return cp_basic_integer(str.begin(), str.end(), cp_basic_integer_whole, -(int) sizeof(*result), result) != str.begin();

}


inline bool cp_integer(const String &str, uint64_t *result)

{

    return cp_basic_integer(str.begin(), str.end(), cp_basic_integer_whole, (int) sizeof(*result), result) != str.begin();

}


#endif


inline bool cp_ip_address(const String& str, struct in_addr *ina  CP_CONTEXT)

{

    return cp_ip_address(str, reinterpret_cast<IPAddress *>(ina)  CP_PASS_CONTEXT);

}


#if HAVE_IP6

inline bool cp_ip6_address(const String& str, struct in6_addr *x  CP_CONTEXT)

{

    return cp_ip6_address(str, reinterpret_cast<IP6Address *>(x)  CP_PASS_CONTEXT);

}

#endif


inline bool cp_seconds_as(int want_power, const String &str, uint32_t *result)

{

    return cp_seconds_as(str, want_power, result);

}


#if !CLICK_TOOL

inline int cp_register_argtype(const char* name, const char* description, int flags,

                               void (*parsefunc)(cp_value *, const String &, ErrorHandler *, const char *, Element *),

                               void (*storefunc)(cp_value *, Element *),

                               void *user_data = 0) {

    return cp_register_argtype(name, description, flags,

                               (cp_parsefunc) parsefunc,

                               (cp_storefunc) storefunc,

                               user_data);

}

#endif


inline String cp_pop_spacevec(String &str) CLICK_DEPRECATED;


inline String cp_pop_spacevec(String &str) {

    return cp_shift_spacevec(str);

}


#undef CP_VA_ARGS_REST

#undef CP_OPT_CONTEXT

#undef CP_CONTEXT

#undef CP_PASS_CONTEXT

#undef CLICK_CONFPARSE_DEPRECATED

#undef CP_SENTINEL

#define cpEnd ((CpVaParseCmd) 0)

CLICK_ENDDECLS

#endif

Element
Base class for Click elements.
Definition element.hh:42

ErrorHandler
Error reporting class.
Definition error.hh:90

EtherAddress
An Ethernet address.
Definition etheraddress.hh:9

HandlerCall
Convenience class for calling handlers.
Definition handlercall.hh:143

Handler
Represents a router's handlers.
Definition handler.hh:19

IPAddress
An IPv4 address.
Definition ipaddress.hh:16

Router
A router configuration.
Definition router.hh:28

StringAccum
Efficiently build up Strings from pieces.
Definition straccum.hh:28

String
A string of characters.
Definition string.hh:22

String::end
const_iterator end() const
Return an iterator for the end of the string.
Definition string.hh:584

String::begin
const_iterator begin() const
Return an iterator for the first character in the string.
Definition string.hh:576

Timestamp
Represents a moment or interval in time.
Definition timestamp.hh:125

Vector
Vector template.
Definition vector.hh:111

Vector::end
iterator end()
Return an iterator for the end of the vector.
Definition vector.hh:266

Vector::begin
iterator begin()
Return an iterator for the first element in the vector.
Definition vector.hh:253

cpSecondsAsMilli
const CpVaParseCmd cpSecondsAsMilli
Result storage uint32_t*, parsed by cp_seconds_as_milli().
Definition confparse.hh:280

cp_va_kparse_remove_keywords
int cp_va_kparse_remove_keywords(Vector< String > &conf, const Element *context, ErrorHandler *errh,...) CP_SENTINEL
Parse and remove matching arguments from conf.
Definition confparse.cc:3913

cpReal10
const CpVaParseCmd cpReal10
Parse parameter int frac_digits, result storage int32_t*, parsed by cp_real10().
Definition confparse.hh:274

cpUnsigned
const CpVaParseCmd cpUnsigned
Result storage uint32_t*, parsed by cp_integer().
Definition confparse.hh:266

cp_double
bool cp_double(const String &str, double *result)
Parse a real number from str.
Definition confparse.cc:1336

cp_time
bool cp_time(const String &str, Timestamp *result, bool allow_negative=false)
Parse a timestamp from str.
Definition confparse.cc:1526

cp_va_static_initialize
void cp_va_static_initialize()
Initialize the cp_va_kparse() implementation.
Definition confparse.cc:4189

cp_spacevec
void cp_spacevec(const String &str, Vector< String > &conf)
Separate a configuration string into arguments at unquoted spaces.
Definition confparse.cc:768

cp_tcpudp_port
bool cp_tcpudp_port(const String &str, int proto, uint16_t *result, const Element *context=0)
Parse a TCP, UDP, etc. port number from str.
Definition confparse.cc:1939

cp_unargvec
String cp_unargvec(const Vector< String > &conf)
Join the strings of conf with commas and return the result.
Definition confparse.cc:815

cp_is_space
bool cp_is_space(const String &str)
Test if str is all spaces.
Definition confparse.hh:466

cp_seconds_as_micro
bool cp_seconds_as_micro(const String &str, uint32_t *result)
Parse an amount of time in microseconds from str.
Definition confparse.cc:1480

cpUnsignedShort
const CpVaParseCmd cpUnsignedShort
Result storage unsigned short*, parsed by cp_integer().
Definition confparse.hh:264

cpIP6Prefix
const CpVaParseCmd cpIP6Prefix
Result storage IP6Address* addr and IP6Address* mask, parsed by cp_ip6_prefix().
Definition confparse.hh:302

cp_keyword
bool cp_keyword(const String &str, String *result, String *rest=0)
Parse a keyword from str.
Definition confparse.cc:966

cpIPPrefix
const CpVaParseCmd cpIPPrefix
Result storage IPAddress* addr and IPAddress *mask, parsed by cp_ip_prefix().
Definition confparse.hh:287

cpWord
const CpVaParseCmd cpWord
Result storage String*, parsed by cp_word().
Definition confparse.hh:259

cp_va_static_cleanup
void cp_va_static_cleanup()
Clean up the cp_va_kparse() implementation.
Definition confparse.cc:4282

cpHandlerCallWrite
const CpVaParseCmd cpHandlerCallWrite
Result storage HandlerCall*, parsed by HandlerCall.
Definition confparse.hh:298

cpIP6Address
const CpVaParseCmd cpIP6Address
Result storage IP6Address* or equivalent, parsed by cp_ip6_address().
Definition confparse.hh:301

cpEnd
const CpVaParseCmd cpEnd
Use as argument name. Ends cp_va argument list.
Definition confparse.cc:2197

cp_handler
bool cp_handler(const String &str, int flags, Element **result_element, const Handler **result_handler, const Element *context, ErrorHandler *errh=0)
Parse a handler reference from str.
Definition confparse.cc:2108

cp_string
bool cp_string(const String &str, String *result, String *rest=0)
Parse a string from str.
Definition confparse.cc:868

cp_real10
bool cp_real10(const String &str, int frac_digits, int32_t *result)
Parse a real number from str, representing the result as an integer with frac_digits decimal digits o...
Definition confparse.cc:1232

cpSize
const CpVaParseCmd cpSize
Result storage size_t*, parsed by cp_integer().
Definition confparse.hh:267

cpConfirmKeywords
const CpVaParseCmd cpConfirmKeywords
cp_va_parse only: Following arguments are confirmed keywords.
Definition confparse.hh:314

cp_seconds_as
bool cp_seconds_as(const String &str, int frac_digits, uint32_t *result)
Parse an amount of time from str.
Definition confparse.cc:1447

cp_ip6_address
bool cp_ip6_address(const String &str, IP6Address *result, const Element *context=0)
Parse an IPv6 address from str.
Definition confparse.cc:1803

cpNamedInteger
const CpVaParseCmd cpNamedInteger
Parse parameter uint32_t nameinfo_type, result storage int32_t*, parsed by NameInfo::query_int.
Definition confparse.hh:268

cpIP6PrefixLen
const CpVaParseCmd cpIP6PrefixLen
Result storage IP6Address* addr and int* prefix_len, parsed by cp_ip6_prefix().
Definition confparse.hh:303

cp_va_parse_remove_keywords
int cp_va_parse_remove_keywords(Vector< String > &conf, int first, const Element *context, ErrorHandler *errh,...)
Legacy function for parsing and removing matching arguments from conf.
Definition confparse.cc:3718

cpArgument
const CpVaParseCmd cpArgument
Result storage String*, accepts any argument.
Definition confparse.hh:256

cpTCPPort
const CpVaParseCmd cpTCPPort
Result storage uint16_t*, parsed by cp_tcpudp_port().
Definition confparse.hh:292

cpIgnoreRest
const CpVaParseCmd cpIgnoreRest
Use as argument name. No result storage; causes cp_va_kparse() to ignore unparsed arguments and any r...
Definition confparse.hh:254

cp_va_space_parse
int cp_va_space_parse(const String &str, const Element *context, ErrorHandler *errh,...)
Legacy function for parsing a space-separated argument string.
Definition confparse.cc:3657

cp_skip_comment_space
const char * cp_skip_comment_space(const char *begin, const char *end)
Find the first nonspace, noncomment character in the string [begin, end).
Definition confparse.cc:361

cpFilename
const CpVaParseCmd cpFilename
Result storage String*, parsed by cp_filename().
Definition confparse.hh:306

cp_real2
bool cp_real2(const String &str, int frac_bits, int32_t *result)
Parse a fixed-point number from str.
Definition confparse.cc:1304

cpUnsignedReal2
const CpVaParseCmd cpUnsignedReal2
Parse parameter int frac_bits, result storage uint32_t*, parsed by cp_real2().
Definition confparse.hh:273

CpKparseFlags
CpKparseFlags
Type of flags for cp_va_kparse() items.
Definition confparse.hh:236

cpkP
@ cpkP
Argument may be specified positionally.
Definition confparse.hh:239

cpkN
@ cpkN
Default flags.
Definition confparse.hh:237

cpkD
@ cpkD
Argument is deprecated.
Definition confparse.hh:241

cpkC
@ cpkC
Argument presence should be confirmed.
Definition confparse.hh:240

cpkM
@ cpkM
Argument is mandatory.
Definition confparse.hh:238

cpSecondsAsMicro
const CpVaParseCmd cpSecondsAsMicro
Result storage uint32_t*, parsed by cp_seconds_as_micro().
Definition confparse.hh:281

cp_unquote
String cp_unquote(const String &str)
Remove one level of quoting from str, returning the result.
Definition confparse.cc:571

cpBool
const CpVaParseCmd cpBool
Result storage bool*, parsed by cp_bool().
Definition confparse.hh:261

cp_ethernet_address
bool cp_ethernet_address(const String &str, EtherAddress *result, const Element *context=0)
Parse an Ethernet address from str.
Definition confparse.cc:1914

cp_integer
const char * cp_integer(const char *begin, const char *end, int base, int *result)
Parse an integer from [begin, end) in base base.
Definition confparse.hh:513

cp_anno
bool cp_anno(const String &str, int size, int *result, const Element *context=0)
Parse a packet annotation value from str.
Definition confparse.cc:2181

cpString
const CpVaParseCmd cpString
Result storage String*, parsed by cp_string().
Definition confparse.hh:258

cpKeyword
const CpVaParseCmd cpKeyword
Result storage String*, parsed by cp_keyword().
Definition confparse.hh:260

cp_bool
bool cp_bool(const String &str, bool *result)
Parse a boolean from str.
Definition confparse.cc:1034

cpByte
const CpVaParseCmd cpByte
Result storage unsigned char*, parsed by cp_integer().
Definition confparse.hh:262

cp_va_space_kparse
int cp_va_space_kparse(const String &str, const Element *context, ErrorHandler *errh,...) CP_SENTINEL
Parse a space-separated argument string.
Definition confparse.cc:3841

cp_ip_address_list
bool cp_ip_address_list(const String &str, Vector< IPAddress > *result, const Element *context=0)
Parse a space-separated list of IP addresses from str.
Definition confparse.cc:1741

cpEthernetAddress
const CpVaParseCmd cpEthernetAddress
Result storage EtherAddress*, parsed by cp_ethernet_address(). Synonym for cpEtherAddress.
Definition confparse.hh:291

cpShort
const CpVaParseCmd cpShort
Result storage short*, parsed by cp_integer().
Definition confparse.hh:263

cp_filename
bool cp_filename(const String &str, String *result)
Parse a filename string from str.
Definition confparse.cc:2145

cp_va_kparse_keyword
int cp_va_kparse_keyword(const String &str, const Element *context, ErrorHandler *errh,...) CP_SENTINEL
Parse a single argument.
Definition confparse.cc:3873

cpUDPPort
const CpVaParseCmd cpUDPPort
Result storage uint16_t*, parsed by cp_tcpudp_port().
Definition confparse.hh:293

cp_va_kparse
int cp_va_kparse(const Vector< String > &conf, const Element *context, ErrorHandler *errh,...) CP_SENTINEL
Parse a list of arguments.
Definition confparse.cc:3779

cpInteger64
const CpVaParseCmd cpInteger64
Result storage int64_t*, parsed by cp_integer().
Definition confparse.hh:270

cpIgnore
const CpVaParseCmd cpIgnore
No result storage, ignores this argument.
Definition confparse.hh:255

cp_uncomment
String cp_uncomment(const String &str)
Simplify str's whitespace and replace comments by spaces, returning the result.
Definition confparse.cc:442

cp_is_click_id
bool cp_is_click_id(const String &str)
Test if str is a valid Click identifier.
Definition confparse.cc:257

cp_unspacevec
String cp_unspacevec(const String *begin, const String *end)
Join the strings in [begin, end) with spaces and return the result.
Definition confparse.cc:838

cp_bandwidth
bool cp_bandwidth(const String &str, uint64_t *result)
Parse a bandwidth value from str.
Definition confparse.cc:1592

cpUnsignedReal10
const CpVaParseCmd cpUnsignedReal10
Parse parameter int frac_digits, result storage uint32_t*, parsed by cp_real10().
Definition confparse.hh:275

cp_ip_address
bool cp_ip_address(const String &str, IPAddress *result, const Element *context=0)
Parse an IP address from str.
Definition confparse.cc:1654

cp_shift_spacevec
String cp_shift_spacevec(String &str)
Remove and return the first space-separated argument from str.
Definition confparse.cc:785

cpMandatoryKeywords
const CpVaParseCmd cpMandatoryKeywords
cp_va_parse only: Following arguments are mandatory keywords.
Definition confparse.hh:315

CpVaParseCmd
const char * CpVaParseCmd
Type of argument type names for cp_va_kparse() items.
Definition confparse.hh:250

cpBandwidth
const CpVaParseCmd cpBandwidth
Result storage uint32_t*, parsed by cp_bandwidth().
Definition confparse.hh:285

cp_word
bool cp_word(const String &str, String *result, String *rest=0)
Parse a word from str.
Definition confparse.cc:935

cp_process_backslash
const char * cp_process_backslash(const char *begin, const char *end, StringAccum &sa)
Process a backslash escape, appending results to sa.
Definition confparse.cc:477

cpHandlerName
const CpVaParseCmd cpHandlerName
Result storage Element** and String*, parsed by cp_handler_name().
Definition confparse.hh:296

cp_eat_space
bool cp_eat_space(String &str)
Remove spaces from the beginning of str.
Definition confparse.cc:227

cpIPAddressList
const CpVaParseCmd cpIPAddressList
Result storage Vector<IPAddress>*, parsed by cp_ip_address_list().
Definition confparse.hh:289

cpOptional
const CpVaParseCmd cpOptional
cp_va_parse only: Following arguments are optional.
Definition confparse.hh:312

cp_quote
String cp_quote(const String &str, bool allow_newlines=false)
Return a quoted version of str.
Definition confparse.cc:629

cpAnno
const CpVaParseCmd cpAnno
Parse parameter int annotation_size, result storage int*, parsed by cp_anno().
Definition confparse.hh:310

cpTimeval
const CpVaParseCmd cpTimeval
Result storage struct timeval*, parsed by cp_time().
Definition confparse.hh:284

cp_file_offset
bool cp_file_offset(const String &str, off_t *result)
Parse a file offset from str.
Definition confparse.cc:1101

cp_ip_prefix
bool cp_ip_prefix(const String &str, IPAddress *result_addr, IPAddress *result_mask, bool allow_bare_address, const Element *context=0)
Parse an IP address or prefix from str.
Definition confparse.cc:1703

cpEtherAddress
const CpVaParseCmd cpEtherAddress
Result storage EtherAddress*, parsed by cp_ethernet_address().
Definition confparse.hh:290

cp_is_word
bool cp_is_word(const String &str)
Test whether str is a valid "word".
Definition confparse.cc:241

cpKeywords
const CpVaParseCmd cpKeywords
cp_va_parse only: Following arguments are keywords.
Definition confparse.hh:313

cp_assign_arguments
int cp_assign_arguments(const Vector< String > &argv, const String *param_begin, const String *param_end, Vector< String > *values=0)
Assign arguments from argv to values.
Definition confparse.cc:3973

cp_seconds
bool cp_seconds(const String &str, double *result)
Parse an amount of time from str.
Definition confparse.cc:1499

cpHandlerCallPtrRead
const CpVaParseCmd cpHandlerCallPtrRead
Result storage HandlerCall**, parsed by HandlerCall::reset_read.
Definition confparse.hh:299

cp_handler_name
bool cp_handler_name(const String &str, Element **result_element, String *result_hname, const Element *context, ErrorHandler *errh=0)
Parse a handler name from str.
Definition confparse.cc:2044

cpSeconds
const CpVaParseCmd cpSeconds
Result storage uint32_t*, parsed by cp_seconds_as() with frac_digits 0.
Definition confparse.hh:279

cp_argvec
void cp_argvec(const String &str, Vector< String > &conf)
Separate a configuration string into arguments at commas.
Definition confparse.cc:697

cpIPAddress
const CpVaParseCmd cpIPAddress
Result storage IPAddress* or equivalent, parsed by cp_ip_address().
Definition confparse.hh:286

cp_element
Element * cp_element(const String &str, const Element *context, ErrorHandler *errh=0, const char *argname=0)
Parse an element reference from str.
Definition confparse.cc:1972

cp_skip_double_quote
const char * cp_skip_double_quote(const char *begin, const char *end)
Return the first character after a double-quoted string starting at begin.
Definition confparse.cc:320

cpFileOffset
const CpVaParseCmd cpFileOffset
Result storage off_t*, parsed by cp_integer().
Definition confparse.hh:307

cp_shift_delimiter
String cp_shift_delimiter(String &str, char delim)
Remove and return the first delimiter-separated argument from str.
Definition confparse.cc:796

cp_skip_space
const char * cp_skip_space(const char *begin, const char *end)
Find the first nonspace character in the string [begin, end).
Definition confparse.cc:216

cpDouble
const CpVaParseCmd cpDouble
Result storage double*, parsed by cp_double().
Definition confparse.hh:277

cpArguments
const CpVaParseCmd cpArguments
Result storage Vector<String>*, accepts any number of arguments with the same keyword.
Definition confparse.hh:257

cpElementCast
const CpVaParseCmd cpElementCast
Parse parameter const char*, result storage void**, parsed by cp_element() and Element::cast().
Definition confparse.hh:295

cpTimestamp
const CpVaParseCmd cpTimestamp
Result storage Timestamp*, parsed by cp_time().
Definition confparse.hh:282

cp_va_parse
int cp_va_parse(const Vector< String > &conf, const Element *context, ErrorHandler *errh,...)
Legacy function for parsing a list of arguments.
Definition confparse.cc:3601

cp_va_parse_keyword
int cp_va_parse_keyword(const String &str, const Element *context, ErrorHandler *errh,...)
Legacy function for parsing a single argument.
Definition confparse.cc:3686

cpHandlerCallPtrWrite
const CpVaParseCmd cpHandlerCallPtrWrite
Result storage HandlerCall**, parsed by HandlerCall::reset_write.
Definition confparse.hh:300

cpElement
const CpVaParseCmd cpElement
Result storage Element**, parsed by cp_element().
Definition confparse.hh:294

cpIP6AddressOrPrefix
const CpVaParseCmd cpIP6AddressOrPrefix
Result storage IP6Address* addr and IP6Address* mask, parsed by cp_ip6_prefix().
Definition confparse.hh:304

cpHandlerCallRead
const CpVaParseCmd cpHandlerCallRead
Result storage HandlerCall*, parsed by HandlerCall.
Definition confparse.hh:297

cpInteger
const CpVaParseCmd cpInteger
Result storage int32_t*, parsed by cp_integer().
Definition confparse.hh:265

cp_seconds_as_milli
bool cp_seconds_as_milli(const String &str, uint32_t *result)
Parse an amount of time in milliseconds from str.
Definition confparse.cc:1467

cpUnsigned64
const CpVaParseCmd cpUnsigned64
Result storage uint64_t*, parsed by cp_integer().
Definition confparse.hh:271

cp_ip6_prefix
bool cp_ip6_prefix(const String &str, IP6Address *result_addr, int *result_prefix, bool allow_bare_address, const Element *context=0)
Parse an IPv6 address or prefix from str.
Definition confparse.cc:1869

cpIPAddressOrPrefix
const CpVaParseCmd cpIPAddressOrPrefix
Result storage IPAddress* addr and IPAddress *mask, parsed by cp_ip_prefix().
Definition confparse.hh:288

cpTimestampSigned
const CpVaParseCmd cpTimestampSigned
Result storage Timestamp*, parsed by cp_time().
Definition confparse.hh:283

string.hh
Click's String class.

vector.hh
Click's vector container template.