src.libs/CjNP_LoggableBase.hh

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
/*
 * mitie
 * Copyright (C) Jason Spencer 2009 <mitie@jasonspencer.org>
 * 
 * mitie 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, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * mitie 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _CJNP_LOGGABLEBASE_H_
#define _CJNP_LOGGABLEBASE_H_ 1

#include <string>
#include <fstream>
#include <list>
#include <memory>       //auto_ptr
#include "CjNLTopology.hh"
#include "CjMatrix.hh"
#include "CjNetworkProcess.hh"
#include "Cj_options_helper.hh"
#include <boost/shared_ptr.hpp>

namespace jmitie {

class CjNP_LoggableBase : public CjNetworkProcess {

protected:
std::string m_label;
bool m_append_epoch;
boost::shared_ptr<std::fstream> m_fout;         // stored as pointer to allow copying of the class
std::string m_header;

public:
CjNP_LoggableBase( const std::string & args, const ctor_va_t & var_arg ):CjNetworkProcess(args, var_arg), m_append_epoch(false) {}
~CjNP_LoggableBase() { }

static std::string getProperty_static(const std::string & opt) {
        if(opt == "usage") { return std::string("[append_epoch]\tAppends the epoch number after the label of each line.\n" \
                                                                                "[overwrite]\tspecifies whether to overwrite the file in case of output to file.\n" \
                                                                                "[label]\tThe label to print at the start of each output line.\n" \
                                                                                "[header]\tThis is printed above any information dumped.\n" \
                                                                                "[fn=filename]\tThe filename of the file to secnd output to. If not specified output will be sent to std out.\n");
                                                                        }
        throw std::invalid_argument("CjNP_LoggableBase::getProperty_static(" + opt + "): Unknown property requested.");
        }

void chompLogOptions( std::list< optval_t > & opts ) {
        std::list< optval_t > opts_ (opts);
        bool overwrite_found = false;
        bool append_epoch = false;
        std::string fname;
        std::string label;
        std::string header;
        std::auto_ptr<std::fstream> fout;

        try {
                extractStringOption( "fn", opts_, fname );
                append_epoch = extractValuelessOption( "append_epoch", opts_ );
                overwrite_found = extractValuelessOption( "overwrite", opts_ );
                extractStringOption( "label", opts_, label );
                extractStringOption( "header", opts_, header );
        } catch (const Cj_OptionParseFail & e) { throw Cj_OptionParseFail(getName() + ": " + e.what()); }

        if(overwrite_found && !fname.empty()) throw Cj_OptionParseFail("Cannot specify overwrite without filename in process " + getName());
        if(!fname.empty()) {
                std::ios_base::openmode mode = std::ios_base::out;
                if(!overwrite_found) mode |= std::ios_base::app;
                fout.reset( new std::fstream( fname.c_str(), mode ) );
                if(!fout->good()) throw Cj_OptionParseFail("In process " + getName() + ": Couldn't open file " + fname + " for " + (overwrite_found?"overwriting.":"appending."));
        }

        m_fout.reset(fout.release());
        opts.swap( opts_ );
        std::swap( m_append_epoch, append_epoch);
        std::swap( m_label, label );
        std::swap( m_header, header );
}

static std::string getLogOpts() { return "[fn=filename] [append_epoch] [label=text] [overwrite] [header=value]\n Where:\n\tfn=\tthe filename to output to, if not present output is cout\n\tlabel=\tthe text to prepend each output line\n\tappend_epoch\tappend the epoch number to the label\n\theader=\tText to print before any output"; }
};

} // namespace jmitie

#endif // _CJNP_LOGGABLEBASE_H_