graph_signal_handler.h

Go to the documentation of this file.

// NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the
// software in any medium, provided that you keep intact this entire notice. You may improve, modify and create
// derivative works of the software or any portion of the software, and you may copy and distribute such modifications
// or works. Modified works should carry a notice stating that you changed the software and should note the date and
// nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the
// source of the software. NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND,
// EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR
// WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE
// CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS
// THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE. You
// are solely responsible for determining the appropriateness of using and distributing the software and you assume
// all risks associated with its use, including but not limited to the risks and costs of program errors, compliance
// with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of 
// operation. This software is not intended to be used in any situation where a failure could cause risk of injury or
// damage to property. The software developed by NIST employees is not subject to copyright protection within the
// United States.
 
 
#ifndef HEDGEHOG_GRAPH_SIGNAL_HANDLER_H
#define HEDGEHOG_GRAPH_SIGNAL_HANDLER_H
#pragma  once
 
#include <csignal>
#include <cstring>
 
#include "graph.h"
namespace hh {
template<size_t Separator, class ...AllTypes>
class GraphSignalHandler {
 private:
  static Graph<Separator, AllTypes...> *graphInstance_; 
  static bool signalHandled_; 
  static ColorScheme colorScheme; 
  static StructureOptions structureOptions; 
  static DebugOptions debugOptions; 
 
 public:
  static void handleSignal(int signum = SIGTERM) {
#ifdef _WIN32
    std::string signalString(std::to_string(signum));
#else
    std::string signalString(strsignal(signum));
#endif
 
    if (!signalHandled_) {
      signalHandled_ = true;
      std::cout << "signal caught: " << signum << ": (" << signalString << ")" << std::endl;
      graphInstance_->createDotFile(
          signalString + "-graph-output.dot", colorScheme, structureOptions, debugOptions);
    }
  }
 
  static void atExit() {
    if (graphInstance_)
      graphInstance_->createDotFile("Exit-graph-output.dot");
  }
 
  static void setColorScheme(ColorScheme scheme) {
    colorScheme = scheme;
  }
 
  static void setStructureOptions(StructureOptions options) {
    structureOptions = options;
  }
 
  static void setDebugOptions(DebugOptions options) {
    debugOptions = options;
  }
 
  static void registerGraph(Graph<Separator, AllTypes...> *graph) {
    graphInstance_ = graph;
  }
 
  static void registerSignal(int signum = SIGTERM, bool atExit = false) {
    std::signal(signum, GraphSignalHandler<Separator, AllTypes ...>::handleSignal);
    if (atExit) {
      std::atexit(GraphSignalHandler<Separator, AllTypes ...>::atExit);
    }
  }
};
 
template<size_t Separator, class ...AllTypes>
bool GraphSignalHandler<Separator, AllTypes...>::signalHandled_ = false;
 
template<size_t Separator, class ...AllTypes>
Graph<Separator, AllTypes...> *GraphSignalHandler<Separator, AllTypes...>::graphInstance_ = nullptr;
 
template<size_t Separator, class ...AllTypes>
ColorScheme GraphSignalHandler<Separator, AllTypes...>::colorScheme = ColorScheme::EXECUTION;
 
template<size_t Separator, class ...AllTypes>
StructureOptions GraphSignalHandler<Separator, AllTypes...>::structureOptions = StructureOptions::ALL;
 
template<size_t Separator, class ...AllTypes>
DebugOptions GraphSignalHandler<Separator, AllTypes...>::debugOptions = DebugOptions::ALL;
}
#endif //HEDGEHOG_GRAPH_SIGNAL_HANDLER_H