Sign in Join
Wiki copytemporary

Codetools/de: what changed

Revision 4 to 5. Removed lines have a minus sign; added lines have a plus sign.

OldNewLine
11# Was sind die CodeTools
22
33Die CodeTools sind ein Lazarus-Package mit Werkzeugen zum Parsen, Untersuchen, Bearbeiten und Refaktorieren von Pascal-Quelltexten. Die CodeTools sind ein Modul für sich und unter der GPL lizensiert. Zahlreiche Beispiele, wie Sie die CodeTools in Ihren eigenen Programmen einsetzen können, finden Sie unter 'components/codetools/examples'.
44
55svn:
66
77- Lazarus: <http://svn.freepascal.org/svn/lazarus/trunk>
88- Nur CodeTools: <http://svn.freepascal.org/svn/lazarus/trunk/components/codetools>
99
1010# Verwendung der CodeTools ohne die IDE (gut für Testzwecke)
1111
1212Sie können die CodeTools ohne die IDE verwenden. Dies kann zum Testen eines neuen Werkzeugs genutzt werden. Ein einfaches Beispiel ist
1313
14-```
14+```text
1515 <lazarusdir>/components/codetools/examples/methodjumping.lpi
1616```
1717
1818Um die *find declaration* zu testen, müssen die CodeTools die Quellen analysieren, besonders die RTL- und FCL-Quellen. Die Beispiele benutzen folgende Umgebungsvariablen:
1919
2020- FPCDIR: der Pfad zu den FPC-Quelltexten, die Vorgabe ist *~/freepascal/fpc*.
2121- PP: der Pfad zum ausführbaren Kompiler (/usr/bin/fpc oder /usr/bin/ppc386 oder C:\lazarus\ppc386.exe). Die CodeTools müssen den Kompiler nach den Einstellungen fragen. Als Vorgabe wird mittels der Variablen 'PATH' nach 'fpc' gesucht.
2222- FPCTARGETOS: weist die CodeTools an, nach einem weiteren Betriebssystem zu suchen ("cross compiling"). Zum Beispiel: linux, freebsd, darwin, win32, win64, wince
2323- FPCTARGETCPU: sucht nach einer anderen CPU. Zum Beispiel: i386, powerpc, x86_64, arm, sparc
2424- LAZARUSDIR: der Pfad zu den Lazarus-Quelltexten. Wird nur benötigt, wenn Sie diese untersuchen wollen.
2525
2626FPC ist ein sehr komplexes Projekt mit vielen Suchpfaden, Include-Dateien und Makros. Die CodeTools müssen alle diese Pfade und Makros kennen, um diesen Dschungel zu analysieren. Um dies alles einfach einzurichten, enthalten die CodeTools vordefinierte Schablonen für FPC-, Lazarus-, Delphi- und Kylix-Quellverzeichnisse. Betrachten Sie für ein *find declaration* folgendes Beispiel
2727
28-```
28+```text
2929 <lazarusdir>/components/codetools/examples/finddeclaration.lpi
3030```
3131
3232Weil die FPC-Quellen mehrere Versionen einiger Units enthalten und die FPC-Quellen oft geändert werden, verwenden die CodeTools keine starre Pfadtabelle. Stattdessen scannen sie zuerst die gesamte FPC Verzeichnisstruktur und versuchen mittels einiger Regeln herauszufinden, welche Quelle die richtige ist für das gegenwärtige ZielOS und ZielCPU. Dieser Scan kann eine Weile dauern. Alle Beipiele speichern das Ergebnis in **codetools.config**, damit diese Suche beim nächsten Start übersprungen wird.
3333
3434Wann immer die FPC-Quellen verschoben wurden oder eine Unit umbenannt wurde, löschen Sie einfach die Datei **codetools.config**. Die Lazarus-IDE hat ihre eigene Konfigurationsdatei und erledigt den Rescan, wann immer das Compiler executable geändert wurde oder der Benutzer dies erzwingt mit 'Einstellungen \> FPC-Quelltextverzeichnis neu einlesen'.
3535
3636# Verwendung der CodeTools in der IDE mit dem IDEIntf
3737
3838Siehe das \<lazarusdir\>/examples/idequickfix/quickfixexample.lpk Package. Es demonstriert:
3939
4040- Wie man ein IDE-Package schreibt. Wenn Sie es installieren, wird es ein Quick-Fix-Element registrieren.
4141- Wie man ein Quick-Fix-Element schreibt für die Compilermeldung 'Parameter "Sender" not used'
4242- Wie man die CodeTools verwendet, um
4343 - eine Unit zu analysieren
4444 - Dateiname, Zeile, Spalte in eine CodeTools Quelltextposition umzuwandeln
4545 - ein CodeTools-Element an der Cursorposition zu finden
4646 - ein 'procedure'-Element und das 'begin..end'-Element zu finden
4747 - für eine Anweisung eine günstige Einfügeposition am Anfang eines 'begin..end'-Blocks zu ermitteln
4848 - die Einrückung einer Zeile zu erhalten, damit sich die neue Zeile in die Prozedur einfügt
4949 - Code einzufügen mit den CodeTools
5050
5151# Codetools-Regeln für FPC-Quelltexte
5252
5353Wenn die CodeTools die Quelltexte nach einer FPC ppu-Datei durchsuchen, verwenden sie einen Satz von Regeln. Sie können Ihre eigenen Regeln Schreiben, aber normalerweise werden Sie die Standardregeln benutzen, die in der der Includedatei 'components/codetools/fpcsrcrules.inc' festgelegt sind. Sie können die Regeln testen mit dem Befehlszeilenwerkzeug: components/codetools/examples/testfpcsrcunitrules.lpi.
5454
5555## Gebrauch von testfpcsrcunitrules
5656
5757 Gebrauch: lazarus/components/codetools/examples/testfpcsrcunitrules -h
5858
5959 -c <compiler file name>, --compiler=<compiler file name>
6060 Vorgabe ist es, die Umgebungsvariable PP zu benutzen.
6161 Wenn nicht angegeben, suche nach fpc
6262
6363 -T <target OS>, --targetos=<target OS>
6464 Vorgabe ist es, die Umgebungsvariable FPCTARGET zu benutzen.
6565 Wenn nicht angegeben, nimm die Vorgabe des Kompilers.
6666
6767 -P <target CPU>, --targetcpu=<target CPU>
6868 Vorgabe ist es, die Umgebungsvariable FPCTARGETCPU zu benutzen.
6969 Wenn nicht angegeben, nimm die Vorgabe des Kompilers.
7070
7171 -F <FPC source directory>, --fpcsrcdir=<FPC source directory>
7272 Vorgabe ist es, die Umgebungsvariable FPCDIR zu benutzen.
7373 Es gibt keine andere Vorgabe.
7474
7575 -u <unit name>, --checkunit=<unit name>
7676 Schreibe einen detailierten Bericht über diese Unit.
7777
7878## Beispiel für testfpcsrcunitrules
7979
8080Öffnen Sie die Datei 'testfpcsrcunitrules.lpi' in der IDE und kompilieren Sie sie. Starten Sie dann das Werkzeug in einer Befehlszeile/Konsole:
8181
82-```
82+```text
8383./testfpcsrcunitrules -F ~/fpc/sources/2.5.1/fpc/
8484```
8585
8686Dadurch erfahren Sie, welcher Kompiler benutzt wird, welcher Kompiler ausgeführt wird, welche Konfigurationsdateinen getestet und analysiert wurden, Sie werden gewarnt über doppelte Units im FPC-Suchpfad und doppelte Quelltextdateien für die selbe Unit.
8787
8888## Doppelte Quelltextdateien
8989
9090Angenommen, Sie finden heraus, dass die CodeTools für das Ziel 'wince/arm' den falschen Quelltext der Unit *mmsystem* öffnen. Starten Sie das Werkzeug mit dem Parameter '-u':
9191
9292./testfpcsrcunitrules -F ~/fpc/2.5.1/fpc/ -T wince -P arm -u mmsystem
9393
9494Dadurch erhalten Sie einen detaillierten Bericht darüber, wo diese Unit gefunden wurde und welches Score jede Quelltextdatei erzielt hat. Zum Beispiel:
9595
9696``` pascal
9797Unit report for mmsystem
9898 WARNING: mmsystem is not in PPU search path
9999GatherUnitsInFPCSources UnitName=mmsystem File=packages/winunits-base/src/mmsystem.pp Score=11
100100GatherUnitsInFPCSources UnitName=mmsystem File=packages/winceunits/src/mmsystem.pp Score=11 => duplicate
101101```
102102
103103Dies bedeutet, dass es zwei Quelltextdateien mit dem selben Score gibt, sodass die CodeTools die erste genommen haben. Die letzte im Verzeichnis 'winceunits' ist für das Ziel 'wince' und die erste ist für 'win32' und 'win64'.
104104
105105Öffnen Sie jetzt die Regeldatei 'fpcsrcrules.inc'.
106106
107107Regeln arbeiten so:
108108
109109``` pascal
110110Score:=10;
111111Targets:='wince';
112112Add('packages/winceunits');
113113```
114114
115115Das **Add** fügt eine Regel hinzu für alle Dateien, die mit 'packages/winceunits' beginnen. Zum Score all dieser Dateien wird 10 addiert. **Targets** ist eine durch Kommas getrennte Liste von Zielbetriebssystemen und/oder Zielprozessoren. Beispielsweise: Targets='wince,linux,i386' bedeutet: wende diese Regel auf das ZielOS 'wince' oder 'linux' und auf die ZielCPU i386 an.
116116
117117# Wie die CodeTools Quelltexte untersuchen, abhängig von einem Kompiler
118118
119119Ein Kompiler ist dazu optimiert den Code linear zu durchlaufen und die benötigten Units und Includedateien dann zu laden, wenn er einen uses-Abschnitt oder eine Direktive findet. Die CodeTools sind dazu optimiert, nur Teile des Codes zu untersuchen. Beispielsweise braucht der Sprung von einer Methodendeklaration zum Methodenrumpf nur die Unit und ihre Includedateien. Wenn die CodeTools eine Deklaration suchen, dann suchen sie rückwärts. Das bedeutet, sie starten die Suche in den lokalen Variablen und dann oberhalb in der Implementation. Wenn sie einen uses-Abschnitt vorfinden, suchen sie den Bezeichner im Abschnitt 'interface' der Units. Wird der Bezeichner gefunden, halten sie an. Das Ergebnis und einige Zwischenschritte werden gecached. Weil oftmals nur einige interface-Abschnitte durchsucht werden müssen, wird ein einzelner Bezeichner rasch gefunden.
120120
121121Die CodeTools durchsuchen einen Quelltext nicht in einem Durchgang wie ein Kompiler, sondern in mehreren Durchgängen, abhängig von den Erfordernissen der aktuellen Funktion:
122122
123123- Zuerst wird ein Quelltext in einen TCodeBuffer geladen. Die IDE benutzt diesen Schritt, um die Kodierung in UTF8 zu ändern. Die Dateien werden im Speicher gehalten und nur nachgeladen, wenn sich das Änderungsdatum ändert oder eine Datei manuell umgeändert wird. Es gibt einige Tools und Funktionen die direkt mit dem Puffer arbeiten.
124124- Die nächste Ebene ist das Untersuchen einer Unit oder Includedatei. Eine Unit muss vom Anfang an durchlaufen werden, deshalb versuchen die CodeTools die Hauptdatei herauszufinden, die erste Datei einer Unit. Dabei suchen sie in der ersten Zeile nach einer Direktive, wie {%MainUnit ../lclintf.pp}. Falls diese nicht existiert, wird der 'includelink cache' durchsucht. Die IDE speichert diesen Cache auf dem Laufwerk, so lernt die IDE mit der Zeit dazu.
125125- Nachdem die Hauptdatei gefunden wurde, scannt TLinkScanner den Quelltext. Er verarbeitet Kompilerdirektiven, wie Include-Direktiven und 'if-else'-Direktiven. Dem Scanner kann ein Bereich übergeben werden, beispielsweise um nur das Interface einer Unit zu durchsuchen. Der Scanner erzeugt den **clean source**. Der 'clean source' besteht aus allen Includedateien und befreit von sämtlichen übersprungenen Codestellen aus den 'else'-Teilen. Er erzeugt auch eine Liste von **links**, die den 'clean source' und die realen Quelltextdatein verbinden. Der 'clean source' ist jetzt Pascal. Beachten Sie: es gibt auch Tools, um eine einzelne Quelle nach allen Direktiven zu durchsuchen und einen Direktivenbaum zu erstellen.
126126- Nach dem Erzeugen des 'clean source' untersucht ein TCodeTool diesen und erstellt einen Baum von 'TCodeTreeNode'-Elementen. Auch hier ist eine Bereichsangabe möglich. Dieser Parser überspringt einige Teile, zum Beispiel 'class members', 'begin..end'-Blocks und Parameterlisten. Viele Tools brauchen diese nicht. Diese Unterknoten werden nur bei Bedarf erzeugt. Ein TCodeTreeNode hat einen Bereich StartPos..EndPos, welche 'clean positions' sind, also Positionen im 'clean source'. Es gibt nur Knoten für die wichtigen Teile. Knoten für jedes Detail zu erstellen würde mehr Speicher benötigen als der Quelltext selbst und ist auch selten erforderlich. Zahlreiche Funktionen sind dazu da, die Details herauszufinden. Ob beispielsweise eine Funktion der Aufrufskonvention 'cdecl' entspricht.
127127- Wird ein Bezeichner gesucht, dann speichert die Suche die gefundenen Basistypen und erzeugt Caches für alle Bezeichner aus dem Interface-Abschnitt.
128128
129129Jede Ebene hat ihre eigenen Caches, die vor dem Aufruf einer Funktion geprüft und aktualisiert werden müssen. Viele High-level-Funktionen, auf die mittels 'CodeToolBoss' zugegriffen werden kann, machen das automatisch. Für andere liegt die Verantwortung beim aufrufenden Prozess.
130130
131131Ein Beispiel dafür:
132132
133133unti1.pas:
134134
135135``` pascal
136136unit Unit1;
137137{$I settings.inc}
138138interface
139139uses
140140 {$IFDEF Flag}
141141 unix,
142142 {$ELSE}
143143 windows,
144144 {$ENDIF}
145145 Classes;
146146```
147147
148148settings.inc:
149149
150150``` pascal
151151{%MainUnit unit1.pas}
152152{$DEFINE Flag}
153153```
154154
155155clean source:
156156
157157``` pascal
158158unit Unit1;
159159{$I settings.inc}{%MainUnit unit1.pas}
160160{$DEFINE Flag}
161161interface
162162uses
163163 {$IFDEF Flag}
164164 unix,
165165 {$ELSE}{$ENDIF}
166166 Classes;
167167```
168168
169169Tipp: Um eine Unit einfach zu durchlaufen und die Knoten zu erstellen, verwenden Sie **CodeToolBoss.Explore**.
170170
171171# Clean Position und Kursorposition
172172
173173Es gibt verschiedene Methoden, um in den CodeTools eine Position zu definieren.
174174
175175Die absolute Position bezieht sich auf den Quelltext als Zeichenkette und beginnt bei 1. Beispielsweise hält ein TCodeBuffer den Dateiinhalt als Zeichenkette in der Eigenschaft 'Source'. Die Positionen der Einfügemarke oder des Kursors sind als X,Y gegeben, wobei Y die Zeilennummer ist (bei 1 beginnend) und X die Spaltennummer (bei 1 beginnend). Ein TCodeBuffer stellt zum Umwandeln die Funktionen **LineColToPosition** und **AbsoluteToLineCol'' zur Verfügung. Wenn Sie mit mehreren Quelltextdateinen arbeiten, wie einer Unit, die aus verschiedenen Includedateien bestehen kann, dann bezieht sich 'Clean Position' auf die absolute Position im bereinigten Code**Src**. Src ist eine Zeichenkette und Clean Positions beginnt bei 1. Die Kursorpositionen werden angegeben als TCodeXYPosition (Code,X,Y). Ein TCodeTool stellt zum Umwandeln die Funktionen**CaretToCleanPos**,**CleanPosToCaret''' zur Verfügung.
176176
177177# Einfügen, Löschen und Ersetzen - der TSourceChangeCache
178178
179179Wenn Sie Änderungen am Quelltext einer Unit (oder ihrer Includedateien) vornehmen, sollten Sie dazu 'CodetoolBoss.SourceChangeCache' benutzen, weil:
180180
181181- Einfache Anwendung. Verbinden, ersetzen, ersetzen, ... anwenden. Siehe unten.
182182- Sie benutzen 'cleanpos' wie durch den Knotenbaum gegeben ODER Sie benutzen die direkten Positionen in einer Datei.
183183- Sie können 'Replace' zum Einfügen und Löschen benutzen. Dies löst automatisch Ereignisse aus, wodurch verbundene Editoren über Veränderungen benachrichtigt werden.
184184- Es können automatisch benötigte Leerzeichen eingefügt werden, ebenso Zeilenendezeichen oder Leerzeilen vor doer nach jedem Replace. Zum Beispiel definieren Sie, dass jeweils eine Leerzeile voran gehen soll. Der SourceChangeCache prüft, was eingefügt werden soll, wie viel Platz bereits dort ist und wird den notwendigen Platz einfügen.
185185- Er überprüft, ob der Bereich für Ersetzen/Löschen beschreibbar ist.
186186- Sie können mehrfache Ersetzungen vornehmen und Sie steuern, wann diese angewendet werden. Bedenken Sie dabei, dass das Einfügen von Code bedeutet, dass der untersuchte Baum ungültig wird und neu erstellt werden muss.
187187- Mehrfache Ersetzungen werden auf Überschneidungen geprüft. Zum Beispiel erhalten Sie beim Einfügen in der Mitte eines gelöschten Codes eine Fehlermeldung.
188188- Mehrfache Ersetzungen an der selben Stelle werden reihenweise abgearbeitet (nach dem FIFO-Prinzip).
189189- Sie können verschiedene Funktionen zum Bearbeiten von Code zu einer größeren Funktion kombinieren. Siehe unten.
190190
191191## Verwendung
192192
193193Der SourceChangeCache arbeitet mit einer Unit, deshalb müssen Sie ein TCodeTool nehmen und eine Unit/Includedatei damit scannen. Zum Beispiel:
194194
195195``` pascal
196196 // Schritt 1: lade die Datei und untersuche sie
197197 Code:=CodeToolBoss.LoadFile(Filename,false,false);
198198 if Code=nil then
199199 raise Exception.Create('loading failed '+Filename);
200200 if not CodeToolBoss.Explore(Code,Tool,false) then
201201 ...;// Fehler beim Untersuchen ...
202202
203203 // Schritt 2: verbinde mit dem SourceChangeCache
204204 CodeToolBoss.SourceChangeCache.MainScanner:=Tool.Scanner;
205205
206206 // Schritt 3: nimm Replace zum Einfügen und/oder Löschen von Code.
207207 // Die beiden ersten Parameter sind die benötigten Leerzeichen vor und hinter der Einfügestelle.
208208 // FromPos, ToPos legen den gelöschten/ersetzten Bereich in CleanPos-Positionen fest.
209209 // NewCode ist die Zeichenkette des neuen Codes. Verwenden Sie '' zum Löschen.
210210 if not CodeToolBoss.SourceChangeCache.Replace(gtNone,gtNone,FromPos,ToPos,NewCode) then
211211 exit; // z.B. Quelltext ist nicht beschreibbar oder ein vorangegangenes Ersetzen hat diese Stelle gelöscht
212212 ...einige weitere Ersetzungen...
213213
214214 // Schritt 4: wende die Änderungen an
215215 if not CodeToolBoss.SourceChangeCache.Apply then
216216 exit; // Anwendung wurde abgebrochen
217217```
218218
219219## BeginUpdate/EndUpdate
220220
221221BeginUpdate/EndUpdate verzögert die Anwendung. Dies ist nützlich, wenn Sie verschiedene Code ändernde Funktionen kombinieren. Zum Beispiel:
222222
223223Sie wollen die Unit scannen, fügen eine Unit in der uses-Klausel des Interface-Bereichs hinzu und entfernen die Unit aus der uses-Klausel des Implementation-Bereichs. Die zwei Funktionen 'AddUnitToMainUsesSection' und 'RemoveUnitFromUsesSection' benutzen 'Apply', ändern den Quelltext, sodass die zweite Funktion die Unit ein zweites Mal scannen würde. Weil aber beide Funktionen voneinander unabhängig sind (Sie verändern verschiedene Teile des Quelltextes) können Sie beide miteinander kombinieren und nur einen Scan machen:
224224
225225``` pascal
226226 // Schritt 1: durchsuche die Unit und verbinde mit SourceChangeCache
227227 if not CodeToolBoss.Explore(Code,Tool,false) then
228228 ...;// Fehler beim Untersuchen ...
229229 CodeToolBoss.SourceChangeCache.MainScanner:=Tool.Scanner;
230230
231231 // Schritt 2: verzögere die Anwendung
232232 CodeToolBoss.SourceChangeCache.BeginUpdate;
233233
234234 // Schritt 3: füge die Unit zum Interface-Bereich hinzu
235235 // AddUnitToMainUsesSection würde angewendet und den Code ändern
236236 // Wegen BeginUpdate finden die Änderungen noch nicht statt, werden aber in SourceChangeCache gespeichert
237237 if not Tool.AddUnitToMainUsesSection('Classes','',CodeToolBoss.SourceChangeCache) then exit;
238238
239239 // Schritt 4: entferne die Unit aus dem Implementation-Bereich
240240 // Ohne BeginUpdate würde RemoveUnitFromUsesSection die Unit erneut scannen
241241 if Tool.FindImplementationUsesSection<>nil then
242242 if not Tool.RemoveUnitFromUsesSection(Tool.FindImplementationUsesSection,'Classes',CodeToolBoss.SourceChangeCache) then exit;
243243
244244 // Schritt 5: wende alle Änderungen an
245245 if not CodeToolBoss.SourceChangeCache.EndUpdate then
246246 exit; // Anwendung wurde abgebrochen
247247```
248248
249249BeginUpdate/EndUpdate arbeiten mit einem Zähler, wenn Sie also BeginUpdate zwei Mal aufrufen, müssen Sie auch EndUpdate zwei Mal aufrufen. Dies bedeutet, dass Sie obiges Beispiel in eine Funktion stellen und mit einer weiteren Funktion kombinieren können.
250250
251251## Speichern Sie die Änderungen auf Disk
252252
253253Die obigen Änderungen werden nur in den Codepuffern gemacht und diese Puffer als 'verändert' markiert. Um die Änderungen auf Disk zu speichern, müssen Sie für jeden veränderten Puffer 'Save' aufrufen.
254254
255255- Die Puffer, die mit dem nächsten Apply/EndUpdate geändert werden liegen in 'SourceChangeCache.BuffersToModify' und 'BuffersToModifyCount'.
256256- Die Ereignisse 'SourceChangeCache.OnBeforeApplyChanges/OnAfterApplyChanges' werden von CodeToolBoss benutzt, der sie mit seinen eigenen 'OnBeforeApplyChanges/OnAfterApplyChanges' verbindet. Die Lazarus-IDE setzt diese Ereignisse und öffnet automatisch die geänderten Dateien im Quelltexteditor, dadurch scheinen alle Änderungen in der Undo-Liste von Synedit auf.
257257
258258# Links
259259
260260- [[Lazarus IDE Tools/de|Lazarus IDE Tools (deutsch)]] - Ein Tutorial über die eingebauten Werkzeuge der Standard-IDE.
261261- [[Cody]] - ein IDE-Package mit fortgeschrittenen CodeTools.
262262- [[Extending the IDE/de|Erweitern der IDE (deutsch)]] - Wie Sie Ihre eigenen CodeTool-Plugins für die IDE schreiben.
263263
264264---
265265*From the Free Pascal wiki, page "Codetools/de", as it stood on 2020-02-11 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).*

Back to history