hphp/compiler/option.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com)  |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15 */
  16
  17 #ifndef incl_HPHP_OPTION_H_
  18 #define incl_HPHP_OPTION_H_
  19
  20 #include <map>
  21 #include <set>
  22 #include <vector>
  23 #include "hphp/util/functional.h"
  24 #include "hphp/util/hash-map.h"
  25 #include "hphp/util/string-bag.h"
  26
  27 namespace HPHP {
  28 ///////////////////////////////////////////////////////////////////////////////
  29
  30 struct Hdf;
  31
  32 struct IniSettingMap;
  33
  34 struct Option {
  35   /**
  36    * Load options from different sources.
  37    */
  38   static void Load(const IniSettingMap& ini, Hdf &config);
  39   static void Load(); // load default options
  40
  41   /**
  42    * Directories to add to a package.
  43    */
  44   static std::string RootDirectory;
  45   static std::set<std::string> PackageDirectories;
  46
  47   /**
  48    * Files to add to a package.
  49    */
  50   static std::set<std::string> PackageFiles;
  51
  52   /**
  53    * File path patterns for excluding files from a package scan of programs.
  54    */
  55   static std::set<std::string> PackageExcludeDirs;
  56   static std::set<std::string> PackageExcludeFiles;
  57   static std::set<std::string> PackageExcludePatterns;
  58   static std::set<std::string> PackageExcludeStaticFiles;
  59   static std::set<std::string> PackageExcludeStaticDirs;
  60   static std::set<std::string> PackageExcludeStaticPatterns;
  61
  62   static bool IsFileExcluded(const std::string &file,
  63                              const std::set<std::string> &patterns);
  64   static void FilterFiles(std::vector<std::string> &files,
  65                           const std::set<std::string> &patterns);
  66
  67   /**
  68    * Directories in which files are parsed on-demand, when parse-on-demand
  69    * is off.
  70    */
  71   static std::vector<std::string> ParseOnDemandDirs;
  72
  73   /**
  74    * Whether to store PHP source files in static file cache.
  75    */
  76   static bool CachePHPFile;
  77
  78   static std::vector<std::string> IncludeSearchPaths;
  79
  80   /**
  81    * PHP functions that can be assumed to always return a certain constant
  82    * value.
  83    */
  84   static hphp_string_imap<std::string> ConstantFunctions;
  85
  86   static std::set<std::string> VolatileClasses;
  87   static std::map<std::string,std::string, stdltistr> AutoloadClassMap;
  88   static std::map<std::string,std::string, stdltistr> AutoloadFuncMap;
  89   static std::map<std::string,std::string> AutoloadConstMap;
  90   static std::string AutoloadRoot;
  91
  92   /**
  93    * CodeGenerator options for HHBC.
  94    */
  95   static bool GenerateTextHHBC;
  96   static bool GenerateHhasHHBC;
  97   static bool GenerateBinaryHHBC;
  98   static std::string RepoCentralPath;
  99
 100   static std::vector<std::string> APCProfile;
 101
 102   /**
 103    * A somewhat unique prefix for system identifiers.
 104    */
 105   static std::string IdPrefix;
 106   static std::string LambdaPrefix;
 107   static std::string Tab;
 108
 109   /**
 110    * Name resolution helpers.
 111    */
 112   static const char *UserFilePrefix;
 113
 114   /**
 115    * Turn it off for cleaner unit tests.
 116    */
 117   static bool KeepStatementsWithNoEffect;
 118
 119   /**
 120    * Turning a file name into an identifier. When id is false, preserve
 121    * "/" in file paths.
 122    */
 123   static std::string MangleFilename(const std::string &name, bool id);
 124
 125   static std::string ProgramName;
 126
 127   static bool EnableShortTags;
 128   static int ParserThreadCount;
 129
 130   static int GetScannerType();
 131
 132   /**
 133    * "Volatile" means a class or a function can be declared dynamically.
 134    */
 135   static bool AllVolatile;
 136
 137   /**
 138    * Output options
 139    */
 140   static bool WholeProgram;
 141   static bool RecordErrors;
 142
 143 private:
 144   static StringBag OptionStrings;
 145
 146   static void LoadRootHdf(const IniSettingMap& ini, const Hdf &roots,
 147                           const std::string& name,
 148                           std::map<std::string, std::string> &map);
 149 };
 150
 151 ///////////////////////////////////////////////////////////////////////////////
 152 }
 153 #endif // incl_HPHP_OPTION_H_