ceedling 1.2.2 → 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 (390) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +1 -1
  4. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  5. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  6. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  7. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  8. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  9. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  10. data/docs/BreakingChanges.md +16 -0
  11. data/docs/Changelog.md +71 -0
  12. data/docs/KnownIssues.md +91 -4
  13. data/examples/wondrous_forest/README.md +29 -1
  14. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  15. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  16. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  17. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  18. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  19. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  20. data/lib/ceedling/c_extractor/README.md +15 -7
  21. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  22. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  23. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  24. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  25. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  26. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  27. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  28. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  29. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  30. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  31. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  32. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  33. data/lib/ceedling/c_identifier.rb +21 -0
  34. data/lib/ceedling/ceedling.h +8 -0
  35. data/lib/ceedling/config/configurator.rb +4 -3
  36. data/lib/ceedling/config/configurator_builder.rb +17 -0
  37. data/lib/ceedling/config/configurator_setup.rb +29 -5
  38. data/lib/ceedling/constants.rb +5 -1
  39. data/lib/ceedling/defaults.rb +31 -1
  40. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  41. data/lib/ceedling/dependencies/README.md +1 -1
  42. data/lib/ceedling/dependencies/dependency_cache_store.rb +30 -25
  43. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  44. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  45. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  46. data/lib/ceedling/diagnostics/README.md +5 -0
  47. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  48. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  49. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  50. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  51. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  52. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  53. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  54. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  55. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  56. data/lib/ceedling/filesystem/PATH_HANDLING.md +83 -27
  57. data/lib/ceedling/filesystem/README.md +6 -1
  58. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  59. data/lib/ceedling/filesystem/build_subpath.rb +110 -25
  60. data/lib/ceedling/filesystem/file_finder.rb +76 -110
  61. data/lib/ceedling/filesystem/file_finder_helper.rb +33 -11
  62. data/lib/ceedling/filesystem/file_path_utils.rb +113 -91
  63. data/lib/ceedling/filesystem/file_wrapper.rb +105 -28
  64. data/lib/ceedling/filesystem/path_matcher.rb +21 -0
  65. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  66. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  67. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  68. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  69. data/lib/ceedling/generators/generator.rb +27 -64
  70. data/lib/ceedling/generators/generator_helper.rb +0 -44
  71. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  72. data/lib/ceedling/generators/generator_partials.rb +305 -243
  73. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  74. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  75. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  76. data/lib/ceedling/includes/header_search.rb +225 -0
  77. data/lib/ceedling/includes/include_factory.rb +9 -12
  78. data/lib/ceedling/includes/include_pathinator.rb +53 -31
  79. data/lib/ceedling/includes/includes.rb +149 -37
  80. data/lib/ceedling/objects.yml +89 -4
  81. data/lib/ceedling/partials/README.md +110 -16
  82. data/lib/ceedling/partials/carry_plan.rb +71 -0
  83. data/lib/ceedling/partials/definition_head.rb +74 -0
  84. data/lib/ceedling/partials/include_groups.rb +37 -0
  85. data/lib/ceedling/partials/interface_extras.rb +25 -0
  86. data/lib/ceedling/partials/partializer.rb +599 -120
  87. data/lib/ceedling/partials/partializer_config.rb +5 -0
  88. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  89. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  90. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  91. data/lib/ceedling/partials/partials.rb +153 -10
  92. data/lib/ceedling/partials/type_macros.rb +126 -0
  93. data/lib/ceedling/preprocess/README.md +43 -33
  94. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  95. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  96. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +31 -75
  97. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  98. data/lib/ceedling/setupinator.rb +16 -3
  99. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  100. data/lib/ceedling/test_invoker/PIPELINE.md +57 -16
  101. data/lib/ceedling/test_invoker/README.md +1 -1
  102. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  103. data/lib/ceedling/test_invoker/mock_locator.rb +116 -9
  104. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  105. data/lib/ceedling/test_invoker/partials_manager.rb +265 -308
  106. data/lib/ceedling/test_invoker/standin_headerinator.rb +8 -15
  107. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  108. data/lib/ceedling/test_invoker/test_build_executor.rb +338 -198
  109. data/lib/ceedling/test_invoker/test_build_planner.rb +13 -19
  110. data/lib/ceedling/test_invoker/test_build_setup.rb +26 -6
  111. data/lib/ceedling/test_invoker/test_build_validations.rb +23 -20
  112. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  113. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +1 -2
  114. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  115. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  116. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +5 -3
  117. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  118. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  119. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  120. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  121. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  122. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  123. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  124. data/lib/version.rb +1 -1
  125. data/plugins/bullseye/bullseye.rake +1 -3
  126. data/plugins/bullseye/lib/bullseye.rb +15 -2
  127. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  128. data/plugins/fff/lib/fff.rb +42 -15
  129. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  130. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +134 -0
  131. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  132. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  133. data/plugins/gcov/lib/console_reportinator.rb +25 -19
  134. data/plugins/gcov/lib/reportgenerator_reportinator.rb +2 -1
  135. data/site-local/404.html +2 -2
  136. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  137. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  138. data/site-local/configuration/environment-vars.html +2 -2
  139. data/site-local/configuration/global-collections.html +3 -3
  140. data/site-local/configuration/index.html +2 -2
  141. data/site-local/configuration/loading.html +2 -2
  142. data/site-local/configuration/mixins.html +2 -2
  143. data/site-local/configuration/parallel-builds.html +2 -2
  144. data/site-local/configuration/project-file.html +2 -2
  145. data/site-local/configuration/reference/cexception.html +2 -2
  146. data/site-local/configuration/reference/cmock.html +5 -2
  147. data/site-local/configuration/reference/defines.html +2 -2
  148. data/site-local/configuration/reference/environment.html +2 -2
  149. data/site-local/configuration/reference/extension.html +2 -2
  150. data/site-local/configuration/reference/files.html +56 -9
  151. data/site-local/configuration/reference/flags.html +2 -2
  152. data/site-local/configuration/reference/index.html +2 -2
  153. data/site-local/configuration/reference/libraries.html +2 -2
  154. data/site-local/configuration/reference/mixins.html +2 -2
  155. data/site-local/configuration/reference/partials.html +84 -2
  156. data/site-local/configuration/reference/paths.html +7 -2
  157. data/site-local/configuration/reference/plugins.html +2 -2
  158. data/site-local/configuration/reference/project.html +247 -5
  159. data/site-local/configuration/reference/release-build.html +2 -2
  160. data/site-local/configuration/reference/test-build.html +2 -2
  161. data/site-local/configuration/reference/test-runner.html +2 -2
  162. data/site-local/configuration/reference/tools.html +49 -4
  163. data/site-local/configuration/reference/unity.html +2 -2
  164. data/site-local/configuration/which-ceedling.html +2 -2
  165. data/site-local/development/index.html +2 -2
  166. data/site-local/development/plugins/configuration.html +2 -2
  167. data/site-local/development/plugins/index.html +2 -2
  168. data/site-local/development/plugins/plugin-subclass.html +5 -4
  169. data/site-local/development/plugins/rake-tasks.html +2 -2
  170. data/site-local/development/releases.html +2 -2
  171. data/site-local/development/workflow.html +2 -2
  172. data/site-local/getting-started/builds.html +2 -2
  173. data/site-local/getting-started/command-line.html +2 -2
  174. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  175. data/site-local/getting-started/example-projects/index.html +2 -2
  176. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  177. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  178. data/site-local/getting-started/index.html +2 -2
  179. data/site-local/getting-started/installation.html +2 -2
  180. data/site-local/getting-started/quick-start.html +2 -2
  181. data/site-local/help.html +2 -2
  182. data/site-local/index.html +2 -2
  183. data/site-local/overview/build-system.html +2 -2
  184. data/site-local/overview/index.html +2 -2
  185. data/site-local/overview/test-environments.html +2 -2
  186. data/site-local/overview/tools-and-frameworks.html +2 -2
  187. data/site-local/plugins/beep.html +2 -2
  188. data/site-local/plugins/bullseye/index.html +45 -38
  189. data/site-local/plugins/bullseye/licensing.html +2 -2
  190. data/site-local/plugins/command-hooks.html +4 -4
  191. data/site-local/plugins/compile-commands-json-db.html +2 -2
  192. data/site-local/plugins/cppcheck.html +2 -2
  193. data/site-local/plugins/dependencies.html +2 -2
  194. data/site-local/plugins/fff.html +16 -2
  195. data/site-local/plugins/gcov/examples.html +2 -2
  196. data/site-local/plugins/gcov/gcovr.html +8 -2
  197. data/site-local/plugins/gcov/index.html +2 -2
  198. data/site-local/plugins/gcov/overview.html +2 -2
  199. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  200. data/site-local/plugins/gcov/reporting.html +2 -2
  201. data/site-local/plugins/gcov/setup.html +2 -2
  202. data/site-local/plugins/gcov/tool-versions.html +2 -2
  203. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  204. data/site-local/plugins/index.html +2 -2
  205. data/site-local/plugins/module-generator.html +2 -2
  206. data/site-local/plugins/report-build-warnings-log.html +2 -2
  207. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  208. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  209. data/site-local/plugins/report-tests-log-factory.html +2 -2
  210. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  211. data/site-local/plugins/report-tests-raw-output-log.html +2 -2
  212. data/site-local/plugins/report-tests-teamcity-stdout.html +2 -2
  213. data/site-local/plugins/sanitize.html +2 -2
  214. data/site-local/plugins/valgrind.html +2 -2
  215. data/site-local/project/index.html +2 -2
  216. data/site-local/project/release-history.html +2 -2
  217. data/site-local/project/sbom.html +2 -2
  218. data/site-local/project/upgrade.html +2 -2
  219. data/site-local/reference/build-directives.html +2 -2
  220. data/site-local/reference/command-line.html +2 -2
  221. data/site-local/reference/environment-vars.html +2 -2
  222. data/site-local/reference/gcov-plugin.html +2 -2
  223. data/site-local/reference/global-collections.html +12 -12
  224. data/site-local/reference/index.html +2 -2
  225. data/site-local/reference/partials-macros.html +47 -2
  226. data/site-local/reference/project-configuration.html +2 -2
  227. data/site-local/sitemap.xml.gz +0 -0
  228. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  229. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  230. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  231. data/site-local/testing-guide/build-directives.html +2 -2
  232. data/site-local/testing-guide/conventions.html +67 -22
  233. data/site-local/testing-guide/frameworks.html +2 -2
  234. data/site-local/testing-guide/index.html +2 -2
  235. data/site-local/testing-guide/partials/configuration.html +31 -4
  236. data/site-local/testing-guide/partials/conventions.html +509 -8
  237. data/site-local/testing-guide/partials/directives.html +4 -3
  238. data/site-local/testing-guide/partials/example.html +2 -2
  239. data/site-local/testing-guide/partials/index.html +2 -2
  240. data/site-local/testing-guide/partials/overview.html +30 -12
  241. data/site-local/testing-guide/partials/variables.html +169 -4
  242. data/site-local/testing-guide/test-cases.html +2 -2
  243. data/site-local/testing-guide/test-sample.html +2 -2
  244. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  245. data/spec/integration/build_step_doctor_spec.rb +270 -0
  246. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  247. data/spec/integration/includes_extraction_spec.rb +27 -14
  248. data/spec/integration/nested_test_artifacts_spec.rb +1 -1
  249. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  250. data/spec/integration/partials_carry_spec.rb +520 -0
  251. data/spec/integration/partials_declarations_spec.rb +655 -0
  252. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  253. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  254. data/spec/integration/partials_header_composition_spec.rb +268 -35
  255. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  256. data/spec/integration/partials_module_resolution_spec.rb +26 -19
  257. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  258. data/spec/integration/path_length_reporting_spec.rb +64 -0
  259. data/spec/integration/path_scenarios_spec.rb +80 -3
  260. data/spec/integration/quote_include_isolator_spec.rb +56 -0
  261. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  262. data/spec/integration/test_includes_extractinator_spec.rb +70 -5
  263. data/spec/integration/test_naming_spec.rb +6 -3
  264. data/spec/integration/test_source_file_checks_spec.rb +5 -3
  265. data/spec/integration/tool_executor_spec.rb +1 -1
  266. data/spec/integration/tool_validator_spec.rb +2 -2
  267. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  268. data/spec/integration/win_path_limit_spec.rb +53 -0
  269. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  270. data/spec/support/integration/configurator_integration_helper.rb +8 -3
  271. data/spec/support/integration/partial_files_harness.rb +181 -0
  272. data/spec/support/integration/partials_generation_integration_helper.rb +237 -141
  273. data/spec/support/integration/path_scenario_harness.rb +4 -2
  274. data/spec/support/integration/spec_integration_helper.rb +8 -3
  275. data/spec/support/integration/test_includes_harness.rb +56 -35
  276. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  277. data/spec/system/bullseye_deployment_spec.rb +2 -0
  278. data/spec/system/delta_builds_spec.rb +26 -12
  279. data/spec/system/encoding_stress_spec.rb +4 -4
  280. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  281. data/spec/system/gcov_deployment_spec.rb +2 -0
  282. data/spec/system/header_include_path_validation_spec.rb +4 -4
  283. data/spec/system/header_search_paths_spec.rb +1083 -0
  284. data/spec/system/mock_include_folders_spec.rb +121 -0
  285. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  286. data/spec/system/partials_carry_spec.rb +581 -0
  287. data/spec/system/partials_delta_builds_spec.rb +280 -0
  288. data/spec/system/partials_function_pointers_spec.rb +106 -0
  289. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  290. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  291. data/spec/system/path_handling_probes_spec.rb +16 -12
  292. data/spec/system/pinned_thread_count_spec.rb +4 -4
  293. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  294. data/spec/system/short_build_paths_spec.rb +87 -0
  295. data/spec/system/sibling_header_collision_spec.rb +30 -6
  296. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  297. data/spec/system/support/common_test_cases.rb +2 -2
  298. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  299. data/spec/system/test_build_layout_spec.rb +209 -0
  300. data/spec/system/test_source_file_directive_spec.rb +35 -5
  301. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  302. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  303. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  304. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  305. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  306. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  307. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  308. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  309. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  310. data/spec/units/c_identifier_spec.rb +35 -0
  311. data/spec/units/config/configurator_builder_spec.rb +24 -0
  312. data/spec/units/config/configurator_setup_spec.rb +72 -4
  313. data/spec/units/config/configurator_spec.rb +27 -1
  314. data/spec/units/dependencies/dependency_cache_store_spec.rb +68 -3
  315. data/spec/units/dependencies/dependency_tracker_spec.rb +25 -0
  316. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  317. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  318. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  319. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  320. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  321. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  322. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  323. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  324. data/spec/units/encodinator_spec.rb +3 -4
  325. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  326. data/spec/units/filesystem/build_subpath_spec.rb +113 -0
  327. data/spec/units/filesystem/file_finder_helper_spec.rb +80 -0
  328. data/spec/units/filesystem/file_finder_spec.rb +242 -58
  329. data/spec/units/filesystem/file_path_utils_spec.rb +251 -118
  330. data/spec/units/filesystem/file_wrapper_spec.rb +191 -6
  331. data/spec/units/filesystem/path_matcher_spec.rb +36 -0
  332. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  333. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  334. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  335. data/spec/units/generators/generator_helper_spec.rb +0 -60
  336. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  337. data/spec/units/generators/generator_partials_spec.rb +656 -55
  338. data/spec/units/generators/generator_spec.rb +26 -0
  339. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  340. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  341. data/spec/units/includes/header_search_spec.rb +406 -0
  342. data/spec/units/includes/include_factory_spec.rb +22 -5
  343. data/spec/units/includes/include_pathinator_spec.rb +77 -13
  344. data/spec/units/includes/include_spec.rb +14 -0
  345. data/spec/units/includes/includes_spec.rb +176 -19
  346. data/spec/units/loginator_spec.rb +31 -0
  347. data/spec/units/mock_locator_spec.rb +199 -5
  348. data/spec/units/partials/include_groups_spec.rb +42 -0
  349. data/spec/units/partials/partializer_config_spec.rb +25 -0
  350. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  351. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  352. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  353. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  354. data/spec/units/partials/partializer_spec.rb +1578 -270
  355. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  356. data/spec/units/partials/partials_rename_spec.rb +160 -0
  357. data/spec/units/partials_manager_spec.rb +554 -261
  358. data/spec/units/plugins/bullseye_spec.rb +34 -0
  359. data/spec/units/plugins/console_reportinator_spec.rb +58 -9
  360. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +1 -1
  361. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +51 -3
  362. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  363. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  364. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  365. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  366. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  367. data/spec/units/setupinator_spec.rb +51 -0
  368. data/spec/units/standin_headerinator_spec.rb +27 -11
  369. data/spec/units/test_build_executor_spec.rb +780 -166
  370. data/spec/units/test_build_planner_spec.rb +116 -28
  371. data/spec/units/test_build_setup_spec.rb +83 -18
  372. data/spec/units/test_context_extractor_spec.rb +11 -2
  373. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  374. data/spec/units/test_includes_extractinator_spec.rb +56 -8
  375. data/spec/units/test_invoker/objects_wiring_spec.rb +20 -3
  376. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  377. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  378. data/spec/units/test_invoker_types_spec.rb +8 -7
  379. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  380. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  381. data/spec/units/test_search_paths_spec.rb +73 -5
  382. data/spec/units/{default_tools_quoting_spec.rb → tools/default_tools_quoting_spec.rb} +39 -5
  383. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  384. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  385. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +1 -1
  386. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  387. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  388. metadata +161 -16
  389. /data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +0 -0
  390. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -0,0 +1,39 @@
1
+ /* =========================================================================
2
+ Ceedling - Test-Centered Build System for C
3
+ ThrowTheSwitch.org
4
+ Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ SPDX-License-Identifier: MIT
6
+ ========================================================================= */
7
+
8
+ #ifndef RAIN_GAUGE_H
9
+ #define RAIN_GAUGE_H
10
+
11
+ #include "Types.h"
12
+
13
+ /* A tipping-bucket gauge. The bucket tips once for each 0.2 mm of rain. */
14
+ #define RAIN_GAUGE_UM_PER_TIP (200u)
15
+
16
+ /* Rain falling at 20 mm per hour or more is a storm */
17
+ #define RAIN_GAUGE_STORM_UM_PER_HOUR (20000u)
18
+
19
+ /* The station updates the gauge once a minute */
20
+ #define RAIN_GAUGE_UPDATES_PER_HOUR (60u)
21
+
22
+ /* Bucket tips since power-up. The tip interrupt in RainTipIsr.c defines and
23
+ * counts it. */
24
+ extern uint32 g_rain_tip_count;
25
+
26
+ /* Shared with the station's display code, which shows rainfall between updates */
27
+ static inline uint32 RainGauge_TipsToMicrometers(uint32 tips)
28
+ {
29
+ return tips * RAIN_GAUGE_UM_PER_TIP;
30
+ }
31
+
32
+ void RainGauge_Init(void);
33
+ void RainGauge_Update(void);
34
+ uint32 RainGauge_GetRainfallUm(void);
35
+ uint32 RainGauge_GetRainfallTenthsMm(void);
36
+ bool RainGauge_IsStorm(void);
37
+ void RainGauge_ReportStorm(void);
38
+
39
+ #endif /* RAIN_GAUGE_H */
@@ -0,0 +1,17 @@
1
+ /* =========================================================================
2
+ Ceedling - Test-Centered Build System for C
3
+ ThrowTheSwitch.org
4
+ Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ SPDX-License-Identifier: MIT
6
+ ========================================================================= */
7
+
8
+ #include "Types.h"
9
+ #include "RainTipIsr.h"
10
+ #include "RainGauge.h"
11
+
12
+ uint32 g_rain_tip_count = 0u;
13
+
14
+ void RainTipIsr_Handler(void)
15
+ {
16
+ g_rain_tip_count++;
17
+ }
@@ -0,0 +1,14 @@
1
+ /* =========================================================================
2
+ Ceedling - Test-Centered Build System for C
3
+ ThrowTheSwitch.org
4
+ Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ SPDX-License-Identifier: MIT
6
+ ========================================================================= */
7
+
8
+ #ifndef RAIN_TIP_ISR_H
9
+ #define RAIN_TIP_ISR_H
10
+
11
+ /* The rain gauge's bucket-tip interrupt handler */
12
+ void RainTipIsr_Handler(void);
13
+
14
+ #endif /* RAIN_TIP_ISR_H */
@@ -0,0 +1,126 @@
1
+ /* =========================================================================
2
+ Ceedling - Test-Centered Build System for C
3
+ ThrowTheSwitch.org
4
+ Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ SPDX-License-Identifier: MIT
6
+ ========================================================================= */
7
+
8
+ /* Partials pattern: TEST_PARTIAL_PUBLIC_MODULE + TEST_PARTIAL_CONFIG subtraction
9
+ * Tests RainGauge's public functions. The Partial carries what they rely on
10
+ * beyond the functions this test selects:
11
+ * - RainGauge_TipsToMicrometers(), a static inline helper RainGauge.h defines.
12
+ * - The extern inline prototype that makes RainGauge.c hold the external
13
+ * definition of ForestUnits_MicrometersToTenthsMm().
14
+ * - The prototype of RainGauge_ReportStorm(), which this test subtracts and
15
+ * stubs below.
16
+ * RainGauge.h declares g_rain_tip_count extern. RainTipIsr.c defines it, and
17
+ * this test links RainTipIsr.c to simulate bucket tips. The Partial's weak
18
+ * definition of the counter gives way to that real one.
19
+ * Run with --verbosity=debug to see what the Partial carries and why. */
20
+
21
+ #include "unity.h"
22
+ #include "ceedling.h"
23
+ #include "RainTipIsr.h"
24
+
25
+ #include TEST_PARTIAL_PUBLIC_MODULE(RainGauge)
26
+ TEST_PARTIAL_CONFIG(RainGauge, -RainGauge_ReportStorm)
27
+
28
+ #include "Types.h"
29
+
30
+ static uint8 s_storm_reports;
31
+
32
+ /* Stands in for the subtracted RainGauge_ReportStorm(). The carried prototype
33
+ * lets RainGauge_Update() call it. */
34
+ void RainGauge_ReportStorm(void)
35
+ {
36
+ s_storm_reports++;
37
+ }
38
+
39
+ static void TipBucket(uint32 times)
40
+ {
41
+ while (times-- > 0u) { RainTipIsr_Handler(); }
42
+ }
43
+
44
+ void setUp(void)
45
+ {
46
+ g_rain_tip_count = 0u;
47
+ s_storm_reports = 0u;
48
+ RainGauge_Init();
49
+ }
50
+
51
+ void tearDown(void)
52
+ {
53
+ }
54
+
55
+ void test_Rainfall_StartsAtZero(void)
56
+ {
57
+ TEST_ASSERT_EQUAL_UINT32(0u, RainGauge_GetRainfallUm());
58
+ }
59
+
60
+ void test_Init_IgnoresTipsBeforeIt(void)
61
+ {
62
+ TipBucket(4u);
63
+ RainGauge_Init();
64
+ RainGauge_Update();
65
+ TEST_ASSERT_EQUAL_UINT32(0u, RainGauge_GetRainfallUm());
66
+ }
67
+
68
+ void test_Update_AddsTwoTenthsOfAMillimeterPerTip(void)
69
+ {
70
+ TipBucket(3u);
71
+ RainGauge_Update();
72
+ TEST_ASSERT_EQUAL_UINT32(600u, RainGauge_GetRainfallUm());
73
+ }
74
+
75
+ void test_Update_AccumulatesRainfallAcrossUpdates(void)
76
+ {
77
+ TipBucket(1u);
78
+ RainGauge_Update();
79
+ TipBucket(1u);
80
+ RainGauge_Update();
81
+ TEST_ASSERT_EQUAL_UINT32(400u, RainGauge_GetRainfallUm());
82
+ }
83
+
84
+ void test_GetRainfallTenthsMm_ConvertsMicrometers(void)
85
+ {
86
+ /* 5 tips = 1000 um = 1.0 mm */
87
+ TipBucket(5u);
88
+ RainGauge_Update();
89
+ TEST_ASSERT_EQUAL_UINT32(10u, RainGauge_GetRainfallTenthsMm());
90
+ }
91
+
92
+ void test_Update_OneTipAMinuteIsNotAStorm(void)
93
+ {
94
+ /* 200 um in a minute = 12 mm per hour */
95
+ TipBucket(1u);
96
+ RainGauge_Update();
97
+ TEST_ASSERT_FALSE(RainGauge_IsStorm());
98
+ TEST_ASSERT_EQUAL_UINT8(0u, s_storm_reports);
99
+ }
100
+
101
+ void test_Update_TwoTipsAMinuteReportAStorm(void)
102
+ {
103
+ /* 400 um in a minute = 24 mm per hour */
104
+ TipBucket(2u);
105
+ RainGauge_Update();
106
+ TEST_ASSERT_TRUE(RainGauge_IsStorm());
107
+ TEST_ASSERT_EQUAL_UINT8(1u, s_storm_reports);
108
+ }
109
+
110
+ void test_Update_ReportsAContinuingStormOnce(void)
111
+ {
112
+ TipBucket(2u);
113
+ RainGauge_Update();
114
+ TipBucket(3u);
115
+ RainGauge_Update();
116
+ TEST_ASSERT_TRUE(RainGauge_IsStorm());
117
+ TEST_ASSERT_EQUAL_UINT8(1u, s_storm_reports);
118
+ }
119
+
120
+ void test_Update_EndsTheStormWhenRainEases(void)
121
+ {
122
+ TipBucket(2u);
123
+ RainGauge_Update();
124
+ RainGauge_Update();
125
+ TEST_ASSERT_FALSE(RainGauge_IsStorm());
126
+ }
@@ -22,15 +22,15 @@ Together these calls let the c_extractor classes behave like a small hand-writte
22
22
 
23
23
  The most important method is `collect_balanced`. It is given an open character and a matching close character, such as `{` and `}`. The scanner must already be sitting on the open character. `collect_balanced` walks forward, counting how deep it is inside nested pairs. It stops the moment the count returns to zero, at the matching close character. Along the way it treats anything inside a string or character literal as inert text, so a stray `}` inside a quoted string can never be mistaken for the end of the group. It also replaces any comment it passes through with a single space, so a brace hiding inside a comment cannot confuse the count either. This one method is what lets the subsystem find the true end of a function body, no matter how deeply that body nests loops, conditionals, or braced initializers.
24
24
 
25
- Other methods in this toolkit skip a string or character literal safely, honoring backslash escapes so an escaped quote does not end the literal early. Others skip whitespace and comments, skip runs of stray semicolons, and strip away compiler-specific syntax such as `__attribute__((...))` or `__declspec(...)`. These extensions are stripped because they can otherwise be mistaken for part of a function's parameter list or a variable's declaration.
25
+ Other methods in this toolkit skip a string or character literal safely, honoring backslash escapes so an escaped quote does not end the literal early. Others skip whitespace and comments, skip runs of stray semicolons, and strip away compiler-specific syntax such as `__attribute__((...))` or `__declspec(...)`. These extensions are stripped because they can otherwise be mistaken for part of a function's parameter list or a variable's declaration. Type keywords and specifiers, such as `_Atomic` and `typeof(...)`, stay.
26
26
 
27
27
  ## Recognizing Functions
28
28
 
29
29
  `CExtractorFunctions` finds function declarations and function definitions. A declaration is a bare prototype ending in a semicolon. A definition carries a full body in braces.
30
30
 
31
- The extractor walks forward from a candidate starting point, tracking how deep it is inside parentheses. It also watches for a few signs that what it is looking at is not actually a function. A leading `(*name)` pattern signals a function-pointer variable, not a function. A `[` appearing before any `(` signals an array variable. An `=` appearing outside any parentheses signals a variable with an initializer. Once these possibilities are ruled out, the extractor knows it has found a genuine function signature.
31
+ The extractor walks forward from a candidate starting point, tracking how deep it is inside parentheses. It also watches for a few signs that what it is looking at is not actually a function. A name inside parentheses, as in `int (*hook)(int)`, declares a function only when a parameter list follows it, as in `int (*get(void))(int)`. Otherwise it signals a variable, such as a function pointer. A pointer inside the parameter list only declares a parameter. A `[` appearing before any `(` signals an array variable. An `=` appearing outside any parentheses signals a variable with an initializer. An asm label, as in `int g asm("sym");`, ends a declaration with a `)` of its own, so the extractor passes over it. Unexpanded macros may sit around a label, so a labeled declaration is a function's when it holds a group that opens like a parameter list. A parameter list is empty or opens with a word, and a macro's argument such as `(4)` doesn't. Once these possibilities are ruled out, the extractor knows it has found a genuine function signature.
32
32
 
33
- For a definition, the extractor calls on `collect_balanced` to pull the complete function body, including every nested brace inside it. For a declaration, it confirms the signature is immediately followed by a semicolon. Either way, the function's name is pulled out with a small regex, and any leading `static` or `inline` keywords are split off separately so a caller can ask about visibility without re-parsing the signature.
33
+ For a definition, the extractor calls on `collect_balanced` to pull the complete function body, including every nested brace inside it. For a declaration, it confirms the signature is immediately followed by a semicolon. Either way, the function's name is pulled out with a small regex. A specifier that takes parentheses, as in `typeof(int) f(void)`, names no function, so it is passed over with its argument. Any storage-class or inline keyword before the name, such as `static`, `extern` or `inline`, is split off separately, so a caller can ask about visibility without re-parsing the signature. Every other word keeps its place, `const` and `_Noreturn` included.
34
34
 
35
35
  ## Recognizing Variables
36
36
 
@@ -38,19 +38,27 @@ For a definition, the extractor calls on `collect_balanced` to pull the complete
38
38
 
39
39
  The extractor tracks three independent counts at the same time: parentheses, square brackets, and braces. Parentheses matter for function-pointer variables. Square brackets matter for arrays. Braces matter for initializer lists, such as `int values[] = {1, 2, 3};`. The extractor only considers the declaration finished when all three counts return to zero at a semicolon.
40
40
 
41
- Once the raw declaration text is captured, it is split at any top-level commas into one record per variable. Each variable's name, base type, array suffix, and any decorating keywords are then pulled out with straightforward regex matching against the now-isolated text.
41
+ Fallback preprocessing leaves comments in the text. Before a declaration is checked, split, and read, each comment in it becomes a single space. String and character literals stay whole, so `"//"` survives. A record's `original` text keeps its comments, because promotion finds the statement in a function body by that text.
42
+
43
+ Once the declaration text is captured, it is split at every top-level comma into one record per variable. A comma inside parentheses, brackets, braces, or a literal separates nothing. The first declarator gives the base type, which is its text ahead of its first star, or else ahead of its name, without its initializer. Each later declarator takes that base type. Each variable's name, base type, array suffix, and any decorating keywords are then pulled out of the now-isolated text. A name may hold `$`, as GCC and Clang allow.
44
+
45
+ Compiler extensions such as attributes are stripped before a name and type are read. A C23 attribute in double brackets strips too, wherever it sits. Only an attribute opens with two brackets, so an array size never strips. The record's text keeps the attribute, and a leading one stays at the front, where C requires it. The function extractor passes over one whole, so its brackets never read as an array's. Type keywords such as `_Atomic`, `_Bool`, and `_Thread_local` stay, as does a type a specifier spells, such as `typeof(int)`. A generated extern repeats the type, and it must agree with the definition.
46
+
47
+ An asm label, as in `int g __asm__("sym") = 1;`, names the variable's symbol. A compiler applies it to the declarations it sees, so a test's own extern must carry it too. `CExtractorDeclarator::AsmLabel` finds a label outside brackets and ahead of any initializer. The record keeps it in `asm_label`, and its name, type, and declarator are read without it.
48
+
49
+ A function pointer or a pointer to an array names its variable inside parentheses, past any stars and qualifiers. `CExtractorDeclarator` reads that group for the function and variable extractors alike. A variable keeps the group as its `declarator`, so generated code can declare it whole, as in `extern int (*hook)(int);`.
42
50
 
43
51
  ## Recognizing Types and Directives
44
52
 
45
- `CExtractorDefinitions` finds two kinds of type-level content. The first is a `typedef` statement, tracked from the `typedef` keyword through to its closing semicolon, watching only for balanced braces since a struct or union body can sit inside it. The second is a standalone `struct`, `enum`, or `union` definition, such as `struct Foo { ... };`. This extractor is careful to tell a type definition apart from a variable declared using an inline struct body, such as `struct Foo { ... } var;`. It does this by looking past the closing brace for a semicolon. If a semicolon follows directly, it is a type definition. If a variable name appears instead, the extractor backs off entirely and lets the variable extractor handle it.
53
+ `CExtractorDefinitions` finds two kinds of type-level content. The first is a `typedef` statement, tracked from the `typedef` keyword through to its closing semicolon, watching only for balanced braces since a struct or union body can sit inside it. The second is a standalone `struct`, `enum`, or `union` definition, such as `struct Foo { ... };`. The same keywords lead variables and functions too, and each of those can have a braced body. The extractor reads two places to tell them apart. Ahead of the brace, it rules out what no type's head holds. A top-level `=` makes an initialized variable. A top-level `*`, or a head ending in `(void)` or a pointer group, makes a function. An attribute's own parentheses don't count. After the closing brace, it passes over attributes such as `__attribute__((packed))` and looks for a semicolon. If a variable name appears instead, as in `struct Foo { ... } var;`, the extractor backs off entirely and lets the variable extractor handle it.
46
54
 
47
- `CExtractorPreprocessing` finds preprocessor directives such as `#define`, correctly following a backslash-newline so a directive spanning several physical lines is still read as one logical line. It also finds C11 and C23 `static_assert` statements. Separately, and outside the main scanning loop described below, it offers the ability to find every call to a specific named macro anywhere in a body of text and to parse out that call's arguments. This capability is used directly by Ceedling's Partials feature to read its own configuration macros (documented in `partials/`).
55
+ `CExtractorPreprocessing` finds preprocessor directives such as `#define`, correctly following a backslash-newline so a directive spanning several physical lines is still read as one logical line. It also finds C11 and C23 `static_assert` statements and bare macro invocations at the top level. A bare invocation, such as an x-macro call, ends without a semicolon. An attribute or a specifier such as `typeof` has the same shape where it leads a declaration, so the detector leaves those for the other recognizers. Separately, and outside the main scanning loop described below, it offers the ability to find every call to a specific named macro anywhere in a body of text and to parse out that call's arguments. This capability is used directly by Ceedling's Partials feature to read its own configuration macros (documented in `partials/`).
48
56
 
49
57
  ## Assembling One Module's Worth of Content
50
58
 
51
59
  `CExtractor` is the class other code actually calls. It reads a file, or an in-memory string, and produces one combined result describing everything of interest inside it.
52
60
 
53
- Internally it works through the source from beginning to end. At each position, it tries each of the recognizers described above, in a fixed order: preprocessor directives, typedefs, static assertions, aggregate type definitions, function definitions, function declarations, and finally plain variable declarations. The first recognizer that succeeds wins, and the recognizers are ordered by the uniqueness of the features they extract. This helps ensure that features that could be confused for one another are kept distinct. Scanning for another features resumes at the position immediately following the previous feature. If nothing recognizes the text at a given position, scanning stops there, and whatever has been gathered so far is returned.
61
+ Internally it works through the source from beginning to end. At each position, it tries each of the recognizers described above, in a fixed order: preprocessor directives, typedefs, static assertions, aggregate type definitions, bare macro invocations, function definitions, function declarations, and finally plain variable declarations. The first recognizer that succeeds wins, and the recognizers are ordered by the uniqueness of the features they extract. This helps ensure that features that could be confused for one another are kept distinct. Scanning for the next feature resumes at the position immediately following the previous one. If nothing recognizes the text at a given position, scanning stops there, and whatever has been gathered so far is returned.
54
62
 
55
63
  Rather than reading an entire file into memory at once, `CExtractor` reads in modest chunks, growing its working buffer only as needed until a recognizer succeeds or the end of the file is reached. This keeps memory use reasonable even for a very large source file. A safety ceiling on how large that buffer is allowed to grow guards against a genuinely malformed or unbounded input.
56
64
 
@@ -11,6 +11,7 @@ require 'ceedling/exceptions'
11
11
  require 'ceedling/c_extractor/c_extractor_constants'
12
12
  require 'ceedling/c_extractor/c_extractor_preprocessing'
13
13
  require 'ceedling/c_extractor/c_extractor_definitions'
14
+ require 'ceedling/c_extractor/c_extractor_defined_type'
14
15
  require 'ceedling/c_extractor/c_extractor_types'
15
16
 
16
17
  class CExtractor
@@ -146,7 +147,7 @@ class CExtractor
146
147
  if typedef_def
147
148
  line_num, cumulative_newlines =
148
149
  _compute_line_info(io, call_start, td_start, cumulative_newlines)
149
- stmt = CStatement.new(text: typedef_def, line_num: line_num)
150
+ stmt = CStatement.new(text: typedef_def, line_num: line_num, **CExtractorDefinedType.names( typedef_def ))
150
151
  type_definitions << stmt
151
152
  sequence << stmt
152
153
  next
@@ -176,7 +177,7 @@ class CExtractor
176
177
  if agg_def
177
178
  line_num, cumulative_newlines =
178
179
  _compute_line_info(io, call_start, agg_start, cumulative_newlines)
179
- stmt = CStatement.new(text: agg_def, line_num: line_num)
180
+ stmt = CStatement.new(text: agg_def, line_num: line_num, **CExtractorDefinedType.names( agg_def ))
180
181
  aggregate_definitions << stmt
181
182
  sequence << stmt
182
183
  next
@@ -184,16 +185,17 @@ class CExtractor
184
185
 
185
186
  # A bare, top-level, semicolon-less macro invocation (e.g. an x-macro call that
186
187
  # expands to a full function definition once the macro itself is applied) has no
187
- # leading '#', no trailing ';', and no trailing '{' -- directives-only
188
- # preprocessing never expands it, so it reaches every extractor below as literal,
189
- # unexpanded text. Tried here, before the signature-scanning extractors, because
190
- # those scan forward for their own terminating '{'/';' with no check that what
191
- # they started scanning actually looks like a signature -- given this shape
192
- # immediately followed by an unrelated typedef, aggregate, or real function, they
193
- # will happily treat that construct's own opening brace as if it belonged to this
194
- # invocation, silently discarding the real content it swallows. Catching the
195
- # invocation here, before any of that can happen, protects every construct that
196
- # can follow it, not only variable declarations (the narrower, original shape).
188
+ # leading '#' and none of what CExtractorPreprocessing::NOT_AFTER_INVOCATION names
189
+ # after it. Directives-only preprocessing never expands it, so it reaches every
190
+ # extractor below as literal, unexpanded text. Tried here, before the
191
+ # signature-scanning extractors, because those scan forward for their own
192
+ # terminating '{'/';' with no check that what they started scanning actually
193
+ # looks like a signature -- given this shape immediately followed by an unrelated
194
+ # typedef, aggregate, or real function, they will happily treat that construct's
195
+ # own opening brace as if it belonged to this invocation, silently discarding the
196
+ # real content it swallows. Catching the invocation here, before any of that can
197
+ # happen, protects every construct that can follow it, not only variable
198
+ # declarations (the narrower, original shape).
197
199
  invocation, invocation_start = extract_next_feature(
198
200
  io: io,
199
201
  max_length: @max_buffer_length,
@@ -253,6 +255,14 @@ class CExtractor
253
255
  line_num, cumulative_newlines =
254
256
  _compute_line_info(io, call_start, vars_start, cumulative_newlines)
255
257
  vars.each { |v| v.line_num = line_num }
258
+ # A declaration defining its type, as `static struct { int n; } s;` does, defines it
259
+ # ahead of its variables, which share it
260
+ defined = vars.first.defined_type
261
+ if defined
262
+ defined.line_num = line_num
263
+ aggregate_definitions << defined
264
+ sequence << defined
265
+ end
256
266
  variable_declarations.concat(vars)
257
267
  sequence.concat(vars)
258
268
  next
@@ -341,8 +351,9 @@ class CExtractor
341
351
  # Create a new scanner for the current buffer
342
352
  scanner = StringScanner.new(buffer)
343
353
 
344
- # Skip any deadspace
345
- @code_text.skip_deadspace(scanner)
354
+ # Skip any deadspace, a stray ';' included. When a feature ends at the buffer's last byte,
355
+ # skip_semicolons below can't see the ';' after it, so that ';' arrives here.
356
+ @code_text.skip_deadspace(scanner, semicolons: true)
346
357
 
347
358
  # If reached end of string having found no feature -- restart loop to containing loop to grow buffer
348
359
  next if scanner.eos?
@@ -12,21 +12,18 @@ class CExtractorCodeText
12
12
 
13
13
  include CExtractorConstants
14
14
 
15
- # Bare (no-argument-list) keywords strip_compiler_extensions strips verbatim:
16
- # MSVC calling conventions, inline hints, and C11 specifier keywords. Built
17
- # once into a single alternation regex rather than tried one keyword at a
18
- # time, since this check runs at every scanner position -- one shared regex
19
- # avoids rebuilding and re-running many small ones on every character
20
- # scanned. `\b` on both ends keeps a short keyword from matching as a mere
21
- # prefix of a longer identifier that happens to start the same way (e.g.
22
- # matching "__cdecl" inside "__cdeclFoo"); listing keywords in any order is
23
- # safe even where one prefixes another (__inline vs. __inline__), since a
24
- # match that fails its own trailing \b simply falls through to try the next
25
- # alternative at that same position.
15
+ # Bare keywords, without an argument list, that strip_compiler_extensions removes. They are
16
+ # MSVC calling conventions, inline hints and `_Noreturn`. Each matches only as a whole
17
+ # identifier, so `__cdecl` isn't found inside `__cdeclFoo` or `x$__cdecl`. Type keywords such
18
+ # as `_Atomic` and `_Bool`, and the storage class `_Thread_local`, stay. A variable's type is
19
+ # read from the text, and its extern must agree with its definition.
26
20
  BARE_STRIP_KEYWORDS = (
27
- MSVC_CALLING_CONVENTIONS + ['__forceinline', '__inline__', '__inline'] + C11_SPECIFIER_KEYWORDS
21
+ MSVC_CALLING_CONVENTIONS + ['__forceinline', '__inline__', '__inline', '_Noreturn']
28
22
  ).freeze unless const_defined?(:BARE_STRIP_KEYWORDS, false)
29
- BARE_STRIP_REGEX = /\b(?:#{BARE_STRIP_KEYWORDS.map { |kw| Regexp.escape(kw) }.join('|')})\b/.freeze unless const_defined?(:BARE_STRIP_REGEX, false)
23
+
24
+ # The keyword of an attribute form whose arguments follow, as in `__attribute__((packed))`
25
+ # and `__declspec(dllexport)`. A type `__typeof__` spells has the same shape and stays.
26
+ EXTENSION_WORD = /\A(?!__typeof(?:_unqual)?__\z)(?:__\w+__|__declspec)\z/ unless const_defined?(:EXTENSION_WORD, false)
30
27
 
31
28
  # Collect the full text of a balanced delimiter pair starting AT open_char.
32
29
  # Nested pairs, string literals (verbatim), and comments (replaced with a
@@ -126,12 +123,16 @@ class CExtractorCodeText
126
123
  # 3. If found, consumes it and continues
127
124
  # 4. If not found, restores position and exits
128
125
  #
126
+ # Deadspace that reaches the end of the text is left in place too. The text may be a buffer
127
+ # that ends early, inside a comment, so the next read must see that deadspace whole.
128
+ #
129
129
  # Parameters:
130
130
  # scanner: StringScanner positioned at potential semicolons/deadspace
131
131
  #
132
132
  # Returns: Nothing (void method)
133
133
  #
134
- # Side effects: Advances scanner position past all consecutive semicolons and deadspace
134
+ # Side effects: Advances scanner position past consecutive semicolons and the deadspace before
135
+ # and between them, not past deadspace after the last one
135
136
  #
136
137
  # Examples:
137
138
  # ";;;" -> skips all three semicolons
@@ -140,19 +141,14 @@ class CExtractorCodeText
140
141
  # "; code" -> skips first semicolon, stops at "code"
141
142
  # "code" -> skips nothing
142
143
  def skip_semicolons(scanner)
143
- while !scanner.eos?
144
+ until scanner.eos?
144
145
  start_pos = scanner.pos
145
146
  skip_deadspace(scanner)
146
- break if scanner.eos?
147
-
148
- # If we find a semicolon, consume it and continue
149
- if scanner.scan(/;/)
150
- next
151
- else
152
- # Not a semicolon, restore position and break
153
- scanner.pos = start_pos
154
- break
155
- end
147
+ next if scanner.scan(/;/)
148
+
149
+ # Not a semicolon, or the text's end: restore position and stop
150
+ scanner.pos = start_pos
151
+ break
156
152
  end
157
153
  end
158
154
 
@@ -167,8 +163,12 @@ class CExtractorCodeText
167
163
  # This method repeatedly scans for and skips these elements until no more are found,
168
164
  # ensuring all consecutive deadspace is consumed in a single call.
169
165
  #
166
+ # Ahead of a statement, a stray ';' declares nothing. With `semicolons`, it counts as
167
+ # deadspace too.
168
+ #
170
169
  # Parameters:
171
- # scanner: StringScanner positioned at potential deadspace
170
+ # scanner: StringScanner positioned at potential deadspace
171
+ # semicolons: Whether a stray ';' counts as deadspace
172
172
  #
173
173
  # Returns: Number of bytes skipped
174
174
  #
@@ -178,14 +178,14 @@ class CExtractorCodeText
178
178
  # " \n// comment\ncode" -> skips to "code"
179
179
  # "/* block */ \t\ncode" -> skips to "code"
180
180
  # "code" -> skips 0 bytes (no deadspace)
181
- def skip_deadspace(scanner)
181
+ def skip_deadspace(scanner, semicolons: false)
182
182
  start_pos = scanner.pos
183
183
 
184
184
  loop do
185
185
  initial = scanner.pos
186
186
 
187
- # Skip whitespace
188
- scanner.skip(/\s+/)
187
+ # Skip whitespace, and any stray ';' when asked
188
+ scanner.skip(semicolons ? /[\s;]+/ : /\s+/)
189
189
 
190
190
  # Skip comments
191
191
  skip_comment(scanner) if scanner.check(%r{/[/*]})
@@ -243,6 +243,32 @@ class CExtractorCodeText
243
243
  false
244
244
  end
245
245
 
246
+ # Characters that can't start an identifier, and aren't a bracket that may open an attribute
247
+ NON_WORD_RUN = /[^A-Za-z_$\[]+/ unless const_defined?(:NON_WORD_RUN, false)
248
+
249
+ # Two brackets, which open a C23 attribute and nothing else
250
+ C23_ATTRIBUTE_OPEN = /\[\s*\[/ unless const_defined?(:C23_ATTRIBUTE_OPEN, false)
251
+
252
+ # Whether a C23 attribute opens at the scanner. A one-character peek first keeps the check
253
+ # cheap, since the scans calling it test every position.
254
+ def c23_attribute_at?(scanner)
255
+ return (scanner.peek(1) == '[' and scanner.check(C23_ATTRIBUTE_OPEN))
256
+ end
257
+
258
+ # The text without its C23 attributes, its spacing otherwise unchanged. A reader looking for
259
+ # array sizes uses it, since an attribute's brackets are no size.
260
+ def strip_c23_attributes(text)
261
+ scanner = StringScanner.new(text)
262
+ result = +""
263
+ until scanner.eos?
264
+ next collect_balanced(scanner, '[', ']') if c23_attribute_at?(scanner)
265
+
266
+ result << (scanner.scan(/[^\[]+/) || scanner.getch)
267
+ end
268
+
269
+ result
270
+ end
271
+
246
272
  # Strip all compiler extensions from a string and return the cleaned result.
247
273
  # Uses an internal StringScanner plus collect_balanced() so all paren nesting depths
248
274
  # are handled correctly (e.g. __declspec(align(8)), __attribute__((format(printf,1,2)))).
@@ -251,41 +277,45 @@ class CExtractorCodeText
251
277
  # Whitespace is normalized to single spaces and the result is stripped.
252
278
  #
253
279
  # Handles:
254
- # __word__(…) — any double-underscore attribute form
280
+ # __word__(…) — a double-underscore attribute form, though `__typeof__(…)` spells a type and stays
255
281
  # __declspec(…) — MSVC declaration specifier (including nested parens)
256
- # Bare MSVC calling conventions, MSVC inline hints, C11 specifier keywords
282
+ # Bare MSVC calling conventions, MSVC inline hints and `_Noreturn`
283
+ # [[…]] — a C23 attribute, before a declaration or after a name. Only an attribute opens
284
+ # with two brackets, so an array size never strips.
257
285
  def strip_compiler_extensions(text)
258
286
  scanner = StringScanner.new(text)
259
287
  result = +""
260
288
 
289
+ # Whole identifiers are read at once, so an extension's keyword is never found inside a
290
+ # longer name, as `__cdecl` would be inside `x$__cdecl`
261
291
  until scanner.eos?
262
- # __word__(…) — any double-underscore attribute form including __attribute__((…))
263
- if scanner.check(/__\w+__\s*\(/)
264
- scanner.skip(/__\w+__/)
265
- skip_deadspace(scanner)
266
- collect_balanced(scanner, '(', ')') if scanner.peek(1) == '('
267
- next
268
- end
292
+ word = scanner.scan(IDENTIFIER)
293
+ next _pass_non_word(scanner, result) if word.nil?
269
294
 
270
- # __declspec(…) — handles nested forms like __declspec(align(8))
271
- if scanner.check(/__declspec\s*\(/)
272
- scanner.skip(/__declspec/)
273
- skip_deadspace(scanner)
274
- collect_balanced(scanner, '(', ')') if scanner.peek(1) == '('
275
- next
276
- end
295
+ result << word unless _extension?(scanner, word)
296
+ end
277
297
 
278
- # Whitelisted bare keywords (calling conventions, inline hints, C11 specifiers)
279
- if scanner.scan(BARE_STRIP_REGEX)
280
- next
281
- end
298
+ return result.gsub(/\s+/, ' ').strip
299
+ end
282
300
 
283
- result << scanner.getch
284
- end
301
+ # Passes text that starts no identifier into the result, a run of it at once. A C23 attribute
302
+ # passes whole and is left out.
303
+ def _pass_non_word(scanner, result)
304
+ return result << scanner.scan(NON_WORD_RUN) if scanner.check(NON_WORD_RUN)
305
+ return collect_balanced(scanner, '[', ']') if c23_attribute_at?(scanner)
285
306
 
286
- result.gsub!(/\s+/, ' ')
287
- result.strip!
288
- result
307
+ result << scanner.getch
308
+ end
309
+
310
+ # Whether a word is an extension to strip. A bare keyword strips alone. An attribute form,
311
+ # `__word__(…)` or `__declspec(…)`, strips only with its arguments, which the scanner passes.
312
+ def _extension?(scanner, word)
313
+ return true if BARE_STRIP_KEYWORDS.include?(word)
314
+ return false unless word.match?(EXTENSION_WORD) and scanner.check(/\s*\(/)
315
+
316
+ skip_deadspace(scanner)
317
+ collect_balanced(scanner, '(', ')')
318
+ return true
289
319
  end
290
320
 
291
321
  end
@@ -18,18 +18,29 @@ module CExtractorConstants
18
18
  # MSVC calling-convention keywords (appear between return type and function name)
19
19
  MSVC_CALLING_CONVENTIONS = ['__cdecl', '__stdcall', '__fastcall', '__thiscall', '__vectorcall'].freeze unless const_defined?(:MSVC_CALLING_CONVENTIONS, false)
20
20
 
21
- # C11/C23 bare specifier keywords (no argument list)
22
- C11_SPECIFIER_KEYWORDS = ['_Noreturn', '_Thread_local', '_Atomic', '_Bool', '_Complex', '_Imaginary'].freeze unless const_defined?(:C11_SPECIFIER_KEYWORDS, false)
21
+ # Specifiers that take parentheses, as `typeof(int)`, `_Atomic(int)` and `_Alignas(8)` do.
22
+ # Each has a macro invocation's shape, and its argument may hold a pointer or a call that
23
+ # names no declarator.
24
+ SPECIFIERS_WITH_ARGUMENTS = %w[typeof typeof_unqual __typeof __typeof__ __typeof_unqual __typeof_unqual__ _Atomic _Alignas alignas _BitInt].freeze unless const_defined?(:SPECIFIERS_WITH_ARGUMENTS, false)
23
25
 
24
- # Common type keywords that are part of return type, not decorators
25
- TYPE_KEYWORDS = ['unsigned', 'signed', 'long', 'short', 'struct', 'union', 'enum'].freeze unless const_defined?(:TYPE_KEYWORDS, false)
26
+ # A C identifier. GCC and Clang accept '$' in one, at its start, middle or end.
27
+ IDENTIFIER = /[A-Za-z_$][\w$]*/ unless const_defined?(:IDENTIFIER, false)
26
28
 
27
29
  # C type qualifiers
28
30
  TYPE_QUALIFIER_KEYWORDS = ['const', 'volatile', 'restrict'].freeze unless const_defined?(:TYPE_QUALIFIER_KEYWORDS, false)
29
31
 
30
- # C function modifier keywords
31
- MODIFIER_KEYWORDS = (['extern'] + TYPE_QUALIFIER_KEYWORDS).freeze unless const_defined?(:MODIFIER_KEYWORDS, false)
32
+ # Keywords that decorate a function rather than its return type. A storage class or inline
33
+ # specifier says how the function links or inlines. A type qualifier belongs to the return type,
34
+ # and `_Noreturn` stays with a selected function so its callers still compile cleanly.
35
+ FUNCTION_DECORATOR_KEYWORDS = (PRIVATE_KEYWORDS + ['extern']).freeze unless const_defined?(:FUNCTION_DECORATOR_KEYWORDS, false)
32
36
 
33
- # Keywords stripped when producing clean `declaration` / `signature_stripped` fields
37
+ # Keywords stripped when producing a variable's clean `text`
34
38
  DECORATOR_KEYWORDS = (PRIVATE_KEYWORDS + TYPE_QUALIFIER_KEYWORDS + ['extern']).freeze unless const_defined?(:DECORATOR_KEYWORDS, false)
39
+
40
+ # A word C reserves for the implementation with no arguments after it, as an attribute macro
41
+ # such as `__packed` is. After a type's body, one belongs to the type.
42
+ BARE_EXTENSION = /__[\w$]*+(?!\s*\()/ unless const_defined?(:BARE_EXTENSION, false)
43
+
44
+ # An attribute whose arguments come next, as in `__attribute__((packed))` and `__aligned(8)`
45
+ ATTRIBUTE_CALL = /(?:__attribute__|__attribute|__aligned)(?![\w$])\s*(?=\()/ unless const_defined?(:ATTRIBUTE_CALL, false)
35
46
  end