GN: Add notion of 'complete' static libraries, akin to GYP.

tools/gn/variables.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 "tools/gn/variables.h"
 
 namespace variables {
 
 // Built-in variables ----------------------------------------------------------
 
@@ skipping 350 matching lines @@
     "  it just skips checking the includes of the current target's files.\n"
     "\n"
     "Example\n"
     "\n"
     "  source_set(\"busted_includes\") {\n"
     "    # This target's includes are messed up, exclude it from checking.\n"
     "    check_includes = false\n"
     "    ...\n"
     "  }\n";
 
+const char kCompleteStaticLib[] = "complete_static_lib";
+const char kCompleteStaticLib_HelpShort[] =
+    "complete_static_lib: [boolean] Actually link this static library target";
+const char kCompleteStaticLib_Help[] =
+    "complete_static_lib: [boolean] Actually link this static library target\n"
+    "\n"
+    "  Static libraries are normally treated roughly like source_sets, in\n"

[brettw, 2014/09/12 20:53:33]

I don't like defining static libraries in terms of source sets, since nobody
knows what a source set is. Maybe something like (feel free to clarify):


Links all dependencies into a static library.

A static library normally doesn't include code from dependencies, but instead
forward the static libraries and source sets in its deps up the dependency chain
until a linkable target (an executable or shared library) is reached. The final
linkable target only links each static library once, even if it appears more
than once in its dependency graph.

In some cases the static library might be the final desired output. For example,
you may be producing a static library for distribution to third parties. In this
case, the static library should include code from all dependencies in one
complete package.

[Chris Masone, 2014/09/12 22:56:37]

Done.

+    "  that they are mostly just a way to group objects that are then linked\n"
+    "  into any upstream linkable targets (generally, executables and shared\n"
+    "  libraries). This is to avoid duplication in cases where multiple\n"
+    "  static libraries depend on the same target. This flag allows a given\n"
+    "  static library target to be explicitly made linkable.\n"
+    "\n"
+    "Example:\n"

[brettw, 2014/09/12 20:53:34]

I've been doing no colon and a blank line after these headings.

[Chris Masone, 2014/09/12 22:56:37]

Done.

+    "  static_library(\"foo\") {\n"
+    "    complete_static_lib = true  # Force foo to.\n"

[brettw, 2014/09/12 20:53:33]

Delete comment. And maybe add a line with deps that would get linked.

[Chris Masone, 2014/09/12 22:56:37]

Done.

+    "  }\n";
+
 const char kConfigs[] = "configs";
 const char kConfigs_HelpShort[] =
     "configs: [label list] Configs applying to this target.";
 const char kConfigs_Help[] =
     "configs: Configs applying to this target.\n"
     "\n"
     "  A list of config labels.\n"
     "\n"
     "  The include_dirs, defines, etc. in each config are appended in the\n"
     "  order they appear to the compile command for each file in the target.\n"
@@ skipping 530 matching lines @@
   if (info_map.empty()) {
     INSERT_VARIABLE(AllDependentConfigs)
     INSERT_VARIABLE(AllowCircularIncludesFrom)
     INSERT_VARIABLE(Args)
     INSERT_VARIABLE(Cflags)
     INSERT_VARIABLE(CflagsC)
     INSERT_VARIABLE(CflagsCC)
     INSERT_VARIABLE(CflagsObjC)
     INSERT_VARIABLE(CflagsObjCC)
     INSERT_VARIABLE(CheckIncludes)
+    INSERT_VARIABLE(CompleteStaticLib)
     INSERT_VARIABLE(Configs)
     INSERT_VARIABLE(Data)
     INSERT_VARIABLE(Datadeps)
     INSERT_VARIABLE(Defines)
     INSERT_VARIABLE(Depfile)
     INSERT_VARIABLE(Deps)
     INSERT_VARIABLE(DirectDependentConfigs)
     INSERT_VARIABLE(ForwardDependentConfigsFrom)
     INSERT_VARIABLE(IncludeDirs)
     INSERT_VARIABLE(Inputs)
     INSERT_VARIABLE(Ldflags)
     INSERT_VARIABLE(Libs)
     INSERT_VARIABLE(LibDirs)
     INSERT_VARIABLE(OutputExtension)
     INSERT_VARIABLE(OutputName)
     INSERT_VARIABLE(Outputs)
     INSERT_VARIABLE(Public)
     INSERT_VARIABLE(Script)
     INSERT_VARIABLE(Sources)
     INSERT_VARIABLE(Testonly)
     INSERT_VARIABLE(Visibility)
   }
   return info_map;
 }
 
 #undef INSERT_VARIABLE
 
 }  // namespace variables