cabriolet 0.1.2 → 0.2.1

data/lib/cabriolet/hlp/command_handler.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+require_relative "../cli/base_command_handler"
+require_relative "decompressor"
+require_relative "compressor"
+
+module Cabriolet
+  module HLP
+    # Command handler for HLP (Help) format
+    #
+    # This handler implements the unified command interface for HLP files,
+    # wrapping the existing HLP::Decompressor and HLP::Compressor classes.
+    # Supports both QuickHelp and Windows Help formats.
+    #
+    class CommandHandler < Commands::BaseCommandHandler
+      # List HLP file contents
+      #
+      # Displays information about the HLP file including format type,
+      # and lists all contained files with their sizes.
+      #
+      # @param file [String] Path to the HLP file
+      # @param options [Hash] Additional options (unused)
+      # @return [void]
+      def list(file, _options = {})
+        validate_file_exists(file)
+
+        decompressor = Decompressor.new
+        header = decompressor.open(file)
+
+        display_header(header, file)
+        display_files(decompressor, header)
+
+        decompressor.close(header)
+      end
+
+      # Extract files from HLP archive
+      #
+      # Extracts all files from the HLP file to the specified output directory.
+      # Supports both QuickHelp and Windows Help formats.
+      #
+      # @param file [String] Path to the HLP file
+      # @param output_dir [String] Output directory path (default: current directory)
+      # @param options [Hash] Additional options (unused)
+      # @return [void]
+      def extract(file, output_dir = nil, _options = {})
+        validate_file_exists(file)
+
+        output_dir ||= "."
+        output_dir = ensure_output_dir(output_dir)
+
+        decompressor = Decompressor.new
+        header = decompressor.open(file)
+
+        count = decompressor.extract_all(header, output_dir)
+        decompressor.close(header)
+
+        puts "Extracted #{count} file(s) to #{output_dir}"
+      end
+
+      # Create a new HLP archive
+      #
+      # Creates an HLP file from source files using QuickHelp format.
+      #
+      # @param output [String] Output HLP file path
+      # @param files [Array<String>] List of input files to add
+      # @param options [Hash] Additional options
+      # @option options [String] :format HLP format (:quickhelp, :winhelp)
+      # @return [void]
+      # @raise [ArgumentError] if no files specified
+      def create(output, files = [], options = {})
+        raise ArgumentError, "No files specified" if files.empty?
+
+        files.each do |f|
+          raise ArgumentError, "File does not exist: #{f}" unless File.exist?(f)
+        end
+
+        format = parse_format_option(options[:format])
+
+        if format == :winhelp
+          create_winhelp(output, files, options)
+        else
+          create_quickhelp(output, files, options)
+        end
+      end
+
+      # Display detailed HLP file information
+      #
+      # Shows comprehensive information about the HLP structure,
+      # including format type, file count, and metadata.
+      #
+      # @param file [String] Path to the HLP file
+      # @param options [Hash] Additional options (unused)
+      # @return [void]
+      def info(file, _options = {})
+        validate_file_exists(file)
+
+        decompressor = Decompressor.new
+        header = decompressor.open(file)
+
+        display_hlp_info(header, file)
+
+        decompressor.close(header)
+      end
+
+      # Test HLP file integrity
+      #
+      # Verifies the HLP file structure.
+      #
+      # @param file [String] Path to the HLP file
+      # @param options [Hash] Additional options (unused)
+      # @return [void]
+      def test(file, _options = {})
+        validate_file_exists(file)
+
+        decompressor = Decompressor.new
+        header = decompressor.open(file)
+
+        puts "Testing #{file}..."
+        # TODO: Implement full integrity testing
+        format_name = if header.respond_to?(:version)
+                        version_value = header.version
+                        # Convert BinData objects to integer for comparison
+                        version_int = version_value.to_i if version_value.respond_to?(:to_i)
+
+                        if version_value.is_a?(Integer) || version_int&.positive?
+                          "QUICKHELP v#{version_value}"
+                        elsif version_value.is_a?(Symbol)
+                          version_value.to_s.upcase.sub("WINHELP", "WinHelp ")
+                        else
+                          "unknown"
+                        end
+                      end
+        puts "OK: HLP file structure is valid (#{format_name} format)"
+
+        decompressor.close(header)
+      end
+
+      private
+
+      # Display HLP header information
+      #
+      # @param header [Object] The HLP header object
+      # @param file [String] Original file path
+      # @return [void]
+      def display_header(header, file)
+        format_name = if header.respond_to?(:version)
+                        version_value = header.version
+                        # Convert BinData objects to integer for comparison
+                        version_int = version_value.to_i if version_value.respond_to?(:to_i)
+
+                        if version_value.is_a?(Integer) || version_int&.positive?
+                          "QUICKHELP v#{version_value}"
+                        elsif header.version.is_a?(Symbol)
+                          header.version.to_s.upcase.sub("WINHELP", "WinHelp ")
+                        else
+                          header.version.to_s
+                        end
+                      end
+        puts "HLP File: #{file}"
+        puts "Format: #{format_name || 'unknown'}"
+        puts "\nFiles:"
+      end
+
+      # Display list of files in HLP
+      #
+      # @param decompressor [Decompressor] The decompressor instance
+      # @param header [Object] The HLP header object
+      # @return [void]
+      def display_files(_decompressor, header)
+        if header.respond_to?(:files)
+          header.files.each do |f|
+            puts "  #{f.filename} (#{f.length} bytes)"
+          end
+        else
+          puts "  (File listing not available for this format)"
+        end
+      end
+
+      # Display comprehensive HLP information
+      #
+      # @param header [Object] The HLP header object
+      # @param file [String] Original file path
+      # @return [void]
+      def display_hlp_info(header, file)
+        puts "HLP File Information"
+        puts "=" * 50
+        puts "Filename: #{file}"
+
+        if header.respond_to?(:version)
+          version_value = header.version
+          # Convert BinData objects to integer for comparison
+          version_int = version_value.to_i if version_value.respond_to?(:to_i)
+
+          format_name = if version_value.is_a?(Integer) || version_int&.positive?
+                          "QUICKHELP v#{version_value}"
+                        elsif version_value.is_a?(Symbol)
+                          version_value.to_s.upcase.sub("WINHELP", "WinHelp ")
+                        else
+                          version_value.to_s
+                        end
+          puts "Format: #{format_name}"
+        end
+
+        if header.respond_to?(:length)
+          puts "Size: #{header.length} bytes"
+        end
+
+        if header.respond_to?(:files)
+          puts "Files: #{header.files.size}"
+          puts ""
+          puts "Files:"
+          header.files.each do |f|
+            puts "  #{f.filename}"
+            puts "    Size: #{f.length} bytes"
+          end
+        end
+      end
+
+      # Create QuickHelp format HLP file
+      #
+      # @param output [String] Output file path
+      # @param files [Array<String>] Input files
+      # @param options [Hash] Additional options
+      # @return [void]
+      def create_quickhelp(output, files, _options)
+        compressor = Compressor.new
+
+        files.each do |f|
+          # Default: add files with compression
+          archive_name = File.basename(f)
+          compressor.add_file(f, "/#{archive_name}", compress: true)
+        end
+
+        puts "Creating #{output} with #{files.size} file(s) (QuickHelp format)" if verbose?
+        bytes = compressor.generate(output)
+        puts "Created #{output} (#{bytes} bytes, #{files.size} files)"
+      end
+
+      # Create Windows Help format HLP file
+      #
+      # @param output [String] Output file path
+      # @param files [Array<String>] Input files
+      # @param options [Hash] Additional options
+      # @return [void]
+      def create_winhelp(output, files, _options)
+        compressor = Compressor.create_winhelp
+
+        files.each do |f|
+          archive_name = File.basename(f)
+          # WinHelp compression uses different API
+          compressor.add_file(f, "/#{archive_name}")
+        end
+
+        puts "Creating #{output} with #{files.size} file(s) (WinHelp format)" if verbose?
+        bytes = compressor.generate(output)
+        puts "Created #{output} (#{bytes} bytes, #{files.size} files)"
+      end
+
+      # Parse format option to symbol
+      #
+      # @param format_value [String, Symbol] The format type
+      # @return [Symbol] The format symbol
+      def parse_format_option(format_value)
+        return :quickhelp if format_value.nil?
+
+        format = format_value.to_sym
+        valid_formats = %i[quickhelp winhelp]
+
+        # Map :hlp to default :quickhelp format
+        format = :quickhelp if format == :hlp
+
+        unless valid_formats.include?(format)
+          raise ArgumentError,
+                "Invalid HLP format: #{format_value}. " \
+                "Valid options: #{valid_formats.join(', ')}"
+        end
+
+        format
+      end
+    end
+  end
+end

data/lib/cabriolet/hlp/compressor.rb

@@ -1,271 +1,61 @@
 # frozen_string_literal: true
 
+require_relative "quickhelp/compressor"
+require_relative "winhelp/compressor"
+
 module Cabriolet
   module HLP
-    # Compressor creates HLP (Windows Help) compressed archives
-    #
-    # HLP files contain an internal file system where files can be compressed
-    # using LZSS MODE_MSHELP compression. The compressor builds the archive
-    # structure and compresses files as needed.
+    # Main compressor for HLP files
     #
-    # NOTE: This implementation is based on the knowledge that HLP files use
-    # LZSS compression with MODE_MSHELP, but cannot be fully validated due to
-    # lack of test fixtures and incomplete libmspack implementation.
+    # Creates HLP files in either QuickHelp or Windows Help format.
+    # By default, uses QuickHelp format for compatibility.
     class Compressor
       attr_reader :io_system
 
-      # Default buffer size for I/O operations
-      DEFAULT_BUFFER_SIZE = 2048
-
-      # Initialize a new HLP compressor
+      # Initialize compressor
       #
-      # @param io_system [System::IOSystem, nil] Custom I/O system or nil for
-      #   default
+      # @param io_system [System::IOSystem, nil] Custom I/O system or nil for default
       def initialize(io_system = nil)
         @io_system = io_system || System::IOSystem.new
-        @files = []
+        @quickhelp = QuickHelp::Compressor.new(@io_system)
       end
 
-      # Add a file to the HLP archive
+      # Add a file to the archive
       #
       # @param source_path [String] Path to source file
-      # @param hlp_path [String] Path within HLP archive
-      # @param compress [Boolean] Whether to compress the file
+      # @param hlp_path [String] Path within archive
+      # @param compress [Boolean] Whether to compress
       # @return [void]
       def add_file(source_path, hlp_path, compress: true)
-        @files << {
-          source: source_path,
-          hlp_path: hlp_path,
-          compress: compress,
-        }
+        @quickhelp.add_file(source_path, hlp_path, compress: compress)
       end
 
-      # Add data from memory to the HLP archive
+      # Add data from memory
       #
       # @param data [String] Data to add
-      # @param hlp_path [String] Path within HLP archive
-      # @param compress [Boolean] Whether to compress the data
+      # @param hlp_path [String] Path within archive
+      # @param compress [Boolean] Whether to compress
       # @return [void]
       def add_data(data, hlp_path, compress: true)
-        @files << {
-          data: data,
-          hlp_path: hlp_path,
-          compress: compress,
-        }
+        @quickhelp.add_data(data, hlp_path, compress: compress)
       end
 
-      # Generate HLP archive
+      # Generate HLP archive (QuickHelp format by default)
       #
-      # @param output_file [String] Path to output HLP file
-      # @param options [Hash] Compression options
-      # @option options [Integer] :version HLP format version (default: 1)
-      # @return [Integer] Bytes written to output file
-      # @raise [Errors::CompressionError] if compression fails
+      # @param output_file [String] Output file path
+      # @param options [Hash] Format options
+      # @return [Integer] Bytes written
       def generate(output_file, **options)
-        version = options.fetch(:version, 1)
-
-        output_handle = @io_system.open(output_file, Constants::MODE_WRITE)
-
-        begin
-          # Compress all files and collect metadata
-          compressed_files = compress_all_files
-
-          # Calculate directory size first
-          directory_size = calculate_directory_size(compressed_files)
-
-          # Calculate offsets
-          header_size = 18 # Header structure size
-          directory_offset = header_size
-          data_offset = header_size + directory_size
-
-          # Assign file offsets
-          current_offset = data_offset
-          compressed_files.each do |file_info|
-            file_info[:offset] = current_offset
-            current_offset += file_info[:compressed_data].bytesize
-          end
-
-          # Write header
-          header_bytes = write_header(
-            output_handle,
-            version,
-            compressed_files.size,
-            directory_offset,
-          )
-
-          # Write directory
-          directory_bytes = write_directory(output_handle, compressed_files)
-
-          # Write file data
-          data_bytes = write_file_data(output_handle, compressed_files)
-
-          header_bytes + directory_bytes + data_bytes
-        ensure
-          @io_system.close(output_handle) if output_handle
-        end
-      end
-
-      private
-
-      # Compress all files and collect metadata
-      #
-      # @return [Array<Hash>] Array of file information hashes
-      def compress_all_files
-        @files.map do |file_spec|
-          compress_file_spec(file_spec)
-        end
-      end
-
-      # Compress a single file specification
-      #
-      # @param file_spec [Hash] File specification
-      # @return [Hash] File information with compressed data
-      def compress_file_spec(file_spec)
-        # Get source data
-        data = file_spec[:data] || read_file_data(file_spec[:source])
-
-        # Compress if requested
-        compressed_data = if file_spec[:compress]
-                            compress_data_lzss(data)
-                          else
-                            data
-                          end
-
-        {
-          hlp_path: file_spec[:hlp_path],
-          uncompressed_size: data.bytesize,
-          compressed_data: compressed_data,
-          compressed: file_spec[:compress],
-        }
-      end
-
-      # Read file data from disk
-      #
-      # @param filename [String] Path to file
-      # @return [String] File contents
-      def read_file_data(filename)
-        handle = @io_system.open(filename, Constants::MODE_READ)
-        begin
-          data = +""
-          loop do
-            chunk = @io_system.read(handle, DEFAULT_BUFFER_SIZE)
-            break if chunk.empty?
-
-            data << chunk
-          end
-          data
-        ensure
-          @io_system.close(handle)
-        end
-      end
-
-      # Compress data using LZSS MODE_MSHELP
-      #
-      # @param data [String] Data to compress
-      # @return [String] Compressed data
-      def compress_data_lzss(data)
-        input_handle = System::MemoryHandle.new(data)
-        output_handle = System::MemoryHandle.new("", Constants::MODE_WRITE)
-
-        compressor = Compressors::LZSS.new(
-          @io_system,
-          input_handle,
-          output_handle,
-          DEFAULT_BUFFER_SIZE,
-          Compressors::LZSS::MODE_MSHELP,
-        )
-
-        compressor.compress
-        output_handle.data
-      end
-
-      # Calculate directory size
-      #
-      # @param compressed_files [Array<Hash>] Compressed file information
-      # @return [Integer] Directory size in bytes
-      def calculate_directory_size(compressed_files)
-        size = 0
-        compressed_files.each do |file_info|
-          # 4 bytes for filename length
-          # N bytes for filename
-          # 4 + 4 + 4 + 1 = 13 bytes for file metadata
-          size += 4 + file_info[:hlp_path].bytesize + 13
-        end
-        size
-      end
-
-      # Write HLP header
-      #
-      # @param output_handle [System::FileHandle] Output file handle
-      # @param version [Integer] Format version
-      # @param file_count [Integer] Number of files
-      # @param directory_offset [Integer] Offset to directory
-      # @return [Integer] Number of bytes written
-      def write_header(output_handle, version, file_count, directory_offset)
-        header = Binary::HLPStructures::Header.new
-        header.signature = Binary::HLPStructures::SIGNATURE
-        header.version = version
-        header.file_count = file_count
-        header.directory_offset = directory_offset
-
-        header_data = header.to_binary_s
-        written = @io_system.write(output_handle, header_data)
-
-        unless written == header_data.bytesize
-          raise Errors::CompressionError,
-                "Failed to write HLP header"
-        end
-
-        written
-      end
-
-      # Write file directory
-      #
-      # @param output_handle [System::FileHandle] Output file handle
-      # @param compressed_files [Array<Hash>] Compressed file information
-      # @return [Integer] Number of bytes written
-      def write_directory(output_handle, compressed_files)
-        bytes_written = 0
-
-        compressed_files.each do |file_info|
-          # Write filename length
-          filename = file_info[:hlp_path].b
-          length_data = [filename.bytesize].pack("V")
-          bytes_written += @io_system.write(output_handle, length_data)
-
-          # Write filename
-          bytes_written += @io_system.write(output_handle, filename)
-
-          # Write file metadata
-          metadata = [
-            file_info[:offset],
-            file_info[:uncompressed_size],
-            file_info[:compressed_data].bytesize,
-            file_info[:compressed] ? 1 : 0,
-          ].pack("V3C")
-          bytes_written += @io_system.write(output_handle, metadata)
-        end
-
-        bytes_written
+        @quickhelp.generate(output_file, **options)
       end
 
-      # Write file data
+      # Create a Windows Help format HLP file
       #
-      # @param output_handle [System::FileHandle] Output file handle
-      # @param compressed_files [Array<Hash>] Compressed file information
-      # @return [Integer] Number of bytes written
-      def write_file_data(output_handle, compressed_files)
-        bytes_written = 0
-
-        compressed_files.each do |file_info|
-          written = @io_system.write(
-            output_handle,
-            file_info[:compressed_data],
-          )
-          bytes_written += written
-        end
-
-        bytes_written
+      # @param output_file [String] Output file path
+      # @param options [Hash] Format options
+      # @return [WinHelp::Compressor] Compressor for building WinHelp file
+      def self.create_winhelp(io_system = nil)
+        WinHelp::Compressor.new(io_system)
       end
     end
   end