BM_makeconst.cc

// file BM_makeconst.cc
// SPDX-License-Identifier: GPL-3.0-or-later

/***
    BISMON
    Copyright © 2018 - 2021 CEA (Commissariat à l'énergie atomique et aux énergies alternatives)
    contributed by Basile Starynkevitch (working at CEA, LIST, France)
    <basile@starynkevitch.net> or <basile.starynkevitch@cea.fr>

    BM_makeconst: a standalone program to scan and collect BMK_<digit><alphanum> constant names
    for example BMK_0eMGYofuNVh_8ZP2mXdhtHO is the 'in' predefined constant

    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 <iostream>
#include <sstream>
#include <fstream>
#include <ostream>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <cctype>
#include <set>
#include <string>
#include <unistd.h>
#include <time.h>
#include <argp.h>

#include "id_BM.h"

#ifndef BISMON_SHORTGIT
#define BISMON_SHORTGIT "???"
#warning BISMON_SHORTGIT should be defined with -D in compilation command
#endif /*BISMON_SHORTGIT*/

char bmk_datestr[24];

char* bmk_progname;
extern "C" void  bmk_fatal_stop_at(const char*fil, int lin);
#define BMK_FATALOUT_AT_BIS(Fil,Lin,...) do {	\
    std::cerr << "** " << bmk_progname << " FATAL! "	\
	      << (Fil) << ":" << Lin << ":: "	\
	      << __VA_ARGS__ << std::endl;	\
    bmk_fatal_stop_at (Fil,Lin); } while(0)

#define BMK_FATALOUT_AT(Fil,Lin,...) BMK_FATALOUT_AT_BIS(Fil,Lin,##__VA_ARGS__)

// typical usage would be BMK_FATALOUT("x=" << x)
#define BMK_FATALOUT(...) BMK_FATALOUT_AT(__FILE__,__LINE__,##__VA_ARGS__)


// see https://www.gnu.org/software/libc/manual/html_node/Argp.html
#warning we should have more options and parse them with argp

/** examples of invocation:
To process a single file and generate its header
    ./BM_makeconst -H user_BM.const.h user_BM.c

To process all the files and generate the constants
    ./BM_makeconst -C _bm_allconsts.c *_BM.c misc_BM.cc

To output, if it is #include-d, the _BM.const.h file related to scalar_BM.c
    ./BM_makeconst -S scalar_BM.c
otherwise exit code is 1
***/

#define BMPREFIXSIZE 4 /* the length of both "BMK_" and "BMH_" prefixes */
typedef std::set<rawid_tyBM, IdLess_BM> set_of_ids_KBM;

// for program argument parsing using argp
// see https://www.gnu.org/software/libc/manual/html_node/Argp.html
void bmk_parse_program_options(int argc, char**argv);
static error_t bmk_parse1opt (int key, char *arg, struct argp_state *state);
enum bmk_progoption_en
{
  BMKPROGOPT__NONE,
  BMKPROGOPT_VERSION= 1000,
  BMKPROGOPT_GENERATE_CONST_HEADER,
  BMKPROGOPT_GENERATE_ALL_CONST,
};				// end enum bmk_progoption_en




int totalnbkocc;		// total cumulated number of occurrences of BMK_ for constants

int totalnbhocc;		// total cumulated number of occurrences of BMH_ for hashes

int parse_cfile(const char*path, set_of_ids_KBM &bmconstset, set_of_ids_KBM &bmhashset, bool verbose=false)
{
  if (access(path, R_OK))
    {
      fprintf(stderr, "cannot access C file %s (%m)\n", path);
      exit(EXIT_FAILURE);
    };
  std::ifstream srcin(path);
  int linecnt = 0;
  int nbkocc = 0;
  int nbhocc = 0;
  do
    {
      std::string line;
      std::getline(srcin, line);
      ssize_t linesize = line.size();
      ssize_t bmkpos=0;
      ssize_t bmhpos=0;
      while (bmkpos<(ssize_t)linesize && bmhpos<(ssize_t)linesize)
        {
          bmkpos=line.find("BMK_", bmkpos);
          bmhpos=line.find("BMH_", bmhpos);
          if (bmkpos>0 && bmhpos > 0)
            {
              fprintf(stderr, "%s:%d: cannot have both BMK_ and BMH_ on the same line\n",
                      path, linecnt+1);
              exit(EXIT_FAILURE);
            };
          if (bmkpos < 0 && bmhpos < 0)
            break;
          ///
          /// ignore BMK_ if following a letter, digit or underscore,
          /// or if not followed by digit
          if (bmkpos>0 && ((isalnum(line[bmkpos-1]) || line[bmkpos-1]=='_')
                           || (bmkpos+BMPREFIXSIZE >= linesize || !isdigit(line[bmkpos+BMPREFIXSIZE]))))
            {
              while (bmkpos>0 && bmkpos<(ssize_t)linesize && (isalnum(line[bmkpos])||line[bmkpos]=='_'))
                bmkpos++;
              continue;
            };
          ///
          /// ignore BMH_ if following a letter, digit or underscore,
          /// or if not followed by digit
          if (bmhpos>0 && ((isalnum(line[bmhpos-1]) || line[bmhpos-1]=='_')
                           || (bmhpos+BMPREFIXSIZE >= linesize || !isdigit(line[bmhpos+BMPREFIXSIZE]))))
            {
              while (bmhpos>0 && bmhpos<(ssize_t)linesize && (isalnum(line[bmhpos])||line[bmhpos]=='_'))
                bmhpos++;
              continue;
            };
          ///
          ///
          /// handle the id after BMK_
          if (bmkpos > 0)
            {
              const char*bmkcptr = line.c_str() + bmkpos;
              const char*endbmk = nullptr;
              const rawid_tyBM bmkid = parse_rawid_BM(bmkcptr+BMPREFIXSIZE-1, &endbmk);
              if (validid_BM(bmkid) && endbmk != nullptr)
                {
                  bmconstset.insert(bmkid);
                  totalnbkocc++;
                  nbkocc++;
                  bmkpos = endbmk - line.c_str();
                }
              else bmkpos += BMPREFIXSIZE;
            }
          ///
          ///
          /// handle the id after BMH_
          if (bmhpos > 0)
            {
              const char*bmhcptr = line.c_str() + bmhpos;
              const char*endbmh = nullptr;
              rawid_tyBM bmhid = parse_rawid_BM(bmhcptr+BMPREFIXSIZE-1, &endbmh);
              if (validid_BM(bmhid) && endbmh != nullptr)
                {
                  bmhashset.insert(bmhid);
                  totalnbhocc++;
                  nbhocc++;
                  bmhpos = endbmh - line.c_str();
                }
              else bmhpos += BMPREFIXSIZE;
            }
        };			// end while
      linecnt++;
    }
  while (srcin);
  if (verbose)
    {
      printf("processed %d lines from %s with %d constant occurrences, %d hashes\n",
             linecnt, path, nbkocc, nbhocc);
      fflush(nullptr);
    }
  return linecnt;
} // end parse_cfile


/// return true if some #include "foo_BM.const.h" was found in start of foo_BM.c, also output that included header
bool
seek_header_in_cfile(const char*path)
{
  std::ifstream srcin(path);
  int linecnt = 0;
  int nbincl = 0;
  do
    {
      std::string line;
      std::getline(srcin, line);
      ssize_t linesize = line.size();
      linecnt ++;
      char inclbuf[64];
      memset (inclbuf, 0, sizeof(inclbuf));
      int eol= -1;
      if (linesize > 8 && line[0] == '#'
          && sscanf(line.c_str(), "# include \"%60[A-Za-z0-9_.]\" %n",
                    inclbuf, &eol) >= 1
          && eol > 16)
        {
          if (strstr(line.c_str(), "_BM.const.h"))
            {
              std::cout << inclbuf << std::endl;
              nbincl ++;
            }
        }
    }
  while (linecnt < 128);
  return nbincl>0;
} // end seek_header_in_cfile


/// heavily inspired by similar code I wrote for RefPerSys - see http://refpersys.org/ for more...
struct argp_option
  bmk_progoptions[] =
{
  /* ======= give version information ======= */
  {/*name:*/ "version", ///
    /*key:*/ BMKPROGOPT_VERSION, ///
    /*arg:*/ nullptr, ///
    /*flags:*/ 0, ///
    /*doc:*/ "give version information", ///
    /*group:*/0 ///
  },
  /* ======= generate a foo_BM.const.h header for foo_BM.c ======= */
  {/*name:*/ "generate-const-header", ///
    /*key:*/ BMKPROGOPT_GENERATE_CONST_HEADER, ///
    /*arg:*/ "HEADER", ///
    /*flags:*/ 0, ///
    /*doc:*/ "generate the (temporary) HEADER constant file for a given"
    " <foo>_BM.c;\n"
    " usually for <foo>_BM.c your HEADER should be <foo>_BM.const.h", ///
    /*group:*/0 ///
  },
  /* ======= generate the all-constants CONSTFILE file for several *_BM.c ======= */
  {/*name:*/ "generate-all-constants", ///
    /*key:*/ BMKPROGOPT_GENERATE_ALL_CONST, ///
    /*arg:*/ "CONSTFILE", ///
    /*flags:*/ 0, ///
    /*doc:*/ "generate the CONSTFILE all-persistent-constants file for several given *_BM.c files;"
    " usually CONSTFILE should be _bismon-constants.c", ///
    /*group:*/0 ///
  },
  /* ======= terminating empty option ======= */
  {/*name:*/(const char*)0, ///
    /*key:*/0, ///
    /*arg:*/(const char*)0, ///
    /*flags:*/0, ///
    /*doc:*/(const char*)0, ///
    /*group:*/0 ///
  }
};				// end bmk_progoptions

error_t
bmk_parse1opt (int key, char *arg, struct argp_state *state)
{
  bool side_effect = state != nullptr;
  switch (key)
    {
    case BMKPROGOPT_VERSION:
    {
      if (side_effect)
        {
          std::cout << bmk_progname << " compiled from " __FILE__ " at " __DATE__ << " git " BISMON_SHORTGIT << std::endl;
        }
      return 0;
    }

    case BMKPROGOPT_GENERATE_CONST_HEADER:
    {
      if (side_effect)
        {
          if (!arg)
            BMK_FATALOUT("Program option --generate-const-header requires a given HEADER argument. Try "
                         << bmk_progname << " --help.");
#warning incomplete code in bmk_parse1opt
        }
    }

    case BMKPROGOPT_GENERATE_ALL_CONST:
    {
    }
    }
  return ARGP_ERR_UNKNOWN;
} // end bmk_parse1opt

void
bmk_parse_program_options(int argc, char**argv)
{
  errno = 0;
  struct argp_state argstate;
  memset (&argstate, 0, sizeof(argstate));
  static struct argp argparser;
  argparser.options = bmk_progoptions;
  argparser.parser = bmk_parse1opt;
  argparser.args_doc = " ; # ";
  argparser.doc = "BM_makeconst is an internal utility (GPLv3+ licensed) [meta-]program generating some C files inside the BISMON project.\n"
                  "see starynkevitch.net/Basile/bismon-doc.pdf and github.com/bstarynk/bismon/ for more about BISMON.\n"
                  "You should have received a copy of the GNU General Public License\n"
                  "along with this program.  If not, see https://www.gnu.org/licenses\n"
                  "**NO WARRANTY, not even for FITNESS FOR A PARTICULAR PURPOSE**\n"
                  "+++ use at your own risk +++\n"
                  "\n Accepted program options are:\n";
  argparser.children = nullptr;
  argparser.help_filter = nullptr;
  argparser.argp_domain = nullptr;
  if (argp_parse(&argparser, argc, argv, 0, nullptr, nullptr))
    BMK_FATALOUT("invalid program arguments - run " << bmk_progname << " --help for more.");
} // end bmk_parse_program_options


const char*bmk_fatal_file;
int bmk_fatal_line;
void bmk_fatal_stop_at(const char*fil, int lin)
{
  bmk_fatal_file = fil;
  bmk_fatal_line = lin;
  abort();
} // end of bmk_fatal_stop_at

int
main(int argc, char**argv)
{
  bmk_progname = argv[0];
  {
    time_t nowt=0;
    time(&nowt);
    struct tm nowtm={};
    localtime_r(&nowt, &nowtm);
    strftime(bmk_datestr,sizeof(bmk_datestr), "%Y_%b_%d", &nowtm);
  }
  if (argc < 3 || (argc>1 && !strcmp(argv[1], "--help")))
show_usage:
    {
      fprintf(stderr, "%s expects one of the following invocations:\n"
              "\t -H <generated-header> <C-file>   # generate *.const.h\n"
              "\t -S <C-file>                      # output included *.const.h, or else fail\n"
              "\t -C <generated-code> <C-files>... # generate the global const file\n", argv[0]);
      fprintf(stderr, "%s also accepts --version and --help, per GNU habits.\n",
              argv[0]);
      fprintf(stderr, "\n"
              "See github.com/bstarynk/bismon and perhaps the DRAFT on starynkevitch.net/Basile/bismon-doc.pdf\n");
      fprintf(stderr, "This is a GPLv3+ licensed software *WITHOUT ANY WARRANTY*, see www.gnu.org/licenses/gpl-3.0.en.html\n");
      exit(EXIT_FAILURE);
    }
  if (argc >= 2 && !strcmp(argv[1], "--version"))
    {
      printf("%s built from %s shortgit %s at %s\n",
             argv[0], __FILE__, BISMON_SHORTGIT, __DATE__ "@" __TIME__);
      printf("See github.com/bstarynk/bismon and perhaps the DRAFT on starynkevitch.net/Basile/bismon-doc.pdf\n");
      printf("This is a GPLv3+ licensed software *WITHOUT ANY WARRANTY*, see www.gnu.org/licenses/gpl-3.0.en.html\n");
      exit(EXIT_SUCCESS);
    };
  if (argc >= 2 && !strcmp(argv[1], "-H"))
    {
      auto hpath = argv[2];
      set_of_ids_KBM bmconstset;
      set_of_ids_KBM bmhashset;
      for (int ix=3; ix<argc; ix++)
        parse_cfile(argv[ix], bmconstset, bmhashset, true);
      std::ofstream outh(hpath);
      outh << "// Generated header " << hpath << " for "
           << bmconstset.size() << " constants and "
           << bmhashset.size() << " hashes;"
           " DONT EDIT" << std::endl;
      outh << "// ... generated by " __FILE__ " git " << BISMON_SHORTGIT << " on " << bmk_datestr << std::endl;
      outh << "// ... see github.com/bstarynk/bismon ...." << std::endl;
      outh << std::endl << "// " << bmconstset.size() << " constants:" << std::endl;
      for (auto id: bmconstset)
        {
          char bufid[32];
          memset (bufid, 0, sizeof(bufid));
          idtocbuf32_BM(id, bufid);
          outh << "extern void*bmconst" << bufid << ";" << std::endl;
          outh << "#define BMK" << bufid << " bmconst" << bufid <<std::endl;
        }
      outh << std::endl << "// " << bmhashset.size() << " hashes:" << std::endl;
      for (auto id: bmhashset)
        {
          char bufid[32];
          memset (bufid, 0, sizeof(bufid));
          idtocbuf32_BM(id, bufid);
          hash_tyBM h = hashid_BM(id);
          outh << "#define BMH" << bufid << " " << h << std::endl;
        }
      outh << "//- eof generated header " << hpath << std::endl;
    }
  else if (argc >= 2 && !strcmp(argv[1], "-C"))
    {
      auto spath = argv[2];
      int nblines = 0;
      set_of_ids_KBM bmconstset;
      set_of_ids_KBM bmhashset;
      for (int ix=3; ix<argc; ix++)
        nblines += parse_cfile(argv[ix], bmconstset, bmhashset, false);
      std::ofstream outs(spath);
      outs << "/** §GENERATED_PERSISTENT§ constant file " << spath << std::endl;
      outs << "  from:";
      for (int ix=3; ix<argc; ix++)
        {
          if ((ix - 3) % 4 == 0)
            outs << std::endl << " ...";
          outs<< ' ' << argv[ix];
        }
      outs << std::endl << " DONT EDIT, but keep this file... **/" << std::endl;
      outs << "// ... generated by " __FILE__ " git " << BISMON_SHORTGIT << " on " << bmk_datestr << std::endl;
      outs << "// ... see github.com/bstarynk/bismon for more." << std::endl;
      outs << std::endl << std::endl;
      for (auto id: bmconstset)
        {
          char bufid[32];
          memset (bufid, 0, sizeof(bufid));
          idtocbuf32_BM(id, bufid);
          outs << "void*bmconst" << bufid << ";" << std::endl;
        };
      outs << std::endl;
      outs << "const int bmnbconsts=" << bmconstset.size() << ";" << std::endl;
      outs << "void** bmconstaddrs[] = {" << std::endl;
      for (auto id: bmconstset)
        {
          char bufid[32];
          memset (bufid, 0, sizeof(bufid));
          idtocbuf32_BM(id, bufid);
          outs << "  &bmconst" << bufid << "," << std::endl;
        }
      outs << " (void**)0 };" << std::endl;
      outs << "const char* bmconstidstrings[] = {" << std::endl;
      for (auto id: bmconstset)
        {
          char bufid[32];
          memset (bufid, 0, sizeof(bufid));
          idtocbuf32_BM(id, bufid);
          outs << " \"" << bufid << "\"," << std::endl;
        }
      outs << " (const char*)0 };" << std::endl;
      outs << "//- eof generated constant file " << spath << std::endl;
      printf("processed %d lines in %d files with %d occurrences of %d constants\n",
             nblines, argc-3, totalnbkocc, (int) bmconstset.size());
    }
  else if (argc >= 2 && !strcmp(argv[1], "-S") && argc == 3)
    {
      if (!seek_header_in_cfile(argv[2]))
        exit(EXIT_FAILURE);
    }
  else
    {
      fprintf(stderr, "%s: expected usage:\n", argv[0]);
      goto show_usage;
    }
  return 0;
} // end main

/// eof BM_makeconst.cc