Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/externals/ptl/include/PTL/GetEnv.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  1 //
  2 // MIT License
  3 // Copyright (c) 2020 Jonathan R. Madsen
  4 // Permission is hereby granted, free of charge, to any person obtaining a copy
  5 // of this software and associated documentation files (the "Software"), to deal
  6 // in the Software without restriction, including without limitation the rights
  7 // to use, copy, modify, merge, publish, distribute, sublicense, and
  8 // copies of the Software, and to permit persons to whom the Software is
  9 // furnished to do so, subject to the following conditions:
 10 // The above copyright notice and this permission notice shall be included in
 11 // all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
 12 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 13 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 14 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 15 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 16 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 17 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 18 //
 19 //
 20 
 21 #pragma once
 22 
 23 #include <cctype>
 24 #include <cstdlib>
 25 #include <functional>
 26 #include <iomanip>
 27 #include <iostream>
 28 #include <map>
 29 #include <mutex>
 30 #include <set>
 31 #include <sstream>  // IWYU pragma: keep
 32 #include <string>
 33 #include <tuple>
 34 #include <utility>
 35 
 36 namespace PTL
 37 {
 38 //--------------------------------------------------------------------------------------//
 39 //  use this function to get an environment variable setting +
 40 //  a default if not defined, e.g.
 41 //      int num_threads =
 42 //          GetEnv<int>("FORCENUMBEROFTHREADS",
 43 //                          std::thread::hardware_concurrency());
 44 //
 45 template <typename Tp>
 46 Tp
 47 GetEnv(const std::string& env_id, Tp _default = Tp())
 48 {
 49     char* env_var = std::getenv(env_id.c_str());
 50     if(env_var)
 51     {
 52         std::string        str_var = std::string(env_var);
 53         std::istringstream iss(str_var);
 54         Tp                 var = Tp();
 55         iss >> var;
 56         return var;
 57     }
 58 
 59     // return default if not specified in environment
 60     return _default;
 61 }
 62 
 63 //--------------------------------------------------------------------------------------//
 64 //  overload for boolean
 65 //
 66 template <>
 67 inline bool
 68 GetEnv(const std::string& env_id, bool _default)
 69 {
 70     char* env_var = std::getenv(env_id.c_str());
 71     if(env_var)
 72     {
 73         std::string var = std::string(env_var);
 74         bool        val = true;
 75         if(var.find_first_not_of("0123456789") == std::string::npos)
 76             val = (bool) atoi(var.c_str());
 77         else
 78         {
 79             for(auto& itr : var)
 80                 itr = tolower(itr);
 81             if(var == "off" || var == "false")
 82                 val = false;
 83         }
 84         return val;
 85     }
 86 
 87     // return default if not specified in environment
 88     return _default;
 89 }
 90 
 91 //--------------------------------------------------------------------------------------//
 92 
 93 }  // namespace PTL
 94