1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
cdt/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_search.htm

153 lines
6.5 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Searching for C/C++ elements</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
<div role="main"><h1>Searching for C/C++ elements</h1>
<p>It is recommended that you perform searches on successfully compiled
programs to ensure the accuracy of search results. It is important to familiarize yourself with the correct search syntax
to use to complete an effective search. It is also important to ensure that
include paths and symbols are correctly defined. For more information, see
<a href="../tasks/cdt_t_sd.htm">Setting up include paths and macros for C/C++ indexer</a>.</p>
<p>See <a href="../concepts/cdt_c_search.htm">C/C++ search</a>, for more information on:</p>
<ul>
<li>What you can search for</li>
<li>How to limit your search</li>
<li>How to use wildcard characters in your search</li>
<li>Syntax examples</li>
</ul>
<p>Performing a C/C++ Search can be done in a number of different ways but regardless of the manner chosen the same information must be provided to C/C++ Search.</p>
The info required to do a search is:
<table border="1" cellpadding="4" cellspacing="0" valign="top" bordercolor="#DDDDDD" width="700px" summary="Search options">
<tr>
<th id="option" style="width:25%" scope="col">Option</th>
<th id="explanation" style="width:75%" scope="col">Explanation</th>
</tr>
<tr>
<td valign="top" headers="option"><strong>Search string</strong></td>
<td valign="top" headers="explanation">this is the name of the element you are looking for. See <a href="../concepts/cdt_c_search.htm">C/C++ search</a> for more information on how to specify wildcard searches and how to further refine your searches by using fully qualified names</td>
</tr>
<tr>
<td valign="top" headers="option"><strong>Search For </strong></td>
<td valign="top" headers="explanation">this is the element type that you wish to search for. You can also select to search on 'Any Element' which will perform the search on a combination of all elements</td>
</tr>
<tr>
<td valign="top" headers="option"><strong>Limit To</strong></td>
<td valign="top" headers="explanation">this allows you to limit your search to declarations, definitions or references. You can also select 'All Occurrences' which will search for declarations, definitions and references that match the element</td>
</tr>
<tr>
<td valign="top" headers="option"><strong>Scope</strong></td>
<td valign="top" headers="explanation">this allows the user to limit the scope of the search. The three available scopes are:
<table cellpadding="2">
<tr class="hidden">
<th id="scope"> Scope</th>
<th id="description">Description</th>
</tr>
<tr>
<td valign="top" headers="scope"><strong>Workspace</strong></td>
<td valign="top" headers="description">this searches all of the open projects in the workspace</td>
</tr>
<tr>
<td valign="top" headers="scope"><strong>Selected Resources</strong></td>
<td valign="top" headers="description">this option becomes enabled whenever something is selected in one of the following views in the C/C++ perspective:
<ul>
<li>C/C++ Projects</li>
2007-06-14 15:58:09 +00:00
<li>Project Explorer</li>
<li>Search</li>
<li>Outline</li>
</ul>
<p>The scope will be limited to whatever element is selected in the view.</p>
</td>
</tr>
<tr>
<td valign="top" headers="scope"><strong>Working Set</strong></td>
<td valign="top" headers="description">working sets can be selected and created </td>
</tr>
</table>
</td>
</tr>
</table>
<p>There are 3 main ways for initiating a C/C++ search:
<ul>
<li>Using the <strong>C/C++ Search</strong> dialog</li>
<li>Selecting an element in the <strong>Editor</strong> view</li>
<li>Selecting an element in the <strong>C/C++ Projects</strong> view or Selecting an element from the <strong>Outline</strong> view</li>
</ul>
<br>
<br>
<h2>Using the C/C++ Search dialog</h2>
<p> <img src="../images/search.png" alt="Search dialog box"></p>
<ol>
<li>Enter the search string in the <strong>Search String</strong> field (optional mark it case sensitive). <br>
<strong>Note: </strong>that previous search queries (from the same work session) are remembered and can be accessed via the drop down list.</li>
<li>Select the <strong>Search For</strong> element.</li>
<li>Select the <strong>Limit To</strong>.</li>
<li>Select the <strong>Scope</strong>.</li>
<li>Press <strong>Search</strong>.</li>
</ol>
<p>Results are displayed in the <a href="../reference/cdt_u_search_view.htm">Search</a> view.</p>
<h2>Selecting an element in the Editor view</h2>
<ol>
<li>Select the desired element in the editor.</li>
<li>Right click and select <strong>All Declarations</strong> or <strong>All References</strong> and the scope you wish to search.</li>
</ol>
<p>Results are displayed in the <strong>Search</strong> view.</p>
<h2>Selecting an element in C/C++ Projects or Outline View</h2>
<ol>
<li>Select the desired element in the tree.</li>
<li>Right click and select <strong>All Declarations</strong> or <strong>All References</strong> and the scope you wish to search.</li>
</ol>
<p>Results are displayed in the <strong>Search</strong> view.</p>
<p>For more information, see:
<ul>
<li><strong>Workbench User Guide &gt; Concepts &gt; Views &gt; Search view</strong></li>
<li><strong>Workbench User Guide &gt; Concepts &gt; Workbench &gt; Working Set</strong></li>
<li><strong>Workbench User Guide &gt; Tasks &gt; Navigating and finding resources</strong></li>
</ul>
<p><img src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
<br>
<a href="../concepts/cdt_c_search.htm">C/C++ search</a><br>
2004-06-22 13:27:13 +00:00
<a href="../concepts/cdt_c_indexer.htm">C/C++ Indexer</a><br>
<a href="../concepts/cdt_c_projects.htm">CDT Projects</a><br>
2007-06-14 15:58:09 +00:00
<a href="../concepts/cdt_c_open_declarations.htm">Open Declaration</a><br>
Doc update from Devin. Here's what I've changed: changes to the doc htm files: - added open definition -> added concepts/cdt_c_open_definitions.htm -> added images/openDefinition.png -> added images/open_definition_error.png -> updated images/openDeclaration.png -> updated images/open_declaration_error.png -> added tasks/cdt_t_open_definitions.htm -> updated links to point to open definition wherever open declaration is linked - information about the code reader buffer and properties in the menu -> added images/cdt_pref_parser.png -> added reference/cdt_o_parser_pref.htm (C/C++ Parser preferences) -> added reference/cdt_u_c_parser_codereader_cache_pref.htm -> added link to cdt_o_parser_pref.htm in reference/cdt_o_ref.htm - removed reference/cdt_u_shared_lib_view_pref.htm since it has no useful information (also removed the corresponding link in contexts_CDT_DEBUGGER.xml) - renamed the link absolute path "file:///E:/CDT/3.1/eclipse/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG" in tasks/indexer_importing_large_project.html to the relative path "../images/indexer_import_largeproject1.PNG" dead links: removed: concepts/cdt_c_editor.htm -> <br><a href="../reference/cdt_u_editor_key_bind.htm">C/C++ editor key binding actions</a> removed: concepts/cdt_c_indexer_ctagsindexer.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer_ctagsindexer.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> removed: concepts/cdt_c_indexer_fullindexer.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer_fullindexer.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> removed: concepts/cdt_c_indexer_open_close.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer_open_close.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> removed: concepts/cdt_c_indexer_prog_bar.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer_prog_bar.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> removed: concepts/cdt_c_indexer.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> renamed to references/cdt_u_m_edit.htm: concepts/cdt-c_templates.htm -> <a href="../reference/cdt_u_menu_edit.htm">Edit menu</a> removed: concepts/cdt_o_concepts.htm -> <img src="../images/trans.gif" border="0" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_c_indexer_prob_rep.htm">C/C++ Indexer Problem Reporting</a><br> removed: reference/cdt_u_m_project.htm -> Concepts/cdtconcepts-4.htm removed: reference/cdt_u_m_project.htm -> Tasks/cdttasks-106.htm removed: reference/cdt_o_ref.htm -> reference/cdt_u_mfile_rbcs.htm removed: reference/cdt_o_ref.htm -> reference/cdt_u_search_pref.htm renamed to cdt_o_mproj_pref.htm: reference/cdt_o_ref.htm -> reference/cdt_o_mproj_pref.htm removed: reference/cdt_u_m_project.htm -> Tasks/cdttasks-106.htm removed: tasks/cdt_o_tasks.htm -> <img src="../images/trans.gif" border="0" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_t_indexer_prob_rep.htm">C/C++ Indexer Problem Reporting</a><br>
2005-08-12 13:43:10 +00:00
</p>
2004-06-22 13:27:13 +00:00
<p><img src="../images/ngtasks.gif" ALT="Related tasks" width="143" height="21"><br>
<a href="cdt_t_sel_search.htm">Selection Searching for C/C++ elements</a><br>
Doc update from Devin. Here's what I've changed: changes to the doc htm files: - added open definition -> added concepts/cdt_c_open_definitions.htm -> added images/openDefinition.png -> added images/open_definition_error.png -> updated images/openDeclaration.png -> updated images/open_declaration_error.png -> added tasks/cdt_t_open_definitions.htm -> updated links to point to open definition wherever open declaration is linked - information about the code reader buffer and properties in the menu -> added images/cdt_pref_parser.png -> added reference/cdt_o_parser_pref.htm (C/C++ Parser preferences) -> added reference/cdt_u_c_parser_codereader_cache_pref.htm -> added link to cdt_o_parser_pref.htm in reference/cdt_o_ref.htm - removed reference/cdt_u_shared_lib_view_pref.htm since it has no useful information (also removed the corresponding link in contexts_CDT_DEBUGGER.xml) - renamed the link absolute path "file:///E:/CDT/3.1/eclipse/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG" in tasks/indexer_importing_large_project.html to the relative path "../images/indexer_import_largeproject1.PNG" dead links: removed: concepts/cdt_c_editor.htm -> <br><a href="../reference/cdt_u_editor_key_bind.htm">C/C++ editor key binding actions</a> removed: concepts/cdt_c_indexer_ctagsindexer.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer_ctagsindexer.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> removed: concepts/cdt_c_indexer_fullindexer.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer_fullindexer.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> removed: concepts/cdt_c_indexer_open_close.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer_open_close.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> removed: concepts/cdt_c_indexer_prog_bar.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer_prog_bar.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> removed: concepts/cdt_c_indexer.htm -> <a href="../tasks/cdt_t_indexer_timeout.htm"></a> removed: concepts/cdt_c_indexer.htm -> <a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a> renamed to references/cdt_u_m_edit.htm: concepts/cdt-c_templates.htm -> <a href="../reference/cdt_u_menu_edit.htm">Edit menu</a> removed: concepts/cdt_o_concepts.htm -> <img src="../images/trans.gif" border="0" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_c_indexer_prob_rep.htm">C/C++ Indexer Problem Reporting</a><br> removed: reference/cdt_u_m_project.htm -> Concepts/cdtconcepts-4.htm removed: reference/cdt_u_m_project.htm -> Tasks/cdttasks-106.htm removed: reference/cdt_o_ref.htm -> reference/cdt_u_mfile_rbcs.htm removed: reference/cdt_o_ref.htm -> reference/cdt_u_search_pref.htm renamed to cdt_o_mproj_pref.htm: reference/cdt_o_ref.htm -> reference/cdt_o_mproj_pref.htm removed: reference/cdt_u_m_project.htm -> Tasks/cdttasks-106.htm removed: tasks/cdt_o_tasks.htm -> <img src="../images/trans.gif" border="0" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_t_indexer_prob_rep.htm">C/C++ Indexer Problem Reporting</a><br>
2005-08-12 13:43:10 +00:00
<a href="cdt_t_open_declarations.htm">Navigate to C/C++ declarations</a><br>
</p>
2004-06-22 13:27:13 +00:00
<p><img src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
<br>
<a href="../reference/cdt_u_search.htm">C/C++ search page, Search dialog box</a></p>
2010-05-10 20:25:24 +00:00
<hr >
2007-06-14 15:58:09 +00:00
<img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" >
</div></body>
</html>