ext/Devel/PPPort/parts/apicheck.pl

   1 #!/usr/bin/perl -w
   2 ################################################################################
   3 #
   4 #  apicheck.pl -- generate C source for automated API check
   5 #
   6 ################################################################################
   7 #
   8 #  $Revision: 29 $
   9 #  $Author: mhx $
  10 #  $Date: 2008/01/04 12:02:22 +0100 $
  11 #
  12 ################################################################################
  13 #
  14 #  Version 3.x, Copyright (C) 2004-2008, Marcus Holland-Moritz.
  15 #  Version 2.x, Copyright (C) 2001, Paul Marquess.
  16 #  Version 1.x, Copyright (C) 1999, Kenneth Albanowski.
  17 #
  18 #  This program is free software; you can redistribute it and/or
  19 #  modify it under the same terms as Perl itself.
  20 #
  21 ################################################################################
  22
  23 use strict;
  24 require 'parts/ppptools.pl';
  25
  26 if (@ARGV) {
  27   my $file = pop @ARGV;
  28   open OUT, ">$file" or die "$file: $!\n";
  29 }
  30 else {
  31   *OUT = \*STDOUT;
  32 }
  33
  34 my @f = parse_embed(qw( parts/embed.fnc parts/apidoc.fnc parts/ppport.fnc ));
  35
  36 my %todo = %{&parse_todo};
  37
  38 my %tmap = (
  39   void => 'int',
  40 );
  41
  42 my %amap = (
  43   SP   => 'SP',
  44   type => 'int',
  45   cast => 'int',
  46 );
  47
  48 my %void = (
  49   void     => 1,
  50   Free_t   => 1,
  51   Signal_t => 1,
  52 );
  53
  54 my %castvoid = (
  55   map { ($_ => 1) } qw(
  56     Nullav
  57     Nullcv
  58     Nullhv
  59     Nullch
  60     Nullsv
  61     HEf_SVKEY
  62     SP
  63     MARK
  64     SVt_PV
  65     SVt_IV
  66     SVt_NV
  67     SVt_PVMG
  68     SVt_PVAV
  69     SVt_PVHV
  70     SVt_PVCV
  71     SvUOK
  72     G_SCALAR
  73     G_ARRAY
  74     G_VOID
  75     G_DISCARD
  76     G_EVAL
  77     G_NOARGS
  78     XS_VERSION
  79   ),
  80 );
  81
  82 my %ignorerv = (
  83   map { ($_ => 1) } qw(
  84     newCONSTSUB
  85   ),
  86 );
  87
  88 my %stack = (
  89   ORIGMARK       => ['dORIGMARK;'],
  90   POPpx          => ['STRLEN n_a;'],
  91   POPpbytex      => ['STRLEN n_a;'],
  92   PUSHp          => ['dTARG;'],
  93   PUSHn          => ['dTARG;'],
  94   PUSHi          => ['dTARG;'],
  95   PUSHu          => ['dTARG;'],
  96   XPUSHp         => ['dTARG;'],
  97   XPUSHn         => ['dTARG;'],
  98   XPUSHi         => ['dTARG;'],
  99   XPUSHu         => ['dTARG;'],
 100   UNDERBAR       => ['dUNDERBAR;'],
 101   XCPT_TRY_START => ['dXCPT;'],
 102   XCPT_TRY_END   => ['dXCPT;'],
 103   XCPT_CATCH     => ['dXCPT;'],
 104   XCPT_RETHROW   => ['dXCPT;'],
 105 );
 106
 107 my %ignore = (
 108   map { ($_ => 1) } qw(
 109     svtype
 110     items
 111     ix
 112     dXSI32
 113     XS
 114     CLASS
 115     THIS
 116     RETVAL
 117     StructCopy
 118   ),
 119 );
 120
 121 print OUT <<HEAD;
 122 /*
 123  * !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
 124  * This file is built by $0.
 125  * Any changes made here will be lost!
 126  */
 127
 128 #include "EXTERN.h"
 129 #include "perl.h"
 130
 131 #define NO_XSLOCKS
 132 #include "XSUB.h"
 133
 134 #ifdef DPPP_APICHECK_NO_PPPORT_H
 135
 136 /* This is just to avoid too many baseline failures with perls < 5.6.0 */
 137
 138 #ifndef dTHX
 139 #  define dTHX extern int Perl___notused
 140 #endif
 141
 142 #else
 143
 144 #define NEED_PL_signals
 145 #define NEED_eval_pv
 146 #define NEED_grok_bin
 147 #define NEED_grok_hex
 148 #define NEED_grok_number
 149 #define NEED_grok_numeric_radix
 150 #define NEED_grok_oct
 151 #define NEED_load_module
 152 #define NEED_my_snprintf
 153 #define NEED_my_strlcat
 154 #define NEED_my_strlcpy
 155 #define NEED_newCONSTSUB
 156 #define NEED_newRV_noinc
 157 #define NEED_newSVpvn_share
 158 #define NEED_sv_2pv_flags
 159 #define NEED_sv_2pvbyte
 160 #define NEED_sv_catpvf_mg
 161 #define NEED_sv_catpvf_mg_nocontext
 162 #define NEED_sv_pvn_force_flags
 163 #define NEED_sv_setpvf_mg
 164 #define NEED_sv_setpvf_mg_nocontext
 165 #define NEED_vload_module
 166 #define NEED_vnewSVpvf
 167 #define NEED_warner
 168 #define NEED_newSVpvn_flags
 169
 170 #include "ppport.h"
 171
 172 #endif
 173
 174 static int    VARarg1;
 175 static char  *VARarg2;
 176 static double VARarg3;
 177
 178 HEAD
 179
 180 if (@ARGV) {
 181   my %want = map { ($_ => 0) } @ARGV;
 182   @f = grep { exists $want{$_->{name}} } @f;
 183   for (@f) { $want{$_->{name}}++ }
 184   for (keys %want) {
 185     die "nothing found for '$_'\n" unless $want{$_};
 186   }
 187 }
 188
 189 my $f;
 190 for $f (@f) {
 191   $ignore{$f->{name}} and next;
 192   $f->{flags}{A} or next;  # only public API members
 193
 194   $ignore{$f->{name}} = 1; # ignore duplicates
 195
 196   my $Perl_ = $f->{flags}{p} ? 'Perl_' : '';
 197
 198   my $stack = '';
 199   my @arg;
 200   my $aTHX = '';
 201
 202   my $i = 1;
 203   my $ca;
 204   my $varargs = 0;
 205   for $ca (@{$f->{args}}) {
 206     my $a = $ca->[0];
 207     if ($a eq '...') {
 208       $varargs = 1;
 209       push @arg, qw(VARarg1 VARarg2 VARarg3);
 210       last;
 211     }
 212     my($n, $p, $d) = $a =~ /^ (\w+(?:\s+\w+)*)\s*  # type name  => $n
 213                               (\**)                # pointer    => $p
 214                               (?:\s*const\s*)?     # const
 215                               ((?:\[[^\]]*\])*)    # dimension  => $d
 216                             $/x
 217                      or die "$0 - cannot parse argument: [$a]\n";
 218     if (exists $amap{$n}) {
 219       push @arg, $amap{$n};
 220       next;
 221     }
 222     $n = $tmap{$n} || $n;
 223     if ($n eq 'const char' and $p eq '*' and !$f->{flags}{f}) {
 224       push @arg, '"foo"';
 225     }
 226     else {
 227       my $v = 'arg' . $i++;
 228       push @arg, $v;
 229       $stack .= "  static $n $p$v$d;\n";
 230     }
 231   }
 232
 233   unless ($f->{flags}{n} || $f->{flags}{'m'}) {
 234     $stack = "  dTHX;\n$stack";
 235     $aTHX = @arg ? 'aTHX_ ' : 'aTHX';
 236   }
 237
 238   if ($stack{$f->{name}}) {
 239     my $s = '';
 240     for (@{$stack{$f->{name}}}) {
 241       $s .= "  $_\n";
 242     }
 243     $stack = "$s$stack";
 244   }
 245
 246   my $args = join ', ', @arg;
 247   my $rvt = $f->{ret} || 'void';
 248   my $ret;
 249   if ($void{$rvt}) {
 250     $ret = $castvoid{$f->{name}} ? '(void) ' : '';
 251   }
 252   else {
 253     $stack .= "  $rvt rval;\n";
 254     $ret = $ignorerv{$f->{name}} ? '(void) ' : "rval = ";
 255   }
 256   my $aTHX_args = "$aTHX$args";
 257
 258   unless ($f->{flags}{'m'} and @arg == 0) {
 259     $args = "($args)";
 260     $aTHX_args = "($aTHX_args)";
 261   }
 262
 263   print OUT <<HEAD;
 264 /******************************************************************************
 265 *
 266 *  $f->{name}
 267 *
 268 ******************************************************************************/
 269
 270 HEAD
 271
 272   if ($todo{$f->{name}}) {
 273     my($ver,$sub) = $todo{$f->{name}} =~ /^5\.(\d{3})(\d{3})$/ or die;
 274     for ($ver, $sub) {
 275       s/^0+(\d)/$1/
 276     }
 277     if ($ver < 6 && $sub > 0) {
 278       $sub =~ s/0$// or die;
 279     }
 280     print OUT "#if PERL_VERSION > $ver || (PERL_VERSION == $ver && PERL_SUBVERSION >= $sub) /* TODO */\n";
 281   }
 282
 283   my $final = $varargs
 284               ? "$Perl_$f->{name}$aTHX_args"
 285               : "$f->{name}$args";
 286
 287   $f->{cond} and print OUT "#if $f->{cond}\n";
 288
 289   print OUT <<END;
 290 void _DPPP_test_$f->{name} (void)
 291 {
 292   dXSARGS;
 293 $stack
 294   {
 295 #ifdef $f->{name}
 296     $ret$f->{name}$args;
 297 #endif
 298   }
 299
 300   {
 301 #ifdef $f->{name}
 302     $ret$final;
 303 #else
 304     $ret$Perl_$f->{name}$aTHX_args;
 305 #endif
 306   }
 307 }
 308 END
 309
 310   $f->{cond} and print OUT "#endif\n";
 311   $todo{$f->{name}} and print OUT "#endif\n";
 312
 313   print OUT "\n";
 314 }
 315
 316 @ARGV and close OUT;
 317