Skip to content

Commit

Permalink
refactor(change_detection): renamed BindingPropagationConfig to Chang…
Browse files Browse the repository at this point in the history
…eDetectorRef
  • Loading branch information
vsavkin committed Apr 15, 2015
1 parent 213dabd commit 8c1adab
Show file tree
Hide file tree
Showing 17 changed files with 89 additions and 73 deletions.
2 changes: 1 addition & 1 deletion modules/angular2/change_detection.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export {DynamicProtoChangeDetector, JitProtoChangeDetector} from './src/change_d
export {BindingRecord} from './src/change_detection/binding_record';
export {DirectiveRecord} from './src/change_detection/directive_record';
export {DynamicChangeDetector} from './src/change_detection/dynamic_change_detector';
export {BindingPropagationConfig} from './src/change_detection/binding_propagation_config';
export {ChangeDetectorRef} from './src/change_detection/change_detector_ref';
export {PipeRegistry} from './src/change_detection/pipes/pipe_registry';
export {uninitialized} from './src/change_detection/change_detection_util';
export {NO_CHANGE, Pipe} from './src/change_detection/pipes/pipe';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {isPresent} from 'angular2/src/facade/lang';
import {List, ListWrapper} from 'angular2/src/facade/collection';
import {BindingPropagationConfig} from './binding_propagation_config';
import {ChangeDetectorRef} from './change_detector_ref';
import {ChangeDetector} from './interfaces';
import {CHECK_ALWAYS, CHECK_ONCE, CHECKED, DETACHED, ON_PUSH} from './constants';

Expand All @@ -9,13 +9,13 @@ export class AbstractChangeDetector extends ChangeDetector {
shadowDomChildren:List;
parent:ChangeDetector;
mode:string;
bindingPropagationConfig:BindingPropagationConfig;
changeDetectorRef:ChangeDetectorRef;

constructor() {
super();
this.lightDomChildren = [];
this.shadowDomChildren = [];
this.bindingPropagationConfig = new BindingPropagationConfig(this);
this.changeDetectorRef = new ChangeDetectorRef(this);
this.mode = null;
}

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -362,13 +362,13 @@ export class ChangeDetectorJITGenerator {
var change = this.changeNames[r.selfIndex];
var pipe = this.pipeNames[r.selfIndex];
var bpc = r.mode === RECORD_TYPE_BINDING_PIPE ? "this.bindingPropagationConfig" : "null";
var cdRef = r.mode === RECORD_TYPE_BINDING_PIPE ? "this.changeDetectorRef" : "null";
var update = this.genUpdateDirectiveOrElement(r);
var addToChanges = this.genAddToChanges(r);
var lastInDirective = this.genNotifyOnChanges(r);
return pipeCheckTemplate(r.selfIndex - 1, context, bpc, pipe, r.name, oldValue, newValue, change,
return pipeCheckTemplate(r.selfIndex - 1, context, cdRef, pipe, r.name, oldValue, newValue, change,
update, addToChanges, lastInDirective);
}
Expand Down
45 changes: 45 additions & 0 deletions modules/angular2/src/change_detection/change_detector_ref.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import {ChangeDetector} from './interfaces';
import {CHECK_ONCE, DETACHED, CHECK_ALWAYS} from './constants';

/**
* Controls change detection.
*
* [ChangeDetectorRef] allows requesting checks for detectors that rely on observables. It also allows detaching and
* attaching change detector subtrees.
*
* @exportedAs angular2/change_detection
*/
export class ChangeDetectorRef {
_cd:ChangeDetector;

constructor(cd:ChangeDetector) {
this._cd = cd;
}

/**
* Request to check all ON_PUSH ancestors.
*/
requestCheck() {
this._cd.markPathToRootAsCheckOnce();
}

/**
* Detaches the change detector from the change detector tree.
*
* The detached change detector will not be checked until it is reattached.
*/
detach() {
this._cd.mode = DETACHED;
}

/**
* Reattach the change detector to the change detector tree.
*
* This also requests a check of this change detector. This reattached change detector will be checked during the
* next change detection run.
*/
reattach() {
this._cd.mode = CHECK_ALWAYS;
this.requestCheck();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -245,12 +245,12 @@ export class DynamicChangeDetector extends AbstractChangeDetector {
}

// Currently, only pipes that used in bindings in the template get
// the bindingPropagationConfig of the encompassing component.
// the changeDetectorRef of the encompassing component.
//
// In the future, pipes declared in the bind configuration should
// be able to access the bindingPropagationConfig of that component.
var bpc = proto.mode === RECORD_TYPE_BINDING_PIPE ? this.bindingPropagationConfig : null;
var pipe = this.pipeRegistry.get(proto.name, context, bpc);
// be able to access the changeDetectorRef of that component.
var cdr = proto.mode === RECORD_TYPE_BINDING_PIPE ? this.changeDetectorRef : null;
var pipe = this.pipeRegistry.get(proto.name, context, cdr);
this._writePipe(proto, pipe);
return pipe;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export class IterableChangesFactory {
return IterableChanges.supportsObj(obj);
}

create(bpc):Pipe {
create(cdRef):Pipe {
return new IterableChanges();
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export class KeyValueChangesFactory {
return KeyValueChanges.supportsObj(obj);
}

create(bpc):Pipe {
create(cdRef):Pipe {
return new KeyValueChanges();
}
}
Expand Down
2 changes: 1 addition & 1 deletion modules/angular2/src/change_detection/pipes/null_pipe.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export class NullPipeFactory {
return NullPipe.supportsObj(obj);
}

create(bpc):Pipe {
create(cdRef):Pipe {
return new NullPipe();
}
}
Expand Down
6 changes: 3 additions & 3 deletions modules/angular2/src/change_detection/pipes/pipe_registry.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {List, ListWrapper} from 'angular2/src/facade/collection';
import {isBlank, isPresent, BaseException, CONST} from 'angular2/src/facade/lang';
import {Pipe} from './pipe';
import {BindingPropagationConfig} from '../binding_propagation_config';
import {ChangeDetectorRef} from '../change_detector_ref';

export class PipeRegistry {
config;
Expand All @@ -10,7 +10,7 @@ export class PipeRegistry {
this.config = config;
}

get(type:string, obj, bpc:BindingPropagationConfig):Pipe {
get(type:string, obj, cdRef:ChangeDetectorRef):Pipe {
var listOfConfigs = this.config[type];
if (isBlank(listOfConfigs)) {
throw new BaseException(`Cannot find a pipe for type '${type}' object '${obj}'`);
Expand All @@ -23,6 +23,6 @@ export class PipeRegistry {
throw new BaseException(`Cannot find a pipe for type '${type}' object '${obj}'`);
}

return matchingConfig.create(bpc);
return matchingConfig.create(cdRef);
}
}
14 changes: 7 additions & 7 deletions modules/angular2/src/core/compiler/element_injector.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import * as viewModule from 'angular2/src/core/compiler/view';
import {ViewContainer} from 'angular2/src/core/compiler/view_container';
import {NgElement} from 'angular2/src/core/compiler/ng_element';
import {Directive, Component, onChange, onDestroy, onAllChangesDone} from 'angular2/src/core/annotations/annotations';
import {BindingPropagationConfig} from 'angular2/change_detection';
import {ChangeDetectorRef} from 'angular2/change_detection';
import {QueryList} from './query_list';

var _MAX_DIRECTIVE_CONSTRUCTION_COUNTER = 10;
Expand Down Expand Up @@ -46,15 +46,15 @@ class StaticKeys {
viewId:number;
ngElementId:number;
viewContainerId:number;
bindingPropagationConfigId:number;
changeDetectorRefId:number;
elementRefId:number;

constructor() {
//TODO: vsavkin Key.annotate(Key.get(AppView), 'static')
this.viewId = Key.get(viewModule.AppView).id;
this.ngElementId = Key.get(NgElement).id;
this.viewContainerId = Key.get(ViewContainer).id;
this.bindingPropagationConfigId = Key.get(BindingPropagationConfig).id;
this.changeDetectorRefId = Key.get(ChangeDetectorRef).id;
this.elementRefId = Key.get(ElementRef).id;
}

Expand Down Expand Up @@ -298,13 +298,13 @@ export class PreBuiltObjects {
view:viewModule.AppView;
element:NgElement;
viewContainer:ViewContainer;
bindingPropagationConfig:BindingPropagationConfig;
changeDetectorRef:ChangeDetectorRef;
constructor(view, element:NgElement, viewContainer:ViewContainer,
bindingPropagationConfig:BindingPropagationConfig) {
changeDetectorRef:ChangeDetectorRef) {
this.view = view;
this.element = element;
this.viewContainer = viewContainer;
this.bindingPropagationConfig = bindingPropagationConfig;
this.changeDetectorRef = changeDetectorRef;
}
}

Expand Down Expand Up @@ -885,7 +885,7 @@ export class ElementInjector extends TreeNode {
if (keyId === staticKeys.viewId) return this._preBuiltObjects.view;
if (keyId === staticKeys.ngElementId) return this._preBuiltObjects.element;
if (keyId === staticKeys.viewContainerId) return this._preBuiltObjects.viewContainer;
if (keyId === staticKeys.bindingPropagationConfigId) return this._preBuiltObjects.bindingPropagationConfig;
if (keyId === staticKeys.changeDetectorRefId) return this._preBuiltObjects.changeDetectorRef;

//TODO add other objects as needed
return _undefined;
Expand Down
2 changes: 1 addition & 1 deletion modules/angular2/src/core/compiler/view.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {ListWrapper, MapWrapper, Map, StringMapWrapper, List} from 'angular2/src/facade/collection';
import {AST, Locals, ChangeDispatcher, ProtoChangeDetector, ChangeDetector,
ChangeRecord, BindingRecord, DirectiveRecord, BindingPropagationConfig} from 'angular2/change_detection';
ChangeRecord, BindingRecord, DirectiveRecord, ChangeDetectorRef} from 'angular2/change_detection';

import {ProtoElementInjector, ElementInjector, PreBuiltObjects, DirectiveBinding} from './element_injector';
import {ElementBinder} from './element_binder';
Expand Down
8 changes: 4 additions & 4 deletions modules/angular2/src/core/compiler/view_factory.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {isPresent, isBlank, BaseException} from 'angular2/src/facade/lang';
import {NgElement} from 'angular2/src/core/compiler/ng_element';
import * as vcModule from './view_container';
import * as viewModule from './view';
import {BindingPropagationConfig} from 'angular2/change_detection';
import {ChangeDetectorRef} from 'angular2/change_detection';

// TODO(tbosch): Make this an OpaqueToken as soon as our transpiler supports this!
export const VIEW_POOL_CAPACITY = 'ViewFactory.viewPoolCapacity';
Expand Down Expand Up @@ -77,12 +77,12 @@ export class ViewFactory {
elementInjectors[binderIdx] = elementInjector;

// componentChildViews
var bindingPropagationConfig = null;
var changeDetectorRef = null;
if (binder.hasStaticComponent()) {
var childView = this._createView(binder.nestedProtoView);
changeDetector.addShadowDomChild(childView.changeDetector);

bindingPropagationConfig = new BindingPropagationConfig(childView.changeDetector);
changeDetectorRef = new ChangeDetectorRef(childView.changeDetector);

componentChildViews[binderIdx] = childView;
}
Expand All @@ -97,7 +97,7 @@ export class ViewFactory {
// preBuiltObjects
if (isPresent(elementInjector)) {
preBuiltObjects[binderIdx] = new eli.PreBuiltObjects(view, new NgElement(view, binderIdx), viewContainer,
bindingPropagationConfig);
changeDetectorRef);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,7 @@ export function main() {

cd.detectChanges();

expect(registry.bpc).toBe(cd.bindingPropagationConfig);
expect(registry.cdRef).toBe(cd.changeDetectorRef);
});
});

Expand Down Expand Up @@ -762,7 +762,7 @@ class FakePipeRegistry extends PipeRegistry {
numberOfLookups:number;
pipeType:string;
factory:Function;
bpc:any;
cdRef:any;

constructor(pipeType, factory) {
super({});
Expand All @@ -771,10 +771,10 @@ class FakePipeRegistry extends PipeRegistry {
this.numberOfLookups = 0;
}

get(type:string, obj, bpc) {
get(type:string, obj, cdRef) {
if (type != this.pipeType) return null;
this.numberOfLookups ++;
this.bpc = bpc;
this.cdRef = cdRef;
return this.factory();
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class PipeFactory {
return this.shouldSupport;
}

create(bpc):Pipe {
create(cdRef):Pipe {
return this.pipe;
}
}
8 changes: 4 additions & 4 deletions modules/angular2/test/core/compiler/element_injector_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {AppProtoView, AppView} from 'angular2/src/core/compiler/view';
import {ViewContainer} from 'angular2/src/core/compiler/view_container';
import {NgElement} from 'angular2/src/core/compiler/ng_element';
import {Directive} from 'angular2/src/core/annotations/annotations';
import {BindingPropagationConfig, Parser, Lexer} from 'angular2/change_detection';
import {ChangeDetectorRef, Parser, Lexer} from 'angular2/change_detection';
import {ViewRef, Renderer, EventBinding} from 'angular2/src/render/api';
import {QueryList} from 'angular2/src/core/compiler/query_list';

Expand Down Expand Up @@ -620,11 +620,11 @@ export function main() {
expect(inj.get(ViewContainer)).toEqual(viewContainer);
});

it('should return bindingPropagationConfig', function () {
var config = new BindingPropagationConfig(null);
it('should return changeDetectorRef', function () {
var config = new ChangeDetectorRef(null);
var inj = injector([], null, null, new PreBuiltObjects(null, null, null, config));

expect(inj.get(BindingPropagationConfig)).toEqual(config);
expect(inj.get(ChangeDetectorRef)).toEqual(config);
});
});

Expand Down
Loading

0 comments on commit 8c1adab

Please sign in to comment.