strings.h

// ------------------------------------------------------------------
//   strings.h
//   Copyright (C) 2019-2020 Divon Lan <divon@genozip.com>
//   Please see terms and conditions in the files LICENSE.non-commercial.txt and LICENSE.commercial.txt

#ifndef STRINGS_INCLUDED
#define STRINGS_INCLUDED

#include <stdint.h>

#define IS_DIGIT(c)   ((c)>='0' && (c)<='9')
#define IS_CLETTER(c) ((c)>='A' && (c)<='Z')
#define IS_SLETTER(c) ((c)>='a' && (c)<='z')
#define IS_LETTER(c) (IS_CLETTER(c) || IS_SLETTER(c))
#define IS_VALID_URL_CHAR(c) (IS_LETTER(c) || IS_DIGIT(c) || c=='-' || c=='_' || c=='.' || c=='~') // characters valid in a URL

extern void str_to_lowercase (char *s);

extern char *str_size (int64_t size, char *str /* out */);
extern char *str_uint_commas (int64_t n, char *str /* out */);
extern char *str_int (int64_t n, char *str /* out */, unsigned *len);

#define POINTER_STR_LEN 19
extern char *str_pointer (const void *p, char *str /* POINTER_STR_LEN bytes allocated by caller*/);

extern const char *type_name (unsigned item, 
                              const char * const *name, // the address in which a pointer to name is found, if item is in range
                              unsigned num_names);

extern int str_print_text (const char **text, unsigned num_lines,
                           const char *wrapped_line_prefix, 
                           const char *newline_separator, 
                           unsigned line_width /* 0=calcuate optimal */);

typedef bool (*ResponseVerifier) (char *response, unsigned response_size, const char *verifier_param);
extern void str_query_user (const char *query, char *response, unsigned response_size, ResponseVerifier verifier, const char *verifier_param);

// ResponseVerifier functions
extern bool str_verify_y_n (char *response, unsigned response_size, const char *y_or_n);
extern bool str_verify_not_empty (char *response, unsigned response_size, const char *unused);

#endif