git_tracker.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// Copyright (C) 2021 CERN & University of Surrey for the benefit of the
// BioDynaMo collaboration. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
//
// See the LICENSE file distributed with this work for details.
// See the NOTICE file distributed with this work for additional information
// regarding copyright ownership.
//
// -----------------------------------------------------------------------------
 
#ifdef USE_LIBGIT2
#ifndef GIT_TRACKER_H_
#define GIT_TRACKER_H_
 
#include <iostream>
#include <string>
 
namespace bdm {
 
class GitTracker {
 public:
  GitTracker() { ConstructFolderNames(); };
  explicit GitTracker(const std::string& simulation_output) : GitTracker() {
    simulation_output_ = GetAbsolutePath(simulation_output);
  }
  ~GitTracker() = default;
 
  void SaveGitDetails();
 
  void SaveGitInfo(const std::string& file,
                   const std::string& repository_path) const;
 
  void PrintGitInfo(const std::string& repository_path,
                    std::ostream& out = std::cout) const;
 
  void SaveGitDiff(const std::string& file,
                   const std::string& repository_path) const;
 
  void SetBdmInstallation(const std::string& path) {
    bdm_installation_ = GetAbsolutePath(path);
  }
 
  void SetSimulationOutput(const std::string& path) {
    simulation_output_ = GetAbsolutePath(path);
  }
 
  void SetCwd(const std::string& path) { cwd_ = GetAbsolutePath(path); }
 
 private:
  std::string GetAbsolutePath(const std::string& path) const;
 
  void ConstructFolderNames();
 
  std::string bdm_installation_ = "";
  std::string simulation_output_ = "";
  std::string cwd_ = "";
};
 
}  // namespace bdm
 
#endif  // GIT_TRACKER_H_
#endif  // USE_LIBGIT2