about summary refs log tree commit diff stats
path: root/subx/064write-byte.subx
diff options
context:
space:
mode:
authorKartik Agaram <vc@akkartik.com>2019-05-02 23:32:51 -0700
committerKartik Agaram <vc@akkartik.com>2019-05-02 23:32:51 -0700
commitf2cd405d04cd904bf1ed4d5ddf4916234c0509f5 (patch)
treeaacf72ab67c49c3ac2a2d6425924ef0999ebfe8d /subx/064write-byte.subx
parent6e131cefe2cdf9d83bd0727fa3ca97a2ec3b2d3f (diff)
downloadmu-f2cd405d04cd904bf1ed4d5ddf4916234c0509f5.tar.gz
standardize function names
Operations on buffered-file now always include the word 'buffered'. More
verbose, but hopefully this highlights holes in the library.
Diffstat (limited to 'subx/064write-byte.subx')
-rw-r--r--subx/064write-byte.subx30
1 files changed, 15 insertions, 15 deletions
diff --git a/subx/064write-byte.subx b/subx/064write-byte.subx
index 9f97c336..a432171d 100644
--- a/subx/064write-byte.subx
+++ b/subx/064write-byte.subx
@@ -1,4 +1,4 @@
-# write-byte: write a single byte to a buffered-file. The write may be buffered.
+# write-byte-buffered: add a single byte to a buffered-file.
 # flush: write out any buffered writes to disk.
 #
 # TODO: Come up with a way to signal failure to write to disk. This is hard
@@ -28,7 +28,7 @@ Stdout:
 # . 1-3 bytes   3 bits              2 bits          3 bits        3 bits      3 bits        2 bits      2 bits      0/1/2/4 bytes   0/1/2/4 bytes
 
 # Write lower byte of 'n' to 'f'.
-write-byte:  # f : (address buffered-file), n : int -> <void>
+write-byte-buffered:  # f : (address buffered-file), n : int -> <void>
     # . prolog
     55/push-EBP
     89/copy                         3/mod/direct    5/rm32/EBP    .           .             .           4/r32/ESP   .               .                 # copy ESP to EBP
@@ -41,7 +41,7 @@ write-byte:  # f : (address buffered-file), n : int -> <void>
     8b/copy                         1/mod/*+disp8   7/rm32/EDI    .           .             .           1/r32/ECX   4/disp8         .                 # copy *(EDI+4) to ECX
     # if (f->write >= f->length) flush and clear f's stream
     3b/compare                      1/mod/*+disp8   7/rm32/EDI    .           .             .           1/r32/ECX   0xc/disp8       .                 # compare ECX with *(EDI+12)
-    7c/jump-if-lesser  $write-byte:to-stream/disp8
+    7c/jump-if-lesser  $write-byte-buffered:to-stream/disp8
     # . flush(f)
     # . . push args
     57/push-EDI
@@ -59,7 +59,7 @@ write-byte:  # f : (address buffered-file), n : int -> <void>
     81          0/subop/add         3/mod/direct    4/rm32/ESP    .           .             .           .           .               4/imm32           # add to ESP
     # . f->write must now be 0; update its cache at ECX
     31/xor                          3/mod/direct    1/rm32/ECX    .           .             .           1/r32/ECX   .               .                 # clear ECX
-$write-byte:to-stream:
+$write-byte-buffered:to-stream:
     # write to stream
     # f->data[f->write] = LSB(n)
     31/xor                          3/mod/direct    0/rm32/EAX    .           .             .           0/r32/EAX   .               .                 # clear EAX
@@ -67,7 +67,7 @@ $write-byte:to-stream:
     88/copy-byte                    1/mod/*+disp8   4/rm32/sib    7/base/EDI  1/index/ECX   .           0/r32/AL    0x10/disp8      .                 # copy AL to *(EDI+ECX+16)
     # ++f->write
     ff          0/subop/increment   1/mod/*+disp8   7/rm32/EDI    .           .             .           .           4/disp8         .                 # increment *(EDI+4)
-$write-byte:end:
+$write-byte-buffered:end:
     # . restore registers
     5f/pop-to-EDI
     59/pop-to-ECX
@@ -105,8 +105,8 @@ $flush:end:
 
 # - tests
 
-test-write-byte-single:
-    # - check that write-byte writes to first byte of 'file'
+test-write-byte-buffered-single:
+    # - check that write-byte-buffered writes to first byte of 'file'
     # setup
     # . clear-stream(_test-stream)
     # . . push args
@@ -124,12 +124,12 @@ test-write-byte-single:
     e8/call  clear-stream/disp32
     # . . discard args
     81          0/subop/add         3/mod/direct    4/rm32/ESP    .           .             .           .           .               4/imm32           # add to ESP
-    # write-byte(_test-buffered-file, 'A')
+    # write-byte-buffered(_test-buffered-file, 'A')
     # . . push args
     68/push  0x41/imm32
     68/push  _test-buffered-file/imm32
     # . . call
-    e8/call  write-byte/disp32
+    e8/call  write-byte-buffered/disp32
     # . . discard args
     81          0/subop/add         3/mod/direct    4/rm32/ESP    .           .             .           .           .               8/imm32           # add to ESP
     # flush(_test-buffered-file)
@@ -141,7 +141,7 @@ test-write-byte-single:
     81          0/subop/add         3/mod/direct    4/rm32/ESP    .           .             .           .           .               4/imm32           # add to ESP
     # check-stream-equal(_test-stream, "A", msg)
     # . . push args
-    68/push  "F - test-write-byte-single"/imm32
+    68/push  "F - test-write-byte-buffered-single"/imm32
     68/push  "A"/imm32
     68/push  _test-stream/imm32
     # . . call
@@ -151,8 +151,8 @@ test-write-byte-single:
     # . end
     c3/return
 
-test-write-byte-multiple-flushes:
-    # - check that write-byte correctly flushes buffered data
+test-write-byte-buffered-multiple-flushes:
+    # - check that write-byte-buffered correctly flushes buffered data
     # setup
     # . clear-stream(_test-stream)
     # . . push args
@@ -181,12 +181,12 @@ test-write-byte-multiple-flushes:
     e8/call  write/disp32
     # . . discard args
     81          0/subop/add         3/mod/direct    4/rm32/ESP    .           .             .           .           .               8/imm32           # add to ESP
-    # write-byte(_test-buffered-file, 'g')
+    # write-byte-buffered(_test-buffered-file, 'g')
     # . . push args
     68/push  0x67/imm32
     68/push  _test-buffered-file/imm32
     # . . call
-    e8/call  write-byte/disp32
+    e8/call  write-byte-buffered/disp32
     # . . discard args
     81          0/subop/add         3/mod/direct    4/rm32/ESP    .           .             .           .           .               8/imm32           # add to ESP
     # flush(_test-buffered-file)
@@ -198,7 +198,7 @@ test-write-byte-multiple-flushes:
     81          0/subop/add         3/mod/direct    4/rm32/ESP    .           .             .           .           .               4/imm32           # add to ESP
     # check-stream-equal(_test-stream, "abcdef", msg)
     # . . push args
-    68/push  "F - test-write-byte-multiple-flushes: 1"/imm32
+    68/push  "F - test-write-byte-buffered-multiple-flushes: 1"/imm32
     68/push  "abcdefg"/imm32
     68/push  _test-stream/imm32
     # . . call