forked from Lephenixnoir/fxsdk
77 lines
2.3 KiB
C
77 lines
2.3 KiB
C
//---
|
|
// fxlink:util - Utility functions and error reporting mechanisms
|
|
//---
|
|
|
|
#ifndef FXLINK_UTIL_H
|
|
#define FXLINK_UTIL_H
|
|
|
|
#include <stdio.h>
|
|
#include <stdbool.h>
|
|
|
|
/* Literal error message printed to stderr, evaluates to 1 for a combined
|
|
return/exit() call */
|
|
#define err(fmt, ...) ({ \
|
|
fprintf(stderr, "error: " fmt "\n", ##__VA_ARGS__); \
|
|
1; \
|
|
})
|
|
/* Fatal error that includes a libusb error message */
|
|
#define libusb_err(rc, fmt, ...) ({ \
|
|
fprintf(stderr, "error: " fmt ": %s\n", ##__VA_ARGS__, \
|
|
libusb_strerror(rc)); \
|
|
1; \
|
|
})
|
|
/* Warning message */
|
|
#define wrn(fmt, ...) \
|
|
fprintf(stderr, "warning: " fmt "\n", ##__VA_ARGS__)
|
|
|
|
/* Warning that includes a libusb error message */
|
|
#define libusb_wrn(rc, fmt, ...) \
|
|
fprintf(stderr, "error: " fmt ": %s\n", ##__VA_ARGS__, \
|
|
libusb_strerror(rc))
|
|
|
|
//---
|
|
// File name generation
|
|
//---
|
|
|
|
/* gen_file_name(): Generate a unique timestamp-based file name
|
|
|
|
This function generates a unique name for a file to be stored in [path],
|
|
with the specified [name] component, and the provided [suffix]. The
|
|
generated path looks like
|
|
|
|
<path>/fxlink-<name>-2021.05.09-19h23-1.<suffix>
|
|
|
|
with the [-1] suffix being chosen as to avoid overriding extisting files.
|
|
Returns a newly-allocated string to be freed after use. */
|
|
char *gen_file_name(char const *path, char const *name, char const *suffix);
|
|
|
|
//---
|
|
// Delay
|
|
//---
|
|
|
|
/* delay_t: An expandable allocated time used to wait for devices */
|
|
typedef int delay_t;
|
|
|
|
/* delay_none(): No delay allowed */
|
|
delay_t delay_none(void);
|
|
/* delay_seconds(): Initial delay from a duration in seconds */
|
|
delay_t delay_seconds(int seconds);
|
|
/* delay_infinite(): Delay that can run through delay_cycle() indefinitely */
|
|
delay_t delay_infinite(void);
|
|
|
|
/* delay_cycle(): Wait for a short cycle
|
|
|
|
This function returns (true) if the delay has expired; otherwise, it waits
|
|
for a short while (250 ms), decreases the supplied delay pointer, and
|
|
returns (false).
|
|
|
|
Not returning (true) after waiting, even if the delay expires then, allows
|
|
the caller to perform the task they were waiting on one last time before
|
|
giving up.
|
|
|
|
@delay Input-output: Delay resource to take time from
|
|
-> Return (true) if (*delay) has expired, or (false) after waiting. */
|
|
bool delay_cycle(delay_t *delay);
|
|
|
|
#endif /* FXLINK_UTIL_H */
|