Mercurial > sci

annotate scid/scid.h @ 54:85c59fbf1407

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
scid: add commands to retrieve API key
author David Demelier <markand@malikania.fr>
date Wed, 17 Aug 2022 11:07:08 +0200
parents 576f4b1ec79f
children 3804a2ab60ec
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
1 /*
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
2 * scid.h -- main scid file and configuration
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
3 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
5 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
8 * copyright notice and this permission notice appear in all copies.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
9 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
17 */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
18
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef SCID_H
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCID_H
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
22 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
23 * \file scid.h
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
24 * \brief Main scid file and configuration.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
25 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
26 * This module logs message with tag `scid`.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
27 */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
28
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #include <limits.h>
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
44
576f4b1ec79f scid: implement API authentication
David Demelier <markand@malikania.fr>
parents: 33
diff changeset
31 #define SCID_API_KEY_MAX (40 + 1)
576f4b1ec79f scid: implement API authentication
David Demelier <markand@malikania.fr>
parents: 33
diff changeset
32
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
33 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
34 * \struct scid
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
35 * \brief Main scid structure for configuration.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
36 */
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 extern struct scid {
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
38 char themedir[PATH_MAX]; /*!< Path to the theme. */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
39 char dbpath[PATH_MAX]; /*!< Path to the database file. */
44
576f4b1ec79f scid: implement API authentication
David Demelier <markand@malikania.fr>
parents: 33
diff changeset
40 char apikey[SCID_API_KEY_MAX]; /*!< Maximum API key with NUL terminator. */
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
41 } scid /*! Global variable. */;
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
43 /**
54
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
44 * \enum scid_init
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
45 * \brief Bitmask of scid components to initialize
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
46 */
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
47 enum scid_init {
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
48 /**
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
49 * Init logs.
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
50 */
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
51 SCID_INIT_LOG = (1 << 0),
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
52
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
53 /**
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
54 * Open database read/write.
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
55 */
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
56 SCID_INIT_DATABASE = (1 << 1),
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
57
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
58 /**
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
59 * Open the theme.
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
60 */
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
61 SCID_INIT_THEME = (1 << 2)
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
62 };
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
63
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
64 /**
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
65 * Initialize scid components.
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
66 *
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
67 * This function can be called multiple times as long as the component differ
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
68 * between each call.
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
69 *
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
70 * It's recommended to init logs first to get proper logging if the underlying
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
71 * component fails.
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
72 *
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
73 * \param components the components (as a bitmask)
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
74 */
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 void
54
85c59fbf1407 scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
76 scid_init(enum scid_init);
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
77
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
78 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
79 * Cleanup scid.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
80 */
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 void
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 scid_finish(void);
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
83
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 #endif /* !SCID_H */