doc: framework for documenting standard macro packages
[nasm/autotest.git] / macros.pl
blobcfddb6adb0de7e23d988d3f86942ae8e9b1c6700
1 #!/usr/bin/perl
3 # macros.pl produce macros.c from standard.mac
5 # The Netwide Assembler is copyright (C) 1996 Simon Tatham and
6 # Julian Hall. All rights reserved. The software is
7 # redistributable under the license given in the file "LICENSE"
8 # distributed in the NASM archive.
10 require 'phash.ph';
11 require 'pptok.ph';
13 my $fname;
14 my $line = 0;
15 my $index = 0;
16 my $tasm_count = 0;
19 # Generate macros.c
21 open(OUT,">macros.c") or die "unable to open macros.c\n";
23 print OUT "/*\n";
24 print OUT " * Do not edit - this file auto-generated by macros.pl from:\n";
25 print OUT " * ", join(' ', @ARGV), "\n";
26 print OUT " */\n";
27 print OUT "\n";
28 print OUT "#include \"tables.h\"\n";
29 print OUT "#include \"nasmlib.h\"\n";
30 print OUT "#include \"hashtbl.h\"\n";
31 print OUT "\n";
32 print OUT "const char * const nasm_stdmac[] = {";
34 my $npkg = 0;
35 my @pkg_list = ();
36 my %pkg_number = ();
37 my %pkg_index = ();
38 my $pkg;
40 foreach $fname ( @ARGV ) {
41 open(INPUT,$fname) or die "unable to open $fname\n";
42 print OUT "\n /* From $fname */\n";
43 while (<INPUT>) {
44 $line++;
45 chomp;
46 if (m/^\s*\*END\*TASM\*MACROS\*\s*$/) {
47 $tasm_count = $index;
48 print OUT " /* End of TASM macros */\n";
49 } elsif (m/^USE:\s*(\S+)\s*$/) {
50 $pkg = $1;
51 if (defined($pkg_number{$pkg})) {
52 die "$0: $fname: duplicate package: $pkg\n";
54 printf OUT " /* %4d */ NULL,\n", $index++;
55 print OUT " /* %use $pkg */\n";
56 push(@pkg_list, $pkg);
57 $pkg_number{$pkg} = $npkg++;
58 $pkg_index{$pkg} = $index;
59 } elsif (m/^\s*((\s*([^\"\';\s]+|\"[^\"]*\"|\'[^\']*\'))*)\s*(;.*)?$/) {
60 my $s1, $s2, $pd, $ws;
61 $s1 = $1;
62 $s1 =~ s/(\s)\s+/$1/g;
63 $s1 =~ s/\\/\\\\/g;
64 $s1 =~ s/"/\\"/g;
65 $s2 = '';
66 while ($s1 =~ /(\%[a-zA-Z_][a-zA-Z0-9_]*)((\s+)(.*)|)$/) {
67 $s2 .= "$'";
68 $pd = $1;
69 $ws = $3;
70 $s1 = $4;
71 if (defined($pptok_hash{$pd}) &&
72 $pptok_hash{$pd} <= 127) {
73 $s2 .= sprintf("\\x%02x\"\"", $pptok_hash{$pd}+128);
74 } else {
75 $s2 .= $pd.$ws;
78 $s2 .= $s1;
79 if (length($s2) > 0) {
80 printf OUT " /* %4d */ \"%s\",\n", $index++, $s2;
82 } else {
83 die "$fname:$line: error unterminated quote";
86 close(INPUT);
88 printf OUT " /* %4d */ NULL\n};\n\n", $index++;
89 print OUT "const char * const * const nasm_stdmac_after_tasm = ",
90 "&nasm_stdmac[$tasm_count];\n\n";
92 my @hashinfo = gen_perfect_hash(\%pkg_number);
93 if (!@hashinfo) {
94 die "$0: no hash found\n";
96 # Paranoia...
97 verify_hash_table(\%pkg_number, \@hashinfo);
98 my ($n, $sv, $g) = @hashinfo;
99 die if ($n & ($n-1));
101 print OUT "const char * const *nasm_stdmac_find_package(const char *package)\n";
102 print OUT "{\n";
103 print OUT " static const struct {\n";
104 print OUT " const char *package;\n";
105 print OUT " const char * const *macros;\n";
106 print OUT " } packages[$npkg] = {\n";
107 foreach $pkg (@pkg_list) {
108 printf OUT " { \"%s\", nasm_stdmac+%d },\n",
109 $pkg, $pkg_index{$pkg};
111 print OUT " };\n";
113 # Put a large value in unused slots. This makes it extremely unlikely
114 # that any combination that involves unused slot will pass the range test.
115 # This speeds up rejection of unrecognized tokens, i.e. identifiers.
116 print OUT "#define UNUSED 16383\n";
118 print OUT " static const int16_t hash1[$n] = {\n";
119 for ($i = 0; $i < $n; $i++) {
120 my $h = ${$g}[$i*2+0];
121 print OUT " ", defined($h) ? $h : 'UNUSED', ",\n";
123 print OUT " };\n";
125 print OUT " static const int16_t hash2[$n] = {\n";
126 for ($i = 0; $i < $n; $i++) {
127 my $h = ${$g}[$i*2+1];
128 print OUT " ", defined($h) ? $h : 'UNUSED', ",\n";
130 print OUT " };\n";
132 print OUT " uint32_t k1, k2;\n";
133 print OUT " uint64_t crc;\n";
134 # For correct overflow behavior, "ix" should be unsigned of the same
135 # width as the hash arrays.
136 print OUT " uint16_t ix;\n";
137 print OUT "\n";
139 printf OUT " crc = crc64i(UINT64_C(0x%08x%08x), package);\n",
140 $$sv[0], $$sv[1];
141 print OUT " k1 = (uint32_t)crc;\n";
142 print OUT " k2 = (uint32_t)(crc >> 32);\n";
143 print OUT "\n";
144 printf OUT " ix = hash1[k1 & 0x%x] + hash2[k2 & 0x%x];\n", $n-1, $n-1;
145 printf OUT " if (ix >= %d)\n", scalar(@pkg_list);
146 print OUT " return NULL;\n";
147 print OUT "\n";
148 print OUT " if (nasm_stricmp(packages[ix].package, package))\n";
149 print OUT " return NULL;\n";
150 print OUT "\n";
151 print OUT " return packages[ix].macros;\n";
152 print OUT "}\n";
154 close(OUT);