DevExpress CodeRush Tips&Tricks

Refactor! Pro has numerous refactorings which perform a single task. What if we could run several refactorings at once?

For example, there is a support for optimizing namespace references added to the Move Type to File refactoring: after the new file is created, the Optimize Namespace References refactoring does its job. Here are other examples of refactoring (code provider) combinations, which can be performed:

• Introduce Local and Promote to Parameter will create a new refactoring, called something like “Introduce Parameter”.
• Declare Class (Struct) and Declare Method (Property) will create a new multi-declare code provider, which will declare everything at once.
• Introduce Parameter Object and Move Type to File will add a new option for the first refactoring to create a new file.
• And so much more…

So how is it possible to perform an existing refactoring or a code provider from another one?

Let’s assume we would like to execute the Rename refactoring from inside your own refactoring. The Rename refactoring creates linked identifiers (green boxes) over all references and its declaration. The following tasks should be performed:

• Execute the Rename refactoring, to create linked identifiers
• Change linked identifiers’ text to something different
• Commit linked identifiers change

Bear in mind, that we need to handle the Undo correctly – it should work in a single step, when the original refactoring is called (which calls others). So, here is the code with comments on how this can be achieved from inside of your refactoring’s Apply event. The code is some kind of “trick”, and future versions of DXCore will handle this more intelligently.

CSharp code:

private void refactoringProvider1_Apply(object sender, ApplyContentEventArgs ea)
{
  // Find the registered Rename refactoring provider...
  RefactoringProviderBase renameRefactoring = CodeRush.Refactoring.Get("Rename");
  if (renameRefactoring == null)
    return;

  // The following two lines of code are a workaround of some bug (fixed in the 10.2.5+ version)...
  CodeRush.SmartTags.HidePopupMenu();
  CodeRush.Refactoring.MenuDeactivated();

  // Sync caret position and selection range if needed...
  CodeRush.SmartTags.UpdateContext();

  // See if the Rename is available at the current caret position...
  if (renameRefactoring.IsAvailable)
  {
    // Create a compound action, to make the Undo work correctly...
    ICompoundAction compoundAction = CodeRush.TextBuffers.NewMultiFileCompoundAction(refactoringProvider1.DisplayName, true);
    try
    {
      // Set the IsNestedProvider property to indicate that we are going to call the refactoring from inside another one...
      // Note that the IsNestedProvider property is hidden from Intellisense.
      renameRefactoring.IsNestedProvider = true;
      // Apply the Rename refactoring...
      renameRefactoring.Execute();

      // Change linked identifiers created by the Rename provider...
      RenameSelectedIdentifier(ea.SelectionRange);
    }
    catch (Exception e)
    {
      throw e;
    }
    finally
    {
      // Restore the IsNestedProvider property to default value...
      renameRefactoring.IsNestedProvider = false;

      // Commint the Undo...
      compoundAction.Close();
    }
  }
}

private static void RenameSelectedIdentifier(SourceRange selectionRange)
{
  // See if we are inside of a linked identifier...
  if (CodeRush.LinkedIdentifiers.Active)
  {
    ILinkedIdentifierStorage activeStorage = CodeRush.LinkedIdentifiers.ActiveStorage;

    // Find a linked identifier at the caret position...
    ILinkedIdentifier[] linkedIdentifiers = activeStorage.Find(selectionRange);
    if (linkedIdentifiers != null && linkedIdentifiers.Length > 0)
    {
      ILinkedIdentifier linkedIdentifier = linkedIdentifiers[0];

      // Change the text...
      linkedIdentifier.Text += "Renamed";

      // Select the linked identifier, to commit it...
      CodeRush.TextViews.Active.Select(linkedIdentifier.Range);

      // Commit the change...
      CodeRush.Command.Execute("Break All Linked Identifiers");
    }
  }
}

Visual Basic code:

Private Sub RefactoringProvider1_Apply(sender As System.Object, ea As ApplyContentEventArgs) Handles RefactoringProvider1.Apply
  ' Find the registered Rename refactoring provider...
  Dim renameRefactoring As RefactoringProviderBase = CodeRush.Refactoring.Get("Rename")
  If renameRefactoring Is Nothing Then
    Return
  End If

  ' The following two lines of code are a workaround of some bug (fixed in the 10.2.5+ version)...
  CodeRush.SmartTags.HidePopupMenu()
  CodeRush.Refactoring.MenuDeactivated()

  ' Sync caret position and selection range if needed...
  CodeRush.SmartTags.UpdateContext();

  ' See if the Rename is available at the current caret position...
  If renameRefactoring.IsAvailable Then
    ' Create a compound action, to make the Undo work correctly...
    Dim compoundAction As ICompoundAction = CodeRush.TextBuffers.NewMultiFileCompoundAction(RefactoringProvider1.DisplayName, True)
    Try
      ' Set the IsNestedProvider property to indicate that we are going to call the refactoring from inside another one...
      renameRefactoring.IsNestedProvider = True

      ' Apply the Rename refactoring...
      renameRefactoring.Execute()

      ' Change linked identifiers created by the Rename provider...
      RenameSelectedIdentifier(ea.SelectionRange)
    Catch e As Exception
      Throw e
    Finally
      ' Restore the IsNestedProvider property to default value...
      renameRefactoring.IsNestedProvider = False

      ' Commint the Undo...
      compoundAction.Close()
    End Try
  End If
End Sub

Private Shared Sub RenameSelectedIdentifier(ByVal selectionRange As SourceRange)
  ' See if we are inside of a linked identifier...
  If CodeRush.LinkedIdentifiers.Active Then
    Dim activeStorage As ILinkedIdentifierStorage = CodeRush.LinkedIdentifiers.ActiveStorage

    ' Find a linked identifier at the caret position...
    Dim linkedIdentifiers As ILinkedIdentifier() = activeStorage.Find(selectionRange)
    If linkedIdentifiers IsNot Nothing AndAlso linkedIdentifiers.Length > 0 Then
      Dim linkedIdentifier As ILinkedIdentifier = linkedIdentifiers(0)

      ' Change the text...
      linkedIdentifier.Text += "Renamed"

      ' Select the linked identifier, to commit it...
      CodeRush.TextViews.Active.Select(linkedIdentifier.Range)

      ' Commit the change...
      CodeRush.Command.Execute("Break All Linked Identifiers")
    End If
  End If
End Sub

The plug-in source (VS2010) and binaries are attached.

Similar Posts:

• DXCore Linked Identifiers feature
• Refactorings – Rename
• DXCore Services – LinkedIdentifiers
• How to implement the Sync Edit feature from Delphi IDE inside Visual Studio IDE using DXCore
• How to manage the refactoring provider appearance and sub menus in the Popup menu