ReportTools.h

/* ReportTools.h */
/* ReportTools.h,v 1.3 1998/06/09 09:19:13 vlad Exp */
#ifndef __ReportTools_h
#define __ReportTools_h

/***********************************************************************
 *
 *                   Tools for reports building.
 *
 ***********************************************************************/

#include <mix/Types.h>
#include <mix/misc.h>
#include <ldb/dbnamedefs.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


#define RtOverwidthChar     '#'
#define RtBadNumberChar     '?'
#define RtShieldChar        '~'
#define RtDefBadNumberLen   3
#define RtDefaultQuotes     {'\"', '\"'}
#define RtDefaultFillChar   ' '
#define RtDefaultDelimiter  ","


/* Parameters for one field */
typedef struct
  {
    int     flags;      /* ORed flags: */
#define RtAF_PutDelimiter   (1<<0)  /* use delimiter or not */
#define RtAF_FillWidth      (1<<1)  /* is width a limit? */
#define RtAF_AdjustRight    (1<<2)  /* adjust to right side */
                    /* (with RtAF_FillWidth only) */
#define RtAF_PutQuotes      (1<<3)  /* use quotes for string and dbtptr */
                    /* or not? */
    int     width;      /* limited width for field value */
    char    *delimiter; /* delimiter for field */
    char    quotes[2];  /* for string and dbtptr */
    char    fill_char;  /* char for filling to width */
    char    *overwidth; /* overwidth string for field */

  } RtAtomField;


/* Return maximum length (in chars) of pure text representation of
   pointed atom type. */
int RtMaxChars (AtomType atype);

/* Return normal (usual) length (in chars) of pure text representation
   of pointed atom type. */
int RtNormChars (AtomType atype);

/* Return width of atom field with delimiter. */
int RtFieldLength (const RtAtomField* afpar);

/* Return width of atom field with delimiter. */
const char* RtFlagsToString (int flags);



/* Printing to dest string of chars.  It's assumed that dest has
   enough memory to take all printed chars */
char*   RtFormatString (char* dest, const RtAtomField* afpar,
            const char* str);

/* Printing to dest name of db table.  It's assumed that dest has
   enough memory to take all printed chars */
char*   RtFormatDbtName (char* dest, const RtAtomField* afpar,
             const dbNameStruct* ns);

/* Printing double number in dest, assuming that dest can hold all chars
   that will be put. */
char*   RtFormatRealNum (char* dest, const RtAtomField* afpar,
             double num);

/* Printing integer number in dest, assuming that dest can hold all
   chars that will be put. */
char*   RtFormatIntNum (char* dest, const RtAtomField* afpar,
            int num);

/* Printing 64-bit integer number in dest, assuming that dest can hold
   all chars that will be put. */
char*   RtFormatInt8Num (char* dest, const RtAtomField* afpar,
             long long num);


#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* ReportTools.h */