shadowmaster.c-Dateireferenz

Objekt, welches eine Liste mit aktiven Shadows hat. Mehr ...

#include <defines.h>
#include <wizlevels.h>

Include-Abhängigkeitsdiagramm für shadowmaster.c:

gehe zum Quellcode dieser Datei

Makrodefinitionen
#define	HOME(x)   (__PATH__(0)+x)
#define	DEBUG(x)
#define	MEMORY   "/secure/memory"
#define	SHADOW_OK   1
#define	SHADOW_ACCESS_DENIED   -1
#define	SHADOW_EXISTS   -2
#define	SHADOW_UNKNOWN   -3
Funktionen
protected void	create ()
public void	DumpShadows ()
	Liefert einen String mit allen Schatten und beschatteten Objekten zurueck.
public object	FindShadow (object opfer)
	Findet zu einem beschatteten Objekt den zugehoerigen Schatten.
public object	FindShadowedObject (object schatten)
	Findet zu einem Schatten das beschattete Objekt.
public object *	QueryObject (object ob)
	Gibt Schatten und Beschatteten zurueck, falls ob eines von beiden ist.
public string	QueryInfo (object ob)
	Gibt einen String mit Infos ueber ob zurueck.
public int	RegisterShadow (object schatten)
	Registriert einen Schatten und sein Opfer.
public int	UnregisterShadow (object caller)
	Traegt einen Schatten wieder aus.
public int	ResetAll ()
public void	reset ()
	Raeumt die Daten ueber die Schatten auf.
Variablen
private mapping	shadows = ([])
	shadows ist ein mapping, welches alle Schatten und ihre Opfer enthaelt.

---

Ausführliche Beschreibung

Objekt, welches eine Liste mit aktiven Shadows hat.

Die simul_efun shadow() meldet das beschattende Objekt hier an. Nuetzlich, damit man als Magier endlich mal rauskriegen kann, welche Shadows es eigentlich gibt.

Autor:

Zesstra

Datum:

07.08.2009

Version:

$Id$

Definiert in Datei shadowmaster.c.

---

Makro-Dokumentation

#define DEBUG

(

x

)

Wert:

if (find_player("zesstra"))\
            tell_object(find_player("zesstra"),\
                                      "SMDBG: "+x+"\n")

Definiert in Zeile 32 der Datei shadowmaster.c.

#define HOME

(

x

)

(__PATH__(0)+x)

Definiert in Zeile 22 der Datei shadowmaster.c.

#define MEMORY   "/secure/memory"

Definiert in Zeile 37 der Datei shadowmaster.c.

#define SHADOW_ACCESS_DENIED   -1

Definiert in Zeile 40 der Datei shadowmaster.c.

#define SHADOW_EXISTS   -2

Definiert in Zeile 41 der Datei shadowmaster.c.

#define SHADOW_OK   1

Definiert in Zeile 39 der Datei shadowmaster.c.

#define SHADOW_UNKNOWN   -3

Definiert in Zeile 42 der Datei shadowmaster.c.

---

Dokumentation der Funktionen

protected void create

(

)

Definiert in Zeile 44 der Datei shadowmaster.c.

Benutzt DEBUG, MEMORY und shadows.

                        {
  mixed tmp;
  seteuid(getuid());
  if (mappingp(tmp=MEMORY->Load("Schatten"))) {
    shadows = tmp;
    DEBUG("Daten aus MEMORY geladen.\n");
  }
  else {
    DEBUG("Keine Daten in MEMORY vorhanden - reinitialisiere.\n");
    if (MEMORY->Save("Schatten", shadows) != 1)
      raise_error("Konnte Daten nicht im Memory ablegen.\n");
  }
}

public void DumpShadows

(

)

Liefert einen String mit allen Schatten und beschatteten Objekten zurueck.

Rückgabe:

string - Liste von Schatten und Opfern

Definiert in Zeile 61 der Datei shadowmaster.c.

Benutzt ELDER_SECURITY und shadows.

                          {
  if (extern_call() && !ELDER_SECURITY ) return 0;

  string res = "";
  foreach(object schatten, object opfer: shadows)
    if (schatten && opfer)
      res += sprintf("%O -> %O\n",schatten,opfer);

  printf("Folgende Shadows sind bekannt: \n\n%s\n", res);
}

public object FindShadow

(

object

opfer

)

Findet zu einem beschatteten Objekt den zugehoerigen Schatten.

Parameter:

[in]

object

- ein beschattetes Objekt.

Rückgabe:

object - Den Schatten oder 0.

Siehe auch:

FindShadowsObject(), QueryObject(), QueryInfo()

Definiert in Zeile 77 der Datei shadowmaster.c.

Benutzt shadows.

Wird benutzt von QueryObject().

                                       {
  if (!objectp(opfer))
    return 0;

  foreach(object schatten, object victim: shadows) {
    if (opfer == victim)
      // Schatten gefunden.
      return schatten;
  }
  return 0;
}

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

public object FindShadowedObject

(

object

schatten

)

Findet zu einem Schatten das beschattete Objekt.

Parameter:

[in]

object

- ein beschattendes Objekt.

Rückgabe:

object - Das beschattete Objekt oder 0.

Siehe auch:

FindShadow(), QueryObject(), QueryInfo()

Definiert in Zeile 94 der Datei shadowmaster.c.

Benutzt shadows.

Wird benutzt von QueryObject().

                                                  {
  return shadows[schatten];
}

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

public string QueryInfo

(

object

ob

)

Gibt einen String mit Infos ueber ob zurueck.

Ist ob ein beschattetes Objekt oder ein Schatten, wird ein beschreibender String zurueckgeliefert (schatten -> beschattetes Objekt). Hierbei wird ggf. die gesamte Beschattungshierarchie angegeben (a -> b -> c -> d).

Parameter:

[in]

object

- ein Objekt.

Rückgabe:

string - String mit Infos ueber ob.

Siehe auch:

FindShadow(), FindShadowedObject(), QueryObject()

Definiert in Zeile 152 der Datei shadowmaster.c.

Benutzt CountUp() und QueryObject().

                                   {
  object *shs = QueryObject(ob);
  if (!shs) return 0;

  return CountUp(map(shs, #'object_name), " -> ", " -> ");
}

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

public object* QueryObject

(

object

ob

)

Gibt Schatten und Beschatteten zurueck, falls ob eines von beiden ist.

Ist ob ein Schatten oder ein beschattetes Objekt, wird ein Array aus Objekten geliefert. Hierbei werden ggf. alle Objekte in der Beschattungshierarchie geliefert, von der ob Bestandteil ist.

Parameter:

[in]

object

- ein Objekt.

Rückgabe:

object* - ({a, b, c, d}) oder 0.

Siehe auch:

FindShadow(), FindShadowedObject, QueryInfo()

Definiert in Zeile 106 der Datei shadowmaster.c.

Benutzt FindShadow(), FindShadowedObject(), QueryObject() und shadows.

                                      {

  if (!objectp(ob)) return 0;
 
  object *res = ({ob});
  object sh = FindShadow(ob);

  while(sh) {
    // es gibt einen Schatten, also Kette nach oben verfolgen.
    res = ({sh}) + res;
    sh = FindShadow(sh);
  }

  object vic = FindShadowedObject(ob);
  while(vic) {
    // es gibt ein beschattetes Objekt, Kette nach unten verfolgen.
    res = res + ({vic});
    vic = FindShadowedObject(vic);
  }

  if (sizeof(res) < 2) {
    // Offenbar wird ob weder beschattet noch beschattet selber.
    // Moeglicherweise wurde jedoch durch wilde Zerstoerung die Hierarchie
    // getrennt. Falls ob nen Schatten ist, laesst sich das reparieren. Falls
    // ob beschattet wird, hilft eigentlich nur ein reset(). Den moechte ich
    // hier aber nicht machen, weils u.U. teuer sein koennte.
    if (query_shadowing(ob)) {
      shadows[ob] = query_shadowing(ob);
      // nochmal.
      return QueryObject(ob);
    }
    // scheinbar nicht.
    return 0;
  }

  return res;
}

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

public int RegisterShadow

(

object

schatten

)

Registriert einen Schatten und sein Opfer.

Registriert den Schatten und sein Opfer. Sollte ausschliesslich durch die simul_efun oder spare_simul_fun gerufen werden.

Siehe auch:

UnregisterShadow()

Definiert in Zeile 164 der Datei shadowmaster.c.

                                           {
  object opfer;

  //DEBUG(sprintf("[%O] %O\n", schatten, caller_stack()));

  // Irgendein Sicherheitscheck ist eigentlich nicht noetig hier, da das Opfer
  // ohnehin per efun ermittelt wird und kein Eintrag erfolgt, wenn kein
  // beschattetes Objekt zu finden ist.

  // das von schatten beschattete Objekt ermitteln 
  if (objectp(opfer=query_shadowing(schatten))) {
    if (shadows[schatten] == opfer)
      return SHADOW_EXISTS;

    // Neueintrag oder ggf. auch Aendern.
    shadows[schatten] = opfer;
    //DEBUG(DumpShadows());
    return SHADOW_OK;
  }
  return SHADOW_ACCESS_DENIED;
}

public void reset

(

void

)

Raeumt die Daten ueber die Schatten auf.

Zerstoeren sich beschattete Objekte, werden die Schatten nicht ausgetragen, daher wird das von zeit zu zeit hier gemacht.

Definiert in Zeile 250 der Datei shadowmaster.c.

                    {
  foreach(object schatten, object opfer: shadows) {
    if (!objectp(opfer)) {
      // war schatten evtl. in einer Hierarchie und beschattet jetzt was
      // anderes?
      if (query_shadowing(schatten))
        shadows[schatten] = query_shadowing(schatten);
      else
        efun::m_delete(shadows, schatten);
    }
  }
}

public int ResetAll

(

)

Definiert in Zeile 233 der Datei shadowmaster.c.

                      {
  if (!ARCH_SECURITY) return SHADOW_ACCESS_DENIED;

  DEBUG("ResetAll() called.\n");

  shadows = ([]);

  if (MEMORY->Save("Schatten", shadows) != 1)
    raise_error("Konnte Daten nicht im Memory ablegen.\n");

  return SHADOW_OK;
}

public int UnregisterShadow

(

object

caller

)

Traegt einen Schatten wieder aus.

Der Schatten wird wieder ausgetragen. Sollte ausschliesslich durch die simul_efun oder spare_simul_fun gerufen werden. Werden Schatten oder beschattete Objekte zerstoert ohne vorher die Schattierung zu beenden, fuehrt dies zu Inkonsistenzen und zerbrochenen Beschattungshierarchien.

Siehe auch:

RegisterShadow(), UnregisterOpfer()

Definiert in Zeile 194 der Datei shadowmaster.c.

                                           {
  object schatten, opfer;

  // Ein Sicherheitscheck fuer den Aufruf ist eigentlich nicht noetig, da ein
  // Eintrag nur entfernt wird, wenn die Beschattung nachweislich beendet
  // wurde.

  //DEBUG(sprintf("[%O] %O\n", caller, caller_stack()));
  if (!objectp(caller)) return SHADOW_UNKNOWN;

  // Schatten und beschatteten aus den lokalen Daten ermitteln.
  if (member(shadows, caller)) {
    schatten = caller;
    opfer = shadows[schatten];
  }
  else if (objectp(schatten = FindShadow(caller))) {
    opfer = caller;
  }
  // wenn nicht bekannt, ist jetzt eh Ende.
  if (!schatten) return SHADOW_UNKNOWN;

  //DEBUG(sprintf("%O -> %O (%O, %O)\n",
  //      schatten, opfer, caller, query_shadowing(schatten)));

  // Schattierung wirklich beendet? Wenn nicht -> Ende
  if (opfer && query_shadowing(schatten) == opfer)
    return SHADOW_ACCESS_DENIED;

  // war schatten in einer Beschattungshierarchie?
  object up = FindShadow(schatten);
  if (up && query_shadowing(up) == opfer) {
    shadows[up] = opfer; // Kette neu verlinken
  }

  // jetzt kann geloescht werden.
  efun::m_delete(shadows,schatten);
  return SHADOW_OK;
}

---

Variablen-Dokumentation

private mapping shadows = ([])

shadows ist ein mapping, welches alle Schatten und ihre Opfer enthaelt.

Struktur: Schatten als Schluessel (object) und Beschatteter (object) als Wert.

Definiert in Zeile 29 der Datei shadowmaster.c.

Wird benutzt von create(), DumpShadows(), FindShadow(), FindShadowedObject() und QueryObject().