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
@@ -7,6 +7,7 @@
7
7
 
8
8
  require 'ceedling/c_extractor/c_extractor_constants'
9
9
  require 'ceedling/c_extractor/c_extractor_types'
10
+ require 'ceedling/c_extractor/c_extractor_declarator'
10
11
 
11
12
  class CExtractorFunctions
12
13
 
@@ -77,6 +78,73 @@ class CExtractorFunctions
77
78
  return [true, func]
78
79
  end
79
80
 
81
+ # Each name's pattern, compiled once, since a name is looked up for every function extracted.
82
+ # The name must be a whole word followed by its parameter list.
83
+ NAME_PATTERNS = Hash.new { |patterns, name| patterns[name] = /(?<![\w$])#{Regexp.escape( name )}(?=\s*\()/ } unless const_defined?(:NAME_PATTERNS, false)
84
+
85
+ # An identifier with a parameter list or a specifier's argument after it
86
+ CALLED_IDENTIFIER = /(?:^|[\s*])(#{IDENTIFIER.source})\s*\(/ unless const_defined?(:CALLED_IDENTIFIER, false)
87
+
88
+ # A specifier up to the '(' of its argument
89
+ SPECIFIER_CALL = /(?<![\w$])(?:#{SPECIFIERS_WITH_ARGUMENTS.join( '|' )})\s*(?=\()/ unless const_defined?(:SPECIFIER_CALL, false)
90
+
91
+ # What follows a parameter list's '('. A list is empty, or opens with a word, an ellipsis or a
92
+ # C23 attribute. A line splice may come first, and so may a directive that fallback
93
+ # preprocessing leaves in place.
94
+ PARAMETERS_AHEAD = /[\s\\]*(?:\)|[A-Za-z_$#]|\.\.\.|\[\[)/ unless const_defined?(:PARAMETERS_AHEAD, false)
95
+
96
+ # Where a function's name starts in text that begins with its signature, or nil. The name must
97
+ # be a whole word followed by its parameter list, so `f` is never found inside `float`.
98
+ def self.name_position(text, name)
99
+ return text.index( NAME_PATTERNS[name] )
100
+ end
101
+
102
+ # How each bracket changes the nesting depth. A literal or a comment changes nothing.
103
+ BRACKET_DEPTH = { '(' => 1, '[' => 1, ')' => -1, ']' => -1 }.freeze unless const_defined?(:BRACKET_DEPTH, false)
104
+
105
+ # The byte at which a function's body opens in its code block: the first brace outside a
106
+ # literal or comment, since an attribute's string in the signature may hold one
107
+ def self.body_start(code_block)
108
+ scanner = StringScanner.new( code_block )
109
+ nil until scanner.skip_until( CExtractorDeclarator::BALANCE_TOKEN ).nil? or scanner.matched == '{'
110
+ return scanner.pos - 1
111
+ end
112
+
113
+ # The byte just past a function's declarator in its code block. That is the last ')' at the
114
+ # top level ahead of the body. A GNU attribute after the parameter list ends in that ')'.
115
+ # A C23 attribute or a comment may follow. Nil when the head has no parameter list.
116
+ def self.signature_end(code_block)
117
+ scanner = StringScanner.new( code_block )
118
+ depth = 0
119
+ close = nil
120
+
121
+ while scanner.skip_until( CExtractorDeclarator::BALANCE_TOKEN )
122
+ break if scanner.matched == '{' and depth.zero?
123
+
124
+ depth += BRACKET_DEPTH.fetch( scanner.matched, 0 )
125
+ close = scanner.pos if scanner.matched == ')' and depth.zero?
126
+ end
127
+
128
+ return close
129
+ end
130
+
131
+ # Removes each listed token once, matching whole whitespace-separated tokens only, so the
132
+ # same word inside an attribute string or a longer name stays. Spaces after a removed token
133
+ # go with it. A newline stays, because a caller may count the lines a decorator occupied.
134
+ def self.remove_tokens(text, tokens)
135
+ parts = text.split( /(\s+)/ )
136
+
137
+ tokens.each do |token|
138
+ index = parts.index( token )
139
+ next if index.nil?
140
+
141
+ parts.delete_at( index )
142
+ parts.delete_at( index ) if parts[index]&.match?( /\A[ \t]+\z/ )
143
+ end
144
+
145
+ return parts.join
146
+ end
147
+
80
148
  private
81
149
 
82
150
  # Extract a function signature from the scanner
@@ -101,6 +169,7 @@ class CExtractorFunctions
101
169
  # - Arrays: int arr[10];
102
170
  # - Function pointers: int (*ptr)(int);
103
171
  # - Initialized variables: int x = 42;
172
+ # - Variables with an asm label: int x asm("sym");
104
173
  #
105
174
  # The method handles:
106
175
  # - String literals (both single and double quoted)
@@ -122,36 +191,16 @@ class CExtractorFunctions
122
191
  start_pos = scanner.pos
123
192
  # Tracks paren depth while accumulating candidate end-positions — not suitable for collect_balanced()
124
193
  paren_depth = 0
125
- in_string = false
126
- string_char = nil
127
194
  signature_candidates = [] # Track positions where paren_depth returns to 0
128
195
  found_opening_paren = false # Track if we've seen an opening paren
129
196
 
130
197
  until scanner.eos?
131
198
  char = scanner.peek(1)
132
199
 
133
- # Handle string literals
134
- if in_string
135
- if char == '\\'
136
- scanner.getch
137
- scanner.getch unless scanner.eos?
138
- next
139
- elsif char == string_char
140
- scanner.getch
141
- in_string = false
142
- string_char = nil
143
- next
144
- else
145
- scanner.getch
146
- next
147
- end
148
- end
149
-
150
200
  case char
151
201
  when '"', "'"
152
- in_string = true
153
- string_char = char
154
- scanner.getch
202
+ # A literal is passed whole, escapes included, so nothing in it counts
203
+ @code_text.skip_c_string(scanner, char)
155
204
  when '/'
156
205
  # Hottest comparison in the extractor -- reached for every '/' in the
157
206
  # source. `start_with?` avoids compiling and running a regex here. The
@@ -178,73 +227,13 @@ class CExtractorFunctions
178
227
  return nil
179
228
  end
180
229
  when '{'
181
- # Found opening brace
182
- if type == :declaration
183
- scanner.pos = start_pos
184
- return nil
185
- else # :definition
186
- # Check if any of our candidates is valid
187
- if signature_candidates.empty?
188
- # No balanced parens found before brace - not a function
189
- scanner.pos = start_pos
190
- return nil
191
- end
192
-
193
- # The last candidate (outermost closing paren) should be the function parameter list
194
- signature_end_pos = signature_candidates.last
195
-
196
- # Extract and clean the signature
197
- signature = scanner.string[start_pos...signature_end_pos]
198
- return clean_signature(signature)
199
- end
230
+ return _definition_end( scanner, start_pos, type, signature_candidates )
200
231
  when ';'
201
- # Found semicolon - this is a declaration, not a definition
202
-
203
- if type == :declaration
204
- # Before accepting this as a function declaration, verify it has parentheses
205
- # and doesn't look like a variable declaration
206
- unless found_opening_paren
207
- # No parentheses found - this is a variable declaration
208
- scanner.pos = start_pos
209
- return nil
210
- end
211
-
212
- scanner.getch
213
- signature = scanner.string[start_pos...scanner.pos]
214
-
215
- # Validate this looks like a function declaration, not a variable
216
- # Function declarations should have: type name(...) ;
217
- # NOT: type (*name)(...) ; (function pointer variable)
218
- # NOT: type name[...] ; (array variable)
219
- # NOT: type name = ... ; (variable with initializer)
220
- cleaned = clean_declaration(signature)
221
-
222
- # Check if this looks like a function declaration
223
- # Pattern: ends with identifier followed by (...) and semicolon
224
- # NOT: contains (*identifier) pattern (function pointer variable)
225
- if cleaned.match?(/\(\s*\*\s*[a-zA-Z_][a-zA-Z0-9_]*\s*\)/)
226
- # This is a function pointer variable, not a function declaration
227
- scanner.pos = start_pos
228
- return nil
229
- end
230
-
231
- # Additional check: ensure the pattern is identifier(...); not identifier[...]; or identifier;
232
- # Strip compiler extensions (e.g. trailing __attribute__((...)) or __declspec(...)) before
233
- # checking the closing paren — otherwise a trailing attribute's ')' fools the check into
234
- # accepting a variable declaration like `int x __attribute__((aligned(16)));` as a function.
235
- content_before_semicolon = @code_text.strip_compiler_extensions(cleaned.gsub(/\s*;$/, ''))
236
- unless content_before_semicolon.end_with?(')')
237
- # Doesn't end with closing paren - likely a variable declaration
238
- scanner.pos = start_pos
239
- return nil
240
- end
241
-
242
- return cleaned
243
- else # :definition
244
- scanner.pos = start_pos
245
- return nil
246
- end
232
+ return _declaration_end( scanner, start_pos, type, found_opening_paren )
247
233
  when '['
234
+ # A C23 attribute passes whole, so its brackets and literals don't count
235
+ next @code_text.collect_balanced(scanner, '[', ']') if @code_text.c23_attribute_at?(scanner)
236
+
248
237
  # Found opening bracket - this could be an array declaration
249
238
  # If we haven't found any opening parenthesis yet, this is likely a variable
250
239
  unless found_opening_paren
@@ -270,6 +259,65 @@ class CExtractorFunctions
270
259
  return nil
271
260
  end
272
261
 
262
+ # The signature a '{' ends, or nil. Only a definition has one. Its parameter list is the last
263
+ # group to close ahead of the brace, and with no group there the text is no function's.
264
+ def _definition_end(scanner, start_pos, type, candidates)
265
+ return _rewind( scanner, start_pos ) unless type == :definition and candidates.any?
266
+
267
+ return clean_signature( scanner.string.byteslice( start_pos, candidates.last - start_pos ) )
268
+ end
269
+
270
+ # The signature a ';' ends, or nil. Only a declaration has one, and only when it declares a
271
+ # function (see _prototype?). On success the scanner passes the ';'.
272
+ def _declaration_end(scanner, start_pos, type, found_opening_paren)
273
+ cleaned = clean_declaration( scanner.string.byteslice( start_pos, scanner.pos + 1 - start_pos ) ) if type == :declaration and found_opening_paren
274
+ return _rewind( scanner, start_pos ) unless cleaned and _prototype?( cleaned )
275
+
276
+ scanner.pos += 1
277
+ return cleaned
278
+ end
279
+
280
+ # Whether a declaration with a parenthesis declares a function rather than a variable. A name
281
+ # inside a pointer group declares a function only when a parameter list follows it. Otherwise the
282
+ # declaration is an object's, such as a pointer to a function or an array. Any other
283
+ # function's declaration ends with its parameter list. Extensions may follow that list and are
284
+ # passed over, so `int x __attribute__((aligned(16)));` stays a variable. Attributes may sit
285
+ # among a group's stars too. An asm label changes the rule (see _labeled_prototype?).
286
+ def _prototype?(cleaned)
287
+ unlabeled = CExtractorDeclarator::AsmLabel.without( cleaned )
288
+ stripped = @code_text.strip_compiler_extensions( unlabeled ).sub( /\s*;\z/, '' )
289
+ grouped = CExtractorDeclarator.parenthesized( stripped )
290
+ return grouped.follows == '(' if grouped
291
+
292
+ return (unlabeled == cleaned) ? stripped.end_with?( ')' ) : _labeled_prototype?( stripped )
293
+ end
294
+
295
+ # Whether a declaration with an asm label, read without it, declares a function. Unexpanded
296
+ # macros may sit around the label, as in `int f(void) MY_API asm("f");`, so the text need not
297
+ # end with the list. A function's text holds a group outside brackets that opens like a
298
+ # parameter list. A macro's argument such as `(4)` or `(".data")` can't, so
299
+ # `int MY_ALIGN(4) g asm("g");` stays a variable. A specifier's argument may, and is passed
300
+ # over, as in `typeof(int) g asm("g");`. A macro's word argument reads as a parameter list,
301
+ # since the two can't be told apart unexpanded.
302
+ def _labeled_prototype?(text)
303
+ scanner = StringScanner.new( text )
304
+ depth = 0
305
+ while scanner.skip_until( CExtractorDeclarator::BALANCE_TOKEN )
306
+ token = scanner.matched
307
+ return true if token == '(' and depth.zero? and scanner.match?( PARAMETERS_AHEAD ) and !CExtractorDeclarator._specifier_argument?( text, scanner.pos - 1 )
308
+
309
+ depth += CExtractorDeclarator::DEPTH_CHANGE.fetch( token, 0 )
310
+ end
311
+
312
+ return false
313
+ end
314
+
315
+ # Returns the scanner to where a signature's scan started, and gives nil
316
+ def _rewind(scanner, start_pos)
317
+ scanner.pos = start_pos
318
+ return nil
319
+ end
320
+
273
321
  def clean_signature(signature)
274
322
  # Remove C-style line comments (in multiline signatures)
275
323
  _signature = signature.gsub(/\/\/.*$/, '')
@@ -291,102 +339,83 @@ class CExtractorFunctions
291
339
  return _declaration
292
340
  end
293
341
 
294
- # Extracts decorator keywords from a C function signature and returns the shortened signature
295
- # Migrated from PartializerParser#parse_signature_decorators
342
+ # Splits a function signature into its decorators and the signature without them.
343
+ # Decorators are the storage-class and inline keywords of FUNCTION_DECORATOR_KEYWORDS.
344
+ # Every other word before the name keeps its place and order. That includes the return type's
345
+ # qualifiers, type keywords and typedef names, and also `_Noreturn`, attributes, calling
346
+ # conventions and unexpanded macros. Reconciling with the fully expanded copy resolves a
347
+ # macro that hides a storage class.
296
348
  #
297
349
  # Parameters:
298
350
  # signature: Complete function signature string
299
351
  # name: Function name string (used to split the signature)
300
352
  #
301
353
  # Returns: [decorators_array, shortened_signature_string]
302
- # Example: "static inline int foo(void)" with name "foo"
303
- # => [["static", "inline"], "int foo(void)"]
354
+ # Example: "static const char *foo(void)" with name "foo"
355
+ # => [["static"], "const char *foo(void)"]
304
356
  def parse_decorators_and_strip(signature, name)
305
357
  return [[], signature] if name.nil?
306
358
 
307
- # Find the function name in the signature
308
- name_index = signature.index(name)
309
- return [[], signature] if name_index.nil?
310
-
311
- # Extract everything before the function name
312
- prefix = signature[0...name_index]
359
+ cut = self.class.name_position( signature, name )
360
+ return [[], signature] if cut.nil?
313
361
 
314
- # Extract everything from the function name onwards
315
- remainder = signature[name_index..-1]
362
+ prefix = signature[0...cut]
363
+ remainder = signature[cut..]
316
364
 
317
- # Split prefix by whitespace to get tokens
318
- tokens = prefix.split(/\s+/).reject(&:empty?)
319
-
320
- return [[], signature] if tokens.empty?
365
+ decorators = prefix.split( /\s+/ ).select { |token| FUNCTION_DECORATOR_KEYWORDS.include?( token ) }
366
+ return [[], signature] if decorators.empty?
321
367
 
322
- # Find where decorators end and return type begins
323
- decorator_end_index = 0
324
- tokens.each_with_index do |token, idx|
325
- if TYPE_KEYWORDS.include?(token) ||
326
- !PRIVATE_KEYWORDS.any? { |kw| token == kw.downcase } &&
327
- !MODIFIER_KEYWORDS.include?(token)
328
- decorator_end_index = idx
329
- break
330
- end
331
- end
368
+ return decorators, "#{self.class.remove_tokens( prefix, decorators ).lstrip}#{remainder}"
369
+ end
332
370
 
333
- # If all tokens are decorators (shouldn't happen in valid C), treat last as return type
334
- decorator_end_index = tokens.length - 1 if decorator_end_index == 0 && tokens.length > 1
371
+ def extract_function_name(signature)
372
+ # If parentheses aren't balanced, return nil
373
+ return nil unless parens_balanced?( signature )
335
374
 
336
- decorators = tokens[0...decorator_end_index]
337
- return_type_tokens = tokens[decorator_end_index..-1]
375
+ # Strategy: Find the main parameter list by looking for the pattern:
376
+ # identifier followed by '(' that represents the function's parameter list
338
377
 
339
- return [[], signature] if decorators.empty?
378
+ cleaned = @code_text.strip_compiler_extensions(signature.dup)
340
379
 
341
- # Find where the first return type token appears in the prefix
342
- first_return_type_token = return_type_tokens.first
343
- return_type_start_index = prefix.index(first_return_type_token)
380
+ # A function returning a function pointer, as in int (*name(params))(params), names itself
381
+ # inside the declarator's parentheses
382
+ grouped = CExtractorDeclarator.parenthesized( cleaned )
383
+ return grouped.name if grouped and grouped.follows == '('
384
+
385
+ # The name is the first identifier followed by '(', after whitespace or a '*' for a pointer
386
+ # return. A specifier, as in `typeof(int) f(void)`, takes parentheses too and names nothing.
387
+ # Its argument is emptied first, since a call inside one, as in `typeof(g(1))`, names
388
+ # another function.
389
+ words = _without_specifier_arguments( cleaned ).scan( CALLED_IDENTIFIER ).flatten
390
+ return words.find { |word| !SPECIFIERS_WITH_ARGUMENTS.include?( word ) }
391
+ end
344
392
 
345
- # Everything from first return type token onwards is the return type portion
346
- return_type_portion = prefix[return_type_start_index..-1]
393
+ # The text with each specifier's argument emptied, so `typeof(g(1)) f(void)` reads
394
+ # `typeof() f(void)`
395
+ def _without_specifier_arguments(text)
396
+ scanner = StringScanner.new( text )
397
+ emptied = +''
398
+ while (before = scanner.scan_until( SPECIFIER_CALL ))
399
+ emptied << before
400
+ break unless CExtractorDeclarator._skip_balanced( scanner )
347
401
 
348
- # Build shortened signature: return_type_portion + remainder
349
- shortened_signature = "#{return_type_portion}#{remainder}"
402
+ emptied << '()'
403
+ end
350
404
 
351
- return decorators, shortened_signature
405
+ return emptied << scanner.rest
352
406
  end
353
407
 
354
- def extract_function_name(signature)
355
- # Paren depth for balance validation only, no text collection — not suitable for collect_balanced()
356
- paren_depth = 0
357
- signature.each_char do |char|
358
- case char
359
- when '('
360
- paren_depth += 1
361
- when ')'
362
- paren_depth -= 1
363
- return nil if paren_depth < 0 # Unbalanced - closing before opening
364
- end
408
+ # True when every ')' closes an earlier '(' and none stays open. It only counts, so it needs
409
+ # nothing collect_balanced() does.
410
+ def parens_balanced?(text)
411
+ depth = 0
412
+ text.each_char do |char|
413
+ depth += 1 if char == '('
414
+ depth -= 1 if char == ')'
415
+ return false if depth < 0
365
416
  end
366
-
367
- # If parentheses aren't balanced, return nil
368
- return nil unless paren_depth == 0
369
-
370
- # Strategy: Find the main parameter list by looking for the pattern:
371
- # identifier followed by '(' that represents the function's parameter list
372
-
373
- # First, handle function pointer return types: int (*name(params))(params)
374
- # Pattern: (*identifier(...))
375
- if signature =~ /\(\s*\*\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*\(/
376
- return $1
377
- end
378
-
379
- cleaned = @code_text.strip_compiler_extensions(signature.dup)
380
-
381
- # Now find the function name in the cleaned signature
382
- # Look for: identifier followed by '('
383
- # The identifier should be preceded by whitespace or * (for pointer returns)
384
- if cleaned =~ /(?:^|[\s*])([a-zA-Z_][a-zA-Z0-9_]*)\s*\(/
385
- return $1
386
- end
387
-
388
- # Fallback: no valid function name found
389
- nil
417
+
418
+ return depth.zero?
390
419
  end
391
-
420
+
392
421
  end
@@ -5,6 +5,7 @@
5
5
  # SPDX-License-Identifier: MIT
6
6
  # =========================================================================
7
7
 
8
+ require 'ceedling/c_extractor/c_extractor_constants'
8
9
  require 'ceedling/c_extractor/c_extractor_types'
9
10
 
10
11
  class CExtractorPreprocessing
@@ -14,79 +15,69 @@ class CExtractorPreprocessing
14
15
 
15
16
  constructor :c_extractor_code_text
16
17
 
17
- # Compiler-extension attribute forms (CExtractorCodeText#strip_compiler_extensions'
18
- # own `__word__(...)`/`__declspec(...)` shapes) are indistinguishable from a bare
19
- # invocation by identifier-plus-parens shape alone -- e.g. `__declspec(dllexport)
20
- # void foo(int x) {...}` -- but they're a function signature's own leading
21
- # decoration, always followed by more of that same signature, never a construct in
22
- # their own right. Excluded in try_extract_bare_macro_invocation below so that method
23
- # never steals them out from under the signature-scanning extractors it exists to run
24
- # ahead of.
18
+ # A compiler extension's attribute form, as in `__declspec(dllexport) void foo(int x) {...}`
25
19
  COMPILER_EXTENSION_IDENTIFIER = /\A(?:__\w+__|__declspec)\z/
26
20
 
21
+ # What can follow IDENTIFIER(balanced-args) in real code but never a bare invocation. A ';'
22
+ # ends a call statement and a '{' opens a function body. A declarator in parentheses, as in
23
+ # `int (*hook)(int) = 0;`, goes on with a parameter list, an array suffix, an initializer or
24
+ # another declarator.
25
+ NOT_AFTER_INVOCATION = [';', '{', '(', '[', '=', ','].freeze
26
+
27
27
  # A bare, top-level, semicolon-less macro invocation (an x-macro call expanding to a
28
- # full function definition once the macro itself is applied) has no leading '#', no
29
- # trailing ';', and no trailing '{' -- real compilable C at file/statement scope
30
- # never has IDENTIFIER(balanced-args) followed by anything else, so this shape only
31
- # exists pre-macro-expansion. A trailing ';' (an ordinary call-as-statement) or '{'
32
- # (a real function definition) are both explicitly NOT this shape and are left for
33
- # the extractors that already handle those correctly.
28
+ # full function definition once the macro itself is applied) has no leading '#' and is
29
+ # followed by nothing NOT_AFTER_INVOCATION names. Compilable C at file scope nearly always
30
+ # follows IDENTIFIER(balanced-args) with one of those, so this shape mostly exists before
31
+ # macro expansion. Each of those shapes is left for the extractor that handles it.
34
32
  #
35
- # One accepted, pre-existing limitation, not introduced here: a K&R-style old-style
36
- # function definition (`foo(a,b)\nint a; int b;\n{...}`) also matches this shape and
37
- # would be misclassified -- but it already falls through to the same broken
38
- # catch-all this method exists to intercept, so this swaps one already-wrong output
39
- # for a different one, for a construct essentially extinct in Ceedling's actual
40
- # (modern embedded C) audience. Not worth the real declaration-grammar knowledge
41
- # this hand-rolled scanner doesn't have.
33
+ # An old K&R-style function definition (`foo(a,b)\nint a; int b;\n{...}`) fits this shape
34
+ # and is misread. The extractors after this one misread K&R too, and the style is
35
+ # essentially extinct in modern embedded C, so it isn't worth real declaration grammar here.
42
36
  #
43
37
  # @param scanner [StringScanner] positioned at a potential macro invocation
44
38
  # @return [Array(Boolean, CExtractorTypes::CStatement|nil)]
45
39
  def try_extract_bare_macro_invocation(scanner)
46
40
  start_pos = scanner.pos
47
-
48
- return [false, nil] unless scanner.scan(/[A-Za-z_]\w*/)
49
- if scanner.matched.match?(COMPILER_EXTENSION_IDENTIFIER)
41
+ finish = _invocation_end(scanner)
42
+ if finish.nil?
50
43
  scanner.pos = start_pos
51
44
  return [false, nil]
52
45
  end
53
46
 
54
- @c_extractor_code_text.skip_deadspace(scanner)
55
- unless scanner.peek(1) == '('
56
- scanner.pos = start_pos
57
- return [false, nil]
58
- end
47
+ scanner.pos = finish
48
+ return [true, CExtractorTypes::CStatement.new(text: scanner.string.byteslice(start_pos, finish - start_pos))]
49
+ end
59
50
 
60
- success, _args = @c_extractor_code_text.collect_balanced(scanner, '(', ')')
61
- unless success
62
- scanner.pos = start_pos
63
- return [false, nil]
64
- end
51
+ # Where a bare invocation at the scanner ends, or nil when there is none. Only the
52
+ # invocation belongs to its text, so the scanner peeks past the deadspace after it.
53
+ #
54
+ # The end of the buffer right after the invocation is ambiguous. It may mean only that this
55
+ # chunk ran out, so the method fails and extract_next_feature grows the buffer and retries,
56
+ # as collect_balanced does. A file that truly ends there is handled like any other trailing
57
+ # content, by CExtractor#extract_contents' final break.
58
+ def _invocation_end(scanner)
59
+ word = scanner.scan(CExtractorConstants::IDENTIFIER)
60
+ return nil if word.nil? or _leads_declaration?(word)
65
61
 
66
- # Peek past trailing deadspace without consuming it as part of this element --
67
- # only the invocation itself belongs to this element's own text span.
68
- after_invocation = scanner.pos
69
62
  @c_extractor_code_text.skip_deadspace(scanner)
70
- # A mid-buffer eos? here is ambiguous -- it may only mean this chunk ran out, not
71
- # that the real file has ended. Fail (not succeed) so extract_next_feature's own
72
- # buffer-growth-and-retry sees more input before this method decides, exactly like
73
- # collect_balanced/try_extract_static_assert already do at their own boundaries. A
74
- # genuine, whole-file EOF right after the invocation is legitimate and handled the
75
- # same way every other feature type's own unterminated-trailing-content case is
76
- # (see CExtractor#extract_contents' final break) -- no special-casing needed here.
77
- if scanner.eos?
78
- scanner.pos = start_pos
79
- return [false, nil]
80
- end
81
- next_char = scanner.peek(1)
82
- scanner.pos = after_invocation
63
+ return nil unless scanner.peek(1) == '(' and @c_extractor_code_text.collect_balanced(scanner, '(', ')').first
83
64
 
84
- if next_char == ';' || next_char == '{'
85
- scanner.pos = start_pos
86
- return [false, nil]
87
- end
65
+ finish = scanner.pos
66
+ @c_extractor_code_text.skip_deadspace(scanner)
67
+ return (_undecided?(scanner) or NOT_AFTER_INVOCATION.include?(scanner.peek(1))) ? nil : finish
68
+ end
69
+
70
+ # Whether the buffer ends before what follows an invocation can be read. A lone '/' there may
71
+ # open a comment the next chunk holds.
72
+ def _undecided?(scanner)
73
+ return (scanner.eos? or (scanner.rest_size == 1 and scanner.peek(1) == '/'))
74
+ end
88
75
 
89
- [true, CExtractorTypes::CStatement.new(text: scanner.string[start_pos...scanner.pos])]
76
+ # Whether a word with an invocation's shape leads a declaration instead. An attribute form
77
+ # leads more of a signature, and a specifier, as in `typeof(int) x;`, leads a declarator. Both
78
+ # are left for the extractors this one runs ahead of.
79
+ def _leads_declaration?(word)
80
+ return (word.match?(COMPILER_EXTENSION_IDENTIFIER) or CExtractorConstants::SPECIFIERS_WITH_ARGUMENTS.include?(word))
90
81
  end
91
82
 
92
83
  # Scan `scanner` for calls to any macro in `macro_names` and return them as a
@@ -0,0 +1,30 @@
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
+ # The statement record CExtractorTypes holds alongside its other records
9
+ module CExtractorTypes
10
+
11
+ # Pairs a raw C statement string with its 1-based source line number.
12
+ # Used for macro_definitions, type_definitions, aggregate_definitions and macro_invocations in
13
+ # CModule. `kind` says which, as :macro, :typedef, :aggregate or :invocation. A CModule gives
14
+ # each statement its list's kind (see STATEMENT_KINDS).
15
+ CStatement = Struct.new(
16
+ :text, # String — raw extracted statement text (comments replaced with spaces)
17
+ :line_num, # Integer — 1-based line number where the statement begins in the source file
18
+ :origin, # :header or :source when the caller knows the file's role, otherwise nil
19
+ :kind, # Symbol — the statement's category, as listed above
20
+ :tag, # The struct, union or enum tag a typedef or aggregate names, or nil
21
+ :type_name, # The name a typedef gives its type. A declaration's own type definition has none
22
+ # until Partials names it (see CVariableDeclaration#defined_type).
23
+ keyword_init: true
24
+ ) do
25
+ def initialize(text: nil, line_num: nil, origin: nil, kind: nil, tag: nil, type_name: nil)
26
+ super
27
+ end
28
+ end unless const_defined?(:CStatement, false)
29
+
30
+ end