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: 34 $
   9 #  $Author: mhx $
  10 #  $Date: 2009/01/18 14:10:51 +0100 $
  11 #
  12 ################################################################################
  13 #
  14 #  Version 3.x, Copyright (C) 2004-2009, 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_PL_parser
 146 #define NEED_eval_pv
 147 #define NEED_grok_bin
 148 #define NEED_grok_hex
 149 #define NEED_grok_number
 150 #define NEED_grok_numeric_radix
 151 #define NEED_grok_oct
 152 #define NEED_load_module
 153 #define NEED_my_snprintf
 154 #define NEED_my_sprintf
 155 #define NEED_my_strlcat
 156 #define NEED_my_strlcpy
 157 #define NEED_newCONSTSUB
 158 #define NEED_newRV_noinc
 159 #define NEED_newSVpvn_share
 160 #define NEED_pv_display
 161 #define NEED_pv_escape
 162 #define NEED_pv_pretty
 163 #define NEED_sv_2pv_flags
 164 #define NEED_sv_2pvbyte
 165 #define NEED_sv_catpvf_mg
 166 #define NEED_sv_catpvf_mg_nocontext
 167 #define NEED_sv_pvn_force_flags
 168 #define NEED_sv_setpvf_mg
 169 #define NEED_sv_setpvf_mg_nocontext
 170 #define NEED_vload_module
 171 #define NEED_vnewSVpvf
 172 #define NEED_warner
 173 #define NEED_newSVpvn_flags
 174
 175 #include "ppport.h"
 176
 177 #endif
 178
 179 static int    VARarg1;
 180 static char  *VARarg2;
 181 static double VARarg3;
 182
 183 HEAD
 184
 185 if (@ARGV) {
 186   my %want = map { ($_ => 0) } @ARGV;
 187   @f = grep { exists $want{$_->{name}} } @f;
 188   for (@f) { $want{$_->{name}}++ }
 189   for (keys %want) {
 190     die "nothing found for '$_'\n" unless $want{$_};
 191   }
 192 }
 193
 194 my $f;
 195 for $f (@f) {
 196   $ignore{$f->{name}} and next;
 197   $f->{flags}{A} or next;  # only public API members
 198
 199   $ignore{$f->{name}} = 1; # ignore duplicates
 200
 201   my $Perl_ = $f->{flags}{p} ? 'Perl_' : '';
 202
 203   my $stack = '';
 204   my @arg;
 205   my $aTHX = '';
 206
 207   my $i = 1;
 208   my $ca;
 209   my $varargs = 0;
 210   for $ca (@{$f->{args}}) {
 211     my $a = $ca->[0];
 212     if ($a eq '...') {
 213       $varargs = 1;
 214       push @arg, qw(VARarg1 VARarg2 VARarg3);
 215       last;
 216     }
 217     my($n, $p, $d) = $a =~ /^ (\w+(?:\s+\w+)*)\s*  # type name  => $n
 218                               (\**)                # pointer    => $p
 219                               (?:\s*const\s*)?     # const
 220                               ((?:\[[^\]]*\])*)    # dimension  => $d
 221                             $/x
 222                      or die "$0 - cannot parse argument: [$a]\n";
 223     if (exists $amap{$n}) {
 224       push @arg, $amap{$n};
 225       next;
 226     }
 227     $n = $tmap{$n} || $n;
 228     if ($n eq 'const char' and $p eq '*' and !$f->{flags}{f}) {
 229       push @arg, '"foo"';
 230     }
 231     else {
 232       my $v = 'arg' . $i++;
 233       push @arg, $v;
 234       $stack .= "  static $n $p$v$d;\n";
 235     }
 236   }
 237
 238   unless ($f->{flags}{n} || $f->{flags}{'m'}) {
 239     $stack = "  dTHX;\n$stack";
 240     $aTHX = @arg ? 'aTHX_ ' : 'aTHX';
 241   }
 242
 243   if ($stack{$f->{name}}) {
 244     my $s = '';
 245     for (@{$stack{$f->{name}}}) {
 246       $s .= "  $_\n";
 247     }
 248     $stack = "$s$stack";
 249   }
 250
 251   my $args = join ', ', @arg;
 252   my $rvt = $f->{ret} || 'void';
 253   my $ret;
 254   if ($void{$rvt}) {
 255     $ret = $castvoid{$f->{name}} ? '(void) ' : '';
 256   }
 257   else {
 258     $stack .= "  $rvt rval;\n";
 259     $ret = $ignorerv{$f->{name}} ? '(void) ' : "rval = ";
 260   }
 261   my $aTHX_args = "$aTHX$args";
 262
 263   unless ($f->{flags}{'m'} and @arg == 0) {
 264     $args = "($args)";
 265     $aTHX_args = "($aTHX_args)";
 266   }
 267
 268   print OUT <<HEAD;
 269 /******************************************************************************
 270 *
 271 *  $f->{name}
 272 *
 273 ******************************************************************************/
 274
 275 HEAD
 276
 277   if ($todo{$f->{name}}) {
 278     my($ver,$sub) = $todo{$f->{name}} =~ /^5\.(\d{3})(\d{3})$/ or die;
 279     for ($ver, $sub) {
 280       s/^0+(\d)/$1/
 281     }
 282     if ($ver < 6 && $sub > 0) {
 283       $sub =~ s/0$// or die;
 284     }
 285     print OUT "#if PERL_VERSION > $ver || (PERL_VERSION == $ver && PERL_SUBVERSION >= $sub) /* TODO */\n";
 286   }
 287
 288   my $final = $varargs
 289               ? "$Perl_$f->{name}$aTHX_args"
 290               : "$f->{name}$args";
 291
 292   $f->{cond} and print OUT "#if $f->{cond}\n";
 293
 294   print OUT <<END;
 295 void _DPPP_test_$f->{name} (void)
 296 {
 297   dXSARGS;
 298 $stack
 299   {
 300 #ifdef $f->{name}
 301     $ret$f->{name}$args;
 302 #endif
 303   }
 304
 305   {
 306 #ifdef $f->{name}
 307     $ret$final;
 308 #else
 309     $ret$Perl_$f->{name}$aTHX_args;
 310 #endif
 311   }
 312 }
 313 END
 314
 315   $f->{cond} and print OUT "#endif\n";
 316   $todo{$f->{name}} and print OUT "#endif\n";
 317
 318   print OUT "\n";
 319 }
 320
 321 @ARGV and close OUT;
 322