program_wrapper.hpp

//--------------------------------------------------------------------------------------------------
// Copyright (c) 2018 Marcus Geelnard
//
// This software is provided 'as-is', without any express or implied warranty. In no event will the
// authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose, including commercial
// applications, and to alter it and redistribute it freely, subject to the following restrictions:
//
//  1. The origin of this software must not be misrepresented; you must not claim that you wrote
//     the original software. If you use this software in a product, an acknowledgment in the
//     product documentation would be appreciated but is not required.
//
//  2. Altered source versions must be plainly marked as such, and must not be misrepresented as
//     being the original software.
//
//  3. This notice may not be removed or altered from any source distribution.
//--------------------------------------------------------------------------------------------------
 
#ifndef BUILDCACHE_PROGRAM_WRAPPER_HPP_
#define BUILDCACHE_PROGRAM_WRAPPER_HPP_
 
#include <base/file_utils.hpp>
#include <base/string_list.hpp>
#include <cache/cache.hpp>
#include <cache/expected_file.hpp>
#include <sys/sys_utils.hpp>
 
#include <string>
 
namespace bcache {
class program_wrapper_t {
public:
  virtual ~program_wrapper_t();
 
  bool handle_command(int& return_code);
 
  virtual bool can_handle_command() = 0;
 
protected:
  class capabilities_t {
  public:
    capabilities_t();
    capabilities_t(const string_list_t& cap_strings);
 
    bool create_target_dirs() const {
      return m_create_target_dirs;
    }
 
    bool direct_mode() const {
      return m_direct_mode;
    }
 
    bool hard_links() const {
      return m_hard_links;
    }
 
  private:
    bool m_create_target_dirs = false;
    bool m_direct_mode = false;
    bool m_hard_links = false;
  };
 
  // This constructor is called by derived classes.
  program_wrapper_t(const file::exe_path_t& exe_path, const string_list_t& args);
 
  virtual void resolve_args();
 
  virtual string_list_t get_capabilities();
 
  virtual std::map<std::string, expected_file_t> get_build_files();
 
  virtual std::string get_program_id();
 
  virtual string_list_t get_relevant_arguments();
 
  virtual std::map<std::string, std::string> get_relevant_env_vars();
 
  virtual string_list_t get_input_files();
 
  virtual std::string preprocess_source();
 
  virtual string_list_t get_implicit_input_files();
 
  virtual sys::run_result_t run_for_miss();
 
  const file::exe_path_t& m_exe_path;
  const string_list_t& m_args;
 
  capabilities_t m_active_capabilities;
 
private:
  std::string get_program_id_cached();
 
  cache_t m_cache;
};
}  // namespace bcache
 
#endif  // BUILDCACHE_PROGRAM_WRAPPER_HPP_