/*
Copyright © 2017-2019,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.  See
the top-level NOTICE for additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
#pragma once

#include "../application_api/Endpoints.hpp"
#include "../application_api/Publications.hpp"
#include "helicsApp.hpp"

#include "../application_api/HelicsPrimaryTypes.hpp"
#include <map>

#include <set>

namespace helics
{
namespace apps
{
class ValueSetter
{
  public:
    Time time;
    int iteration = 0;
    int index;
    std::string type;
    std::string pubName;
    defV value;
};

class MessageHolder
{
  public:
    Time sendTime;
    int index;
    Message mess;
};

/** class implementing a Player object, which is capable of reading a file and generating interfaces
and sending signals at the appropriate times
@details  the Player class is not thread-safe,  don't try to use it from multiple threads without external
protection, that will result in undefined behavior
*/
class Player : public App
{
  public:
    /** default constructor*/
    Player () = default;
    /** construct from command line arguments
    @param argc the number of arguments
    @param argv the strings in the input
    */
    Player (int argc, char *argv[]);
    /** construct from a federate info object
    @param name the name of the federate (can be empty to use defaults from fi)
    @param fi a pointer info object containing information on the desired federate configuration
    */
    explicit Player (const std::string &name, const FederateInfo &fi);
    /**constructor taking a federate information structure and using the given core
    @param name the name of the federate (can be empty to use defaults from fi)
    @param core a pointer to core object which the federate can join
    @param fi  a federate information structure
    */
    Player (const std::string &name, const std::shared_ptr<Core> &core, const FederateInfo &fi);
    /**constructor taking a file with the required information
    @param appName the name of the app
    @param configString JSON, TOML or text file or JSON string defining the federate information and other
    configuration
    */
    Player (const std::string &appName, const std::string &configString);

    /** move construction*/
    Player (Player &&other_player) = default;
    /** move assignment*/
    Player &operator= (Player &&fed) = default;

    /** initialize the Player federate
    @details generate all the publications and organize the points, the final publication count will be available
    after this time and the Player will enter the initialization mode, which means it will not be possible to add
    more publications calling run will automatically do this if necessary
    */
    virtual void initialize () override;

    /** run the Player until the specified time
    @param stopTime_input the desired stop time
    */
    virtual void runTo (Time stopTime_input) override;

    /** add a publication to a Player
    @param key the key of the publication to add
    @param type the type of the publication
    @param pubUnits the units associated with the publication
    */
    void addPublication (const std::string &key, data_type type, const std::string &pubUnits = std::string ());

    /** add a publication to a Player
    @param key the key of the publication to add
    @param pubUnits the units associated with the publication
    */
    template <class valType>
    typename std::enable_if_t<helicsType<valType> () != data_type::helics_custom>
    addPublication (const std::string &key, const std::string &pubUnits = std::string ())
    {
        if (!useLocal)
        {
            publications.push_back (Publication (GLOBAL, fed.get (), key, helicsType<valType> (), pubUnits));
        }
        else
        {
            publications.push_back (Publication (fed.get (), key, helicsType<valType> (), pubUnits));
        }

        pubids[key] = static_cast<int> (publications.size ()) - 1;
    }

    /** add an endpoint to the Player
    @param endpointName the name of the endpoint
    @param endpointType the named type of the endpoint
    */
    void addEndpoint (const std::string &endpointName, const std::string &endpointType = std::string ());
    /** add a data point to publish through a Player
    @param pubTime the time of the publication
    @param key the key for the publication
    @param val the value to publish
    */
    template <class valType>
    void addPoint (Time pubTime, const std::string &key, const valType &val)
    {
        points.resize (points.size () + 1);
        points.back ().time = pubTime;
        points.back ().pubName = key;
        points.back ().value = val;
    }

    /** add a data point to publish through a Player
    @param pubTime the time of the publication
    @param iteration the iteration count on which the value should be published
    @param key the key for the publication
    @param val the value to publish
    */
    template <class valType>
    void addPoint (Time pubTime, int iteration, const std::string &key, const valType &val)
    {
        points.resize (points.size () + 1);
        points.back ().time = pubTime;
        points.back ().iteration = iteration;
        points.back ().pubName = key;
        points.back ().value = val;
    }
    /** add a message to a Player queue
    @param sendTime  the time the message should be sent
    @param src the source endpoint of the message
    @param dest the destination endpoint of the message
    @param payload the payload of the message
    */
    void addMessage (Time sendTime, const std::string &src, const std::string &dest, const std::string &payload);

    /** add an event for a specific time to a Player queue
    @param sendTime  the time the message should be sent
    @param actionTime  the eventTime listed for the message
    @param src the source endpoint of the message
    @param dest the destination endpoint of the message
    @param payload the payload of the message
    */
    void addMessage (Time sendTime,
                     Time actionTime,
                     const std::string &src,
                     const std::string &dest,
                     const std::string &payload);

    /** get the number of points loaded*/
    auto pointCount () const { return points.size (); }
    /** get the number of messages loaded*/
    auto messageCount () const { return messages.size (); }
    /** get the number of publications */
    auto publicationCount () const { return publications.size (); }
    /** get the number of endpoints*/
    auto endpointCount () const { return endpoints.size (); }
    /** get the point from an index*/
    const auto &getPoint (int index) const { return points[index]; }
    /** get the messages from an index*/
    const auto &getMessage (int index) const { return messages[index]; }

  private:
    int loadArguments (boost::program_options::variables_map &vm_map);
    /** load from a jsonString
    @param jsonString either a JSON filename or a string containing JSON
    */
    virtual void loadJsonFile (const std::string &jsonString) override;
    /** load a text file*/
    virtual void loadTextFile (const std::string &filename) override;
    /** helper function to sort through the tags*/
    void sortTags ();
    /** helper function to generate the publications*/
    void generatePublications ();
    /** helper function to generate the used Endpoints*/
    void generateEndpoints ();
    /** helper function to sort the points and link them to publications*/
    void cleanUpPointList ();

    /** send all points and messages up to the specified time*/
    void sendInformation (Time sendTime, int iteration = 0);

    /** extract a time from the string based on Player parameters
    @param str the string containing the time
    @param lineNumber the lineNumber of the file which is used in case of invalid specification
    */
    helics::Time extractTime (const std::string &str, int lineNumber = 0) const;

  private:
    std::vector<ValueSetter> points;  //!< the points to generate into the federation
    std::vector<MessageHolder> messages;  //!< list of message to hold
    std::map<std::string, std::string> tags;  //!< map of the key and type strings
    std::set<std::string> epts;  //!< set of the used endpoints
    std::vector<Publication> publications;  //!< the actual publication objects
    std::vector<Endpoint> endpoints;  //!< the actual endpoint objects
    std::map<std::string, int> pubids;  //!< publication id map
    std::map<std::string, int> eptids;  //!< endpoint id maps
    helics::data_type defType =
      helics::data_type::helics_string;  //!< the default data type unless otherwise specified
    size_t pointIndex = 0;  //!< the current point index
    size_t messageIndex = 0;  //!< the current message index
    time_units units = time_units::sec;
    double timeMultiplier = 1.0;  //!< specify the time multiplier for different time specifications
    Time nextPrintTimeStep = helics::timeZero;  //!< the time advancement period for printing markers
};
}  // namespace apps
}  // namespace helics
