Home | History | Annotate | Download | only in src
      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 #include "checks.h"
     31 
     32 namespace v8 {
     33 namespace internal {
     34 
     35 // Declare all of our flags.
     36 #define FLAG_MODE_DECLARE
     37 #include "flag-definitions.h"
     38 
     39 // The global list of all flags.
     40 class FlagList {
     41  public:
     42   // The list of all flags with a value different from the default
     43   // and their values. The format of the list is like the format of the
     44   // argv array passed to the main function, e.g.
     45   // ("--prof", "--log-file", "v8.prof", "--nolazy").
     46   //
     47   // The caller is responsible for disposing the list, as well
     48   // as every element of it.
     49   static List<const char*>* argv();
     50 
     51   // Set the flag values by parsing the command line. If remove_flags is
     52   // set, the flags and associated values are removed from (argc,
     53   // argv). Returns 0 if no error occurred. Otherwise, returns the argv
     54   // index > 0 for the argument where an error occurred. In that case,
     55   // (argc, argv) will remain unchanged independent of the remove_flags
     56   // value, and no assumptions about flag settings should be made.
     57   //
     58   // The following syntax for flags is accepted (both '-' and '--' are ok):
     59   //
     60   //   --flag        (bool flags only)
     61   //   --noflag      (bool flags only)
     62   //   --flag=value  (non-bool flags only, no spaces around '=')
     63   //   --flag value  (non-bool flags only)
     64   //   --            (equivalent to --js_arguments, captures all remaining args)
     65   static int SetFlagsFromCommandLine(int* argc, char** argv, bool remove_flags);
     66 
     67   // Set the flag values by parsing the string str. Splits string into argc
     68   // substrings argv[], each of which consisting of non-white-space chars,
     69   // and then calls SetFlagsFromCommandLine() and returns its result.
     70   static int SetFlagsFromString(const char* str, int len);
     71 
     72   // Reset all flags to their default value.
     73   static void ResetAllFlags();
     74 
     75   // Print help to stdout with flags, types, and default values.
     76   static void PrintHelp();
     77 };
     78 
     79 } }  // namespace v8::internal
     80 
     81 #endif  // V8_FLAGS_H_
     82