xerg 0.2.1

Ultra-fast grep implementation in Rust - built for maximum speed with direct output and parallel processing
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
//! # Parallel File Search
//!
//! This module provides high-performance parallel file search using Rayon's work-stealing
//! thread pool. It efficiently searches through multiple files concurrently while maintaining
//! optimal system responsiveness.
//!
//! ## Features
//!
//! - **Multi-core Processing**: Utilizes available CPU cores with intelligent thread management
//! - **Work-stealing Scheduler**: Rayon's scheduler automatically balances work across threads
//! - **Memory Efficient**: Line-by-line processing handles files of any size
//! - **Structured Streaming**: Streams structured matches per file with headers and statistics
//! - **Error Resilient**: Graceful per-file error recovery without stopping other files
//!
//! ## Performance Characteristics
//!
//! - **Thread Pool Size**: Uses `cores - 1` threads to prevent system lock-up
//! - **I/O Optimization**: Buffered reading with `BufReader` for optimal disk access
//! - **Regex Reuse**: Compiled patterns shared across threads for efficiency
//!
//! ## Example
//!
//! ```no_run
//! use xerg::search::default::search_files;
//! use xerg::output::colors::Color;
//! use std::path::PathBuf;
//!
//! let files = vec![PathBuf::from("src/main.rs")];
//! let pattern = "use";
//! let color = Color::Blue;
//! let rx = search_files(&files, pattern, &color, true);
//!
//! // Process results from receiver...
//! ```

use super::reader::FileReader;
use crate::output::result::{FileMatchResult, ResultMessage};
use crate::output::{colors::Color, highlighter::TextHighlighter};
use memmap2::MmapOptions;
use rayon::scope;
use std::fs::File;
use std::io::{BufRead, BufReader, Result};
use std::path::PathBuf;
use std::sync::mpsc;

/// Process content line by line and collect matches
fn _process_content_lines(
    content: &str,
    highlighter: &TextHighlighter,
    messages: &mut Vec<ResultMessage>,
) -> (usize, usize) {
    let mut total_lines = 0;
    let mut matched_count = 0;

    for (index, line) in content.lines().enumerate() {
        total_lines += 1;

        if highlighter.regex.is_match(line) {
            let line_msg = ResultMessage::Line {
                index,
                content: highlighter.highlight(line),
            };
            messages.push(line_msg);
            let matches_in_line = highlighter.regex.find_iter(line).count();
            matched_count += matches_in_line;
        }
    }

    (total_lines, matched_count)
}

/// Process file using streaming line-by-line reading with BufReader
fn _process_file_streaming(
    filepath: &PathBuf,
    highlighter: &TextHighlighter,
    messages: &mut Vec<ResultMessage>,
) -> Result<(usize, usize, usize)> {
    let file = File::open(filepath)?;
    let reader = BufReader::new(file);

    let mut total_lines = 0;
    let mut matched_count = 0;
    let mut skipped_count = 0;

    for (index, line) in reader.lines().enumerate() {
        let line = match line {
            Ok(l) => l,
            Err(_e) => {
                skipped_count += 1;
                continue;
            }
        };
        total_lines += 1;

        if highlighter.regex.is_match(&line) {
            let line_msg = ResultMessage::Line {
                index,
                content: highlighter.highlight(&line),
            };
            messages.push(line_msg);
            let matches_in_line = highlighter.regex.find_iter(&line).count();
            matched_count += matches_in_line;
        }
    }

    Ok((total_lines, matched_count, skipped_count))
}

/// Process file using bulk read with fs::read_to_string
fn _process_file_bulk_read(
    filepath: &PathBuf,
    highlighter: &TextHighlighter,
    messages: &mut Vec<ResultMessage>,
) -> Result<(usize, usize, usize)> {
    let content = std::fs::read_to_string(filepath)?;
    let (total_lines, matched_count) = _process_content_lines(&content, highlighter, messages);
    Ok((total_lines, matched_count, 0)) // No skipped lines with bulk reading
}

/// Process file using memory mapping
fn _process_file_memory_map(
    filepath: &PathBuf,
    highlighter: &TextHighlighter,
    messages: &mut Vec<ResultMessage>,
) -> Result<(usize, usize, usize)> {
    let file = File::open(filepath)?;
    let mmap = unsafe { MmapOptions::new().map(&file)? };
    let content = std::str::from_utf8(&mmap)
        .map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?;

    let (total_lines, matched_count) = _process_content_lines(content, highlighter, messages);
    Ok((total_lines, matched_count, 0)) // No skipped lines with memory mapping
}

fn _process_file(
    filepath: &PathBuf,
    _pattern: &str,
    highlighter: &TextHighlighter,
    show_stats: bool,
    reader: FileReader,
) -> Result<FileMatchResult> {
    let mut messages = Vec::new();
    messages.push(ResultMessage::Header(filepath.to_path_buf()));

    let (total_lines, matched_count, skipped_count) = match reader {
        FileReader::Streaming => {
            match _process_file_streaming(filepath, highlighter, &mut messages) {
                Ok(stats) => stats,
                Err(e) => {
                    let err_msg = format!("Failed to process file {}: {}", filepath.display(), e);
                    messages.push(ResultMessage::Error(err_msg));
                    return Ok(messages);
                }
            }
        }

        FileReader::BulkRead => {
            match _process_file_bulk_read(filepath, highlighter, &mut messages) {
                Ok(stats) => stats,
                Err(e) => {
                    let err_msg = format!("Failed to read file {}: {}", filepath.display(), e);
                    messages.push(ResultMessage::Error(err_msg));
                    return Ok(messages);
                }
            }
        }

        FileReader::MemoryMap => {
            match _process_file_memory_map(filepath, highlighter, &mut messages) {
                Ok(stats) => stats,
                Err(e) => {
                    let err_msg =
                        format!("Failed to memory map file {}: {}", filepath.display(), e);
                    messages.push(ResultMessage::Error(err_msg));
                    return Ok(messages);
                }
            }
        }
    };

    // Add file summary with counts if stats are enabled
    if show_stats {
        messages.push(ResultMessage::SearchStats {
            lines: total_lines,
            matched: matched_count,
            skipped: skipped_count,
        });
    }

    messages.push(ResultMessage::Done);
    Ok(messages)
}

pub fn search_files(
    files: &[PathBuf],
    pattern: &str,
    color: &Color,
    show_stats: bool,
) -> mpsc::Receiver<FileMatchResult> {
    let (tx, rx) = mpsc::channel();
    let highlighter = TextHighlighter::new(pattern, color);
    let is_single_file = files.len() == 1;

    // Single-file optimization: bypass thread pool overhead for single files
    if is_single_file {
        let file = &files[0];
        let reader = FileReader::select(file, true);

        let messages = match _process_file(file, pattern, &highlighter, show_stats, reader) {
            Ok(msg) => msg,
            Err(e) => {
                let err_msg = format!("Error processing file {}: {}", file.display(), e);
                vec![ResultMessage::Error(err_msg)]
            }
        };

        // Send result immediately for single file
        tx.send(messages).ok();
        return rx;
    }

    // Multi-file processing: use existing thread pool approach with streaming reader
    scope(|s| {
        for file in files {
            let _tx = tx.clone();
            let _highlighter = &highlighter;
            let _pattern = pattern;
            let _file = file.clone();

            s.spawn(move |_| {
                let reader = FileReader::select(&_file, false);
                let messages =
                    match _process_file(&_file, _pattern, _highlighter, show_stats, reader) {
                        Ok(msg) => msg,
                        Err(e) => {
                            let err_msg =
                                format!("Error processing file {}: {}", _file.display(), e);
                            vec![ResultMessage::Error(err_msg)]
                        }
                    };
                _tx.send(messages).ok();
            });
        }
    });

    rx
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Write;
    use tempdir::TempDir;

    #[test]
    fn test_search_files_finds_pattern() {
        // Create temporary directory and file with content
        let temp_dir = TempDir::new("search_test").unwrap();
        let test_file = temp_dir.path().join("test.txt");

        let mut file = File::create(&test_file).unwrap();
        writeln!(file, "Hello world").unwrap();
        writeln!(file, "This is a test").unwrap();
        writeln!(file, "Hello again").unwrap();

        // Test that search finds the pattern
        let files = vec![test_file];
        let pattern = "Hello";
        let color = Color::Red;

        // Test that search_files completes without panicking
        // Results go to stdout, so we're testing the function doesn't crash
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_multiple_files() {
        let temp_dir = TempDir::new("search_multi_test").unwrap();

        // Create first file
        let file1 = temp_dir.path().join("file1.txt");
        let mut f1 = File::create(&file1).unwrap();
        writeln!(f1, "Pattern in file 1").unwrap();
        writeln!(f1, "Some other text").unwrap();

        // Create second file
        let file2 = temp_dir.path().join("file2.txt");
        let mut f2 = File::create(&file2).unwrap();
        writeln!(f2, "Different content").unwrap();
        writeln!(f2, "Pattern in file 2").unwrap();

        let files = vec![file1, file2];
        let pattern = "Pattern";
        let color = Color::Blue;

        // Test that function completes without panicking
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_no_matches() {
        let temp_dir = TempDir::new("search_no_match_test").unwrap();
        let test_file = temp_dir.path().join("test.txt");

        let mut file = File::create(&test_file).unwrap();
        writeln!(file, "Hello world").unwrap();
        writeln!(file, "This is a test").unwrap();

        let files = vec![test_file];
        let pattern = "NotFound";
        let color = Color::Green;

        // Should handle no matches gracefully
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_empty_file() {
        let temp_dir = TempDir::new("search_empty_test").unwrap();
        let test_file = temp_dir.path().join("empty.txt");

        // Create empty file
        File::create(&test_file).unwrap();

        let files = vec![test_file];
        let pattern = "anything";
        let color = Color::Red;

        // Should handle empty files without errors
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_nonexistent_file() {
        let temp_dir = TempDir::new("search_nonexistent_test").unwrap();
        let nonexistent_file = temp_dir.path().join("does_not_exist.txt");

        let files = vec![nonexistent_file];
        let pattern = "anything";
        let color = Color::Red;

        // Should print error message to stderr and continue (not panic)
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_different_colors() {
        let temp_dir = TempDir::new("search_colors_test").unwrap();
        let test_file = temp_dir.path().join("test.txt");

        let mut file = File::create(&test_file).unwrap();
        writeln!(file, "Test pattern here").unwrap();

        let files = vec![
            test_file.clone(),
            test_file.clone(),
            test_file.clone(),
            test_file,
        ];
        let pattern = "pattern";

        // Test all color variants
        search_files(&vec![files[0].clone()], pattern, &Color::Red, false);
        search_files(&vec![files[1].clone()], pattern, &Color::Green, false);
        search_files(&vec![files[2].clone()], pattern, &Color::Blue, false);
        search_files(&vec![files[3].clone()], pattern, &Color::Bold, false);
    }

    #[test]
    fn test_search_files_regex_patterns() {
        let temp_dir = TempDir::new("search_regex_test").unwrap();
        let test_file = temp_dir.path().join("test.txt");

        let mut file = File::create(&test_file).unwrap();
        writeln!(file, "email@example.com").unwrap();
        writeln!(file, "test@domain.org").unwrap();
        writeln!(file, "not an email").unwrap();

        let files = vec![test_file];
        let pattern = r"\w+@\w+\.\w+"; // Email regex pattern
        let color = Color::Blue;

        // Should handle regex patterns (TextHighlighter uses regex internally)
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_special_characters() {
        let temp_dir = TempDir::new("search_special_test").unwrap();
        let test_file = temp_dir.path().join("test.txt");

        let mut file = File::create(&test_file).unwrap();
        writeln!(file, "Special chars: àáâã").unwrap();
        writeln!(file, "Symbols: @#$%^&*()").unwrap();
        writeln!(file, "Unicode: 🦀 Rust crab").unwrap();

        let files = vec![test_file];
        let pattern = "🦀";
        let color = Color::Green;

        // Should handle Unicode and special characters
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_case_sensitive() {
        let temp_dir = TempDir::new("search_case_test").unwrap();
        let test_file = temp_dir.path().join("test.txt");

        let mut file = File::create(&test_file).unwrap();
        writeln!(file, "Hello World").unwrap();
        writeln!(file, "hello world").unwrap();
        writeln!(file, "HELLO WORLD").unwrap();

        let files = vec![test_file];
        let pattern = "Hello"; // Exact case
        let color = Color::Red;

        // Should be case-sensitive by default
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_long_lines() {
        let temp_dir = TempDir::new("search_long_test").unwrap();
        let test_file = temp_dir.path().join("test.txt");

        let mut file = File::create(&test_file).unwrap();
        // Create a very long line
        let long_line = "x".repeat(10000) + "PATTERN" + &"y".repeat(10000);
        writeln!(file, "{}", long_line).unwrap();
        writeln!(file, "Short line").unwrap();

        let files = vec![test_file];
        let pattern = "PATTERN";
        let color = Color::Blue;

        // Should handle very long lines without issues
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_empty_pattern() {
        let temp_dir = TempDir::new("search_empty_pattern_test").unwrap();
        let test_file = temp_dir.path().join("test.txt");

        let mut file = File::create(&test_file).unwrap();
        writeln!(file, "Some content").unwrap();

        let files = vec![test_file];
        let pattern = ""; // Empty pattern
        let color = Color::Red;

        // Should handle empty pattern gracefully (regex behavior)
        search_files(&files, pattern, &color, false);
    }

    #[test]
    fn test_search_files_mixed_scenarios() {
        let temp_dir = TempDir::new("search_mixed_test").unwrap();

        // Create valid file
        let valid_file = temp_dir.path().join("valid.txt");
        let mut f = File::create(&valid_file).unwrap();
        writeln!(f, "Valid content with pattern").unwrap();

        // Create empty file
        let empty_file = temp_dir.path().join("empty.txt");
        File::create(&empty_file).unwrap();

        // Reference non-existent file
        let nonexistent = temp_dir.path().join("missing.txt");

        let files = vec![valid_file, empty_file, nonexistent];
        let pattern = "pattern";
        let color = Color::Green;

        // Should handle mixed scenarios: valid, empty, and missing files
        search_files(&files, pattern, &color, false);
    }
}