src/3rdparty/v8/src/flags.h

   1 // Copyright 2006-2008 the V8 project authors. All rights reserved.
   2 // Redistribution and use in source and binary forms, with or without
   3 // modification, are permitted provided that the following conditions are
   4 // met:
   5 //
   6 //     * Redistributions of source code must retain the above copyright
   7 //       notice, this list of conditions and the following disclaimer.
   8 //     * Redistributions in binary form must reproduce the above
   9 //       copyright notice, this list of conditions and the following
  10 //       disclaimer in the documentation and/or other materials provided
  11 //       with the distribution.
  12 //     * Neither the name of Google Inc. nor the names of its
  13 //       contributors may be used to endorse or promote products derived
  14 //       from this software without specific prior written permission.
  15 //
  16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 #ifndef V8_FLAGS_H_
  28 #define V8_FLAGS_H_
  29
  30 namespace v8 {
  31 namespace internal {
  32
  33 // Declare all of our flags.
  34 #define FLAG_MODE_DECLARE
  35 #include "flag-definitions.h"
  36
  37 // The global list of all flags.
  38 class FlagList {
  39  public:
  40   // The list of all flags with a value different from the default
  41   // and their values. The format of the list is like the format of the
  42   // argv array passed to the main function, e.g.
  43   // ("--prof", "--log-file", "v8.prof", "--nolazy").
  44   //
  45   // The caller is responsible for disposing the list, as well
  46   // as every element of it.
  47   static List<const char*>* argv();
  48
  49   // Set the flag values by parsing the command line. If remove_flags is
  50   // set, the flags and associated values are removed from (argc,
  51   // argv). Returns 0 if no error occurred. Otherwise, returns the argv
  52   // index > 0 for the argument where an error occurred. In that case,
  53   // (argc, argv) will remain unchanged independent of the remove_flags
  54   // value, and no assumptions about flag settings should be made.
  55   //
  56   // The following syntax for flags is accepted (both '-' and '--' are ok):
  57   //
  58   //   --flag        (bool flags only)
  59   //   --noflag      (bool flags only)
  60   //   --flag=value  (non-bool flags only, no spaces around '=')
  61   //   --flag value  (non-bool flags only)
  62   //   --            (equivalent to --js_arguments, captures all remaining args)
  63   static int SetFlagsFromCommandLine(int* argc, char** argv, bool remove_flags);
  64
  65   // Set the flag values by parsing the string str. Splits string into argc
  66   // substrings argv[], each of which consisting of non-white-space chars,
  67   // and then calls SetFlagsFromCommandLine() and returns its result.
  68   static int SetFlagsFromString(const char* str, int len);
  69
  70   // Reset all flags to their default value.
  71   static void ResetAllFlags();
  72
  73   // Print help to stdout with flags, types, and default values.
  74   static void PrintHelp();
  75
  76   // Set flags as consequence of being implied by another flag.
  77   static void EnforceFlagImplications();
  78 };
  79
  80 } }  // namespace v8::internal
  81
  82 #endif  // V8_FLAGS_H_