nikosch

Inspiriert von Zerglings letzter Frage zu Bitmasken, möchte ich ein paar Grundlagen zu Dualzahlen und deren Verwendung als Flag zum Besten geben.

Die meisten werden bei der Arbeit mit PHP schon die Bekanntschaft mit Flags gemacht haben. Sie werden oft benutzt, um das Verhalten von Funktionen mit hinter aussagekräftigen Konstantennamen definierten Werten zu beeinflussen. Dabei können meist mehrere Konstanten durch | (Pipe) kombiniert werden.

Hinter diesem Verfahren steckt ein einfaches Prinzip: die Stelle, an der bei Funktionsaufruf keine, eine oder eine Anzahl mit Pipe verknüpfter Konstanten angegeben wird, erwartet eigentlich einen ganz normalen Funktionsparameter, speziell einen Binärwert. Die zugehörigen Konstanten werden ebenfalls als Binärzahlen definiert, jede entspricht dabei einem anderen ganzzahligen Exponenten (Das kann man gut sehen, wenn man sich die Konstanten einer beliebigen Funktion mit Flags einfach mal ausgeben läßt). Das Pipe Symbol ist dann schlichtweg der Bit-Operator für 'ODER'.

Ein Beispiel:
Wir haben eine Funktion, die verschiedene Arbeitsweisen bietet, gesteuert von 4 Konstanten oder deren Kombination. Wir nennen diese Zustände mal AA, BB, CC und DD. Jeder dieser Zustände wird nun als Konstante mit einer Zahl aus dem Binärsystem belegt:

Jede Zahl ist als doppelter Wert der vorhergehenden definiert, das entspricht aufsteigenden, ganzzahligen Exponenten im Binärsystem, oder ums plastischer zu machen:

Stellen wir uns nun vor, wir wollen eine beliebige Kombination dieser 4 Zustände angeben und schauen wir uns dazu die binäre Darstellung der einzelnen Werte an, so wird schnell ersichtlich, dass jeder Zustand seine 'eigene' Dualstelle besitzt, die ihn als An (1) oder Aus (0) kennzeichnen kann.

Binär 1010 wäre demzufolge die Schreibweise für eine Kombination aus den Zuständen BB und DD.


Kurzer Ausflug in die interne Darstellung in php:

• Während jeder Rechner - jedenfalls bisher - intern ausschließlich bitweise, also mit Binärzahlen arbeitet, bietet php selbst gar keinen Variablentyp, der Binärzahlen darstellt. Allerdings ist das auch nicht nötig. Für eine Darstellung wie eben bietet sich der Stringtyp an, rechnen tut php jedoch mit integer Zahlen, auf die man trotzdem Bit-Operatoren anwenden kann. Der Hintergrund ist rein mathematisch: Eine Binärzahl ist lediglich in einem anderen Zahlensystem definiert, rechnen läßt sich ebenso gut mit einer Repräsentation derselben Zahl im Zehner-(Dezimal-)system. Wenn hier also von Binärzahlen die Rede ist, so nutzt php doch einen Integer als Variablentyp.

1. Verwendung als Flag (Zustandsangabe)

Nehmen wir an, unsere Zustände AA bis DD sollen einer Funktion bestimmte Verhaltensweisen signalisieren.
Wir definieren uns zunächst, wie oben bereits beschrieben unsere Binärwerte als Konstante.

Dann kommt unsere Funktion. Sie erfüllt in diesem Beispiel keinen anderen Zweck, als auf die gesetzten Flags zu reagieren:

Wir rufen die Funktion mit test (AA | CC); auf und erhalten folgende Ausgabe:

Wie funktionierts? Bei der Übergabe werden die durch AA und CC repräsentierten Werte binär ODER-Verknüpft:

Die ODER-Verknüpfung setzt dabei an jede Dualstelle eine 1, an der in einem der beiden Werte eine 1 steht. Das Resultat binär 0101 wird an die Funktion übergeben. Würden wir in test die Variable $flag ausgeben, würden wir aus o.g. Gründen nur die Dezimaldarstellung der Zahl sehen, konkret die 5.
Innerhalb der Funktion gilt es nun, die Flags wieder voneinander zu trennen. Wir wollen dies mit einem weiteren Bit-Operator, dem UND tun. UND tut genau das Gegenteil von ODER: es setzt jede Dualstelle auf 0, an der in mindestens einem der Operanden auch eine 0 steht.
Da die Konstanten global und damit auch in der Funktion verfügbar sind, prüfen wir nun alle 4 Flags auf Gesetztsein des entsprechenden Bits, in dem wir sie mit dem Inhalt von $flags UND-verknüpfen. Exemplarisch für AA und BB:

Wie wir sehen, ergibt sich für gesetzte Flags genau der jeweils in der Konstante definierte Binärwert, für nicht gesetzte Flags der Binärwert 0.
In unserer Funktion werden alle 4 Zustände geprüft und bei Übereinstimmung mit der Konstante der gesetzte Zustand durch Ausgabe des Konstantennamens signalisiert. Bei einer 'echten' Funktion könnten jetzt hier bestimmte Fälle abgearbeitet werden, wobei meist weitere Parametervariablen verarbeitet werden würden.


2. Verwendung gegenteiliger Flags

php Funktionen wie bspw. preg_match_all() verwenden auch durchaus Flags, die miteinander kombiniert gegenteilige Bedeutungen haben. Da Binärstellen prinzipbedingt nur zwei Zustände aufnehmen können, werden diese Zustände zunächst genauso angegeben wie im Vorgängerbeispiel, in der Funktion muß dann die logische Auswertung erfolgen.

In dieser Funktion schließt die Angabe von AA den Zustand BB aus. Wie vorher wird dazu geprüft, ob Zustand AA gesetzt ist. Wenn nicht, geht alles seinen gewohnten Gang. Falls doch, muß der Zustand BB aus $flags entfernt werden, um die nachfolgende Abarbeitung für BB zu unterbinden. Wieder hilft uns eine logische Operation - $flags wird mit dem inversen Wert von BB UND-verknüpft. Die für BB repräsentative Dualstelle 1 wird dabei zur 0 und löscht die entsprechende Stelle aus $flags aus, alle anderen Stellen werden 1 und stellen so sicher, dass die weiteren Dualstellen in $flags unbeeinflusst bleiben:

Voila! Aus unserer usprünglichen Zustandsangabe AA | BB | DD wurde BB während der Abarbeitung von AA entfernt. Übrig bleiben die dual definierten Zustände AA und DD.

Der Aufruf test2 (AA | BB | DD); gibt also zurück:

3. Verwendung des höchstwertigen Flag

Zerglings Ausgangsfrage bezog sich auf die Aufgabenstellung, eine Art Maximum der verwendeten Flags zu bestimmen, genauer gesagt, den größten innerhalb von $flags verwendeten Exponenten. Mir ist keine Möglichkeit mit Bit-Operatoren dafür bekannt. Mathematisch ausgedrückt gilt es, den 2er Logarithmus des Wertes in $flags zu bestimmen. Der ganzzahlige Teil des Ergebnisses ist unser Wert.
php bietet hier eine einfachere Variante. Wir verwandeln mittels decbin() den Wert in $flags seine Stringrepräsentation, also in eine Folge von Null- und Eins-Zeichen. Von rechts beginnend steht jede Dualstelle für einen Exponenten, die erste für 2 hoch 0, die zweite für 2 hoch 1 usw. Da php intern nicht mit führenden Nullen arbeitet (wie gesagt, eigentlich ja nicht einmal mit Binärzahlen) und wir die am weitesten links stehende 1 suchen, kann das Ergebnis direkt aus der Länge der Stringrepräsentation unserer Binärzahl bestimmt werden. Wir ziehen noch 1 ab, da das erste Zeichen für 2 hoch 0 steht.
Für unsere Signalfunktion (also um unserer Beispielfunktion hier irgendeinen Nutzen zu geben) verwenden wir den Exponenten, den wir erhalten haben, um mit pow() wieder eine Binärzahl zu erzeugen. Die Ausgabe erfolgt in einem Switch, da ja nur das höchstwertige gesetzte Flag gesucht war.

4. Eine große oder unbekannte Anzahl von Flags

Zuletzt ein etwas konstruiertes Beispiel, das mit dem Shift Operator arbeitet.
Nehmen wir an, wir wollen die übergebenen Flag-Bits nicht individuell prüfen und verarbeiten, sondern per Schleife (z.B. weil wir nicht wissen, welche numerischen Flags vorkommen können). Es wird also nötig, Bit für Bit, von 2 hoch 0 bis 2 hoch n auszulesen. Stellt man sich einen solchen Bitwert vor, wäre die naheliegendste Variante, diesen als String zu betrachten, per Schleife zeichenweise zu durchlaufen und den aktuellen numerischen Schlüssel mit der geschwungenen Klammer Syntax auszulesen. Das ist in php auch durchaus legitim, da es sich um eine schwach typisierte Sprache handelt und die Umwandlung der verschiedenen Typen im Allgemeinen automatisch erfolgt.
Trotzdem möchte ich hier auch die Arbeit mit Bit-Operatoren vorstellen. Als Beispiel sollen hier einfach die Binärwerte der gesetzten Zustände ausgegeben werden. Stellt man sich jetzt 40 statt der bisher verwendeten 4 Flags vor, sieht man, dass eine Lösung wie in der ersten Funktion unglaublich viel redundaten Code erzeugen würde. Stattdessen nutzen wir eine Schleife:

Ausgabe:
Der Clou an dieser Funktion ist das Bit-Shifting: mit dem << Operator wird eine Binärzahl erzeugt, die dann, ähnlich wie in der ersten Funktion mit $flags UND-verknüpft wird. Der Shift-Operator füllt die Ausgangszahl (1, binär 1) rechts mit weiteren Nullen auf, in Folge dessen wird $flags nacheinander mit 10000000000 , 1000000000 , 100000000 ... 1 UND-verknüpft und auf Vorhandensein eines Ergebnisses größer 0 geprüft. Bei Erfolg war das aktuelle Flag gesetzt, was durch die Ausgabe des Expontenten signalisiert wurde.
Übrigens: Statt $iMax fest zu definieren, könnte auch hier wie oben die Anzahl der maximalen Dualstellen von $flags ermittelt werden.


Auch wenn's zuletzt dann doch noch etwas knifflig wurde, könnt Ihr hoffentlich den einen oder anderen Punkt umsetzen, um eure Funktionen um eine paar Flag-gesteuerte Erweiterungen zu bereichern. Sinnvollerweise sollte der $flags Parameter immer mit 0 oder einem Defaultwert vorbelegt sein.

Viel Spaß beim Ausprobieren, Anmerkungen und Berichtigungen sind willkommen.
--n

Mister Ad

Zergling-new

Hast du schön gemacht

Bekanntestes Beispiel hierfür sind ja die Error-Reporting-Flags in PHP, hier ein Auszug aus einer php.ini:
http://de3.php.net/manual/de/functio...-reporting.php
Gute Frage allerdings, warum E_ALL jetzt auf 6143 steht, die Summe der restlichen Flags + 1 scheint es ja nicht zu sein.

Ist halt wirklich ne schöne Geschichte mit den Flags, weil man TRUE/FALSE Optionseinstellungen gesammelt einfach in eine Variable packen kann.

Überlege man sich mal, ich müsste - bezogen auf den von nikosch verlinkten Thread von mir - für eine CSV-Spalte speichern, ob darin VARCHAR, INTEGER, DATE, etc. Werte gefunden hätte, ohne dabei auf eine Bitmaske zurückzugreifen. Das würde schnell sehr unübersichtlich werden.

nikosch

Gute Frage, vor allem weil 6143 binär 1011111111111 ist. Wozu die Null frag ich mich da. Wohl um E_STRICT explizit auszuschließen. 2^0 bis 2^10 sind ja abgedeckt. Und auch 4096 ist bereits definiert - als E_RECOVERABLE_ERROR:
Dann stimmts ja wieder! Abzüglich E_STRICT natürlich.
E_ALL ist je nach Version aber auch als 8191 bzw. 2047 definiert. 8191 übrigens dann ohne die Lücke für E_STRICT.

Zergling-new

Stimmt, E_STRICT is ja nich mit drin.