/home/dcp1990/prog/fakedbfs/include/fakedbfs/fakedbfs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005-2006, Dan Ponte
 *
 * fakedbfs.h - main header
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the author nor the names of his contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
/* $Amigan: fakedbfs/include/fakedbfs/fakedbfs.h,v 1.77 2006/04/19 19:58:22 dcp1990 Exp $ */
#include <fakedbfs/types.h>

#include <fakedbfs/fdbfsconfig.h>
#ifndef _SQLITE3_H_
#include <sqlite3.h>
#endif
#include <fakedbfs/conf.h>
#ifndef HAVE_DBSPECDATA_H
#include <fakedbfs/dbspecdata.h>
#endif
#ifndef HAVE_QUERY_H
#include <fakedbfs/query.h>
#endif
#if defined(DMALLOC) && !defined(NODMALLOC)
#include "dmalloc.h"
#endif

#ifdef HAVE_FICL_H
#include <ficl.h>
#endif

#define ERR(act, fmt, ...) fdbfs_ferr(f, act, fmt, __VA_ARGS__)
#define SERR(act, fmt) fdbfs_ferr(f, act, fmt)
#define CERR(act, fmt, ...) fdbfs_cferr(f, act, fmt, __VA_ARGS__)
#define SCERR(act, fmt) fdbfs_cferr(f, act, fmt)
#define _unused       __attribute__((__unused__))

#define MAJOR_API_VERSION 2
#define MINOR_API_VERSION 0

#define FAKEDBFSVER "2.0.0" /* major changes with major incompat changes, minor with minor incompat, micro with additions, bugfixes, and security fixes */
#define VERNAME "Doctor Wu" /* this changes for each release */
#define FAKEDBFSMAJOR   2
#define FAKEDBFSMINOR   0
#define FAKEDBFSMICRO   0


#ifndef lint
#define RCSID(str) static const char _cvsid[] __unused = str;
#else
#define RCSID(str) ;
#endif

#define DELIMCHAR "|"
#define FDBFSDIR ".fdbfs"
#define FDBFSPLUGENV "FDBFSPLUGPATH"

#ifdef lint
/* LINTLIBRARY */
#endif

#if !defined(ISLEX) && defined(FREEDEBUG) && !defined(DMALLOC)
#undef free
#define free(x)         printf("fr %p (%s:%d)\n", x, __FILE__, __LINE__); free(x)
#endif



#define FIELDS_FLAG_MMAPED      0x1     /* set if we need to do an mmap (only for stuff that supports this! */
#define FIELDS_FLAG_LASTDEF     0x2     /* used in the indexer to keep track of what it can and cannot free */




struct PluginInfo {
        const char *extensions; /* a list of file extensions, not including dots, that
                                this plugin handles. Each extension is separated
                                by a slash character. (since it cannot occur in a filename)
                                Note that this isn't required, but if a file's extension is in
                                the list, the plugin will be given priority,
                                thereby speeding up searches (check_file() is
                                always called, however).
                          */
        const char *pluginname; /* the name of the plugin; self-explanatory */
        const char *version; /* the version of the plugin */
        const char *author; /* author (usually name and email address) */
        const char *website; /* website of plugin */
        const int majapi; /* major API version; this changes when incompatible changes
                        are made to the API. This should always be set to the
                        define MAJOR_API_VERSION.
                    */
        const int minapi; /* minor API version; this changes for backwards-compatible
                        changes. This should be set to MINOR_API_VERSION.
                    */
};      /*
        note that this structure will stay fairly consistent, at least for the
        first elements listed here. Another words: plugin_inf.majapi should
        always refer to the same object, even across major API changes.
        */


#define DEBUGFUNC_STDERR ((void(*)(char*, enum ErrorAction))0)
#define AFFPROTO (answer_t * /* buffer */, answer_t * /* default */, const char * /*fieldname*/, const char * /* unformatted name */, \
                        const char * /* filename */, enum DataType, struct EnumHead * /* if oenum */, struct EnumSubElem * /* if sub */)
#define ASKFUNC_STD ((answer_t*(*)AFFPROTO)0)

union _ansdata {
        char *string; /* this and vd will be free()d if they aren't NULL, no exceptions. Hence, make them dynamic. */
        int integer; /* applies to enums and subenums as well */
        long long linteger; /* long integer */
        FLOATTYPE fp;
        void *vd;
};

struct _answer {
        enum DataType dt;
        ansdata_t ad;
        size_t len;
};

struct _actcat {
        char *name;
        char *alias;
        struct CatalogueHead *def;
        actcat_t *next;
};

struct reg_functype {
        fdbfs_t *f;
        short negated;
};

struct _fdbfs {
        char *dbname;
        sqlite3 *db;
        error_t error;
        config_t conf;
        query_t *curq; /* current query; must be reset on each exec/step */
        struct Plugin *plugins;
        void (*debugfunc)(char*, enum ErrorAction);
        answer_t *(*askfieldfunc) AFFPROTO; /* returns status: 0 means no change, 1 means change, -1 means error */
        Heads heads;
        actcat_t *catsh;
        ficlSystem *fsys;
        ficlstate_t fst;
        confnode_t *rconf;
        struct reg_functype reg_norm; /* hack! oh well. */
        struct reg_functype reg_negated;
};

/* crawler stuff */
struct _file_id {
#if defined(UNIX)
        int filenum;
        int devnum;
#endif
        char *filename;
};

struct _crawl {
        crawlframe_t *topframe;
        crawlframe_t *curframe;
        fdbfs_t *f;
        int maxlevels;
        int mlbefdep; /* max levels before we just start doing a depth traversal rather than a breadth */
};

struct DirState {
#if defined(UNIX) && defined(HAVE_DIR_H)
        DIR *dir;
#endif
};

struct _crawlframe {
        crawlframe_t **stack; /* this is stack of POINTERS to crawlframes, not of crawlframes themselves! */
        crawlframe_t **sp; /* *sp is the object, sp is what we deal with */
        crawlframe_t **stop;
        int maxelements;
        int cindex;
        file_id_t oid;
        struct DirState ds;
        int level;
        crawlframe_t *parent;
        crawl_t *fajah;
};

struct _dspdata {
        fdbfs_t *f;
        char *yytext;
        int error;
        struct CatalogueHead *cat;
        fields_t *fhead;
        fields_t *lastf;
        fields_t *cf;
};

#define CRAWL_ERROR     0x0 /* error; curframe null? */
#define CRAWL_FILE      0x1 /* found a file; act upon it */
#define CRAWL_DIR       0x2 /* found a directory; rerun crawl_go() to find the next entry */
#define CRAWL_FINISHED  0x3 /* we've hit the bottom; give up */

/* flags */
#define CRAWL_DIE_ON_ERROR      0x1


/* end crawler */

#ifdef NO_CALLOC
void* allocz(size_t size);
#else
#define allocz(x)       calloc(1, x)
#endif

void fdbfs_set_aff(fdbfs_t *f, answer_t *(*aff)AFFPROTO);

fdbfs_t *fdbfs_new(const char *dbfile, char **error, void (*debugf)(char*, enum ErrorAction), int useplugins);

int fdbfs_destroy(fdbfs_t *f);

int fdbfs_read_specs_from_db(fdbfs_t *f);

/* misc string functions */

char* fdbfs_normalise(const char *s);

size_t fdbfs_number_size(unsigned int n);

size_t fdbfs_signed_size(int n);

answer_t* fdbfs_askfunc_std AFFPROTO;

char* fdbfs_strdupq(const char *s);

char* fdbfs_fstrdup(const char *str);

int fdbfs_create_catalogue(fdbfs_t *f, const char *name, const char *alias, const char *cname);

int fdbfs_cat_type_exists(fdbfs_t *f, const char *ct);

actcat_t* fdbfs_find_catalogue(fdbfs_t *f, const char *name);


/* crawl stuff -- will move to own file when we can*/
crawl_t* fdbfs_crawler_new(fdbfs_t *f, int mlevels, int mlbd);
void fdbfs_crawler_destroy(crawl_t *cr);
int fdbfs_crawl_dir(crawl_t *cr, const char *dir); /* simply adds dir to the base frame */

---