angular-cn/modules/change_detection/src/record.js

import {ProtoWatchGroup, WatchGroup} from './watch_group';
import {FIELD} from 'facade/lang';
import {FieldGetterFactory} from './facade';

/**
 * For now we are dropping expression coalescence. We can always add it later, but
 * real world numbers show that it does not provide significant benefits.
 */
export class ProtoRecord {
  @FIELD('final watchGroup:wg.ProtoWatchGroup')
  @FIELD('final fieldName:String')
  /// order list of all records. Including head/tail markers
  @FIELD('next:ProtoRecord')
  @FIELD('prev:ProtoRecord')
  // Opaque data which will be the target of notification.
  // If the object is instance of Record, than it it is directly processed
  // Otherwise it is the context used by  WatchGroupDispatcher.
  @FIELD('memento')
  constructor(watchGroup:ProtoWatchGroup, fieldName:string, dispatchMemento) {
    this.watchGroup = watchGroup;
    this.fieldName = fieldName;
    this.dispatchMemento = dispatchMemento;
    this.next = null;
    this.prev = null;
 }
}


/**
 * Represents a Record for keeping track of changes. A change is a difference between previous
 * and current value.
 *
 * By default changes are detected using dirty checking, but a notifier can be present which can
 * notify the records of changes by means other than dirty checking. For example Object.observe
 * or events on DOM elements.
 *
 * DESIGN NOTES:
 *  - No inheritance allowed so that code is monomorphic for performance.
 *  - Atomic watch operations
 *  - Defaults to dirty checking
 *  - Keep this object as lean as possible. (Lean in number of fields)
 */
export class Record {
  @FIELD('final watchGroup:WatchGroup')
  @FIELD('final protoRecord:ProtoRecord')
  /// order list of all records. Including head/tail markers
  @FIELD('_next:Record')
  @FIELD('_prev:Record')
  /// next record to dirty check
  @FIELD('_checkNext:Record')
  @FIELD('_checkPrev:Record')
  // next notifier
  @FIELD('_notifierNext:Record')

  @FIELD('_mode:int')
  @FIELD('_context')
  @FIELD('_getter')
  @FIELD('_arguments')
  @FIELD('previousValue')
  constructor(watchGroup/*:wg.WatchGroup*/, protoRecord:ProtoRecord) {
    this.protoRecord = protoRecord;
    this.watchGroup = watchGroup;
    this.next = null;
    this.prev = null;
    this.checkNext = null;
    this.checkPrev = null;
    this.notifierNext = null;

    this.mode = MODE_STATE_MARKER;
    this.context = null;
    this.getter = null;
    this.arguments = null;
    this.previousValue = null;
    this.currentValue = null;
  }

  check():boolean {
    var mode = this.mode;
    var state = mode & MODE_MASK_STATE;
    var notify = mode & MODE_MASK_NOTIFY;
    var newValue;
    switch (state) {
      case MODE_STATE_MARKER:
        return false;
      case MODE_STATE_PROPERTY:
        newValue = this.getter(this.context);
        break;
      case MODE_STATE_INVOKE_CLOSURE:
        newValue = this.context(this.arguments);
        break;
      case MODE_STATE_INVOKE_METHOD:
        newValue = this.getter(this.context, this.arguments);
        break;
      case MODE_STATE_MAP:
        throw 'not implemented';
      case MODE_STATE_LIST:
        throw 'not implemented';
      default:
        throw 'not implemented';
    }


    var previousValue = this.currentValue;
    if (previousValue === this) {
      // When the record is checked for the first time we should always notify
      this.currentValue = newValue;
      this.previousValue = previousValue = null;
    } else {
      this.currentValue = newValue;
      this.previousValue = previousValue;

      if (isSame(previousValue, newValue)) return false;

      // In Dart, we can have `str1 !== str2` but `str1 == str2`
      if (previousValue instanceof String &&
          newValue instanceof String &&
          previousValue == newValue) {
        return false
      }
    }


    // todo(vicb): compute this info only once in ctor ? (add a bit in mode not to grow the mem req)
    if (this.protoRecord.dispatchMemento === null) {
      // forward propagate to the next record
    } else {
      // notify through dispatcher
      this.watchGroup.dispatcher.onRecordChange(this, this.protoRecord.dispatchMemento);
    }

    return true;
  }

  setContext(context) {
    // use `this` as a marker for a fresh record
    this.currentValue = this;
    this.mode = MODE_STATE_PROPERTY;
    this.context = context;
    var factory = new FieldGetterFactory();
    this.getter = factory.getter(context, this.protoRecord.fieldName);
  }

}

// The mode is divided into two parts. Which notification mechanism
// to use and which dereference mode to execute.

// We use dirty checking aka no notification
const MODE_MASK_NOTIFY = 0xFF00;
// Encodes the state of dereference
const MODE_MASK_STATE = 0x00FF;

const MODE_PLUGIN_DIRTY_CHECK = 0x0000;
const MODE_STATE_MARKER = 0x0000;

/// _context[_protoRecord.propname] => _getter(_context)
const MODE_STATE_PROPERTY = 0x0001;
/// _context(_arguments)
const MODE_STATE_INVOKE_CLOSURE = 0x0002;
/// _getter(_context, _arguments)
const MODE_STATE_INVOKE_METHOD = 0x0003;

/// _context is Map => _previousValue is MapChangeRecord
const MODE_STATE_MAP = 0x0004;
/// _context is Array/List/Iterable => _previousValue = ListChangeRecord
const MODE_STATE_LIST = 0x0005;

function isSame(a, b) {
  if (a === b) return true;
  if ((a !== a) && (b !== b)) return true;
  return false;
}