A library that simplifies proxying stub functions in c
Project description
k3stubproxy
An proxy implementation to be used by embedded c stub implementations
Stub generation
Use the cli tool k3stubproxy-generate-stub included in this package.
Requirements:
- Stub functions begin with extern
- In the code documnetation a parameter is labled in/out in the following style
- param [in] variableName
- param [out] variableName
Example CLI Usage
k3stubproxy-generate-stub -v ../Code/HAL/HAL_*.c --func_prefix HAL_ -o ../Code/HAL/high_level_stub/ --filename_suffix _teststub --file_header defheader.txt --stub_function_definition_out stub_function_definition.json
Other CLI Tools (Version 0.2.1)
- k3stubproxy-generate-target-stub (Generate a python target stub using the stub function definition created by k3stubproxy-generate-stub
- k3stubproxy-analyse-stub-function-definition (Given the stub function definition, show stub functions and used input, output and return types)
Example usage within C
C API usage
#include "Stub_Connector_Interface.h"
...
if initStubConnector(NULL) != 0
{
// error
return 1;
}
Provide Implementations for the following functions:
PyObject* convert_input_to_python_object(va_list valist, int parameterPos, char* typeString);
int convert_python_object_to_output(va_list valist, int parameterPos, char* typeString, PyObject* outputObject);
And include the files Stub_Connector_Implementation.c,Stub_Connector_Interface.h from within k3stubproxy/c_stub and the replace the standard implementation with generated stub when compiling and linking.
General Information About Embedding Python Within C
char* phDir = "/some/path/to/a/venv";
printf("INFO: Using virutalenv: %s", phDir);
// This should not be some hard code palth like /home/annoying_user/temp/project123
// For example in some usages of the k3stubproxy this is set dynamically to look
// beside the exe vor the venv
// Note: Need to check return of Py_DecodeLocale is != NULL
Py_SetPythonHome(Py_DecodeLocale(phDir, NULL));
//optional but recommended
wchar_t *program = Py_DecodeLocale("stub_program", NULL);
Py_SetProgramName(program);
Py_Initialize();
// Then any lib within the venv can be used via cpython
PyRun_SimpleString("import k3stubproxy;");
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
k3stubproxy-0.2.3.tar.gz
(9.7 kB
view hashes)
Built Distribution
Close
Hashes for k3stubproxy-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f35c89927851429ae7a3a7734a40477dd64ecede3999398f5c4bf5677764ba52 |
|
MD5 | 6634c04f670ef4ef25d1270a02765bca |
|
BLAKE2b-256 | 76841e877219769ea44bbfefa026e7f56b127b48f6d1a6a438df4b4fee4cdd5e |