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 Lexer;
  21 class TeXErrors;
  22
  23
  24 ///
  25 class Chktex {
  26 public:
  27         /**
  28           @param cmd the chktex command.
  29           @param file name of the (temporary) latex file.
  30           @param path name of the files original path.
  31         */
  32         Chktex(std::string const & cmd, std::string const & file,
  33                std::string const & path);
  34
  35         /** Runs chktex.
  36             @return -1 if fail, number of messages otherwise.
  37           */
  38         int run(TeXErrors &);
  39 private:
  40         ///
  41         int scanLogFile(TeXErrors &);
  42         ///
  43         std::string cmd;
  44         ///
  45         std::string file;
  46         ///
  47         std::string path;
  48 };
  49
  50
  51 } // namespace lyx
  52
  53 #endif