Der Shortcut

Man kennt aber von vielen Programmen den Shortcut zum Öffnen eines gerade geschlossenen Fensters/Tabs. Wieso sollte dieser also nicht auch in eclipse funktionieren? Also habe ich ihn kurzerhand mal gedrückt und erwartet, dass die gerade geschlossene Datei wieder geöffnet wird:

STRG + SHIFT + T

Leider wurde mit diesem Shortcut nicht die zuletzt geschlossene Datei geöffnet, sondern es wurde ein Fenster mit dem Titel “Open PHP Element” geöffnet, das wie folgt aussieht:

Es handelt sich hierbei um ein Suchfenster, mit dem man nach Klassen, Funktionen und Konstanten suchen kann. Hierbei wird immer in allen Projekten gleichzeitig gesucht. Wie ihr in meiner Beispielsuche sehen könnt, kann man auch nach Methoden einer Klasse suchen. Wichtig ist aber bei der Suche, dass sie immer am Beginn eines Bezeichners sucht. Man kann allerdings einen Stern voranstellen, um auch innerhalb der Bezeichner nach einem Wort zu suchen:

Das ist auch dann notwendig, wenn man z.B. den Methodennamen einer Klasse kennt, nicht aber den Namen der Klasse, in der die Methode enthalten ist.

Ein Doppelklick auf einen Eintrag des Suchergebnisses öffnet die Datei, in der die Klasse, Funktion oder Konstante definiert wurde und springt zu der entsprechenden Stelle. Das ist vor Allem dann sinnvoll, wenn die entsprechenden Funktionen nicht mit Hilfe von PHPDoc beschrieben wurden und man feststellen möchte, was genau die Funktion macht. Gerade bei der Arbeit mit WordPress ist es oft sehr hilfreich nachzusehen, ob es in einer Funktion einen Filter gibt, wann er ausgeführt wird und was er macht.

Der Shortcut lässt sich in meiner aktuellen Installation von eclipse mit dem Aptana Plugin allerdings nur dann ausführen, wenn ich gerade eine Datei geöffnet habe, die mit einem der Aptana Editoren verknüpft ist. Wenn ich also gerade eine Textdatei oder eine SQL-Datei offen habe, die mit einem nativen eclipse Editor verknüpft ist, funktioniert der Shortcut nicht.

Das Indizieren der Dateien für diese Suche läuft im Hintergrund ab. Es wird meistens nach einem Update z.B. aus einem SVN Respository durchgeführt. Mich hat es oft gewundert, was genau Aptana danach immer so lange macht, aber jetzt weiß ich ja wofür das gut ist.

Verwandter Shortcut und alternatives Plugin

Es steht übrigens eine Funktion “Open Ressource” zur Verfügung, mit der man direkt eine Datei öffnen kann, wobei auch hier Platzhalter verwendet werden können:

STRG + SHIFT + R

Ich verwende aber für die Suche nach Dateien das Plugin GotoFile welches selbst bei Tippfehlern noch die Datei findet. Man kann das Plugin entweder direkt aufrufen, oder aber vorher einen Text in einer Datei markieren, der dann beim Aufruf direkt in das Suchfeld eingetragen wird. Das ist vor allem beim Dateinamen sinnvoll, die z.B. per include() oder require() Funktion in eine Datei eingebunden wurden. Der Shortcut des Plugins lautet wie folgt:

STRG + ALT + N

Das Plugin wird zwar seit 2006 nicht mehr weiterentwickelt, aber es funktioniert auch mit der aktuellsten Version von eclipse (3.6.1) noch ohne Probleme. Es kann allerdings nicht über die Funktion “Software Updates…” hinzugefügt werden. Stattdessen kann man das Zip-Archiv einfach in den Plugins-Ordner der eclipse Installation entpacken.

Fazit

Ich bin von der neu entdeckten Funktion sehr begeistert, denn oft weiß ich ja genau wie eine Funktion heißt, aber nicht mehr unbedingt wo sie implementiert wurde. Doch selbst wenn man es weiß, kann man so sehr viel schneller an die entsprechende Stelle springen. Es hat mir schon einiges an Zeit und Sucherei erspart.

Ich hoffe, dass der Shortcut (oder das Plugin) auch bei eurer täglichen Arbeit helfen kann. Wenn jemand von euch einen tollen Vorschlag für einen Shortcut hat, würde ich mich sehr über einen Kommentar freuen. Ich werde ihn dann gerne hier vorstellen oder ihr schreibt selbst einen Gastbeitrag darüber.

Der Shortcut

Aber nun zum Shortcut selbst. Ich arbeite sehr viel mit eclipse (vor allem mit dem Plugin Aptana). Dabei bin ich vor kurzem aus Versehen auf einen neuen Shortcut gestoßen:

STRG + ALT + J

Aber was genau macht der Shortcut? Er dient dazu mehrere markierte Zeilen im Editor in einer Zeile hintereinander zu schreiben. Dabei werden alle Zeilenumbrüche und Tabs (bzw. mehrfache Leerzeichen) zu Beginn einer Zeile gelöscht. Die vorherigen Zeilen werden dann mit einem Leerzeichen getrennt in nur einer Zeile aufgeführt.

Ein Beispiel

Hierzu ein einfaches Beispiel, das viele von euch bestimmt häufiger haben. Wir nehmen eine kleine CSS Datei als Ausgangspunkt (hier als Beispiel meine aktuellen Footer Styles):

/* footer styles */
#footer {
    margin: 0;
    padding: 0 0 0 20px;
    list-style: none;
    color: white
}

#footer li {
    margin: 0;
    padding: 10px 0;
    font: 11px Arial, Helvetica, sans-serif;
}

#footer li.left {
    float: left;
    width: 35%;
}

#footer li.right {
    float: right;
    width: 65%;
}

Oft möchte man diese Styles kompakter in einer Zeile darstellen. Dazu würde man jetzt händisch immer alle Zeilenumbrüche und Tabs löschen (oder sich irgendwelche super komplexen Suchen-Ersetzen Regeln mit regulären Ausdrücken ausdenken). Aber es geht auch sehr einfach mit dem beschriebenen Shortcut. Dazu markiert man z.B. einfach der Quellcode von Zeile 1 bis 6 und benutzt den beschriebenen Shortcut STRG+ALT+J für die Selektion. Dies wiederholt man dann mit allen weiteren Definitionen inkl. aller Ausdrücke in den geschweiften Klammern und führt den Shortcut erneut durch. Am Ende kann man noch die Leerzeilen zwischen den zusammengefassten Definitionsblöcken löschen und erhält folgendes Ergebnis:

/* footer styles */
#footer { margin: 0; padding: 0 0 0 20px; list-style: none; color: white }
#footer li { margin: 0; padding: 10px 0; font: 11px Arial, Helvetica, sans-serif; }
#footer li.left { float: left; width: 35%; }
#footer li.right { float: right; width: 65%; }

Weiteres Beispiel

Das funktioniert aber natürlich nicht nur mit CSS, sondern auch mit andern Sprachen. Auch für Dinge wie Switch-Case Blöcke, XML Strukturen und vieles mehr kann der Shortcut eingesetzt werden, um den Quellcode übersichtlicher zu gestalten:

Switch-Case vorher:

switch($var){
	case 1 :
		func1();
		break;
	case 2 :
		func2();
		break;
	case 3 :
		func3();
		break;
	default :
		func();
}

Switch-Case nachher

switch($var){
	case 1 : func1(); break;
	case 2 : func2(); break;
	case 3 : func3(); break;
	default : func();
}

Wie ihr sehen könnt, kann man damit viele Konstrukte vereinfachen und dadurch eventuell besser lesbar machen. Eine nette Anwendung ist auch das “Minimieren” von CSS Datei. Hierzu markiert man einfach den gesamten Quellcode der CSS Datei und wendet den Shortcut an. Bei Sprachen mit einzeiligen Kommentaren, die in vielen Programmiersprachen mit zwei Slashes beginnen, kann der Quellcode so einfach natürlich nicht minimiert werden, da alles nach dem ersten einzeiligen Kommentar auch auskommentiert werden würde.

Grenzen des Shortcuts und Fazit

Der Shortcut ist nicht geeignet, wenn die Zeilenumbrüche notwendig sind. Es kann auch zu Problemen führen, wenn man Beispielsweise HTML Quellcode so vereinfacht, da hier die Leerzeichen zwischen der vorherigen Zeichen zu einem Leerzeichen im Text führen könnten, das vorher eventuell noch nicht vorhanden war. Aber für alle Kontrukte, bei denen Leerzeichen keine Auswirkung haben, kann es sehr zur Lesbarkeit eures Quellcodes beitragen. Es ist im Grunde eine Möglichkeit, die Autoformatierung durch den Shortcut STRG+SHIFT+F wieder teilweise zurückzunehmen. Ich habe mich jedenfalls gefreut den Shortcut entdeckt zu haben und hoffe, dass auch ihr damit ein bisschen Zeit in Zukunft einsparen könnt.

Dabei ist heute ein Problem aufgetaucht, für dass ich zuerst keine Lösung finden konnte. Ich habe einen Benutzer angelegt und anschließend ein SVN Repository mit svnadmin erstellt. Den Benutzer habe ich zu einer Gruppe hinzugefügt und dieser Gruppe die entsprechenden Rechte am Repository gegeben. Soweit so gut. Aber beim Versuch das Repository mit Subclipse in Eclipse einzubinden scheiterte dann das Anmelden per SSH.

Ich konnte allerdings von einem anderen Server per Konsole und mit svn+ssh auf das Repository zugreifen. Meine Vermutung war also, dass etwas mit dem Benutzer nicht stimmen muss. Und ich kam dann auch auf die Lösung. Mein Passwort enthielt einige Sonderzeichen als Ersatz für Buchstaben, in etwa so:

S1ch€resP@ssw0rt

Das Problem dabei war das Euro-Zeichen. Dieses ist in zwar im ASCII Zeichensatz enthalten, aber entweder verwendet Subclipse eine andere Zeichenkodierung, oder es unterstützt das Euro-Zeichen schlichtweg nicht. Nachdem ich das Euro-Zeichen durch ein anderes Symbol ersetzt habe, konnte ich mich auch mit Subclipse an meinem SVN Repository per svn+ssh verbinden.

Ich hoffe, ich konnte dem ein oder anderen mit diesem Tipp weiterhelfen, da es bestimmt nicht selten vorkommt, dass man im europäischen Raum ein “E” mit dem “€”-Zeichen ersetzt um ein Passwort etwas sicherer zu machen. Falls ihr auch einen tollen Tipp zu Subversion habt würde ich mich über einen Kommentar wie immer freuen

Die schlechte Lösung des Problems

Ich habe bisher, wie vermutlich die meisten von euch, das Problem wie folgt gelöst. Man macht einen Screenshot des Quellcodes in dem Editor, in dem die Syntaxhervorhebung funktioniert und erstellt sich dann ein Bild von dem entsprechenden Quellcode. Dieses Bild fügt man dann ich das Dokument ein.

Diese Lösung hat aber einen entscheidenden Nachteil. Viele Quelltexte aus Dokumenten werden als Vorlage verwendet und müssen daher aus dem Dokument kopiert werden können. Mit einem Bild ist das aber natürlich nicht möglich.

Die einfache aber tolle Lösung

Durch Zufall bin ich auf folgende einfache Lösung gestoßen. Ich habe diese Woche ein PDF-Dokument erstellen müssen und habe dazu auch zuerst mit Screenshots gearbeitet. Aber Aufgrund der Vielzahl an Quellcode Teilen und der bevorstehenden Abgabe habe ich dann darauf verzichtet, zu jedem einen Screenshot zu erstellen. Also habe ich den Quellcode einfach in eclipse markiert und in Word eingefügt.

Und dann hat es mich buchstäblich vom Hocker gehauen. Die gesamte Syntaxhervorhebung wurde 1:1 übernommen. Ich konnte es mit mehreren Dateietypen unter mehreren eclipse Plugins rekonstruieren. Mit anderen Editoren wie z.B. notepad++ hat es aber leider nicht funktioniert, aber mit eclipse 3.5 klappt es. Ich kann auch keine Aussage darüber treffen, ob es auch mit andern Office Suiten wie OpenOffice funktioniert. Aber da es mit Word 2007 inkl. Service Pack 2 ja auch sehr komfortabel möglich ist eine PDF zu erzeugen, bin ich mit der Lösung vollkommen zufrieden. Hier mal ein kleines Beispiel, wie es dann innerhalb von Word aussieht, nachdem man den Quellcode eingefügt hat:

Kennt ihr einen anderen Editor, der das gleiche ermöglicht. Oder kennt ihr auch eine andere Office Suite, die das einfügen mit Syntaxhervorhebung unterstützt? Wenn ja, würde ich mich sehr über einen Kommentar freuen. Ich kann dann hier eine kleine Tabelle einfügen mit Kombinationen, bei denen es funktioniert.