dataio_raw.h

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   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, 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 General Public License for more details.
***********************************************************************/
#ifndef FC__DATAIO_RAW_H
#define FC__DATAIO_RAW_H
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* utility */
#include "bitvector.h"
#include "support.h"            /* bool type */
 
struct cm_parameter;
struct worklist;
struct unit_order;
struct requirement;
struct act_prob;
 
struct data_in {
  const void *src;
  size_t src_size, current;
};
 
struct raw_data_out {
  void *dest;
  size_t dest_size, used, current;
  bool too_short;              /* set to 1 if try to read past end */
};
 
/* Used for dio_<put|get>_type() methods.
 * NB: we only support integer handling currently. */
enum data_type {
  DIOT_UINT8,
  DIOT_UINT16,
  DIOT_UINT32,
  DIOT_SINT8,
  DIOT_SINT16,
  DIOT_SINT32,
 
  DIOT_LAST
};
 
/* What a location inside a packet is. */
enum plocation_kind {
  /* A field. Addressed by its name. */
  PADR_FIELD,
  /* An array element. Addressed by its number. */
  PADR_ELEMENT
};
 
/* Address of a location inside a packet. */
struct plocation {
  /* The location kind. */
  enum plocation_kind kind;
 
  union {
    // PTZ190716 int is too small for indexing
    /* Used if this is an array element */
    size_t number;
 
    /* Used if this is a field. */
    char *name;
  };
 
  /* If the full address is to a location inside this this field should
   * point to it. If this location is the final location this field should
   * be nullptr. */
  struct plocation *sub_location;
};
 
struct plocation *plocation_field_new(char *name);
struct plocation *plocation_elem_new(int number);
const char *plocation_name(const struct plocation *loc);
 
#ifdef FREECIV_JSON_CONNECTION
#include "dataio_json.h"
#endif
 
/* network string conversion */
typedef char *(*DIO_PUT_CONV_FUN) (const char *src, size_t *length);
void dio_set_put_conv_callback(DIO_PUT_CONV_FUN fun);
 
typedef bool(*DIO_GET_CONV_FUN) (char *dst, size_t ndst,
                                 const char *src, size_t nsrc);
void dio_set_get_conv_callback(DIO_GET_CONV_FUN fun);
 
bool dataio_get_conv_callback(char *dst, size_t ndst, const char *src,
                              size_t nsrc);
 
/* General functions */
void dio_output_init(struct raw_data_out *d_out, void *destination,
                     size_t dest_size);
void dio_output_rewind(struct raw_data_out *d_out);
size_t dio_output_used(struct raw_data_out *d_out);
 
void dio_input_init(struct data_in *d_out, const void *src, size_t src_size);
void dio_input_rewind(struct data_in *din);
size_t dio_input_remaining(struct data_in *din);
bool dio_input_skip(struct data_in *din, size_t size);
 
size_t data_type_size(enum data_type type);
 
/* gets */
bool dio_get_type_raw(struct data_in *din, enum data_type type, int *dest)
    fc__attribute((nonnull (3)));
 
bool dio_get_uint8_raw(struct data_in *din, int *dest)
    fc__attribute((nonnull (2)));
bool dio_get_uint16_raw(struct data_in *din, int *dest)
    fc__attribute((nonnull (2)));
bool dio_get_uint32_raw(struct data_in *din, int *dest)
    fc__attribute((nonnull (2)));
 
bool dio_get_sint8_raw(struct data_in *din, int *dest)
    fc__attribute((nonnull (2)));
bool dio_get_sint16_raw(struct data_in *din, int *dest)
    fc__attribute((nonnull (2)));
bool dio_get_sint32_raw(struct data_in *din, int *dest)
    fc__attribute((nonnull (2)));
 
bool dio_get_bool8_raw(struct data_in *din, bool *dest)
    fc__attribute((nonnull (2)));
bool dio_get_bool32_raw(struct data_in *din, bool *dest)
    fc__attribute((nonnull (2)));
bool dio_get_ufloat_raw(struct data_in *din, float *dest, int float_factor)
    fc__attribute((nonnull (2)));
bool dio_get_sfloat_raw(struct data_in *din, float *dest, int float_factor)
    fc__attribute((nonnull (2)));
bool dio_get_memory_raw(struct data_in *din, void *dest, size_t dest_size)
    fc__attribute((nonnull (2)));
bool dio_get_string_raw(struct data_in *din, char *dest, size_t max_dest_size)
    fc__attribute((nonnull (2)));
bool dio_get_cm_parameter_raw(struct data_in *din, struct cm_parameter *param)
    fc__attribute((nonnull (2)));
bool dio_get_worklist_raw(struct data_in *din, struct worklist *pwl)
    fc__attribute((nonnull (2)));
bool dio_get_unit_order_raw(struct data_in *din, struct unit_order *order)
    fc__attribute((nonnull (2)));
bool dio_get_requirement_raw(struct data_in *din, struct requirement *preq)
    fc__attribute((nonnull (2)));
bool dio_get_action_probability_raw(struct data_in *din,
                                    struct act_prob *aprob)
    fc__attribute((nonnull (2)));
 
bool dio_get_uint8_vec8_raw(struct data_in *din, int **values, int stop_value)
    fc__attribute((nonnull (2)));
bool dio_get_uint16_vec8_raw(struct data_in *din, int **values, int stop_value)
    fc__attribute((nonnull (2)));
 
/* There is currently no need to escape strings in the binary protocol. */
#define dio_get_estring_raw dio_get_string_raw
#define dio_put_estring_raw dio_put_string_raw
 
/* In the binary protocol, just encode the array lengths. */
#define dio_get_arraylen_raw dio_get_uint16_raw
#define dio_put_arraylen_raw dio_put_uint16_raw
 
#ifndef FREECIV_JSON_CONNECTION
 
/* Should be a function but we need some macro magic. */
#define DIO_BV_GET(pdin, location, bv)               \
  dio_get_memory_raw((pdin), (bv).vec, sizeof((bv).vec))
 
#define DIO_GET(f, d, l, ...) dio_get_##f##_raw(d, ## __VA_ARGS__)
 
#endif /* FREECIV_JSON_CONNECTION */
 
/* Puts */
int dio_put_type_raw(struct raw_data_out *d_out, enum data_type type,
                     int value);
 
int dio_put_uint8_raw(struct raw_data_out *d_out, int value);
int dio_put_uint16_raw(struct raw_data_out *d_out, int value);
int dio_put_uint32_raw(struct raw_data_out *d_out, int value);
 
int dio_put_sint8_raw(struct raw_data_out *d_out, int value);
int dio_put_sint16_raw(struct raw_data_out *d_out, int value);
int dio_put_sint32_raw(struct raw_data_out *d_out, int value);
 
int dio_put_bool8_raw(struct raw_data_out *d_out, bool value);
int dio_put_bool32_raw(struct raw_data_out *d_out, bool value);
int dio_put_ufloat_raw(struct raw_data_out *d_out, float value,
                       int float_factor);
int dio_put_sfloat_raw(struct raw_data_out *d_out, float value,
                       int float_factor);
 
int dio_put_memory_raw(struct raw_data_out *d_out, const void *value,
                       size_t size);
int dio_put_string_raw(struct raw_data_out *d_out, const char *value);
int dio_put_cm_parameter_raw(struct raw_data_out *d_out,
                             const struct cm_parameter *param);
int dio_put_worklist_raw(struct raw_data_out *d_out, const struct worklist *pwl);
int dio_put_unit_order_raw(struct raw_data_out *d_out,
                           const struct unit_order *order);
int dio_put_requirement_raw(struct raw_data_out *d_out,
                            const struct requirement *preq);
int dio_put_action_probability_raw(struct raw_data_out *d_out,
                                   const struct act_prob *aprob);
 
int dio_put_uint8_vec8_raw(struct raw_data_out *d_out, int *values,
                           int stop_value);
int dio_put_uint16_vec8_raw(struct raw_data_out *d_out, int *values,
                            int stop_value);
 
#ifndef FREECIV_JSON_CONNECTION
 
/* Should be a function but we need some macro magic. */
#define DIO_BV_PUT(pd_out, location, bv)               \
  dio_put_memory_raw((pd_out), (bv).vec, sizeof((bv).vec))
 
#define DIO_PUT(f, d, l, ...) dio_put_##f##_raw(d, ## __VA_ARGS__)
 
#endif /* FREECIV_JSON_CONNECTION */
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif  /* FC__DATAIO_RAW_H */