mirror of
https://github.com/libretro/RetroArch.git
synced 2024-05-20 05:20:19 -04:00
679083a08b
* Graceful fallback to readonly mode if RDB can't be opened readwrite * let RA open db readonly
111 lines
3.4 KiB
C
111 lines
3.4 KiB
C
/* Copyright (C) 2010-2017 The RetroArch team
|
|
*
|
|
* ---------------------------------------------------------------------------------------
|
|
* The following license statement only applies to this file (libretrodb.h).
|
|
* ---------------------------------------------------------------------------------------
|
|
*
|
|
* Permission is hereby granted, free of charge,
|
|
* to any person obtaining a copy of this software and associated documentation files (the "Software"),
|
|
* to deal in the Software without restriction, including without limitation the rights to
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
|
|
* and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
|
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef __LIBRETRODB_H__
|
|
#define __LIBRETRODB_H__
|
|
|
|
#include <stdint.h>
|
|
#ifdef _WIN32
|
|
#include <direct.h>
|
|
#else
|
|
#include <unistd.h>
|
|
#endif
|
|
|
|
#include <retro_common_api.h>
|
|
|
|
#include "query.h"
|
|
#include "rmsgpack_dom.h"
|
|
|
|
RETRO_BEGIN_DECLS
|
|
|
|
typedef struct libretrodb libretrodb_t;
|
|
|
|
typedef struct libretrodb_cursor libretrodb_cursor_t;
|
|
|
|
typedef struct libretrodb_index libretrodb_index_t;
|
|
|
|
typedef int (*libretrodb_value_provider)(void *ctx, struct rmsgpack_dom_value *out);
|
|
|
|
int libretrodb_create(RFILE *fd, libretrodb_value_provider value_provider, void *ctx);
|
|
|
|
void libretrodb_close(libretrodb_t *db);
|
|
|
|
int libretrodb_open(const char *path, libretrodb_t *db, bool write);
|
|
|
|
int libretrodb_create_index(libretrodb_t *db, const char *name,
|
|
const char *field_name);
|
|
|
|
int libretrodb_find_entry(libretrodb_t *db, const char *index_name,
|
|
const void *key, struct rmsgpack_dom_value *out);
|
|
|
|
libretrodb_t *libretrodb_new(void);
|
|
|
|
void libretrodb_free(libretrodb_t *db);
|
|
|
|
libretrodb_cursor_t *libretrodb_cursor_new(void);
|
|
|
|
void libretrodb_cursor_free(libretrodb_cursor_t *dbc);
|
|
|
|
/**
|
|
* libretrodb_cursor_open:
|
|
* @db : Handle to database.
|
|
* @cursor : Handle to database cursor.
|
|
* @q : Query to execute.
|
|
*
|
|
* Opens cursor to database based on query @q.
|
|
*
|
|
* Returns: 0 if successful, otherwise negative.
|
|
**/
|
|
int libretrodb_cursor_open(libretrodb_t *db,
|
|
libretrodb_cursor_t *cursor,
|
|
libretrodb_query_t *query);
|
|
|
|
/**
|
|
* libretrodb_cursor_reset:
|
|
* @cursor : Handle to database cursor.
|
|
*
|
|
* Resets cursor.
|
|
*
|
|
* Returns: ???.
|
|
**/
|
|
int libretrodb_cursor_reset(libretrodb_cursor_t *cursor);
|
|
|
|
/**
|
|
* libretrodb_cursor_close:
|
|
* @cursor : Handle to database cursor.
|
|
*
|
|
* Closes cursor and frees up allocated memory.
|
|
**/
|
|
void libretrodb_cursor_close(libretrodb_cursor_t *cursor);
|
|
|
|
void *libretrodb_query_compile(libretrodb_t *db, const char *query,
|
|
size_t buff_len, const char **error);
|
|
|
|
void libretrodb_query_free(void *q);
|
|
|
|
int libretrodb_cursor_read_item(libretrodb_cursor_t *cursor,
|
|
struct rmsgpack_dom_value *out);
|
|
|
|
RETRO_END_DECLS
|
|
|
|
#endif
|