ceedling 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (545) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +11 -9
  4. data/Rakefile +2 -1
  5. data/assets/features/ceedling +1 -1
  6. data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
  7. data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
  8. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  9. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  10. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  11. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  12. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  13. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  14. data/bin/actionator.rb +6 -12
  15. data/bin/app_cfg.rb +14 -1
  16. data/bin/ceedling +13 -3
  17. data/bin/cli.rb +25 -6
  18. data/bin/cli_handler.rb +113 -73
  19. data/bin/cli_helper.rb +51 -78
  20. data/bin/installation_selector.rb +81 -0
  21. data/bin/launchinator.rb +69 -0
  22. data/bin/mixin_resolvinator.rb +26 -36
  23. data/bin/objects.yml +13 -0
  24. data/bin/path_validator.rb +25 -29
  25. data/bin/versionator.rb +47 -48
  26. data/ceedling.gemspec +19 -15
  27. data/docs/BreakingChanges.md +86 -1
  28. data/docs/Changelog.md +145 -3
  29. data/docs/KnownIssues.md +179 -6
  30. data/docs/ReleaseNotes.md +13 -0
  31. data/examples/wondrous_forest/README.md +29 -1
  32. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  33. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  34. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  35. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  36. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  37. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  38. data/lib/ceedling/build_log_writer.rb +33 -0
  39. data/lib/ceedling/c_extractor/README.md +15 -7
  40. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  41. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  42. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  43. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  44. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  45. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  46. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  47. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  48. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  49. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  50. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  51. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  52. data/lib/ceedling/c_identifier.rb +21 -0
  53. data/lib/ceedling/ceedling.h +8 -0
  54. data/lib/ceedling/config/build_root_policy.rb +70 -0
  55. data/lib/ceedling/config/configurator.rb +18 -19
  56. data/lib/ceedling/config/configurator_builder.rb +75 -28
  57. data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
  58. data/lib/ceedling/config/configurator_plugins.rb +1 -1
  59. data/lib/ceedling/config/configurator_setup.rb +44 -33
  60. data/lib/ceedling/config/configurator_validator.rb +1 -110
  61. data/lib/ceedling/constants.rb +5 -1
  62. data/lib/ceedling/defaults.rb +35 -5
  63. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  64. data/lib/ceedling/dependencies/README.md +18 -16
  65. data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
  66. data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
  67. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  68. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  69. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  70. data/lib/ceedling/diagnostics/README.md +5 -0
  71. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  72. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  73. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  74. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  75. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  76. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  77. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  78. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  79. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  80. data/lib/ceedling/filename_extension.rb +7 -1
  81. data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
  82. data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
  83. data/lib/ceedling/filesystem/README.md +46 -0
  84. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  85. data/lib/ceedling/filesystem/build_subpath.rb +187 -0
  86. data/lib/ceedling/filesystem/destination_collision.rb +25 -0
  87. data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
  88. data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
  89. data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
  90. data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
  91. data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
  92. data/lib/ceedling/filesystem/file_tree.rb +241 -0
  93. data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
  94. data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
  95. data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
  96. data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
  97. data/lib/ceedling/filesystem/path_spellings.rb +55 -0
  98. data/lib/ceedling/filesystem/project_paths.rb +184 -0
  99. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  100. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  101. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  102. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  103. data/lib/ceedling/filesystem/working_dir.rb +40 -0
  104. data/lib/ceedling/generators/generator.rb +32 -70
  105. data/lib/ceedling/generators/generator_helper.rb +0 -44
  106. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  107. data/lib/ceedling/generators/generator_partials.rb +306 -244
  108. data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
  109. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  110. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  111. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  112. data/lib/ceedling/handoff.rb +121 -0
  113. data/lib/ceedling/includes/header_search.rb +225 -0
  114. data/lib/ceedling/includes/include_factory.rb +9 -12
  115. data/lib/ceedling/includes/include_pathinator.rb +112 -33
  116. data/lib/ceedling/includes/includes.rb +150 -38
  117. data/lib/ceedling/installation.rb +92 -0
  118. data/lib/ceedling/library_resolver.rb +99 -0
  119. data/lib/ceedling/objects.yml +112 -6
  120. data/lib/ceedling/partials/README.md +110 -16
  121. data/lib/ceedling/partials/carry_plan.rb +71 -0
  122. data/lib/ceedling/partials/definition_head.rb +74 -0
  123. data/lib/ceedling/partials/include_groups.rb +37 -0
  124. data/lib/ceedling/partials/interface_extras.rb +25 -0
  125. data/lib/ceedling/partials/partializer.rb +603 -124
  126. data/lib/ceedling/partials/partializer_config.rb +8 -1
  127. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  128. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  129. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  130. data/lib/ceedling/partials/partials.rb +153 -10
  131. data/lib/ceedling/partials/type_macros.rb +126 -0
  132. data/lib/ceedling/plugins/report_log_writer_plugin.rb +3 -5
  133. data/lib/ceedling/preprocess/README.md +43 -33
  134. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  135. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  136. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +32 -76
  137. data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
  138. data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
  139. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  140. data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
  141. data/lib/ceedling/rakefile.rb +15 -1
  142. data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
  143. data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
  144. data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
  145. data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
  146. data/lib/ceedling/reportinator.rb +3 -4
  147. data/lib/ceedling/setupinator.rb +104 -87
  148. data/lib/ceedling/test_context_extractor.rb +5 -1
  149. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  150. data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
  151. data/lib/ceedling/test_invoker/README.md +1 -1
  152. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  153. data/lib/ceedling/test_invoker/mock_locator.rb +175 -10
  154. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  155. data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
  156. data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
  157. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  158. data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
  159. data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
  160. data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
  161. data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
  162. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  163. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
  164. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  165. data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
  166. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  167. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
  168. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  169. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  170. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  171. data/lib/ceedling/test_invoker/test_source_file_directive_resolver.rb +40 -20
  172. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  173. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  174. data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
  175. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  176. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  177. data/lib/ceedling/yaml_wrapper.rb +3 -2
  178. data/lib/version.rb +1 -1
  179. data/plugins/bullseye/bullseye.rake +1 -3
  180. data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  181. data/plugins/bullseye/lib/bullseye.rb +24 -9
  182. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  183. data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
  184. data/plugins/dependencies/config/defaults.yml +6 -6
  185. data/plugins/dependencies/dependencies.rake +4 -1
  186. data/plugins/dependencies/lib/dependencies.rb +18 -8
  187. data/plugins/dependencies/lib/dependency_spec.rb +17 -5
  188. data/plugins/fff/lib/fff.rb +79 -46
  189. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  190. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -0
  191. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  192. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  193. data/plugins/gcov/config/defaults_gcov.rb +1 -1
  194. data/plugins/gcov/lib/console_reportinator.rb +28 -36
  195. data/plugins/gcov/lib/gcov.rb +9 -2
  196. data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
  197. data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
  198. data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
  199. data/plugins/module_generator/lib/module_generator.rb +3 -3
  200. data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
  201. data/plugins/sanitize/lib/sanitize_records.rb +3 -6
  202. data/plugins/valgrind/lib/valgrind.rb +14 -7
  203. data/site-local/404.html +2 -2
  204. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  205. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  206. data/site-local/configuration/environment-vars.html +2 -2
  207. data/site-local/configuration/global-collections.html +3 -3
  208. data/site-local/configuration/index.html +2 -2
  209. data/site-local/configuration/loading.html +2 -2
  210. data/site-local/configuration/mixins.html +2 -2
  211. data/site-local/configuration/parallel-builds.html +2 -2
  212. data/site-local/configuration/project-file.html +2 -2
  213. data/site-local/configuration/reference/cexception.html +2 -2
  214. data/site-local/configuration/reference/cmock.html +7 -3
  215. data/site-local/configuration/reference/defines.html +2 -2
  216. data/site-local/configuration/reference/environment.html +2 -2
  217. data/site-local/configuration/reference/extension.html +2 -2
  218. data/site-local/configuration/reference/files.html +65 -12
  219. data/site-local/configuration/reference/flags.html +2 -2
  220. data/site-local/configuration/reference/index.html +2 -2
  221. data/site-local/configuration/reference/libraries.html +23 -5
  222. data/site-local/configuration/reference/mixins.html +2 -2
  223. data/site-local/configuration/reference/partials.html +84 -2
  224. data/site-local/configuration/reference/paths.html +36 -8
  225. data/site-local/configuration/reference/plugins.html +2 -2
  226. data/site-local/configuration/reference/project.html +264 -12
  227. data/site-local/configuration/reference/release-build.html +4 -2
  228. data/site-local/configuration/reference/test-build.html +2 -2
  229. data/site-local/configuration/reference/test-runner.html +2 -2
  230. data/site-local/configuration/reference/tools.html +58 -4
  231. data/site-local/configuration/reference/unity.html +2 -2
  232. data/site-local/configuration/which-ceedling.html +379 -19
  233. data/site-local/development/index.html +2 -2
  234. data/site-local/development/plugins/configuration.html +2 -2
  235. data/site-local/development/plugins/index.html +2 -2
  236. data/site-local/development/plugins/plugin-subclass.html +5 -4
  237. data/site-local/development/plugins/rake-tasks.html +2 -2
  238. data/site-local/development/releases.html +7 -3
  239. data/site-local/development/workflow.html +50 -45
  240. data/site-local/getting-started/builds.html +4 -2
  241. data/site-local/getting-started/command-line.html +58 -6
  242. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  243. data/site-local/getting-started/example-projects/index.html +2 -2
  244. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  245. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  246. data/site-local/getting-started/index.html +2 -2
  247. data/site-local/getting-started/installation.html +2 -2
  248. data/site-local/getting-started/quick-start.html +2 -2
  249. data/site-local/help.html +2 -2
  250. data/site-local/index.html +2 -2
  251. data/site-local/overview/build-system.html +2 -2
  252. data/site-local/overview/index.html +2 -2
  253. data/site-local/overview/test-environments.html +2 -2
  254. data/site-local/overview/tools-and-frameworks.html +2 -2
  255. data/site-local/plugins/beep.html +2 -2
  256. data/site-local/plugins/bullseye/index.html +45 -38
  257. data/site-local/plugins/bullseye/licensing.html +2 -2
  258. data/site-local/plugins/command-hooks.html +4 -4
  259. data/site-local/plugins/compile-commands-json-db.html +2 -2
  260. data/site-local/plugins/cppcheck.html +2 -2
  261. data/site-local/plugins/dependencies.html +8 -5
  262. data/site-local/plugins/fff.html +58 -13
  263. data/site-local/plugins/gcov/examples.html +2 -2
  264. data/site-local/plugins/gcov/gcovr.html +23 -14
  265. data/site-local/plugins/gcov/index.html +2 -2
  266. data/site-local/plugins/gcov/overview.html +2 -2
  267. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  268. data/site-local/plugins/gcov/reporting.html +2 -2
  269. data/site-local/plugins/gcov/setup.html +4 -3
  270. data/site-local/plugins/gcov/tool-versions.html +2 -2
  271. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  272. data/site-local/plugins/index.html +2 -2
  273. data/site-local/plugins/module-generator.html +2 -2
  274. data/site-local/plugins/report-build-warnings-log.html +2 -2
  275. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  276. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  277. data/site-local/plugins/report-tests-log-factory.html +2 -2
  278. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  279. data/site-local/plugins/report-tests-raw-output-log.html +5 -3
  280. data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
  281. data/site-local/plugins/sanitize.html +9 -8
  282. data/site-local/plugins/valgrind.html +10 -9
  283. data/site-local/project/index.html +2 -2
  284. data/site-local/project/release-history.html +2 -2
  285. data/site-local/project/sbom.html +2 -2
  286. data/site-local/project/upgrade.html +5 -2
  287. data/site-local/reference/build-directives.html +2 -2
  288. data/site-local/reference/command-line.html +11 -4
  289. data/site-local/reference/environment-vars.html +2 -2
  290. data/site-local/reference/gcov-plugin.html +2 -2
  291. data/site-local/reference/global-collections.html +12 -12
  292. data/site-local/reference/index.html +2 -2
  293. data/site-local/reference/partials-macros.html +47 -2
  294. data/site-local/reference/project-configuration.html +2 -2
  295. data/site-local/sitemap.xml.gz +0 -0
  296. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  297. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  298. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  299. data/site-local/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  300. data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
  301. data/site-local/testing-guide/build-directives.html +2 -2
  302. data/site-local/testing-guide/conventions.html +113 -15
  303. data/site-local/testing-guide/frameworks.html +2 -2
  304. data/site-local/testing-guide/index.html +2 -2
  305. data/site-local/testing-guide/partials/configuration.html +31 -4
  306. data/site-local/testing-guide/partials/conventions.html +509 -8
  307. data/site-local/testing-guide/partials/directives.html +4 -3
  308. data/site-local/testing-guide/partials/example.html +2 -2
  309. data/site-local/testing-guide/partials/index.html +2 -2
  310. data/site-local/testing-guide/partials/overview.html +30 -12
  311. data/site-local/testing-guide/partials/variables.html +169 -4
  312. data/site-local/testing-guide/test-cases.html +2 -2
  313. data/site-local/testing-guide/test-sample.html +2 -2
  314. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  315. data/spec/integration/actionator_file_operations_spec.rb +91 -1
  316. data/spec/integration/build_step_doctor_spec.rb +270 -0
  317. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  318. data/spec/integration/compile_commands_json_db_spec.rb +1 -1
  319. data/spec/integration/configurator_validation_spec.rb +1 -1
  320. data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
  321. data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
  322. data/spec/integration/includes_extraction_spec.rb +27 -14
  323. data/spec/integration/launcher_handoff_spec.rb +297 -0
  324. data/spec/integration/mixin_loading_spec.rb +1 -1
  325. data/spec/integration/module_generator_spec.rb +3 -3
  326. data/spec/integration/nested_test_artifacts_spec.rb +99 -0
  327. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  328. data/spec/integration/partials_carry_spec.rb +520 -0
  329. data/spec/integration/partials_declarations_spec.rb +655 -0
  330. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  331. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  332. data/spec/integration/partials_header_composition_spec.rb +268 -35
  333. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  334. data/spec/integration/partials_module_resolution_spec.rb +33 -23
  335. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  336. data/spec/integration/path_intake_scenarios_spec.rb +101 -0
  337. data/spec/integration/path_length_reporting_spec.rb +64 -0
  338. data/spec/integration/path_scenarios_spec.rb +399 -0
  339. data/spec/integration/quote_include_isolator_spec.rb +57 -1
  340. data/spec/integration/report_build_warnings_log_spec.rb +1 -1
  341. data/spec/integration/report_tests_log_factory_spec.rb +1 -1
  342. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  343. data/spec/integration/test_executable_manifest_spec.rb +1 -1
  344. data/spec/integration/test_includes_extractinator_spec.rb +69 -3
  345. data/spec/integration/test_naming_spec.rb +201 -0
  346. data/spec/integration/test_source_file_checks_spec.rb +168 -0
  347. data/spec/integration/tool_executor_spec.rb +1 -1
  348. data/spec/integration/tool_validator_spec.rb +3 -3
  349. data/spec/integration/upgrade_docs_spec.rb +84 -0
  350. data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
  351. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  352. data/spec/integration/win_path_limit_spec.rb +53 -0
  353. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  354. data/spec/support/file_tree_helper.rb +88 -0
  355. data/spec/support/integration/configurator_integration_helper.rb +14 -9
  356. data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
  357. data/spec/support/integration/partial_files_harness.rb +181 -0
  358. data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
  359. data/spec/support/integration/path_scenario_harness.rb +175 -0
  360. data/spec/support/integration/spec_integration_helper.rb +9 -4
  361. data/spec/support/integration/test_includes_harness.rb +69 -37
  362. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  363. data/spec/support/spec_helper.rb +2 -0
  364. data/spec/support/system/spec_system_helper.rb +7 -6
  365. data/spec/support/system/system_context.rb +21 -3
  366. data/spec/support/working_dir_tracking.rb +49 -0
  367. data/spec/system/build_output_mirroring_spec.rb +2 -2
  368. data/spec/system/bullseye_deployment_spec.rb +2 -0
  369. data/spec/system/conditional_mock_includes_spec.rb +1 -1
  370. data/spec/system/delta_builds_spec.rb +163 -23
  371. data/spec/system/encoding_stress_spec.rb +4 -4
  372. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  373. data/spec/system/gcov_deployment_spec.rb +3 -0
  374. data/spec/system/header_include_path_validation_spec.rb +4 -4
  375. data/spec/system/header_search_paths_spec.rb +1083 -0
  376. data/spec/system/launcher_handoff_spec.rb +82 -0
  377. data/spec/system/mock_include_folders_spec.rb +212 -0
  378. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  379. data/spec/system/parent_directory_reference_spec.rb +5 -3
  380. data/spec/system/partials_carry_spec.rb +581 -0
  381. data/spec/system/partials_delta_builds_spec.rb +280 -0
  382. data/spec/system/partials_function_pointers_spec.rb +106 -0
  383. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  384. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  385. data/spec/system/path_handling_probes_spec.rb +196 -0
  386. data/spec/system/pinned_thread_count_spec.rb +4 -4
  387. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  388. data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
  389. data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
  390. data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
  391. data/spec/system/short_build_paths_spec.rb +87 -0
  392. data/spec/system/sibling_header_collision_spec.rb +30 -6
  393. data/spec/system/special_path_characters_spec.rb +86 -0
  394. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  395. data/spec/system/support/common_test_cases.rb +23 -21
  396. data/spec/system/support/gcov_common_test_cases.rb +37 -9
  397. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  398. data/spec/system/support/sanitize_common_test_cases.rb +2 -2
  399. data/spec/system/support/valgrind_common_test_cases.rb +12 -12
  400. data/spec/system/test_build_layout_spec.rb +209 -0
  401. data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
  402. data/spec/system/test_runner_system_include_spec.rb +1 -1
  403. data/spec/system/test_source_file_directive_spec.rb +64 -5
  404. data/spec/units/bin/actionator_spec.rb +14 -17
  405. data/spec/units/bin/app_cfg_spec.rb +37 -0
  406. data/spec/units/bin/cli_handler_spec.rb +282 -6
  407. data/spec/units/bin/cli_helper_spec.rb +116 -45
  408. data/spec/units/bin/installation_selector_spec.rb +114 -0
  409. data/spec/units/bin/launchinator_spec.rb +171 -0
  410. data/spec/units/bin/path_validator_spec.rb +10 -0
  411. data/spec/units/bin/versionator_spec.rb +38 -6
  412. data/spec/units/build_log_writer_spec.rb +57 -0
  413. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  414. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  415. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  416. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  417. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  418. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  419. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  420. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  421. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  422. data/spec/units/c_identifier_spec.rb +35 -0
  423. data/spec/units/config/build_root_policy_spec.rb +61 -0
  424. data/spec/units/config/configurator_builder_spec.rb +61 -6
  425. data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
  426. data/spec/units/config/configurator_setup_spec.rb +80 -68
  427. data/spec/units/config/configurator_spec.rb +54 -6
  428. data/spec/units/config/configurator_validator_spec.rb +1 -172
  429. data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
  430. data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
  431. data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
  432. data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
  433. data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
  434. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  435. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  436. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  437. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  438. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  439. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  440. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  441. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  442. data/spec/units/encodinator_spec.rb +3 -4
  443. data/spec/units/filename_extension_spec.rb +11 -0
  444. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  445. data/spec/units/filesystem/build_subpath_spec.rb +235 -0
  446. data/spec/units/filesystem/destination_collision_spec.rb +30 -0
  447. data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
  448. data/spec/units/filesystem/file_finder_spec.rb +845 -0
  449. data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
  450. data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
  451. data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
  452. data/spec/units/filesystem/file_tree_spec.rb +511 -0
  453. data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
  454. data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
  455. data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
  456. data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
  457. data/spec/units/filesystem/project_paths_spec.rb +147 -0
  458. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  459. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  460. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  461. data/spec/units/filesystem/working_dir_spec.rb +71 -0
  462. data/spec/units/generators/generator_helper_spec.rb +0 -60
  463. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  464. data/spec/units/generators/generator_partials_spec.rb +656 -55
  465. data/spec/units/generators/generator_spec.rb +38 -6
  466. data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
  467. data/spec/units/generators/generator_test_results_spec.rb +1 -1
  468. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  469. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  470. data/spec/units/handoff_spec.rb +205 -0
  471. data/spec/units/includes/header_search_spec.rb +406 -0
  472. data/spec/units/includes/include_factory_spec.rb +23 -6
  473. data/spec/units/includes/include_pathinator_spec.rb +118 -8
  474. data/spec/units/includes/include_spec.rb +14 -0
  475. data/spec/units/includes/includes_spec.rb +176 -19
  476. data/spec/units/installation_spec.rb +228 -0
  477. data/spec/units/library_resolver_spec.rb +157 -0
  478. data/spec/units/loginator_spec.rb +31 -0
  479. data/spec/units/mock_locator_spec.rb +275 -6
  480. data/spec/units/partials/include_groups_spec.rb +42 -0
  481. data/spec/units/partials/partializer_config_spec.rb +32 -0
  482. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  483. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  484. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  485. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  486. data/spec/units/partials/partializer_spec.rb +1579 -270
  487. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  488. data/spec/units/partials/partials_rename_spec.rb +160 -0
  489. data/spec/units/partials_manager_spec.rb +561 -251
  490. data/spec/units/plugins/bullseye_spec.rb +49 -2
  491. data/spec/units/plugins/console_reportinator_spec.rb +73 -26
  492. data/spec/units/plugins/dependencies_spec.rb +33 -7
  493. data/spec/units/plugins/dependency_spec_spec.rb +17 -0
  494. data/spec/units/plugins/gcov_spec.rb +28 -3
  495. data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
  496. data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
  497. data/spec/units/plugins/module_generator_spec.rb +5 -5
  498. data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
  499. data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
  500. data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
  501. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
  502. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
  503. data/spec/units/plugins/sanitize_records_spec.rb +3 -1
  504. data/spec/units/plugins/sanitize_spec.rb +1 -1
  505. data/spec/units/plugins/valgrind_spec.rb +23 -8
  506. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  507. data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
  508. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  509. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  510. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  511. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  512. data/spec/units/rake_app/rakefile_component_resolver_spec.rb +21 -0
  513. data/spec/units/release_build_executor_spec.rb +53 -14
  514. data/spec/units/release_build_planner_spec.rb +15 -3
  515. data/spec/units/reportinator_spec.rb +5 -5
  516. data/spec/units/setupinator_spec.rb +51 -0
  517. data/spec/units/standin_headerinator_spec.rb +55 -9
  518. data/spec/units/test_build_executor_spec.rb +842 -166
  519. data/spec/units/test_build_planner_spec.rb +205 -15
  520. data/spec/units/test_build_setup_spec.rb +179 -30
  521. data/spec/units/test_context_extractor_spec.rb +36 -2
  522. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  523. data/spec/units/test_file_preprocessinator_spec.rb +17 -1
  524. data/spec/units/test_includes_extractinator_spec.rb +61 -9
  525. data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
  526. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  527. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  528. data/spec/units/test_invoker_spec.rb +14 -1
  529. data/spec/units/test_invoker_types_spec.rb +8 -7
  530. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  531. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  532. data/spec/units/test_search_paths_spec.rb +73 -5
  533. data/spec/units/test_source_file_directive_resolver_spec.rb +38 -7
  534. data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
  535. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  536. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  537. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +27 -1
  538. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  539. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  540. data/spec/units/yaml_wrapper_spec.rb +11 -0
  541. metadata +265 -36
  542. data/lib/ceedling/file_finder_helper.rb +0 -127
  543. data/lib/ceedling/file_path_collection_utils.rb +0 -164
  544. data/spec/units/file_finder_spec.rb +0 -495
  545. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -5,10 +5,13 @@
5
5
  # SPDX-License-Identifier: MIT
6
6
  # =========================================================================
7
7
 
8
- require 'ceedling/file_wrapper'
8
+ require 'set'
9
+ require 'ceedling/filesystem/file_wrapper'
9
10
  require 'ceedling/partials/partials'
10
11
  require 'ceedling/c_extractor/c_extractor_types'
11
12
  require 'ceedling/c_extractor/c_extractor_constants'
13
+ require 'ceedling/generators/partial_source_writer'
14
+ require 'ceedling/generators/partial_header_writer'
12
15
 
13
16
  class GeneratorPartials
14
17
 
@@ -22,48 +25,83 @@ class GeneratorPartials
22
25
  end
23
26
 
24
27
  def generate_implementation(
25
- test:,
26
28
  name:,
27
29
  function_definitions:,
28
30
  source_includes:,
29
31
  header_includes:,
30
32
  c_module:,
31
33
  output_path:,
32
- include_guard: nil
34
+ header_following_includes: [],
35
+ include_guard: nil,
36
+ carry: Partials::CarryPlan.new,
37
+ suppress_redundant_decls: true,
38
+ extern_variables: :weak
33
39
  )
34
- source = @file_path_utils.form_partial_implementation_source_filename(name)
35
40
  header = @file_path_utils.form_partial_implementation_header_filename(name)
41
+ source = File.join(output_path, @file_path_utils.form_partial_implementation_source_filename(name))
36
42
 
37
- header_filepath = _prepare( File.join(output_path, header) )
38
- source_filepath = _prepare( File.join(output_path, source) )
39
-
40
- # Binary mode: the function bodies written below may already contain their
41
- # own line endings verbatim. Windows text mode rewrites every "\n" on
42
- # write, which would alter any line ending already present in that
43
- # content instead of passing it through unchanged.
44
- @file_wrapper.open(header_filepath, 'wb') do |file|
43
+ _write( File.join(output_path, header) ) do |file|
45
44
  generate_header(file, header, header_includes, function_definitions, c_module,
46
- include_variables: true, include_guard: include_guard)
45
+ include_variables: true, include_guard: include_guard, following_includes: header_following_includes)
47
46
  end
48
47
 
49
- @file_wrapper.open(source_filepath, 'wb') do |file|
50
- generate_source(file, source_includes, function_definitions, c_module)
48
+ return _write( source ) do |file|
49
+ generate_source(file, source_includes, function_definitions, c_module, carry: carry,
50
+ suppress_redundant_decls: suppress_redundant_decls, extern_variables: extern_variables, filepath: source)
51
51
  end
52
+ end
52
53
 
53
- return source_filepath
54
+ # The mockable interface header. With `extras` it also writes the extras header and includes
55
+ # it where the module header's items end, ahead of the source's later includes, as the rest
56
+ # of the real header it stands in for.
57
+ def generate_interface(name:, function_declarations:, includes:, c_module:, output_path:, following_includes: [], include_guard: nil,
58
+ extras: nil)
59
+ header = @file_path_utils.form_partial_interface_header_filename(name)
60
+ flag = (include_guard and extras and !extras.empty?) ? _extras_flag( name ) : nil
61
+ extras_h = generate_extras( name: name, extras: extras, c_module: c_module, output_path: output_path, flag: flag )
62
+ following = extras_h ? [UserInclude.new( extras_h )] + following_includes : following_includes
63
+
64
+ return _write( File.join(output_path, header) ) do |file|
65
+ generate_header(file, header, includes, function_declarations, c_module,
66
+ include_variables: false, include_guard: include_guard, following_includes: following, extras_flag: flag)
67
+ end
54
68
  end
55
69
 
56
- def generate_interface(test:, name:, function_declarations:, includes:, c_module:, output_path:, include_guard: nil)
57
- header = @file_path_utils.form_partial_interface_header_filename(name)
58
- filepath = _prepare( File.join(output_path, header) )
70
+ # Defined by an interface that spoofs its real header's guard, where the real header hasn't
71
+ # arrived yet, so the extras hold what it would have supplied there and nowhere else
72
+ def _extras_flag(name)
73
+ return "#{FileWrapper.generate_include_guard( @file_path_utils.form_partial_extras_header_filename( name ) )}_WANTED"
74
+ end
59
75
 
60
- # Binary mode: see generate_implementation above.
61
- @file_wrapper.open(filepath, 'wb') do |file|
62
- generate_header(file, header, includes, function_declarations, c_module,
63
- include_variables: false, include_guard: include_guard)
76
+ # What a mock-only Partial keeps of its real header beyond the mocked functions (see
77
+ # PartializerHelper#plan_interface_extras), in the module's order. CMock parses only the
78
+ # interface header, so nothing here can read to it as a function to mock. A helper keeps its
79
+ # #line attribution to the real header, as carried helpers do. With `flag`, the items stand
80
+ # under it (see _extras_flag). Returns the filename, or nil when nothing is kept, in which case
81
+ # nothing is written.
82
+ def generate_extras(name:, extras:, c_module:, output_path:, flag: nil)
83
+ return nil if extras.nil? or extras.empty?
84
+
85
+ header = @file_path_utils.form_partial_extras_header_filename( name )
86
+ filepath = File.join( output_path, header )
87
+ context = _header_context( nil, header, [], _variables( c_module ) )
88
+
89
+ _write( filepath ) do |file|
90
+ _write_extras( PartialSourceWriter.new( io: file, filepath: filepath, suppress_redundant_decls: false ), header, extras, context, flag )
64
91
  end
65
92
 
66
- return filepath
93
+ return header
94
+ end
95
+
96
+ def _write_extras(writer, header, extras, context, flag)
97
+ guard = FileWrapper.generate_include_guard( header )
98
+
99
+ writer.preamble( [] )
100
+ writer.text( "#ifndef #{guard}\n#define #{guard}\n\n" )
101
+ writer.text( "#ifdef #{flag}\n" ) if flag
102
+ extras.items.each { |item| _write_extras_item( writer, item, context ) }
103
+ writer.text( "#endif\n" ) if flag
104
+ writer.text( "#endif // #{guard}\n" )
67
105
  end
68
106
 
69
107
  # A module's typedefs and aggregate (struct/enum/union) definitions are the same
@@ -78,49 +116,19 @@ class GeneratorPartials
78
116
  # @param name [String] Partial module name (used to form the filename and include guard)
79
117
  # @param c_module [CExtractorTypes::CModule] Merged module with type_definitions/aggregate_definitions
80
118
  # @param output_path [String] Directory shared with the implementation and interface headers
119
+ # @param includes [Array] Includes ahead of the module's types
120
+ # @param following_includes [Array] The source's includes after the module header, written where
121
+ # the header's items end (see PartialHeaderWriter#following_includes)
81
122
  # @return [String, nil] The bare filename (for use as a sibling #include), or nil if nothing was generated
82
- def generate_types(name:, c_module:, output_path:, includes: [], include_guard: nil)
83
- return nil if c_module.type_definitions.empty? && c_module.aggregate_definitions.empty?
123
+ def generate_types(name:, c_module:, output_path:, includes: [], following_includes: [], include_guard: nil)
124
+ return nil unless c_module.types?
84
125
 
85
126
  header = @file_path_utils.form_partial_types_header_filename(name)
86
- filepath = _prepare( File.join(output_path, header) )
87
-
88
- # Binary mode: see generate_implementation above.
89
- @file_wrapper.open(filepath, 'wb') do |file|
90
- guard = FileWrapper.generate_include_guard( header )
91
- emit_preamble( file, guard, include_guard, includes )
92
-
93
- anything_emitted = false
94
- pending_macros = []
95
-
96
- c_module.element_sequence.each do |item|
97
- next unless item.is_a?(CExtractorTypes::CStatement)
98
-
99
- if c_module.macro_definitions.include?(item)
100
- # The guard emitted above also arrives among the extracted macros, since the real
101
- # header's own `#define` survives preprocessing. Carrying it a second time is legal
102
- # but puts a pointless duplicate in every generated types header.
103
- pending_macros << item unless guard_macro?(item, include_guard)
104
- next
105
- end
106
-
107
- next unless type_defining?(item, c_module)
108
-
109
- # A typedef/struct/enum moved here may depend on a macro (e.g. an array-size
110
- # constant) that preceded it in the original source -- this header is #included
111
- # before any macro generate_header later emits inline into the non-shared
112
- # header, so that macro would otherwise be undefined here. Carrying it forward
113
- # is safe: an identical #define may legally repeat, so generate_header's own
114
- # unmodified inline copy causes no redefinition conflict.
115
- pending_macros.each { |macro| file << macro.text << "\n" }
116
- pending_macros.clear
117
-
118
- file << item.text << "\n"
119
- anything_emitted = true
120
- end
121
-
122
- file << "\n" if anything_emitted
123
- file << "#endif // #{guard}\n\n"
127
+ _write( File.join(output_path, header) ) do |file|
128
+ writer = PartialHeaderWriter.new( io: file, name: header )
129
+ writer.preamble( include_guard, includes )
130
+ write_types( writer, c_module, following_includes.dup )
131
+ writer.finish
124
132
  end
125
133
 
126
134
  return header
@@ -128,59 +136,76 @@ class GeneratorPartials
128
136
 
129
137
  private
130
138
 
131
- # Everything above a generated header's own content: the file's include guard, the spoof of the
132
- # real module header's guard, and the includes that header carries. Shared by all three
133
- # generated headers, which open identically.
139
+ # The statement kinds that establish a type. C treats a second definition of the same type in
140
+ # one translation unit as a redefinition even when the two are textually identical, unlike an
141
+ # identical #define, which may legally repeat. So these live in the shared types header alone.
142
+ TYPE_KINDS = [:typedef, :aggregate].freeze unless const_defined?(:TYPE_KINDS, false)
143
+
144
+ # Writes a generated file, creating the directory a module named by directory needs. Binary
145
+ # mode: the function bodies written may already contain their own line endings verbatim.
146
+ # Windows text mode rewrites every "\n" on write, which would alter any line ending already
147
+ # present in that content instead of passing it through unchanged. Returns the file's path.
148
+ def _write(filepath, &block)
149
+ @file_wrapper.open( _prepare( filepath ), 'wb', &block )
150
+ return filepath
151
+ end
152
+
153
+ # The types header's content: each type in element_sequence order, any macro ahead of it,
154
+ # and the source's later includes where the header's items end. `following` is consumed.
134
155
  #
135
- # The order of the last two is the whole point. A carried header can transitively reach the
136
- # real module header, so the spoof has to be satisfied before any include is processed rather
137
- # than after. And relocated content names things a generated file does not define, so without
138
- # the includes it compiles only where something earlier in the translation unit happened to
139
- # supply those names -- which is what made the types header's placement a conflict between two
140
- # correct requirements rather than a choice.
141
- def emit_preamble(io, guard, include_guard, includes)
142
- io << "#ifndef #{guard}\n"
143
- io << "#define #{guard}\n\n"
144
-
145
- # A module header with no guard of its own supplies nothing to spoof.
146
- io << "#define #{include_guard}\n\n" if include_guard
147
-
148
- return if includes.empty?
149
-
150
- includes.each { |include| io << "#{include}\n" }
151
- io << "\n"
156
+ # A type moved here may depend on a macro, such as an array-size constant, that preceded it in
157
+ # the original source. This header is included before any macro generate_header writes inline,
158
+ # so such a macro is carried just ahead of the type that follows it. An identical #define may
159
+ # legally repeat, so generate_header's own copy causes no redefinition.
160
+ def write_types(writer, c_module, following)
161
+ held = []
162
+ c_module.element_sequence.each do |item|
163
+ writer.following_includes( following, macros: held ) if item.origin == :source
164
+ _write_type_item( writer, item, held )
165
+ end
166
+
167
+ writer.following_includes( following, macros: held )
152
168
  end
153
169
 
154
- # Whether a macro statement is nothing but the definition of `include_guard`. Anchored so a
155
- # macro whose name merely begins with the guard's name is never mistaken for it, and so a
156
- # guard-named macro carrying an actual value is left alone.
157
- def guard_macro?(item, include_guard)
158
- return false if include_guard.nil?
170
+ # A macro is held until a type follows it. A type is written after the macros held for it.
171
+ def _write_type_item(writer, item, held)
172
+ return unless item.is_a?( CExtractorTypes::CStatement )
173
+ return held << item if item.kind == :macro
174
+ return unless TYPE_KINDS.include?( item.kind )
159
175
 
160
- item.text.match?(/\A\s*#\s*define\s+#{Regexp.escape( include_guard )}\s*\z/)
176
+ held.each { |macro| writer.line( macro.text ) }.clear
177
+ writer.line( _type_text( item ) )
161
178
  end
162
179
 
163
- # A typedef or a non-typedef struct/enum/union tag definition establishes a type; C treats
164
- # a second definition of the same type in one translation unit as a redefinition error even
165
- # when the two definitions are textually identical. A macro statement carries no such
166
- # restriction -- an identical #define may legally repeat -- so only membership in
167
- # type_definitions or aggregate_definitions marks a CStatement as type-defining content
168
- # that belongs in the shared types header instead of being emitted inline.
169
- def type_defining?(item, c_module)
170
- c_module.type_definitions.include?(item) || c_module.aggregate_definitions.include?(item)
180
+ # A type statement as the types header writes it. A type a declaration defines, as
181
+ # `struct { int count; }` in `static struct { int count; } s_ctx;`, is written once here, as a
182
+ # typedef naming it for its variables (see Partials.type_name). That keeps an anonymous type
183
+ # one type, and gives a tagged one a name a test can write too.
184
+ def _type_text(item)
185
+ return item.text unless item.kind == :aggregate and item.type_name
186
+
187
+ return "typedef #{item.text.chomp( ';' ).rstrip} #{item.type_name};"
171
188
  end
172
189
 
173
- # A `CVariableDeclaration`'s `decorators` mixes storage-class specifiers (`static`,
174
- # `extern`) with base-type qualifiers (`const`, `volatile`, `restrict`) in their
175
- # original source order, since both kinds of keyword lead a declaration the same
176
- # way. An `extern` declaration and the variable's own definition both need the
177
- # qualifiers reasserted -- omitting them produces a type that disagrees with any
178
- # other declaration of the same variable elsewhere in the same translation unit --
179
- # but neither may carry a storage-class specifier: `static` would contradict the
180
- # external linkage the Partial is establishing, and `extern` is supplied literally
181
- # by the caller. Filtering to TYPE_QUALIFIER_KEYWORDS keeps only what belongs on
182
- # both forms.
190
+ # The type a variable is declared with, and its declaration's text from there on. A type the
191
+ # declaration defines is written once in the types header, so the variable names it.
192
+ def _declared_type(var)
193
+ return var.defined_type ? "#{var.defined_type.type_name} #{var.type}".rstrip : var.type
194
+ end
195
+
196
+ # A variable's definition as the implementation source writes it, less any storage class.
183
197
  #
198
+ # A `CVariableDeclaration`'s `decorators` mixes storage-class specifiers (`static`, `extern`)
199
+ # with base-type qualifiers (`const`, `volatile`, `restrict`) in their original source order,
200
+ # since both kinds of keyword lead a declaration the same way. The extern and the definition
201
+ # both need the qualifiers -- omitting them gives a type that disagrees with the variable's
202
+ # other declarations -- and neither may carry a storage class: `static` would contradict the
203
+ # external linkage the Partial establishes, and an extern supplies `extern` itself.
204
+ def _definition(var)
205
+ text = var.defined_type ? "#{var.defined_type.type_name} #{var.text}" : var.text
206
+ return "#{qualifier_prefix( var )}#{text}"
207
+ end
208
+
184
209
  # @param decl [CExtractorTypes::CVariableDeclaration]
185
210
  # @return [String] e.g. "volatile " / "const volatile " / "" (trailing space when non-empty)
186
211
  def qualifier_prefix(decl)
@@ -188,14 +213,39 @@ class GeneratorPartials
188
213
  quals.empty? ? '' : "#{quals.join(' ')} "
189
214
  end
190
215
 
216
+ # A definition for a variable the module only declares `extern`. Weak, it satisfies the link
217
+ # when nothing else defines the variable and yields to a real definition without a duplicate
218
+ # symbol. A compiler without GCC's weak attribute gets a plain definition.
219
+ def weak_definition(decl)
220
+ text = _definition( decl )
221
+ return "#if defined(__GNUC__)\n__attribute__((weak)) #{text}\n#else\n#{text}\n#endif\n"
222
+ end
223
+
224
+ # What generation consults about a module's variables: each variable's defining declaration,
225
+ # which knows its full type, such as an array's size, and each one's asm label, which any of
226
+ # its declarations may hold
227
+ Variables = Struct.new( :defining, :labels, keyword_init: true ) unless const_defined?(:Variables, false)
228
+
229
+ def _variables(c_module)
230
+ return Variables.new(
231
+ defining: c_module.variable_declarations.reject( &:extern? ).group_by( &:name ).transform_values( &:first ),
232
+ labels: c_module.variable_declarations.select( &:asm_label ).to_h { |v| [v.name, v.asm_label] }
233
+ )
234
+ end
235
+
191
236
  # Emit a partial header file.
192
237
  #
193
- # Iterates c_module.element_sequence to emit non-function items (macros, typedefs,
194
- # aggregates, and optionally variable extern declarations) in their original extraction
195
- # order. Function items in element_sequence are matched by name against function_list
196
- # (pre-filtered Partials::FunctionDeclaration or Partials::FunctionDefinition objects)
197
- # and emitted at their natural position. Any function_list entries not found in
198
- # element_sequence (e.g., added from a different module) are emitted afterward.
238
+ # Iterates c_module.element_sequence to emit non-function items (macros, and optionally
239
+ # variable extern declarations) in their original extraction order. Function items in
240
+ # element_sequence are matched by name against function_list (pre-filtered
241
+ # Partials::FunctionDeclaration or Partials::FunctionDefinition objects) and emitted at their
242
+ # natural position. An entry element_sequence never names is not written.
243
+ #
244
+ # Types live in the shared types header generated by generate_types, so a type is defined
245
+ # exactly once no matter how many of a module's generated headers one test file includes. A
246
+ # bare macro invocation expands to real code, typically a function definition, once compiled.
247
+ # Each generated header is included by several separately compiled sources of one test build,
248
+ # so the invocation belongs only in the implementation source (see generate_source).
199
249
  #
200
250
  # @param io [IO] Output file handle
201
251
  # @param name [String] Header filename (used for include guard)
@@ -205,151 +255,163 @@ class GeneratorPartials
205
255
  # @param include_variables [Boolean] True for implementation header (emits extern vars); false for interface
206
256
  # @param include_guard [String, nil] The real module header's own guard, spoofed so a transitive
207
257
  # reach at that header finds it already satisfied. nil when the header has no guard.
208
- def generate_header(io, name, includes, function_list, c_module, include_variables:, include_guard: nil)
209
- guard = FileWrapper.generate_include_guard( name )
210
- emit_preamble( io, guard, include_guard, includes )
211
-
212
- func_by_name = function_list.to_h { |f| [f.name, f] }
213
- emitted_funcs = {}
214
- last_was_func = false
215
- anything_emitted = false
216
-
217
- emit_func = lambda do |func|
218
- # Blank line before a function when preceded by a non-function item
219
- io << "\n" if anything_emitted && !last_was_func
220
- io << func.signature << ";\n\n"
221
- emitted_funcs[func.name] = true
222
- last_was_func = true
223
- anything_emitted = true
258
+ # @param following_includes [Array] The source's includes after the module header, written where
259
+ # the header's items end (see PartialHeaderWriter#following_includes)
260
+ # @param extras_flag [String, nil] An interface's flag for its extras header (see _extras_flag)
261
+ def generate_header(io, name, includes, function_list, c_module, include_variables:, include_guard: nil, following_includes: [],
262
+ extras_flag: nil)
263
+ context = _header_context( io, name, function_list, include_variables ? _variables( c_module ) : nil )
264
+ following = following_includes.dup
265
+
266
+ context.writer.preamble( include_guard, includes, flag: extras_flag )
267
+ c_module.element_sequence.each do |item|
268
+ context.writer.following_includes( following ) if item.origin == :source
269
+ _write_header_item( item, context )
224
270
  end
271
+ context.writer.following_includes( following )
272
+ context.writer.finish
273
+ end
225
274
 
226
- c_module.element_sequence.each do |item|
227
- case item
228
- when CExtractorTypes::CStatement
229
- # Typedefs and aggregate definitions live in the shared types header generated by
230
- # generate_types instead of here, so that content defines a type exactly once no
231
- # matter how many of a module's generated headers end up in the same test file.
232
- next if type_defining?(item, c_module)
233
- # A bare macro invocation expands to real executable code (typically a function
234
- # definition) once actually compiled. Unlike a #define (safe to repeat
235
- # identically across translation units) or an extern declaration (no symbol of
236
- # its own), a real function definition violates the one-definition rule the
237
- # moment more than one compiled object contains it -- and both of this method's
238
- # callers' generated headers routinely get #include'd into more than one
239
- # separately-compiled source for one test build (the implementation source
240
- # file, the test file itself, and the generated test runner all #include the
241
- # implementation header). Never emitted here, in any header; see generate_source
242
- # for where it actually belongs -- the one file that compiles to the one object
243
- # the real definition can safely live in.
244
- next if c_module.macro_invocations.include?(item)
245
- # The spoof above already states this one deliberately; carrying it again would put a
246
- # pointless duplicate in the file.
247
- next if guard_macro?(item, include_guard)
248
- io << item.text << "\n"
249
- last_was_func = false
250
- anything_emitted = true
251
- when CExtractorTypes::CVariableDeclaration
252
- next unless include_variables
253
- # If there is no array involved, array_suffix collapses to an empty string.
254
- # A leading const/volatile/restrict on the original declaration (see
255
- # qualifier_prefix) is part of the variable's type and belongs here too,
256
- # so this extern agrees with the definition and any other declaration of
257
- # the same variable elsewhere in the translation unit.
258
- io << "extern #{qualifier_prefix(item)}#{item.type} #{item.name}#{item.array_suffix};\n"
259
- last_was_func = false
260
- anything_emitted = true
261
- when CExtractorTypes::CFunctionDefinition, CExtractorTypes::CFunctionDeclaration
262
- func = func_by_name[item.name]
263
- next unless func && !emitted_funcs[item.name]
264
- emit_func.call(func)
265
- end
275
+ # What header generation consults about the module as it writes each item. A function leaves
276
+ # `functions` once written, so a later declaration or definition of it writes nothing.
277
+ HeaderContext = Struct.new( :writer, :variables, :emitted, :functions, keyword_init: true ) unless const_defined?(:HeaderContext, false)
278
+
279
+ def _header_context(io, name, function_list, variables)
280
+ return HeaderContext.new(
281
+ writer: io && PartialHeaderWriter.new( io: io, name: name ), variables: variables, emitted: Set.new,
282
+ functions: function_list.to_h { |f| [f.name, f] }
283
+ )
284
+ end
285
+
286
+ def _write_header_item(item, context)
287
+ case item
288
+ when CExtractorTypes::CStatement
289
+ context.writer.line( item.text ) if item.kind == :macro
290
+ when CExtractorTypes::CVariableDeclaration
291
+ _write_extern( item, context )
292
+ when CExtractorTypes::CFunctionDefinition, CExtractorTypes::CFunctionDeclaration
293
+ func = context.functions.delete( item.name )
294
+ context.writer.function( func.signature ) if func
266
295
  end
296
+ end
267
297
 
268
- # Non-function items end with \n; add one more for a blank line before #endif.
269
- # Function items already end with \n\n, so no extra newline needed.
270
- io << "\n" if anything_emitted && !last_was_func
298
+ # A helper as written, its prototype, a static variable keeping `static`, or an extern
299
+ def _write_extras_item(writer, item, context)
300
+ case item
301
+ when CExtractorTypes::CFunctionDefinition then writer.function( item )
302
+ when CExtractorTypes::CFunctionDeclaration then writer.prototype( item )
303
+ when CExtractorTypes::CVariableDeclaration
304
+ text = item.extern? ? _own_extern( item, context ) : "static #{_definition( item )}"
305
+ writer.text( "#{text}\n" ) if text
306
+ end
307
+ end
308
+
309
+ # An extern as the header declares it. The source may size or type the variable with what the
310
+ # extras never see. An asm label from any of the variable's declarations comes along.
311
+ def _own_extern(item, context)
312
+ name = item.name
313
+ return nil unless name and context.emitted.add?( name )
271
314
 
272
- io << "#endif // #{guard}\n\n"
315
+ declared = [item.declarator || "#{name}#{item.array_suffix}", item.asm_label || context.variables.labels[name]].compact
316
+ return "extern #{qualifier_prefix( item )}#{_declared_type( item )} #{declared.join( ' ' )};"
317
+ end
318
+
319
+ # An interface header writes no variables, so its context holds none
320
+ def _write_extern(item, context)
321
+ extern = context.variables && _header_extern( item, context )
322
+ context.writer.line( extern ) if extern
323
+ end
324
+
325
+ # The extern a header writes for a variable, or nil when it writes none.
326
+ # - A variable the extractor read no name from, such as one a macro declares, has no extern.
327
+ # - A header's extern and the source's definition name one variable, so it gets one line.
328
+ # - The definition knows the full type, such as an array's size, so the extern comes from there.
329
+ # - A leading const, volatile or restrict is part of the type (see _definition), so the
330
+ # extern agrees with every other declaration of the variable.
331
+ # - A function pointer or a pointer to an array has its name inside a parenthesized
332
+ # declarator, which the extern writes whole.
333
+ # - An asm label names the variable's symbol, so the extern carries it to reach that symbol.
334
+ # Any of the variable's declarations may hold it. The implementation source includes the
335
+ # extern ahead of the definition, so the Partial's symbol takes the label too.
336
+ def _header_extern(item, context)
337
+ name = item.name
338
+ return nil unless name and context.emitted.add?( name )
339
+
340
+ var = context.variables.defining[name] || item
341
+ declared = [var.declarator || "#{name}#{var.array_suffix}", context.variables.labels[name]].compact
342
+ return "extern #{qualifier_prefix( var )}#{_declared_type( var )} #{declared.join( ' ' )};"
273
343
  end
274
344
 
275
345
  # Emit a partial source file.
276
346
  #
277
- # Iterates c_module.element_sequence to emit CVariableDeclaration and
278
- # CFunctionDefinition items, plus bare-macro-invocation CStatements specifically (see
279
- # the CStatement branch below for why only that one CStatement category belongs
280
- # here), in their original extraction order. Every other CStatement category and
281
- # CFunctionDeclaration items are skipped (they belong in headers). Function items
282
- # are matched by name against function_definitions (pre-filtered
283
- # Partials::FunctionDefinition objects). Any entries not found in element_sequence
284
- # are emitted afterward.
347
+ # Iterates c_module.element_sequence and writes, in their original extraction order:
348
+ # - the selected functions, matched by name against function_definitions;
349
+ # - the header helpers and prototypes the carry plan carries;
350
+ # - variable definitions, and for a variable the module only declares `extern`, what
351
+ # `extern_variables` asks for;
352
+ # - bare macro invocations, the one CStatement category that belongs here. A real function
353
+ # definition, once such a macro is applied, would violate the one-definition rule the
354
+ # moment more than one compiled object contains it. This is the one file that compiles to
355
+ # the one object the real definition can safely live in.
356
+ # Every other CStatement category belongs in a header.
285
357
  #
286
- # @param io [IO] Output file handle
287
- # @param includes [Array] Include directives
288
- # @param function_definitions [Array] Pre-filtered Partials::FunctionDefinition objects
289
- # @param c_module [CExtractorTypes::CModule] Merged module with element_sequence
290
- def generate_source(io, includes, function_definitions, c_module)
291
- io << "// Ceedling generated file\n"
292
- includes.each do |include|
293
- io << "#{include}\n"
294
- end
358
+ # @param io [IO] Output file handle
359
+ # @param includes [Array] Include directives
360
+ # @param function_definitions [Array] Pre-filtered Partials::FunctionDefinition objects
361
+ # @param c_module [CExtractorTypes::CModule] Merged module with element_sequence
362
+ # @param carry [Partials::CarryPlan] What the source carries beyond the selection
363
+ # @param suppress_redundant_decls [Boolean] Whether carried prototypes sit inside GCC pragmas
364
+ # @param extern_variables [Symbol] :weak or :test, for variables the module only declares
365
+ # @param filepath [String, nil] This file's own path, for handing #line attribution back
366
+ def generate_source(io, includes, function_definitions, c_module, carry: Partials::CarryPlan.new,
367
+ suppress_redundant_decls: true, extern_variables: :weak, filepath: nil)
368
+ writer = PartialSourceWriter.new( io: io, filepath: filepath, suppress_redundant_decls: suppress_redundant_decls )
369
+ context = SourceContext.new(
370
+ carry: carry, extern_variables: extern_variables, weak: Set.new, variables: _variables( c_module ),
371
+ selected: function_definitions.to_h { |f| [f.name, f] }
372
+ )
295
373
 
296
- io << "\n"
297
-
298
- func_by_name = function_definitions.to_h { |f| [f.name, f] }
299
- emitted_funcs = {}
300
- last_was_func = false
301
- anything_emitted = false
302
-
303
- emit_func = lambda do |func|
304
- # Blank line before a function when preceded by a non-function item
305
- io << "\n" if anything_emitted && !last_was_func
306
- if func.line_num and func.source_filepath
307
- # #line ties this generated file's code back to its original source
308
- # location -- debuggers, error messages, and gcov coverage attribution
309
- # all point at the real file/line instead of this generated stand-in.
310
- # That mapping only holds if this file's line count matches what
311
- # #line promises, which is why it's opened in binary mode above.
312
- io << "#line #{func.line_num} \"#{func.source_filepath}\"\n"
313
- end
314
- io << func.code_block << "\n\n"
315
- emitted_funcs[func.name] = true
316
- last_was_func = true
317
- anything_emitted = true
318
- end
374
+ writer.preamble( includes )
375
+ c_module.element_sequence.each { |item| _write_source_item( writer, item, context ) }
376
+ writer.finish
377
+ end
319
378
 
320
- c_module.element_sequence.each do |item|
321
- case item
322
- when CExtractorTypes::CStatement
323
- # Only a bare macro invocation belongs here -- see generate_header for why it's
324
- # never emitted into any header (a real function definition, once the macro is
325
- # actually applied, would violate the one-definition rule the moment more than
326
- # one compiled object contains it). This is the one file that compiles to the
327
- # one object the real definition can safely live in. Every other CStatement
328
- # category (macro definitions, typedefs, aggregate definitions) belongs only in
329
- # a header -- #line-anchored function bodies below are the only other code this
330
- # file itself contributes.
331
- next unless c_module.macro_invocations.include?(item)
332
- io << item.text << "\n"
333
- last_was_func = false
334
- anything_emitted = true
335
- when CExtractorTypes::CVariableDeclaration
336
- # `item.text` is the declaration with its leading decorator run removed (see
337
- # CExtractorDeclarations#extract_decorators), so a const/volatile/restrict
338
- # qualifier on the base type is reapplied here via qualifier_prefix -- this
339
- # definition's type must match the extern declaration emitted for the same
340
- # variable in generate_header.
341
- io << "#{qualifier_prefix(item)}#{item.text}\n"
342
- last_was_func = false
343
- anything_emitted = true
344
- when CExtractorTypes::CFunctionDefinition
345
- func = func_by_name[item.name]
346
- next unless func && !emitted_funcs[item.name]
347
- emit_func.call(func)
348
- end
349
- # CStatement and CFunctionDeclaration items are skipped in source
379
+ # What source generation consults about the module as it writes each item
380
+ SourceContext = Struct.new( :carry, :extern_variables, :selected, :variables, :weak, keyword_init: true ) unless const_defined?(:SourceContext, false)
381
+
382
+ def _write_source_item(writer, item, context)
383
+ case item
384
+ when CExtractorTypes::CStatement
385
+ writer.text( "#{item.text}\n" ) if item.kind == :invocation
386
+ when CExtractorTypes::CVariableDeclaration
387
+ _write_variable( writer, item, context )
388
+ when CExtractorTypes::CFunctionDefinition
389
+ writer.function( _selected_or_carried( item, context ) )
390
+ when CExtractorTypes::CFunctionDeclaration
391
+ writer.prototype( item ) if context.carry.prototype?( item )
350
392
  end
393
+ end
394
+
395
+ def _write_variable(writer, var, context)
396
+ text = _source_variable( var, context )
397
+ writer.text( text ) if text
398
+ end
351
399
 
400
+ # A function's selected definition, or the helper the carry plan carries by its name, or nil
401
+ def _selected_or_carried(func, context)
402
+ return context.selected[func.name] || context.carry.helper( func.name )
352
403
  end
353
404
 
405
+ # A variable's definition, or nil. A variable the module defines is written where it does.
406
+ # One it only declares `extern` gets a weak definition, once, unless `extern_variables` leaves
407
+ # it to the test or its type is never completed, which no definition could compile with.
408
+ def _source_variable(var, context)
409
+ return "#{_definition( var )}\n" unless var.extern?
410
+ return nil if context.extern_variables != :weak
411
+ return nil if context.variables.defining.key?( var.name ) or context.carry.incomplete?( var.name )
412
+ return nil unless context.weak.add?( var.name )
413
+
414
+ return weak_definition( var )
415
+ end
354
416
 
355
417
  end