summaryrefslogtreecommitdiff
path: root/dviware/dvisvgm/src/SignalHandler.cpp
blob: 14badba08599a8390d95aed17d3027a56b906a38 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*************************************************************************
** SignalHandler.cpp                                                    **
**                                                                      **
** This file is part of dvisvgm -- a fast DVI to SVG converter          **
** Copyright (C) 2005-2020 Martin Gieseking <martin.gieseking@uos.de>   **
**                                                                      **
** This program is free software; you can redistribute it and/or        **
** modify it under the terms of the GNU General Public License as       **
** published by the Free Software Foundation; either version 3 of       **
** the License, or (at your option) any later version.                  **
**                                                                      **
** This program is distributed in the hope that it will be useful, but  **
** WITHOUT ANY WARRANTY; without even the implied warranty of           **
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the         **
** GNU General Public License for more details.                         **
**                                                                      **
** You should have received a copy of the GNU General Public License    **
** along with this program; if not, see <http://www.gnu.org/licenses/>. **
*************************************************************************/

#include <config.h>
#include <cerrno>
#include <csignal>
#include <cstdlib>
#include "SignalHandler.hpp"
#include "utility.hpp"

using namespace std;

volatile bool SignalHandler::_break = false;

/** Helper class that encapsulates the system-specific parts of
 *  registering and handling CTRL-C (SIGINT) events. */
class SignalHandler::Impl {
	using HandlerFunc = void (*)(int);
	public:
		Impl ();
		bool setSigintHandler (HandlerFunc handler);
		bool restoreSigintHandler ();

	private:
#ifdef HAVE_SIGACTION
		struct sigaction _currentSigaction;
		struct sigaction _origSigaction;
#else
		HandlerFunc _origHandlerFunc;
#endif
};


SignalHandler::SignalHandler ()
	: _impl(util::make_unique<SignalHandler::Impl>())
{
}


SignalHandler::~SignalHandler () {
	stop();
}


/** Returns the singleton handler object. */
SignalHandler& SignalHandler::instance() {
	static SignalHandler handler;
	return handler;
}


/** Starts listening to CTRL-C signals.
 *  @return true if handler was activated. */
bool SignalHandler::start () {
	if (!_active) {
		_break = false;
		if (_impl->setSigintHandler(callback))
			_active = true;
	}
	return _active;
}


/** Stops listening for CTRL-C signals. */
void SignalHandler::stop () {
	if (_active) {
		_impl->restoreSigintHandler();
		_active = false;
	}
}


/** Checks for incoming signals and throws an exception if CTRL-C was caught.
 *  @throw SignalException */
void SignalHandler::check () {
	if (_break)
		throw SignalException();
}


void SignalHandler::trigger (bool notify) {
	_break = true;
	if (notify)
		check();
}


/** This function is called on CTRL-C signals. */
void SignalHandler::callback (int) {
	_break = true;
}


// Prefer sigaction() to signal() due to its more reliable interface and behavior.
// Use signal() as fallback on systems that don't provide sigaction().

#ifdef HAVE_SIGACTION

SignalHandler::Impl::Impl () {
	_origSigaction.sa_handler = nullptr;
}


bool SignalHandler::Impl::setSigintHandler (HandlerFunc handler) {
	sigemptyset(&_currentSigaction.sa_mask);
	_currentSigaction.sa_handler = handler;
	_currentSigaction.sa_flags = SA_SIGINFO;
	return (sigaction(SIGINT, &_currentSigaction, &_origSigaction) == 0);
}


bool SignalHandler::Impl::restoreSigintHandler () {
	if (_origSigaction.sa_handler == nullptr)
		return false;
	return (sigaction(SIGINT, &_origSigaction, nullptr) == 0);
}

#else  // !HAVE_SIGACTION

SignalHandler::Impl::Impl () : _origHandlerFunc(SIG_ERR) {
}


bool SignalHandler::Impl::setSigintHandler (HandlerFunc handler) {
	_origHandlerFunc = signal(SIGINT, handler);
	return _origHandlerFunc != SIG_ERR;
}


bool SignalHandler::Impl::restoreSigintHandler () {
	if (_origHandlerFunc == SIG_ERR)
		return false;
	return (signal(SIGINT, _origHandlerFunc) != SIG_ERR);
}

#endif