sponsor Vim development Vim logo Vim Book Ad

SrchRplcHiGrp.vim : Search and/or replace based on a syntax highlight group

 script karma  Rating 27/9, Downloaded by 2697  Comments, bugs, improvements  Vim wiki

created by
David Fishburn
script type
SR = Search and/or Replace

This plugin defines some commands to allow you to:
1.  Search for characters with a particular syntax highlight group
2.  Search and replace characters with a particular syntax highlight group

Displays the syntax id and name the of the syntax group
which has been chosen.

                Before you can run the search and replace command (:SRHiGrp),
                you must choose which syntax group id you want to operate on.  
                The top level syntax id of the current cursor position is
                chosen (ie. the top-level one versus the final one).

                The optional bang lets SRChooseHiGrp use the translated
                syntax ID. This is final one versus the top-level one.

                Assuming we were using a SQL file and placed the cursor on the
                FROM word, then using the SyntaxAttr plugin
                it displays both the top-level and translated
                (or final) highlight group as follows:
                  group: sqlKeyword->Statement guifg=#ffff00(#ffff00)

                      Will operate on only sqlKeyword syntax groups

                      Will operate on all Statement syntax groups.  Based on
                      |group-name|, the Statement group will highlight the
                      same color for the following highlight groups:
                      Therefore SRChooseHiGrp! will operate over all of the
                      above syntax groups.

                This command will perform a search and replace over a visual
                range.  It works in all visual modes, characterwise (v),
                linewise (V) and blockwise (<C-V>).

It optionally takes takes 2 parameters.

                Parameter 1 controls what characters are matched.  The default
                for this value is \(\w\+\>\).  This expression is appended to
                the \%# which starts the match from the current cursor
                position.  This expression must specify a submatch \(...\).

Parameter 2 controls what to do with the matched string.  The
default for this value is \U\1.  This expression will cause
the matched string to be UPPER cased.  The \1 refers to the
                submatch from the first parameter.

If the parameters are not supplied, the user will be prompted
to enter the expression(s).

                The optional bang (!) works the same as SRHiGrp, but will
                operate on all syntax groups that are NOT the chosen one

[range]SRHiGrp[!] 'from-pattern','to-string'

                This command will perform a forward search starting at the current
                cursor position for a specified highlight group name.  The range defaults
                to the entire file.  It supports all visual modes, characterwise (v),
                linewise (V) and blockwise (<C-V>).

                It will optionally take a regular expression and match on both the syntax
                group and the regular expression.

                When using SRSearch! it NOT match the syntax group.

3. Examples *srchrplchigrp-examples*


First place your cursor on an item that is syntax colored the way
you want:

Next, visually select a block of text
(all visual modes are supported)
:SRHiGrp '\(\w\+\>\)'
:SRHiGrp '\(\w\+\>\)', '\U\1'

If you had the following in a SQL file:
if exists( select 1
            from sys.sysprocedure sp
             key join sys.sysuserperm sup
           where sp.proc_name = 'sp_http_course_detail'
             and sup.user_name = user_name()             ) then
    drop procedure sp_http_course_detail;
end if;

Where the keywords (if, exists, select, from ...) are all
highlighted yellow (based on my colorscheme).  After I visually
select the area and run the command taking default prompts:

The result is:
            FROM sys.sysprocedure sp
             KEY JOIN sys.sysuserperm sup
           WHERE sp.proc_name = 'sp_http_course_detail'
             AND sup.user_name = user_name()             ) THEN
    DROP PROCEDURE sp_http_course_detail;

Where the keywords (if, exists, select, from ...) are all
highlighted yellow (based on my colorscheme).  After I visually
select the area and run the command taking default prompts:

The result is:
if exists( select 1
            from SYS.SYSPROCEDURE SP
             key join SYS.SYSUSERPERM SUP
             and SUP.USER_NAME = USER_NAME()             ) then
    drop procedure SP_HTTP_COURSE_DETAIL;
end if;

SRSearch simply does a forward search for the specified highlight
        group.  You must first use SRChooseHiGrp to choose a highlight group.
        Find the next item highlighted as that syntax group:  

        Find the next item highlighted that is NOT that syntax group:

        Find the next item highlighted as that syntax group and matches
        the regular expression supplied:
:SRSearch something
:SRSearch \(first\|second\|word\)

        Find the next item highlighted that is NOT that syntax group and
        matches the regular expression supplied:
:SRSearch! \(first\|second\|word\)

        The results of the search is displayed in the command line and is
        highlighted in the color of the syntax group.  This will remind you
        which group was searched for.
            SRSearch - Match found - Group ID: 171  Name: sqlKeyword
            SRSearch - Match NOT found - Group ID: 171  Name: sqlKeyword
            SRSearch - Match found - Group ID: 171  Name: sqlKeyword  Regex: \(first\|second\|word\)
            SRSearch - Match NOT found - Group ID: 171  Name: sqlKeyword  Regex \(first\|second\|word\)

install details
Unzip into your vimfiles(windows) or .vim(Unix) directory (using directory structure).
Run the following to update the Vim help files:
:helptags $VIM/vimfiles/doc
:helptags $VIM/.vim/doc


rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
SrchRplHiGrp_v70.zip 7.0 2015-08-25 7.0 David Fishburn Changed SRSeach.  

It will first look for the next item that has the syntax group chosen via SRChooseHiGrp.  

It will also take an optional regular expression and not only find that syntax group, but also match the regular expression.

Added SRSearch!, which will find the next item that is NOT what was chosen via SRChooseHiGrp.  

Same applied with the regular expression, so if I put my cursor on a comment and

Then ran
    :SRSearch! something

It will find the word "something" that is NOT in a comment.
SrchRplHiGrp_v60.zip 6.0 2015-07-27 7.0 David Fishburn - Changed to save and restore cp options on load

- Changed to use Vim's autoload mechanism to load only when required (speeds Vim's load time and memory usage)

- When using SRHiGrp! (operate over non-matching areas) the plugin always reported "Did not find highlight group" (Mathieu Westphal)

- SRHiGrp now defaults the range to the entire file, instead of the current row
SrchRplHiGrp_v50.zip 5.0 2011-01-01 7.0 David Fishburn When using SRSearch only stop at the next match when clearly moving between gaps of the highlight group (Sergio).
SrchRplHiGrp_v40.zip 4.0 2008-01-30 7.0 David Fishburn Fixed an undefined variable and some boundary conditions.
SrchRplHiGrp.zip 2.0 2006-04-11 6.0 David Fishburn New command, SRSearch, so you can find characters with a specific syntax highlight group.

Changed SRHiGrp to escape the regex provided.  This saves you from having to escape the expression yourself.
SrchRplHiGrp.zip 0.15 2004-01-09 6.0 David Fishburn Changed SRChooseGrp to default to the top-level syntax group instead of the translated group.  Using SRChooseGrp! will choose the translated group (which will effect more values).
Added a help file.
Removed SRHiGrpNot and replaced it with SRHiGrp!.
Updated the examples.
Most of this work was done by Dr. Chip (thanks!).
ip used for rating:

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.