Limit the set of Visual Studio projects generated by GN

tools/gn/command_gen.cc

 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/atomicops.h"
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/stringprintf.h"
 #include "base/timer/elapsed_timer.h"
 #include "tools/gn/build_settings.h"
 #include "tools/gn/commands.h"
 #include "tools/gn/eclipse_writer.h"
 #include "tools/gn/ninja_target_writer.h"
 #include "tools/gn/ninja_writer.h"
 #include "tools/gn/runtime_deps.h"
 #include "tools/gn/scheduler.h"
 #include "tools/gn/setup.h"
 #include "tools/gn/standard_out.h"
 #include "tools/gn/switches.h"
 #include "tools/gn/target.h"
 #include "tools/gn/visual_studio_writer.h"
 
 namespace commands {
 
 namespace {
 
 const char kSwitchCheck[] = "check";
+const char kSwitchFilters[] = "filters";
 const char kSwitchIde[] = "ide";
 const char kSwitchIdeValueEclipse[] = "eclipse";
 const char kSwitchIdeValueVs[] = "vs";
 const char kSwitchIdeValueVs2013[] = "vs2013";
 const char kSwitchIdeValueVs2015[] = "vs2015";
+const char kSwitchSln[] = "sln";
 
 // Called on worker thread to write the ninja file.
 void BackgroundDoWrite(const Target* target) {
   NinjaTargetWriter::RunAndWriteFile(target);
   g_scheduler->DecrementWorkCount();
 }
 
 // Called on the main thread.
 void ItemResolvedCallback(base::subtle::Atomic32* write_counter,
                           scoped_refptr<Builder> builder,
@@ skipping 104 matching lines @@
     OutputString(base::StringPrintf("\n%d generated input errors found.\n",
                                     errors_found), DECORATION_YELLOW);
   }
   return false;
 }
 
 bool RunIdeWriter(const std::string& ide,
                   const BuildSettings* build_settings,
                   Builder* builder,
                   Err* err) {
+  const base::CommandLine* command_line =
+      base::CommandLine::ForCurrentProcess();
   base::ElapsedTimer timer;
+
   if (ide == kSwitchIdeValueEclipse) {
     bool res = EclipseWriter::RunAndWriteFile(build_settings, builder, err);
-    if (res &&
-        !base::CommandLine::ForCurrentProcess()->HasSwitch(switches::kQuiet)) {
+    if (res && !command_line->HasSwitch(switches::kQuiet)) {
       OutputString("Generating Eclipse settings took " +
                    base::Int64ToString(timer.Elapsed().InMilliseconds()) +
                    "ms\n");
     }
     return res;
   } else if (ide == kSwitchIdeValueVs || ide == kSwitchIdeValueVs2013 ||
              ide == kSwitchIdeValueVs2015) {
     VisualStudioWriter::Version version =
         ide == kSwitchIdeValueVs2013 ? VisualStudioWriter::Version::Vs2013
                                      : VisualStudioWriter::Version::Vs2015;
-    bool res = VisualStudioWriter::RunAndWriteFiles(build_settings, builder,
-                                                    version, err);
-    if (res &&
-        !base::CommandLine::ForCurrentProcess()->HasSwitch(switches::kQuiet)) {
+    std::string sln_name;
+    if (command_line->HasSwitch(kSwitchSln))
+      sln_name = command_line->GetSwitchValueASCII(kSwitchSln);
+    std::string filters;
+    if (command_line->HasSwitch(kSwitchFilters))
+      filters = command_line->GetSwitchValueASCII(kSwitchFilters);
+    bool res = VisualStudioWriter::RunAndWriteFiles(
+        build_settings, builder, version, sln_name, filters, err);
+    if (res && !command_line->HasSwitch(switches::kQuiet)) {
       OutputString("Generating Visual Studio projects took " +
                    base::Int64ToString(timer.Elapsed().InMilliseconds()) +
                    "ms\n");
     }
     return res;
   }
 
   *err = Err(Location(), "Unknown IDE: " + ide);
   return false;
 }
 
 }  // namespace
 
 const char kGen[] = "gen";
 const char kGen_HelpShort[] =
     "gen: Generate ninja files.";
 const char kGen_Help[] =
     "gn gen: Generate ninja files.\n"
     "\n"
-    "  gn gen [--ide=<ide_name>] <out_dir>\n"
+    "  gn gen [<ide options>] <out_dir>\n"
     "\n"
     "  Generates ninja files from the current tree and puts them in the given\n"
     "  output directory.\n"
     "\n"
     "  The output directory can be a source-repo-absolute path name such as:\n"
     "      //out/foo\n"
     "  Or it can be a directory relative to the current directory such as:\n"
     "      out/foo\n"
     "\n"
+    "  See \"gn help switches\" for the common command-line switches.\n"
+    "\n"
+    "GN optionally generates files for IDEs. Possibilities for <ide options>\n"

[brettw, 2016/02/24 22:11:26]

Can you do this instead:
"""
IDE options

  GN optionally generates files for IDEs. Possibilities for <ide options>\n
  ...
"""

(so "IDE options" is the title, the string you have not is the text under it,
indented, followed by the options).

[Tomasz Moniuszko, 2016/02/25 13:28:20]

Done.

+    "\n"
     "  --ide=<ide_name>\n"
-    "    Also generate files for an IDE. Currently supported values:\n"
+    "      Generate files for an IDE. Currently supported values:\n"
     "      \"eclipse\" - Eclipse CDT settings file.\n"
     "      \"vs\" - Visual Studio project/solution files.\n"
     "             (default Visual Studio version: 2015)\n"
     "      \"vs2013\" - Visual Studio 2013 project/solution files.\n"
     "      \"vs2015\" - Visual Studio 2015 project/solution files.\n"
     "\n"
-    "  See \"gn help switches\" for the common command-line switches.\n"
+    "  --sln=<file_name>\n"
+    "      Override default sln file name (\"all\"). Only for Visual Studio.\n"

[brettw, 2016/02/24 22:11:26]

Can you explain where this file will be put (I assume in the root build
directory)?

[Tomasz Moniuszko, 2016/02/25 13:28:20]

Yes, exactly (I added this information to the help).

+    "\n"
+    "  --filters=<path_prefixes>\n"
+    "      Semicolon-separated list of path prefixes used to limit the set of\n"

[brettw, 2016/02/24 22:11:26]

Assuming we do the label pattern thing I suggested in the other file, this
should reference "gn help label_pattern"

[Tomasz Moniuszko, 2016/02/25 13:28:20]

Done.

+    "      generated projects. Each prefix may be source-absolute\n"
+    "      (e.g. \"//base\") or system-absolute (e.g. \"/C:/foo/bar\"). Only\n"
+    "      targets whose directory paths start with one of specified prefixes\n"
+    "      will be included to the solution. Only for Visual Studio.\n"
+    "      Example: --filters=\"//base;//tools/gn\"\n"
     "\n"
     "Eclipse IDE Support\n"
     "\n"
     "  GN DOES NOT generate Eclipse CDT projects. Instead, it generates a\n"
     "  settings file which can be imported into an Eclipse CDT project. The\n"
     "  XML file contains a list of include paths and defines. Because GN does\n"
     "  not generate a full .cproject definition, it is not possible to\n"
     "  properly define includes/defines for each file individually.\n"
     "  Instead, one set of includes/defines is generated for the entire\n"
     "  project. This works fairly well but may still result in a few indexer\n"
@@ skipping 66 matching lines @@
             setup->scheduler().input_file_manager()->GetInputFileCount()) +
         " files in " +
         base::Int64ToString(elapsed_time.InMilliseconds()) + "ms\n";
     OutputString(stats);
   }
 
   return 0;
 }
 
 }  // namespace commands