biohdf_api.h

/*****************************************************************************
 * Copyright by The HDF Group                                                *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of BioHDF.  The full BioHDF copyright notice, including *
 * terms governing use, modification, and redistribution, is contained in    *
 * the file COPYING.  COPYING can be found at the root of the source code    *
 * distribution tree.  If you do not have access to this file, you may       *
 * request a copy from help@hdfgroup.org.                                    *
 *****************************************************************************/

#ifndef _BIOHDF_API_H
#define _BIOHDF_API_H

#include <stdint.h>
#include <inttypes.h>


/*****************************************************************************
 * API header                                                                *
 *****************************************************************************/



#if defined(_WIN32)
    #if defined(LIBBIOHDF_EXPORTS)
        /* When the header file is used in the context of creating the BioHDF
         * dll, we need to label all exported functions "dllexport" so they
         * can be accessed by other software.
         */
        #if defined(__cplusplus)
            #define BIOHDF_API extern "C" __declspec(dllexport)
        #else
            #define BIOHDF_API __declspec(dllexport)
        #endif
    #elif defined(LIBBIOHDF_DLL_IMPORT)
        /* When the header file is used in the context of importing the
         * functions from a dll (the default case), we label them with
         * dllimport.  This is entirely a performance feature (it saves
         * one level of indirection) since I'm not exporting variables,
         * which do require the dllimport.
         */
        #if defined(__cplusplus)
            #define BIOHDF_API extern "C" __declspec(dllimport)
        #else
            #define BIOHDF_API __declspec(dllimport)
        #endif
    #else
        /* Everything else uses undecorated functions */
        #if defined(__cplusplus)
            #define BIOHDF_API extern "C" 
        #else
            #define BIOHDF_API
        #endif
    #endif
#else /* Not Windows */
    #if defined(__cplusplus)
        #define BIOHDF_API extern "C"
    #else
        #define BIOHDF_API
    #endif
#endif



/*****************************************************************************
 * BioHDF Defaults                                                           *
 *****************************************************************************/



#define BIOHDF_MAX_STRING_SIZE 4096



#define BIOHDF_DEFAULT_COMPRESSION_LEVEL 5



#define BIOHDF_DEFAULT_CHUNK_SIZE 1024



/*****************************************************************************
 * BioHDF Type Attribute                                                     *
 *****************************************************************************/



#define BIOHDF_TYPE_ATTR_NAME "BIOHDF_TYPE"



/*****************************************************************************
 * BioHDF Common Structs and Enums                                           *
 *****************************************************************************/



typedef enum
{
    FIXED_LENGTH_STRING,     
    VARIABLE_LENGTH_STRING,  
    HYBRID_STRING,           
} biohdf_string_storage_scheme;



typedef enum _biohdf_open_mode
{
    READ_ONLY = 0,      
    READ_WRITE          
} biohdf_open_mode;



typedef enum
{
    NO_COMPRESSION = 0,   
    GZIP_1 = 1,           
    GZIP_2 = 2,           
    GZIP_3 = 3,           
    GZIP_4 = 4,           
    GZIP_5 = 5,           
    GZIP_6 = 6,           
    GZIP_7 = 7,           
    GZIP_8 = 8,           
    GZIP_9 = 9            
}
compression_level;



#endif