packets_json.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__PACKETS_JSON_H
#define FC__PACKETS_JSON_H
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include <jansson.h>
 
#define log_packet_json log_debug
 
void *get_packet_from_connection_json(struct connection *pc,
                                      enum packet_type *ptype);
 
#define SEND_PACKET_START(packet_type)                                  \
  unsigned char buffer[MAX_LEN_PACKET * 5];                             \
  struct plocation *pid_addr;                                           \
  char *json_buffer = NULL;                                             \
  struct json_data_out dout;                                            \
  dio_output_init(&(dout.raw), buffer, sizeof(buffer));                 \
  if (pc->json_mode) {                                                  \
    dout.json = json_object();                                          \
    dio_put_uint16_raw(&(dout.raw), 0);                                 \
    pid_addr = plocation_field_new("pid");                              \
    dio_put_uint8_json(&dout, pid_addr, packet_type);                   \
    FC_FREE(pid_addr);                                                  \
  } else {                                                              \
    dout.json = NULL;                                                   \
    dio_put_type_raw(&dout.raw, pc->packet_header.length, 0);           \
    dio_put_type_raw(&dout.raw, pc->packet_header.type, packet_type);   \
  }
 
#define SEND_PACKET_END(packet_type) \
  {                                                                     \
    size_t size;                                                        \
    if (pc->json_mode) {                                                \
      json_buffer = json_dumps(dout.json, JSON_COMPACT | JSON_ENSURE_ASCII); \
      if (json_buffer) {                                                \
        dio_put_string_raw(&(dout.raw), json_buffer);                   \
        log_packet_json("Json out: %s", json_buffer);                   \
      }                                                                 \
      size = dio_output_used(&dout.raw);                                \
                                                                        \
      dio_output_rewind(&(dout.raw));                                   \
      dio_put_uint16_raw(&(dout.raw), size);                            \
      free(json_buffer);                                                \
      json_decref(dout.json);                                           \
    } else {                                                            \
      size = dio_output_used(&dout.raw);                                \
                                                                        \
      dio_output_rewind(&dout.raw);                                     \
      dio_put_type_raw(&dout.raw, pc->packet_header.length, size);      \
    }                                                                   \
    fc_assert(!dout.raw.too_short);                                     \
    return send_packet_data(pc, buffer, size, packet_type);             \
  }
 
#define SEND_PACKET_DISCARD() \
  {                           \
    if (pc->json_mode) {      \
      json_decref(dout.json); \
    }                         \
    return 0;                 \
  }
 
#define RECEIVE_PACKET_START(packet_type, result)                           \
  struct packet_type packet_buf, *result = &packet_buf;                     \
  struct data_in din;                                                       \
  init_ ##packet_type (&packet_buf);                                        \
  if (!pc->json_mode) {                                                     \
      dio_input_init(&din, pc->buffer->data,                                \
                 data_type_size(pc->packet_header.length));                 \
    {                                                                       \
      int size;                                                             \
                                                                            \
      dio_get_type_raw(&din, pc->packet_header.length, &size);              \
      dio_input_init(&din, pc->buffer->data, MIN(size, pc->buffer->ndata)); \
    }                                                                       \
    dio_input_skip(&din, (data_type_size(pc->packet_header.length)          \
                   + data_type_size(pc->packet_header.type)));              \
  }
 
#define RECEIVE_PACKET_END(result)              \
  if (pc->json_mode) {                          \
    json_decref(pc->json_packet);               \
    result = fc_malloc(sizeof(*result));        \
    *result = packet_buf;                       \
    return result;                              \
  } else {                                      \
    if (!packet_check(&din, pc)) {              \
      FREE_PACKET_STRUCT(&packet_buf);          \
      return NULL;                              \
    }                                           \
    remove_packet_from_buffer(pc->buffer);      \
    result = fc_malloc(sizeof(*result));        \
    *result = packet_buf;                       \
    return result;                              \
  }
 
#define RECEIVE_PACKET_FIELD_ERROR(field, ...)           \
  log_packet("Error on field '" #field "'" __VA_ARGS__); \
  FREE_PACKET_STRUCT(&packet_buf);                       \
  return NULL;
 
/* Utilities to move string vectors in and out of packets. */
#define PACKET_STRVEC_INSERT(dest, src) \
  dest = src
#define PACKET_STRVEC_EXTRACT(dest, src)        \
  if (src != nullptr && strvec_size(src) > 0) { \
    dest = strvec_new();                        \
    strvec_copy(dest, src);                     \
  } else {                                      \
    dest = nullptr;                             \
  }
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* FC__PACKETS_JSON_H */