coveo-search-ui/src/magicbox/Expression/ExpressionRef.ts

Coveo JavaScript Search Framework

import { Expression } from './Expression';
import { Result } from '../Result/Result';
import { Grammar } from '../Grammar';
import { RefResult } from '../Result/RefResult';
import { ExpressionEndOfInput } from './ExpressionEndOfInput';
import _ = require('underscore');

export class ExpressionRef implements Expression {
  constructor(public ref: string, public occurrence: string | number, public id: string, public grammar: Grammar) {}

  parse(input: string, end: boolean): Result {
    var ref = this.grammar.getExpression(this.ref);
    if (ref == null) {
      throw new Error('Expression not found:' + this.ref);
    }
    if (this.occurrence == '?' || this.occurrence == null) {
      return this.parseOnce(input, end, ref);
    } else {
      return this.parseMany(input, end, ref);
    }
  }

  parseOnce(input: string, end: boolean, ref: Expression): Result {
    var refResult = ref.parse(input, end);
    var success = refResult.isSuccess();
    if (!success && this.occurrence == '?') {
      if (end) {
        // if end was found
        if (input.length == 0) {
          return new RefResult([], this, input, refResult);
        }
        // if end was not found and all error expression are EndOfInput, reparse with end = false.
        if (_.all(refResult.getBestExpect(), expect => expect.expression == ExpressionEndOfInput)) {
          return new RefResult([new Result(null, ExpressionEndOfInput, input)], this, input, refResult);
        }
        return refResult;
      }
      // the ref is not required and it do not need to end the input
      return new RefResult([], this, input, null);
    }
    return new RefResult([refResult], this, input, success ? null : refResult);
  }

  parseMany(input: string, end: boolean, ref: Expression) {
    var subResults: Result[] = [];
    var subResult: Result;
    var subInput = input;
    var success: boolean;

    // try to parse until it do not match, do not manage the end yet
    do {
      subResult = ref.parse(subInput, false);
      success = subResult.isSuccess();
      if (success) {
        subResults.push(subResult);
        subInput = subInput.substr(subResult.getLength());
      }
    } while (success && subResult.input != subInput);

    // minimal occurance of a ref
    var requiredOccurance = _.isNumber(this.occurrence) ? <number>this.occurrence : this.occurrence == '+' ? 1 : 0;

    // if the minimal occurance is not reached add the fail result to the list
    if (subResults.length < requiredOccurance) {
      subResults.push(subResult);
    } else if (end) {
      // if there is at least one match, check if the last match is at the end
      if (subResults.length > 0) {
        var last = _.last(subResults);
        subResult = ref.parse(last.input, true);
        if (subResult.isSuccess()) {
          // if successful, replace the last subResult by the one with end
          subResults[subResults.length - 1] = subResult;
        } else {
          // if not successful, we keep the last successful result and we add a endOfInputExpected Result after it
          subResults.push(new Result(null, ExpressionEndOfInput, last.input.substr(last.getLength())));
          // we parse back the last with the length of the successful Result (at the same place we put the endOfInputExpected) and put it in failAttempt
          subResult = ref.parse(last.input.substr(last.getLength()), true);
        }
      } else if (input.length != 0) {
        // if there is no result at all and we are not at the end, return a endOfInputExpected Result
        var endOfInput = new Result(null, ExpressionEndOfInput, input);
        return new RefResult([endOfInput], this, input, subResult);
      }
    }
    return new RefResult(subResults, this, input, subResult);
  }

  public toString() {
    return this.id;
  }
}