sip_python_binding_quickstart_for_cpp_word_class.py

1# To create bindings with SIP, you typically need three files: 
2# 1. The C++ header (word.h)
3# 2. The SIP specification file (word.sip)
4# 3. The build script (project.py)
5
6# --- word.h (The C++ Library) ---
7"""
8class Word {
9    const char *the_word;
10public:
11    Word(const char *w);
12    char *reverse() const;
13};
14"""
15
16# --- word.sip (The SIP Specification) ---
17"""
18%Module word
19
20class Word {
21%TypeHeaderCode
22#include "word.h"
23%End
24
25public:
26    Word(const char *w);
27    char *reverse() const;
28};
29"""
30
31# --- project.py (The Build Script using SIP's build system) ---
32import os
33from sipbuild import Project
34
35class WordProject(Project):
36    def __init__(self):
37        super().__init__()
38
39    def get_dunder_init(self):
40        return ""
41
42if __name__ == "__main__":
43    from sipbuild.api import prepare_project
44    # This script is typically invoked via 'sip-build' or 'sip-install'
45    # but the API can be used to programmaticlly handle the project metadata.
46    pass
47
48# --- Usage in Python (after running sip-install) ---
49# import word
50# w = word.Word("Hello")
51# print(w.reverse())