base.h

Go to the documentation of this file.

/*
base +
*/
 
#ifndef __BASE_H__
#define __BASE_H__
 
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <string.h>
#include <ctype.h>
#include <math.h>
#include <time.h>
#include <stdbool.h>
// #include <execinfo.h> // stack traces
#include "basedefs.h"
 
 
// Initialization
 
void base_init(void);
 
void report_memory_leaks(bool do_check);
 
 
 
// Assertions
 
#define NO_ASSERT_DOC
 
#define NO_REQUIRE_DOC
 
#define NO_ENSURE_DOC
 
#ifdef NO_ASSERT
#define assert(description, condition)
#else
#define assert(description, condition) \
if (!(condition)) {\
    fprintf(stderr, "%s, line %d: assertion \"%s\" (%s) violated\n", __FILE__, __LINE__, description, #condition);\
    exit(EXIT_FAILURE);\
}
#endif
 
#ifdef NO_ASSERT
#define assert_x(description, condition, ...)
#else
#define assert_x(description, condition, ...) \
if (!(condition)) {\
    fprintf(stderr, "%s, line %d: assertion \"%s\" violated: ", __FILE__, __LINE__, description);\
    fprintf(stderr, __VA_ARGS__);\
    fprintf(stderr, "\n");\
    exit(EXIT_FAILURE);\
}
#endif
 
#ifdef NO_ASSERT
#define assert_not_null(pointer)
#else
#define assert_not_null(pointer) \
if (pointer == NULL) {\
    fprintf(stderr, "%s, line %d: assertion \"not null\" (" #pointer ") violated\n", __FILE__, __LINE__);\
    exit(EXIT_FAILURE);\
}
#endif
 
#ifdef NO_ASSERT
#define assert_code(x)
#else
#define assert_code(x) x
#endif
 
 
 
#ifdef NO_REQUIRE
#define require(description, condition)
#else
#define require(description, condition) \
if (!(condition)) {\
    fprintf(stderr, "%s, line %d: %s's precondition \"%s\" (%s) violated\n", __FILE__, __LINE__, __func__, description, #condition);\
    exit(EXIT_FAILURE);\
}
#endif
 
#ifdef NO_REQUIRE
#define require_x(description, condition, ...)
#else
#define require_x(description, condition, ...) \
if (!(condition)) {\
    fprintf(stderr, "%s, line %d: %s's precondition \"%s\" violated: ", __FILE__, __LINE__, __func__, description);\
    fprintf(stderr, __VA_ARGS__);\
    fprintf(stderr, "\n");\
    exit(EXIT_FAILURE);\
}
#endif
 
#if 0
// print stack trace using gcc, requires
// #include <execinfo.h>
 
#include <execinfo.h>
#define require_x(description, condition, ...) \
if (!(condition)) {\
    fprintf(stderr, "%s, line %d: %s's precondition \"%s\" violated: ", __FILE__, __LINE__, __func__, description);\
    fprintf(stderr, __VA_ARGS__);\
    fprintf(stderr, "\n");\
    void *buffer[10];\
    int size = backtrace(buffer, 10);\
    char** strings = backtrace_symbols(buffer, size);\
    if (strings != NULL) {\
        for (int i = 1; i < size - 1; i++) {\
            String s = strings[i] + 59;\
            String t = strchr(s, ' ');\
            int n = t ? t - s : strlen(s);\
            printf ("    is called from %.*s\n", n, s);\
        }\
    }\
    exit(EXIT_FAILURE);\
}
#endif
 
#ifdef NO_REQUIRE
#define require_not_null(argument)
#else
#define require_not_null(argument) \
if (argument == NULL) {\
    fprintf(stderr, "%s, line %d: %s's precondition \"not null\" (" #argument ") violated\n", __FILE__, __LINE__, __func__);\
    exit(EXIT_FAILURE);\
}
#endif
 
 
 
#ifdef NO_ENSURE
#define ensure(description, condition)
#else
#define ensure(description, condition) \
if (!(condition)) {\
    fprintf(stderr, "%s, line %d: %s's postcondition \"%s\" (%s) violated\n", __FILE__, __LINE__, __func__, description, #condition);\
    exit(EXIT_FAILURE);\
}
#endif
 
#ifdef NO_ENSURE
#define ensure_x(description, condition, ...)
#else
#define ensure_x(description, condition, ...) \
if (!(condition)) {\
    fprintf(stderr, "%s, line %d: %s's postcondition \"%s\" violated: ", __FILE__, __LINE__, __func__, description);\
    fprintf(stderr, __VA_ARGS__);\
    fprintf(stderr, "\n");\
    exit(EXIT_FAILURE);\
}
#endif
 
#ifdef NO_ENSURE
#define ensure_code(x)
#else
#define ensure_code(x) x
#endif
 
#ifdef NO_ENSURE
#define ensure_not_null(pointer)
#else
#define ensure_not_null(pointer) \
if (pointer == NULL) {\
    fprintf(stderr, "%s, line %d: %s's postcondition \"not null\" (" #pointer ") violated\n", __FILE__, __LINE__, __func__);\
    exit(EXIT_FAILURE);\
}
#endif
 
#define forall(i, length, condition) ({\
   bool _forall_result = true;\
   for (int i = 0; i < length; i++) { if (!(condition)) { _forall_result = false; break; } }\
   _forall_result;\
})
 
#define forall_x(init, has_more_steps, do_step, condition) ({\
   bool _forall_result = true;\
   for (init; has_more_steps; do_step) { if (!(condition)) { _forall_result = false; break; } }\
   _forall_result;\
})
 
#define exists(i, length, condition) ({\
   bool _exists_result = false;\
   for (int i = 0; i < length; i++) { if (condition) { _exists_result = true; break; } }\
   _exists_result;\
})
 
#define exists_x(init, has_more_steps, do_step, condition) ({\
   bool _exists_result = false;\
   for (init; has_more_steps; do_step) { if (condition) { _exists_result = true; break; } }\
   _exists_result;\
})
 
#define count_if(init, has_more_steps, do_step, condition) ({\
   int _count_if_result = 0;\
   for (init; has_more_steps; do_step) { if (condition) { _count_if_result++; } }\
   _count_if_result;\
})
 
// Exit on Failure
 
#define exit_if(condition, ...) \
if (condition) {\
    flockfile(stderr);\
    fprintf(stderr, __VA_ARGS__);\
    fprintf(stderr, "\n");\
    funlockfile(stderr);\
    exit(EXIT_FAILURE);\
}
 
#define panic(...) {\
    flockfile(stderr);\
    fprintf(stderr, "%s:%d, %s: ", __FILE__, __LINE__, __func__);\
    fprintf(stderr, __VA_ARGS__);\
    fprintf(stderr, "\n");\
    funlockfile(stderr);\
    exit(EXIT_FAILURE);\
}
 
#define panic_if(condition, ...) \
if (condition) {\
    flockfile(stderr);\
    fprintf(stderr, "%s:%d, %s: ", __FILE__, __LINE__, __func__);\
    fprintf(stderr, __VA_ARGS__);\
    fprintf(stderr, "\n");\
    funlockfile(stderr);\
    exit(EXIT_FAILURE);\
}
 
// Timing
 
/*
typedef struct timespec timespec;
 
timespec time_now(void);
 
double time_ms_since(timespec t);
*/
 
// Debugging
 
#ifdef NO_DEBUG
    #define PL
    #define PLi(i)
    #define PLs(s)
    #define PLf(...)
#else
    #define PL printf("%s:%d\n", __func__, __LINE__)
    #define PLi(i) printf("%s:%d: %d\n", __func__, __LINE__, i)
    #define PLf(...) {\
        fprintf(stderr, "%s:%d: ", __func__, __LINE__);\
        fprintf(stderr, __VA_ARGS__);\
        fprintf(stderr, "\n");\
    }
#endif
 
// Memory
 
// http://www.gnu.org/software/libc/manual/html_node/Malloc-Examples.html
 
Any base_malloc(const char *file, const char *function, int line, size_t size);
 
#define xmalloc(size) base_malloc(__FILE__, __func__, __LINE__, size)
 
Any base_realloc(const char *file, const char *function, int line, Any ptr, size_t size);
 
#define xrealloc(ptr, size) base_realloc(__FILE__, __func__, __LINE__, ptr, size)
 
 
Any base_calloc(const char *file, const char *function, int line, size_t num, size_t size);
 
#define xcalloc(num, size) base_calloc(__FILE__, __func__, __LINE__, num, size)
 
void base_free(Any p);
 
#define free base_free
 
void __attribute__((noreturn)) base_exit(int status);
 
#define exit base_exit
 
// Strings
 
String s_copy(String s);
 
char s_get(String s, int i);
 
void s_set(String s, int i, char c);
 
int s_length(String s);
 
bool s_equals(String s, String t);
 
bool s_contains(String s, String part);
 
// Conversion
 
int i_of_s(String s);
 
double d_of_s(String s);
 
// Output
 
void printi(int i);
 
void printiln(int i);
 
void printd(double d);
 
void printdln(double d);
 
void printc(char c);
 
void printcln(char c);
 
void prints(String s);
 
void printsln(String s);
 
void printb(bool b);
 
void printbln(bool b);
 
void println();
 
void printia(int *a, int n);
 
void printialn(int *a, int n);
 
void printda(double *a, int n);
 
void printdaln(double *a, int n);
 
void printsa(String *a, int n); 
 
void printsaln(String *a, int n); 
 
void printca(char *a, int n);
 
void printcaln(char *a, int n);
 
void printba(Byte *a, int n);
 
void printbaln(Byte *a, int n);
 
void printboa(bool *a, int n);
 
void printboaln(bool *a, int n);
 
 
 
// Input
 
void get_line(char *line, int n);
 
String s_input(int n);
 
int i_input(void);
 
double d_input(void);
 
 
// Files
 
String s_read_file(String name);
 
void s_write_file(String name, String data);
 
void write_file_data(String name, Byte *data, int n);
 
 
 
// Random numbers
 
int i_rnd(int i);
 
double d_rnd(double i);
 
bool b_rnd(void);
 
 
 
// Testing
 
#define EPSILON 0.00000001
 
bool base_test_equal_b(const char *file, int line, bool a, bool e);
 
bool base_test_equal_i(const char *file, int line, int a, int e);
 
bool base_test_within_d(const char *file, int line, double a, double e, double epsilon);
 
bool base_test_within_i(const char *file, int line, int a, int e, int epsilon);
 
bool base_test_equal_c(const char *file, int line, char a, char e);
 
bool base_test_equal_s(const char *file, int line, String a, String e);
 
bool base_test_equal_struct(const char *file, int line, 
        Any a, Any e, AnyFn predicate);
 
 
 
#define test_equal_b(a, e) base_test_equal_b(__FILE__, __LINE__, a, e)
 
#define test_equal_i(a, e) base_test_equal_i(__FILE__, __LINE__, a, e)
 
#define test_within_d(a, e, epsilon) base_test_within_d(__FILE__, __LINE__, a, e, epsilon)
 
#define test_within_i(a, e, epsilon) base_test_within_i(__FILE__, __LINE__, a, e, epsilon)
 
#define test_equal_c(a, e) base_test_equal_c(__FILE__, __LINE__, a, e)
 
#define test_equal_s(a, e) base_test_equal_s(__FILE__, __LINE__, a, e)
 
 
 
#define test_equal_ca(a, e, ne) base_test_equal_ca(__FILE__, __LINE__, a, e, ne)
 
#define test_equal_boa(a, e, ne) base_test_equal_ba(__FILE__, __LINE__, a, e, ne)
 
#define test_equal_struct(a, e, p) base_test_equal_struct(__FILE__, __LINE__, a, e, p)
 
 
 
void base_count_check(void);
 
void base_count_success(void);
 
#endif