corn/include/lib.h
2024-02-01 17:01:20 -05:00

222 lines
6.5 KiB
C

#pragma once
#include <stdarg.h>
#include <stddef.h>
/**
* The memcmp() function compares the first n bytes (each interpreted as unsigned char) of the memory
* areas s1 and s2.
*/
int memcmp(const void *restrict s1, const void *restrict s2, unsigned long n);
/**
* The memcpy() function copies n bytes from memory area src to memory area dest.
* The memory areas must not overlap.
*/
void *memcpy(void *restrict dest, const void *restrict src, unsigned long n);
/**
* The memmove() function copies n bytes from memory area src to memory area dest. The memory areas
* may overlap: copying takes place as though the bytes in src are first copied into a temporary array
* that does not overlap src or dest, and the bytes are then copied from the temporary array to dest.
*/
void *memmove(void *dest, const void *src, unsigned long n);
/**
* The memset() function fills the first n bytes of the memory area pointed to by s with the constant
* byte c.
*/
void *memset(void *restrict dest, int c, unsigned long n);
/**
* The strcmp() function compares the two strings s1 and s2. The locale is not taken into account
* (for a locale-aware comparison, see strcoll(3)). The comparison is done using unsigned characters.
*/
int strncmp(const char *restrict s1, const char *restrict s2, unsigned long n);
/**
* Copys the string pointed to by src , into a string at the buffer pointer to by dest.
* The dest buffer must be long enough to hold src.
*/
char *strcpy(char *restrict dest, const char *restrict src);
/**
* Copys the string pointed to by src , into a string at the buffer pointer to by dest.
* The dest buffer must be long enough to hold src or size n.
*/
char *strncpy(char *restrict dest, const char *restrict src, unsigned long n);
/**
* Calculates the length of the string pointed to by str, excluding
* the terminating null byte
* @param str - the string pointer
* @returns the length of the string in bytes
*/
size_t strlen(const char *str);
/**
* Concatenate the string pointed to by src after the string pointed
* to by dst.
* @param dst - the pointer to the destination string
* @param src - the pointer to the source string
* @returns dst
*/
char *strcat(char *restrict dst, const char *restrict src);
/**
* @returns 1 if c is a space
*/
int isspace(int c);
/**
* @returns 1 if c is a digit (0 - 9)
*/
int isdigit(int c);
/**
* converts single digit int to base 36
* @param i - int
* @returns c - base 36 char
*/
char itoc(int i);
/**
* converts single base 36 chat into int
* @param c - base 36 char
* @returns i - int
*/
int ctoi(char c);
/**
* Converts the initial portiion of the string pointed to by s to int.
* @param s - the string to convert
* @returns the number inside s or 0 on error
*/
int atoi(const char *s);
/**
* Converts the initial portiion of the string pointed to by s to long.
* @param s - the string to convert
* @returns the number inside s or 0 on error
*/
long int atol(const char *s);
/**
* Converts the initial portiion of the string pointed to by s to long long.
* @param s - the string to convert
* @returns the number inside s or 0 on error
*/
long long int atoll(const char *s);
/**
* Converts a integer to asci inside a string with a given radix (base).
* @param n - the number to convert
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *itoa(int n, char *buffer, int radix);
/**
* Converts a long to asci inside a string with a given radix (base).
* @param n - the number to convert
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *ltoa(long int n, char *buffer, int radix);
/**
* Converts a long long to asci inside a string with a given radix (base).
* @param n - the number to conver
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *lltoa(long long int n, char *buffer, int radix);
/**
* Converts a unsigned integer to asci inside a string with a given radix (base).
* @param n - the number to convert
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *utoa(unsigned int n, char *buffer, int radix);
/**
* Converts a unsigned long to asci inside a string with a given radix (base).
* @param n - the number to convert
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *ultoa(unsigned long int n, char *buffer, int radix);
/**
* Converts a unsigned long long to asci inside a string with a given radix (base).
* @param n - the number to conver
* @param buffer - the string buffer
* @param radix - the base to convert
*/
char *ulltoa(unsigned long long int n, char *buffer, int radix);
/**
* Converts a byte count to a human readable file size
* @param bytes - the bytes to convert
* @param buf - the buffer to store it in
* @preturns - bus
*/
char *btoa(size_t bytes, char *buf);
/**
* Converts the string in str to an int value based on the given base.
* The endptr is updated to where the string was no longer valid.
* @param str - the string buffer
* @param endptr - the endptr
* @param base - the base to convert to
* @returns 0 on error or success, error if endptr is still equal to str
*/
int strtoi(const char *str, char **endptr, int base);
/**
* Converts the string in str to an long value based on the given base.
* The endptr is updated to where the string was no longer valid.
* @param str - the string buffer
* @param endptr - the endptr
* @param base - the base to convert to
* @returns 0 on error or success, error if endptr is still equal to str
*/
long int strtol(const char *str, char **endptr, int base);
/**
* Converts the string in str to an long long value based on the given base.
* The endptr is updated to where the string was no longer valid.
* @param str - the string buffer
* @param endptr - the endptr
* @param base - the base to convert to
* @returns 0 on error or success, error if endptr is still equal to str
*/
long long int strtoll(const char *str, char **endptr, int base);
/**
* Prints out a char
* @param c - the char
*/
void kputc(char c);
/**
* Prints out a null terminated string
* @param s - the string
*/
void kputs(const char *s);
/**
* Prints out a formatted string
* @param format - the format string
* @param ... - variable args for the format
*/
void kvprintf(const char *format, va_list args);
/**
* Prints out a formatted string
* @param format - the format string
* @param ... - variable args for the format
*/
__attribute__((format(printf, 1, 2)))
void kprintf(const char *format, ...);