Content-Security-Policy: default-src 'none'
Content-Type: text/plain; charset=UTF-8
Content-Length: 54965
Content-Disposition: inline; filename="H5Znbit.c"
Last-Modified: Fri, 19 Jul 2024 16:26:54 GMT
Expires: Mon, 17 Jul 2034 16:26:54 GMT
ETag: "ff3ead2d0b1daf9187f8131267c270887798c147"
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#define H5Z_PACKAGE /*suppress error about including H5Zpkg */
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5Iprivate.h" /* IDs */
#include "H5MMprivate.h" /* Memory management */
#include "H5Ppublic.h" /* Property lists */
#include "H5Oprivate.h" /* Object headers */
#include "H5Sprivate.h" /* Dataspaces */
#include "H5Tprivate.h" /* Datatypes */
#include "H5Zpkg.h" /* Data filters */
/* Struct of parameters needed for compressing/decompressing
* one nbit atomic datatype: integer or floating-point
*/
typedef struct {
size_t size; /* size of datatype */
int order; /* datatype endianness order */
int precision; /* datatype precision */
int offset; /* datatype offset */
} parms_atomic;
/* Local function prototypes */
static htri_t H5Z_can_apply_nbit(hid_t dcpl_id, hid_t type_id, hid_t space_id);
static herr_t H5Z_set_local_nbit(hid_t dcpl_id, hid_t type_id, hid_t space_id);
static size_t H5Z_filter_nbit(unsigned flags, size_t cd_nelmts, const unsigned cd_values[],
size_t nbytes, size_t *buf_size, void **buf);
static void H5Z_calc_parms_nooptype(void);
static void H5Z_calc_parms_atomic(void);
static herr_t H5Z_calc_parms_array(const H5T_t *type);
static herr_t H5Z_calc_parms_compound(const H5T_t *type);
static herr_t H5Z_set_parms_nooptype(const H5T_t *type, unsigned cd_values[]);
static herr_t H5Z_set_parms_atomic(const H5T_t *type, unsigned cd_values[]);
static herr_t H5Z_set_parms_array(const H5T_t *type, unsigned cd_values[]);
static herr_t H5Z_set_parms_compound(const H5T_t *type, unsigned cd_values[]);
static void H5Z_nbit_next_byte(size_t *j, int *buf_len);
static void H5Z_nbit_decompress_one_byte(unsigned char *data, size_t data_offset, int k, int begin_i,
int end_i, unsigned char *buffer, size_t *j, int *buf_len, parms_atomic p, int datatype_len);
static void H5Z_nbit_compress_one_byte(unsigned char *data, size_t data_offset, int k, int begin_i,
int end_i, unsigned char *buffer, size_t *j, int *buf_len, parms_atomic p, int datatype_len);
static void H5Z_nbit_decompress_one_nooptype(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, unsigned size);
static void H5Z_nbit_decompress_one_atomic(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, parms_atomic p);
static void H5Z_nbit_decompress_one_array(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, const unsigned parms[]);
static void H5Z_nbit_decompress_one_compound(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, const unsigned parms[]);
static void H5Z_nbit_decompress(unsigned char *data, unsigned d_nelmts, unsigned char *buffer,
const unsigned parms[]);
static void H5Z_nbit_compress_one_nooptype(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, unsigned size);
static void H5Z_nbit_compress_one_atomic(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, parms_atomic p);
static void H5Z_nbit_compress_one_array(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, const unsigned parms[]);
static void H5Z_nbit_compress_one_compound(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, const unsigned parms[]);
static void H5Z_nbit_compress(unsigned char *data, unsigned d_nelmts, unsigned char *buffer,
size_t *buffer_size, const unsigned parms[]);
/* This message derives from H5Z */
H5Z_class2_t H5Z_NBIT[1] = {{
H5Z_CLASS_T_VERS, /* H5Z_class_t version */
H5Z_FILTER_NBIT, /* Filter id number */
1, /* Assume encoder present: check before registering */
1, /* decoder_present flag (set to true) */
"nbit", /* Filter name for debugging */
H5Z_can_apply_nbit, /* The "can apply" callback */
H5Z_set_local_nbit, /* The "set local" callback */
H5Z_filter_nbit, /* The actual filter function */
}};
/* Local macros */
#define H5Z_NBIT_ATOMIC 1 /* Atomic datatype class: integer/floating-point */
#define H5Z_NBIT_ARRAY 2 /* Array datatype class */
#define H5Z_NBIT_COMPOUND 3 /* Compound datatype class */
#define H5Z_NBIT_NOOPTYPE 4 /* Other datatype class: nbit does no compression */
#define H5Z_NBIT_MAX_NPARMS 4096 /* Max number of parameters for filter */
#define H5Z_NBIT_ORDER_LE 0 /* Little endian for datatype byte order */
#define H5Z_NBIT_ORDER_BE 1 /* Big endian for datatype byte order */
/* Local variables */
/*
* cd_values_index: index of array cd_values inside function H5Z_set_local_nbit
* cd_values_actual_nparms: number of parameters in array cd_values[]
* need_not_compress: flag if TRUE indicating no need to do nbit compression
* parms_index: index of array parms used by compression/decompression functions
*/
static unsigned cd_values_index = 0;
static size_t cd_values_actual_nparms = 0;
static unsigned char need_not_compress = FALSE;
static unsigned parms_index = 0;
/*-------------------------------------------------------------------------
* Function: H5Z_can_apply_nbit
*
* Purpose: Check the parameters for nbit compression for validity and
* whether they fit a particular dataset.
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Xiaowen Wu
* Tuesday, December 21, 2004
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static htri_t
H5Z_can_apply_nbit(hid_t UNUSED dcpl_id, hid_t type_id, hid_t UNUSED space_id)
{
const H5T_t *type; /* Datatype */
htri_t ret_value = TRUE; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Get datatype */
if(NULL == (type = (H5T_t *)H5I_object_verify(type_id, H5I_DATATYPE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a datatype")
/* Get datatype's class, for checking the "datatype class" */
if(H5T_get_class(type, TRUE) == H5T_NO_CLASS)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype class")
/* Get datatype's size, for checking the "datatype size" */
if(H5T_get_size(type) == 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype size")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5Z_can_apply_nbit() */
/*-------------------------------------------------------------------------
* Function: H5Z_calc_parms_nooptype
*
* Purpose: Calculate the number of parameters of array cd_values[]
* of datatype that is not integer, nor floating-point, nor
* compound, and nor array.
*
* Programmer: Xiaowen Wu
* Thursday, March 3, 2005
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static void H5Z_calc_parms_nooptype(void)
{
/* Store datatype class code */
++cd_values_actual_nparms;
/* Store datatype size */
++cd_values_actual_nparms;
}
/*-------------------------------------------------------------------------
* Function: H5Z_calc_parms_atomic
*
* Purpose: Calculate the number of parameters of array cd_values[]
* of atomic datatype whose datatype class is integer
* or floating point
*
* Programmer: Xiaowen Wu
* Saturday, January 29, 2005
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static void H5Z_calc_parms_atomic(void)
{
/* Store datatype class code */
++cd_values_actual_nparms;
/* Store datatype size */
++cd_values_actual_nparms;
/* Store datatype endianness */
++cd_values_actual_nparms;
/* Store datatype's precision */
++cd_values_actual_nparms;
/* Store datatype's offset */
++cd_values_actual_nparms;
}
/*-------------------------------------------------------------------------
* Function: H5Z_calc_parms_array
*
* Purpose: Calculate the number of parameters of array cd_values[]
* for a given datatype identifier type_id
* if its datatype class is array datatype
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Xiaowen Wu
* Wednesday, January 19, 2005
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5Z_calc_parms_array(const H5T_t *type)
{
H5T_t *dtype_base = NULL; /* Array datatype's base datatype */
H5T_class_t dtype_base_class; /* Array datatype's base datatype's class */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Store datatype class code */
++cd_values_actual_nparms;
/* Store array datatype's size */
++cd_values_actual_nparms;
/* Get array datatype's base datatype */
if(NULL == (dtype_base = H5T_get_super(type)))
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad base datatype")
/* Get base datatype's class */
if((dtype_base_class = H5T_get_class(dtype_base, TRUE)) == H5T_NO_CLASS)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad base datatype class")
/* Calculate number of the rest parameters according to base datatype's class */
switch(dtype_base_class) {
case H5T_INTEGER:
case H5T_FLOAT:
H5Z_calc_parms_atomic();
break;
case H5T_ARRAY:
if(H5Z_calc_parms_array(dtype_base) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot compute parameters for datatype")
break;
case H5T_COMPOUND:
if(H5Z_calc_parms_compound(dtype_base) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot compute parameters for datatype")
break;
default: /* Other datatype class: nbit does no compression */
H5Z_calc_parms_nooptype();
break;
} /* end switch */
done:
if(dtype_base)
if(H5T_close(dtype_base) < 0)
HDONE_ERROR(H5E_PLINE, H5E_CLOSEERROR, FAIL, "Unable to close base datatype")
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5Z_calc_parms_array() */
/*-------------------------------------------------------------------------
* Function: H5Z_calc_parms_compound
*
* Purpose: Calculate the number of parameters of array cd_values[]
* for a given datatype identifier type_id
* if its datatype class is compound datatype
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Xiaowen Wu
* Wednesday, January 19, 2005
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5Z_calc_parms_compound(const H5T_t *type)
{
int nmembers; /* Compound datatype's number of members */
H5T_t *dtype_member = NULL; /* Compound datatype's member datatype */
H5T_class_t dtype_member_class; /* Compound datatype's member datatype's class */
unsigned u; /* Local index variable */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Store compound datatype class code */
++cd_values_actual_nparms;
/* Store compound datatype's size */
++cd_values_actual_nparms;
/* Get number of members */
if((nmembers = H5T_get_nmembers(type)) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype number of members")
/* Store number of members */
++cd_values_actual_nparms;
/* For each member, calculate parameters */
for(u = 0; u < (unsigned)nmembers; u++) {
/* Get member datatype */
if(NULL == (dtype_member = H5T_get_member_type(type, u, H5T_COPY_TRANSIENT)))
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad member datatype")
/* Get member datatype's class */
if((dtype_member_class = H5T_get_class(dtype_member, TRUE)) == H5T_NO_CLASS)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad member datatype class")
/* Store member offset */
++cd_values_actual_nparms;
/* Calculate parameters according to member's datatype class */
switch(dtype_member_class) {
case H5T_INTEGER:
case H5T_FLOAT:
H5Z_calc_parms_atomic();
break;
case H5T_ARRAY:
if(H5Z_calc_parms_array(dtype_member) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot compute parameters for datatype")
break;
case H5T_COMPOUND:
if(H5Z_calc_parms_compound(dtype_member) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot compute parameters for datatype")
break;
default: /* Other datatype class: nbit does no compression */
H5Z_calc_parms_nooptype();
break;
} /* end switch */
/* Close member datatype */
if(H5T_close(dtype_member) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_CLOSEERROR, FAIL, "Unable to close member datatype")
dtype_member = NULL;
} /* end for */
done:
if(dtype_member)
if(H5T_close(dtype_member) < 0)
HDONE_ERROR(H5E_PLINE, H5E_CLOSEERROR, FAIL, "Unable to close member datatype")
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5Z_calc_params_compound */
/*-------------------------------------------------------------------------
* Function: H5Z_set_parms_nooptype
*
* Purpose: Set the array cd_values[] for a given datatype identifier
* type_id if its datatype class is not integer, nor
* floating-point, nor array, nor compound, nor VL datatype,
* and nor VL string
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Xiaowen Wu
* Tuesday, April 5, 2005
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5Z_set_parms_nooptype(const H5T_t *type, unsigned cd_values[])
{
size_t dtype_size; /* No-op datatype's size (in bytes) */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Set datatype class code */
cd_values[cd_values_index++] = H5Z_NBIT_NOOPTYPE;
/* Get datatype's size */
if((dtype_size = H5T_get_size(type)) == 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype size")
/* Set "local" parameter for datatype size */
cd_values[cd_values_index++] = dtype_size;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5Z_set_parms_nooptype() */
/*-------------------------------------------------------------------------
* Function: H5Z_set_parms_atomic
*
* Purpose: Set the array cd_values[] for a given datatype identifier
* type_id if its datatype class is integer or floating point
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Xiaowen Wu
* Tuesday, January 11, 2005
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5Z_set_parms_atomic(const H5T_t *type, unsigned cd_values[])
{
H5T_order_t dtype_order; /* Atomic datatype's endianness order */
size_t dtype_size; /* Atomic datatype's size (in bytes) */
size_t dtype_precision; /* Atomic datatype's precision (in bits) */
int dtype_offset; /* Atomic datatype's offset (in bits) */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Set datatype class code */
cd_values[cd_values_index++] = H5Z_NBIT_ATOMIC;
/* Get datatype's size */
if((dtype_size = H5T_get_size(type)) == 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype size")
/* Set "local" parameter for datatype size */
cd_values[cd_values_index++] = dtype_size;
/* Get datatype's endianness order */
if((dtype_order = H5T_get_order(type)) == H5T_ORDER_ERROR)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype endianness order")
/* Set "local" parameter for datatype endianness */
switch(dtype_order) {
case H5T_ORDER_LE: /* Little-endian byte order */
cd_values[cd_values_index++] = H5Z_NBIT_ORDER_LE;
break;
case H5T_ORDER_BE: /* Big-endian byte order */
cd_values[cd_values_index++] = H5Z_NBIT_ORDER_BE;
break;
default:
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype endianness order")
} /* end switch */
/* Get datatype's precision */
if((dtype_precision = H5T_get_precision(type)) == 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype precision")
/* Get datatype's offset */
if((dtype_offset = H5T_get_offset(type)) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype offset")
/* Check values of precision and offset */
if(dtype_precision > dtype_size * 8 || (dtype_precision + dtype_offset) > dtype_size * 8
|| dtype_precision <= 0 || dtype_offset < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "invalid datatype precision/offset")
/* Set "local" parameter for datatype precision */
cd_values[cd_values_index++] = dtype_precision;
/* Set "local" parameter for datatype offset */
cd_values[cd_values_index++] = dtype_offset;
/* If before this point, there is no need to compress, check the need to
* compress at this point. If current datatype is not full-precision,
* flag need_not_compress should be set to FALSE.
*/
if(need_not_compress) /* so far no need to compress */
if(dtype_offset != 0 || dtype_precision != dtype_size * 8)
need_not_compress = FALSE;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5Z_set_parms_atomic() */
/*-------------------------------------------------------------------------
* Function: H5Z_set_parms_array
*
* Purpose: Set the array cd_values[] for a given datatype identifier
* type_id if its datatype class is array datatype
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Xiaowen Wu
* Tuesday, April 5, 2005
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5Z_set_parms_array(const H5T_t *type, unsigned cd_values[])
{
H5T_t *dtype_base = NULL; /* Array datatype's base datatype */
H5T_class_t dtype_base_class; /* Array datatype's base datatype's class */
size_t dtype_size; /* Array datatype's size (in bytes) */
htri_t is_vlstring; /* flag indicating if datatype is varible-length string */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Set datatype class code */
cd_values[cd_values_index++] = H5Z_NBIT_ARRAY;
/* Get array datatype's size */
if((dtype_size = H5T_get_size(type)) == 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype size")
/* Set "local" parameter for array datatype's size */
cd_values[cd_values_index++]=dtype_size;
/* Get array datatype's base datatype */
if(NULL == (dtype_base = H5T_get_super(type)))
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad base datatype")
/* Get base datatype's class */
if((dtype_base_class = H5T_get_class(dtype_base, TRUE)) == H5T_NO_CLASS)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad base datatype class")
/* Call appropriate function according to base datatype's class */
switch(dtype_base_class) {
case H5T_INTEGER:
case H5T_FLOAT:
if(H5Z_set_parms_atomic(dtype_base, cd_values) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
case H5T_ARRAY:
if(H5Z_set_parms_array(dtype_base, cd_values) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
case H5T_COMPOUND:
if(H5Z_set_parms_compound(dtype_base, cd_values) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
default: /* other datatype that nbit does no compression */
/* Check if base datatype is a variable-length string */
if((is_vlstring = H5T_is_variable_str(dtype_base)) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "cannot determine if datatype is a variable-length string")
/* base datatype of VL or VL-string is not supported */
if(dtype_base_class == H5T_VLEN || is_vlstring)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "datatype not supported by nbit")
if(H5Z_set_parms_nooptype(dtype_base, cd_values) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
} /* end switch */
done:
if(dtype_base)
if(H5T_close(dtype_base) < 0)
HDONE_ERROR(H5E_PLINE, H5E_CLOSEERROR, FAIL, "Unable to close base datatype")
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5Z_set_parms_array() */
/*-------------------------------------------------------------------------
* Function: H5Z_set_parms_compound
*
* Purpose: Set the array cd_values[] for a given datatype identifier
* type_id if its datatype class is compound datatype
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Xiaowen Wu
* Tuesday, April 5, 2005
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5Z_set_parms_compound(const H5T_t *type, unsigned cd_values[])
{
int nmembers; /* Compound datatype's number of members */
H5T_t *dtype_member = NULL; /* Compound datatype's member datatype */
H5T_class_t dtype_member_class; /* Compound datatype's member datatype's class */
size_t dtype_member_offset; /* Compound datatype's current member datatype's offset (in bytes) */
size_t dtype_next_member_offset;/* Compound datatype's next member datatype's offset (in bytes) */
size_t dtype_size; /* Compound datatype's size (in bytes) */
htri_t is_vlstring; /* flag indicating if datatype is varible-length string */
unsigned u; /* Local index variable */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Set "local" parameter for compound datatype class code */
cd_values[cd_values_index++] = H5Z_NBIT_COMPOUND;
/* Get datatype's size */
if((dtype_size = H5T_get_size(type)) == 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype size")
/* Set "local" parameter for compound datatype size */
cd_values[cd_values_index++] = dtype_size;
/* Get number of members */
if((nmembers = H5T_get_nmembers(type)) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype number of members")
/* Set "local" parameter for number of members */
cd_values[cd_values_index++] = nmembers;
/* For each member, set parameters */
for(u = 0; u < (unsigned)nmembers; u++) {
/* Get member datatype */
if(NULL == (dtype_member = H5T_get_member_type(type, u, H5T_COPY_TRANSIENT)))
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad member datatype")
/* Get member datatype's class */
if((dtype_member_class = H5T_get_class(dtype_member, TRUE)) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad member datatype class")
/* Get member offset, success if H5T_get_class() success */
dtype_member_offset = H5T_get_member_offset(type, u);
/* Set "local" parameter for member offset */
cd_values[cd_values_index++] = dtype_member_offset;
/* Call appropriate function according to member's datatype class */
switch(dtype_member_class) {
case H5T_INTEGER:
case H5T_FLOAT:
if(H5Z_set_parms_atomic(dtype_member, cd_values) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
case H5T_ARRAY:
if(H5Z_set_parms_array(dtype_member, cd_values) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
case H5T_COMPOUND:
if(H5Z_set_parms_compound(dtype_member, cd_values) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
default: /* other datatype that nbit does no compression */
/* Check if datatype is a variable-length string */
if((is_vlstring = H5T_is_variable_str(dtype_member)) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "cannot determine if datatype is a variable-length string")
/* Because for some no-op datatype (VL datatype and VL string datatype), its
* size can not be retrieved correctly by using function call H5T_get_size,
* special handling is needed for getting the size. Here the difference between
* adjacent member offset is used (if alignment is present, the result can be
* larger, but it does not affect the nbit filter's correctness).
*/
if(dtype_member_class == H5T_VLEN || is_vlstring) {
/* Set datatype class code */
cd_values[cd_values_index++] = H5Z_NBIT_NOOPTYPE;
if(u != (unsigned)nmembers - 1)
dtype_next_member_offset = H5T_get_member_offset(type, u + 1);
else /* current member is the last member */
dtype_next_member_offset = dtype_size;
/* Set "local" parameter for datatype size */
cd_values[cd_values_index++] = dtype_next_member_offset - dtype_member_offset;
} else
if(H5Z_set_parms_nooptype(dtype_member, cd_values)==FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
} /* end switch */
/* Close member datatype */
if(H5T_close(dtype_member) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_CLOSEERROR, FAIL, "Unable to close member datatype")
dtype_member = NULL;
} /* end for */
done:
if(dtype_member)
if(H5T_close(dtype_member) < 0)
HDONE_ERROR(H5E_PLINE, H5E_CLOSEERROR, FAIL, "Unable to close member datatype")
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5Z_set_params_compound */
/*-------------------------------------------------------------------------
* Function: H5Z_set_local_nbit
*
* Purpose: Set the "local" dataset parameters for nbit compression.
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Xiaowen Wu
* Tuesday, January 11, 2005
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5Z_set_local_nbit(hid_t dcpl_id, hid_t type_id, hid_t space_id)
{
H5P_genplist_t *dcpl_plist; /* Property list pointer */
const H5T_t *type; /* Datatype */
const H5S_t *ds; /* Dataspace */
unsigned flags; /* Filter flags */
size_t cd_nelmts = H5Z_NBIT_USER_NPARMS; /* Number of filter parameters */
unsigned *cd_values = NULL; /* Filter parameters */
hssize_t npoints; /* Number of points in the dataspace */
H5T_class_t dtype_class; /* Datatype's class */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Get datatype */
if(NULL == (type = (H5T_t *)H5I_object_verify(type_id, H5I_DATATYPE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a datatype")
/* Get datatype's class */
if((dtype_class = H5T_get_class(type, TRUE)) == H5T_NO_CLASS)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "bad datatype class")
/* Calculate how many parameters will fill the cd_values array
* First three parameters reserved for:
* 1. number of parameters in array cd_values
* 2. flag if TRUE indicating no need to do nbit compression
* 3. number of elements in the chunk
*/
cd_values_actual_nparms = 3;
switch(dtype_class) {
case H5T_INTEGER:
case H5T_FLOAT:
H5Z_calc_parms_atomic();
break;
case H5T_ARRAY:
if(H5Z_calc_parms_array(type) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot compute parameters for datatype")
break;
case H5T_COMPOUND:
if(H5Z_calc_parms_compound(type) == FAIL)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot compute parameters for datatype")
break;
default: /* no need to calculate other datatypes at top level */
break;
} /* end switch */
/* Check if the number of parameters exceed what cd_values[] can store */
if(cd_values_actual_nparms > H5Z_NBIT_MAX_NPARMS)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "datatype needs too many nbit parameters")
/* Allocate memory space for cd_values[] */
if(NULL == (cd_values = (unsigned *)H5MM_malloc(cd_values_actual_nparms * sizeof(unsigned))))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed for cd_values[]")
/* Get the plist structure */
if(NULL == (dcpl_plist = H5P_object_verify(dcpl_id, H5P_DATASET_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get the filter's current parameters */
if(H5P_get_filter_by_id(dcpl_plist, H5Z_FILTER_NBIT, &flags, &cd_nelmts, cd_values, (size_t)0, NULL, NULL) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_CANTGET, FAIL, "can't get nbit parameters")
/* Get dataspace */
if(NULL == (ds = (H5S_t *)H5I_object_verify(space_id, H5I_DATASPACE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space")
/* Get total number of elements in the chunk */
if((npoints = H5S_GET_EXTENT_NPOINTS(ds)) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_CANTGET, FAIL, "unable to get number of points in the dataspace")
HDassert(npoints);
/* Initialize index for cd_values array starting from the third entry */
cd_values_index = 2;
/* Set "local" parameter for number of elements in the chunk */
H5_CHECKED_ASSIGN(cd_values[cd_values_index++], unsigned, npoints, hssize_t);
/* Assume no need to compress now, will be changed to FALSE later if not */
need_not_compress = TRUE;
/* Call appropriate function according to the datatype class */
switch(dtype_class) {
case H5T_INTEGER:
case H5T_FLOAT:
if(H5Z_set_parms_atomic(type, cd_values) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
case H5T_ARRAY:
if(H5Z_set_parms_array(type, cd_values) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
case H5T_COMPOUND:
if(H5Z_set_parms_compound(type, cd_values) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_BADTYPE, FAIL, "nbit cannot set parameters for datatype")
break;
default: /* no need to set parameters for other datatypes at top level */
break;
} /* end switch */
/* Check if calculation of parameters matches with setting of parameters */
HDassert(cd_values_actual_nparms == cd_values_index);
/* Finally set the first two entries of cd_values[] */
cd_values[0] = cd_values_actual_nparms;
cd_values[1] = need_not_compress;
/* Modify the filter's parameters for this dataset */
if(H5P_modify_filter(dcpl_plist, H5Z_FILTER_NBIT, flags, cd_values_actual_nparms, cd_values) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_CANTSET, FAIL, "can't set local nbit parameters")
done:
if(cd_values)
H5MM_xfree(cd_values);
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5Z_set_local_nbit() */
/*-------------------------------------------------------------------------
* Function: H5Z_filter_nbit
*
* Purpose: Implement an I/O filter for storing packed nbit data
*
* Return: Success: Size of buffer filtered
* Failure: 0
*
* Programmer: Xiaowen Wu
* Friday, January 21, 2005
*
*-------------------------------------------------------------------------
*/
static size_t
H5Z_filter_nbit(unsigned flags, size_t cd_nelmts, const unsigned cd_values[],
size_t nbytes, size_t *buf_size, void **buf)
{
unsigned char *outbuf; /* pointer to new output buffer */
size_t size_out = 0; /* size of output buffer */
unsigned d_nelmts = 0; /* number of elements in the chunk */
size_t ret_value = 0; /* return value */
FUNC_ENTER_NOAPI_NOINIT
/* check arguments
* cd_values[0] stores actual number of parameters in cd_values[]
*/
if(cd_nelmts != cd_values[0])
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, 0, "invalid nbit aggression level")
/* check if need to do nbit compress or decompress
* cd_values[1] stores the flag if true indicating no need to compress
*/
if(cd_values[1])
HGOTO_DONE(*buf_size)
/* copy a filter parameter to d_nelmts */
d_nelmts = cd_values[2];
/* input; decompress */
if(flags & H5Z_FLAG_REVERSE) {
size_out = d_nelmts * cd_values[4]; /* cd_values[4] stores datatype size */
/* allocate memory space for decompressed buffer */
if(NULL == (outbuf = (unsigned char *)H5MM_malloc(size_out)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, 0, "memory allocation failed for nbit decompression")
/* decompress the buffer */
H5Z_nbit_decompress(outbuf, d_nelmts, (unsigned char *)*buf, cd_values);
} /* end if */
/* output; compress */
else {
HDassert(nbytes == d_nelmts * cd_values[4]);
size_out = nbytes;
/* allocate memory space for compressed buffer */
if(NULL == (outbuf = (unsigned char *)H5MM_malloc(size_out)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, 0, "memory allocation failed for nbit compression")
/* compress the buffer, size_out will be changed */
H5Z_nbit_compress((unsigned char *)*buf, d_nelmts, outbuf, &size_out, cd_values);
} /* end else */
/* free the input buffer */
H5MM_xfree(*buf);
/* set return values */
*buf = outbuf;
*buf_size = size_out;
ret_value = size_out;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5Z_filter_nbit() */
/* ======== Nbit Algorithm ===============================================
* assume one byte has 8 bit
* assume padding bit is 0
* assume size of unsigned char is one byte
* assume one data item of certain datatype is stored continously in bytes
* atomic datatype is treated on byte basis
*/
static void
H5Z_nbit_next_byte(size_t *j, int *buf_len)
{
++(*j);
*buf_len = 8 * sizeof(unsigned char);
}
static void
H5Z_nbit_decompress_one_byte(unsigned char *data, size_t data_offset, int k,
int begin_i, int end_i, unsigned char *buffer, size_t *j, int *buf_len,
parms_atomic p, int datatype_len)
{
int dat_len; /* dat_len is the number of bits to be copied in each data byte */
int uchar_offset;
unsigned char val; /* value to be copied in each data byte */
/* initialize value and bits of unsigned char to be copied */
val = buffer[*j];
uchar_offset = 0;
if(begin_i != end_i) { /* significant bits occupy >1 unsigned char */
if(k == begin_i)
dat_len = 8 - (datatype_len - p.precision - p.offset) % 8;
else if(k == end_i) {
dat_len = 8 - p.offset %8;
uchar_offset = 8 - dat_len;
}
else
dat_len = 8;
} else { /* all significant bits in one unsigned char */
uchar_offset = p.offset % 8;
dat_len = p.precision;
}
if(*buf_len > dat_len) {
data[data_offset + k] =
((val >> (*buf_len - dat_len)) & ~(~0 << dat_len)) << uchar_offset;
*buf_len -= dat_len;
} else {
data[data_offset + k] =
((val & ~(~0 << *buf_len)) << (dat_len - *buf_len)) << uchar_offset;
dat_len -= *buf_len;
H5Z_nbit_next_byte(j, buf_len);
if(dat_len == 0) return;
val = buffer[*j];
data[data_offset + k] |=
((val >> (*buf_len - dat_len)) & ~(~0 << dat_len)) << uchar_offset;
*buf_len -= dat_len;
}
}
static void
H5Z_nbit_decompress_one_nooptype(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, unsigned size)
{
unsigned i; /* index */
unsigned dat_len; /* dat_len is the number of bits to be copied in each data byte */
unsigned char val; /* value to be copied in each data byte */
for(i = 0; i < size; i++) {
/* initialize value and bits of unsigned char to be copied */
val = buffer[*j];
dat_len = sizeof(unsigned char) * 8;
data[data_offset + i] = ((val & ~(~0 << *buf_len)) << (dat_len - *buf_len));
dat_len -= *buf_len;
H5Z_nbit_next_byte(j, buf_len);
if(dat_len == 0) continue;
val = buffer[*j];
data[data_offset + i] |= ((val >> (*buf_len - dat_len)) & ~(~0 << dat_len));
*buf_len -= dat_len;
}
}
static void
H5Z_nbit_decompress_one_atomic(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, parms_atomic p)
{
/* begin_i: the index of byte having first significant bit
end_i: the index of byte having last significant bit */
int k, begin_i, end_i, datatype_len;
datatype_len = p.size * 8;
if(p.order == H5Z_NBIT_ORDER_LE) { /* little endian */
/* calculate begin_i and end_i */
if((p.precision + p.offset) % 8 != 0)
begin_i = (p.precision + p.offset) / 8;
else
begin_i = (p.precision + p.offset) / 8 - 1;
end_i = p.offset / 8;
for(k = begin_i; k >= end_i; k--)
H5Z_nbit_decompress_one_byte(data, data_offset, k, begin_i, end_i,
buffer, j, buf_len, p, datatype_len);
}
if(p.order == H5Z_NBIT_ORDER_BE) { /* big endian */
/* calculate begin_i and end_i */
begin_i = (datatype_len - p.precision - p.offset) / 8;
if(p.offset % 8 != 0)
end_i = (datatype_len - p.offset) / 8;
else
end_i = (datatype_len - p.offset) / 8 - 1;
for(k = begin_i; k <= end_i; k++)
H5Z_nbit_decompress_one_byte(data, data_offset, k, begin_i, end_i,
buffer, j, buf_len, p, datatype_len);
}
}
static void
H5Z_nbit_decompress_one_array(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, const unsigned parms[])
{
unsigned i, total_size, base_class, base_size, n, begin_index;
parms_atomic p;
total_size = parms[parms_index++];
base_class = parms[parms_index++];
switch(base_class) {
case H5Z_NBIT_ATOMIC:
p.size = parms[parms_index++];
p.order = parms[parms_index++];
p.precision = parms[parms_index++];
p.offset = parms[parms_index++];
n = total_size/p.size;
for(i = 0; i < n; i++)
H5Z_nbit_decompress_one_atomic(data, data_offset + i*p.size,
buffer, j, buf_len, p);
break;
case H5Z_NBIT_ARRAY:
base_size = parms[parms_index]; /* read in advance */
n = total_size/base_size; /* number of base_type elements inside the array datatype */
begin_index = parms_index;
for(i = 0; i < n; i++) {
H5Z_nbit_decompress_one_array(data, data_offset + i*base_size,
buffer, j, buf_len, parms);
parms_index = begin_index;
}
break;
case H5Z_NBIT_COMPOUND:
base_size = parms[parms_index]; /* read in advance */
n = total_size/base_size; /* number of base_type elements inside the array datatype */
begin_index = parms_index;
for(i = 0; i < n; i++) {
H5Z_nbit_decompress_one_compound(data, data_offset + i*base_size,
buffer, j, buf_len, parms);
parms_index = begin_index;
}
break;
case H5Z_NBIT_NOOPTYPE:
parms_index++; /* skip size of no-op type */
H5Z_nbit_decompress_one_nooptype(data, data_offset, buffer, j, buf_len, total_size);
break;
default:
HDassert(0 && "This Should never be executed!");
} /* end switch */
}
static void
H5Z_nbit_decompress_one_compound(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, const unsigned parms[])
{
unsigned i, nmembers, member_offset, member_class, size;
parms_atomic p;
parms_index++; /* skip total size of compound datatype */
nmembers = parms[parms_index++];
for(i = 0; i < nmembers; i++) {
member_offset = parms[parms_index++];
member_class = parms[parms_index++];
switch(member_class) {
case H5Z_NBIT_ATOMIC:
p.size = parms[parms_index++];
p.order = parms[parms_index++];
p.precision = parms[parms_index++];
p.offset = parms[parms_index++];
H5Z_nbit_decompress_one_atomic(data, data_offset + member_offset,
buffer, j, buf_len, p);
break;
case H5Z_NBIT_ARRAY:
H5Z_nbit_decompress_one_array(data, data_offset + member_offset,
buffer, j, buf_len, parms);
break;
case H5Z_NBIT_COMPOUND:
H5Z_nbit_decompress_one_compound(data, data_offset+member_offset,
buffer, j, buf_len, parms);
break;
case H5Z_NBIT_NOOPTYPE:
size = parms[parms_index++];
H5Z_nbit_decompress_one_nooptype(data, data_offset+member_offset,
buffer, j, buf_len, size);
break;
default:
HDassert(0 && "This Should never be executed!");
} /* end switch */
}
}
static void
H5Z_nbit_decompress(unsigned char *data, unsigned d_nelmts, unsigned char *buffer,
const unsigned parms[])
{
/* i: index of data, j: index of buffer,
buf_len: number of bits to be filled in current byte */
size_t i, j, size;
int buf_len;
parms_atomic p;
/* may not have to initialize to zeros */
for(i = 0; i < d_nelmts*parms[4]; i++) data[i] = 0;
/* initialization before the loop */
j = 0;
buf_len = sizeof(unsigned char) * 8;
switch(parms[3]) {
case H5Z_NBIT_ATOMIC:
/* set the index before goto function call */
p.size = parms[4];
p.order = parms[5];
p.precision = parms[6];
p.offset = parms[7];
for(i = 0; i < d_nelmts; i++) {
H5Z_nbit_decompress_one_atomic(data, i*p.size, buffer, &j, &buf_len, p);
}
break;
case H5Z_NBIT_ARRAY:
size = parms[4];
parms_index = 4;
for(i = 0; i < d_nelmts; i++) {
H5Z_nbit_decompress_one_array(data, i*size, buffer, &j, &buf_len, parms);
parms_index = 4;
}
break;
case H5Z_NBIT_COMPOUND:
size = parms[4];
parms_index = 4;
for(i = 0; i < d_nelmts; i++) {
H5Z_nbit_decompress_one_compound(data, i*size, buffer, &j, &buf_len, parms);
parms_index = 4;
}
break;
default:
HDassert(0 && "This Should never be executed!");
} /* end switch */
}
static void H5Z_nbit_compress_one_byte(unsigned char *data, size_t data_offset, int k, int begin_i,
int end_i, unsigned char *buffer, size_t *j, int *buf_len, parms_atomic p, int datatype_len)
{
int dat_len; /* dat_len is the number of bits to be copied in each data byte */
unsigned char val; /* value to be copied in each data byte */
/* initialize value and bits of unsigned char to be copied */
val = data[data_offset + k];
if(begin_i != end_i) { /* significant bits occupy >1 unsigned char */
if(k == begin_i)
dat_len = 8 - (datatype_len - p.precision - p.offset) % 8;
else if(k == end_i) {
dat_len = 8 - p.offset % 8;
val >>= 8 - dat_len;
}
else
dat_len = 8;
} else { /* all significant bits in one unsigned char */
val >>= p.offset % 8;
dat_len = p.precision;
}
if(*buf_len > dat_len) {
buffer[*j] |= (val & ~(~0 << dat_len)) << (*buf_len - dat_len);
*buf_len -= dat_len;
} else {
buffer[*j] |= (val >> (dat_len - *buf_len)) & ~(~0 << *buf_len);
dat_len -= *buf_len;
H5Z_nbit_next_byte(j, buf_len);
if(dat_len == 0) return;
buffer[*j] = (val & ~(~0 << dat_len)) << (*buf_len - dat_len);
*buf_len -= dat_len;
}
}
static void H5Z_nbit_compress_one_nooptype(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, unsigned size)
{
unsigned i; /* index */
unsigned dat_len; /* dat_len is the number of bits to be copied in each data byte */
unsigned char val; /* value to be copied in each data byte */
for(i = 0; i < size; i++) {
/* initialize value and bits of unsigned char to be copied */
val = data[data_offset + i];
dat_len = sizeof(unsigned char) * 8;
buffer[*j] |= (val >> (dat_len - *buf_len)) & ~(~0 << *buf_len);
dat_len -= *buf_len;
H5Z_nbit_next_byte(j, buf_len);
if(dat_len == 0) continue;
buffer[*j] = (val & ~(~0 << dat_len)) << (*buf_len - dat_len);
*buf_len -= dat_len;
}
}
static void H5Z_nbit_compress_one_atomic(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, parms_atomic p)
{
/* begin_i: the index of byte having first significant bit
end_i: the index of byte having last significant bit */
int k, begin_i, end_i, datatype_len;
datatype_len = p.size * 8;
if(p.order == H5Z_NBIT_ORDER_LE) { /* little endian */
/* calculate begin_i and end_i */
if((p.precision + p.offset) % 8 != 0)
begin_i = (p.precision + p.offset) / 8;
else
begin_i = (p.precision + p.offset) / 8 - 1;
end_i = p.offset / 8;
for(k = begin_i; k >= end_i; k--)
H5Z_nbit_compress_one_byte(data, data_offset, k, begin_i, end_i,
buffer, j, buf_len, p, datatype_len);
}
if(p.order == H5Z_NBIT_ORDER_BE) { /* big endian */
/* calculate begin_i and end_i */
begin_i = (datatype_len - p.precision - p.offset) / 8;
if(p.offset % 8 != 0)
end_i = (datatype_len - p.offset) / 8;
else
end_i = (datatype_len - p.offset) / 8 - 1;
for(k = begin_i; k <= end_i; k++)
H5Z_nbit_compress_one_byte(data, data_offset, k, begin_i, end_i,
buffer, j, buf_len, p, datatype_len);
}
}
static void H5Z_nbit_compress_one_array(unsigned char *data, size_t data_offset, unsigned char *buffer,
size_t *j, int *buf_len, const unsigned parms[])
{
unsigned i, total_size, base_class, base_size, n, begin_index;
parms_atomic p;
total_size = parms[parms_index++];
base_class = parms[parms_index++];
switch(base_class) {
case H5Z_NBIT_ATOMIC:
p.size = parms[parms_index++];
p.order = parms[parms_index++];
p.precision = parms[parms_index++];
p.offset = parms[parms_index++];
n = total_size/p.size;
for(i = 0; i < n; i++)
H5Z_nbit_compress_one_atomic(data, data_offset + i*p.size,
buffer, j, buf_len, p);
break;
case H5Z_NBIT_ARRAY:
base_size = parms[parms_index]; /* read in advance */
n = total_size/base_size; /* number of base_type elements inside the array datatype */
begin_index = parms_index;
for(i = 0; i < n; i++) {
H5Z_nbit_compress_one_array(data, data_offset + i*base_size,
buffer, j, buf_len, parms);
parms_index = begin_index;
}
break;
case H5Z_NBIT_COMPOUND:
base_size = parms[parms_index]; /* read in advance */
n = total_size/base_size; /* number of base_type elements inside the array datatype */
begin_index = parms_index;
for(i = 0; i < n; i++) {
H5Z_nbit_compress_one_compound(data, data_offset + i*base_size,
buffer, j, buf_len, parms);
parms_index = begin_index;
}
break;
case H5Z_NBIT_NOOPTYPE:
parms_index++; /* skip size of no-op type */
H5Z_nbit_compress_one_nooptype(data, data_offset, buffer, j, buf_len, total_size);
break;
default:
HDassert(0 && "This Should never be executed!");
} /* end switch */
}
static void H5Z_nbit_compress_one_compound(unsigned char *data, size_t data_offset,
unsigned char *buffer, size_t *j, int *buf_len, const unsigned parms[])
{
unsigned i, nmembers, member_offset, member_class, size;
parms_atomic p;
parms_index++; /* skip size of compound datatype */
nmembers = parms[parms_index++];
for(i = 0; i < nmembers; i++) {
member_offset = parms[parms_index++];
member_class = parms[parms_index++];
switch(member_class) {
case H5Z_NBIT_ATOMIC:
p.size = parms[parms_index++];
p.order = parms[parms_index++];
p.precision = parms[parms_index++];
p.offset = parms[parms_index++];
H5Z_nbit_compress_one_atomic(data, data_offset + member_offset,
buffer, j, buf_len, p);
break;
case H5Z_NBIT_ARRAY:
H5Z_nbit_compress_one_array(data, data_offset + member_offset,
buffer, j, buf_len, parms);
break;
case H5Z_NBIT_COMPOUND:
H5Z_nbit_compress_one_compound(data, data_offset+member_offset,
buffer, j, buf_len, parms);
break;
case H5Z_NBIT_NOOPTYPE:
size = parms[parms_index++];
H5Z_nbit_compress_one_nooptype(data, data_offset+member_offset,
buffer, j, buf_len, size);
break;
default:
HDassert(0 && "This Should never be executed!");
} /* end switch */
}
}
static void H5Z_nbit_compress(unsigned char *data, unsigned d_nelmts, unsigned char *buffer,
size_t *buffer_size, const unsigned parms[])
{
/* i: index of data, new_size: index of buffer,
buf_len: number of bits to be filled in current byte */
size_t i, size;
size_t new_size = 0;
int buf_len;
parms_atomic p;
/* must initialize buffer to be zeros */
HDmemset(buffer, 0, *buffer_size);
/* initialization before the loop */
buf_len = sizeof(unsigned char) * 8;
switch(parms[3]) {
case H5Z_NBIT_ATOMIC:
/* set the index before goto function call */
p.size = parms[4];
p.order = parms[5];
p.precision = parms[6];
p.offset = parms[7];
for(i = 0; i < d_nelmts; i++) {
H5Z_nbit_compress_one_atomic(data, i*p.size, buffer, &new_size, &buf_len, p);
}
break;
case H5Z_NBIT_ARRAY:
size = parms[4];
parms_index = 4;
for(i = 0; i < d_nelmts; i++) {
H5Z_nbit_compress_one_array(data, i*size, buffer, &new_size, &buf_len, parms);
parms_index = 4;
}
break;
case H5Z_NBIT_COMPOUND:
size = parms[4];
parms_index = 4;
for(i = 0; i < d_nelmts; i++) {
H5Z_nbit_compress_one_compound(data, i*size, buffer, &new_size, &buf_len, parms);
parms_index = 4;
}
break;
default:
HDassert(0 && "This Should never be executed!");
} /* end switch */
/* Update the size to the new value after compression. If there are any bits hanging over in
* the last byte, increment the value by 1. */
*buffer_size = new_size + 1;
}
' href='#n1494'>1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
<doxygenconfig>
<group name='Project' docs='Project related configuration options'>
<option type='string' id='DOXYFILE_ENCODING' format='string' docs='
This tag specifies the encoding used for all characters in the config file
that follow. The default is UTF-8 which is also the encoding used for all
text before the first occurrence of this tag. Doxygen uses libiconv (or the
iconv built into libc) for the transcoding. See
http://www.gnu.org/software/libiconv for the list of possible encodings.
' defval='UTF-8'/>
<option type='string' id='PROJECT_NAME' format='string' docs='
The PROJECT_NAME tag is a single word (or sequence of words) that should
identify the project. Note that if you do not use Doxywizard you need
to put quotes around the project name if it contains spaces.' defval='My Project'/>
<option type='string' id='PROJECT_NUMBER' format='string' docs='
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.
' defval=''/>
<option type='string' id='PROJECT_BRIEF' format='string' docs='
Using the PROJECT_BRIEF tag one can provide an optional one line description
for a project that appears at the top of each page and should give viewer
a quick idea about the purpose of the project. Keep the description short.
' defval=''/>
<option type='string' id='PROJECT_LOGO' format='file' docs='
With the PROJECT_LOGO tag one can specify an logo or icon that is
included in the documentation. The maximum height of the logo should not
exceed 55 pixels and the maximum width should not exceed 200 pixels.
Doxygen will copy the logo to the output directory.
' defval=''/>
<option type='string' id='OUTPUT_DIRECTORY' format='dir' docs='
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.
' defval=''/>
<option type='bool' id='CREATE_SUBDIRS' docs='
If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
4096 sub-directories (in 2 levels) under the output directory of each output
format and will distribute the generated files over these directories.
Enabling this option can be useful when feeding doxygen a huge amount of
source files, where putting all generated files in the same directory would
otherwise cause performance problems for the file system.
' defval='0'/>
<option type='enum' id='OUTPUT_LANGUAGE' defval='English' docs='
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:
Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
'>
<value name='Afrikaans'/>
<value name='Arabic'/>
<value name='Brazilian'/>
<value name='Catalan'/>
<value name='Chinese'/>
<value name='Chinese-Traditional'/>
<value name='Croatian'/>
<value name='Czech'/>
<value name='Danish'/>
<value name='Dutch'/>
<value name='English'/>
<value name='Esperanto'/>
<value name='Farsi'/>
<value name='Finnish'/>
<value name='French'/>
<value name='German'/>
<value name='Greek'/>
<value name='Hungarian'/>
<value name='Italian'/>
<value name='Japanese'/>
<value name='Japanese-en'/>
<value name='Korean'/>
<value name='Korean-en'/>
<value name='Norwegian'/>
<value name='Macedonian'/>
<value name='Persian'/>
<value name='Polish'/>
<value name='Portuguese'/>
<value name='Romanian'/>
<value name='Russian'/>
<value name='Serbian'/>
<value name='Slovak'/>
<value name='Slovene'/>
<value name='Spanish'/>
<value name='Swedish'/>
<value name='Turkish'/>
<value name='Ukrainian'/>
<value name='Vietnamese'/>
</option>
<option type='bool' id='BRIEF_MEMBER_DESC' docs='
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.
' defval='1'/>
<option type='bool' id='REPEAT_BRIEF' docs='
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.
' defval='1'/>
<option type='list' id='ABBREVIATE_BRIEF' format='string' docs='
This tag implements a quasi-intelligent brief description abbreviator
that is used to form the text in various listings. Each string
in this list, if found as the leading text of the brief description, will be
stripped from the text and the result after processing the whole list, is
used as the annotated text. Otherwise, the brief description is used as-is.
If left blank, the following values are used ("$name" is automatically
replaced with the name of the entity): "The $name class" "The $name widget"
"The $name file" "is" "provides" "specifies" "contains"
"represents" "a" "an" "the"
'>
<value name='The $name class'/>
<value name='The $name widget'/>
<value name='The $name file'/>
<value name='is'/>
<value name='provides'/>
<value name='specifies'/>
<value name='contains'/>
<value name='represents'/>
<value name='a'/>
<value name='an'/>
<value name='the'/>
</option>
<option type='bool' id='ALWAYS_DETAILED_SEC' docs='
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.
' defval='0'/>
<option type='bool' id='INLINE_INHERITED_MEMB' docs='
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.
' defval='0'/>
<option type='bool' id='FULL_PATH_NAMES' docs='
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.
' defval='1'/>
<option type='list' id='STRIP_FROM_PATH' format='string' docs='
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. The tag can be used to show relative paths in the file list.
If left blank the directory from which doxygen is run is used as the
path to strip.
' depends='FULL_PATH_NAMES'>
<value name=''/>
</option>
<option type='list' id='STRIP_FROM_INC_PATH' format='string' docs='
The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
the path mentioned in the documentation of a class, which tells
the reader which header file to include in order to use a class.
If left blank only the name of the header file containing the class
definition is used. Otherwise one should specify the include paths that
are normally passed to the compiler using the -I flag.
'>
</option>
<option type='bool' id='SHORT_NAMES' docs='
If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
(but less readable) file names. This can be useful if your file system
doesn't support long names like on DOS, Mac, or CD-ROM.
' defval='0'/>
<option type='bool' id='JAVADOC_AUTOBRIEF' docs='
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 regular Qt-style comments
(thus requiring an explicit @brief command for a brief description.)
' defval='0'/>
<option type='bool' id='QT_AUTOBRIEF' docs='
If the QT_AUTOBRIEF tag is set to YES then Doxygen will
interpret the first line (until the first dot) of a Qt-style
comment as the brief description. If set to NO, the comments
will behave just like regular Qt-style comments (thus requiring
an explicit \brief command for a brief description.)
' defval='0'/>
<option type='bool' id='MULTILINE_CPP_IS_BRIEF' docs='
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.
' defval='0'/>
<option type='bool' id='INHERIT_DOCS' docs='
If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
member inherits the documentation from any documented member that it
re-implements.
' defval='1'/>
<option type='bool' id='SEPARATE_MEMBER_PAGES' docs='
If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
a new page for each member. If set to NO, the documentation of a member will
be part of the file/class/namespace that contains it.
' defval='0'/>
<option type='int' id='TAB_SIZE' docs='
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.
' minval='1' maxval='16' defval='8'/>
<option type='list' id='ALIASES' format='string' docs='
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.
'/>
<option type='list' id='TCL_SUBST' format='string' docs='
This tag can be used to specify a number of word-keyword mappings (TCL only).
A mapping has the form "name=value". For example adding
"class=itcl::class" will allow you to use the command class in the
itcl::class meaning.
'/>
<option type='bool' id='OPTIMIZE_OUTPUT_FOR_C' docs='
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.
' defval='0'/>
<option type='bool' id='OPTIMIZE_OUTPUT_JAVA' docs='
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.
' defval='0'/>
<option type='bool' id='OPTIMIZE_FOR_FORTRAN' docs='
Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
sources only. Doxygen will then generate output that is more tailored for
Fortran.
' defval='0'/>
<option type='bool' id='OPTIMIZE_OUTPUT_VHDL' docs='
Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
sources. Doxygen will then generate output that is tailored for
VHDL.
' defval='0'/>
<option type='list' id='EXTENSION_MAPPING' format='string' docs='
Doxygen selects the parser to use depending on the extension of the files it
parses. With this tag you can assign which parser to use for a given extension.
Doxygen has a built-in mapping, but you can override or extend it using this
tag. The format is ext=language, where ext is a file extension, and language
is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
(default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
'>
</option>
<option type='bool' id='BUILTIN_STL_SUPPORT' docs='
If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
to include (a tag file for) the STL sources as input, then you should
set this tag to YES in order to let doxygen match functions declarations and
definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
func(std::string) {}). This also makes the inheritance and collaboration
diagrams that involve STL classes more complete and accurate.
' defval='0'/>
<option type='bool' id='CPP_CLI_SUPPORT' docs='
If you use Microsoft's C++/CLI language, you should set this option to YES to
enable parsing support.
' defval='0'/>
<option type='bool' id='SIP_SUPPORT' docs='
Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
Doxygen will parse them like normal C++ but will assume all classes use public
instead of private inheritance when no explicit protection keyword is present.
' defval='0'/>
<option type='bool' id='IDL_PROPERTY_SUPPORT' docs='
For Microsoft's IDL there are propget and propput attributes to indicate getter
and setter methods for a property. Setting this option to YES (the default)
will make doxygen replace the get and set methods by a property in the
documentation. This will only work if the methods are indeed getting or
setting a simple type. If this is not the case, or you want to show the
methods anyway, you should set this option to NO.
' defval='1'/>
<option type='bool' id='DISTRIBUTE_GROUP_DOC' docs='
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.
' defval='0'/>
<option type='bool' id='SUBGROUPING' docs='
Set the SUBGROUPING tag to YES (the default) to allow class member groups of
the same type (for instance a group of public functions) to be put as a
subgroup of that type (e.g. under the Public Functions section). Set it to
NO to prevent subgrouping. Alternatively, this can be done per class using
the \nosubgrouping command.
' defval='1'/>
<option type='bool' id='INLINE_GROUPED_CLASSES' docs='
When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
unions are shown inside the group in which they are included (e.g. using
@ingroup) instead of on a separate page (for HTML and Man pages) or
section (for LaTeX and RTF).
' defval='0'/>
<option type='bool' id='INLINE_SIMPLE_STRUCTS' docs='
When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
unions with only public data fields will be shown inline in the documentation
of the scope in which they are defined (i.e. file, namespace, or group
documentation), provided this scope is documented. If set to NO (the default),
structs, classes, and unions are shown on a separate page (for HTML and Man
pages) or section (for LaTeX and RTF).' defval='0'/>
<option type='bool' id='TYPEDEF_HIDES_STRUCT' docs='
When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
is documented as struct, union, or enum with the name of the typedef. So
typedef struct TypeS {} TypeT, will appear in the documentation as a struct
with name TypeT. When disabled the typedef will appear as a member of a file,
namespace, or class. And the struct will be named TypeS. This can typically
be useful for C code in case the coding convention dictates that all compound
types are typedef'ed and only the typedef is referenced, never the tag name.
' defval='0'/>
<option type='int' id='SYMBOL_CACHE_SIZE' docs='
The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
determine which symbols to keep in memory and which to flush to disk.
When the cache is full, less often used symbols will be written to disk.
For small to medium size projects (<1000 input files) the default value is
probably good enough. For larger projects a too small cache size can cause
doxygen to be busy swapping symbols to and from disk most of the time
causing a significant performance penalty.
If the system has enough physical memory increasing the cache will improve the
performance by keeping more symbols in memory. Note that the value works on
a logarithmic scale so increasing the size by one will roughly double the
memory usage. The cache size is given by this formula:
2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
corresponding to a cache size of 2^16 = 65536 symbols
' minval='0' maxval='9' defval='0'/>
</group>
<group name='Build' docs='Build related configuration options'>
<option type='bool' id='EXTRACT_ALL' docs='
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
' defval='0'/>
<option type='bool' id='EXTRACT_PRIVATE' docs='
If the EXTRACT_PRIVATE tag is set to YES all private members of a class
will be included in the documentation.
' defval='0'/>
<option type='bool' id='EXTRACT_STATIC' docs='
If the EXTRACT_STATIC tag is set to YES all static members of a file
will be included in the documentation.
' defval='0'/>
<option type='bool' id='EXTRACT_LOCAL_CLASSES' docs='
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.
' defval='1'/>
<option type='bool' id='EXTRACT_LOCAL_METHODS' docs='
This flag is only useful for Objective-C code. When set to YES local
methods, which are defined in the implementation section but not in
the interface are included in the documentation.
If set to NO (the default) only methods in the interface are included.
' defval='0'/>
<option type='bool' id='EXTRACT_ANON_NSPACES' docs='
If this flag is set to YES, the members of anonymous namespaces will be
extracted and appear in the documentation as a namespace called
'anonymous_namespace{file}', where file will be replaced with the base
name of the file that contains the anonymous namespace. By default
anonymous namespaces are hidden.
' defval='0'/>
<option type='bool' id='HIDE_UNDOC_MEMBERS' docs='
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.
' defval='0'/>
<option type='bool' id='HIDE_UNDOC_CLASSES' docs='
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 classes will be included in the various
overviews. This option has no effect if EXTRACT_ALL is enabled.
' defval='0'/>
<option type='bool' id='HIDE_FRIEND_COMPOUNDS' docs='
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.
' defval='0'/>
<option type='bool' id='HIDE_IN_BODY_DOCS' docs='
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.
' defval='0'/>
<option type='bool' id='INTERNAL_DOCS' docs='
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.
' defval='0'/>
<option type='bool' id='CASE_SENSE_NAMES' docs='
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
and Mac users are advised to set this option to NO.
' defval='0' altdefval='portable_fileSystemIsCaseSensitive()'/>
<option type='bool' id='HIDE_SCOPE_NAMES' docs='
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.
' defval='0'/>
<option type='bool' id='SHOW_INCLUDE_FILES' docs='
If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
will put a list of the files that are included by a file in the documentation
of that file.
' defval='1'/>
<option type='bool' id='FORCE_LOCAL_INCLUDES' docs='
If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
will list include files with double quotes in the documentation
rather than with sharp brackets.
' defval='0'/>
<option type='bool' id='INLINE_INFO' docs='
If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
is inserted in the documentation for inline members.
' defval='1'/>
<option type='bool' id='SORT_MEMBER_DOCS' docs='
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.
' defval='1'/>
<option type='bool' id='SORT_BRIEF_DOCS' docs='
If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
brief documentation of file, namespace and class members alphabetically
by member name. If set to NO (the default) the members will appear in
declaration order.
' defval='0'/>
<option type='bool' id='SORT_MEMBERS_CTORS_1ST' docs='
If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
will sort the (brief and detailed) documentation of class members so that
constructors and destructors are listed first. If set to NO (the default)
the constructors will appear in the respective orders defined by
SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.' defval='0'/>
<option type='bool' id='SORT_GROUP_NAMES' docs='
If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
hierarchy of group names into alphabetical order. If set to NO (the default)
the group names will appear in their defined order.
' defval='0'/>
<option type='bool' id='SORT_BY_SCOPE_NAME' docs='
If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
sorted by fully-qualified names, including namespaces. If set to
NO (the default), the class list will be sorted only by class name,
not including the namespace part.
Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Note: This option applies only to the class list, not to the
alphabetical list.
' defval='0'/>
<option type='bool' id='STRICT_PROTO_MATCHING' docs='
If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
do proper type resolution of all parameters of a function it will reject a
match between the prototype and the implementation of a member function even
if there is only one candidate or it is obvious which candidate to choose
by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
will still accept a match between prototype and implementation in such cases.
' defval='0'/>
<option type='bool' id='GENERATE_TODOLIST' docs='
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.
' defval='1'/>
<option type='bool' id='GENERATE_TESTLIST' docs='
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.
' defval='1'/>
<option type='bool' id='GENERATE_BUGLIST' docs='
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.
' defval='1'/>
<option type='bool' id='GENERATE_DEPRECATEDLIST' docs='
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.
' defval='1'/>
<option type='list' id='ENABLED_SECTIONS' format='string' docs='
The ENABLED_SECTIONS tag can be used to enable conditional
documentation sections, marked by \if sectionname ... \endif.
'>
</option>
<option type='int' id='MAX_INITIALIZER_LINES' docs='
The MAX_INITIALIZER_LINES tag determines the maximum number of lines
the initial value of a variable or macro consists 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 macros in the
documentation can be controlled using \showinitializer or \hideinitializer
command in the documentation regardless of this setting.
' minval='0' maxval='10000' defval='30'/>
<option type='bool' id='SHOW_USED_FILES' docs='
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.
' defval='1'/>
<option type='bool' id='SHOW_DIRECTORIES' docs='
If the sources in your project are distributed over multiple directories
then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
in the documentation. The default is NO.
' defval='0'/>
<option type='bool' id='SHOW_FILES' docs='
Set the SHOW_FILES tag to NO to disable the generation of the Files page.
This will remove the Files entry from the Quick Index and from the
Folder Tree View (if specified). The default is YES.
' defval='1'/>
<option type='bool' id='SHOW_NAMESPACES' docs='
Set the SHOW_NAMESPACES tag to NO to disable the generation of the
Namespaces page. This will remove the Namespaces entry from the Quick Index
and from the Folder Tree View (if specified). The default is YES.
' defval='1'/>
<option type='string' id='FILE_VERSION_FILTER' format='file' docs='
The FILE_VERSION_FILTER tag can be used to specify a program or script that
doxygen should invoke to get the current version for each file (typically from
the version control system). Doxygen will invoke the program by executing (via
popen()) the command <command> <input-file>, where <command> is the value of
the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
provided by doxygen. Whatever the program writes to standard output
is used as the file version. See the manual for examples.
' defval=''/>
<option type='string' id='LAYOUT_FILE' format='file' docs='
The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
by doxygen. The layout file controls the global structure of the generated
output files in an output format independent way. The create the layout file
that represents doxygen's defaults, run doxygen with the -l option.
You can optionally specify a file name after the option, if omitted
DoxygenLayout.xml will be used as the name of the layout file.
' defval=''/>
<option type='list' id='CITE_BIB_FILES' format='file' docs='
The CITE_BIB_FILES tag can be used to specify one or more bib files
containing the references data. This must be a list of .bib files. The
.bib extension is automatically appended if omitted. Using this command
requires the bibtex tool to be installed. See also
http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
feature you need bibtex and perl available in the search path.
' defval=''/>
</group>
<group name='Messages' docs='configuration options related to warning and progress messages'>
<option type='bool' id='QUIET' docs='
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.
' defval='0'/>
<option type='bool' id='WARNINGS' docs='
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.
' defval='1'/>
<option type='bool' id='WARN_IF_UNDOCUMENTED' docs='
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.
' defval='1'/>
<option type='bool' id='WARN_IF_DOC_ERROR' docs='
If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
potential errors in the documentation, such as not documenting some
parameters in a documented function, or documenting parameters that
don't exist or using markup commands wrongly.
' defval='1'/>
<option type='bool' id='WARN_NO_PARAMDOC' docs='
The WARN_NO_PARAMDOC option can be enabled to get warnings for
functions that are documented, but have no documentation for their parameters
or return value. If set to NO (the default) doxygen will only warn about
wrong or incomplete parameter documentation, but not about the absence of
documentation.
' defval='0'/>
<option type='string' id='WARN_FORMAT' format='string' docs='
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. Optionally the format may contain
$version, which will be replaced by the version of the file (if it could
be obtained via FILE_VERSION_FILTER)
' defval='$file:$line: $text'/>
<option type='string' id='WARN_LOGFILE' format='file' docs='
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.
' defval=''/>
</group>
<group name='Input' docs='configuration options related to the input files'>
<option type='list' id='INPUT' format='filedir' docs='
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.
'>
<value name=''/>
</option>
<option type='string' id='INPUT_ENCODING' format='string' docs='
This tag can be used to specify the character encoding of the source files
that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
also the default input encoding. Doxygen uses libiconv (or the iconv built
into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
the list of possible encodings.
' defval='UTF-8'/>
<option type='list' id='FILE_PATTERNS' format='string' docs='
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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
*.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
*.f90 *.f *.for *.vhd *.vhdl
'>
<value name='*.c'/>
<value name='*.cc'/>
<value name='*.cxx'/>
<value name='*.cpp'/>
<value name='*.c++'/>
<value name='*.d'/>
<value name='*.java'/>
<value name='*.ii'/>
<value name='*.ixx'/>
<value name='*.ipp'/>
<value name='*.i++'/>
<value name='*.inl'/>
<value name='*.h'/>
<value name='*.hh'/>
<value name='*.hxx'/>
<value name='*.hpp'/>
<value name='*.h++'/>
<value name='*.idl'/>
<value name='*.odl'/>
<value name='*.cs'/>
<value name='*.php'/>
<value name='*.php3'/>
<value name='*.inc'/>
<value name='*.m'/>
<value name='*.mm'/>
<value name='*.dox'/>
<value name='*.py'/>
<value name='*.f90'/>
<value name='*.f'/>
<value name='*.for'/>
<value name='*.vhd'/>
<value name='*.vhdl'/>
</option>
<option type='bool' id='RECURSIVE' docs='
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.
' defval='0'/>
<option type='list' id='EXCLUDE' format='filedir' docs='
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.
Note that relative paths are relative to directory from which doxygen is run.
'>
</option>
<option type='bool' id='EXCLUDE_SYMLINKS' docs='
The EXCLUDE_SYMLINKS tag can be used select whether or not files or
directories that are symbolic links (a Unix file system feature) are excluded
from the input.
' defval='0'/>
<option type='list' id='EXCLUDE_PATTERNS' format='string' docs='
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. Note that the wildcards are matched
against the file with absolute path, so to exclude all test directories
for example use the pattern */test/*
'>
</option>
<option type='list' id='EXCLUDE_SYMBOLS' format='string' docs='
The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
(namespaces, classes, functions, etc.) that should be excluded from the
output. The symbol name can be a fully qualified name, a word, or if the
wildcard * is used, a substring. Examples: ANamespace, AClass,
AClass::ANamespace, ANamespace::*Test
'>
</option>
<option type='list' id='EXAMPLE_PATH' format='dir' docs='
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).
'>
</option>
<option type='list' id='EXAMPLE_PATTERNS' format='string' docs='
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.
'>
<value name='*'/>
</option>
<option type='bool' id='EXAMPLE_RECURSIVE' docs='
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.
' defval='0'/>
<option type='list' id='IMAGE_PATH' format='dir' docs='
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).
'>
</option>
<option type='string' id='INPUT_FILTER' format='file' docs='
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. If FILTER_PATTERNS is specified, this tag will be
ignored.
' defval=''/>
<option type='list' id='FILTER_PATTERNS' format='string' docs='
The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
basis. Doxygen will compare the file name with each pattern and apply the
filter if there is a match. The filters are a list of the form:
pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
info on how filters are used. If FILTER_PATTERNS is empty or if
non of the patterns match the file name, INPUT_FILTER is applied.
'>
</option>
<option type='bool' id='FILTER_SOURCE_FILES' docs='
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).
' defval='0'/>
<option type='list' id='FILTER_SOURCE_PATTERNS' format='string' docs='
The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
pattern. A pattern will override the setting for FILTER_PATTERN (if any)
and it is also possible to disable source filtering for a specific pattern
using *.ext= (so without naming a filter). This option only has effect when
FILTER_SOURCE_FILES is enabled.
' depends='FILTER_SOURCE_FILES'/>
</group>
<group name='Source Browser' docs='configuration options related to source browsing'>
<option type='bool' id='SOURCE_BROWSER' docs='
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.
Note: To get rid of all source code in the generated output, make sure also
VERBATIM_HEADERS is set to NO.
' defval='0'/>
<option type='bool' id='INLINE_SOURCES' docs='
Setting the INLINE_SOURCES tag to YES will include the body
of functions and classes directly in the documentation.
' defval='0'/>
<option type='bool' id='STRIP_CODE_COMMENTS' docs='
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.
' defval='1'/>
<option type='bool' id='REFERENCED_BY_RELATION' docs='
If the REFERENCED_BY_RELATION tag is set to YES
then for each documented function all documented
functions referencing it will be listed.
' defval='0'/>
<option type='bool' id='REFERENCES_RELATION' docs='
If the REFERENCES_RELATION tag is set to YES
then for each documented function all documented entities
called/used by that function will be listed.
' defval='0'/>
<option type='bool' id='REFERENCES_LINK_SOURCE' docs='
If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
link to the source code. Otherwise they will link to the documentation.
' defval='1'/>
<option type='bool' id='USE_HTAGS' docs='
If the USE_HTAGS tag is set to YES then the references to source code
will point to the HTML generated by the htags(1) tool instead of doxygen
built-in source browser. The htags tool is part of GNU's global source
tagging system (see http://www.gnu.org/software/global/global.html). You
will need version 4.8.6 or higher.
' defval='0' depends='SOURCE_BROWSER'/>
<option type='bool' id='VERBATIM_HEADERS' docs='
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.
' defval='1'/>
</group>
<group name='Index' docs='configuration options related to the alphabetical class index'>
<option type='bool' id='ALPHABETICAL_INDEX' docs='
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.
' defval='1'/>
<option type='int' id='COLS_IN_ALPHA_INDEX' docs='
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])
' minval='1' maxval='20' defval='5'/>
<option type='list' id='IGNORE_PREFIX' format='string' docs='
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.
'>
</option>
</group>
<group name='HTML' docs='configuration options related to the HTML output'>
<option type='bool' id='GENERATE_HTML' docs='
If the GENERATE_HTML tag is set to YES (the default) Doxygen will
generate HTML output.
' defval='1'/>
<option type='string' id='HTML_OUTPUT' format='dir' docs='
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.
' defval='html' depends='GENERATE_HTML'/>
<option type='string' id='HTML_FILE_EXTENSION' format='string' docs='
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.
' defval='.html' depends='GENERATE_HTML'/>
<option type='string' id='HTML_HEADER' format='file' docs='
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. Note that when using a custom header you are responsible
for the proper inclusion of any scripts and style sheets that doxygen
needs, which is dependent on the configuration options used.
It is advised to generate a default header using "doxygen -w html
header.html footer.html stylesheet.css YourConfigFile" and then modify
that header. Note that the header is subject to change so you typically
have to redo this when upgrading to a newer version of doxygen or when
changing the value of configuration settings such as GENERATE_TREEVIEW!
' defval='' depends='GENERATE_HTML'/>
<option type='string' id='HTML_FOOTER' format='file' docs='
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.
' defval='' depends='GENERATE_HTML'/>
<option type='string' id='HTML_STYLESHEET' format='file' docs='
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. Note that doxygen will try to copy
the style sheet file to the HTML output directory, so don't put your own
style sheet in the HTML output directory as well, or it will be erased!
' defval='' depends='GENERATE_HTML'/>
<option type='list' id='HTML_EXTRA_FILES' format='file' docs='
The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
other source files which should be copied to the HTML output directory. Note
that these files will be copied to the base HTML output directory. Use the
$relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
files. In the HTML_STYLESHEET file, use the file name only. Also note that
the files will be copied as-is; there are no commands or markers available.
' depends='GENERATE_HTML'/>
<option type='int' id='HTML_COLORSTYLE_HUE' docs='
The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
Doxygen will adjust the colors in the style sheet and background images
according to this color. Hue is specified as an angle on a colorwheel,
see http://en.wikipedia.org/wiki/Hue for more information.
For instance the value 0 represents red, 60 is yellow, 120 is green,
180 is cyan, 240 is blue, 300 purple, and 360 is red again.
The allowed range is 0 to 359.
' minval='0' maxval='359' defval='220' depends='GENERATE_HTML'/>
<option type='int' id='HTML_COLORSTYLE_SAT' docs='
The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
the colors in the HTML output. For a value of 0 the output will use
grayscales only. A value of 255 will produce the most vivid colors.
' minval='0' maxval='255' defval='100' depends='GENERATE_HTML'/>
<option type='int' id='HTML_COLORSTYLE_GAMMA' docs='
The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
the luminance component of the colors in the HTML output. Values below
100 gradually make the output lighter, whereas values above 100 make
the output darker. The value divided by 100 is the actual gamma applied,
so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
and 100 does not change the gamma.
' minval='40' maxval='240' defval='80'/>
<option type='bool' id='HTML_TIMESTAMP' docs='
If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
page will contain the date and time when the page was generated. Setting
this to NO can help when comparing the output of multiple runs.
' defval='1' depends='GENERATE_HTML'/>
<option type='bool' id='HTML_ALIGN_MEMBERS' docs='
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.
' defval='1' depends='GENERATE_HTML'/>
<option type='bool' id='HTML_DYNAMIC_SECTIONS' docs='
If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
documentation will contain sections that can be hidden and shown after the
page has loaded. For this to work a browser that supports
JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
' defval='0' depends='GENERATE_HTML'/>
<option type='bool' id='GENERATE_DOCSET' docs='
If the GENERATE_DOCSET tag is set to YES, additional index files
will be generated that can be used as input for Apple's Xcode 3
integrated development environment, introduced with OSX 10.5 (Leopard).
To create a documentation set, doxygen will generate a Makefile in the
HTML output directory. Running make will produce the docset in that
directory and running "make install" will install the docset in
~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
it at startup.
See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
for more information.
' defval='0' depends='GENERATE_HTML'/>
<option type='string' id='DOCSET_FEEDNAME' format='string' docs='
When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
feed. A documentation feed provides an umbrella under which multiple
documentation sets from a single provider (such as a company or product suite)
can be grouped.
' defval='Doxygen generated docs' depends='GENERATE_DOCSET'/>
<option type='string' id='DOCSET_BUNDLE_ID' format='string' docs='
When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
should uniquely identify the documentation set bundle. This should be a
reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
will append .docset to the name.
' defval='org.doxygen.Project' depends='GENERATE_DOCSET'/>
<option type='string' id='DOCSET_PUBLISHER_ID' format='string' docs='
When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
the documentation publisher. This should be a reverse domain-name style
string, e.g. com.mycompany.MyDocSet.documentation.
' defval='org.doxygen.Publisher' depends='GENERATE_DOCSET'/>
<option type='string' id='DOCSET_PUBLISHER_NAME' format='string' docs='
The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
' defval='Publisher' depends='GENERATE_DOCSET'/>
<option type='bool' id='GENERATE_HTMLHELP' docs='
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 compiled HTML help file (.chm)
of the generated HTML documentation.
' defval='0' depends='GENERATE_HTML'/>
<option type='string' id='CHM_FILE' format='file' docs='
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 directory.
' defval='' depends='GENERATE_HTMLHELP'/>
<option type='string' id='HHC_LOCATION' format='file' docs='
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.
' defval='' depends='GENERATE_HTMLHELP' abspath='1'/>
<option type='bool' id='GENERATE_CHI' docs='
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).
' defval='0' depends='GENERATE_HTMLHELP'/>
<option type='string' id='CHM_INDEX_ENCODING' format='string' docs='
If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
is used to encode HtmlHelp index (hhk), content (hhc) and project file
content.
' defval='' depends='GENERATE_HTMLHELP'/>
<option type='bool' id='BINARY_TOC' docs='
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.
' defval='0' depends='GENERATE_HTMLHELP'/>
<option type='bool' id='TOC_EXPAND' docs='
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.
' defval='0' depends='GENERATE_HTMLHELP'/>
<option type='bool' id='GENERATE_QHP' docs='
If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
that can be used as input for Qt's qhelpgenerator to generate a
Qt Compressed Help (.qch) of the generated HTML documentation.
' defval='0' depends='GENERATE_HTML'/>
<option type='string' id='QCH_FILE' format='file' docs='
If the QHG_LOCATION tag is specified, the QCH_FILE tag can
be used to specify the file name of the resulting .qch file.
The path specified is relative to the HTML output folder.
' defval='' depends='GENERATE_QHP'/>
<option type='string' id='QHP_NAMESPACE' format='string' docs='
The QHP_NAMESPACE tag specifies the namespace to use when generating
Qt Help Project output. For more information please see
http://doc.trolltech.com/qthelpproject.html#namespace
' defval='org.doxygen.Project' depends='GENERATE_QHP'/>
<option type='string' id='QHP_VIRTUAL_FOLDER' format='string' docs='
The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
Qt Help Project output. For more information please see
http://doc.trolltech.com/qthelpproject.html#virtual-folders
' defval='doc' depends='GENERATE_QHP'/>
<option type='string' id='QHP_CUST_FILTER_NAME' format='string' docs='
If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
add. For more information please see
http://doc.trolltech.com/qthelpproject.html#custom-filters
' defval='' depends='GENERATE_QHP'/>
<option type='string' id='QHP_CUST_FILTER_ATTRS' format='string' docs='
The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
custom filter to add. For more information please see
<a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
Qt Help Project / Custom Filters</a>.
' defval='' depends='GENERATE_QHP'/>
<option type='string' id='QHP_SECT_FILTER_ATTRS' format='string' docs='
The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
project's
filter section matches.
<a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
Qt Help Project / Filter Attributes</a>.
' defval='' depends='GENERATE_QHP'/>
<option type='string' id='QHG_LOCATION' format='file' docs='
If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
be used to specify the location of Qt's qhelpgenerator.
If non-empty doxygen will try to run qhelpgenerator on the generated
.qhp file.
' defval='' depends='GENERATE_QHP'/>
<option type='bool' id='GENERATE_ECLIPSEHELP' docs='
If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
will be generated, which together with the HTML files, form an Eclipse help
plugin. To install this plugin and make it available under the help contents
menu in Eclipse, the contents of the directory containing the HTML and XML
files needs to be copied into the plugins directory of eclipse. The name of
the directory within the plugins directory should be the same as
the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
the help appears.
' defval='0' depends='GENERATE_HTML'/>
<option type='string' id='ECLIPSE_DOC_ID' docs='
A unique identifier for the eclipse help plugin. When installing the plugin
the directory name containing the HTML and XML files should also have
this name.
' defval='org.doxygen.Project' depends='GENERATE_ECLIPSEHELP'/>
<option type='bool' id='DISABLE_INDEX' docs='
The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
at top of each HTML page. The value NO (the default) enables the index and
the value YES disables it. Since the tabs have the same information as the
navigation tree you can set this option to NO if you already set
GENERATE_TREEVIEW to YES.
' defval='0' depends='GENERATE_HTML'/>
<option type='bool' id='GENERATE_TREEVIEW' defval='0' docs='
The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
structure should be generated to display hierarchical information.
If the tag value 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, DHTML, CSS and frames is required (i.e. any modern browser).
Windows users are probably better off using the HTML help feature.
Since the tree basically has the same information as the tab index you
could consider to set DISABLE_INDEX to NO when enabling this option.
' depends='GENERATE_HTML'/>
<option type='int' id='ENUM_VALUES_PER_LINE' docs='
The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
(range [0,1..20]) that doxygen will group on one line in the generated HTML
documentation. Note that a value of 0 will completely suppress the enum
values from appearing in the overview section.
' minval='0' maxval='20' defval='4' depends='GENERATE_HTML'/>
<option type='bool' id='USE_INLINE_TREES' defval='0' docs='
By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
and Class Hierarchy pages using a tree view instead of an ordered list.
' depends='GENERATE_HTML'/>
<option type='int' id='TREEVIEW_WIDTH' docs='
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.
' minval='0' maxval='1500' defval='250' depends='GENERATE_HTML'/>
<option type='bool' id='EXT_LINKS_IN_WINDOW' defval='0' docs='
When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
links to external symbols imported via tag files in a separate window.
' depends='GENERATE_HTML'/>
<option type='int' id='FORMULA_FONTSIZE' docs='
Use this tag to change the font size of Latex formulas included
as images in the HTML documentation. The default is 10. Note that
when you change the font size after a successful doxygen run you need
to manually remove any form_*.png images from the HTML output directory
to force them to be regenerated.
' minval='8' maxval='50' defval='10' depends='GENERATE_HTML'/>
<option type='bool' id='FORMULA_TRANSPARENT' docs='
Use the FORMULA_TRANPARENT tag to determine whether or not the images
generated for formulas are transparent PNGs. Transparent PNGs are
not supported properly for IE 6.0, but are supported on all modern browsers.
Note that when changing this option you need to delete any form_*.png files
in the HTML output before the changes have effect.
' defval='1' depends='GENERATE_HTML'/>
<option type='bool' id='USE_MATHJAX' docs='
Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
(see http://www.mathjax.org) which uses client side Javascript for the
rendering instead of using prerendered bitmaps. Use this if you do not
have LaTeX installed or if you want to formulas look prettier in the HTML
output. When enabled you also need to install MathJax separately and
configure the path to it using the MATHJAX_RELPATH option.
' defval='0'/>
<option type='string' id='MATHJAX_RELPATH' docs='
When MathJax is enabled you need to specify the location relative to the
HTML output directory using the MATHJAX_RELPATH option. The destination
directory should contain the MathJax.js script. For instance, if the mathjax
directory is located at the same level as the HTML output directory, then
MATHJAX_RELPATH should be ../mathjax. The default value points to the
mathjax.org site, so you can quickly see the result without installing
MathJax, but it is strongly recommended to install a local copy of MathJax
before deployment.
' defval='http://www.mathjax.org/mathjax'/>
<option type='list' id='MATHJAX_EXTENSIONS' format='string' docs='
The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
names that should be enabled during MathJax rendering.
' depends='USE_MATHJAX'>
</option>
<option type='bool' id='SEARCHENGINE' docs='
When the SEARCHENGINE tag is enabled doxygen will generate a search box
for the HTML output. The underlying search engine uses javascript
and DHTML and should work on any modern browser. Note that when using
HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
(GENERATE_DOCSET) there is already a search function so this one should
typically be disabled. For large projects the javascript based search engine
can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
' defval='1' depends='GENERATE_HTML'/>
<option type='bool' id='SERVER_BASED_SEARCH' docs='
When the SERVER_BASED_SEARCH tag is enabled the search engine will be
implemented using a PHP enabled web server instead of at the web client
using Javascript. Doxygen will generate the search PHP script and index
file to put on the web server. The advantage of the server
based approach is that it scales better to large projects and allows
full text search. The disadvantages are that it is more difficult to setup
and does not have live searching capabilities.
' defval='0' depends='SEARCHENGINE'/>
</group>
<group name='LaTeX' docs='configuration options related to the LaTeX output'>
<option type='bool' id='GENERATE_LATEX' docs='
If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
generate Latex output.
' defval='1'/>
<option type='string' id='LATEX_OUTPUT' format='dir' docs='
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.
' defval='latex' depends='GENERATE_LATEX'/>
<option type='string' id='LATEX_CMD_NAME' format='file' docs='
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.
Note that when enabling USE_PDFLATEX this option is only used for
generating bitmaps for formulas in the HTML output, but not in the
Makefile that is written to the output directory.
' defval='latex' depends='GENERATE_LATEX'/>
<option type='string' id='MAKEINDEX_CMD_NAME' format='file' docs='
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.
' defval='makeindex' depends='GENERATE_LATEX'/>
<option type='bool' id='COMPACT_LATEX' docs='
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.
' defval='0' depends='GENERATE_LATEX'/>
<option type='enum' id='PAPER_TYPE' defval='a4' docs='
The PAPER_TYPE tag can be used to set the paper type that is used
by the printer. Possible values are: a4, letter, legal and
executive. If left blank a4wide will be used.
' depends='GENERATE_LATEX'>
<value name='a4'/>
<value name='a4wide'/>
<value name='letter'/>
<value name='legal'/>
<value name='executive'/>
</option>
<option type='list' id='EXTRA_PACKAGES' format='string' docs='
The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
packages that should be included in the LaTeX output.
' depends='GENERATE_LATEX'>
</option>
<option type='string' id='LATEX_HEADER' format='file' docs='
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!
' defval='' depends='GENERATE_LATEX'/>
<option type='string' id='LATEX_FOOTER' format='file' docs='
The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
the generated latex document. The footer should contain everything after
the last chapter. If it is left blank doxygen will generate a
standard footer. Notice: only use this tag if you know what you are doing!
' defval='' depends='GENERATE_LATEX'/>
<option type='bool' id='PDF_HYPERLINKS' docs='
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.
' defval='1' depends='GENERATE_LATEX'/>
<option type='bool' id='USE_PDFLATEX' docs='
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.
' defval='1' depends='GENERATE_LATEX'/>
<option type='bool' id='LATEX_BATCHMODE' docs='
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.
' defval='0' depends='GENERATE_LATEX'/>
<option type='bool' id='LATEX_HIDE_INDICES' docs='
If LATEX_HIDE_INDICES is set to YES then doxygen will not
include the index chapters (such as File Index, Compound Index, etc.)
in the output.
' defval='0' depends='GENERATE_LATEX'/>
<option type='bool' id='LATEX_SOURCE_CODE' docs='
If LATEX_SOURCE_CODE is set to YES then doxygen will include
source code with syntax highlighting in the LaTeX output.
Note that which sources are shown also depends on other settings
such as SOURCE_BROWSER.
' defval='0' depends='GENERATE_LATEX'/>
<option type='string' id='LATEX_BIB_STYLE' format='string' docs='
The LATEX_BIB_STYLE tag can be used to specify the style to use for the
bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
http://en.wikipedia.org/wiki/BibTeX for more info.
' defval='plain'/>
</group>
<group name='RTF' docs='configuration options related to the RTF output'>
<option type='bool' id='GENERATE_RTF' docs='
If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
The RTF output is optimized for Word 97 and may not look very pretty with
other RTF readers or editors.
' defval='0'/>
<option type='string' id='RTF_OUTPUT' format='dir' docs='
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.
' defval='rtf' depends='GENERATE_RTF'/>
<option type='bool' id='COMPACT_RTF' docs='
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.
' defval='0' depends='GENERATE_RTF'/>
<option type='bool' id='RTF_HYPERLINKS' docs='
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.
' defval='0' depends='GENERATE_RTF'/>
<option type='string' id='RTF_STYLESHEET_FILE' format='file' docs='
Load style sheet definitions from file. Syntax is similar to doxygen's
config file, i.e. a series of assignments. You only have to provide
replacements, missing definitions are set to their default value.
' defval='' depends='GENERATE_RTF'/>
<option type='string' id='RTF_EXTENSIONS_FILE' format='file' docs='
Set optional variables used in the generation of an rtf document.
Syntax is similar to doxygen's config file.
' defval='' depends='GENERATE_RTF'/>
</group>
<group name='Man' docs='configuration options related to the man page output'>
<option type='bool' id='GENERATE_MAN' docs='
If the GENERATE_MAN tag is set to YES (the default) Doxygen will
generate man pages
' defval='0'/>
<option type='string' id='MAN_OUTPUT' format='dir' docs='
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.
' defval='man' depends='GENERATE_MAN'/>
<option type='string' id='MAN_EXTENSION' format='string' docs='
The MAN_EXTENSION tag determines the extension that is added to
the generated man pages (default is the subroutine's section .3)
' defval='.3' depends='GENERATE_MAN'/>
<option type='bool' id='MAN_LINKS' docs='
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.
' defval='0' depends='GENERATE_MAN'/>
</group>
<group name='XML' docs='configuration options related to the XML output'>
<option type='bool' id='GENERATE_XML' docs='
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.
' defval='0'/>
<option type='string' id='XML_OUTPUT' format='dir' docs='
The XML_OUTPUT tag is used to specify where the XML 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 `xml' will be used as the default path.
' defval='xml' depends='GENERATE_XML'/>
<option type='string' id='XML_SCHEMA' format='string' docs='
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.
' defval='' depends='GENERATE_XML'/>
<option type='string' id='XML_DTD' format='string' docs='
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.
' defval='' depends='GENERATE_XML'/>
<option type='bool' id='XML_PROGRAMLISTING' docs='
If the XML_PROGRAMLISTING tag is set to YES Doxygen will
dump the program listings (including syntax highlighting
and cross-referencing information) to the XML output. Note that
enabling this will significantly increase the size of the XML output.
' defval='1' depends='GENERATE_XML'/>
</group>
<group name='DEF' docs='configuration options for the AutoGen Definitions output'>
<option type='bool' id='GENERATE_AUTOGEN_DEF' docs='
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.
' defval='0'/>
</group>
<group name='PerlMod' docs='configuration options related to the Perl module output'>
<option type='bool' id='GENERATE_PERLMOD' docs='
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.
' defval='0'/>
<option type='bool' id='PERLMOD_LATEX' docs='
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.
' defval='0' depends='GENERATE_PERLMOD'/>
<option type='bool' id='PERLMOD_PRETTY' docs='
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.
' defval='1' depends='GENERATE_PERLMOD'/>
<option type='string' id='PERLMOD_MAKEVAR_PREFIX' format='string' docs='
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.' defval='' depends='GENERATE_PERLMOD'/>
</group>
<group name='Preprocessor' docs='Configuration options related to the preprocessor'>
<option type='bool' id='ENABLE_PREPROCESSING' docs='
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.
' defval='1'/>
<option type='bool' id='MACRO_EXPANSION' docs='
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.
' defval='0' depends='ENABLE_PREPROCESSING'/>
<option type='bool' id='EXPAND_ONLY_PREDEF' docs='
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_DEFINED tags.
' defval='0' depends='ENABLE_PREPROCESSING'/>
<option type='bool' id='SEARCH_INCLUDES' docs='
If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
pointed to by INCLUDE_PATH will be searched when a #include is found.
' defval='1' depends='ENABLE_PREPROCESSING'/>
<option type='list' id='INCLUDE_PATH' format='dir' docs='
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.
' depends='ENABLE_PREPROCESSING'>
</option>
<option type='list' id='INCLUDE_FILE_PATTERNS' format='string' docs='
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.
' depends='ENABLE_PREPROCESSING'>
</option>
<option type='list' id='PREDEFINED' format='string' docs='
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. To prevent a macro definition from being
undefined via #undef or recursively expanded use the := operator
instead of the = operator.
' depends='ENABLE_PREPROCESSING'>
</option>
<option type='list' id='EXPAND_AS_DEFINED' format='string' docs='
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 that
overrules the definition found in the source code.
' depends='ENABLE_PREPROCESSING'>
</option>
<option type='bool' id='SKIP_FUNCTION_MACROS' docs='
If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
doxygen's preprocessor will remove all references to function-like macros
that are alone on a line, have an all uppercase name, and do not end with a
semicolon, because these will confuse the parser if not removed.
' defval='1' depends='ENABLE_PREPROCESSING'/>
</group>
<group name='External' docs='Configuration::additions related to external references'>
<option type='list' id='TAGFILES' format='file' docs='
The TAGFILES option can be used to specify one or more tagfiles.
Optionally an initial location of the external documentation
can be added for each tagfile. The format of a tag file without
this location is as follows:
TAGFILES = file1 file2 ...
Adding location for the tag files is done as follows:
TAGFILES = file1=loc1 "file2 = loc2" ...
where "loc1" and "loc2" can be relative or absolute paths or
URLs. If a location is present for each tag, the installdox tool
does not have to be run to correct the links.
Note that each tag file must have a unique name
(where the name does NOT include the path)
If a tag file is not located in the directory in which doxygen
is run, you must also specify the path to the tagfile here.
'>
</option>
<option type='string' id='GENERATE_TAGFILE' format='file' docs='
When a file name is specified after GENERATE_TAGFILE, doxygen will create
a tag file that is based on the input files it reads.
' defval=''/>
<option type='bool' id='ALLEXTERNALS' docs='
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.
' defval='0'/>
<option type='bool' id='EXTERNAL_GROUPS' docs='
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.
' defval='1'/>
<option type='string' id='PERL_PATH' format='dir' docs='
The PERL_PATH should be the absolute path and name of the perl script
interpreter (i.e. the result of `which perl').
' defval='/usr/bin/perl'/>
</group>
<group name='Dot' docs='Configuration options related to the dot tool'>
<option type='bool' id='CLASS_DIAGRAMS' docs='
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 also works with HAVE_DOT disabled, but it is recommended to
install and use dot, since it yields more powerful graphs.
' defval='1'/>
<option type='string' id='MSCGEN_PATH' format='string' docs='
You can define message sequence charts within doxygen comments using the \msc
command. Doxygen will then run the mscgen tool (see
http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
documentation. The MSCGEN_PATH tag allows you to specify the directory where
the mscgen tool resides. If left empty the tool is assumed to be found in the
default search path.
' defval=''/>
<option type='bool' id='HIDE_UNDOC_RELATIONS' docs='
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.
' defval='1'/>
<option type='bool' id='HAVE_DOT' docs='
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)
' defval='0'/>
<option type='int' id='DOT_NUM_THREADS' docs='
The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
allowed to run in parallel. When set to 0 (the default) doxygen will
base this on the number of processors available in the system. You can set it
explicitly to a value larger than 0 to get control over the balance
between CPU load and processing speed.
' defval='0' minval='0' maxval='32'/>
<option type='string' id='DOT_FONTNAME' format='string' docs='
By default doxygen will use the Helvetica font for all dot files that
doxygen generates. When you want a differently looking font you can specify
the font name using DOT_FONTNAME. You need to make sure dot is able to find
the font, which can be done by putting it in a standard location or by setting
the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
directory containing the font.
' defval='Helvetica' depends='HAVE_DOT'/>
<option type='int' id='DOT_FONTSIZE' docs='
The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
The default size is 10pt.
' minval='4' maxval='24' defval='10' depends='HAVE_DOT'/>
<option type='string' id='DOT_FONTPATH' format='string' docs='
By default doxygen will tell dot to use the Helvetica font.
If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
set the path where dot can find it.
' defval='' depends='HAVE_DOT'/>
<option type='bool' id='CLASS_GRAPH' docs='
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
CLASS_DIAGRAMS tag to NO.
' defval='1' depends='HAVE_DOT'/>
<option type='bool' id='COLLABORATION_GRAPH' docs='
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.
' defval='1' depends='HAVE_DOT'/>
<option type='bool' id='GROUP_GRAPHS' docs='
If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
will generate a graph for groups, showing the direct groups dependencies
' defval='1' depends='HAVE_DOT'/>
<option type='bool' id='UML_LOOK' docs='
If the UML_LOOK tag is set to YES doxygen will generate inheritance and
collaboration diagrams in a style similar to the OMG's Unified Modeling
Language.
' defval='0' depends='HAVE_DOT'/>
<option type='bool' id='TEMPLATE_RELATIONS' docs='
If set to YES, the inheritance and collaboration graphs will show the
relations between templates and their instances.
' defval='0' depends='HAVE_DOT'/>
<option type='bool' id='INCLUDE_GRAPH' docs='
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.
' defval='1' depends='HAVE_DOT'/>
<option type='bool' id='INCLUDED_BY_GRAPH' docs='
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.
' defval='1' depends='HAVE_DOT'/>
<option type='bool' id='CALL_GRAPH' docs='
If the CALL_GRAPH and HAVE_DOT options are set to YES then
doxygen will generate a call dependency graph for every global function
or class method. Note that enabling this option will significantly increase
the time of a run. So in most cases it will be better to enable call graphs
for selected functions only using the \callgraph command.
' defval='0' depends='HAVE_DOT'/>
<option type='bool' id='CALLER_GRAPH' docs='
If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
doxygen will generate a caller dependency graph for every global function
or class method. Note that enabling this option will significantly increase
the time of a run. So in most cases it will be better to enable caller
graphs for selected functions only using the \callergraph command.
' defval='0' depends='HAVE_DOT'/>
<option type='bool' id='GRAPHICAL_HIERARCHY' docs='
If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
will generate a graphical hierarchy of all classes instead of a textual one.
' defval='1' depends='HAVE_DOT'/>
<option type='bool' id='DIRECTORY_GRAPH' docs='
If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
then doxygen will show the dependencies a directory has on other directories
in a graphical way. The dependency relations are determined by the #include
relations between the files in the directories.
' defval='1' depends='HAVE_DOT'/>
<option type='enum' id='DOT_IMAGE_FORMAT' defval='png' docs='
The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
generated by dot. Possible values are svg, png, jpg, or gif.
If left blank png will be used. If you choose svg you need to set
HTML_FILE_EXTENSION to xhtml in order to make the SVG files
visible in IE 9+ (other browsers do not have this requirement).
' depends='HAVE_DOT'>
<value name='png'/>
<value name='jpg'/>
<value name='gif'/>
<value name='svg'/>
</option>
<option type='bool' id='INTERACTIVE_SVG' docs='
If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
enable generation of interactive SVG images that allow zooming and panning.
Note that this requires a modern browser other than Internet Explorer.
Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
visible. Older versions of IE do not have SVG support.
' defval='0' depends='HAVE_DOT'/>
<option type='string' id='DOT_PATH' format='dir' docs='
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 in the path.
' defval='' depends='HAVE_DOT'/>
<option type='list' id='DOTFILE_DIRS' format='dir' docs='
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).
' depends='HAVE_DOT'>
</option>
<option type='list' id='MSCFILE_DIRS' format='dir' docs='
The MSCFILE_DIRS tag can be used to specify one or more directories that
contain msc files that are included in the documentation (see the
\mscfile command).
' >
</option>
<option type='int' id='DOT_GRAPH_MAX_NODES' docs='
The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
nodes that will be shown in the graph. If the number of nodes in a graph
becomes larger than this value, doxygen will truncate the graph, which is
visualized by representing a node as a red box. Note that doxygen if the
number of direct children of the root node in a graph is already larger than
DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
' minval='0' maxval='10000' defval='50' depends='HAVE_DOT'/>
<option type='int' id='MAX_DOT_GRAPH_DEPTH' docs='
The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
graphs generated by dot. A depth value of 3 means that only nodes reachable
from the root by following a path via at most 3 edges will be shown. Nodes
that lay further from the root node will be omitted. Note that setting this
option to 1 or 2 may greatly reduce the computation time needed for large
code bases. Also note that the size of a graph can be further restricted by
DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
' minval='0' maxval='1000' defval='0' depends='HAVE_DOT'/>
<option type='bool' id='DOT_TRANSPARENT' docs='
Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
background. This is disabled by default, because dot on Windows does not
seem to support this out of the box. Warning: Depending on the platform used,
enabling this option may lead to badly anti-aliased labels on the edges of
a graph (i.e. they become hard to read).
' defval='0' depends='HAVE_DOT'/>
<option type='bool' id='DOT_MULTI_TARGETS' docs='
Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
files in one run (i.e. multiple -o and -T options on the command line). This
makes dot run faster, but since only newer versions of dot (>1.8.10)
support this, this feature is disabled by default.
' defval='0' depends='HAVE_DOT'/>
<option type='bool' id='GENERATE_LEGEND' docs='
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.
' defval='1' depends='HAVE_DOT'/>
<option type='bool' id='DOT_CLEANUP' docs='
If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
remove the intermediate dot files that are used to generate
the various graphs.
' defval='1' depends='HAVE_DOT'/>
<option type='obsolete' id='USE_WINDOWS_ENCODING'/>
<option type='obsolete' id='DETAILS_AT_TOP'/>
<option type='obsolete' id='QTHELP_FILE'/>
<option type='obsolete' id='QTHELP_CONFIG'/>
<option type='obsolete' id='DOXYGEN2QTHELP_LOC'/>
<option type='obsolete' id='MAX_DOT_GRAPH_WIDTH'/>
<option type='obsolete' id='MAX_DOT_GRAPH_HEIGHT'/>
<option type='obsolete' id='CGI_NAME'/>
<option type='obsolete' id='CGI_URL'/>
<option type='obsolete' id='DOC_URL'/>
<option type='obsolete' id='DOC_ABSPATH'/>
<option type='obsolete' id='BIN_ABSPATH'/>
<option type='obsolete' id='EXT_DOC_PATHS'/>
</group>
</doxygenconfig>
|