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,245 @@
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
+ require 'spec_helper'
9
+ require 'timeout'
10
+ require 'ceedling/c_extractor/c_extractor_declarator'
11
+
12
+ describe CExtractorDeclarator do
13
+
14
+ context ".parenthesized" do
15
+ def read(text)
16
+ reading = described_class.parenthesized( text )
17
+ reading && reading.to_h
18
+ end
19
+
20
+ it "reads a pointer to a function" do
21
+ expect( read( 'int (*s_hook)(int)' ) ).to eq( name: 's_hook', follows: nil, base_type: 'int', declarator: '(*s_hook)(int)' )
22
+ end
23
+
24
+ it "reads an array of pointers to functions" do
25
+ expect( read( 'int (*s_table[2])(int)' ) ).to eq( name: 's_table', follows: '[', base_type: 'int', declarator: '(*s_table[2])(int)' )
26
+ end
27
+
28
+ it "reads a pointer to an array" do
29
+ expect( read( 'int (*g_row)[4]' ) ).to eq( name: 'g_row', follows: nil, base_type: 'int', declarator: '(*g_row)[4]' )
30
+ end
31
+
32
+ # A parameter list right after the name makes the declaration a function's
33
+ it "reads a function returning a pointer to a function" do
34
+ expect( read( 'int (*ticker_get(void))(int)' ) ).to eq( name: 'ticker_get', follows: '(', base_type: 'int', declarator: '(*ticker_get(void))(int)' )
35
+ end
36
+
37
+ it "reads a function taking and returning function pointers" do
38
+ expect( read( 'void (*signal(int sig, void (*func)(int)))(int)' ) ).to include( name: 'signal', follows: '(' )
39
+ end
40
+
41
+ it "reads past qualifiers and further stars" do
42
+ expect( read( 'int (*const k_hook)(int)' ) ).to include( name: 'k_hook', follows: nil )
43
+ expect( read( 'int (** volatile pp)(int)' ) ).to include( name: 'pp', follows: nil )
44
+ end
45
+
46
+ it "reads through a nested group" do
47
+ expect( read( 'char (*(*fpp)(int))(long)' ) ).to include( name: 'fpp', follows: nil, base_type: 'char' )
48
+ expect( read( 'char (* const (*fpp)(int))(long)' ) ).to include( name: 'fpp', follows: nil, base_type: 'char' )
49
+ end
50
+
51
+ # A compiler may add its own qualifiers, and the name is the last word ahead of what ends it
52
+ it "reads past a qualifier a compiler adds" do
53
+ expect( read( 'int (* _Nullable np)(int)' ) ).to include( name: 'np', follows: nil )
54
+ expect( read( 'void (* __far fp)(void)' ) ).to include( name: 'fp', follows: nil )
55
+ expect( read( 'void (* _Nullable sigset(int, void (* _Nullable)(int)))(int)' ) ).to include( name: 'sigset', follows: '(' )
56
+ end
57
+
58
+ # A name in a declarator ends at the group's ')', a parameter list or an array size
59
+ it "finds nothing in a macro's arguments that open with a pointer" do
60
+ expect( read( 'DECLARE_THING(*p, b)' ) ).to be_nil
61
+ end
62
+
63
+ it "reads past a calling convention" do
64
+ expect( read( 'void (__cdecl *on_tick)(int)' ) ).to include( name: 'on_tick', follows: nil, base_type: 'void' )
65
+ expect( read( 'void (__stdcall*on_tock)(int)' ) ).to include( name: 'on_tock', follows: nil )
66
+ end
67
+
68
+ it "reads through redundant parentheses" do
69
+ expect( read( 'int ((*p))(int)' ) ).to include( name: 'p', follows: nil, base_type: 'int' )
70
+ expect( read( 'int (*(rp))(int)' ) ).to include( name: 'rp', follows: nil )
71
+ expect( read( 'char (*(x))[4]' ) ).to include( name: 'x', follows: nil )
72
+ expect( read( 'int (* const (rp))(int)' ) ).to include( name: 'rp', follows: nil )
73
+ expect( read( 'int (*(get_cb(void)))(int)' ) ).to include( name: 'get_cb', follows: '(' )
74
+ end
75
+
76
+ # The name's own parentheses close before what follows it decides the kind
77
+ it "reads past the parentheses around a name to what follows them" do
78
+ expect( read( 'int (*(get_a)(void))(int)' ) ).to include( name: 'get_a', follows: '(' )
79
+ expect( read( 'int (*(fy)(int))[3]' ) ).to include( name: 'fy', follows: '(' )
80
+ expect( read( 'int (*(arr)[3])(int)' ) ).to include( name: 'arr', follows: '[' )
81
+ expect( read( 'FOO(* const (a), b)' ) ).to be_nil
82
+ end
83
+
84
+ # A type specifier's argument may hold a pointer, but that names no declarator
85
+ it "passes over the group of a type specifier that takes parentheses" do
86
+ expect( read( 'typeof(*g_pp) g_q' ) ).to be_nil
87
+ expect( read( '__typeof__(*g_pp) g_q' ) ).to be_nil
88
+ expect( read( '_Atomic(int *) g_a' ) ).to be_nil
89
+ expect( read( 'typeof(*p) (*g_fp)(int)' ) ).to include( name: 'g_fp', base_type: 'typeof(*p)' )
90
+ end
91
+
92
+ # GCC accepts '$' in an identifier, and fallback preprocessing leaves comments in place
93
+ it "reads a name holding '$' or followed by a comment" do
94
+ expect( read( 'int (*count$all)(int)' ) ).to include( name: 'count$all', follows: nil )
95
+ expect( read( 'int (*s_hook /* callback */)(int)' ) ).to include( name: 's_hook', follows: nil )
96
+ end
97
+
98
+ # An extern repeats the declarator. An attribute or macro after its last suffix could draw a
99
+ # warning there, and an asm label is read apart.
100
+ it "leaves out what follows a declarator's last suffix" do
101
+ expect( read( 'void (* const vec[])(void) __attribute__ ((used))' ) ).to include( declarator: '(* const vec[])(void)' )
102
+ expect( read( 'int (*g)(int) __attribute((used))' ) ).to include( declarator: '(*g)(int)' )
103
+ expect( read( 'int (*g)(int) MY_USED' ) ).to include( declarator: '(*g)(int)' )
104
+ expect( read( 'int (*g)(int) MY__attribute__(4)' ) ).to include( declarator: '(*g)(int)' )
105
+ expect( read( 'int (*g)(int) /* 1) */' ) ).to include( declarator: '(*g)(int)' )
106
+ expect( read( 'int (*fp)(int) __asm__("fp_label")' ) ).to include( declarator: '(*fp)(int)' )
107
+ expect( read( 'int (*g)(int) __attribute__((used)) MY_SECTION __asm__("sym")' ) ).to include( declarator: '(*g)(int)' )
108
+ end
109
+
110
+ # A macro may sit ahead of an array size, but a word ahead of a '(' is a macro call
111
+ it "keeps every suffix, with what sits between them" do
112
+ expect( read( 'int (*g_cb) /* cb */ (int)' ) ).to include( declarator: '(*g_cb) /* cb */ (int)' )
113
+ expect( read( 'int (*p) PACKED [2]' ) ).to include( declarator: '(*p) PACKED [2]' )
114
+ expect( read( 'int (*p)[4] ALIGN(4)' ) ).to include( declarator: '(*p)[4]' )
115
+ expect( read( 'void (*fp)(int __attribute__((unused)) n)' ) ).to include( declarator: '(*fp)(int __attribute__((unused)) n)' )
116
+ end
117
+
118
+ # A bracket in a string or a comment doesn't count toward a group's balance
119
+ it "passes over brackets in strings and comments" do
120
+ expect( read( 'char (*p)[sizeof ")"]' ) ).to include( name: 'p', declarator: '(*p)[sizeof ")"]' )
121
+ expect( read( 'int (*g /* ) */)(int)' ) ).to include( name: 'g', declarator: '(*g /* ) */)(int)' )
122
+ expect( read( 'int (*g)(int /* ) */)' ) ).to include( name: 'g', declarator: '(*g)(int /* ) */)' )
123
+ end
124
+
125
+ # Pathological nesting must still read in one pass
126
+ it "reads deeply nested parentheses in linear time" do
127
+ text = 'int ' + ('( ' * 20_000) + '*x' + (' )' * 20_000) + '(int)'
128
+
129
+ result = nil
130
+ Timeout.timeout( 2 ) { result = read( text ) }
131
+
132
+ expect( result ).to include( name: 'x', follows: nil )
133
+ end
134
+
135
+ # A struct's body may declare function-pointer members, which belong to the struct
136
+ it "passes over a struct body to the declarator after it" do
137
+ expect( read( 'struct ops { int (*open)(void); } s_ops' ) ).to be_nil
138
+ expect( read( 'struct ops { int (*open)(void); } (*make_ops)(void)' ) ).to include( name: 'make_ops' )
139
+ end
140
+
141
+ it "keeps pointer stars ahead of the group in the base type" do
142
+ expect( read( 'char *(*name_of)(int)' ) ).to include( name: 'name_of', base_type: 'char *' )
143
+ end
144
+
145
+ it "drops a trailing semicolon" do
146
+ expect( read( 'int (*s_hook)(int);' ) ).to include( declarator: '(*s_hook)(int)' )
147
+ end
148
+
149
+ # A group that doesn't open with a pointer is a parameter list or a macro's arguments
150
+ it "skips a group that doesn't open with a pointer to find the declarator after it" do
151
+ expect( read( '__ALIGNED(8) int (*s_hook)(int)' ) ).to include( name: 's_hook', base_type: '__ALIGNED(8) int' )
152
+ end
153
+
154
+ it "finds nothing in a plain declaration" do
155
+ expect( read( 'int x' ) ).to be_nil
156
+ expect( read( 'uint8_t buf[16]' ) ).to be_nil
157
+ expect( read( '__ALIGNED(8) uint32_t x' ) ).to be_nil
158
+ end
159
+
160
+ # The parameter list is the function's own, and a pointer inside it declares a parameter
161
+ it "finds nothing in a function declaring a function-pointer parameter" do
162
+ expect( read( 'void ticker_register(int (*cb)(int))' ) ).to be_nil
163
+ end
164
+
165
+ it "finds no name in a group holding none" do
166
+ expect( read( 'int (*)(int)' ) ).to include( name: nil )
167
+ end
168
+ end
169
+
170
+ context ".without_initializer" do
171
+ it "cuts a declaration at its initializer" do
172
+ expect( described_class.without_initializer( 'int (*g_hook)(int) = 0;' ) ).to eq( 'int (*g_hook)(int)' )
173
+ end
174
+
175
+ it "leaves a declaration without an initializer whole, less its semicolon" do
176
+ expect( described_class.without_initializer( 'int (*g_row)[4];' ) ).to eq( 'int (*g_row)[4]' )
177
+ end
178
+
179
+ # An array size may compare, and only a top-level '=' starts an initializer
180
+ it "ignores an equals sign inside brackets or parentheses" do
181
+ expect( described_class.without_initializer( 'int a[sizeof(int) == 4 ? 1 : 2] = { 0 };' ) ).to eq( 'int a[sizeof(int) == 4 ? 1 : 2]' )
182
+ end
183
+
184
+ # A bracket in a comment or literal doesn't count, so the initializer is still found
185
+ it "finds the initializer past brackets in comments and literals" do
186
+ expect( described_class.without_initializer( 'int (*g)(int) /* 1) */ = f;' ) ).to eq( 'int (*g)(int) /* 1) */' )
187
+ expect( described_class.without_initializer( "char (*g_z)[sizeof(')')] = 0;" ) ).to eq( "char (*g_z)[sizeof(')')]" )
188
+ end
189
+
190
+ # A large lookup table is common, and only its declarator need be read
191
+ it "stops at the initializer of a large table" do
192
+ text = 'static const uint8_t table[] = { ' + ('0x5A, ' * 200_000) + '0 };'
193
+
194
+ result = nil
195
+ Timeout.timeout( 2 ) { result = described_class.without_initializer( text ) }
196
+
197
+ expect( result ).to eq( 'static const uint8_t table[]' )
198
+ end
199
+ end
200
+
201
+ context "AsmLabel.of" do
202
+ it "reads each spelling of a label" do
203
+ expect( described_class::AsmLabel.of( 'int g asm("g_sym");' ) ).to eq( 'asm("g_sym")' )
204
+ expect( described_class::AsmLabel.of( 'int g __asm ("g_sym");' ) ).to eq( '__asm ("g_sym")' )
205
+ expect( described_class::AsmLabel.of( 'int g __asm__("g_sym") = 1;' ) ).to eq( '__asm__("g_sym")' )
206
+ end
207
+
208
+ # GCC's grammar puts the label after the declarator and ahead of attributes and the initializer
209
+ it "reads a label after an array size, a group or an attribute" do
210
+ expect( described_class::AsmLabel.of( 'int g[2] asm("arr_sym") = { 1, 2 };' ) ).to eq( 'asm("arr_sym")' )
211
+ expect( described_class::AsmLabel.of( 'int (*fp)(int) __asm__("fp_sym");' ) ).to eq( '__asm__("fp_sym")' )
212
+ expect( described_class::AsmLabel.of( 'int g __attribute__((used)) asm("g_sym");' ) ).to eq( 'asm("g_sym")' )
213
+ expect( described_class::AsmLabel.of( 'int f(void) asm("f_sym")' ) ).to eq( 'asm("f_sym")' )
214
+ end
215
+
216
+ # Fallback preprocessing leaves comments in place
217
+ it "reads a label whose string follows a comment" do
218
+ expect( described_class::AsmLabel.of( 'int g asm /* sym */ ("g_sym");' ) ).to eq( 'asm /* sym */ ("g_sym")' )
219
+ end
220
+
221
+ it "finds no label in a longer word, in brackets, in a literal or past the initializer" do
222
+ expect( described_class::AsmLabel.of( 'int asm_count;' ) ).to be_nil
223
+ expect( described_class::AsmLabel.of( 'int x$asm MY__asm("x");' ) ).to be_nil
224
+ expect( described_class::AsmLabel.of( 'int 0asm("x");' ) ).to be_nil
225
+ expect( described_class::AsmLabel.of( 'int (*fp)(int asm(x));' ) ).to be_nil
226
+ expect( described_class::AsmLabel.of( 'char *g = "asm(\"x\")";' ) ).to be_nil
227
+ expect( described_class::AsmLabel.of( 'int g = WRAP(asm("x"));' ) ).to be_nil
228
+ end
229
+ end
230
+
231
+ context "AsmLabel.without" do
232
+ it "removes the label with the space ahead of it" do
233
+ expect( described_class::AsmLabel.without( 'int g asm("g_sym");' ) ).to eq( 'int g;' )
234
+ expect( described_class::AsmLabel.without( 'int g __asm__("g_sym") = 1;' ) ).to eq( 'int g = 1;' )
235
+ expect( described_class::AsmLabel.without( 'int g[2] __asm("arr_sym") __attribute__((used));' ) ).to eq( 'int g[2] __attribute__((used));' )
236
+ expect( described_class::AsmLabel.without( 'int f(void) asm("f_sym")' ) ).to eq( 'int f(void)' )
237
+ expect( described_class::AsmLabel.without( 'int g asm("g_sym"), *h __asm("h_sym");' ) ).to eq( 'int g, *h;' )
238
+ end
239
+
240
+ it "leaves a declaration without a label whole" do
241
+ expect( described_class::AsmLabel.without( 'int asm_count = 1;' ) ).to eq( 'int asm_count = 1;' )
242
+ end
243
+ end
244
+
245
+ end
@@ -0,0 +1,45 @@
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 head rules a declaration rarely reaches through extraction. Extraction composition, in
9
+ # spec/integration/c_extractor_composition_spec.rb, covers the shapes real modules write.
10
+
11
+ require 'spec_helper'
12
+ require 'ceedling/c_extractor/c_extractor_defined_type'
13
+
14
+ describe CExtractorDefinedType do
15
+ describe '.split' do
16
+ it 'splits a declaration at the type it defines' do
17
+ split = CExtractorDefinedType.split( 'static struct s { int a; } x, y;', 7 )
18
+
19
+ expect( split.to_h ).to eq( type: 'struct s { int a; }', tag: 's', declarators: 'static x, y;' )
20
+ end
21
+
22
+ # A macro spelling the tag may expand to anything
23
+ it 'names no tag when a group follows the tag' do
24
+ expect( CExtractorDefinedType.split( 'struct TAG_OF(x) { int a; } q;', 0 ).tag ).to be_nil
25
+ end
26
+
27
+ it 'reads a tag past an attribute in the head' do
28
+ expect( CExtractorDefinedType.split( 'struct __attribute__((packed)) pk { char c; } q;', 0 ).tag ).to eq 'pk'
29
+ end
30
+
31
+ it 'defines no type for a declaration naming one' do
32
+ expect( CExtractorDefinedType.split( 'struct s *p = 0;', 0 ) ).to be_nil
33
+ end
34
+
35
+ it 'defines no type when the keyword is not where the type would start' do
36
+ expect( CExtractorDefinedType.split( 'int x = { 1 };', 0 ) ).to be_nil
37
+ end
38
+ end
39
+
40
+ describe '.names' do
41
+ it 'gives no name to a typedef declaring several' do
42
+ expect( CExtractorDefinedType.names( 'typedef struct { int a; } A, *PA;' ) ).to eq( tag: nil, type_name: nil )
43
+ end
44
+ end
45
+ end
@@ -28,6 +28,14 @@ describe CExtractorDefinitions do
28
28
 
29
29
  # --- Failure cases ---
30
30
 
31
+ # GCC and Clang accept '$' in an identifier, so a longer name only starts like the keyword
32
+ it "returns [false, nil] for a name that only starts with typedef or struct" do
33
+ result, pos = try_typedef('typedef$init(a);')
34
+ expect(result).to eq [false, nil]
35
+ expect(pos).to eq 0
36
+ expect(@definitions.try_extract_aggregate_definition(StringScanner.new('struct$x(a) { 1; };'))).to eq [false, nil]
37
+ end
38
+
31
39
  it "returns [false, nil] when scanner is not at typedef" do
32
40
  result, pos = try_typedef('int x;')
33
41
  expect(result).to eq [false, nil]
@@ -204,6 +212,13 @@ describe CExtractorDefinitions do
204
212
  expect(pos).to eq "typedef int MyInt;\n".length
205
213
  end
206
214
 
215
+ it "keeps a literal whole after text that isn't ASCII" do
216
+ input = "typedef struct { char d[sizeof(\"é;\")]; } T;"
217
+ scanner = StringScanner.new(input)
218
+ expect(@definitions.try_extract_typedef(scanner)).to eq [true, input]
219
+ expect(scanner.pos).to eq input.bytesize
220
+ end
221
+
207
222
  it "leaves scanner position unchanged on failure" do
208
223
  scanner = StringScanner.new("int x;")
209
224
  scanner.pos = 0
@@ -242,12 +257,18 @@ describe CExtractorDefinitions do
242
257
  expect(scanner.pos).to eq 0
243
258
  end
244
259
 
245
- it "returns [false, nil] for a forward declaration without body (struct Foo;)" do
260
+ # A tag alone declares a struct or union type, so it reads as one rather than as a variable
261
+ it "extracts a forward declaration without body (struct Foo;)" do
246
262
  result, pos = try_aggregate('struct Foo;')
247
- expect(result).to eq [false, nil]
248
- expect(pos).to eq 0
263
+ expect(result).to eq [true, 'struct Foo;']
264
+ expect(pos).to eq 11
249
265
  end
250
266
 
267
+ it "extracts a forward declaration without body (union Word;)" do
268
+ expect( try_aggregate('union Word;')[0] ).to eq [true, 'union Word;']
269
+ end
270
+
271
+ # C has no forward declaration of an enum
251
272
  it "returns [false, nil] for a forward declaration without body (enum Color;)" do
252
273
  result, pos = try_aggregate('enum Color;')
253
274
  expect(result).to eq [false, nil]
@@ -403,6 +424,145 @@ describe CExtractorDefinitions do
403
424
  expect(pos).to eq input.length
404
425
  end
405
426
 
427
+ # --- The head ahead of the body ---
428
+
429
+ # A variable's initializer and a function's body are braced too. The text ahead of the brace
430
+ # tells them from a type's body.
431
+ [
432
+ "struct ops g_ops = { 1 };",
433
+ "union u g_u = { 0 };",
434
+ "struct ops *tbl[] = { &a1, &b1 };",
435
+ "struct ops g_arr[2] = { {1}, {2} };",
436
+ "struct ops g_a = { 1 }, g_b = { 2 };",
437
+ "struct ops *make_ops(void) { return &k; };",
438
+ "struct ops make_v(void) { struct ops o = { 1 }; return o; };",
439
+ "struct ops (*get_ops(void)) { return 0; };",
440
+ "struct ops (__stdcall *get_cb(void)) { return 0; };",
441
+ "struct ops *make_q(const char *s, int n) { return &k; };",
442
+ "struct ops __wrap_make(void) { return o; };",
443
+ "struct ops *__wrap_make2(int a) { return &k; };"
444
+ ].each do |input|
445
+ it "rolls back for a variable or function with a braced body: #{input}" do
446
+ result, pos = try_aggregate(input)
447
+ expect(result).to eq [false, nil]
448
+ expect(pos).to eq 0
449
+ end
450
+ end
451
+
452
+ [
453
+ "struct __attribute__((packed)) pk { char c; int i; };",
454
+ "struct __attribute__((aligned(sizeof(int) == 4 ? 4 : 8))) al { int a; };",
455
+ "struct __attribute__((section(\"a=b)\"))) sec { int a; };",
456
+ "struct __declspec(align(16)) ds { int a; };",
457
+ "struct [[gnu::packed]] c23 { char c; int i; };",
458
+ "struct PACKED pm { char c; };",
459
+ "struct ALIGNED(4) fm { int a; };",
460
+ "struct FOO_TYPE(bar) { int baz; };",
461
+ "struct __attribute__((packed)) FOO_TYPE(bar) { int baz; };",
462
+ "struct PACKED FOO_TYPE(bar) { int baz; };",
463
+ "struct ALIGN(4) FOO_TYPE(bar, 2) { int baz; };",
464
+ "struct ALIGN_T(4) FOO_TYPE(bar, (2)) { int a; };",
465
+ "struct FOO_TYPE(bar, 2 * N) { int a; };",
466
+ "struct FOO_TYPE(\"name\") { int a; };",
467
+ "enum ENUM_ATTR(sizeof(int)) { EA, EB };",
468
+ "enum __attribute((packed)) { HA, HB };",
469
+ "struct __attribute((packed)) gp { char c; int i; };",
470
+ "enum Color ENUM_BASE(unsigned char) { RED };",
471
+ "enum PACKED_ATTR(N*2) { X1 };",
472
+ "struct ALIGNED_T(N * 2) { int a; };",
473
+ "struct STACK_OF(char *) { int a; };",
474
+ "enum ATTR_PACKED() { AP1 };",
475
+ "enum e : typeof(unsigned char) { EA = 1 };",
476
+ "enum mode : unsigned char { M_A = 1, M_B = 2 };",
477
+ "struct __attribute__((packed)) { int a; };"
478
+ ].each do |input|
479
+ it "extracts a type whose head holds attributes, macros or an enum base: #{input}" do
480
+ result, pos = try_aggregate(input)
481
+ expect(result).to eq [true, input]
482
+ expect(pos).to eq input.length
483
+ end
484
+ end
485
+
486
+ # A macro can spell a tag the way these spell a function's name and parameters, so the head
487
+ # reads as a type's. Only the stray ';' after the body makes the function look like one.
488
+ [
489
+ "struct ops make_p(int a, int b) { return o; };",
490
+ "struct ops make_u(VOID) { return o; };"
491
+ ].each do |input|
492
+ it "reads a function with a stray ';' as a type when its head could spell a tag: #{input}" do
493
+ result, _pos = try_aggregate(input)
494
+ expect(result).to eq [true, input]
495
+ end
496
+ end
497
+
498
+ # --- Attributes after the body ---
499
+
500
+ [
501
+ "struct pk2 { char c; int i; } __attribute__((packed));",
502
+ "union pu { char c; int i; } __attribute__((aligned(8)));",
503
+ "enum big { BA, BB } __attribute__((packed)) /* small */ ;",
504
+ "struct two { char c; } __attribute__((packed)) __attribute__((aligned(4)));",
505
+ "struct zp { char c; int i; } __packed;",
506
+ "struct za { char c; } __aligned(8);",
507
+ "struct zg { char c; } __attribute((packed));"
508
+ ].each do |input|
509
+ it "extracts a type with attributes after its body: #{input}" do
510
+ result, pos = try_aggregate(input)
511
+ expect(result).to eq [true, input]
512
+ expect(pos).to eq input.length
513
+ end
514
+ end
515
+
516
+ it "rolls back for a declarator after the body's attributes" do
517
+ result, pos = try_aggregate("struct pk3 { char c; } __attribute__((packed)) g_pk3;")
518
+ expect(result).to eq [false, nil]
519
+ expect(pos).to eq 0
520
+ end
521
+
522
+ # A word C doesn't reserve may name a variable, so it reads as one
523
+ it "rolls back for a plain word after the body, which may be a variable or a macro" do
524
+ result, pos = try_aggregate("struct pm2 { char c; } PACKED;")
525
+ expect(result).to eq [false, nil]
526
+ expect(pos).to eq 0
527
+ end
528
+
529
+ # A file-scope statement of its own can follow a function the head misreads
530
+ [
531
+ "struct ops make_v2(VOID) { return o; }\n__asm__(\".symver make_v2,make_v2@V1\");",
532
+ "struct ops make_v3(VOID) { return o; }\n__FBSDID(\"$FreeBSD$\");"
533
+ ].each do |input|
534
+ it "rolls back rather than take a following statement for an extension: #{input.lines.last}" do
535
+ result, pos = try_aggregate(input)
536
+ expect(result).to eq [false, nil]
537
+ expect(pos).to eq 0
538
+ end
539
+ end
540
+
541
+ # --- Text that isn't ASCII ---
542
+
543
+ it "keeps a literal whole after text that isn't ASCII" do
544
+ input = "struct M { char d[sizeof(\"é;\")]; } __attribute__((packed));"
545
+ result, pos = try_aggregate(input)
546
+ expect(result).to eq [true, input]
547
+ expect(pos).to eq input.bytesize
548
+ end
549
+
550
+ it "passes an extension's arguments after text that isn't ASCII" do
551
+ input = "struct M2 { /* #{'é' * 20} */ int a; } __attribute__((section(\"x\")));"
552
+ result, pos = try_aggregate(input)
553
+ expect(result[0]).to be true
554
+ expect(pos).to eq input.bytesize
555
+ end
556
+
557
+ # --- A buffer that ends early ---
558
+
559
+ # The extractor sees a growing buffer, so text cut short must fail rather than succeed
560
+ it "rolls back when an extension's arguments are cut off" do
561
+ result, pos = try_aggregate("struct cut { char c; } __attribute__((section(\";\"")
562
+ expect(result).to eq [false, nil]
563
+ expect(pos).to eq 0
564
+ end
565
+
406
566
  # --- Boundary behaviour ---
407
567
 
408
568
  it "stops at ';' and does not consume following code" do