lyx_mirror/src/Chktex.cpp
Juergen Spitzmueller 0e08b4e4f5 Adapt to new ChkTeX return values.
As of v. 1.7.7, chktex has four exit values. Only consider the program
failed with EXIT_FAILURE (1). This is backwards compatible to chktex
up to v. 1.7.5 and later patched versions included in TeXLive, where
there was the distinction EXIT_FAILURE (program failed) and EXIT_SUCCESS
(program successfully run, with or without something to report).

Note that ChkTeX v. 1.7.5 and 1.7.6 vanilla (as included in MikTeX) also
returned EXITE_FAILURE if ChkTeX found something to report.

We do not, and never did, support this case.

Fixes: #9989 (after ChkTeX 1.7.7. is released).
(cherry picked from commit 0d806799aa)
2018-03-17 15:44:05 -04:00

93 lines
2.3 KiB
C++

/**
* \file Chktex.cpp
* 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 "LaTeX.h" // TeXErrors
#include "support/convert.h"
#include "support/docstream.h"
#include "support/filetools.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/Systemcall.h"
using namespace std;
using namespace lyx::support;
namespace lyx {
Chktex::Chktex(string const & chktex, string const & f, string const & p)
: cmd(chktex), file(f), path(p)
{}
int Chktex::run(TeXErrors &terr)
{
// run chktex
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);
// ChkTeX (as of v. 1.7.7) has the following return values:
// 0 = EXIT_SUCCESS : program ran successfully, nothing to report
// 1 = EXIT_FAILURE : program ran unsucessfully
// 2 = EXIT_WARNINGS : program ran successfully, only warnings to report
// 3 = EXIT_ERRORS : program ran successfully, errors to report
// We only check for EXIT_FAILURE here, since older versions of ChkTeX
// returned 0 also in case 2 and 3.
if (result == EXIT_FAILURE)
result = -1;
else
result = scanLogFile(terr);
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"))));
docstring const msg(_("ChkTeX warning id # %1$s"));
docstring token;
// FIXME UNICODE
// We have no idea what the encoding of the error file is
ifdocstream 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);
terr.insertError(lineno, bformat(msg, warno), warning);
++retval;
}
return retval;
}
} // namespace lyx