diff --git a/visitor.h b/visitor.h new file mode 100644 index 00000000..8e8b838f --- /dev/null +++ b/visitor.h @@ -0,0 +1,460 @@ +///\file + +/****************************************************************************** +The MIT License(MIT) + +Embedded Template Library. + +Copyright(c) 2014 jwellbelove + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files(the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and / or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions : + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +******************************************************************************/ + +#ifndef __etl_visitor__ +#define __etl_visitor__ + +//***************************************************************************** +///\defgroup visitor visitor +/// A set of template classes for easy implementation of the visitor pattern.
+/// The visitor design pattern is a way of separating an algorithm from an object +/// structure on which it operates. A practical result of this separation is the +/// ability to add new operations to existing object structures without modifying +/// those structures. It is one way to easily follow the open/closed principle. +/// In essence, the visitor allows one to add new virtual functions to a family +/// of classes without modifying the classes themselves; instead, one creates a +/// visitor class that implements all of the appropriate specialisations of the +/// virtual function. The visitor takes the instance as input, and implements +/// the goal through double dispatch.
+/// \ingroup patterns +//***************************************************************************** + +namespace etl +{ + //***************************************************************** + /// The visitable base class for four visitor types. + /// Derive visitable classes from this. + ///\ingroup visitor + //***************************************************************** + template + class visitable + { + public: + + virtual void accept(T1&) = 0; + virtual void accept(T2&) = 0; + virtual void accept(T3&) = 0; + virtual void accept(T4&) = 0; + }; + + //***************************************************************** + /// The visitable base class for three visitor types. + /// Derive visitable classes from this. + ///\ingroup visitor + //***************************************************************** + template + class visitable + { + public: + + virtual void accept(T1&) = 0; + virtual void accept(T2&) = 0; + virtual void accept(T3&) = 0; + }; + + //***************************************************************** + /// The visitable base class for two visitor types. + /// Derive visitable classes from this. + ///\ingroup visitor + //***************************************************************** + template + class visitable + { + public: + + virtual void accept(T1&) = 0; + virtual void accept(T2&) = 0; + }; + + //***************************************************************** + /// The visitable base class for one visitor type. + /// Derive visitable classes from this. + ///\ingroup visitor + //***************************************************************** + template + class visitable + { + public: + + virtual void accept(T1&) = 0; + }; + + //***************************************************************** + /// The visitor base class for sixteen types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + virtual void visit(T8&) = 0; + virtual void visit(T9&) = 0; + virtual void visit(T10&) = 0; + virtual void visit(T11&) = 0; + virtual void visit(T12&) = 0; + virtual void visit(T13&) = 0; + virtual void visit(T14&) = 0; + virtual void visit(T15&) = 0; + virtual void visit(T16&) = 0; + }; + + //***************************************************************** + /// The visitor base class for fifteen types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + virtual void visit(T8&) = 0; + virtual void visit(T9&) = 0; + virtual void visit(T10&) = 0; + virtual void visit(T11&) = 0; + virtual void visit(T12&) = 0; + virtual void visit(T13&) = 0; + virtual void visit(T14&) = 0; + virtual void visit(T15&) = 0; + }; + + //***************************************************************** + /// The visitor base class for fourteen types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + virtual void visit(T8&) = 0; + virtual void visit(T9&) = 0; + virtual void visit(T10&) = 0; + virtual void visit(T11&) = 0; + virtual void visit(T12&) = 0; + virtual void visit(T13&) = 0; + virtual void visit(T14&) = 0; + }; + + //***************************************************************** + /// The visitor base class for thirteen types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + virtual void visit(T8&) = 0; + virtual void visit(T9&) = 0; + virtual void visit(T10&) = 0; + virtual void visit(T11&) = 0; + virtual void visit(T12&) = 0; + virtual void visit(T13&) = 0; + }; + + //***************************************************************** + /// The visitor base class for twelve types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + virtual void visit(T8&) = 0; + virtual void visit(T9&) = 0; + virtual void visit(T10&) = 0; + virtual void visit(T11&) = 0; + virtual void visit(T12&) = 0; + }; + + //***************************************************************** + /// The visitor base class for eleven types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + virtual void visit(T8&) = 0; + virtual void visit(T9&) = 0; + virtual void visit(T10&) = 0; + virtual void visit(T11&) = 0; + }; + + //***************************************************************** + /// The visitor base class for ten types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + virtual void visit(T8&) = 0; + virtual void visit(T9&) = 0; + virtual void visit(T10&) = 0; + }; + + //***************************************************************** + /// The visitor base class for nine types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + virtual void visit(T8&) = 0; + virtual void visit(T9&) = 0; + }; + + //***************************************************************** + /// The visitor base class for eight types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + virtual void visit(T8&) = 0; + }; + + //***************************************************************** + /// The visitor base class for seven types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + virtual void visit(T7&) = 0; + }; + + //***************************************************************** + /// The visitor base class for six types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + virtual void visit(T6&) = 0; + }; + + //***************************************************************** + /// The visitor base class for five types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + virtual void visit(T5&) = 0; + }; + + //***************************************************************** + /// The visitor base class for four types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + virtual void visit(T4&) = 0; + }; + + //***************************************************************** + /// The visitor base class for three types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + virtual void visit(T3&) = 0; + }; + + //***************************************************************** + /// The visitor base class for two types. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + virtual void visit(T2&) = 0; + }; + + //***************************************************************** + /// The visitor base class for one type. + /// Derive visitors from this. + ///\ingroup visitor + //***************************************************************** + template + class visitor + { + public: + + virtual void visit(T1&) = 0; + }; +} + +#endif