Child pages
  • Introducing JetBrains dotPeek

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

CamelHumps support is a significant concept that also spans multiple navigation features of dotPeek that are highlighted below.
dotPeek provides the Assembly Explorer to traverse the list of opened assemblies. Expanding an assembly node lists namespaces within the assembly that can be further expanded to types and type members, as well as assembly references. Note that the Assembly Explorer uses the same set of icons that are used in Visual Studio for member identification.

...

  • Edit > Parameter Information (Ctrl+P) on a method call will display all available signatures of the a given method.
  • Edit > Show Quick Documentation (Ctrl+Q) on a usage of a type, method, property, or another type member will display an overview of its documentation comments:

Navigation and Search

The primary idea behind dotPeek is to bring ReSharper experience to browsing external assemblies and make this available to everyone. The main thing that distinguishes dotPeek from other decompilers around is that the majority of ReSharper navigation features are available in dotPeek as well. Let's take a closer look at those:

...

When you're loading an assembly and you don't know what you're looking for and you want to find out how things are organized within the assembly, you start off with assembly explorer the Assembly Explorer and you probably proceed by navigating between symbol declarations in the code view area.

However, you go a different path if you know exactly (or even approximately) which part of the assembly you need to look at - in this case, you can use one of ReSharper's "go to" context-insensitive navigation features:

...

Use Navigate > Go to Type (Ctrl+N) to navigate to a specific class or interface. You type in the name of the type you want to find, and dotPeek searches for a match within all loaded assemblies. Here again, the concept of CamelHumps is applicable - you don't need to type DynamicMethodGenerator to open this class - typing dmg is enough:

...

Use Navigate > Go to Symbol (Ctrl+Shift+Alt+N) to navigate to an a specific symbol declaration, which could be a type, method, field, or property. Again, use CamelHumps to narrow down the list of symbols that dotPeek presents:

Since symbols are a lot more numerous than the number of symbols is greatly higher than that of types, and there can possibly be multiple symbols with the same name, you may want to spend a little more time investigating the list of results. One way to do that is press the plus sign (Show in Find Results) while dotPeek shows symbols in the Go to Symbol drop-down list - this will allow you to flush all found results to the Find Results tool window where you can take your time to investigate themthe results, group based on different criteria, copy to clipboard or export to a file.

...

As soon as you've opened a specific type, use Navigate > Go to File Member for a quick overview of and navigation to members in this file.

Alternatively, you can open the File Structure tool window (Windows > File Structure, or Ctrl+F11) for a static display of members in the current file.

File Structure provides additional file browsing capabilities: for example, if you set Automatically scroll to source in File Structure toolbar, every time you select a member in File Structure, the code view area scrolls to the declaration of this member.
The Track caret in editor option works the opposite way: as you move the caret within the code view area, the corresponding member is highlighted in File Structure.
You can learn more about File Structure options in ReSharper web help.

...

dotPeek also provides Go to File (Navigate > Go to File or Ctrl+Shift+N) to quickly open files and folders. It However, it is limited to temporary files from dotPeek decompiled code cache, so you can use it as an extended tab switcher that not only works with currently opened code files but also takes into account any tabs that you've opened during the current dotPeek session.

Context-Sensitive Navigation Between Symbols in Decompiled Code

dotPeek provides exactly the same level of insight in context-sensitive navigation between decompiled code symbols as ReSharper does for source code. You navigate to symbol declarations, implementations, derived and base symbols, and any other applicable destinations just like you would in Visual Studio with ReSharper enabled.
Specifically, when you've landed the caret on a symbol, you can always get an overview of all possible navigation targets using the Navigate To drop-down menu (Navigate > Navigate To or Ctrl+Shift+G):

The majority of navigation destination destinations presented in the Navigate To drop-down menu are also available directly through the top-level Navigate menu.
The following context-sensitive navigation commands can be available depending on context:

  • Go to Declaration (Ctrl+B): this takes you from a usage of any symbol to its declaration. Should the symbol be dependent on another assembly, the assembly will be loaded silently, if available.
  • Go to Base Symbols (Ctrl+U): this takes you to corresponding symbols upwards the inheritance hierarchy:
  • Go to Derived Symbols (Ctrl+Alt+B): the opposite of base symbols, this command lets you go to any of implementing/overriding members or implementing/derived types:
  • Go to Implementation (Ctrl+Shift+Alt+B): allowing navigating to end implementations of types and type members, bypassing intermediate inheritance steps in the inheritance chain, such as abstract classes.
  • Go to Extension Methods (only available through Navigate To): shows all extension methods for a certain type.
  • Go to Sources from Symbol Files (only available through Navigate To): download symbol information from a source server and recreate source code. (See below for more information.)
  • Go to Assembly Explorer (only available through Navigate To): navigates from a type or type member in source code view to the corresponding node in the Assembly Explorer. Interestingly, this command is duplicated by another shortcut, Shift+Alt+L, that, when applied in ReSharper, locates the current currently open file in the Solution Explorer.

For more details on these and other special-purpose commands available through the Navigate To drop-down menu, see ReSharper web help.

Note
titleKnown Issue

The Navigate To functionality is shared between ReSharper and dotPeek. As of early EAP, the Navigate To menu in dotPeek contains several items that are ReSharper-specific, such as Go to Related Files. These items will be removed in subsequent EAP builds.

...

  • Navigate > Find Usages (Alt+F7): This finds all usages of a symbol (method, property, local variable etc.) from its any occurrence, be it a declaration or one of its usages. You can invoke this command from the code view area, from the Assembly Explorer, or any other tool window. If more than a single usage is found, all usages are fetched to the Find Results tool window where you can group them in different ways, navigate between them, and open in the code view area. You can learn more about Find Usages on ReSharper web site.
  • Navigate > Usages of Symbol (Ctrl+Alt+F7): This is a modification on Find Usages that shows a pop-up with all found usages instead of flushing them to Find Results. This is handy when you have a limited number set of usages from which you can quickly pick the one you need. It is also available via the Navigate To drop-down menu.
  • Navigate > Find Usages Advanced (Shift+Alt+F7): This is a zoomed-in version of Find Usages that allows you to fine-tune search criteria by limiting its the scope of search and other characteristics.
Note
titleKnown Issue

As of early EAP, the Find Usages Advanced dialog box contains ReSharper-specific items. These items will be removed in subsequent EAP builds.

Other Features

Type Hierarchy

We've already covered Go to Derived Symbols and Go to Base Symbols above but these two features are useful when you want to go to an inheritor or a base symbol right away. What if you're looking to plainly get an overview of a certain inheritance chain? That's where the Type Hierarchy view comes handy: press Ctrl+Alt+H on a usage of any type, and dotPeek will show you all types that are inherited from it, as well as types that it inherits itself - as a tree view, in a separate tool window.

Goodness doesn't end here, though: you can select nodes in the tool window, rebase hierarchies on them; show or hide preview previews of type members; and switch between several hierarchy views: for example, you can opt to only show subtypes or supertypes of a given type.

...

Decompiled code is better than nothing (especially if it's decompiled with dotPeek) but sometimes you want to explore an assembly exactly the way it had been originally written, and be able to read comments its developers have made. Sometimes dotPeek can help with that: it is able to get symbol information and recreate source code from Microsoft Reference Source Center and SymbolSource.org. You can try calling Navigate > Navigate To > Sources from Symbol Files on a type or member and see if symbol information for this particular assembly is available. Before you do that, though, go to File > Options and select Allow downloading from remote locations.

Note
titleKnown Issue

As of early EAP testing, Microsoft Reference Source Server frequently refuses download requests from dotPeek. One particular side effect of this behavior is that the EULA dialog box is shown multiple times before a PDB download is finally rejected. We're looking to find ways to improve this highly annoying behavior.

Keyboard-Driven Navigation Between Tool Windows

In the best traditions of JetBrains tools, you rarely need to use a mouse when working with dotPeek: switching between the Assembly Explorer and the code view area; opening File Structure, Find Results, Type Hierarchy and other tool windows doesn't require clickingmouse clicks: every tool window is assigned a shortcut of its own (see the Windows menu for shortcut hints), and getting back to the code view area is as easy as pressing Esc.

...

When it comes to customizing your workspace within dotPeek, you do need the mouse but otherwise, it's plain easy and familiar. Tool windows behave the same way they do in Visual Studio: they can be left floating or docked in multiple positions. Find Results and Type Hierarchy support multiple tabs, allowing you to have several set sets of search results or hierarchies open at the same time, and File Structure content can be filtered to only display results that match a search string:

...