[C++] Event Bugfix

dieser Bugfix ist vermutlich nur für wenige interessant, die sich schon etwas mehr mit dem Source auseinandergesetzt haben, aber diejenigen, die irgendwann mal dieses vermeintlich unlogische Problem bekommen sollten, welches ich heute gehabt habe und 3 Stunden an einer Lösung gesessen habe, denen möchte ich hiermit helfen.

Worum geht es in diesem Release? Ich möchte einen Fehler im Game-Source nennen, der Standartmäßig vorhanden ist - nur bisher nicht aufgefallen ist, da man diesen Fehler nur auf komplizierten Wegen erreicht. Der Fehler liegt in der Verbarbeitung von Events - also zeitabhängigen Ereignissen die einem bestimmten Intervall folgen. Der Fehler liegt darin, dass die Warteschlangenelemente vor dem Aufruf der Event-Funktion gelöscht werden (operator delete) und aber erst nach dem Aufruf der Pointer vom Event auf das Warteschlangenelement auf NULL gesetzt wird - sofern das Event während der Ausführung sich selbst beendet hat (durch "event_cancel") oder durch eine 0-Rückgabe der Event-Funktion.

Praktisches Beispiel für den Fehler (ich nehme jetzt mal den Weg, wie ich den Fehler bekommen habe):
a) In der Warteschlange von den Events wird das Warteschlangenelement W1 geladen
b) Dieses Element enthält Event E1 (welches einen Pointer auf W1 enthält)
c) Das Warteschlangenelement W1 wird gelöscht (operator delete)
d) Die Event-Funktion F1 wird von E1 aufgerufen
e) Diese Event-Funktion ruft eine weitere Funktion (F2) auf
f) In F2 wird ein neues Event (E2) erstellt
g) Dabei wird ein neues Warteschlangenelement W2 erstellt
h) Am Ende von F2 wird der Befehl "event_cancel(&E1)" aufgerufen (das Event (vermeintlich E1) wird beendet)
So, wo ist der Fehler? Der Fehler liegt darin, dass E2 niemals aufgerufen wird. Egal welche Zeit eingestellt wurde oder welche Funktion (F3) angegeben wurde, es wird niemals aufgerufen werden - da es von dem Befehl bei h) beendet wurde. Warum? Schauen wir es uns noch einmal detailierter mit Pointern an:

a) In der Warteschlange von den Events wird das Warteschlangenelement W1 geladen [W1->Data = E1]
b) Dieses Element enthält Event E1 [E1->pElement = W1]
c) Das Warteschlangenelement W1 wird gelöscht (operator delete) [E1->pElement = (gelöschtes) W1]
d) Die Event-Funktion F1 wird von E1 aufgerufen [E1->pElement = (gelöschtes) W1]
e) Diese Event-Funktion ruft eine weitere Funktion (F2) auf [E1->pElement = (gelöschtes) W1]
f) In F2 wird ein neues Event (E2) erstellt [W2->Data = E2; E2->pElement = W2; E1->pElement = (gelöschtes) W1 = W2]
g) Am Ende von F2 wird der Befehl "event_cancel(&E1)" aufgerufen [E1->pElement = (gelöschtes) W1 = W2 -> event_cancel(&E1) = event_cancel(&E2)]

Ich hoffe, dies war detailiert genug - für alle die sich mit kleinen Änderungen am Source auseinandersetzen ist dies sowieso noch uninteressant bzw. unrelevant.

Lösung für das Problem: ihr öffnet eure event.cpp & geht dort zur Funktion Dort scrollt ihr runter bis und ändert den Teil zu diesem Teil ab:

This bugfix is only for these people interesting who are really working with the source. I did this for these who will maybe have this - alleged unlogical - problem in the future and that they won't have to search and search for a solution like I did it for three hours.. Well, let's begin.

What is this release about? I wanna name a mistake in the game source which is in every source (by ymir) - just nobody have found the mistake because you need to go complicated ways to produce it. The error lays in the processing of the events. The elements of the event queue are removed before the event is called (operator delete) but the pointer to them is removed after (removed = set to NULL) the event is called (it's only set to NULL if the event has stopped the repeat with a 0-return or with a call of "event_cancel").

A pratical way how to produce the error (I'll tell you the way I found it):
a) The event-queue loads / computes an element [Q1]
b) This element contains a pointer to an event [E1] (and the event [E1] contains a pointer to the queue element [Q1])
c) The queue element [Q1] will be removed (operator delete)
d) The function [F1] of the event [E1] will be called
e) This function [F1] calls another function [F2]
f) The function [F2] creates another event [E2] (which contains a pointer to the queue element [Q2] - also created with the new event)
g) At the end of [F2] the command "event_cancel(&[E1])" will be called (the event (supposed to be [E1]) will be canceled)
Well, where is the failure? The failure is: [E2] won't ever be called. You can insert every time and every function to the event [E2] but it won't ever be called - because it has been canceled at the command in g). Why? Let's have a more detailed look to this (with pointer this time):

a) The event-queue loads / computes an element [Q1] ([Q1]->Data = [E1])
b) This element contains a pointer to an event [E1] ([E1]->pElement = [Q1])
c) The queue element [Q1] will be removed ([E1]->pElement = (removed) [Q1])
d) The function [F1] of the event [E1] will be called ([E1]->pElement = (removed) [Q1])
e) This function [F1] calls another function [F2] ([E1]->pElement = (removed) [W1])
f) The function [F2] creates another event [E2] (and another queue element [Q2]) ([Q2]->Data = [E2]; [E2]->pElement = [Q2]; [E1]->pElement = (removed) [Q1] = [Q2]) -> [Q1] is removed so the address is free and if there is another event created just in the event function it will take exactly this address (tested it more than 10 times)
g) At the end of [F2] the command "event_cancel(&[E1])" will be called ([E1]->pElement = (removed) [Q1] = [Q2] -> event_cancel(&[E1]) = event_cancel(&[E2]))

I hope this was enough detailed - for everyone who doesn't really change the source it's not really interesting (or better irrelevant).

Solution for the problem: open your event.cpp & jump to the function Scroll down to the code and change the part to the following part: