[Monodevelop-devel] Improving refactoring after 2.0

Mike Krüger mkrueger at novell.com
Fri Nov 7 03:31:07 EST 2008


> Notice that change previewing for the rename operation can be done
> the current infrastructure. It's a matter of finding the references,
> displaying them and do the replace when the user clicks on OK. The API
> supports that, although we haven't implemented the GUI.

No not really. It's a hack. There is an operation called:

IMember RenameMember (RefactorerContext ctx, 
                      IType cls, 
                      IMember member, 
                      string newName);

And that's it. Ok you've:

MemberReferenceCollection FindMemberReferences (RefactorerContext ctx,
string fileName,
IType cls,
IMember member);
MemberReferenceCollection FindVariableReferences (RefactorerContext ctx,
string fileName, LocalVariable var);
MemberReferenceCollection FindParameterReferences (RefactorerContext
ctx, string fileName, IParameter param);

And with these three methods you can hack something together for this
one refactoring case - but that's it. Thisis not really what I've in
mind to do.

> > 
> > I'll need to extend/change the current refactoring infrastructure
> > this. And one of the goals for the new one is: unit test support.
> > new code completion infrastructure is tested with unit tests and I
> > that this has improved the code completion correctness greatly.
> > 
> > Any thoughts/inputs here ?
> I'd like to see a high level design of the API to get an idea of how
> plan to improve the refactoring infrastructure.


Anything seems to be called "refactorer" (Even classes that don't
implement IRefactorer) to make it more stangely we've a refactorer
called CodeGenerator (inheriting from BaseRefactorer). It looks like
thats currently anything is hacked together.
It starts with clicking on something in the editor window there is a
class that builds the context menu and this class controls which
operations are valid.

I want:

Split up refactoring a bit to make it clear what each class does.

I intend to split up the "refactoring" feature. Each refactoring
operation should be an own class that knows it's responsibilities (based
on the resolve result) it knows when it's valid to display in the
refactoring context menu.

Then we would've classes like:



These refactorings should be placed in the addin tree.

We've a RefactorerContext - that's good these context should be
containing the find functions and some helper functions that are
currently splitted up between IRefactorer and CodeRefactorer).

Then we need a CodeGenerator - this is a class that actually builds
code. Not by changing it, it should produce "diffs".

Then we need something like a result of the refactoring operations.
That'll give us a list of files with diffs as well as a list of the
class tree with changes. I intend to have a dialog that looks like:






That's what I intend to:

class RefactoringResult {
	List<Change> Changes;

class Change {
	string fileName; 
	IMember memberLocation;

        DomLocation position;

        string old;
	string new;

Something like this an 'positions' should be switchable between class
view and file view (like the pads).

The Refactoring should something look like:

IRefactoring {
	bool IsSupported (ResolveResult result);
	string GetDisplaySting (ResolveResult result);
	void Run ();

IResultRefactoring : IRefactoring {
	RefactoringResult DoOperation (RefactorerContext, ResolveResult

I want to support maybe more than one type of refactoring, therefore
just the "run" method. And there are more types than just the diff
refactoring - implement/override members for example therefore not all
refactorings require the position/diff dialogs. 
Another example could be renaming a local variable or parameter which
could be displayed inline in the text editor instead of having pop up
dialogs. (Ok I admit I've worked a bit with eclipse this week :) )

To decide: On which infrastructure we'll build. Currently it's a bit
mixed up between CodeDOM and NRefactory. I would've chosen NRefactory
because we're already building on this and an own AST gives more control
than a pre defined one.


More information about the Monodevelop-devel-list mailing list