Skip to content

Commit d870abc

Browse files
committed
Cython binding! + better build system
1 parent eb92813 commit d870abc

File tree

14 files changed

+32296
-19
lines changed

14 files changed

+32296
-19
lines changed

CMakeLists.txt

+4-3
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ set(HEADER_FILES
1818

1919
add_library(dynamic-bits SHARED ${SOURCES} ${HEADER_FILES})
2020

21-
add_executable(test test.c)
22-
target_link_libraries(test PUBLIC dynamic-bits m)
23-
2421
set(CMAKE_BUILD_TYPE Release)
2522
set(CMAKE_CXX_STANDARD 17)
2623
set(CMAKE_CXX_STANDARD_REQUIRED True)
@@ -30,6 +27,10 @@ set_target_properties(${PROJECT_NAME}
3027
PUBLIC_HEADER "${HEADER_FILES}"
3128
)
3229

30+
if (UNIX)
31+
set(CMAKE_INSTALL_PREFIX "/usr")
32+
endif (UNIX)
33+
3334
install(TARGETS dynamic-bits
3435
CONFIGURATIONS Release
3536
LIBRARY DESTINATION lib

README.md

+8-14
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
<a href="https://www.buymeacoffee.com/st1vms"><img src="https://img.buymeacoffee.com/button-api/?text=1 Pizza Margherita&emoji=🍕&slug=st1vms&button_colour=0fa913&font_colour=ffffff&font_family=Bree&outline_colour=ffffff&coffee_colour=FFDD00" /></a>
22
# dynamic-bits
33

4+
45
## Table of content
56

67
- [Overview](#overview)
78
- [Linux Installation](#linux-installation)
8-
- [Building on Linux (Cmake)](#building-on-linux-cmake)
9+
- [Installing on Linux (Cmake)](#installing-on-linux-cmake)
910
- [Android Installation](#manual-android-installation)
1011
- [Uninstalling](#uninstalling)
1112
- [Usage](#usage)
@@ -26,6 +27,7 @@ Programmers must register their packets in the table before any de/serialization
2627

2728
# Linux-Installation
2829

30+
## Requirements
2931
## Requirements
3032

3133
- [cmake](https://cmake.org/install/) is required in order to build this library.
@@ -45,25 +47,17 @@ It is drastically important to tweak this value in order to optimize space requi
4547
4648
*PacketTableByteSize = 255 * (MAX_PACKET_FIELDS) bytes*
4749
48-
## Building-On-Linux-CMake
50+
## Installing-On-Linux-CMake
4951
50-
After configuration is done, open a terminal inside the repository directory, make a build folder and generate build files using cmake.
52+
After configuration is done, open a terminal inside the repository directory, and execute these commands.
5153
```
52-
cd ./dynamic-bits
53-
mkdir build
54-
cd build
55-
cmake .. && cmake --build .
54+
chmod u+x ./build.sh
55+
./build.sh && sudo make install -C build/
5656
```
5757
5858
Inside the build folder you will find the generated shared library.
5959
60-
To install the library on Linux run these two commands inside build folder...
61-
62-
```
63-
sudo make install
64-
sudo ldconfig /usr/local/lib
65-
```
66-
60+
The library will be already installed on your system...
6761
6862
# Manual-Android-Installation
6963

binds/Android/JDBits/jdbits/src/main/cpp/include/dpacket.h

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
#ifndef __DPACKET_H
22

3-
const unsigned int PACKET_TABLE_SIZE = (1<<8)-1;
3+
#define PACKET_TABLE_SIZE ((1<<8)-1)
44

55
// Max number of fields x packet
66
#define MAX_PACKET_FIELDS 20
77

88
// The result packet table,
99
// will occupy 255*(MAX_PACKET_FIELDS) bytes
1010

11+
// The result packet table,
12+
// will occupy 255*(MAX_PACKET_FIELDS) bytes
13+
1114
#include <dtypes.h>
1215

1316
#ifdef __cplusplus

binds/python/pydbits/.gitignore

+160
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
154+
155+
# PyCharm
156+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158+
# and can be added to the global gitignore or merged into this file. For a more nuclear
159+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160+
#.idea/

binds/python/pydbits/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)