Expression.cpp 13.6 KB
Newer Older
1
2
3
4
#include <iostream>
#include <locale>
#include <sstream>

5
6
7
8
#include "MantidAPI/Expression.h"

#include <Poco/StringTokenizer.h>

9
10
namespace Mantid {
namespace API {
11
12
13

typedef Poco::StringTokenizer tokenizer;

14
15
const std::string DEFAULT_OPS_STR[] = {";", ",", "=", "== != > < <= >=",
                                       "&& || ^^", "+ -", "* /", "^"};
16

17
Expression::Expression() {
18
19

  m_operators.reset(new Operators());
20
21
22
  // Define binary operators. Put them in the reverse precedence order (from
  // lower to higher prec.)
  std::vector<std::string> ops(DEFAULT_OPS_STR, DEFAULT_OPS_STR + 8);
23
24
25
26
27
28
29
30
31
32
33
34

  add_operators(ops);

  // Define unary operators
  std::set<std::string> unary;
  unary.insert("+");
  unary.insert("-");

  add_unary(unary);
}

/// contructor
35
Expression::Expression(const std::vector<std::string> &ops) {
36
37
38
39
40
  m_operators.reset(new Operators());
  add_operators(ops);
}

/// contructor
41
42
Expression::Expression(const std::vector<std::string> &binary,
                       const std::set<std::string> &unary) {
43
44
45
46
47
  m_operators.reset(new Operators());
  add_operators(binary);
  add_unary(unary);
}

48
49
50
51
52
53
54
Expression::Expression(const Expression &expr)
    : // m_tokens(expr.m_tokens),
      // m_expr(expr.m_expr),
      m_funct(expr.m_funct),
      m_op(expr.m_op), m_terms(expr.m_terms), m_operators(expr.m_operators) {}
Expression::Expression(const Expression *pexpr)
    : m_operators(pexpr->m_operators) {}
55
56

/// Assignment operator
57
Expression &Expression::operator=(const Expression &expr) {
58
59
60
61
  m_operators = expr.m_operators;
  m_funct = expr.m_funct;
  m_op = expr.m_op;
  m_terms = expr.m_terms;
62
63
  // m_expr = expr.m_expr;
  // m_tokens = expr.m_tokens;
64
65
66
  return *this;
}

67
void Expression::add_operators(const std::vector<std::string> &ops) {
68
69
  m_operators->binary = ops;
  // Fill in the precedence table (m_op_precedence)
70
  for (size_t i = 0; i < m_operators->binary.size(); i++) {
71
    char j = 0;
72
73
    tokenizer tkz(m_operators->binary[i], " ",
                  tokenizer::TOK_IGNORE_EMPTY | tokenizer::TOK_TRIM);
74
    for (auto it = tkz.begin(); it != tkz.end(); it++) {
75
76
77
78
79
      m_operators->precedence[*it] = i + 1;
      m_operators->op_number[*it] = j++;
    }
  }

80
  for (size_t i = 0; i < ops.size(); i++) {
81
    std::string str = ops[i];
82
    for (size_t j = 0; j < str.size(); j++) {
83
      char c = str[j];
84
85
      if (c == ' ')
        continue;
86
87
88
89
90
      m_operators->symbols.insert(c);
    }
  }
}

91
void Expression::add_unary(const std::set<std::string> &ops) {
92
  m_operators->unary = ops;
93
94
  for (auto it = ops.cbegin(); it != ops.cend(); ++it) {
    for (auto c = it->cbegin(); c != it->cend(); ++c) {
95
96
97
98
99
      m_operators->symbols.insert(*c);
    }
  }
}

100
101
102
103
104
size_t Expression::op_prec(const std::string &op) const {
  std::map<std::string, size_t>::const_iterator i =
      m_operators->precedence.find(op);
  if (i == m_operators->precedence.end())
    return 0;
105
106
107
  return i->second;
}

108
bool Expression::is_unary(const std::string &op) const {
109
  return m_operators->unary.find(op) != m_operators->unary.end();
110
111
}

112
bool Expression::is_op_symbol(const char c) const {
113
  return m_operators->symbols.find(c) != m_operators->symbols.end();
114
115
}

116
void Expression::trim(std::string &str) {
117
118
  size_t i = str.find_first_not_of(" \t\n\r");
  size_t j = str.find_last_not_of(" \t\n\r");
119
  if (i == std::string::npos || j == std::string::npos || j < i) {
120
    str = "";
121
122
  } else {
    str = str.substr(i, j - i + 1);
123
124
125
  }
}

126
void Expression::parse(const std::string &str) {
127
128
129
  m_expr = str;
  trim(m_expr);

130
131
132
133
134
  if (m_expr.size() > 1 && m_expr[0] == '(' &&
      m_expr[m_expr.size() - 1] == ')') {
    if (m_expr.find('(', 1) == std::string::npos) {
      m_expr.erase(0, 1);
      m_expr.erase(m_expr.size() - 1, 1);
135
136
137
138
139
140
      trim(m_expr);
    }
  }

  tokenize();

141
  if (m_tokens.size() == 0) {
142
143
144
145
146
    setFunct(m_expr);
    return;
  }

  std::string op = GetOp(0);
147
  // size_t prec = m_operators->precedence[op];
148
  size_t prec = op_prec(op);
149
150
  tokenizer tkz(m_operators->binary[prec - 1], " ",
                tokenizer::TOK_IGNORE_EMPTY | tokenizer::TOK_TRIM);
151
152
153

  setFunct(*tkz.begin());

154
  for (size_t i = 0; i <= m_tokens.size(); i++) {
155
    m_terms.push_back(Expression(this));
156
    Expression &t = m_terms.back();
157
    if (i)
158
      t.m_op = GetOp(i - 1);
159
160
161
162
163
164
    t.parse(GetToken(i));
  }
  m_expr = "";
  m_tokens.clear();
}

165
void Expression::tokenize() {
166
167
  m_tokens.clear();

Peterson, Peter's avatar
Peterson, Peter committed
168
  size_t min_prec = 1000;
169
170
171
172
173
174
175
  size_t is = 0;
  size_t is1 = 0;
  unsigned int lvl = 0;
  size_t last = m_expr.size() - 1;
  bool inString = false;
  int skip = 0;
  bool canBeBinary = false;
176
177
  bool isNumber =
      false; // if parser is inside a number (important case is 123.45e+67)
178
179
180
  bool canDotBeAdded = false;
  bool canEBeAdded = false;
  bool canPlusBeAdded = false;
181
  Tokens tokens;
182
  for (size_t i = 0; i < m_expr.size(); i++) {
183
    char c = m_expr[i];
184

185
186
187
188
    if (!inString && skip == 0) {
      if (isNumber) {
        if (c == '.') {
          if (canDotBeAdded) {
189
            canDotBeAdded = false;
190
          } else {
191
192
            isNumber = false;
          }
193
194
        } else if (c == 'e' || c == 'E') {
          if (canEBeAdded) {
195
196
197
            canEBeAdded = false;
            canDotBeAdded = false;
            canPlusBeAdded = true;
198
          } else {
199
200
            isNumber = false;
          }
201
202
        } else if (c == '+' || c == '-') {
          if (canPlusBeAdded) {
203
204
205
            canPlusBeAdded = false;
            canEBeAdded = false;
            canDotBeAdded = false;
206
          } else {
207
208
            isNumber = false;
          }
209
        } else if (!isdigit(c)) {
210
211
          isNumber = false;
        }
212
      } else if (isdigit(c)) {
213
214
215
216
217
        isNumber = true;
        canDotBeAdded = true;
        canEBeAdded = true;
        canPlusBeAdded = false;
      }
218
      if (lvl == 0 && !isNumber && is_op_symbol(c)) // insert new token
219
      {
220
        if (i == last) {
221
          break;
222
          // throw std::runtime_error("Expression: syntax error");
223
224
        }

225
        if (is_op_symbol(m_expr[i + 1])) {
226
          is1 = i + 2;
227
        } else {
228
229
230
          is1 = i + 1;
        }

231
        if (is1 > last) {
232
233
234
          throw std::runtime_error("Expression: syntax error");
        }

235
236
        std::string op = m_expr.substr(i, is1 - i);
        size_t prec = canBeBinary ? m_operators->precedence[op] : 0;
237
238
239
240
241
        if (!prec) // operator does not exist
        {
          std::ostringstream mess;
          bool error = true;
          // check if it's a binary and a unary operators together
242
243
          if (op.size() == 2) {
            if (is_unary(op)) {
244
245
246
247
              is1 -= 2;
              skip = 2;
              prec = min_prec + 1; // do not add token
              error = false;
248
            } else {
249
              is1 -= 1;
250
              std::string uop = op.substr(1, 1);
251
              op = op[0];
252
253
254
255
              if (is_op_symbol(m_expr[is1 + 1])) {
                uop += m_expr[is1 + 1];
                if (is1 + 2 > last) {
                  mess << "Expression: syntax error at " << is1 + 1;
256
257
258
                  throw std::runtime_error(mess.str());
                }
              }
259
              if (is_unary(uop)) {
260
                prec = m_operators->precedence[op];
261
262
                if (prec) { // we don't want to create a new token with unary
                            // operator. it is processed in SetFunct()
263
264
265
266
267
                  skip = 1;
                  error = false;
                }
              }
            }
268
269
270
          } // op.size == 2
          else if (op.size() == 1) {
            // skip = 1;
271
272
273
            prec = min_prec + 1; // do not add token
            error = false;
          }
274
          if (error) {
275
276
277
278
279
            mess << "Expression: unrecognized operator " << op;
            throw std::runtime_error(mess.str());
          }
        }

280
        if (prec <= min_prec) {
Peterson, Peter's avatar
Peterson, Peter committed
281
          if (prec < min_prec)
282
283
            min_prec = prec;
          Token tok(is, i - 1, is1, prec);
284
285
286
287
288
289
290
291
          tokens.push_back(tok);
          is = is1;
        }

        i = is1 - 1;

        canBeBinary = false;

292
293
      } // insert new token
      else if (c != ' ' && c != '\t' && c != '\r' && c != '\n') {
294
295
296
        canBeBinary = true;
      }

297
298
299
300
301
302
      if (c == '(')
        lvl++;
      if (c == ')') {
        if (lvl)
          lvl--;
        else {
303
304
305
306
          throw std::runtime_error("Unmatched brackets");
        }
      }
    } // !inString || skip
307
308
    else if (skip > 0) {
      skip--;
309
310
    }

311
312
    if (c == '"') {
      if (!inString) {
313
        inString = true;
314
      } else {
315
316
317
318
319
320
        inString = false;
      }
    }

  } // for i

321
  if (tokens.size()) {
322
323
    // remove operators of higher prec
    m_tokens.push_back(Token(tokens[0]));
324
325
326
327
328
    for (size_t i = 0; i < tokens.size(); i++) {
      Token &tok = tokens[i];
      std::string op = m_expr.substr(tok.ie + 1, tok.is1 - tok.ie - 1); //?
      if (m_operators->precedence[op] == min_prec) {
        Token &last_tok = m_tokens.back();
329
        last_tok.ie = tok.ie;
330
331
332
        last_tok.is1 = tok.is1;
        if (i != tokens.size() - 1)
          m_tokens.push_back(Token(tokens[i + 1]));
333
334
335
336
337
      }
    }
  }
}

338
339
340
std::string Expression::GetToken(size_t i) {
  if (m_tokens.size() == 0)
    return m_expr;
341

342
343
344
  if (i < m_tokens.size()) {
    Token &tok = m_tokens[i];
    return m_expr.substr(tok.is, tok.ie - tok.is + 1);
345
346
  }

347
348
  if (i == m_tokens.size()) {
    Token &tok = m_tokens[i - 1];
349
350
351
352
353
354
    return m_expr.substr(tok.is1);
  }

  return "";
}

355
356
357
std::string Expression::GetOp(size_t i) {
  if (m_tokens.size() == 0 || i >= m_tokens.size())
    return "";
358

359
360
  Token &tok = m_tokens[i];
  return m_expr.substr(tok.ie + 1, tok.is1 - tok.ie - 1);
361
362
}

363
void Expression::logPrint(const std::string &pads) const {
364
  std::string myPads = pads + "   ";
365
366
367
  if (m_terms.size()) {
    std::cerr << myPads << m_op << '[' << m_funct << ']' << "(" << '\n';
    for (size_t i = 0; i < m_terms.size(); i++)
368
      m_terms[i].logPrint(myPads);
369
370
371
    std::cerr << myPads << ")" << '\n';
  } else
    std::cerr << myPads << m_op << m_funct << '\n';
372
373
}

374
375
void Expression::setFunct(const std::string &name) {
  if (!op_prec(name)) {
376
    std::string op = "";
377
378
379
    if (name.size() > 1 && is_op_symbol(name[0])) {
      op = name.substr(0, 1);
      if (name.size() > 2 && is_op_symbol(name[1])) {
380
381
382
        op += name[1];
      }
    }
383
    if (!op.empty() && is_unary(op)) {
384
385
386
387
388
389
390
391
392
393
      m_funct = op;
      Expression tmp(this);
      tmp.parse(name.substr(op.size()));
      m_terms.push_back(tmp);
      return;
    }
  }

  m_funct = name;
  trim(m_funct);
394
  if (m_funct.empty()) {
395
396
397
398
399
400
401
    throw std::runtime_error("Expression: Syntax error");
  }

  // Check if the function has arguments
  std::string::size_type i = std::string::npos;

  bool inQuotes = false;
402
403
404
405
  for (std::string::const_iterator c = name.begin(); c != name.end(); ++c) {
    if (*c == '"') {
      if (inQuotes)
        inQuotes = false;
406
407
408
409
410
      else
        inQuotes = true;
      continue;
    }

411
    if (!inQuotes && *c == '(') {
412
413
414
415
416
      i = c - name.begin();
      break;
    }
  }

417
  if (i != std::string::npos) {
418
    std::string::size_type j = name.find_last_of(')');
419
    if (j == std::string::npos || j < i) {
420
421
422
      throw std::runtime_error("Unmatched brackets");
    }

423
    if (j > i + 1) // nonzero argument list
424
    {
425
      std::string args = name.substr(i + 1, j - i - 1); //?
426
      trim(args);
427
      std::string f = name.substr(0, i);
428
429
      Expression tmp(this);
      tmp.parse(args);
430
      if (!tmp.isFunct() || tmp.name() != ",") {
431
        m_terms.push_back(tmp);
432
      } else {
433
434
435
436
437
438
439
440
441
        std::string my_op = m_op;
        *this = tmp;
        m_op = my_op;
      }
      m_funct = f;
    }
  }
}

442
std::string Expression::str() const {
443
444
445
  bool brackets = false;
  std::ostringstream res;
  size_t prec = op_prec(m_funct);
446
  if (size() == 1 && is_unary(m_funct)) { // unary operator
447
    res << m_funct;
448
    if (op_prec(m_terms[0].m_funct) > 0) {
449
450
      brackets = true;
    }
451
  } else if (!prec) { // function with a name
452
453
454
455
    res << m_funct;
    brackets = true;
  }

456
457
458
459
  if (m_terms.size()) {
    if (brackets)
      res << '(';
    for (size_t i = 0; i < m_terms.size(); i++) {
460
      res << m_terms[i].operator_name();
461
      size_t prec1 = op_prec(m_terms[i].m_funct);
462
      bool isItUnary = false;
463
      if (m_terms[i].size() == 1 && is_unary(m_terms[i].m_funct)) {
464
465
466
        prec1 = 0; // unary operator
        isItUnary = true;
      }
467
468
469
470
471
      bool bk = prec > 0 && prec1 > 0 && prec > prec1;
      if (bk)
        res << '(';
      if (isItUnary)
        res << ' ';
472
      res << m_terms[i].str();
473
474
      if (bk)
        res << ')';
475
    }
476
477
    if (brackets)
      res << ')';
478
479
480
481
  }
  return res.str();
}

482
483
484
const Expression &Expression::bracketsRemoved() const {
  const Expression *e = this;
  while (e->name().empty() && e->size() == 1) {
485
486
487
488
489
    e = &e->m_terms[0];
  }
  return *e;
}

490
491
492
/**
 * Return a list of all variable names in this expression
 */
493
std::set<std::string> Expression::getVariables() const {
494
  std::set<std::string> out;
495
  if (!isFunct()) {
496
    std::string s = name();
497
    if (!s.empty() && !isdigit(s[0])) {
498
499
      out.insert(s);
    }
500
  } else {
501
    for (auto e = begin(); e != end(); ++e) {
502
      if (e->isFunct()) {
503
        std::set<std::string> tout = e->getVariables();
504
505
        out.insert(tout.begin(), tout.end());
      } else {
506
        std::string s = e->name();
507
        if (!s.empty() && !isdigit(s[0])) {
508
509
          out.insert(s);
        }
510
511
512
513
514
515
      }
    }
  }
  return out;
}

516
void Expression::rename(const std::string &newName) { m_funct = newName; }
517

518
519
520
void Expression::renameAll(const std::string &oldName,
                           const std::string &newName) {
  if (!isFunct() && name() == oldName) {
521
    rename(newName);
522
  } else {
523
524
    for (auto &term : m_terms) {
      term.renameAll(oldName, newName);
525
526
527
528
    }
  }
}

529
530
531
void Expression::toList(const std::string &sep) {
  if (name() == sep)
    return;
532
533
534
535
536
537
  Expression term(*this);
  m_terms.resize(1);
  m_terms[0] = term;
  setFunct(sep);
}

538
539
} // API
} // Mantid