//
// This file is generated by fmtgen from "libaegis/rptidx.def".
// If you want to change the contents of this file
// you need to edit libaegis/rptidx.def
// or you need to enhance fmtgen.
//

#ifndef LIBAEGIS_RPTIDX_H
#define LIBAEGIS_RPTIDX_H

#include <common/str.h>
#include <libaegis/output.h>
#include <libaegis/meta_lex.h>
#include <libaegis/meta_parse.h>
#include <libaegis/meta_type.h>

class nstring; // forward

#ifndef rptidx_where_DEF
#define rptidx_where_DEF

#define rptidx_where_name_mask	((unsigned long)0)
#define rptidx_where_description_mask	((unsigned long)0)
#define rptidx_where_filename_mask  ((unsigned long)0)

struct rptidx_where_ty
{
    long	    reference_count;
    unsigned long   mask;
    string_ty	    *errpos;
    string_ty	    *name;
    string_ty	    *description;
    string_ty	    *filename;
};
#endif // rptidx_where_DEF

extern meta_type rptidx_where_type;

void rptidx_where_write(const output::pointer &fp, const char *name, rptidx_where_ty *value);
void rptidx_where_write_xml(const output::pointer &fp, const char *name, rptidx_where_ty *value);
rptidx_where_ty *rptidx_where_copy(rptidx_where_ty *);
rptidx_where_ty *rptidx_where_clone(rptidx_where_ty *);
#ifdef DEBUG
void rptidx_where_trace_real(const char *name, const rptidx_where_ty *value);
#define rptidx_where_trace(x) ((void)(trace_pretest_ && (trace_where_, rptidx_where_trace_real(trace_stringize(x), x), 0)))
#else
#define rptidx_where_trace(x)
#endif

#ifndef rptidx_where_list_DEF
#define rptidx_where_list_DEF
struct rptidx_where_list_ty
{
    size_t length;
    size_t maximum;
    rptidx_where_ty **list;
};
#endif // rptidx_where_list_DEF

extern meta_type rptidx_where_list_type;

rptidx_where_list_ty *rptidx_where_list_copy(rptidx_where_list_ty *);
rptidx_where_list_ty *rptidx_where_list_clone(rptidx_where_list_ty *);
void rptidx_where_list_write(const output::pointer &fp, const char *name, rptidx_where_list_ty *value);
void rptidx_where_list_write_xml(const output::pointer &fp, const char *name, rptidx_where_list_ty *value);
#ifdef DEBUG
void rptidx_where_list_trace_real(const char *name, const rptidx_where_list_ty *value);
#define rptidx_where_list_trace(x) ((void)(trace_pretest_ && (trace_where_, rptidx_where_list_trace_real(trace_stringize(x), x), 0)))
#else
#define rptidx_where_list_trace(x)
#endif

#ifndef rptidx_DEF
#define rptidx_DEF

#define rptidx_where_mask   ((unsigned long)0)

struct rptidx_ty
{
    long	    reference_count;
    unsigned long   mask;
    string_ty	    *errpos;
    rptidx_where_list_ty *where;
};
#endif // rptidx_DEF

extern meta_type rptidx_type;

void rptidx_write(const output::pointer &fp, rptidx_ty *value);
void rptidx_write_xml(const output::pointer &fp, rptidx_ty *value);
rptidx_ty *rptidx_copy(rptidx_ty *);
rptidx_ty *rptidx_clone(rptidx_ty *);
#ifdef DEBUG
void rptidx_trace_real(const char *name, const rptidx_ty *value);
#define rptidx_trace(x) ((void)(trace_pretest_ && (trace_where_, rptidx_trace_real(trace_stringize(x), x), 0)))
#else
#define rptidx_trace(x)
#endif

/**
* The rptidx_write_file function is used to
* write rptidx meta data to the named file.
*
* @param filename
*     The name of the file to be written.
* @param value
*     The value of the meta-data to be written.
* @param comp
*     true (non-zero) if data should be compressed.
* @note
*      If any errors are encountered, this
*      function will not return.  All errors
*      will print a fatal error message, and
*      exit with an exit status of 1.
*/
void rptidx_write_file(string_ty *filename, rptidx_ty *value, int comp);

/**
* The rptidx_write_file function is used to
* write rptidx meta data to the named file.
*
* @param filnam
*     The name of the file to be written.
* @param value
*     The value of the meta-data to be written.
* @param comp
*     true if data should be compressed.
* @note
*      If any errors are encountered, this
*      function will not return.  All errors
*      will print a fatal error message, and
*      exit with an exit status of 1.
*/
void rptidx_write_file(const nstring &filnam, rptidx_ty *value, bool comp);

/**
* The rptidx_read_file function is used to
* read rptidx meta data from the named file.
*
* @param filename
*     The name of the file to be read.
* @returns
*     a pointer to a dynamically allocated
*     value read from the file.
* @note
*      If any errors are encountered, this
*      function will not return.  All errors
*      (including syntax errors) will print a
*      fatal error message, and exit with an
*      exit status of 1.
*/
rptidx_ty *rptidx_read_file(string_ty *filename);

/**
* The rptidx_read_file function is used to
* read rptidx meta data from the named file.
*
* @param filename
*     The name of the file to be read.
* @returns
*     a pointer to a dynamically allocated
*     value read from the file.
* @note
*      If any errors are encountered, this
*      function will not return.  All errors
*      (including syntax errors) will print a
*      fatal error message, and exit with an
*      exit status of 1.
*/
rptidx_ty *rptidx_read_file(const nstring &filename);
void rptidx__rpt_init(void);

#endif // LIBAEGIS_RPTIDX_H