Add ability to configure cargo build features.

ehuss · ehuss · commit 2dec48759d5d · 2017-03-18T14:46:34.000-07:00
diff --git a/RustEnhanced.sublime-commands b/RustEnhanced.sublime-commands
@@ -31,4 +31,8 @@
         "caption": "Rust: Set Cargo Toolchain",
         "command": "cargo_set_toolchain"
     },
+    {
+        "caption": "Rust: Set Cargo Features",
+        "command": "cargo_set_features"
+    },
 ]
diff --git a/docs/build.md b/docs/build.md
@@ -59,6 +59,7 @@ Command | Description
 Rust: Set Cargo Target | Set the Cargo target (`--lib`, `--example foo`, etc.) for each build variant.  The "Automatic Detection" option will attempt to determine which target to use based on the current active view in Sublime (a test file will use `--test` or a binary will use `--bin`, etc.).
 Rust: Set Cargo Build Profile | Set whether or not to use the `--release` flag.
 Rust: Set Cargo Target Triple | Set the target triple (such as `x86_64-apple-darwin`).
+Rust: Set Cargo Features | Set the Cargo build features to use.
 Rust: Set Cargo Toolchain | Set the Rust toolchain to use (`nightly`, `beta`, etc.).  Use the Targets > "All Targets" to set globally.
 
 Caution: If you have not created a `sublime-project` file, then any changes
@@ -117,6 +118,8 @@ Setting Name | Description
 `target_triple` | If set, uses the `--target` flag with the given value.
 `toolchain` | The Rust toolchain to use (such as `nightly` or `beta`).
 `target` | The Cargo target (such as `"--bin myprog"`).  Applies to `variants` only.  Can be `"auto"` (see "Set Cargo Target" above).
+`no_default_features` | If True, sets the `--no-default-features` flag.
+`features` | A string with a space separated list of features to pass to the `--features` flag.  Set to "ALL" to pass the `--all-features` flag.
 `extra_cargo_args` | Extra arguments passed to Cargo (before the `--` flags separator).
 `extra_run_args` | Extra arguments passed to Cargo (after the `--` flags separator).
 
diff --git a/rust/cargo_config.py b/rust/cargo_config.py
@@ -83,7 +83,7 @@ def show_next_question(self):
         item_info = getattr(self, 'items_' + q)()
         if not isinstance(item_info, dict):
             item_info = {'items': item_info}
-        items = item_info['items']
+
         f_selected = getattr(self, 'selected_' + q, None)
 
         def make_choice(value):
@@ -94,34 +94,45 @@ def make_choice(value):
                     self._sequence.extend(next)
             self.show_next_question()
 
-        def wrapper(index):
-            if index != -1:
-                chosen = items[index][1]
-                RECENT_CHOICES[q] = chosen
-                make_choice(chosen)
-
         if q in self.input:
             make_choice(self.input[q])
-        elif item_info.get('skip_if_one', False) and len(items) == 1:
-            wrapper(0)
         else:
-            # If the user manually edits the config and enters custom values
-            # then it won't show up in the list (because it is not an exact
-            # match).  Add it so that it is a valid choice (assuming the user
-            # entered a valid value).
-            if 'default' in item_info:
-                default_index = index_with(items,
-                    lambda x: x[1] == item_info['default'])
-                if default_index == -1:
-                    items.append((item_info['default'], item_info['default']))
-            # Determine the default selection.
-            # Use the default provided by the items_ method, else
-            # use the most recently used value.
-            default = index_with(items,
-                lambda x: x[1] == item_info.get('default',
-                    RECENT_CHOICES.get(q, '_NO_DEFAULT_SENTINEL_')))
-            display_items = [x[0] for x in items]
-            self.window.show_quick_panel(display_items, wrapper, 0, default)
+            if 'items' in item_info:
+                def wrapper(index):
+                    if index != -1:
+                        chosen = item_info['items'][index][1]
+                        RECENT_CHOICES[q] = chosen
+                        make_choice(chosen)
+
+                items = item_info['items']
+                if item_info.get('skip_if_one', False) and len(items) == 1:
+                    wrapper(0)
+                else:
+                    # If the user manually edits the config and enters custom
+                    # values then it won't show up in the list (because it is
+                    # not an exact match).  Add it so that it is a valid
+                    # choice (assuming the user entered a valid value).
+                    if 'default' in item_info:
+                        default_index = index_with(items,
+                            lambda x: x[1] == item_info['default'])
+                        if default_index == -1:
+                            items.append((item_info['default'],
+                                          item_info['default']))
+                    # Determine the default selection.
+                    # Use the default provided by the items_ method, else
+                    # use the most recently used value.
+                    default = index_with(items,
+                        lambda x: x[1] == item_info.get('default',
+                            RECENT_CHOICES.get(q, '_NO_DEFAULT_SENTINEL_')))
+                    display_items = [x[0] for x in items]
+                    self.window.show_quick_panel(display_items, wrapper, 0,
+                                                 default)
+            elif 'caption' in item_info:
+                self.window.show_input_panel(item_info['caption'],
+                                             item_info.get('default', ''),
+                                             make_choice, None, None)
+            else:
+                raise ValueError(item_info)
 
     def items_package(self):
         # path/to/package: package_info
@@ -365,3 +376,53 @@ def done(self):
                                           self.choices['toolchain'])
         else:
             raise AssertionError(self.choices['which'])
+
+
+class CargoSetFeatures(CargoConfigBase):
+
+    sequence = ['package', 'target', 'no_default_features', 'features']
+
+    def items_no_default_features(self):
+        current = self.settings.get_with_target(self.choices['package'],
+                                                self.choices['target'],
+                                                'no_default_features', False)
+        items = [
+            ('Include default features.', False),
+            ('Do not include default features.', True)
+        ]
+        return {
+            'items': items,
+            'default': current,
+        }
+
+    def items_features(self):
+        features = self.settings.get_with_target(self.choices['package'],
+                                                 self.choices['target'],
+                                                 'features', None)
+        if features is None:
+            package_path = self.choices['package']
+            available_features = self.packages[package_path].get('features', {})
+            items = list(available_features.keys())
+            # Remove the "default" entry.
+            if 'default' in items:
+                del items[items.index('default')]
+                if not self.choices['no_default_features']:
+                    # Don't show default features, (they are already included).
+                    for ft in available_features['default']:
+                        if ft in items:
+                            del items[items.index(ft)]
+            features = ' '.join(items)
+        return {
+            'caption': 'Choose features (space separated, use "ALL" to use all features)',
+            'default': features,
+        }
+
+    def done(self):
+        self.settings.set_with_target(self.choices['package'],
+                                      self.choices['target'],
+                                      'no_default_features',
+                                      self.choices['no_default_features'])
+        self.settings.set_with_target(self.choices['package'],
+                                      self.choices['target'],
+                                      'features',
+                                      self.choices['features'])
diff --git a/rust/cargo_settings.py b/rust/cargo_settings.py
@@ -321,6 +321,19 @@ def get(key, default=None):
         if cmd_info.get('allows_json'):
             result.append('--message-format=json')
 
+        # features
+        if cmd_info.get('allows_features', False):
+            v = get('no_default_features', False)
+            if v:
+                result.append('--no-default-features')
+            v = get('features', None)
+            if v:
+                if v.upper() == 'ALL':
+                    result.append('--all-features')
+                else:
+                    result.append('--features')
+                    result.append(v)
+
         # Add path from current active view (mainly for "cargo script").
         if cmd_info.get('wants_view_path', False):
             if not self._active_view_is_rust():
diff --git a/tests/multi-targets/Cargo.toml b/tests/multi-targets/Cargo.toml
@@ -7,6 +7,10 @@ build = "build.rs"
 
 [features]
 nightly = []
+default = ["feat1"]
+feat1 = []
+feat2 = []
+feat3 = []
 
 [[bin]]
 name = "otherbin"
@@ -27,6 +31,10 @@ path = "src/bin/bin1.rs"
 name = "bin2"
 path = "src/bin/bin2.rs"
 
+[[bin]]
+name = "feats"
+path = "src/bin/feats.rs"
+
 [[example]]
 name = "ex1"
 path = "examples/ex1.rs"
diff --git a/tests/multi-targets/src/bin/feats.rs b/tests/multi-targets/src/bin/feats.rs
@@ -0,0 +1,14 @@
+fn main() {
+    print!("feats: ");
+    let mut v = Vec::new();
+    if cfg!(feature="feat1") {
+        v.push("feat1");
+    }
+    if cfg!(feature="feat2") {
+        v.push("feat2")
+    }
+    if cfg!(feature="feat3") {
+        v.push("feat3")
+    }
+    println!("{}", v.join(" "));
+}
diff --git a/tests/test_cargo_build.py b/tests/test_cargo_build.py
@@ -63,7 +63,7 @@ def _test_build_with_target(self, view):
                                'libmulti_targets.rlib']),
             # I'm actually uncertain why Cargo builds all bins here.
             ('--test test1', [exe('bin1'), exe('bin2'), exe('multi-targets'),
-                              exe('otherbin'),
+                              exe('otherbin'), exe('feats'),
                               'libmulti_targets.rlib', 'test1-*']),
             # bench requires nightly
         ]
@@ -307,3 +307,44 @@ def _test_script(self, view):
         self._run_build_wait('script')
         output = self._get_build_output(window)
         self.assertRegex(output, '(?m)^Hello Mystery$')
+
+    def test_features(self):
+        """Test feature selection."""
+        self._with_open_file('tests/multi-targets/src/bin/feats.rs',
+            self._test_features)
+
+    def _test_features(self, view):
+        window = view.window()
+        window.run_command('cargo_set_target', {'variant': 'run',
+                                                'target': '--bin feats'})
+        self._run_build_wait('run')
+        output = self._get_build_output(window)
+        self.assertRegex(output, '(?m)^feats: feat1$')
+
+        window.run_command('cargo_set_features', {'target': None,
+                                                  'no_default_features': True,
+                                                  'features': ''})
+        self._run_build_wait('run')
+        output = self._get_build_output(window)
+        self.assertRegex(output, '(?m)^feats: $')
+
+        window.run_command('cargo_set_features', {'target': None,
+                                                  'no_default_features': False,
+                                                  'features': 'feat3'})
+        self._run_build_wait('run')
+        output = self._get_build_output(window)
+        self.assertRegex(output, '(?m)^feats: feat1 feat3$')
+
+        window.run_command('cargo_set_features', {'target': None,
+                                                  'no_default_features': True,
+                                                  'features': 'feat2 feat3'})
+        self._run_build_wait('run')
+        output = self._get_build_output(window)
+        self.assertRegex(output, '(?m)^feats: feat2 feat3$')
+
+        window.run_command('cargo_set_features', {'target': None,
+                                                  'no_default_features': True,
+                                                  'features': 'ALL'})
+        self._run_build_wait('run')
+        output = self._get_build_output(window)
+        self.assertRegex(output, '(?m)^feats: feat1 feat2 feat3$')

Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,8 @@`
`31`	`31`	`"caption": "Rust: Set Cargo Toolchain",`
`32`	`32`	`"command": "cargo_set_toolchain"`
`33`	`33`	`},`
	`34`	`+ {`
	`35`	`+ "caption": "Rust: Set Cargo Features",`
	`36`	`+ "command": "cargo_set_features"`
	`37`	`+ },`
`34`	`38`	`]`