context.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2014 - 2016 by Chris Beck <[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.
*/

/**
 * Manages the availability of wesnoth callbacks to plug-ins while the
 * application is context switching.
 */

#ifndef INCLUDED_PLUGINS_CONTEXT_HPP_
#define INCLUDED_PLUGINS_CONTEXT_HPP_

#include "utils/functional.hpp"

#include <map>
#include <string>
#include <vector>

class config;

class plugins_context {

public:
    typedef std::function<bool(config)> callback_function;
    typedef struct { char const * name; callback_function func; } Reg;

    typedef std::function<config(config)> accessor_function;
    typedef struct { char const * name; accessor_function func; } aReg;

    plugins_context( const std::string & name );
    plugins_context( const std::string & name, const std::vector<Reg>& callbacks, const std::vector<aReg>& accessors);
    template<int N, int M>
    plugins_context( const std::string & name, const Reg (& callbacks)[N], const aReg (& accessors)[M])
        : name_(name)
    {
        std::vector<Reg> l;
        std::vector<aReg> r;
        l.reserve(N);
        r.reserve(M);
        for(int i = 0; i < N; i++) {
            l.push_back(callbacks[i]);
        }
        for(int i = 0; i < M; i++) {
            r.push_back(accessors[i]);
        }
        initialize(l, r);
    }

    void play_slice();

    void set_callback(const std::string & name, callback_function);
    void set_callback(const std::string & name, std::function<void(config)> function, bool preserves_context);
    size_t erase_callback(const std::string & name);
    size_t clear_callbacks();

    void set_accessor(const std::string & name, accessor_function);
    void set_accessor_string(const std::string & name, std::function<std::string(config)>); //helpers which create a config from a simple type
    void set_accessor_int(const std::string & name, std::function<int(config)>);
    size_t erase_accessor(const std::string & name);
    size_t clear_accessors();

    friend class application_lua_kernel;

private:
    typedef std::map<std::string, callback_function > callback_list;
    typedef std::map<std::string, accessor_function > accessor_list;

    void initialize(const std::vector<Reg>& callbacks, const std::vector<aReg>& accessors);

    callback_list callbacks_;
    accessor_list accessors_;
    std::string name_;
};

//A shim to assist in retrieving config attribute values
extern const std::function< std::string ( const config & , const std::string & ) > get_str;
extern const std::function< int ( const config & , const std::string &, int ) > get_int;
extern const std::function< size_t ( const config & , const std::string &, size_t ) > get_size_t;

#endif