lcn_terminfos.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_terminfos.h
 * @brief Routines for manipulating the terminfos file from a lucene segment
 */

#ifndef _LCN_TERMINFOS_H
#define _LCN_TERMINFOS_H

#include "lcn_types.h"
#include "lcn_directory.h"
#include "lcn_term.h"

#include <apr_hash.h>
#include <apr_file_io.h>

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

/** Opaque structure representing the information about a particular term. */
typedef struct lcn_terminfo_t lcn_terminfo_t;

/** Opaque structure representing the contents of the terminfos index. */
typedef struct lcn_terminfos_idx_t lcn_terminfos_idx_t;

/** Opaque structure representing a segments terminfos file. */
typedef struct lcn_terminfos_t lcn_terminfos_t;

/** Return the term @a ti corresponds to. */
const lcn_term_t *lcn_terminfo_term (const lcn_terminfo_t *ti);

/** Return the field number @a ti corresponds to. */
apr_uint32_t lcn_terminfo_field_num (const lcn_terminfo_t *ti);

/** Return the document frequency for terminfo @a ti. */
apr_uint32_t lcn_terminfo_doc_freq (const lcn_terminfo_t *ti);

/** Return the proximity position for terminfo @a ti. */
apr_uint64_t lcn_terminfo_prox_position (const lcn_terminfo_t *ti);

/** Return the frequency position for terminfo @a ti. */
apr_uint64_t lcn_terminfo_freq_position (const lcn_terminfo_t *ti);

/** Return the skip offset for terminfo @a ti. */
apr_uint32_t lcn_terminfo_skip_offset (const lcn_terminfo_t *ti);

/** Return a copy of terminfo @a ti, allocated in @a pool. */
lcn_terminfo_t *
lcn_terminfo_copy (const lcn_terminfo_t *ti, apr_pool_t *pool);

/** Read the terminfos index for @a segment in directory @a directory and
 * return it in @a tisidx, allocated in @a pool.
 */
lcn_error_t *
lcn_terminfos_idx_read (lcn_terminfos_idx_t **tisidx,
                        const lcn_directory_t *directory,
                        const lcn_char_t *segment,
                        apr_pool_t *pool);

/** Return the count of the terminfos in @a tisidx. */
apr_uint64_t
lcn_terminfos_idx_get_count (const lcn_terminfos_idx_t *tisidx);

/** Return the terminfo @a ti at @a position in @a tisidx. */
lcn_error_t *
lcn_terminfos_idx_get_terminfo (lcn_terminfo_t **ti,
                                const lcn_terminfos_idx_t *tisidx,
                                apr_uint64_t position);

/** Open the terminfos file for @a segment in @a directory, return it in
 * @a tis, allocated in @a pool.
 */
lcn_error_t *
lcn_terminfos_open (lcn_terminfos_t **tis,
                    const lcn_directory_t *directory,
                    const lcn_char_t *segment,
                    apr_pool_t *pool);

/** Return the terminfo @a ti from @a tis that corresponds to @a term, 
 * allocated in @a pool.
 */
lcn_error_t *
lcn_terminfos_get_terminfo (lcn_terminfo_t **ti,
                            const lcn_terminfos_t *tis,
                            const lcn_term_t *term,
                            apr_pool_t *pool);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif

---