[8850] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * > www.orxonox.net < |
---|
| 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
| 23 | * Fabian 'x3n' Landau |
---|
| 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
| 29 | /** |
---|
| 30 | @file |
---|
| 31 | @ingroup Output |
---|
| 32 | @brief Declaration of the SubcontextOutputListener interface which adds the ability to filter sub-contexts to OutputListener. |
---|
| 33 | */ |
---|
| 34 | |
---|
| 35 | #ifndef _SubcontextOutputListener_H__ |
---|
| 36 | #define _SubcontextOutputListener_H__ |
---|
| 37 | |
---|
| 38 | #include "util/UtilPrereqs.h" |
---|
| 39 | |
---|
| 40 | #include <set> |
---|
| 41 | |
---|
| 42 | #include "OutputListener.h" |
---|
| 43 | |
---|
| 44 | namespace orxonox |
---|
| 45 | { |
---|
[8853] | 46 | /** |
---|
| 47 | @brief This class extends the basic OutputListener interface and adds the ability to filter sub-contexts. |
---|
| 48 | |
---|
| 49 | Defining additional contexts with setAdditionalContextsMask() enables |
---|
| 50 | all sub-contexts of these additional contexts. To accept only some |
---|
| 51 | particular sub-contexts, setAdditionalSubcontexts() has to be used. |
---|
| 52 | Note that this requires a set, since a mask is not possible with |
---|
| 53 | sub-contexts. |
---|
| 54 | |
---|
| 55 | The "final" context mask which will be seen by OutputManager is the |
---|
| 56 | combination of all regular contexts plus the masks of all sub-contexts. |
---|
| 57 | |
---|
| 58 | @remark |
---|
| 59 | It would have been possible to implement filtering of sub-contexts |
---|
| 60 | directly in OutputListener and even to make OutputManager aware of |
---|
| 61 | sub-contexts. This would reduce the amount of unnecessarily generated |
---|
| 62 | output, but also increase the complexity of the checks whether some |
---|
| 63 | output is needed. |
---|
| 64 | On the other hand, filtering of sub-contexts makes the whole concept |
---|
| 65 | more complicated, as it adds another mask and a set. So to keep it |
---|
| 66 | clean and simple I figured it's best to put sub-context filtering into |
---|
| 67 | a seaparate class. |
---|
| 68 | */ |
---|
[8850] | 69 | class _UtilExport SubcontextOutputListener : public OutputListener |
---|
| 70 | { |
---|
| 71 | public: |
---|
| 72 | SubcontextOutputListener(bool bRegister = true); |
---|
| 73 | virtual ~SubcontextOutputListener(); |
---|
| 74 | |
---|
[11071] | 75 | virtual void setAdditionalContextsMask(OutputContextMask mask) override; |
---|
[8850] | 76 | void setAdditionalSubcontexts(const std::set<const OutputContextContainer*>& subcontexts); |
---|
| 77 | |
---|
[11071] | 78 | virtual bool acceptsOutput(OutputLevel level, const OutputContextContainer& context) const override; |
---|
[8850] | 79 | |
---|
[9550] | 80 | inline const std::set<OutputContextSubID>& getSubcontexts() const |
---|
| 81 | { return this->subcontexts_; } |
---|
| 82 | |
---|
[8850] | 83 | private: |
---|
[8853] | 84 | OutputContextMask subcontextsCheckMask_; ///< All contexts defined by this mask need to be checked whether they are accepted by the set of sub-contexts |
---|
| 85 | OutputContextMask subcontextsNoCheckMask_; ///< All contexts defined by this mask don't need to be checked since we accept all sub-contexts |
---|
| 86 | std::set<OutputContextSubID> subcontexts_; ///< The set of accepted sub-contexts |
---|
[8850] | 87 | }; |
---|
| 88 | } |
---|
| 89 | |
---|
| 90 | #endif /* _SubcontextOutputListener_H__ */ |
---|