side_filter.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2010 - 2016 by Yurii Chernyi <[email protected]>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 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.

   See the COPYING file for more details.
*/

#ifndef SIDE_FILTER_H_INCLUDED
#define SIDE_FILTER_H_INCLUDED

#include "variable.hpp"

#include <boost/scoped_ptr.hpp>
#include <set>
#include <string>
#include <vector>

class config;
class filter_context;
class unit;
class unit_filter;
class unit_map;
class team;

//side_filter: a class that implements the Standard Side Filter
class side_filter {
public:

#ifdef _MSC_VER
    // This constructor is required for MSVC 9 SP1 due to a bug there
    // see http://social.msdn.microsoft.com/forums/en-US/vcgeneral/thread/34473b8c-0184-4750-a290-08558e4eda4e
    // other compilers don't need it.
    side_filter();
#endif
    ~side_filter();

    side_filter(const std::string &side_string, const filter_context * fc, bool flat_tod = false);
    side_filter(const vconfig &cfg, const filter_context * fc, bool flat_tod = false);

    //match: returns true if and only if the given team matches this filter
    bool match(const team& t) const;
    bool match(const int side) const;
    std::vector<int> get_teams() const;

private:
    side_filter(const side_filter &other);
    side_filter& operator=(const side_filter &other);

    bool match_internal(const team& t) const;

    const vconfig cfg_; //config contains WML for a Standard Side Filter

    bool flat_;
    std::string side_string_;

    const filter_context * fc_; //!< The filter context for this filter. It should be a pointer because otherwise the default ctor doesn't work

    mutable boost::scoped_ptr<unit_filter> ufilter_;
    mutable boost::scoped_ptr<side_filter> allied_filter_;
    mutable boost::scoped_ptr<side_filter> enemy_filter_;
    mutable boost::scoped_ptr<side_filter> has_ally_filter_;
    mutable boost::scoped_ptr<side_filter> has_enemy_filter_;
};

#endif