--- a/src/eric7/Documentation/Source/eric7.UI.PythonDisViewer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.UI.PythonDisViewer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,20 +7,18 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.UI.PythonDisViewer</h1>
-
<p>
Module implementing a widget to visualize the Python Disassembly for some
Python sources.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PythonDisViewer">PythonDisViewer</a></td>
<td>Class implementing a widget to visualize the Python Disassembly for some Python sources.</td>
@@ -30,10 +28,9 @@
<td>Class implementing the disassembly viewer operation modes.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#linestarts">linestarts</a></td>
<td>Function to get the line starts for the given code object.</td>
@@ -43,31 +40,32 @@
<td>Function to attempt to compile the given source, first as an expression and then as a statement if the first approach fails.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="PythonDisViewer" ID="PythonDisViewer"></a>
<h2>PythonDisViewer</h2>
-
<p>
Class implementing a widget to visualize the Python Disassembly for some
Python sources.
</p>
+
<h3>Derived from</h3>
QWidget, Ui_PythonDisViewer
<h3>Class Attributes</h3>
+<table>
+<tr><td>CodeInfoRole</td></tr>
+<tr><td>EndLineRole</td></tr>
+<tr><td>StartLineRole</td></tr>
+</table>
-<table>
-<tr><td>CodeInfoRole</td></tr><tr><td>EndLineRole</td></tr><tr><td>StartLineRole</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PythonDisViewer.__init__">PythonDisViewer</a></td>
<td>Constructor</td>
@@ -221,19 +219,20 @@
<td>Public method to perform shutdown actions.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PythonDisViewer.__init__" ID="PythonDisViewer.__init__"></a>
<h4>PythonDisViewer (Constructor)</h4>
<b>PythonDisViewer</b>(<i>viewmanager, mode=PythonDisViewerModes.SOURCEDISASSEMBLY, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>viewmanager</i> (ViewManager)</dt>
@@ -252,17 +251,17 @@
<a NAME="PythonDisViewer.__clearSelection" ID="PythonDisViewer.__clearSelection"></a>
<h4>PythonDisViewer.__clearSelection</h4>
<b>__clearSelection</b>(<i></i>)
-
<p>
Private method to clear all selected items.
</p>
+
<a NAME="PythonDisViewer.__codeInfoContextMenuRequested" ID="PythonDisViewer.__codeInfoContextMenuRequested"></a>
<h4>PythonDisViewer.__codeInfoContextMenuRequested</h4>
<b>__codeInfoContextMenuRequested</b>(<i>coord</i>)
-
<p>
Private slot to show the context menu of the code info widget.
</p>
+
<dl>
<dt><i>coord</i> (QPoint)</dt>
@@ -273,31 +272,31 @@
<a NAME="PythonDisViewer.__collapseAllCodeInfo" ID="PythonDisViewer.__collapseAllCodeInfo"></a>
<h4>PythonDisViewer.__collapseAllCodeInfo</h4>
<b>__collapseAllCodeInfo</b>(<i></i>)
-
<p>
Private slot to collapse all items of the code info widget.
</p>
+
<a NAME="PythonDisViewer.__collapseAllDis" ID="PythonDisViewer.__collapseAllDis"></a>
<h4>PythonDisViewer.__collapseAllDis</h4>
<b>__collapseAllDis</b>(<i></i>)
-
<p>
Private slot to collapse all items of the disassembly widget.
</p>
+
<a NAME="PythonDisViewer.__configure" ID="PythonDisViewer.__configure"></a>
<h4>PythonDisViewer.__configure</h4>
<b>__configure</b>(<i></i>)
-
<p>
Private method to open the configuration dialog.
</p>
+
<a NAME="PythonDisViewer.__createCodeInfo" ID="PythonDisViewer.__createCodeInfo"></a>
<h4>PythonDisViewer.__createCodeInfo</h4>
<b>__createCodeInfo</b>(<i>co</i>)
-
<p>
Private method to create a dictionary containing the code info data.
</p>
+
<dl>
<dt><i>co</i> (code)</dt>
@@ -320,10 +319,10 @@
<a NAME="PythonDisViewer.__createErrorItem" ID="PythonDisViewer.__createErrorItem"></a>
<h4>PythonDisViewer.__createErrorItem</h4>
<b>__createErrorItem</b>(<i>error</i>)
-
<p>
Private method to create a top level error item.
</p>
+
<dl>
<dt><i>error</i> (str)</dt>
@@ -346,10 +345,10 @@
<a NAME="PythonDisViewer.__createInstructionItem" ID="PythonDisViewer.__createInstructionItem"></a>
<h4>PythonDisViewer.__createInstructionItem</h4>
<b>__createInstructionItem</b>(<i>instr, parent, lasti=-1</i>)
-
<p>
Private method to create an item for the given instruction.
</p>
+
<dl>
<dt><i>instr</i> (dis.Instruction)</dt>
@@ -380,10 +379,10 @@
<a NAME="PythonDisViewer.__createTitleItem" ID="PythonDisViewer.__createTitleItem"></a>
<h4>PythonDisViewer.__createTitleItem</h4>
<b>__createTitleItem</b>(<i>title, line, parentItem</i>)
-
<p>
Private method to create a title item.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -414,10 +413,10 @@
<a NAME="PythonDisViewer.__disContextMenuRequested" ID="PythonDisViewer.__disContextMenuRequested"></a>
<h4>PythonDisViewer.__disContextMenuRequested</h4>
<b>__disContextMenuRequested</b>(<i>coord</i>)
-
<p>
Private slot to show the context menu of the disassembly widget.
</p>
+
<dl>
<dt><i>coord</i> (QPoint)</dt>
@@ -428,10 +427,10 @@
<a NAME="PythonDisViewer.__disItemClicked" ID="PythonDisViewer.__disItemClicked"></a>
<h4>PythonDisViewer.__disItemClicked</h4>
<b>__disItemClicked</b>(<i>itm, column</i>)
-
<p>
Private slot handling a user click on a Disassembly node item.
</p>
+
<dl>
<dt><i>itm</i> (QTreeWidgetItem)</dt>
@@ -446,10 +445,10 @@
<a NAME="PythonDisViewer.__disViewerStateChanged" ID="PythonDisViewer.__disViewerStateChanged"></a>
<h4>PythonDisViewer.__disViewerStateChanged</h4>
<b>__disViewerStateChanged</b>(<i>on</i>)
-
<p>
Private slot to toggle the display of the Disassembly viewer.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -460,10 +459,10 @@
<a NAME="PythonDisViewer.__disassembleObject" ID="PythonDisViewer.__disassembleObject"></a>
<h4>PythonDisViewer.__disassembleObject</h4>
<b>__disassembleObject</b>(<i>co, parentItem, parentName="", lasti=-1</i>)
-
<p>
Private method to disassemble the given code object recursively.
</p>
+
<dl>
<dt><i>co</i> (code object)</dt>
@@ -486,10 +485,10 @@
<a NAME="PythonDisViewer.__editorChanged" ID="PythonDisViewer.__editorChanged"></a>
<h4>PythonDisViewer.__editorChanged</h4>
<b>__editorChanged</b>(<i>editor</i>)
-
<p>
Private slot to handle a change of the current editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -500,10 +499,10 @@
<a NAME="PythonDisViewer.__editorLanguageChanged" ID="PythonDisViewer.__editorLanguageChanged"></a>
<h4>PythonDisViewer.__editorLanguageChanged</h4>
<b>__editorLanguageChanged</b>(<i>editor</i>)
-
<p>
Private slot to handle a change of the editor language.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -514,10 +513,10 @@
<a NAME="PythonDisViewer.__editorLineChanged" ID="PythonDisViewer.__editorLineChanged"></a>
<h4>PythonDisViewer.__editorLineChanged</h4>
<b>__editorLineChanged</b>(<i>editor, lineno</i>)
-
<p>
Private slot to handle a mouse button double click in the editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -532,11 +531,11 @@
<a NAME="PythonDisViewer.__editorSaved" ID="PythonDisViewer.__editorSaved"></a>
<h4>PythonDisViewer.__editorSaved</h4>
<b>__editorSaved</b>(<i>editor</i>)
-
<p>
Private slot to reload the Disassembly after the connected editor was
saved.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -547,57 +546,57 @@
<a NAME="PythonDisViewer.__expandAllCodeInfo" ID="PythonDisViewer.__expandAllCodeInfo"></a>
<h4>PythonDisViewer.__expandAllCodeInfo</h4>
<b>__expandAllCodeInfo</b>(<i></i>)
-
<p>
Private slot to expand all items of the code info widget.
</p>
+
<a NAME="PythonDisViewer.__expandAllDis" ID="PythonDisViewer.__expandAllDis"></a>
<h4>PythonDisViewer.__expandAllDis</h4>
<b>__expandAllDis</b>(<i></i>)
-
<p>
Private slot to expand all items of the disassembly widget.
</p>
+
<a NAME="PythonDisViewer.__lastEditorClosed" ID="PythonDisViewer.__lastEditorClosed"></a>
<h4>PythonDisViewer.__lastEditorClosed</h4>
<b>__lastEditorClosed</b>(<i></i>)
-
<p>
Private slot to handle the last editor closed signal of the view
manager.
</p>
+
<a NAME="PythonDisViewer.__loadDIS" ID="PythonDisViewer.__loadDIS"></a>
<h4>PythonDisViewer.__loadDIS</h4>
<b>__loadDIS</b>(<i></i>)
-
<p>
Private method to generate the Disassembly from the source of the
current editor and visualize it.
</p>
+
<a NAME="PythonDisViewer.__resizeCodeInfoColumns" ID="PythonDisViewer.__resizeCodeInfoColumns"></a>
<h4>PythonDisViewer.__resizeCodeInfoColumns</h4>
<b>__resizeCodeInfoColumns</b>(<i></i>)
-
<p>
Private method to resize the columns of the code info widget to
suitable values.
</p>
+
<a NAME="PythonDisViewer.__resizeDisColumns" ID="PythonDisViewer.__resizeDisColumns"></a>
<h4>PythonDisViewer.__resizeDisColumns</h4>
<b>__resizeDisColumns</b>(<i></i>)
-
<p>
Private method to resize the columns of the disassembly widget to
suitable values.
</p>
+
<a NAME="PythonDisViewer.__selectChildren" ID="PythonDisViewer.__selectChildren"></a>
<h4>PythonDisViewer.__selectChildren</h4>
<b>__selectChildren</b>(<i>itm, lineno</i>)
-
<p>
Private method to select children of the given item covering the given
line number.
</p>
+
<dl>
<dt><i>itm</i> (QTreeWidgetItem)</dt>
@@ -612,25 +611,25 @@
<a NAME="PythonDisViewer.__selectItemForEditorLine" ID="PythonDisViewer.__selectItemForEditorLine"></a>
<h4>PythonDisViewer.__selectItemForEditorLine</h4>
<b>__selectItemForEditorLine</b>(<i></i>)
-
<p>
Private slot to select the items corresponding with the cursor line
of the current editor.
</p>
+
<a NAME="PythonDisViewer.__showCodeInfo" ID="PythonDisViewer.__showCodeInfo"></a>
<h4>PythonDisViewer.__showCodeInfo</h4>
<b>__showCodeInfo</b>(<i></i>)
-
<p>
Private slot handling the context menu action to show code info.
</p>
+
<a NAME="PythonDisViewer.__showCodeInfoData" ID="PythonDisViewer.__showCodeInfoData"></a>
<h4>PythonDisViewer.__showCodeInfoData</h4>
<b>__showCodeInfoData</b>(<i>codeInfo</i>)
-
<p>
Private method to show the passed code info data.
</p>
+
<dl>
<dt><i>codeInfo</i> (dict)</dt>
@@ -641,17 +640,17 @@
<a NAME="PythonDisViewer.__styleLabels" ID="PythonDisViewer.__styleLabels"></a>
<h4>PythonDisViewer.__styleLabels</h4>
<b>__styleLabels</b>(<i></i>)
-
<p>
Private method to style the info labels iaw. selected colors.
</p>
+
<a NAME="PythonDisViewer.__updateItemEndLine" ID="PythonDisViewer.__updateItemEndLine"></a>
<h4>PythonDisViewer.__updateItemEndLine</h4>
<b>__updateItemEndLine</b>(<i>itm</i>)
-
<p>
Private method to update an items end line based on its children.
</p>
+
<dl>
<dt><i>itm</i> (QTreeWidgetItem)</dt>
@@ -662,17 +661,17 @@
<a NAME="PythonDisViewer.clear" ID="PythonDisViewer.clear"></a>
<h4>PythonDisViewer.clear</h4>
<b>clear</b>(<i></i>)
-
<p>
Public method to clear the display.
</p>
+
<a NAME="PythonDisViewer.createCodeInfoItems" ID="PythonDisViewer.createCodeInfoItems"></a>
<h4>PythonDisViewer.createCodeInfoItems</h4>
<b>createCodeInfoItems</b>(<i>infoList</i>)
-
<p>
Function to create code info items for the given list.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -687,24 +686,24 @@
<a NAME="PythonDisViewer.hide" ID="PythonDisViewer.hide"></a>
<h4>PythonDisViewer.hide</h4>
<b>hide</b>(<i></i>)
-
<p>
Public slot to hide the DIS viewer.
</p>
+
<a NAME="PythonDisViewer.preferencesChanged" ID="PythonDisViewer.preferencesChanged"></a>
<h4>PythonDisViewer.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
-
<p>
Public slot handling changes of the Disassembly viewer settings.
</p>
+
<a NAME="PythonDisViewer.resizeEvent" ID="PythonDisViewer.resizeEvent"></a>
<h4>PythonDisViewer.resizeEvent</h4>
<b>resizeEvent</b>(<i>evt</i>)
-
<p>
Protected method to handle resize events.
</p>
+
<dl>
<dt><i>evt</i> (QResizeEvent)</dt>
@@ -715,17 +714,17 @@
<a NAME="PythonDisViewer.show" ID="PythonDisViewer.show"></a>
<h4>PythonDisViewer.show</h4>
<b>show</b>(<i></i>)
-
<p>
Public slot to show the DIS viewer.
</p>
+
<a NAME="PythonDisViewer.showDisassembly" ID="PythonDisViewer.showDisassembly"></a>
<h4>PythonDisViewer.showDisassembly</h4>
<b>showDisassembly</b>(<i>disassembly</i>)
-
<p>
Public slot to receive a code disassembly from the debug client.
</p>
+
<dl>
<dt><i>disassembly</i> (dict)</dt>
@@ -736,52 +735,53 @@
<a NAME="PythonDisViewer.shutdown" ID="PythonDisViewer.shutdown"></a>
<h4>PythonDisViewer.shutdown</h4>
<b>shutdown</b>(<i></i>)
-
<p>
Public method to perform shutdown actions.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="PythonDisViewerModes" ID="PythonDisViewerModes"></a>
<h2>PythonDisViewerModes</h2>
-
<p>
Class implementing the disassembly viewer operation modes.
</p>
+
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
+<table>
+<tr><td>SOURCEDISASSEMBLY</td></tr>
+<tr><td>TRACEBACK</td></tr>
+</table>
-<table>
-<tr><td>SOURCEDISASSEMBLY</td></tr><tr><td>TRACEBACK</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="linestarts" ID="linestarts"></a>
<h2>linestarts</h2>
<b>linestarts</b>(<i>co, filename="", getall=True</i>)
-
<p>
Function to get the line starts for the given code object.
</p>
+
<dl>
<dt><i>co</i> (code object or str)</dt>
@@ -815,11 +815,11 @@
<a NAME="tryCompile" ID="tryCompile"></a>
<h2>tryCompile</h2>
<b>tryCompile</b>(<i>source, name</i>)
-
<p>
Function to attempt to compile the given source, first as an
expression and then as a statement if the first approach fails.
</p>
+
<dl>
<dt><i>source</i> (str)</dt>
@@ -845,4 +845,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
