icuSources/tools/genren/genren.pl

   1 #!/usr/bin/perl
   2 #*
   3 #*******************************************************************************
   4 #*   Copyright (C) 2001-2011, International Business Machines
   5 #*   Corporation and others.  All Rights Reserved.
   6 #*******************************************************************************
   7 #*
   8 #*   file name:  genren.pl
   9 #*   encoding:   US-ASCII
  10 #*   tab size:   8 (not used)
  11 #*   indentation:4
  12 #*
  13 #*   Created by: Vladimir Weinstein
  14 #*   07/19/2001
  15 #*
  16 #*  Used to generate renaming headers.
  17 #*  Run on UNIX platforms (linux) in order to catch all the exports
  18
  19 use POSIX qw(strftime);
  20
  21 $headername = 'urename.h';
  22
  23 $path = substr($0, 0, rindex($0, "/")+1)."../../common/unicode/uversion.h";
  24
  25 $nmopts = '-Cg -f s';
  26 $post = '';
  27
  28 $mode = 'POSIX';
  29
  30 (-e $path) || die "Cannot find uversion.h";
  31
  32 open(UVERSION, $path);
  33
  34 while(<UVERSION>) {
  35     if(/\#define U_ICU_VERSION_SUFFIX/) {
  36         chop;
  37         s/\#define U_ICU_VERSION_SUFFIX //;
  38         $U_ICU_VERSION_SUFFIX = "$_";
  39         last;
  40     }
  41 }
  42
  43 while($ARGV[0] =~ /^-/) { # detects whether there are any arguments
  44     $_ = shift @ARGV;      # extracts the argument for processing
  45     /^-v/ && ($VERBOSE++, next);                      # verbose
  46     /^-h/ && (&printHelpMsgAndExit, next);               # help
  47     /^-o/ && (($headername = shift (@ARGV)), next);   # output file
  48     /^-n/ && (($nmopts = shift (@ARGV)), next);   # nm opts
  49     /^-p/ && (($post = shift (@ARGV)), next);   # nm opts
  50     /^-x/ && (($mode = shift (@ARGV)), next);   # nm opts
  51     /^-S/ && (($U_ICU_VERSION_SUFFIX = shift(@ARGV)), next); # pick the suffix
  52     warn("Invalid option $_\n");
  53     &printHelpMsgAndExit;
  54 }
  55
  56 unless(@ARGV > 0) {
  57     warn "No libraries, exiting...\n";
  58     &printHelpMsgAndExit;
  59 }
  60
  61 #$headername = "uren".substr($ARGV[0], 6, index(".", $ARGV[0])-7).".h";
  62
  63 $HEADERDEF = uc($headername);  # this is building the constant for #define
  64 $HEADERDEF =~ s/\./_/;
  65
  66
  67     open HEADER, ">$headername"; # opening a header file
  68
  69 #We will print our copyright here + warnings
  70
  71 $YEAR = strftime "%Y",localtime;
  72
  73 print HEADER <<"EndOfHeaderComment";
  74 /*
  75 *******************************************************************************
  76 *   Copyright (C) 2002-$YEAR, International Business Machines
  77 *   Corporation and others.  All Rights Reserved.
  78 *******************************************************************************
  79 *
  80 *   file name:  $headername
  81 *   encoding:   US-ASCII
  82 *   tab size:   8 (not used)
  83 *   indentation:4
  84 *
  85 *   Created by: Perl script written by Vladimir Weinstein
  86 *
  87 *  Contains data for renaming ICU exports.
  88 *  Gets included by umachine.h
  89 *
  90 *  THIS FILE IS MACHINE-GENERATED, DON'T PLAY WITH IT IF YOU DON'T KNOW WHAT
  91 *  YOU ARE DOING, OTHERWISE VERY BAD THINGS WILL HAPPEN!
  92 */
  93
  94 #ifndef $HEADERDEF
  95 #define $HEADERDEF
  96
  97 /* Uncomment the following line to disable renaming on platforms
  98    that do not use Autoconf. */
  99 /* #define U_DISABLE_RENAMING 1 */
 100
 101 #if !U_DISABLE_RENAMING
 102
 103 /* We need the U_ICU_ENTRY_POINT_RENAME definition. There's a default one in unicode/uvernum.h we can use, but we will give
 104    the platform a chance to define it first.
 105    Normally (if utypes.h or umachine.h was included first) this will not be necessary as it will already be defined.
 106  */
 107 #ifndef U_ICU_ENTRY_POINT_RENAME
 108 #include "unicode/uconfig.h"
 109 #endif
 110
 111 #ifndef U_ICU_ENTRY_POINT_RENAME
 112 #include "unicode/umachine.h"
 113 #endif
 114
 115 /* If we still don't have U_ICU_ENTRY_POINT_RENAME use the default. */
 116 #ifndef U_ICU_ENTRY_POINT_RENAME
 117 #include "unicode/uvernum.h"
 118 #endif
 119
 120 /* Error out before the following defines cause very strange and unexpected code breakage */
 121 #ifndef U_ICU_ENTRY_POINT_RENAME
 122 #error U_ICU_ENTRY_POINT_RENAME is not defined - cannot continue. Consider defining U_DISABLE_RENAMING if renaming should not be used.
 123 #endif
 124
 125 EndOfHeaderComment
 126
 127 $fileCount = 0;
 128 $itemCount = 0;
 129 $symbolCount = 0;
 130
 131 for(;@ARGV; shift(@ARGV)) {
 132     $fileCount++;
 133     @NMRESULT = `nm $nmopts $ARGV[0] $post`;
 134     if($?) {
 135         warn "Couldn't do 'nm' for $ARGV[0], continuing...\n";
 136         next; # Couldn't do nm for the file
 137     }
 138     if($mode =~ /POSIX/) {
 139         splice @NMRESULT, 0, 6;
 140     } elsif ($mode =~ /Mach-O/) {
 141 #        splice @NMRESULT, 0, 10;
 142     }
 143     foreach (@NMRESULT) { # Process every line of result and stuff it in $_
 144         $itemCount++;
 145         if($mode =~ /POSIX/) {
 146             &verbose("  $_");
 147             ($_, $address, $type) = split(/\|/);
 148             chop $qtype;
 149         } elsif ($mode =~ /Mach-O/) {
 150             if(/^(?:[0-9a-fA-F]){8} ([A-Z]) (?:_)?(.*)$/) {
 151                 ($_, $type) = ($2, $1);
 152             } else {
 153                 next;
 154             }
 155         } else {
 156             die "Unknown mode $mode";
 157         }
 158         &verbose( "type: \"$type\" ");
 159         if(!($type =~ /[UAwW?]/)) {
 160             if(/@@/) { # These would be imports
 161                 &verbose( "Import: $_ \"$type\"\n");
 162                 &verbose( "C++ method: $_\n");
 163             } elsif (/^[^\(]*::/) { # C++ methods, stuff class name in associative array
 164                 ##  DON'T match    ...  (   foo::bar ...   want :: to be to the left of paren
 165                 ## icu::CharString::~CharString(void) -> CharString
 166                 @CppName = split(/::/); ## remove scope stuff
 167
 168                 if(@CppName>1) {
 169                     ## MessageFormat virtual table -> MessageFormat
 170                     if(! ($CppName[0] =~ /icu/ )) {
 171                         # *** WARNING Bad namespace (not 'icu') on ShoeSize::ShoeSize()
 172                         warn "*** WARNING Bad namespace (not 'icu') on $_\n";
 173                         next;
 174                     }
 175                     &verbose ( "(Chopping scope $CppName[0] )");
 176                     @CppName = split(/ /, $CppName[1]); ## remove debug stuff
 177                 }
 178                 ## ures_getUnicodeStringByIndex(UResourceBundle -> ures_getUnicodeStringByIndex
 179                 @CppName = split(/\(/, $CppName[0]); ## remove function args
 180                 if($CppName[0] =~ /^operator/) {
 181                     &verbose ("Skipping C++ function: $_\n");
 182                 } elsif($CppName[0] =~ /^~/) {
 183                     &verbose ("Skipping C++ destructor: $_\n");
 184                 } else {
 185                     &verbose( "Skipping C++ class: '$CppName[0]': $_ \n");
 186                     # $CppClasses{$CppName[0]}++;
 187                     # $symbolCount++;
 188                 }
 189             } elsif ( my ($cfn) = m/^([A-Za-z0-9_]*)\(.*/ ) {
 190                 &verbose ( "$ARGV[0]:  got global C++ function  $cfn with '$_'\n" );
 191                 $CFuncs{$cfn}++;
 192                 $symbolCount++;
 193             } elsif ( /\(/) { # These are strange functions
 194                 print STDERR "$ARGV[0]: Not sure what to do with '$_'\n";
 195             } elsif ( /^_init/ ) {
 196                 &verbose( "$ARGV[0]: Skipped initializer $_\n" );
 197             } elsif ( /^_fini/ ) {
 198                 &verbose( "$ARGV[0]: Skipped finilizer $_\n" );
 199             } elsif ( /icu_/) {
 200                 print STDERR "$ARGV[0]: Skipped strange mangled function $_\n";
 201             } elsif ( /^vtable for /) {
 202                 print STDERR "$ARGV[0]: Skipped vtable $_\n";
 203             } elsif ( /^typeinfo/) {
 204                 print STDERR "$ARGV[0]: Skipped typeinfo $_\n";
 205             } elsif ( /operator\+/ ) {
 206                 print STDERR "$ARGV[0]: Skipped ignored function $_\n";
 207             } else { # This is regular C function
 208                 &verbose( "C func: $_\n");
 209                 @funcname = split(/[\(\s+]/);
 210                 $CFuncs{$funcname[0]}++;
 211                 $symbolCount++;
 212             }
 213         } else {
 214             &verbose( "Skipped: $_ $1\n");
 215         }
 216     }
 217 }
 218
 219 if( $fileCount == 0 ) {
 220   die "Error: $itemCount lines from $fileCount files processed, but $symbolCount symbols were found.\n";
 221 }
 222
 223 if( $symbolCount == 0 ) {
 224   die "Error: $itemCount lines from $fileCount files processed, but $symbolCount symbols were found.\n";
 225 }
 226
 227 print " Loaded $symbolCount symbols from $itemCount lines in $fileCount files.\n";
 228
 229 print HEADER "\n/* C exports renaming data */\n\n";
 230 foreach(sort keys(%CFuncs)) {
 231     print HEADER "#define $_ U_ICU_ENTRY_POINT_RENAME($_)\n";
 232 #    print HEADER "#define $_ $_$U_ICU_VERSION_SUFFIX\n";
 233 }
 234
 235 print HEADER "\n#endif\n";
 236 print HEADER "\n#endif\n";
 237
 238 close HEADER;
 239
 240 sub verbose {
 241     if($VERBOSE) {
 242         print STDERR @_;
 243     }
 244 }
 245
 246
 247 sub printHelpMsgAndExit {
 248     print STDERR <<"EndHelpText";
 249 Usage: $0 [OPTIONS] LIBRARY_FILES
 250   Options:
 251     -v - verbose
 252     -h - help
 253     -o - output file name (defaults to 'urename.h'
 254     -S - suffix (defaults to _MAJOR_MINOR of current ICU version)
 255 Will produce a renaming .h file
 256
 257 EndHelpText
 258
 259     exit 0;
 260
 261 }