lcn_term.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_term.h
 * @brief Routines for handling lucene terms
 */

#ifndef _LCN_TERM_H
#define _LCN_TERM_H

#include "lcn_types.h"

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

/** A lucene term. */
typedef struct {
  lcn_char_t *contents;  /**< The actual contents of the term */
  lcn_char_t *field;     /**< The field the term is found in */
} lcn_term_t;

/** Create a new term with contents @a contents and field @a field, allocated
 * in @a pool.
 */
lcn_term_t *
lcn_term_create (const lcn_char_t *contents,
                 const lcn_char_t *field,
                 apr_pool_t *pool);

/** Like @c lcn_term_create, but with cstring arguments. */
lcn_term_t *
lcn_term_create_cstring (const char *contents,
                         const char *field,
                         apr_pool_t *pool);

/** Compare terms @a one and @a two, returning an integer less than, equal to,
 * or greater than if @a one is less than, equal to, or greater than @a two.
 */
int lcn_term_compare (const lcn_term_t *one, const lcn_term_t *two);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _LCN_TERM_H */

---