lyx_mirror/src/Chktex.C

/**
 * \file Chktex.C
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Asger Alstrup
 *
 * Full author contact details are available in file CREDITS.
 */

#include <config.h>

#include "Chktex.h"
#include "gettext.h"

#include "LaTeX.h" // TeXErrors

#include "support/convert.h"
#include "support/docstream.h"
#include "support/filetools.h"
#include "support/lstrings.h"
#include "support/systemcall.h"

#include <boost/format.hpp>


namespace lyx {

using support::changeExtension;
using support::FileName;
using support::makeAbsPath;
using support::onlyFilename;
using support::split;
using support::Systemcall;

using std::getline;
using std::string;


Chktex::Chktex(string const & chktex, string const & f, string const & p)
		: cmd(chktex), file(f), path(p)
{
}


int Chktex::run(TeXErrors &terr)
{
	// run bibtex
	string log = onlyFilename(changeExtension(file, ".log"));
	string tmp = cmd + " -q -v0 -b0 -x " + file + " -o " + log;
	Systemcall one;
	int result = one.startscript(Systemcall::Wait, tmp);
	if (result == 0) {
		result = scanLogFile(terr);
	} else {
		result = -1;
	}
	return result;
}


int Chktex::scanLogFile(TeXErrors & terr)
{
	int retval = 0;

	// FIXME: Find out whether onlyFilename() is really needed,
	// or whether makeAbsPath(onlyFilename()) is a noop here
	FileName const tmp(makeAbsPath(onlyFilename(changeExtension(file, ".log"))));

#if USE_BOOST_FORMAT
	boost::basic_format<char_type> msg(_("ChkTeX warning id # %1$d"));
#else
	docstring const msg(_("ChkTeX warning id # "));
#endif
	docstring token;
	// FIXME UNICODE
	// We have no idea what the encoding of the error file is
	idocfstream ifs(tmp.toFilesystemEncoding().c_str());
	while (getline(ifs, token)) {
		docstring srcfile;
		docstring line;
		docstring pos;
		docstring warno;
		docstring warning;
		token = split(token, srcfile, ':');
		token = split(token, line, ':');
		token = split(token, pos, ':');
		token = split(token, warno, ':');
		token = split(token, warning, ':');

		int const lineno = convert<int>(line);

#if USE_BOOST_FORMAT
		msg % warno;
		terr.insertError(lineno, msg.str(), warning);
		msg.clear();
#else
		terr.insertError(lineno, msg + warno, warning);
#endif

		++retval;
	}
	return retval;
}


} // namespace lyx