annotate scid/scid.h @ 37:62aefd02ac59

make: remove config.mk
author David Demelier <markand@malikania.fr>
date Sun, 07 Aug 2022 08:41:06 +0200
parents 1d0ddf9e6efd
children 576f4b1ec79f
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
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
31 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
32 * \struct scid
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
33 * \brief Main scid structure for configuration.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
34 */
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 extern struct scid {
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
36 char themedir[PATH_MAX]; /*!< Path to the theme. */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
37 char dbpath[PATH_MAX]; /*!< Path to the database file. */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
38 } scid /*! Global variable. */;
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
40 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
41 * Initialize scid.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
42 */
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 void
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 scid_init(void);
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
46 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
47 * Cleanup scid.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 30
diff changeset
48 */
26
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 void
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 scid_finish(void);
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
7e10cace67a3 scid: add basic mustache support
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 #endif /* !SCID_H */