]> git.lyx.org Git - lyx.git/blobdiff - src/lyxlex_pimpl.C
cleanup some debug messages
[lyx.git] / src / lyxlex_pimpl.C
index 4068b7eb2ade0a1e97ec65a05e87203b404ececa..292778761a44a3bd87fc7d77c3a8b60e4b91fc6e 100644 (file)
@@ -1,75 +1,86 @@
-#include <config.h>
+/**
+ * \file lyxlex_pimpl.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author Jürgen Vigna
+ *
+ * Full author contact details are available in file CREDITS.
+ */
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-#include <algorithm>
+#include <config.h>
 
 #include "lyxlex_pimpl.h"
-#include "support/lyxalgo.h"
-#include "support/filetools.h"
+
 #include "debug.h"
 
+#include "support/filetools.h"
+#include "support/lyxalgo.h"
+#include "support/lstrings.h"
+
+#include <functional>
+
+using lyx::support::compare_ascii_no_case;
+using lyx::support::getFormatFromContents;
+using lyx::support::MakeDisplayPath;
+using lyx::support::split;
+using lyx::support::subst;
+
+using std::endl;
+using std::getline;
+using std::lower_bound;
 using std::sort;
-using std::ostream;
+using std::string;
 using std::ios;
 using std::istream;
-using std::endl;
-using std::lower_bound;
+using std::ostream;
 
-// namespace {
-struct compare_tags {
-       // used by lower_bound
-       inline
-       int operator()(keyword_item const & a, char const * const tag) const {
-               return compare_no_case(a.tag, tag) < 0;
-       }
-       // used by sorted and sort
-       inline
-       int operator()(keyword_item const & a, keyword_item const & b) const {
-               return compare_no_case(a.tag, b.tag) < 0;
+namespace {
+
+class compare_tags
+       : public std::binary_function<keyword_item, keyword_item, bool> {
+public:
+       // used by lower_bound, sort and sorted
+       bool operator()(keyword_item const & a, keyword_item const & b) const
+       {
+               // we use the ascii version, because in turkish, 'i'
+               // is not the lowercase version of 'I', and thus
+               // turkish locale breaks parsing of tags.
+               return compare_ascii_no_case(a.tag, b.tag) < 0;
        }
 };
-// } // end of anon namespace
+
+} // end of anon namespace
 
 
-LyXLex::Pimpl::Pimpl(keyword_item * tab, int num) 
-       : is(&fb__), table(tab), no_items(num),
-         status(0), pushed(0), lineno(0)
+LyXLex::Pimpl::Pimpl(keyword_item * tab, int num)
+       : is(&fb_), table(tab), no_items(num),
+         status(0), lineno(0), commentChar('#')
 {
-       if (table && !sorted(table, table + no_items, compare_tags())) {
-               lyxerr << "The table passed to LyXLex is not sorted!!\n"
-                      << "Tell the developers to fix it!" << endl;
-               // We sort it anyway to avoid problems.
-               lyxerr << "\nUnsorted:\n";
-               printTable(lyxerr);
-               
-               sort(table, table + no_items,
-                    compare_tags());
-               lyxerr << "\nSorted:\n";
-               printTable(lyxerr);
-       }
+       verifyTable();
 }
 
 
-string LyXLex::Pimpl::GetString() const
+string const LyXLex::Pimpl::getString() const
 {
-       return string(buff);
+       return string(buff.begin(), buff.end());
 }
 
 
 void LyXLex::Pimpl::printError(string const & message) const
 {
-       string tmpmsg = subst(message, "$$Token", GetString());
+       string const tmpmsg = subst(message, "$$Token", getString());
        lyxerr << "LyX: " << tmpmsg << " [around line " << lineno
               << " of file " << MakeDisplayPath(name) << ']' << endl;
 }
 
-       
+
 void LyXLex::Pimpl::printTable(ostream & os)
 {
-       os << "\nNumber of tags: " << no_items << '\n';
-       for(int i= 0; i < no_items; ++i)
+       os << "\nNumber of tags: " << no_items << endl;
+       for (int i= 0; i < no_items; ++i)
                os << "table[" << i
                   << "]:  tag: `" << table[i].tag
                   << "'  code:" << table[i].code << '\n';
@@ -77,76 +88,123 @@ void LyXLex::Pimpl::printTable(ostream & os)
 }
 
 
-void LyXLex::Pimpl::pushTable(keyword_item * tab, int num)
+void LyXLex::Pimpl::verifyTable()
 {
-       pushed_table * tmppu = new pushed_table;
-       tmppu->next = pushed;
-       tmppu->table_elem = table;
-       tmppu->table_siz = no_items;
-       pushed = tmppu;
-       table = tab;
-       no_items = num;
        // Check if the table is sorted and if not, sort it.
        if (table
-           && !sorted(table, table + no_items, compare_tags())) {
-               lyxerr << "The table passed to LyXLex is not sorted!!\n"
+           && !lyx::sorted(table, table + no_items, compare_tags())) {
+               lyxerr << "The table passed to LyXLex is not sorted!\n"
                       << "Tell the developers to fix it!" << endl;
                // We sort it anyway to avoid problems.
-               lyxerr << "\nUnsorted:\n";
+               lyxerr << "\nUnsorted:" << endl;
                printTable(lyxerr);
-               
+
                sort(table, table + no_items, compare_tags());
-               lyxerr << "\nSorted:\n";
+               lyxerr << "\nSorted:" << endl;
                printTable(lyxerr);
        }
 }
 
-       
+
+void LyXLex::Pimpl::pushTable(keyword_item * tab, int num)
+{
+       pushed_table tmppu(table, no_items);
+       pushed.push(tmppu);
+
+       table = tab;
+       no_items = num;
+
+       verifyTable();
+}
+
+
 void LyXLex::Pimpl::popTable()
 {
-       if (pushed == 0)
+       if (pushed.empty()) {
                lyxerr << "LyXLex error: nothing to pop!" << endl;
-       
-       pushed_table * tmp;
-       tmp = pushed;
-       table = tmp->table_elem;
-       no_items = tmp->table_siz;
-       tmp->table_elem = 0;
-       pushed = tmp->next;
-       delete tmp;
+               return;
+       }
+
+       pushed_table tmp = pushed.top();
+       pushed.pop();
+       table = tmp.table_elem;
+       no_items = tmp.table_siz;
 }
 
 
 bool LyXLex::Pimpl::setFile(string const & filename)
 {
-       //if (fb__.is_open())
-       //      lyxerr << "Error in LyXLex::setFile: "
-       //              "file or stream already set." << endl;
-       fb__.open(filename.c_str(), ios::in);
-       //is.rdbuf(&fb__);
-       name = filename;
-       lineno = 0;
-       return fb__.is_open() && is.good();
+       // Check the format of the file.
+       string const format = getFormatFromContents(filename);
+
+       if (format == "gzip" || format == "zip" || format == "compress") {
+               lyxerr[Debug::LYXLEX] << "lyxlex: compressed" << endl;
+
+#ifdef USE_COMPRESSION
+               // The check only outputs a debug message, because it triggers
+               // a bug in compaq cxx 6.2, where is_open() returns 'true' for
+               // a fresh new filebuf.  (JMarc)
+               if (gz_.is_open() || istream::off_type(is.tellg()) > -1)
+                       lyxerr[Debug::LYXLEX] << "Error in LyXLex::setFile: "
+                               "file or stream already set." << endl;
+               gz_.open(filename.c_str(), ios::in);
+               is.rdbuf(&gz_);
+               name = filename;
+               lineno = 0;
+               return gz_.is_open() && is.good();
+#else
+               return false;
+#endif
+       } else {
+               lyxerr[Debug::LYXLEX] << "lyxlex: UNcompressed" << endl;
+
+               // The check only outputs a debug message, because it triggers
+               // a bug in compaq cxx 6.2, where is_open() returns 'true' for
+               // a fresh new filebuf.  (JMarc)
+               if (fb_.is_open() || istream::off_type(is.tellg()) > 0)
+                       lyxerr[Debug::LYXLEX] << "Error in LyXLex::setFile: "
+                               "file or stream already set." << endl;
+               fb_.open(filename.c_str(), ios::in);
+               is.rdbuf(&fb_);
+               name = filename;
+               lineno = 0;
+               return fb_.is_open() && is.good();
+       }
 }
 
-       
+
 void LyXLex::Pimpl::setStream(istream & i)
 {
-       if (fb__.is_open() || is.rdbuf()->in_avail())
-               lyxerr << "Error in LyXLex::setStream: "
+       if (fb_.is_open() || istream::off_type(is.tellg()) > 0)
+               lyxerr[Debug::LYXLEX]  << "Error in LyXLex::setStream: "
                        "file or stream already set." << endl;
        is.rdbuf(i.rdbuf());
        lineno = 0;
 }
 
 
+void LyXLex::Pimpl::setCommentChar(char c)
+{
+       commentChar = c;
+}
+
+
 bool LyXLex::Pimpl::next(bool esc /* = false */)
 {
        if (!pushTok.empty()) {
-               pushTok.copy(buff, string::npos);
-               buff[pushTok.length()] = '\0';
-               pushTok.erase();
-               return true;
+               // There can have been a whole line pushed so
+               // we extract the first word and leaves the rest
+               // in pushTok. (Lgb)
+               if (pushTok.find(' ') != string::npos && pushTok[0] == '\\') {
+                       string tmp;
+                       pushTok = split(pushTok, tmp, ' ');
+                       buff.assign(tmp.begin(), tmp.end());
+                       return true;
+               } else {
+                       buff.assign(pushTok.begin(), pushTok.end());
+                       pushTok.erase();
+                       return true;
+               }
        }
        if (!esc) {
                unsigned char c = 0; // getc() returns an int
@@ -155,64 +213,63 @@ bool LyXLex::Pimpl::next(bool esc /* = false */)
                while (is && !status) {
                        is.get(cc);
                        c = cc;
-                       if (c == '#') {
+                       if (c == commentChar) {
                                // Read rest of line (fast :-)
-                               is.getline(buff, sizeof(buff));
+#if 1
+                               // That is not fast... (Lgb)
+                               string dummy;
+                               getline(is, dummy);
+
                                lyxerr[Debug::LYXLEX] << "Comment read: `" << c
-                                                     << buff << "'" << endl;
+                                                     << dummy << '\'' << endl;
+#else
+                               // unfortunately ignore is buggy (Lgb)
+                               is.ignore(100, '\n');
+#endif
                                ++lineno;
                                continue;
                        }
-                       
+
                        if (c == '\"') {
-                               int i = -1;
+                               buff.clear();
+
                                do {
                                        is.get(cc);
                                        c = cc;
                                        if (c != '\r')
-                                               buff[++i] = c;
-                               } while (c != '\"' && c != '\n' && is &&
-                                        i != (LEX_MAX_BUFF - 2));
-                               
-                               if (i == (LEX_MAX_BUFF - 2)) {
-                                       printError("Line too long");
-                                       c = '\"'; // Pretend we got a "
-                                       ++i;
-                               }
-                               
+                                               buff.push_back(c);
+                               } while (c != '\"' && c != '\n' && is);
+
                                if (c != '\"') {
                                        printError("Missing quote");
                                        if (c == '\n')
                                                ++lineno;
                                }
-                               
-                               buff[i] = '\0';
+
+                               buff.pop_back();
                                status = LEX_DATA;
-                               break; 
+                               break;
                        }
-                       
+
                        if (c == ',')
                                continue;              /* Skip ','s */
-                       
+
                                // using relational operators with chars other
                                // than == and != is not safe. And if it is done
                                // the type _have_ to be unsigned. It usually a
                                // lot better to use the functions from cctype
                        if (c > ' ' && is)  {
-                               int i = 0;
+                               buff.clear();
+
                                do {
-                                       buff[i++] = c;
+                                       buff.push_back(c);
                                        is.get(cc);
                                        c = cc;
-                               } while (c > ' ' && c != ',' && is
-                                        && (i != LEX_MAX_BUFF - 1) );
-                               if (i == LEX_MAX_BUFF - 1) {
-                                       printError("Line too long");
-                               }
-                               buff[i] = '\0';
+                               } while (c > ' ' && c != ',' && is);
+
                                status = LEX_TOKEN;
                        }
-                       
+
                        if (c == '\r' && is) {
                                // The Windows support has lead to the
                                // possibility of "\r\n" at the end of
@@ -221,62 +278,69 @@ bool LyXLex::Pimpl::next(bool esc /* = false */)
                                is.get(cc);
                                c = cc;
                        }
-                       
+
                        if (c == '\n')
                                ++lineno;
-                       
+
                }
                if (status) return true;
-               
+
                status = is.eof() ? LEX_FEOF: LEX_UNDEF;
-               buff[0] = '\0';
+               buff.clear();
                return false;
        } else {
                unsigned char c = 0; // getc() returns an int
                char cc = 0;
-               
+
                status = 0;
                while (is && !status) {
                        is.get(cc);
                        c = cc;
-                       
+
                        // skip ','s
                        if (c == ',') continue;
-                       
+
                        if (c == '\\') {
                                // escape
-                               int i = 0;
+                               buff.clear();
+
                                do {
                                        if (c == '\\') {
                                                // escape the next char
                                                is.get(cc);
                                                c = cc;
                                        }
-                                       buff[i++] = c;
+                                       buff.push_back(c);
                                        is.get(cc);
                                        c = cc;
-                               } while (c > ' ' && c != ',' && is
-                                        && (i != LEX_MAX_BUFF - 1) );
-                               if (i == LEX_MAX_BUFF - 1) {
-                                       printError("Line too long");
-                               }
-                               buff[i] = '\0';
+                               } while (c > ' ' && c != ',' && is);
+
                                status = LEX_TOKEN;
                                continue;
                        }
-                       
-                       if (c == '#') {
+
+                       if (c == commentChar) {
                                // Read rest of line (fast :-)
-                               is.getline(buff, sizeof(buff));
+#if 1
+                               // That is still not fast... (Lgb)
+                               string dummy;
+                               getline(is, dummy);
+
                                lyxerr[Debug::LYXLEX] << "Comment read: `" << c
-                                                     << buff << "'" << endl;
+                                                     << dummy << '\'' << endl;
+#else
+                               // but ignore is also still buggy (Lgb)
+                               // This is fast (Lgb)
+                               is.ignore(100, '\n');
+#endif
                                ++lineno;
                                continue;
                        }
-                       
+
                        // string
                        if (c == '\"') {
-                               int i = -1;
+                               buff.clear();
+
                                bool escaped = false;
                                do {
                                        escaped = false;
@@ -287,33 +351,30 @@ bool LyXLex::Pimpl::next(bool esc /* = false */)
                                                // escape the next char
                                                is.get(cc);
                                                c = cc;
-                                               escaped = true;
+                                               if (c == '\"' || c == '\\')
+                                                       escaped = true;
+                                               else
+                                                       buff.push_back('\\');
                                        }
-                                       buff[++i] = c;
-                                       
+                                       buff.push_back(c);
+
                                        if (!escaped && c == '\"') break;
-                               } while (c != '\n' && is &&
-                                        i != (LEX_MAX_BUFF - 2));
-                               
-                               if (i == (LEX_MAX_BUFF - 2)) {
-                                       printError("Line too long");
-                                       c = '\"'; // Pretend we got a "
-                                       ++i;
-                               }
-                               
+                               } while (c != '\n' && is);
+
                                if (c != '\"') {
                                        printError("Missing quote");
                                        if (c == '\n')
                                                ++lineno;
                                }
-                               
-                               buff[i] = '\0';
+
+                               buff.pop_back();
                                status = LEX_DATA;
-                               break; 
+                               break;
                        }
-                       
+
                        if (c > ' ' && is) {
-                               int i = 0;
+                               buff.clear();
+
                                do {
                                        if (c == '\\') {
                                                // escape the next char
@@ -321,38 +382,38 @@ bool LyXLex::Pimpl::next(bool esc /* = false */)
                                                c = cc;
                                                //escaped = true;
                                        }
-                                       buff[i++] = c;
+                                       buff.push_back(c);
                                        is.get(cc);
                                        c = cc;
-                               } while (c > ' ' && c != ',' && is
-                                        && (i != LEX_MAX_BUFF-1) );
-                               if (i == LEX_MAX_BUFF-1) {
-                                       printError("Line too long");
-                               }
-                               buff[i] = '\0';
+                               } while (c > ' ' && c != ',' && is);
+
                                status = LEX_TOKEN;
                        }
                        // new line
                        if (c == '\n')
                                ++lineno;
                }
-               
+
                if (status) return true;
-               
+
                status = is.eof() ? LEX_FEOF : LEX_UNDEF;
-               buff[0] = '\0';
+               buff.clear();
                return false;
        }
 }
 
-       ///
+
 int LyXLex::Pimpl::search_kw(char const * const tag) const
 {
+       keyword_item search_tag = { tag, 0 };
        keyword_item * res =
                lower_bound(table, table + no_items,
-                           tag, compare_tags());
+                           search_tag, compare_tags());
+       // use the compare_ascii_no_case instead of compare_no_case,
+       // because in turkish, 'i' is not the lowercase version of 'I',
+       // and thus turkish locale breaks parsing of tags.
        if (res != table + no_items
-           && !compare_no_case(res->tag, tag))
+           && !compare_ascii_no_case(res->tag, tag))
                return res->code;
        return LEX_UNDEF;
 }
@@ -361,39 +422,34 @@ int LyXLex::Pimpl::search_kw(char const * const tag) const
 int LyXLex::Pimpl::lex()
 {
        //NOTE: possible bug.
-       if (next() && status == LEX_TOKEN)
-               return search_kw(buff);
-       else
+       if (next() && status == LEX_TOKEN) {
+               return search_kw(getString().c_str());
+       else
                return status;
 }
 
-       
-bool LyXLex::Pimpl::EatLine()
+
+bool LyXLex::Pimpl::eatLine()
 {
-       int i = 0;
+       buff.clear();
+
        unsigned char c = '\0';
        char cc = 0;
-       while(is && c != '\n' && i != (LEX_MAX_BUFF - 1)) {
+       while (is && c != '\n') {
                is.get(cc);
                c = cc;
-               lyxerr[Debug::LYXLEX] << "LyXLex::EatLine read char: `"
-                                     << c << "'" << endl;
+               //lyxerr[Debug::LYXLEX] << "LyXLex::EatLine read char: `"
+               //                    << c << '\'' << endl;
                if (c != '\r')
-                       buff[i++] = c;
-       }
-       if (i == (LEX_MAX_BUFF - 1) && c != '\n') {
-               printError("Line too long");
-               c = '\n'; // Pretend we had an end of line
-               --lineno; // but don't increase line counter (netto effect)
-               ++i; // and preserve last character read.
+                       buff.push_back(c);
        }
+
        if (c == '\n') {
                ++lineno;
-               buff[--i] = '\0'; // i can never be 0 here, so no danger
+               buff.pop_back();
                status = LEX_DATA;
                return true;
        } else {
-               buff[i] = '\0';
                return false;
        }
 }
@@ -402,10 +458,19 @@ bool LyXLex::Pimpl::EatLine()
 bool LyXLex::Pimpl::nextToken()
 {
        if (!pushTok.empty()) {
-               pushTok.copy(buff, string::npos);
-               buff[pushTok.length()] = '\0';
-               pushTok.erase();
-               return true;
+               // There can have been a whole line pushed so
+               // we extract the first word and leaves the rest
+               // in pushTok. (Lgb)
+               if (pushTok.find(' ') != string::npos && pushTok[0] == '\\') {
+                       string tmp;
+                       pushTok = split(pushTok, tmp, ' ');
+                       buff.assign(tmp.begin(), tmp.end());
+                       return true;
+               } else {
+                       buff.assign(pushTok.begin(), pushTok.end());
+                       pushTok.erase();
+                       return true;
+               }
        }
 
        status = 0;
@@ -415,40 +480,34 @@ bool LyXLex::Pimpl::nextToken()
                is.get(cc);
                c = cc;
                if (c >= ' ' && is) {
-                       int i = 0;
+                       buff.clear();
+
                        if (c == '\\') { // first char == '\\'
                                do {
-                                       buff[i++] = c;
+                                       buff.push_back(c);
                                        is.get(cc);
                                        c = cc;
-                               } while (c > ' ' && c != '\\' && is
-                                        && i != (LEX_MAX_BUFF-1));
+                               } while (c > ' ' && c != '\\' && is);
                        } else {
                                do {
-                                       buff[i++] = c;
+                                       buff.push_back(c);
                                        is.get(cc);
                                        c = cc;
-                               } while (c >= ' ' && c != '\\' && is
-                                        && i != (LEX_MAX_BUFF-1));
-                       }
-                       
-                       if (i == (LEX_MAX_BUFF - 1)) {
-                               printError("Line too long");
+                               } while (c >= ' ' && c != '\\' && is);
                        }
-                       
+
                        if (c == '\\') is.putback(c); // put it back
-                       buff[i] = '\0';
                        status = LEX_TOKEN;
                }
-               
+
                if (c == '\n')
                        ++lineno;
-               
+
        }
        if (status)  return true;
-       
+
        status = is.eof() ? LEX_FEOF: LEX_UNDEF;
-       buff[0] = '\0';
+       buff.clear();
        return false;
 }