Author: rooneg
Date: Sat Feb 26 08:47:57 2005
New Revision: 155552
URL: http://svn.apache.org/viewcvs?view=rev&rev=155552
Log:
Initial import of the Lucene4c project.
Added:
incubator/lucene4c/branches/
incubator/lucene4c/tags/
incubator/lucene4c/trunk/ (with props)
incubator/lucene4c/trunk/CHANGES
incubator/lucene4c/trunk/HACKING
incubator/lucene4c/trunk/Makefile.am
incubator/lucene4c/trunk/README
incubator/lucene4c/trunk/TODO
incubator/lucene4c/trunk/bootstrap (with props)
incubator/lucene4c/trunk/config/ (with props)
incubator/lucene4c/trunk/config/find_apr.m4
incubator/lucene4c/trunk/configure.in
incubator/lucene4c/trunk/doc/
incubator/lucene4c/trunk/doc/doxygen.conf
incubator/lucene4c/trunk/include/
incubator/lucene4c/trunk/include/lcn_api.h
incubator/lucene4c/trunk/include/lcn_directory.h
incubator/lucene4c/trunk/include/lcn_document.h
incubator/lucene4c/trunk/include/lcn_field.h
incubator/lucene4c/trunk/include/lcn_fielddata.h
incubator/lucene4c/trunk/include/lcn_fieldinfos.h
incubator/lucene4c/trunk/include/lcn_frequencies.h
incubator/lucene4c/trunk/include/lcn_index.h
incubator/lucene4c/trunk/include/lcn_istream.h
incubator/lucene4c/trunk/include/lcn_query.h
incubator/lucene4c/trunk/include/lcn_scorer.h
incubator/lucene4c/trunk/include/lcn_segment.h
incubator/lucene4c/trunk/include/lcn_segments.h
incubator/lucene4c/trunk/include/lcn_term.h
incubator/lucene4c/trunk/include/lcn_terminfos.h
incubator/lucene4c/trunk/include/lcn_types.h
incubator/lucene4c/trunk/src/
incubator/lucene4c/trunk/src/cmdline/ (with props)
incubator/lucene4c/trunk/src/cmdline/main.c
incubator/lucene4c/trunk/src/document/ (with props)
incubator/lucene4c/trunk/src/document/document.c
incubator/lucene4c/trunk/src/document/field.c
incubator/lucene4c/trunk/src/index/ (with props)
incubator/lucene4c/trunk/src/index/fielddata.c
incubator/lucene4c/trunk/src/index/fieldinfos.c
incubator/lucene4c/trunk/src/index/frequencies.c
incubator/lucene4c/trunk/src/index/index.c
incubator/lucene4c/trunk/src/index/segment.c
incubator/lucene4c/trunk/src/index/segments.c
incubator/lucene4c/trunk/src/index/term.c
incubator/lucene4c/trunk/src/index/terminfos.c
incubator/lucene4c/trunk/src/search/ (with props)
incubator/lucene4c/trunk/src/search/query.c
incubator/lucene4c/trunk/src/search/scorer.c
incubator/lucene4c/trunk/src/store/ (with props)
incubator/lucene4c/trunk/src/store/directory.c
incubator/lucene4c/trunk/src/store/istream.c
incubator/lucene4c/trunk/src/util/ (with props)
incubator/lucene4c/trunk/src/util/error.c
incubator/lucene4c/trunk/src/util/pools.c
incubator/lucene4c/trunk/src/util/string.c
incubator/lucene4c/trunk/test/ (with props)
incubator/lucene4c/trunk/test/abts.c
incubator/lucene4c/trunk/test/abts.h
incubator/lucene4c/trunk/test/abts_tests.h
incubator/lucene4c/trunk/test/data/
incubator/lucene4c/trunk/test/data/index/
incubator/lucene4c/trunk/test/data/index-cfs/
incubator/lucene4c/trunk/test/data/index-cfs/_1or.cfs (with props)
incubator/lucene4c/trunk/test/data/index-cfs/deletable (with props)
incubator/lucene4c/trunk/test/data/index-cfs/segments (with props)
incubator/lucene4c/trunk/test/data/index/_c7.f1
incubator/lucene4c/trunk/test/data/index/_c7.f2
incubator/lucene4c/trunk/test/data/index/_c7.f3
incubator/lucene4c/trunk/test/data/index/_c7.fdt (with props)
incubator/lucene4c/trunk/test/data/index/_c7.fdx (with props)
incubator/lucene4c/trunk/test/data/index/_c7.fnm (with props)
incubator/lucene4c/trunk/test/data/index/_c7.frq
incubator/lucene4c/trunk/test/data/index/_c7.prx
incubator/lucene4c/trunk/test/data/index/_c7.tii (with props)
incubator/lucene4c/trunk/test/data/index/_c7.tis (with props)
incubator/lucene4c/trunk/test/data/index/deletable (with props)
incubator/lucene4c/trunk/test/data/index/segments (with props)
incubator/lucene4c/trunk/test/index/ (with props)
incubator/lucene4c/trunk/test/index/fielddata_test.c
incubator/lucene4c/trunk/test/index/fieldinfos_test.c
incubator/lucene4c/trunk/test/index/frequencies_test.c
incubator/lucene4c/trunk/test/index/index_test.c
incubator/lucene4c/trunk/test/index/segment_test.c
incubator/lucene4c/trunk/test/index/segments_test.c
incubator/lucene4c/trunk/test/index/terminfos_test.c
incubator/lucene4c/trunk/test/lcn_tests.c
incubator/lucene4c/trunk/test/lcn_tests.h
incubator/lucene4c/trunk/test/search/ (with props)
incubator/lucene4c/trunk/test/search/scorer_test.c
incubator/lucene4c/trunk/test/store/ (with props)
incubator/lucene4c/trunk/test/store/directory_test.c
incubator/lucene4c/trunk/test/store/istream_test.c
incubator/lucene4c/trunk/test/util/ (with props)
incubator/lucene4c/trunk/test/util/string_test.c
incubator/lucene4c/trunk/www/
incubator/lucene4c/trunk/www/index.xhtml
Propchange: incubator/lucene4c/trunk/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Sat Feb 26 08:47:57 2005
@@ -0,0 +1,10 @@
+.gdb_history
+Makefile.in
+Makefile
+aclocal.m4
+autom4te.cache
+config.log
+config.status
+configure
+.deps
+liblucene4c.a
Added: incubator/lucene4c/trunk/CHANGES
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/CHANGES?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/CHANGES (added)
+++ incubator/lucene4c/trunk/CHANGES Sat Feb 26 08:47:57 2005
@@ -0,0 +1,51 @@
+[ Changes for 0.04 - XXX ]
+
+* Add a duplicate function for istreams, currently only implemented for file
+ based streams.
+
+* Added initial cuts at query and scorer infrastructure.
+
+[ Changes for 0.03 - Mon, 21 Feb 2005 ]
+
+* Added support for running various operations over an entire index instead
+ of just a single segment at a time.
+
+* Added interface for iterating over all documents that contain a term.
+
+* Added lcn_document_t object to represent a document.
+
+* Added HACKING document, which contains documentation useful to a programmer
+ trying to get up to speed on lucene4c development.
+
+* Added lcn_error_createf interface and used it to improve many error
+ messages.
+
+* Improved algorithm for finding a specific term's terminfo.
+
+* Fixed compound file istreams so they work in more complex use cases than
+ I had previously tested. This lets searching over cfs segments actually
+ work.
+
+* Added doxygen documentation for public header files.
+
+[ Changes for 0.02 - Sun, 13 Feb 2005 ]
+
+* Added support for compound file stream directories.
+
+* Implemented lcn_directory abstraction, converted all public APIs to use it
+ instead of directly accessing the filesystem.
+
+* Fixed build error on gcc 2.95.x.
+
+[ Changes for 0.01 - Sun, 26 Dec 2004 ]
+
+* Initial public release.
+
+* Raw API to read Lucene 1.4.x non-compound segments is working.
+
+* Command line client to dump data about an index. Not really useful yet.
+
+* No analysis support, no indexing support, primative searching support.
+
+* Index level API is missing, so you have to either manually merge results
+ from different segments or use a totally optimized index.
Added: incubator/lucene4c/trunk/HACKING
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/HACKING?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/HACKING (added)
+++ incubator/lucene4c/trunk/HACKING Sat Feb 26 08:47:57 2005
@@ -0,0 +1,106 @@
+If you plan on contributing code to the Lucene4c project, this should be
+the first thing you read. If anything in this file is unclear, please ask
+about it on the project mailing list (XXX fill in list address here).
+
+TABLE OF CONTENTS
+
+ * Directory layout
+ * Coding style
+ * Naming conventions
+ * API documentation
+
+Directory layout
+================
+
+The top level of the source tree contains the following subdirectories:
+
+ config/ holds random autoconf cruft, so as much of it as possible
+ stays out of the way as possible.
+
+ include/ holds public header files.
+
+ src/ holds source code, broken out into subdirectories based on
+ general category, like 'index' for code related to reading
+ or writing an index, 'store' based on lower level code for
+ reading or writing data on disk, 'util' for random utility
+ code, and 'cmdline' for a command line interface.
+
+ test/ holds code for the test suite, broken up into the same kind
+ of subdirectories as the main lucene4c code.
+
+ www/ holds the project web pages.
+
+ doc/ holds files related to the project's documentation.
+
+Coding style
+============
+
+The project uses a style that basically boils down to the GNU coding style
+guidelines. Here's an example:
+
+char *
+function (char *arg, int otherarg)
+{
+ if ((some_condition && otherarg)
+ || another_condition)
+ {
+ arg = some_function (arg, otherarg);
+ }
+ else
+ {
+ do
+ {
+ arg = other_func (arg);
+ }
+ while (something);
+ }
+
+ switch (otherarg)
+ {
+ case 1:
+ yet_another_function (arg);
+ break;
+
+ default:
+ break;
+ }
+
+ return NULL;
+}
+
+If code does not conform to these guidelines then either comply with the
+local style if it's consistent about it or make it conform to the guidelines
+in a separate commit if it does not.
+
+Naming conventions
+==================
+
+Lucene4c is implemented in C. Duh. This means that we don't have any
+automagical language provided namespacing mechanism, so we need to rely on
+naming conventions to avoid polluting the global namespace.
+
+All Lucene4c symbols that are exported from the final binaries or that
+appear in public header files must be prefixed with 'lcn' or 'LCN'. It
+is convention that macros are in capital letters, and functions lower
+case. If a function is declared non-static for technical reasons, not
+because it is intended to be consumed by users of the library, then it
+will contain a double underscore, for example 'lcn__cfs_istream_create'.
+This is to indicate to consumers that they are not allowed to call the
+function, as it is an internal implementation detail that could change
+at any time.
+
+Similarly, all public header files are named starting with 'lcn'.
+
+For readability reasons, all symbols are either all lower case, or all
+upper case, with underscores used to indicate breaks in words.
+
+API documentation
+=================
+
+Lucene4c uses Doxygen (http://doxygen.org/) to generate documentation for
+its public APIs. This means that if you're adding to or making changes to
+any of the header files in the 'include' directory you need to keep the
+doxygen tags in the comments up to date. You can use the existing comments
+as a guide to the style we use, but in general we use a conversational
+style with arguments marked up with @a tags, bits of C code with @c, and so
+forth.
Added: incubator/lucene4c/trunk/Makefile.am
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/Makefile.am?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/Makefile.am (added)
+++ incubator/lucene4c/trunk/Makefile.am Sat Feb 26 08:47:57 2005
@@ -0,0 +1,73 @@
+AUTOMAKE_OPTIONS = subdir-objects
+
+EXTRA_DIST = bootstrap
+
+MAINTAINERCLEANFILES = Makefile.in \
+ aclocal.m4 \
+ configure \
+ config/compile \
+ config/config.sub \
+ config/config.guess \
+ config/depcomp \
+ config/install-sh \
+ config/missing \
+ config/mkinstalldirs
+
+lib_LIBRARIES = liblucene4c.a
+
+liblucene4c_a_SOURCES = src/util/error.c \
+ src/util/string.c \
+ src/util/pools.c \
+ src/store/istream.c \
+ src/store/directory.c \
+ src/search/query.c \
+ src/search/scorer.c \
+ src/index/index.c \
+ src/index/segments.c \
+ src/index/segment.c \
+ src/index/term.c \
+ src/index/terminfos.c \
+ src/index/frequencies.c \
+ src/index/fielddata.c \
+ src/index/fieldinfos.c \
+ src/document/document.c \
+ src/document/field.c
+
+bin_PROGRAMS = test/tests \
+ src/cmdline/lcn
+
+test_tests_SOURCES = test/abts.c \
+ test/lcn_tests.c \
+ test/util/string_test.c \
+ test/index/fieldinfos_test.c \
+ test/index/fielddata_test.c \
+ test/index/index_test.c \
+ test/index/segments_test.c \
+ test/index/segment_test.c \
+ test/index/terminfos_test.c \
+ test/index/frequencies_test.c \
+ test/store/istream_test.c \
+ test/search/scorer_test.c \
+ test/store/directory_test.c
+
+src_cmdline_lcn_SOURCES = src/cmdline/main.c
+
+src_cmdline_lcn_LDADD= liblucene4c.a
+
+test_tests_LDADD = liblucene4c.a
+
+INCLUDES = -Iinclude -Itest $(LCN_APR_INCLUDES)
+
+LIBS = $(LCN_APR_LIBS)
+
+check:
+ @./test/tests
+
+doxygen:
+ @doxygen doc/doxygen.conf
+
+publish-website: doxygen
+ @scp www/index.xhtml \
+ electricjellyfish.net:public_html/garrett/lucene4c/index.html
+ @scp -r doc/doxygen/html \
+ electricjellyfish.net:public_html/garrett/lucene4c/apidocs
Added: incubator/lucene4c/trunk/README
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/README?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/README (added)
+++ incubator/lucene4c/trunk/README Sat Feb 26 08:47:57 2005
@@ -0,0 +1,20 @@
+Lucene4c is a port of the Lucene [1] search engine library to C.
+
+It is built on top of the Apache Portable Runtime [2] for portability, and
+aims to be compatable with the data formats used in Lucene 1.4.
+
+At this point only read-only support exists, so you still have to use the
+Java version of Lucene for indexing data.
+
+To build lucene4c just use the standard ./configure && make routine you're
+used to from other packages. If configure cannot find your APR install you
+might need to pass it the --with-apr argument, see ./configure --help for
+details.
+
+Please direct any questions, comments, and patches implementing large parts
+of the incomplete functionality to the author,
+
+Garrett Rooney <rooneg at electricjellyfish.net>
+
+[1] - http://jakarta.apache.org/lucene/
+[2] - http://apr.apache.org/
Added: incubator/lucene4c/trunk/TODO
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/TODO?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/TODO (added)
+++ incubator/lucene4c/trunk/TODO Sat Feb 26 08:47:57 2005
@@ -0,0 +1,23 @@
+- write code to read the rest of the index files
+ - positions (.prx) files.
+ - normalization factor (.f[0-9]) files.
+ - term vector (.tvx) files.
+ - deleted documents (.del) files.
+ - deletable file (low priority, win32 only).
+
+- write code to do locking.
+
+- figure out what to do about the char issue.
+ - does that API think in terms of lcn_char_t or const char *?
+ - if we use const char * does that mean utf8? is that too slow?
+
+- define the set of functions that the index and segment layers expose
+ to the rest of the world.
+
+- design and implement analysis layer
+
+- design and implement search layer
+
+- think about indexing support
+
+- istream read code needs a way to return number of bytes read
Added: incubator/lucene4c/trunk/bootstrap
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/bootstrap?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/bootstrap (added)
+++ incubator/lucene4c/trunk/bootstrap Sat Feb 26 08:47:57 2005
@@ -0,0 +1,12 @@
+#!/bin/sh
+if [ -e /etc/debian_version ]; then
+ aclocal-1.6 -I config
+ automake-1.6 --foreign --add-missing --copy
+ autoconf
+else
+ aclocal -I config
+ automake --foreign --add-missing --copy
+ autoconf
+fi
+
+rm -rf autom4te.cache
Propchange: incubator/lucene4c/trunk/bootstrap
------------------------------------------------------------------------------
svn:executable = *
Propchange: incubator/lucene4c/trunk/config/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Sat Feb 26 08:47:57 2005
@@ -0,0 +1,7 @@
+mkinstalldirs
+depcomp
+compile
+missing
+install-sh
+config.guess
+config.sub
Added: incubator/lucene4c/trunk/config/find_apr.m4
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/config/find_apr.m4?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/config/find_apr.m4 (added)
+++ incubator/lucene4c/trunk/config/find_apr.m4 Sat Feb 26 08:47:57 2005
@@ -0,0 +1,150 @@
+dnl
+dnl find_apr.m4 : locate the APR include files and libraries
+dnl
+dnl This macro file can be used by applications to find and use the APR
+dnl library. It provides a standardized mechanism for using APR. It supports
+dnl embedding APR into the application source, or locating an installed
+dnl copy of APR.
+dnl
+dnl APR_FIND_APR(srcdir, builddir, implicit-install-check, acceptable-majors)
+dnl
+dnl where srcdir is the location of the bundled APR source directory, or
+dnl empty if source is not bundled.
+dnl
+dnl where builddir is the location where the bundled APR will will be built,
+dnl or empty if the build will occur in the srcdir.
+dnl
+dnl where implicit-install-check set to 1 indicates if there is no
+dnl --with-apr option specified, we will look for installed copies.
+dnl
+dnl where acceptable-majors is a space separated list of acceptable major
+dnl version numbers. Often only a single major version will be acceptable.
+dnl If multiple versions are specified, and --with-apr=PREFIX or the
+dnl implicit installed search are used, then the first (leftmost) version
+dnl in the list that is found will be used. Currently defaults to [0 1].
+dnl
+dnl Sets the following variables on exit:
+dnl
+dnl apr_found : "yes", "no", "reconfig"
+dnl
+dnl apr_config : If the apr-config tool exists, this refers to it. If
+dnl apr_found is "reconfig", then the bundled directory
+dnl should be reconfigured *before* using apr_config.
+dnl
+dnl Note: this macro file assumes that apr-config has been installed; it
+dnl is normally considered a required part of an APR installation.
+dnl
+dnl If a bundled source directory is available and needs to be (re)configured,
+dnl then apr_found is set to "reconfig". The caller should reconfigure the
+dnl (passed-in) source directory, placing the result in the build directory,
+dnl as appropriate.
+dnl
+dnl If apr_found is "yes" or "reconfig", then the caller should use the
+dnl value of apr_config to fetch any necessary build/link information.
+dnl
+
+AC_DEFUN([APR_FIND_APR], [
+ apr_found="no"
+
+ if test "$ac_cv_emxos2" = "yes"; then
+ # Scripts don't pass test -x on OS/2
+ TEST_X="test -f"
+ else
+ TEST_X="test -x"
+ fi
+
+ ifelse([$4], [], [
+ ifdef(AC_WARNING,AC_WARNING([$0: missing argument 4
(acceptable-majors): Defaulting to APR 0.x then APR 1.x]))
+ acceptable_majors="0 1"],
+ [acceptable_majors="$4"])
+
+ apr_temp_acceptable_apr_config=""
+ for apr_temp_major in $acceptable_majors
+ do
+ case $apr_temp_major in
+ 0)
+ apr_temp_acceptable_apr_config="$apr_temp_acceptable_apr_config
apr-config"
+ ;;
+ *)
+ apr_temp_acceptable_apr_config="$apr_temp_acceptable_apr_config
apr-$apr_temp_major-config"
+ ;;
+ esac
+ done
+
+ AC_MSG_CHECKING(for APR)
+ AC_ARG_WITH(apr,
+ [ --with-apr=PATH prefix for installed APR, path to APR build tree,
+ or the full path to apr-config],
+ [
+ if test "$withval" = "no" || test "$withval" = "yes"; then
+ AC_MSG_ERROR([--with-apr requires a directory or file to be provided])
+ fi
+
+ for apr_temp_apr_config_file in $apr_temp_acceptable_apr_config
+ do
+ for lookdir in "$withval/bin" "$withval"
+ do
+ if $TEST_X "$lookdir/$apr_temp_apr_config_file"; then
+ apr_found="yes"
+ apr_config="$lookdir/$apr_temp_apr_config_file"
+ break 2
+ fi
+ done
+ done
+
+ if test "$apr_found" != "yes" && $TEST_X "$withval" && $withval --help >
/dev/null 2>&1 ; then
+ apr_found="yes"
+ apr_config="$withval"
+ fi
+
+ dnl if --with-apr is used, it is a fatal error for its argument
+ dnl to be invalid
+ if test "$apr_found" != "yes"; then
+ AC_MSG_ERROR([the --with-apr parameter is incorrect. It must specify an
install prefix, a build directory, or an apr-config file.])
+ fi
+ ],[
+ dnl if we have a bundled source directory, use it
+ if test -d "$1"; then
+ apr_temp_abs_srcdir="`cd $1 && pwd`"
+ apr_found="reconfig"
+ apr_bundled_major="`sed -n
'/#define.*APR_MAJOR_VERSION/s/^[^0-9]*\([0-9]*\).*$/\1/p'
\"$1/include/apr_version.h\"`"
+ case $apr_bundled_major in
+ "")
+ AC_MSG_ERROR([failed to find major version of bundled APR])
+ ;;
+ 0)
+ apr_temp_apr_config_file="apr-config"
+ ;;
+ *)
+ apr_temp_apr_config_file="apr-$apr_bundled_major-config"
+ ;;
+ esac
+ if test -n "$2"; then
+ apr_config="$2/$apr_temp_apr_config_file"
+ else
+ apr_config="$1/$apr_temp_apr_config_file"
+ fi
+ fi
+ if test "$apr_found" = "no" && test -n "$3" && test "$3" = "1"; then
+ for apr_temp_apr_config_file in $apr_temp_acceptable_apr_config
+ do
+ if $apr_temp_apr_config_file --help > /dev/null 2>&1 ; then
+ apr_found="yes"
+ apr_config="$apr_temp_apr_config_file"
+ break
+ else
+ dnl look in some standard places (apparently not in builtin/default)
+ for lookdir in /usr /usr/local /opt/apr /usr/local/apache2 ; do
+ if $TEST_X "$lookdir/bin/$apr_temp_apr_config_file"; then
+ apr_found="yes"
+ apr_config="$lookdir/bin/$apr_temp_apr_config_file"
+ break 2
+ fi
+ done
+ fi
+ done
+ fi
+ ])
+
+ AC_MSG_RESULT($apr_found)
+])
Added: incubator/lucene4c/trunk/configure.in
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/configure.in?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/configure.in (added)
+++ incubator/lucene4c/trunk/configure.in Sat Feb 26 08:47:57 2005
@@ -0,0 +1,41 @@
+AC_INIT(src/store/istream.c)
+AC_CONFIG_AUX_DIR(config)
+AM_INIT_AUTOMAKE(lucene4c, 0.01)
+
+AC_PROG_CC
+AM_PROG_CC_C_O
+AC_PROG_RANLIB
+
+AC_MSG_NOTICE([Apache Portable Runtime (APR) library configuration])
+
+APR_FIND_APR("", "", 1, 1 0)
+
+if test $apr_found = "no"; then
+ AC_MSG_ERROR([APR not found])
+fi
+
+# just use APR's defaults for this stuff...
+CPPFLAGS="$CPPFLAGS `$apr_config --cppflags`"
+CFLAGS="$CFLAGS `$apr_config --cflags`"
+LDFLAGS="$LDLAGS `$apr_config --ldflags`"
+
+LCN_APR_LIBS="$LIBS `$apr_config --link-ld --libs`"
+LCN_APR_INCLUDES="`$apr_config --includes`"
+
+AC_ARG_ENABLE(maintainer-mode,
+AC_HELP_STRING([--enable-maintainer-mode],
+ [Turn on debugging and extra compile time warnings]),
+[
+ if test "$enableval" = "yes" ; then
+ if test "$GCC" = "yes"; then
+ CFLAGS="$CFLAGS -Wall -Werror -Wpointer-arith -Wwrite-strings"
+ fi
+ CFLAGS="$CFLAGS -g"
+ fi
+])
+
+AC_SUBST(ac_aux_dir)
+AC_SUBST(LCN_APR_INCLUDES)
+AC_SUBST(LCN_APR_LIBS)
+
+AC_OUTPUT([Makefile])
Added: incubator/lucene4c/trunk/doc/doxygen.conf
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/doc/doxygen.conf?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/doc/doxygen.conf (added)
+++ incubator/lucene4c/trunk/doc/doxygen.conf Sat Feb 26 08:47:57 2005
@@ -0,0 +1,991 @@
+# Doxyfile 1.3.7
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# General configuration options
+#---------------------------------------------------------------------------
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = Lucene4c
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = doc/doxygen
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
Dutch,
+# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
+# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
+# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these class will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed
description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
inherited
+# members of a class in the documentation of that class as if those members
were
+# ordinary class members. Constructors, destructors and assignment operators
of
+# the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. It is allowed to use relative paths in the argument list.
+
+STRIP_FROM_PATH =
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower case letters. If set to YES upper case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# users are adviced to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = YES
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like the Qt-style comments (thus requiring an
+# explict @brief command for a brief description.
+
+JAVADOC_AUTOBRIEF = YES
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen
+# will output the detailed description near the top, like JavaDoc.
+# If set to NO, the detailed description appears after the member
+# documentation.
+
+DETAILS_AT_TOP = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# reimplements.
+
+INHERIT_DOCS = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consist of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
sources
+# only. Doxygen will then generate output that is more tailored for C.
+# For instance some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
sources
+# only. Doxygen will then generate output that is more tailored for Java.
+# For instance namespaces will be presented as packages, qualified scopes
+# will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = YES
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that
contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = include
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
*.hxx *.hpp
+# *.h++ *.idl *.odl
+
+FILE_PATTERNS = *.h
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT
tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
directories
+# that are symbolic links (a Unix filesystem feature) are excluded from the
input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+
+EXCLUDE_PATTERNS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output.
+
+INPUT_FILTER =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these
sources.
+
+SOURCE_BROWSER = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = NO
+
+# If the REFERENCED_BY_RELATION tag is set to YES (the default)
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES (the default)
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output dir.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
+# the html help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the Html help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 1
+
+# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
+# generated containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
+# or Internet explorer 4.0+). Note that for large projects the tree generation
+# can take a very long time. In such cases it is better to disable this
feature.
+# Windows users are probably better off using the HTML help feature.
+
+GENERATE_TREEVIEW = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = NO
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = NO
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimised for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assigments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_XML = NO
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = YES
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_PREDEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed.
+
+PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be
expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
the
+# parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::addtions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tagfiles.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with
base or
+# super classes. Setting the tag to NO turns the diagrams off. Note that this
+# option is superceded by the HAVE_DOT option below. This is only a fallback.
It is
+# recommended to install and use dot, since it yield more powerful graphs.
+
+CLASS_DIAGRAMS = YES
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph
visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = NO
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found on the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+
+MAX_DOT_GRAPH_WIDTH = 1024
+
+# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+
+MAX_DOT_GRAPH_HEIGHT = 1024
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermedate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
Added: incubator/lucene4c/trunk/include/lcn_api.h
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/include/lcn_api.h?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/include/lcn_api.h (added)
+++ incubator/lucene4c/trunk/include/lcn_api.h Sat Feb 26 08:47:57 2005
@@ -0,0 +1,40 @@
+/* Copyright 2005 Garrett Rooney
+ *
+ * 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.
+ */
+
+/** @mainpage Lucene4c API Documentation
+ *
+ * Lucene4c is a port of the Lucene search engine to C, built on top of the
+ * Apache Portable Runtime.
+ *
+ * Unlike some other Lucene ports, Lucene4c does not stick to the API used
+ * in the original Java based Lucene when a more idiomatic APR and C API makes
+ * more sense. The goal is to remain compatible with the on-disk format used
+ * by Java Lucene (currently that of Lucene 1.4.x) but to provide an API that
+ * makes sense to programmers used to coding in C with APR.
+ *
+ * Currently Lucene4c is read-only, and only the lowest level portions of the
+ * search engine has been implemented. The goal is to implement the remaining
+ * parts of the search side of Lucene4c first, and then to begin work on
+ * indexing support. In the meantime the Java Lucene must be used to create
+ * the index searched by Lucene4c.
+ *
+ * In order to make effective use of Lucene4c you will need to understand how
+ * to use APR, which has its own API documentation at <a
+ * href="http://apr.apache.org/docs/apr/";>http://apr.apache.org/docs/apr/</a>.
+ */
+
+/* XXX eventually this will include the various header files a consumer of the
+ * Lucene4c API would probably want to include, for now it just holds the intro
+ * documentation for the doxygen docs. */
Added: incubator/lucene4c/trunk/include/lcn_directory.h
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/include/lcn_directory.h?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/include/lcn_directory.h (added)
+++ incubator/lucene4c/trunk/include/lcn_directory.h Sat Feb 26 08:47:57 2005
@@ -0,0 +1,163 @@
+/* Copyright 2005 Garrett Rooney
+ *
+ * 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_directory.h
+ * @brief Routines for working with various types of directories
+ */
+
+#ifndef _LCN_DIRECTORY_H
+#define _LCN_DIRECTORY_H
+
+#include "lcn_types.h"
+#include "lcn_istream.h"
+
+#include <apr_hash.h>
+#include <apr_tables.h>
+#include <apr_time.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/** An opaque directory object. */
+typedef struct lcn_directory_t lcn_directory_t;
+
+/** An entry in a ram-based directory. */
+typedef struct {
+ const char *bytes; /**< The actual contents of the file */
+ apr_size_t len; /**< The length of the contents in bytes */
+ apr_time_t mtime; /**< The time the file was last modified on */
+} lcn_directory_entry_t;
+
+/** Open a new ram-backed directory @a dir, allocated within @a pool.
+ *
+ * @a contents maps from <tt>const char *</tt> filenames to pointers to
+ * @c lcn_directory_entry_t objects.
+ */
+lcn_error_t *
+lcn_ram_directory_open (lcn_directory_t **dir,
+ apr_hash_t *contents,
+ apr_pool_t *pool);
+
+/** Open a new directory object @a dir which corresponds to the filesystem
+ * directory located at @a path, all allocation is done within @a pool.
+ */
+lcn_error_t *
+lcn_fs_directory_open (lcn_directory_t **dir,
+ const char *path,
+ apr_pool_t *pool);
+
+/** Open an new compound file stream directory @a dir, using the stream
+ * @a cfsfile for the backing store, all allocation is done within @a pool.
+ */
+lcn_error_t *
+lcn_cfs_directory_open (lcn_directory_t **dir,
+ lcn_istream_t *cfsfile,
+ apr_pool_t *pool);
+
+/** Return in @a contents a list of the files within directory @a d, allocated
+ * in @a pool.
+ *
+ * @a contents will contain <tt>const char *</tt> filenames.
+ */
+lcn_error_t *
+lcn_directory_list (apr_array_header_t **contents,
+ const lcn_directory_t *d,
+ apr_pool_t *pool);
+
+/** If file @a name exists in directory @a d return @c TRUE in @a result,
+ * otherwise return @c FALSE in @a result.
+ *
+ * @a pool is used for all temporary allocations.
+ */
+lcn_error_t *
+lcn_directory_file_exists (lcn_boolean_t *result,
+ const lcn_directory_t *d,
+ const char *name,
+ apr_pool_t *pool);
+
+/** Return the time file @a name in directory @a d was modified in @a result,
+ * using @a pool for temporary allocations.
+ */
+lcn_error_t *
+lcn_directory_file_modified (apr_time_t *result,
+ const lcn_directory_t *d,
+ const char *name,
+ apr_pool_t *pool);
+
+/** Update the modification time for file @a name in directory @a d, using
+ * @a pool for any temporary allocations.
+ */
+lcn_error_t *
+lcn_directory_touch_file (lcn_directory_t *d,
+ const char *name,
+ apr_pool_t *pool);
+
+/** Delete file @a name in directory @a d, using @a pool for any temporary
+ * allocations.
+ */
+lcn_error_t *
+lcn_directory_delete_file (lcn_directory_t *d,
+ const char *name,
+ apr_pool_t *pool);
+
+/** Rename file @a from to @a to within directory @a d, using @a pool for
+ * temporary allocations.
+ */
+lcn_error_t *
+lcn_directory_rename_file (lcn_directory_t *d,
+ const char *from,
+ const char *to,
+ apr_pool_t *pool);
+
+#ifdef NOTYET
+lcn_error_t *
+lcn_directory_create_file (lcn_ostream_t **result,
+ lcn_directory_t *d,
+ const char *name,
+ apr_pool_t *pool);
+#endif
+
+/** Open file @a name in directory @a d for reading, returning a corresponding
+ * stream in @a result, using @a pool for all allocation.
+ */
+lcn_error_t *
+lcn_directory_open_file (lcn_istream_t **result,
+ const lcn_directory_t *d,
+ const char *name,
+ apr_pool_t *pool);
+
+#ifdef NOTYET
+lcn_error_t *
+lcn_directory_make_lock (lcn_lock_t **lock,
+ lcn_directory_t *d,
+ const char *name,
+ apr_pool_t *pool);
+#endif
+
+/** Close directory @a d, using @a pool for any temporary allocation.
+ *
+ * @note This isn't strictly necessary, you can just let pool cleanups clean
+ * up the directory for you if you want.
+ */
+lcn_error_t *
+lcn_directory_close (lcn_directory_t *d, apr_pool_t *pool);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif
Added: incubator/lucene4c/trunk/include/lcn_document.h
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/include/lcn_document.h?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/include/lcn_document.h (added)
+++ incubator/lucene4c/trunk/include/lcn_document.h Sat Feb 26 08:47:57 2005
@@ -0,0 +1,58 @@
+/* Copyright 2005 Garrett Rooney
+ *
+ * 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_document.h
+ * @brief Routines for manipulating lucene documents
+ */
+
+#ifndef _LCN_DOCUMENT_H
+#define _LCN_DOCUMENT_H
+
+#include "lcn_types.h"
+#include "lcn_field.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/** Opaque structure representing a document in the index. */
+typedef struct lcn_document_t lcn_document_t;
+
+/** Create an empty document, allocated from @a pool. */
+lcn_document_t *
+lcn_document_create (apr_pool_t *pool);
+
+/** Return the number of fields in document @a doc. */
+apr_uint32_t lcn_document_numfields (lcn_document_t *doc);
+
+/** Add @a field to @a doc. */
+void lcn_document_add_field (lcn_document_t *doc, lcn_field_t *field);
+
+/** Return field number @a num from @a doc, or @c NULL if it does not exist. */
+const lcn_field_t *
+lcn_document_field_by_num (const lcn_document_t *doc,
+ apr_uint32_t num);
+
+/** Return field @a name from @a doc, or @c NULL if it does not exist. */
+const lcn_field_t *
+lcn_document_field_by_name (const lcn_document_t *doc,
+ const lcn_char_t *name);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* _LCN_DOCUMENT_H */
Added: incubator/lucene4c/trunk/include/lcn_field.h
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/include/lcn_field.h?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/include/lcn_field.h (added)
+++ incubator/lucene4c/trunk/include/lcn_field.h Sat Feb 26 08:47:57 2005
@@ -0,0 +1,93 @@
+/* Copyright 2005 Garrett Rooney
+ *
+ * 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_field.h
+ * @brief Routines for manipulating lucene fields
+ */
+
+#ifndef _LCN_FIELD_H
+#define _LCN_FIELD_H
+
+#include "lcn_types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/** Opaque structure representing a field in a document. */
+typedef struct lcn_field_t lcn_field_t;
+
+/** Indicates if a field is stored in the index or not. */
+typedef enum {
+ LCN_STORED_NO, /**< Field is not stored */
+ LCN_STORED_YES, /**< Field is stored */
+ LCN_STORED_COMPRESS /**< Field is stored in compressed form */
+} lcn_field_stored_t;
+
+/** Indicates if a field is indexed or not. */
+typedef enum {
+ LCN_INDEXED_NO, /**< Field is not indexed */
+ LCN_INDEXED_TOKENIZED, /**< Field is indexed in tokenized form */
+ LCN_INDEXED_UNTOKENIZED /**< Field is indexed without being tokenized */
+} lcn_field_indexed_t;
+
+/** Indicates if a field is stored in the index's termvector. */
+typedef enum {
+ /** Field is not stored in the termvector */
+ LCN_TERMVECTOR_NO,
+
+ /** Field is stored in the termvector */
+ LCN_TERMVECTOR_YES,
+
+ /** Field is stored in the termvector along with its positions */
+ LCN_TERMVECTOR_WITH_POSITIONS,
+
+ /** Field is stored in the termvector along with its offsets */
+ LCN_TERMVECTOR_WITH_OFFSETS,
+
+ /** Field is stored in the termvector along with its positions and offsets */
+ LCN_TERMVECTOR_WITH_POSITIONS_OFFSETS
+} lcn_field_termvector_t;
+
+/** Create new field.
+ *
+ * The field will have the name @a name, the value @a value, and its status
+ * with regard to storage, indexing, and termvector are determined by the
+ * @a stored, @a indexed, and @a termvector arguments.
+ *
+ * All allocation is done with @a pool.
+ */
+lcn_field_t *
+lcn_field_create (const lcn_char_t *name,
+ const lcn_char_t *value,
+ lcn_field_stored_t stored,
+ lcn_field_indexed_t indexed,
+ lcn_field_termvector_t termvector,
+ apr_pool_t *pool);
+
+/** Return the name of field @a f. */
+const lcn_char_t *
+lcn_field_name (const lcn_field_t *f);
+
+/** Return the content of field @a f. */
+const lcn_char_t *
+lcn_field_content (const lcn_field_t *f);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* _LCN_FIELD_H */
Added: incubator/lucene4c/trunk/include/lcn_fielddata.h
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/include/lcn_fielddata.h?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/include/lcn_fielddata.h (added)
+++ incubator/lucene4c/trunk/include/lcn_fielddata.h Sat Feb 26 08:47:57 2005
@@ -0,0 +1,59 @@
+/* Copyright 2004-2005 Garrett Rooney
+ *
+ * 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_fielddata.h
+ * @brief Routines for manipulating a segment's field data file
+ */
+
+#ifndef _LCN_FIELDDATA_H
+#define _LCN_FIELDDATA_H
+
+#include "lcn_types.h"
+#include "lcn_directory.h"
+#include "lcn_field.h"
+
+#include <apr_tables.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/** Opaque structure representing a segment's field data. */
+typedef struct lcn_fielddata_t lcn_fielddata_t;
+
+/** Return the field data @a fd for segment @a s in directory @a d, allocated
+ * within @a pool.
+ */
+lcn_error_t *
+lcn_fielddata_open (lcn_fielddata_t **fd,
+ const lcn_directory_t *d,
+ const lcn_char_t *s,
+ apr_pool_t *pool);
+
+/** Returns in @a doc an array of @c lcn_field_t pointers associated with
+ * document number @a doc_num, allocated within @a pool.
+ */
+lcn_error_t *
+lcn_fielddata_get_doc (apr_array_header_t **doc,
+ lcn_fielddata_t *fd,
+ apr_uint32_t doc_num,
+ apr_pool_t *pool);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif
Added: incubator/lucene4c/trunk/include/lcn_fieldinfos.h
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/include/lcn_fieldinfos.h?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/include/lcn_fieldinfos.h (added)
+++ incubator/lucene4c/trunk/include/lcn_fieldinfos.h Sat Feb 26 08:47:57 2005
@@ -0,0 +1,79 @@
+/* Copyright 2004-2005 Garrett Rooney
+ *
+ * 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_fieldinfos.h
+ * @brief Routines for reading information about a segment's fields
+ */
+
+#ifndef _LCN_FIELDINFOS_H
+#define _LCN_FIELDINFOS_H
+
+#include "lcn_types.h"
+#include "lcn_directory.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/** Information about a particular field in a segment. */
+typedef struct {
+ /** The name of the field */
+ const lcn_char_t *name;
+
+ /** Is the field indexed? */
+ lcn_boolean_t is_indexed;
+
+ /** The field's number */
+ apr_int32_t number;
+
+ /** Is the field stored in the term vector? */
+ lcn_boolean_t store_term_vector;
+} lcn_fieldinfo_t;
+
+/** Opaque structure representing a segment's fieldinfos file. */
+typedef struct lcn_fieldinfos_t lcn_fieldinfos_t;
+
+/** Return in @a fis an @c lcn_fieldinfos_t corresponding to segment @a s in
+ * directory @a d, allocated in @a pool.
+ */
+lcn_error_t *
+lcn_fieldinfos_read (lcn_fieldinfos_t **fis,
+ const lcn_directory_t *d,
+ const lcn_char_t *s,
+ apr_pool_t *pool);
+
+/** Return a pointer to the @c lcn_fieldinfo_t that corresponds to number
+ * @a i, or @c NULL if none exists.
+ */
+lcn_fieldinfo_t *
+lcn_fieldinfos_get_by_number (const lcn_fieldinfos_t *fis,
+ int i);
+
+/** Return a pointer to the @c lcn_fieldinfo_t that corresponds to @a name,
+ * or @c NULL if none exists.
+ */
+lcn_fieldinfo_t *
+lcn_fieldinfos_get_by_name (const lcn_fieldinfos_t *fis,
+ const lcn_char_t *name);
+
+/** Return the number of fieldinfos within @a fis */
+int lcn_fieldinfos_get_count (const lcn_fieldinfos_t *fis);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif
Added: incubator/lucene4c/trunk/include/lcn_frequencies.h
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/include/lcn_frequencies.h?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/include/lcn_frequencies.h (added)
+++ incubator/lucene4c/trunk/include/lcn_frequencies.h Sat Feb 26 08:47:57 2005
@@ -0,0 +1,61 @@
+/* Copyright 2004-2005 Garrett Rooney
+ *
+ * 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_frequencies.h
+ * @brief routines for reading the frequencies data for a segment
+ */
+
+#ifndef _LCN_FREQUENCIES_H
+#define _LCN_FREQUENCIES_H
+
+#include "lcn_types.h"
+#include "lcn_terminfos.h"
+#include "lcn_directory.h"
+
+#include <apr_pools.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/** Opaque structure representing the frequencies file for a segment. */
+typedef struct lcn_frequencies_t lcn_frequencies_t;
+
+/** Return the @a freqs for segment @a s in directory @a d, allocated in
+ * @a pool.
+ */
+lcn_error_t *
+lcn_frequencies_open (lcn_frequencies_t **freqs,
+ const lcn_directory_t *d,
+ const lcn_char_t *s,
+ apr_pool_t *pool);
+
+/** Return the document numbers @a docs and frequencies @a freqs for all
+ * documents that contain the term represented by @c lcn_terminfo_t @a ti
+ * within @c lcn_frequencies_t @a f, allocated in @a pool.
+ */
+lcn_error_t *
+lcn_frequencies_get_terminfo_data (apr_uint32_t **docs,
+ apr_uint32_t **freqs,
+ lcn_frequencies_t *f,
+ const lcn_terminfo_t *ti,
+ apr_pool_t *pool);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif
Added: incubator/lucene4c/trunk/include/lcn_index.h
URL:
http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/include/lcn_index.h?view=auto&rev=155552
==============================================================================
--- incubator/lucene4c/trunk/include/lcn_index.h (added)
+++ incubator/lucene4c/trunk/include/lcn_index.h Sat Feb 26 08:47:57 2005
@@ -0,0 +1,95 @@
+/* Copyright 2004-2005 Garrett Rooney
+ *
+ * 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_index.h
+ * @brief Routines for manipulating a lucene index
+ */
+
+#ifndef _LCN_INDEX_H
+#define _LCN_INDEX_H
+
+#include "lcn_types.h"
+#include "lcn_term.h"
+#include "lcn_document.h"
+
+#include <apr_file_io.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/** Opaque structure representing a lucene index. */
+typedef struct lcn_index_t lcn_index_t;
+
+/** Return the index contained in directory @a d in @a idx, allocated in
+ * @a pool.
+ */
+lcn_error_t *
+lcn_index_open (lcn_index_t **idx,
+ const char *d,
+ apr_pool_t *pool);
+
+/** Return the maximum document number contained in index @a idx, using
+ * @a pool for temporary allocations.
+ */
+apr_uint32_t
+lcn_index_max_docs (lcn_index_t *idx, apr_pool_t *pool);
+
+/** Opaque iterator for iterating over a list of documents. */
+typedef struct lcn_doc_iter_t lcn_doc_iter_t;
+
+/** Return the current document number from @a itr. */
+apr_uint32_t lcn_doc_iter_doc (lcn_doc_iter_t *itr);
+
+/** Return the current document's frequency from @a itr. */
+apr_uint32_t lcn_doc_iter_freq (lcn_doc_iter_t *itr);
+
+/** Move @a itr to the next document.
+ *
+ * Returns an @c APR_EOF error when the last document has been returned.
+ */
+lcn_error_t * lcn_doc_iter_next (lcn_doc_iter_t *itr);
+
+/* XXX need an interface to read multiple doc/freq pairs at once. */
+
+/* XXX need an interface to skip to a certain document. */
+
+/** Close @a itr. */
+lcn_error_t * lcn_doc_iter_close (lcn_doc_iter_t *itr);
+
+/** Return an iterator @a itr for iterating over all documents that contain
+ * @a term within @a idx, allocated from within @a pool.
+ */
+lcn_error_t *
+lcn_index_term_docs (lcn_doc_iter_t **itr,
+ lcn_index_t *idx,
+ lcn_term_t *term,
+ apr_pool_t *pool);
+
+/** Return the document @a doc from @a idx that has the number @a docnum,
+ * allocated from @a pool.
+ */
+lcn_error_t *
+lcn_index_get_document (lcn_document_t **doc,
+ lcn_index_t *idx,
+ apr_uint32_t docnum,
+ apr_pool_t *pool);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif
