capi.h

/* File: $Id$
   Author: John Wu <John.Wu at acm.org>
      Lawrence Berkeley National Laboratory
   Copyright (c) 2006-2016 the Regents of the University of California
*/
#ifndef IBIS_CAPI_H
#define IBIS_CAPI_H

#if _MSC_VER >= 1000
#pragma once
#endif /* _MSC_VER >= 1000 */

#if !defined(WITHOUT_FASTBIT_CONFIG_H) && !defined(__MINGW32__) && !defined(_MSC_VER)
#include "fastbit-config.h"
#endif
#if defined(HAVE_SYS_TYPES_H) || defined(__PGI)
#  include <sys/types.h>        /* required by PGI compilers (bug 775993) */
#endif
#if defined(HAVE_INTTYPES_H) || defined(__sun) || defined(__MINGW32__) || defined(__FreeBSD__)
#  include <inttypes.h>
#elif defined(HAVE_STDINT_H) || defined(__unix__) || defined(__APPLE__)
#  include <stdint.h>
#elif defined(_WIN32) && defined(_MSC_VER)
/* MS windows has its own exact-width types, use them */
#  ifndef int16_t
#    define int16_t __int16
#  endif
#  ifndef uint16_t
#    define uint16_t unsigned __int16
#  endif
#  ifndef int32_t
#    define int32_t __int32
#  endif
#  ifndef uint32_t
#    define uint32_t unsigned __int32
#  endif
#  ifndef int64_t
#    define int64_t __int64
#  endif
#  ifndef uint64_t
#    define uint64_t unsigned __int64
#  endif
#else
#error Do NOT know how to find the exact width data types!
#endif

#if defined(_WIN32) && (defined(_MSC_VER) || defined(__MINGW32__))
#  if defined(_USRDLL) || defined(CXX_USE_DLL)
#    if defined(DLL_EXPORT)
#      define FASTBIT_DLLSPEC __declspec(dllexport)
#    else
#      define FASTBIT_DLLSPEC __declspec(dllimport)
#    endif
#  else
#    define FASTBIT_DLLSPEC
#  endif
#else
#  define FASTBIT_DLLSPEC
#endif

#include <stdio.h>      /* FILE* */

#ifdef __cplusplus
extern "C" {
#endif

    FASTBIT_DLLSPEC int
    fastbit_build_indexes(const char *indexLocation,
                          const char *indexOptions);
    FASTBIT_DLLSPEC int fastbit_purge_indexes(const char *indexLocation);
    FASTBIT_DLLSPEC int
    fastbit_build_index(const char *indexLocation, const char* cname,
                        const char *indexOptions);
    FASTBIT_DLLSPEC int
    fastbit_purge_index(const char *indexLocation, const char* cname);
    FASTBIT_DLLSPEC int fastbit_reorder_partition(const char *dir);

    struct FastBitQuery;
    typedef struct FastBitQuery* FastBitQueryHandle;

    FASTBIT_DLLSPEC FastBitQueryHandle
    fastbit_build_query(const char *selectClause, const char *indexLocation,
                        const char *queryConditions);
    FASTBIT_DLLSPEC int fastbit_destroy_query(FastBitQueryHandle query);

    FASTBIT_DLLSPEC int fastbit_get_result_columns(FastBitQueryHandle query);
    FASTBIT_DLLSPEC int fastbit_get_result_rows(FastBitQueryHandle query);
    FASTBIT_DLLSPEC int fastbit_get_result_row_ids
    (FastBitQueryHandle, uint32_t *);

    FASTBIT_DLLSPEC const char*
    fastbit_get_select_clause(FastBitQueryHandle query);
    FASTBIT_DLLSPEC const char*
    fastbit_get_from_clause(FastBitQueryHandle query);
    FASTBIT_DLLSPEC const char*
    fastbit_get_where_clause(FastBitQueryHandle query);

    FASTBIT_DLLSPEC const float*
    fastbit_get_qualified_floats(FastBitQueryHandle query,
                                 const char* cname);
    FASTBIT_DLLSPEC const double*
    fastbit_get_qualified_doubles(FastBitQueryHandle query,
                                  const char* cname);
    FASTBIT_DLLSPEC const signed char*
    fastbit_get_qualified_bytes(FastBitQueryHandle query,
                                const char* cname);
    FASTBIT_DLLSPEC const int16_t*
    fastbit_get_qualified_shorts(FastBitQueryHandle query,
                                 const char* cname);
    FASTBIT_DLLSPEC const int32_t*
    fastbit_get_qualified_ints(FastBitQueryHandle query,
                               const char* cname);
    FASTBIT_DLLSPEC const int64_t*
    fastbit_get_qualified_longs(FastBitQueryHandle query,
                                const char* cname);
    FASTBIT_DLLSPEC const unsigned char*
    fastbit_get_qualified_ubytes(FastBitQueryHandle query,
                                 const char* cname);
    FASTBIT_DLLSPEC const uint16_t*
    fastbit_get_qualified_ushorts(FastBitQueryHandle query,
                                  const char* cname);
    FASTBIT_DLLSPEC const uint32_t*
    fastbit_get_qualified_uints(FastBitQueryHandle query,
                                const char* cname);
    FASTBIT_DLLSPEC const uint64_t*
    fastbit_get_qualified_ulongs(FastBitQueryHandle query,
                                 const char* cname);
    FASTBIT_DLLSPEC const char**
    fastbit_get_qualified_strings(FastBitQueryHandle query,
                                  const char* cname);
    struct FastBitResultSet;
    typedef struct FastBitResultSet* FastBitResultSetHandle;

    FASTBIT_DLLSPEC FastBitResultSetHandle
    fastbit_build_result_set(FastBitQueryHandle query);
    FASTBIT_DLLSPEC int
    fastbit_destroy_result_set(FastBitResultSetHandle rset);

    FASTBIT_DLLSPEC int fastbit_result_set_next(FastBitResultSetHandle);
    FASTBIT_DLLSPEC int fastbit_result_set_next_bundle(FastBitResultSetHandle);
    FASTBIT_DLLSPEC int
    fastbit_result_set_get_int(FastBitResultSetHandle rset, const char *cname);
    FASTBIT_DLLSPEC unsigned
    fastbit_result_set_get_unsigned(FastBitResultSetHandle rset,
                                    const char *cname);
    FASTBIT_DLLSPEC int64_t
    fastbit_result_set_get_long(FastBitResultSetHandle rset,
                                const char *cname);
    FASTBIT_DLLSPEC float
    fastbit_result_set_get_float(FastBitResultSetHandle rset,
                                 const char *cname);
    FASTBIT_DLLSPEC double
    fastbit_result_set_get_double(FastBitResultSetHandle rset,
                                  const char *cname);
    FASTBIT_DLLSPEC const char*
    fastbit_result_set_get_string(FastBitResultSetHandle rset,
                                  const char *cname);
    FASTBIT_DLLSPEC int32_t
    fastbit_result_set_getInt(FastBitResultSetHandle rset,
                              unsigned position);
    FASTBIT_DLLSPEC uint32_t
    fastbit_result_set_getUnsigned(FastBitResultSetHandle rset,
                                   unsigned position);
    FASTBIT_DLLSPEC int64_t
    fastbit_result_set_getLong(FastBitResultSetHandle rset,
                                unsigned position);
    FASTBIT_DLLSPEC float
    fastbit_result_set_getFloat(FastBitResultSetHandle rset,
                                unsigned position);
    FASTBIT_DLLSPEC double
    fastbit_result_set_getDouble(FastBitResultSetHandle rset,
                                 unsigned position);
    FASTBIT_DLLSPEC const char*
    fastbit_result_set_getString(FastBitResultSetHandle rset,
                                 unsigned position);
    FASTBIT_DLLSPEC int fastbit_flush_buffer(const char *dir);
    FASTBIT_DLLSPEC int
    fastbit_add_values(const char *colname, const char *coltype,
                       void *vals, uint32_t nelem, uint32_t start);
    FASTBIT_DLLSPEC int fastbit_rows_in_partition(const char *dir);
    FASTBIT_DLLSPEC int fastbit_columns_in_partition(const char *dir);

    FASTBIT_DLLSPEC void fastbit_init(const char *rcfile);
    FASTBIT_DLLSPEC void fastbit_cleanup(void);
    FASTBIT_DLLSPEC int  fastbit_set_verbose_level(int v);
    FASTBIT_DLLSPEC int  fastbit_get_verbose_level(void);
    FASTBIT_DLLSPEC int  fastbit_set_logfile(const char* filename);
    FASTBIT_DLLSPEC const char* fastbit_get_logfile();
    FASTBIT_DLLSPEC FILE* fastbit_get_logfilepointer();
    FASTBIT_DLLSPEC double fastbit_read_clock();

    FASTBIT_DLLSPEC const char* fastbit_get_version_string();
    FASTBIT_DLLSPEC int fastbit_get_version_number();
#ifdef __cplusplus
}
#endif

#endif /* ifndef IBIS_CAPI_H */