lyx_mirror/src/lyxlex_pimpl.h

120 lines
2.2 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file lyxlex_pimpl.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bj<EFBFBD>nnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef LYXLEX_PIMPL_H
#define LYXLEX_PIMPL_H
#include "lyxlex.h"
#include "support/types.h"
# include <boost/iostreams/filtering_streambuf.hpp>
# include <boost/iostreams/filter/gzip.hpp>
# include <boost/iostreams/device/file.hpp>
namespace io = boost::iostreams;
#include <boost/utility.hpp>
#include <istream>
#include <stack>
#include <vector>
namespace lyx {
namespace support { class FileName; }
///
class LyXLex::Pimpl : boost::noncopyable {
public:
///
Pimpl(keyword_item * tab, int num);
///
std::string const getString() const;
///
docstring const getDocString() const;
///
void printError(std::string const & message) const;
///
void printTable(std::ostream & os);
///
void pushTable(keyword_item * tab, int num);
///
void popTable();
///
bool setFile(support::FileName const & filename);
///
void setStream(std::istream & i);
///
void setCommentChar(char c);
///
bool next(bool esc = false);
///
int search_kw(char const * const tag) const;
///
int lex();
///
bool eatLine();
///
bool nextToken();
Fix bug 3293 by Bernhard Roider: This changes the semantics of isOK() and operator(), comments from Bernhard below: With the old version of lyxlex it was _impossible_ to check whether reading an integer, float, ... succeeded or not. The current solution to check for is.bad() in some cases and in other cases use is.good() does not give the desired information. Moreover the result of is.bad() depends on the stl implementation and behaves different for linux and windows. the bug was introduced by the patch that fixed the bug that crashed lyx when "inset-insert ert" was executed from the command buffer. The lexer has the method isOK() which reflects the status of the stream is. The operators void* and ! are not really well defined (they depend on the value of is.bad()). What is missing is a test if the last reading operation was successful and thus the returned value is valid. That's what i implemented in this patch. The new rule for using the lexer: if you want to know if the lexer still has data to read (either from the stream or from the pushed token) then use "lex.isOK()". If you want to test if the last reading operation was successful then use eg. "if (lex) {...}" or unsuccessful then use eg. "if (!lex) {...}" an example: int readParam(LyxLex &lex) { int param = 1; // default value if (lex.isOK()) { // the lexer has data to read int p; // temporary variable lex >> p; if (lex) param = p; // only use the input if the reading operation was successful } return param; } git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@17569 a592a061-630c-0410-9148-cb99ea01b6c8
2007-03-26 13:43:49 +00:00
/// test if there is a pushed token or the stream is ok
bool inputAvailable();
///
void pushToken(std::string const &);
/// fb_ is only used to open files, the stream is accessed through is.
std::filebuf fb_;
/// gz_ is only used to open files, the stream is accessed through is.
io::filtering_istreambuf gz_;
/// the stream that we use.
std::istream is;
///
std::string name;
///
keyword_item * table;
///
int no_items;
///
std::string buff;
///
int status;
///
int lineno;
///
std::string pushTok;
///
char commentChar;
private:
///
void verifyTable();
///
class pushed_table {
public:
///
pushed_table()
: table_elem(0), table_siz(0) {}
///
pushed_table(keyword_item * ki, int siz)
: table_elem(ki), table_siz(siz) {}
///
keyword_item * table_elem;
///
int table_siz;
};
///
std::stack<pushed_table> pushed;
};
} // namespace lyx
#endif