1c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Copyright (c) 2006, Google Inc. 2c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// All rights reserved. 3c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 4c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Redistribution and use in source and binary forms, with or without 5c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// modification, are permitted provided that the following conditions are 6c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// met: 7c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 8c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// * Redistributions of source code must retain the above copyright 9c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// notice, this list of conditions and the following disclaimer. 10c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// * Redistributions in binary form must reproduce the above 11c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// copyright notice, this list of conditions and the following disclaimer 12c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// in the documentation and/or other materials provided with the 13c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// distribution. 14c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// * Neither the name of Google Inc. nor the names of its 15c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// contributors may be used to endorse or promote products derived from 16c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// this software without specific prior written permission. 17c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 18c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 30c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// --- 31c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Author: Ray Sidney 32c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Revamped and reorganized by Craig Silverstein 33c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 34c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// This file contains code for handling the 'reporting' flags. These 35c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// are flags that, when present, cause the program to report some 36c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// information and then exit. --help and --version are the canonical 37c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// reporting flags, but we also have flags like --helpxml, etc. 38c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 39c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// There's only one function that's meant to be called externally: 40c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// HandleCommandLineHelpFlags(). (Well, actually, ShowUsageWithFlags(), 41c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// ShowUsageWithFlagsRestrict(), and DescribeOneFlag() can be called 42c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// externally too, but there's little need for it.) These are all 43c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// declared in the main commandlineflags.h header file. 44c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 45c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// HandleCommandLineHelpFlags() will check what 'reporting' flags have 46c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// been defined, if any -- the "help" part of the function name is a 47c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// bit misleading -- and do the relevant reporting. It should be 48c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// called after all flag-values have been assigned, that is, after 49c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// parsing the command-line. 50c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 51c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "config.h" 52c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <stdio.h> 53c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <string.h> 54c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <ctype.h> 55c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <assert.h> 56c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <string> 57c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <vector> 58c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "gflags/gflags.h" 59c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 60c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#ifndef PATH_SEPARATOR 61c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#define PATH_SEPARATOR '/' 62c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif 63c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 64c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottusing std::vector; 65c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 66c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// The 'reporting' flags. They all call exit(). 67c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_bool(help, false, 68c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott "show help on all flags [tip: all flags can have two dashes]"); 69c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_bool(helpfull, false, 70c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott "show help on all flags -- same as -help"); 71c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_bool(helpshort, false, 72c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott "show help on only the main module for this program"); 73c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_string(helpon, "", 74c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott "show help on the modules named by this flag value"); 75c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_string(helpmatch, "", 76c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott "show help on modules whose name contains the specified substr"); 77c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_bool(helppackage, false, 78c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott "show help on all modules in the main package"); 79c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_bool(helpxml, false, 80c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott "produce an xml version of help"); 81c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_bool(version, false, 82c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott "show version and build info and exit"); 83c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 84c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottnamespace google { 85c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 86c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottusing std::string; 87c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 88c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// -------------------------------------------------------------------- 89c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// DescribeOneFlag() 90c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// DescribeOneFlagInXML() 91c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Routines that pretty-print info about a flag. These use 92c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// a CommandLineFlagInfo, which is the way the commandlineflags 93c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// API exposes static info about a flag. 94c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// -------------------------------------------------------------------- 95c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 96c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic const int kLineLength = 80; 97c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 98c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic void AddString(const string& s, 99c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string* final_string, int* chars_in_line) { 100c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const int slen = static_cast<int>(s.length()); 101c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (*chars_in_line + 1 + slen >= kLineLength) { // < 80 chars/line 102c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *final_string += "\n "; 103c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *chars_in_line = 6; 104c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } else { 105c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *final_string += " "; 106c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *chars_in_line += 1; 107c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 108c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *final_string += s; 109c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *chars_in_line += slen; 110c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 111c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 112c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Create a descriptive string for a flag. 113c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Goes to some trouble to make pretty line breaks. 114c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstring DescribeOneFlag(const CommandLineFlagInfo& flag) { 115c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string main_part = (string(" -") + flag.name + 116c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott " (" + flag.description + ')'); 117c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const char* c_string = main_part.c_str(); 118c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int chars_left = static_cast<int>(main_part.length()); 119c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string final_string = ""; 120c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int chars_in_line = 0; // how many chars in current line so far? 121c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott while (1) { 122c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott assert(chars_left == strlen(c_string)); // Unless there's a \0 in there? 123c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const char* newline = strchr(c_string, '\n'); 124c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (newline == NULL && chars_in_line+chars_left < kLineLength) { 125c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // The whole remainder of the string fits on this line 126c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott final_string += c_string; 127c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott chars_in_line += chars_left; 128c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott break; 129c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 130c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (newline != NULL && newline - c_string < kLineLength - chars_in_line) { 131c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int n = static_cast<int>(newline - c_string); 132c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott final_string.append(c_string, n); 133c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott chars_left -= n + 1; 134c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott c_string += n + 1; 135c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } else { 136c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Find the last whitespace on this 80-char line 137c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int whitespace = kLineLength-chars_in_line-1; // < 80 chars/line 138c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott while ( whitespace > 0 && !isspace(c_string[whitespace]) ) { 139c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott --whitespace; 140c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 141c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (whitespace <= 0) { 142c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Couldn't find any whitespace to make a line break. Just dump the 143c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // rest out! 144c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott final_string += c_string; 145c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott chars_in_line = kLineLength; // next part gets its own line for sure! 146c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott break; 147c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 148c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott final_string += string(c_string, whitespace); 149c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott chars_in_line += whitespace; 150c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott while (isspace(c_string[whitespace])) ++whitespace; 151c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott c_string += whitespace; 152c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott chars_left -= whitespace; 153c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 154c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (*c_string == '\0') 155c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott break; 156c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott final_string += "\n "; 157c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott chars_in_line = 6; 158c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 159c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 160c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Append data type 161c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddString(string("type: ") + flag.type, &final_string, &chars_in_line); 162c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Append the effective default value (i.e., the value that the flag 163c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // will have after the command line is parsed if the flag is not 164c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // specified on the command line), which may be different from the 165c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // stored default value. This would happen if the value of the flag 166c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // was modified before the command line was parsed. (Unless the 167c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // value was modified using SetCommandLineOptionWithMode() with mode 168c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // SET_FLAGS_DEFAULT.) 169c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Note that we are assuming this code is being executed because a help 170c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // request was just parsed from the command line, in which case the 171c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // printed value is indeed the effective default, as long as no value 172c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // for the flag was parsed from the command line before "--help". 173c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (strcmp(flag.type.c_str(), "string") == 0) { // add quotes for strings 174c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddString(string("default: \"") + flag.current_value + string("\""), 175c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott &final_string, &chars_in_line); 176c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } else { 177c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddString(string("default: ") + flag.current_value, 178c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott &final_string, &chars_in_line); 179c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 180c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 181c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott final_string += '\n'; 182c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return final_string; 183c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 184c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 185c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Simple routine to xml-escape a string: escape & and < only. 186c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic string XMLText(const string& txt) { 187c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string ans = txt; 188c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott for (string::size_type pos = 0; (pos = ans.find("&", pos)) != string::npos; ) 189c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ans.replace(pos++, 1, "&"); 190c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott for (string::size_type pos = 0; (pos = ans.find("<", pos)) != string::npos; ) 191c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ans.replace(pos++, 1, "<"); 192c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return ans; 193c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 194c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 195c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic void AddXMLTag(string* r, const char* tag, const string& txt) { 196c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *r += ('<'); 197c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *r += (tag); 198c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *r += ('>'); 199c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *r += (XMLText(txt)); 200c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *r += ("</"); 201c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *r += (tag); 202c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott *r += ('>'); 203c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 204c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 205c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic string DescribeOneFlagInXML(const CommandLineFlagInfo& flag) { 206c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // The file and flagname could have been attributes, but default 207c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // and meaning need to avoid attribute normalization. This way it 208c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // can be parsed by simple programs, in addition to xml parsers. 209c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string r("<flag>"); 210c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddXMLTag(&r, "file", flag.filename); 211c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddXMLTag(&r, "name", flag.name); 212c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddXMLTag(&r, "meaning", flag.description); 213c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddXMLTag(&r, "default", flag.default_value); 214c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddXMLTag(&r, "current", flag.current_value); 215c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddXMLTag(&r, "type", flag.type); 216c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott r += "</flag>"; 217c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return r; 218c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 219c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 220c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// -------------------------------------------------------------------- 221c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// ShowUsageWithFlags() 222c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// ShowUsageWithFlagsRestrict() 223c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// ShowXMLOfFlags() 224c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// These routines variously expose the registry's list of flag 225c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// values. ShowUsage*() prints the flag-value information 226c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// to stdout in a user-readable format (that's what --help uses). 227c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// The Restrict() version limits what flags are shown. 228c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// ShowXMLOfFlags() prints the flag-value information to stdout 229c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// in a machine-readable format. In all cases, the flags are 230c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// sorted: first by filename they are defined in, then by flagname. 231c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// -------------------------------------------------------------------- 232c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 233c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic const char* Basename(const char* filename) { 234c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const char* sep = strrchr(filename, PATH_SEPARATOR); 235c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return sep ? sep + 1 : filename; 236c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 237c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 238c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic string Dirname(const string& filename) { 239c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string::size_type sep = filename.rfind(PATH_SEPARATOR); 240c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return filename.substr(0, (sep == string::npos) ? 0 : sep); 241c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 242c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 243c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Test whether a filename contains at least one of the substrings. 244c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic bool FileMatchesSubstring(const string& filename, 245c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const vector<string>& substrings) { 246c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott for (vector<string>::const_iterator target = substrings.begin(); 247c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott target != substrings.end(); 248c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ++target) { 249c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (strstr(filename.c_str(), target->c_str()) != NULL) 250c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return true; 251c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // If the substring starts with a '/', that means that we want 252c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // the string to be at the beginning of a directory component. 253c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // That should match the first directory component as well, so 254c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // we allow '/foo' to match a filename of 'foo'. 255c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (!target->empty() && (*target)[0] == '/' && 256c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott strncmp(filename.c_str(), target->c_str() + 1, 257c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott strlen(target->c_str() + 1)) == 0) 258c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return true; 259c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 260c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott return false; 261c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 262c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 263c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Show help for every filename which matches any of the target substrings. 264c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// If substrings is empty, shows help for every file. If a flag's help message 265c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// has been stripped (e.g. by adding '#define STRIP_FLAG_HELP 1' before 266c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// including gflags/gflags.h), then this flag will not be displayed by 267c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// '--help' and its variants. 268c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic void ShowUsageWithFlagsMatching(const char *argv0, 269c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const vector<string> &substrings) { 270c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "%s: %s\n", Basename(argv0), ProgramUsage()); 271c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 272c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott vector<CommandLineFlagInfo> flags; 273c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott GetAllFlags(&flags); // flags are sorted by filename, then flagname 274c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 275c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string last_filename; // so we know when we're at a new file 276c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool first_directory = true; // controls blank lines between dirs 277c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool found_match = false; // stays false iff no dir matches restrict 278c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott for (vector<CommandLineFlagInfo>::const_iterator flag = flags.begin(); 279c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott flag != flags.end(); 280c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ++flag) { 281c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (substrings.empty() || 282c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott FileMatchesSubstring(flag->filename, substrings)) { 283c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // If the flag has been stripped, pretend that it doesn't exist. 284c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (flag->description == kStrippedFlagHelp) continue; 285c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott found_match = true; // this flag passed the match! 286c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (flag->filename != last_filename) { // new file 287c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (Dirname(flag->filename) != Dirname(last_filename)) { // new dir! 288c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (!first_directory) 289c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "\n\n"); // put blank lines between directories 290c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott first_directory = false; 291c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 292c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "\n Flags from %s:\n", flag->filename.c_str()); 293c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott last_filename = flag->filename; 294c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 295c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Now print this flag 296c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "%s", DescribeOneFlag(*flag).c_str()); 297c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 298c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 299c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (!found_match && !substrings.empty()) { 300c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "\n No modules matched: use -help\n"); 301c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 302c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 303c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 304c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottvoid ShowUsageWithFlagsRestrict(const char *argv0, const char *restrict) { 305c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott vector<string> substrings; 306c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (restrict != NULL && *restrict != '\0') { 307c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott substrings.push_back(restrict); 308c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 309c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ShowUsageWithFlagsMatching(argv0, substrings); 310c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 311c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 312c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottvoid ShowUsageWithFlags(const char *argv0) { 313c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ShowUsageWithFlagsRestrict(argv0, ""); 314c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 315c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 316c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Convert the help, program, and usage to xml. 317c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic void ShowXMLOfFlags(const char *prog_name) { 318c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott vector<CommandLineFlagInfo> flags; 319c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott GetAllFlags(&flags); // flags are sorted: by filename, then flagname 320c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 321c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // XML. There is no corresponding schema yet 322c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "<?xml version=\"1.0\"?>\n"); 323c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // The document 324c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "<AllFlags>\n"); 325c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // the program name and usage 326c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "<program>%s</program>\n", 327c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott XMLText(Basename(prog_name)).c_str()); 328c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "<usage>%s</usage>\n", 329c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott XMLText(ProgramUsage()).c_str()); 330c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // All the flags 331c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott for (vector<CommandLineFlagInfo>::const_iterator flag = flags.begin(); 332c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott flag != flags.end(); 333c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ++flag) { 334c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (flag->description != kStrippedFlagHelp) 335c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "%s\n", DescribeOneFlagInXML(*flag).c_str()); 336c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 337c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // The end of the document 338c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "</AllFlags>\n"); 339c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 340c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 341c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// -------------------------------------------------------------------- 342c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// ShowVersion() 343c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Called upon --version. Prints build-related info. 344c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// -------------------------------------------------------------------- 345c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 346c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic void ShowVersion() { 347c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "%s\n", ProgramInvocationShortName()); 348c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // TODO: add other stuff, like a timestamp, who built it, what 349c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // target they built, etc. 350c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 351c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott# if !defined(NDEBUG) 352c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stdout, "Debug build (NDEBUG not #defined)\n"); 353c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott# endif 354c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 355c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 356c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottstatic void AppendPrognameStrings(vector<string>* substrings, 357c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const char* progname) { 358c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string r("/"); 359c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott r += progname; 360c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott substrings->push_back(r + "."); 361c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott substrings->push_back(r + "-main."); 362c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott substrings->push_back(r + "_main."); 363c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 364c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 365c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// -------------------------------------------------------------------- 366c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// HandleCommandLineHelpFlags() 367c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Checks all the 'reporting' commandline flags to see if any 368c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// have been set. If so, handles them appropriately. Note 369c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// that all of them, by definition, cause the program to exit 370c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// if they trigger. 371c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// -------------------------------------------------------------------- 372c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 373c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottvoid HandleCommandLineHelpFlags() { 374c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const char* progname = ProgramInvocationShortName(); 375c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott extern void (*commandlineflags_exitfunc)(int); // in gflags.cc 376c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 377c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott vector<string> substrings; 378c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AppendPrognameStrings(&substrings, progname); 379c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 380c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (FLAGS_helpshort) { 381c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // show only flags related to this binary: 382c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // E.g. for fileutil.cc, want flags containing ... "/fileutil." cc 383c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ShowUsageWithFlagsMatching(progname, substrings); 384c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott commandlineflags_exitfunc(1); // almost certainly exit() 385c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 386c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } else if (FLAGS_help || FLAGS_helpfull) { 387c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // show all options 388c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ShowUsageWithFlagsRestrict(progname, ""); // empty restrict 389c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott commandlineflags_exitfunc(1); 390c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 391c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } else if (!FLAGS_helpon.empty()) { 392c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string restrict = "/" + FLAGS_helpon + "."; 393c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ShowUsageWithFlagsRestrict(progname, restrict.c_str()); 394c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott commandlineflags_exitfunc(1); 395c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 396c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } else if (!FLAGS_helpmatch.empty()) { 397c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ShowUsageWithFlagsRestrict(progname, FLAGS_helpmatch.c_str()); 398c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott commandlineflags_exitfunc(1); 399c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 400c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } else if (FLAGS_helppackage) { 401c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Shows help for all files in the same directory as main(). We 402c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // don't want to resort to looking at dirname(progname), because 403c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // the user can pick progname, and it may not relate to the file 404c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // where main() resides. So instead, we search the flags for a 405c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // filename like "/progname.cc", and take the dirname of that. 406c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott vector<CommandLineFlagInfo> flags; 407c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott GetAllFlags(&flags); 408c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott string last_package; 409c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott for (vector<CommandLineFlagInfo>::const_iterator flag = flags.begin(); 410c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott flag != flags.end(); 411c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ++flag) { 412c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (!FileMatchesSubstring(flag->filename, substrings)) 413c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott continue; 414c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const string package = Dirname(flag->filename) + "/"; 415c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (package != last_package) { 416c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ShowUsageWithFlagsRestrict(progname, package.c_str()); 417c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (!last_package.empty()) { // means this isn't our first pkg 418c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stderr, "WARNING: Multiple packages contain a file=%s\n", 419c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott progname); 420c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 421c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott last_package = package; 422c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 423c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 424c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott if (last_package.empty()) { // never found a package to print 425c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott fprintf(stderr, "WARNING: Unable to find a package for file=%s\n", 426c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott progname); 427c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 428c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott commandlineflags_exitfunc(1); 429c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 430c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } else if (FLAGS_helpxml) { 431c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ShowXMLOfFlags(progname); 432c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott commandlineflags_exitfunc(1); 433c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 434c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } else if (FLAGS_version) { 435c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ShowVersion(); 436c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Unlike help, we may be asking for version in a script, so return 0 437c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott commandlineflags_exitfunc(0); 438c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott } 439c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 440c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 441c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} // namespace google 442