binfile.h

Go to the documentation of this file.

/***************************************************************************
     binfile.h - Definitions useful for handling KStars binary data files
                             -------------------
    begin                : Sun 27 Jul 2008
    copyright            : (C) 2008 by Akarsh Simha
    email                : akarshsimha@gmail.com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

/* NOTE: This file is a NON portable C file that need not be built for
   KStars to be built.  This file is useful only to generate binary
   data files and ensure that they comply with KStars' format, and
   hence need not be cross platform.

   This file does not use Qt or KDE libraries as it is just provided
   here as a tool to build and test data files for KStars

   Hence, we shall hide this file from the watchful eyes of Krazy
*/
//krazy:skip

#ifndef BINFILE_H
#define BINFILE_H

#include <sys/types.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <math.h>
#include "byteorder.h"

/* NOTE: HTM_LEVEL and other HTM-related stuff must be defined before using this header */

// Bogus Define 
#ifndef INDEX_ENTRY_SIZE
#define INDEX_ENTRY_SIZE 12
#endif

/*
 * enum listing out various possible data types
 */

enum dataType {
    DT_CHAR,              /* Character */
    DT_INT8,              /* 8-bit Integer */
    DT_UINT8,             /* 8-bit Unsigned Integer */
    DT_INT16,             /* 16-bit Integer */
    DT_UINT16,            /* 16-bit Unsigned Integer */
    DT_INT32,             /* 32-bit Integer */
    DT_UINT32,            /* 32-bit Unsigned Integer */
    DT_CHARV,             /* Fixed-length array of characters */
    DT_STR,               /* Variable length array of characters, either terminated by NULL or by the limit on field size */
    DT_SPCL = 128         /* Flag indicating that the field requires special treatment (eg: Different bits may mean different things) */
};

/*
 * struct to store the description of a field / data element in the binary files
 */

typedef struct dataElement {
    char name[10];
    int8_t size;
    u_int8_t type;
    int32_t scale;
} dataElement;

void charv2str(char *str, char *charv, int n) {
    int i;
    for(i = 0; i < n; ++i) {
        *str = *charv;
        str++;
        charv++;
    }
    *str = '\0';
}

int displayDataElementDescription(dataElement *e) {
    char str[11];
    charv2str(str, e -> name, 10);
    printf("\nData Field:\n");
    printf("  Name: %s\n", str);
    printf("  Size: %d\n", e -> size);
    printf("  Type: %d\n", e -> type);
    printf("  Scale: %ld\n", e -> scale);
}

// NOTE: Ineffecient. Not to be used for high-productivity
// applications
void swapbytes(char byteswap, void *ptr, int nbytes) {

    char *destptr;
    char *i;

    if( !byteswap )
        return;

    destptr = (char *)malloc(nbytes);
    i = ((char *)ptr + (nbytes - 1));
    while( i >= (char *)ptr ) {
        *destptr = *i;
        ++destptr;
        --i;
    }

    destptr -= nbytes;

    memcpy(ptr, (void *)destptr, nbytes);
    free(destptr);

}


u_int32_t trixel2number(char *trixel) {
    int index;
    u_int32_t id = 0;
    for( index = HTM_LEVEL + 1; index >= 1; --index ) {
        id += (trixel[ index ] - '0') * (u_int16_t)round( pow(4, (HTM_LEVEL + 1 - index)) );
    }
    id += ( ( trixel[0] == 'S' ) ? round( pow(4, HTM_LEVEL + 1) ) + 1 : 0 );
    return id;
}

char *number2trixel(char *trixel, u_int16_t number) {

    int index;
    u_int16_t hpv = (u_int16_t)round( pow(4, HTM_LEVEL) ) * 2;
    if( number >= hpv ) {
        trixel[ 0 ] = 'S';
        number -= hpv;
    }
    else
        trixel[ 0 ] = 'N';
    hpv /= 2;

    for( index = 1; index < HTM_LEVEL + 2; ++index ) {
        trixel[ index ] = (number - (number % hpv)) / hpv + '0';
        number = number % hpv;
        hpv /= 4;
    }

    trixel[ HTM_LEVEL + 2 ] = '\0';

    return trixel;
}


/*
 * Convert a string to an int32_t with a double as an intermediate
 * i : A pointer to the target int32_t
 * str : A pointer to the string that carries the data
 * ndec : Number of decimal places to truncate to
 */

int str2int32(int32_t *i, const char *str, int ndec) {

  double dbl;

  if(i == NULL)
    return 0;

  dbl = atof(str);

  *i = (int32_t)(round(dbl * pow(10, ndec)));

  return 1;

}

/*
 * Convert a string to an int16_t with a double as an intermediate
 * i : A pointer to the target int16_t
 * str : The string that carries the data
 * ndec : Number of decimal places to truncate to
 */

int str2int16(int16_t *i, const char *str, int ndec) {

  double dbl;

  if(i == NULL || str == NULL)
    return 0;

  dbl = atof(str);

  *i = (int16_t)(round(dbl * pow(10, ndec)));

  return 1;
}

/*
 * Convert a string into a character array for n characters
 * a : The target array
 * str : The string that carries the data
 * n : Number of characters to convert
 */

int str2charv(char *a, const char *str, int n) {

  int i, ret;

  if(a == NULL || str == NULL)
    return 0;

  ret = 1;

  for(i = 0; i < n; ++i) {
    a[i] = ((ret < 0)? '\0' : str[i]);
    if(str[i] == '\0')                /* We can do this safely because we aren't storing binary data in the DB */
      ret = -1;
  }

  return ret;
}

/*
 * Check whether the string passed is blank
 * str : String to check
 * returns 1 if the string is blank, 0 otherwise.
 */

int isblank(char *str) {

  if(str == NULL)
    return 1;

  while(*str != '\0') {
    if(*str != ' ' && *str != '\n' && *str != '\r' && *str != '\t')
      return 0;
    ++str;
  }

  return 1;
}

/*
 * Write one data element description into a binary file header.
 *
 * f    : Handle of file to write into
 * name : Name of the field, as a string. Max as specified in struct dataElement
 * size : Size (in bytes) of the field
 * type : Type of the field, as specified in enum dataType
 * scale : Scale factor used for conversion of fixed-point reals to integers. N/A to DT_CHARV, DT_STR and DT_CHAR
 */

int writeDataElementDescription(FILE *f, char *name, int8_t size, enum dataType type, int32_t scale) {
  struct dataElement de;
  if(f == NULL || name == NULL)
    return 0;
  str2charv(de.name, name, 10);
  de.size = size;
  de.type = type;
  de.scale = scale;
  fwrite(&de, sizeof(struct dataElement), 1, f);
  return 1;
}

int writeIndexEntry(FILE *hf, u_int32_t trixel_id, u_int32_t offset, u_int32_t nrec) {

  if(hf == NULL)
    return 0;

  fwrite(&trixel_id, 4, 1, hf);
  fwrite(&offset, 4, 1, hf);
  fwrite(&nrec, 4, 1, hf);

  /* Put this just for safety, in case we change our mind - we should avoid screwing things up */
  if(4 + 4 + 4 != INDEX_ENTRY_SIZE) {
    fprintf(stderr, "CODE ERROR: 4 + 4 + 4 != INDEX_ENTRY_SIZE\n");
  }

  return 1;
}

/*
 * "Increments" a trixel
 *
 * str : String to hold the incremented trixel
 */
/*
void nextTrixel(char *trixel) {

  char *ptr = trixel + HTM_LEVEL + 1;
  while(ptr > trixel) {
    *ptr = *ptr + 1;
    if(*ptr != '4')
      break;
    *ptr = '0';
    ptr--;
  }
  if(*ptr == 'N')
    *ptr = 'S';
  else if(*ptr == 'S')
    *ptr = '0';
}

*/
#endif