From 800161fd6dcb7648b671ae1aff584de1fae0f0fa Mon Sep 17 00:00:00 2001 From: Colby Russell <15d33c797bc3f191@x.colbyrussell.com> Date: Wed, 3 Apr 2024 13:24:54 -0500 Subject: [PATCH] Init with the basics --- ACKNOWLEDGEMENTS.txt | 58 + src/XXD.src | 299 +++++ tests/bs/256.bin | Bin 0 -> 256 bytes tests/bs/index.js | 66 + tests/bs/xxd-8.2.3995.c | 868 +++++++++++++ tests/harness.app.htm | 2628 +++++++++++++++++++++++++++++++++++++++ 6 files changed, 3919 insertions(+) create mode 100644 ACKNOWLEDGEMENTS.txt create mode 100644 src/XXD.src create mode 100644 tests/bs/256.bin create mode 100644 tests/bs/index.js create mode 100644 tests/bs/xxd-8.2.3995.c create mode 100644 tests/harness.app.htm diff --git a/ACKNOWLEDGEMENTS.txt b/ACKNOWLEDGEMENTS.txt new file mode 100644 index 0000000..742cb5f --- /dev/null +++ b/ACKNOWLEDGEMENTS.txt @@ -0,0 +1,58 @@ +The primary work is xxditb ("xxd in-the-browser"), version 0.0.1-pre +Available under MIT License, unless otherwise noted. + +NB: Any auxiliary development tools, including but not limited to those +distributed alongside the project source code and used to build the primary +work, are separate works used under license compatible with this use and are +not considered a part of the primary work. + +The primary work also incorporates elements from other works, which are +indentified below. + +(The preceding notes are informational, and reproducing them is not itself +intended to be a prerequisite for redistribution, although the inclusion of +some of the content below may be required in order to redistribute the primary +work in whole or in part.) + + +Authorship and contributions +============================ + +* Bram Moolenaar +* Colby Russell +* Juergen Weigert + + +Works involved +============== + +Original xxd implementation available under X11-MIT license. + +> (c) 1990-1998 by Juergen Weigert (jnweiger@gmail.com) +> Contributions by Bram Moolenaar et al. + + + + +Licenses compatible for use in the primary work +=============================================== + +X11-MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/src/XXD.src b/src/XXD.src new file mode 100644 index 0000000..9f650a3 --- /dev/null +++ b/src/XXD.src @@ -0,0 +1,299 @@ +/* + * A port of xxd as distributed with Vim 8.2 (on Ubuntu 22.04 LTS). + * + * That utility's source code is distributed with the following notice: + * + * (c) 1990-1998 by Juergen Weigert (jnweiger@gmail.com) + * + * I hereby grant permission to distribute and use xxd + * under X11-MIT or GPL-2.0 (at the user's choice). + * + * Contributions by Bram Moolenaar et al. + * + * Only the defaults are supported at this time. The argument processing + * logic is mostly absent. + * + * The choices made here (and there are few--we primarily aim for the source + * to correspond to the routines just as they appear in xxd-8.2.3995.c) are + * done with the main aim being to reconcile the impedance mismatch between + * the C implementation and the dialect used here for the programming + * environment we are targeting. Modifications have been made where necessary + * with the foremost goal being to get the code to work. It is not meant to + * be efficient nor to satisfy some other measure of good. This is bad code. + * + * This class doesn't actually output anything (or read anything, for that + * matter). It does its work with the `input` and `output` buffers. There is + * a `toString` implementation to reify the completed dump as a string. + */ + +export +class XXD { + exec() { + const _static = new XXD.Keeps; + + const { EOF } = XXD; + + const { HEX_NORMAL } = XXD; + const { HEX_POSTSCRIPT } = XXD; + const { HEX_CINCLUDE } = XXD; + const { HEX_BITS } = XXD; + const { HEX_LITTLEENDIAN } = XXD; + + const { COLS } = XXD; + const { LLEN } = XXD; + + const $ = ((c) => (c.charCodeAt(0))); + const $$ = ((s) => (Uint8Array.from(s, $))); + const $puts = ((...args) => (this._putOrDie(...args))); + const $exit = ((...args) => (this._exit(...args))); + + const hexx = $$("0123456789abcdef0123456789ABCDEF"); + + let fp = this.input; + let fpo = this.output; + + let c, e, p = 0; + + let relseek = 1; + let negseek = 0; + let revert = 0; + + let cols = 0; + let nonzero = 0; + let autoskip = 0; + let hextype = HEX_NORMAL; + + let capitalize, decimaloff = 0; + let ebcdic = 0; + let octspergrp = -1; + let grplen; + let length = -1, n = 0, seekoff = 0; + let displayoff = 0; + + let l = new Uint8Array(LLEN + 1); + + let pp; + let addrlen = 9; + + if (!cols) { + switch (hextype) { + case HEX_POSTSCRIPT: cols = 30; break; + case HEX_CINCLUDE: cols = 12; break; + case HEX_BITS: cols = 6; break; + case HEX_NORMAL: + case HEX_LITTLENDIAN: + default: cols = 16; break; + } + } + + if (octspergrp < 0) { + switch (hextype) { + case HEX_BITS: octspergrp = 1; break; + case HEX_NORMAL: octspergrp = 2; break; + case HEX_LITTLENDIAN: octspergrp = 4; break; + case HEX_POSTSCRIPT: + case HEX_CINCLUDE: + default: octspergrp = 0; break; + } + } + + if (cols < 1 || ((hextype == HEX_NORMAL || hextype == HEX_BITS || + hextype == HEX_LITTLEENDIAN) && (cols > COLS))) { + return void this._exit( + 1, null, pname + ": invalid number of columns (max. " + COLS + ")" + ); + } + + if (octspergrp < 1 || octspergrp > cols) { + octspergrp = cols; + } else if (hextype == HEX_LITTLEENDIAN) { + if (octspergrp & (octspergrp - 1)) { + return void this._exit( + 1, "number of octets per group must be a power of 2 with -e." + ); + } + } + + if (revert) { + if (hextype && hextype != HEX_POSTSCRIPT) { + return void this._exit(-1, "Sorry, cannot revert this type of hexdump"); + } + return void this._exit(XXD.UNIMPLEMENTED); // XXX + } + + if (seekoff || negseek || !relseek) { + if (relseek) { + e = _fseek(fp, (negseek) ? -seekoff : seekoff, SEEK_CUR); + } else { + e = _fseek(fp, (negseek) ? -seekoff : seekoff, + (negseek) ? SEEK_END : SEEK_SET); + } + + if (e < 0 && negseek) { + return void this._exit(4, "Sorry, cannot seek."); + } else if (e >= 0) { + seekoff = _ftell(fp); + } else { + let s = seekoff; + while (s--) { + let e = this._getOrDie(fp); + if (e == EOF) return void this._exit(4, "Sorry, cannot seek."); + } + } + } + + if (hextype == HEX_CINCLUDE) { + return void this._exit(XXD.UNIMPLEMENTED); // XXX + } else if (hextype == HEX_POSTSCRIPT) { + return void this._exit(XXD.UNIMPLEMENTED); // XXX + } + + if (hextype != HEX_BITS) { + grplen = octspergrp + octspergrp + 1; + } else { + grplen = 8 * octspergrp + 1; + } + + while (length < 0 || n < length) { + e = this._getOrDie(fp); + if (e == EOF) break; + + let x; + + if (p == 0) { + addrlen = _sprintf( + l, (decimaloff) ? "%08ld:" : "%08lx:", + n + seekoff + displayoff + ); + + for (c = addrlen; c < LLEN; l[c++] = $(' ')); + } + x = (hextype == HEX_LITTLEENDIAN) ? (p ^ (octspergrp - 1)) : p; + c = addrlen + 1 + ~~((grplen * x) / octspergrp); + if (hextype == HEX_NORMAL || hextype == HEX_LITTLEENDIAN) { + l[c+0] = hexx[(e >> 4) & 0x0F]; + l[++c] = hexx[(e >> 0) & 0x0F]; + } else { // HEX_BITS + for (let i = 7; i >= 0; --i) { + l[c++] = (e & (1 << i)) ? $('1') : $('0'); + } + } + + if (e) nonzero++; + + if (ebcdic) return void this._exit(XXD.UNIMPLEMENTED); // XXX + + c = addrlen + 3 + ~~((grplen * cols - 1) / octspergrp) + p; + + if (31 < e && e < 127) { + l[c++] = e; + } else { + l[c++] = $('.'); + } + + ++n; + + if (++p == cols) { + l[c+0] = $('\n'); + l[++c] = $('\0'); + _xxdline(fpo, l , (autoskip) ? nonzero : 1); + nonzero = 0; + p = 0; + } + } + + if (p) { + l[c+0] = $('\n'); + l[++c] = $('\0'); + _xxdline(fpo, l, 1); + } else if (autoskip) { + _xxdline(fpo, l, -1); + } + + function _xxdline(fp, l, nz, _ = _static) { + if (!nz && _.s == 1) { + _strcpy(_.z, l); + } + + if (nz || !_.s++) { + if (nz) { + if (nz < 0) _.s--; + if (_.s == 2) $puts(_.z, fp); + if (_.s > 2) $puts($$("*\n"), fp); + } + if (nz >= 0 || _.s > 0) $puts(l, fp); + if (nz) _.s = 0; + } + } + + function _strcpy(dest, src) { + let stop = src.indexOf(0); + if (stop >= 0) { + dest.set(new Uint8Array(src.buffer, 0, stop)); + } else { + return void $exit(XXD.IMPLEMENTATION_ERROR); // XXX + } + } + + function _sprintf(bytes, format, ...args) { + if (args.length == 1 && format == "%08lx:") { + let what = args[0].toString(16).padStart(8, "0") + ":"; + bytes.set($$(what)); + return what.length; + } + return void $exit(XXD.UNIMPLEMENTED); // XXX + } + } + + constructor(input, output = []) { + this.input = input; + this.output = output; + + this._place = 0; + } + + toString() { + return this.output.map((x) => (String.fromCharCode(x))).join(""); + } + + _getOrDie(fp) { + if (fp == this.input) { + if (this._place < this.input.length) { + return this.input[this._place++]; + } + return XXD.EOF; + } + return void this._exit(XXD.UNIMPLEMENTED); // XXX + } + + _putOrDie(bytes, fp) { + if (fp == this.output) { + for (let i = 0, n = bytes.length; i < n; ++i) { + if (bytes[i] == 0) return; + this.output.push(bytes[i]); + } + } + return void this._exit(XXD.UNIMPLEMENTED); // XXX + } +} + +XXD.Keeps = class { + constructor() { + this.s = 0; // was `zero_seen` in C + this.z = new Uint8Array(XXD.LLEN + 1); + } +} + +XXD.HEX_NORMAL = 0; +XXD.HEX_POSTSCRIPT = 1; +XXD.HEX_CINCLUDE = 2; +XXD.HEX_BITS = 3; +XXD.HEX_LITTLEENDIAN = 4; + +XXD.COLS = 256; +XXD.LLEN = 2573; // XXX (2 * 4) + 4 + (9 * COLS - 1) + COLS + 2 + +XXD.EOF = -1; + +XXD.UNIMPLEMENTED = 90; +XXD.IMPLEMENTATION_ERROR = 91; diff --git a/tests/bs/256.bin b/tests/bs/256.bin new file mode 100644 index 0000000000000000000000000000000000000000..c8aadcbd4adc27e65ad2fb0ac55957211ca335b6 GIT binary patch literal 256 zcmV+b0ssE}H+ooF000E$*0e?f03iVu0001VFXf};1RL-ET>v;3OLlD83QoA1v(KTk z1gj-@{GO%Fq6erUYZ0KJd*MYG#$d}F7^3|VL_ZK|eFB8ubV#3DLSdX5GDBFBI7-Ez z>da+bw>Q)Q*A_j>j&wk)kL+qZzo{{;?_~;NzlC6s0=TD{Z$M5OEV4i@8*ypu4_>s- zSjA-fL7Sisd)6`*l9`*AMq$J9eNNf?_n9#p_3=BGp5|)NlFdg*_XhpI@D42qtdpg4 zR9Rq$1ga+@R#ZkHYl6=nyUoU=Q0IhnPEkpZg^IV2tm7~a3`vT?8?t21GgYxbj=Div G>78!VCUzzO literal 0 HcmV?d00001 diff --git a/tests/bs/index.js b/tests/bs/index.js new file mode 100644 index 0000000..ae0bf4a --- /dev/null +++ b/tests/bs/index.js @@ -0,0 +1,66 @@ +import { test, read } from "$TEST_HELPER" + +import { XXD } from "$PROJECT/src/XXD.src"; + +const OWN_TEST_DIR = "$PROJECT/tests/bs/"; +const PLAINTEXT_INPUT_FILE = "xxd-8.2.3995.c"; +const BIN_FILE = "256.bin"; + +test(function handcrafted_byte_array() { + let bytes = Uint8Array.from([ + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, + 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, + 0xFF, 0xFE, 0xFD, 0xFC, 0xFB, 0xFA, 0xF9, 0xF8, + 0xF7, 0xF6, 0xF5, 0xF4, 0xF3, 0xF2, 0xF1, 0xF0 + ]); + let xxd = new XXD(bytes); + xxd.exec(); + let output = String(xxd); + test.is(output, + "00000000: 0001 0203 0405 0607 0809 0a0b 0c0d 0e0f ................" + + "\n00000010: fffe fdfc fbfa f9f8 f7f6 f5f4 f3f2 f1f0 ................" + + "\n" + ); +}) + +XXD.from = function(bytes) { + let doer = new XXD(bytes); + doer.exec(); + return doer; +} + +test(function two_lines() { + return read(OWN_TEST_DIR + PLAINTEXT_INPUT_FILE, true).then((bytes) => { + let output = String(XXD.from(bytes)); + test.ok(output.startsWith( + "00000000: 2f2a 2078 7864 3a20 6d79 2068 6578 6475 /* xxd: my hexdu" + + "\n00000010: 6d70 2066 6163 696c 6974 792e 206a 770a mp facility. jw." + + "\n" + )); + }); +}) + +test(function compressed_tarball_halfblock() { + return read(OWN_TEST_DIR + BIN_FILE, true).then((bytes) => { + let output = String(XXD.from(bytes)); + test.is(output, + "00000000: fd37 7a58 5a00 0004 e6d6 b446 0200 2101 .7zXZ......F..!." + + "\n00000010: 1600 0000 742f e5a3 e404 1bef fe5d 0038 ....t/.......].8" + + "\n00000020: 184b 766c d90a 4eb8 9ab3 cfa1 b304 ab25 .Kvl..N........%" + + "\n00000030: 78fc 9ea5 cda2 07a8 216b 11a0 a07b e145 x.......!k...{.E" + + "\n00000040: 18c6 60cb 1c18 a2fd 1144 3f10 697d 0284 ..`......D?.i}.." + + "\n00000050: de74 489f 5b42 619c 1a32 4358 9238 4ac5 .tH.[Ba..2CX.8J." + + "\n00000060: 9fea cc65 5db7 37d4 01d7 163d ca8e 7440 ...e].7....=..t@" + + "\n00000070: ab8f ec6a 3cbf a931 adef 650a 62bf 8560 ...j<..1..e.b..`" + + "\n00000080: 9002 b8a7 996f 404e 1a2c b240 2e1b 7169 .....o@N.,.@..qi" + + "\n00000090: ec0f 5eb4 cf58 c564 fb41 9ba0 0e7b d632 ..^..X.d.A...{.2" + + "\n000000a0: 1692 999b 9746 61c3 f27d 4ed9 fbf7 9931 .....Fa..}N....1" + + "\n000000b0: 1bf5 f13b 979e e66a d192 cd47 48f7 06fd ...;...j...GH..." + + "\n000000c0: c0f0 0e2d 08ac 93a5 7354 5960 8704 aa27 ...-....sTY`...'" + + "\n000000d0: 2256 5446 206b 82cf 1ebb cdc6 a450 e784 \"VTF k.......P.." + + "\n000000e0: 744e 5149 8f85 8ab7 8fac e330 0e0c 498a tNQI.......0..I." + + "\n000000f0: c11b b264 ce33 55b1 408e ba41 59e9 9d6e ...d.3U.@..AY..n" + + "\n" + ); + }); +}) diff --git a/tests/bs/xxd-8.2.3995.c b/tests/bs/xxd-8.2.3995.c new file mode 100644 index 0000000..c32b9b8 --- /dev/null +++ b/tests/bs/xxd-8.2.3995.c @@ -0,0 +1,868 @@ +/* xxd: my hexdump facility. jw + * + * 2.10.90 changed to word output + * 3.03.93 new indent style, dumb bug inserted and fixed. + * -c option, mls + * 26.04.94 better option parser, -ps, -l, -s added. + * 1.07.94 -r badly needs - as input file. Per default autoskip over + * consecutive lines of zeroes, as unix od does. + * -a shows them too. + * -i dump as c-style #include "file.h" + * 1.11.95 if "xxd -i" knows the filename, an 'unsigned char filename_bits[]' + * array is written in correct c-syntax. + * -s improved, now defaults to absolute seek, relative requires a '+'. + * -r improved, now -r -s -0x... is supported. + * change/suppress leading '\0' bytes. + * -l n improved: stops exactly after n bytes. + * -r improved, better handling of partial lines with trailing garbage. + * -r improved, now -r -p works again! + * -r improved, less flushing, much faster now! (that was silly) + * 3.04.96 Per repeated request of a single person: autoskip defaults to off. + * 15.05.96 -v added. They want to know the version. + * -a fixed, to show last line inf file ends in all zeros. + * -u added: Print upper case hex-letters, as preferred by unix bc. + * -h added to usage message. Usage message extended. + * Now using outfile if specified even in normal mode, aehem. + * No longer mixing of ints and longs. May help doze people. + * Added binify ioctl for same reason. (Enough Doze stress for 1996!) + * 16.05.96 -p improved, removed occasional superfluous linefeed. + * 20.05.96 -l 0 fixed. tried to read anyway. + * 21.05.96 -i fixed. now honours -u, and prepends __ to numeric filenames. + * compile -DWIN32 for NT or W95. George V. Reilly, * -v improved :-) + * support --gnuish-longhorn-options + * 25.05.96 MAC support added: CodeWarrior already uses ``outline'' in Types.h + * which is included by MacHeaders (Axel Kielhorn). Renamed to + * xxdline(). + * 7.06.96 -i printed 'int' instead of 'char'. *blush* + * added Bram's OS2 ifdefs... + * 18.07.96 gcc -Wall @ SunOS4 is now silent. + * Added osver for MSDOS/DJGPP/WIN32. + * 29.08.96 Added size_t to strncmp() for Amiga. + * 24.03.97 Windows NT support (Phil Hanna). Clean exit for Amiga WB (Bram) + * 02.04.97 Added -E option, to have EBCDIC translation instead of ASCII + * (azc10@yahoo.com) + * 22.05.97 added -g (group octets) option (jcook@namerica.kla.com). + * 23.09.98 nasty -p -r misfeature fixed: slightly wrong output, when -c was + * missing or wrong. + * 26.09.98 Fixed: 'xxd -i infile outfile' did not truncate outfile. + * 27.10.98 Fixed: -g option parser required blank. + * option -b added: 01000101 binary output in normal format. + * 16.05.00 Added VAXC changes by Stephen P. Wall + * 16.05.00 Improved MMS file and merge for VMS by Zoltan Arpadffy + * 2011 March Better error handling by Florian Zumbiehl. + * 2011 April Formatting by Bram Moolenaar + * 08.06.2013 Little-endian hexdump (-e) and offset (-o) by Vadim Vygonets. + * 11.01.2019 Add full 64/32 bit range to -o and output by Christer Jensen. + * 04.02.2020 Add -d for decimal offsets by Aapo Rantalainen + * + * (c) 1990-1998 by Juergen Weigert (jnweiger@gmail.com) + * + * I hereby grant permission to distribute and use xxd + * under X11-MIT or GPL-2.0 (at the user's choice). + * + * Contributions by Bram Moolenaar et al. + */ + +/* Visual Studio 2005 has 'deprecated' many of the standard CRT functions */ +#if _MSC_VER >= 1400 +# define _CRT_SECURE_NO_DEPRECATE +# define _CRT_NONSTDC_NO_DEPRECATE +#endif +#if !defined(CYGWIN) && defined(__CYGWIN__) +# define CYGWIN +#endif + +#if (defined(__linux__) && !defined(__ANDROID__)) || defined(__CYGWIN__) +# define _XOPEN_SOURCE 700 /* for fdopen() */ +#endif + +#include +#ifdef VAXC +# include +#else +# include +#endif +#if defined(WIN32) || defined(CYGWIN) +# include /* for setmode() */ +#else +# ifdef UNIX +# include +# endif +#endif +#include +#include /* for strncmp() */ +#include /* for isalnum() */ +#include +#if __MWERKS__ && !defined(BEBOX) +# include /* for fdopen() on MAC */ +#endif + + +/* This corrects the problem of missing prototypes for certain functions + * in some GNU installations (e.g. SunOS 4.1.x). + * Darren Hiebert (sparc-sun-sunos4.1.3_U1/2.7.2.2) + */ +#if defined(__GNUC__) && defined(__STDC__) +# ifndef __USE_FIXED_PROTOTYPES__ +# define __USE_FIXED_PROTOTYPES__ +# endif +#endif + +#ifndef __USE_FIXED_PROTOTYPES__ +/* + * This is historic and works only if the compiler really has no prototypes: + * + * Include prototypes for Sun OS 4.x, when using an ANSI compiler. + * FILE is defined on OS 4.x, not on 5.x (Solaris). + * if __SVR4 is defined (some Solaris versions), don't include this. + */ +#if defined(sun) && defined(FILE) && !defined(__SVR4) && defined(__STDC__) +# define __P(a) a +/* excerpt from my sun_stdlib.h */ +extern int fprintf __P((FILE *, char *, ...)); +extern int fputs __P((char *, FILE *)); +extern int _flsbuf __P((unsigned char, FILE *)); +extern int _filbuf __P((FILE *)); +extern int fflush __P((FILE *)); +extern int fclose __P((FILE *)); +extern int fseek __P((FILE *, long, int)); +extern int rewind __P((FILE *)); + +extern void perror __P((char *)); +# endif +#endif + +extern long int strtol(); +extern long int ftell(); + +char version[] = "xxd 2021-10-22 by Juergen Weigert et al."; +#ifdef WIN32 +char osver[] = " (Win32)"; +#else +char osver[] = ""; +#endif + +#if defined(WIN32) +# define BIN_READ(yes) ((yes) ? "rb" : "rt") +# define BIN_WRITE(yes) ((yes) ? "wb" : "wt") +# define BIN_CREAT(yes) ((yes) ? (O_CREAT|O_BINARY) : O_CREAT) +# define BIN_ASSIGN(fp, yes) setmode(fileno(fp), (yes) ? O_BINARY : O_TEXT) +# define PATH_SEP '\\' +#elif defined(CYGWIN) +# define BIN_READ(yes) ((yes) ? "rb" : "rt") +# define BIN_WRITE(yes) ((yes) ? "wb" : "w") +# define BIN_CREAT(yes) ((yes) ? (O_CREAT|O_BINARY) : O_CREAT) +# define BIN_ASSIGN(fp, yes) ((yes) ? (void) setmode(fileno(fp), O_BINARY) : (void) (fp)) +# define PATH_SEP '/' +#else +# ifdef VMS +# define BIN_READ(dummy) "r" +# define BIN_WRITE(dummy) "w" +# define BIN_CREAT(dummy) O_CREAT +# define BIN_ASSIGN(fp, dummy) fp +# define PATH_SEP ']' +# define FILE_SEP '.' +# else +# define BIN_READ(dummy) "r" +# define BIN_WRITE(dummy) "w" +# define BIN_CREAT(dummy) O_CREAT +# define BIN_ASSIGN(fp, dummy) fp +# define PATH_SEP '/' +# endif +#endif + +/* open has only to arguments on the Mac */ +#if __MWERKS__ +# define OPEN(name, mode, umask) open(name, mode) +#else +# define OPEN(name, mode, umask) open(name, mode, umask) +#endif + +#ifdef AMIGA +# define STRNCMP(s1, s2, l) strncmp(s1, s2, (size_t)l) +#else +# define STRNCMP(s1, s2, l) strncmp(s1, s2, l) +#endif + +#ifndef __P +# if defined(__STDC__) || defined(WIN32) +# define __P(a) a +# else +# define __P(a) () +# endif +#endif + +#define TRY_SEEK /* attempt to use lseek, or skip forward by reading */ +#define COLS 256 /* change here, if you ever need more columns */ +#define LLEN ((2*(int)sizeof(unsigned long)) + 4 + (9*COLS-1) + COLS + 2) + +char hexxa[] = "0123456789abcdef0123456789ABCDEF", *hexx = hexxa; + +/* the different hextypes known by this program: */ +#define HEX_NORMAL 0 +#define HEX_POSTSCRIPT 1 +#define HEX_CINCLUDE 2 +#define HEX_BITS 3 /* not hex a dump, but bits: 01111001 */ +#define HEX_LITTLEENDIAN 4 + +#define CONDITIONAL_CAPITALIZE(c) (capitalize ? toupper((int)c) : c) + +static char *pname; + + static void +exit_with_usage(void) +{ + fprintf(stderr, "Usage:\n %s [options] [infile [outfile]]\n", pname); + fprintf(stderr, " or\n %s -r [-s [-]offset] [-c cols] [-ps] [infile [outfile]]\n", pname); + fprintf(stderr, "Options:\n"); + fprintf(stderr, " -a toggle autoskip: A single '*' replaces nul-lines. Default off.\n"); + fprintf(stderr, " -b binary digit dump (incompatible with -ps,-i,-r). Default hex.\n"); + fprintf(stderr, " -C capitalize variable names in C include file style (-i).\n"); + fprintf(stderr, " -c cols format octets per line. Default 16 (-i: 12, -ps: 30).\n"); + fprintf(stderr, " -E show characters in EBCDIC. Default ASCII.\n"); + fprintf(stderr, " -e little-endian dump (incompatible with -ps,-i,-r).\n"); + fprintf(stderr, " -g bytes number of octets per group in normal output. Default 2 (-e: 4).\n"); + fprintf(stderr, " -h print this summary.\n"); + fprintf(stderr, " -i output in C include file style.\n"); + fprintf(stderr, " -l len stop after octets.\n"); + fprintf(stderr, " -o off add to the displayed file position.\n"); + fprintf(stderr, " -ps output in postscript plain hexdump style.\n"); + fprintf(stderr, " -r reverse operation: convert (or patch) hexdump into binary.\n"); + fprintf(stderr, " -r -s off revert with added to file positions found in hexdump.\n"); + fprintf(stderr, " -d show offset in decimal instead of hex.\n"); + fprintf(stderr, " -s %sseek start at bytes abs. %sinfile offset.\n", +#ifdef TRY_SEEK + "[+][-]", "(or +: rel.) "); +#else + "", ""); +#endif + fprintf(stderr, " -u use upper case hex letters.\n"); + fprintf(stderr, " -v show version: \"%s%s\".\n", version, osver); + exit(1); +} + + static void +perror_exit(int ret) +{ + fprintf(stderr, "%s: ", pname); + perror(NULL); + exit(ret); +} + + static void +error_exit(int ret, char *msg) +{ + fprintf(stderr, "%s: %s\n", pname, msg); + exit(ret); +} + + static int +getc_or_die(FILE *fpi) +{ + int c = getc(fpi); + if (c == EOF && ferror(fpi)) + perror_exit(2); + return c; +} + + static void +putc_or_die(int c, FILE *fpo) +{ + if (putc(c, fpo) == EOF) + perror_exit(3); +} + + static void +fputs_or_die(char *s, FILE *fpo) +{ + if (fputs(s, fpo) == EOF) + perror_exit(3); +} + +/* Use a macro to allow for different arguments. */ +#define FPRINTF_OR_DIE(args) if (fprintf args < 0) perror_exit(3) + + static void +fclose_or_die(FILE *fpi, FILE *fpo) +{ + if (fclose(fpo) != 0) + perror_exit(3); + if (fclose(fpi) != 0) + perror_exit(2); +} + +/* + * If "c" is a hex digit, return the value. + * Otherwise return -1. + */ + static int +parse_hex_digit(int c) +{ + return (c >= '0' && c <= '9') ? c - '0' + : (c >= 'a' && c <= 'f') ? c - 'a' + 10 + : (c >= 'A' && c <= 'F') ? c - 'A' + 10 + : -1; +} + +/* + * Ignore text on "fpi" until end-of-line or end-of-file. + * Return the '\n' or EOF character. + * When an error is encountered exit with an error message. + */ + static int +skip_to_eol(FILE *fpi, int c) +{ + while (c != '\n' && c != EOF) + c = getc_or_die(fpi); + return c; +} + +/* + * Max. cols binary characters are decoded from the input stream per line. + * Two adjacent garbage characters after evaluated data delimit valid data. + * Everything up to the next newline is discarded. + * + * The name is historic and came from 'undo type opt h'. + */ + static int +huntype( + FILE *fpi, + FILE *fpo, + int cols, + int hextype, + long base_off) +{ + int c, ign_garb = 1, n1 = -1, n2 = 0, n3, p = cols; + long have_off = 0, want_off = 0; + + rewind(fpi); + + while ((c = getc(fpi)) != EOF) + { + if (c == '\r') /* Doze style input file? */ + continue; + + /* Allow multiple spaces. This doesn't work when there is normal text + * after the hex codes in the last line that looks like hex, thus only + * use it for PostScript format. */ + if (hextype == HEX_POSTSCRIPT && (c == ' ' || c == '\n' || c == '\t')) + continue; + + n3 = n2; + n2 = n1; + + n1 = parse_hex_digit(c); + if (n1 == -1 && ign_garb) + continue; + + ign_garb = 0; + + if (!hextype && (p >= cols)) + { + if (n1 < 0) + { + p = 0; + continue; + } + want_off = (want_off << 4) | n1; + continue; + } + + if (base_off + want_off != have_off) + { + if (fflush(fpo) != 0) + perror_exit(3); +#ifdef TRY_SEEK + if (fseek(fpo, base_off + want_off - have_off, SEEK_CUR) >= 0) + have_off = base_off + want_off; +#endif + if (base_off + want_off < have_off) + error_exit(5, "Sorry, cannot seek backwards."); + for (; have_off < base_off + want_off; have_off++) + putc_or_die(0, fpo); + } + + if (n2 >= 0 && n1 >= 0) + { + putc_or_die((n2 << 4) | n1, fpo); + have_off++; + want_off++; + n1 = -1; + if (!hextype && (++p >= cols)) + /* skip the rest of the line as garbage */ + c = skip_to_eol(fpi, c); + } + else if (n1 < 0 && n2 < 0 && n3 < 0) + /* already stumbled into garbage, skip line, wait and see */ + c = skip_to_eol(fpi, c); + + if (c == '\n') + { + if (!hextype) + want_off = 0; + p = cols; + ign_garb = 1; + } + } + if (fflush(fpo) != 0) + perror_exit(3); +#ifdef TRY_SEEK + fseek(fpo, 0L, SEEK_END); +#endif + fclose_or_die(fpi, fpo); + return 0; +} + +/* + * Print line l. If nz is false, xxdline regards the line a line of + * zeroes. If there are three or more consecutive lines of zeroes, + * they are replaced by a single '*' character. + * + * If the output ends with more than two lines of zeroes, you + * should call xxdline again with l being the last line and nz + * negative. This ensures that the last line is shown even when + * it is all zeroes. + * + * If nz is always positive, lines are never suppressed. + */ + static void +xxdline(FILE *fp, char *l, int nz) +{ + static char z[LLEN+1]; + static int zero_seen = 0; + + if (!nz && zero_seen == 1) + strcpy(z, l); + + if (nz || !zero_seen++) + { + if (nz) + { + if (nz < 0) + zero_seen--; + if (zero_seen == 2) + fputs_or_die(z, fp); + if (zero_seen > 2) + fputs_or_die("*\n", fp); + } + if (nz >= 0 || zero_seen > 0) + fputs_or_die(l, fp); + if (nz) + zero_seen = 0; + } +} + +/* This is an EBCDIC to ASCII conversion table */ +/* from a proposed BTL standard April 16, 1979 */ +static unsigned char etoa64[] = +{ + 0040,0240,0241,0242,0243,0244,0245,0246, + 0247,0250,0325,0056,0074,0050,0053,0174, + 0046,0251,0252,0253,0254,0255,0256,0257, + 0260,0261,0041,0044,0052,0051,0073,0176, + 0055,0057,0262,0263,0264,0265,0266,0267, + 0270,0271,0313,0054,0045,0137,0076,0077, + 0272,0273,0274,0275,0276,0277,0300,0301, + 0302,0140,0072,0043,0100,0047,0075,0042, + 0303,0141,0142,0143,0144,0145,0146,0147, + 0150,0151,0304,0305,0306,0307,0310,0311, + 0312,0152,0153,0154,0155,0156,0157,0160, + 0161,0162,0136,0314,0315,0316,0317,0320, + 0321,0345,0163,0164,0165,0166,0167,0170, + 0171,0172,0322,0323,0324,0133,0326,0327, + 0330,0331,0332,0333,0334,0335,0336,0337, + 0340,0341,0342,0343,0344,0135,0346,0347, + 0173,0101,0102,0103,0104,0105,0106,0107, + 0110,0111,0350,0351,0352,0353,0354,0355, + 0175,0112,0113,0114,0115,0116,0117,0120, + 0121,0122,0356,0357,0360,0361,0362,0363, + 0134,0237,0123,0124,0125,0126,0127,0130, + 0131,0132,0364,0365,0366,0367,0370,0371, + 0060,0061,0062,0063,0064,0065,0066,0067, + 0070,0071,0372,0373,0374,0375,0376,0377 +}; + + int +main(int argc, char *argv[]) +{ + FILE *fp, *fpo; + int c, e, p = 0, relseek = 1, negseek = 0, revert = 0; + int cols = 0, nonzero = 0, autoskip = 0, hextype = HEX_NORMAL; + int capitalize = 0, decimal_offset = 0; + int ebcdic = 0; + int octspergrp = -1; /* number of octets grouped in output */ + int grplen; /* total chars per octet group */ + long length = -1, n = 0, seekoff = 0; + unsigned long displayoff = 0; + static char l[LLEN+1]; /* static because it may be too big for stack */ + char *pp; + int addrlen = 9; + +#ifdef AMIGA + /* This program doesn't work when started from the Workbench */ + if (argc == 0) + exit(1); +#endif + + pname = argv[0]; + for (pp = pname; *pp; ) + if (*pp++ == PATH_SEP) + pname = pp; +#ifdef FILE_SEP + for (pp = pname; *pp; pp++) + if (*pp == FILE_SEP) + { + *pp = '\0'; + break; + } +#endif + + while (argc >= 2) + { + pp = argv[1] + (!STRNCMP(argv[1], "--", 2) && argv[1][2]); + if (!STRNCMP(pp, "-a", 2)) autoskip = 1 - autoskip; + else if (!STRNCMP(pp, "-b", 2)) hextype = HEX_BITS; + else if (!STRNCMP(pp, "-e", 2)) hextype = HEX_LITTLEENDIAN; + else if (!STRNCMP(pp, "-u", 2)) hexx = hexxa + 16; + else if (!STRNCMP(pp, "-p", 2)) hextype = HEX_POSTSCRIPT; + else if (!STRNCMP(pp, "-i", 2)) hextype = HEX_CINCLUDE; + else if (!STRNCMP(pp, "-C", 2)) capitalize = 1; + else if (!STRNCMP(pp, "-d", 2)) decimal_offset = 1; + else if (!STRNCMP(pp, "-r", 2)) revert++; + else if (!STRNCMP(pp, "-E", 2)) ebcdic++; + else if (!STRNCMP(pp, "-v", 2)) + { + fprintf(stderr, "%s%s\n", version, osver); + exit(0); + } + else if (!STRNCMP(pp, "-c", 2)) + { + if (pp[2] && !STRNCMP("apitalize", pp + 2, 9)) + capitalize = 1; + else if (pp[2] && STRNCMP("ols", pp + 2, 3)) + cols = (int)strtol(pp + 2, NULL, 0); + else + { + if (!argv[2]) + exit_with_usage(); + cols = (int)strtol(argv[2], NULL, 0); + argv++; + argc--; + } + } + else if (!STRNCMP(pp, "-g", 2)) + { + if (pp[2] && STRNCMP("roup", pp + 2, 4)) + octspergrp = (int)strtol(pp + 2, NULL, 0); + else + { + if (!argv[2]) + exit_with_usage(); + octspergrp = (int)strtol(argv[2], NULL, 0); + argv++; + argc--; + } + } + else if (!STRNCMP(pp, "-o", 2)) + { + int reloffset = 0; + int negoffset = 0; + if (pp[2] && STRNCMP("ffset", pp + 2, 5)) + displayoff = strtoul(pp + 2, NULL, 0); + else + { + if (!argv[2]) + exit_with_usage(); + + if (argv[2][0] == '+') + reloffset++; + if (argv[2][reloffset] == '-') + negoffset++; + + if (negoffset) + displayoff = ULONG_MAX - strtoul(argv[2] + reloffset+negoffset, NULL, 0) + 1; + else + displayoff = strtoul(argv[2] + reloffset+negoffset, NULL, 0); + + argv++; + argc--; + } + } + else if (!STRNCMP(pp, "-s", 2)) + { + relseek = 0; + negseek = 0; + if (pp[2] && STRNCMP("kip", pp+2, 3) && STRNCMP("eek", pp+2, 3)) + { +#ifdef TRY_SEEK + if (pp[2] == '+') + relseek++; + if (pp[2+relseek] == '-') + negseek++; +#endif + seekoff = strtol(pp + 2+relseek+negseek, (char **)NULL, 0); + } + else + { + if (!argv[2]) + exit_with_usage(); +#ifdef TRY_SEEK + if (argv[2][0] == '+') + relseek++; + if (argv[2][relseek] == '-') + negseek++; +#endif + seekoff = strtol(argv[2] + relseek+negseek, (char **)NULL, 0); + argv++; + argc--; + } + } + else if (!STRNCMP(pp, "-l", 2)) + { + if (pp[2] && STRNCMP("en", pp + 2, 2)) + length = strtol(pp + 2, (char **)NULL, 0); + else + { + if (!argv[2]) + exit_with_usage(); + length = strtol(argv[2], (char **)NULL, 0); + argv++; + argc--; + } + } + else if (!strcmp(pp, "--")) /* end of options */ + { + argv++; + argc--; + break; + } + else if (pp[0] == '-' && pp[1]) /* unknown option */ + exit_with_usage(); + else + break; /* not an option */ + + argv++; /* advance to next argument */ + argc--; + } + + if (!cols) + switch (hextype) + { + case HEX_POSTSCRIPT: cols = 30; break; + case HEX_CINCLUDE: cols = 12; break; + case HEX_BITS: cols = 6; break; + case HEX_NORMAL: + case HEX_LITTLEENDIAN: + default: cols = 16; break; + } + + if (octspergrp < 0) + switch (hextype) + { + case HEX_BITS: octspergrp = 1; break; + case HEX_NORMAL: octspergrp = 2; break; + case HEX_LITTLEENDIAN: octspergrp = 4; break; + case HEX_POSTSCRIPT: + case HEX_CINCLUDE: + default: octspergrp = 0; break; + } + + if (cols < 1 || ((hextype == HEX_NORMAL || hextype == HEX_BITS || hextype == HEX_LITTLEENDIAN) + && (cols > COLS))) + { + fprintf(stderr, "%s: invalid number of columns (max. %d).\n", pname, COLS); + exit(1); + } + + if (octspergrp < 1 || octspergrp > cols) + octspergrp = cols; + else if (hextype == HEX_LITTLEENDIAN && (octspergrp & (octspergrp-1))) + error_exit(1, "number of octets per group must be a power of 2 with -e."); + + if (argc > 3) + exit_with_usage(); + + if (argc == 1 || (argv[1][0] == '-' && !argv[1][1])) + BIN_ASSIGN(fp = stdin, !revert); + else + { + if ((fp = fopen(argv[1], BIN_READ(!revert))) == NULL) + { + fprintf(stderr,"%s: ", pname); + perror(argv[1]); + return 2; + } + } + + if (argc < 3 || (argv[2][0] == '-' && !argv[2][1])) + BIN_ASSIGN(fpo = stdout, revert); + else + { + int fd; + int mode = revert ? O_WRONLY : (O_TRUNC|O_WRONLY); + + if (((fd = OPEN(argv[2], mode | BIN_CREAT(revert), 0666)) < 0) || + (fpo = fdopen(fd, BIN_WRITE(revert))) == NULL) + { + fprintf(stderr, "%s: ", pname); + perror(argv[2]); + return 3; + } + rewind(fpo); + } + + if (revert) + { + if (hextype && (hextype != HEX_POSTSCRIPT)) + error_exit(-1, "Sorry, cannot revert this type of hexdump"); + return huntype(fp, fpo, cols, hextype, + negseek ? -seekoff : seekoff); + } + + if (seekoff || negseek || !relseek) + { +#ifdef TRY_SEEK + if (relseek) + e = fseek(fp, negseek ? -seekoff : seekoff, SEEK_CUR); + else + e = fseek(fp, negseek ? -seekoff : seekoff, + negseek ? SEEK_END : SEEK_SET); + if (e < 0 && negseek) + error_exit(4, "Sorry, cannot seek."); + if (e >= 0) + seekoff = ftell(fp); + else +#endif + { + long s = seekoff; + + while (s--) + if (getc_or_die(fp) == EOF) + { + error_exit(4, "Sorry, cannot seek."); + } + } + } + + if (hextype == HEX_CINCLUDE) + { + if (fp != stdin) + { + FPRINTF_OR_DIE((fpo, "unsigned char %s", isdigit((int)argv[1][0]) ? "__" : "")); + for (e = 0; (c = argv[1][e]) != 0; e++) + putc_or_die(isalnum(c) ? CONDITIONAL_CAPITALIZE(c) : '_', fpo); + fputs_or_die("[] = {\n", fpo); + } + + p = 0; + c = 0; + while ((length < 0 || p < length) && (c = getc_or_die(fp)) != EOF) + { + FPRINTF_OR_DIE((fpo, (hexx == hexxa) ? "%s0x%02x" : "%s0X%02X", + (p % cols) ? ", " : (!p ? " " : ",\n "), c)); + p++; + } + + if (p) + fputs_or_die("\n", fpo); + + if (fp != stdin) + { + fputs_or_die("};\n", fpo); + FPRINTF_OR_DIE((fpo, "unsigned int %s", isdigit((int)argv[1][0]) ? "__" : "")); + for (e = 0; (c = argv[1][e]) != 0; e++) + putc_or_die(isalnum(c) ? CONDITIONAL_CAPITALIZE(c) : '_', fpo); + FPRINTF_OR_DIE((fpo, "_%s = %d;\n", capitalize ? "LEN" : "len", p)); + } + + fclose_or_die(fp, fpo); + return 0; + } + + if (hextype == HEX_POSTSCRIPT) + { + p = cols; + while ((length < 0 || n < length) && (e = getc_or_die(fp)) != EOF) + { + putc_or_die(hexx[(e >> 4) & 0xf], fpo); + putc_or_die(hexx[e & 0xf], fpo); + n++; + if (!--p) + { + putc_or_die('\n', fpo); + p = cols; + } + } + if (p < cols) + putc_or_die('\n', fpo); + fclose_or_die(fp, fpo); + return 0; + } + + /* hextype: HEX_NORMAL or HEX_BITS or HEX_LITTLEENDIAN */ + + if (hextype != HEX_BITS) + grplen = octspergrp + octspergrp + 1; /* chars per octet group */ + else /* hextype == HEX_BITS */ + grplen = 8 * octspergrp + 1; + + while ((length < 0 || n < length) && (e = getc_or_die(fp)) != EOF) + { + int x; + + if (p == 0) + { + addrlen = sprintf(l, decimal_offset ? "%08ld:" : "%08lx:", + ((unsigned long)(n + seekoff + displayoff))); + for (c = addrlen; c < LLEN; l[c++] = ' '); + } + x = hextype == HEX_LITTLEENDIAN ? p ^ (octspergrp-1) : p; + c = addrlen + 1 + (grplen * x) / octspergrp; + if (hextype == HEX_NORMAL || hextype == HEX_LITTLEENDIAN) + { + l[c] = hexx[(e >> 4) & 0xf]; + l[++c] = hexx[e & 0xf]; + } + else /* hextype == HEX_BITS */ + { + int i; + for (i = 7; i >= 0; i--) + l[c++] = (e & (1 << i)) ? '1' : '0'; + } + if (e) + nonzero++; + if (ebcdic) + e = (e < 64) ? '.' : etoa64[e-64]; + /* When changing this update definition of LLEN above. */ + c = addrlen + 3 + (grplen * cols - 1)/octspergrp + p; + l[c++] = +#ifdef __MVS__ + (e >= 64) +#else + (e > 31 && e < 127) +#endif + ? e : '.'; + n++; + if (++p == cols) + { + l[c] = '\n'; + l[++c] = '\0'; + xxdline(fpo, l, autoskip ? nonzero : 1); + nonzero = 0; + p = 0; + } + } + if (p) + { + l[c] = '\n'; + l[++c] = '\0'; + xxdline(fpo, l, 1); + } + else if (autoskip) + xxdline(fpo, l, -1); /* last chance to flush out suppressed lines */ + + fclose_or_die(fp, fpo); + return 0; +} + +/* vi:set ts=8 sw=4 sts=2 cino+={2 cino+=n-2 : */ diff --git a/tests/harness.app.htm b/tests/harness.app.htm new file mode 100644 index 0000000..78d0050 --- /dev/null +++ b/tests/harness.app.htm @@ -0,0 +1,2628 @@ +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +///