summaryrefslogtreecommitdiff
path: root/docs/markdown/Vala.md
blob: c5d2b79c1ec7f9fd0dd131b989f2747196e0e53e (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
90
91
92
93
94
95
96
97
98
---
title: Vala
short-description: Compiling Vala and Genie programs
...

# Compiling Vala applications

Meson has support for compiling Vala and Genie programs. A skeleton `meson.build` file for Vala looks like this:

```meson
project('valaprog', 'vala', 'c')

glib_dep = dependency('glib-2.0')
gobject_dep = dependency('gobject-2.0')

executable('valaprog', 'prog.vala',
           dependencies : [glib_dep, gobject_dep])
```

You must always specify `glib-2.0` and `gobject-2.0` as dependencies, because all Vala applications use them.

## Using a custom VAPI

When dealing with libraries that are not providing Vala bindings, a `--vapidir` flag can be added to extend the search path for the current project.

```meson
project('vala app', 'c', 'vala')

add_project_arguments(['--vapidir', join_paths(meson.current_source_dir(), 'vapi')],
                      language: 'vala')

glib_dep = dependency('glib-2.0')
gobject_dep = dependency('gobject-2.0')
foo_dep = dependency('foo') # 'foo.vapi' will be resolved in './vapi/foo.vapi'

executable('app', 'app.vala', dependencies: [glib_dep, gobject_dep, foo_dep])
```

In this case, make sure that the VAPI name corresponds to the pkg-config file.

If no pkg-config file is provided, you must use `find_library`. Using`declare_dependency` is cleaner because it does not require passing both dependency objects to the target.

```meson
foo_lib = meson.get_compiler('c').find_library('foo') # assuming libfoo.so is installed
foo_vapi = meson.get_compiler('vala').find_library('foo', dirs: join_paths(meson.current_source_dir(), 'vapi'))
foo_dep = declare_dependency(dependencies: [foo_lib, foo_vapi])

executable('app', 'app.vala', dependencies: [glib_dep, gobject_dep, foo_dep])
```

## VAPI without pkg-config file

Some Vala bindings do not need a corresponding pkg-config file and `dependency` is unsuitable for resolving them. It's necessary to use `find_library` in this case.

```meson
posix_dep = meson.get_compiler('vala').find_library('posix')

executable('app', 'app.vala', dependencies: [glib_dep, gobject_dep, posix_dep])
```

## Custom output names

If a library target is used, Meson automatically outputs the C header and the VAPI. They can be renamed by setting the `vala_header` and `vala_vapi` arguments respectively. In this case, the second and third elements of the `install_dir` array indicate the destination with `true` to indicate default directories (i.e. `include` and `share/vala/vapi`).

```meson
foo_lib = library('foo', 'foo.vala',
                  vala_header: 'foo.h',
                  vala_vapi: 'foo-1.0.vapi',
                  dependencies: [glib_dep, gobject_dep],
                  install: true,
                  install_dir: [true, true, true])
```

## GObject Introspection

To generate GObject Introspection metadata, the `vala_gir` option has to be set with the desired name.

The fourth element in the `install_dir` array indicate where the GIR file will be installed. The `true` value tells Meson to use the default directory (i.e. `share/gir-1.0`).

```meson
foo_lib = library('foo', 'foo.vala',
                  vala_gir: 'Foo-1.0.gir',
                  dependencies: [glib_dep, gobject_dep],
                  install: true,
                  install_dir: [true, true, true, true])
```

For the typelib, use a custom target depending on the library:

```meson
g_ir_compiler = find_program('g-ir-compiler')
custom_target('foo typelib', command: [g_ir_compiler, '--output', '@OUTPUT@', '@INPUT@'],
              input: join_paths(meson.current_build_dir(), 'Foo-1.0.gir'),
              output: 'Foo-1.0.typelib',
              depends: foo_lib,
              install: true,
              install_dir: join_paths(get_option('libdir'), 'girepository-1.0'))
```