trans.h

/* trans.h */
/* trans.h,v 1.13 2001/09/27 17:03:48 ibadm Exp */

/*********************************************************************
 *
 * UNIVERS
 * (C) ¾¾¾ "³µ¾²µÀÁ", 2001
 *
 * ²áÕ ßàÐÒÐ ×ÐéØéÕÝë *
 * ¸áßÞÛì×ÞÒÐÝØÕ, ÚÞßØàÞÒÐÝØÕ ØÛØ ßÕàÕÔÐçÐ àÕÓãÛØàãîâáï ×ÐÚÞÝÐÜØ
 * ÀÞááØÙáÚÞÙ ÄÕÔÕàÐæØØ "¾Ñ ÐÒâÞàáÚÞÜ ßàÐÒÕ Ø áÜÕÖÝëå ßàÐÒÐå", "¾
 * ßàÐÒÞÒÞÙ ÞåàÐÝÕ ßàÞÓàÐÜÜ ÔÛï íÛÕÚâàÞÝÝëå ÒëçØáÛØâÕÛìÝëå ÜÐèØÝ Ø ÑÐ×
 * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __trans_h
#define __trans_h

/***********************************************************************
 *
 * Module for data transformation between different computer
 * architectures.
 *
 ***********************************************************************/

#include <mix/Types.h>


/* Supported architectures. */
typedef enum
{
  /* MSB; SPARC, Power, MC680x0, Network Byte Order */
  trans_big_endian,
  /* LSB; INTEL x86, VAX-11 */
  trans_little_endian,
  /* MSB; IBM S/360 and clones */
  trans_ibm_s360

}   ByteOrder;


/* String equivalents for ByteOrder. */
#define TRANS_BIG_ENDIAN    "sparc,mc68k,power,bigend"
#define TRANS_LITTLE_ENDIAN "intel86,vax11,litend"
#define TRANS_IBM_S360      "ibm360"


/* Supported text encodings. */
typedef enum
{
  trans_enc_unknown,    /* undefined encoding */
  trans_ascii,      /* 8-bits (7-bits informational) */
  trans_ebcdic,     /* 8-bits (equivalent to ASCII) */
  trans_iso8859_5,  /* 8-bits cyrillic ISO 8859-5 (GOST) */
  trans_koi8r,      /* 8-bits cyrillic KOI8-R (Internet) */
  trans_cp866,      /* 8-bits cyrillic CP 866 (alternative, DOS) */
  trans_cp1251,     /* 8-bits cyrillic CP 1251 (windows) */
  trans_gb2312      /* 16-bits chinese + english + greek + cyrillic */

}   TextEncoding;


/***********************************************************************
 * Floating point number Real4 representation for endian transformation.
 ***********************************************************************/
typedef union
{
  UnsInt1   byte[sizeof(Real4)];
  Real4     value;

}   endian_Real4;


/***********************************************************************
 * Floating point number Real4 description for IBM S/360.
 * unsigned sign:1;
 * unsigned exponent:7; 16**(e-64)
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 *
 * Floating point number Real4 description by ANSI/IEEE 754-1985.
 * unsigned sign:1;
 * unsigned exponent:8; 2**(e-128)
 * unsigned fraction2:7;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 ***********************************************************************/
typedef struct
{
  unsigned  sign;       /* 0 means +1; 1 means -1 */
  unsigned  exponent;
  unsigned  fraction;

}   struct_Real4;


/***********************************************************************
 * Floating point number Real8 representation for endian transformation.
 ***********************************************************************/
typedef union
{
  UnsInt1   byte[sizeof(Real8)];
  Real8     value;

}   endian_Real8;


/***********************************************************************
 * Floating point number Real8 description for IBM S/360.
 * unsigned sign:1;
 * unsigned exponent:7; 16**(e-64)
 * unsigned fraction6:8;
 * unsigned fraction5:8;
 * unsigned fraction4:8;
 * unsigned fraction3:8;
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 *
 * Floating point number Real8 description by ANSI/IEEE 754-1985.
 * unsigned sign:1;
 * unsigned exponent:11;    2**(e-1024)
 * unsigned fraction6:4;
 * unsigned fraction5:8;
 * unsigned fraction4:8;
 * unsigned fraction3:8;
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 ***********************************************************************/
typedef struct
{
  unsigned  sign;       /* 0 means +1; 1 means -1 */
  unsigned  exponent;
  unsigned  fraction1;
  unsigned  fraction0;

}   struct_Real8;


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


/***********************************************************************
 * Service functions.  Pointer address alignment insensitive.
 ***********************************************************************/

/* Procedure to exchange 8 bytes MSB<->LSB at the pointer. */
void    trans_endian_8b (void* pInPlace);

/* Procedure to exchange 4 bytes MSB<->LSB at the pointer. */
void    trans_endian_4b (void* pInPlace);

/* Procedure to exchange 2 bytes MSB<->LSB at the pointer. */
void    trans_endian_2b (void* pInPlace);

/* Procedure to determine actual computer architecture. */
ByteOrder   trans_smart ();

/* Procedures for conversion ByteOrder id to string and vise versa. */
const char* trans_to_string (ByteOrder trans_type);
ByteOrder   string_to_trans (const char* str);

/* Procedures for conversion text encoding id to string and vise versa. */
const char* textenc_to_label (TextEncoding textenc);
const char* textenc_to_string (TextEncoding textenc);
TextEncoding    string_to_textenc (const char* str);

/* Determine atom type for representing given text encoding. */
AtomType    textenc_atom (TextEncoding textenc);


/***********************************************************************
 * Unified structured representation of float numbers.
 ***********************************************************************/

  /*
   *  REAL*4
   */

/* Transform float of given endian and architecture (ANSI/IEEE
   754-1985 or IBM S/360) to structured format. */
void    trans_Real4_to_struct (const void* pValue, ByteOrder eFloatArch,
                   struct_Real4* pStruct);

/* Transform structured format to float of needed endian and
   architecture (ANSI/IEEE 754-1985 or IBM S/360). */
void    trans_struct_to_Real4 (void* pValue, ByteOrder eFloatArch,
                   const struct_Real4* pStruct);


  /*
   *  REAL*8
   */

/* Transform float of given endian and architecture (ANSI/IEEE
   754-1985 or IBM S/360) to structured format. */
void    trans_Real8_to_struct (const void* pValue, ByteOrder eFloatArch,
                   struct_Real8* pStruct);

/* Transform structured format to float of needed endian and
   architecture (ANSI/IEEE 754-1985 or IBM S/360). */
void    trans_struct_to_Real8 (void* pValue, ByteOrder eFloatArch,
                   const struct_Real8* pStruct);


/***********************************************************************
 * Language <-> encoding.
 *
 * Due to usual encoding supports few languages and each non-English
 * language has many different encodings, "favorite" term is set.
 *
 * For example, there are many cyrillic encodings: "koi8-r", "iso-8859-5",
 * "cp1251", "cp866" etc, but favorite text encoding for "ru" language is
 * "iso-8859-5" (inside UNIVERS package of course :-).
 * Each encoding contains latin chars, but favorite language for the
 * "iso-8859-5" encoding is "ru", because this language is target for it.
 *
 * Next two functions perform two way "favoritism":
 ***********************************************************************/

/* Get favorite text encoding for the given language */
TextEncoding    lang_to_textenc (const char* lang);

/* Return favorite language of this encoding */
const char* textenc_to_lang (TextEncoding textenc);


/***********************************************************************
 * Elementary transformation functions.
 * The pointer pInPlace must be aligned to 4-bytes (2-bytes for Int2)
 * boundary.  Alignment for Char pointers isn't needed.
 ***********************************************************************/

/* Procedure of floating point Real4 number transformation. */
int trans_one_Real4 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);

/* Procedure of floating point Real8 number transformation. */
/* NOT TESTED! trans_ibm_s360<->trans_*_endian IEEE maybe BUGGY! */
int trans_one_Real8 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);

#ifdef CompilerIs64bitReady
/* Procedure of signed integer Int8 number transformation. */
int trans_one_Int8 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);
#endif /* CompilerIs64bitReady */

/* Procedure of signed integer Int4 number transformation. */
int trans_one_Int4 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of signed integer Int2 number transformation. */
int trans_one_Int2 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of signed integer Int1 number transformation. */
int trans_one_Int1 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of character transformation. */
int trans_one_Char (TextEncoding trans_target, TextEncoding trans_source,
            void* pInPlace);

/* Procedure of 2-byte character transformation. */
int trans_one_Char2 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);


/***********************************************************************
 * Batch transformation functions.
 * Pointers pTarget and pSource must be aligned to 4-bytes (2-bytes for
 * Int2) boundary.  Alignment for Char pointers isn't needed.
 ***********************************************************************/

/* Procedure of floating point Real4 number's array transformation. */
int trans_many_Real4 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

/* Procedure of floating point Real8 number's array transformation. */
  /* NOT TESTED! trans_ibm_s360<->trans_*_endian IEEE maybe BUGGY! */
int trans_many_Real8 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

#ifdef CompilerIs64bitReady
/* Procedure of signed integer Int8 number's array transformation. */
int trans_many_Int8 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);
#endif /* CompilerIs64bitReady */

/* Procedure of signed integer Int4 number's array transformation. */
int trans_many_Int4 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of signed integer Int2 number's array transformation. */
int trans_many_Int2 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of signed integer Int1 number's array transformation. */
int trans_many_Int1 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of 2-byte character's array transformation. */
int trans_many_Char2 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

/* Procedure of character's array transformation. */
int trans_many_Char (TextEncoding trans_target, void* pTarget,
             TextEncoding trans_source, const void* pSource,
             unsigned long count);


/***********************************************************************
 * Batch data transformation functions of given type.
 ***********************************************************************/

/* Procedure for given data type (numbers, Char2) array transformation. */
int trans_numbers (AtomType atom_type,
               ByteOrder trans_target, void* pTarget,
               ByteOrder trans_source, const void* pSource,
               unsigned long count);

/* Procedure for given string (1-byte chars) transformation. */
int trans_string (TextEncoding trans_target, Char* szTarget,
              TextEncoding trans_source, const Char* szSource);


/***********************************************************************
 * Char2 <-> multibyte char string translations.
 * ASCII + something in second part of 8bits table (c2enc dependent).
 ***********************************************************************/

/* Translate multibyte string to one two-byte char */
int trans_get_Char2 (TextEncoding c2enc, Char2* c2symbol,
             const char* mbs);

/* Translate multibyte string to one two-byte char */
int trans_put_Char2 (TextEncoding c2enc, Char* mbs,
             Char2 c2symbol);


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

#endif /* trans.h */

 *
 * ¸áßÞÛì×ÞÒÐÝØÕ, ÚÞßØàÞÒÐÝØÕ ØÛØ ßÕàÕÔÐçÐ àÕÓãÛØàãîâáï ×ÐÚÞÝÐÜØ
 * ÀÞááØÙáÚÞÙ ÄÕÔÕàÐæØØ "¾Ñ ÐÒâÞàáÚÞÜ ßàÐÒÕ Ø áÜÕÖÝëå ßàÐÒÐå", "¾ * ßàÐÒÞÒÞÙ ÞåàÐÝÕ ßàÞÓàÐÜÜ ÔÛï íÛÕÚâàÞÝÝëå ÒëçØáÛØâÕÛìÝëå ÜÐèØÝ Ø ÑÐ×
 * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __trans_h
#define __trans_h

/***********************************************************************
 *
 * Module for data transformation between different computer
 * architectures.
 *
 ***********************************************************************/

#include <mix/Types.h>


/* Supported architectures. */
typedef enum
{
  /* MSB; SPARC, Power, MC680x0, Network Byte Order */
  trans_big_endian,
  /* LSB; INTEL x86, VAX-11 */
  trans_little_endian,
  /* MSB; IBM S/360 and clones */
  trans_ibm_s360

}   ByteOrder;


/* String equivalents for ByteOrder. */
#define TRANS_BIG_ENDIAN    "sparc,mc68k,power,bigend"
#define TRANS_LITTLE_ENDIAN "intel86,vax11,litend"
#define TRANS_IBM_S360      "ibm360"


/* Supported text encodings. */
typedef enum
{
  trans_enc_unknown,    /* undefined encoding */
  trans_ascii,      /* 8-bits (7-bits informational) */
  trans_ebcdic,     /* 8-bits (equivalent to ASCII) */
  trans_iso8859_5,  /* 8-bits cyrillic ISO 8859-5 (GOST) */
  trans_koi8r,      /* 8-bits cyrillic KOI8-R (Internet) */
  trans_cp866,      /* 8-bits cyrillic CP 866 (alternative, DOS) */
  trans_cp1251,     /* 8-bits cyrillic CP 1251 (windows) */
  trans_gb2312      /* 16-bits chinese + english + greek + cyrillic */

}   TextEncoding;


/***********************************************************************
 * Floating point number Real4 representation for endian transformation.
 ***********************************************************************/
typedef union
{
  UnsInt1   byte[sizeof(Real4)];
  Real4     value;

}   endian_Real4;


/***********************************************************************
 * Floating point number Real4 description for IBM S/360.
 * unsigned sign:1;
 * unsigned exponent:7; 16**(e-64)
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 *
 * Floating point number Real4 description by ANSI/IEEE 754-1985.
 * unsigned sign:1;
 * unsigned exponent:8; 2**(e-128)
 * unsigned fraction2:7;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 ***********************************************************************/
typedef struct
{
  unsigned  sign;       /* 0 means +1; 1 means -1 */
  unsigned  exponent;
  unsigned  fraction;

}   struct_Real4;


/***********************************************************************
 * Floating point number Real8 representation for endian transformation.
 ***********************************************************************/
typedef union
{
  UnsInt1   byte[sizeof(Real8)];
  Real8     value;

}   endian_Real8;


/***********************************************************************
 * Floating point number Real8 description for IBM S/360.
 * unsigned sign:1;
 * unsigned exponent:7; 16**(e-64)
 * unsigned fraction6:8;
 * unsigned fraction5:8;
 * unsigned fraction4:8;
 * unsigned fraction3:8;
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 *
 * Floating point number Real8 description by ANSI/IEEE 754-1985.
 * unsigned sign:1;
 * unsigned exponent:11;    2**(e-1024)
 * unsigned fraction6:4;
 * unsigned fraction5:8;
 * unsigned fraction4:8;
 * unsigned fraction3:8;
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 ***********************************************************************/
typedef struct
{
  unsigned  sign;       /* 0 means +1; 1 means -1 */
  unsigned  exponent;
  unsigned  fraction1;
  unsigned  fraction0;

}   struct_Real8;


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


/***********************************************************************
 * Service functions.  Pointer address alignment insensitive.
 ***********************************************************************/

/* Procedure to exchange 8 bytes MSB<->LSB at the pointer. */
void    trans_endian_8b (void* pInPlace);

/* Procedure to exchange 4 bytes MSB<->LSB at the pointer. */
void    trans_endian_4b (void* pInPlace);

/* Procedure to exchange 2 bytes MSB<->LSB at the pointer. */
void    trans_endian_2b (void* pInPlace);

/* Procedure to determine actual computer architecture. */
ByteOrder   trans_smart ();

/* Procedures for conversion ByteOrder id to string and vise versa. */
const char* trans_to_string (ByteOrder trans_type);
ByteOrder   string_to_trans (const char* str);

/* Procedures for conversion text encoding id to string and vise versa. */
const char* textenc_to_label (TextEncoding textenc);
const char* textenc_to_string (TextEncoding textenc);
TextEncoding    string_to_textenc (const char* str);

/* Determine atom type for representing given text encoding. */
AtomType    textenc_atom (TextEncoding textenc);


/***********************************************************************
 * Unified structured representation of float numbers.
 ***********************************************************************/

  /*
   *  REAL*4
   */

/* Transform float of given endian and architecture (ANSI/IEEE
   754-1985 or IBM S/360) to structured format. */
void    trans_Real4_to_struct (const void* pValue, ByteOrder eFloatArch,
                   struct_Real4* pStruct);

/* Transform structured format to float of needed endian and
   architecture (ANSI/IEEE 754-1985 or IBM S/360). */
void    trans_struct_to_Real4 (void* pValue, ByteOrder eFloatArch,
                   const struct_Real4* pStruct);


  /*
   *  REAL*8
   */

/* Transform float of given endian and architecture (ANSI/IEEE
   754-1985 or IBM S/360) to structured format. */
void    trans_Real8_to_struct (const void* pValue, ByteOrder eFloatArch,
                   struct_Real8* pStruct);

/* Transform structured format to float of needed endian and
   architecture (ANSI/IEEE 754-1985 or IBM S/360). */
void    trans_struct_to_Real8 (void* pValue, ByteOrder eFloatArch,
                   const struct_Real8* pStruct);


/***********************************************************************
 * Language <-> encoding.
 *
 * Due to usual encoding supports few languages and each non-English
 * language has many different encodings, "favorite" term is set.
 *
 * For example, there are many cyrillic encodings: "koi8-r", "iso-8859-5",
 * "cp1251", "cp866" etc, but favorite text encoding for "ru" language is
 * "iso-8859-5" (inside UNIVERS package of course :-).
 * Each encoding contains latin chars, but favorite language for the
 * "iso-8859-5" encoding is "ru", because this language is target for it.
 *
 * Next two functions perform two way "favoritism":
 ***********************************************************************/

/* Get favorite text encoding for the given language */
TextEncoding    lang_to_textenc (const char* lang);

/* Return favorite language of this encoding */
const char* textenc_to_lang (TextEncoding textenc);


/***********************************************************************
 * Elementary transformation functions.
 * The pointer pInPlace must be aligned to 4-bytes (2-bytes for Int2)
 * boundary.  Alignment for Char pointers isn't needed.
 ***********************************************************************/

/* Procedure of floating point Real4 number transformation. */
int trans_one_Real4 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);

/* Procedure of floating point Real8 number transformation. */
/* NOT TESTED! trans_ibm_s360<->trans_*_endian IEEE maybe BUGGY! */
int trans_one_Real8 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);

#ifdef CompilerIs64bitReady
/* Procedure of signed integer Int8 number transformation. */
int trans_one_Int8 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);
#endif /* CompilerIs64bitReady */

/* Procedure of signed integer Int4 number transformation. */
int trans_one_Int4 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of signed integer Int2 number transformation. */
int trans_one_Int2 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of signed integer Int1 number transformation. */
int trans_one_Int1 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of character transformation. */
int trans_one_Char (TextEncoding trans_target, TextEncoding trans_source,
            void* pInPlace);

/* Procedure of 2-byte character transformation. */
int trans_one_Char2 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);


/***********************************************************************
 * Batch transformation functions.
 * Pointers pTarget and pSource must be aligned to 4-bytes (2-bytes for
 * Int2) boundary.  Alignment for Char pointers isn't needed.
 ***********************************************************************/

/* Procedure of floating point Real4 number's array transformation. */
int trans_many_Real4 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

/* Procedure of floating point Real8 number's array transformation. */
  /* NOT TESTED! trans_ibm_s360<->trans_*_endian IEEE maybe BUGGY! */
int trans_many_Real8 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

#ifdef CompilerIs64bitReady
/* Procedure of signed integer Int8 number's array transformation. */
int trans_many_Int8 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);
#endif /* CompilerIs64bitReady */

/* Procedure of signed integer Int4 number's array transformation. */
int trans_many_Int4 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of signed integer Int2 number's array transformation. */
int trans_many_Int2 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of signed integer Int1 number's array transformation. */
int trans_many_Int1 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of 2-byte character's array transformation. */
int trans_many_Char2 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

/* Procedure of character's array transformation. */
int trans_many_Char (TextEncoding trans_target, void* pTarget,
             TextEncoding trans_source, const void* pSource,
             unsigned long count);


/***********************************************************************
 * Batch data transformation functions of given type.
 ***********************************************************************/

/* Procedure for given data type (numbers, Char2) array transformation. */
int trans_numbers (AtomType atom_type,
               ByteOrder trans_target, void* pTarget,
               ByteOrder trans_source, const void* pSource,
               unsigned long count);

/* Procedure for given string (1-byte chars) transformation. */
int trans_string (TextEncoding trans_target, Char* szTarget,
              TextEncoding trans_source, const Char* szSource);


/***********************************************************************
 * Char2 <-> multibyte char string translations.
 * ASCII + something in second part of 8bits table (c2enc dependent).
 ***********************************************************************/

/* Translate multibyte string to one two-byte char */
int trans_get_Char2 (TextEncoding c2enc, Char2* c2symbol,
             const char* mbs);

/* Translate multibyte string to one two-byte char */
int trans_put_Char2 (TextEncoding c2enc, Char* mbs,
             Char2 c2symbol);


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

#endif /* trans.h */

 * ßàÐÒÞÒÞÙ ÞåàÐÝÕ ßàÞÓàÐÜÜ ÔÛï íÛÕÚâàÞÝÝëå ÒëçØáÛØâÕÛìÝëå ÜÐèØÝ Ø ÑÐ× * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __trans_h
#define __trans_h

/***********************************************************************
 *
 * Module for data transformation between different computer
 * architectures.
 *
 ***********************************************************************/

#include <mix/Types.h>


/* Supported architectures. */
typedef enum
{
  /* MSB; SPARC, Power, MC680x0, Network Byte Order */
  trans_big_endian,
  /* LSB; INTEL x86, VAX-11 */
  trans_little_endian,
  /* MSB; IBM S/360 and clones */
  trans_ibm_s360

}   ByteOrder;


/* String equivalents for ByteOrder. */
#define TRANS_BIG_ENDIAN    "sparc,mc68k,power,bigend"
#define TRANS_LITTLE_ENDIAN "intel86,vax11,litend"
#define TRANS_IBM_S360      "ibm360"


/* Supported text encodings. */
typedef enum
{
  trans_enc_unknown,    /* undefined encoding */
  trans_ascii,      /* 8-bits (7-bits informational) */
  trans_ebcdic,     /* 8-bits (equivalent to ASCII) */
  trans_iso8859_5,  /* 8-bits cyrillic ISO 8859-5 (GOST) */
  trans_koi8r,      /* 8-bits cyrillic KOI8-R (Internet) */
  trans_cp866,      /* 8-bits cyrillic CP 866 (alternative, DOS) */
  trans_cp1251,     /* 8-bits cyrillic CP 1251 (windows) */
  trans_gb2312      /* 16-bits chinese + english + greek + cyrillic */

}   TextEncoding;


/***********************************************************************
 * Floating point number Real4 representation for endian transformation.
 ***********************************************************************/
typedef union
{
  UnsInt1   byte[sizeof(Real4)];
  Real4     value;

}   endian_Real4;


/***********************************************************************
 * Floating point number Real4 description for IBM S/360.
 * unsigned sign:1;
 * unsigned exponent:7; 16**(e-64)
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 *
 * Floating point number Real4 description by ANSI/IEEE 754-1985.
 * unsigned sign:1;
 * unsigned exponent:8; 2**(e-128)
 * unsigned fraction2:7;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 ***********************************************************************/
typedef struct
{
  unsigned  sign;       /* 0 means +1; 1 means -1 */
  unsigned  exponent;
  unsigned  fraction;

}   struct_Real4;


/***********************************************************************
 * Floating point number Real8 representation for endian transformation.
 ***********************************************************************/
typedef union
{
  UnsInt1   byte[sizeof(Real8)];
  Real8     value;

}   endian_Real8;


/***********************************************************************
 * Floating point number Real8 description for IBM S/360.
 * unsigned sign:1;
 * unsigned exponent:7; 16**(e-64)
 * unsigned fraction6:8;
 * unsigned fraction5:8;
 * unsigned fraction4:8;
 * unsigned fraction3:8;
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 *
 * Floating point number Real8 description by ANSI/IEEE 754-1985.
 * unsigned sign:1;
 * unsigned exponent:11;    2**(e-1024)
 * unsigned fraction6:4;
 * unsigned fraction5:8;
 * unsigned fraction4:8;
 * unsigned fraction3:8;
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 ***********************************************************************/
typedef struct
{
  unsigned  sign;       /* 0 means +1; 1 means -1 */
  unsigned  exponent;
  unsigned  fraction1;
  unsigned  fraction0;

}   struct_Real8;


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


/***********************************************************************
 * Service functions.  Pointer address alignment insensitive.
 ***********************************************************************/

/* Procedure to exchange 8 bytes MSB<->LSB at the pointer. */
void    trans_endian_8b (void* pInPlace);

/* Procedure to exchange 4 bytes MSB<->LSB at the pointer. */
void    trans_endian_4b (void* pInPlace);

/* Procedure to exchange 2 bytes MSB<->LSB at the pointer. */
void    trans_endian_2b (void* pInPlace);

/* Procedure to determine actual computer architecture. */
ByteOrder   trans_smart ();

/* Procedures for conversion ByteOrder id to string and vise versa. */
const char* trans_to_string (ByteOrder trans_type);
ByteOrder   string_to_trans (const char* str);

/* Procedures for conversion text encoding id to string and vise versa. */
const char* textenc_to_label (TextEncoding textenc);
const char* textenc_to_string (TextEncoding textenc);
TextEncoding    string_to_textenc (const char* str);

/* Determine atom type for representing given text encoding. */
AtomType    textenc_atom (TextEncoding textenc);


/***********************************************************************
 * Unified structured representation of float numbers.
 ***********************************************************************/

  /*
   *  REAL*4
   */

/* Transform float of given endian and architecture (ANSI/IEEE
   754-1985 or IBM S/360) to structured format. */
void    trans_Real4_to_struct (const void* pValue, ByteOrder eFloatArch,
                   struct_Real4* pStruct);

/* Transform structured format to float of needed endian and
   architecture (ANSI/IEEE 754-1985 or IBM S/360). */
void    trans_struct_to_Real4 (void* pValue, ByteOrder eFloatArch,
                   const struct_Real4* pStruct);


  /*
   *  REAL*8
   */

/* Transform float of given endian and architecture (ANSI/IEEE
   754-1985 or IBM S/360) to structured format. */
void    trans_Real8_to_struct (const void* pValue, ByteOrder eFloatArch,
                   struct_Real8* pStruct);

/* Transform structured format to float of needed endian and
   architecture (ANSI/IEEE 754-1985 or IBM S/360). */
void    trans_struct_to_Real8 (void* pValue, ByteOrder eFloatArch,
                   const struct_Real8* pStruct);


/***********************************************************************
 * Language <-> encoding.
 *
 * Due to usual encoding supports few languages and each non-English
 * language has many different encodings, "favorite" term is set.
 *
 * For example, there are many cyrillic encodings: "koi8-r", "iso-8859-5",
 * "cp1251", "cp866" etc, but favorite text encoding for "ru" language is
 * "iso-8859-5" (inside UNIVERS package of course :-).
 * Each encoding contains latin chars, but favorite language for the
 * "iso-8859-5" encoding is "ru", because this language is target for it.
 *
 * Next two functions perform two way "favoritism":
 ***********************************************************************/

/* Get favorite text encoding for the given language */
TextEncoding    lang_to_textenc (const char* lang);

/* Return favorite language of this encoding */
const char* textenc_to_lang (TextEncoding textenc);


/***********************************************************************
 * Elementary transformation functions.
 * The pointer pInPlace must be aligned to 4-bytes (2-bytes for Int2)
 * boundary.  Alignment for Char pointers isn't needed.
 ***********************************************************************/

/* Procedure of floating point Real4 number transformation. */
int trans_one_Real4 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);

/* Procedure of floating point Real8 number transformation. */
/* NOT TESTED! trans_ibm_s360<->trans_*_endian IEEE maybe BUGGY! */
int trans_one_Real8 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);

#ifdef CompilerIs64bitReady
/* Procedure of signed integer Int8 number transformation. */
int trans_one_Int8 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);
#endif /* CompilerIs64bitReady */

/* Procedure of signed integer Int4 number transformation. */
int trans_one_Int4 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of signed integer Int2 number transformation. */
int trans_one_Int2 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of signed integer Int1 number transformation. */
int trans_one_Int1 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of character transformation. */
int trans_one_Char (TextEncoding trans_target, TextEncoding trans_source,
            void* pInPlace);

/* Procedure of 2-byte character transformation. */
int trans_one_Char2 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);


/***********************************************************************
 * Batch transformation functions.
 * Pointers pTarget and pSource must be aligned to 4-bytes (2-bytes for
 * Int2) boundary.  Alignment for Char pointers isn't needed.
 ***********************************************************************/

/* Procedure of floating point Real4 number's array transformation. */
int trans_many_Real4 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

/* Procedure of floating point Real8 number's array transformation. */
  /* NOT TESTED! trans_ibm_s360<->trans_*_endian IEEE maybe BUGGY! */
int trans_many_Real8 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

#ifdef CompilerIs64bitReady
/* Procedure of signed integer Int8 number's array transformation. */
int trans_many_Int8 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);
#endif /* CompilerIs64bitReady */

/* Procedure of signed integer Int4 number's array transformation. */
int trans_many_Int4 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of signed integer Int2 number's array transformation. */
int trans_many_Int2 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of signed integer Int1 number's array transformation. */
int trans_many_Int1 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of 2-byte character's array transformation. */
int trans_many_Char2 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

/* Procedure of character's array transformation. */
int trans_many_Char (TextEncoding trans_target, void* pTarget,
             TextEncoding trans_source, const void* pSource,
             unsigned long count);


/***********************************************************************
 * Batch data transformation functions of given type.
 ***********************************************************************/

/* Procedure for given data type (numbers, Char2) array transformation. */
int trans_numbers (AtomType atom_type,
               ByteOrder trans_target, void* pTarget,
               ByteOrder trans_source, const void* pSource,
               unsigned long count);

/* Procedure for given string (1-byte chars) transformation. */
int trans_string (TextEncoding trans_target, Char* szTarget,
              TextEncoding trans_source, const Char* szSource);


/***********************************************************************
 * Char2 <-> multibyte char string translations.
 * ASCII + something in second part of 8bits table (c2enc dependent).
 ***********************************************************************/

/* Translate multibyte string to one two-byte char */
int trans_get_Char2 (TextEncoding c2enc, Char2* c2symbol,
             const char* mbs);

/* Translate multibyte string to one two-byte char */
int trans_put_Char2 (TextEncoding c2enc, Char* mbs,
             Char2 c2symbol);


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

#endif /* trans.h */

 * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __trans_h
#define __trans_h

/***********************************************************************
 *
 * Module for data transformation between different computer
 * architectures.
 *
 ***********************************************************************/

#include <mix/Types.h>


/* Supported architectures. */
typedef enum
{
  /* MSB; SPARC, Power, MC680x0, Network Byte Order */
  trans_big_endian,
  /* LSB; INTEL x86, VAX-11 */
  trans_little_endian,
  /* MSB; IBM S/360 and clones */
  trans_ibm_s360

}   ByteOrder;


/* String equivalents for ByteOrder. */
#define TRANS_BIG_ENDIAN    "sparc,mc68k,power,bigend"
#define TRANS_LITTLE_ENDIAN "intel86,vax11,litend"
#define TRANS_IBM_S360      "ibm360"


/* Supported text encodings. */
typedef enum
{
  trans_enc_unknown,    /* undefined encoding */
  trans_ascii,      /* 8-bits (7-bits informational) */
  trans_ebcdic,     /* 8-bits (equivalent to ASCII) */
  trans_iso8859_5,  /* 8-bits cyrillic ISO 8859-5 (GOST) */
  trans_koi8r,      /* 8-bits cyrillic KOI8-R (Internet) */
  trans_cp866,      /* 8-bits cyrillic CP 866 (alternative, DOS) */
  trans_cp1251,     /* 8-bits cyrillic CP 1251 (windows) */
  trans_gb2312      /* 16-bits chinese + english + greek + cyrillic */

}   TextEncoding;


/***********************************************************************
 * Floating point number Real4 representation for endian transformation.
 ***********************************************************************/
typedef union
{
  UnsInt1   byte[sizeof(Real4)];
  Real4     value;

}   endian_Real4;


/***********************************************************************
 * Floating point number Real4 description for IBM S/360.
 * unsigned sign:1;
 * unsigned exponent:7; 16**(e-64)
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 *
 * Floating point number Real4 description by ANSI/IEEE 754-1985.
 * unsigned sign:1;
 * unsigned exponent:8; 2**(e-128)
 * unsigned fraction2:7;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 ***********************************************************************/
typedef struct
{
  unsigned  sign;       /* 0 means +1; 1 means -1 */
  unsigned  exponent;
  unsigned  fraction;

}   struct_Real4;


/***********************************************************************
 * Floating point number Real8 representation for endian transformation.
 ***********************************************************************/
typedef union
{
  UnsInt1   byte[sizeof(Real8)];
  Real8     value;

}   endian_Real8;


/***********************************************************************
 * Floating point number Real8 description for IBM S/360.
 * unsigned sign:1;
 * unsigned exponent:7; 16**(e-64)
 * unsigned fraction6:8;
 * unsigned fraction5:8;
 * unsigned fraction4:8;
 * unsigned fraction3:8;
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 *
 * Floating point number Real8 description by ANSI/IEEE 754-1985.
 * unsigned sign:1;
 * unsigned exponent:11;    2**(e-1024)
 * unsigned fraction6:4;
 * unsigned fraction5:8;
 * unsigned fraction4:8;
 * unsigned fraction3:8;
 * unsigned fraction2:8;
 * unsigned fraction1:8;
 * unsigned fraction0:8;
 ***********************************************************************/
typedef struct
{
  unsigned  sign;       /* 0 means +1; 1 means -1 */
  unsigned  exponent;
  unsigned  fraction1;
  unsigned  fraction0;

}   struct_Real8;


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


/***********************************************************************
 * Service functions.  Pointer address alignment insensitive.
 ***********************************************************************/

/* Procedure to exchange 8 bytes MSB<->LSB at the pointer. */
void    trans_endian_8b (void* pInPlace);

/* Procedure to exchange 4 bytes MSB<->LSB at the pointer. */
void    trans_endian_4b (void* pInPlace);

/* Procedure to exchange 2 bytes MSB<->LSB at the pointer. */
void    trans_endian_2b (void* pInPlace);

/* Procedure to determine actual computer architecture. */
ByteOrder   trans_smart ();

/* Procedures for conversion ByteOrder id to string and vise versa. */
const char* trans_to_string (ByteOrder trans_type);
ByteOrder   string_to_trans (const char* str);

/* Procedures for conversion text encoding id to string and vise versa. */
const char* textenc_to_label (TextEncoding textenc);
const char* textenc_to_string (TextEncoding textenc);
TextEncoding    string_to_textenc (const char* str);

/* Determine atom type for representing given text encoding. */
AtomType    textenc_atom (TextEncoding textenc);


/***********************************************************************
 * Unified structured representation of float numbers.
 ***********************************************************************/

  /*
   *  REAL*4
   */

/* Transform float of given endian and architecture (ANSI/IEEE
   754-1985 or IBM S/360) to structured format. */
void    trans_Real4_to_struct (const void* pValue, ByteOrder eFloatArch,
                   struct_Real4* pStruct);

/* Transform structured format to float of needed endian and
   architecture (ANSI/IEEE 754-1985 or IBM S/360). */
void    trans_struct_to_Real4 (void* pValue, ByteOrder eFloatArch,
                   const struct_Real4* pStruct);


  /*
   *  REAL*8
   */

/* Transform float of given endian and architecture (ANSI/IEEE
   754-1985 or IBM S/360) to structured format. */
void    trans_Real8_to_struct (const void* pValue, ByteOrder eFloatArch,
                   struct_Real8* pStruct);

/* Transform structured format to float of needed endian and
   architecture (ANSI/IEEE 754-1985 or IBM S/360). */
void    trans_struct_to_Real8 (void* pValue, ByteOrder eFloatArch,
                   const struct_Real8* pStruct);


/***********************************************************************
 * Language <-> encoding.
 *
 * Due to usual encoding supports few languages and each non-English
 * language has many different encodings, "favorite" term is set.
 *
 * For example, there are many cyrillic encodings: "koi8-r", "iso-8859-5",
 * "cp1251", "cp866" etc, but favorite text encoding for "ru" language is
 * "iso-8859-5" (inside UNIVERS package of course :-).
 * Each encoding contains latin chars, but favorite language for the
 * "iso-8859-5" encoding is "ru", because this language is target for it.
 *
 * Next two functions perform two way "favoritism":
 ***********************************************************************/

/* Get favorite text encoding for the given language */
TextEncoding    lang_to_textenc (const char* lang);

/* Return favorite language of this encoding */
const char* textenc_to_lang (TextEncoding textenc);


/***********************************************************************
 * Elementary transformation functions.
 * The pointer pInPlace must be aligned to 4-bytes (2-bytes for Int2)
 * boundary.  Alignment for Char pointers isn't needed.
 ***********************************************************************/

/* Procedure of floating point Real4 number transformation. */
int trans_one_Real4 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);

/* Procedure of floating point Real8 number transformation. */
/* NOT TESTED! trans_ibm_s360<->trans_*_endian IEEE maybe BUGGY! */
int trans_one_Real8 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);

#ifdef CompilerIs64bitReady
/* Procedure of signed integer Int8 number transformation. */
int trans_one_Int8 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);
#endif /* CompilerIs64bitReady */

/* Procedure of signed integer Int4 number transformation. */
int trans_one_Int4 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of signed integer Int2 number transformation. */
int trans_one_Int2 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of signed integer Int1 number transformation. */
int trans_one_Int1 (ByteOrder trans_target, ByteOrder trans_source,
            void* pInPlace);

/* Procedure of character transformation. */
int trans_one_Char (TextEncoding trans_target, TextEncoding trans_source,
            void* pInPlace);

/* Procedure of 2-byte character transformation. */
int trans_one_Char2 (ByteOrder trans_target, ByteOrder trans_source,
             void* pInPlace);


/***********************************************************************
 * Batch transformation functions.
 * Pointers pTarget and pSource must be aligned to 4-bytes (2-bytes for
 * Int2) boundary.  Alignment for Char pointers isn't needed.
 ***********************************************************************/

/* Procedure of floating point Real4 number's array transformation. */
int trans_many_Real4 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

/* Procedure of floating point Real8 number's array transformation. */
  /* NOT TESTED! trans_ibm_s360<->trans_*_endian IEEE maybe BUGGY! */
int trans_many_Real8 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

#ifdef CompilerIs64bitReady
/* Procedure of signed integer Int8 number's array transformation. */
int trans_many_Int8 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);
#endif /* CompilerIs64bitReady */

/* Procedure of signed integer Int4 number's array transformation. */
int trans_many_Int4 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of signed integer Int2 number's array transformation. */
int trans_many_Int2 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of signed integer Int1 number's array transformation. */
int trans_many_Int1 (ByteOrder trans_target, void* pTarget,
             ByteOrder trans_source, const void* pSource,
             unsigned long count);

/* Procedure of 2-byte character's array transformation. */
int trans_many_Char2 (ByteOrder trans_target, void* pTarget,
              ByteOrder trans_source, const void* pSource,
              unsigned long count);

/* Procedure of character's array transformation. */
int trans_many_Char (TextEncoding trans_target, void* pTarget,
             TextEncoding trans_source, const void* pSource,
             unsigned long count);


/***********************************************************************
 * Batch data transformation functions of given type.
 ***********************************************************************/

/* Procedure for given data type (numbers, Char2) array transformation. */
int trans_numbers (AtomType atom_type,
               ByteOrder trans_target, void* pTarget,
               ByteOrder trans_source, const void* pSource,
               unsigned long count);

/* Procedure for given string (1-byte chars) transformation. */
int trans_string (TextEncoding trans_target, Char* szTarget,
              TextEncoding trans_source, const Char* szSource);


/***********************************************************************
 * Char2 <-> multibyte char string translations.
 * ASCII + something in second part of 8bits table (c2enc dependent).
 ***********************************************************************/

/* Translate multibyte string to one two-byte char */
int trans_get_Char2 (TextEncoding c2enc, Char2* c2symbol,
             const char* mbs);

/* Translate multibyte string to one two-byte char */
int trans_put_Char2 (TextEncoding c2enc, Char* mbs,
             Char2 c2symbol);


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

#endif /* trans.h */