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.
106 lines
4.4 KiB
106 lines
4.4 KiB
/* =========================================================================
|
|
ztrie - simple trie for tokenizable strings
|
|
|
|
Copyright (c) 1991-2012 iMatix Corporation -- http://www.imatix.com
|
|
Copyright other contributors as noted in the AUTHORS file.
|
|
|
|
This file is part of CZMQ, the high-level C binding for 0MQ: http://czmq.zeromq.org
|
|
|
|
This Source Code Form is subject to the terms of the Mozilla Public
|
|
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
=========================================================================
|
|
*/
|
|
|
|
#ifndef ZTRIE_H_INCLUDED
|
|
#define ZTRIE_H_INCLUDED
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
// @warning THE FOLLOWING @INTERFACE BLOCK IS AUTO-GENERATED BY ZPROJECT
|
|
// @warning Please edit the model at "api/ztrie.api" to make changes.
|
|
// @interface
|
|
// This is a draft class, and may change without notice. It is disabled in
|
|
// stable builds by default. If you use this in applications, please ask
|
|
// for it to be pushed to stable state. Use --enable-drafts to enable.
|
|
#ifdef CZMQ_BUILD_DRAFT_API
|
|
// Callback function for ztrie_node to destroy node data.
|
|
typedef void (ztrie_destroy_data_fn) (
|
|
void **data);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Creates a new ztrie.
|
|
CZMQ_EXPORT ztrie_t *
|
|
ztrie_new (char delimiter);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Destroy the ztrie.
|
|
CZMQ_EXPORT void
|
|
ztrie_destroy (ztrie_t **self_p);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Inserts a new route into the tree and attaches the data. Returns -1
|
|
// if the route already exists, otherwise 0. This method takes ownership of
|
|
// the provided data if a destroy_data_fn is provided.
|
|
CZMQ_EXPORT int
|
|
ztrie_insert_route (ztrie_t *self, const char *path, void *data, ztrie_destroy_data_fn destroy_data_fn);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Removes a route from the trie and destroys its data. Returns -1 if the
|
|
// route does not exists, otherwise 0.
|
|
// the start of the list call zlist_first (). Advances the cursor.
|
|
CZMQ_EXPORT int
|
|
ztrie_remove_route (ztrie_t *self, const char *path);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Returns true if the path matches a route in the tree, otherwise false.
|
|
CZMQ_EXPORT bool
|
|
ztrie_matches (ztrie_t *self, const char *path);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Returns the data of a matched route from last ztrie_matches. If the path
|
|
// did not match, returns NULL. Do not delete the data as it's owned by
|
|
// ztrie.
|
|
CZMQ_EXPORT void *
|
|
ztrie_hit_data (ztrie_t *self);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Returns the count of parameters that a matched route has.
|
|
CZMQ_EXPORT size_t
|
|
ztrie_hit_parameter_count (ztrie_t *self);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Returns the parameters of a matched route with named regexes from last
|
|
// ztrie_matches. If the path did not match or the route did not contain any
|
|
// named regexes, returns NULL.
|
|
CZMQ_EXPORT zhashx_t *
|
|
ztrie_hit_parameters (ztrie_t *self);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Returns the asterisk matched part of a route, if there has been no match
|
|
// or no asterisk match, returns NULL.
|
|
CZMQ_EXPORT const char *
|
|
ztrie_hit_asterisk_match (ztrie_t *self);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Print the trie
|
|
CZMQ_EXPORT void
|
|
ztrie_print (ztrie_t *self);
|
|
|
|
// *** Draft method, for development use, may change without warning ***
|
|
// Self test of this class.
|
|
CZMQ_EXPORT void
|
|
ztrie_test (bool verbose);
|
|
|
|
#endif // CZMQ_BUILD_DRAFT_API
|
|
// @end
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|