stream-tokenizer.h

Go to the documentation of this file.

// Copyright 2014, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//   * Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//   * Redistributions in binary form must reproduce the above
//     copyright notice, this list of conditions and the following disclaimer
//     in the documentation and/or other materials provided with the
//     distribution.
//   * Neither the name of Google Inc. nor the names of its
//     contributors may be used to endorse or promote products derived from
//     this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// -----------------------------------------------------------------------------
//
//

#ifndef INFACT_STREAM_TOKENIZER_H_
#define INFACT_STREAM_TOKENIZER_H_

#include <iostream>
#include <set>
#include <sstream>
#include <stdexcept>
#include <string>
#include <string.h>
#include <vector>

#include "error.h"

namespace infact {

using std::istream;
using std::istringstream;
using std::ostringstream;
using std::set;
using std::streampos;
using std::string;
using std::vector;
using std::cerr;
using std::endl;

static const char *default_reserved_words[] = {
  "-",
  "nullptr",
  "NULL",
  "import",
  "false",
  "true",
  "bool",
  "int",
  "double",
  "string",
  "bool[]",
  "int[]",
  "double[]",
  "string[]",
};

#define DEFAULT_RESERVED_CHARS "(){},=;/"

class StreamTokenizer {
 public:
  enum TokenType {
    EOF_TYPE,
    RESERVED_CHAR,
    RESERVED_WORD,
    STRING,
    NUMBER,
    IDENTIFIER
  };

  static const char *TypeName(TokenType token_type) {
    static const char *names[] = {
      "EOF", "RESERVED_CHAR", "RESERVED_WORD", "STRING", "NUMBER", "IDENTIFIER"
    };
    return names[token_type];
  }

  struct Token {
    string tok;
    TokenType type;

    // The following three fields capture information about the underlying
    // byte stream at the time this token was read from it.

    size_t start;
    size_t line_number;
    size_t line_start_pos;
    size_t curr_pos;
  };

  StreamTokenizer(istream &is,
                  const char *reserved_chars = DEFAULT_RESERVED_CHARS) :
      is_(is) {
    Init(reserved_chars);
  }

  StreamTokenizer(const string &s,
                  const char *reserved_chars = DEFAULT_RESERVED_CHARS) :
      sstream_(s), is_(sstream_) {
    Init(reserved_chars);
  }

  void set_reserved_words(set<string> &reserved_words) {
    reserved_words_ = reserved_words;
  }

  virtual ~StreamTokenizer() {
    delete[] reserved_chars_;
  }

  string str() { return oss_.str(); }

  size_t tellg() const {
    return HasPrev() ? token_[next_token_idx_ - 1].curr_pos : 0;
  }

  size_t line_number() const {
    return HasNext() ? token_[next_token_idx_].line_number : line_number_;
  }

  string line();

  size_t line_start() {
    return HasNext() ? token_[next_token_idx_].line_start_pos : 0;
  }

  bool HasNext() const { return next_token_idx_ < token_.size(); }

  bool HasPrev() const { return next_token_idx_ > 0; }

  string PeekPrev() const {
    return HasPrev() ? token_[next_token_idx_ - 1].tok : "";
  }

  size_t PeekPrevTokenLineStart() const {
    return HasPrev() ? token_[next_token_idx_ - 1].line_start_pos : 0;
  }

  size_t PeekPrevTokenStart() const {
    return HasPrev() ? token_[next_token_idx_ - 1].start : 0;
  }

  TokenType PeekPrevTokenType() const {
    return HasPrev() ? token_[next_token_idx_ - 1].type : EOF_TYPE;
  }

  string Next() {
    if (!HasNext()) {
      Error("invoking StreamTokenizer::Next when HasNext returns false");
    }

    size_t curr_token_idx = next_token_idx_;

    // Try to get the next token of the stream if we're about to run out of
    // tokens.
    if (!eof_reached_ && next_token_idx_ + 1 == token_.size()) {
      Token next;
      if (GetNext(&next)) {
        token_.push_back(next);
      }
    }
    // Ensure that we only advance if we haven't already reached token_.size().
    if (next_token_idx_ < token_.size()) {
      ++next_token_idx_;
    }

    return token_[curr_token_idx].tok;
  }

  void Rewind() {
    next_token_idx_ = 0;
  }

  void Rewind(size_t num_tokens) {
    // Cannot rewind more than the number of tokens read so far.
    if (num_tokens > next_token_idx_) {
      num_tokens = next_token_idx_;
    }
    next_token_idx_ -= num_tokens;
  }

  void Putback() {
    Rewind(1);
  }

  size_t PeekTokenStart() const {
    return HasNext() ? token_[next_token_idx_].start : num_read_;
  }

  TokenType PeekTokenType() const {
    return HasNext() ? token_[next_token_idx_].type : EOF_TYPE;
  }

  size_t PeekTokenLineNumber() const {
    return HasNext() ? token_[next_token_idx_].line_number : line_number_;
  }

  string Peek() const { return HasNext() ? token_[next_token_idx_].tok : ""; }

 private:
  void Init(const char *reserved_chars) {
    num_reserved_chars_ = strlen(reserved_chars);
    reserved_chars_ = new char[num_reserved_chars_ + 1];
    strcpy(reserved_chars_, reserved_chars);
    int num_reserved_words = sizeof(default_reserved_words)/sizeof(const char*);
    for (int i = 0; i < num_reserved_words; ++i) {
      reserved_words_.insert(string(default_reserved_words[i]));
    }
    Token next;
    if (GetNext(&next)) {
      token_.push_back(next);
    }
  }

  void ConsumeChar(char c);

  bool ReadChar(char *c);

  bool GetNext(Token *next);

  bool ReservedChar(char c) const {
    for (size_t i = 0; i < num_reserved_chars_; ++i) {
      if (c == reserved_chars_[i]) {
        return true;
      }
    }
    return false;
  }

  // data members

  // The stream itself.
  istringstream sstream_;
  istream &is_;

  // Information about special tokens.
  char *reserved_chars_;
  size_t num_reserved_chars_;
  set<string> reserved_words_;

  // Information about the current state of the underlying byte stream.
  size_t num_read_ = 0;
  size_t line_number_ = 0;
  size_t line_start_pos_ = 0;
  bool eof_reached_ = false;
  ostringstream oss_;

  // The sequence of tokens read so far.
  vector<Token> token_;

  // The index of the next token in this stream in token_, or token_.size()
  // if there are no more tokens left in this stream.  Note that invocations
  // of the Rewind and Putback methods alter this data member.
  size_t next_token_idx_ = 0;
};

}  // namespace infact

#endif