LIBJODYCODE(3)

NAME
libjodycode - shared code used by several tools written by Jody Bruchon

SYNOPSIS
#include <libjodycode.h>

DESCRIPTION
libjodycode is a software code library containing code shared among several of the programs written by Jody Bruchon such as imagepile, jdupes, winregfs, and zeromerge. These shared pieces of code were copied between each program as they were updated. As the number of programs increased and keeping these pieces of code synced became more annoying, the decision was made to combine all of them into a single reusable shared library.

APPLICATION USAGE

  Standard C library swap-in calls
int jc_access(const char *pathname, int mode)
int jc_closedir(JC_DIR * const restrict dirp)
int jc_fclose(FILE *stream)
FILE *jc_fopen(const char *pathname, const JC_WCHAR_T *mode)
char *jc_getcwd(char * const restrict pathname, const size_t size)
int jc_link(const char *path1, const char *path2);
JC_DIR *jc_opendir(const char * restrict path)
struct JC_DIRENT *jc_readdir(JC_DIR * const restrict dirp)
int jc_rename(const char *oldpath, const char *newpath)
int jc_remove(const char *pathname)
int jc_stat(const char * const filename, struct JC_STAT * const restrict buf)

  Alarm API
int jc_start_alarm(const unsigned int seconds, const int repeat)
int jc_stop_alarm(void)

int jc_alarm_ring
    Number of alarm triggers that have occurred; writable by the program

  Batch file list API
struct jc_fileinfo_batch *jc_fileinfo_batch_alloc(const int filecnt, const int stat, const int namlen)
void jc_fileinfo_batch_free(struct jc_fileinfo_batch * const restrict batch)

  Cacheinfo API
struct jc_proc_cacheinfo *jc_get_proc_cacheinfo(int cleanup)

  Directory API
size_t jc_get_d_namlen(const struct JC_DIRENT * const restrict dirent)

  Error API
const char *jc_get_errname(int errnum)
const char *jc_get_errdesc(int errnum)
int jc_print_error(int errnum)

int32_t jc_errno
    libjodycode equivalent to C library's errno

  jodyhash API
int jc_block_hash(const enum jc_e_hash type, jodyhash_t *data, jodyhash_t *hash, const size_t count)

enum jc_e_hash
    Selects hash type to perform, NORMAL or ROLLING

#define JODY_HASH_VERSION
    Version of jody_hash the library currently uses

  Linkfiles API
int jc_linkfiles(struct jc_fileinfo_batch * const restrict batch, const enum jc_e_link linktype)

enum jc_e_link
    Selects type of link to perform: SYMLINK, HARDLINK, or REFLINK

  OOM (out-of-memory) API
void jc_oom(const char * restrict msg)
void jc_nullptr(const char * restrict func)

  Path manipulation API
int jc_collapse_dotdot(char * const path)
int jc_make_relative_link_name(const char * const src, const char * const dest, char *rel_path)

  Size Suffix API
const struct jc_size_suffix jc_size_suffix[]

  Numerically correct string comparison API
int jc_numeric_strcmp(char * restrict c1, char * restrict c2, int insensitive)

  String API
int jc_fwprint(FILE * const restrict stream, const char * const restrict str, const int cr)
int jc_strncaseeq(const char *s1, const char *s2, const size_t len)
int jc_strcaseeq(const char *s1, const char *s2)
int jc_strneq(const char *s1, const char *s2, const size_t len)
int jc_streq(const char *s1, const char *s2)
JC_STR_T *jc_str_init(const char *string, uint32_t len)
int jc_strteq(const JC_STR_T *s1, const JC_STR_T *s2)
int jc_strtneq(const JC_STR_T *s1, const JC_STR_T *s2, const size_t len)
int jc_strtcaseeq(const JC_STR_T *s1, const JC_STR_T *s2)
int jc_strtncaseeq(const JC_STR_T *s1, const JC_STR_T *s2, const size_t len)
int jc_strtcmp(const JC_STR_T *s1, const JC_STR_T * s2 )"
int jc_strtncmp(const JC_STR_T *s1, const JC_STR_T * s2, size_t len )"
int jc_strtcasecmp(const JC_STR_T *s1, const JC_STR_T *s2 )"
int jc_strtncasecmp(const JC_STR_T *s1, const JC_STR_T *s2, size_t len)

JC_STR_T
    Structure for a string with its length prefixed as a 32-bit unsigned integer
    Members: len = length, str = string

  Time API
time_t jc_strtoepoch(const char * const datetime)
int jc_nttime_to_unixtime(const FILETIME * const restrict filetime, struct JC_TIMESPEC * const restrict unixtime)
int jc_unixtime_to_nttime(const struct JC_TIMESPEC * const restrict unixtime, FILETIME * const restrict filetime)

struct JC_TIMESPEC
    libjodycode equivalent to struct timespec from time.h

  Version API
const char *jc_version
const char *jc_verdate
const int jc_api_version
const int jc_api_featurelevel
const int jc_jodyhash_version
const unsigned char jc_api_versiontable[]
int jc_get_kernel_version(void)
(Linux only) get current Linux kernel version as an integer

  Windows-specific stat() mode test definitions

S_ISARCHIVE(st_mode)
    is Windows archive attribute set?

S_ISRO(st_mode)
    is Windows read-only attribute set?

S_ISHIDDEN(st_mode)
    is Windows hidden attribute set?

S_ISSYSTEM(st_mode)
    is Windows system attribute set?

S_ISCRYPT(st_mode)
    is it a Windows encrypted file/dir?

S_ISDIR(st_mode)
    is it a directory?

S_ISCOMPR(st_mode)
    is it a Windows compressed file?

S_ISREPARSE(st_mode)
    is it a Windows reparse point?

S_ISSPARSE(st_mode)
    is it a Windows sparse file?

S_ISTEMP(st_mode)
    is it a Windows temporary file?

S_ISREG(st_mode)
    is it a regular file?

  Windows Unicode API
int jc_ffd_to_dirent(JC_DIR **dirp, HANDLE hFind, WIN32_FIND_DATA *ffd)
void jc_set_output_modes(const int out, const int err)
int jc_setup_unicode_terminal(int argc, JC_WCHAR_T **wargv, char ***argv, int * stdout_tty)
void jc_slash_convert(char *path)
int jc_string_to_wstring(const char * const restrict string, JC_WCHAR_T **wstring)
int jc_widearg_to_argv(int argc, JC_WCHAR_T **wargv, char **argv)

  Windows Unicode wide equivalence definitions

JC_WCHAR_T
    wchar_t for Windows Unicode, char otherwise

JC_FILE_MODE_RDONLY
    string "rb"

JC_FILE_MODE_WRONLY
    string "wb"

JC_FILE_MODE_RW
    string "w+b"

JC_FILE_MODE_RW_EXISTING
    string "r+b"

JC_FILE_MODE_WRONLY_APPEND
    string "ab"

JC_FILE_MODE_RW_APPEND
    string "a+b"

JC_FILE_MODE_RDONLY_SEQ
    string "rbS" (Windows) or "rb"

JC_FILE_MODE_WRONLY_SEQ
    string "wbS" (Windows) or "wb"

JC_FILE_MODE_RW_SEQ
    string "w+bS" (Windows) or "w+b"

JC_FILE_MODE_RW_EXISTING_SEQ
    string "r+bS" (Windows) or "r+b"

JC_FILE_MODE_WRONLY_APPEND_SEQ
    string "abS" (Windows) or "ab"

JC_FILE_MODE_RW_APPEND_SEQ
    string "a+bS" (Windows) or "a+b"

JC_F_OK
    unistd.h F_OK

JC_R_OK
    unistd.h R_OK

JC_W_OK
    unistd.h W_OK

JC_X_OK
    unistd.h X_OK

  Windows Unicode conversion shortcut definitions
M2W(char *a, JC_WCHAR_T *b)
convert string a to wide string b using MultiByteToWideChar()
W2M(JC_WCHAR_T *a, char *b)
convert wide string a to normal string b using WideCharToMultiByte()

NOTES
libjodycode is created and maintained by Jody Bruchon <jody@jodybruchon.com> General information, help, and tech info: http://www.jdupes.com/ Development, source code, releases: https://codeberg.org/jbruchon/libjodycode If you find this software useful, please consider financially supporting its development through the author's home page: https://www.jodybruchon.com/

LICENSE
MIT License Copyright (c) 2014-2026 Jody Lee Bruchon <jody@jodybruchon.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.