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
@@ -34,10 +34,10 @@ describe GeneratorPartials do
34
34
  end
35
35
 
36
36
  # Helper to create CVariableDeclaration structs for testing
37
- def make_var(name:, type:, text:, decorators: [], line_num: nil)
37
+ def make_var(name:, type:, text:, decorators: [], line_num: nil, array_suffix: '', origin: nil)
38
38
  CExtractorTypes::CVariableDeclaration.new(
39
- name: name, type: type, decorators: decorators,
40
- text: text, original: text, line_num: line_num
39
+ name: name, type: type, decorators: decorators, array_suffix: array_suffix,
40
+ text: text, original: text, line_num: line_num, origin: origin
41
41
  )
42
42
  end
43
43
 
@@ -83,6 +83,27 @@ describe GeneratorPartials do
83
83
  end
84
84
 
85
85
  context "#generate_implementation" do
86
+ it "hands the carry plan and both Partials settings to source generation" do
87
+ allow(@file_path_utils).to receive(:form_partial_implementation_source_filename).and_return( 'm_impl.c' )
88
+ allow(@file_path_utils).to receive(:form_partial_implementation_header_filename).and_return( 'm_impl.h' )
89
+ allow(@file_wrapper).to receive(:mkdir)
90
+ allow(@file_wrapper).to receive(:open).and_yield( double('handle').as_null_object )
91
+ allow(@generator).to receive(:generate_header)
92
+ plan = Partials::CarryPlan.new
93
+
94
+ expect(@generator).to receive(:generate_source).with(
95
+ anything, [], [], empty_module, carry: plan, suppress_redundant_decls: false,
96
+ extern_variables: :test, filepath: '/path/to/output/m_impl.c'
97
+ )
98
+
99
+ @generator.generate_implementation(
100
+ name: 'm', function_definitions: [],
101
+ source_includes: [], header_includes: [],
102
+ c_module: empty_module, output_path: '/path/to/output',
103
+ carry: plan, suppress_redundant_decls: false, extern_variables: :test
104
+ )
105
+ end
106
+
86
107
  # A bare module name implies no directory of its own, so the directory created is
87
108
  # just the output path it was handed.
88
109
  it "creates the output path for a module named without a directory" do
@@ -95,7 +116,7 @@ describe GeneratorPartials do
95
116
  expect(@file_wrapper).to receive(:mkdir).with( '/path/to/output' ).at_least(:once)
96
117
 
97
118
  @generator.generate_implementation(
98
- test: 'test_m', name: 'm', function_definitions: [],
119
+ name: 'm', function_definitions: [],
99
120
  source_includes: [], header_includes: [],
100
121
  c_module: empty_module, output_path: '/path/to/output'
101
122
  )
@@ -115,7 +136,7 @@ describe GeneratorPartials do
115
136
  expect(@file_wrapper).to receive(:mkdir).with( '/path/to/output/drivers/uart' ).at_least(:once)
116
137
 
117
138
  @generator.generate_implementation(
118
- test: 'test_config', name: 'drivers/uart/config', function_definitions: [],
139
+ name: 'drivers/uart/config', function_definitions: [],
119
140
  source_includes: [], header_includes: [],
120
141
  c_module: empty_module, output_path: '/path/to/output'
121
142
  )
@@ -137,7 +158,7 @@ describe GeneratorPartials do
137
158
  allow(@file_wrapper).to receive(:open).and_yield( handle )
138
159
 
139
160
  @generator.generate_implementation(
140
- test: 'test_both', name: "#{dir}/config", function_definitions: [],
161
+ name: "#{dir}/config", function_definitions: [],
141
162
  source_includes: [], header_includes: [],
142
163
  c_module: empty_module, output_path: '/path/to/output'
143
164
  )
@@ -202,7 +223,6 @@ describe GeneratorPartials do
202
223
 
203
224
  # Execute
204
225
  result = @generator.generate_implementation(
205
- test: 'test_my_implementation',
206
226
  name: name,
207
227
  function_definitions: defns,
208
228
  source_includes: source_includes,
@@ -218,15 +238,19 @@ describe GeneratorPartials do
218
238
  header_includes,
219
239
  defns,
220
240
  c_module,
221
- { include_variables: true, include_guard: nil }
241
+ { include_variables: true, include_guard: nil, following_includes: [] }
222
242
  )
223
243
 
224
244
  # Verify generate_source was called with correct parameters
245
+ # With nothing to carry, the default plan is empty, suppression is on and extern
246
+ # variables get weak definitions
225
247
  expect(@generator).to have_received(:generate_source).with(
226
248
  source_file_handle,
227
249
  source_includes,
228
250
  defns,
229
- c_module
251
+ c_module,
252
+ { carry: an_instance_of( Partials::CarryPlan ).and( have_attributes( prototypes: [], helpers: {}, skipped: [] ) ),
253
+ suppress_redundant_decls: true, extern_variables: :weak, filepath: expected_source_filepath }
230
254
  )
231
255
 
232
256
  # Verify file path utilities were called
@@ -280,7 +304,6 @@ describe GeneratorPartials do
280
304
 
281
305
  # Execute
282
306
  result = @generator.generate_interface(
283
- test: 'test_my_interface',
284
307
  function_declarations: decls,
285
308
  name: name,
286
309
  includes: includes,
@@ -295,7 +318,7 @@ describe GeneratorPartials do
295
318
  includes,
296
319
  decls,
297
320
  c_module,
298
- { include_variables: false, include_guard: nil }
321
+ { include_variables: false, include_guard: nil, following_includes: [], extras_flag: nil }
299
322
  )
300
323
 
301
324
  # Verify file path utilities were called
@@ -309,6 +332,143 @@ describe GeneratorPartials do
309
332
  end
310
333
  end
311
334
 
335
+ # A mock-only Partial's interface stands in for its real header, so what that header supplied
336
+ # beyond the mocked functions goes in an extras header the interface includes
337
+ context "#generate_extras" do
338
+ def extras_module
339
+ table = make_var(name: 'table', type: 'int', text: 'int table[] = { 1, 2 };', decorators: ['static', 'const'])
340
+ count = make_var(name: 'count', type: 'int', text: 'int count;', decorators: ['extern'])
341
+ init = CExtractorTypes::CFunctionDeclaration.new(name: 'init', signature: 'int init(void);')
342
+ twice = CExtractorTypes::CFunctionDefinition.new(name: 'twice', code_block: 'static inline int twice(int x) { return 2 * x; }')
343
+ return make_module(table, count, init, twice), Partials::InterfaceExtras.new(items: [table, count, init, twice])
344
+ end
345
+
346
+ it "writes the kept items in the module's order, guarded, and returns the filename" do
347
+ allow(@file_path_utils).to receive(:form_partial_extras_header_filename).with('sensor').and_return('sensor_extras.h')
348
+ buf = StringIO.new
349
+ allow(@file_wrapper).to receive(:open).with('/out/sensor_extras.h', 'wb').and_yield(buf)
350
+ c_module, extras = extras_module
351
+
352
+ result = @generator.generate_extras( name: 'sensor', extras: extras, c_module: c_module, output_path: '/out' )
353
+
354
+ expect( mask_include_guard_hashes( buf.string ) ).to eq( <<~CONTENTS )
355
+ // Ceedling generated file
356
+
357
+ #ifndef GEN<HASH>_SENSOR_EXTRAS_H_CEEDLING
358
+ #define GEN<HASH>_SENSOR_EXTRAS_H_CEEDLING
359
+
360
+ static const int table[] = { 1, 2 };
361
+ extern int count;
362
+ int init(void);
363
+
364
+ static inline int twice(int x) { return 2 * x; }
365
+
366
+ #endif // GEN<HASH>_SENSOR_EXTRAS_H_CEEDLING
367
+ CONTENTS
368
+ expect( result ).to eq( 'sensor_extras.h' )
369
+ end
370
+
371
+ # The source may size or type the variable with what the extras never see
372
+ it "writes an extern as the header declares it, not as the source defines it" do
373
+ allow(@file_path_utils).to receive(:form_partial_extras_header_filename).with('port').and_return('port_extras.h')
374
+ buf = StringIO.new
375
+ allow(@file_wrapper).to receive(:open).with('/out/port_extras.h', 'wb').and_yield(buf)
376
+ header_extern = make_var(name: 'port_buf', type: 'int', text: 'int port_buf[];', decorators: ['extern'], array_suffix: '[]', origin: :header)
377
+ definition = make_var(name: 'port_buf', type: 'int', text: 'int port_buf[PORT_BUF_LEN];', array_suffix: '[PORT_BUF_LEN]', origin: :source)
378
+
379
+ @generator.generate_extras( name: 'port', extras: Partials::InterfaceExtras.new(items: [header_extern]),
380
+ c_module: make_module(header_extern, definition), output_path: '/out' )
381
+
382
+ expect( buf.string ).to include( "extern int port_buf[];\n" )
383
+ end
384
+
385
+ it "keeps an extern's qualifiers and an asm label another declaration holds" do
386
+ allow(@file_path_utils).to receive(:form_partial_extras_header_filename).with('port').and_return('port_extras.h')
387
+ buf = StringIO.new
388
+ allow(@file_wrapper).to receive(:open).with('/out/port_extras.h', 'wb').and_yield(buf)
389
+ header_extern = make_var(name: 'port_k', type: 'int', text: 'int port_k;', decorators: ['extern', 'const'], origin: :header)
390
+ labelled = CExtractorTypes::CVariableDeclaration.new( name: 'port_k', type: 'int', text: 'int port_k __asm__("k_sym") = 1;',
391
+ decorators: ['const'], asm_label: '__asm__("k_sym")', origin: :source )
392
+
393
+ @generator.generate_extras( name: 'port', extras: Partials::InterfaceExtras.new(items: [header_extern]),
394
+ c_module: make_module(header_extern, labelled), output_path: '/out' )
395
+
396
+ expect( buf.string ).to include( "extern const int port_k __asm__(\"k_sym\");\n" )
397
+ end
398
+
399
+ # The real header may arrive before the interface, through another include. Its helpers are
400
+ # then already defined, so the extras hold their content only where the interface spoofed it.
401
+ it "holds its items under the flag an interface sets when it spoofs the real header" do
402
+ allow(@file_path_utils).to receive(:form_partial_extras_header_filename).with('sensor').and_return('sensor_extras.h')
403
+ buf = StringIO.new
404
+ allow(@file_wrapper).to receive(:open).with('/out/sensor_extras.h', 'wb').and_yield(buf)
405
+ c_module, extras = extras_module
406
+
407
+ @generator.generate_extras( name: 'sensor', extras: extras, c_module: c_module, output_path: '/out', flag: 'SENSOR_EXTRAS_WANTED' )
408
+
409
+ expect( buf.string ).to match( %r{#ifdef SENSOR_EXTRAS_WANTED\n.*static const int table.*static inline int twice.*\n#endif\n#endif // }m )
410
+ end
411
+
412
+ it "sets that flag in the interface ahead of the spoof, only where the real header's guard isn't yet defined" do
413
+ allow(@file_path_utils).to receive(:form_partial_extras_header_filename).with('sensor').and_return('sensor_extras.h')
414
+ allow(@file_path_utils).to receive(:form_partial_interface_header_filename).with('sensor').and_return('sensor_interface.h')
415
+ interface = StringIO.new
416
+ allow(@file_wrapper).to receive(:open).with('/out/sensor_extras.h', 'wb').and_yield(StringIO.new)
417
+ allow(@file_wrapper).to receive(:open).with('/out/sensor_interface.h', 'wb').and_yield(interface)
418
+ c_module, extras = extras_module
419
+
420
+ @generator.generate_interface(
421
+ name: 'sensor', function_declarations: [], includes: [], c_module: c_module, output_path: '/out',
422
+ include_guard: 'SENSOR_H', extras: extras
423
+ )
424
+
425
+ flag = "#{FileWrapper.generate_include_guard( 'sensor_extras.h' )}_WANTED"
426
+ expect( interface.string ).to include( "#ifndef SENSOR_H\n#define #{flag}\n#endif\n#define SENSOR_H\n" )
427
+ end
428
+
429
+ it "sets no flag for a header without an include guard, whose extras hold only declarations" do
430
+ allow(@file_path_utils).to receive(:form_partial_extras_header_filename).with('sensor').and_return('sensor_extras.h')
431
+ allow(@file_path_utils).to receive(:form_partial_interface_header_filename).with('sensor').and_return('sensor_interface.h')
432
+ extras_buf = StringIO.new
433
+ allow(@file_wrapper).to receive(:open).with('/out/sensor_extras.h', 'wb').and_yield(extras_buf)
434
+ allow(@file_wrapper).to receive(:open).with('/out/sensor_interface.h', 'wb').and_yield(StringIO.new)
435
+ c_module, extras = extras_module
436
+
437
+ @generator.generate_interface( name: 'sensor', function_declarations: [], includes: [], c_module: c_module, output_path: '/out', extras: extras )
438
+
439
+ expect( extras_buf.string ).not_to include( '#ifdef' )
440
+ end
441
+
442
+ it "writes nothing and returns nil without extras" do
443
+ allow(@file_wrapper).to receive(:open)
444
+
445
+ expect( @generator.generate_extras( name: 'sensor', extras: Partials::InterfaceExtras.new, c_module: make_module, output_path: '/out' ) ).to be_nil
446
+ expect( @generator.generate_extras( name: 'sensor', extras: nil, c_module: make_module, output_path: '/out' ) ).to be_nil
447
+ expect( @file_wrapper ).not_to have_received(:open)
448
+ end
449
+
450
+ # It stands for the rest of the real header, which comes before the source's later includes
451
+ it "is included by the interface where the header's items end, ahead of the source's later includes" do
452
+ allow(@file_path_utils).to receive(:form_partial_extras_header_filename).with('sensor').and_return('sensor_extras.h')
453
+ allow(@file_path_utils).to receive(:form_partial_interface_header_filename).with('sensor').and_return('sensor_interface.h')
454
+ interface = StringIO.new
455
+ allow(@file_wrapper).to receive(:open).with('/out/sensor_extras.h', 'wb').and_yield(StringIO.new)
456
+ allow(@file_wrapper).to receive(:open).with('/out/sensor_interface.h', 'wb').and_yield(interface)
457
+ allow(@generator).to receive(:generate_header)
458
+ c_module, extras = extras_module
459
+
460
+ @generator.generate_interface(
461
+ name: 'sensor', function_declarations: [], includes: [], c_module: c_module, output_path: '/out',
462
+ following_includes: [UserInclude.new('later.h')], extras: extras
463
+ )
464
+
465
+ expect(@generator).to have_received(:generate_header).with(
466
+ interface, 'sensor_interface.h', [], [], c_module,
467
+ { include_variables: false, include_guard: nil, following_includes: [UserInclude.new('sensor_extras.h'), UserInclude.new('later.h')], extras_flag: nil }
468
+ )
469
+ end
470
+ end
471
+
312
472
  context "#generate_types" do
313
473
  it "writes nothing and returns nil when the module has no typedefs or aggregate definitions" do
314
474
  allow(@file_wrapper).to receive(:open)
@@ -440,6 +600,93 @@ describe GeneratorPartials do
440
600
  expect( mask_include_guard_hashes(buf.string).strip() ).to eq file_contents.strip()
441
601
  end
442
602
 
603
+ # The source's includes after the module header follow everything that header supplies, as
604
+ # when the source compiles. The spoof keeps the real header out, so those includes find its
605
+ # types and macros only here.
606
+ context "with the source's includes after the module header" do
607
+ def stamped(text, origin)
608
+ make_stmt(text: text).tap { |stmt| stmt.origin = origin }
609
+ end
610
+
611
+ def generate_sensor_types(*items, following_includes:)
612
+ buf = types_buffer( 'sensor', 'sensor_types.h' )
613
+ types, macros = items.partition { |item| item.text.start_with?( 'typedef' ) }
614
+
615
+ @generator.generate_types(
616
+ name: 'sensor',
617
+ c_module: CExtractorTypes::CModule.new(
618
+ type_definitions: types, macro_definitions: macros, element_sequence: items
619
+ ),
620
+ output_path: '/path/to/output',
621
+ includes: [SystemInclude.new('stdint.h'), UserInclude.new('sensor_config.h')],
622
+ following_includes: following_includes,
623
+ include_guard: 'SENSOR_H'
624
+ )
625
+
626
+ mask_include_guard_hashes( buf.string )
627
+ end
628
+
629
+ let(:header_type) { stamped( 'typedef enum { SENSOR_OK } sensor_status_t;', :header ) }
630
+ let(:header_macro) { stamped( '#define SENSOR_COUNT 4', :header ) }
631
+ let(:source_type) { stamped( 'typedef struct { sensor_status_t status; } sensor_reading_t;', :source ) }
632
+
633
+ it "writes them where the header's types end, after the header's macros" do
634
+ file_contents = <<~CONTENTS
635
+ #ifndef GEN<HASH>_SENSOR_TYPES_H_CEEDLING
636
+ #define GEN<HASH>_SENSOR_TYPES_H_CEEDLING
637
+
638
+ #define SENSOR_H
639
+
640
+ #include <stdint.h>
641
+ #include "sensor_config.h"
642
+
643
+ typedef enum { SENSOR_OK } sensor_status_t;
644
+ #define SENSOR_COUNT 4
645
+
646
+ #include "sensor_log.h"
647
+
648
+ typedef struct { sensor_status_t status; } sensor_reading_t;
649
+
650
+ #endif // GEN<HASH>_SENSOR_TYPES_H_CEEDLING
651
+ CONTENTS
652
+
653
+ result = generate_sensor_types( header_type, header_macro, source_type, following_includes: [UserInclude.new('sensor_log.h')] )
654
+
655
+ expect( result.strip ).to eq( file_contents.strip )
656
+ end
657
+
658
+ it "writes them last when the source adds nothing" do
659
+ file_contents = <<~CONTENTS
660
+ #ifndef GEN<HASH>_SENSOR_TYPES_H_CEEDLING
661
+ #define GEN<HASH>_SENSOR_TYPES_H_CEEDLING
662
+
663
+ #define SENSOR_H
664
+
665
+ #include <stdint.h>
666
+ #include "sensor_config.h"
667
+
668
+ typedef enum { SENSOR_OK } sensor_status_t;
669
+ #define SENSOR_COUNT 4
670
+
671
+ #include "sensor_log.h"
672
+
673
+ #endif // GEN<HASH>_SENSOR_TYPES_H_CEEDLING
674
+ CONTENTS
675
+
676
+ result = generate_sensor_types( header_type, header_macro, following_includes: [UserInclude.new('sensor_log.h')] )
677
+
678
+ expect( result.strip ).to eq( file_contents.strip )
679
+ end
680
+
681
+ # Without later includes, a macro goes only ahead of a type that follows it
682
+ it "writes the same header as before when there are none" do
683
+ result = generate_sensor_types( header_type, source_type, header_macro, following_includes: [] )
684
+
685
+ expect( result ).to include( "sensor_status_t;\ntypedef struct { sensor_status_t status; } sensor_reading_t;\n\n#endif" )
686
+ expect( result ).not_to include( 'SENSOR_COUNT' )
687
+ end
688
+ end
689
+
443
690
  it "states no guard when the module's header has none to spoof" do
444
691
  buf = types_buffer( 'my_module', 'my_module_types.h' )
445
692
  typedef_stmt = CExtractorTypes::CStatement.new(text: "typedef uint8_t Byte;", line_num: 1)
@@ -459,50 +706,6 @@ describe GeneratorPartials do
459
706
  expect( buf.string.scan(/^#define /).length ).to eq(1) # the generated guard alone
460
707
  end
461
708
 
462
- # The real header's own guard also arrives among the extracted macros, since it survives
463
- # preprocessing. Stating it deliberately and carrying it too would duplicate it.
464
- it "drops the carried copy of the guard it states itself" do
465
- buf = types_buffer( 'my_module', 'my_module_types.h' )
466
- guard_macro = CExtractorTypes::CStatement.new(text: "#define MY_MODULE_H", line_num: 1)
467
- typedef_stmt = CExtractorTypes::CStatement.new(text: "typedef uint8_t Byte;", line_num: 2)
468
-
469
- @generator.generate_types(
470
- name: 'my_module',
471
- c_module: CExtractorTypes::CModule.new(
472
- type_definitions: [typedef_stmt],
473
- macro_definitions: [guard_macro],
474
- element_sequence: [guard_macro, typedef_stmt]
475
- ),
476
- output_path: '/path/to/output',
477
- include_guard: 'MY_MODULE_H'
478
- )
479
-
480
- expect( buf.string.scan(/^#define MY_MODULE_H$/).length ).to eq(1)
481
- end
482
-
483
- # GH #1266's shape, one level over: a macro whose name merely begins with the guard's, and
484
- # a guard-named macro that actually carries a value. Neither is the guard statement.
485
- it "keeps a macro whose name only resembles the guard" do
486
- buf = types_buffer( 'my_module', 'my_module_types.h' )
487
- near_macro = CExtractorTypes::CStatement.new(text: "#define MY_MODULE_H_LIMIT 8", line_num: 1)
488
- valued_macro = CExtractorTypes::CStatement.new(text: "#define MY_MODULE_H 2", line_num: 2)
489
- typedef_stmt = CExtractorTypes::CStatement.new(text: "typedef uint8_t Byte;", line_num: 3)
490
-
491
- @generator.generate_types(
492
- name: 'my_module',
493
- c_module: CExtractorTypes::CModule.new(
494
- type_definitions: [typedef_stmt],
495
- macro_definitions: [near_macro, valued_macro],
496
- element_sequence: [near_macro, valued_macro, typedef_stmt]
497
- ),
498
- output_path: '/path/to/output',
499
- include_guard: 'MY_MODULE_H'
500
- )
501
-
502
- expect( buf.string ).to include('#define MY_MODULE_H_LIMIT 8')
503
- expect( buf.string ).to include('#define MY_MODULE_H 2')
504
- end
505
-
506
709
  it "carries a macro forward directly before the single typedef it immediately precedes" do
507
710
  output_path = '/path/to/output'
508
711
  name = 'my_module'
@@ -693,6 +896,52 @@ describe GeneratorPartials do
693
896
  expect( mask_include_guard_hashes(buf.string).strip() ).to eq file_contents.strip()
694
897
  end
695
898
 
899
+ # A module with no types has no types header, so its macros and the source's later
900
+ # includes meet here, in the order the source compiles them
901
+ it "writes the source's later includes where the header's items end" do
902
+ file_contents = <<~CONTENTS
903
+ #ifndef GEN<HASH>_SENSOR_IMPL_H_CEEDLING
904
+ #define GEN<HASH>_SENSOR_IMPL_H_CEEDLING
905
+
906
+ #define SENSOR_H
907
+
908
+ #include "sensor_config.h"
909
+
910
+ #define SENSOR_COUNT 4
911
+
912
+ #include "sensor_log.h"
913
+
914
+ void sensor_read(void);
915
+
916
+ #endif // GEN<HASH>_SENSOR_IMPL_H_CEEDLING
917
+
918
+ CONTENTS
919
+
920
+ macro = make_stmt(text: '#define SENSOR_COUNT 4').tap { |stmt| stmt.origin = :header }
921
+ read = CExtractorTypes::CFunctionDefinition.new(name: 'sensor_read', origin: :source)
922
+ decls = [Partials.manufacture_function_declaration(name: 'sensor_read', signature: 'void sensor_read(void)')]
923
+
924
+ @generator.send(
925
+ :generate_header, buf, 'sensor_impl', [UserInclude.new('sensor_config.h')], decls, make_module( macro, read ),
926
+ include_variables: true, include_guard: 'SENSOR_H', following_includes: [UserInclude.new('sensor_log.h')]
927
+ )
928
+
929
+ expect( mask_include_guard_hashes(buf.string).strip() ).to eq file_contents.strip()
930
+ end
931
+
932
+ it "writes the source's later includes last when the source adds nothing" do
933
+ macro = make_stmt(text: '#define SENSOR_COUNT 4').tap { |stmt| stmt.origin = :header }
934
+
935
+ @generator.send(
936
+ :generate_header, buf, 'sensor_impl', [], [], make_module( macro ),
937
+ include_variables: true, following_includes: [UserInclude.new('sensor_log.h')]
938
+ )
939
+
940
+ expect( mask_include_guard_hashes(buf.string) ).to end_with(
941
+ "#define SENSOR_COUNT 4\n\n#include \"sensor_log.h\"\n\n#endif // GEN<HASH>_SENSOR_IMPL_H_CEEDLING\n\n"
942
+ )
943
+ end
944
+
696
945
  it "should generate a header file with variable declarations (extern prefix added automatically)" do
697
946
  file_contents = <<~CONTENTS
698
947
  #ifndef GEN<HASH>_PB_AND_J_H_CEEDLING
@@ -722,6 +971,106 @@ describe GeneratorPartials do
722
971
  expect(buf.string).to include('extern volatile cmd_t cmd;')
723
972
  end
724
973
 
974
+ # A header that declares a variable and a source that defines it name one variable
975
+ it "should write one extern declaration for a variable both declared and defined" do
976
+ c_module = make_module(
977
+ make_var(name: 'mode', type: 'int', text: 'int mode;', decorators: ['extern']),
978
+ make_var(name: 'mode', type: 'int', text: 'int mode = 3;')
979
+ )
980
+ @generator.send(:generate_header, buf, 'mymod', [], [], c_module, include_variables: true)
981
+
982
+ expect(buf.string.scan('extern int mode;').size).to eq(1)
983
+ end
984
+
985
+ # The definition knows the array's size, so a test's sizeof still works
986
+ it "should write that one extern declaration from the variable's definition" do
987
+ c_module = make_module(
988
+ CExtractorTypes::CVariableDeclaration.new(name: 'lut', type: 'int', array_suffix: '[]', text: 'int lut[];', decorators: ['extern', 'const']),
989
+ CExtractorTypes::CVariableDeclaration.new(name: 'lut', type: 'int', array_suffix: '[4]', text: 'int lut[4] = {1, 2, 3, 4};', decorators: ['const'])
990
+ )
991
+ @generator.send(:generate_header, buf, 'mymod', [], [], c_module, include_variables: true)
992
+
993
+ expect(buf.string).to include('extern const int lut[4];')
994
+ expect(buf.string).not_to include('lut[];')
995
+ end
996
+
997
+ # A function pointer's type wraps its name, so the extern needs the whole declarator
998
+ it "should write a function pointer's extern declaration with its whole declarator" do
999
+ c_module = make_module(
1000
+ CExtractorTypes::CVariableDeclaration.new(name: 's_hook', type: 'int', declarator: '(*s_hook)(int)', text: 'int (*s_hook)(int);', decorators: ['static'])
1001
+ )
1002
+ @generator.send(:generate_header, buf, 'mymod', [], [], c_module, include_variables: true)
1003
+
1004
+ expect(buf.string).to include('extern int (*s_hook)(int);')
1005
+ end
1006
+
1007
+ it "should take a function-pointer array's declarator from its definition" do
1008
+ c_module = make_module(
1009
+ CExtractorTypes::CVariableDeclaration.new(name: 'table', type: 'int', declarator: '(*table[])(int)', text: 'int (*table[])(int);', decorators: ['extern']),
1010
+ CExtractorTypes::CVariableDeclaration.new(name: 'table', type: 'int', declarator: '(*table[2])(int)', text: 'int (*table[2])(int) = { one, two };')
1011
+ )
1012
+ @generator.send(:generate_header, buf, 'mymod', [], [], c_module, include_variables: true)
1013
+
1014
+ expect(buf.string).to include('extern int (*table[2])(int);')
1015
+ expect(buf.string).not_to include('table[])')
1016
+ end
1017
+
1018
+ # An asm label names the symbol, so the extern must carry it to reach the definition
1019
+ it "should write a variable's asm label after its name, array size or declarator" do
1020
+ c_module = make_module(
1021
+ CExtractorTypes::CVariableDeclaration.new(name: 'g_s', type: 'int', asm_label: '__asm__("g_sym")', text: 'int g_s __asm__("g_sym") = 1;'),
1022
+ CExtractorTypes::CVariableDeclaration.new(name: 'g_a', type: 'int', array_suffix: '[2]', asm_label: 'asm("a_sym")', text: 'int g_a[2] asm("a_sym");'),
1023
+ CExtractorTypes::CVariableDeclaration.new(name: 'g_fp', type: 'int', declarator: '(*g_fp)(int)', asm_label: '__asm("fp_sym")', text: 'int (*g_fp)(int) __asm("fp_sym");')
1024
+ )
1025
+ @generator.send(:generate_header, buf, 'mymod', [], [], c_module, include_variables: true)
1026
+
1027
+ expect(buf.string).to include('extern int g_s __asm__("g_sym");', 'extern int g_a[2] asm("a_sym");', 'extern int (*g_fp)(int) __asm("fp_sym");')
1028
+ end
1029
+
1030
+ # A compiler applies one declaration's label to the variable's other declarations
1031
+ it "should take an asm label from a header's extern when the definition has none" do
1032
+ c_module = make_module(
1033
+ CExtractorTypes::CVariableDeclaration.new(name: 'g_h', type: 'int', asm_label: 'asm("h_sym")', text: 'int g_h asm("h_sym");', decorators: ['extern']),
1034
+ CExtractorTypes::CVariableDeclaration.new(name: 'g_h', type: 'int', text: 'int g_h = 3;')
1035
+ )
1036
+ @generator.send(:generate_header, buf, 'mymod', [], [], c_module, include_variables: true)
1037
+
1038
+ expect(buf.string).to include('extern int g_h asm("h_sym");')
1039
+ end
1040
+
1041
+ it "should take an asm label from a later declaration when neither the first nor the definition has one" do
1042
+ c_module = make_module(
1043
+ CExtractorTypes::CVariableDeclaration.new(name: 'g_l', type: 'int', text: 'int g_l;', decorators: ['extern']),
1044
+ CExtractorTypes::CVariableDeclaration.new(name: 'g_l', type: 'int', asm_label: 'asm("l_sym")', text: 'int g_l asm("l_sym");', decorators: ['extern']),
1045
+ CExtractorTypes::CVariableDeclaration.new(name: 'g_l', type: 'int', text: 'int g_l = 1;')
1046
+ )
1047
+ @generator.send(:generate_header, buf, 'mymod', [], [], c_module, include_variables: true)
1048
+
1049
+ expect(buf.string).to include('extern int g_l asm("l_sym");')
1050
+ expect(buf.string.scan('g_l').size).to eq(1)
1051
+ end
1052
+
1053
+ # A macro may spell a whole declaration, and the extractor then reads no name from it
1054
+ it "should write no extern declaration for a variable without a name" do
1055
+ c_module = make_module(
1056
+ CExtractorTypes::CVariableDeclaration.new(name: nil, text: 'DEFINE_VAR(int, g_x) = 5;'),
1057
+ CExtractorTypes::CVariableDeclaration.new(name: 'g_y', type: 'int', text: 'int g_y;')
1058
+ )
1059
+ @generator.send(:generate_header, buf, 'mymod', [], [], c_module, include_variables: true)
1060
+
1061
+ expect(buf.string).to include('extern int g_y;')
1062
+ expect(buf.string.scan('extern').size).to eq(1)
1063
+ end
1064
+
1065
+ it "should reapply a leading qualifier ahead of a declarator" do
1066
+ c_module = make_module(
1067
+ CExtractorTypes::CVariableDeclaration.new(name: 'pick', type: 'char', declarator: '(*pick)(int)', text: 'char (*pick)(int);', decorators: ['const'])
1068
+ )
1069
+ @generator.send(:generate_header, buf, 'mymod', [], [], c_module, include_variables: true)
1070
+
1071
+ expect(buf.string).to include('extern const char (*pick)(int);')
1072
+ end
1073
+
725
1074
  it "should not reapply a qualifier already embedded in a pointer-level declarator" do
726
1075
  c_module = make_module(
727
1076
  make_var(name: 'lookup_table', type: 'uint8_t* const', text: 'uint8_t* const lookup_table;', decorators: ['static', 'const'])
@@ -1414,6 +1763,258 @@ describe GeneratorPartials do
1414
1763
  expect(buf.string).to include('int counter __attribute__((aligned(16)));')
1415
1764
  end
1416
1765
 
1766
+ # A variable declared `extern` lives elsewhere. A weak definition satisfies the link when
1767
+ # nothing else defines it, and yields to a real definition without a duplicate symbol.
1768
+ it "writes a weak definition of an extern variable by default" do
1769
+ c_module = make_module(
1770
+ make_var(name: 'board_count', type: 'int', text: 'int board_count;', decorators: ['extern'])
1771
+ )
1772
+
1773
+ @generator.send(:generate_source, buf, [], [], c_module)
1774
+
1775
+ expect(buf.string).to include(
1776
+ "#if defined(__GNUC__)\n__attribute__((weak)) int board_count;\n#else\nint board_count;\n#endif\n"
1777
+ )
1778
+ end
1779
+
1780
+ it "keeps a const qualifier on the weak definition" do
1781
+ c_module = make_module(
1782
+ make_var(name: 'limit', type: 'int', text: 'int limit;', decorators: ['extern', 'const'])
1783
+ )
1784
+
1785
+ @generator.send(:generate_source, buf, [], [], c_module)
1786
+
1787
+ expect(buf.string).to include("__attribute__((weak)) const int limit;\n")
1788
+ end
1789
+
1790
+ it "writes no definition of an extern variable when the test defines it" do
1791
+ c_module = make_module(
1792
+ make_var(name: 'board_count', type: 'int', text: 'int board_count;', decorators: ['extern'])
1793
+ )
1794
+
1795
+ @generator.send(:generate_source, buf, [], [], c_module, extern_variables: :test)
1796
+
1797
+ expect(buf.string).not_to include('board_count')
1798
+ end
1799
+
1800
+ # The module's own definition is the variable, so its extern needs nothing more
1801
+ it "writes only the module's definition of a variable the header declares extern" do
1802
+ c_module = make_module(
1803
+ make_var(name: 'mode', type: 'int', text: 'int mode;', decorators: ['extern']),
1804
+ make_var(name: 'mode', type: 'int', text: 'int mode = 3;')
1805
+ )
1806
+
1807
+ @generator.send(:generate_source, buf, [], [], c_module)
1808
+
1809
+ expect(buf.string).not_to include('weak')
1810
+ expect(buf.string.scan('mode').size).to eq(1)
1811
+ expect(buf.string).to include('int mode = 3;')
1812
+ end
1813
+
1814
+ # A header and its source may both declare the same extern variable
1815
+ it "writes one weak definition for a variable declared extern more than once" do
1816
+ c_module = make_module(
1817
+ make_var(name: 'board_count', type: 'int', text: 'int board_count;', decorators: ['extern']),
1818
+ make_var(name: 'board_count', type: 'int', text: 'int board_count;', decorators: ['extern'])
1819
+ )
1820
+
1821
+ @generator.send(:generate_source, buf, [], [], c_module)
1822
+
1823
+ expect(buf.string.scan('__attribute__((weak)) int board_count;').size).to eq(1)
1824
+ end
1825
+
1826
+ # A definition of a type never completed in the module's translation unit cannot compile
1827
+ it "writes no weak definition for a variable the plan marks incomplete" do
1828
+ c_module = make_module(
1829
+ make_var(name: 'handle', type: 'struct handle_s', text: 'struct handle_s handle;', decorators: ['extern'])
1830
+ )
1831
+ carry = Partials::CarryPlan.new( incomplete: Set['handle'] )
1832
+
1833
+ @generator.send(:generate_source, buf, [], [], c_module, carry: carry)
1834
+
1835
+ expect(buf.string).not_to include('handle')
1836
+ end
1837
+ end
1838
+
1839
+ context "#generate_source (private method) carrying unselected content" do
1840
+ let(:buf) { StringIO.new() }
1841
+
1842
+ def make_decl(signature, line_num: nil, source_filepath: nil)
1843
+ CExtractorTypes::CFunctionDeclaration.new(
1844
+ name: signature[/(\w+)\s*\(/, 1], signature: signature, line_num: line_num, source_filepath: source_filepath
1845
+ )
1846
+ end
1847
+
1848
+ def make_defn(code_block)
1849
+ CExtractorTypes::CFunctionDefinition.new( name: code_block[/(\w+)\s*\(/, 1], code_block: code_block )
1850
+ end
1851
+
1852
+ def plan_with(prototypes: [], helpers: [])
1853
+ plan = Partials::CarryPlan.new
1854
+ prototypes.each { |d| plan.add_prototype( d, 'external: no body in module' ) }
1855
+ helpers.each { |h| plan.add_helper( h, 'helper: referenced by `get`' ) }
1856
+ plan
1857
+ end
1858
+
1859
+ it "writes nothing new when nothing is carried" do
1860
+ tick = make_decl( 'int board_tick(void);' )
1861
+
1862
+ @generator.send(:generate_source, buf, [], [], make_module( tick ))
1863
+
1864
+ expect( buf.string.strip ).to eq( '// Ceedling generated file' )
1865
+ end
1866
+
1867
+ it "writes a carried prototype word for word after the includes" do
1868
+ twice = make_decl( 'extern inline int engine_get_twice(void);' )
1869
+
1870
+ @generator.send(:generate_source, buf, [UserInclude.new('engine_api.h')], [], make_module( twice ), carry: plan_with( prototypes: [twice] ))
1871
+
1872
+ expect( buf.string.index( 'extern inline int engine_get_twice(void);' ) ).to be > buf.string.index( '#include "engine_api.h"' )
1873
+ end
1874
+
1875
+ it "writes only the prototypes the plan carries" do
1876
+ kept = make_decl( 'int board_tick(void);' )
1877
+ dropped = make_decl( 'int engine_get(void);' )
1878
+
1879
+ @generator.send(:generate_source, buf, [], [], make_module( kept, dropped ), carry: plan_with( prototypes: [kept] ))
1880
+
1881
+ expect( buf.string ).to include( 'int board_tick(void);' )
1882
+ expect( buf.string ).not_to include( 'int engine_get(void);' )
1883
+ end
1884
+
1885
+ # Matching is by identity, because the plan chose particular declarations
1886
+ it "skips an equal declaration the plan did not choose" do
1887
+ chosen = make_decl( 'int board_tick(void);' )
1888
+ twin = make_decl( 'int board_tick(void);' )
1889
+
1890
+ @generator.send(:generate_source, buf, [], [], make_module( chosen, twin ), carry: plan_with( prototypes: [chosen] ))
1891
+
1892
+ expect( buf.string.scan( 'int board_tick(void);' ).size ).to eq( 1 )
1893
+ end
1894
+
1895
+ it "anchors a located prototype to its original line" do
1896
+ tick = make_decl( 'int board_tick(void);', line_num: 5, source_filepath: 'src/engine.h' )
1897
+
1898
+ @generator.send(:generate_source, buf, [], [], make_module( tick ), carry: plan_with( prototypes: [tick] ))
1899
+
1900
+ expect( buf.string ).to include( "#line 5 \"src/engine.h\"\nint board_tick(void);\n" )
1901
+ end
1902
+
1903
+ it "writes an unlocated prototype without a line directive" do
1904
+ tick = make_decl( 'int board_tick(void);' )
1905
+
1906
+ @generator.send(:generate_source, buf, [], [], make_module( tick ), carry: plan_with( prototypes: [tick] ))
1907
+
1908
+ expect( buf.string ).not_to include( '#line' )
1909
+ end
1910
+
1911
+ it "wraps a run of carried prototypes once in GCC diagnostic pragmas" do
1912
+ tick = make_decl( 'int board_tick(void);' )
1913
+ poll = make_decl( 'int engine_poll(void);' )
1914
+
1915
+ @generator.send(:generate_source, buf, [], [], make_module( tick, poll ), carry: plan_with( prototypes: [tick, poll] ))
1916
+
1917
+ expect( buf.string ).to include( PartialSourceWriter::REDUNDANT_DECLS_PUSH + "int board_tick(void);\nint engine_poll(void);\n" + PartialSourceWriter::REDUNDANT_DECLS_POP )
1918
+ expect( buf.string.scan( 'diagnostic push' ).size ).to eq( 1 )
1919
+ end
1920
+
1921
+ it "treats an uncarried declaration between prototypes as part of the run" do
1922
+ tick = make_decl( 'int board_tick(void);' )
1923
+ skipped = make_decl( 'int engine_get(void);' )
1924
+ poll = make_decl( 'int engine_poll(void);' )
1925
+
1926
+ @generator.send(:generate_source, buf, [], [], make_module( tick, skipped, poll ), carry: plan_with( prototypes: [tick, poll] ))
1927
+
1928
+ expect( buf.string.scan( 'diagnostic push' ).size ).to eq( 1 )
1929
+ end
1930
+
1931
+ it "closes the wrapper before other content and opens a new one after it" do
1932
+ tick = make_decl( 'int board_tick(void);' )
1933
+ mode = make_var( name: 'mode', type: 'int', text: 'int mode = 3;' )
1934
+ poll = make_decl( 'int engine_poll(void);' )
1935
+
1936
+ @generator.send(:generate_source, buf, [], [], make_module( tick, mode, poll ), carry: plan_with( prototypes: [tick, poll] ))
1937
+
1938
+ expect( buf.string ).to include( "int board_tick(void);\n" + PartialSourceWriter::REDUNDANT_DECLS_POP + "int mode = 3;\n" + PartialSourceWriter::REDUNDANT_DECLS_PUSH + "int engine_poll(void);\n" )
1939
+ end
1940
+
1941
+ it "writes carried prototypes bare when suppression is off" do
1942
+ tick = make_decl( 'int board_tick(void);' )
1943
+
1944
+ @generator.send(:generate_source, buf, [], [], make_module( tick ), carry: plan_with( prototypes: [tick] ), suppress_redundant_decls: false)
1945
+
1946
+ expect( buf.string ).to include( 'int board_tick(void);' )
1947
+ expect( buf.string ).not_to include( '#pragma' )
1948
+ end
1949
+
1950
+ it "writes a carried helper as written, anchored to the header" do
1951
+ clamp_def = make_defn( 'static inline int clamp(int v) { return v; }' )
1952
+ helper = Partials.manufacture_function_definition(
1953
+ name: 'clamp', signature: 'static inline int clamp(int v)', code_block: 'static inline int clamp(int v) { return v; }',
1954
+ source_filepath: 'src/engine.h', line_num: 7
1955
+ )
1956
+
1957
+ @generator.send(:generate_source, buf, [], [], make_module( clamp_def ), carry: plan_with( helpers: [helper] ))
1958
+
1959
+ expect( buf.string ).to include( "#line 7 \"src/engine.h\"\nstatic inline int clamp(int v) { return v; }\n" )
1960
+ end
1961
+
1962
+ it "writes a selected function rather than a helper of the same name" do
1963
+ get_def = make_defn( 'int get(void) { return 1; }' )
1964
+ selected = Partials.manufacture_function_definition( name: 'get', signature: 'int get(void)', code_block: 'int get(void) { return 1; }' )
1965
+ helper = Partials.manufacture_function_definition(
1966
+ name: 'get', signature: 'static inline int get(void)', code_block: 'static inline int get(void) { return 2; }'
1967
+ )
1968
+
1969
+ @generator.send(:generate_source, buf, [], [selected], make_module( get_def ), carry: plan_with( helpers: [helper] ))
1970
+
1971
+ expect( buf.string ).to include( 'int get(void) { return 1; }' )
1972
+ expect( buf.string ).not_to include( 'return 2;' )
1973
+ end
1974
+
1975
+ # Items after a located prototype would otherwise be attributed to the prototype's header
1976
+ it "points the line marker back at the generated file after located prototypes" do
1977
+ tick = make_decl( 'int board_tick(void);', line_num: 5, source_filepath: 'src/engine.h' )
1978
+ mode = make_var( name: 'mode', type: 'int', text: 'int mode = 3;' )
1979
+
1980
+ @generator.send(:generate_source, buf, [UserInclude.new('a.h')], [], make_module( tick, mode ),
1981
+ carry: plan_with( prototypes: [tick] ), filepath: 'build/partials/engine_impl.c')
1982
+
1983
+ lines = buf.string.lines
1984
+ reset = lines.index { |l| l.include?( '"build/partials/engine_impl.c"' ) }
1985
+ expect( lines[reset] ).to eq( "#line #{reset + 2} \"build/partials/engine_impl.c\"\n" )
1986
+ expect( lines[reset + 1] ).to eq( "int mode = 3;\n" )
1987
+ end
1988
+
1989
+ it "leaves the line marker alone when a located function follows" do
1990
+ tick = make_decl( 'int board_tick(void);', line_num: 5, source_filepath: 'src/engine.h' )
1991
+ get_def = make_defn( 'int get(void) { return 1; }' )
1992
+ get = Partials.manufacture_function_definition(
1993
+ name: 'get', signature: 'int get(void)', code_block: 'int get(void) { return 1; }', source_filepath: 'src/engine.c', line_num: 9
1994
+ )
1995
+
1996
+ @generator.send(:generate_source, buf, [], [get], make_module( tick, get_def ),
1997
+ carry: plan_with( prototypes: [tick] ), filepath: 'build/partials/engine_impl.c')
1998
+
1999
+ expect( buf.string ).not_to include( 'engine_impl.c' )
2000
+ end
2001
+
2002
+ it "leaves the line marker alone at the end of the file" do
2003
+ tick = make_decl( 'int board_tick(void);', line_num: 5, source_filepath: 'src/engine.h' )
2004
+
2005
+ @generator.send(:generate_source, buf, [], [], make_module( tick ),
2006
+ carry: plan_with( prototypes: [tick] ), filepath: 'build/partials/engine_impl.c')
2007
+
2008
+ expect( buf.string ).not_to include( 'engine_impl.c' )
2009
+ end
2010
+
2011
+ it "closes an open wrapper at the end of the file" do
2012
+ tick = make_decl( 'int board_tick(void);' )
2013
+
2014
+ @generator.send(:generate_source, buf, [], [], make_module( tick ), carry: plan_with( prototypes: [tick] ))
2015
+
2016
+ expect( buf.string ).to end_with( PartialSourceWriter::REDUNDANT_DECLS_POP )
2017
+ end
1417
2018
  end
1418
2019
 
1419
2020
  end