boost_container.dart 8.78 KB
Newer Older
Jidong Chen's avatar
init  
Jidong Chen committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * The MIT License (MIT)
 * 
 * Copyright (c) 2019 Alibaba Group
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
import 'package:flutter/material.dart';
Yacumima's avatar
dev  
Yacumima committed
25 26 27
import 'container_manager.dart';
import '../flutter_boost.dart';
import 'boost_page_route.dart';
28
import '../support/logger.dart';
Jidong Chen's avatar
init  
Jidong Chen committed
29 30 31 32

enum ContainerLifeCycle {
  Init,
  Appear,
33
  WillDisappear,
Jidong Chen's avatar
init  
Jidong Chen committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
  Disappear,
  Destroy,
  Background,
  Foreground
}

typedef void BoostContainerLifeCycleObserver(
    ContainerLifeCycle state, BoostContainerSettings settings);

class BoostContainer extends Navigator {
  final BoostContainerSettings settings;

  const BoostContainer(
      {GlobalKey<BoostContainerState> key,
      this.settings = const BoostContainerSettings(),
      String initialRoute,
      RouteFactory onGenerateRoute,
      RouteFactory onUnknownRoute,
      List<NavigatorObserver> observers})
      : super(
            key: key,
            initialRoute: initialRoute,
            onGenerateRoute: onGenerateRoute,
            onUnknownRoute: onUnknownRoute,
            observers: observers);

  factory BoostContainer.copy(Navigator navigator,
          [BoostContainerSettings settings = const BoostContainerSettings()]) =>
      BoostContainer(
        key: GlobalKey<BoostContainerState>(),
        settings: settings,
        initialRoute: navigator.initialRoute,
        onGenerateRoute: navigator.onGenerateRoute,
        onUnknownRoute: navigator.onUnknownRoute,
        observers: navigator.observers,
      );

  factory BoostContainer.obtain(
          Navigator navigator, BoostContainerSettings settings) =>
      BoostContainer(
          key: GlobalKey<BoostContainerState>(),
          settings: settings,
          onGenerateRoute: (RouteSettings routeSettings) {
            if (routeSettings.name == '/') {
              return BoostPageRoute<dynamic>(
                  pageName: settings.name,
                  params: settings.params,
                  uniqueId: settings.uniqueId,
                  animated: false,
                  settings: routeSettings,
                  builder: settings.builder);
            } else {
              return navigator.onGenerateRoute(routeSettings);
            }
          },
          observers: <NavigatorObserver>[
zjq's avatar
zjq committed
90 91
            ContainerNavigatorObserver.bindContainerManager(),
            HeroController(),
Jidong Chen's avatar
init  
Jidong Chen committed
92 93 94 95 96 97 98 99 100 101 102
          ],
          onUnknownRoute: navigator.onUnknownRoute);

  @override
  BoostContainerState createState() => BoostContainerState();

  @override
  StatefulElement createElement() => ContainerElement(this);

  static BoostContainerState tryOf(BuildContext context) {
    final BoostContainerState container =
justin's avatar
justin committed
103
        context.findAncestorStateOfType<BoostContainerState>();
Jidong Chen's avatar
init  
Jidong Chen committed
104 105 106 107 108
    return container;
  }

  static BoostContainerState of(BuildContext context) {
    final BoostContainerState container =
justin's avatar
justin committed
109
        context.findAncestorStateOfType<BoostContainerState>();
Jidong Chen's avatar
init  
Jidong Chen committed
110 111 112 113 114 115 116 117
    assert(container != null, 'not in flutter boost');
    return container;
  }

  String desc() => '{uniqueId=${settings.uniqueId},name=${settings.name}}';
}

class BoostContainerState extends NavigatorState {
Yacumima's avatar
dev  
Yacumima committed
118
  VoidCallback backPressedHandler;
Jidong Chen's avatar
init  
Jidong Chen committed
119 120 121 122 123

  String get uniqueId => widget.settings.uniqueId;

  String get name => widget.settings.name;

124 125
  Map get params => widget.settings.params;

Jidong Chen's avatar
init  
Jidong Chen committed
126 127 128 129 130 131 132 133 134 135 136
  BoostContainerSettings get settings => widget.settings;

  bool get onstage =>
      BoostContainerManager.of(context).onstageContainer == this;

  bool get maybeOnstageNext =>
      BoostContainerManager.of(context).subContainer == this;

  @override
  BoostContainer get widget => super.widget as BoostContainer;

137 138
  final List<Route<dynamic>> routerHistory = <Route<dynamic>>[];

Jidong Chen's avatar
init  
Jidong Chen committed
139 140 141 142 143 144 145 146 147 148 149
  ContainerNavigatorObserver findContainerNavigatorObserver(
      Navigator navigator) {
    for (NavigatorObserver observer in navigator.observers) {
      if (observer is ContainerNavigatorObserver) {
        return observer;
      }
    }

    return null;
  }

Yacumima's avatar
dev  
Yacumima committed
150 151 152
  @override
  void initState() {
    super.initState();
153
    backPressedHandler = () => maybePop();
Yacumima's avatar
dev  
Yacumima committed
154 155
  }

Jidong Chen's avatar
init  
Jidong Chen committed
156 157 158 159 160 161 162
  @override
  void didUpdateWidget(Navigator oldWidget) {
    super.didUpdateWidget(oldWidget);
  }

  @override
  void dispose() {
163
    routerHistory.clear();
Jidong Chen's avatar
init  
Jidong Chen committed
164 165 166 167 168 169
    super.dispose();
  }

  void performBackPressed() {
    Logger.log('performBackPressed');

Yacumima's avatar
dev  
Yacumima committed
170
    backPressedHandler?.call();
Jidong Chen's avatar
init  
Jidong Chen committed
171 172
  }

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
  @override
  Future<bool> maybePop<T extends Object>([T result]) async {
    final Route<T> route = routerHistory.last;
    final RoutePopDisposition disposition = await route.willPop();
    if (mounted) {
      switch (disposition) {
        case RoutePopDisposition.pop:
          pop(result);
          return true;
          break;
        case RoutePopDisposition.doNotPop:
          return false;
          break;
        case RoutePopDisposition.bubble:
          pop(result);
          return true;
          break;
      }
    }
justin's avatar
justin committed
192
    return false;
193 194
  }

Jidong Chen's avatar
init  
Jidong Chen committed
195 196
  @override
  bool pop<T extends Object>([T result]) {
197 198 199 200
    if (routerHistory.length > 1) {
      routerHistory.removeLast();
    }

Jidong Chen's avatar
init  
Jidong Chen committed
201 202 203
    if (canPop()) {
      return super.pop(result);
    } else {
204 205 206 207
      if (T is Map<String, dynamic>) {
        FlutterBoost.singleton
            .close(uniqueId, result: result as Map<String, dynamic>);
      } else {
Yacumima's avatar
Yacumima committed
208 209
        FlutterBoost.singleton.close(uniqueId);
      }
Jidong Chen's avatar
init  
Jidong Chen committed
210 211 212 213
    }
    return false;
  }

214 215 216 217 218 219 220 221 222 223
  @override
  Future<T> push<T extends Object>(Route<T> route) {
    Route<T> newRoute;
    if (FlutterBoost.containerManager.prePushRoute != null) {
      newRoute = FlutterBoost.containerManager
          .prePushRoute(name, uniqueId, params, route);
    }

    Future<T> future = super.push<T>(newRoute ?? route);

224 225
    routerHistory.add(route);

226 227 228 229 230 231 232 233
    if (FlutterBoost.containerManager.postPushRoute != null) {
      FlutterBoost.containerManager
          .postPushRoute(name, uniqueId, params, newRoute ?? route, future);
    }

    return future;
  }

Jidong Chen's avatar
init  
Jidong Chen committed
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
  VoidCallback addLifeCycleObserver(BoostContainerLifeCycleObserver observer) {
    return FlutterBoost.singleton.addBoostContainerLifeCycleObserver(
        (ContainerLifeCycle state, BoostContainerSettings settings) {
      if (settings.uniqueId == uniqueId) {
        observer(state, settings);
      }
    });
  }
}

class BoostContainerSettings {
  final String uniqueId;
  final String name;
  final Map params;
  final WidgetBuilder builder;

  const BoostContainerSettings(
      {this.uniqueId = 'default',
      this.name = 'default',
      this.params,
      this.builder});
}

class ContainerElement extends StatefulElement {
  ContainerElement(StatefulWidget widget) : super(widget);
}

class ContainerNavigatorObserver extends NavigatorObserver {
justin's avatar
justin committed
262
  static final Set<NavigatorObserver> boostObservers = Set<NavigatorObserver>();
Jidong Chen's avatar
init  
Jidong Chen committed
263 264 265 266

  ContainerNavigatorObserver();

  factory ContainerNavigatorObserver.bindContainerManager() =>
yangwu.jia's avatar
yangwu.jia committed
267
      ContainerNavigatorObserver();
Jidong Chen's avatar
init  
Jidong Chen committed
268

yangwu.jia's avatar
yangwu.jia committed
269 270
  VoidCallback addBoostNavigatorObserver(NavigatorObserver observer) {
    boostObservers.add(observer);
Jidong Chen's avatar
init  
Jidong Chen committed
271

yangwu.jia's avatar
yangwu.jia committed
272
    return () => boostObservers.remove(observer);
Jidong Chen's avatar
init  
Jidong Chen committed
273 274
  }

yangwu.jia's avatar
yangwu.jia committed
275 276
  void removeBoostNavigatorObserver(NavigatorObserver observer) {
    boostObservers.remove(observer);
Jidong Chen's avatar
init  
Jidong Chen committed
277 278 279 280
  }

  @override
  void didPush(Route<dynamic> route, Route<dynamic> previousRoute) {
yangwu.jia's avatar
yangwu.jia committed
281
    for (NavigatorObserver observer in boostObservers) {
Jidong Chen's avatar
init  
Jidong Chen committed
282 283 284 285 286 287
      observer.didPush(route, previousRoute);
    }
  }

  @override
  void didPop(Route<dynamic> route, Route<dynamic> previousRoute) {
yangwu.jia's avatar
yangwu.jia committed
288
    for (NavigatorObserver observer in boostObservers) {
Jidong Chen's avatar
init  
Jidong Chen committed
289 290 291 292 293 294
      observer.didPop(route, previousRoute);
    }
  }

  @override
  void didRemove(Route<dynamic> route, Route<dynamic> previousRoute) {
yangwu.jia's avatar
yangwu.jia committed
295
    for (NavigatorObserver observer in boostObservers) {
Jidong Chen's avatar
init  
Jidong Chen committed
296 297 298 299 300 301
      observer.didRemove(route, previousRoute);
    }
  }

  @override
  void didReplace({Route<dynamic> newRoute, Route<dynamic> oldRoute}) {
yangwu.jia's avatar
yangwu.jia committed
302
    for (NavigatorObserver observer in boostObservers) {
Jidong Chen's avatar
init  
Jidong Chen committed
303 304 305 306
      observer.didReplace(newRoute: newRoute, oldRoute: oldRoute);
    }
  }
}