/usr/include/tulip/Observable.h is in libtulip-dev 3.1.2-2.3ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 | //-*-c++-*-
/**
Authors: David Auber, Patrick Mary, Morgan Mathiaut
from the LaBRI Visualization Team
Email : auber@tulip-software.org
Last modification : 13/03/2009
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
*/
#ifndef OBSERVABLE_H
#define OBSERVABLE_H
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <tulip/tulipconf.h>
#include <ext/slist>
#include <map>
#include <set>
namespace tlp {
class Observable;
//=========================================================
/**
* The Observer pattern is a
* framework for handling state dependency between observer and observed
* object. It is described in the lecture notes and pp293-304
* of Design Patterns by Gamma, Helm, Johnson, and Vlissides.
*/
class Observer {
public:
virtual ~Observer() {}
/**
* Methods called when a change occur in the observed objects
* Due to the possibility to differs notificatiosn several objects can
* send a notify events simultaneously. The iterators given in parameter
* enable to iterate all these objects.
*/
virtual void update(std::set<Observable *>::iterator begin ,std::set<Observable *>::iterator end)=0;
/**
* Methods called when an observable has been deleted. holdObservers and unHoldObservers function
* have no effects on this function.
*/
virtual void observableDestroyed(Observable *) = 0;
};
typedef std::map<Observer *,std::set<Observable *> > ObserverMap;
//=========================================================
/** All instances of that class can be observed by by an instance of the
* Observer class.
*/
class TLP_SCOPE Observable {
public:
virtual ~Observable() {}
/**
* Register a new observer
*/
void addObserver(Observer *);
/**
* Returns the number of observers
*/
unsigned int countObservers();
/**
* Remove an observer
*/
void removeObserver(Observer *);
/**
* Remove all observers
*/
void removeObservers();
/**
* Notify all the observers
*/
void notifyObservers();
/**
* Notify all the observers that the object will be destroyed.
* Need to be call into the dstructor of the observable.
*/
void notifyDestroy();
/**
* Queue notifications
*/
static void holdObservers();
/**
* UnQueue notifications
*/
static void unholdObservers();
protected:
static int holdCounter;
static ObserverMap holdMap;
stdext::slist<Observer*> observersList;
};
inline void Observable::addObserver(Observer *obs) {
observersList.push_front(obs);
}
inline unsigned int Observable::countObservers() {
return observersList.size();
}
inline void Observable::removeObserver(Observer *item) {
observersList.remove(item);
}
inline void Observable::removeObservers() {
observersList.clear();
}
}
#endif
|