src/Chktex.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Chktex.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef CHKTEX_H
  13 #define CHKTEX_H
  14
  15 #include <string>
  16
  17
  18 namespace lyx {
  19
  20 class TeXErrors;
  21
  22
  23 ///
  24 class Chktex {
  25 public:
  26         /**
  27           @param cmd the chktex command.
  28           @param file name of the (temporary) latex file.
  29           @param path name of the files original path.
  30         */
  31         Chktex(std::string const & cmd, std::string const & file,
  32                std::string const & path);
  33
  34         /** Runs chktex.
  35             @return -1 if fail, number of messages otherwise.
  36           */
  37         int run(TeXErrors &);
  38 private:
  39         ///
  40         int scanLogFile(TeXErrors &);
  41         ///
  42         std::string cmd;
  43         ///
  44         std::string file;
  45         ///
  46         std::string path;
  47 };
  48
  49
  50 } // namespace lyx
  51
  52 #endif