Add date formatting and parsing code.

lib/i18n/_date_format_field.dart

+// Copyright (c) 2012, 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.
+
+/**
+ * This is a private class internal to DateFormat which is used for formatting
+ * particular fields in a template. e.g. if the format is hh:mm:ss then the
+ * fields would be "hh", ":", "mm", ":", and "ss". Each type of field knows
+ * how to format that portion of a date.
+ */
+class _DateFormatField{

[Emily Fortuna, 2012/08/06 22:43:00]

space between _DateFormatField and {

[Alan Knight, 2012/08/08 00:47:44]

Done.

+  /** The format string that defines us, e.g. "hh" */
+  String pattern;
+
+  /** The DateFormat that we are part of.*/
+  DateFormat parent;
+
+  _DateFormatField(this.pattern, this.parent);
+
+  /**
+   * Return the width of [pattern]. Different widths represent different
+   * formatting options. See the comment for DateFormat for details.
+   */
+  int get width() => pattern.length;
+
+  String fullPattern() => pattern;
+
+  String toString() => pattern;
+
+  /** Format date according to our specification and return the result. */
+  String format(Date date) {

[Emily Fortuna, 2012/08/06 22:43:00]

String format(Date date) => pattern; (?)
seems like this is unimplemented... Should we add a TODO?

[Alan Knight, 2012/08/08 00:47:44]

It's a default implementation in the superclass that works for the two literal
pattern subclasses. The field pattern subclass overrides. Added a comment. Can
push it down into the two subclasses if you think that's clearer.

+    return pattern;
+  }
+
+  abstract void parse(_Stream input, _DateBuilder dateFields);
+
+  /** Parse a literal field. We just look for the exact input. */
+  void parseLiteral(_Stream input) {
+    var found = input.read(width);
+    if (found != pattern) throw

[Emily Fortuna, 2012/08/06 22:43:00]

if your "if" statement is going to span more than one line, use {}. Don't line
break + 4 spaces.

[Alan Knight, 2012/08/08 00:47:44]

Done.

+        new FormatException(input, this);
+  }
+}
+
+/**
+ * Represents a literal field - a sequence of characters that doesn't
+ * change according to the date's data. As such, the implementation
+ * is extremely simple.
+ */
+class _DateFormatLiteralField extends _DateFormatField{

[Emily Fortuna, 2012/08/06 22:43:00]

space before { and elsewhere

[Alan Knight, 2012/08/08 00:47:44]

Done.

+
+  _DateFormatLiteralField(pattern,parent): super(pattern,parent);

[Emily Fortuna, 2012/08/06 22:43:00]

give these variables some space to breathe! space after the ,

[Alan Knight, 2012/08/08 00:47:44]

Done.

+
+  parse(_Stream input, _DateBuilder dateFields) {
+    return parseLiteral(input);
+  }
+}
+
+/**
+ * Represents a literal field with quoted characters in it. This is
+ * only slightly more complex than a _DateFormatLiteralField.
+ */
+class _DateFormatQuotedField extends _DateFormatField{
+
+  String _fullPattern;
+
+  String fullPattern() => _fullPattern;
+
+  _DateFormatQuotedField(pattern,parent): super(pattern,parent) {
+    _fullPattern = pattern;
+    patchQuotes();
+  }
+
+  parse(_Stream input, _DateBuilder dateFields) {
+    return parseLiteral(input);
+  }
+
+  void patchQuotes() {
+     if (pattern == "''") {
+      pattern = "'";
+    } else {
+      pattern = pattern.substring(1,pattern.length - 1);
+      var twoEscapedQuotes = new RegExp("\'\'");

[Emily Fortuna, 2012/08/06 22:43:00]

nit: could also be written as new RegExp(@"''");

[Alan Knight, 2012/08/08 00:47:44]

Done.

+      pattern = pattern.replaceAll(twoEscapedQuotes, "'");
+    }
+  }
+}
+
+/*
+ * Represents a field in the pattern that formats some aspect of the
+ * date. Consists primarily of a switch on the particular pattern characters
+ * to determine what to do.
+ */
+class _DateFormatPatternField extends _DateFormatField {
+
+  _DateFormatPatternField(pattern,parent): super(pattern,parent);

[Emily Fortuna, 2012/08/06 22:43:00]

space between parameters:
"pattern, parent"

[Alan Knight, 2012/08/08 00:47:44]

Done.

+
+  /** Format date according to our specification and return the result. */
+  String format(Date date) {
+      return formatField(date);
+  }
+
+  /**
+   * Parse the date according to our specification and put the result
+   * into the correct place in dateFields.
+   */
+  void parse(_Stream input, _DateBuilder dateFields) {
+    parseField(input,dateFields);
+  }
+
+  /**
+   * Parse a field representing part of a date pattern. Note that we do not
+   * return a value, but rather build up the result in [builder].
+   */
+  void parseField(_Stream input, _DateBuilder builder) {
+   try {
+     switch(pattern[0]) {
+       case 'a': parseAmPm(input,builder); break;
+       case 'c': parseStandaloneDay(input); break;
+       case 'd': handleNumericField(input,builder.setDay); break; // day
+       case 'E': parseDayOfWeek(input); break;
+       case 'G': break; // era
+       case 'h': parse1To12Hours(input,builder); break;
+       case 'H': handleNumericField(input,builder.setHour); break; // hour 0-23
+       case 'K': handleNumericField(input,builder.setHour); break; //hour 0-11
+       case 'k': handleNumericField(input,builder.setHour,-1); break; //hr 1-24
+       case 'L': parseStandaloneMonth(input,builder); break;
+       case 'M': parseMonth(input,builder); break;
+       case 'm': handleNumericField(input,builder.setMinute); break; // minutes
+       case 'Q': break; // quarter
+       case 'S': handleNumericField(input,builder.setFractionalSecond); break;
+       case 's': handleNumericField(input,builder.setSecond); break;
+       case 'v': break; // time zone id
+       case 'y': handleNumericField(input,builder.setYear); break;
+       case 'z': break; // time zone
+       case 'Z': break; // time zone RFC
+       default: return;
+     }
+   } catch (var e) {throw new FormatException(input,this);}
+ }
+
+  /** Formatting logic if we are of type FIELD */
+  String formatField(Date date) {
+     switch (pattern[0]) {
+      case 'a': return formatAmPm(date);
+      case 'c': return formatStandaloneDay(date);
+      case 'd': return formatDayOfMonth(date);
+      case 'E': return formatDayOfWeek(date);
+      case 'G': return formatEra(date);
+      case 'h': return format1To12Hours(date);
+      case 'H': return format0To23Hours(date);
+      case 'K': return format0To11Hours(date);
+      case 'k': return format24Hours(date);
+      case 'L': return formatStandaloneMonth(date);
+      case 'M': return formatMonth(date);
+      case 'm': return formatMinutes(date);
+      case 'Q': return formatQuarter(date);
+      case 'S': return formatFractionalSeconds(date);
+      case 's': return formatSeconds(date);
+      case 'v': return formatTimeZoneId(date);
+      case 'y': return formatYear(date);
+      case 'z': return formatTimeZone(date);
+      case 'Z': return formatTimeZoneRFC(date);
+      default: return '';
+    }
+  }
+
+  /** Return the symbols for our current locale. */
+  DateSymbols get symbols() => dateTimeSymbols[parent.locale];
+
+  formatEra(Date date) {
+    var era = date.year > 0 ? 1 : 0;
+    return width >= 4 ? symbols.ERANAMES[era] :
+                        symbols.ERAS[era];
+  }
+
+  formatYear(Date date) {
+    // TODO(alanknight): Proper handling of years <= 0
+    var year = date.year;
+    if (year < 0) {
+      year = -year;
+    }
+    return width == 2 ? padTo(2, year % 100) : year.toString();
+  }
+
+  /**
+   * We are given [input] as a stream from which we want to read a date. We
+   * can't dynamically build up a date, so we are given a list [dateFields] of
+   * the constructor arguments and an [position] at which to set it
+   * (year,month,day,hour,minute,second,fractionalSecond)
+   * then after all parsing is done we construct a date from the arguments.
+   * This method handles reading any of the numeric fields. The [offset]
+   * argument allows us to compensate for zero-based versus one-based values.
+   */
+  void handleNumericField(
+                   _Stream input,

[Emily Fortuna, 2012/08/06 22:43:00]

curious indentation

[Alan Knight, 2012/08/08 00:47:44]

Done. It fits into 80 characters now, so no need to break at all.

+                   Function setter,
+                   [int offset = 0]) {
+    var result = input.nextInteger();
+    setter(result + offset);
+  }
+
+  /**
+   * We are given [input] as a stream from which we want to read a date. We
+   * can't dynamically build up a date, so we are given a list [dateFields] of
+   * the constructor arguments and an [position] at which to set it
+   * (year,month,day,hour,minute,second,fractionalSecond)
+   * then after all parsing is done we construct a date from the arguments.
+   * This method handles reading any of string fields from an enumerated set.
+   */
+   int parseEnumeratedString(_Stream input, List possibilities) {
+     var results = new _Stream(possibilities).findIndexes(
+       (each) => input.peek(each.length) == each);
+     if (results.isEmpty()) throw new FormatException(input,this);
+     results.sort(
+       (a, b) => possibilities[a].length.compareTo(possibilities[b].length));
+     var longestResult = results.last();
+     input.read(possibilities[longestResult].length);
+     return longestResult;
+     }
+
+  String formatMonth(Date date) {
+    switch (width) {
+      case 5: return symbols.NARROWMONTHS[date.month-1];
+      case 4: return symbols.MONTHS[date.month-1];
+      case 3: return symbols.SHORTMONTHS[date.month-1];
+      default:
+        return padTo(width, date.month);
+    }
+  }
+
+  void parseMonth(input,dateFields) {
+    var possibilities;
+    switch(width) {
+      case 5: possibilities = symbols.NARROWMONTHS; break;
+      case 4: possibilities = symbols.MONTHS; break;
+      case 3: possibilities = symbols.SHORTMONTHS; break;
+      default: return handleNumericField(input,dateFields.setMonth);
+    }
+    dateFields.month = parseEnumeratedString(input,possibilities) + 1;
+  }
+
+  String format24Hours(Date date) {
+    return padTo(width, date.hour);
+  }
+
+  String formatFractionalSeconds(Date date) {
+    // Always print at least 3 digits. If the width is greater, append 0s
+    var basic = padTo(3,date.millisecond);
+    if (width - 3 > 0) {
+      var extra = padTo(width - 3, 0);
+      return basic.concat(extra);
+    } else {
+      return basic;
+    }
+  }
+
+  String formatAmPm(Date date) {
+    var hours = date.hour;
+    var index = (date.hour >= 12) && (date.hour < 24) ? 1 : 0;
+    var ampm = symbols.AMPMS;
+    return ampm[index];
+  }
+
+  void parseAmPm(input,dateFields) {
+    // If we see a "PM" note it in an extra field.
+    var ampm = parseEnumeratedString(input,symbols.AMPMS);
+    if (ampm == 1) dateFields.pm = true;
+  }
+
+  String format1To12Hours(Date date) {
+    var hours = date.hour;
+    if (date.hour > 12) hours = hours - 12;
+    if (hours == 0) hours = 12;
+    return padTo(width,hours);
+  }
+
+  void parse1To12Hours(_Stream input, _DateBuilder dateFields) {
+    handleNumericField(input,dateFields.setHour);
+    if (dateFields.hour == 12) dateFields.hour = 0;
+  }
+
+  String format0To11Hours(Date date) {
+    return padTo(width,date.hour % 12);
+  }
+
+  String format0To23Hours(Date date) {
+    return padTo(width,date.hour);
+  }
+
+  String formatStandaloneDay(Date date) {
+    switch (width) {
+      case 5: return symbols.STANDALONENARROWWEEKDAYS[date.weekday % 7];
+      case 4: return symbols.STANDALONEWEEKDAYS[date.weekday % 7];
+      case 3: return symbols.STANDALONESHORTWEEKDAYS[date.weekday % 7];
+      default:
+        return padTo(1, date.day);
+    }
+  }
+
+  void parseStandaloneDay(_Stream input) {
+    // This is ignored, but we still have to skip over it the correct amount.
+    var possibilities;
+    switch(width) {
+      case 5: possibilities = symbols.STANDALONENARROWWEEKDAYS; break;
+      case 4: possibilities = symbols.STANDALONEWEEKDAYS; break;
+      case 3: possibilities = symbols.STANDALONESHORTWEEKDAYS; break;
+      default: return handleNumericField(input,(x)=>x);
+    }
+    parseEnumeratedString(input,possibilities);
+  }
+
+  String formatStandaloneMonth(Date date) {
+  switch (width) {
+    case 5:
+      return symbols.STANDALONENARROWMONTHS[date.month-1];
+    case 4:
+      return symbols.STANDALONEMONTHS[date.month-1];
+    case 3:
+      return symbols.STANDALONESHORTMONTHS[date.month-1];
+    default:
+      return padTo(width, date.month);
+    }
+  }
+
+  void parseStandaloneMonth(input,dateFields) {
+    var possibilities;
+    switch(width) {
+      case 5: possibilities = symbols.STANDALONENARROWMONTHS; break;
+      case 4: possibilities = symbols.STANDALONEMONTHS; break;
+      case 3: possibilities = symbols.STANDALONESHORTMONTHS; break;
+      default: return handleNumericField(input,dateFields.setMonth);
+    }
+    dateFields.month = parseEnumeratedString(input,possibilities) + 1;
+  }
+
+  String formatQuarter(Date date) {
+    var quarter = (date.month / 3).truncate().toInt();
+    if (width < 4) {
+      return symbols.SHORTQUARTERS[quarter];
+    } else {
+      return symbols.QUARTERS[quarter];
+    }
+  }
+  String formatDayOfMonth(Date date) {
+    return padTo(width,date.day);
+  }
+
+  String formatDayOfWeek(Date date) {
+    // Note that Dart's weekday returns 1 for Monday and 7 for Sunday.
+    return (width >= 4 ? symbols.WEEKDAYS :
+                        symbols.SHORTWEEKDAYS)[(date.weekday) % 7];
+  }
+
+  void parseDayOfWeek(_Stream input) {
+    // This is IGNORED, but we still have to skip over it the correct amount.
+    var possibilities = width >= 4 ? symbols.WEEKDAYS : symbols.SHORTWEEKDAYS;
+    parseEnumeratedString(input,possibilities);
+  }
+
+  String formatMinutes(Date date) {
+    return padTo(width,date.minute);
+  }
+
+  String formatSeconds(Date date) {
+    return padTo(width,date.second);
+  }
+
+  String formatTimeZoneId(Date date) {
+    // TODO(alanknight): implement time zone support
+    throw new NotImplementedException();
+  }
+
+  String formatTimeZone(Date date) {
+    throw new NotImplementedException();
+  }
+
+  String formatTimeZoneRFC(Date date) {
+    throw new NotImplementedException();
+  }
+
+ /**
+  * Return a string representation of the object padded to the left with
+  * zeros. Primarily useful for numbers.
+  */
+  String padTo(int width, Object toBePrinted) {
+    var basicString = toBePrinted.toString();
+    if (basicString.length >= width) return basicString;
+    var buffer = new StringBuffer();
+    for (var i = 0; i < width - basicString.length; i++) {
+      buffer.add('0');
+     }
+    buffer.add(basicString);
+    return buffer.toString();
+  }
+}