Add support for platinum searcher

Author: yegappan

README.md

@@ -4,8 +4,9 @@ grep
 Plugin to integrate various grep like search tools with Vim.
 
 The grep plugin integrates grep like utilities (grep, fgrep, egrep, agrep,
-findstr, silver searcher (ag), ripgrep, ack, git grep and sift) with Vim and
-allows you to search for a pattern in one or more files and jump to them.
+findstr, silver searcher (ag), ripgrep, ack, git grep, sift and platinum
+searcher) with Vim and allows you to search for a pattern in one or more files
+and jump to them.
 
 To use this plugin, you will need the grep like utilities in your system.  If a
 particular utility is not present, then you cannot use the corresponding
@@ -49,6 +50,11 @@ utility from:
 
     https://sift-tool.org
 
-The silver searcher, ripgrep and ack utilities can search for a pattern
-recursively across directories without using any other additional utilities
-like find and xargs.
+If you want to use the platinum searcher (pt) with this plugin, then you can
+download the platinum searcher utility from:
+
+    https://github.com/monochromegane/the_platinum_searcher
+
+The silver searcher, ripgrep, ack and platinum searcher utilities can search
+for a pattern recursively across directories without using any other additional
+utilities like find and xargs.

autoload/grep.vim

@@ -1,11 +1,11 @@
 " File: grep.vim
 " Author: Yegappan Lakshmanan (yegappan AT yahoo DOT com)
 " Version: 2.1
-" Last Modified: March 11, 2018
+" Last Modified: March 13, 2018
 " 
 " Plugin to integrate grep like utilities with Vim
 " Supported utilities are: grep, fgrep, egrep, agrep, findstr, ag, ack,
-" ripgrep, git grep and sift
+" ripgrep, git grep, sift and platinum searcher
 "
 " License: MIT License
 " Copyright (c) 2002-2018 Yegappan Lakshmanan
@@ -83,6 +83,11 @@ if !exists("Sift_Path")
     let Sift_Path = 'sift'
 endif
 
+" Location of the platinum searcher utility
+if !exists("Pt_Path")
+    let Pt_Path = 'pt'
+endif
+
 " grep options
 if !exists("Grep_Options")
     let Grep_Options = ''
@@ -133,6 +138,11 @@ if !exists("Sift_Options")
     let Sift_Options = ''
 endif
 
+" pt options
+if !exists("Pt_Options")
+    let Pt_Options = ''
+endif
+
 " Location of the find utility
 if !exists("Grep_Find_Path")
     let Grep_Find_Path = 'find'
@@ -304,6 +314,14 @@ let s:cmdTable = {
 	    \     'opts' : g:Sift_Options,
 	    \     'expropt' : '-e',
 	    \     'nulldev' : ''
+	    \   },
+	    \   'pt' : {
+	    \     'cmdpath' : g:Pt_Path,
+	    \     'optprefix' : '-',
+	    \     'defopts' : '--nocolor --nogroup',
+	    \     'opts' : g:Pt_Options,
+	    \     'expropt' : '',
+	    \     'nulldev' : ''
 	    \   }
 	    \ }
 
@@ -554,7 +572,8 @@ function! s:recursive_search_cmd(cmd_name)
     return a:cmd_name == 'ag' ||
 		\ a:cmd_name == 'rg' ||
 		\ a:cmd_name == 'ack' ||
-		\ a:cmd_name == 'git'
+		\ a:cmd_name == 'git' ||
+		\ a:cmd_name == 'pt'
 endfunction
 
 " formFullCmd()

doc/grep.txt

@@ -2,7 +2,7 @@
 
 Author: Yegappan Lakshmanan  (yegappan AT yahoo DOT com)
 For Vim version 7.0 and above
-Last change: March 11, 2018
+Last change: March 13, 2018
 
 ==============================================================================
 						*grep-license*
@@ -39,8 +39,9 @@ CONTENTS~
 1. Overview~
 
 The grep plugin integrates grep like utilities (grep, fgrep, egrep, agrep,
-findstr, silver searcher, ack, ripgrep, git grep, sift) with Vim and allows
-you to search for a pattern in one or more files and jump to them.
+findstr, silver searcher, ack, ripgrep, git grep, sift and platinum searcher)
+with Vim and allows you to search for a pattern in one or more files and jump
+to them.
 
 To use this plugin, you will need the grep like utilities in your system.  If
 a particular utility is not present, then you cannot use the corresponding
@@ -79,14 +80,19 @@ ripgrep utility from:
 
     https://github.com/BurntSushi/ripgrep
 
-If you want to use sift with this plugin, then you can download the sift
-utility from:
+If you want to use the sift utility with this plugin, then you can download
+the sift utility from:
 
     https://sift-tool.org
 
-The silver searcher, ripgrep, ack and sift utilities can search for a pattern
-recursively across directories without using any other additional utilities
-like find and xargs.
+If you want to use the platinum searcher with this plugin, then you can
+download the platinum searcher utility from:
+
+    https://github.com/monochromegane/the_platinum_searcher
+
+The silver searcher, ripgrep, ack, sift and platinum searcher utilities can
+search for a pattern recursively across directories without using any other
+additional utilities like find and xargs.
 
 The github repository for this plugin is at https://github.com/yegappan/grep
 
@@ -153,6 +159,8 @@ The grep.vim plugin introduces the following Vim commands:
 :GitgrepAdd    - Same as ":Gitgrep" but adds the results to the current list
 :Sift          - Run sift
 :SiftAdd       - Same as ":Sift" but adds the results to the current list
+:Ptgrep        - Run the platinum searcher (pt)
+:PtgrepAdd     - Same as ":Ptgrep" but adds the results to the current list
 
 The above commands can be invoked like this:
 
@@ -170,6 +178,7 @@ The above commands can be invoked like this:
     :Rg [<options>] [<search_pattern> [<file_name(s)>]]
     :Gitgrep [<options>] [<search_pattern> [<file_name(s)>]]
     :Sift [<options>] [<search_pattern> [<file_name(s)>]]
+    :Ptgrep [<options>] [<search_pattern> [<file_name(s)>]]
 
     :GrepAdd   [<grep_options>] [<search_pattern> [<file_name(s)>]]
     :RgrepAdd  [<grep_options>] [<search_pattern> [<file_name(s)>]]
@@ -184,7 +193,8 @@ The above commands can be invoked like this:
     :AckAdd [<options>] [<search_pattern> [<file_name(s)>]]
     :RgAdd [<options>] [<search_pattern> [<file_name(s)>]]
     :GitgrepAdd [<options>] [<search_pattern> [<file_name(s)>]]
-    :SftAdd [<options>] [<search_pattern> [<file_name(s)>]]
+    :SiftAdd [<options>] [<search_pattern> [<file_name(s)>]]
+    :PtgrepAdd [<options>] [<search_pattern> [<file_name(s)>]]
 
     :GrepBuffer [<grep_options>] [<search_pattern>]
     :Bgrep [<grep_options>] [<search_pattern>]
@@ -295,10 +305,10 @@ When using GUI Vim, the Tools->Search menu item with a few sub-menu items is
 created for few variations of the search command.
 
 Note that when recursively searching for a pattern using the silver searcher,
-ripgrep, ack, git grep or sift utilities, if a large number (several
-thousands) of matching files are found, then it will take some time for Vim to
-load all the files into the buffer list. In the meantime, Vim will be slow to
-respond or may not respond to keystrokes.
+ripgrep, ack, git grep, sift or platinum searcher utilities, if a large number
+(several thousands) of matching files are found, then it will take some time
+for Vim to load all the files into the buffer list. In the meantime, Vim will
+be slow to respond or may not respond to keystrokes.
 
 ==============================================================================
 						*grep-configuration*
@@ -355,12 +365,18 @@ command:
 
     :let Git_Path = 'C:\Progra~1\git\git.exe'
 
-The 'Sift_Path' variable is used to locate the sift utility used by the
-Siftgrep command. By default, this is set to sift. You can change this using
-the let command:
+The 'Sift_Path' variable is used to locate the sift utility used by the Sift
+command. By default, this is set to sift. You can change this using the let
+command:
 
     :let Sift_Path = 'C:\Progra~1\sift\sift.exe'
 
+The 'Pt_Path' variable is used to locate the platinum searcher utility used by
+the Ptgrep command. By default, this is set to pt. You can change this
+using the let command:
+
+    :let Pt_Path = 'C:\Progra~1\pt\pt.exe'
+
 The 'Grep_Find_Path' variable is used to locate the find utility. By default,
 this is set to 'find'. Note that on MS-Windows, there is a find.exe that is
 part of the base OS. This find utility is different from the Unix find
@@ -392,8 +408,8 @@ using the let command:
 
 Similarly you can pass command line options to other commands by setting the
 'Fgrep_Options', 'Egrep_Options', 'Agrep_Options', 'Findstr_Options',
-'Ag_options', 'Ack_Options', 'Rg_Options', "Gitgrep_Options' and
-'Sift_Options' variables in your .vimrc file.
+'Ag_options', 'Ack_Options', 'Rg_Options', "Gitgrep_Options', 'Sift_Options'
+and 'Pt_Options' variables in your .vimrc file.
 
 The 'Grep_Skip_Dirs' variable specifies the list of directories to skip while
 doing recursive searches. By default, this is set to 'RCS CVS SCCS'.  You can

plugin/grep.vim

@@ -1,11 +1,11 @@
 " File: grep.vim
 " Author: Yegappan Lakshmanan (yegappan AT yahoo DOT com)
 " Version: 2.1
-" Last Modified: March 11, 2018
+" Last Modified: March 13, 2018
 " 
 " Plugin to integrate grep like utilities with Vim
 " Supported utilities are: grep, fgrep, egrep, agrep, findstr, ag, ack,
-" ripgrep, git grep and sift
+" ripgrep, git grep, sift and platinum searcher
 "
 " License: MIT License
 " Copyright (c) 2002-2018 Yegappan Lakshmanan
@@ -114,6 +114,12 @@ command! -nargs=* -complete=file Sift
 command! -nargs=* -complete=file SiftAdd
 	\ call grep#runGrep('SiftAdd', 'sift', 'add', <f-args>)
 
+" Platinum Searcher commands
+command! -nargs=* -complete=file Ptgrep
+	    \ call grep#runGrep('Ptgrep', 'pt', 'set', <f-args>)
+command! -nargs=* -complete=file PtgrepAdd
+	\ call grep#runGrep('PtgrepAdd', 'pt', 'add', <f-args>)
+
 " findstr commands
 if has('win32')
     command! -nargs=* -complete=file Findstr