Dream 52/Amiga_Dream_52.iso/Linux/Divers/lyx-0.13.2.tar.gz/lyx-0.13.2.tar/lyx-0.13.2/src/LaTeX.h

C/C++ Source or Header | 1998-04-23 | 4KB | 236 lines

// -*- C++ -*-
/* This file is part of
 * ======================================================
 *
 *           LyX, The Document Processor
 *         Copyright (C) 1995 Matthias Ettrich
 *
 *           This file is Copyright (C) 1996-1998
 *           Lars Gullik Bj°nnes
 *
 *======================================================
 */

#ifndef _LATEX_H
#define _LATEX_H

#ifdef __GNUG__
#pragma interface
#endif

#include "LString.h"
#include "DepTable.h"

class LyXLex;
class MiniBuffer;

///
class TeXErrors {
public:
    ///
    TeXErrors() {
        errors = NULL;
        next_error = NULL;
        status = 0;
        number_of_errors = 0;
    }
    ///
    ~TeXErrors();
    ///
    void scanError(LyXLex &);
    ///
    bool getFirstError(int *line, LString *text);
    ///
    bool getNextError(int *line, LString *text);
    ///
    void insertError(int line, LString const &error_desc,
             LString const &error_text);
    ///
    void printErrors();
    ///
    void printWarnings();
    ///
    void printStatus();
    ///
    int getStatus() { return status; }
private:
    ///
    friend class LaTeX;
    ///
    int status;
    ///
    int number_of_errors;
    ///
    struct Error {
        ///
        Error () {
            next_error = NULL;
            error_in_line = 0;
        }
        ///
        Error(int line, LString const &desc, LString const &text) {
            next_error = NULL;
            error_in_line = line;
            error_desc = desc;
            error_text = text;
        }
        ///
        ~Error() {
        }
        ///
        Error *next_error;
        /// what line in the TeX file the error occured in
        int error_in_line;
        /// The kind of error
        LString error_desc;
        /// The line/cmd that caused the error.
        LString error_text;
    };
    ///
    Error *errors;
    ///
    Error *next_error;
};


///
class LaTeX {
public:
    /** All the different files produced by TeX.

      This is the files mentioned on page 208-9 in Lamports book +
      .ltx and .tex files.
     */
    enum TEX_FILES {
        ///
        NO_FILES = 0,
        /// used for table of contents et.al.
        AUX = 1,
        /// written by BibTeX
        BBL = 2,
        /// LaTeX's output
        DVI = 4,
        /// glossary (not supported by LyX so far)
        GLO = 8,
        ///index
        IDX = 16,
        /// written by makeindex
        IND = 32,
        /// list of figures
        LOF = 64,
        /// the LaTeX log file
        LOG = 128,
        /// list of tables
        LOT = 256,
        /// table of contents
        TOC = 512,
        /// latex files
        LTX = 1024,
        /// tex files
        TEX = 2048,
        /// list of algorithms
        LOA = 4096
    };

    /** Return values from scanLogFile() and run() (to come)

      This enum should be enlarged a bit so that one could
      get more feedback from the LaTeX run.
      */
    enum log_status {
        ///
        NO_ERRORS = 0,
        ///
        NO_LOGFILE = 1,
        ///
        NO_OUTPUT = 2,
        ///
        UNDEF_REF = 4, // Reference '...' on page ... undefined.
        ///
        UNDEF_CIT = 8, // Citation '...' on page ... undefined.
        ///
        RERUN = 16, // Label(s) may have changed. Rerun to get...
        ///
        TEX_ERROR = 32,
        ///
        TEX_WARNING = 64,
        ///
        LATEX_ERROR = 128,
        ///
        LATEX_WARNING = 256,
        ///
        PACKAGE_WARNING = 512,
        ///
        NO_FILE = 1024,
        ///
        NO_CHANGE = 2048,
        ///
        ERRORS = TEX_ERROR + LATEX_ERROR,
        ///
        WARNINGS = TEX_WARNING + LATEX_WARNING + PACKAGE_WARNING
    };


    /**
      cmd = the latex command, file = name of the (temporary) latex file,
      path = name of the files original path.
      */
    LaTeX(LString const & cmd, LString const & file, LString const & path);

    /// runs LaTeX several times
    int run(TeXErrors &, MiniBuffer *);

    ///
    int getNumErrors() { return num_errors;}

    /// use this for running LaTeX once
    int operator() ();
private:
    /** The dependency file.

      We store the file dependencies in this file.
      the depency file is on the format:
      <file> <new checksum> <old checksum>
      */
    LString depfile;

    ///
    LaTeX(){;}

    ///
    LaTeX(const LaTeX&){;}

    ///
    void deplog(DepTable &head);
    ///
    void deptex(DepTable &head);

    ///
    int scanLogFile(TeXErrors &);

    ///
    bool runMakeIndex(LString const &);

    ///
    bool runBibTeX(LString const &);

    ///
    LString cmd;

    ///
    LString file;

    ///
    LString path;
    ///
    TEX_FILES tex_files;

    ///
    int file_count;

    // used by scanLogFile
    int num_errors;
};

#endif