# HG changeset patch # User Sebastien Jodogne # Date 1571139961 -7200 # Node ID af4b9cba905f40d79d5a49559e5a2d32bca8b6dd # Parent 3e8f59cefec61135910cc1ec74646b5e1204835c simplify how observers are regsitered, and how callables are created diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Loaders/LoaderStateMachine.cpp --- a/Framework/Loaders/LoaderStateMachine.cpp Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Loaders/LoaderStateMachine.cpp Tue Oct 15 13:46:01 2019 +0200 @@ -159,33 +159,27 @@ LoaderStateMachine::LoaderStateMachine(IOracle& oracle, IObservable& oracleObservable) : oracle_(oracle), - oracleObservable_(oracleObservable), active_(false), simultaneousDownloads_(4), activeCommands_(0) { LOG(TRACE) << "LoaderStateMachine(" << std::hex << this << std::dec << ")::LoaderStateMachine()"; - oracleObservable.RegisterObserverCallback( - new Callable - (shared_from_this(), &LoaderStateMachine::HandleSuccessMessage)); + oracleObservable.RegisterObserver + (*this, &LoaderStateMachine::HandleSuccessMessage); - oracleObservable.RegisterObserverCallback( - new Callable - (shared_from_this(), &LoaderStateMachine::HandleSuccessMessage)); + oracleObservable.RegisterObserver + (*this, &LoaderStateMachine::HandleSuccessMessage); - oracleObservable.RegisterObserverCallback( - new Callable - (shared_from_this(), &LoaderStateMachine::HandleSuccessMessage)); + oracleObservable.RegisterObserver + (*this, &LoaderStateMachine::HandleSuccessMessage); - oracleObservable.RegisterObserverCallback( - new Callable - (shared_from_this(), &LoaderStateMachine::HandleExceptionMessage)); + oracleObservable.RegisterObserver + (*this, &LoaderStateMachine::HandleExceptionMessage); } LoaderStateMachine::~LoaderStateMachine() { - oracleObservable_.Unregister(this); LOG(TRACE) << "LoaderStateMachine(" << std::hex << this << std::dec << ")::~LoaderStateMachine()"; Clear(); } diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Loaders/LoaderStateMachine.h --- a/Framework/Loaders/LoaderStateMachine.h Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Loaders/LoaderStateMachine.h Tue Oct 15 13:46:01 2019 +0200 @@ -22,7 +22,7 @@ #pragma once #include "../Messages/IObservable.h" -#include "../Messages/IObserver.h" +#include "../Messages/ObserverBase.h" #include "../Oracle/GetOrthancImageCommand.h" #include "../Oracle/GetOrthancWebViewerJpegCommand.h" #include "../Oracle/IOracle.h" @@ -95,7 +95,6 @@ typedef std::list PendingCommands; IOracle& oracle_; - IObservable& oracleObservable_; bool active_; unsigned int simultaneousDownloads_; PendingCommands pendingCommands_; diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Loaders/OrthancSeriesVolumeProgressiveLoader.cpp --- a/Framework/Loaders/OrthancSeriesVolumeProgressiveLoader.cpp Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Loaders/OrthancSeriesVolumeProgressiveLoader.cpp Tue Oct 15 13:46:01 2019 +0200 @@ -422,29 +422,24 @@ IOracle& oracle, IObservable& oracleObservable) : oracle_(oracle), - oracleObservable_(oracleObservable), active_(false), simultaneousDownloads_(4), volume_(volume), sorter_(new BasicFetchingItemsSorter::Factory), volumeImageReadyInHighQuality_(false) { - oracleObservable.RegisterObserverCallback( - new Callable - (shared_from_this(), &OrthancSeriesVolumeProgressiveLoader::LoadGeometry)); - - oracleObservable.RegisterObserverCallback( - new Callable - (shared_from_this(), &OrthancSeriesVolumeProgressiveLoader::LoadBestQualitySliceContent)); - - oracleObservable.RegisterObserverCallback( - new Callable - (shared_from_this(), &OrthancSeriesVolumeProgressiveLoader::LoadJpegSliceContent)); + oracleObservable.RegisterObserver + (*this, &OrthancSeriesVolumeProgressiveLoader::LoadGeometry); + + oracleObservable.RegisterObserver + (*this, &OrthancSeriesVolumeProgressiveLoader::LoadBestQualitySliceContent); + + oracleObservable.RegisterObserver + (*this, &OrthancSeriesVolumeProgressiveLoader::LoadJpegSliceContent); } OrthancSeriesVolumeProgressiveLoader::~OrthancSeriesVolumeProgressiveLoader() { - oracleObservable_.Unregister(this); LOG(TRACE) << "OrthancSeriesVolumeProgressiveLoader::~OrthancSeriesVolumeProgressiveLoader()"; } diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Loaders/OrthancSeriesVolumeProgressiveLoader.h --- a/Framework/Loaders/OrthancSeriesVolumeProgressiveLoader.h Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Loaders/OrthancSeriesVolumeProgressiveLoader.h Tue Oct 15 13:46:01 2019 +0200 @@ -22,7 +22,7 @@ #pragma once #include "../Messages/IObservable.h" -#include "../Messages/IObserver.h" +#include "../Messages/ObserverBase.h" #include "../Oracle/GetOrthancImageCommand.h" #include "../Oracle/GetOrthancWebViewerJpegCommand.h" #include "../Oracle/IOracle.h" @@ -106,7 +106,6 @@ void LoadJpegSliceContent(const GetOrthancWebViewerJpegCommand::SuccessMessage& message); IOracle& oracle_; - IObservable& oracleObservable_; bool active_; unsigned int simultaneousDownloads_; SeriesGeometry seriesGeometry_; diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Messages/ICallable.h --- a/Framework/Messages/ICallable.h Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Messages/ICallable.h Tue Oct 15 13:46:01 2019 +0200 @@ -35,7 +35,7 @@ { // This is referencing an object and member function that can be notified // by an IObservable. The object must derive from IO - // The member functions must be of type "void Function(const IMessage& message)" or reference a derived class of IMessage + // The member functions must be of type "void Method(const IMessage& message)" or reference a derived class of IMessage class ICallable : public boost::noncopyable { public: @@ -64,14 +64,14 @@ class Callable : public MessageHandler { private: - typedef void (TObserver::* MemberFunction) (const TMessage&); + typedef void (TObserver::* MemberMethod) (const TMessage&); boost::weak_ptr observer_; - MemberFunction function_; + MemberMethod function_; public: Callable(boost::shared_ptr observer, - MemberFunction function) : + MemberMethod function) : observer_(observer), function_(function) { diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Messages/IObservable.cpp --- a/Framework/Messages/IObservable.cpp Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Messages/IObservable.cpp Tue Oct 15 13:46:01 2019 +0200 @@ -118,6 +118,11 @@ (*it)->Apply(message); } } + else + { + // TODO => Remove "it" from the list of callables => This + // allows to suppress the need for "Unregister()" + } } } } diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Messages/IObservable.h --- a/Framework/Messages/IObservable.h Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Messages/IObservable.h Tue Oct 15 13:46:01 2019 +0200 @@ -44,12 +44,12 @@ void EmitMessageInternal(const IObserver* receiver, const IMessage& message); + // Takes ownsership of the callable + void RegisterObserverCallback(ICallable* callable); + public: virtual ~IObservable(); - // Takes ownsership - void RegisterObserverCallback(ICallable* callable); - // TODO - Remove this? void Unregister(IObserver* observer); @@ -60,5 +60,13 @@ // Takes ownsership void RegisterForwarder(IMessageForwarder* forwarder); + + template + void RegisterObserver(TObserver& observer, + void (TObserver::* MemberMethod) (const TMessage&)) + { + RegisterObserverCallback(new Callable(observer.GetSharedObserver(), MemberMethod)); + } }; } diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Messages/IObserver.h --- a/Framework/Messages/IObserver.h Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Messages/IObserver.h Tue Oct 15 13:46:01 2019 +0200 @@ -22,7 +22,6 @@ #pragma once #include -#include namespace OrthancStone { @@ -37,11 +36,4 @@ { } }; - - template - class ObserverBase : - public IObserver, - public boost::enable_shared_from_this - { - }; } diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Messages/ObserverBase.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Framework/Messages/ObserverBase.h Tue Oct 15 13:46:01 2019 +0200 @@ -0,0 +1,58 @@ +/** + * Stone of Orthanc + * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics + * Department, University Hospital of Liege, Belgium + * Copyright (C) 2017-2019 Osimis S.A., Belgium + * + * This program is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + **/ + + +#pragma once + +#include "ICallable.h" +#include "IObserver.h" + +#include + +#include + +namespace OrthancStone +{ + template + class ObserverBase : + public IObserver, + public boost::enable_shared_from_this + { + public: + boost::shared_ptr GetSharedObserver() + { + try + { + return this->shared_from_this(); + } + catch (boost::bad_weak_ptr&) + { + throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError, + "Cannot get a shared pointer to an observer from a constructor"); + } + } + + template + ICallable* CreateCallable(void (TObserver::* MemberMethod) (const TMessage&)) + { + return new Callable(GetSharedObserver(), MemberMethod); + } + }; +} diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Scene2DViewport/MeasureTool.cpp --- a/Framework/Scene2DViewport/MeasureTool.cpp Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Scene2DViewport/MeasureTool.cpp Tue Oct 15 13:46:01 2019 +0200 @@ -84,9 +84,8 @@ : controllerW_(controllerW) , enabled_(true) { - GetController()->RegisterObserverCallback( - new Callable - (shared_from_this(), &MeasureTool::OnSceneTransformChanged)); + GetController()->RegisterObserver + (*this, &MeasureTool::OnSceneTransformChanged); } diff -r 3e8f59cefec6 -r af4b9cba905f Framework/Scene2DViewport/MeasureTool.h --- a/Framework/Scene2DViewport/MeasureTool.h Tue Oct 15 12:22:44 2019 +0200 +++ b/Framework/Scene2DViewport/MeasureTool.h Tue Oct 15 13:46:01 2019 +0200 @@ -20,6 +20,7 @@ #pragma once +#include "../Messages/ObserverBase.h" #include "../Scene2D/PolylineSceneLayer.h" #include "../Scene2D/Scene2D.h" #include "../Scene2D/ScenePoint2D.h" @@ -27,7 +28,6 @@ #include "../Scene2DViewport/PredeclaredTypes.h" #include "../Scene2DViewport/ViewportController.h" -#include #include #include