aboutsummaryrefslogtreecommitdiffstats
path: root/src/common.h
blob: e3182dc52d391eff230312e5e3ec6eee54eedc0e (plain) (blame)
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
/* See LICENSE file for copyright and license details. */
#include <libkeccak.h>
#include <argparser.h>

#define libkeccak_spec_keccak   libkeccak_spec_sha3
#define LIBKECCAK_KECCAK_SUFFIX ""


/**
 * Wrapper for `run` that also initialises the command line parser
 * 
 * @param  algo    The name of the hashing algorithm, must be a string literal
 * @param  prog    The name of program, must be a string literal
 * @param  suffix  The message suffix
 */
#define RUN(algo, prog, suffix)\
	(args_init(algo " checksum calculator",\
	           prog " [options...] [--] [files...]", NULL,\
	           NULL, 1, 0, args_standard_abbreviations),\
	 run(argc, argv, &spec, suffix))


/**
 * Print the checksum in binary
 */
#define REPRESENTATION_BINARY 0

/**
 * Print the checksum in upper case hexadecimal
 */
#define REPRESENTATION_UPPER_CASE 1

/**
 * Print the checksum in lower case hexadecimal
 */
#define REPRESENTATION_LOWER_CASE 2


/**
 * Parse the command line and calculate the hashes of the selected files
 * 
 * @param   argc    The first argument from `main`
 * @param   argv    The second argument from `main`
 * @param   gspec   The default algorithm parameters
 * @param   suffix  Message suffix
 * @return          An appropriate exit value
 */
int run(int argc, char *argv[], libkeccak_generalised_spec_t *restrict gspec, const char *restrict suffix);