summaryrefslogtreecommitdiffstats
path: root/contrib/libconfig-ruby/README
blob: 1a45477be1fbe9a9565c5da847353df7dd96c852 (plain)
1
2
3
4
5
6
7
8
9
10
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Rese
# << 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 );
#