aboutsummaryrefslogtreecommitdiff
path: root/src/db.h
blob: 4344b94c3879731131200d29cde0eeb2410ff508 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/* Copyright (c) 2019, Anthony Latorre <tlatorre at uchicago>
 *
 * 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 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 General Public License for
 * more details.

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

#ifndef DB_H
#define DB_H

/* This is a library for importing title banks from SNOMAN files. Each bank is
 * stored in a dictionary with the bank name and id as the key. For example, to
 * load the DQXX files:
 *
 *     dbval *dbval;
 *
 *     db_init();
 *     load_file("DQXX_0000010000.dat");
 *     dbval = get_bank("DQCH",1);
 *     db_free();
 *
 * The return value of get_bank() is a pointer to the bank values. It's up to
 * the caller to know the exact offsets for each value in the bank. Typically,
 * SNO database title banks have a database header of 20 words and 10 unused
 * words at the beginning of the bank.
 *
 * Note: Currently only 32 bit unsigned integers and 32 bit floating point
 * numbers are supported. I don't think that any of the SNOMAN files have
 * doubles. */

#include <stdint.h> /* for uint32_t */
#include "dict.h"

typedef union dbval {
    uint32_t u32;
    float f;
} dbval;

extern char db_err[256];

dict *db_init(void);
void db_free(dict *db);
void replace_bank(dict *db, const char name[4], uint32_t id, dbval *data);
int add_bank(dict *db, const char name[4], uint32_t id, dbval *data);
dbval *get_bank(dict *db, const char name[4], uint32_t id);
int load_file(dict *db, const char *filename, int replace);

#endif