xref: /netbsd-src/external/bsd/kyua-cli/dist/utils/signals/programmer.hpp (revision 46b85cbbd3d745f264b248ec8702f62b162c7789)
1 // Copyright 2010 Google Inc.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/signals/programmer.hpp
30 /// Provides the signals::programmer class.
31 
32 #if !defined(UTILS_SIGNALS_PROGRAMMER_HPP)
33 #define UTILS_SIGNALS_PROGRAMMER_HPP
34 
35 #include <memory>
36 
37 #include "utils/noncopyable.hpp"
38 
39 namespace utils {
40 namespace signals {
41 
42 
43 /// Function type for signal handlers.
44 typedef void (*handler_type)(const int);
45 
46 
47 /// A RAII class to program signal handlers.
48 class programmer : noncopyable {
49     struct impl;
50 
51     /// Pointer to the shared internal implementation.
52     std::unique_ptr< impl > _pimpl;
53 
54 public:
55     programmer(const int, const handler_type);
56     ~programmer(void);
57 
58     void unprogram(void);
59 };
60 
61 
62 } // namespace signals
63 } // namespace utils
64 
65 #endif // !defined(UTILS_SIGNALS_PROGRAMMER_HPP)
66