bin/bin/docstringer.pl

   1 #!/usr/bin/env perl
   2 # Simple script for substitute placeholders in Texinfo files with
   3 # docstring values found in source code.
   4 # Copyright (C) 2020 Sergey Matveev (stargrave@stargrave.org)
   5 #
   6 # If you C source code contains:
   7 #
   8 #     // TEXINFO: SomeKey
   9 #     // ...
  10 #     // last line of docstring
  11 #     some C code
  12 #
  13 # Then under "SomeKey" you will have the whole docstring (starting from
  14 # the line after "TEXINFO", till "last line"). You can include its
  15 # contents (excluding comment characters) in your .texi files placing
  16 #
  17 #     @DOCSTRING SomeKey@
  18
  19 use strict;
  20 use warnings;
  21
  22 my $verbose = 0;
  23 if ($ARGV[0] eq "-v") {
  24     $verbose = 1;
  25     shift @ARGV;
  26 };
  27 my @srcDirs = split / /, $ARGV[0];
  28 my $docDir = $ARGV[1];
  29 my $docBuildDir = $ARGV[2];
  30 my @exts = split / /, defined $ENV{EXTS} ? $ENV{EXTS} : "c h h.in";
  31
  32 my %docstrings;
  33
  34 foreach my $srcDir (@srcDirs) {
  35     print "src: $srcDir\n" if $verbose;
  36     opendir(my $dir, $srcDir) or die "can not open $srcDir";
  37     foreach my $fn (readdir $dir) {
  38         next unless grep { $fn =~ /\.$_$/ } @exts;
  39         open(my $src, "<:encoding(UTF-8)", "$srcDir/$fn") or
  40             die "can not open $srcDir/$fn";
  41         my $curEntry;
  42         while(<$src>) {
  43             chomp;
  44             if (not /^\/\//) {
  45                 if (defined $curEntry) {
  46                     undef $curEntry;
  47                 };
  48                 next;
  49             };
  50             s/^\/\/ ?//;
  51             if (/^TEXINFO: (.*)$/) {
  52                 $curEntry = $1;
  53                 $docstrings{$curEntry} = "";
  54                 print "\t$fn: $curEntry\n" if $verbose;
  55                 next;
  56             };
  57             ( $docstrings{$curEntry} .= "$_\n" ) if defined $curEntry;
  58         };
  59         close $src;
  60     };
  61     closedir $dir;
  62 };
  63
  64 print "doc: $docDir\n" if $verbose;
  65 opendir(my $dir, $docDir) or die "can not open $docDir";
  66 foreach my $fn (readdir $dir) {
  67     next unless $fn =~ /\.texi$/;
  68     open(my $src, "<:encoding(UTF-8)", "$docDir/$fn") or
  69         die "can not open $docDir/$fn";
  70     open(my $dst, ">:encoding(UTF-8)", "$docBuildDir/$fn") or
  71         die "can not open $docBuildDir/$fn";
  72     while(<$src>) {
  73         ( print($dst $_) and next ) unless /^\s*\@DOCSTRING (.*)\@$/;
  74         print "\t$fn: $1\n" if $verbose;
  75         die "unable to find docstring: $1" unless defined $docstrings{$1};
  76         print $dst $docstrings{$1};
  77     };
  78     close $src;
  79     close $dst;
  80 };
  81 closedir $dir;