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