Add GN variables for controlling header checking.

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 263 matching lines @@
     "  This addition happens in a second phase once a target and all of its\n"
     "  dependencies have been resolved. Therefore, a target will not see\n"
     "  these force-added configs in their \"configs\" variable while the\n"
     "  script is running, and then can not be removed. As a result, this\n"
     "  capability should generally only be used to add defines and include\n"
     "  directories necessary to compile a target's headers.\n"
     "\n"
     "  See also \"direct_dependent_configs\".\n"
     COMMON_ORDERING_HELP;
 
+const char kAllowCircularIncludesFrom[] = "allow_circular_includes_from";
+const char kAllowCircularIncludesFrom_HelpShort[] =
+    "allow_circular_includes_from: [label list] Permit include cycles.";

[viettrungluu, 2014/08/28 19:47:54]

"include cycles" is inaccurate and misleading.

+const char kAllowCircularIncludesFrom_Help[] =
+    "allow_circular_includes_from: Permit include cycles from listed targets.\n"

[viettrungluu, 2014/08/28 19:47:54]

"Permit includes from the listed targets, which are dependencies of this
target."?

+    "\n"
+    "  A list of target labels. Must be a subset of the target's \"deps\".\n"
+    "\n"
+    "  Normally, for a file in target A to include a file from target B,\n"
+    "  A must list B as a dependency. This invariant is enforced by the\n"
+    "  \"gn check\" command (and the --check flag to \"gn gen\").\n"
+    "\n"
+    "  Sometimes, two targets might be the same unit for linking purposes\n"
+    "  (two source sets or static libraries that would always be linked\n"
+    "  together in a final executable or shared library). In this case,\n"
+    "  you want A to be able to include B's headers, and B to include A's\n"
+    "  headers.\n"
+    "\n"
+    "  This list, if specified, lists which of the dependencies of the\n"
+    "  current target can include header files from the current target.\n"
+    "  That is, if A depends on B, B can only include headers from A if it is\n"

[viettrungluu, 2014/08/27 23:30:40]

Does A have to depend on B? What if you put B in this list without A depending
on B (directly or indirectly)?

[brettw, 2014/08/28 05:46:16]

It must depend on B directly, there is code in the binary_target_generator that
enforces this.

+    "  in A's allow_circular_includes_from list.\n"
+    "\n"
+    "Example\n"
+    "\n"
+    "  source_set(\"a\") {\n"
+    "    deps = [ \":b\", \":c\" ]\n"
+    "    allow_circular_includes_from = [ \":b\" ]\n"
+    "    ...\n"
+    "  }\n";
+
 const char kArgs[] = "args";
 const char kArgs_HelpShort[] =
     "args: [string list] Arguments passed to an action.";
 const char kArgs_Help[] =
     "args: Arguments passed to an action.\n"
     "\n"
     "  For action and action_foreach targets, args is the list of arguments\n"
     "  to pass to the script. Typically you would use source expansion (see\n"
     "  \"gn help source_expansion\") to insert the source file names.\n"
     "\n"
@@ skipping 29 matching lines @@
 const char kCflagsObjC[] = "cflags_objc";
 const char kCflagsObjC_HelpShort[] =
     "cflags_objc: [string list] Flags passed to the Objective C compiler.";
 const char* kCflagsObjC_Help = kCommonCflagsHelp;
 
 const char kCflagsObjCC[] = "cflags_objcc";
 const char kCflagsObjCC_HelpShort[] =
     "cflags_objcc: [string list] Flags passed to the Objective C++ compiler.";
 const char* kCflagsObjCC_Help = kCommonCflagsHelp;
 
+const char kCheckIncludes[] = "check_includes";
+const char kCheckIncludes_HelpShort[] =
+    "check_includes: [boolean] Controls whether a target's files are checked.";
+const char kCheckIncludes_Help[] =
+    "check_includes: [boolean] Controls whether a target's files are checked.\n"
+    "\n"
+    "  When true (the default), the \"gn check\" command (as well as\n"
+    "  \"gn gen\" with the --check flag) will check this target's sources\n"
+    "  and headers for proper dependencies.\n"
+    "\n"
+    "  When false, the files in this target will be skipped by default.\n"
+    "  This does not affect other targets that depend on the current target,\n"
+    "  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 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 501 matching lines @@
     INSERT_VARIABLE(TargetGenDir)
     INSERT_VARIABLE(TargetOutDir)
   }
   return info_map;
 }
 
 const VariableInfoMap& GetTargetVariables() {
   static VariableInfoMap info_map;
   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(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(Visibility)
   }
   return info_map;
 }
 
 #undef INSERT_VARIABLE
 
 }  // namespace variables