/*
 * SPDX-FileCopyrightText: 2000-2002 Copyright LifeLine Networks BV (www.lifeline.nl)
 * SPDX-FileCopyrightText: 2000-2002 Copyright Bastiaan Bakker
 * SPDX-FileCopyrightText: 2004 Copyright contributors to the cppTango project
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later
 */

#ifndef TANGO_COMMON_LOG4TANGO_APPENDERATTACHABLE_H
#define TANGO_COMMON_LOG4TANGO_APPENDERATTACHABLE_H

#include <tango/common/log4tango/Appender.h>
#include <tango/common/log4tango/Portability.h>

#include <map>
#include <mutex>
#include <vector>

namespace log4tango
{

/**
 * A map of appenders
 **/
typedef std::map<std::string, Appender *> AppenderMap;

/**
 * A map of appenders iterator
 **/
typedef AppenderMap::iterator AppenderMapIterator;

/**
 * Define what is a list of appenders
 **/
typedef std::vector<Appender *> AppenderList;

//-----------------------------------------------------------------------------
// class : AppenderAttachable
//-----------------------------------------------------------------------------
class AppenderAttachable
{
  public:
    /**
     * Constructor.
     **/
    AppenderAttachable();

    /**
     * Destructor.
     **/
    virtual ~AppenderAttachable();

    /**
     * Adds an Appender. Does nothing if the appender is nullptr
     * or already attached.
     **/
    void add_appender(Appender *appender);

    /**
     * Get all previously added appenders as a vector.
     * The caller must call "release" on each Appender in
     * the returned list when it is no longer needed (the
     * Appender class is ref-counted).
     **/
    AppenderList get_all_appenders();

    /**
     * Get an appender by name.
     * The caller must call "release" on the returned Appender
     * when it is no longer needed (the Appender class is
     * ref-counted). Returns 0 if there is no Appender named
     * "name" currently attached.
     **/
    Appender *get_appender(const std::string &name);

    /**
     * Returns true if the specified appender is in list of
     * attached appanders, false otherwise.
     **/
    bool is_attached(Appender *appender);

    /**
     * Removes all appenders for this Logger.
     **/
    void remove_all_appenders();

    /**
     * Remove the appender passed as parameter from the list of appenders.
     **/
    void remove_appender(Appender *appender);

    /**
     * Remove the appender with the name passed as parameter from the
     * list of appenders.
     **/
    void remove_appender(const std::string &name);

  protected:
    /**
     * Appenders repository.
     **/
    AppenderMap _appenders;

    /**
     * A mutex to protect the repository against race conditions.
     **/
    std::mutex _appendersMutex;

    AppenderAttachable(const AppenderAttachable &other);
    AppenderAttachable &operator=(const AppenderAttachable &other);
};

} // namespace log4tango

#endif // TANGO_COMMON_LOG4TANGO_APPENDERATTACHABLE_H
