gnunet_sq_lib.h

Go to the documentation of this file.

/*
   This file is part of GNUnet
   Copyright (C) 2017 GNUnet e.V.
 
   GNUnet 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.
 
   GNUnet 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/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
#ifndef GNUNET_SQ_LIB_H
#define GNUNET_SQ_LIB_H
 
 
#include <sqlite3.h>
#include "gnunet_util_lib.h"
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_SQ_QueryConverter)(void *cls,
                            const void *data,
                            size_t data_len,
                            sqlite3_stmt *stmt,
                            unsigned int off);
 
 
struct GNUNET_SQ_QueryParam
{
  GNUNET_SQ_QueryConverter conv;
 
  void *conv_cls;
 
  const void *data;
 
  size_t size;
 
  unsigned int num_params;
};
 
 
#define GNUNET_SQ_query_param_end { NULL, NULL, NULL, 0, 0 }
 
 
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_fixed_size (const void *ptr,
                                  size_t ptr_size);
 
 
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_string (const char *ptr);
 
 
#define GNUNET_SQ_query_param_auto_from_type( \
    x) GNUNET_SQ_query_param_fixed_size ((x), sizeof(*(x)))
 
 
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_rsa_public_key (const struct
                                      GNUNET_CRYPTO_RsaPublicKey *x);
 
 
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_rsa_signature (const struct
                                     GNUNET_CRYPTO_RsaSignature *x);
 
 
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_absolute_time (const struct GNUNET_TIME_Absolute *x);
 
 
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_absolute_time_nbo (
  const struct GNUNET_TIME_AbsoluteNBO *x);
 
 
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_uint16 (const uint16_t *x);
 
 
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_uint32 (const uint32_t *x);
 
 
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_uint64 (const uint64_t *x);
 
 
enum GNUNET_GenericReturnValue
GNUNET_SQ_bind (sqlite3_stmt *stmt,
                const struct GNUNET_SQ_QueryParam *params);
 
 
void
GNUNET_SQ_reset (sqlite3 *dbh,
                 sqlite3_stmt *stmt);
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_SQ_ResultConverter)(void *cls,
                             sqlite3_stmt *result,
                             unsigned int column,
                             size_t *dst_size,
                             void *dst);
 
 
struct GNUNET_SQ_ResultSpec;
 
 
typedef void
(*GNUNET_SQ_ResultCleanup)(void *cls);
 
 
struct GNUNET_SQ_ResultSpec
{
  GNUNET_SQ_ResultConverter conv;
 
  GNUNET_SQ_ResultCleanup cleaner;
 
  void *cls;
 
  void *dst;
 
  size_t dst_size;
 
  size_t *result_size;
 
  unsigned int num_params;
};
 
 
#define GNUNET_SQ_result_spec_end { NULL, NULL, NULL, NULL, 0, NULL, 0 }
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_variable_size (void **dst,
                                     size_t *sptr);
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_fixed_size (void *dst,
                                  size_t dst_size);
 
 
#define GNUNET_SQ_result_spec_auto_from_type( \
    dst) GNUNET_SQ_result_spec_fixed_size ((dst), sizeof(*(dst)))
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_variable_size (void **dst,
                                     size_t *sptr);
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_string (char **dst);
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_rsa_public_key (struct GNUNET_CRYPTO_RsaPublicKey **rsa);
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_rsa_signature (struct GNUNET_CRYPTO_RsaSignature **sig);
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_absolute_time (struct GNUNET_TIME_Absolute *at);
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_absolute_time_nbo (struct GNUNET_TIME_AbsoluteNBO *at);
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_uint16 (uint16_t *u16);
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_uint32 (uint32_t *u32);
 
 
struct GNUNET_SQ_ResultSpec
GNUNET_SQ_result_spec_uint64 (uint64_t *u64);
 
 
enum GNUNET_GenericReturnValue
GNUNET_SQ_extract_result (sqlite3_stmt *result,
                          struct GNUNET_SQ_ResultSpec *rs);
 
 
void
GNUNET_SQ_cleanup_result (struct GNUNET_SQ_ResultSpec *rs);
 
 
/* ******************** sq_prepare.c functions ************** */
 
 
struct GNUNET_SQ_PrepareStatement
{
  const char *sql;
 
  sqlite3_stmt **pstmt;
};
 
 
#define GNUNET_SQ_PREPARE_END { NULL, NULL }
 
 
struct GNUNET_SQ_PrepareStatement
GNUNET_SQ_make_prepare (const char *sql,
                        sqlite3_stmt **pstmt);
 
 
enum GNUNET_GenericReturnValue
GNUNET_SQ_prepare (sqlite3 *dbh,
                   const struct GNUNET_SQ_PrepareStatement *ps);
 
 
/* ******************** sq_exec.c functions ************** */
 
 
struct GNUNET_SQ_ExecuteStatement
{
  const char *sql;
 
  bool ignore_errors;
};
 
 
#define GNUNET_SQ_EXECUTE_STATEMENT_END { NULL, GNUNET_SYSERR }
 
 
struct GNUNET_SQ_ExecuteStatement
GNUNET_SQ_make_execute (const char *sql);
 
 
struct GNUNET_SQ_ExecuteStatement
GNUNET_SQ_make_try_execute (const char *sql);
 
 
enum GNUNET_GenericReturnValue
GNUNET_SQ_exec_statements (sqlite3 *dbh,
                           const struct GNUNET_SQ_ExecuteStatement *es);
 
 
#endif  /* GNUNET_SQ_LIB_H_ */
 
/* end of include/gnunet_sq_lib.h */