Indexed grep
C++ Makefile C Batchfile
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc buildsystem refacor & added tests Jun 10, 2017
src simplified whole word and line grepping Jun 18, 2017
.gitignore buildsystem refacor & added tests Jun 10, 2017
LICENSE Initial commit Dec 3, 2016
README.md
TODO added --file switch Dec 18, 2016

README.md

grip

Indexed grep - fast search (grep like) in huge stack of files.

Author: Mike Szymaniak

Features

  • support for POSIX (Linux and UNIX) and Windows (with MinGW);
  • fast search for pattern in text files;
  • intended mainly (but not limited to) source code;
  • support for Huge Blobs of Legacy Code™;
  • language & encoding agnostic (excluding UTF-16);
  • search with regex (basic and extended) or fixed string;
  • case sensitive and case insensitive search;
  • search limited to current subdirectory;
  • context line control (greps -B, -A and -C switches);
  • colored output.

Limitations

  • index must be generated prior to search;
  • and it must be up to date with files content;
  • some regular expressions are too convoluted to lookup into index;
  • only limited greps switches are implemented;
  • search pattern is assumed to be encoded the same way as searched files (usually not the case for ASCII characters, e.g. source code).

Requirements

  • C++11 compiler (e.g. GCC 4.8+ or Clang 3.4+);
  • POSIX-compatibile environment (tested on Ubuntu 16.04 and Debian 8) or Boost library (tested on Windows 10).

Installation

Assuming above requirements are met

cd src
make
make install

For more information see installation guide

Usage

First we need to generate index database. Under POSIX system:

find -type f | gripgen

Or under Windows:

dir /b /s /a:-d | gripgen

It will create database directory .grip. Binary files (these containing zero byte) will be ignored. In case of great number of files, this step will take some time. Indexer typically process 100 to 1000 files per second, and the resulting database size will be about 10% of the indexed data.

You could also provide file list to index

gripgen list.txt

Indexed files must be located inside current directory and its subdirectories.

Now you could perform search, e.g.:

grip printf
grip -E '(foo|bar)-[a-z]*'
grip -i -C3 'hello world'
grip --list main

For more usage information type grip --help.