classify.h

Go to the documentation of this file.

// Copyright (C) 2014-2022 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef CLASSIFY_H
#define CLASSIFY_H

#include <cc/data.h>

#include <boost/multi_index_container.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/identity.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/sequenced_index.hpp>

#include <string>


namespace isc {
namespace dhcp {

    typedef std::string ClientClass;

    struct ClassSequenceTag { };

    struct ClassNameTag { };

    typedef boost::multi_index_container<
        ClientClass,
        boost::multi_index::indexed_by<
            // First index is the sequence one.
            boost::multi_index::sequenced<
                boost::multi_index::tag<ClassSequenceTag>
            >,
            // Second index is the name hash one.
            boost::multi_index::hashed_unique<
                boost::multi_index::tag<ClassNameTag>,
                boost::multi_index::identity<ClientClass>
            >
        >
    > ClientClassContainer;

    struct SubClassRelation {
        SubClassRelation(const ClientClass& class_def, const ClientClass& subclass) :
            class_def_(class_def), class_(subclass) {
        }

        ClientClass class_def_;

        ClientClass class_;
    };

    struct TemplateClassSequenceTag { };

    struct TemplateClassNameTag { };

    typedef boost::multi_index_container<
        SubClassRelation,
        boost::multi_index::indexed_by<
            // First index is the sequence one.
            boost::multi_index::sequenced<
                boost::multi_index::tag<TemplateClassSequenceTag>
            >,
            // Second index is the name hash one.
            boost::multi_index::hashed_unique<
                boost::multi_index::tag<TemplateClassNameTag>,
                boost::multi_index::member<SubClassRelation,
                                           ClientClass,
                                           &SubClassRelation::class_def_>
            >
        >
    > SubClassRelationContainer;

    class ClientClasses {
    public:

        typedef ClientClassContainer::const_iterator const_iterator;
        typedef ClientClassContainer::iterator iterator;

        ClientClasses() : container_() {
        }

        ClientClasses(const std::string& class_names);

        void insert(const ClientClass& class_name) {
            static_cast<void>(container_.push_back(class_name));
        }

        void erase(const ClientClass& class_name);

        bool empty() const {
            return (container_.empty());
        }

        size_t size() const {
            return (container_.size());
        }

        const_iterator cbegin() const {
            return (container_.cbegin());
        }
        const_iterator begin() const {
            return (container_.begin());
        }
        iterator begin() {
            return (container_.begin());
        }

        const_iterator cend() const {
            return (container_.cend());
        }
        const_iterator end() const {
            return (container_.end());
        }
        iterator end() {
            return (container_.end());
        }

        bool contains(const ClientClass& x) const;

        void clear() {
            container_.clear();
        }

        std::string toText(const std::string& separator = ", ") const;

        isc::data::ElementPtr toElement() const;

    private:
        ClientClassContainer container_;
    };
}
}

#endif /* CLASSIFY_H */