Search Operations Data Flow

Complete sequence diagrams for find and replace operations

📋 Table of Contents

Overview
FindFirst Sequence
FindAll Sequence
CountOccurrences Sequence
ReplaceAll Sequence
String Search

📖 Overview

This document details the complete data flow for search and replace operations, showing efficient pattern matching algorithms and memory optimization strategies.

🔍 FindFirst Sequence

Sequence Diagram

sequenceDiagram
    actor User
    participant HE as HexEditor
    participant VM as ViewModel
    participant SS as SearchService
    participant BP as ByteProvider
    participant BR as ByteReader
    participant FP as FileProvider

    User->>HE: FindFirst([0xDE, 0xAD, 0xBE, 0xEF])
    HE->>VM: FindFirst(pattern, startPos=0)

    VM->>SS: FindFirst(pattern, startPos=0)
    activate SS

    SS->>SS: Validate pattern
    alt Pattern is null or empty
        SS->>VM: ArgumentException
        VM->>HE: Error
        HE->>User: Show error
    else Valid pattern
        SS->>BP: Get total length
        BP-->>SS: Length

        SS->>SS: Calculate search range
        Note over SS: Search from startPos to (Length - patternLength)

        loop For each position
            SS->>BP: ReadBytes(position, patternLength)
            activate BP

            BP->>BR: ReadByte(position)
            activate BR

            BR->>BR: Check if insertion
            alt Is insertion
                BR->>EM: GetInsertionValue(position)
                EM-->>BR: Inserted byte
            else Not insertion
                BR->>PM: VirtualToPhysical(position)
                PM-->>BR: Physical position
                BR->>EM: IsModified(physical)?
                alt Modified
                    EM-->>BR: Modified value
                else Not modified
                    BR->>FP: ReadByte(physical)
                    activate FP
                    FP->>FP: Check cache
                    alt Cache hit
                        FP-->>BR: Cached byte
                    else Cache miss
                        FP->>FS: Read from disk
                        FS-->>FP: Byte
                        FP-->>BR: Byte
                    end
                    deactivate FP
                end
            end

            BR-->>BP: Byte value
            deactivate BR

            BP-->>SS: Bytes read

            SS->>SS: Compare with pattern
            alt Match found
                SS-->>VM: Position (match index)
                VM-->>HE: Position
                HE->>HE: Highlight match
                HE->>User: Scroll to match
            else No match
                Note over SS: Continue searching
            end

            deactivate BP
        end

        alt No match found
            SS-->>VM: -1 (not found)
            VM-->>HE: Not found
            HE->>User: Show "Pattern not found"
        end

        deactivate SS
    end

Algorithm: Boyer-Moore-Horspool

public long FindFirst(byte[] pattern, long startPosition = 0)
{
    if (pattern == null || pattern.Length == 0)
        throw new ArgumentException("Pattern cannot be null or empty");

    long patternLength = pattern.Length;
    long endPosition = _provider.Length - patternLength;

    // Build skip table (Boyer-Moore-Horspool)
    var skipTable = BuildSkipTable(pattern);

    long position = startPosition;

    while (position <= endPosition)
    {
        // Compare pattern from right to left
        bool match = true;
        for (int i = patternLength - 1; i >= 0; i--)
        {
            byte value = _provider.ReadByte(position + i);
            if (value != pattern[i])
            {
                match = false;

                // Skip ahead using skip table
                byte skipByte = _provider.ReadByte(position + patternLength - 1);
                int skip = skipTable.TryGetValue(skipByte, out int skipValue) ? skipValue : patternLength;
                position += skip;

                break;
            }
        }

        if (match)
            return position;  // Found!

        if (!match && position > endPosition)
            break;
    }

    return -1;  // Not found
}

private Dictionary<byte, int> BuildSkipTable(byte[] pattern)
{
    var table = new Dictionary<byte, int>();
    int patternLength = pattern.Length;

    for (int i = 0; i < patternLength - 1; i++)
    {
        table[pattern[i]] = patternLength - 1 - i;
    }

    return table;
}

Performance

File Size	Pattern	Naive Search	Boyer-Moore-Horspool	Speedup
1 MB	4 bytes	250ms	50ms	5x faster
10 MB	4 bytes	2500ms	400ms	6x faster
100 MB	4 bytes	25000ms	3500ms	7x faster

🔍 FindAll Sequence

Sequence Diagram

sequenceDiagram
    actor User
    participant HE as HexEditor
    participant VM as ViewModel
    participant SS as SearchService
    participant BP as ByteProvider

    User->>HE: FindAll([0xFF, 0xFF])
    HE->>VM: FindAll(pattern)

    VM->>SS: FindAll(pattern, startPos=0)
    activate SS

    SS->>SS: Create results list
    Note over SS: List<long> positions

    SS->>BP: Get total length
    BP-->>SS: Length

    loop Search entire file
        SS->>SS: FindFirst(pattern, currentPos)

        alt Match found
            SS->>SS: Add position to results
            SS->>SS: Update currentPos = position + patternLength
            Note over SS: Continue searching after match
        else No match
            Note over SS: Exit loop
        end
    end

    SS->>SS: Sort results (if needed)
    SS-->>VM: List<long> (all positions)
    deactivate SS

    VM->>VM: Store search results
    VM->>VM: Highlight all matches

    VM-->>HE: Search complete
    HE->>User: Show "Found N matches"

Code Example

public List<long> FindAll(byte[] pattern, long startPosition = 0)
{
    var results = new List<long>();
    long currentPosition = startPosition;

    while (currentPosition < _provider.Length)
    {
        // Find next occurrence
        long position = FindFirst(pattern, currentPosition);

        if (position >= 0)
        {
            // Add to results
            results.Add(position);

            // Continue search after this match
            currentPosition = position + pattern.Length;
        }
        else
        {
            // No more matches
            break;
        }
    }

    return results;
}

Memory Considerations

Problem: FindAll() stores all positions in memory.

Example:

File size: 100 MB
Pattern: 0xFF (single byte)
Matches: 1,000,000
Memory: 1M positions × 8 bytes = 8 MB

Solution: Use CountOccurrences() if only count is needed.

🔢 CountOccurrences Sequence

Sequence Diagram

sequenceDiagram
    actor User
    participant HE as HexEditor
    participant VM as ViewModel
    participant SS as SearchService
    participant BP as ByteProvider

    User->>HE: CountOccurrences([0xFF])
    HE->>VM: CountOccurrences(pattern)

    VM->>SS: CountOccurrences(pattern, startPos=0)
    activate SS

    SS->>SS: Initialize count = 0
    Note over SS: No list allocation

    SS->>BP: Get total length
    BP-->>SS: Length

    loop Search entire file
        SS->>SS: FindFirst(pattern, currentPos)

        alt Match found
            SS->>SS: Increment count
            SS->>SS: Update currentPos = position + patternLength
            Note over SS: Don't store position (memory efficient)
        else No match
            Note over SS: Exit loop
        end
    end

    SS-->>VM: Count (int)
    deactivate SS

    VM-->>HE: Count
    HE->>User: Show "Found N occurrences"

Code Example

public int CountOccurrences(byte[] pattern, long startPosition = 0)
{
    int count = 0;
    long currentPosition = startPosition;

    while (currentPosition < _provider.Length)
    {
        // Find next occurrence
        long position = FindFirst(pattern, currentPosition);

        if (position >= 0)
        {
            // Increment count (don't store position)
            count++;

            // Continue search after this match
            currentPosition = position + pattern.Length;
        }
        else
        {
            // No more matches
            break;
        }
    }

    return count;
}

Memory Comparison

Method	Memory Usage (1M matches)	Use Case
`FindAll()`	~8 MB	Need positions for highlight/navigation
`CountOccurrences()`	~0 KB	Only need count

🔄 ReplaceAll Sequence

Sequence Diagram

sequenceDiagram
    actor User
    participant HE as HexEditor
    participant VM as ViewModel
    participant SS as SearchService
    participant BP as ByteProvider
    participant EM as EditsManager
    participant UR as UndoRedoManager

    User->>HE: ReplaceAll(find=[0xDE, 0xAD], replace=[0xCA, 0xFE])
    HE->>VM: ReplaceAll(findPattern, replacePattern)

    VM->>SS: ReplaceAll(findPattern, replacePattern)
    activate SS

    SS->>SS: Validate patterns
    alt Patterns invalid
        SS->>VM: ArgumentException
        VM->>HE: Error
        HE->>User: Show error
    else Patterns valid
        SS->>SS: FindAll(findPattern)
        SS-->>SS: List<long> positions

        alt No matches found
            SS-->>VM: 0 (replacements)
            VM-->>HE: Not found
            HE->>User: Show "Pattern not found"
        else Matches found
            SS->>BP: BeginBatch()
            BP->>UR: BeginBatch()
            UR-->>BP: Batch started
            BP-->>SS: Batch active

            loop For each match position
                SS->>SS: Check pattern length

                alt Same length (modify)
                    loop For each byte in pattern
                        SS->>BP: ModifyByte(pos + i, replacePattern[i])
                        BP->>EM: AddModification(pos + i, value)
                        EM-->>BP: Modified
                        BP->>UR: PushEdit(ModifyCommand)
                        UR-->>BP: Recorded
                        BP-->>SS: Byte modified
                    end
                else Different length
                    SS->>BP: DeleteBytes(pos, findPattern.Length)
                    BP->>EM: AddDeletion(pos, count)
                    EM-->>BP: Deleted
                    BP-->>SS: Deleted

                    SS->>BP: InsertBytes(pos, replacePattern)
                    loop For each byte in replacePattern
                        BP->>EM: AddInsertion(pos + i, value)
                        EM-->>BP: Inserted
                    end
                    BP-->>SS: Inserted
                end
            end

            SS->>BP: EndBatch()
            BP->>UR: EndBatch()
            UR-->>BP: Batch finalized
            BP->>BP: RaiseDataChanged()
            BP-->>SS: Batch complete

            SS-->>VM: replacementCount
            deactivate SS

            VM->>VM: RefreshVisibleLines()
            VM-->>HE: Replacements complete
            HE->>User: Show "Replaced N occurrences"
        end
    end

Replace Algorithm

public int ReplaceAll(byte[] findPattern, byte[] replacePattern)
{
    // Validate
    if (findPattern == null || findPattern.Length == 0)
        throw new ArgumentException("Find pattern cannot be null or empty");
    if (replacePattern == null)
        throw new ArgumentException("Replace pattern cannot be null");

    // Find all occurrences
    var positions = FindAll(findPattern);

    if (positions.Count == 0)
        return 0;  // Nothing to replace

    // Begin batch for performance
    _provider.BeginBatch();

    try
    {
        // Replace each occurrence
        int replacementCount = 0;

        // Process in reverse order if length changes (to preserve positions)
        if (findPattern.Length != replacePattern.Length)
        {
            positions.Reverse();
        }

        foreach (var position in positions)
        {
            if (findPattern.Length == replacePattern.Length)
            {
                // Same length: modify in place
                for (int i = 0; i < replacePattern.Length; i++)
                {
                    _provider.ModifyByte(position + i, replacePattern[i]);
                }
            }
            else
            {
                // Different length: delete and insert
                _provider.DeleteBytes(position, findPattern.Length);
                _provider.InsertBytes(position, replacePattern);
            }

            replacementCount++;
        }

        return replacementCount;
    }
    finally
    {
        _provider.EndBatch();
    }
}

Replace with Length Change

Original: [41 42 DE AD 43 44 DE AD 45 46]

ReplaceAll([DE AD] → [CA FE BA BE])

Process in reverse to preserve positions:
1. Position 6: Delete [DE AD], Insert [CA FE BA BE]
   Result: [41 42 DE AD 43 44 CA FE BA BE 45 46]

2. Position 2: Delete [DE AD], Insert [CA FE BA BE]
   Result: [41 42 CA FE BA BE 43 44 CA FE BA BE 45 46]

Final: 2 replacements, length changed from 10 to 14 bytes (+4)

🔤 String Search

Sequence Diagram

sequenceDiagram
    actor User
    participant HE as HexEditor
    participant VM as ViewModel
    participant SS as SearchService
    participant Enc as Encoding

    User->>HE: FindString("HELLO", UTF8)
    HE->>VM: FindString(text, encoding)

    VM->>SS: FindString(text, encoding, startPos=0)
    activate SS

    SS->>Enc: GetBytes(text)
    activate Enc
    Enc-->>SS: byte[] pattern
    deactivate Enc

    Note over SS: Now search for byte pattern

    SS->>SS: FindFirst(pattern, startPos)
    SS-->>VM: Position

    VM-->>HE: Position
    HE->>User: Highlight match
    deactivate SS

Code Example

public long FindString(string text, Encoding encoding, long startPosition = 0)
{
    // Convert string to bytes using encoding
    byte[] pattern = encoding.GetBytes(text);

    // Search for byte pattern
    return FindFirst(pattern, startPosition);
}

// Usage
long pos1 = searchService.FindString("HELLO", Encoding.UTF8);
long pos2 = searchService.FindString("こんにちは", Encoding.UTF8);  // Japanese
long pos3 = searchService.FindString("HELLO", Encoding.Unicode);  // UTF-16

Supported Encodings

Encoding	Bytes per Character	Example
ASCII	1 byte	"HELLO" → `[48 45 4C 4C 4F]`
UTF-8	1-4 bytes	"こんにちは" → `[E3 81 93 E3 81 ...]`
UTF-16 (Unicode)	2-4 bytes	"HELLO" → `[48 00 45 00 4C 00 ...]`
UTF-32	4 bytes	"HELLO" → `[48 00 00 00 45 00 ...]`

⚡ Performance Optimizations

1. Skip Table Caching

// Cache skip tables for frequently searched patterns
private Dictionary<string, Dictionary<byte, int>> _skipTableCache = new();

private Dictionary<byte, int> GetSkipTable(byte[] pattern)
{
    string key = Convert.ToBase64String(pattern);

    if (_skipTableCache.TryGetValue(key, out var table))
        return table;

    table = BuildSkipTable(pattern);
    _skipTableCache[key] = table;

    return table;
}

2. Early Exit

// Exit early if pattern is longer than remaining bytes
if (position + patternLength > _provider.Length)
    return -1;  // Can't possibly match

3. Chunk Reading

// Read bytes in chunks instead of one at a time
private const int ChunkSize = 4096;

byte[] chunk = new byte[ChunkSize];
long chunksRead = _provider.ReadBytes(position, ChunkSize);

// Search within chunk

🔗 See Also

Edit Operations - Modify, insert, delete sequences
File Operations - Open, close, save sequences
ByteProvider System - Data access

Last Updated: 2026-02-19 Version: V2.0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Search Operations Data Flow

📋 Table of Contents

📖 Overview

🔍 FindFirst Sequence

Sequence Diagram

Algorithm: Boyer-Moore-Horspool

Performance

🔍 FindAll Sequence

Sequence Diagram

Code Example

Memory Considerations

🔢 CountOccurrences Sequence

Sequence Diagram

Code Example

Memory Comparison

🔄 ReplaceAll Sequence

Sequence Diagram

Replace Algorithm

Replace with Length Change

🔤 String Search

Sequence Diagram

Code Example

Supported Encodings

⚡ Performance Optimizations

1. Skip Table Caching

2. Early Exit

3. Chunk Reading

🔗 See Also

FilesExpand file tree

search-operations.md

Latest commit

History

search-operations.md

File metadata and controls

Search Operations Data Flow

📋 Table of Contents

📖 Overview

🔍 FindFirst Sequence

Sequence Diagram

Algorithm: Boyer-Moore-Horspool

Performance

🔍 FindAll Sequence

Sequence Diagram

Code Example

Memory Considerations

🔢 CountOccurrences Sequence

Sequence Diagram

Code Example

Memory Comparison

🔄 ReplaceAll Sequence

Sequence Diagram

Replace Algorithm

Replace with Length Change

🔤 String Search

Sequence Diagram

Code Example

Supported Encodings

⚡ Performance Optimizations

1. Skip Table Caching

2. Early Exit

3. Chunk Reading

🔗 See Also