summaryrefslogtreecommitdiff
path: root/doc/inslist.pl
diff options
context:
space:
mode:
authorCharles Crayne <chuck@thor.crayne.org>2008-01-20 16:27:03 -0800
committerCharles Crayne <chuck@thor.crayne.org>2008-01-20 16:27:03 -0800
commitc17a0eb31b109af863bc7fb5b9e80172d11d4c75 (patch)
tree15637d263dad4643a11cdcbb92e68c78258ce40a /doc/inslist.pl
parente6c01e659e21f10ad38ad18c304f3b3bbab2a9ff (diff)
downloadnasm-c17a0eb31b109af863bc7fb5b9e80172d11d4c75.tar.gz
Add autogenerated instruction list to NASM documentation
1. Allow included files in rdsrc.pl 2. New program inslist.pl to generate instruction list from insns.dat 3. Mark certain comments in insns.dat as documentation subheaders 4. Add Instruction List appendix to nasmdoc.src 5. Update build process to invoke inslist.pl
Diffstat (limited to 'doc/inslist.pl')
-rw-r--r--doc/inslist.pl66
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/inslist.pl b/doc/inslist.pl
new file mode 100644
index 00000000..8cab04bf
--- /dev/null
+++ b/doc/inslist.pl
@@ -0,0 +1,66 @@
+#!/usr/bin/perl
+#
+# inslist.pl produce inslist.src
+#
+# The Netwide Assembler is copyright (C) 1996 Simon Tatham and
+# Julian Hall. All rights reserved. The software is
+# redistributable under the licence given in the file "Licence"
+# distributed in the NASM archive.
+
+# Opcode prefixes which need their own opcode tables
+# LONGER PREFIXES FIRST!
+@disasm_prefixes = qw(0F24 0F25 0F38 0F3A 0F7A 0FA6 0FA7 0F);
+
+print STDERR "Reading insns.dat...\n";
+
+@args = ();
+undef $output;
+foreach $arg ( @ARGV ) {
+ if ( $arg =~ /^\-/ ) {
+ if ( $arg =~ /^\-([adins])$/ ) {
+ $output = $1;
+ } else {
+ die "$0: Unknown option: ${arg}\n";
+ }
+ } else {
+ push (@args, $arg);
+ }
+}
+
+$fname = "../insns.dat" unless $fname = $args[0];
+open (F, $fname) || die "unable to open $fname";
+print STDERR "Writing inslist.src...\n";
+open S, ">inslist.src";
+$line = 0;
+$insns = 0;
+while (<F>) {
+ $line++;
+ if ( /^\s*;/ ) # comments
+ {
+ if ( /^\s*;\#\s*(.+)/ ) # section subheader
+ {
+ print S "\n\\S{} $1\n\n";
+ }
+ next;
+ }
+ chomp;
+ my @entry = split;
+ next if $#entry == -1; # blank lines
+ (warn "line $line does not contain four fields\n"), next if $#entry != 3;
+
+ @entry[1] =~ s/ignore//;
+ @entry[1] =~ s/void//;
+ @entry[3] =~ s/ignore//;
+ @entry[3] =~ s/,SB//;
+ @entry[3] =~ s/,SM//;
+ @entry[3] =~ s/,SM2//;
+ @entry[3] =~ s/,SQ//;
+ @entry[3] =~ s/,AR2//;
+ printf S "\\c %-16s %-24s %s\n",@entry[0],@entry[1],@entry[3];
+ $insns++;
+}
+print S "\n";
+close S;
+close F;
+printf STDERR "Done: %d instructions\n", $insns;
+