Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
M
mruby
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
mruby
Commits
1f03d34f
Unverified
Commit
1f03d34f
authored
Apr 05, 2021
by
Yukihiro "Matz" Matsumoto
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
link.md: add new document for linking `libmruby`; ref #5393
parent
27d3747f
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
80 additions
and
0 deletions
+80
-0
doc/guides/link.md
doc/guides/link.md
+80
-0
No files found.
doc/guides/link.md
0 → 100644
View file @
1f03d34f
Linking `libmruby` to your application
===
You have two ways to link
`libmruby`
to your application.
*
using executable gem.
*
using normal compilation process
# Executable Gems
If your application is relatively small,
`mrbgem`
is easier way to
create the executable. By tradition, the gem name start with
`mruby-bin-`
, e.g.
`mruby-bin-debugger`
.
## `mrbgem.rake` file
The executable name is specified in
`mrbgem.rake`
file at the top of
your
`mrbgem`
directory.
```
ruby
MRuby
::
Gem
::
Specification
.
new
(
'mruby-bin-example'
)
do
|
spec
|
spec
.
license
=
'MIT'
spec
.
author
=
'mruby developers'
spec
.
summary
=
'Example for executable command gem'
spec
.
bins
=
%w(mruby-example)
# <- this is binary name
end
```
## Source tree structure
The source file for the gem executable should be in
`<gem-name>/tools/<bin-name>`
. Currently, we support C or C++ source code
(
`.c`
,
`.cpp`
,
`.cxx`
,
`.cc`
) for the executable. Ruby source files are not
supported. Put the functionality in the different gem and specify dependency to
it in
`mrbgem.rake`
.
# Normal compilation process
The
`libmruby`
is a normal library so that you can just link it to your
application. Specify proper compiler options (
`-I`
etc.) and linker options
(
`-Lmruby`
etc.) to compile and link your application. Specify those options in
your build script (e.g.
`Makefile`
).
## Compiler options
You need to specify compiler options that are compatible to mruby configuration,
for example:
*
`-I`
to specify the place for mruby header files
*
`-D`
to specify mruby configuration macros
To retrieve compiler options used to build
`mruby`
, you can use
`mruby-config`
command.
```
$ mruby-config --cflags
-std=gnu99 -g -O3 -Wall -DMRB_GC_FIXED_ARENA -I/home/matz/work/mruby/include -I/home/matz/work/mruby/build/host/include
```
## Linker options
Just like compiler options, you need to specify linker options that are
compatible to mruby configuration.
To retrieve linker options, you can use
`mruby-config`
with following options:
*
`--ldflags`
options passed to linker
*
`--ldflags-before-libs`
options passed to linker before linked libraries
*
`--lbs`
linked libraries
```
$ mruby-config --ldflags
-L/home/matz/work/mruby/build/host/lib
$ mruby-config --ldflags-before-libs
# <nothing in this case>
$ mruby-config --libs
-lmruby -lm
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment