archive_r_ruby 0.1.21 → 0.1.22

data/ext/archive_r/extconf.rb

@@ -1,125 +1,125 @@
-# SPDX-License-Identifier: MIT
-# Copyright (c) 2025 archive_r Team
-
-require 'mkmf'
-
-def archive_r_core_root
-  candidates = []
-
-  env_root = ENV['ARCHIVE_R_CORE_ROOT']
-  candidates << File.expand_path(env_root) if env_root && !env_root.empty?
-
-  repo_root = File.expand_path('../../../..', __dir__)
-  candidates << repo_root
-
-  vendor_root = File.expand_path('vendor/archive_r', __dir__)
-  candidates << vendor_root
-
-  candidates.each do |root|
-    next unless root
-    include_dir = File.join(root, 'include')
-    src_dir = File.join(root, 'src')
-    return root if Dir.exist?(include_dir) && Dir.exist?(src_dir)
-  end
-
-  nil
-end
-archive_r_root = archive_r_core_root
-
-unless archive_r_root
-  abort <<~MSG
-    archive_r core library not found.
-    Please set ARCHIVE_R_CORE_ROOT to a repository checkout or use the vendored gem package.
-  MSG
-end
-
-vendor_root = File.expand_path('vendor/archive_r', __dir__)
-
-if archive_r_root == vendor_root
-  puts 'Using vendored archive_r core sources'
-elsif ENV['ARCHIVE_R_CORE_ROOT'] && File.expand_path(ENV['ARCHIVE_R_CORE_ROOT']) == archive_r_root
-  puts "Using archive_r core from #{archive_r_root} (ARCHIVE_R_CORE_ROOT)"
-else
-  puts "Using archive_r core from #{archive_r_root}"
-end
-
-archive_r_include = File.join(archive_r_root, 'include')
-archive_r_src = File.join(archive_r_root, 'src')
-archive_r_lib_dir = File.join(archive_r_root, 'build')
-archive_r_local_libs = File.expand_path('.libs', __dir__)
-glue_source = File.join(__dir__, 'archive_r_ext.cc')
-
-# Ensure make can locate vendored sources via VPATH
-$VPATH ||= ''
-unless $VPATH.empty?
-  $VPATH << File::PATH_SEPARATOR
-end
-$VPATH << archive_r_src
-
-# Add include paths
-$INCFLAGS << " -I#{archive_r_include}"
-$INCFLAGS << " -I#{archive_r_src}"
-$LIBPATH.unshift(archive_r_local_libs)
-
-unless Gem.win_platform?
-  $LDFLAGS << ' -Wl,-rpath,$ORIGIN/.libs'
-end
-
-# C++17 standard
-$CXXFLAGS << " -std=c++17"
-
-# Configure libarchive paths from environment variables
-if ENV['LIBARCHIVE_ROOT']
-  root = File.expand_path(ENV['LIBARCHIVE_ROOT'])
-  $INCFLAGS << " -I#{File.join(root, 'include')}"
-  $LIBPATH.unshift(File.join(root, 'lib'))
-end
-
-if ENV['LIBARCHIVE_INCLUDE_DIRS']
-  ENV['LIBARCHIVE_INCLUDE_DIRS'].split(File::PATH_SEPARATOR).each do |dir|
-    $INCFLAGS << " -I#{dir}"
-  end
-end
-
-if ENV['LIBARCHIVE_LIBRARY_DIRS']
-  ENV['LIBARCHIVE_LIBRARY_DIRS'].split(File::PATH_SEPARATOR).each do |dir|
-    $LIBPATH.unshift(dir)
-  end
-end
-
-# Check for libarchive
-unless have_library('archive') || have_library('libarchive')
-  abort "libarchive is required but not found"
-end
-
-shared_candidates = [
-  File.join(archive_r_lib_dir, 'libarchive_r_core.so'),
-  File.join(archive_r_lib_dir, 'libarchive_r_core.dylib'),
-  File.join(archive_r_lib_dir, 'archive_r_core.dll'),
-  File.join(archive_r_lib_dir, 'archive_r_core.lib'),
-  File.join(archive_r_lib_dir, 'Release', 'archive_r_core.dll'),
-  File.join(archive_r_lib_dir, 'Release', 'archive_r_core.lib'),
-  File.join(archive_r_local_libs, 'libarchive_r_core.so'),
-  File.join(archive_r_local_libs, 'libarchive_r_core.dylib'),
-  File.join(archive_r_local_libs, 'archive_r_core.dll'),
-]
-
-found_shared = shared_candidates.find { |path| File.exist?(path) }
-
-if found_shared
-  $LIBPATH.unshift(File.dirname(found_shared))
-  $libs = "-larchive_r_core #{$libs}"
-  puts "Using pre-built shared archive_r core: #{found_shared}"
-else
-  puts "Pre-built shared library not found, will build from source"
-  srcs = [glue_source] + Dir.glob(File.join(archive_r_src, '*.cc'))
-  $srcs = srcs
-end
-
-# Guarantee the Ruby glue source is part of the compilation list when $srcs is set
-if defined?($srcs) && $srcs
-  $srcs.unshift(glue_source) unless $srcs.include?(glue_source)
-end
-
-# Create Makefile
-create_makefile('archive_r/archive_r')
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2025 archive_r Team
+
+require 'mkmf'
+
+def archive_r_core_root
+  candidates = []
+
+  env_root = ENV['ARCHIVE_R_CORE_ROOT']
+  candidates << File.expand_path(env_root) if env_root && !env_root.empty?
+
+  repo_root = File.expand_path('../../../..', __dir__)
+  candidates << repo_root
+
+  vendor_root = File.expand_path('vendor/archive_r', __dir__)
+  candidates << vendor_root
+
+  candidates.each do |root|
+    next unless root
+    include_dir = File.join(root, 'include')
+    src_dir = File.join(root, 'src')
+    return root if Dir.exist?(include_dir) && Dir.exist?(src_dir)
+  end
+
+  nil
+end
+archive_r_root = archive_r_core_root
+
+unless archive_r_root
+  abort <<~MSG
+    archive_r core library not found.
+    Please set ARCHIVE_R_CORE_ROOT to a repository checkout or use the vendored gem package.
+  MSG
+end
+
+vendor_root = File.expand_path('vendor/archive_r', __dir__)
+
+if archive_r_root == vendor_root
+  puts 'Using vendored archive_r core sources'
+elsif ENV['ARCHIVE_R_CORE_ROOT'] && File.expand_path(ENV['ARCHIVE_R_CORE_ROOT']) == archive_r_root
+  puts "Using archive_r core from #{archive_r_root} (ARCHIVE_R_CORE_ROOT)"
+else
+  puts "Using archive_r core from #{archive_r_root}"
+end
+
+archive_r_include = File.join(archive_r_root, 'include')
+archive_r_src = File.join(archive_r_root, 'src')
+archive_r_lib_dir = File.join(archive_r_root, 'build')
+archive_r_local_libs = File.expand_path('.libs', __dir__)
+glue_source = File.join(__dir__, 'archive_r_ext.cc')
+
+# Ensure make can locate vendored sources via VPATH
+$VPATH ||= ''
+unless $VPATH.empty?
+  $VPATH << File::PATH_SEPARATOR
+end
+$VPATH << archive_r_src
+
+# Add include paths
+$INCFLAGS << " -I#{archive_r_include}"
+$INCFLAGS << " -I#{archive_r_src}"
+$LIBPATH.unshift(archive_r_local_libs)
+
+unless Gem.win_platform?
+  $LDFLAGS << ' -Wl,-rpath,$ORIGIN/.libs'
+end
+
+# C++17 standard
+$CXXFLAGS << " -std=c++17"
+
+# Configure libarchive paths from environment variables
+if ENV['LIBARCHIVE_ROOT']
+  root = File.expand_path(ENV['LIBARCHIVE_ROOT'])
+  $INCFLAGS << " -I#{File.join(root, 'include')}"
+  $LIBPATH.unshift(File.join(root, 'lib'))
+end
+
+if ENV['LIBARCHIVE_INCLUDE_DIRS']
+  ENV['LIBARCHIVE_INCLUDE_DIRS'].split(File::PATH_SEPARATOR).each do |dir|
+    $INCFLAGS << " -I#{dir}"
+  end
+end
+
+if ENV['LIBARCHIVE_LIBRARY_DIRS']
+  ENV['LIBARCHIVE_LIBRARY_DIRS'].split(File::PATH_SEPARATOR).each do |dir|
+    $LIBPATH.unshift(dir)
+  end
+end
+
+# Check for libarchive
+unless have_library('archive') || have_library('libarchive')
+  abort "libarchive is required but not found"
+end
+
+shared_candidates = [
+  File.join(archive_r_lib_dir, 'libarchive_r_core.so'),
+  File.join(archive_r_lib_dir, 'libarchive_r_core.dylib'),
+  File.join(archive_r_lib_dir, 'archive_r_core.dll'),
+  File.join(archive_r_lib_dir, 'archive_r_core.lib'),
+  File.join(archive_r_lib_dir, 'Release', 'archive_r_core.dll'),
+  File.join(archive_r_lib_dir, 'Release', 'archive_r_core.lib'),
+  File.join(archive_r_local_libs, 'libarchive_r_core.so'),
+  File.join(archive_r_local_libs, 'libarchive_r_core.dylib'),
+  File.join(archive_r_local_libs, 'archive_r_core.dll'),
+]
+
+found_shared = shared_candidates.find { |path| File.exist?(path) }
+
+if found_shared
+  $LIBPATH.unshift(File.dirname(found_shared))
+  $libs = "-larchive_r_core #{$libs}"
+  puts "Using pre-built shared archive_r core: #{found_shared}"
+else
+  puts "Pre-built shared library not found, will build from source"
+  srcs = [glue_source] + Dir.glob(File.join(archive_r_src, '*.cc'))
+  $srcs = srcs
+end
+
+# Guarantee the Ruby glue source is part of the compilation list when $srcs is set
+if defined?($srcs) && $srcs
+  $srcs.unshift(glue_source) unless $srcs.include?(glue_source)
+end
+
+# Create Makefile
+create_makefile('archive_r/archive_r')

data/ext/archive_r/vendor/archive_r/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 archive_r Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 archive_r Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/ext/archive_r/vendor/archive_r/NOTICE

@@ -1,116 +1,116 @@
-archive_r Notices
-
-This file contains third-party notices and licensing information for bundled or
-linked components. It does not replace the project license.
-
-For full license texts, see the files under the LICENSES/ directory in this
-repository. Python wheels include these texts under the *.dist-info/licenses/
-directory.
-
-----------------------------------------
-Third-Party Notices
-----------------------------------------
-
-This distribution (notably the Python wheels) bundles and/or dynamically links
-against the following third-party components. Their respective license terms
-apply in addition to the MIT License.
-
-1. libarchive
-	- Purpose: core archive reading and writing functionality for the C++
-	  library and language bindings.
-	- Version (manylinux wheels): 3.7.5
-	- License: New BSD License (https://www.libarchive.org/)
-	- Full license text and notices: LICENSES/libarchive-COPYING
-
-2. pybind11
-	- Purpose: header-only binding generator for the Python extension module.
-	- License: BSD-style License (https://github.com/pybind/pybind11)
-	- Notes: used at build time; not redistributed as a runtime library.
-
-The following components are redistributed only because libarchive (bundled in
-some artifacts such as Python wheels) depends on them at runtime:
-
-3. zlib
-	- Purpose: libarchive dependency providing DEFLATE compression.
-	- License: zlib License (https://zlib.net/zlib_license.html)
-	- Notes: typically provided by the platform runtime (not bundled in wheels).
-
-4. bzip2
-	- Purpose: libarchive dependency providing bzip2 compression support; distributed with archive_r artifacts.
-	- Version (manylinux wheels): 1.0.8
-	- License: BSD-style license (https://sourceware.org/bzip2/)
-	- Full license text and notices: LICENSES/bzip2-LICENSE
-
-5. liblzma (XZ Utils)
-	- Purpose: libarchive dependency providing LZMA/XZ compression; included with archive_r packages.
-	- Version (manylinux wheels): 5.6.2
-	- License: BSD Zero Clause License (0BSD) for liblzma (https://tukaani.org/xz/)
-	- Full license texts and notices: LICENSES/xz-COPYING, LICENSES/xz-COPYING.0BSD
-
-6. libxml2
-	- Purpose: libarchive dependency used for archive formats such as xar; distributed alongside archive_r.
-	- Version (manylinux wheels): 2.13.4
-	- License: MIT-style License (http://xmlsoft.org/)
-	- Full license text and notices: LICENSES/libxml2-Copyright
-
-7. zstd
-	- Purpose: libarchive dependency providing Zstandard compression; shipped within archive_r binaries.
-	- Version (manylinux wheels): 1.5.5
-	- License: BSD License (https://github.com/facebook/zstd)
-	- Full license text and notices: LICENSES/zstd-LICENSE
-
-8. Nettle
-	- Purpose: libarchive dependency providing cryptographic support (macOS/Linux); bundled with archive_r binaries.
-	- Version (manylinux wheels): 3.9.1
-	- License: GNU LGPLv3+ or GNU GPLv2+ (https://www.lysator.liu.se/~nisse/nettle/)
-	- Full license texts and notices: LICENSES/nettle-COPYING.LESSERv3, LICENSES/nettle-COPYINGv2
-
-9. mini-gmp
-	- Purpose: Nettle dependency for arithmetic operations (macOS/Linux); bundled with archive_r binaries.
-	- License: GNU LGPLv3+ or GNU GPLv2+ (https://gmplib.org/)
-
-10. OpenSSL 3
-	- Purpose: libarchive dependency providing cryptographic support (Windows); bundled with archive_r Windows wheels.
-	- License: Apache License 2.0 with OpenSSL exception (https://www.openssl.org/source/license.html)
-
-11. lz4
-	- Purpose: libarchive dependency providing LZ4 compression; shipped with archive_r artifacts when required.
-	- Version (manylinux wheels): 1.10.0
-	- License: BSD 2-Clause (https://github.com/lz4/lz4)
-	- Full license text and notices: LICENSES/lz4-LICENSE
-
-12. libb2 (BLAKE2)
-	- Purpose: libarchive dependency providing BLAKE2 hashing; bundled when archive formats require it.
-	- Version (manylinux wheels): 0.98.1
-	- License: CC0 1.0 Universal (https://github.com/BLAKE2/libb2)
-	- Full license text and notices: LICENSES/libb2-COPYING
-
-13. libattr
-	- Purpose: libarchive dependency providing extended attribute support on POSIX platforms; included in POSIX builds only.
-	- Version (manylinux wheels): 2.5.2
-	- License: LGPL-2.1-or-later for the library (https://savannah.nongnu.org/projects/attr)
-	- Full license text and notices: LICENSES/attr-COPYING.LGPL
-
-14. libacl
-	- Purpose: libarchive dependency providing POSIX ACL support; included in POSIX builds only.
-	- Version (manylinux wheels): 2.3.2
-	- License: LGPL-2.1-or-later for the library (https://savannah.nongnu.org/projects/acl)
-	- Full license text and notices: LICENSES/acl-COPYING.LGPL
-
-15. LLVM OpenMP runtime (libomp)
-	- Purpose: runtime dependency that can be bundled into Linux wheels depending on toolchain and binary dependencies.
-	- License: Apache License 2.0 with LLVM Exceptions (https://llvm.org/)
-	- Full license text and notices: LICENSES/libomp-LICENSE.TXT
-
-----------------------------------------
-Source Availability
-----------------------------------------
-
-For the components redistributed in binary form, the corresponding source code
-can be obtained from the upstream project release pages listed above.
-
-For the manylinux wheel build, exact dependency versions are recorded in:
-	- bindings/python/tools/build-deps-manylinux.sh
-
-Full license texts copied from upstream release archives are stored under:
-	- LICENSES/
+archive_r Notices
+
+This file contains third-party notices and licensing information for bundled or
+linked components. It does not replace the project license.
+
+For full license texts, see the files under the LICENSES/ directory in this
+repository. Python wheels include these texts under the *.dist-info/licenses/
+directory.
+
+----------------------------------------
+Third-Party Notices
+----------------------------------------
+
+This distribution (notably the Python wheels) bundles and/or dynamically links
+against the following third-party components. Their respective license terms
+apply in addition to the MIT License.
+
+1. libarchive
+	- Purpose: core archive reading and writing functionality for the C++
+	  library and language bindings.
+	- Version (manylinux wheels): 3.7.5
+	- License: New BSD License (https://www.libarchive.org/)
+	- Full license text and notices: LICENSES/libarchive-COPYING
+
+2. pybind11
+	- Purpose: header-only binding generator for the Python extension module.
+	- License: BSD-style License (https://github.com/pybind/pybind11)
+	- Notes: used at build time; not redistributed as a runtime library.
+
+The following components are redistributed only because libarchive (bundled in
+some artifacts such as Python wheels) depends on them at runtime:
+
+3. zlib
+	- Purpose: libarchive dependency providing DEFLATE compression.
+	- License: zlib License (https://zlib.net/zlib_license.html)
+	- Notes: typically provided by the platform runtime (not bundled in wheels).
+
+4. bzip2
+	- Purpose: libarchive dependency providing bzip2 compression support; distributed with archive_r artifacts.
+	- Version (manylinux wheels): 1.0.8
+	- License: BSD-style license (https://sourceware.org/bzip2/)
+	- Full license text and notices: LICENSES/bzip2-LICENSE
+
+5. liblzma (XZ Utils)
+	- Purpose: libarchive dependency providing LZMA/XZ compression; included with archive_r packages.
+	- Version (manylinux wheels): 5.6.2
+	- License: BSD Zero Clause License (0BSD) for liblzma (https://tukaani.org/xz/)
+	- Full license texts and notices: LICENSES/xz-COPYING, LICENSES/xz-COPYING.0BSD
+
+6. libxml2
+	- Purpose: libarchive dependency used for archive formats such as xar; distributed alongside archive_r.
+	- Version (manylinux wheels): 2.13.4
+	- License: MIT-style License (http://xmlsoft.org/)
+	- Full license text and notices: LICENSES/libxml2-Copyright
+
+7. zstd
+	- Purpose: libarchive dependency providing Zstandard compression; shipped within archive_r binaries.
+	- Version (manylinux wheels): 1.5.5
+	- License: BSD License (https://github.com/facebook/zstd)
+	- Full license text and notices: LICENSES/zstd-LICENSE
+
+8. Nettle
+	- Purpose: libarchive dependency providing cryptographic support (macOS/Linux); bundled with archive_r binaries.
+	- Version (manylinux wheels): 3.9.1
+	- License: GNU LGPLv3+ or GNU GPLv2+ (https://www.lysator.liu.se/~nisse/nettle/)
+	- Full license texts and notices: LICENSES/nettle-COPYING.LESSERv3, LICENSES/nettle-COPYINGv2
+
+9. mini-gmp
+	- Purpose: Nettle dependency for arithmetic operations (macOS/Linux); bundled with archive_r binaries.
+	- License: GNU LGPLv3+ or GNU GPLv2+ (https://gmplib.org/)
+
+10. OpenSSL 3
+	- Purpose: libarchive dependency providing cryptographic support (Windows); bundled with archive_r Windows wheels.
+	- License: Apache License 2.0 with OpenSSL exception (https://www.openssl.org/source/license.html)
+
+11. lz4
+	- Purpose: libarchive dependency providing LZ4 compression; shipped with archive_r artifacts when required.
+	- Version (manylinux wheels): 1.10.0
+	- License: BSD 2-Clause (https://github.com/lz4/lz4)
+	- Full license text and notices: LICENSES/lz4-LICENSE
+
+12. libb2 (BLAKE2)
+	- Purpose: libarchive dependency providing BLAKE2 hashing; bundled when archive formats require it.
+	- Version (manylinux wheels): 0.98.1
+	- License: CC0 1.0 Universal (https://github.com/BLAKE2/libb2)
+	- Full license text and notices: LICENSES/libb2-COPYING
+
+13. libattr
+	- Purpose: libarchive dependency providing extended attribute support on POSIX platforms; included in POSIX builds only.
+	- Version (manylinux wheels): 2.5.2
+	- License: LGPL-2.1-or-later for the library (https://savannah.nongnu.org/projects/attr)
+	- Full license text and notices: LICENSES/attr-COPYING.LGPL
+
+14. libacl
+	- Purpose: libarchive dependency providing POSIX ACL support; included in POSIX builds only.
+	- Version (manylinux wheels): 2.3.2
+	- License: LGPL-2.1-or-later for the library (https://savannah.nongnu.org/projects/acl)
+	- Full license text and notices: LICENSES/acl-COPYING.LGPL
+
+15. LLVM OpenMP runtime (libomp)
+	- Purpose: runtime dependency that can be bundled into Linux wheels depending on toolchain and binary dependencies.
+	- License: Apache License 2.0 with LLVM Exceptions (https://llvm.org/)
+	- Full license text and notices: LICENSES/libomp-LICENSE.TXT
+
+----------------------------------------
+Source Availability
+----------------------------------------
+
+For the components redistributed in binary form, the corresponding source code
+can be obtained from the upstream project release pages listed above.
+
+For the manylinux wheel build, exact dependency versions are recorded in:
+	- bindings/python/tools/build-deps-manylinux.sh
+
+Full license texts copied from upstream release archives are stored under:
+	- LICENSES/

data/ext/archive_r/vendor/archive_r/include/archive_r/data_stream.h

@@ -1,42 +1,42 @@
-// SPDX-License-Identifier: MIT
-// Copyright (c) 2025 archive_r Team
-
-#pragma once
-
-#include "archive_r/path_hierarchy.h"
-#include "archive_r/platform_compat.h"
-
-#include <cstdint>
-#include <functional>
-#include <memory>
-
-namespace archive_r {
-
-/**
- * @brief Abstract stream interface used by the archive traversal stack
- */
-class IDataStream {
-public:
-  virtual ~IDataStream() = default;
-  virtual ssize_t read(void *buffer, size_t size) = 0;
-  virtual void rewind() = 0;
-  virtual bool at_end() const = 0;
-  virtual int64_t seek(int64_t offset, int whence) { return -1; }
-  virtual int64_t tell() const { return -1; }
-  virtual bool can_seek() const { return false; }
-  virtual PathHierarchy source_hierarchy() const = 0;
-};
-
-using RootStreamFactory = std::function<std::shared_ptr<IDataStream>(const PathHierarchy &)>;
-
-/**
- * @brief Register the default factory used for root PathHierarchy streams
- */
-void set_root_stream_factory(RootStreamFactory factory);
-
-/**
- * @brief Retrieve the currently registered root stream factory
- */
-RootStreamFactory get_root_stream_factory();
-
-} // namespace archive_r
+// SPDX-License-Identifier: MIT
+// Copyright (c) 2025 archive_r Team
+
+#pragma once
+
+#include "archive_r/path_hierarchy.h"
+#include "archive_r/platform_compat.h"
+
+#include <cstdint>
+#include <functional>
+#include <memory>
+
+namespace archive_r {
+
+/**
+ * @brief Abstract stream interface used by the archive traversal stack
+ */
+class IDataStream {
+public:
+  virtual ~IDataStream() = default;
+  virtual ssize_t read(void *buffer, size_t size) = 0;
+  virtual void rewind() = 0;
+  virtual bool at_end() const = 0;
+  virtual int64_t seek(int64_t offset, int whence) { return -1; }
+  virtual int64_t tell() const { return -1; }
+  virtual bool can_seek() const { return false; }
+  virtual PathHierarchy source_hierarchy() const = 0;
+};
+
+using RootStreamFactory = std::function<std::shared_ptr<IDataStream>(const PathHierarchy &)>;
+
+/**
+ * @brief Register the default factory used for root PathHierarchy streams
+ */
+void set_root_stream_factory(RootStreamFactory factory);
+
+/**
+ * @brief Retrieve the currently registered root stream factory
+ */
+RootStreamFactory get_root_stream_factory();
+
+} // namespace archive_r