Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neko-box-coder/system2.cpp
A C++ wrapper for System2, for executing shell commands or running processes
https://github.com/neko-box-coder/system2.cpp
command cpp shell sub-process subprocess subprocess-run system
Last synced: 7 days ago
JSON representation
A C++ wrapper for System2, for executing shell commands or running processes
- Host: GitHub
- URL: https://github.com/neko-box-coder/system2.cpp
- Owner: Neko-Box-Coder
- License: unlicense
- Created: 2024-10-07T03:05:35.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-10-20T21:23:00.000Z (2 months ago)
- Last Synced: 2024-10-31T05:05:30.974Z (about 2 months ago)
- Topics: command, cpp, shell, sub-process, subprocess, subprocess-run, system
- Language: C++
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# System2 C++ Wrapper
This is a thin C++ wrapper for the [System2](https://github.com/Neko-Box-Coder/System2) library, a cross-platform C library for executing shell commands and subprocesses with input/output redirection capabilities.
## Features
- Provides a C++ interface to the System2 library
- Uses `std::string` and `std::vector` for easier memory management
- Maintains all functionality of the original C library
- Cross-platform support (POSIX and Windows)
## Usage
1. Clone this repository recursively.
2. This wrapper can be included as header only or be linked as library
- CMake: Set `SYSTEM2_CPP_USE_SOURCE` accordingly and link it by doing `target_link_libraries(YourTarget System2Cpp)`
- Header Only: Add `External/System2` and this directory to your project include paths and include `System2.hpp` in your code.
- Link As Library Manually: Same as Header only, then add `System2.cpp` to your project, define `SYSTEM2_CPP_USE_SOURCE=1` either in your project or before `#include "System2.hpp"`
## API
The C++ wrapper provides the following functions:
```cpp
SYSTEM2_RESULT System2CppRun(const std::string& command, System2CommandInfo& inOutCommandInfo);
SYSTEM2_RESULT System2CppRunSubprocess(const std::string& executable,
const std::vector& args,
System2CommandInfo& inOutCommandInfo);
SYSTEM2_RESULT System2CppReadFromOutput(const System2CommandInfo& info,
std::string& outputBuffer);
SYSTEM2_RESULT System2CppWriteToInput(const System2CommandInfo& info,
const std::string& inputBuffer);
SYSTEM2_RESULT System2CppGetCommandReturnValueAsync(const System2CommandInfo& info,
int& outReturnCode);
SYSTEM2_RESULT System2CppGetCommandReturnValueSync(const System2CommandInfo& info,
int& outReturnCode);
```
These functions correspond directly to their C counterparts in the System2 library, with the main differences being the use of `std::string` for command and input/output buffers, and `std::vector` for command arguments.
## Example
Here's a basic example of how to use the System2 C++ wrapper:
```cpp
#include "System2.hpp"
#include
int main()
{
System2CommandInfo commandInfo = {};
commandInfo.RedirectOutput = true;
std::string command = "echo Hello, World!";
SYSTEM2_RESULT result = System2CppRun(command, commandInfo);
if(result == SYSTEM2_RESULT_SUCCESS)
{
std::string output;
System2CppReadFromOutput(commandInfo, output);
std::cout << "Command output: " << output << std::endl;
int returnCode;
System2CppGetCommandReturnValueSync(commandInfo, returnCode);
std::cout << "Command return code: " << returnCode << std::endl;
}
else
{
std::cerr << "Failed to run command" << std::endl;
}
return 0;
}
```
## Notes
- This wrapper maintains the same behavior and return values as the original C library.
- For detailed information about the `System2CommandInfo` structure and `SYSTEM2_RESULT` enum, please refer to the original System2 library documentation.
- The wrapper does not add any additional error handling or resource management beyond what the C library provides.