sdk/lib/json/json.dart

// Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

#library("dart:json");

// Pure Dart implementation of JSON protocol.

/**
 * Utility class to parse JSON and serialize objects to JSON.
 */
class JSON {
  /**
   * Parses [json] and build the corresponding object.
   */
  static parse(String json) {
    return _JsonParser.parse(json);
  }

  /**
   * Checks validity of JSON source in [str] and returns its text
   * length. Returns 0 if [str] does not begin with a valid JSON
   * object.
   */
  static int length(String str) {
    return _JsonParser.objectLength(str);
  }

  /**
   * Serializes [object] into JSON string.
   */
  static String stringify(Object object) {
    return JsonStringifier.stringify(object);
  }

  /**
   * Serializes [object] into [output] stream.
   */
  static void printOn(Object object, StringBuffer output) {
    return JsonStringifier.printOn(object, output);
  }
}

//// Implementation ///////////////////////////////////////////////////////////

// TODO(ajohnsen): Introduce when we have a common exception interface for json.
class JSONParseException {
  JSONParseException(int position, String message) :
      position = position,
      message = 'JSONParseException: $message, at offset $position';

  String toString() => message;

  final String message;
  final int position;
}

class _JsonParser {
  static final int BACKSPACE = 8;
  static final int TAB = 9;
  static final int NEW_LINE = 10;
  static final int FORM_FEED = 12;
  static final int CARRIAGE_RETURN = 13;
  static final int SPACE = 32;
  static final int QUOTE = 34;
  static final int PLUS = 43;
  static final int COMMA = 44;
  static final int MINUS = 45;
  static final int DOT = 46;
  static final int SLASH = 47;
  static final int CHAR_0 = 48;
  static final int CHAR_1 = 49;
  static final int CHAR_2 = 50;
  static final int CHAR_3 = 51;
  static final int CHAR_4 = 52;
  static final int CHAR_5 = 53;
  static final int CHAR_6 = 54;
  static final int CHAR_7 = 55;
  static final int CHAR_8 = 56;
  static final int CHAR_9 = 57;
  static final int COLON = 58;
  static final int CHAR_CAPITAL_E = 69;
  static final int LBRACKET = 91;
  static final int BACKSLASH = 92;
  static final int RBRACKET = 93;
  static final int CHAR_B = 98;
  static final int CHAR_E = 101;
  static final int CHAR_F = 102;
  static final int CHAR_N = 110;
  static final int CHAR_R = 114;
  static final int CHAR_T = 116;
  static final int CHAR_U = 117;
  static final int LBRACE = 123;
  static final int RBRACE = 125;

  static final int STRING_LITERAL = QUOTE;
  static final int NUMBER_LITERAL = MINUS;
  static final int NULL_LITERAL = CHAR_N;
  static final int FALSE_LITERAL = CHAR_F;
  static final int TRUE_LITERAL = CHAR_T;

  static final int WHITESPACE = SPACE;

  static final int LAST_ASCII = RBRACE;

  static final String NULL_STRING = "null";
  static final String TRUE_STRING = "true";
  static final String FALSE_STRING = "false";


  static parse(String json) {
    return new _JsonParser._internal(json)._parseToplevel();
  }

  static objectLength(String str) {
    var p = new _JsonParser._internal(str);
    var firstToken = p._token();
    if (firstToken != LBRACE) {
      return 0;
    }
    try {
      p._parseObject();
      assert(p.position <= p.length);
      return p.position;
    } catch (var e) {
      return 0;
    }
  }

  _JsonParser._internal(String json)
      : json = json,
        length = json.length {
    if (tokens !== null) return;

    // Use a list as jump-table, faster then switch and if.
    tokens = new List<int>(LAST_ASCII + 1);
    tokens[TAB] = WHITESPACE;
    tokens[NEW_LINE] = WHITESPACE;
    tokens[CARRIAGE_RETURN] = WHITESPACE;
    tokens[SPACE] = WHITESPACE;
    tokens[CHAR_0] = NUMBER_LITERAL;
    tokens[CHAR_1] = NUMBER_LITERAL;
    tokens[CHAR_2] = NUMBER_LITERAL;
    tokens[CHAR_3] = NUMBER_LITERAL;
    tokens[CHAR_4] = NUMBER_LITERAL;
    tokens[CHAR_5] = NUMBER_LITERAL;
    tokens[CHAR_6] = NUMBER_LITERAL;
    tokens[CHAR_7] = NUMBER_LITERAL;
    tokens[CHAR_8] = NUMBER_LITERAL;
    tokens[CHAR_9] = NUMBER_LITERAL;
    tokens[MINUS] = NUMBER_LITERAL;
    tokens[LBRACE] = LBRACE;
    tokens[RBRACE] = RBRACE;
    tokens[LBRACKET] = LBRACKET;
    tokens[RBRACKET] = RBRACKET;
    tokens[QUOTE] = STRING_LITERAL;
    tokens[COLON] = COLON;
    tokens[COMMA] = COMMA;
    tokens[CHAR_N] = NULL_LITERAL;
    tokens[CHAR_T] = TRUE_LITERAL;
    tokens[CHAR_F] = FALSE_LITERAL;
  }

  _parseToplevel() {
    final result = _parseValue();
    if (_token() !== null) {
      _error('Junk at the end of JSON input');
    }
    return result;
  }

  _parseValue() {
    final int token = _token();
    if (token === null) {
      _error('Nothing to parse');
    }
    switch (token) {
      case STRING_LITERAL: return _parseString();
      case NUMBER_LITERAL: return _parseNumber();
      case NULL_LITERAL: return _expectKeyword(NULL_STRING, null);
      case FALSE_LITERAL: return _expectKeyword(FALSE_STRING, false);
      case TRUE_LITERAL: return _expectKeyword(TRUE_STRING, true);
      case LBRACE: return _parseObject();
      case LBRACKET: return _parseList();

      default:
        _error('Unexpected token');
    }
  }

  Object _expectKeyword(String word, Object value) {
    for (int i = 0; i < word.length; i++) {
      // Implicit end check in _char().
      if (_char() != word.charCodeAt(i)) _error("Expected keyword '$word'");
      position++;
    }
    return value;
  }

  _parseObject() {
    final object = {};

    position++;  // Eat '{'.

    if (!_isToken(RBRACE)) {
      while (true) {
        final String key = _parseString();
        if (!_isToken(COLON)) _error("Expected ':' when parsing object");
        position++;
        object[key] = _parseValue();

        if (!_isToken(COMMA)) break;
        position++;  // Skip ','.
      };

      if (!_isToken(RBRACE)) _error("Expected '}' at end of object");
    }
    position++;

    return object;
  }

  _parseList() {
    final list = [];

    position++;  // Eat '['.

    if (!_isToken(RBRACKET)) {
      while (true) {
        list.add(_parseValue());

        if (!_isToken(COMMA)) break;
        position++;
      };

      if (!_isToken(RBRACKET)) _error("Expected ']' at end of list");
    }
    position++;

    return list;
  }

  String _parseString() {
    if (!_isToken(STRING_LITERAL)) _error("Expected string literal");

    position++;  // Eat '"'.

    List<int> charCodes = new List<int>();
    while (true) {
      int c = _char();
      if (c == QUOTE) {
        position++;
        break;
      }
      if (c == BACKSLASH) {
        position++;
        if (position == length) {
          _error('\\ at the end of input');
        }

        switch (_char()) {
          case QUOTE:
            c = QUOTE;
            break;
          case BACKSLASH:
            c = BACKSLASH;
            break;
          case SLASH:
            c = SLASH;
            break;
          case CHAR_B:
            c = BACKSPACE;
            break;
          case CHAR_N:
            c = NEW_LINE;
            break;
          case CHAR_R:
            c = CARRIAGE_RETURN;
            break;
          case CHAR_F:
            c = FORM_FEED;
            break;
          case CHAR_T:
            c = TAB;
            break;
          case CHAR_U:
            if (position + 5 > length) {
              _error('Invalid unicode esacape sequence');
            }
            final codeString = json.substring(position + 1, position + 5);
            try {
              c = Math.parseInt('0x${codeString}');
            } catch (var e) {
              _error('Invalid unicode esacape sequence');
            }
            position += 4;
            break;
          default:
            _error('Invalid esacape sequence in string literal');
        }
      }
      charCodes.add(c);
      position++;
    }

    return new String.fromCharCodes(charCodes);
  }

  num _parseNumber() {
    if (!_isToken(NUMBER_LITERAL)) _error('Expected number literal');

    final int startPos = position;
    int char = _char();
    if (char === MINUS) char = _nextChar();
    if (char === CHAR_0) {
      char = _nextChar();
    } else if (_isDigit(char)) {
      char = _nextChar();
      while (_isDigit(char)) char = _nextChar();
    } else {
      _error('Expected digit when parsing number');
    }

    bool isInt = true;
    if (char === DOT) {
      char = _nextChar();
      if (_isDigit(char)) {
        char = _nextChar();
        isInt = false;
        while (_isDigit(char)) char = _nextChar();
      } else {
        _error('Expected digit following comma');
      }
    }

    if (char === CHAR_E || char === CHAR_CAPITAL_E) {
      char = _nextChar();
      if (char === MINUS || char === PLUS) char = _nextChar();
      if (_isDigit(char)) {
        char = _nextChar();
        isInt = false;
        while (_isDigit(char)) char = _nextChar();
      } else {
        _error('Expected digit following \'e\' or \'E\'');
      }
    }

    String number = json.substring(startPos, position);
    if (isInt) {
      return Math.parseInt(number);
    } else {
      return Math.parseDouble(number);
    }
  }

  bool _isChar(int char) {
    if (position >= length) return false;
    return json.charCodeAt(position) == char;
  }

  bool _isDigit(int char) {
    return char >= CHAR_0 && char <= CHAR_9;
  }

  bool _isToken(int tokenKind) => _token() == tokenKind;

  int _char() {
    if (position >= length) {
      _error('Unexpected end of JSON stream');
    }
    return json.charCodeAt(position);
  }

  int _nextChar() {
    position++;
    if (position >= length) return 0;
    return json.charCodeAt(position);
  }

  int _token() {
    while (true) {
      if (position >= length) return null;
      int char = json.charCodeAt(position);
      int token = tokens[char];
      if (token === WHITESPACE) {
        position++;
        continue;
      }
      if (token === null) return 0;
      return token;
    }
  }

  void _error(String message) {
    throw message;
  }

  final String json;
  final int length;
  int position = 0;
  static List<int> tokens;
}

// TODO: proper base class.
class JsonUnsupportedObjectType {
  const JsonUnsupportedObjectType();
}

class JsonStringifier {
  static String stringify(final object) {
    StringBuffer output = new StringBuffer();
    JsonStringifier stringifier = new JsonStringifier._internal(output);
    stringifier._stringify(object);
    return output.toString();
  }

  static void printOn(final object, StringBuffer output) {
    JsonStringifier stringifier = new JsonStringifier._internal(output);
    stringifier._stringify(object);
  }

  JsonStringifier._internal(this._sb)
      : _seen = [];

  StringBuffer _sb;
  List<Object> _seen;  // TODO: that should be identity set.

  static String _numberToString(num x) {
    // TODO: need some more investigation what to do with precision
    // of double values.
    if (x is int) {
      return x.toString();
    } else if (x is double) {
      return x.toString();
    } else {
      return x.toDouble().toString();
    }
  }

  // ('0' + x) or ('a' + x - 10)
  static int _hexDigit(int x) => x < 10 ? 48 + x : 87 + x;

  static void _escape(StringBuffer sb, String s) {
    final int length = s.length;
    bool needsEscape = false;
    final charCodes = new List<int>();
    for (int i = 0; i < length; i++) {
      int charCode = s.charCodeAt(i);
      if (charCode < 32) {
        needsEscape = true;
        charCodes.add(_JsonParser.BACKSLASH);
        switch (charCode) {
        case _JsonParser.BACKSPACE:
          charCodes.add(_JsonParser.CHAR_B);
          break;
        case _JsonParser.TAB:
          charCodes.add(_JsonParser.CHAR_T);
          break;
        case _JsonParser.NEW_LINE:
          charCodes.add(_JsonParser.CHAR_N);
          break;
        case _JsonParser.FORM_FEED:
          charCodes.add(_JsonParser.CHAR_F);
          break;
        case _JsonParser.CARRIAGE_RETURN:
          charCodes.add(_JsonParser.CHAR_R);
          break;
        default:
          charCodes.add(_JsonParser.CHAR_U);
          charCodes.add(_hexDigit((charCode >> 12) & 0xf));
          charCodes.add(_hexDigit((charCode >> 8) & 0xf));
          charCodes.add(_hexDigit((charCode >> 4) & 0xf));
          charCodes.add(_hexDigit(charCode & 0xf));
          break;
        }
      } else if (charCode == _JsonParser.QUOTE ||
          charCode == _JsonParser.BACKSLASH) {
        needsEscape = true;
        charCodes.add(_JsonParser.BACKSLASH);
        charCodes.add(charCode);
      } else {
        charCodes.add(charCode);
      }
    }
    sb.add(needsEscape ? new String.fromCharCodes(charCodes) : s);
  }

  void _checkCycle(final object) {
    // TODO: use Iterables.
    for (int i = 0; i < _seen.length; i++) {
      if (_seen[i] === object) {
        throw 'Cyclic structure';
      }
    }
    _seen.add(object);
  }

  void _stringify(final object) {
    if (object is num) {
      // TODO: use writeOn.
      _sb.add(_numberToString(object));
      return;
    } else if (object === true) {
      _sb.add('true');
      return;
    } else if (object === false) {
      _sb.add('false');
       return;
    } else if (object === null) {
      _sb.add('null');
      return;
    } else if (object is String) {
      _sb.add('"');
      _escape(_sb, object);
      _sb.add('"');
      return;
    } else if (object is List) {
      _checkCycle(object);
      List a = object;
      _sb.add('[');
      if (a.length > 0) {
        _stringify(a[0]);
        // TODO: switch to Iterables.
        for (int i = 1; i < a.length; i++) {
          _sb.add(',');
          _stringify(a[i]);
        }
      }
      _sb.add(']');
      _seen.removeLast();
      return;
    } else if (object is Map) {
      _checkCycle(object);
      Map<String, Object> m = object;
      _sb.add('{');
      bool first = true;
      m.forEach((String key, Object value) {
        if (!first) {
          _sb.add(',"');
        } else {
          _sb.add('"');
        }
        _escape(_sb, key);
        _sb.add('":');
        _stringify(value);
        first = false;
      });
      _sb.add('}');
      _seen.removeLast();
      return;
    } else {
      throw const JsonUnsupportedObjectType();
    }
  }
}