config_values_extractors.h revision 58537e28ecd584eab876aee8be7156509866d23a
1d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch// Copyright (c) 2013 The Chromium Authors. All rights reserved. 2d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch// Use of this source code is governed by a BSD-style license that can be 3d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch// found in the LICENSE file. 4d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch 5d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch#ifndef TOOLS_GN_CONFIG_VALUES_EXTRACTORS_H_ 6d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch#define TOOLS_GN_CONFIG_VALUES_EXTRACTORS_H_ 7d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch 8d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch#include <ostream> 9d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch#include <string> 10d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch#include <vector> 11d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch 12d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch#include "tools/gn/config.h" 13d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch#include "tools/gn/config_values.h" 14d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch#include "tools/gn/target.h" 15d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch 163551c9c881056c480085172ff9840cab31610854Torne (Richard Coles)struct EscapeOptions; 173551c9c881056c480085172ff9840cab31610854Torne (Richard Coles) 1858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// Provides a way to iterate through all ConfigValues applying to a given 1958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// target. This is more complicated than normal because the target has a list 2058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// of configs applying to it, and also config values on the target itself. 2158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// 2258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// This iterator allows one to iterate through all of these in a defined order 2358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// in one convenient loop. The order is defined to be the ConfigValues on the 2458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// target itself first, then the applying configs, in order. 2558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// 2658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// Example: 2758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// for (ConfigValueIterator iter(target); !iter.done(); iter.Next()) 2858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)// DoSomething(iter->cur()); 2958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)class ConfigValuesIterator { 3058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) public: 3158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) explicit ConfigValuesIterator(const Target* target) 3258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) : target_(target), 3358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) cur_index_(-1) { 3458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) } 3558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 3658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) bool done() const { 3758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) return cur_index_ >= static_cast<int>(target_->configs().size()); 3858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) } 3958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 4058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) const ConfigValues& cur() const { 4158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) if (cur_index_ == -1) 4258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) return target_->config_values(); 4358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) return target_->configs()[cur_index_]->config_values(); 4458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) } 4558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 4658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) void Next() { 4758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) cur_index_++; 4858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) } 4958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 5058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) // Returns the config holding the current config values, or NULL for those 5158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) // config values associated with the target itself. 5258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) const Config* GetCurrentConfig() const { 5358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) if (cur_index_ == -1) 5458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) return NULL; 5558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) return target_->configs()[cur_index_]; 5658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) } 5758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 5858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) private: 5958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) const Target* target_; 6058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 6158537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) // Represents an index into the target_'s configs() or, when -1, the config 6258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) // values on the target itself. 6358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) int cur_index_; 6458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)}; 6558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 66d3868032626d59662ff73b372b5d584c1d144c53Ben Murdochtemplate<typename T, class Writer> 67d3868032626d59662ff73b372b5d584c1d144c53Ben Murdochinline void ConfigValuesToStream( 68d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch const ConfigValues& values, 69d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch const std::vector<T>& (ConfigValues::* getter)() const, 70d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch const Writer& writer, 71d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch std::ostream& out) { 72d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch const std::vector<T>& v = (values.*getter)(); 73d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch for (size_t i = 0; i < v.size(); i++) 74d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch writer(v[i], out); 75d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch}; 76d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch 772385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch// Writes a given config value that applies to a given target. This collects 782385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch// all values from the target itself and all configs that apply, and writes 792385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch// then in order. 80d3868032626d59662ff73b372b5d584c1d144c53Ben Murdochtemplate<typename T, class Writer> 81d3868032626d59662ff73b372b5d584c1d144c53Ben Murdochinline void RecursiveTargetConfigToStream( 82d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch const Target* target, 83d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch const std::vector<T>& (ConfigValues::* getter)() const, 84d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch const Writer& writer, 85d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch std::ostream& out) { 8658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) for (ConfigValuesIterator iter(target); !iter.done(); iter.Next()) 8758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) ConfigValuesToStream(iter.cur(), getter, writer, out); 88d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch} 89d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch 90d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch// Writes the values out as strings with no transformation. 91d3868032626d59662ff73b372b5d584c1d144c53Ben Murdochvoid RecursiveTargetConfigStringsToStream( 92d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch const Target* target, 93d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch const std::vector<std::string>& (ConfigValues::* getter)() const, 943551c9c881056c480085172ff9840cab31610854Torne (Richard Coles) const EscapeOptions& escape_options, 95d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch std::ostream& out); 96d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch 97d3868032626d59662ff73b372b5d584c1d144c53Ben Murdoch#endif // TOOLS_GN_CONFIG_VALUES_EXTRACTORS_H_ 98