User Manual, Developers Guide and API Documentation

DependencyList.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 16, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#ifndef WNS_MODULE_DEPENDENCY_LIST_HPP
#define WNS_MODULE_DEPENDENCY_LIST_HPP

#include <WNS/module/Version.hpp>
#include <vector>

namespace wns { namespace module {
    class DepListError
    {
    public:
        virtual
        ~DepListError()
        {}
    };

    class DepListElemInvalidInitString :
        public DepListError
    {};

    class DepListElem
    {
    public:
        enum depModeType { LessThan, EqualTo, GreaterThan };

        DepListElem(const depModeType mode, const Version dep);

        DepListElem(const std::string s) throw (DepListElemInvalidInitString);

        depModeType getDepMode() const;

        Version getDependency() const;

        void setDepMode(const depModeType depMode);

        void setDependency(const Version dependency);

        bool dependencyMetBy(const Version ver) const;

        std::string getString() const;
        std::string getNiceString() const;

    private:
        depModeType depMode;

        Version dependency;
    };

    class DepList
    {
        typedef std::vector<DepListElem> DepListPredecessor;
    public:
        DepList() :
            depListElements()
        {}

        explicit
        DepList(const std::string& s);

        // public member functions

        template<class VerList>
        bool
        dependenciesMetBy(const VerList vers, const VerList end) const;

        std::string getString() const;
        std::string getNiceString() const;
    private:
        // The following function exists only to make dependeciesMetBy() look
        // a bit nicer and is not needed anywhere else, thus should be a nested
        // function, if that was possible. But as it isn't, it's where it is now...
        bool projectDoesMatch(const Version v1, const Version v2) const
        {
            return (v1.getBuildRelease().getCategory() == v2.getBuildRelease().getCategory())
                && (v1.getBuildRelease().getBranch() == v2.getBuildRelease().getBranch());
        }

        DepListPredecessor depListElements;
    };

    template<class VerList>
    bool
    DepList::dependenciesMetBy(const VerList vers, const VerList end) const
    {
        // go through all dependencies
        for (size_t i = 0; i < depListElements.size(); ++i) {
            // ... and for each dependency try to find a matching version in the list
            VerList vi = vers;

            while ((vi != end) && !projectDoesMatch(depListElements[i].getDependency(), vi->getVersion())) ++vi;
            // abort, if no matching version was found...
            if ((vi == end) || !depListElements[i].dependencyMetBy(vi->getVersion())) return false;
            // ... otherwise continue
        }
        // all dependencies are met
        return true;
    }
} // module
} // wns

#endif // NOT defined WNS_MODULE_DEPENDENCY_LIST_HPP

---