Pattern searching provides a means to widen a search beyond a single element. A pattern search can be executed using the command
:RubySearch -p <pattern> [-t <type> -s <scope> -i -a <action>]
When there is more than 1 result, those results will be placed into vim's quickfix list (:help quickfix) so that you can easily navigate them using vim's quickfix commands.
Vim command completion is supported through out the command with the exception of the pattern to search for.
:RubySearch <Tab> :RubySearch -p MyClass* <Tab> :RubySearch -p MyClass* -t <Tab> :RubySearch -p MyClass* -t class <Tab> :RubySearch -p MyClass* -t class -s <Tab> :RubySearch -p MyClass* -t class -s project
-p <pattern>: The pattern to search for.
MyClass myFunction my*
-t <type> (Default: all): The type of element to search for where possible types include
-x <context> (Default: declarations): The context of the search, where possible values include
-s <scope> (Default: all): The scope of the search where possible values include
-i: Ignore case when searching.
-a: The vim command to use to open the result (edit, split, vsplit, etc).
Element searching allows you to place the cursor over just about any element in a source file (method call, class name, constant) and perform a search for that element. Performing an element search is the same as performing a pattern search with the exception that you do not specify the -p option since the element under the cursor will be searched for instead.
If only one result is found and that result is in the current source file, the cursor will be moved to the element found. Otherwise, on single result matches, the value of g:EclimRubySearchSingleResult will be consulted for the action to take. If there are multiple results, the quickfix list will be opened with the list of results.
As a convenience eclim also provides the command :RubySearchContext. This
command accepts only the optional
-a argument described above, and will
perform the appropriate search depending on the context of the element under the
g:EclimRubySearchSingleResult (Default: 'split') - Determines what action to take when a only a single result is found.
Possible values include:
This setting overrides the global default for all supported language types which can be set using the g:EclimDefaultFileOpenAction setting which accepts the same possible values.