Class: Fluent::Config::LiteralParser

Inherits:
BasicParser show all
Defined in:
lib/fluent/config/literal_parser.rb

Direct Known Subclasses

V1Parser

Constant Summary

Constants inherited from BasicParser

BasicParser::LINE_END, BasicParser::LINE_END_WITHOUT_SPACING_AND_COMMENT, BasicParser::SPACING, BasicParser::SPACING_WITHOUT_COMMENT, BasicParser::ZERO_OR_MORE_SPACING

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BasicParser

#check, #eof?, #error_sample, #getch, #line_end, #parse_error!, #prev_match, #scan, #skip, #spacing, #spacing_without_comment

Methods included from BasicParser::ClassMethods

#def_literal, #def_symbol, #symbol

Constructor Details

#initialize(strscan, eval_context) ⇒ LiteralParser

Returns a new instance of LiteralParser.



51
52
53
54
 
# File 'lib/fluent/config/literal_parser.rb', line 51

def initialize(strscan, eval_context)
  super(strscan)
  @eval_context = eval_context
end

Class Method Details

.unescape_char(c) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/fluent/config/literal_parser.rb', line 28

def self.unescape_char(c)
  case c
  when '"'
    '\"'
  when "'"
    "\\'"
  when '\\'
    '\\\\'
  when "\r"
    '\r'
  when "\n"
    '\n'
  when "\t"
    '\t'
  when "\f"
    '\f'
  when "\b"
    '\b'
  else
    c
  end
end

Instance Method Details

#eval_embedded_code(code) ⇒ Object 



161
162
163
164
165
166
 
# File 'lib/fluent/config/literal_parser.rb', line 161

def eval_embedded_code(code)
  if @eval_context.nil?
    parse_error! "embedded code is not allowed in this file"
  end
  @eval_context.instance_eval(code)
end

#eval_escape_char(c) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/fluent/config/literal_parser.rb', line 168

def eval_escape_char(c)
  case c
  when '"'
    '"'
  when "'"
    "'"
  when "r"
    "\r"
  when "n"
    "\n"
  when "t"
    "\t"
  when "f"
    "\f"
  when "b"
    "\b"
  when /[a-zA-Z0-9]/
    parse_error! "unexpected back-slash escape character '#{c}'"
  else  # symbols
    c
  end
end

#parse_literal(string_boundary_charset = LINE_END) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/fluent/config/literal_parser.rb', line 56

def parse_literal(string_boundary_charset = LINE_END)
  spacing_without_comment

  value = if skip(/\[/)
            scan_json(true)
          elsif skip(/\{/)
            scan_json(false)
          else
            scan_string(string_boundary_charset)
          end
  value
end

#scan_double_quoted_string ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/fluent/config/literal_parser.rb', line 79

def scan_double_quoted_string
  string = []
  while true
    if skip(/\"/)
      return string.join
    elsif check(/[^"]#{LINE_END_WITHOUT_SPACING_AND_COMMENT}/)
      if s = check(/[^\\]#{LINE_END_WITHOUT_SPACING_AND_COMMENT}/)
        string << s
      end
      skip(/[^"]#{LINE_END_WITHOUT_SPACING_AND_COMMENT}/)
    elsif s = scan(/\\./)
      string << eval_escape_char(s[1,1])
    elsif skip(/\#\{/)
      string << eval_embedded_code(scan_embedded_code)
      skip(/\}/)
    elsif s = scan(/./)
      string << s
    else
      parse_error! "unexpected end of file in a double quoted string"
    end
  end
end

#scan_embedded_code ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/fluent/config/literal_parser.rb', line 140

def scan_embedded_code
  rlex = RubyLex.new
  src = '"#{'+@ss.rest+"\n=end\n}"

  input = StringIO.new(src)
  input.define_singleton_method(:encoding) { external_encoding }
  rlex.set_input(input)

  tk = rlex.token
  code = src[3,tk.seek-3]

  if @ss.rest.length < code.length
    @ss.pos += @ss.rest.length
    parse_error! "expected end of embedded code but $end"
  end

  @ss.pos += code.length

  '"#{' + code + '}"'
end

#scan_json(is_array) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/fluent/config/literal_parser.rb', line 191

def scan_json(is_array)
  result = nil
  # Yajl does not raise ParseError for imcomplete json string, like '[1', '{"h"', '{"h":' or '{"h1":1'
  # This is the reason to use JSON module.

  buffer = (is_array ? "[" : "{")
  line_buffer = ""

  until result
    char = getch

    break if char.nil?

    if char == "#"
      # If this is out of json string literals, this object can be parsed correctly
      # '{"foo":"bar", #' -> '{"foo":"bar"}' (to check)
      parsed = nil
      begin
        parsed = JSON.parse(buffer + line_buffer.rstrip.sub(/,$/, '') + (is_array ? "]" : "}"))
      rescue JSON::ParserError => e
        # This '#' is in json string literals
      end

      if parsed
        # ignore chars as comment before newline
        while (char = getch) != "\n"
          # ignore comment char
        end
        buffer << line_buffer + "\n"
        line_buffer = ""
      else
        # '#' is a char in json string
        line_buffer << char
      end

      next # This char '#' MUST NOT terminate json object.
    end

    if char == "\n"
      buffer << line_buffer + "\n"
      line_buffer = ""
      next
    end

    line_buffer << char
    begin
      result = JSON.parse(buffer + line_buffer)
    rescue JSON::ParserError => e
      # Incomplete json string yet
    end
  end

  unless result
    parse_error! "got incomplete JSON #{is_array ? 'array' : 'hash'} configuration"
  end

  JSON.dump(result)
end

#scan_nonquoted_string(boundary_charset = LINE_END) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/fluent/config/literal_parser.rb', line 119

def scan_nonquoted_string(boundary_charset = LINE_END)
  charset = /(?!#{boundary_charset})./

  string = []
  while true
    if s = scan(/\#/)
      string << '#'
    elsif s = scan(charset)
      string << s
    else
      break
    end
  end

  if string.empty?
    return nil
  end

  string.join
end

#scan_single_quoted_string ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/fluent/config/literal_parser.rb', line 102

def scan_single_quoted_string
  string = []
  while true
    if skip(/\'/)
      return string.join
    elsif s = scan(/\\'/)
      string << "'"
    elsif s = scan(/\\\\/)
      string << "\\"
    elsif s = scan(/./)
      string << s
    else
      parse_error! "unexpected end of file in a signle quoted string"
    end
  end
end

#scan_string(string_boundary_charset = LINE_END) ⇒ Object 



69
70
71
72
73
74
75
76
77
 
# File 'lib/fluent/config/literal_parser.rb', line 69

def scan_string(string_boundary_charset = LINE_END)
  if skip(/\"/)
    return scan_double_quoted_string
  elsif skip(/\'/)
    return scan_single_quoted_string
  else
    return scan_nonquoted_string(string_boundary_charset)
  end
end