tools
authorLaurent Mazet <laurent.mazet@thalesgroup.com>
Tue, 5 Dec 2023 12:55:08 +0000 (13:55 +0100)
committerLaurent Mazet <laurent.mazet@thalesgroup.com>
Tue, 5 Dec 2023 12:55:08 +0000 (13:55 +0100)
getcomments.pl [new file with mode: 0644]
makefile [new file with mode: 0644]

diff --git a/getcomments.pl b/getcomments.pl
new file mode 100644 (file)
index 0000000..47edf67
--- /dev/null
@@ -0,0 +1,85 @@
+#!/usr/bin/perl
+
+use strict;
+
+# default value
+my $format = "%";
+my $pattern = "";
+
+# help message
+sub usage() {
+
+  print <<EOF;
+usage: getcomments [-f string] [-h] [-p regex] file...
+ -f|--format string: format string for output printing [%]
+ -h|--help: help message
+ -p|--pattern regex: pattern matching on block []
+
+ Extract C/C++ block of comments
+
+Example: getcomments.pl -p='test:\\s' -f='./%' random.c
+EOF
+
+  exit 1;
+}
+
+usage() if ($#ARGV < 0);
+
+# process argument
+foreach my $arg (@ARGV) {
+  use vars qw/$caif $caip $naif $naip/;
+
+  # analyse format argument
+  ($caif, $_) = ($arg =~ /^(-f|--format)=(.*)/);
+  ($caif, $_) = (1, $arg) if ($naif);
+  next if ($naif = ($arg =~ /^(-f|--format)$/));
+  if ($caif) { $format = $_; next }
+
+  # check for help message
+  usage() if ($arg =~ /^(-h|--help)$/);
+
+  # analyse pattern argument
+  ($caip, $_) = ($arg =~ /^(-p|--pattern)=(.*)/);
+  ($caip, $_) = (1, $arg) if ($naip);
+  next if ($naip = ($arg =~ /^(-p|--pattern)$/));
+  if ($caip) { $pattern = $_; next }
+
+  # no more argument, only file
+  my $filename = $arg;
+
+  # open file
+  if (!open (IN, "<", $filename)) {
+    print "Can not open $filename\n";
+  }
+
+  # init table of comments
+  my @comments;
+  $#comments = -1;
+
+  # read all the file
+  while ($_ .= <IN>) {
+    my $cmt;
+
+    # process c++ comments
+    ($cmt, $_) = m{//\s*(.*?)\s*$()} if (m{//} && !m{/\*.*//});
+
+    # process standard c comments
+    ($cmt, $_) = m{^.*?/\*\s*(.*?)\s*\*/(.*)}s if (m{/\*.*\*/}s);
+
+    push(@comments, $cmt) if ($cmt);
+
+    # empty buffer if no comment is present
+    undef($_) if (!m{/[/*]});
+  }
+
+  # close file
+  close (IN);
+
+  # display comment blocks
+  foreach my $block (@comments) {
+    if (($block) = ($block =~ /$pattern(.*)/s)) {
+      ($_ = $format) =~ s/%/$block/gs;
+      print "$_\n";
+    }
+  }
+}
diff --git a/makefile b/makefile
new file mode 100644 (file)
index 0000000..1120900
--- /dev/null
+++ b/makefile
@@ -0,0 +1,141 @@
+# Default flags
+
+CC = gcc
+
+INCLUDES = -I../debug -D__MEMORY_ALLOCATION__ 
+OFLAGS  = -O4 -Os
+#OFLAGS  = -O4 -ffast-math -finline-functions
+#OFLAGS  = -O4 -finline-functions
+#OFLAGS += -mtune=pentium3 -mmmx -msse -msse2 -m3dnow
+#OFLAGS += -minline-all-stringops -fsingle-precision-constant
+#OFLAGS += -malign-double
+CFLAGS += -W -Wall -Wextra -g
+CFLAGS += -std=c99 -D_XOPEN_SOURCE=500
+CFLAGS += $(OFLAGS) $(INCLUDES) $(GCOVER)
+LDFLAGS += -g
+
+# Targets
+
+ALLEXE  =
+ALLEXE += indent
+
+SHELL = bash
+
+MAKE = mingw32-make
+MAKEFLAGS += -s
+
+# Functions
+
+TITLE = echo -en "\033[0;1m$(strip $(1))\033[0;0m:\t"
+PASS = echo -e "\033[1;32m$(strip $(1))\033[0;0m"
+WARN = echo -e "\033[1;33m$(strip $(1))\033[0;0m"
+FAIL = echo -e "\033[1;31m$(strip $(1))\033[0;0m"
+
+MKDIR = mkdir -p $(1) && chmod a+rx,go-w $(1)
+
+INSTALL = test -d `dirname $(2)` || $(call MKDIR, `dirname $(2)`) && cp -pa $(1) $(2) && chmod a+rX,go-w $(2)
+
+VALID = $(call TITLE, $(1)) && $(2) && $(call PASS, SUCCESS) || { $(call FAIL, FAILED); test; }
+
+## Generic rules
+
+all: depends
+       $(MAKE) $(ALLEXE:%=%.exe)
+
+count:
+       wc $(wildcard *.c *.h) $(MAKEFILE_LIST)
+
+clean:
+       $(call TITLE, "Cleaning")
+       touch clean
+       rm -f clean $(wildcard *.d *.ld *.log *.o *.test *~ .exec_*)
+       $(call PASS, SUCCESS)
+
+depends: $(patsubst %.c, %.d, $(wildcard *.c)) $(patsubst %, %.ld, $(ALLEXE))
+
+gcovs:
+       $(MAKE) $(addprefix gcov_,$(ALLEXE))
+
+purge: clean
+       $(call TITLE, "Purging")
+       touch purge
+       rm -f purge $(ALLEXE:%=%.exe)
+       $(call PASS, SUCCESS)
+
+valgrinds:
+       $(MAKE) $(addprefix valgrind_,$(ALLEXE))
+
+wipe: purge
+       $(call TITLE, "Wiping")
+       touch wipe
+       rm -f wipe $(wildcard *.gcda *.gcno)
+       $(call PASS, SUCCESS)
+
+tests: all
+       $(MAKE) $(addprefix test_,$(ALLEXE))
+
+## Main rules
+
+include $(wildcard *.d)
+include $(wildcard *.ld)
+
+gcov_%:
+       $(MAKE) purge
+       CFLAGS="-fprofile-arcs -ftest-coverage" LDFLAGS="-fprofile-arcs -ftest-coverage" $(MAKE)
+       $(MAKE) test_$(@:gcov_%=%)
+       gcov `sed -e 's/\.exe:/.c/;s/\.o/.c/g' $(@:gcov_%=%.ld)`
+       touch gcov
+       rm -f gcov $(wildcard *.gcda *.gcno)
+       $(MAKE) purge
+
+%.test: %.c
+       $(call TITLE, "Building $@")
+#      awk '/\/\* *test:.*\*\// { sub(/^.*\/\* *test: */, ""); sub(/ *\*\/.*$$/, ""); print }' $< > $@
+       ./getcomments.pl -p='test:\s' -f='%' $< > $@
+       $(call PASS, SUCCESS)
+
+test_%: %.test %.exe
+       IFS=$$'\n'; RC=0; \
+       for test in `cat $< | sed 's,${<:.test=.exe},./${<:.test=.exe},g'`; do \
+         echo "=== $$test ==="; \
+         eval $(VALGRIND) $$test; \
+         [ $$? -eq 0 ] && echo -e "\033[1;32mSUCCESS\033[0;0m" \
+                       || { echo -e "\033[1;31mFAILED\033[0;0m"; RC=1; }; \
+       done; \
+       test "$$RC" -ne 1 
+
+valgrind_%: %.exe
+       VALGRIND="valgrind -v --leak-check=full --show-reachable=yes --log-fd=2"; \
+       export VALGRIND; \
+       $(MAKE) $(@:valgrind_%=test_%)
+
+%.d: %.c
+       $(call TITLE, "Building $@")
+       $(CC) $(INCLUDES) -MM $< -o $@~
+       echo ${<:.c=.o}: $(shell ./getcomments.pl -p='depend:\s' -f='%' $<) >> $@~
+       mv $@~ $@
+       $(call PASS, SUCCESS)
+
+%.ld: %.c
+       $(call TITLE, "Building $@")
+       echo ${<:.c=.exe}: $(shell ./getcomments.pl -p='linker:\s' -f='%' $< | awk '{for (i=1;i<=NF;i++) if ($$(i) ~ /.o$$/) printf " %s", $$(i)}') > $@
+       $(call PASS, SUCCESS)
+
+%.o: %.c
+       $(call TITLE, "Building $@")
+       $(CC) $(CFLAGS) $(INCLUDES) $(shell ./getcomments.pl -p='cflags:\s' -f='%' $<) -c $< -o $@
+       $(call PASS, SUCCESS)
+
+
+%.exe: %.o %.d
+       $(call TITLE, "Building $@")
+       $(CC) $(LDFLAGS) $(shell ./getcomments.pl -p='linker:\s' -f='%' ${<:.o=.c}) $< -o $@
+       $(call PASS, SUCCESS)
+
+## Phony
+
+.PHONY: all clean count depends gcovs purge tests
+
+## Precious
+
+.PRECIOUS: %.d %.o