15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2005, Google Inc. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// All rights reserved. 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Redistribution and use in source and binary forms, with or without 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modification, are permitted provided that the following conditions are 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// met: 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions of source code must retain the above copyright 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// notice, this list of conditions and the following disclaimer. 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions in binary form must reproduce the above 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the documentation and/or other materials provided with the 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// distribution. 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Neither the name of Google Inc. nor the names of its 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// contributors may be used to endorse or promote products derived from 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this software without specific prior written permission. 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// --- 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file is a compatibility layer that defines Google's version of 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// command line flags that are used for configuration. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// We put flags into their own namespace. It is purposefully 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// named in an opaque way that people should have trouble typing 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// directly. The idea is that DEFINE puts the flag in the weird 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// namespace, and DECLARE imports the flag from there into the 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// current namespace. The net result is to force people to use 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DECLARE to get access to a flag, rather than saying 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// extern bool FLAGS_logtostderr; 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// or some such instead. We want this so we can put extra 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// functionality (like sanity-checking) in DECLARE if we want, 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and make sure it is picked up everywhere. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// We also put the type of the variable in the namespace, so that 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// people can't DECLARE_int32 something that they DEFINE_bool'd 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// elsewhere. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_COMMANDLINEFLAGS_H_ 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_COMMANDLINEFLAGS_H_ 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <config.h> 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string.h> // for memchr 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdlib.h> // for getenv 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DECLARE_VARIABLE(type, name) \ 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) namespace FLAG__namespace_do_not_use_directly_use_DECLARE_##type##_instead { \ 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) extern PERFTOOLS_DLL_DECL type FLAGS_##name; \ 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } \ 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) using FLAG__namespace_do_not_use_directly_use_DECLARE_##type##_instead::FLAGS_##name 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_VARIABLE(type, name, value, meaning) \ 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) namespace FLAG__namespace_do_not_use_directly_use_DECLARE_##type##_instead { \ 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PERFTOOLS_DLL_DECL type FLAGS_##name(value); \ 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char FLAGS_no##name; \ 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } \ 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) using FLAG__namespace_do_not_use_directly_use_DECLARE_##type##_instead::FLAGS_##name 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// bool specialization 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DECLARE_bool(name) \ 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DECLARE_VARIABLE(bool, name) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_bool(name, value, meaning) \ 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DEFINE_VARIABLE(bool, name, value, meaning) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// int32 specialization 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DECLARE_int32(name) \ 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DECLARE_VARIABLE(int32, name) 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_int32(name, value, meaning) \ 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DEFINE_VARIABLE(int32, name, value, meaning) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// int64 specialization 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DECLARE_int64(name) \ 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DECLARE_VARIABLE(int64, name) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_int64(name, value, meaning) \ 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DEFINE_VARIABLE(int64, name, value, meaning) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DECLARE_uint64(name) \ 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DECLARE_VARIABLE(uint64, name) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_uint64(name, value, meaning) \ 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DEFINE_VARIABLE(uint64, name, value, meaning) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// double specialization 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DECLARE_double(name) \ 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DECLARE_VARIABLE(double, name) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_double(name, value, meaning) \ 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DEFINE_VARIABLE(double, name, value, meaning) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Special case for string, because we have to specify the namespace 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// std::string, which doesn't play nicely with our FLAG__namespace hackery. 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DECLARE_string(name) \ 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) namespace FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead { \ 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) extern std::string FLAGS_##name; \ 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } \ 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) using FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead::FLAGS_##name 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEFINE_string(name, value, meaning) \ 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) namespace FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead { \ 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string FLAGS_##name(value); \ 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char FLAGS_no##name; \ 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } \ 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) using FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead::FLAGS_##name 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// These macros (could be functions, but I don't want to bother with a .cc 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// file), make it easier to initialize flags from the environment. 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define EnvToString(envname, dflt) \ 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (!getenv(envname) ? (dflt) : getenv(envname)) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define EnvToBool(envname, dflt) \ 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (!getenv(envname) ? (dflt) : memchr("tTyY1\0", getenv(envname)[0], 6) != NULL) 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define EnvToInt(envname, dflt) \ 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (!getenv(envname) ? (dflt) : strtol(getenv(envname), NULL, 10)) 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define EnvToInt64(envname, dflt) \ 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (!getenv(envname) ? (dflt) : strtoll(getenv(envname), NULL, 10)) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define EnvToDouble(envname, dflt) \ 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (!getenv(envname) ? (dflt) : strtod(getenv(envname), NULL)) 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // BASE_COMMANDLINEFLAGS_H_ 132