]> git.lyx.org Git - lyx.git/blobdiff - src/lyxlex.C
fix arabtex-related problems (bug 1225 and bug 1404)
[lyx.git] / src / lyxlex.C
index 00a488341b39b41059953efc1acf892f799379cd..bff5266e194f1760fcb32a226f44ca164f962efa 100644 (file)
-//  Generalized simple lexical analizer.
-//  It can be used for simple syntax parsers, like lyxrc,
-//  texclass and others to come.   [asierra30/03/96]
-//
-//   (C) 1996 Lyx Team.
+/**
+ * \file lyxlex.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Alejandro Aguilar Sierra
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
+ */
 
 #include <config.h>
 
-#include <cstdlib>
-
-#ifdef __GNUG__
-#pragma implementation "lyxlex.h"
-#endif
-
 #include "lyxlex.h"
+
 #include "debug.h"
-#include "support/filetools.h"
+#include "lyxlex_pimpl.h"
+
+#include "support/lstrings.h"
+
+using lyx::support::compare_ascii_no_case;
+using lyx::support::isStrDbl;
+using lyx::support::isStrInt;
+using lyx::support::ltrim;
+using lyx::support::prefixIs;
+using lyx::support::strToDbl;
+using lyx::support::strToInt;
+using lyx::support::subst;
+using lyx::support::trim;
+
+using std::endl;
+using std::string;
+using std::istream;
+using std::ostream;
+
 
 LyXLex::LyXLex(keyword_item * tab, int num)
-       : table(tab), no_items(num)
+       : pimpl_(new Pimpl(tab, num))
+{}
+
+
+LyXLex::~LyXLex()
+{
+       delete pimpl_;
+}
+
+
+bool LyXLex::isOK() const
+{
+       return pimpl_->is.good();
+}
+
+
+void LyXLex::setLineNo(int l)
+{
+       pimpl_->lineno = l;
+}
+
+
+int LyXLex::getLineNo() const
 {
-       file = 0;
-       owns_file = false;
-       status = 0;
-       pushed = 0;
+       return pimpl_->lineno;
+}
+
+
+istream & LyXLex::getStream()
+{
+       return pimpl_->is;
 }
 
 
 void LyXLex::pushTable(keyword_item * tab, int num)
 {
-       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;
+       pimpl_->pushTable(tab, num);
 }
 
 
 void LyXLex::popTable()
 {
-       if (pushed == 0)
-               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;
+       pimpl_->popTable();
 }
 
 
-void LyXLex::printTable()
+void LyXLex::printTable(ostream & os)
 {
-       lyxerr << "\nNumber of tags: " << no_items << endl;
-       for(int i= 0; i<no_items; i++)
-               lyxerr << "table[" << i
-                      << "]:  tag: `" << table[i].tag
-                      << "'  code:" << table[i].code << endl;
-       lyxerr << endl;
+       pimpl_->printTable(os);
 }
 
 
-void LyXLex::printError(string const & message)
+void LyXLex::printError(string const & message) const
 {
-       string tmpmsg = subst(message, "$$Token", GetString());
-       lyxerr << "LyX: " << tmpmsg << " [around line " << lineno
-              << " of file " << MakeDisplayPath(name) << ']' << endl;
+       pimpl_->printError(message);
 }
 
 
 bool LyXLex::setFile(string const & filename)
 {
-        if (file) 
-               lyxerr << "Error in LyXLex::setFile: file already set." <<endl;
-       file = fopen(filename.c_str(), "r");
-       name = filename;
-       owns_file = true;
-       lineno = 0;
-       return (file ? true : false);
+       return pimpl_->setFile(filename);
 }
 
 
-void LyXLex::setFile(FILE * f)
+void LyXLex::setStream(istream & i)
 {
-        if (file) 
-               lyxerr << "Error in LyXLex::setFile: file already set." << endl;
-       file = f;
-       owns_file = false;
-       lineno = 0; // this is bogus if the file already has been read from
+       pimpl_->setStream(i);
 }
 
 
+void LyXLex::setCommentChar(char c)
+{
+       pimpl_->setCommentChar(c);
+}
+
 int LyXLex::lex()
 {
-       //NOTE: possible bug.
-   if (next() && status == LEX_TOKEN)
-       return search_kw(buff);
-   else
-       return status;
+       return pimpl_->lex();
 }
 
 
-int LyXLex::GetInteger()
+int LyXLex::getInteger() const
 {
-   if (buff[0]>' ')   
-       return atoi(buff);
-   else {
-       printError("Bad integer `$$Token'");
+       if (isStrInt(pimpl_->getString()))
+               return strToInt(pimpl_->getString());
+       pimpl_->printError("Bad integer `$$Token'");
        return -1;
-   }
 }
 
 
-float LyXLex::GetFloat()
+float LyXLex::getFloat() const
 {
-   if (buff[0]>' ')   
-       return (float)strtod(buff, (char**)0);
-   else {
-       printError("Bad float `$$Token'");
+       // replace comma with dot in case the file was written with
+       // the wrong locale (should be rare, but is easy enough to
+       // avoid).
+       string str = subst(pimpl_->getString(), ",", ".");
+       if (isStrDbl(str))
+               return strToDbl(str);
+       pimpl_->printError("Bad float `$$Token'");
        return -1;
-   }
 }
 
 
-string LyXLex::GetString() const
+string const LyXLex::getString() const
 {
-       return string(buff);
+       return pimpl_->getString();
 }
 
 
 // I would prefer to give a tag number instead of an explicit token
-// here, but it is not possible because Buffer::readLyXformat2 uses
-// explicit tokens (JMarc) 
-string LyXLex::getLongString(string const & endtoken)
+// here, but it is not possible because Buffer::readBody uses
+// explicit tokens (JMarc)
+string const LyXLex::getLongString(string const & endtoken)
 {
        string str, prefix;
        bool firstline = true;
 
-       while (IsOK()) {
-               if (!EatLine())
+       while (isOK()) {
+               if (!eatLine())
                        // blank line in the file being read
                        continue;
-               
-               string const token = frontStrip(strip(GetString()), " \t");
-               
+
+               string const token = trim(getString(), " \t");
+
                lyxerr[Debug::PARSER] << "LongString: `"
-                                     << GetString() << '\'' << endl;
-
-               // We do a case independent comparison, like search_kw
-               // does.
-                if (compare_no_case(token, endtoken) != 0) {
-                       string tmpstr = GetString();
-                       if (firstline) {
-                               unsigned int i = 0;
-                               while(i < tmpstr.length()
-                                     && tmpstr[i] == ' ') {
-                                       ++i;
-                                       prefix += ' ';
-                               }
-                               firstline = false;
-                               lyxerr[Debug::PARSER] << "Prefix = `" << prefix
-                                                     << '\'' << endl;
-                       } 
-
-                       if (!prefix.empty() 
-                           && prefixIs(tmpstr, prefix.c_str())) {
-                               tmpstr.erase(0, prefix.length() - 1);
-                       }
-                       str += tmpstr + '\n';
-                }
-               else // token == endtoken
+                                     << getString() << '\'' << endl;
+
+               // We do a case independent comparison, like search_kw does.
+               if (compare_ascii_no_case(token, endtoken) == 0)
                        break;
+
+               string tmpstr = getString();
+               if (firstline) {
+                       string::size_type i(tmpstr.find_first_not_of(' '));
+                       if (i != string::npos)
+                               prefix = tmpstr.substr(0, i);
+                       firstline = false;
+                       lyxerr[Debug::PARSER]
+                               << "Prefix = `" << prefix << "\'" << endl;
+               }
+
+               // further lines in long strings may have the same
+               // whitespace prefix as the first line. Remove it.
+               if (prefix.length() && prefixIs(tmpstr, prefix)) {
+                       tmpstr.erase(0, prefix.length() - 1);
+               }
+
+               str += ltrim(tmpstr, "\t") + '\n';
        }
-       if (!IsOK())
+
+       if (!isOK()) {
                printError("Long string not ended by `" + endtoken + '\'');
+       }
 
        return str;
 }
 
 
-bool LyXLex::GetBool()
+bool LyXLex::getBool() const
+{
+       if (pimpl_->getString() == "true") {
+               return true;
+       } else if (pimpl_->getString() != "false") {
+               pimpl_->printError("Bad boolean `$$Token'. "
+                                  "Use \"false\" or \"true\"");
+       }
+       return false;
+}
+
+
+bool LyXLex::eatLine()
 {
-   if (compare(buff, "true") == 0)
-       return true;
-   else if (compare(buff, "false") != 0)
-       printError("Bad boolean `$$Token'. Use \"false\" or \"true\"");
-   return false;
+       return pimpl_->eatLine();
 }
 
 
-bool LyXLex::EatLine()
+bool LyXLex::next(bool esc)
 {
-       int i= 0;
-       int c = '\0'; // getc() returns an int
+       return pimpl_->next(esc);
+}
 
-       while (!feof(file) && c!= '\n' && i!= (LEX_MAX_BUFF-1)) {
-               c = getc(file);
-               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.
+
+bool LyXLex::nextToken()
+{
+       return pimpl_->nextToken();
+}
+
+
+void LyXLex::pushToken(string const & pt)
+{
+       pimpl_->pushToken(pt);
+}
+
+
+int LyXLex::findToken(char const * str[])
+{
+       if (!next()) {
+               pimpl_->printError("file ended while scanning string token");
+               return -1;
        }
-       if (c == '\n') {
-               ++lineno;
-               buff[--i] = '\0'; // i can never be 0 here, so no danger
-               status = LEX_DATA;
-               return true;
-       } else {
-               buff[i] = '\0';
-               return false;
+
+       int i = 0;
+
+       string const search_token = pimpl_->getString();
+
+       if (search_token != "default") {
+               while (str[i][0] && str[i] != search_token) {
+                       ++i;
+               }
+               if (!str[i][0]) {
+                       pimpl_->printError("Unknown argument `$$Token'");
+                       i = -1;
+               }
        }
+
+       return i;
 }
 
 
-int LyXLex::search_kw(char const * const tag) const
+LyXLex::operator void const *() const
 {
-       int m, k= 0 , l= 0, r= no_items;
+       // This behaviour is NOT the same as the std::streams which would
+       // use fail() here. However, our implementation of getString() et al.
+       // can cause the eof() and fail() bits to be set, even though we
+       // haven't tried to read 'em.
+       return pimpl_->is.bad() ? 0 : this;
+}
 
-       while (l < r) {
-               m = (l+r)/2;
 
-               if (lyxerr.debugging(Debug::PARSER)) {
-                       lyxerr << "LyXLex::search_kw: elem " << m
-                              << " tag " << table[m].tag
-                              << " search tag " << tag
-                              << endl;
-               }
+bool LyXLex::operator!() const
+{
+       return pimpl_->is.bad();
+}
+
 
-               if (table[m].tag)
-                       k = compare_no_case(table[m].tag, tag);
-               if (k == 0)
-                       return table[m].code;
-               else
-                       if (k<0) l = m+1; else r = m;
+LyXLex & LyXLex::operator>>(std::string & s)
+{
+       if (isOK()) {
+               next();
+               s = getString();
        }
-       return -1;
+       return *this;
 }
 
 
-bool LyXLex::next(bool esc)
+LyXLex & LyXLex::operator>>(float & s)
 {
-
-       if (!esc) {
-               int c; // getc() returns an int
-               //int i;
-               
-               
-               status = 0;
-               while (!feof(file) && !status) { 
-                       c = getc(file);
-                       if (c == '#') {
-                               // Read rest of line (fast :-)
-                               fgets(buff, sizeof(buff), file);
-                               ++lineno;
-                               continue;
-                       }
-                       
-                       if (c == '\"') {
-                               int i = -1;
-                               do {
-                                       c = getc(file);
-                                       if (c != '\r')
-                                               buff[++i] = c;
-                               } while (c!= '\"' && c!= '\n' && !feof(file) &&
-                                        i!= (LEX_MAX_BUFF-2));
-                               
-                               if (i == (LEX_MAX_BUFF-2)) {
-                                       printError("Line too long");
-                                       c = '\"'; // Pretend we got a "
-                                       ++i;
-                               }
-                               
-                               if (c!= '\"') {
-                                       printError("Missing quote");
-                                       if (c == '\n')
-                                               ++lineno;
-                               }
-                               
-                               buff[i] = '\0';
-                               status = LEX_DATA;
-                               break; 
-                       }
-                       
-                       if (c == ',')
-                               continue;              /* Skip ','s */
-                       
-                       if (c > ' ' && !feof(file))  {
-                               int i = 0;
-                               do {
-                                       buff[i++] = c;
-                                       c = getc(file);
-                               } while (c > ' ' && c != ',' && !feof(file) &&
-                                        (i != LEX_MAX_BUFF-1) );
-                               if (i == LEX_MAX_BUFF-1) {
-                                       printError("Line too long");
-                               }
-                               buff[i] = '\0';
-                               status = LEX_TOKEN;
-                       }
-                       
-                       if (c == '\r' && !feof(file)) {
-                               // The Windows support has lead to the
-                               // possibility of "\r\n" at the end of
-                               // a line.  This will stop LyX choking
-                               // when it expected to find a '\n'
-                               c = getc(file);
-                       }
-
-                       if (c == '\n')
-                               ++lineno;
-                       
-               }
-               if (status) return true;
-               
-               status = (feof(file)) ? LEX_FEOF: LEX_UNDEF;
-               buff[0] = '\0';
-               return false;
-       } else {
-               int c; // getc() returns an int
-               //int i;
-               
-               
-               status = 0;
-               while (!feof(file) && !status) { 
-                       c = getc(file);
-
-                       // skip ','s
-                       if (c == ',') continue;
-                       
-                       if (c == '\\') {
-                               // escape
-                               int i = 0;
-                               do {
-                                       if (c == '\\') {
-                                               // escape the next char
-                                               c = getc(file);
-                                       }
-                                       buff[i++] = c;
-                                       c = getc(file);
-                               } while (c > ' ' && c != ',' && !feof(file) &&
-                                        (i != LEX_MAX_BUFF-1) );
-                               if (i == LEX_MAX_BUFF-1) {
-                                       printError("Line too long");
-                               }
-                               buff[i] = '\0';
-                               status = LEX_TOKEN;
-                               continue;
-                       }
-                       
-                       if (c == '#') {
-                               // Read rest of line (fast :-)
-                               fgets(buff, sizeof(buff), file);
-                               ++lineno;
-                               continue;
-                       }
-
-                       // string
-                       if (c == '\"') {
-                               int i = -1;
-                               bool escaped = false;
-                               do {
-                                       escaped = false;
-                                       c = getc(file);
-                                       if (c == '\r') continue;
-                                       if (c == '\\') {
-                                               // escape the next char
-                                               c = getc(file);
-                                               escaped = true;
-                                       }
-                                       buff[++i] = c;
-                               
-                                       if (!escaped && c == '\"') break;
-                               } while (c!= '\n' && !feof(file) &&
-                                        i!= (LEX_MAX_BUFF-2));
-                               
-                               if (i == (LEX_MAX_BUFF-2)) {
-                                       printError("Line too long");
-                                       c = '\"'; // Pretend we got a "
-                                       ++i;
-                               }
-                               
-                               if (c!= '\"') {
-                                       printError("Missing quote");
-                                       if (c == '\n')
-                                               ++lineno;
-                               }
-                               
-                               buff[i] = '\0';
-                               status = LEX_DATA;
-                               break; 
-                       }
-                       
-                       if (c > ' ' && !feof(file))  {
-                               int i = 0;
-                               do {
-                                       if (c == '\\') {
-                                               // escape the next char
-                                               c = getc(file);
-                                               //escaped = true;
-                                       }
-                                       buff[i++] = c;
-                                       c = getc(file);
-                               } while (c > ' ' && c != ',' && !feof(file) &&
-                                        (i != LEX_MAX_BUFF-1) );
-                               if (i == LEX_MAX_BUFF-1) {
-                                       printError("Line too long");
-                               }
-                               buff[i] = '\0';
-                               status = LEX_TOKEN;
-                       }
-
-                       // new line
-                       if (c == '\n')
-                               ++lineno;
-               }
-               
-               if (status) return true;
-               
-               status = (feof(file)) ? LEX_FEOF: LEX_UNDEF;
-               buff[0] = '\0';
-               return false;   
+       if (isOK()) {
+               next();
+               s = getFloat();
        }
+       return *this;
 }
 
 
-bool LyXLex::nextToken()
+LyXLex & LyXLex::operator>>(int & s)
 {
-       int c; // getc() returns an int
-       int i;
-        
-        status = 0;
-       while (!feof(file) && !status) { 
-               c = getc(file);
-          
-               if (c >= ' ' && !feof(file))  {
-                       i = 0;
-                       if (c == '\\') { // first char == '\\'
-                               do {
-                                       buff[i++] = c;
-                                       c = getc(file);
-                               } while (c > ' ' && c != '\\' && !feof(file) &&
-                                        i != (LEX_MAX_BUFF-1));
-                       } else {
-                               do {
-                                       buff[i++] = c;
-                                       c = getc(file);
-                               } while (c >= ' ' && c != '\\' && !feof(file)
-                                        && i != (LEX_MAX_BUFF-1));
-                       }
-
-                       if (i == (LEX_MAX_BUFF-1)) {
-                               printError("Line too long");
-                       }
-
-                       if (c == '\\') ungetc(c, file); // put it back
-                       buff[i] = '\0';
-                       status = LEX_TOKEN;
-               }
-                 
-               if (c == '\n')
-                       ++lineno;
-       
+       if (isOK()) {
+               next();
+               s = getInteger();
        }
-        if (status)  return true;
-        
-        status = (feof(file)) ? LEX_FEOF: LEX_UNDEF;
-        buff[0] = '\0';
-        return false;
+       return *this;
 }
 
 
-int LyXLex::FindToken(char const * str[])
-{  
-   int i = -1;
-   
-   if (next()) {
-      if (compare(buff, "default")) {
-        for (i = 0; str[i][0] && compare(str[i], buff); ++i);
-        if (!str[i][0]) {
-           printError("Unknown argument `$$Token'");
-           i = -1;
-        }
-      }  
-   } else
-     printError("file ended while scanning string token");
-   return i;
+LyXLex & LyXLex::operator>>(unsigned int & s)
+{
+       if (isOK()) {
+               next();
+               s = getInteger();
+       }
+       return *this;
 }
 
 
-int LyXLex::CheckToken(char const * str[], int print_error)
-{  
-   int i = -1;
-   
-   if (compare(buff, "default")) {
-       for (i = 0; str[i][0] && compare(str[i], buff); i++);
-       if (!str[i][0]) {
-           if (print_error)
-               printError("Unknown argument `$$Token'");
-           i = -1;
-       }
-   }
-   return i;
+LyXLex & LyXLex::operator>>(bool & s)
+{
+       if (isOK()) {
+               next();
+               s = getBool();
+       }
+       return *this;
 }