Class: Preprocessinator

Inherits:
Object show all
Defined in:
lib/ceedling/preprocessinator.rb

Overview

Ceedling - Test-Centered Build System for C
ThrowTheSwitch.org
Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
SPDX-License-Identifier: MIT

Instance Method Summary collapse

Instance Method Details

#preprocess_includes(filepath:, test:, flags:, include_paths:, defines:, deep: false) ⇒ Object 



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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/ceedling/preprocessinator.rb', line 32

def preprocess_includes(filepath:, test:, flags:, include_paths:, defines:, deep: false)
  includes_list_filepath = @file_path_utils.form_preprocessed_includes_list_filepath( filepath, test )

  includes = []

  # If existing YAML file of includes is newer than the file we're processing, skip preprocessing
  if @file_wrapper.newer?( includes_list_filepath, filepath )
    msg = @reportinator.generate_module_progress(
      operation: "Loading #include statement listing file for",
      module_name: test,
      filename: File.basename(filepath)
      )
    @loginator.log( msg, Verbosity::NORMAL )
    
    # Note: It's possible empty YAML content returns nil
    includes = @yaml_wrapper.load( includes_list_filepath )

    msg = "Loaded existing #include list from #{includes_list_filepath}:"

    if includes.nil? or includes.empty?
      # Ensure includes defaults to emtpy array to prevent external iteration problems
      includes = []
      msg += ' <empty>'
    else
      includes.each { |include| msg += "\n - #{include}" }
    end

    @loginator.log( msg, Verbosity::DEBUG )
    @loginator.log( '', Verbosity::DEBUG )

  # Full preprocessing-based #include extraction with saving to YAML file
  else
    includes = @includes_handler.extract_includes(
      filepath:      filepath,
      test:          test,
      flags:         flags,
      include_paths: include_paths,
      defines:       defines,
      deep:          deep
      )

    msg = "Extracted #include list from #{filepath}:"

    if includes.nil? or includes.empty?
      # Ensure includes defaults to emtpy array to prevent external iteration problems
      includes = []
      msg += ' <empty>'
    else
      includes.each { |include| msg += "\n - #{include}" }
    end

    @loginator.log( msg, Verbosity::DEBUG )
    @loginator.log( '', Verbosity::DEBUG )
    
    @includes_handler.write_includes_list( includes_list_filepath, includes )
  end

  return includes
end

#preprocess_mockable_header_file(filepath:, test:, flags:, include_paths:, defines:) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
 
# File 'lib/ceedling/preprocessinator.rb', line 93

def preprocess_mockable_header_file(filepath:, test:, flags:, include_paths:, defines:)
  preprocessed_filepath = @file_path_utils.form_preprocessed_file_filepath( filepath, test )

  # Check if we're using deep define processing for mocks
  preprocess_deep = !@configurator.project_use_deep_preprocessor.nil? && [:mocks, :all].include?(@configurator.project_use_deep_preprocessor)

  plugin_arg_hash = {
    header_file:              filepath,
    preprocessed_header_file: preprocessed_filepath,
    test:                     test,
    flags:                    flags,
    include_paths:            include_paths,
    defines:                  defines      
  }

  # Trigger pre_mock_preprocessing plugin hook
  @plugin_manager.pre_mock_preprocess( plugin_arg_hash )

  arg_hash = {
    filepath:       filepath,
    test:           test,
    flags:          flags,
    include_paths:  include_paths,
    defines:        defines,
    deep:           preprocess_deep     
  }

  # Extract includes & log progress and details   
  includes = preprocess_file_common( **arg_hash )

  arg_hash = {
    source_filepath:       filepath,
    test:                  test,
    flags:                 flags,
    include_paths:         include_paths,
    defines:               defines,
    extras:                (@configurator.cmock_treat_inlines == :include)
  }

  # `contents` & `extras` are arrays of text strings to be assembled in generating a new header file.
  # `extras` are macro definitions, pragmas, etc. needed for the special case of mocking `inline` function declarations.
  # `extras` are empty for any cases other than mocking `inline` function declarations
  #  (We don't want to increase our chances of a badly generated file--extracting extras could fail in complex files.)
  contents, extras = @file_handler.collect_header_file_contents( **arg_hash )

  arg_hash = {
    filename:              File.basename( filepath ),
    preprocessed_filepath: preprocessed_filepath,
    contents:              contents,
    extras:                extras,
    includes:              includes                       
  }

  # Create a reconstituted header file from preprocessing expansion and preserving any extras
  @file_handler.assemble_preprocessed_header_file( **arg_hash )

  # Trigger post_mock_preprocessing plugin hook
  @plugin_manager.post_mock_preprocess( plugin_arg_hash )

  return preprocessed_filepath
end

#preprocess_test_file(filepath:, test:, flags:, include_paths:, defines:) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ceedling/preprocessinator.rb', line 156

def preprocess_test_file(filepath:, test:, flags:, include_paths:, defines:)
  preprocessed_filepath = @file_path_utils.form_preprocessed_file_filepath( filepath, test )

  # Check if we're using deep define processing for mocks
  preprocess_deep = !@configurator.project_use_deep_preprocessor.nil? && [:tests, :all].include?(@configurator.project_use_deep_preprocessor)

  plugin_arg_hash = {
    test_file:              filepath,
    preprocessed_test_file: preprocessed_filepath,
    test:                   test,
    flags:                  flags,
    include_paths:          include_paths,
    defines:                defines      
  }

  # Trigger pre_test_preprocess plugin hook
  @plugin_manager.pre_test_preprocess( plugin_arg_hash )

  arg_hash = {
    filepath:      filepath,
    test:          test,
    flags:         flags,
    include_paths: include_paths,
    defines:       defines,
    deep:          preprocess_deep      
  }

  # Extract includes & log progress and info
  includes = preprocess_file_common( **arg_hash )

  arg_hash = {
    source_filepath:       filepath,
    test:                  test,
    flags:                 flags,
    include_paths:         include_paths,
    defines:               defines      
  }

  # `contents` & `extras` are arrays of text strings to be assembled in generating a new test file.
  # `extras` are test build directives TEST_SOURCE_FILE() and TEST_INCLUDE_PATH().
  contents, extras = @file_handler.collect_test_file_contents( **arg_hash )

  arg_hash = {
    filename:              File.basename( filepath ),
    preprocessed_filepath: preprocessed_filepath,
    contents:              contents,
    extras:                extras,
    includes:              includes                       
  }

  # Create a reconstituted test file from preprocessing expansion and preserving any extras
  @file_handler.assemble_preprocessed_test_file( **arg_hash )

  # Trigger pre_mock_preprocessing plugin hook
  @plugin_manager.post_test_preprocess( plugin_arg_hash )

  return preprocessed_filepath
end

#setup ⇒ Object 



25
26
27
28
29
 
# File 'lib/ceedling/preprocessinator.rb', line 25

def setup
  # Aliases
  @includes_handler = @preprocessinator_includes_handler
  @file_handler = @preprocessinator_file_handler
end