// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).

//

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

// You may obtain a copy of the License at

//

//     http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.

/**

 * @file XMLEndpointParser.h

 *

 */

#ifndef FASTDDS_XMLPARSER__XMLENDPOINTPARSER_H

#define FASTDDS_XMLPARSER__XMLENDPOINTPARSER_H

#ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC

#include <cstdint>

#include <set>

#include <string>

#include <vector>

#include <tinyxml2.h>

#include <rtps/builtin/data/ReaderProxyData.hpp>

#include <rtps/builtin/data/WriterProxyData.hpp>

#include <xmlparser/XMLParserCommon.h>

#include <xmlparser/XMLParser.h>

namespace tinyxml2 {

class XMLElement;

class XMLDocument;

} // namespace tinyxml2

namespace eprosima {

namespace fastdds {

namespace rtps {

class ReaderProxyData;

class WriterProxyData;

} // namespace rtps

namespace xmlparser {

/**

 * Class StaticRTPSParticipantInfo, contains the information of writers and readers loaded from the XML file.

 *@ingroup DISCOVERY_MODULE

 */

class StaticRTPSParticipantInfo

{

public:

    StaticRTPSParticipantInfo()

    {

    }

    virtual ~StaticRTPSParticipantInfo()

    {

    }

    //!RTPS PArticipant name

    std::string m_RTPSParticipantName;

    //!Vector of ReaderProxyData pointer

    std::vector<rtps::ReaderProxyData*> m_readers;

    //!Vector of ReaderProxyData pointer

    std::vector<rtps::WriterProxyData*> m_writers;

};

/**

 * Class XMLEndpointParser used to parse the XML file that contains information about remote endpoints.

 * @ingroup DISCOVERY_MODULE

 */

class XMLEndpointParser : XMLParser

{

public:

    XMLEndpointParser();

    virtual ~XMLEndpointParser();

    /**

     * Load the XML file

     * @param filename Name or data of the file to load and parse.

     * The string could contain a filename (file://) or the XML content directly (data://), filename assumed if neither

     * @return True if correct.

     */

    XMLP_ret loadXMLFile(

            std::string& filename);

    /**

     * Load the XML node

     * @param doc Node to parse.

     * @return True if correct.

     */

    XMLP_ret loadXMLNode(

            tinyxml2::XMLDocument& doc);

    void loadXMLParticipantEndpoint(

            tinyxml2::XMLElement* xml_endpoint,

            StaticRTPSParticipantInfo* pdata);

    /**

     * Load a Reader endpoint.

     * @param xml_endpoint Reference of a tree child for a reader.

     * @param pdata Pointer to the RTPSParticipantInfo where the reader must be added.

     * @return True if correctly added.

     */

    XMLP_ret loadXMLReaderEndpoint(

            tinyxml2::XMLElement* xml_endpoint,

            StaticRTPSParticipantInfo* pdata);

    /**

     * Load a Writer endpoint.

     * @param xml_endpoint Reference of a tree child for a writer.

     * @param pdata Pointer to the RTPSParticipantInfo where the reader must be added.

     * @return True if correctly added.

     */

    XMLP_ret loadXMLWriterEndpoint(

            tinyxml2::XMLElement* xml_endpoint,

            StaticRTPSParticipantInfo* pdata);

    /**

     * Look for a reader in the previously loaded endpoints.

     * @param [in] partname RTPSParticipant name

     * @param [in] id Id of the reader

     * @param [out] rdataptr Pointer to pointer to return the information.

     * @param [out] position Return the position of the reader in the vector of readers.

     * @return True if found.

     */

    XMLP_ret lookforReader(

            const char* partname,

            uint16_t id,

            rtps::ReaderProxyData** rdataptr,

            uint32_t& position);

    /**

     * Look for a writer in the previously loaded endpoints.

     * @param [in] partname RTPSParticipant name

     * @param [in] id Id of the writer

     * @param [out] wdataptr Pointer to pointer to return the information.

     * @param [out] position Return the position of the writer in the vector of writers.

     * @return True if found

     */

    XMLP_ret lookforWriter(

            const char* partname,

            uint16_t id,

            rtps::WriterProxyData** wdataptr,

            uint32_t& position);

    /**

     * Get a reader from the position in the vector of readers.

     * @param[in] participant_name Name of the participant

     * @param[in] pos Position in the vector of readers.

     * @param[out] rdataptr Pointer to pointer to return the information.

     * @return XMLP_ret::XML_OK if found, XMLP_ret::XML_ERROR otherwise.

     */

    XMLP_ret get_reader_from_position(

            const std::string& participant_name,

            size_t pos,

            rtps::ReaderProxyData** rdataptr);

    /**

     * Get a writer from the position in the vector of writers.

     * @param[in] participant_name Name of the participant

     * @param[in] pos Position in the vector of writers.

     * @param[out] wdataptr Pointer to pointer to return the information.

     * @return XMLP_ret::XML_OK if found, XMLP_ret::XML_ERROR otherwise.

     */

    XMLP_ret get_writer_from_position(

            const std::string& participant_name,

            size_t pos,

            rtps::WriterProxyData** wdataptr);

    /**

     * Get the number of readers for a participant.

     * @param[in] participant_name Name of the participant.

     * @return Number of readers for the participant.

     */

    size_t get_number_of_readers(

            const std::string& participant_name);

    /**

     * Get the number of writers for a participant.

     * @param[in] participant_name Name of the participant.

     * @return Number of writers for the participant.

     */

    size_t get_number_of_writers(

            const std::string& participant_name);

private:

    XMLP_ret get_disable_positive_acks_qos(

            tinyxml2::XMLElement* elem,

            dds::DisablePositiveACKsQosPolicy& disable_positive_acks_qos);

    std::set<int16_t> m_endpointIds;

    std::set<uint32_t> m_entityIds;

    std::vector<StaticRTPSParticipantInfo*> m_RTPSParticipants;

};

} // namespace xmlparser

} // namespace fastdds

} // namespace eprosima

#endif // ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC

#endif // FASTDDS_XMLPARSER__XMLENDPOINTPARSER_H