summaryrefslogtreecommitdiffstats
path: root/contrib/libconfig-ruby/README
blob: 1a45477be1fbe9a9565c5da847353df7dd96c852 (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
# << Usage >>

# you can feed this README to irb and see the result
# $ irb README

# IMPORTANT NOTICE:
# be careful with big *fixnum* (plain int) values in configs
# int is 32 bit, but ruby fixnum is only 31!
# For example, 2100000000 will be read as -47483648.

require 'rconfig'
c = Config.new

c.read!('test.cfg')
# => IOError
c.read('test.cfg')
# => false

p c['some_var']
# => SettingNotFoundError
# note: Config#lookup is alias for Config#[]

c.append 'fixnum', Config::Fixnum.new(150)
# #<Config::Fixnum...>

f1 = Config::Fixnum.new(1)
c.append 'another_fixnum', f1

f2 = Config::Fixnum.new(256)
c.append 'next_fixnum', f2

p c.size
# => 3

c.delete(f1)            # by element
c.delete(0)             # by index
c.delete('next_fixnum') # by name
# note: (at now) you cannot delete nested elements by Config#delete
#       you can do c['nested.element'].parent.delete(c['nested.element'])

p c.size
# => 0

l = Config::List.new
c.append 'the_list', l

l.append Config::String.new("abcdef")
l << Config::Float.new(3.14)
# note: Config::List#append and Config::Array#append both have
#       aliases Config::[Aggregate]#<<

p l.name
# => "the_list"

p l.index
# => 0

p l.root?
# => false

p l.size
# => 3

l[0].format = Config::FORMAT_HEX

p l[1].value
# => 3.14

l[1].value = 2.71828

c.write 'test.cfg'

# you will get test.cfg with following contents:
#
# the_list = ( "abcdef", 2.71828, 0x2A );
#
han535-639/+317 2014-10-20Release 0+git20141009.d26b627-1debian/0+git20141009.d26b627-1Jonathan McCrohan1-2/+2 2014-10-20Fix up packaging to account for move to DVBv5Jonathan McCrohan2-2/+6 2014-10-20delete d/dtv-scan-files.install; Upstream now supplies a MakefileJonathan McCrohan2-4/+1 2014-10-15d/control: update Standards Version to 3.9.6Jonathan McCrohan2-1/+3 2014-10-15d/control: add Build-Depends on dvb-toolsJonathan McCrohan2-1/+2 2014-10-15New Upstream Snapshot (commit d26b627)Jonathan McCrohan1-0/+10 2014-10-15Imported Upstream version 0+git20141009.d26b627upstream/0+git20141009.d26b627Jonathan McCrohan2010-11120/+159271 2014-07-23Release 0+git20140611.14bd6c7-1debian/0+git20140611.14bd6c7-1Jonathan McCrohan1-2/+2 2014-07-23New Upstream Snapshot (commit 14bd6c7)Jonathan McCrohan1-2/+3 2014-07-23Imported Upstream version 0+git20140611.14bd6c7upstream/0+git20140611.14bd6c7Jonathan McCrohan7-11/+60 2014-05-13New Upstream Snapshot (commit 1246b27)Jonathan McCrohan1-0/+6 2014-05-13Imported Upstream version 0+git20140512.1246b27upstream/0+git20140512.1246b27Jonathan McCrohan391-301/+3983 2014-04-05Release 0+git20140326.cfc2975-1debian/0+git20140326.cfc2975-1Jonathan McCrohan1-2/+2 2014-04-05d/control: update Homepage (upstream has moved from Gitweb to cgit)Jonathan McCrohan2-1/+2 2014-04-05New Upstream Snapshot (commit cfc2975)Jonathan McCrohan1-0/+6 2014-04-05Imported Upstream version 0+git20140326.cfc2975upstream/0+git20140326.cfc2975Jonathan McCrohan118-656/+877 2014-01-16Release 0+git20140107.1850cf8-1debian/0+git20140107.1850cf8-1Jonathan McCrohan1-2/+2 2014-01-16Update Standards Version to 3.9.5Jonathan McCrohan2-1/+9