start gathering snippets into one library

examples/CMakeLists.txt

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 3.9)
+project(examples)
+
+# common includes & library
+include_directories(../)
+link_libraries(usefull_macros)
+
+# exe list
+add_executable(helloworld helloworld.c)
+add_executable(options options.c cmdlnopts.c)

examples/cmdlnopts.c

@@ -0,0 +1,87 @@
+/*                                                                                                  geany_encoding=koi8-r
+ * cmdlnopts.c - the only function that parse cmdln args and returns glob parameters
+ *
+ * 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 <assert.h>
+#include <stdio.h>
+#include <string.h>
+#include <strings.h>
+#include <math.h>
+#include "cmdlnopts.h"
+#include "usefull_macros.h"
+
+/*
+ * here are global parameters initialisation
+ */
+int help;
+glob_pars  G;
+
+#define DEFAULT_COMDEV  "/dev/ttyUSB0"
+// default PID filename:
+#define DEFAULT_PIDFILE "/tmp/testcmdlnopts.pid"
+
+//            DEFAULTS
+// default global parameters
+glob_pars const Gdefault = {
+    .device = DEFAULT_COMDEV,
+    .pidfile = DEFAULT_PIDFILE,
+    .logfile = NULL // don't save logs
+};
+
+/*
+ * Define command line options by filling structure:
+ *  name        has_arg     flag    val     type        argptr              help
+*/
+myoption cmdlnopts[] = {
+// common options
+    {"help",    NO_ARGS,    NULL,   'h',    arg_int,    APTR(&help),        _("show this help")},
+    {"device",  NEED_ARG,   NULL,   'd',    arg_string, APTR(&G.device),    _("serial device name (default: " DEFAULT_COMDEV ")")},
+    {"logfile", NEED_ARG,   NULL,   'l',    arg_string, APTR(&G.logfile),   _("file to save logs")},
+    {"pidfile", NEED_ARG,   NULL,   'P',    arg_string, APTR(&G.pidfile),   _("pidfile (default: " DEFAULT_PIDFILE ")")},
+   end_option
+};
+
+/**
+ * Parse command line options and return dynamically allocated structure
+ *      to global parameters
+ * @param argc - copy of argc from main
+ * @param argv - copy of argv from main
+ * @return allocated structure with global parameters
+ */
+glob_pars *parse_args(int argc, char **argv){
+    int i;
+    void *ptr;
+    ptr = memcpy(&G, &Gdefault, sizeof(G)); assert(ptr);
+    size_t hlen = 1024;
+    char helpstring[1024], *hptr = helpstring;
+    snprintf(hptr, hlen, "Usage: %%s [args]\n\n\tWhere args are:\n");
+    // format of help: "Usage: progname [args]\n"
+    change_helpstring(helpstring);
+    // parse arguments
+    parseargs(&argc, &argv, cmdlnopts);
+    if(help) showhelp(-1, cmdlnopts);
+    if(argc > 0){
+        G.rest_pars_num = argc;
+        G.rest_pars = MALLOC(char *, argc);
+        for (i = 0; i < argc; i++)
+            G.rest_pars[i] = strdup(argv[i]);
+    }
+    return &G;
+}
+

examples/cmdlnopts.h

@@ -0,0 +1,39 @@
+/*                                                                                                  geany_encoding=koi8-r
+ * cmdlnopts.h - comand line options for parceargs
+ *
+ * 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.
+ */
+
+#pragma once
+#ifndef __CMDLNOPTS_H__
+#define __CMDLNOPTS_H__
+
+/*
+ * here are some typedef's for global data
+ */
+typedef struct{
+    char *device;           // serial device name
+    char *pidfile;          // name of PID file
+    char *logfile;          // logging to this file
+    int rest_pars_num;      // number of rest parameters
+    char** rest_pars;       // the rest parameters: array of char*
+} glob_pars;
+
+
+glob_pars *parse_args(int argc, char **argv);
+#endif // __CMDLNOPTS_H__

examples/helloworld.c

@@ -0,0 +1,35 @@
+/*
+ * This file is part of the usefull_macros project.
+ * Copyright 2018 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <usefull_macros.h>
+
+/**
+ * This is a simplest example of library usage: "blind" getchar
+ */
+
+int main(){
+    initial_setup();
+    // setup non-echo non-canonical mode
+    setup_con();
+    green("Press any key...\n");
+    char k = mygetchar();
+    red("You press %c\n", k);
+    // don't forget to restore @exit!
+    restore_console();
+    return 0;
+}

examples/options.c

@@ -0,0 +1,81 @@
+/*
+ * This file is part of the usefull_macros project.
+ * Copyright 2018 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <usefull_macros.h>
+#include <signal.h>         // signal
+#include <stdlib.h>         // exit, free
+#include <stdio.h>          // printf
+#include <string.h>         // strdup
+#include <unistd.h>         // sleep
+#include "cmdlnopts.h"
+
+/**
+ * This is an example of usage:
+ *  - command line arguments,
+ *  - log file,
+ *  - check of another file version running,
+ *  - signals management,
+ *  - serial port reading/writing.
+ * The `cmdlnopts.[hc]` are intrinsic files of this demo.
+ */
+
+/**
+ * We REDEFINE the default WEAK function of signal processing
+ */
+void signals(int sig){
+    signal(sig, SIG_IGN);
+    restore_console();
+    restore_tty();
+    DBG("Get signal %d, quit.\n", sig);
+    putlog("Exit with status %d", sig);
+    exit(sig);
+}
+
+void iffound_default(pid_t pid){
+    ERRX("Another copy of this process found, pid=%d. Exit.", pid);
+}
+
+int main(int argc, char *argv[]){
+    initial_setup();
+    char *self = strdup(argv[0]);
+    glob_pars *GP = parse_args(argc, argv);
+    if(GP->rest_pars_num){
+        printf("%d extra options:\n", GP->rest_pars_num);
+        for(int i = 0; i < GP->rest_pars_num; ++i)
+            printf("%s\n", GP->rest_pars[i]);
+    }
+    check4running(self, GP->pidfile);
+    free(self);
+    signal(SIGTERM, signals); // kill (-15) - quit
+    signal(SIGHUP, SIG_IGN);  // hup - ignore
+    signal(SIGINT, signals);  // ctrl+C - quit
+    signal(SIGQUIT, signals); // ctrl+\ - quit
+    signal(SIGTSTP, SIG_IGN); // ignore ctrl+Z
+    if(GP->logfile) openlogfile(GP->logfile);
+    setup_con();
+    putlog(("Start application..."));
+    ; // main stuff goes here
+    green("Now I will sleep for 10 seconds. Do whatever you want.\n");
+    sleep(10);
+    ; // clean everything
+    if(GP->pidfile) // remove unnesessary PID file
+        unlink(GP->pidfile);
+    restore_console();
+    restore_tty();
+    return 0;
+}