Options.hpp

/*
 * Options.hpp
 * 
 * Copyright (C) 2019-20 by RStudio, PBC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
#ifndef LAUNCHER_PLUGINS_ABSTRACT_OPTIONS_HPP
#define LAUNCHER_PLUGINS_ABSTRACT_OPTIONS_HPP
 
#include <boost/noncopyable.hpp>
 
#include <boost/program_options/value_semantic.hpp>
 
#include <memory>
 
#include "Error.hpp"
#include "logging/Logger.hpp"
#include "system/DateTime.hpp"
 
namespace rstudio {
namespace launcher_plugins {
namespace system {
 
class FilePath;
class User;
 
}
}
}
 
namespace rstudio {
namespace launcher_plugins {
namespace options {
 
template <class T>
class Value;
class Options;
template<class T>
class Value
{
public:
   Value();
 
   explicit Value(T& io_storeTo);
 
   Value& setDefaultValue(const T& in_defaultValue);
 
private:
   PRIVATE_IMPL_SHARED(m_impl);
 
   friend class Options;
};
 
class Options : boost::noncopyable
{
public:
   class Init
   {
   public:
      explicit Init(Options& in_owner);
 
      template <class T>
      Init& operator()(const char* in_name, Value<T>& in_value, const char* in_description);
 
      template <class T>
      Init& operator()(const char* in_name, Value<T>&& in_value, const char* in_description);
 
   private:
      Options& m_owner;
   };
 
   static Options& getInstance();
 
   Init registerOptions();
 
   Error readOptions(int in_argc, const char* const in_argv[], const system::FilePath& in_location);
 
   system::TimeDuration getJobExpiryHours() const;
 
   system::TimeDuration getHeartbeatIntervalSeconds() const;
 
   logging::LogLevel getLogLevel() const;
 
   const system::FilePath& getLauncherConfigFile() const;
 
   size_t getMaxMessageSize() const;
 
   const std::string& getPluginName() const;
 
   const system::FilePath& getRSandboxPath() const;
 
  const system::FilePath& getScratchPath() const;
 
   const system::FilePath& getLoggingDir() const;
 
   Error getServerUser(system::User& out_serverUser) const;
 
   size_t getThreadPoolSize() const;
 
   bool useUnprivilegedMode() const;
   
   bool enableDebugLogging() const;
 
private:
   Options();
 
   // The private implementation of Options.
   PRIVATE_IMPL(m_impl);
 
   friend Init;
};
 
} // namespace options
} // namespace launcher_plugins
} // namespace rstudio
 
#endif