PageRenderTime 45ms CodeModel.GetById 16ms RepoModel.GetById 1ms app.codeStats 0ms

/tags/SN-513-2003-04-09/snavigator/doc/html/enterprise/userguide/intro.html

https://gitlab.com/OpenSourceMirror/sourcenav
HTML | 299 lines | 244 code | 55 blank | 0 comment | 0 complexity | 07eedf96b653eda1837dd6e79a11eef8 MD5 | raw file
    

  1. <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4.    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    5. 

  5.    <meta http-equiv="Content-Style-Type" content="text/css">
    6. 

  6.    <meta name="GENERATOR" content="Mozilla/4.51 [en] (WinNT; U) [Netscape]">
    7. 

  7.    <title>Introduction</title>
    8. 

  8. </head>
    9. 

  9. <body bgcolor="#FFFFFF">
    10. 

  10. 

  11. <h1 CLASS="Chapter">
    12. 

  12. <a NAME="pgfId-1034206"></a><a NAME="pgfId-1034208"></a><a NAME="33630"></a>Introduction</h1>
    13. 

  13. <img SRC="intro-1.gif" >
    14. 

  14. 

  15. <p CLASS="Body"><a NAME="pgfId-1036070"></a>Source-Navigator<sup>TM</sup>
    16. 

  16. 99r1 is a powerful code analysis and comprehension tool that provides a
    17. 

  17. graphic framework for understanding and reengineering large or complex
    18. 

  18. software projects. Source-Navigator's cross-platform nature also makes
    19. 

  19. it an invaluable code porting tool.
    20. 

  20. 

  21. <p CLASS="Body"><a NAME="pgfId-1035068"></a>Source-Navigator parsers scan
    22. 

  22. through source code, extracting information from existing C, C++, Java,
    23. 

  23. Tcl, <tt>[incr tcl]</tt>, FORTRAN, Cobol, and assembly programs and then
    24. 

  24. using this information to build a <i>project database</i>. The database
    25. 

  25. represents internal program structures, locations of function declarations,
    26. 

  26. contents of class declarations, and relationships between program components.
    27. 

  27. Source-Navigator graphical browsing tools use this database to query symbols
    28. 

  28. (such as functions and global variables) and the relationships between
    29. 

  29. them.
    30. 

  30. 

  31. <p CLASS="Body"><a NAME="pgfId-1036095"></a>In addition to the languages
    32. 

  32. supported in the standard distribution, you can use the Source-Navigator
    33. 

  33. Software Development Kit (SDK) to add new parsers and extend Source-Navigator
    34. 

  34. functionality to other languages.
    35. 

  35. <h3 CLASS="Heading1">
    36. 

  36. <a NAME="pgfId-988404"></a>Managing Projects</h3>
    37. 

  37. 

  38. <div CLASS="Body"><a NAME="pgfId-988407"></a>A&nbsp;<a NAME="marker-988405"></a>Source-Navigator
    39. 

  39. <i>project<a NAME="marker-988406"></a></i>
    40. 

  40. is an entity containing references to source code files. A project describes
    41. 

  41. where files are located and how to operate on them. Once a project is defined,
    42. 

  42. developers can:</div>
    43. 

  43. 

  44. <ul>
    45. 

  45. <li CLASS="Bullet">
    46. 

  46. <a NAME="pgfId-894045"></a>identify, locate, access, modify, and analyze
    47. 

  47. program components, including symbol definitions and usage of classes in
    48. 

  48. object-oriented languages.</li>
    49. 

  49. 

  50. <li CLASS="Bullet">
    51. 

  51. <a NAME="pgfId-894046"></a>prevent parallel modifications on the same code
    52. 

  52. and manage different versions of sources by way of an interface to external
    53. 

  53. version control systems such as ClearCase and CVS.</li>
    54. 

  54. 

  55. <li CLASS="Bullet">
    56. 

  56. <a NAME="pgfId-1036106"></a>create views of pertinent information while
    57. 

  57. hiding information not relevant for the current view.</li>
    58. 

  58. </ul>
    59. 

  59. 

  60. <h4 CLASS="Heading2">
    61. 

  61. <a NAME="pgfId-885382"></a>Navigational Tools</h4>
    62. 

  62. 

  63. <div CLASS="Body"><a NAME="pgfId-889612"></a>All Source-Navigator tools
    64. 

  64. are organized around the&nbsp;<a NAME="marker-889611"></a>project database
    65. 

  65. that holds all project-specific symbols. The name and location of the project
    66. 

  66. files, symbols extracted from the source code, and the relationships between
    67. 

  67. symbols all reside in the project database. File structure may not be pertinent
    68. 

  68. when visualizing code relationships, so Source-Navigator allows you to
    69. 

  69. view and understand software structure regardless of which file contains
    70. 

  70. what information.</div>
    71. 

  71. 

  72. <div CLASS="Body"><a NAME="pgfId-889616"></a>The&nbsp;<a NAME="marker-889613"></a>Symbol
    73. 

  73. Browser, the&nbsp;<a NAME="marker-889614"></a>Editor, and the&nbsp;<a NAME="marker-889615"></a>Cross-Referencer
    74. 

  74. are the basic tools for working with source code in a project.</div>
    75. 

  75. 

  76. <ul>
    77. 

  77. <li CLASS="Bullet">
    78. 

  78. <a NAME="pgfId-1010192"></a>The Symbol Browser operates on the project
    79. 

  79. database and helps you learn the existing program structure. The Symbol
    80. 

  80. Browser list can be sorted and filtered in different ways, showing you
    81. 

  81. how and where symbols are used. The Symbol Browser answers the question
    82. 

  82. "What is in this project?"</li>
    83. 

  83. 

  84. <br>&nbsp;
    85. 

  85. <div CLASS="BodyListFollow"><a NAME="pgfId-1010193"></a>See <a href="symbrws.html#16805" CLASS="XRef">Symbol
    86. 

  86. Browser</a> for more information.</div>
    87. 

  87. </ul>
    88. 

  88. 

  89. <ul>
    90. 

  90. <li CLASS="Bullet">
    91. 

  91. <a NAME="pgfId-991773"></a>The Editor, the main Source-Navigator window,
    92. 

  92. combines navigating with browsing. It allows you to navigate through actual
    93. 

  93. program text and shows the location of that text in the source code. The
    94. 

  94. Editor highlights the basic syntax of all supported programming languages
    95. 

  95. and updates the project database when files are modified and saved. This
    96. 

  96. means that the project database is always up-to-date with your changes
    97. 

  97. during the development cycle. The Editor answers the question "How is this
    98. 

  98. project structured?"</li>
    99. 

    100. 

  100. <br>&nbsp;
    101. 

  101. <div CLASS="BodyListFollow"><a NAME="pgfId-1010229"></a>See <a href="editor.html#40005" CLASS="XRef">Editor</a>
    102. 

  102. for more information.</div>
    103. 

  103. </ul>
    104. 

  104. 

  105. <ul>
    106. 

  106. <li CLASS="Bullet">
    107. 

  107. <a NAME="pgfId-884895"></a>The Cross-Referencer shows, for a given symbol,
    108. 

  108. all the other symbols it refers to, and all the symbols that refer to it.
    109. 

  109. These are known as <i>Refers-to</i> and <i>Referred-by</i> relationships,
    110. 

  110. respectively. The Cross-Referencer answers the question "How do the parts
    111. 

  111. of this project work together?"</li>
    112. 

    113. 

  113. <br>&nbsp;
    114. 

  114. <div CLASS="BodyListFollow"><a NAME="pgfId-1010230"></a>See <a href="crossref.html#35957" CLASS="XRef">Cross-Referencer</a>
    115. 

  115. for more information.</div>
    116. 

  116. </ul>
    117. 

  117. 

  118. <h3 CLASS="Heading1">
    119. 

  119. <a NAME="pgfId-857195"></a><a NAME="10308"></a>About this Guide</h3>
    120. 

  120. 

  121. <div CLASS="Body"><a NAME="pgfId-884185"></a>This guide serves as a reference
    122. 

  122. to Source-Navigator menus, tools, and functionality.</div>
    123. 

  123. 

  124. <h4 CLASS="Heading2">
    125. 

  125. <a NAME="pgfId-886167"></a>Document Conventions</h4>
    126. 

  126. 

  127. <div CLASS="Body"><a NAME="pgfId-857408"></a>Source-Navigator's documentation
    128. 

  128. uses the following general&nbsp;<a NAME="marker-886449"></a>conventions:</div>
    129. 

  129. 

  130. <br>&nbsp;
    131. 

  131. <table WIDTH="100%" >
    132. 

  132. <tr>
    133. 

  133. <td VALIGN=TOP>
    134. 

  134. <div CLASS="BodyHang2"><a NAME="pgfId-886989"></a><i>Italic Font</i></div>
    135. 

  135. </td>
    136. 

  136. 

  137. <td VALIGN=TOP>Indicates a new term that will be defined in the text and
    138. 

  138. items called out for special emphasis.</td>
    139. 

  139. </tr>
    140. 

  140. 

  141. <tr>
    142. 

  142. <td VALIGN=TOP>
    143. 

  143. <div CLASS="BodyHang2"><a NAME="pgfId-886990"></a><b>Bold Font</b></div>
    144. 

  144. </td>
    145. 

  145. 

  146. <td VALIGN=TOP>Represents menus, window names, and tool buttons.</td>
    147. 

  147. </tr>
    148. 

  148. 

  149. <tr>
    150. 

  150. <td VALIGN=TOP>
    151. 

  151. <div CLASS="BodyHang2"><a NAME="pgfId-857411"></a><tt>Plain Typewriter
    152. 

  152. Font</tt></div>
    153. 

  153. </td>
    154. 

  154. 

  155. <td VALIGN=TOP>Denotes code fragments, command lines, contents of files,
    156. 

  156. and command names; also indicates directory, file, and project names where
    157. 

  157. they appear in body text.</td>
    158. 

  158. </tr>
    159. 

  159. 

  160. <tr>
    161. 

  161. <td VALIGN=TOP>
    162. 

  162. <div CLASS="BodyHang2"><a NAME="pgfId-887052"></a><i><tt>Italic Typewriter
    163. 

  163. Font</tt></i></div>
    164. 

  164. </td>
    165. 

  165. 

  166. <td VALIGN=TOP>Represents a variable for which an actual value should be
    167. 

  167. substituted.&nbsp;</td>
    168. 

  168. </tr>
    169. 

  169. </table>
    170. 

  170. 

  171. 

  172. <p CLASS="Body"><a NAME="pgfId-885350"></a>Menu names and their submenus
    173. 

  173. are separated by an arrow (->). For example, <b>File -> Open</b> means
    174. 

  174. select the <b>File</b> menu and choose <b>Open</b> from its submenu.
    175. 

  175. 

  176. <p CLASS="Body"><a NAME="pgfId-894130"></a>Paths are written in UNIX notation
    177. 

  177. (forward slashes) throughout; <tt>.../bin</tt> means the directory Source-Navigator
    178. 

  178. is installed into, subdirectory <tt>bin</tt>.
    179. 

  179. <h4 CLASS="Heading2">
    180. 

  180. <a NAME="pgfId-887938"></a><a NAME="20859"></a>Using the Mouse</h4>
    181. 

  181. 

  182. <div CLASS="Body"><a NAME="pgfId-887969"></a>The following are conventions
    183. 

  183. for using the mouse with Source-Navigator:</div>
    184. 

  184. 

  185. <br>&nbsp;
    186. 

  186. <table BORDER >
    187. 

  187. <tr>
    188. 

  188. <td VALIGN=TOP>
    189. 

  189. <div CLASS="CellBody"><a NAME="pgfId-887942"></a>Click</div>
    190. 

  190. </td>
    191. 

  191. 

  192. <td VALIGN=TOP>
    193. 

  193. <div CLASS="CellBody"><a NAME="pgfId-887944"></a>Place the cursor on a
    194. 

  194. specified object and press the left mouse button. Double-click means to
    195. 

  195. click the left mouse button twice in rapid succession without moving the
    196. 

  196. mouse.</div>
    197. 

  197. 

  198. <div CLASS="CellBody"><a NAME="pgfId-1010121"></a>The term "click" alone
    199. 

  199. always means left-click.</div>
    200. 

  200. </td>
    201. 

  201. </tr>
    202. 

  202. 

  203. <tr>
    204. 

  204. <td VALIGN=TOP>
    205. 

  205. <div CLASS="CellBody"><a NAME="pgfId-887946"></a>Ctrl+click</div>
    206. 

  206. </td>
    207. 

  207. 

  208. <td VALIGN=TOP>
    209. 

  209. <div CLASS="CellBody"><a NAME="pgfId-887948"></a>Depress and hold the <b>Ctrl</b>
    210. 

  210. key, simultaneously clicking with the left mouse button.</div>
    211. 

  211. </td>
    212. 

  212. </tr>
    213. 

  213. 

  214. <tr>
    215. 

  215. <td VALIGN=TOP>
    216. 

  216. <div CLASS="CellBody"><a NAME="pgfId-887950"></a>Shift+click</div>
    217. 

  217. </td>
    218. 

  218. 

  219. <td VALIGN=TOP>
    220. 

  220. <div CLASS="CellBody"><a NAME="pgfId-887952"></a>Depress and hold the <b>Shift</b>
    221. 

  221. key, simultaneously clicking with the left mouse button.</div>
    222. 

  222. </td>
    223. 

  223. </tr>
    224. 

  224. 

  225. <tr>
    226. 

  226. <td VALIGN=TOP>
    227. 

  227. <div CLASS="CellBody"><a NAME="pgfId-887954"></a>Right+click</div>
    228. 

  228. </td>
    229. 

  229. 

  230. <td VALIGN=TOP>
    231. 

  231. <div CLASS="CellBody"><a NAME="pgfId-887956"></a>Place the cursor on a
    232. 

  232. specific object and click the right mouse button.</div>
    233. 

  233. </td>
    234. 

  234. </tr>
    235. 

  235. 

  236. <tr>
    237. 

  237. <td VALIGN=TOP>
    238. 

  238. <div CLASS="CellBody"><a NAME="pgfId-887958"></a>Select Text</div>
    239. 

  239. </td>
    240. 

  240. 

  241. <td VALIGN=TOP>
    242. 

  242. <div CLASS="CellBody"><a NAME="pgfId-887960"></a>Click and drag cursor
    243. 

  243. through text (or code) to be selected. Selected text is highlighted.</div>
    244. 

  244. </td>
    245. 

  245. </tr>
    246. 

  246. 

  247. <tr>
    248. 

  248. <td VALIGN=TOP>
    249. 

  249. <div CLASS="CellBody"><a NAME="pgfId-887962"></a>Select Entries</div>
    250. 

  250. </td>
    251. 

  251. 

  252. <td VALIGN=TOP>
    253. 

  253. <div CLASS="CellBody"><a NAME="pgfId-887964"></a>Clicking a line selects
    254. 

  254. it. To indicate the end of the selection, hold down the <b>Shift</b> key
    255. 

  255. and click the desired line. This function is enabled in the Project Editor
    256. 

  256. and file selection boxes.</div>
    257. 

  257. </td>
    258. 

  258. </tr>
    259. 

  259. 

  260. <tr>
    261. 

  261. <td VALIGN=TOP WIDTH="10%">
    262. 

  262. <div CLASS="CellBody"><a NAME="pgfId-887966"></a>Show the number of items
    263. 

  263. in symbol lists</div>
    264. 

  264. </td>
    265. 

  265. 

  266. <td VALIGN=TOP>
    267. 

  267. <div CLASS="CellBody"><a NAME="pgfId-887968"></a>Click the center mouse
    268. 

  268. button or press <b>Alt</b>+right mouse button (Windows); <b>Meta</b>+right
    269. 

  269. mouse button (UNIX).</div>
    270. 

  270. </td>
    271. 

  271. </tr>
    272. 

  272. </table>
    273. 

  273. 

  274. <h4 CLASS="Heading2">
    275. 

  275. <a NAME="pgfId-889426"></a>Keyboard Shortcuts</h4>
    276. 

  276. 

  277. <div CLASS="Body"><a NAME="pgfId-889428"></a>You can use the&nbsp;<a NAME="marker-889427"></a>keyboard
    278. 

  278. to activate many of the functions displayed on the toolbar and in the menus.</div>
    279. 

  279. 

  280. <ul>
    281. 

  281. <li CLASS="Bullet">
    282. 

  282. <a NAME="pgfId-889434"></a>Holding down the <b>Alt</b> key while pressing
    283. 

  283. <b>S</b>
    284. 

  284. is represented as <b>Alt+S</b>.</li>
    285. 

  285. 

  286. <li CLASS="Bullet">
    287. 

  287. <a NAME="pgfId-889435"></a>To open a command in the menu bar, press the
    288. 

  288. <b>Alt</b>
    289. 

  289. key plus the first letter of the menu.</li>
    290. 

  290. 

  291. <li CLASS="Bullet">
    292. 

  292. <a NAME="pgfId-889436"></a>If a letter in the menu item is underlined,
    293. 

  293. press the underlined letter to open the submenu.</li>
    294. 

  294. </ul>
    295. 

  295. 

  296. <div CLASS="Body"><a NAME="pgfId-938107"></a></div>
    297. 

  297. 

  298. </body>
    299. 

  299. </html>
    300. 

  300.