Class: UCL

Inherits:
Object
  • Object
show all
Defined in:
ext/ucl.c,
ext/ucl.c

Overview

UCL configuration file.

Defined Under Namespace

Classes: Error

Constant Summary collapse

KEY_LOWERCASE =

Constants

INT2FIX(UCL_PARSER_KEY_LOWERCASE)
NO_TIME = 
INT2FIX(UCL_PARSER_NO_TIME      )
DISABLE_MACRO = 
INT2FIX(UCL_PARSER_DISABLE_MACRO)
NO_FILEVARS = 
INT2FIX(UCL_PARSER_NO_FILEVARS  )
KEY_SYMBOL = 
INT2FIX(UCL_PARSER_KEY_SYMBOL   )

Class Method Summary collapse

Class Method Details

.load_file(*args) ⇒ Object

Load configuration file

Examples:

UCL.load_file('foo.conf', UCL::KEY_SYMBOL)

Parameters:

  • file (String)
  • flags (Integer)

Returns:

  • configuration file as ruby objects.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'ext/ucl.c', line 171

static VALUE
ucl_s_load_file(int argc, VALUE *argv, VALUE klass)
{
    VALUE file, flags;
    rb_scan_args(argc, argv, "11", &file, &flags);

    VALUE read_kwargs = rb_hash_new();
    rb_hash_aset(read_kwargs, rb_id2sym(rb_intern("encoding")),
		 rb_str_new_cstr("BINARY"));

    VALUE read_args[] = { file, read_kwargs };
    VALUE data = rb_funcallv_kw(rb_cFile, rb_intern("read"),
				2, read_args, RB_PASS_KEYWORDS);

    VALUE parse_args[] = { data, flags };
    return ucl_s_parse(2, parse_args, klass);
}

.parse(*args) ⇒ Object

Parse a configuration file

Parameters:

  • data (String)
  • flags (Integer)

Returns:

  • configuration file as ruby objects.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'ext/ucl.c', line 116

static VALUE
ucl_s_parse(int argc, VALUE *argv, VALUE klass)
{
    static int allowed_flags = UCL_PARSER_KEY_LOWERCASE |
	                       UCL_PARSER_NO_TIME       |
	                       UCL_PARSER_DISABLE_MACRO |
	                       UCL_PARSER_NO_FILEVARS   ;

    VALUE data, flags;
    rb_scan_args(argc, argv, "11", &data, &flags);
    if (NIL_P(flags)) flags = INT2FIX(0);

    rb_check_type(data,  T_STRING);
    rb_check_type(flags, T_FIXNUM);
	
    int c_flags = FIX2INT(flags) & allowed_flags;

    struct ucl_parser *parser =
	ucl_parser_new(c_flags | UCL_PARSER_NO_IMPLICIT_ARRAYS);

    ucl_parser_add_chunk(parser,
			 (unsigned char *)RSTRING_PTR(data),
			 RSTRING_LEN(data));
    
    if (ucl_parser_get_error(parser)) {
	rb_raise(eUCLError, "%s", ucl_parser_get_error(parser));
    }

    ucl_object_t *root = ucl_parser_get_object(parser);

    VALUE res = _iterate_valid_ucl(root, FIX2INT(flags));

    if (parser != NULL) {
	ucl_parser_free(parser);
    }
    
    if (root != NULL) {
	ucl_object_unref(root);
    }
    
    return res;
}