Class: RubyHeaderParser::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_header_parser/config.rb

Overview

Manager for config file

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config_file) ⇒ Config

Note:

See CONFIG.md for config file details

Returns a new instance of Config.

Parameters:

  • config_file (String) 


13
14
15
16
17
 
# File 'lib/ruby_header_parser/config.rb', line 13

def initialize(config_file)
  erb = File.read(config_file)
  yaml = ERB.new(erb).result
  @data = YAML.safe_load(yaml, aliases: true, permitted_classes: [Regexp])
end

Instance Attribute Details

#data ⇒ Hash (readonly)

Returns:

  • (Hash) 


8
9
10
 
# File 'lib/ruby_header_parser/config.rb', line 8

def data
  @data
end

Instance Method Details

#function_arg_pointer_hint(function_name:, pos:) ⇒ Symbol

Returns :ref, :array, :ref_array, :function, :sref, :str_array, :in_ref.

Parameters:

  • function_name (String)
  • pos (Integer) —

    arg position (1 origin)

Returns:

  • (Symbol) —

    :ref, :array, :ref_array, :function, :sref, :str_array, :in_ref



22
23
24
25
26
27
 
# File 'lib/ruby_header_parser/config.rb', line 22

def function_arg_pointer_hint(function_name:, pos:)
  pointer_hint = data["function"]["pointer_hint"].dig(function_name, pos)
  return pointer_hint.to_sym if pointer_hint

  :ref
end

#function_self_pointer_hint(function_name) ⇒ Symbol

Returns :ref, :raw.

Parameters:

  • function_name (String)

Returns:

  • (Symbol) —

    :ref, :raw



31
32
33
34
35
36
 
# File 'lib/ruby_header_parser/config.rb', line 31

def function_self_pointer_hint(function_name)
  pointer_hint = data["function"]["pointer_hint"].dig(function_name, "self")
  return pointer_hint.to_sym if pointer_hint

  :ref
end

#should_generate_enum?(enum_name) ⇒ Boolean

Whether generate C enum to go

Parameters:

  • enum_name (String)

Returns:

  • (Boolean) 


70
71
72
73
74
 
# File 'lib/ruby_header_parser/config.rb', line 70

def should_generate_enum?(enum_name)
  return false if data["enum"]["exclude_name"].any? { |format| format === enum_name }

  data["enum"]["include_name"].any? { |format| format === enum_name }
end

#should_generate_function?(function_name) ⇒ Boolean

Whether generate C function to go

Parameters:

  • function_name (String)

Returns:

  • (Boolean) 


43
44
45
46
47
 
# File 'lib/ruby_header_parser/config.rb', line 43

def should_generate_function?(function_name)
  return false if data["function"]["exclude_name"].any? { |format| format === function_name }

  data["function"]["include_name"].any? { |format| format === function_name }
end

#should_generate_struct?(struct_name) ⇒ Boolean

Whether generate C struct to go

Parameters:

  • struct_name (String)

Returns:

  • (Boolean) 


52
53
54
55
56
 
# File 'lib/ruby_header_parser/config.rb', line 52

def should_generate_struct?(struct_name)
  return false if data["struct"]["exclude_name"].any? { |format| format === struct_name }

  data["struct"]["include_name"].any? { |format| format === struct_name }
end

#should_generate_type?(type_name) ⇒ Boolean

Whether generate C type to go

Parameters:

  • type_name (String)

Returns:

  • (Boolean) 


61
62
63
64
65
 
# File 'lib/ruby_header_parser/config.rb', line 61

def should_generate_type?(type_name)
  return false if data["type"]["exclude_name"].any? { |format| format === type_name }

  data["type"]["include_name"].any? { |format| format === type_name }
end