annotate ruby/rbdc/README.txt @ 2:a27ef6fdc275

- assume dyncall dir is next to maintainers'
author cslag
date Thu, 31 Dec 2015 20:20:18 +0100
parents 5e159be89d73
children 80273969f043
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
1 dyncall ruby bindings
1
5e159be89d73 - ruby and sh binding updates for dc r0.9
cslag
parents: 0
diff changeset
2 Copyright 2007-2015 Tassilo Philipp
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
3
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
4
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
5 BUILD
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
6
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
7 Build and install this gem with:
2
a27ef6fdc275 - assume dyncall dir is next to maintainers'
cslag
parents: 1
diff changeset
8 (cd ../../../dyncall; make distclean) || (gem build rbdc.gemspec && gem install ../../../rbdc-*.gem)
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
9
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
10
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
11 SIGNATURE FORMAT
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
12
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
13 format: "xxxxx)y"
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
14
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
15 x is positional parameter-type charcode
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
16
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
17 'B' C++: bool <- Ruby: TrueClass, FalseClass, NilClass, Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
18 'c' C: char <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
19 'C' C: unsigned char <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
20 's' C: short <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
21 'S' C: unsigned short <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
22 'i' C: int <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
23 'I' C: unsigned int <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
24 'j' C: long <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
25 'J' C: unsigned long <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
26 'l' C: long long <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
27 'L' C: unsigned long long <- Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
28 'f' C: float <- Ruby: Float
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
29 'd' C: double <- Ruby: Float
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
30 'p' C: void* <- Ruby: String (check if there are other pointer-convertible ruby types @@@)
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
31 'Z' C: void* <- Ruby: String
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
32
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33 y is result-type charcode
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
34
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
35 'v' C: void -> Ruby: NilClass
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
36 'B' C: bool -> Ruby: TrueClass, FalseClass
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
37 'c' C: char -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
38 'C' C: unsigned char -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
39 's' C: short -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
40 'S' C: unsigned short -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
41 'i' C: int -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
42 'I' C: unsigned int -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
43 'j' C: long -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
44 'J' C: unsigned long -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
45 'l' C: long long -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
46 'L' C: unsigned long long -> Ruby: Fixnum
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
47 'f' C: float -> Ruby: Float
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
48 'd' C: double -> Ruby: Float
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
49 'p' C: void* -> unsupported at the moment @@@
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
50 'Z' C: void* -> Ruby: String
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
51
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
52
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
53 -> Note that signature suffixes used to indicate calling
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
54 -> conventions, are not supported yet! @@@