program_slicing

Zersetzung

Satz von Methoden zur Quellcode -Zerlegung.

---

Installation

1. $ git clone [email protected]:acheshkov/program_slicing.git
2. $ cd program_slicing
3. $ git submodule update --recursive --init
4. $ pip3 install ./program_slicing

Sie sollten Zugriff auf globales Netzwerk haben, um PIP zu verwenden. Python 3.9 mit entsprechendem C -Compiler ist erforderlich. Führen Sie die Python -Konsole aus, um die Version des C -Compilers zu überprüfen.

---

Verwendung

Dieses Projekt kann über die Befehlszeilenschnittstelle verwendet werden oder in jedem anderen Python -Projekt als Submodul aufgenommen werden.

Befehlszeilenschnittstelle

Scheibe

Verwenden Sie diesen Befehl, wenn Sie Quelldateien durch vollständige Berechnungsscheibe zerlegen möchten (Nikolaos Tsantalis und Alexander Chatzigeorgiou. 2011. Identifizierung der Extraktmethoden -Refactoring -Möglichkeiten zur Zerlegung von Methoden).

$ python cli.py slice [-h]
                      [-o OUTPUT]
                      source

Positionsargumente:

Quelle - Quellordner, Datei oder URL

Optionale Argumente:

-O , -Ausgabeausgabe -Ausgabedatei oder Verzeichnis: Abhängig von dem, was Sie als Ausgabe festlegen, erhalten Sie den Ordner voller Schnittabschlüsse oder einer einzelnen Datei damit. Es verwendet Stdout, wenn nicht angegeben

-h , -HELP -Zeigen Sie diese Hilfebotschaft und beenden Sie aus

Beispiele:

$ python cli.py slice MyProjectPath

$ python cli.py slice MyFile.java

$ python cli.py slice MyProjectPath --output MyResultPath

$ python cli.py slice MyFile.java --output MyResultPath

---

Submodul -Schnittstelle

Kontrollabhängigkeitsgraphen - Struktur, die Kontrollabhängigkeitsgraphen (von networkx.digraph geerbt) mit entsprechenden Methoden darstellt.

 from program_slicing . graph . cdg import ControlDependenceGraph

• add_entry_point - Markierender Knoten als Einstiegspunkt.
• get_entry_points - Geben Sie einen Satz von Knoten zurück, die als Einstiegspunkt markiert sind.

---

Kontrollflussdiagramm - Struktur, die den Kontrollflussdiagramm (von networkx.digraph geerbt) mit entsprechenden Methoden darstellt.

 from program_slicing . graph . cfg import ControlFlowGraph

• add_entry_point - Markierender Knoten als Einstiegspunkt.
• get_entry_points - Geben Sie einen Satz von Knoten zurück, die als Einstiegspunkt markiert sind.

---

Datenabhängigkeitsgraphen - Struktur, die Datenabhängigkeitsgraphen (von networkx.digraph geerbt) mit entsprechenden Methoden darstellt.

 from program_slicing . graph . ddg import DataDependenceGraph

• add_entry_point - Markierender Knoten als Einstiegspunkt.
• get_entry_points - Geben Sie einen Satz von Knoten zurück, die als Einstiegspunkt markiert sind.

---

Programmabhängigkeitsgrafik - Struktur, die Programmabhängigkeitsgraphen (von networkx.digraph geerbt) mit entsprechenden Methoden darstellen.

 from program_slicing . graph . pdg import ProgramDependenceGraph

• add_entry_point - Markierender Knoten als Einstiegspunkt.
• get_entry_points - Geben Sie einen Satz von Knoten zurück, die als Einstiegspunkt markiert sind.

---

Anweisung - Struktur, die Kontrollabhängigkeitsgrafik , Datenabhängigkeitsgrafik oder Programmabhängigkeitsgraden darstellt.

 from program_slicing . graph . statement import Statement

• Anweisung_Type - AnweisungType -Objekt.
• START_POINT - Zeilen- und Spaltennummern des Starts der Anweisung .
• end_point - Zeilen- und Spaltennummern des Endes der Anweisung .
• betroffen_by - saiten mit Namen von Variablen, die die aktuelle Anweisung beeinflussen können.
• Name - Zeichenfolge mit dem Namen der Anweisung . Nicht alle Aussagen werden benannt.
• AST_NODE_TYPE - String mit zusätzlichen Informationen zum Knoten (z. B. Klasse von AST -Root).

---

AnweisungType - Struktur, die Anweisungstypen aufzählt.

 from program_slicing . graph . statement import StatementType

• Funktion - Funktionserklärung Anweisung .
• Variable - Variable Deklaration Anweisung .
• Zuordnung - Anweisung für variable Zuordnung (wie i = 0 , i += 1 , i++ usw.).
• Anruf - Funktionsaufrufanweisung .
• Scope - Scope Anweisung (wie Zahnspangen {} oder leerer Körper in if (...) a = 0 ).
• Ast - Anweisung , die den Fluss verzweigt (z. B. if , try , catch , switch ).
• Schleife - Zweiganweisung , die einen Rückfluss erzeugt (z. B. for und while ).
• GOTO - Aussage , die zu einer konkreten Aussage führt (z. B. break , continue , throw , return und noch else ).
• Unbekannt - alle anderen Aussagen .
• Beenden - Sonderaussage , die am Ende der Funktionserklärung platziert ist, hat keine Größe und alle "Return "- und 'Throw' -Knoten führen in sie (sowie die letzte Aussage im Fluss).

---

Basic Block - Struktur, die Kontrollflussgraphen darstellen.

 from program_slicing . graph . basic_block import BasicBlock

• Aussagen - Erhalten Sie den Inhalt des Basisblocks , dh eine Liste von Aussagen .
• Root - Holen Sie sich die erste Anweisung aus dem Basisblock . Keine, wenn es leer ist.
• Anhängen - Fügen Sie dem Basisblock eine angegebene Anweisung hinzu.
• IS_EMPETY - RECHT TRUE, wenn es im Basisblock keine Anweisungen gibt, ansonsten - Falsch.
• Split - Split -Inhalt nach dem angegebenen Index, links erster Teil des Aufteils am ursprünglichen Basisblock und geben Sie einen neuen Basisblock zurück, der alle REST -Anweisungen enthält.

---

Programmdiagramm -Manager - Struktur, die verschiedene Arten von Programmdiagramme (z. B. Steuerungsgrafik- oder Kontrollabhängigkeitsgraphen ) basierend auf demselben Quellcode enthält und eine Reihe von Methoden für ihre Analyse liefert.

 from program_slicing . graph . parse import Lang
from program_slicing . graph . parse import control_dependence_graph
from program_slicing . graph . parse import control_flow_graph
from program_slicing . graph . manager import ProgramGraphsManager

manager_by_source = ProgramGraphsManager ( source_code , Lang . JAVA )

manager_by_cdg = ProgramGraphsManager . from_control_dependence_graph ( control_dependence_graph ( source_code , Lang . JAVA ))

manager_by_cfg = ProgramGraphsManager . from_control_flow_graph ( control_flow_graph ( source_code , Lang . JAVA ))

Eigenschaften:

• control_dependence_graph - Geben Sie das Kontrollabhängigkeitsgraphen zurück.
• CONTROL_FLOW_GRAPH - Geben Sie den Steuerflussgabel zurück.
• Data_Dependence_Graph - Geben Sie die Datenabhängigkeitsgrafik zurück.
• Programm_Dependence_Graph - Geben Sie die Programmabhängigkeitsgrafik zurück.
• Sorted_Statements - Rückgabetechnik, die zuerst sortiert werden, indem ihr start_point erhöht wird und dann durch Verringerung ihres end_point abnimmt.
• General_Statements - Allgemeine Aussagen zurückgeben (diejenigen , die in keiner SCOPE , BRANCH , LOOP , FUNCTION oder EXIT enthalten sind).
• SCOPE_STATEMENTS - Geben Sie den gesamten SCOPE , BRANCH , LOOP oder die Funktionsanweisungen FUNCTION .

Öffentliche Methoden:

• get_basic_block - Geben Sie einen Basisblock zurück (dh ein Knoten des Steuerflusses ), der eine bestimmte Anweisung enthält.
• Get_Boundary_Blocks - Geben Sie einen Satz grundlegender Blöcke zurück, die sich von dominiertem und Reichblöcken schneiden und den angegebenen einen Block enthalten.
• get_boundary_blocks_for_statement - Geben Sie einen Satz von Grenzblöcken für den Basisblock zurück, in dem die angegebene Anweisung platziert wird.
• Get_Domined_blocks geben eine Reihe von Basisblöcken zurück, die von der angegebenen dominiert werden (dh ihre Aussagen werden in einem Kontrollabhängigkeits -Diagramm der Stammwurzel des angegebenen Basisblocks platziert).
• get_reach_blocks - Geben Sie einen Satz grundlegender Blöcke zurück, die aus dem angegebenen im Steuerflussgraphen erreichbar sind.
• get_statement_line_numbers - Geben Sie eine Reihe von Zeilennummern zurück, in denen die angegebene Anweisung platziert ist.
• get_function_statement - Geben Sie die minimale FUNCTION zurück , in der die angegebene Anweisung platziert wird.
• get_function_statement_by_range - Geben Sie die minimale Funktionserklärung zurück, in der der angegebene Bereich platziert ist.
• Get_Scope_Statement - Geben Sie eine minimale Anweisung "Zielfernrohr" ( SCOPE , LOOP , BRANCH ) zurück, die eine bestimmte Anweisung enthält.
• get_statements_in_scope - Geben Sie alle Anweisungen in der angegebenen Umfangsanweisung zurück.
• Get_Statements_in_Range - Geben Sie alle Aussagen im angegebenen Bereich zurück.
• Get_exit_statements - Rückgaberichtungen , die Flussabhängigkeit Kinder der angegebenen Aussagen sind, aber nicht eines von ihnen.
• Get_Affecting_Statements - Rückgabeanweisungen aus dem angegebenen Satz von Anweisungen , die sich auf eine Anweisung auswirken, bilden nicht den angegebenen Satz.
• get_changed_variables_statements - VARIABLE , die in der angegebenen Aussage geändert werden.
• get_involved_variables_statements - VARIABLE , die die beteiligten Variablen (einschließlich der Verwendung) in der angegebenen Aussage darstellen.
• Enthalten_redundant_statements - Überprüfen Sie, ob der angegebene Satz von Anweisungen einen Teil einiger Konstruktionen enthalten, die nicht vollständig in der angegebenen Menge enthalten sind.

Klassenmethoden:

• Von_Source_Code - Erstellen Sie alle Diagramme nach einer bestimmten Quellcodezeichenfolge und einer Sprachbeschreibung.
• Von_Control_Dependence_Graph - Erstellen Sie alle Diagramme nach einem bestimmten Kontrollabhängigkeitsgraphen .
• Von_Control_Flow_Graph - Erstellen Sie alle Diagramme durch ein bestimmtes Steuerflussdiagramm .
• Von_Data_Dependence_Graph - Erstellen Sie alle Diagramme nach einem bestimmten Datenabhängigkeitsgraphen .
• Von_Program_Dependence_Graph - Erstellen Sie alle Diagramme nach einem bestimmten Programmabhängigkeitsgraphen .

---

Analyse - Satz von Funktionen, mit denen verschiedene Diagramme aus der angegebenen Spezifikation für Quellcode -Zeichenfolge und Programmiersprache erstellt werden können.

• contrel_dependence_graph - analysieren Sie einen Kontrollabhängigkeitsgraphen :

 from program_slicing . graph . cdg import ControlDependenceGraph
from program_slicing . graph . parse import control_dependence_graph , Lang

cdg : ControlDependenceGraph = control_dependence_graph ( source_code , Lang . JAVA )

• CONTROL_FLOW_GRAPH - Analysieren Sie einen Steuerflussdiagramm :

 from program_slicing . graph . cfg import ControlFlowGraph
from program_slicing . graph . parse import control_flow_graph , Lang

cfg : ControlFlowGraph = control_flow_graph ( source_code , Lang . JAVA )

• Data_Dependence_Graph - Analyse eines Datenabhängigkeitsgraphen :

 from program_slicing . graph . ddg import DataDependenceGraph
from program_slicing . graph . parse import data_dependence_graph , Lang

ddg : DataDependenceGraph = data_dependence_graph ( source_code , Lang . JAVA )

• Programm_Dependence_Graph - Analyse eines Programmabhängigkeitsgraphen :

 from program_slicing . graph . pdg import ProgramDependenceGraph
from program_slicing . graph . parse import program_dependence_graph , Lang

pdg : ProgramDependenceGraph = program_dependence_graph ( source_code , Lang . JAVA )

• Tree_Sitter_AST - Analysieren Sie einen abstrakten Syntaxbaum :

 from tree_sitter import Tree
from program_slicing . graph . parse import tree_sitter_ast , Lang

ast : Tree = tree_sitter_ast ( source_code , Lang . JAVA )

---

Convert - Es gibt auch eine Option, um einen Diagertyp in einen anderen umzuwandeln:

 from program_slicing . graph import convert
from program_slicing . graph . cdg import ControlDependenceGraph
from program_slicing . graph . cfg import ControlFlowGraph

cdg : ControlDependenceGraph = ControlDependenceGraph ()
cfg : ControlFlowGraph = convert . cdg . to_cfg ( cdg )
new_cdg : ControlDependenceGraph = convert . cfg . to_cdg ( cfg )