tools/gn/inherited_libraries.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef TOOLS_GN_INHERITED_LIBRARIES_H_
   6 #define TOOLS_GN_INHERITED_LIBRARIES_H_
   7
   8 #include <map>
   9 #include <utility>
  10 #include <vector>
  11
  12 #include "base/macros.h"
  13
  14 class Target;
  15
  16 // Represents an ordered uniquified set of all shared/static libraries for
  17 // a given target. These are pushed up the dependency tree.
  18 //
  19 // Maintaining the order is important so GN links all libraries in the same
  20 // order specified in the build files.
  21 //
  22 // Since this list is uniquified, appending to the list will not actually
  23 // append a new item if the target already exists. However, the existing one
  24 // may have its is_public flag updated. "Public" always wins, so is_public will
  25 // be true if any dependency with that name has been set to public.
  26 class InheritedLibraries {
  27  public:
  28   InheritedLibraries();
  29   ~InheritedLibraries();
  30
  31   // Returns the list of dependencies in order, optionally with the flag
  32   // indicating whether the dependency is public.
  33   std::vector<const Target*> GetOrdered() const;
  34   std::vector<std::pair<const Target*, bool>> GetOrderedAndPublicFlag() const;
  35
  36   // Adds a single dependency to the end of the list. See note on adding above.
  37   void Append(const Target* target, bool is_public);
  38
  39   // Appends all items from the "other" list to the current one. The is_public
  40   // parameter indicates how the current target depends on the items in
  41   // "other". If is_public is true, the existing public flags of the appended
  42   // items will be preserved (propogating the public-ness up the dependency
  43   // chain). If is_public is false, all deps will be added as private since
  44   // the current target isn't forwarding them.
  45   void AppendInherited(const InheritedLibraries& other, bool is_public);
  46
  47   // Like AppendInherited but only appends the items in "other" that are of
  48   // type SHARED_LIBRARY and only when they're marked public. This is used
  49   // to push shared libraries up the dependency chain, following only public
  50   // deps, to dependent targets that need to use them.
  51   void AppendPublicSharedLibraries(const InheritedLibraries& other,
  52                                    bool is_public);
  53
  54  private:
  55   struct Node {
  56     Node() : index(static_cast<size_t>(-1)), is_public(false) {}
  57     Node(size_t i, bool p) : index(i), is_public(p) {}
  58
  59     size_t index;
  60     bool is_public;
  61   };
  62
  63   typedef std::map<const Target*, Node> LibraryMap;
  64   LibraryMap map_;
  65
  66   DISALLOW_COPY_AND_ASSIGN(InheritedLibraries);
  67 };
  68
  69 #endif  // TOOLS_GN_INHERITED_LIBRARIES_H_