diff -r 91b171fdd85f -r d51e810107ec RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient.html
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient.html Fri Oct 11 19:05:23 2019 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient.html Fri Oct 11 19:05:59 2019 +0200
@@ -18,647 +18,864 @@
</style>
</head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
<h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient</h1>
+
<p>
Module implementing the refactoring client interface to rope.
</p>
<h3>Global Attributes</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
+
<table>
+
<tr>
<td><a href="#RefactoringClient">RefactoringClient</a></td>
<td>Class implementing the refactoring client interface to rope.</td>
</tr>
</table>
<h3>Functions</h3>
+
<table>
<tr><td>None</td></tr>
</table>
-<hr /><hr />
+<hr />
+<hr />
<a NAME="RefactoringClient" ID="RefactoringClient"></a>
<h2>RefactoringClient</h2>
+
<p>
Class implementing the refactoring client interface to rope.
</p>
<h3>Derived from</h3>
JsonClient
<h3>Class Attributes</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
+
<table>
+
<tr>
<td><a href="#RefactoringClient.__init__">RefactoringClient</a></td>
<td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__abortAction">__abortAction</a></td>
<td>Private method to abort the current action.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__applyChanges">__applyChanges</a></td>
<td>Private method to apply the changes of a given change group.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateChangeOccurrencesChanges">__calculateChangeOccurrencesChanges</a></td>
<td>Private method to calculate the 'Change Occurrences' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateEncapsulateFieldChanges">__calculateEncapsulateFieldChanges</a></td>
<td>Private method to calculate the 'Encapsulate Field' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateExtractChanges">__calculateExtractChanges</a></td>
<td>Private method to calculate the 'Extract' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateImportsChanges">__calculateImportsChanges</a></td>
<td>Private method to calculate the 'Import' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateInlineArgumentDefaultChanges">__calculateInlineArgumentDefaultChanges</a></td>
<td>Private method to calculate the 'Inline Argument Default' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateInlineChanges">__calculateInlineChanges</a></td>
<td>Private method to calculate the 'Inline' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateIntroduceFactoryChanges">__calculateIntroduceFactoryChanges</a></td>
<td>Private method to calculate the 'Introduce Factory' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateIntroduceParameterChanges">__calculateIntroduceParameterChanges</a></td>
<td>Private method to calculate the 'Introduce Parameter' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateLocalToAttributeChanges">__calculateLocalToAttributeChanges</a></td>
<td>Private method to calculate the 'Local Variabe to Attribute' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateMethodObjectChanges">__calculateMethodObjectChanges</a></td>
<td>Private method to calculate the 'Method to Method Object' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateModuleToPackageChanges">__calculateModuleToPackageChanges</a></td>
<td>Private method to calculate the 'Module to Package' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateMoveChanges">__calculateMoveChanges</a></td>
<td>Private method to calculate the 'Move ...' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateRenameChanges">__calculateRenameChanges</a></td>
<td>Private method to calculate the rename changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateRestructureChanges">__calculateRestructureChanges</a></td>
<td>Private method to calculate the 'Restructure' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateSignatureChanges">__calculateSignatureChanges</a></td>
<td>Private method to calculate the 'Signature' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__calculateUseFunctionChanges">__calculateUseFunctionChanges</a></td>
<td>Private method to calculate the 'Use Function' changes based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__clearChanges">__clearChanges</a></td>
<td>Private method to clear the changes cache of a given change group.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__closeProject">__closeProject</a></td>
<td>Private slot to validate the project.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__configChanged">__configChanged</a></td>
<td>Private method to handle a change of the configuration file.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__confirmUnsure">__confirmUnsure</a></td>
<td>Private method to confirm unsure occurrences.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__getConfig">__getConfig</a></td>
<td>Private method to send some configuration data to the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__handleRopeError">__handleRopeError</a></td>
<td>Private method to process a rope error.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__performSOA">__performSOA</a></td>
<td>Private method to perform SOA on all modules.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__previewChanges">__previewChanges</a></td>
<td>Private method to determine the changes data for a preview.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__processHistory">__processHistory</a></td>
<td>Private method to process the various history related requests.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__queryDefinition">__queryDefinition</a></td>
<td>Private method to handle the Find Definition action.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__queryImplementations">__queryImplementations</a></td>
<td>Private method to handle the Find Implementations action.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__queryReferences">__queryReferences</a></td>
<td>Private method to handle the Find References action.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__reportChanged">__reportChanged</a></td>
<td>Private method to register some changed sources.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__requestFieldName">__requestFieldName</a></td>
<td>Private method to calculate the 'Field Name' based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__requestInlineType">__requestInlineType</a></td>
<td>Private method to determine the 'Inline' changes type based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__requestMoveType">__requestMoveType</a></td>
<td>Private method to determine the 'Move Method' changes type based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__requestSignature">__requestSignature</a></td>
<td>Private method to calculate the 'Signature' based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__requestUseFunction">__requestUseFunction</a></td>
<td>Private method to determine the 'Use Function' function name based on the parameters sent by the server.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.__validate">__validate</a></td>
<td>Private slot to validate the project.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#RefactoringClient.handleCall">handleCall</a></td>
<td>Public method to handle a method call from the server.</td>
</tr>
</table>
<h3>Static Methods</h3>
+
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="RefactoringClient.__init__" ID="RefactoringClient.__init__"></a>
<h4>RefactoringClient (Constructor)</h4>
<b>RefactoringClient</b>(<i>host, port, projectPath</i>)
+
<p>
Constructor
-</p><dl>
+</p>
+<dl>
+
<dt><i>host</i> (str)</dt>
<dd>
ip address the background service is listening
-</dd><dt><i>port</i> (int)</dt>
+</dd>
+<dt><i>port</i> (int)</dt>
<dd>
port of the background service
-</dd><dt><i>projectPath</i> (str)</dt>
+</dd>
+<dt><i>projectPath</i> (str)</dt>
<dd>
path to the project
</dd>
-</dl><a NAME="RefactoringClient.__abortAction" ID="RefactoringClient.__abortAction"></a>
+</dl>
+<a NAME="RefactoringClient.__abortAction" ID="RefactoringClient.__abortAction"></a>
<h4>RefactoringClient.__abortAction</h4>
<b>__abortAction</b>(<i>params</i>)
+
<p>
Private method to abort the current action.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__applyChanges" ID="RefactoringClient.__applyChanges"></a>
+</dl>
+<a NAME="RefactoringClient.__applyChanges" ID="RefactoringClient.__applyChanges"></a>
<h4>RefactoringClient.__applyChanges</h4>
<b>__applyChanges</b>(<i>params</i>)
+
<p>
Private method to apply the changes of a given change group.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateChangeOccurrencesChanges" ID="RefactoringClient.__calculateChangeOccurrencesChanges"></a>
+</dl>
+<a NAME="RefactoringClient.__calculateChangeOccurrencesChanges" ID="RefactoringClient.__calculateChangeOccurrencesChanges"></a>
<h4>RefactoringClient.__calculateChangeOccurrencesChanges</h4>
<b>__calculateChangeOccurrencesChanges</b>(<i>params</i>)
+
<p>
Private method to calculate the 'Change Occurrences' changes based on
the parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateEncapsulateFieldChanges" ID="RefactoringClient.__calculateEncapsulateFieldChanges"></a>
+</dl>
+<a NAME="RefactoringClient.__calculateEncapsulateFieldChanges" ID="RefactoringClient.__calculateEncapsulateFieldChanges"></a>
<h4>RefactoringClient.__calculateEncapsulateFieldChanges</h4>
<b>__calculateEncapsulateFieldChanges</b>(<i>params</i>)
+
<p>
Private method to calculate the 'Encapsulate Field' changes based on
the parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateExtractChanges" ID="RefactoringClient.__calculateExtractChanges"></a>
+</dl>
+<a NAME="RefactoringClient.__calculateExtractChanges" ID="RefactoringClient.__calculateExtractChanges"></a>
<h4>RefactoringClient.__calculateExtractChanges</h4>
<b>__calculateExtractChanges</b>(<i>params</i>)
+
<p>
Private method to calculate the 'Extract' changes based on the
parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><dl>
+</dl>
+<dl>
+
<dt>Raises <b>Exception</b>:</dt>
<dd>
raised to indicate an invalid extraction type
</dd>
-</dl><a NAME="RefactoringClient.__calculateImportsChanges" ID="RefactoringClient.__calculateImportsChanges"></a>
+</dl>
+<a NAME="RefactoringClient.__calculateImportsChanges" ID="RefactoringClient.__calculateImportsChanges"></a>
<h4>RefactoringClient.__calculateImportsChanges</h4>
<b>__calculateImportsChanges</b>(<i>params</i>)
+
<p>
Private method to calculate the 'Import' changes based on the
parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateInlineArgumentDefaultChanges" ID="RefactoringClient.__calculateInlineArgumentDefaultChanges"></a>
+</dl>
+<a NAME="RefactoringClient.__calculateInlineArgumentDefaultChanges" ID="RefactoringClient.__calculateInlineArgumentDefaultChanges"></a>
<h4>RefactoringClient.__calculateInlineArgumentDefaultChanges</h4>
<b>__calculateInlineArgumentDefaultChanges</b>(<i>params</i>)
+
<p>
Private method to calculate the 'Inline Argument Default' changes
based on the parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateInlineChanges" ID="RefactoringClient.__calculateInlineChanges"></a>
+</dl>
+<a NAME="RefactoringClient.__calculateInlineChanges" ID="RefactoringClient.__calculateInlineChanges"></a>
<h4>RefactoringClient.__calculateInlineChanges</h4>
<b>__calculateInlineChanges</b>(<i>params</i>)
+
<p>
Private method to calculate the 'Inline' changes based on the
parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateIntroduceFactoryChanges" ID="RefactoringClient.__calculateIntroduceFactoryChanges"></a>
+</dl>
+<a NAME="RefactoringClient.__calculateIntroduceFactoryChanges" ID="RefactoringClient.__calculateIntroduceFactoryChanges"></a>
<h4>RefactoringClient.__calculateIntroduceFactoryChanges</h4>
<b>__calculateIntroduceFactoryChanges</b>(<i>params</i>)
+
<p>
Private method to calculate the 'Introduce Factory' changes based on
the parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
+<dt><i>params</i> (dict)</dt>
+<dd>
+dictionary containing the method parameters sent by
+ the server
+</dd>
+</dl>
+<a NAME="RefactoringClient.__calculateIntroduceParameterChanges" ID="RefactoringClient.__calculateIntroduceParameterChanges"></a>
+<h4>RefactoringClient.__calculateIntroduceParameterChanges</h4>
+<b>__calculateIntroduceParameterChanges</b>(<i>params</i>)
+
+<p>
+ Private method to calculate the 'Introduce Parameter' changes based on
+ the parameters sent by the server.
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateIntroduceParameterChanges" ID="RefactoringClient.__calculateIntroduceParameterChanges"></a>
-<h4>RefactoringClient.__calculateIntroduceParameterChanges</h4>
-<b>__calculateIntroduceParameterChanges</b>(<i>params</i>)
+</dl>
+<a NAME="RefactoringClient.__calculateLocalToAttributeChanges" ID="RefactoringClient.__calculateLocalToAttributeChanges"></a>
+<h4>RefactoringClient.__calculateLocalToAttributeChanges</h4>
+<b>__calculateLocalToAttributeChanges</b>(<i>params</i>)
+
<p>
- Private method to calculate the 'Introduce Parameter' changes based on
- the parameters sent by the server.
-</p><dl>
+ Private method to calculate the 'Local Variabe to Attribute' changes
+ based on the parameters sent by the server.
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateLocalToAttributeChanges" ID="RefactoringClient.__calculateLocalToAttributeChanges"></a>
-<h4>RefactoringClient.__calculateLocalToAttributeChanges</h4>
-<b>__calculateLocalToAttributeChanges</b>(<i>params</i>)
+</dl>
+<a NAME="RefactoringClient.__calculateMethodObjectChanges" ID="RefactoringClient.__calculateMethodObjectChanges"></a>
+<h4>RefactoringClient.__calculateMethodObjectChanges</h4>
+<b>__calculateMethodObjectChanges</b>(<i>params</i>)
+
<p>
- Private method to calculate the 'Local Variabe to Attribute' changes
+ Private method to calculate the 'Method to Method Object' changes
based on the parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateMethodObjectChanges" ID="RefactoringClient.__calculateMethodObjectChanges"></a>
-<h4>RefactoringClient.__calculateMethodObjectChanges</h4>
-<b>__calculateMethodObjectChanges</b>(<i>params</i>)
+</dl>
+<a NAME="RefactoringClient.__calculateModuleToPackageChanges" ID="RefactoringClient.__calculateModuleToPackageChanges"></a>
+<h4>RefactoringClient.__calculateModuleToPackageChanges</h4>
+<b>__calculateModuleToPackageChanges</b>(<i>params</i>)
+
<p>
- Private method to calculate the 'Method to Method Object' changes
+ Private method to calculate the 'Module to Package' changes
based on the parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateModuleToPackageChanges" ID="RefactoringClient.__calculateModuleToPackageChanges"></a>
-<h4>RefactoringClient.__calculateModuleToPackageChanges</h4>
-<b>__calculateModuleToPackageChanges</b>(<i>params</i>)
+</dl>
+<a NAME="RefactoringClient.__calculateMoveChanges" ID="RefactoringClient.__calculateMoveChanges"></a>
+<h4>RefactoringClient.__calculateMoveChanges</h4>
+<b>__calculateMoveChanges</b>(<i>params</i>)
+
<p>
- Private method to calculate the 'Module to Package' changes
- based on the parameters sent by the server.
-</p><dl>
+ Private method to calculate the 'Move ...' changes based on the
+ parameters sent by the server.
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateMoveChanges" ID="RefactoringClient.__calculateMoveChanges"></a>
-<h4>RefactoringClient.__calculateMoveChanges</h4>
-<b>__calculateMoveChanges</b>(<i>params</i>)
+</dl>
+<a NAME="RefactoringClient.__calculateRenameChanges" ID="RefactoringClient.__calculateRenameChanges"></a>
+<h4>RefactoringClient.__calculateRenameChanges</h4>
+<b>__calculateRenameChanges</b>(<i>params</i>)
+
<p>
- Private method to calculate the 'Move ...' changes based on the
- parameters sent by the server.
-</p><dl>
+ Private method to calculate the rename changes based on the parameters
+ sent by the server.
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateRenameChanges" ID="RefactoringClient.__calculateRenameChanges"></a>
-<h4>RefactoringClient.__calculateRenameChanges</h4>
-<b>__calculateRenameChanges</b>(<i>params</i>)
+</dl>
+<a NAME="RefactoringClient.__calculateRestructureChanges" ID="RefactoringClient.__calculateRestructureChanges"></a>
+<h4>RefactoringClient.__calculateRestructureChanges</h4>
+<b>__calculateRestructureChanges</b>(<i>params</i>)
+
<p>
- Private method to calculate the rename changes based on the parameters
- sent by the server.
-</p><dl>
+ Private method to calculate the 'Restructure' changes based on the
+ parameters sent by the server.
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateRestructureChanges" ID="RefactoringClient.__calculateRestructureChanges"></a>
-<h4>RefactoringClient.__calculateRestructureChanges</h4>
-<b>__calculateRestructureChanges</b>(<i>params</i>)
+</dl>
+<a NAME="RefactoringClient.__calculateSignatureChanges" ID="RefactoringClient.__calculateSignatureChanges"></a>
+<h4>RefactoringClient.__calculateSignatureChanges</h4>
+<b>__calculateSignatureChanges</b>(<i>params</i>)
+
<p>
- Private method to calculate the 'Restructure' changes based on the
+ Private method to calculate the 'Signature' changes based on the
parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateSignatureChanges" ID="RefactoringClient.__calculateSignatureChanges"></a>
-<h4>RefactoringClient.__calculateSignatureChanges</h4>
-<b>__calculateSignatureChanges</b>(<i>params</i>)
+</dl>
+<a NAME="RefactoringClient.__calculateUseFunctionChanges" ID="RefactoringClient.__calculateUseFunctionChanges"></a>
+<h4>RefactoringClient.__calculateUseFunctionChanges</h4>
+<b>__calculateUseFunctionChanges</b>(<i>params</i>)
+
<p>
- Private method to calculate the 'Signature' changes based on the
+ Private method to calculate the 'Use Function' changes based on the
parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__calculateUseFunctionChanges" ID="RefactoringClient.__calculateUseFunctionChanges"></a>
-<h4>RefactoringClient.__calculateUseFunctionChanges</h4>
-<b>__calculateUseFunctionChanges</b>(<i>params</i>)
+</dl>
+<a NAME="RefactoringClient.__clearChanges" ID="RefactoringClient.__clearChanges"></a>
+<h4>RefactoringClient.__clearChanges</h4>
+<b>__clearChanges</b>(<i>params</i>)
+
<p>
- Private method to calculate the 'Use Function' changes based on the
- parameters sent by the server.
-</p><dl>
+ Private method to clear the changes cache of a given change group.
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__clearChanges" ID="RefactoringClient.__clearChanges"></a>
-<h4>RefactoringClient.__clearChanges</h4>
-<b>__clearChanges</b>(<i>params</i>)
-<p>
- Private method to clear the changes cache of a given change group.
-</p><dl>
-<dt><i>params</i> (dict)</dt>
-<dd>
-dictionary containing the method parameters sent by
- the server
-</dd>
-</dl><a NAME="RefactoringClient.__closeProject" ID="RefactoringClient.__closeProject"></a>
+</dl>
+<a NAME="RefactoringClient.__closeProject" ID="RefactoringClient.__closeProject"></a>
<h4>RefactoringClient.__closeProject</h4>
<b>__closeProject</b>(<i>params</i>)
+
<p>
Private slot to validate the project.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__configChanged" ID="RefactoringClient.__configChanged"></a>
+</dl>
+<a NAME="RefactoringClient.__configChanged" ID="RefactoringClient.__configChanged"></a>
<h4>RefactoringClient.__configChanged</h4>
<b>__configChanged</b>(<i>params</i>)
+
<p>
Private method to handle a change of the configuration file.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__confirmUnsure" ID="RefactoringClient.__confirmUnsure"></a>
+</dl>
+<a NAME="RefactoringClient.__confirmUnsure" ID="RefactoringClient.__confirmUnsure"></a>
<h4>RefactoringClient.__confirmUnsure</h4>
<b>__confirmUnsure</b>(<i>occurrence, changeGroup</i>)
+
<p>
Private method to confirm unsure occurrences.
-</p><dl>
+</p>
+<dl>
+
<dt><i>occurrence</i> (rope.refactor.occurrences.Occurrence)</dt>
<dd>
reference to the occurrence object
-</dd><dt><i>changeGroup</i> (str)</dt>
+</dd>
+<dt><i>changeGroup</i> (str)</dt>
<dd>
name of the change group
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
flag indicating an occurrence
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
-</dl><a NAME="RefactoringClient.__getConfig" ID="RefactoringClient.__getConfig"></a>
+</dl>
+<a NAME="RefactoringClient.__getConfig" ID="RefactoringClient.__getConfig"></a>
<h4>RefactoringClient.__getConfig</h4>
<b>__getConfig</b>(<i>params</i>)
+
<p>
Private method to send some configuration data to the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__handleRopeError" ID="RefactoringClient.__handleRopeError"></a>
+</dl>
+<a NAME="RefactoringClient.__handleRopeError" ID="RefactoringClient.__handleRopeError"></a>
<h4>RefactoringClient.__handleRopeError</h4>
<b>__handleRopeError</b>(<i>err</i>)
+
<p>
Private method to process a rope error.
-</p><dl>
+</p>
+<dl>
+
<dt><i>err</i> (Exception)</dt>
<dd>
rope exception object
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
dictionary containing the error information
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
-</dl><a NAME="RefactoringClient.__performSOA" ID="RefactoringClient.__performSOA"></a>
+</dl>
+<a NAME="RefactoringClient.__performSOA" ID="RefactoringClient.__performSOA"></a>
<h4>RefactoringClient.__performSOA</h4>
<b>__performSOA</b>(<i>params</i>)
+
<p>
Private method to perform SOA on all modules.
-</p><dl>
+</p>
+<dl>
+
+<dt><i>params</i> (dict)</dt>
+<dd>
+dictionary containing the method parameters sent by
+ the server
+</dd>
+</dl>
+<a NAME="RefactoringClient.__previewChanges" ID="RefactoringClient.__previewChanges"></a>
+<h4>RefactoringClient.__previewChanges</h4>
+<b>__previewChanges</b>(<i>params</i>)
+
+<p>
+ Private method to determine the changes data for a preview.
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__previewChanges" ID="RefactoringClient.__previewChanges"></a>
-<h4>RefactoringClient.__previewChanges</h4>
-<b>__previewChanges</b>(<i>params</i>)
-<p>
- Private method to determine the changes data for a preview.
-</p><dl>
-<dt><i>params</i> (dict)</dt>
-<dd>
-dictionary containing the method parameters sent by
- the server
-</dd>
-</dl><a NAME="RefactoringClient.__processHistory" ID="RefactoringClient.__processHistory"></a>
+</dl>
+<a NAME="RefactoringClient.__processHistory" ID="RefactoringClient.__processHistory"></a>
<h4>RefactoringClient.__processHistory</h4>
<b>__processHistory</b>(<i>params</i>)
+
<p>
Private method to process the various history related requests.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__queryDefinition" ID="RefactoringClient.__queryDefinition"></a>
+</dl>
+<a NAME="RefactoringClient.__queryDefinition" ID="RefactoringClient.__queryDefinition"></a>
<h4>RefactoringClient.__queryDefinition</h4>
<b>__queryDefinition</b>(<i>params</i>)
+
<p>
Private method to handle the Find Definition action.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__queryImplementations" ID="RefactoringClient.__queryImplementations"></a>
+</dl>
+<a NAME="RefactoringClient.__queryImplementations" ID="RefactoringClient.__queryImplementations"></a>
<h4>RefactoringClient.__queryImplementations</h4>
<b>__queryImplementations</b>(<i>params</i>)
+
<p>
Private method to handle the Find Implementations action.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__queryReferences" ID="RefactoringClient.__queryReferences"></a>
+</dl>
+<a NAME="RefactoringClient.__queryReferences" ID="RefactoringClient.__queryReferences"></a>
<h4>RefactoringClient.__queryReferences</h4>
<b>__queryReferences</b>(<i>params</i>)
+
<p>
Private method to handle the Find References action.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__reportChanged" ID="RefactoringClient.__reportChanged"></a>
+</dl>
+<a NAME="RefactoringClient.__reportChanged" ID="RefactoringClient.__reportChanged"></a>
<h4>RefactoringClient.__reportChanged</h4>
<b>__reportChanged</b>(<i>params</i>)
+
<p>
Private method to register some changed sources.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__requestFieldName" ID="RefactoringClient.__requestFieldName"></a>
+</dl>
+<a NAME="RefactoringClient.__requestFieldName" ID="RefactoringClient.__requestFieldName"></a>
<h4>RefactoringClient.__requestFieldName</h4>
<b>__requestFieldName</b>(<i>params</i>)
+
<p>
Private method to calculate the 'Field Name' based on the parameters
sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__requestInlineType" ID="RefactoringClient.__requestInlineType"></a>
+</dl>
+<a NAME="RefactoringClient.__requestInlineType" ID="RefactoringClient.__requestInlineType"></a>
<h4>RefactoringClient.__requestInlineType</h4>
<b>__requestInlineType</b>(<i>params</i>)
+
<p>
Private method to determine the 'Inline' changes type based on the
parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
+<dt><i>params</i> (dict)</dt>
+<dd>
+dictionary containing the method parameters sent by
+ the server
+</dd>
+</dl>
+<a NAME="RefactoringClient.__requestMoveType" ID="RefactoringClient.__requestMoveType"></a>
+<h4>RefactoringClient.__requestMoveType</h4>
+<b>__requestMoveType</b>(<i>params</i>)
+
+<p>
+ Private method to determine the 'Move Method' changes type based on the
+ parameters sent by the server.
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__requestMoveType" ID="RefactoringClient.__requestMoveType"></a>
-<h4>RefactoringClient.__requestMoveType</h4>
-<b>__requestMoveType</b>(<i>params</i>)
-<p>
- Private method to determine the 'Move Method' changes type based on the
- parameters sent by the server.
-</p><dl>
-<dt><i>params</i> (dict)</dt>
-<dd>
-dictionary containing the method parameters sent by
- the server
-</dd>
-</dl><a NAME="RefactoringClient.__requestSignature" ID="RefactoringClient.__requestSignature"></a>
+</dl>
+<a NAME="RefactoringClient.__requestSignature" ID="RefactoringClient.__requestSignature"></a>
<h4>RefactoringClient.__requestSignature</h4>
<b>__requestSignature</b>(<i>params</i>)
+
<p>
Private method to calculate the 'Signature' based on the parameters
sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__requestUseFunction" ID="RefactoringClient.__requestUseFunction"></a>
+</dl>
+<a NAME="RefactoringClient.__requestUseFunction" ID="RefactoringClient.__requestUseFunction"></a>
<h4>RefactoringClient.__requestUseFunction</h4>
<b>__requestUseFunction</b>(<i>params</i>)
+
<p>
Private method to determine the 'Use Function' function name based on
the parameters sent by the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.__validate" ID="RefactoringClient.__validate"></a>
+</dl>
+<a NAME="RefactoringClient.__validate" ID="RefactoringClient.__validate"></a>
<h4>RefactoringClient.__validate</h4>
<b>__validate</b>(<i>params</i>)
+
<p>
Private slot to validate the project.
-</p><dl>
+</p>
+<dl>
+
<dt><i>params</i> (dict)</dt>
<dd>
dictionary containing the method parameters sent by
the server
</dd>
-</dl><a NAME="RefactoringClient.handleCall" ID="RefactoringClient.handleCall"></a>
+</dl>
+<a NAME="RefactoringClient.handleCall" ID="RefactoringClient.handleCall"></a>
<h4>RefactoringClient.handleCall</h4>
<b>handleCall</b>(<i>method, params</i>)
+
<p>
Public method to handle a method call from the server.
-</p><dl>
+</p>
+<dl>
+
<dt><i>method</i> (str)</dt>
<dd>
requested method name
-</dd><dt><i>params</i> (dict)</dt>
+</dd>
+<dt><i>params</i> (dict)</dt>
<dd>
dictionary with method specific parameters
</dd>
