Release version 1.6.0

eebce6e7cc

.gitignore

@@ -6,3 +6,6 @@ __pycache__/
 *.egg-info/
 build/
 dist/
+
+# mypy
+.mypy_cache/

README.rst

@@ -108,25 +108,59 @@ Writing resource data is not supported at all.
 Further info on resource files
 ------------------------------
 
-Sources of information about the resource fork data format, and the structure of common resource types:
-
-* Inside Macintosh, Volume I, Chapter 5 "The Resource Manager". This book can probably be obtained in physical form somewhere, but the relevant chapter/book is also available in a few places online:
-
-  * `Apple's legacy documentation <https://developer.apple.com/legacy/library/documentation/mac/pdf/MoreMacintoshToolbox.pdf>`_
-  * pagetable.com, a site that happened to have a copy of the book: `info blog post <http://www.pagetable.com/?p=50>`_, `direct download <http://www.weihenstephan.org/~michaste/pagetable/mac/Inside_Macintosh.pdf>`_
-
-* `Wikipedia <https://en.wikipedia.org/wiki/Resource_fork>`_, of course
-* The `Resource Fork <http://fileformats.archiveteam.org/wiki/Resource_Fork>`_ article on "Just Solve the File Format Problem" (despite the title, this is a decent site and not clickbait)
-* The `KSFL <https://github.com/kreativekorp/ksfl>`_ library (and `its wiki <https://github.com/kreativekorp/ksfl/wiki/Macintosh-Resource-File-Format>`_), written in Java, which supports reading and writing resource files
-* Alysis Software Corporation's article on resource compression (found on `the company's website <http://www.alysis.us/arctechnology.htm>`_ and in `MacTech Magazine's online archive <http://preserve.mactech.com/articles/mactech/Vol.09/09.01/ResCompression/index.html>`_) has some information on the structure of certain kinds of compressed resources.
-* Apple's macOS SDK, which is distributed with Xcode. The latest version of Xcode is available for free from the Mac App Store. Current and previous versions can be downloaded from `the Apple Developer download page <https://developer.apple.com/download/more/>`_. Accessing these downloads requires an Apple ID with (at least) a free developer program membership.
-* Apple's MPW (Macintosh Programmer's Workshop) and related developer tools. These were previously available from Apple's FTP server at ftp://ftp.apple.com/, which is no longer functional. Because of this, these downloads are only available on mirror sites, such as http://staticky.com/mirrors/ftp.apple.com/.
-
-If these links are no longer functional, some are archived in the `Internet Archive Wayback Machine <https://archive.org/web/>`_ or `archive.is <http://archive.is/>`_ aka `archive.fo <https://archive.fo/>`_.
+For technical info and documentation about resource files and resources, see the `"resource forks" section of the mac_file_format_docs repo <https://github.com/dgelessus/mac_file_format_docs/blob/master/README.md#resource-forks>`_.
 
 Changelog
 ---------
 
+Version 1.6.0
+^^^^^^^^^^^^^
+
+* Added a new subcommand-based command-line syntax to the ``rsrcfork`` tool, similar to other CLI tools such as ``git`` or ``diskutil``.
+
+  * This subcommand-based syntax is meant to replace the old CLI options, as the subcommand structure is easier to understand and more extensible in the future.
+  * Currently there are three subcommands: ``list`` to list resources in a file, ``read`` to read/display resource data, and ``read-header`` to read a resource file's header data. These subcommands can be used to perform all operations that were also available with the old CLI syntax.
+  * The old CLI syntax is still supported for now, but it will be removed soon.
+  * The new syntax no longer supports reading CLI arguments from a file (using ``@args_file.txt``), abbreviating long options (e. g. ``--no-d`` instead of ``--no-decompress``), or the short option ``-f`` instead of ``--fork``. If you have a need for any of these features, please open an issue.
+
+Version 1.5.0
+^^^^^^^^^^^^^
+
+* Added stream-based decompression methods to the ``rsrcfork.compress`` module.
+
+  * The internal decompressor implementations have been refactored to use streams.
+  * This allows for incremental decompression of compressed resource data. In practice this has no noticeable effect yet, because the main ``rsrcfork`` API doesn't support incremental reading of resource data.
+
+* Fixed the command line tool always displaying an incorrect error "Cannot specify an explicit fork when reading from stdin" when using ``-`` (stdin) as the input file.
+
+Version 1.4.0
+^^^^^^^^^^^^^
+
+* Added ``length`` and ``length_raw`` attributes to ``Resource``. These attributes are equivalent to the ``len`` of ``data`` and ``data_raw`` respectively, but may be faster to access.
+
+  * Currently, the only optimized case is ``length`` for compressed resources, but more optimizations may be added in the future.
+
+* Added a ``compressed_info`` attribute to ``Resource`` that provides access to the header information of compressed resources.
+* Improved handling of compressed resources when listing resource files with the command line tool.
+
+  * Metadata of compressed resources is now displayed even if no decompressor implementation is available (as long as the compressed data header can be parsed).
+  * Performance has been improved - the data no longer needs to be fully decompressed to get its length, this information is now read from the header.
+  * The ``'dcmp'`` ID used to decompress each resource is displayed.
+
+* Fixed an incorrect ``options.packages`` in ``setup.cfg``, which made the library unusable except when installing from source using ``--editable``.
+* Fixed ``ResourceFile.__enter__`` returning ``None``, which made it impossible to use ``ResourceFile`` properly in a ``with`` statement.
+* Fixed various minor errors reported by type checking with ``mypy``.
+
+Version 1.3.0.post1
+^^^^^^^^^^^^^^^^^^^
+
+* Fixed an incorrect ``options.packages`` in ``setup.cfg``, which made the library unusable except when installing from source using ``--editable``.
+
+Version 1.2.0.post1
+^^^^^^^^^^^^^^^^^^^
+
+* Fixed an incorrect ``options.packages`` in ``setup.cfg``, which made the library unusable except when installing from source using ``--editable``.
+
 Version 1.3.0
 ^^^^^^^^^^^^^
 

rsrcfork/__init__.py

@@ -1,6 +1,26 @@
 """A pure Python, cross-platform library/tool for reading Macintosh resource data, as stored in resource forks and ``.rsrc`` files."""
 
-__version__ = "1.3.0"
+# To release a new version:
+# * Remove the .dev suffix from the version number in this file.
+# * Update the changelog in the README.rst (rename the "next version" section to the correct version number).
+# * Remove the ``dist`` directory (if it exists) to clean up any old release files.
+# * Run ``python3 setup.py sdist bdist_wheel`` to build the release files.
+# * Run ``python3 -m twine check dist/*`` to check the release files.
+# * Fix any errors reported by the build and/or check steps.
+# * Commit the changes to master.
+# * Tag the release commit with the version number, prefixed with a "v" (e. g. version 1.2.3 is tagged as v1.2.3).
+# * Fast-forward the release branch to the new release commit.
+# * Push the master and release branches.
+# * Upload the release files to PyPI using ``python3 -m twine upload dist/*``.
+# * On the GitHub repo's Releases page, edit the new release tag and add the relevant changelog section from the README.rst. (Note: The README is in reStructuredText format, but GitHub's release notes use Markdown, so it may be necessary to adjust the markup syntax.)
+
+# After releasing:
+# * (optional) Remove the build and dist directories from the previous release as they are no longer needed.
+# * Bump the version number in this file to the next version and add a .dev suffix.
+# * Add a new empty section for the next version to the README.rst changelog.
+# * Commit and push the changes to master.
+
+__version__ = "1.6.0"
 
 __all__ = [
 	"Resource",

rsrcfork/__main__.py

@@ -2,6 +2,7 @@ import argparse
 import collections
 import enum
 import itertools
+import pathlib
 import sys
 import textwrap
 import typing
@@ -25,13 +26,13 @@ _REZ_ATTR_NAMES = {
 	api.ResourceAttrs.resCompressed: None, # "Extended Header resource attribute"
 }
 
-F = typing.TypeVar("F", bound=enum.Flag, covariant=True)
-def _decompose_flags(value: F) -> typing.Sequence[F]:
+F = typing.TypeVar("F", bound=enum.Flag)
+def decompose_flags(value: F) -> typing.Sequence[F]:
 	"""Decompose an enum.Flags instance into separate enum constants."""
 	
 	return [bit for bit in type(value) if bit in value]
 
-def _is_printable(char: str) -> bool:
+def is_printable(char: str) -> bool:
 	"""Determine whether a character is printable for our purposes.
 	
 	We mainly use Python's definition of printable (i. e. everything that Unicode does not consider a separator or "other" character). However, we also treat U+F8FF as printable, which is the private use codepoint used for the Apple logo character.
@@ -39,20 +40,20 @@ def _is_printable(char: str) -> bool:
 	
 	return char.isprintable() or char == "\uf8ff"
 
-def _bytes_unescape(string: str) -> bytes:
+def bytes_unescape(string: str) -> bytes:
 	"""Convert a string containing text (in _TEXT_ENCODING) and hex escapes to a bytestring.
 	
 	(We implement our own unescaping mechanism here to not depend on any of Python's string/bytes escape syntax.)
 	"""
 	
-	out = []
+	out: typing.List[int] = []
 	it = iter(string)
 	for char in it:
 		if char == "\\":
 			try:
 				esc = next(it)
 				if esc in "\\\'\"":
-					out.append(esc)
+					out.extend(esc.encode(_TEXT_ENCODING))
 				elif esc == "x":
 					x1, x2 = next(it), next(it)
 					out.append(int(x1+x2, 16))
@@ -65,7 +66,7 @@ def _bytes_unescape(string: str) -> bytes:
 	
 	return bytes(out)
 
-def _bytes_escape(bs: bytes, *, quote: str=None) -> str:
+def bytes_escape(bs: bytes, *, quote: typing.Optional[str]=None) -> str:
 	"""Convert a bytestring to a string (using _TEXT_ENCODING), with non-printable characters hex-escaped.
 	
 	(We implement our own escaping mechanism here to not depend on Python's str or bytes repr.)
@@ -75,15 +76,15 @@ def _bytes_escape(bs: bytes, *, quote: str=None) -> str:
 	for byte, char in zip(bs, bs.decode(_TEXT_ENCODING)):
 		if char in {quote, "\\"}:
 			out.append(f"\\{char}")
-		elif _is_printable(char):
+		elif is_printable(char):
 			out.append(char)
 		else:
 			out.append(f"\\x{byte:02x}")
 	
 	return "".join(out)
 
-def _filter_resources(rf: api.ResourceFile, filters: typing.Sequence[str]) -> typing.Sequence[api.Resource]:
-	matching = collections.OrderedDict()
+def filter_resources(rf: api.ResourceFile, filters: typing.Sequence[str]) -> typing.List[api.Resource]:
+	matching: typing.MutableMapping[typing.Tuple[bytes, int], api.Resource] = collections.OrderedDict()
 	
 	for filter in filters:
 		if len(filter) == 4:
@@ -96,7 +97,7 @@ def _filter_resources(rf: api.ResourceFile, filters: typing.Sequence[str]) -> ty
 				matching[res.type, res.id] = res
 		elif filter[0] == filter[-1] == "'":
 			try:
-				resources = rf[_bytes_unescape(filter[1:-1])]
+				resources = rf[bytes_unescape(filter[1:-1])]
 			except KeyError:
 				continue
 			
@@ -109,44 +110,44 @@ def _filter_resources(rf: api.ResourceFile, filters: typing.Sequence[str]) -> ty
 			elif filter[pos + 1] != " ":
 				raise ValueError(f"Invalid filter {filter!r}: Resource type and ID must be separated by a space")
 			
-			restype, resid = filter[:pos + 1], filter[pos + 2:]
+			restype_str, resid_str = filter[:pos + 1], filter[pos + 2:]
 			
-			if not restype[0] == restype[-1] == "'":
+			if not restype_str[0] == restype_str[-1] == "'":
 				raise ValueError(
-					f"Invalid filter {filter!r}: Resource type is not a single-quoted type identifier: {restype!r}")
-			restype = _bytes_unescape(restype[1:-1])
+					f"Invalid filter {filter!r}: Resource type is not a single-quoted type identifier: {restype_str!r}")
+			restype = bytes_unescape(restype_str[1:-1])
 			
 			if len(restype) != 4:
 				raise ValueError(
 					f"Invalid filter {filter!r}: Type identifier must be 4 bytes after replacing escapes, got {len(restype)} bytes: {restype!r}")
 			
-			if resid[0] != "(" or resid[-1] != ")":
+			if resid_str[0] != "(" or resid_str[-1] != ")":
 				raise ValueError(f"Invalid filter {filter!r}: Resource ID must be parenthesized")
-			resid = resid[1:-1]
+			resid_str = resid_str[1:-1]
 			
 			try:
 				resources = rf[restype]
 			except KeyError:
 				continue
 			
-			if resid[0] == resid[-1] == '"':
-				name = _bytes_unescape(resid[1:-1])
+			if resid_str[0] == resid_str[-1] == '"':
+				name = bytes_unescape(resid_str[1:-1])
 				
 				for res in resources.values():
 					if res.name == name:
 						matching[res.type, res.id] = res
 						break
-			elif ":" in resid:
-				if resid.count(":") > 1:
-					raise ValueError(f"Invalid filter {filter!r}: Too many colons in ID range expression: {resid!r}")
-				start, end = resid.split(":")
-				start, end = int(start), int(end)
+			elif ":" in resid_str:
+				if resid_str.count(":") > 1:
+					raise ValueError(f"Invalid filter {filter!r}: Too many colons in ID range expression: {resid_str!r}")
+				start_str, end_str = resid_str.split(":")
+				start, end = int(start_str), int(end_str)
 				
 				for res in resources.values():
 					if start <= res.id <= end:
 						matching[res.type, res.id] = res
 			else:
-				resid = int(resid)
+				resid = int(resid_str)
 				try:
 					res = resources[resid]
 				except KeyError:
@@ -155,7 +156,7 @@ def _filter_resources(rf: api.ResourceFile, filters: typing.Sequence[str]) -> ty
 	
 	return list(matching.values())
 
-def _hexdump(data: bytes):
+def hexdump(data: bytes) -> None:
 	last_line = None
 	asterisk_shown = False
 	for i in range(0, len(data), 16):
@@ -177,18 +178,18 @@ def _hexdump(data: bytes):
 	if data:
 		print(f"{len(data):08x}")
 
-def _raw_hexdump(data: bytes):
+def raw_hexdump(data: bytes) -> None:
 	for i in range(0, len(data), 16):
 		print(" ".join(f"{byte:02x}" for byte in data[i:i + 16]))
 
-def _translate_text(data: bytes) -> str:
+def translate_text(data: bytes) -> str:
 	return data.decode(_TEXT_ENCODING).replace("\r", "\n")
 
-def _describe_resource(res: api.Resource, *, include_type: bool, decompress: bool) -> str:
+def describe_resource(res: api.Resource, *, include_type: bool, decompress: bool) -> str:
 	id_desc_parts = [f"{res.id}"]
 	
 	if res.name is not None:
-		name = _bytes_escape(res.name, quote='"')
+		name = bytes_escape(res.name, quote='"')
 		id_desc_parts.append(f'"{name}"')
 	
 	id_desc = ", ".join(id_desc_parts)
@@ -197,16 +198,18 @@ def _describe_resource(res: api.Resource, *, include_type: bool, decompress: boo
 	
 	if decompress and api.ResourceAttrs.resCompressed in res.attributes:
 		try:
-			res.data
+			res.compressed_info
 		except compress.DecompressError:
-			length_desc = f"decompression failed ({len(res.data_raw)} bytes compressed)"
+			length_desc = f"unparseable compressed data header ({res.length_raw} bytes compressed)"
 		else:
-			length_desc = f"{len(res.data)} bytes ({len(res.data_raw)} bytes compressed)"
+			assert res.compressed_info is not None
+			length_desc = f"{res.length} bytes ({res.length_raw} bytes compressed, 'dcmp' ({res.compressed_info.dcmp_id}) format)"
 	else:
-		length_desc = f"{len(res.data_raw)} bytes"
+		assert res.compressed_info is None
+		length_desc = f"{res.length_raw} bytes"
 	content_desc_parts.append(length_desc)
 	
-	attrs = _decompose_flags(res.attributes)
+	attrs = decompose_flags(res.attributes)
 	if attrs:
 		content_desc_parts.append(" | ".join(attr.name for attr in attrs))
 	
@@ -214,11 +217,11 @@ def _describe_resource(res: api.Resource, *, include_type: bool, decompress: boo
 	
 	desc = f"({id_desc}): {content_desc}"
 	if include_type:
-		restype = _bytes_escape(res.type, quote="'")
+		restype = bytes_escape(res.type, quote="'")
 		desc = f"'{restype}' {desc}"
 	return desc
 
-def _parse_args() -> argparse.Namespace:
+def parse_args_old(args: typing.List[str]) -> argparse.Namespace:
 	ap = argparse.ArgumentParser(
 		add_help=False,
 		fromfile_prefix_chars="@",
@@ -254,16 +257,16 @@ def _parse_args() -> argparse.Namespace:
 	ap.add_argument("file", help="The file to read, or - for stdin")
 	ap.add_argument("filter", nargs="*", help="One or more filters to select which resources to display, or omit to show an overview of all resources")
 	
-	ns = ap.parse_args()
+	ns = ap.parse_args(args)
 	return ns
 
-def _show_header_data(data: bytes, *, format: str) -> None:
+def show_header_data(data: bytes, *, format: str) -> None:
 	if format == "dump":
-		_hexdump(data)
+		hexdump(data)
 	elif format == "dump-text":
-		print(_translate_text(data))
+		print(translate_text(data))
 	elif format == "hex":
-		_raw_hexdump(data)
+		raw_hexdump(data)
 	elif format == "raw":
 		sys.stdout.buffer.write(data)
 	elif format == "derez":
@@ -272,7 +275,7 @@ def _show_header_data(data: bytes, *, format: str) -> None:
 	else:
 		raise ValueError(f"Unhandled output format: {format}")
 
-def _show_filtered_resources(resources: typing.Sequence[api.Resource], format: str, decompress: bool) -> None:
+def show_filtered_resources(resources: typing.Sequence[api.Resource], format: str, decompress: bool) -> None:
 	if not resources:
 		if format in ("dump", "dump-text"):
 			print("No resources matched the filter")
@@ -295,19 +298,19 @@ def _show_filtered_resources(resources: typing.Sequence[api.Resource], format: s
 		
 		if format in ("dump", "dump-text"):
 			# Human-readable info and hex or text dump
-			desc = _describe_resource(res, include_type=True, decompress=decompress)
+			desc = describe_resource(res, include_type=True, decompress=decompress)
 			print(f"Resource {desc}:")
 			if format == "dump":
-				_hexdump(data)
+				hexdump(data)
 			elif format == "dump-text":
-				print(_translate_text(data))
+				print(translate_text(data))
 			else:
 				raise AssertionError(f"Unhandled format: {format!r}")
 			print()
 		elif format == "hex":
 			# Data only as hex
 			
-			_raw_hexdump(data)
+			raw_hexdump(data)
 		elif format == "raw":
 			# Data only as raw bytes
 			
@@ -315,7 +318,7 @@ def _show_filtered_resources(resources: typing.Sequence[api.Resource], format: s
 		elif format == "derez":
 			# Like DeRez with no resource definitions
 			
-			attrs = list(_decompose_flags(res.attributes))
+			attrs = list(decompose_flags(res.attributes))
 			
 			if decompress and api.ResourceAttrs.resCompressed in attrs:
 				attrs.remove(api.ResourceAttrs.resCompressed)
@@ -323,19 +326,21 @@ def _show_filtered_resources(resources: typing.Sequence[api.Resource], format: s
 			else:
 				attrs_comment = ""
 			
-			attr_descs = [_REZ_ATTR_NAMES[attr] for attr in attrs]
-			if None in attr_descs:
-				attr_descs[:] = [f"${res.attributes.value:02X}"]
+			attr_descs_with_none = [_REZ_ATTR_NAMES[attr] for attr in attrs]
+			if None in attr_descs_with_none:
+				attr_descs = [f"${res.attributes.value:02X}"]
+			else:
+				attr_descs = typing.cast(typing.List[str], attr_descs_with_none)
 			
 			parts = [str(res.id)]
 			
 			if res.name is not None:
-				name = _bytes_escape(res.name, quote='"')
+				name = bytes_escape(res.name, quote='"')
 				parts.append(f'"{name}"')
 			
 			parts += attr_descs
 			
-			restype = _bytes_escape(res.type, quote="'")
+			restype = bytes_escape(res.type, quote="'")
 			print(f"data '{restype}' ({', '.join(parts)}{attrs_comment}) {{")
 			
 			for i in range(0, len(data), 16):
@@ -358,45 +363,33 @@ def _show_filtered_resources(resources: typing.Sequence[api.Resource], format: s
 		else:
 			raise ValueError(f"Unhandled output format: {format}")
 
-def _list_resource_file(rf: api.ResourceFile, *, sort: bool, group: str, decompress: bool) -> None:
-	if rf.header_system_data != bytes(len(rf.header_system_data)):
-		print("Header system data:")
-		_hexdump(rf.header_system_data)
-	
-	if rf.header_application_data != bytes(len(rf.header_application_data)):
-		print("Header application data:")
-		_hexdump(rf.header_application_data)
-	
-	attrs = _decompose_flags(rf.file_attributes)
-	if attrs:
-		print("File attributes: " + " | ".join(attr.name for attr in attrs))
-	
+def list_resource_file(rf: api.ResourceFile, *, sort: bool, group: str, decompress: bool) -> None:
 	if len(rf) == 0:
 		print("No resources (empty resource file)")
 		return
 	
 	if group == "none":
-		all_resources = []
+		all_resources: typing.List[api.Resource] = []
 		for reses in rf.values():
 			all_resources.extend(reses.values())
 		if sort:
 			all_resources.sort(key=lambda res: (res.type, res.id))
 		print(f"{len(all_resources)} resources:")
 		for res in all_resources:
-			print(_describe_resource(res, include_type=True, decompress=decompress))
+			print(describe_resource(res, include_type=True, decompress=decompress))
 	elif group == "type":
 		print(f"{len(rf)} resource types:")
-		restype_items = rf.items()
+		restype_items: typing.Collection[typing.Tuple[bytes, typing.Mapping[int, api.Resource]]] = rf.items()
 		if sort:
 			restype_items = sorted(restype_items, key=lambda item: item[0])
-		for typecode, resources in restype_items:
-			restype = _bytes_escape(typecode, quote="'")
-			print(f"'{restype}': {len(resources)} resources:")
-			resources_items = resources.items()
+		for typecode, resources_map in restype_items:
+			restype = bytes_escape(typecode, quote="'")
+			print(f"'{restype}': {len(resources_map)} resources:")
+			resources_items: typing.Collection[typing.Tuple[int, api.Resource]] = resources_map.items()
 			if sort:
 				resources_items = sorted(resources_items, key=lambda item: item[0])
 			for resid, res in resources_items:
-				print(_describe_resource(res, include_type=False, decompress=decompress))
+				print(describe_resource(res, include_type=False, decompress=decompress))
 			print()
 	elif group == "id":
 		all_resources = []
@@ -410,16 +403,16 @@ def _list_resource_file(rf: api.ResourceFile, *, sort: bool, group: str, decompr
 			if sort:
 				resources.sort(key=lambda res: res.type)
 			for res in resources:
-				print(_describe_resource(res, include_type=True, decompress=decompress))
+				print(describe_resource(res, include_type=True, decompress=decompress))
 			print()
 	else:
 		raise AssertionError(f"Unhandled group mode: {group!r}")
 
-def main():
-	ns = _parse_args()
+def main_old(args: typing.List[str]) -> typing.NoReturn:
+	ns = parse_args_old(args)
 	
 	if ns.file == "-":
-		if ns.fork is not None:
+		if ns.fork != "auto":
 			print("Cannot specify an explicit fork when reading from stdin", file=sys.stderr)
 			sys.exit(1)
 		
@@ -428,16 +421,260 @@ def main():
 		rf = api.ResourceFile.open(ns.file, fork=ns.fork)
 	
 	with rf:
+		print("Warning: The syntax of the rsrcfork command has changed.", file=sys.stderr)
+		
 		if ns.header_system or ns.header_application:
 			if ns.header_system:
+				print('Please use "rsrcfork read-header --part=system <file>" instead of "rsrcfork --header-system <file>".', file=sys.stderr)
+				print(file=sys.stderr)
+				
 				data = rf.header_system_data
 			else:
+				print('Please use "rsrcfork read-header --part=application <file>" instead of "rsrcfork --header-application <file>".', file=sys.stderr)
+				print(file=sys.stderr)
+				
 				data = rf.header_application_data
 			
-			_show_header_data(data, format=ns.format)
+			show_header_data(data, format=ns.format)
 		elif ns.filter or ns.all:
 			if ns.filter:
-				resources = _filter_resources(rf, ns.filter)
+				print('Please use "rsrcfork read <file> <filters...>" instead of "rsrcfork <file> <filters...>".', file=sys.stderr)
+				print(file=sys.stderr)
+				
+				resources = filter_resources(rf, ns.filter)
+			else:
+				print('Please use "rsrcfork read <file>" instead of "rsrcfork <file> --all".', file=sys.stderr)
+				print(file=sys.stderr)
+				
+				resources = []
+				for reses in rf.values():
+					resources.extend(reses.values())
+			
+			if ns.sort:
+				resources.sort(key=lambda res: (res.type, res.id))
+			
+			show_filtered_resources(resources, format=ns.format, decompress=ns.decompress)
+		else:
+			print('Please use "rsrcfork list <file>" instead of "rsrcfork <file>".', file=sys.stderr)
+			print(file=sys.stderr)
+			
+			if rf.header_system_data != bytes(len(rf.header_system_data)):
+				print("Header system data:")
+				hexdump(rf.header_system_data)
+			
+			if rf.header_application_data != bytes(len(rf.header_application_data)):
+				print("Header application data:")
+				hexdump(rf.header_application_data)
+			
+			attrs = decompose_flags(rf.file_attributes)
+			if attrs:
+				print("File attributes: " + " | ".join(attr.name for attr in attrs))
+			
+			list_resource_file(rf, sort=ns.sort, group=ns.group, decompress=ns.decompress)
+	
+	sys.exit(0)
+
+
+def make_argument_parser(*, description: str, **kwargs: typing.Any) -> argparse.ArgumentParser:
+	"""Create an argparse.ArgumentParser with some slightly modified defaults.
+	
+	This function is used to ensure that all subcommands use the same base configuration for their ArgumentParser.
+	"""
+	
+	ap = argparse.ArgumentParser(
+		formatter_class=argparse.RawDescriptionHelpFormatter,
+		description=textwrap.dedent(description),
+		allow_abbrev=False,
+		add_help=False,
+		**kwargs,
+	)
+	
+	ap.add_argument("--help", action="help", help="Display this help message and exit")
+	
+	return ap
+
+def add_resource_file_args(ap: argparse.ArgumentParser) -> None:
+	"""Define common options/arguments for specifying an input resource file.
+	
+	This includes a positional argument for the resource file's path, and the ``--fork`` option to select which fork of the file to use.
+	"""
+	
+	ap.add_argument("--fork", choices=["auto", "data", "rsrc"], default="auto", help="The fork from which to read the resource file data, or auto to guess. Default: %(default)s")
+	ap.add_argument("file", help="The file from which to read resources, or - for stdin.")
+
+def open_resource_file(file: str, *, fork: str = None) -> api.ResourceFile:
+	"""Open a resource file at the given path, using the specified fork."""
+	
+	if file == "-":
+		if fork != "auto":
+			print("Cannot specify an explicit fork when reading from stdin", file=sys.stderr)
+			sys.exit(1)
+		
+		return api.ResourceFile(sys.stdin.buffer)
+	else:
+		return api.ResourceFile.open(file, fork=fork)
+
+
+def do_read_header(prog: str, args: typing.List[str]) -> typing.NoReturn:
+	"""Read the header data from a resource file."""
+	
+	ap = make_argument_parser(
+		prog=prog,
+		description="""
+		Read and output a resource file's header data.
+		
+		The header data consists of two parts:
+		
+		The system-reserved data is 112 bytes long and used by the Classic Mac OS
+		Finder as temporary storage space. It usually contains parts of the
+		file metadata (name, type/creator code, etc.).
+		
+		The application-specific data is 128 bytes long and is available for use by
+		applications. In practice it usually contains junk data that happened to be in
+		memory when the resource file was written.
+		
+		Mac OS X does not use the header data fields anymore. Resource files written
+		on Mac OS X normally have both parts of the header data set to all zero bytes.
+		""",
+	)
+	
+	ap.add_argument("--format", choices=["dump", "dump-text", "hex", "raw"], default="dump", help="How to output the header data: human-readable info with hex dump (dump) (default), human-readable info with newline-translated data (dump-text), data only as hex (hex), or data only as raw bytes (raw). Default: %(default)s")
+	ap.add_argument("--part", choices=["system", "application", "all"], default="all", help="Which part of the header to read. Default: %(default)s")
+	add_resource_file_args(ap)
+	
+	ns = ap.parse_args(args)
+	
+	with open_resource_file(ns.file, fork=ns.fork) as rf:
+		if ns.format in {"dump", "dump-text"}:
+			if ns.format == "dump":
+				dump_func = hexdump
+			elif ns.format == "dump-text":
+				def dump_func(d):
+					print(translate_text(d))
+			else:
+				raise AssertionError(f"Unhandled --format: {ns.format!r}")
+			
+			if ns.part in {"system", "all"}:
+				print("System-reserved header data:")
+				dump_func(rf.header_system_data)
+			
+			if ns.part in {"application", "all"}:
+				print("Application-specific header data:")
+				dump_func(rf.header_application_data)
+		elif ns.format in {"hex", "raw"}:
+			if ns.part == "system":
+				data = rf.header_system_data
+			elif ns.part == "application":
+				data = rf.header_application_data
+			elif ns.part == "all":
+				data = rf.header_system_data + rf.header_application_data
+			else:
+				raise AssertionError(f"Unhandled --part: {ns.part!r}")
+			
+			if ns.format == "hex":
+				raw_hexdump(data)
+			elif ns.format == "raw":
+				sys.stdout.buffer.write(data)
+			else:
+				raise AssertionError(f"Unhandled --format: {ns.format!r}")
+		else:
+			raise AssertionError(f"Unhandled --format: {ns.format!r}")
+
+def do_info(prog: str, args: typing.List[str]) -> typing.NoReturn:
+	"""Display technical information about the resource file."""
+	
+	ap = make_argument_parser(
+		prog=prog,
+		description="""
+		Display technical information and stats about the resource file.
+		""",
+	)
+	add_resource_file_args(ap)
+	
+	ns = ap.parse_args(args)
+	
+	with open_resource_file(ns.file, fork=ns.fork) as rf:
+		print("System-reserved header data:")
+		hexdump(rf.header_system_data)
+		print()
+		print("Application-specific header data:")
+		hexdump(rf.header_application_data)
+		print()
+		
+		print(f"Resource data starts at {rf.data_offset:#x} and is {rf.data_length:#x} bytes long")
+		print(f"Resource map starts at {rf.map_offset:#x} and is {rf.map_length:#x} bytes long")
+		attrs = decompose_flags(rf.file_attributes)
+		if attrs:
+			attrs_desc = " | ".join(attr.name for attr in attrs)
+		else:
+			attrs_desc = "(none)"
+		print(f"Resource map attributes: {attrs_desc}")
+		print(f"Resource map type list starts at {rf.map_type_list_offset:#x} (relative to map start) and contains {len(rf)} types")
+		print(f"Resource map name list starts at {rf.map_name_list_offset:#x} (relative to map start)")
+
+def do_list(prog: str, args: typing.List[str]) -> typing.NoReturn:
+	"""List the resources in a file."""
+	
+	ap = make_argument_parser(
+		prog=prog,
+		description="""
+		List the resources stored in a resource file.
+		
+		Each resource's type, ID, name (if any), attributes (if any), and data length
+		are displayed. For compressed resources, the compressed and decompressed data
+		length are displayed, as well as the ID of the 'dcmp' resource used to
+		decompress the resource data.
+		
+		If the resource file has any global (resource map) attributes or non-zero
+		header data, they are displayed before the list of resources.
+		""",
+	)
+	
+	ap.add_argument("--no-decompress", action="store_false", dest="decompress", help="Do not parse the data header of compressed resources and only output their compressed length.")
+	ap.add_argument("--group", action="store", choices=["none", "type", "id"], default="type", help="Group resources by type or ID, or disable grouping. Default: %(default)s")
+	ap.add_argument("--no-sort", action="store_false", dest="sort", help="Output resources in the order in which they are stored in the file, instead of sorting them by type and ID.")
+	add_resource_file_args(ap)
+	
+	ns = ap.parse_args(args)
+	
+	with open_resource_file(ns.file, fork=ns.fork) as rf:
+		list_resource_file(rf, sort=ns.sort, group=ns.group, decompress=ns.decompress)
+	
+def do_read(prog: str, args: typing.List[str]) -> typing.NoReturn:
+	"""Read data from resources."""
+	
+	ap = make_argument_parser(
+		prog=prog,
+		description="""
+		Read the data of one or more resources.
+		
+		The resource filters use syntax similar to Rez (resource definition) files.
+		Each filter can have one of the following forms:
+		
+		An unquoted type name (without escapes): TYPE
+		A quoted type name: 'TYPE'
+		A quoted type name and an ID: 'TYPE' (42)
+		A quoted type name and an ID range: 'TYPE' (24:42)
+		A quoted type name and a resource name: 'TYPE' ("foobar")
+		
+		Note that the resource filter syntax uses quotes, parentheses and spaces,
+		which have special meanings in most shells. It is recommended to quote each
+		resource filter (using double quotes) to ensure that it is not interpreted
+		or rewritten by the shell.
+		""",
+	)
+	
+	ap.add_argument("--no-decompress", action="store_false", dest="decompress", help="Do not decompress compressed resources, output the raw compressed resource data.")
+	ap.add_argument("--format", choices=["dump", "dump-text", "hex", "raw", "derez"], default="dump", help="How to output the resources: human-readable info with hex dump (dump), human-readable info with newline-translated data (dump-text), data only as hex (hex), data only as raw bytes (raw), or like DeRez with no resource definitions (derez). Default: %(default)s")
+	ap.add_argument("--no-sort", action="store_false", dest="sort", help="Output resources in the order in which they are stored in the file, instead of sorting them by type and ID.")
+	add_resource_file_args(ap)
+	ap.add_argument("filter", nargs="*", help="One or more filters to select which resources to read. If no filters ae specified, all resources are read.")
+	
+	ns = ap.parse_args(args)
+	
+	with open_resource_file(ns.file, fork=ns.fork) as rf:
+		if ns.filter:
+			resources = filter_resources(rf, ns.filter)
 		else:
 			resources = []
 			for reses in rf.values():
@@ -446,11 +683,114 @@ def main():
 		if ns.sort:
 			resources.sort(key=lambda res: (res.type, res.id))
 		
-			_show_filtered_resources(resources, format=ns.format, decompress=ns.decompress)
-		else:
-			_list_resource_file(rf, sort=ns.sort, group=ns.group, decompress=ns.decompress)
+		show_filtered_resources(resources, format=ns.format, decompress=ns.decompress)
 
-	sys.exit(0)
+
+SUBCOMMANDS = {
+	"read-header": do_read_header,
+	"info": do_info,
+	"list": do_list,
+	"read": do_read,
+}
+
+
+def format_subcommands_help() -> str:
+	"""Return a formatted help text describing the availble subcommands.
+	
+	Because we do not use argparse's native support for subcommands (see comments in main function), the main ArgumentParser's help does not include any information about the subcommands by default, so we have to format and add it ourselves.
+	"""
+	
+	# The list of subcommands is formatted using a "fake" ArgumentParser, which is never actually used to parse any arguments.
+	# The options are chosen so that the help text will only include the subcommands list and epilog, but no usage or any other arguments.
+	fake_ap = argparse.ArgumentParser(
+		usage=argparse.SUPPRESS,
+		epilog=textwrap.dedent("""
+		Most of the above subcommands take additional arguments. Run a subcommand with
+		the option --help for help about the options understood by that subcommand.
+		"""),
+		add_help=False,
+		formatter_class=argparse.RawDescriptionHelpFormatter,
+	)
+	
+	# The subcommands are added as positional arguments to a custom group with the title "subcommands".
+	# Semantically this makes no sense, but it looks right in the formatted help text:
+	# the result is a section "subcommands" with an aligned list of command names and short descriptions.
+	fake_group = fake_ap.add_argument_group(title="subcommands")
+	
+	for name, func in SUBCOMMANDS.items():
+		# Each command's short description is taken from the implementation function's docstring.
+		fake_group.add_argument(name, help=func.__doc__)
+	
+	return fake_ap.format_help()
+
+
+def main() -> typing.NoReturn:
+	"""Main function of the CLI.
+	
+	This function is a valid setuptools entry point. Arguments are passed in sys.argv, and every execution path ends with a sys.exit call. (setuptools entry points are also permitted to return an integer, which will be treated as an exit code. We do not use this feature and instead always call sys.exit ourselves.)
+	"""
+	
+	prog = pathlib.PurePath(sys.argv[0]).name
+	args = sys.argv[1:]
+	
+	# The rsrcfork CLI is structured into subcommands, each implemented in a separate function.
+	# The main function parses the command-line arguments enough to determine which subcommand to call, but leaves parsing of the rest of the arguments to the subcommand itself.
+	# In addition, it detects use of the old, non-subcommand-based CLI syntax, and delegates to the old main function in that case.
+	# This backwards compatibility handling is one of the reasons why we cannot use the subcommand support of argparse or other CLI parsing libraries, so we have to implement most of the subcommand handling ourselves.
+	
+	ap = make_argument_parser(
+		prog=prog,
+		# Custom usage string to make "subcommand ..." show up in the usage, but not as "positional arguments" in the main help text.
+		usage=f"{prog} (--help | --version | subcommand ...)",
+		description="""
+		%(prog)s is a tool for working with Classic Mac OS resource files.
+		Currently this tool can only read resource files; modifying/writing resource
+		files is not supported yet.
+		
+		Note: This tool is intended for human users. The output format is not
+		machine-readable and may change at any time. The command-line syntax usually
+		does not change much across versions, but this should not be relied on.
+		Automated scripts and programs should use the Python API provided by the
+		rsrcfork library, which this tool is a part of.
+		""",
+		# The list of subcommands is shown in the epilog so that it appears under the list of optional arguments.
+		epilog=format_subcommands_help(),
+	)
+	
+	ap.add_argument("--version", action="version", version=__version__, help="Display version information and exit.")
+	
+	# The help of these arguments is set to argparse.SUPPRESS so that they do not cause a mostly useless "positional arguments" list to appear.
+	# If the old, non-subcommand syntax is used, the subcommand argument can actually be a file name.
+	ap.add_argument("subcommand", help=argparse.SUPPRESS)
+	ap.add_argument("args", nargs=argparse.REMAINDER, help=argparse.SUPPRESS)
+	
+	if not args:
+		print(f"{prog}: Missing subcommand.", file=sys.stderr)
+		ap.print_help()
+		sys.exit(2)
+	
+	# First, parse only known arguments from the CLI.
+	# This is so that we can extract the subcommand/file to check if the old CLI syntax was used, without causing CLI syntax errors because of unknown options before the subcommand/file.
+	ns, _ = ap.parse_known_args(args)
+	
+	try:
+		# Check if the subcommand is valid.
+		subcommand_func = SUBCOMMANDS[ns.subcommand]
+	except KeyError:
+		if ns.subcommand == "-" or pathlib.Path(ns.subcommand).exists():
+			# Subcommand is actually a file path.
+			# Call the old main function with the entire unparsed argument list, so that it can be reparsed and handled like in previous versions.
+			main_old(args)
+		else:
+			# Subcommand is invalid and also not a path to an existing file. Display an error.
+			print(f"{prog}: Unknown subcommand: {ns.subcommand}", file=sys.stderr)
+			print(f"Run {prog} --help for a list of available subcommands.", file=sys.stderr)
+			sys.exit(2)
+	else:
+		# Subcommand is valid. Parse the arguments again, this time without allowing unknown arguments before the subcommand.
+		ns = ap.parse_args(args)
+		# Call the looked up subcommand and pass on further arguments.
+		subcommand_func(f"{prog} {ns.subcommand}", ns.args)
 
 if __name__ == "__main__":
 	sys.exit(main())

rsrcfork/api.py

@@ -4,6 +4,7 @@ import enum
 import io
 import os
 import struct
+import types
 import typing
 import warnings
 
@@ -96,20 +97,26 @@ class ResourceAttrs(enum.Flag):
 class Resource(object):
 	"""A single resource from a resource file."""
 	
-	__slots__ = ("type", "id", "name", "attributes", "data_raw", "_data_decompressed")
+	type: bytes
+	id: int
+	name: typing.Optional[bytes]
+	attributes: ResourceAttrs
+	data_raw: bytes
+	_compressed_info: compress.common.CompressedHeaderInfo
+	_data_decompressed: bytes
 	
-	def __init__(self, resource_type: bytes, resource_id: int, name: typing.Optional[bytes], attributes: ResourceAttrs, data_raw: bytes):
+	def __init__(self, resource_type: bytes, resource_id: int, name: typing.Optional[bytes], attributes: ResourceAttrs, data_raw: bytes) -> None:
 		"""Create a new resource with the given type code, ID, name, attributes, and data."""
 		
 		super().__init__()
 		
-		self.type: bytes = resource_type
-		self.id: int = resource_id
-		self.name: typing.Optional[bytes] = name
-		self.attributes: ResourceAttrs = attributes
-		self.data_raw: bytes = data_raw
+		self.type = resource_type
+		self.id = resource_id
+		self.name = name
+		self.attributes = attributes
+		self.data_raw = data_raw
 	
-	def __repr__(self):
+	def __repr__(self) -> str:
 		try:
 			data = self.data
 		except compress.DecompressError:
@@ -138,6 +145,43 @@ class Resource(object):
 		warnings.warn(DeprecationWarning("The resource_id attribute has been deprecated and will be removed in a future version. Please use the id attribute instead."))
 		return self.id
 	
+	@property
+	def compressed_info(self) -> typing.Optional[compress.common.CompressedHeaderInfo]:
+		"""The compressed resource header information, or None if this resource is not compressed.
+		
+		Accessing this attribute may raise a DecompressError if the resource data is compressed and the header could not be parsed. To access the unparsed header data, use the data_raw attribute.
+		"""
+		
+		if ResourceAttrs.resCompressed in self.attributes:
+			try:
+				return self._compressed_info
+			except AttributeError:
+				self._compressed_info = compress.common.CompressedHeaderInfo.parse(self.data_raw)
+				return self._compressed_info
+		else:
+			return None
+	
+	@property
+	def length_raw(self) -> int:
+		"""The length of the raw resource data, which may be compressed.
+		
+		Accessing this attribute may be faster than computing len(self.data_raw) manually.
+		"""
+		
+		return len(self.data_raw)
+	
+	@property
+	def length(self) -> int:
+		"""The length of the resource data. If the resource data is compressed, this is the length of the data after decompression.
+		
+		Accessing this attribute may be faster than computing len(self.data) manually.
+		"""
+		
+		if self.compressed_info is not None:
+			return self.compressed_info.decompressed_length
+		else:
+			return self.length_raw
+	
 	@property
 	def data(self) -> bytes:
 		"""The resource data, decompressed if necessary.
@@ -145,42 +189,46 @@ class Resource(object):
 		Accessing this attribute may raise a DecompressError if the resource data is compressed and could not be decompressed. To access the compressed resource data, use the data_raw attribute.
 		"""
 		
-		if ResourceAttrs.resCompressed in self.attributes:
+		if self.compressed_info is not None:
 			try:
 				return self._data_decompressed
 			except AttributeError:
-				self._data_decompressed = compress.decompress(self.data_raw)
+				self._data_decompressed = compress.decompress_parsed(self.compressed_info, self.data_raw[self.compressed_info.header_length:])
 				return self._data_decompressed
 		else:
 			return self.data_raw
 
-class ResourceFile(collections.abc.Mapping):
+class ResourceFile(typing.Mapping[bytes, typing.Mapping[int, Resource]], typing.ContextManager["ResourceFile"]):
 	"""A resource file reader operating on a byte stream."""
 	
 	# noinspection PyProtectedMember
-	class _LazyResourceMap(collections.abc.Mapping):
+	class _LazyResourceMap(typing.Mapping[int, Resource]):
 		"""Internal class: Lazy mapping of resource IDs to resource objects, returned when subscripting a ResourceFile."""
 		
-		def __init__(self, resfile: "ResourceFile", restype: bytes):
+		_resfile: "ResourceFile"
+		_restype: bytes
+		_submap: typing.Mapping[int, typing.Tuple[int, ResourceAttrs, int]]
+		
+		def __init__(self, resfile: "ResourceFile", restype: bytes) -> None:
 			"""Create a new _LazyResourceMap "containing" all resources in resfile that have the type code restype."""
 			
 			super().__init__()
 			
-			self._resfile: "ResourceFile" = resfile
-			self._restype: bytes = restype
-			self._submap: typing.Mapping[int, typing.Tuple[int, ResourceAttrs, int]] = self._resfile._references[self._restype]
+			self._resfile = resfile
+			self._restype = restype
+			self._submap = self._resfile._references[self._restype]
 		
-		def __len__(self):
+		def __len__(self) -> int:
 			"""Get the number of resources with this type code."""
 			
 			return len(self._submap)
 		
-		def __iter__(self):
+		def __iter__(self) -> typing.Iterator[int]:
 			"""Iterate over the IDs of all resources with this type code."""
 			
 			return iter(self._submap)
 		
-		def __contains__(self, key: int):
+		def __contains__(self, key: object) -> bool:
 			"""Check if a resource with the given ID exists for this type code."""
 			
 			return key in self._submap
@@ -203,14 +251,31 @@ class ResourceFile(collections.abc.Mapping):
 			
 			return Resource(self._restype, key, name, attributes, data)
 		
-		def __repr__(self):
+		def __repr__(self) -> str:
 			if len(self) == 1:
 				return f"<{type(self).__module__}.{type(self).__qualname__} at {id(self):#x} containing one resource: {next(iter(self.values()))}>"
 			else:
 				return f"<{type(self).__module__}.{type(self).__qualname__} at {id(self):#x} containing {len(self)} resources with IDs: {list(self)}>"
 	
+	_close_stream: bool
+	_stream: typing.BinaryIO
+	
+	data_offset: int
+	map_offset: int
+	data_length: int
+	map_length: int
+	header_system_data: bytes
+	header_application_data: bytes
+	
+	map_type_list_offset: int
+	map_name_list_offset: int
+	file_attributes: ResourceFileAttrs
+	
+	_reference_counts: typing.MutableMapping[bytes, int]
+	_references: typing.MutableMapping[bytes, typing.MutableMapping[int, typing.Tuple[int, ResourceAttrs, int]]]
+	
 	@classmethod
-	def open(cls, filename: typing.Union[str, bytes, os.PathLike], *, fork: str="auto", **kwargs) -> "ResourceFile":
+	def open(cls, filename: typing.Union[str, os.PathLike], *, fork: str="auto", **kwargs: typing.Any) -> "ResourceFile":
 		"""Open the file at the given path as a ResourceFile.
 		
 		The fork parameter controls which fork of the file the resource data will be read from. It accepts the following values:
@@ -269,7 +334,7 @@ class ResourceFile(collections.abc.Mapping):
 		else:
 			raise ValueError(f"Unsupported value for the fork parameter: {fork!r}")
 	
-	def __init__(self, stream: typing.io.BinaryIO, *, close: bool=False):
+	def __init__(self, stream: typing.BinaryIO, *, close: bool=False) -> None:
 		"""Create a ResourceFile wrapping the given byte stream.
 		
 		To read resource file data from a bytes object, wrap it in an io.BytesIO.
@@ -283,8 +348,7 @@ class ResourceFile(collections.abc.Mapping):
 		
 		super().__init__()
 		
-		self._close_stream: bool = close
-		self._stream: typing.io.BinaryIO
+		self._close_stream = close
 		if stream.seekable():
 			self._stream = stream
 		else:
@@ -308,7 +372,7 @@ class ResourceFile(collections.abc.Mapping):
 			raise InvalidResourceFileError(f"Attempted to read {byte_count} bytes of data, but only got {len(data)} bytes")
 		return data
 	
-	def _stream_unpack(self, st: struct.Struct) -> typing.Tuple:
+	def _stream_unpack(self, st: struct.Struct) -> tuple:
 		"""Unpack data from the stream according to the struct st. The number of bytes to read is determined using st.size, so variable-sized structs cannot be used with this method."""
 		
 		try:
@@ -316,17 +380,11 @@ class ResourceFile(collections.abc.Mapping):
 		except struct.error as e:
 			raise InvalidResourceFileError(str(e))
 	
-	def _read_header(self):
+	def _read_header(self) -> None:
 		"""Read the resource file header, starting at the current stream position."""
 		
 		assert self._stream.tell() == 0
 		
-		self.data_offset: int
-		self.map_offset: int
-		self.data_length: int
-		self.map_length: int
-		self.header_system_data: bytes
-		self.header_application_data: bytes
 		(
 			self.data_offset,
 			self.map_offset,
@@ -339,25 +397,23 @@ class ResourceFile(collections.abc.Mapping):
 		if self._stream.tell() != self.data_offset:
 			raise InvalidResourceFileError(f"The data offset ({self.data_offset}) should point exactly to the end of the file header ({self._stream.tell()})")
 	
-	def _read_map_header(self):
+	def _read_map_header(self) -> None:
 		"""Read the map header, starting at the current stream position."""
 		
 		assert self._stream.tell() == self.map_offset
 		
-		self.map_type_list_offset: int
-		self.map_name_list_offset: int
 		(
 			_file_attributes,
 			self.map_type_list_offset,
 			self.map_name_list_offset,
 		) = self._stream_unpack(STRUCT_RESOURCE_MAP_HEADER)
 		
-		self.file_attributes: ResourceFileAttrs = ResourceFileAttrs(_file_attributes)
+		self.file_attributes = ResourceFileAttrs(_file_attributes)
 	
-	def _read_all_resource_types(self):
+	def _read_all_resource_types(self) -> None:
 		"""Read all resource types, starting at the current stream position."""
 		
-		self._reference_counts: typing.MutableMapping[bytes, int] = collections.OrderedDict()
+		self._reference_counts = collections.OrderedDict()
 		
 		(type_list_length_m1,) = self._stream_unpack(STRUCT_RESOURCE_TYPE_LIST_HEADER)
 		type_list_length = (type_list_length_m1 + 1) % 0x10000
@@ -371,10 +427,10 @@ class ResourceFile(collections.abc.Mapping):
 			count = (count_m1 + 1) % 0x10000
 			self._reference_counts[resource_type] = count
 	
-	def _read_all_references(self):
+	def _read_all_references(self) -> None:
 		"""Read all resource references, starting at the current stream position."""
 		
-		self._references: typing.MutableMapping[bytes, typing.MutableMapping[int, typing.Tuple[int, ResourceAttrs, int]]] = collections.OrderedDict()
+		self._references = collections.OrderedDict()
 		
 		for resource_type, count in self._reference_counts.items():
 			resmap: typing.MutableMapping[int, typing.Tuple[int, ResourceAttrs, int]] = collections.OrderedDict()
@@ -391,7 +447,7 @@ class ResourceFile(collections.abc.Mapping):
 				
 				resmap[resource_id] = (name_offset, ResourceAttrs(attributes), data_offset)
 	
-	def close(self):
+	def close(self) -> None:
 		"""Close this ResourceFile.
 		
 		If close=True was passed when this ResourceFile was created, the underlying stream's close method is called as well.
@@ -400,23 +456,29 @@ class ResourceFile(collections.abc.Mapping):
 		if self._close_stream:
 			self._stream.close()
 	
-	def __enter__(self):
-		pass
+	def __enter__(self) -> "ResourceFile":
+		return self
 	
-	def __exit__(self, exc_type, exc_val, exc_tb):
+	def __exit__(
+		self,
+		exc_type: typing.Optional[typing.Type[BaseException]],
+		exc_val: typing.Optional[BaseException],
+		exc_tb: typing.Optional[types.TracebackType]
+	) -> typing.Optional[bool]:
 		self.close()
+		return None
 	
-	def __len__(self):
+	def __len__(self) -> int:
 		"""Get the number of resource types in this ResourceFile."""
 		
 		return len(self._references)
 	
-	def __iter__(self):
+	def __iter__(self) -> typing.Iterator[bytes]:
 		"""Iterate over all resource types in this ResourceFile."""
 		
 		return iter(self._references)
 	
-	def __contains__(self, key: bytes):
+	def __contains__(self, key: object) -> bool:
 		"""Check whether this ResourceFile contains any resources of the given type."""
 		
 		return key in self._references
@@ -426,5 +488,5 @@ class ResourceFile(collections.abc.Mapping):
 		
 		return ResourceFile._LazyResourceMap(self, key)
 	
-	def __repr__(self):
+	def __repr__(self) -> str:
 		return f"<{type(self).__module__}.{type(self).__qualname__} at {id(self):#x}, attributes {self.file_attributes}, containing {len(self)} resource types: {list(self)}>"

rsrcfork/compress/__init__.py

@@ -1,97 +1,63 @@
-import struct
+import io
+import typing
 
 from . import dcmp0
 from . import dcmp1
 from . import dcmp2
 
-from .common import DecompressError
+from .common import DecompressError, CompressedHeaderInfo
 
 __all__ = [
+	"CompressedHeaderInfo",
 	"DecompressError",
 	"decompress",
+	"decompress_parsed",
+	"decompress_stream",
+	"decompress_stream_parsed",
 ]
 
-# The signature of all compressed resource data, 0xa89f6572 in hex, or "®üer" in MacRoman.
-COMPRESSED_SIGNATURE = b"\xa8\x9fer"
-# The compression type commonly used for application resources.
-COMPRESSED_TYPE_APPLICATION = 0x0801
-# The compression type commonly used for System file resources.
-COMPRESSED_TYPE_SYSTEM = 0x0901
 
-# Common header for compressed resources of all types.
-# 4 bytes: Signature (see above).
-# 2 bytes: Length of the complete header (this common part and the type-specific part that follows it). (This meaning is just a guess - the field's value is always 0x0012, so there's no way to know for certain what it means.)
-# 2 bytes: Compression type. Known so far: 0x0901 is used in the System file's resources. 0x0801 is used in other files' resources.
-# 4 bytes: Length of the data after decompression.
-STRUCT_COMPRESSED_HEADER = struct.Struct(">4sHHI")
-
-# Header continuation part for an "application" compressed resource.
-# 1 byte: "Working buffer fractional size" - the ratio of the compressed data size to the uncompressed data size, times 256.
-# 1 byte: "Expansion buffer size" - the maximum number of bytes that the data might grow during decompression.
-# 2 bytes: The ID of the 'dcmp' resource that can decompress this resource. Currently only ID 0 is supported.
-# 2 bytes: Reserved (always zero).
-STRUCT_COMPRESSED_APPLICATION_HEADER = struct.Struct(">BBhH")
-
-# Header continuation part for a "system" compressed resource.
-# 2 bytes: The ID of the 'dcmp' resource that can decompress this resource. Currently only ID 2 is supported.
-# 4 bytes: Decompressor-specific parameters.
-STRUCT_COMPRESSED_SYSTEM_HEADER = struct.Struct(">h4s")
+# Maps 'dcmp' IDs to their corresponding Python implementations.
+# Each decompressor has the signature (header_info: CompressedHeaderInfo, stream: typing.BinaryIO, *, debug: bool=False) -> typing.Iterator[bytes].
+DECOMPRESSORS = {
+	0: dcmp0.decompress_stream,
+	1: dcmp1.decompress_stream,
+	2: dcmp2.decompress_stream,
+}
 
 
-def _decompress_application(data: bytes, decompressed_length: int, *, debug: bool=False) -> bytes:
-	working_buffer_fractional_size, expansion_buffer_size, dcmp_id, reserved = STRUCT_COMPRESSED_APPLICATION_HEADER.unpack_from(data)
+def decompress_stream_parsed(header_info: CompressedHeaderInfo, stream: typing.BinaryIO, *, debug: bool=False) -> typing.Iterator[bytes]:
+	"""Decompress compressed resource data from a stream, whose header has already been read and parsed into a CompressedHeaderInfo object."""
+	
+	try:
+		decompress_func = DECOMPRESSORS[header_info.dcmp_id]
+	except KeyError:
+		raise DecompressError(f"Unsupported 'dcmp' ID: {header_info.dcmp_id}")
+	
+	decompressed_length = 0
+	for chunk in decompress_func(header_info, stream, debug=debug):
+		decompressed_length += len(chunk)
+		yield chunk
+	
+	if decompressed_length != header_info.decompressed_length:
+		raise DecompressError(f"Actual length of decompressed data ({decompressed_length}) does not match length stored in resource ({header_info.decompressed_length})")
+
+def decompress_parsed(header_info: CompressedHeaderInfo, data: bytes, *, debug: bool=False) -> bytes:
+	"""Decompress the given compressed resource data, whose header has already been removed and parsed into a CompressedHeaderInfo object."""
+	
+	return b"".join(decompress_stream_parsed(header_info, io.BytesIO(data), debug=debug))
+
+def decompress_stream(stream: typing.BinaryIO, *, debug: bool=False) -> typing.Iterator[bytes]:
+	"""Decompress compressed resource data from a stream."""
+	
+	header_info = CompressedHeaderInfo.parse_stream(stream)
 	
 	if debug:
-		print(f"Working buffer fractional size: {working_buffer_fractional_size} (=> {len(data) * 256 / working_buffer_fractional_size})")
-		print(f"Expansion buffer size: {expansion_buffer_size}")
-	
-	if dcmp_id == 0:
-		decompress_func = dcmp0.decompress
-	elif dcmp_id == 1:
-		decompress_func = dcmp1.decompress
-	else:
-		raise DecompressError(f"Unsupported 'dcmp' ID: {dcmp_id}, expected 0 or 1")
-	
-	if reserved != 0:
-		raise DecompressError(f"Reserved field should be 0, not 0x{reserved:>04x}")
-	
-	return decompress_func(data[STRUCT_COMPRESSED_APPLICATION_HEADER.size:], decompressed_length, debug=debug)
-
-
-def _decompress_system(data: bytes, decompressed_length: int, *, debug: bool=False) -> bytes:
-	dcmp_id, params = STRUCT_COMPRESSED_SYSTEM_HEADER.unpack_from(data)
-	
-	if dcmp_id == 2:
-		decompress_func = dcmp2.decompress
-	else:
-		raise DecompressError(f"Unsupported 'dcmp' ID: {dcmp_id}, expected 2")
-	
-	return decompress_func(data[STRUCT_COMPRESSED_SYSTEM_HEADER.size:], decompressed_length, params, debug=debug)
+		print(f"Compressed resource data header: {header_info}")
 	
+	yield from decompress_stream_parsed(header_info, stream, debug=debug)
 
 def decompress(data: bytes, *, debug: bool=False) -> bytes:
 	"""Decompress the given compressed resource data."""
 	
-	try:
-		signature, header_length, compression_type, decompressed_length = STRUCT_COMPRESSED_HEADER.unpack_from(data)
-	except struct.error:
-		raise DecompressError(f"Invalid header")
-	if signature != COMPRESSED_SIGNATURE:
-		raise DecompressError(f"Invalid signature: {signature!r}, expected {COMPRESSED_SIGNATURE}")
-	if header_length != 0x12:
-		raise DecompressError(f"Unsupported header length: 0x{header_length:>04x}, expected 0x12")
-	
-	if compression_type == COMPRESSED_TYPE_APPLICATION:
-		decompress_func = _decompress_application
-	elif compression_type == COMPRESSED_TYPE_SYSTEM:
-		decompress_func = _decompress_system
-	else:
-		raise DecompressError(f"Unsupported compression type: 0x{compression_type:>04x}")
-	
-	if debug:
-		print(f"Decompressed length: {decompressed_length}")
-	
-	decompressed = decompress_func(data[STRUCT_COMPRESSED_HEADER.size:], decompressed_length, debug=debug)
-	if len(decompressed) != decompressed_length:
-		raise DecompressError(f"Actual length of decompressed data ({len(decompressed)}) does not match length stored in resource ({decompressed_length})")
-	return decompressed
+	return b"".join(decompress_stream(io.BytesIO(data), debug=debug))

rsrcfork/compress/common.py

@@ -1,3 +1,5 @@
+import io
+import struct
 import typing
 
 
@@ -5,19 +7,192 @@ class DecompressError(Exception):
 	"""Raised when resource data decompression fails, because the data is invalid or the compression type is not supported."""
 
 
-def _read_variable_length_integer(data: bytes, position: int) -> typing.Tuple[int, int]:
-	"""Read a variable-length integer starting at the given position in the data, and return the integer as well as the number of bytes consumed.
+# The signature of all compressed resource data, 0xa89f6572 in hex, or "®üer" in MacRoman.
+COMPRESSED_SIGNATURE = b"\xa8\x9fer"
+# The number of the "type 8" compression type. This type is used in the Finder, ResEdit, and some other system files.
+COMPRESSED_TYPE_8 = 0x0801
+# The number of the "type 9" compression type. This type is used in the System file and System 7.5's Installer.
+COMPRESSED_TYPE_9 = 0x0901
+
+# Common header for compressed resources of all types.
+# 4 bytes: Signature (see above).
+# 2 bytes: Length of the complete header (this common part and the type-specific part that follows it). (This meaning is just a guess - the field's value is always 0x0012, so there's no way to know for certain what it means.)
+# 2 bytes: Compression type. Known so far: 0x0801 ("type 8") and 0x0901 ("type 9").
+# 4 bytes: Length of the data after decompression.
+# 6 bytes: Remainder of the header. The exact format varies depending on the compression type.
+STRUCT_COMPRESSED_HEADER = struct.Struct(">4sHHI6s")
+
+# Remainder of header for a "type 8" compressed resource.
+# 1 byte: "Working buffer fractional size" - the ratio of the compressed data size to the uncompressed data size, times 256.
+# 1 byte: "Expansion buffer size" - the maximum number of bytes that the data might grow during decompression.
+# 2 bytes: The ID of the 'dcmp' resource that can decompress this resource. Currently only ID 0 is supported.
+# 2 bytes: Reserved (always zero).
+STRUCT_COMPRESSED_TYPE_8_HEADER = struct.Struct(">BBhH")
+
+# Remainder of header for a "type 9" compressed resource.
+# 2 bytes: The ID of the 'dcmp' resource that can decompress this resource. Currently only ID 2 is supported.
+# 4 bytes: Decompressor-specific parameters.
+STRUCT_COMPRESSED_TYPE_9_HEADER = struct.Struct(">h4s")
+
+
+class CompressedHeaderInfo(object):
+	@classmethod
+	def parse_stream(cls, stream: typing.BinaryIO) -> "CompressedHeaderInfo":
+		try:
+			signature, header_length, compression_type, decompressed_length, remainder = STRUCT_COMPRESSED_HEADER.unpack(stream.read(STRUCT_COMPRESSED_HEADER.size))
+		except struct.error:
+			raise DecompressError(f"Invalid header")
+		if signature != COMPRESSED_SIGNATURE:
+			raise DecompressError(f"Invalid signature: {signature!r}, expected {COMPRESSED_SIGNATURE}")
+		if header_length != 0x12:
+			raise DecompressError(f"Unsupported header length: 0x{header_length:>04x}, expected 0x12")
+		
+		if compression_type == COMPRESSED_TYPE_8:
+			working_buffer_fractional_size, expansion_buffer_size, dcmp_id, reserved = STRUCT_COMPRESSED_TYPE_8_HEADER.unpack(remainder)
+			
+			if reserved != 0:
+				raise DecompressError(f"Reserved field should be 0, not 0x{reserved:>04x}")
+			
+			return CompressedType8HeaderInfo(header_length, compression_type, decompressed_length, dcmp_id, working_buffer_fractional_size, expansion_buffer_size)
+		elif compression_type == COMPRESSED_TYPE_9:
+			dcmp_id, parameters = STRUCT_COMPRESSED_TYPE_9_HEADER.unpack(remainder)
+			
+			return CompressedType9HeaderInfo(header_length, compression_type, decompressed_length, dcmp_id, parameters)
+		else:
+			raise DecompressError(f"Unsupported compression type: 0x{compression_type:>04x}")
+	
+	@classmethod
+	def parse(cls, data: bytes) -> "CompressedHeaderInfo":
+		return cls.parse_stream(io.BytesIO(data))
+	
+	header_length: int
+	compression_type: int
+	decompressed_length: int
+	dcmp_id: int
+	
+	def __init__(self, header_length: int, compression_type: int, decompressed_length: int, dcmp_id: int) -> None:
+		super().__init__()
+		
+		self.header_length = header_length
+		self.compression_type = compression_type
+		self.decompressed_length = decompressed_length
+		self.dcmp_id = dcmp_id
+
+
+class CompressedType8HeaderInfo(CompressedHeaderInfo):
+	working_buffer_fractional_size: int
+	expansion_buffer_size: int
+	
+	def __init__(self, header_length: int, compression_type: int, decompressed_length: int, dcmp_id: int, working_buffer_fractional_size: int, expansion_buffer_size: int) -> None:
+		super().__init__(header_length, compression_type, decompressed_length, dcmp_id)
+		
+		self.working_buffer_fractional_size = working_buffer_fractional_size
+		self.expansion_buffer_size = expansion_buffer_size
+	
+	def __repr__(self) -> str:
+		return f"{type(self).__qualname__}(header_length={self.header_length}, compression_type=0x{self.compression_type:>04x}, decompressed_length={self.decompressed_length}, dcmp_id={self.dcmp_id}, working_buffer_fractional_size={self.working_buffer_fractional_size}, expansion_buffer_size={self.expansion_buffer_size})"
+
+
+class CompressedType9HeaderInfo(CompressedHeaderInfo):
+	parameters: bytes
+	
+	def __init__(self, header_length: int, compression_type: int, decompressed_length: int, dcmp_id: int, parameters: bytes) -> None:
+		super().__init__(header_length, compression_type, decompressed_length, dcmp_id)
+		
+		self.parameters = parameters
+	
+	def __repr__(self) -> str:
+		return f"{type(self).__qualname__}(header_length={self.header_length}, compression_type=0x{self.compression_type:>04x}, decompressed_length={self.decompressed_length}, dcmp_id={self.dcmp_id}, parameters={self.parameters!r})"
+
+
+if typing.TYPE_CHECKING:
+	class PeekableIO(typing.Protocol):
+		"""Minimal protocol for binary IO streams that support the peek method.
+		
+		The peek method is supported by various standard Python binary IO streams, such as io.BufferedReader. If a stream does not natively support the peek method, it may be wrapped using the custom helper function make_peekable.
+		"""
+		
+		def readable(self) -> bool: ...
+		def read(self, size: typing.Optional[int] = ...) -> bytes: ...
+		def peek(self, size: int = ...) -> bytes: ...
+
+
+class _PeekableIOWrapper(object):
+	"""Wrapper class to add peek support to an existing stream. Do not instantiate this class directly, use the make_peekable function instead.
+	
+	Python provides a standard io.BufferedReader class, which supports the peek method. However, according to its documentation, it only supports wrapping io.RawIOBase subclasses, and not streams which are already otherwise buffered.
+	
+	Warning: this class does not perform any buffering of its own, outside of what is required to make peek work. It is strongly recommended to only wrap streams that are already buffered or otherwise fast to read from. In particular, raw streams (io.RawIOBase subclasses) should be wrapped using io.BufferedReader instead.
+	"""
+	
+	_wrapped: typing.BinaryIO
+	_readahead: bytes
+	
+	def __init__(self, wrapped: typing.BinaryIO) -> None:
+		super().__init__()
+		
+		self._wrapped = wrapped
+		self._readahead = b""
+	
+	def readable(self) -> bool:
+		return self._wrapped.readable()
+	
+	def read(self, size: typing.Optional[int] = None) -> bytes:
+		if size is None or size < 0:
+			ret = self._readahead + self._wrapped.read()
+			self._readahead = b""
+		elif size <= len(self._readahead):
+			ret = self._readahead[:size]
+			self._readahead = self._readahead[size:]
+		else:
+			ret = self._readahead + self._wrapped.read(size - len(self._readahead))
+			self._readahead = b""
+		
+		return ret
+	
+	def peek(self, size: int = -1) -> bytes:
+		if not self._readahead:
+			self._readahead = self._wrapped.read(io.DEFAULT_BUFFER_SIZE if size < 0 else size)
+		return self._readahead
+
+
+def make_peekable(stream: typing.BinaryIO) -> "PeekableIO":
+	"""Wrap an arbitrary binary IO stream so that it supports the peek method.
+	
+	The stream is wrapped as efficiently as possible (or not at all if it already supports the peek method). However, in the worst case a custom wrapper class needs to be used, which may not be particularly efficient and only supports a very minimal interface. The only methods that are guaranteed to exist on the returned stream are readable, read, and peek.
+	"""
+	
+	if hasattr(stream, "peek"):
+		# Stream is already peekable, nothing to be done.
+		return typing.cast("PeekableIO", stream)
+	elif isinstance(stream, io.RawIOBase):
+		# Raw IO streams can be wrapped efficiently using BufferedReader.
+		return io.BufferedReader(stream)
+	else:
+		# Other streams need to be wrapped using our custom wrapper class.
+		return _PeekableIOWrapper(stream)
+
+
+def read_exact(stream: typing.BinaryIO, byte_count: int) -> bytes:
+	"""Read byte_count bytes from the stream and raise an exception if too few bytes are read (i. e. if EOF was hit prematurely)."""
+	
+	data = stream.read(byte_count)
+	if len(data) != byte_count:
+		raise DecompressError(f"Attempted to read {byte_count} bytes of data, but only got {len(data)} bytes")
+	return data
+
+def read_variable_length_integer(stream: typing.BinaryIO) -> int:
+	"""Read a variable-length integer from the stream.
 	
 	This variable-length integer format is used by the 0xfe codes in the compression formats used by 'dcmp' (0) and 'dcmp' (1).
 	"""
 	
-	assert len(data) > position
-	if data[position] == 0xff:
-		assert len(data) > position + 4
-		return int.from_bytes(data[position+1:position+5], "big", signed=True), 5
-	elif data[position] >= 0x80:
-		assert len(data) > position + 1
-		data_modified = bytes([(data[position] - 0xc0) & 0xff, data[position+1]])
-		return int.from_bytes(data_modified, "big", signed=True), 2
+	head = read_exact(stream, 1)
+	
+	if head[0] == 0xff:
+		return int.from_bytes(read_exact(stream, 4), "big", signed=True)
+	elif head[0] >= 0x80:
+		data_modified = bytes([(head[0] - 0xc0) & 0xff]) + read_exact(stream, 1)
+		return int.from_bytes(data_modified, "big", signed=True)
 	else:
-		return int.from_bytes(data[position:position+1], "big", signed=True), 1
+		return int.from_bytes(head, "big", signed=True)

rsrcfork/compress/dcmp0.py

@@ -1,3 +1,6 @@
+import io
+import typing
+
 from . import common
 
 # Lookup table for codes in range(0x4b, 0xfe).
@@ -36,94 +39,73 @@ TABLE = [TABLE_DATA[i:i + 2] for i in range(0, len(TABLE_DATA), 2)]
 assert len(TABLE) == len(range(0x4b, 0xfe))
 
 
-def decompress(data: bytes, decompressed_length: int, *, debug: bool=False) -> bytes:
-	"""Decompress compressed data in the format used by 'dcmp' (0)."""
+def decompress_stream_inner(header_info: common.CompressedHeaderInfo, stream: typing.BinaryIO, *, debug: bool=False) -> typing.Iterator[bytes]:
+	"""Internal helper function, implements the main decompression algorithm. Only called from decompress_stream, which performs some extra checks and debug logging."""
 	
-	prev_literals = []
-	decompressed = b""
+	if not isinstance(header_info, common.CompressedType8HeaderInfo):
+		raise common.DecompressError(f"Incorrect header type: {type(header_info).__qualname__}")
 	
-	i = 0
+	prev_literals: typing.List[bytes] = []
 	
-	while i < len(data):
-		byte = data[i]
+	while True: # Loop is terminated when the EOF marker (0xff) is encountered
+		(byte,) = common.read_exact(stream, 1)
 		if debug:
-			print(f"Tag byte 0x{byte:>02x}, at 0x{i:x}, decompressing to 0x{len(decompressed):x}")
+			print(f"Tag byte 0x{byte:>02x}")
 		
 		if byte in range(0x00, 0x20):
 			# Literal byte sequence.
 			if byte in (0x00, 0x10):
 				# The length of the literal data is stored in the next byte.
-				count_div2 = data[i+1]
-				begin = i + 2
+				(count_div2,) = common.read_exact(stream, 1)
 			else:
 				# The length of the literal data is stored in the low nibble of the tag byte.
 				count_div2 = byte >> 0 & 0xf
-				begin = i + 1
-			end = begin + 2*count_div2
+			count = 2 * count_div2
 			# Controls whether or not the literal is stored so that it can be referenced again later.
 			do_store = byte >= 0x10
-			literal = data[begin:end]
+			literal = common.read_exact(stream, count)
 			if debug:
 				print(f"Literal (storing: {do_store})")
-				print(f"\t-> {literal}")
-			decompressed += literal
 			if do_store:
 				if debug:
-					print(f"\t-> stored as literal number 0x{len(prev_literals):x}")
+					print(f"\t-> storing as literal number 0x{len(prev_literals):x}")
 				prev_literals.append(literal)
-			i = end
+			yield literal
 		elif byte in (0x20, 0x21):
 			# Backreference to a previous literal, 2-byte form.
 			# This can reference literals with index in range(0x28, 0x228).
-			table_index = 0x28 + ((byte - 0x20) << 8 | data[i+1])
-			i += 2
+			(next_byte,) = common.read_exact(stream, 1)
+			table_index = 0x28 + ((byte - 0x20) << 8 | next_byte)
 			if debug:
 				print(f"Backreference (2-byte form) to 0x{table_index:>02x}")
-			literal = prev_literals[table_index]
-			if debug:
-				print(f"\t-> {literal}")
-			decompressed += literal
+			yield prev_literals[table_index]
 		elif byte == 0x22:
 			# Backreference to a previous literal, 3-byte form.
 			# This can reference any literal with index 0x28 and higher, but is only necessary for literals with index 0x228 and higher.
-			table_index = 0x28 + int.from_bytes(data[i+1:i+3], "big", signed=False)
-			i += 3
+			table_index = 0x28 + int.from_bytes(common.read_exact(stream, 2), "big", signed=False)
 			if debug:
 				print(f"Backreference (3-byte form) to 0x{table_index:>02x}")
-			literal = prev_literals[table_index]
-			if debug:
-				print(f"\t-> {literal}")
-			decompressed += literal
+			yield prev_literals[table_index]
 		elif byte in range(0x23, 0x4b):
 			# Backreference to a previous literal, 1-byte form.
 			# This can reference literals with indices in range(0x28).
 			table_index = byte - 0x23
-			i += 1
 			if debug:
 				print(f"Backreference (1-byte form) to 0x{table_index:>02x}")
-			literal = prev_literals[table_index]
-			if debug:
-				print(f"\t-> {literal}")
-			decompressed += literal
+			yield prev_literals[table_index]
 		elif byte in range(0x4b, 0xfe):
 			# Reference into a fixed table of two-byte literals.
 			# All compressed resources use the same table.
 			table_index = byte - 0x4b
-			i += 1
 			if debug:
 				print(f"Fixed table reference to 0x{table_index:>02x}")
-			entry = TABLE[table_index]
-			if debug:
-				print(f"\t-> {entry}")
-			decompressed += entry
+			yield TABLE[table_index]
 		elif byte == 0xfe:
 			# Extended code, whose meaning is controlled by the following byte.
 			
-			i += 1
-			kind = data[i]
+			(kind,) = common.read_exact(stream, 1)
 			if debug:
 				print(f"Extended code: 0x{kind:>02x}")
-			i += 1
 			
 			if kind == 0x00:
 				# Compact representation of (part of) a segment loader jump table, as used in 'CODE' (0) resources.
@@ -132,37 +114,28 @@ def decompress(data: bytes, decompressed_length: int, *, debug: bool=False) -> b
 					print(f"Segment loader jump table entries")
 				
 				# All generated jump table entries have the same segment number.
-				segment_number_int, length = common._read_variable_length_integer(data, i)
-				i += length
+				segment_number_int = common.read_variable_length_integer(stream)
 				if debug:
 					print(f"\t-> segment number: {segment_number_int:#x}")
 				
 				# The tail part of all jump table entries (i. e. everything except for the address).
 				entry_tail = b"?<" + segment_number_int.to_bytes(2, "big", signed=True) + b"\xa9\xf0"
-				if debug:
-					print(f"\t-> tail of first entry: {entry_tail}")
 				# The tail is output once *without* an address in front, i. e. the first entry's address must be generated manually by a previous code.
-				decompressed += entry_tail
+				yield entry_tail
 				
-				count, length = common._read_variable_length_integer(data, i)
-				i += length
+				count = common.read_variable_length_integer(stream)
 				if count <= 0:
 					raise common.DecompressError(f"Jump table entry count must be greater than 0, not {count}")
 				
 				# The second entry's address is stored explicitly.
-				current_int, length = common._read_variable_length_integer(data, i)
-				i += length
+				current_int = common.read_variable_length_integer(stream)
 				if debug:
-					print(f"-> address of second entry: {current_int:#x}")
-				entry = current_int.to_bytes(2, "big", signed=False) + entry_tail
-				if debug:
-					print(f"-> second entry: {entry}")
-				decompressed += entry
+					print(f"\t-> address of second entry: {current_int:#x}")
+				yield current_int.to_bytes(2, "big", signed=False) + entry_tail
 				
 				for _ in range(1, count):
 					# All further entries' addresses are stored as differences relative to the previous entry's address.
-					diff, length = common._read_variable_length_integer(data, i)
-					i += length
+					diff = common.read_variable_length_integer(stream)
 					# For some reason, each difference is 6 higher than it should be.
 					diff -= 6
 					
@@ -170,10 +143,7 @@ def decompress(data: bytes, decompressed_length: int, *, debug: bool=False) -> b
 					current_int = (current_int + diff) & 0xffff
 					if debug:
 						print(f"\t-> difference {diff:#x}: {current_int:#x}")
-					entry = current_int.to_bytes(2, "big", signed=False) + entry_tail
-					if debug:
-						print(f"\t-> {entry}")
-					decompressed += entry
+					yield current_int.to_bytes(2, "big", signed=False) + entry_tail
 			elif kind in (0x02, 0x03):
 				# Repeat 1 or 2 bytes a certain number of times.
 				
@@ -188,23 +158,19 @@ def decompress(data: bytes, decompressed_length: int, *, debug: bool=False) -> b
 					print(f"Repeat {byte_count}-byte value")
 				
 				# The byte(s) to repeat, stored as a variable-length integer. The value is treated as unsigned, i. e. the integer is never negative.
-				to_repeat_int, length = common._read_variable_length_integer(data, i)
-				i += length
+				to_repeat_int = common.read_variable_length_integer(stream)
 				try:
 					to_repeat = to_repeat_int.to_bytes(byte_count, "big", signed=False)
 				except OverflowError:
 					raise common.DecompressError(f"Value to repeat out of range for {byte_count}-byte repeat: {to_repeat_int:#x}")
 				
-				count_m1, length = common._read_variable_length_integer(data, i)
-				i += length
-				count = count_m1 + 1
+				count = common.read_variable_length_integer(stream) + 1
 				if count <= 0:
 					raise common.DecompressError(f"Repeat count must be positive: {count}")
 				
-				repeated = to_repeat * count
 				if debug:
-					print(f"\t-> {to_repeat} * {count}: {repeated}")
-				decompressed += repeated
+					print(f"\t-> {to_repeat} * {count}")
+				yield to_repeat * count
 			elif kind == 0x04:
 				# A sequence of 16-bit signed integers, with each integer encoded as a difference relative to the previous integer. The first integer is stored explicitly.
 				
@@ -212,18 +178,16 @@ def decompress(data: bytes, decompressed_length: int, *, debug: bool=False) -> b
 					print(f"Difference-encoded 16-bit integers")
 				
 				# The first integer is stored explicitly, as a signed value.
-				initial_int, length = common._read_variable_length_integer(data, i)
-				i += length
+				initial_int = common.read_variable_length_integer(stream)
 				try:
 					initial = initial_int.to_bytes(2, "big", signed=True)
 				except OverflowError:
 					raise common.DecompressError(f"Initial value out of range for 16-bit integer difference encoding: {initial_int:#x}")
 				if debug:
-					print(f"\t-> initial: {initial}")
-				decompressed += initial
+					print(f"\t-> initial: 0x{initial_int:>04x}")
+				yield initial
 				
-				count, length = common._read_variable_length_integer(data, i)
-				i += length
+				count = common.read_variable_length_integer(stream)
 				if count < 0:
 					raise common.DecompressError(f"Count cannot be negative: {count}")
 				
@@ -232,64 +196,74 @@ def decompress(data: bytes, decompressed_length: int, *, debug: bool=False) -> b
 				for _ in range(count):
 					# The difference to the previous integer is stored as an 8-bit signed integer.
 					# The usual variable-length integer format is *not* used here.
-					diff = int.from_bytes(data[i:i+1], "big", signed=True)
-					i += 1
+					diff = int.from_bytes(common.read_exact(stream, 1), "big", signed=True)
 					
 					# Simulate 16-bit integer wraparound.
 					current_int = (current_int + diff) & 0xffff
-					current = current_int.to_bytes(2, "big", signed=False)
 					if debug:
-						print(f"\t-> difference {diff:#x}: {current}")
-					decompressed += current
+						print(f"\t-> difference {diff:#x}: 0x{current_int:>04x}")
+					yield current_int.to_bytes(2, "big", signed=False)
 			elif kind == 0x06:
 				# A sequence of 32-bit signed integers, with each integer encoded as a difference relative to the previous integer. The first integer is stored explicitly.
 				
 				if debug:
-					print(f"Difference-encoded 16-bit integers")
+					print(f"Difference-encoded 32-bit integers")
 				
 				# The first integer is stored explicitly, as a signed value.
-				initial_int, length = common._read_variable_length_integer(data, i)
-				i += length
+				initial_int = common.read_variable_length_integer(stream)
 				try:
 					initial = initial_int.to_bytes(4, "big", signed=True)
 				except OverflowError:
 					raise common.DecompressError(f"Initial value out of range for 32-bit integer difference encoding: {initial_int:#x}")
 				if debug:
-					print(f"\t-> initial: {initial}")
-				decompressed += initial
+					print(f"\t-> initial: 0x{initial_int:>08x}")
+				yield initial
 				
-				count, length = common._read_variable_length_integer(data, i)
-				i += length
+				count = common.read_variable_length_integer(stream)
 				assert count >= 0
 				
 				# To make the following calculations simpler, the signed initial_int value is converted to unsigned.
 				current_int = initial_int & 0xffffffff
 				for _ in range(count):
 					# The difference to the previous integer is stored as a variable-length integer, whose value may be negative.
-					diff, length = common._read_variable_length_integer(data, i)
-					i += length
+					diff = common.read_variable_length_integer(stream)
 					
 					# Simulate 32-bit integer wraparound.
 					current_int = (current_int + diff) & 0xffffffff
-					current = current_int.to_bytes(4, "big", signed=False)
 					if debug:
-						print(f"\t-> difference {diff:#x}: {current}")
-					decompressed += current
+						print(f"\t-> difference {diff:#x}: 0x{current_int:>08x}")
+					yield current_int.to_bytes(4, "big", signed=False)
 			else:
 				raise common.DecompressError(f"Unknown extended code: 0x{kind:>02x}")
 		elif byte == 0xff:
 			# End of data marker, always occurs exactly once as the last byte of the compressed data.
 			if debug:
 				print("End marker")
-			if i != len(data) - 1:
-				raise common.DecompressError(f"End marker reached at {i}, before the expected end of data at {len(data) - 1}")
-			i += 1
-		else:
-			raise common.DecompressError(f"Unknown tag byte: 0x{data[i]:>02x}")
 			
-	if decompressed_length % 2 != 0 and len(decompressed) == decompressed_length + 1:
+			# Check that there really is no more data left.
+			extra = stream.read(1)
+			if extra:
+				raise common.DecompressError(f"Extra data encountered after end of data marker (first extra byte: {extra})")
+			break
+		else:
+			raise common.DecompressError(f"Unknown tag byte: 0x{byte:>02x}")
+
+def decompress_stream(header_info: common.CompressedHeaderInfo, stream: typing.BinaryIO, *, debug: bool=False) -> typing.Iterator[bytes]:
+	"""Decompress compressed data in the format used by 'dcmp' (0)."""
+		
+	decompressed_length = 0
+	for chunk in decompress_stream_inner(header_info, stream, debug=debug):
+		if debug:
+			print(f"\t-> {chunk}")
+		
+		if header_info.decompressed_length % 2 != 0 and decompressed_length + len(chunk) == header_info.decompressed_length + 1:
 			# Special case: if the decompressed data length stored in the header is odd and one less than the length of the actual decompressed data, drop the last byte.
 			# This is necessary because nearly all codes generate data in groups of 2 or 4 bytes, so it is basically impossible to represent data with an odd length using this compression format.
-		decompressed = decompressed[:-1]
+			decompressed_length += len(chunk) - 1
+			yield chunk[:-1]
+		else:
+			decompressed_length += len(chunk)
+			yield chunk
 		
-	return decompressed
+		if debug:
+			print(f"Decompressed {decompressed_length:#x} bytes so far")

rsrcfork/compress/dcmp1.py

@@ -1,3 +1,6 @@
+import io
+import typing
+
 from . import common
 
 # Lookup table for codes in range(0xd5, 0xfe).
@@ -19,96 +22,75 @@ TABLE = [TABLE_DATA[i:i + 2] for i in range(0, len(TABLE_DATA), 2)]
 assert len(TABLE) == len(range(0xd5, 0xfe))
 
 
-def decompress(data: bytes, decompressed_length: int, *, debug: bool=False) -> bytes:
-	"""Decompress compressed data in the format used by 'dcmp' (1)."""
+def decompress_stream_inner(header_info: common.CompressedHeaderInfo, stream: typing.BinaryIO, *, debug: bool=False) -> typing.Iterator[bytes]:
+	"""Internal helper function, implements the main decompression algorithm. Only called from decompress_stream, which performs some extra checks and debug logging."""
 	
-	prev_literals = []
-	decompressed = b""
+	if not isinstance(header_info, common.CompressedType8HeaderInfo):
+		raise common.DecompressError(f"Incorrect header type: {type(header_info).__qualname__}")
 	
-	i = 0
+	prev_literals: typing.List[bytes] = []
 	
-	while i < len(data):
-		byte = data[i]
+	while True: # Loop is terminated when the EOF marker (0xff) is encountered
+		(byte,) = common.read_exact(stream, 1)
 		if debug:
-			print(f"Tag byte 0x{byte:>02x}, at 0x{i:x}, decompressing to 0x{len(decompressed):x}")
+			print(f"Tag byte 0x{byte:>02x}")
 		
 		if byte in range(0x00, 0x20):
 			# Literal byte sequence, 1-byte header.
 			# The length of the literal data is stored in the low nibble of the tag byte.
 			count = (byte >> 0 & 0xf) + 1
-			begin = i + 1
-			end = begin + count
 			# Controls whether or not the literal is stored so that it can be referenced again later.
 			do_store = byte >= 0x10
-			literal = data[begin:end]
+			literal = common.read_exact(stream, count)
 			if debug:
 				print(f"Literal (1-byte header, storing: {do_store})")
-				print(f"\t-> {literal}")
-			decompressed += literal
 			if do_store:
 				if debug:
-					print(f"\t-> stored as literal number 0x{len(prev_literals):x}")
+					print(f"\t-> storing as literal number 0x{len(prev_literals):x}")
 				prev_literals.append(literal)
-			i = end
+			yield literal
 		elif byte in range(0x20, 0xd0):
 			# Backreference to a previous literal, 1-byte form.
 			# This can reference literals with indices in range(0xb0).
 			table_index = byte - 0x20
-			i += 1
 			if debug:
 				print(f"Backreference (1-byte form) to 0x{table_index:>02x}")
-			literal = prev_literals[table_index]
-			if debug:
-				print(f"\t-> {literal}")
-			decompressed += literal
+			yield prev_literals[table_index]
 		elif byte in (0xd0, 0xd1):
 			# Literal byte sequence, 2-byte header.
 			# The length of the literal data is stored in the following byte.
-			count = data[i+1]
-			begin = i + 2
-			end = begin + count
+			(count,) = common.read_exact(stream, 1)
 			# Controls whether or not the literal is stored so that it can be referenced again later.
 			do_store = byte == 0xd1
-			literal = data[begin:end]
+			literal = common.read_exact(stream, count)
 			if debug:
 				print(f"Literal (2-byte header, storing: {do_store})")
-				print(f"\t-> {literal}")
-			decompressed += literal
 			if do_store:
 				if debug:
-					print(f"\t-> stored as literal number 0x{len(prev_literals):x}")
+					print(f"\t-> storing as literal number 0x{len(prev_literals):x}")
 				prev_literals.append(literal)
-			i = end
+			yield literal
 		elif byte == 0xd2:
 			# Backreference to a previous literal, 2-byte form.
 			# This can reference literals with indices in range(0xb0, 0x1b0).
-			table_index = data[i+1] + 0xb0
-			i += 2
+			(next_byte,) = common.read_exact(stream, 1)
+			table_index = next_byte + 0xb0
 			if debug:
 				print(f"Backreference (2-byte form) to 0x{table_index:>02x}")
-			literal = prev_literals[table_index]
-			if debug:
-				print(f"\t-> {literal}")
-			decompressed += literal
+			yield prev_literals[table_index]
 		elif byte in range(0xd5, 0xfe):
 			# Reference into a fixed table of two-byte literals.
 			# All compressed resources use the same table.
 			table_index = byte - 0xd5
-			i += 1
 			if debug:
 				print(f"Fixed table reference to 0x{table_index:>02x}")
-			entry = TABLE[table_index]
-			if debug:
-				print(f"\t-> {entry}")
-			decompressed += entry
+			yield TABLE[table_index]
 		elif byte == 0xfe:
 			# Extended code, whose meaning is controlled by the following byte.
 			
-			i += 1
-			kind = data[i]
+			(kind,) = common.read_exact(stream, 1)
 			if debug:
 				print(f"Extended code: 0x{kind:>02x}")
-			i += 1
 			
 			if kind == 0x02:
 				# Repeat 1 byte a certain number of times.
@@ -119,33 +101,44 @@ def decompress(data: bytes, decompressed_length: int, *, debug: bool=False) -> b
 					print(f"Repeat {byte_count}-byte value")
 				
 				# The byte(s) to repeat, stored as a variable-length integer. The value is treated as unsigned, i. e. the integer is never negative.
-				to_repeat_int, length = common._read_variable_length_integer(data, i)
-				i += length
+				to_repeat_int = common.read_variable_length_integer(stream)
 				try:
 					to_repeat = to_repeat_int.to_bytes(byte_count, "big", signed=False)
 				except OverflowError:
 					raise common.DecompressError(f"Value to repeat out of range for {byte_count}-byte repeat: {to_repeat_int:#x}")
 				
-				count_m1, length = common._read_variable_length_integer(data, i)
-				i += length
-				count = count_m1 + 1
+				count = common.read_variable_length_integer(stream) + 1
 				if count <= 0:
 					raise common.DecompressError(f"Repeat count must be positive: {count}")
 				
-				repeated = to_repeat * count
 				if debug:
-					print(f"\t-> {to_repeat} * {count}: {repeated}")
-				decompressed += repeated
+					print(f"\t-> {to_repeat} * {count}")
+				yield to_repeat * count
 			else:
 				raise common.DecompressError(f"Unknown extended code: 0x{kind:>02x}")
 		elif byte == 0xff:
 			# End of data marker, always occurs exactly once as the last byte of the compressed data.
 			if debug:
 				print("End marker")
-			if i != len(data) - 1:
-				raise common.DecompressError(f"End marker reached at {i}, before the expected end of data at {len(data) - 1}")
-			i += 1
-		else:
-			raise common.DecompressError(f"Unknown tag byte: 0x{data[i]:>02x}")
 			
-	return decompressed
+			# Check that there really is no more data left.
+			extra = stream.read(1)
+			if extra:
+				raise common.DecompressError(f"Extra data encountered after end of data marker (first extra byte: {extra})")
+			break
+		else:
+			raise common.DecompressError(f"Unknown tag byte: 0x{byte:>02x}")
+
+def decompress_stream(header_info: common.CompressedHeaderInfo, stream: typing.BinaryIO, *, debug: bool=False) -> typing.Iterator[bytes]:
+	"""Decompress compressed data in the format used by 'dcmp' (1)."""
+	
+	decompressed_length = 0
+	for chunk in decompress_stream_inner(header_info, stream, debug=debug):
+		if debug:
+			print(f"\t-> {chunk}")
+		
+		decompressed_length += len(chunk)
+		yield chunk
+		
+		if debug:
+			print(f"Decompressed {decompressed_length:#x} bytes so far")

rsrcfork/compress/dcmp2.py

@@ -1,4 +1,5 @@
 import enum
+import io
 import struct
 import typing
 
@@ -73,68 +74,72 @@ def _split_bits(i: int) -> typing.Tuple[bool, bool, bool, bool, bool, bool, bool
 	)
 
 
-def _decompress_system_untagged(data: bytes, decompressed_length: int, table: typing.Sequence[bytes], *, debug: bool=False) -> bytes:
-	parts = []
-	i = 0
-	while i < len(data):
-		if i == len(data) - 1 and decompressed_length % 2 != 0:
+def _decompress_untagged(stream: "common.PeekableIO", decompressed_length: int, table: typing.Sequence[bytes], *, debug: bool=False) -> typing.Iterator[bytes]:
+	while True: # Loop is terminated when EOF is reached.
+		table_index_data = stream.read(1)
+		if not table_index_data:
+			# End of compressed data.
+			break
+		elif not stream.peek(1) and decompressed_length % 2 != 0:
 			# Special case: if we are at the last byte of the compressed data, and the decompressed data has an odd length, the last byte is a single literal byte, and not a table reference.
 			if debug:
-				print(f"Last byte: {data[-1:]}")
-			parts.append(data[-1:])
+				print(f"Last byte: {table_index_data}")
+			yield table_index_data
 			break
 		
 		# Compressed data is untagged, every byte is a table reference.
+		(table_index,) = table_index_data
 		if debug:
-			print(f"Reference: {data[i]} -> {table[data[i]]}")
-		parts.append(table[data[i]])
-		i += 1
+			print(f"Reference: {table_index} -> {table[table_index]}")
+		yield table[table_index]
 
-	return b"".join(parts)
-
-def _decompress_system_tagged(data: bytes, decompressed_length: int, table: typing.Sequence[bytes], *, debug: bool=False) -> bytes:
-	parts = []
-	i = 0
-	while i < len(data):
-		if i == len(data) - 1 and decompressed_length % 2 != 0:
+def _decompress_tagged(stream: "common.PeekableIO", decompressed_length: int, table: typing.Sequence[bytes], *, debug: bool=False) -> typing.Iterator[bytes]:
+	while True: # Loop is terminated when EOF is reached.
+		tag_data = stream.read(1)
+		if not tag_data:
+			# End of compressed data.
+			break
+		elif not stream.peek(1) and decompressed_length % 2 != 0:
 			# Special case: if we are at the last byte of the compressed data, and the decompressed data has an odd length, the last byte is a single literal byte, and not a tag or a table reference.
 			if debug:
-				print(f"Last byte: {data[-1:]}")
-			parts.append(data[-1:])
+				print(f"Last byte: {tag_data}")
+			yield tag_data
 			break
 		
 		# Compressed data is tagged, each tag byte is followed by 8 table references and/or literals.
-		tag = data[i]
+		(tag,) = tag_data
 		if debug:
 			print(f"Tag: 0b{tag:>08b}")
-		i += 1
 		for is_ref in _split_bits(tag):
 			if is_ref:
 				# This is a table reference (a single byte that is an index into the table).
+				table_index_data = stream.read(1)
+				if not table_index_data:
+					# End of compressed data.
+					break
+				(table_index,) = table_index_data
 				if debug:
-					print(f"Reference: {data[i]} -> {table[data[i]]}")
-				parts.append(table[data[i]])
-				i += 1
+					print(f"Reference: {table_index} -> {table[table_index]}")
+				yield table[table_index]
 			else:
 				# This is a literal (two uncompressed bytes that are literally copied into the output).
-				# Note: if i == len(data)-1, the literal is actually only a single byte long.
-				# This case is handled automatically - the slice extends one byte past the end of the data, and only one byte is returned.
-				if debug:
-					print(f"Literal: {data[i:i+2]}")
-				parts.append(data[i:i + 2])
-				i += 2
-			
-			# If the end of the compressed data is reached in the middle of a chunk, all further tag bits are ignored (they should be zero) and decompression ends.
-			if i >= len(data):
+				literal = stream.read(2)
+				if not literal:
+					# End of compressed data.
 					break
-	
-	return b"".join(parts)
+				# Note: the literal may be only a single byte long if it is located exactly at EOF. This is intended and expected - the 1-byte literal is yielded normally, and on the next iteration, decompression is terminated as EOF is detected.
+				if debug:
+					print(f"Literal: {literal}")
+				yield literal
 
 
-def decompress(data: bytes, decompressed_length: int, parameters: bytes, *, debug: bool=False) -> bytes:
+def decompress_stream(header_info: common.CompressedHeaderInfo, stream: typing.BinaryIO, *, debug: bool=False) -> typing.Iterator[bytes]:
 	"""Decompress compressed data in the format used by 'dcmp' (2)."""
 	
-	unknown, table_count_m1, flags_raw = STRUCT_PARAMETERS.unpack(parameters)
+	if not isinstance(header_info, common.CompressedType9HeaderInfo):
+		raise common.DecompressError(f"Incorrect header type: {type(header_info).__qualname__}")
+	
+	unknown, table_count_m1, flags_raw = STRUCT_PARAMETERS.unpack(header_info.parameters)
 	
 	if debug:
 		print(f"Value of unknown parameter field: 0x{unknown:>04x}")
@@ -152,24 +157,21 @@ def decompress(data: bytes, decompressed_length: int, parameters: bytes, *, debu
 		print(f"Flags: {flags}")
 	
 	if ParameterFlags.CUSTOM_TABLE in flags:
-		table_start = 0
-		data_start = table_start + table_count * 2
 		table = []
-		for i in range(table_start, data_start, 2):
-			table.append(data[i:i + 2])
+		for _ in range(table_count):
+			table.append(common.read_exact(stream, 2))
 		if debug:
 			print(f"Using custom table: {table}")
 	else:
 		if table_count_m1 != 0:
 			raise common.DecompressError(f"table_count_m1 field is {table_count_m1}, but must be zero when the default table is used")
 		table = DEFAULT_TABLE
-		data_start = 0
 		if debug:
 			print("Using default table")
 	
 	if ParameterFlags.TAGGED in flags:
-		decompress_func = _decompress_system_tagged
+		decompress_func = _decompress_tagged
 	else:
-		decompress_func = _decompress_system_untagged
+		decompress_func = _decompress_untagged
 	
-	return decompress_func(data[data_start:], decompressed_length, table, debug=debug)
+	yield from decompress_func(common.make_peekable(stream), header_info.decompressed_length, table, debug=debug)

setup.cfg

@@ -36,9 +36,28 @@ keywords =
 setup_requires =
 	setuptools>=39.2.0
 python_requires = >=3.6
-packages =
+packages = find:
+
+[options.packages.find]
+include =
 	rsrcfork
+	rsrcfork.*
 
 [options.entry_points]
 console_scripts =
 	rsrcfork = rsrcfork.__main__:main
+
+[mypy]
+files=rsrcfork/**/*.py
+python_version = 3.6
+
+disallow_untyped_calls = True
+disallow_untyped_defs = True
+disallow_untyped_decorators = True
+
+no_implicit_optional = True
+
+warn_unused_ignores = True
+warn_unreachable = True
+
+warn_redundant_casts = True