lcn_query_parser.h

Go to the documentation of this file.

/* Copyright 2005 The Apache Software Foundation or its licensors, as
 * applicable.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file lcn_query_parser.h
 * @brief Routines for creating queries from a user provided string
 */

#ifndef _LCN_QUERY_PARSER_H
#define _LCN_QUERY_PARSER_H

#include "lcn_types.h"
#include "lcn_query.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** A query parser. */
typedef struct lcn_query_parser_t lcn_query_parser_t;

/** Create a query parser @a parser, which uses @a default_field and
 * @a default_occur and is allocated from @a pool. */
lcn_error_t *
lcn_query_parser_create (lcn_query_parser_t **parser,
                         lcn_char_t *default_field,
                         lcn_boolean_clause_occur_t default_occur,
                         apr_pool_t *pool);

/** Use @a parser to create @a query from @a input, allocated in @a pool. */
lcn_error_t *
lcn_query_parser_parse (lcn_query_t **query,
                        lcn_query_parser_t *parser,
                        lcn_char_t *input,
                        apr_pool_t *pool);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _LCN_QUERY_PARSER_H */

---