Difference between revisions of "ThreadSearch plugin"

From Code::Blocks
Line 10: Line 10:
 
== Features ==
 
== Features ==
 
'''ThreadSearch''' plugin offers the following features:
 
'''ThreadSearch''' plugin offers the following features:
<ul>
+
 
<li>multi-threaded "Search in files"</li>
+
* multi-threaded "Search in files"
<li>internal read-only editor to preview the results</li>
+
* internal read-only editor to preview the results
<li>file open in editors notebook</li>
+
* file open in editors notebook
<li>highly configurable</li>
+
* highly configurable
<li>contextual menu "Find occurrences" to start a search in files with the word under cursor</li>
+
* contextual menu "Find occurrences" to start a search in files with the word under cursor
</ul>
 
  
 
== Why ? ==
 
== Why ? ==
<ul>
+
* The default ''Search in files'' displays a blocking dialog. Being blocked for 6 minutes is unpleasant. Workaround was to run 2 Code::Blocks instances.
<li>The default ''Search in files'' displays a blocking dialog. Being blocked for 6 minutes is unpleasant.
+
* The default ''Search in files'' automatically move to first occurrence. Current edition situation is lost, either a new editor is open or cursor is moved.
Workaround was to run 2 Code::Blocks instances.</li>
+
* The line containing search expression may be senseless without its context, forcing user to open the file to browse the result.
<li>The default ''Search in files'' automatically move to first occurrence. Current edition situation is lost, either a new editor is open or cursor is moved.</li>
+
* Impossibility to search in files both in workspace and other directory.
<li>The line containing search expression may be senseless without its context, forcing user to open the file to browse the result.</li>
+
* I love Code::Blocks and I wanted to bring my contribution.
<li>Impossibility to search in files both in workspace and other directory.</li>
 
<li>I love Code::Blocks and I wanted to bring my contribution.</li>
 
</ul>
 
  
 
== Configuration ==
 
== Configuration ==
 
To access '''ThreadSearch''' plugin configuration panel click on:
 
To access '''ThreadSearch''' plugin configuration panel click on:
<ol>
+
 
<li>''Options'' button on Messages notebook ''Thread search'' panel.</li>
+
# ''Options'' button on Messages notebook ''Thread search'' panel.
<li>''Options'' button on ''Thread search'' toolbar.</li>
+
# ''Options'' button on ''Thread search'' toolbar.
<li>''Settings/Environment'' menu item and then on the ''Thread search'' item on the left columns</li>
+
# ''Settings/Environment'' menu item and then on the ''Thread search'' item on the left columns
</ol>
+
 
 
Note :
 
Note :
 
items 1 and 2 may not be available according to current configuration.
 
items 1 and 2 may not be available according to current configuration.
Line 42: Line 38:
  
 
== Usage ==
 
== Usage ==
<ul>
+
* Configure your search preferences (see configuration part).
<li>Configure your search preferences (see configuration part).
+
* Once the plugin is installed, there are 4 ways to run a search :
<li>Once the plugin is installed, there are 4 ways to run a search :
+
 
<ol>
+
# Type/Select a word in the search combo box and press enter or click on ''Search'' on the ''Thread search'' panel of the Messages notebook
<li>Type/Select a word in the search combo box and press enter or click on ''Search'' on the ''Thread search'' panel of the Messages notebook</li>
+
# Type/Select a word in the toolbar search combo box and press enter or click on ''Search'' button
<li>Type/Select a word in the toolbar search combo box and press enter or click on ''Search'' button</li>
+
# Right click on any 'word' in active editor and click on ''Find occurrences of 'word' ''
<li>Right click on any 'word' in active editor and click on ''Find occurrences of 'word' ''</li>
+
# Click on Search/Thread search in the toolbar to search for current word in active editor<br>Note :<br>items 1, 2 and 3 may not be available according to current configuration.
<li>Click on Search/Thread search in the toolbar to search for current word in active editor</li>
+
* Click again on the search button to cancel current search.
</ol>
+
* A single click on a result item displays it on the preview editor at right location.
Note :
+
* A double click on a result item opens or set an editor in editors notebook at right location.
items 1, 2 and 3 may not be available according to current configuration.
 
<li>Click again on the search button to cancel current search.</li>
 
<li>A single click on a result item displays it on the preview editor at right location.</li>
 
<li>A double click on a result item opens or set an editor in editors notebook at right location.</li>
 
</ul>
 

Revision as of 17:21, 1 July 2007

Thread search
ThreadSearch.png
Developer(s): Jérôme ANTOINE
Maintainer(s): Jérôme ANTOINE
Version: 0.7

Features

ThreadSearch plugin offers the following features:

  • multi-threaded "Search in files"
  • internal read-only editor to preview the results
  • file open in editors notebook
  • highly configurable
  • contextual menu "Find occurrences" to start a search in files with the word under cursor

Why ?

  • The default Search in files displays a blocking dialog. Being blocked for 6 minutes is unpleasant. Workaround was to run 2 Code::Blocks instances.
  • The default Search in files automatically move to first occurrence. Current edition situation is lost, either a new editor is open or cursor is moved.
  • The line containing search expression may be senseless without its context, forcing user to open the file to browse the result.
  • Impossibility to search in files both in workspace and other directory.
  • I love Code::Blocks and I wanted to bring my contribution.

Configuration

To access ThreadSearch plugin configuration panel click on:

  1. Options button on Messages notebook Thread search panel.
  2. Options button on Thread search toolbar.
  3. Settings/Environment menu item and then on the Thread search item on the left columns

Note : items 1 and 2 may not be available according to current configuration.

The following configuration panel appears: File:MainAndOptions.png

Usage

  • Configure your search preferences (see configuration part).
  • Once the plugin is installed, there are 4 ways to run a search :
  1. Type/Select a word in the search combo box and press enter or click on Search on the Thread search panel of the Messages notebook
  2. Type/Select a word in the toolbar search combo box and press enter or click on Search button
  3. Right click on any 'word' in active editor and click on Find occurrences of 'word'
  4. Click on Search/Thread search in the toolbar to search for current word in active editor
    Note :
    items 1, 2 and 3 may not be available according to current configuration.
  • Click again on the search button to cancel current search.
  • A single click on a result item displays it on the preview editor at right location.
  • A double click on a result item opens or set an editor in editors notebook at right location.