Update doc

yssl · yssl · commit 62c055cdba07 · 2015-08-02T01:50:11.000+09:00
diff --git a/README.md b/README.md
@@ -50,7 +50,7 @@ If your vim doesn't support python, one of the easiest solutions would be instal
 5. Note that your ```set tags=...``` setting should have ```./tags;,tags;``` to use the generated tag file (The name of the tag file is set by```g:vintsearch_tagfilename```).
 6. Move the cursor to one of the functions or variables. Typing **:VIntSearchCursor symbol n l** or **:VIntSearchCursor text n l** will give search results in the quickfix window. Typing **:VIntSearchPrintStack** will show the search stack.
 
-## Search Types / Search Commands
+## Search Types / Commands
 
 VIntSearch supports symbol search, text search, and file search.
 Currently, available search commands for each type of search are as follows:
diff --git a/autoload/VIntSearch.vim b/autoload/VIntSearch.vim
@@ -496,9 +496,6 @@ function! s:DoFinishingWork(qflist, keyword, searchtype, searchcmd, options, jum
 	endif
 
 	redraw
-	if exists('g:vintsearch_codeexts')
-		echom 'VIntSearch: g:vintsearch_codeexts is deprecated. Please use g:vintsearch_includepatterns instead.'
-	endif
 	if exists('g:vintsearch_search_include_patterns')
 		echom 'VIntSearch: g:vintsearch_search_include_patterns is deprecated. Please use g:vintsearch_includepatterns instead.'
 	endif
diff --git a/doc/VIntSearch.txt b/doc/VIntSearch.txt
@@ -8,21 +8,22 @@ Contents                                                 *VIntSearch-contents*
 
          1. Introduction ......................... |VIntSearch-intro|
          2. Getting Started ...................... |VIntSearch-gettingstarted|
-         3. Search Path .......................... |VIntSearch-searchpath|
-         4. Search Commands ...................... |VIntSearch-searchcommands|
-         5. Stack Commands ....................... |VIntSearch-stackcommands|
-         6. Options .............................. |VIntSearch-options|
-         7. Key Mappings ......................... |VIntSearch-keymappings|
-         8. Changelog ............................ |VIntSearch-changelog|
+         3. Search Types / Commands .............. |VIntSearch-searchtypes|
+         4. Search Path / Tag Commands ........... |VIntSearch-searchpathtagcommands|
+         5. Search Commands ...................... |VIntSearch-searchcommands|
+         6. Stack Commands ....................... |VIntSearch-stackcommands|
+         7. Options .............................. |VIntSearch-options|
+         8. Key Mappings ......................... |VIntSearch-keymappings|
+         9. Deprecated Commands & Options ........ |VIntSearch-deprecated|
+        10. Changelog ............................ |VIntSearch-changelog|
 
 ==============================================================================
 1. Introduction                                             *VIntSearch-intro*
 
-|VIntSearch| is a vim plugin providing an integrated interface across various 
-types of searches. It currently supports symbol search (by ctags), text search 
-(by grep), and file search (by find).
-Search results are given in the quickfix window and a user can conviniently Move
-to previous or next search results via the integrated search stack.
+|VIntSearch| is a vim plugin providing an integrated interface across various
+types of searches. It currently supports symbol search, text search, and file search.
+Search results are given in the quickfix window and a user can conviniently 
+move forward / backward through the integrated search history.
 VIntSearch means Vim Integrated Search.
 
 ## Features
@@ -50,24 +51,40 @@ VIntSearch means Vim Integrated Search.
 
 3. Open one of your source files with vim.
 
-4. Build a tag file by typing |:VIntSearchBuildTag|. The tag file will be c
-   reated in the nearest ancestor dir of the source file that contains 
+4. Build a tag file by typing |:VIntSearchBuildSymbolDB|. The tag file will be 
+   created in the nearest ancestor dir of the source file that contains 
    a repository dir such as `.git`,
    or in the current working dir if the source file is not managed by any 
    version control system. 
-   (Type `:help g:vintsearch_searchpathmode` for more detail) 
+   (You can change this behavior via `g:vintsearch_searchpathmode`)
 
 5. Note that your `set tags=...` setting should have `./tags;,tags;` to use 
    the generated tag file. 
    (The name of the tag file can be changed by setting |g:vintsearch_tagfilename|)
 
 6. Move the cursor to one of the functions or variables. 
-   Typing |:VIntSearchGrepCursor| n l or |:VIntSearchCtagsCursor| n l will 
+   Typing |:VIntSearchCursor| symbol n l or |:VIntSearchCursor| text n l will 
    give search results in the quickfix window. 
    Typing |:VIntSearchPrintStack| will show the search stack.
 
 ==============================================================================
-3. Search Path / Tag Commands               *VIntSearch-searchpathtagcommands*
+3. Search Types / Commands                            *VIntSearch-searchtypes*
+
+VIntSearch supports symbol search, text search, and file search.
+Currently, available search commands for each type of search are as follows:
+
+- Symbol search
+	- ctags
+- Text search
+	- grep
+- File search
+	- find
+
+You can set the default commands for search types via `g:vintsearch_symbol_defaultcmd`,
+`g:vintsearch_text_defaultcmd`, and `g:vintsearch_file_defaultcmd`.
+
+==============================================================================
+4. Search Path / Tag Commands               *VIntSearch-searchpathtagcommands*
 
 The search path is a directory 1) that is recursively searched by grep, 
 2) that is the root of the entire source directory tree for which a tag file is generated,
@@ -77,39 +94,63 @@ It is determined by |g:vintsearch_searchpathmode|.
 *:VIntSearchPrintPath*, *:VSpath*    
 Print current search path.
 
-*:VIntSearchBuildTag*, *:VSbtag*   
-Build a tag file for the search path.
+*:VIntSearchBuildSymbolDB*, *:VSbuild*   
+Build a symbol db file for the search path.
 
 ==============================================================================
-4. Search Commands                                 *VIntSearch-searchcommands*
+5. Search Commands                                 *VIntSearch-searchcommands*
 
-*:VIntSearchCtags* [keyword], *:VSctags* [keyword]  
-Search for [keyword] by ctags.
+*:VSsymbol* [keyword]  
+Search symbol for [keyword] (by default using ctags).
+
+*:VStext* [keyword] [options]  
+Search text for [keyword] with [options] (by default using grep, [option] is grep option).
+[keyword] can be double-quoted and the argument order can be changed.  
 
-*:VIntSearchGrep* [keyword] [grep_options], *:VSgrep* [keyword] [grep_options]  
-Search for [keyword] by grep with [grep_options]. [keyword] can be double-quoted and the argument order can be changed.  
 For example:
 ```
-:VSgrep tags
-:VSgrep "let tags"
-:VSgrep tags -i
-:VSgrep -i tags
-:VSgrep "let tags" -i
+:VStext tags
+:VStext "let tags"
+:VStext tags -i
+:VStext -i tags
+:VStext "let tags" -i
 ```
-(See ```man grep``` for more details about [grep_options])
+(See ```man grep``` for more details about [options])
 
-*:VIntSearchCFGrep* [keyword] [grep_options], *:VScfgrep* [keyword] [grep_options]  
-Search for [keyword] by grep with [grep_options] in the current file.
+*:VSfile* [keyword] [options]  
+Search file for [keyword] with [options] (by default using find).
+Curently only works with -path options of find command.  
 
-*:VIntSearchFind* [keyword], *:VSfind* [keyword]  
-Search for [keyword] by find (file search). Curently works with -path options of find command.  
 For example,
 ```
 :VSfind *test-class.cpp
 ```
 
-*:VIntSearchCtagsCursor* [vimmode] [action]  
-Search for keyword under the cursor by ctags.
+*:VScftext* [keyword] [options]  
+Search text for [keyword] with [options] in the current file.
+
+--------------------
+*:VIntSearch* [search type] [keyword] [options]  
+A search command taking a search type as an argument.
+
+[search type] can be one of:
+- symbol
+- text
+- file
+- cftext
+
+For example,
+`:VIntSearch text "this is"` is same to `:VStext "this is"`.
+
+*:VIntSearchCmd* [search type] [search command] [keyword] [options]  
+A search command taking a search type and a search command as arguments.
+For example,
+`:VIntSearchCmd text grep "this is"` is same to `:VStext "this is"`
+with `grep` as the default text search command.
+
+--------------------
+*:VIntSearchCursor* [search type] [vimmode] [action]  
+Search for keyword under the cursor with a specified [search type].
 
 [vimmode] can be one of:  
 - 'n' : Use this if vim is in normal mode. Then keyword is the word under the cursor.  
@@ -119,17 +160,12 @@ Search for keyword under the cursor by ctags.
 - 'l' : List search result in the quickfix window and open the quickfix window.
 - 'j' : Jump to the first search result. The quickfix window is also updated but not opened.
 
-*:VIntSearchGrepCursor* [vimmode] [action]  
-Search for keyword under the cursor by grep.
-
-*:VIntSearchCFGrepCursor* [vimmode] [action]  
-Search for keyword under the cursor by grep in the current file.
+*:VIntSearchCursorCmd* [search type] [search command] [vimmode] [action]  
+Search for keyword under the cursor with a specified [search type] and a
+[search command].
 
-+**:VIntSearchFindCursor** [vimmode] [action]  
-+Search for *keyword* under the cursor by find (file search).
-+
 ==============================================================================
-5. Stack Commands                                   *VIntSearch-stackcommands*
+6. Stack Commands                                   *VIntSearch-stackcommands*
 
 Search stack contains your search history - search keywords you jumped to,
 from which file, and search results in the quickfix also.
@@ -168,7 +204,7 @@ such as [QFEnter](http://www.vim.org/scripts/script.php?script_id=4778).
 `let g:qfenter_cc_cmd = 'VScc ##'` in your .vimrc.)
 
 ==============================================================================
-6. Options                                                *VIntSearch-options*
+7. Options                                                *VIntSearch-options*
 
 *g:vintsearch_searchpathmode*
 A option to determine the search path.
@@ -199,26 +235,26 @@ Default: >
 	let g:vintsearch_repodirs = ['.git', '.hg', '.svn']
 <
 
-*g:vintsearch_search_include_patterns*
+*g:vintsearch_includepatterns*
 File patterns to specified files being searched.
-The tag file generated by |:VIntSearchBuildTag| will only contain files 
+The symbol db file generated by |:VIntSearchBuildSymbolDB| will only contain files 
 including these patterns in their paths.
-:VIntSearch*Grep commands will search files only including these patterns in
+|:VStext| commands will search files only including these patterns in
 their names.
 Default: >
-	let g:vintsearch_search_include_patterns =
+	let g:vintsearch_includepatterns =
 		\ ['*.c','*.cpp','*.h','*.hpp','*.inl','*.py','*.lua','*.vim','*.js',
 		\'*.md','*.txt','*.tex']
 <
 
-*g:vintsearch_search_exclude_patterns*
+*g:vintsearch_excludepatterns*
 File patterns to specified files not being searched.
-The tag file generated by |:VIntSearchBuildTag| will only contain files 
+The symbol db file generated by |:VIntSearchBuildSymbolDB| will only contain files 
 excluding these patterns in their paths.
-:VIntSearch*Grep commands will search files only excluding these patterns in
+|:VStext| commands will search files only excluding these patterns in
 their names and paths.
-If a file matches patterns in both |g:vintsearch_search_include_patterns| and
-*g:vintsearch_search_exclude_patterns*, it will be excluded from search results.
+If a file matches patterns in both |g:vintsearch_includepatterns| and
+*g:vintsearch_excludepatterns*, it will be excluded from search results.
 Default: >
 	let g:vintsearch_search_exclude_patterns =
 		\ []
@@ -259,8 +295,26 @@ If you don't want to use keyword highlighting, just set the option as:
 	let g:vintsearch_highlight_group = ''
 <
 
+*g:vintsearch_symbol_defaultcmd*
+Default search command for symbol search.
+Default: >
+	let g:vintsearch_symbol_defaultcmd = 'ctags'
+<
+
+*g:vintsearch_text_defaultcmd*
+Default search command for text search.
+Default: >
+	let g:vintsearch_text_defaultcmd = 'grep'
+<
+
+*g:vintsearch_file_defaultcmd*
+Default search command for file search.
+Default: >
+	let g:vintsearch_file_defaultcmd = 'find'
+<
+
 ==============================================================================
-7. Key Mappings                                       *VIntSearch-keymappings*
+8. Key Mappings                                       *VIntSearch-keymappings*
 
 VIntSearch does not provide default key mappings to keep your key mappings clean.
 Instead, I suggest convenient one what I'm using now.
@@ -277,29 +331,106 @@ endfunction
 call s:nnoreicmap('','<A-3>',':VIntSearchMoveBackward<CR>')
 call s:nnoreicmap('','<A-4>',':VIntSearchMoveForward<CR>')
 
-call s:nnoreicmap('','<A-]>',':VIntSearchCtagsCursor n j<CR>')
-call s:nnoreicmap('','g]',':VIntSearchCtagsCursor n l<CR>')
-call s:nnoreicmap('','g[',':VIntSearchGrepCursor n l<CR><CR>')
-call s:nnoreicmap('','g{',':VIntSearchCFGrepCursor n l<CR><CR>')
-call s:nnoreicmap('','g\',':VIntSearchFindCursor n l<CR><CR>')
-vnoremap <A-]> :<C-u>VIntSearchCtagsCursor v j<CR>
-vnoremap g] :<C-u>VIntSearchCtagsCursor v l<CR>
-vnoremap g[ :<C-u>VIntSearchGrepCursor v l<CR><CR>
-vnoremap g{ :<C-u>VIntSearchCFGrepCursor v l<CR><CR>
-vnoremap g\ :<C-u>VIntSearchFindCursor v l<CR><CR>
+call s:nnoreicmap('','<A-]>',':VIntSearchCursor symbol n j<CR>')
+call s:nnoreicmap('','g]',':VIntSearchCursor symbol n l<CR>')
+call s:nnoreicmap('','g[',':VIntSearchCursor text n l<CR><CR>')
+call s:nnoreicmap('','g{',':VIntSearchCursor cftext n l<CR><CR>')
+call s:nnoreicmap('','g\',':VIntSearchCursor file n l<CR><CR>')
+vnoremap <A-]> :<C-u>VIntSearchCursor symbol v j<CR>
+vnoremap g] :<C-u>VIntSearchCursor symbol v l<CR>
+vnoremap g[ :<C-u>VIntSearchCursor text v l<CR><CR>
+vnoremap g{ :<C-u>VIntSearchCursor cftext v l<CR><CR>
+vnoremap g\ :<C-u>VIntSearchCursor file v l<CR><CR>
 
 call s:nnoreicmap('','<F8>',':VScnext<CR>')
 call s:nnoreicmap('','<S-F8>',':VScprev<CR>')
 ```
 
-I've define the function `s:nnoreicmap()` to map for normal, insert and 
-command-line modes simultaneously, 
-and installed ![vim-fixkey](https://github.com/drmikehenry/vim-fixkey) plugin 
-to use alt-key mappings. 
-`<A-T>` means alt+shift+t.
+`s:nnoreicmap()` is a function to register mappings for normal, insert and 
+command-line modes simultaneously. I installed ![vim-fixkey]
+(https://github.com/drmikehenry/vim-fixkey) to use alt-key mappings.
+
+==============================================================================
+9. Deprecated Commands & Options                       *VIntSearch-deprecated*
+
+Those commands are deprecated since version 1.3.0 and are supposed to be removed
+in version 1.4.0.
+
+*:VIntSearchBuildTag*, *:VSbtag*   
+Build a tag file for the search path.
+
+*:VIntSearchCtags* [keyword], *:VSctags* [keyword]  
+Search for [keyword] by ctags.
+
+*:VIntSearchGrep* [keyword] [grep_options], *:VSgrep* [keyword] [grep_options]  
+Search for [keyword] by grep with [grep_options]. [keyword] can be double-quoted and the argument order can be changed.  
+For example:
+```
+:VSgrep tags
+:VSgrep "let tags"
+:VSgrep tags -i
+:VSgrep -i tags
+:VSgrep "let tags" -i
+```
+(See ```man grep``` for more details about [grep_options])
+
+*:VIntSearchCFGrep* [keyword] [grep_options], *:VScfgrep* [keyword] [grep_options]  
+Search for [keyword] by grep with [grep_options] in the current file.
+
+*:VIntSearchFind* [keyword], *:VSfind* [keyword]  
+Search for [keyword] by find (file search). Curently works with -path options of find command.  
+For example,
+```
+:VSfind *test-class.cpp
+```
+
+*:VIntSearchCtagsCursor* [vimmode] [action]  
+Search for keyword under the cursor by ctags.
+
+[vimmode] can be one of:  
+- 'n' : Use this if vim is in normal mode. Then keyword is the word under the cursor.  
+- 'v' : Use this if vim is in visual mode. Then keyword is the visually selected text.
+
+[action] can be one of:  
+- 'l' : List search result in the quickfix window and open the quickfix window.
+- 'j' : Jump to the first search result. The quickfix window is also updated but not opened.
+
+*:VIntSearchGrepCursor* [vimmode] [action]  
+Search for keyword under the cursor by grep.
+
+*:VIntSearchCFGrepCursor* [vimmode] [action]  
+Search for keyword under the cursor by grep in the current file.
+
+**:VIntSearchFindCursor** [vimmode] [action]  
+Search for *keyword* under the cursor by find (file search).
+
+*g:vintsearch_search_include_patterns*
+File patterns to specified files being searched.
+The tag file generated by |:VIntSearchBuildTag| will only contain files 
+including these patterns in their paths.
+:VIntSearch*Grep commands will search files only including these patterns in
+their names.
+Default: >
+	let g:vintsearch_search_include_patterns =
+		\ ['*.c','*.cpp','*.h','*.hpp','*.inl','*.py','*.lua','*.vim','*.js',
+		\'*.md','*.txt','*.tex']
+<
+
+*g:vintsearch_search_exclude_patterns*
+File patterns to specified files not being searched.
+The tag file generated by |:VIntSearchBuildTag| will only contain files 
+excluding these patterns in their paths.
+:VIntSearch*Grep commands will search files only excluding these patterns in
+their names and paths.
+If a file matches patterns in both |g:vintsearch_search_include_patterns| and
+*g:vintsearch_search_exclude_patterns*, it will be excluded from search results.
+Default: >
+	let g:vintsearch_search_exclude_patterns =
+		\ []
+<
 
 ==============================================================================
-8. Changelog                                            *VIntSearch-changelog*
+10. Changelog                                            *VIntSearch-changelog*
 
 1.2.2                       2015/07/09
     - Add hightlight option for search result (g:vintsearch_highlight_group)
