Split off libword.

Author: larsbrinkhoff

.gitignore

@@ -15,7 +15,6 @@ palx
 kldcp
 klfedr
 libfiles.a
-libwords.a
 scrmbl
 unscr
 tvpic

Makefile

@@ -1,14 +1,12 @@
 
-CFLAGS = -g -W -Wall
+CFLAGS = -g -W -Wall -Ilibword
 
 FILES =  sblk-file.o pdump-file.o dmp-file.o raw-file.o exe-file.o \
 	 mdl-file.o rim10-file.o fasl-file.o palx-file.o lda-file.o \
 	 cross-file.o hex-file.o atari-file.o iml-file.o exb-file.o \
 	 tenex-file.o csave-file.o hiseg-file.o
 
-WORDS =  aa-word.o alto-word.o bin-word.o cadr-word.o core-word.o \
-	 data8-word.o dta-word.o its-word.o oct-word.o pt-word.o \
-	 sail-word.o tape-word.o
+LIBWORD = libword/libword.a
 
 OBJS =	pdp10-opc.o info.o dis.o symbols.o \
 	timing.o timing_ka10.o timing_ki10.o memory.o weenix.o
@@ -21,96 +19,97 @@ UTILS =	cat36 itsarc magdmp magfrm dskdmp dump \
 all: dis10 $(UTILS) check
 
 clean:
-	rm -f $(OBJS) $(WORDS) libfiles.a libwords.a
+	cd libword; make clean
+	rm -f $(OBJS) libfiles.a
 	rm -f dis10 core
 	rm -f $(UTILS)
 	rm -f main.o dmp.o raw.o das.o crypt.o
 	for f in $(UTILS); do rm -f $${f}.o; done
 	rm -f out/*
 	rm -f check
 
-dis10: main.o $(OBJS) libfiles.a libwords.a
+dis10: main.o $(OBJS) libfiles.a $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
 libfiles.a: file.o $(FILES)
 	ar -crs $@ $^
 
-libwords.a: word.o $(WORDS)
-	ar -crs $@ $^
+$(LIBWORD):
+	cd libword && make
 
-cat36: cat36.o libwords.a
+cat36: cat36.o $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-dump: dump.c $(OBJS) libfiles.a libwords.a
+dump: dump.c $(OBJS) libfiles.a $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-dskdmp: dskdmp.c $(OBJS) libwords.a
+dskdmp: dskdmp.c $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-macdmp: macdmp.c $(OBJS) libwords.a
+macdmp: macdmp.c $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-tendmp: tendmp.o dec.o $(OBJS) libfiles.a libwords.a
+tendmp: tendmp.o dec.o $(OBJS) libfiles.a $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-magdmp: magdmp.c core-word.o $(OBJS) libwords.a
+magdmp: magdmp.c $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-magfrm: magfrm.c core-word.o $(OBJS) libwords.a
+magfrm: magfrm.c $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-ipak: ipak.o $(OBJS) libwords.a
+ipak: ipak.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-itsarc: itsarc.o $(OBJS) libwords.a
+itsarc: itsarc.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-macro-tapes: macro-tapes.o $(OBJS) libwords.a
+macro-tapes: macro-tapes.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-tape-dir: tape-dir.o $(OBJS) libwords.a
+tape-dir: tape-dir.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-tito: tito.o $(OBJS) libwords.a
+tito: tito.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-dart: dart.o dec.o $(OBJS) libwords.a
+dart: dart.o dec.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-dumper: dumper.o $(OBJS) libwords.a
+dumper: dumper.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
 mini-dumper: dumper
 	ln -f $< $@
 
-od10: od10.o $(OBJS) libwords.a
+od10: od10.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-linum: linum.o $(OBJS) libwords.a
+linum: linum.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-constantinople: constantinople.o $(OBJS) libfiles.a libwords.a
+constantinople: constantinople.o $(OBJS) libfiles.a $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-harscntopbm: harscntopbm.o libwords.a
+harscntopbm: harscntopbm.o $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-palx: palx.o $(OBJS) libwords.a
+palx: palx.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-cross: cross.o $(OBJS) libwords.a
+cross: cross.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-kldcp: kldcp.o $(OBJS) das.o libwords.a
+kldcp: kldcp.o $(OBJS) das.o $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-klfedr: klfedr.o $(OBJS) libwords.a
+klfedr: klfedr.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-scrmbl: scrmbl.o crypt.o $(OBJS) libwords.a
+scrmbl: scrmbl.o crypt.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-unscr: unscr.o crypt.o $(OBJS) libwords.a
+unscr: unscr.o crypt.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
 lodepng.c: lodepng/lodepng.cpp
@@ -121,13 +120,13 @@ lodepng.h: lodepng/lodepng.h
 
 tvpic.o: tvpic.c lodepng.h
 
-tvpic: tvpic.o lodepng.o $(OBJS) libwords.a
+tvpic: tvpic.o lodepng.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-test/test_write: test/test_write.o $(OBJS) libwords.a
+test/test_write: test/test_write.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
-test/test_read: test/test_read.o $(OBJS) libwords.a
+test/test_read: test/test_read.o $(OBJS) $(LIBWORD)
 	$(CC) $(CFLAGS) $^ -o $@
 
 check: check.sh

dis.h

@@ -19,6 +19,7 @@
 #include <time.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <libword.h>
 
 #define WORDMASK	(0777777777777LL)
 #define SIGNBIT		(0400000000000LL)
@@ -29,8 +30,6 @@
 /* DEC page size, in words */
 #define DEC_PAGESIZE 512
 
-typedef long long word_t;
-
 #define JRST   ((word_t)(0254000000000LL))
 #define JRST_1 (JRST + 1)
 #define JUMPA  ((word_t)(0324000000000LL))
@@ -46,23 +45,8 @@ struct file_format {
   void (*write) (FILE *f, struct pdp10_memory *memory);
 };
 
-struct word_format {
-  const char *name;
-  word_t (*get_word) (FILE *);
-  void (*rewind_word) (FILE *);		/* NULL means just rewind (f) */
-  void (*seek_word) (FILE *, int);	/* NULL means rewind and go forward. */
-  void (*write_word) (FILE *, word_t);
-  void (*flush_word) (FILE *);		/* NULL means do nothing */
-};
-
 enum { SYMBOLS_NONE, SYMBOLS_DDT, SYMBOLS_ALL };
 
-enum {
-  START_FILE = 1LL << 36,
-  START_RECORD = 1LL << 37,
-  START_TAPE = 1LL << 38
-};
-
 extern struct file_format *input_file_format;
 extern struct file_format *output_file_format;
 extern struct file_format atari_file_format;
@@ -87,51 +71,10 @@ extern struct file_format sblk_file_format;
 extern struct file_format shr_file_format;
 extern struct file_format tenex_file_format;
 
-extern struct word_format *input_word_format;
-extern struct word_format *output_word_format;
-extern struct word_format aa_word_format;
-extern struct word_format alto_word_format;
-extern struct word_format bin_word_format;
-extern struct word_format cadr_word_format;
-extern struct word_format core_word_format;
-extern struct word_format data8_word_format;
-extern struct word_format dta_word_format;
-extern struct word_format its_word_format;
-extern struct word_format oct_word_format;
-extern struct word_format pt_word_format;
-extern struct word_format sail_word_format;
-extern struct word_format tape_word_format;
-extern struct word_format tape7_word_format;
-
 extern void     usage_file_format (void);
 extern int      parse_input_file_format (const char *);
 extern int      parse_output_file_format (const char *);
 extern void     guess_input_file_format (FILE *);
-extern void     usage_word_format (void);
-extern int      parse_input_word_format (const char *);
-extern int      parse_output_word_format (const char *);
-extern word_t	get_word (FILE *f);
-extern word_t	get_checksummed_word (FILE *f);
-extern void	reset_checksum (word_t);
-extern void	check_checksum (word_t);
-extern void	rewind_word (FILE *f);
-extern void	seek_word (FILE *f, int position);
-extern void	by_five_octets (FILE *f, int position);
-extern void	by_eight_octets (FILE *f, int position);
-extern void	write_word (FILE *, word_t);
-extern void	flush_word (FILE *);
-extern void     (*tape_hook) (int code);
-extern int      get_7track_record (FILE *f, word_t **buffer);
-extern int      get_9track_record (FILE *f, word_t **buffer);
-extern void     write_7track_record (FILE *f, word_t *buffer, int);
-extern void     write_9track_record (FILE *f, word_t *buffer, int);
-extern void     write_tape_mark (FILE *f);
-extern void     write_tape_eof (FILE *f);
-extern void     write_tape_eot (FILE *f);
-extern void     write_tape_gap (FILE *f, unsigned code);
-extern void     write_tape_error (FILE *f, unsigned code);
-extern word_t	get_core_word (FILE *f);
-extern void	write_core_word (FILE *f, word_t word);
 extern void	read_raw_at (FILE *f, struct pdp10_memory *memory,
 			     int address);
 extern void	write_raw_at (FILE *f, struct pdp10_memory *memory,

libword/.gitignore

@@ -0,0 +1,3 @@
+*~
+*.o
+libword.a

libword/Makefile

@@ -0,0 +1,14 @@
+CFLAGS = -g -W -Wall
+
+OBJS =	aa-word.o alto-word.o bin-word.o cadr-word.o core-word.o \
+	data8-word.o dta-word.o its-word.o oct-word.o pt-word.o \
+	sail-word.o tape-word.o
+
+all: libword.a
+
+clean:
+	rm -f libword.a *.o
+
+libword.a: word.o $(OBJS)
+	$(AR) -crs $@ $^
+

libword/README.md

@@ -0,0 +1,66 @@
+# LIBWORD
+
+A library for reading and writing binary words.
+
+### API
+
+**Basic word input/output.**
+
+- `word_t`  
+   Type for storing a word.
+
+- `word_t read_word (FILE *file);`  
+   Read one `word` from the `file`.
+
+- `void write_word (FILE *file, word_t word);`  
+   Write one `word` to the `file`.
+
+- `void rewind_word (FILE *file);`  
+   Rewind the `file` to the beginning.
+
+- `void seek_word (FILE *file, long long position);`  
+   Seek to word number `position` in the `file`.
+
+- `void flush_word (FILE *file);`  
+   Prepare output `file` to be closed.
+
+**Selecting a word format.**
+
+- `word usage_word_format (void);`
+   Print a summary of valid word formats.
+
+- `int parse_input_word_format (const char *string);`
+   Parse a `string` and set the input word format.
+   Return 0 on success, or -1 on error.
+
+- `int parse_output_word_format (const char *string);`
+   Parse a `string` and set the output word format.
+   Return 0 on success, or -1 on error.
+
+Word formats are:
+
+- `ascii` - PDP-10 ANSI ASCII.
+- `alto` - PDP-10 words stored in an Alto file system.
+- `bin` - PDP-10 densely packed words.
+- `cadr` - 32-bit CADR Lisp machine words stored left aligned in 36-bit words.
+- `core` - PDP-10 core dump.
+- `data8` - PDP-10 words stored little-endian in eight octets.
+- `dta` - 36-bit DECtape image.
+- `its` - ITS evacuate format.
+- `oct` - 36-bit octal numbers as ASCII text.
+- `pt` - 36-bit words in a paper tape image.
+- `sail` - Saildart.org text files.
+- `tape` - SIMH 9-track tape image.
+- `tape7` - SIMH 7-track tape image.
+
+**Tape structured data.**
+
+A `word_t` can have the bits `START_TAPE`, `START_FILE`, or
+`START_RECORD` set.  On input, this means a structure boundary was
+encountered before the word.  On output, mark such a boundary before
+the word.
+
+More complicated media events are supported by a hook which receives
+a SIMH tape image code with the most significant bit set.
+
+- `void (*tape_hook) (int code);`

aa-word.c renamed to libword/aa-word.c

@@ -26,7 +26,7 @@
 
 #include <stdio.h>
 
-#include "dis.h"
+#include "libword.h"
 
 static inline int
 get_byte (FILE *f)

alto-word.c renamed to libword/alto-word.c

@@ -15,7 +15,7 @@
 
 #include <stdio.h>
 
-#include "dis.h"
+#include "libword.h"
 
 static int
 get_byte (FILE *f)

bin-word.c renamed to libword/bin-word.c

@@ -14,8 +14,11 @@
     along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #include <stdio.h>
+#include <stdlib.h>
+#include "libword.h"
 
-#include "dis.h"
+#define WORDMASK	(0777777777777LL)
+#define SIGNBIT		(0400000000000LL)
 
 static int leftover_input, have_leftover_input = 0;
 static int leftover_output, have_leftover_output = 0;

cadr-word.c renamed to libword/cadr-word.c

@@ -14,7 +14,7 @@
     along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #include <stdio.h>
-#include "dis.h"
+#include "libword.h"
 
 /* Data files for CADR Lisp machines were apparently stored as 32 bits
    left aligned in a 36-bit word.  The 32-bit word is in PDP-11 endian