include-code parameter in zeus2txt

Author: jia3ep

README.rst

@@ -1,6 +1,6 @@
-============================================
+=====================================
 Tools to manipulate ZX Spectrum files
-============================================
+=====================================
 
 .. image:: https://travis-ci.org/codeatcpp/zxtools.svg?branch=master
    :target: https://travis-ci.org/codeatcpp/zxtools
@@ -20,7 +20,7 @@ TODO: I have future plans to implement some more tools I need to restore my old
 
 But you can use them in the way you need. And it's very easy to use: download the package, run ``setup.py`` (or install via ``pip install zxtools``), invoke in the following way::
 
-   $ python3 -m zxtools.hobeta strip input.hobetta result.zeus
+   $ python3 -m zxtools.hobeta strip input.hobeta result.zeus
    $ python3 -m zxtools.zeus2txt result.zeus listing.txt
 
 NOTE: Python 3 is required to use this package, and Python 2 is not supported but you are welcome to fix it.

test/test_hobeta.py

@@ -8,8 +8,6 @@
 # Licensed under the BSD 3-Clause license.
 # See LICENSE file in the project root for full license information.
 #
-""" Convert Zeus Z80 assembler file to a plain text """
-
 """ hobeta.py tests """
 
 import os
@@ -24,26 +22,26 @@
 class TestHobeta(unittest.TestCase):
     def test_args_parser(self):
         with self.assertRaises(SystemExit):
-            args = hobeta.parse_args(("-h", "-v"))
+            hobeta.parse_args(("-h", "-v"))
 
         temp_in_file = tempfile.mkstemp()[1]
         input_file = open(temp_in_file, "w")
         input_file.close()
         temp_out_file = tempfile.mkstemp()[1]
         try:
-           args = hobeta.parse_args(("info", temp_in_file))
-           self.assertEqual(args.func, hobeta.show_info)
-           args.hobeta_file.close()
-
-           args = hobeta.parse_args(("strip", temp_in_file, temp_out_file))
-           self.assertEqual(args.func, hobeta.strip_header)
-           args.hobeta_file.close()
-           args.output_file.close()
+            args = hobeta.parse_args(("info", temp_in_file))
+            self.assertEqual(args.func, hobeta.show_info)
+            args.hobeta_file.close()
+
+            args = hobeta.parse_args(("strip", temp_in_file, temp_out_file))
+            self.assertEqual(args.func, hobeta.strip_header)
+            args.hobeta_file.close()
+            args.output_file.close()
         finally:
             os.remove(temp_in_file)
             os.remove(temp_out_file)
 
-    def test_ckechsum(self):
+    def test_checksum(self):
         data = b'F.load.AC\x00\x80\xf9\x06\x00\x07'
         self.assertEqual(hobeta.calc_checksum(data), 20661)
 
@@ -101,8 +99,8 @@ def test_parse_info2(self):
     def strip_header(test_input_file, ignore_header_info):
         temp_output_path = tempfile.mkstemp()[1]
         temp_output_file = open(temp_output_path, "wb")
-        Args = namedtuple('Args', "hobeta_file output_file ignore_header")
-        parsed_args = Args(test_input_file,
+        args = namedtuple('Args', "hobeta_file output_file ignore_header")
+        parsed_args = args(test_input_file,
                            temp_output_file,
                            ignore_header_info)
         copied_bytes = hobeta.strip_header(parsed_args)
@@ -160,10 +158,6 @@ def test_strip_header3(self):
             temp_output_file.close()
             os.remove(temp_output_path)
 
-    def test_args_parser(self):
-        parser = hobeta.parse_args(['hobeta-help'])
-        self.assertTrue(parser.func)
-
 
 if __name__ == '__main__':
     unittest.main()

test/test_trdos.py

@@ -8,8 +8,6 @@
 # Licensed under the BSD 3-Clause license.
 # See LICENSE file in the project root for full license information.
 #
-""" Convert Zeus Z80 assembler file to a plain text """
-
 """ trdos.py tests """
 
 import unittest

test/test_zeus2txt.py

@@ -8,8 +8,6 @@
 # Licensed under the BSD 3-Clause license.
 # See LICENSE file in the project root for full license information.
 #
-""" Convert Zeus Z80 assembler file to a plain text """
-
 """ zeus2txt.py tests """
 
 import io
@@ -25,33 +23,34 @@
 class TestZeus2Txt(unittest.TestCase):
     def test_args_parser(self):
         with self.assertRaises(SystemExit):
-            args = zeus2txt.parse_args(("-h", "-v"))
+            zeus2txt.parse_args(("-h", "-v"))
 
         temp_in_file = tempfile.mkstemp()[1]
         input_file = open(temp_in_file, "w")
         input_file.close()
         temp_out_file = tempfile.mkstemp()[1]
         try:
-           args = zeus2txt.parse_args(("info", temp_in_file))
-           self.assertEqual(args.func, zeus2txt.show_info)
-           args.zeus_file.close()
+            args = zeus2txt.parse_args(("info", temp_in_file))
+            self.assertEqual(args.func, zeus2txt.show_info)
+            args.zeus_file.close()
 
-           args = zeus2txt.parse_args(("convert", temp_in_file, temp_out_file))
-           self.assertEqual(args.func, zeus2txt.convert_file)
-           args.zeus_file.close()
-           args.output_file.close()
+            args = zeus2txt.parse_args(("convert",
+                                        temp_in_file, temp_out_file))
+            self.assertEqual(args.func, zeus2txt.convert_file)
+            args.zeus_file.close()
+            args.output_file.close()
         finally:
             os.remove(temp_in_file)
             os.remove(temp_out_file)
 
     @staticmethod
-    def prepare_convert_args(test_data):
+    def prepare_convert_args(test_data, include_code=False):
         test_file = io.BytesIO(test_data)
         temp_output_path = tempfile.mkstemp()[1]
         temp_output_file = open(temp_output_path, "w")
 
-        Args = namedtuple('Args', "zeus_file output_file")
-        parsed_args = Args(test_file, temp_output_file)
+        args = namedtuple('Args', "zeus_file output_file include_code")
+        parsed_args = args(test_file, temp_output_file, include_code)
         return parsed_args, temp_output_path, temp_output_file
 
     def test_undefined_token(self):
@@ -64,7 +63,7 @@ def test_undefined_token(self):
             temp_output_file.close()
             temp_output_file = open(temp_output_path, "r")
             lines = temp_output_file.read().splitlines()
-            self.assertEqual(lines, ["00010       ,42",""])
+            self.assertEqual(lines, ["00010       ,42", ""])
         finally:
             temp_output_file.close()
             os.remove(temp_output_path)
@@ -78,7 +77,24 @@ def test_no_eof(self):
             temp_output_file.close()
             temp_output_file = open(temp_output_path, "r")
             lines = temp_output_file.read().splitlines()
-            self.assertEqual(lines, ["00010       ADD BC,42",])
+            self.assertEqual(lines, ["00010       ADD BC,42", ])
+        finally:
+            temp_output_file.close()
+            os.remove(temp_output_path)
+
+    def test_include_code(self):
+        args, temp_output_path, temp_output_file = self.prepare_convert_args(
+            b"\x0A\x00\x0A\x06\x82\x87\x2C\x34\x32\x00", True)
+
+        try:
+            zeus2txt.convert_file(args)
+            temp_output_file.close()
+            temp_output_file = open(temp_output_path, "r")
+            lines = temp_output_file.read().splitlines()
+            self.assertEqual(lines, ["00010       ADD BC,42"
+                                     "              ; 0x000A "
+                                     "0x0A 0x06 0x82 0x87 "
+                                     "0x2C 0x34 0x32 0x00 ", ])
         finally:
             temp_output_file.close()
             os.remove(temp_output_path)
@@ -423,5 +439,6 @@ def setUp(self):
             b"\x20\x20\x4E\x4F\x50\x0A"
         )
 
+
 if __name__ == '__main__':
     unittest.main()

zxtools/__init__.py

@@ -8,7 +8,6 @@
 # Licensed under the BSD 3-Clause license.
 # See LICENSE file in the project root for full license information.
 #
-""" Convert Zeus Z80 assembler file to a plain text """
 
 CHUNK_SIZE = 512 * 1024  # 512 KBytes
 

zxtools/hobeta.py

@@ -28,7 +28,7 @@
 def hobeta_help(*parsed_args):
     print(
         "Hobeta file has the following format:\n"
-        "(this is accroding to http://speccy.info/Hobeta)\n"
+        "(this is according to http://speccy.info/Hobeta)\n"
         "\n"
         "0                   1                   2                   3\n"
         "0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1\n"

zxtools/trdos.py

@@ -12,7 +12,7 @@
 
 from collections import namedtuple
 
-# TR-DOS diskette stucture description
+# TR-DOS diskette structure description
 #
 # 0 track contains FAT in sectors 0..7
 ###############################################################################

zxtools/zeus2txt.py

@@ -17,6 +17,8 @@
 
 from zxtools import CHUNK_SIZE
 
+CODE_ALIGN_WIDTH = 35
+
 
 def show_info(*parsed_args):
     return
@@ -32,6 +34,7 @@ def read_file(src_file):
             else:
                 break
 
+
 ASM_FIRST_TOKEN = 128
 ASM_META = [
     "A", "ADC ", "ADD ", "AF'", "AF", "AND ", "B", "BC", "BIT ", "C",
@@ -48,7 +51,8 @@ def read_file(src_file):
 
 
 def convert_file(parsed_args):
-    """ Convert Zeus Z80 assembler file specified in zeus_file to the plain text and print it to the output_file """
+    """ Convert Zeus Z80 assembler file specified in zeus_file to the plain
+    text and print it to the output_file """
     logger = logging.getLogger('convert_file')
 
     process_string = False
@@ -58,11 +62,17 @@ def convert_file(parsed_args):
     strnum = 0
     for b in read_file(parsed_args.zeus_file):
         if process_string:
+            cur_buffer += "0x%02X " % b
             if not b:  # End of string
                 process_string = False
                 strnum_lo = False, 0
-                print(file=cur_line)
-                print(cur_line.getvalue(), file=output)
+                cur_str = cur_line.getvalue()
+                print(cur_str, end="", file=output)
+                if parsed_args.include_code:
+                    print(" "*(CODE_ALIGN_WIDTH-len(cur_str))+";",
+                          "0x%04X " % strnum + cur_buffer, file=output)
+                else:
+                    print(file=output)
                 continue
             if tab:
                 print(" "*b, end="", file=cur_line)
@@ -77,8 +87,8 @@ def convert_file(parsed_args):
             try:
                 print(ASM_META[b-ASM_FIRST_TOKEN], end="", file=cur_line)
             except IndexError:
-                logger.warning("Token not defined: 0x%02X (%d), at line %05d"
-                    % (b, b, strnum))
+                logger.warning("Token not defined: 0x%02X (%d), at line %05d. "
+                               "Skipped." % (b, b, strnum))
         else:
             if not strnum_lo[0]:
                 strnum_lo = True, b
@@ -89,6 +99,7 @@ def convert_file(parsed_args):
                     break
                 cur_line = io.StringIO()
                 cur_line.truncate(0)
+                cur_buffer = ""
                 print("%05d" % strnum, end=" ", file=cur_line)
                 process_string = True
     output.close()
@@ -120,6 +131,9 @@ def parse_args(args):
     convert_parser.add_argument(
         'output_file', metavar='output-file',
         type=argparse.FileType('w'), help="Path to the output file")
+    convert_parser.add_argument(
+        '--include-code', dest='include_code',
+        action='store_true', help="Include original code in the output file")
     convert_parser.set_defaults(func=convert_file)
 
     return parser.parse_args(args)