Smarter splitting around named collection arguments.

lib/src/rule/argument.dart

 // Copyright (c) 2015, 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_style.src.rule.argument;
 
 import '../chunk.dart';
 import 'rule.dart';
 
 /// Base class for a rule that handles argument or parameter lists.
 abstract class ArgumentRule extends Rule {
+  /// The chunks prior to each positional argument.
+  final List<Chunk> _arguments = [];
+
+  /// The rule used to split collections in the argument list, if any.
+  Rule _collectionRule;
+
+  /// The number of leading collection arguments.
+  ///
+  /// This and [_trailingCollections] cannot both be positive. If every
+  /// argument is a collection, this will be [_arguments.length] and
+  /// [_trailingCollections] will be 0.
+  final int _leadingCollections;
+
+  /// The number of trailing collections.
+  ///
+  /// This and [_leadingCollections] cannot both be positive.
+  final int _trailingCollections;
+
   /// If true, then inner rules that are written will force this rule to split.
   ///
   /// Temporarily disabled while writing collectio arguments so that they can be
   /// multi-line without forcing the whole argument list to split.
   bool _trackInnerRules = true;
 
   /// Don't split when an inner collection rule splits.
   bool get splitsOnInnerRules => _trackInnerRules;
 
+  ArgumentRule(this._collectionRule, this._leadingCollections,
+      this._trailingCollections);
+
+  void addConstrainedRules(Set<Rule> rules) {
+    super.addConstrainedRules(rules);
+    if (_collectionRule != null) rules.add(_collectionRule);
+  }
+
+  void forgetUnusedRules() {
+    super.forgetUnusedRules();
+    if (_collectionRule != null && _collectionRule.index == null) {
+      _collectionRule = null;
+    }
+  }
+
+  /// Remembers [chunk] as containing the split that occurs right before an
+  /// argument in the list.
+  void beforeArgument(Chunk chunk) {
+    _arguments.add(chunk);
+  }
+
   /// Called before a collection argument is written.
   ///
   /// Disables tracking inner rules while a collection argument is written.
   void beforeCollection() {
     assert(_trackInnerRules == true);
     _trackInnerRules = false;
   }
 
   /// Called after a collection argument is complete.
   ///
   /// Re-enables tracking inner rules.
   void afterCollection() {
     assert(_trackInnerRules == false);
     _trackInnerRules = true;
   }
 }
 
 /// Base class for a rule for handling positional argument lists.
 abstract class PositionalRule extends ArgumentRule {
-  /// The chunks prior to each positional argument.
-  final List<Chunk> _arguments = [];
-
-  /// The rule used to split collections in the argument list, if any.
-  Rule _collectionRule;
-
   /// If there are named arguments following these positional ones, this will
   /// be their rule.
   Rule _namedArgsRule;
 
   /// Creates a new rule for a positional argument list.
   ///
   /// If [_collectionRule] is given, it is the rule used to split the collection
   /// arguments in the list.
-  PositionalRule(this._collectionRule);
+  PositionalRule(
+      Rule collectionRule, int leadingCollections, int trailingCollections)
+      : super(collectionRule, leadingCollections, trailingCollections);
 
   void addConstrainedRules(Set<Rule> rules) {
-    if (_collectionRule != null) rules.add(_collectionRule);
+    super.addConstrainedRules(rules);
     if (_namedArgsRule != null) rules.add(_namedArgsRule);
   }
 
   void forgetUnusedRules() {
     super.forgetUnusedRules();
     if (_namedArgsRule != null && _namedArgsRule.index == null) {
       _namedArgsRule = null;
     }
-
-    if (_collectionRule != null && _collectionRule.index == null) {
-      _collectionRule = null;
-    }
   }
 
-  /// Remembers [chunk] as containing the split that occurs right before an
-  /// argument in the list.
-  void beforeArgument(Chunk chunk) {
-    _arguments.add(chunk);
-  }
-
-  /// Remembers that [rule] is the [NamedArgsRule] immediately following this
+  /// Remembers that [rule] is the [Rule] immediately following this positional
   /// positional argument list.
-  void setNamedArgsRule(NamedRule rule) {
+  ///
+  /// This is normally a [NamedRule] but [PositionalRule] is also used for the
+  /// property accesses at the beginning of a call chain, in which case this
+  /// is just a [SimpleRule].
+  void setNamedArgsRule(Rule rule) {
     _namedArgsRule = rule;
   }
 
   /// Constrains the named argument list to at least move to the next line if
   /// there are any splits in the positional arguments. Prevents things like:
   ///
   ///      function(
   ///          argument,
   ///          argument, named: argument);
   int constrain(int value, Rule other) {
@@ skipping 22 matching lines @@
   /// If there is only a single non-collection argument, allow it to split
   /// internally without forcing a split before the argument.
   final bool splitsOnInnerRules;
 
   /// Creates a new rule for a positional argument list.
   ///
   /// If [collectionRule] is given, it is the rule used to split the
   /// collections in the list. If [splitsOnInnerRules] is `true`, then we will
   /// split before the argument if the argument itself contains a split.
   SinglePositionalRule(Rule collectionRule, {bool splitsOnInnerRules})
-      : super(collectionRule),
+      : super(collectionRule, 0, 0),
         splitsOnInnerRules =
             splitsOnInnerRules != null ? splitsOnInnerRules : false;
 
   int constrain(int value, Rule other) {
     var constrained = super.constrain(value, other);
     if (constrained != null) return constrained;
 
     if (other != _collectionRule) return null;
 
     // If we aren't splitting any args, we can split the collection.
@@ skipping 17 matching lines @@
 /// Then there is a value for each argument, to split before that argument.
 /// These values work back to front. So, for a two-argument list, value 2 splits
 /// after the second argument and value 3 splits after the first.
 ///
 /// Then there is a value that splits before every argument.
 ///
 /// Finally, if there are collection arguments, there is another value that
 /// splits before all of the non-collection arguments, but does not split
 /// before the collections, so that they can split internally.
 class MultiplePositionalRule extends PositionalRule {
-  /// The number of leading collection arguments.
-  ///
-  /// This and [_trailingCollections] cannot both be positive. If every
-  /// argument is a collection, this will be [_arguments.length] and
-  /// [_trailingCollections] will be 0.
-  final int _leadingCollections;
-
-  /// The number of trailing collections.
-  ///
-  /// This and [_leadingCollections] cannot both be positive.
-  final int _trailingCollections;
-
   int get numValues {
     // Can split before any one argument, none, or all.
     var result = 2 + _arguments.length;
 
     // When there are collection arguments, there are two ways we can split on
     // "all" arguments:
     //
     // - Split on just the non-collection arguments, and force the collection
     //   arguments to split internally.
     // - Split on all of them including the collection arguments, and do not
     //   allow the collection arguments to split internally.
     if (_leadingCollections > 0 || _trailingCollections > 0) result++;
 
     return result;
   }
 
   MultiplePositionalRule(
-      Rule collectionRule, this._leadingCollections, this._trailingCollections)
-      : super(collectionRule);
+      Rule collectionRule, int leadingCollections, int trailingCollections)
+      : super(collectionRule, leadingCollections, trailingCollections);
 
   String toString() => "*Pos${super.toString()}";
 
   bool isSplitAtValue(int value, Chunk chunk) {
     // Split only before the first argument. Keep the entire argument list
     // together on the next line.
     if (value == 1) return chunk == _arguments.first;
 
     // Split before a single argument. Try later arguments before earlier ones
     // to try to keep as much on the first line as possible.
@@ skipping 64 matching lines @@
     if (value == _arguments.length + 1) return 1;
 
     // Split before all of the arguments, even the collections. We'll allow
     // them to split but indent their bodies if they do.
     return null;
   }
 }
 
 /// Splitting rule for a list of named arguments or parameters. Its values mean:
 ///
-/// * 0: Do not split at all.
-/// * 1: Split only before first argument.
-/// * 2: Split before all arguments, including the first.
+/// * Do not split at all.
+/// * Split only before first argument.
+/// * Split before all arguments.
 class NamedRule extends ArgumentRule {
-  /// The chunk prior to the first named argument.
-  Chunk _first;
-
-  /// Whether any of the named arguments are collection literals.
-  final bool _containsCollections;
-
   int get numValues => 3;
 
-  NamedRule({bool containsCollections})
-      : _containsCollections = containsCollections ?? false;
+  NamedRule(
+      Rule collectionRule, int leadingCollections, int trailingCollections)
+      : super(collectionRule, leadingCollections, trailingCollections);
 
-  void beforeArguments(Chunk chunk) {
-    assert(_first == null);
-    _first = chunk;
+  bool isSplitAtValue(int value, Chunk chunk) {
+    // Move all arguments to the second line as a unit.
+    if (value == 1) return chunk == _arguments.first;
+
+    // Otherwise, split before all arguments.
+    return true;
   }
 
-  bool isSplitAtValue(int value, Chunk chunk) {
-    // Only split before the first argument.
-    if (value == 1) return chunk == _first;
+  int constrain(int value, Rule other) {
+    var constrained = super.constrain(value, other);
+    if (constrained != null) return constrained;
 
-    // Split before every argument.
-    return true;
+    // Decide how to constrain the collection rule.
+    if (other != _collectionRule) return null;
+
+    // If all of the collections are in the named arguments, [_collectionRule]
+    // will not be null, but we don't have to handle it.
+    if (_leadingCollections == 0 && _trailingCollections == 0) return null;
+
+    // If we aren't splitting any args, we can split the collection.
+    if (value == Rule.unsplit) return null;
+
+    // Split only before the first argument. Don't allow the collections to
+    // split.
+    if (value == 1) return Rule.unsplit;
+
+    // Split before all of the arguments, even the collections. We'll allow
+    // them to split but indent their bodies if they do.
+    return null;
   }
 
   String toString() => "Named${super.toString()}";
 }