//
// Layout.hh
//
// Copyright (C) :  2000 - 2002
//					LifeLine Networks BV (www.lifeline.nl). All rights reserved.
//					Bastiaan Bakker. All rights reserved.   
//					
//					2004,2005,2006,2007,2008,2009,2010,2011,2012
//					Synchrotron SOLEIL
//                	L'Orme des Merisiers
//                	Saint-Aubin - BP 48 - France
//
// This file is part of log4tango.
//
// Log4ango is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// Log4tango is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public License
// along with Log4Tango.  If not, see <http://www.gnu.org/licenses/>.

#ifndef _LOG4TANGO_LAYOUT_H
#define _LOG4TANGO_LAYOUT_H

#include <log4tango/Portability.hh>
#include <log4tango/threading/Threading.hh>
#include <log4tango/LoggingEvent.hh>
#include <string>

namespace log4tango {

//-----------------------------------------------------------------------------
// class : Appender (abstract class)
//-----------------------------------------------------------------------------
class LOG4TANGO_EXPORT Layout 
{
public:

  /**
   * Constructor for Layout.
   **/
  Layout() {};

  /**
   * Destructor for Layout.
   **/
  virtual ~Layout() {};

  /**
   * Formats the LoggingEvent data to a string that appenders can log.
   * Overload this method to create your own layout format.
   * @param event The LoggingEvent.
   * @returns an appendable string.
   **/
  virtual std::string format (const LoggingEvent& event);
};  
      
} // namespace log4tango

#endif // _LOG4TANGO_LAYOUT_H
