blob: 3a823cdb20e92d4143fbe2582e3f147c395f61bd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
# Installation and building
This chapter contains the instructions to build and install the Go library.
## Dependencies
This section contains the dependencies needed to build the library on Linux and Windows
### Linux
To build the GO shared library using Linux you need the following dependencies:
- [Go](https://go.dev/doc/install) 1.15 or later
- [Gcc](https://gcc.gnu.org/)
- [GNU Make](https://www.gnu.org/software/make/)
- Dependencies for each wrapper you are interested in
### Windows
On Windows, you can install gcc and make (or even Go) via MinGW or Cygwin or use WSL. For MinGW:
1. [Install MinGW](https://www.msys2.org/#installation) (you don't need to install any extra packages yet) and open some
MSYS2 terminal (e.g. from the start menu or one of the installed binaries)
2. Install the [`make`](https://packages.msys2.org/package/make?repo=msys) package (`pacman -S make`) (or
e.g. [`mingw-w64-x86_64-make`](https://packages.msys2.org/package/mingw-w64-x86_64-make?repo=mingw64) and
use `mingw32-make` in the command line)
3. To compile for x86_64:
1. Install the [`mingw-w64-x86_64-gcc`](https://packages.msys2.org/package/mingw-w64-x86_64-gcc?repo=mingw64)
package
2. Open the MinGW 64-bit console, via the start menu, or in your current
terminal: `path/to/msys64/msys2_shell.cmd -mingw64 -defterm -no-start -use-full-path`
3. Run the make commands in the project directory
4. To compile for x86 (32-bit):
1. Install the [`mingw-w64-i686-gcc`](https://packages.msys2.org/package/mingw-w64-i686-gcc?repo=mingw32) package
2. Open the MinGW 32-bit console, via the start menu, or in your current
terminal: `path/to/msys64/msys2_shell.cmd -mingw32 -defterm -no-start -use-full-path`
3. Run the make commands in the project directory
## Building
To build the shared library for the current platform issue the following command in the root directory:
```shell
make
```
Build shared library for specified OS & architecture (example):
```shell
make GOOS=windows GOARCH=386
```
To list all platforms supported by cgo, run `go tool dist list`.
Results will be output in `exports/lib/`.
Usually you will need to specify the compiler when cross compiling, for example:
```shell
make GOOS=windows GOARCH=amd64 CC=x86_64-w64-mingw32-gcc
```
For example, you can cross compile for Windows from Linux using [MinGW-w64](https://www.mingw-w64.org/downloads/).
Test Go code:
```shell
make test-go
```
## Testing
To test the wrappers, issue the following command in a shell (you will need compilers for all wrappers if you do this):
```shell
make test-wrappers
```
Specify `-j` to execute tests in parallel. You can specify specific wrappers to test by appending
e.g. `WRAPPERS="csharp php"`.
Test both:
```shell
make test
```
Clean built libraries and wrapper builds:
```shell
make -j clean
```
Usually you won't need to do this, as changes in the library should automatically be incorporated in wrappers.
Specify `CLEAN_ALL=1` to also remove downloaded dependencies for some wrappers. You can clean individual wrappers by
executing clean in their directories, or specify `WRAPPERS=...`.
|
