/**
 * @file
 * $Id$
 * $Revision$
 * $Author$
 * $Date$
 *
 * This file is part of The iWear Framework.
 * In particular this file is part of the Framework Core Library
 *
 * The iWear Framework 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 as in version 2 of the License.

 * 
 * The iWear Framework 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 General Public License for
 * more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * The iWear Framework; if not, write to the Free Software Foundation, Inc., 59
 * Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef __IWEAR_DEBUGMODULEFILE_H
#define __IWEAR_DEBUGMODULEFILE_H

#ifndef __IWEAR_DEBUGMODULE_H
#include <iwear/debugmodule.h>
#endif

#include <string>
using std::string;


extern "C" {
#include <sys/stat.h>
}

namespace iwear
{

enum timestamp_type 
{
    ts_none,	///< Dont record a timestamp in the log
    ts_ctime,	///< Record a ctime style timestamp (human readable)
    ts_epoch,	///< Record seconds since epoch
    ts_repoch,	///< Record relative seconds since epoch (i.e. seconds since start)
    ts_relative
};
/**
 * This output modules logs everything to a file, and prefixes a timestamp to every line.
 * @note Due to internal buffering of the debugstream and the cout itself, it
 * may come to delays in output that do not seem to be expeted at first. To
 * make sure that everything is output, put a flush or endl into the stream.
 */
class debugmodulefile : public debugmodule/*{{{*/
{
private:
    string logfilename;


    off_t last_filesize;

    bool check_and_open( void );
    void update_filesize( void );
protected:
    timestamp_type wanted_timestamp;
    int logfd;
    time_t offset;
    int do_log ( const char * msg );
public:
   /**
    * We need to base a debugmanager reference to the base
    */
    debugmodulefile( const string& file, debugmanager&, timestamp_type wts = ts_ctime );

   /**
    * This does nothing at the moment
    */
    virtual ~debugmodulefile( );

   /**
    * This simply outputs things to file via cout
    */
    virtual int log ( const char * msg );
};/*}}}*/

inline void debugmodulefile::update_filesize( void )/*{{{*/
{
    if ( logfd <= 0 ) return;
    struct stat ms;
    fstat(logfd,&ms);
    last_filesize = ms.st_size;
}/*}}}*/

}

#endif