binary_data_common.h

Go to the documentation of this file.

/*
** binary_data_common.h
** 

    Copyright (C) 2009 Joseph Pingenot

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

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

** Made by Johnny Q. Hacker
** Login   <solarion@nathan>
** 
** Started on  Tue Nov 24 21:39:16 2009 Johnny Q. Hacker
** Last update Tue Nov 24 21:39:16 2009 Johnny Q. Hacker
*/

#ifndef     BINARY_DATA_COMMON_H_
# define    BINARY_DATA_COMMON_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <glib-2.0/glib.h>

#define DOTCODE_INT_SIZE 4
#define DOTCODE_FLOAT4_SIZE 4
#define DOTCODE_FLOAT8_SIZE 8

enum dotcode_type {
  DOTCODE_INVALID_TYPE = -1,
  DOTCODE_FLOAT8,
  DOTCODE_FLOAT4,
  DOTCODE_INT,
  DOTCODE_SSTRING,
  DOTCODE_VECTOR,
  DOTCODE_ARRAY,
  DOTCODE_TENSOR,
  DOTCODE_GRID
};

struct dotcode_data {
  enum dotcode_type t;
  void* storage;
};

struct dotcode_array {
  enum dotcode_type t;
  int imin;
  int imax;
  void* storage;
};

struct dotcode_vector {
  enum dotcode_type t;
  /*Pointer to an array of 3 t's; cast the pointer to index properly.*/
  void* data;
};

struct dotcode_tensor {
  enum dotcode_type t;
  char* metadata;
  /*Number of dimensions*/
  int Nd;
  /*The min, max indices for each direction. Allocation:
    m + 2*d
    m = min (0) or max (1)
    d = dimension (0<=d<Nd)
   */
  int* indices;
  void* data;
};

/**The *new* grid, not grid1*/
struct dotcode_grid {
  /*X, Y, Z*/
  struct dotcode_array* gridsites[3];
  /*Informational; Ng{x,y,z}_*/
  int Ng[3];
  struct dotcode_tensor* data;
};

enum dotcode_type dotcode_type_from_string(const char* s);
char* dotcode_string_from_type(enum dotcode_type t);
/**This one is nice for using for one-off situations, e.g. error strings*/
const char* dotcode_string_from_type2(enum dotcode_type t);
void flip_endian(char* buffer, int bytes);
int dotcode_get_tensor_index(const struct dotcode_tensor, unsigned int* index);
void dotcode_free_type(enum dotcode_type t, void* ptr, long unsigned int count, 
           GError **err, gboolean free_struct);
/**Appends the type containers in str into a GList of 
 *\param str string containing type template.
 *\param tlist a pointer to a NULL-initialized GList pointer.
 *\param err pointer to a NULL-initialized error pointer.
 */
void dotcode_determine_templated_type(const char* str, GList** tlist, GError **err);

#ifdef __cplusplus
}
#endif

#endif      /* !BINARY_DATA_COMMON_H_ */