https://github.com/evgenykislov/ctrl-c

Crossplatform code to handle Ctrl+C signal
https://github.com/evgenykislov/ctrl-c

cplusplus cplusplus-11 cpp cpp11 crossplatform ctrl-c ctrlc linux macos macosx windows

Last synced: 3 months ago
JSON representation

Crossplatform code to handle Ctrl+C signal

• Host: GitHub
• URL: https://github.com/evgenykislov/ctrl-c
• Owner: evgenykislov
• License: mit
• Created: 2020-04-01T17:32:59.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-04T23:15:13.000Z (6 months ago)
• Last Synced: 2024-09-30T00:02:41.369Z (4 months ago)
• Topics: cplusplus, cplusplus-11, cpp, cpp11, crossplatform, ctrl-c, ctrlc, linux, macos, macosx, windows
• Language: C++
• Homepage:
• Size: 16.6 KB
• Stars: 20
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• trackawesomelist - Ctrl+C (⭐20) - Crossplatform C++11 library to handle Ctrl+C event in custom functions. \[MIT] (Recently Updated / [Oct 28, 2024](/content/2024/10/28/README.md))

README

        
# Ctrl+C

Crossplatform source code (C++11) to handle Ctrl+C event in custom functions.

Supports Windows, Linux and Mac OS X.

## Getting Started

To catch Ctrl+C event/signal you should call:

```cpp

unsigned int CtrlCLibrary::SetCtrlCHandler(std::function handler);

```

handler - custom handler;

**Return**:

Returns handler identifier, or CtrlCLibrary::kErrorID in case of error.

To remove handler you should call:

```cpp

void CtrlCLibrary::ResetCtrlCHandler(unsigned int id);

```

id - handler identifier, returned by CtrlCLibrary::SetCtrlCHandler.

### Installing

You should copy source files (src/ctrl-c.h, src/ctrl-c.cpp) to your project.

## Example of usage

Source file test/main.cpp contains example of usage Ctrl+C code.

You can compile the example by your favourite C++ compiler.

## Authors

**Evgeny Kislov** - [evgenykislov.com](https://evgenykislov.com), [github/evgenykislov](https://github.com/evgenykislov)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

## Notes

You can add a few handlers for Ctrl+C processing. All handlers will be called in LIFO order: first added handler will be called at last.

Each handler should return bool value:  

* *true* - to stop processing by other handlers;

* *false* - to continue processing by other handlers (also, see notes for Windows below).

The functions to set, reset and handle event are thread-safe.  *Warning*: You shouldn't remove handler from handler code. It will cause deadlock.

#### Errors

Adding a new handler can return error id (kErrorID) in case of system error or lack of memory.

#### Exceptions

The code processes its errors (and any bad_alloc into SetCtrlCHandler call). In this case it will return error identifier (kErrorID).

Other exceptions aren't processed - you should catch them by your code.

#### Linux and Mac OS X notes

Setting any handler will cause a previous handler will not work. If first setting causes error, previous handler will not work too - OS will use DEFAULT handler.

Removing of all handlers causes set DEFAULT handler for Ctrl+C.

#### Windows notes

If all handlers return **false**, a previous handler will be called. It can be default OS handler and your process will be closed.