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