zeiss_utils/Z1000_focus/usefull_macros.c

/*
 * usefull_macros.h - a set of usefull functions: memory, color etc
 *
 * Copyright 2013 Edward V. Emelianoff <eddy@sao.ru>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 */

#include "usefull_macros.h"
#include <time.h>
#include <linux/limits.h> // PATH_MAX

/**
 * function for different purposes that need to know time intervals
 * @return double value: time in seconds
 */
double dtime(){
    double t;
    struct timeval tv;
    gettimeofday(&tv, NULL);
    t = tv.tv_sec + ((double)tv.tv_usec)/1e6;
    return t;
}

/******************************************************************************\
 *                          Coloured terminal
\******************************************************************************/
int globErr = 0; // errno for WARN/ERR

// pointers to coloured output printf
int (*red)(const char *fmt, ...);
int (*green)(const char *fmt, ...);
int (*_WARN)(const char *fmt, ...);

/*
 * format red / green messages
 * name: r_pr_, g_pr_
 * @param fmt ... - printf-like format
 * @return number of printed symbols
 */
int r_pr_(const char *fmt, ...){
    va_list ar; int i;
    printf(RED);
    va_start(ar, fmt);
    i = vprintf(fmt, ar);
    va_end(ar);
    printf(OLDCOLOR);
    return i;
}
int g_pr_(const char *fmt, ...){
    va_list ar; int i;
    printf(GREEN);
    va_start(ar, fmt);
    i = vprintf(fmt, ar);
    va_end(ar);
    printf(OLDCOLOR);
    return i;
}
/*
 * print red error/warning messages (if output is a tty)
 * @param fmt ... - printf-like format
 * @return number of printed symbols
 */
int r_WARN(const char *fmt, ...){
    va_list ar; int i = 1;
    fprintf(stderr, RED);
    va_start(ar, fmt);
    if(globErr){
        errno = globErr;
        vwarn(fmt, ar);
        errno = 0;
    }else
        i = vfprintf(stderr, fmt, ar);
    va_end(ar);
    i++;
    fprintf(stderr, OLDCOLOR "\n");
    return i;
}

static const char stars[] = "****************************************";
/*
 * notty variants of coloured printf
 * name: s_WARN, r_pr_notty
 * @param fmt ... - printf-like format
 * @return number of printed symbols
 */
int s_WARN(const char *fmt, ...){
    va_list ar; int i;
    i = fprintf(stderr, "\n%s\n", stars);
    va_start(ar, fmt);
    if(globErr){
        errno = globErr;
        vwarn(fmt, ar);
        errno = 0;
    }else
        i = +vfprintf(stderr, fmt, ar);
    va_end(ar);
    i += fprintf(stderr, "\n%s\n", stars);
    i += fprintf(stderr, "\n");
    return i;
}
int r_pr_notty(const char *fmt, ...){
    va_list ar; int i;
    i = printf("\n%s\n", stars);
    va_start(ar, fmt);
    i += vprintf(fmt, ar);
    va_end(ar);
    i += printf("\n%s\n", stars);
    return i;
}

/**
 * Run this function in the beginning of main() to setup locale & coloured output
 */
void initial_setup(){
    // setup coloured output
    if(isatty(STDOUT_FILENO)){ // make color output in tty
        red = r_pr_; green = g_pr_;
    }else{ // no colors in case of pipe
        red = r_pr_notty; green = printf;
    }
    if(isatty(STDERR_FILENO)) _WARN = r_WARN;
    else _WARN = s_WARN;
    // Setup locale
    setlocale(LC_ALL, "");
    setlocale(LC_NUMERIC, "C");
#if defined GETTEXT_PACKAGE && defined LOCALEDIR
    bindtextdomain(GETTEXT_PACKAGE, LOCALEDIR);
    textdomain(GETTEXT_PACKAGE);
#endif
}

/******************************************************************************\
 *                                  Memory
\******************************************************************************/
/*
 * safe memory allocation for macro ALLOC
 * @param N - number of elements to allocate
 * @param S - size of single element (typically sizeof)
 * @return pointer to allocated memory area
 */
void *my_alloc(size_t N, size_t S){
    void *p = calloc(N, S);
    if(!p) ERR("malloc");
    //assert(p);
    return p;
}

/**
 * Mmap file to a memory area
 *
 * @param filename (i) - name of file to mmap
 * @return stuct with mmap'ed file or die
 */
mmapbuf *My_mmap(char *filename){
    int fd;
    char *ptr;
    size_t Mlen;
    struct stat statbuf;
    /// "<22><> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD>!"
    if(!filename){
        WARNX(_("No filename given!"));
        return NULL;
    }
    if((fd = open(filename, O_RDONLY)) < 0){
    /// "<22><> <20><><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> %s <20><><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>"
        WARN(_("Can't open %s for reading"), filename);
        return NULL;
    }
    if(fstat (fd, &statbuf) < 0){
    /// "<22><> <20><><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> stat %s"
        WARN(_("Can't stat %s"), filename);
        close(fd);
        return NULL;
    }
    Mlen = statbuf.st_size;
    if((ptr = mmap (0, Mlen, PROT_READ, MAP_PRIVATE, fd, 0)) == MAP_FAILED){
    /// "<22><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> mmap"
        WARN(_("Mmap error for input"));
        close(fd);
        return NULL;
    }
    /// "<22><> <20><><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> mmap'<27><><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD>"
    if(close(fd)) WARN(_("Can't close mmap'ed file"));
    mmapbuf *ret = MALLOC(mmapbuf, 1);
    ret->data = ptr;
    ret->len = Mlen;
    return  ret;
}

void My_munmap(mmapbuf *b){
    if(munmap(b->data, b->len)){
    /// "<22><> <20><><EFBFBD><EFBFBD> munmap"
        ERR(_("Can't munmap"));
    }
    FREE(b);
}


/******************************************************************************\
 *                          Terminal in no-echo mode
\******************************************************************************/
static struct termios oldt, newt; // terminal flags
static int console_changed = 0;
// run on exit:
void restore_console(){
    if(console_changed)
        tcsetattr(STDIN_FILENO, TCSANOW, &oldt); // return terminal to previous state
    console_changed = 0;
}

// initial setup:
void setup_con(){
    if(console_changed) return;
    tcgetattr(STDIN_FILENO, &oldt);
    newt = oldt;
    newt.c_lflag &= ~(ICANON | ECHO);
    if(tcsetattr(STDIN_FILENO, TCSANOW, &newt) < 0){
        /// "<22><> <20><><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>"
        WARN(_("Can't setup console"));
        tcsetattr(STDIN_FILENO, TCSANOW, &oldt);
        signals(0); //quit?
    }
    console_changed = 1;
}

/**
 * Read character from console without echo
 * @return char readed
 */
int read_console(){
    int rb;
    struct timeval tv;
    int retval;
    fd_set rfds;
    FD_ZERO(&rfds);
    FD_SET(STDIN_FILENO, &rfds);
    tv.tv_sec = 0; tv.tv_usec = 10000;
    retval = select(1, &rfds, NULL, NULL, &tv);
    if(!retval) rb = 0;
    else {
        if(FD_ISSET(STDIN_FILENO, &rfds)) rb = getchar();
        else rb = 0;
    }
    return rb;
}

/**
 * getchar() without echo
 * wait until at least one character pressed
 * @return character readed
 */
int mygetchar(){ // getchar() without need of pressing ENTER
    int ret;
    do ret = read_console();
    while(ret == 0);
    return ret;
}


/******************************************************************************\
 *                              TTY with select()
\******************************************************************************/
static struct termio oldtty, tty; // TTY flags
static int comfd = -1; // TTY fd

// run on exit:
void restore_tty(){
    if(comfd == -1) return;
    ioctl(comfd, TCSANOW, &oldtty ); // return TTY to previous state
    close(comfd);
    comfd = -1;
}

#ifndef BAUD_RATE
#define BAUD_RATE B4800
#endif
// init:
void tty_init(char *comdev){
    DBG("\nOpen port %s ...\n", comdev);
    do{
        comfd = open(comdev,O_RDWR|O_NOCTTY|O_NONBLOCK);
    }while (comfd == -1 && errno == EINTR);
    if(comfd < 0){
        WARN("Can't use port %s\n",comdev);
        signals(-1); // quit?
    }
    // make exclusive open
    if(ioctl(comfd, TIOCEXCL)){
        WARN(_("Can't do exclusive open"));
        close(comfd);
        signals(2);
    }
    DBG(" OK\nGet current settings... ");
    if(ioctl(comfd,TCGETA,&oldtty) < 0){  // Get settings
        /// "<22><> <20><><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>"
        WARN(_("Can't get settings"));
        signals(-1);
    }
    tty = oldtty;
    tty.c_lflag     = 0; // ~(ICANON | ECHO | ECHOE | ISIG)
    tty.c_oflag     = 0;
    tty.c_cflag     = BAUD_RATE|CS8|CREAD|CLOCAL; // 9.6k, 8N1, RW, ignore line ctrl
    tty.c_cc[VMIN]  = 0;  // non-canonical mode
    tty.c_cc[VTIME] = 5;
    if(ioctl(comfd,TCSETA,&tty) < 0){
        /// "<22><> <20><><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>"
        WARN(_("Can't set settings"));
        signals(-1);
    }
    DBG(" OK\n");
}

/**
 * Read data from TTY
 * @param buff (o) - buffer for data read
 * @param length   - buffer len
 * @return amount of bytes read
 */
size_t read_tty(char *buff, size_t length){
    ssize_t L = 0, l;
    char *ptr = buff;
    fd_set rfds;
    struct timeval tv;
    int retval;
    do{
        l = 0;
        FD_ZERO(&rfds);
        FD_SET(comfd, &rfds);
        // wait for 100ms
        tv.tv_sec = 0; tv.tv_usec = 100000;
        retval = select(comfd + 1, &rfds, NULL, NULL, &tv);
        if (!retval) break;
        if(FD_ISSET(comfd, &rfds)){
            if((l = read(comfd, ptr, length)) < 1){
                return 0;
            }
            ptr += l; L += l;
            length -= l;
        }
    }while(l);
    return (size_t)L;
}

int write_tty(char *buff, size_t length){
    ssize_t L = write(comfd, buff, length);
    if((size_t)L != length){
        /// "<22><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>!"
        WARN("Write error");
        return 1;
    }
    return 0;
}


/**
 * Safely convert data from string to double
 *
 * @param num (o) - double number read from string
 * @param str (i) - input string
 * @return 1 if success, 0 if fails
 */
int str2double(double *num, const char *str){
    double res;
    char *endptr;
    if(!str) return 0;
    res = strtod(str, &endptr);
    if(endptr == str || *str == '\0' || *endptr != '\0'){
        /// "<22><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD> double!"
        WARNX("Wrong double number format!");
        return FALSE;
    }
    if(num) *num = res; // you may run it like myatod(NULL, str) to test wether str is double number
    return TRUE;
}

static FILE *Flog = NULL; // log file descriptor
static char *logname = NULL; // full logfile name (with PID prefix)
static time_t log_open_time = 0; // time when log file was opened
/**
 * Try to open log file
 * if failed show warning message
 */
void openlogfile(char *name){
    //char buf[PATH_MAX];
    if(Flog){
        fclose(Flog);
        Flog = NULL;
    }
    if(!name) return;
    /*
    if(!name){ // filename is omit -> try to open log with old name
        if(!fullogname){
            WARNX(_("openlogfile(): need filename"));
            return;
        }
        name = fullogname;
    }else{
        if(fullogname) FREE(fullogname);
        // append PID to name
        snprintf(buf, PATH_MAX, "%d_%s", getpid(), name);
        name = buf;
        green(_("Try to open log file %s in append mode"), name);
        printf("\n");
    }*/
    if(!(Flog = fopen(name, "a"))){
        WARN(_("Can't open log file"));
        return;
    }
    log_open_time = time(NULL);
    logname = name;
    //fullogname = strdup(buf);
}

/**
 * Save message to log file, rotate logs every 24 hours
 */
int putlog(const char *fmt, ...){
    if(!Flog) return 0;
    char strtm[128];
    time_t t = time(NULL);
    struct tm *curtm = localtime(&t);
    int i = strftime(strtm, 128, "%Y/%m/%d-%H:%M", curtm);
    if(t - log_open_time > 86400){ // rotate log
        fprintf(Flog, "\n\n%s\tRotate log\n", strtm);
        fclose(Flog);
        Flog = NULL;
        char newname[PATH_MAX];
        snprintf(newname, PATH_MAX, "%s.old", logname);
        if(rename(logname, newname)) WARN("rename()");
        openlogfile(NULL);
        if(!Flog) return 0;
    }
    va_list ar;
    fprintf(Flog, "%s\t", strtm);
    va_start(ar, fmt);
    i += vfprintf(Flog, fmt, ar);
    va_end(ar);
    fprintf(Flog, "\n");
    ++i;
    fflush(Flog);
    return i;
}

// add message to log file without printing time
int addtolog(const char *fmt, ...){
    if(!Flog) return 0;
    va_list ar;
    int i = 1;
    fprintf(Flog, "\t\t\t");
    va_start(ar, fmt);
    i += vfprintf(Flog, fmt, ar);
    va_end(ar);
    fprintf(Flog, "\n");
    ++i;
    fflush(Flog);
    return i;
}

// messages for warning codes
static const char *wmsgs[WARN_LAST] = {
    [WARN_NO]           = "All OK",
    [WARN_ESWSTATE]     = "Can't read end-switches state",
    [WARN_SENDPAR]      = "can_send_param(): error getting answer",
    [WARN_MOVEDAMAGED]  = "Try to move in damaged state",
    [WARN_BOTHESW]      = "Both end-switches are active! Damage state.",
    [WARN_LESSMIN]      = "Forbidden position: < FOCMIN!",
    [WARN_GRTRMAX]      = "Forbidden position: > FOCMAX!",
    [WARN_CANSEND]      = "Error sending CAN frame",
    [WARN_CANNOANS]     = "can_send_chk(): error getting answer",

};
static time_t lasttime[WARN_LAST] = {0};

/**
 * @brief clrwarnsingle - reset warning timeout & give log message
 * @param errnum - number of warning
 */
void clrwarnsingle(locwarn errnum){
    if(errnum >= WARN_LAST) return;
    time_t cur = time(NULL);
    if(cur - lasttime[errnum] > SINGLEW_TIMEOUT) return;
    putlog("Cleared error: %s", wmsgs[errnum]);
    lasttime[errnum] = 0;
}
/**
 * @brief warnsingle
 * @param msg
 * @param errnum
 */
void warnsingle(const char *msg, locwarn errnum){
    if(errnum >= WARN_LAST) return;
    time_t cur = time(NULL);
    if(cur - lasttime[errnum] < SINGLEW_TIMEOUT) return;
    lasttime[errnum] = cur;
    const char *wmsg = wmsgs[errnum];
    _WARN("WARNING in %s: %s", msg, wmsg);
    putlog("WARNING in %s:", msg);
    addtolog(wmsg);
}