ceedling 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (545) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +11 -9
  4. data/Rakefile +2 -1
  5. data/assets/features/ceedling +1 -1
  6. data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
  7. data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
  8. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  9. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  10. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  11. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  12. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  13. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  14. data/bin/actionator.rb +6 -12
  15. data/bin/app_cfg.rb +14 -1
  16. data/bin/ceedling +13 -3
  17. data/bin/cli.rb +25 -6
  18. data/bin/cli_handler.rb +113 -73
  19. data/bin/cli_helper.rb +51 -78
  20. data/bin/installation_selector.rb +81 -0
  21. data/bin/launchinator.rb +69 -0
  22. data/bin/mixin_resolvinator.rb +26 -36
  23. data/bin/objects.yml +13 -0
  24. data/bin/path_validator.rb +25 -29
  25. data/bin/versionator.rb +47 -48
  26. data/ceedling.gemspec +19 -15
  27. data/docs/BreakingChanges.md +86 -1
  28. data/docs/Changelog.md +145 -3
  29. data/docs/KnownIssues.md +179 -6
  30. data/docs/ReleaseNotes.md +13 -0
  31. data/examples/wondrous_forest/README.md +29 -1
  32. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  33. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  34. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  35. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  36. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  37. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  38. data/lib/ceedling/build_log_writer.rb +33 -0
  39. data/lib/ceedling/c_extractor/README.md +15 -7
  40. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  41. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  42. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  43. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  44. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  45. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  46. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  47. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  48. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  49. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  50. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  51. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  52. data/lib/ceedling/c_identifier.rb +21 -0
  53. data/lib/ceedling/ceedling.h +8 -0
  54. data/lib/ceedling/config/build_root_policy.rb +70 -0
  55. data/lib/ceedling/config/configurator.rb +18 -19
  56. data/lib/ceedling/config/configurator_builder.rb +75 -28
  57. data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
  58. data/lib/ceedling/config/configurator_plugins.rb +1 -1
  59. data/lib/ceedling/config/configurator_setup.rb +44 -33
  60. data/lib/ceedling/config/configurator_validator.rb +1 -110
  61. data/lib/ceedling/constants.rb +5 -1
  62. data/lib/ceedling/defaults.rb +35 -5
  63. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  64. data/lib/ceedling/dependencies/README.md +18 -16
  65. data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
  66. data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
  67. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  68. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  69. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  70. data/lib/ceedling/diagnostics/README.md +5 -0
  71. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  72. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  73. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  74. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  75. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  76. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  77. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  78. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  79. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  80. data/lib/ceedling/filename_extension.rb +7 -1
  81. data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
  82. data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
  83. data/lib/ceedling/filesystem/README.md +46 -0
  84. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  85. data/lib/ceedling/filesystem/build_subpath.rb +187 -0
  86. data/lib/ceedling/filesystem/destination_collision.rb +25 -0
  87. data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
  88. data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
  89. data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
  90. data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
  91. data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
  92. data/lib/ceedling/filesystem/file_tree.rb +241 -0
  93. data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
  94. data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
  95. data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
  96. data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
  97. data/lib/ceedling/filesystem/path_spellings.rb +55 -0
  98. data/lib/ceedling/filesystem/project_paths.rb +184 -0
  99. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  100. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  101. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  102. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  103. data/lib/ceedling/filesystem/working_dir.rb +40 -0
  104. data/lib/ceedling/generators/generator.rb +32 -70
  105. data/lib/ceedling/generators/generator_helper.rb +0 -44
  106. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  107. data/lib/ceedling/generators/generator_partials.rb +306 -244
  108. data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
  109. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  110. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  111. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  112. data/lib/ceedling/handoff.rb +121 -0
  113. data/lib/ceedling/includes/header_search.rb +225 -0
  114. data/lib/ceedling/includes/include_factory.rb +9 -12
  115. data/lib/ceedling/includes/include_pathinator.rb +112 -33
  116. data/lib/ceedling/includes/includes.rb +150 -38
  117. data/lib/ceedling/installation.rb +92 -0
  118. data/lib/ceedling/library_resolver.rb +99 -0
  119. data/lib/ceedling/objects.yml +112 -6
  120. data/lib/ceedling/partials/README.md +110 -16
  121. data/lib/ceedling/partials/carry_plan.rb +71 -0
  122. data/lib/ceedling/partials/definition_head.rb +74 -0
  123. data/lib/ceedling/partials/include_groups.rb +37 -0
  124. data/lib/ceedling/partials/interface_extras.rb +25 -0
  125. data/lib/ceedling/partials/partializer.rb +603 -124
  126. data/lib/ceedling/partials/partializer_config.rb +8 -1
  127. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  128. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  129. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  130. data/lib/ceedling/partials/partials.rb +153 -10
  131. data/lib/ceedling/partials/type_macros.rb +126 -0
  132. data/lib/ceedling/plugins/report_log_writer_plugin.rb +3 -5
  133. data/lib/ceedling/preprocess/README.md +43 -33
  134. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  135. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  136. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +32 -76
  137. data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
  138. data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
  139. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  140. data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
  141. data/lib/ceedling/rakefile.rb +15 -1
  142. data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
  143. data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
  144. data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
  145. data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
  146. data/lib/ceedling/reportinator.rb +3 -4
  147. data/lib/ceedling/setupinator.rb +104 -87
  148. data/lib/ceedling/test_context_extractor.rb +5 -1
  149. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  150. data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
  151. data/lib/ceedling/test_invoker/README.md +1 -1
  152. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  153. data/lib/ceedling/test_invoker/mock_locator.rb +175 -10
  154. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  155. data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
  156. data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
  157. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  158. data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
  159. data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
  160. data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
  161. data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
  162. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  163. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
  164. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  165. data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
  166. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  167. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
  168. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  169. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  170. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  171. data/lib/ceedling/test_invoker/test_source_file_directive_resolver.rb +40 -20
  172. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  173. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  174. data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
  175. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  176. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  177. data/lib/ceedling/yaml_wrapper.rb +3 -2
  178. data/lib/version.rb +1 -1
  179. data/plugins/bullseye/bullseye.rake +1 -3
  180. data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  181. data/plugins/bullseye/lib/bullseye.rb +24 -9
  182. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  183. data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
  184. data/plugins/dependencies/config/defaults.yml +6 -6
  185. data/plugins/dependencies/dependencies.rake +4 -1
  186. data/plugins/dependencies/lib/dependencies.rb +18 -8
  187. data/plugins/dependencies/lib/dependency_spec.rb +17 -5
  188. data/plugins/fff/lib/fff.rb +79 -46
  189. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  190. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -0
  191. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  192. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  193. data/plugins/gcov/config/defaults_gcov.rb +1 -1
  194. data/plugins/gcov/lib/console_reportinator.rb +28 -36
  195. data/plugins/gcov/lib/gcov.rb +9 -2
  196. data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
  197. data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
  198. data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
  199. data/plugins/module_generator/lib/module_generator.rb +3 -3
  200. data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
  201. data/plugins/sanitize/lib/sanitize_records.rb +3 -6
  202. data/plugins/valgrind/lib/valgrind.rb +14 -7
  203. data/site-local/404.html +2 -2
  204. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  205. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  206. data/site-local/configuration/environment-vars.html +2 -2
  207. data/site-local/configuration/global-collections.html +3 -3
  208. data/site-local/configuration/index.html +2 -2
  209. data/site-local/configuration/loading.html +2 -2
  210. data/site-local/configuration/mixins.html +2 -2
  211. data/site-local/configuration/parallel-builds.html +2 -2
  212. data/site-local/configuration/project-file.html +2 -2
  213. data/site-local/configuration/reference/cexception.html +2 -2
  214. data/site-local/configuration/reference/cmock.html +7 -3
  215. data/site-local/configuration/reference/defines.html +2 -2
  216. data/site-local/configuration/reference/environment.html +2 -2
  217. data/site-local/configuration/reference/extension.html +2 -2
  218. data/site-local/configuration/reference/files.html +65 -12
  219. data/site-local/configuration/reference/flags.html +2 -2
  220. data/site-local/configuration/reference/index.html +2 -2
  221. data/site-local/configuration/reference/libraries.html +23 -5
  222. data/site-local/configuration/reference/mixins.html +2 -2
  223. data/site-local/configuration/reference/partials.html +84 -2
  224. data/site-local/configuration/reference/paths.html +36 -8
  225. data/site-local/configuration/reference/plugins.html +2 -2
  226. data/site-local/configuration/reference/project.html +264 -12
  227. data/site-local/configuration/reference/release-build.html +4 -2
  228. data/site-local/configuration/reference/test-build.html +2 -2
  229. data/site-local/configuration/reference/test-runner.html +2 -2
  230. data/site-local/configuration/reference/tools.html +58 -4
  231. data/site-local/configuration/reference/unity.html +2 -2
  232. data/site-local/configuration/which-ceedling.html +379 -19
  233. data/site-local/development/index.html +2 -2
  234. data/site-local/development/plugins/configuration.html +2 -2
  235. data/site-local/development/plugins/index.html +2 -2
  236. data/site-local/development/plugins/plugin-subclass.html +5 -4
  237. data/site-local/development/plugins/rake-tasks.html +2 -2
  238. data/site-local/development/releases.html +7 -3
  239. data/site-local/development/workflow.html +50 -45
  240. data/site-local/getting-started/builds.html +4 -2
  241. data/site-local/getting-started/command-line.html +58 -6
  242. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  243. data/site-local/getting-started/example-projects/index.html +2 -2
  244. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  245. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  246. data/site-local/getting-started/index.html +2 -2
  247. data/site-local/getting-started/installation.html +2 -2
  248. data/site-local/getting-started/quick-start.html +2 -2
  249. data/site-local/help.html +2 -2
  250. data/site-local/index.html +2 -2
  251. data/site-local/overview/build-system.html +2 -2
  252. data/site-local/overview/index.html +2 -2
  253. data/site-local/overview/test-environments.html +2 -2
  254. data/site-local/overview/tools-and-frameworks.html +2 -2
  255. data/site-local/plugins/beep.html +2 -2
  256. data/site-local/plugins/bullseye/index.html +45 -38
  257. data/site-local/plugins/bullseye/licensing.html +2 -2
  258. data/site-local/plugins/command-hooks.html +4 -4
  259. data/site-local/plugins/compile-commands-json-db.html +2 -2
  260. data/site-local/plugins/cppcheck.html +2 -2
  261. data/site-local/plugins/dependencies.html +8 -5
  262. data/site-local/plugins/fff.html +58 -13
  263. data/site-local/plugins/gcov/examples.html +2 -2
  264. data/site-local/plugins/gcov/gcovr.html +23 -14
  265. data/site-local/plugins/gcov/index.html +2 -2
  266. data/site-local/plugins/gcov/overview.html +2 -2
  267. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  268. data/site-local/plugins/gcov/reporting.html +2 -2
  269. data/site-local/plugins/gcov/setup.html +4 -3
  270. data/site-local/plugins/gcov/tool-versions.html +2 -2
  271. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  272. data/site-local/plugins/index.html +2 -2
  273. data/site-local/plugins/module-generator.html +2 -2
  274. data/site-local/plugins/report-build-warnings-log.html +2 -2
  275. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  276. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  277. data/site-local/plugins/report-tests-log-factory.html +2 -2
  278. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  279. data/site-local/plugins/report-tests-raw-output-log.html +5 -3
  280. data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
  281. data/site-local/plugins/sanitize.html +9 -8
  282. data/site-local/plugins/valgrind.html +10 -9
  283. data/site-local/project/index.html +2 -2
  284. data/site-local/project/release-history.html +2 -2
  285. data/site-local/project/sbom.html +2 -2
  286. data/site-local/project/upgrade.html +5 -2
  287. data/site-local/reference/build-directives.html +2 -2
  288. data/site-local/reference/command-line.html +11 -4
  289. data/site-local/reference/environment-vars.html +2 -2
  290. data/site-local/reference/gcov-plugin.html +2 -2
  291. data/site-local/reference/global-collections.html +12 -12
  292. data/site-local/reference/index.html +2 -2
  293. data/site-local/reference/partials-macros.html +47 -2
  294. data/site-local/reference/project-configuration.html +2 -2
  295. data/site-local/sitemap.xml.gz +0 -0
  296. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  297. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  298. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  299. data/site-local/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  300. data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
  301. data/site-local/testing-guide/build-directives.html +2 -2
  302. data/site-local/testing-guide/conventions.html +113 -15
  303. data/site-local/testing-guide/frameworks.html +2 -2
  304. data/site-local/testing-guide/index.html +2 -2
  305. data/site-local/testing-guide/partials/configuration.html +31 -4
  306. data/site-local/testing-guide/partials/conventions.html +509 -8
  307. data/site-local/testing-guide/partials/directives.html +4 -3
  308. data/site-local/testing-guide/partials/example.html +2 -2
  309. data/site-local/testing-guide/partials/index.html +2 -2
  310. data/site-local/testing-guide/partials/overview.html +30 -12
  311. data/site-local/testing-guide/partials/variables.html +169 -4
  312. data/site-local/testing-guide/test-cases.html +2 -2
  313. data/site-local/testing-guide/test-sample.html +2 -2
  314. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  315. data/spec/integration/actionator_file_operations_spec.rb +91 -1
  316. data/spec/integration/build_step_doctor_spec.rb +270 -0
  317. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  318. data/spec/integration/compile_commands_json_db_spec.rb +1 -1
  319. data/spec/integration/configurator_validation_spec.rb +1 -1
  320. data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
  321. data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
  322. data/spec/integration/includes_extraction_spec.rb +27 -14
  323. data/spec/integration/launcher_handoff_spec.rb +297 -0
  324. data/spec/integration/mixin_loading_spec.rb +1 -1
  325. data/spec/integration/module_generator_spec.rb +3 -3
  326. data/spec/integration/nested_test_artifacts_spec.rb +99 -0
  327. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  328. data/spec/integration/partials_carry_spec.rb +520 -0
  329. data/spec/integration/partials_declarations_spec.rb +655 -0
  330. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  331. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  332. data/spec/integration/partials_header_composition_spec.rb +268 -35
  333. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  334. data/spec/integration/partials_module_resolution_spec.rb +33 -23
  335. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  336. data/spec/integration/path_intake_scenarios_spec.rb +101 -0
  337. data/spec/integration/path_length_reporting_spec.rb +64 -0
  338. data/spec/integration/path_scenarios_spec.rb +399 -0
  339. data/spec/integration/quote_include_isolator_spec.rb +57 -1
  340. data/spec/integration/report_build_warnings_log_spec.rb +1 -1
  341. data/spec/integration/report_tests_log_factory_spec.rb +1 -1
  342. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  343. data/spec/integration/test_executable_manifest_spec.rb +1 -1
  344. data/spec/integration/test_includes_extractinator_spec.rb +69 -3
  345. data/spec/integration/test_naming_spec.rb +201 -0
  346. data/spec/integration/test_source_file_checks_spec.rb +168 -0
  347. data/spec/integration/tool_executor_spec.rb +1 -1
  348. data/spec/integration/tool_validator_spec.rb +3 -3
  349. data/spec/integration/upgrade_docs_spec.rb +84 -0
  350. data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
  351. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  352. data/spec/integration/win_path_limit_spec.rb +53 -0
  353. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  354. data/spec/support/file_tree_helper.rb +88 -0
  355. data/spec/support/integration/configurator_integration_helper.rb +14 -9
  356. data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
  357. data/spec/support/integration/partial_files_harness.rb +181 -0
  358. data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
  359. data/spec/support/integration/path_scenario_harness.rb +175 -0
  360. data/spec/support/integration/spec_integration_helper.rb +9 -4
  361. data/spec/support/integration/test_includes_harness.rb +69 -37
  362. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  363. data/spec/support/spec_helper.rb +2 -0
  364. data/spec/support/system/spec_system_helper.rb +7 -6
  365. data/spec/support/system/system_context.rb +21 -3
  366. data/spec/support/working_dir_tracking.rb +49 -0
  367. data/spec/system/build_output_mirroring_spec.rb +2 -2
  368. data/spec/system/bullseye_deployment_spec.rb +2 -0
  369. data/spec/system/conditional_mock_includes_spec.rb +1 -1
  370. data/spec/system/delta_builds_spec.rb +163 -23
  371. data/spec/system/encoding_stress_spec.rb +4 -4
  372. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  373. data/spec/system/gcov_deployment_spec.rb +3 -0
  374. data/spec/system/header_include_path_validation_spec.rb +4 -4
  375. data/spec/system/header_search_paths_spec.rb +1083 -0
  376. data/spec/system/launcher_handoff_spec.rb +82 -0
  377. data/spec/system/mock_include_folders_spec.rb +212 -0
  378. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  379. data/spec/system/parent_directory_reference_spec.rb +5 -3
  380. data/spec/system/partials_carry_spec.rb +581 -0
  381. data/spec/system/partials_delta_builds_spec.rb +280 -0
  382. data/spec/system/partials_function_pointers_spec.rb +106 -0
  383. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  384. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  385. data/spec/system/path_handling_probes_spec.rb +196 -0
  386. data/spec/system/pinned_thread_count_spec.rb +4 -4
  387. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  388. data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
  389. data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
  390. data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
  391. data/spec/system/short_build_paths_spec.rb +87 -0
  392. data/spec/system/sibling_header_collision_spec.rb +30 -6
  393. data/spec/system/special_path_characters_spec.rb +86 -0
  394. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  395. data/spec/system/support/common_test_cases.rb +23 -21
  396. data/spec/system/support/gcov_common_test_cases.rb +37 -9
  397. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  398. data/spec/system/support/sanitize_common_test_cases.rb +2 -2
  399. data/spec/system/support/valgrind_common_test_cases.rb +12 -12
  400. data/spec/system/test_build_layout_spec.rb +209 -0
  401. data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
  402. data/spec/system/test_runner_system_include_spec.rb +1 -1
  403. data/spec/system/test_source_file_directive_spec.rb +64 -5
  404. data/spec/units/bin/actionator_spec.rb +14 -17
  405. data/spec/units/bin/app_cfg_spec.rb +37 -0
  406. data/spec/units/bin/cli_handler_spec.rb +282 -6
  407. data/spec/units/bin/cli_helper_spec.rb +116 -45
  408. data/spec/units/bin/installation_selector_spec.rb +114 -0
  409. data/spec/units/bin/launchinator_spec.rb +171 -0
  410. data/spec/units/bin/path_validator_spec.rb +10 -0
  411. data/spec/units/bin/versionator_spec.rb +38 -6
  412. data/spec/units/build_log_writer_spec.rb +57 -0
  413. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  414. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  415. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  416. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  417. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  418. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  419. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  420. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  421. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  422. data/spec/units/c_identifier_spec.rb +35 -0
  423. data/spec/units/config/build_root_policy_spec.rb +61 -0
  424. data/spec/units/config/configurator_builder_spec.rb +61 -6
  425. data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
  426. data/spec/units/config/configurator_setup_spec.rb +80 -68
  427. data/spec/units/config/configurator_spec.rb +54 -6
  428. data/spec/units/config/configurator_validator_spec.rb +1 -172
  429. data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
  430. data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
  431. data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
  432. data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
  433. data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
  434. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  435. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  436. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  437. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  438. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  439. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  440. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  441. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  442. data/spec/units/encodinator_spec.rb +3 -4
  443. data/spec/units/filename_extension_spec.rb +11 -0
  444. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  445. data/spec/units/filesystem/build_subpath_spec.rb +235 -0
  446. data/spec/units/filesystem/destination_collision_spec.rb +30 -0
  447. data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
  448. data/spec/units/filesystem/file_finder_spec.rb +845 -0
  449. data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
  450. data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
  451. data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
  452. data/spec/units/filesystem/file_tree_spec.rb +511 -0
  453. data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
  454. data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
  455. data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
  456. data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
  457. data/spec/units/filesystem/project_paths_spec.rb +147 -0
  458. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  459. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  460. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  461. data/spec/units/filesystem/working_dir_spec.rb +71 -0
  462. data/spec/units/generators/generator_helper_spec.rb +0 -60
  463. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  464. data/spec/units/generators/generator_partials_spec.rb +656 -55
  465. data/spec/units/generators/generator_spec.rb +38 -6
  466. data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
  467. data/spec/units/generators/generator_test_results_spec.rb +1 -1
  468. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  469. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  470. data/spec/units/handoff_spec.rb +205 -0
  471. data/spec/units/includes/header_search_spec.rb +406 -0
  472. data/spec/units/includes/include_factory_spec.rb +23 -6
  473. data/spec/units/includes/include_pathinator_spec.rb +118 -8
  474. data/spec/units/includes/include_spec.rb +14 -0
  475. data/spec/units/includes/includes_spec.rb +176 -19
  476. data/spec/units/installation_spec.rb +228 -0
  477. data/spec/units/library_resolver_spec.rb +157 -0
  478. data/spec/units/loginator_spec.rb +31 -0
  479. data/spec/units/mock_locator_spec.rb +275 -6
  480. data/spec/units/partials/include_groups_spec.rb +42 -0
  481. data/spec/units/partials/partializer_config_spec.rb +32 -0
  482. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  483. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  484. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  485. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  486. data/spec/units/partials/partializer_spec.rb +1579 -270
  487. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  488. data/spec/units/partials/partials_rename_spec.rb +160 -0
  489. data/spec/units/partials_manager_spec.rb +561 -251
  490. data/spec/units/plugins/bullseye_spec.rb +49 -2
  491. data/spec/units/plugins/console_reportinator_spec.rb +73 -26
  492. data/spec/units/plugins/dependencies_spec.rb +33 -7
  493. data/spec/units/plugins/dependency_spec_spec.rb +17 -0
  494. data/spec/units/plugins/gcov_spec.rb +28 -3
  495. data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
  496. data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
  497. data/spec/units/plugins/module_generator_spec.rb +5 -5
  498. data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
  499. data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
  500. data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
  501. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
  502. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
  503. data/spec/units/plugins/sanitize_records_spec.rb +3 -1
  504. data/spec/units/plugins/sanitize_spec.rb +1 -1
  505. data/spec/units/plugins/valgrind_spec.rb +23 -8
  506. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  507. data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
  508. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  509. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  510. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  511. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  512. data/spec/units/rake_app/rakefile_component_resolver_spec.rb +21 -0
  513. data/spec/units/release_build_executor_spec.rb +53 -14
  514. data/spec/units/release_build_planner_spec.rb +15 -3
  515. data/spec/units/reportinator_spec.rb +5 -5
  516. data/spec/units/setupinator_spec.rb +51 -0
  517. data/spec/units/standin_headerinator_spec.rb +55 -9
  518. data/spec/units/test_build_executor_spec.rb +842 -166
  519. data/spec/units/test_build_planner_spec.rb +205 -15
  520. data/spec/units/test_build_setup_spec.rb +179 -30
  521. data/spec/units/test_context_extractor_spec.rb +36 -2
  522. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  523. data/spec/units/test_file_preprocessinator_spec.rb +17 -1
  524. data/spec/units/test_includes_extractinator_spec.rb +61 -9
  525. data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
  526. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  527. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  528. data/spec/units/test_invoker_spec.rb +14 -1
  529. data/spec/units/test_invoker_types_spec.rb +8 -7
  530. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  531. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  532. data/spec/units/test_search_paths_spec.rb +73 -5
  533. data/spec/units/test_source_file_directive_resolver_spec.rb +38 -7
  534. data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
  535. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  536. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  537. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +27 -1
  538. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  539. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  540. data/spec/units/yaml_wrapper_spec.rb +11 -0
  541. metadata +265 -36
  542. data/lib/ceedling/file_finder_helper.rb +0 -127
  543. data/lib/ceedling/file_path_collection_utils.rb +0 -164
  544. data/spec/units/file_finder_spec.rb +0 -495
  545. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -784,20 +784,22 @@ describe CExtractorCodeText do
784
784
  expect(rest).to eq("")
785
785
  end
786
786
 
787
- it "handles only semicolons and whitespace" do
787
+ # The text may be a buffer that ends early, so deadspace running to its end may go on past
788
+ # it. That deadspace stays for the next read, which sees all of it.
789
+ it "leaves trailing whitespace after the last semicolon" do
788
790
  content = "; ; ; "
789
791
  pos, rest = skip_semicolons.call(content)
790
-
791
- expect(pos).to eq(6)
792
- expect(rest).to eq("")
792
+
793
+ expect(pos).to eq(5)
794
+ expect(rest).to eq(" ")
793
795
  end
794
796
 
795
- it "handles semicolons with unterminated comment" do
797
+ it "leaves a comment the text cuts short" do
796
798
  content = "; /* unterminated"
797
799
  pos, rest = skip_semicolons.call(content)
798
-
799
- expect(pos).to eq(17)
800
- expect(rest).to eq("")
800
+
801
+ expect(pos).to eq(1)
802
+ expect(rest).to eq(" /* unterminated")
801
803
  end
802
804
 
803
805
  end
@@ -867,6 +869,20 @@ describe CExtractorCodeText do
867
869
  end
868
870
  end
869
871
 
872
+ # A stray ';' declares nothing, so ahead of a statement it can count as space
873
+ context "stray semicolons" do
874
+ it "stops at a ';' by default" do
875
+ _bytes, _pos, rest = skip_deadspace.call( " ; int x;" )
876
+ expect( rest ).to eq( "; int x;" )
877
+ end
878
+
879
+ it "skips each ';' among the space when asked" do
880
+ scanner = StringScanner.new( " ;; /* c */ ;\n int x;" )
881
+ CExtractorCodeText.new().skip_deadspace( scanner, semicolons: true )
882
+ expect( scanner.rest ).to eq( "int x;" )
883
+ end
884
+ end
885
+
870
886
  context "whitespace handling" do
871
887
  it "skips spaces" do
872
888
  content = " code"
@@ -2015,6 +2031,19 @@ describe CExtractorCodeText do
2015
2031
  end
2016
2032
  end
2017
2033
 
2034
+ ###
2035
+ ### strip_c23_attributes()
2036
+ ###
2037
+ describe "#strip_c23_attributes" do
2038
+ it "removes C23 attributes and keeps everything else as written" do
2039
+ expect(CExtractorCodeText.new.strip_c23_attributes('[[maybe_unused]] static int buf [[x("]]")]] [4]')).to eq(' static int buf [4]')
2040
+ end
2041
+
2042
+ it "keeps nested array subscripts and GCC attributes" do
2043
+ expect(CExtractorCodeText.new.strip_c23_attributes('int a[b[1]] __attribute__((unused))')).to eq('int a[b[1]] __attribute__((unused))')
2044
+ end
2045
+ end
2046
+
2018
2047
  ###
2019
2048
  ### strip_compiler_extensions()
2020
2049
  ###
@@ -2047,6 +2076,22 @@ describe CExtractorCodeText do
2047
2076
  expect(strip_ext.call("__attribute__((format(printf,1,2))) int foo(char *fmt, ...)")).to eq("int foo(char *fmt, ...)")
2048
2077
  end
2049
2078
 
2079
+ it "strips a leading C23 attribute" do
2080
+ expect(strip_ext.call("[[maybe_unused]] int count")).to eq("int count")
2081
+ end
2082
+
2083
+ it "strips a C23 attribute after a name, keeping the array size" do
2084
+ expect(strip_ext.call("int buf [[maybe_unused]] [4]")).to eq("int buf [4]")
2085
+ end
2086
+
2087
+ it "strips a C23 attribute whose argument holds brackets" do
2088
+ expect(strip_ext.call("[[deprecated(\"a]]b\")]] [[gnu::aligned(8)]] int x")).to eq("int x")
2089
+ end
2090
+
2091
+ it "keeps nested array subscripts" do
2092
+ expect(strip_ext.call("int a[b[1]]")).to eq("int a[b[1]]")
2093
+ end
2094
+
2050
2095
  it "strips __cdecl calling convention" do
2051
2096
  expect(strip_ext.call("int __cdecl foo(void)")).to eq("int foo(void)")
2052
2097
  end
@@ -2067,8 +2112,20 @@ describe CExtractorCodeText do
2067
2112
  expect(strip_ext.call("_Noreturn void exit_prog(int code)")).to eq("void exit_prog(int code)")
2068
2113
  end
2069
2114
 
2070
- it "strips _Thread_local C11 specifier" do
2071
- expect(strip_ext.call("_Thread_local int counter")).to eq("int counter")
2115
+ # A variable's type is read from this text, and its extern must agree with its definition
2116
+ [
2117
+ '_Thread_local int counter',
2118
+ '_Atomic int counter',
2119
+ '_Atomic(int) counter',
2120
+ '_Bool ready',
2121
+ 'double _Complex z',
2122
+ 'double _Imaginary y',
2123
+ '__typeof__(int) counter',
2124
+ 'typeof(*p) q'
2125
+ ].each do |text|
2126
+ it "keeps the type in `#{text}`" do
2127
+ expect(strip_ext.call(text)).to eq(text)
2128
+ end
2072
2129
  end
2073
2130
 
2074
2131
  it "strips multiple extensions in one signature" do
@@ -5,6 +5,7 @@
5
5
  # SPDX-License-Identifier: MIT
6
6
  # =========================================================================
7
7
 
8
+ require 'timeout'
8
9
  require 'spec_helper'
9
10
  require 'ceedling/c_extractor/c_extractor_declarations'
10
11
  require 'ceedling/c_extractor/c_extractor_code_text'
@@ -700,6 +701,203 @@ describe CExtractorDeclarations do
700
701
  expect(pos).to eq(20)
701
702
  expect(rest).to eq("")
702
703
  end
704
+
705
+ # A comma after an initializer separates declarators just as one before it does. A comma
706
+ # inside brackets, braces or a literal belongs to the initializer.
707
+ [
708
+ ['int g_x = 0, g_y;', [['g_x', 'int', 'int g_x = 0;'], ['g_y', 'int', 'int g_y;']]],
709
+ ['int g_p = f(1, 2), g_q, g_r = 3;', [['g_p', 'int', 'int g_p = f(1, 2);'], ['g_q', 'int', 'int g_q;'], ['g_r', 'int', 'int g_r = 3;']]],
710
+ ['char *g_s = "a,b", *g_t;', [['g_s', 'char *', 'char *g_s = "a,b";'], ['g_t', 'char *', 'char *g_t;']]],
711
+ ["char g_c = ',', g_d;", [['g_c', 'char', "char g_c = ',';"], ['g_d', 'char', 'char g_d;']]],
712
+ ['int g_a[2] = {1, 2}, g_b;', [['g_a', 'int', 'int g_a[2] = {1, 2};'], ['g_b', 'int', 'int g_b;']]],
713
+ ['struct ops g_o = { 1 }, g_n = { 2 };', [['g_o', 'struct ops', 'struct ops g_o = { 1 };'], ['g_n', 'struct ops', 'struct ops g_n = { 2 };']]],
714
+ ['int g_m[N == 2 ? 2 : 3] = {0}, g_k;', [['g_m', 'int', 'int g_m[N == 2 ? 2 : 3] = {0};'], ['g_k', 'int', 'int g_k;']]]
715
+ ].each do |content, expected|
716
+ it "splits `#{content}` at its top-level commas" do
717
+ success, variables, _pos, _rest = extract_variable.call( content )
718
+
719
+ expect( success ).to be true
720
+ expect( variables.map { |v| [v.name, v.type, v.text] } ).to eq expected
721
+ expect( variables.map( &:original ).uniq ).to eq [content]
722
+ end
723
+ end
724
+
725
+ # A later declarator takes the text ahead of the first one's declarator. Stars, qualifiers
726
+ # after a star, attributes after the name and line breaks belong to the first declarator.
727
+ [
728
+ ["int\ng_x = 0, g_y = 1;", ['g_y', 'int', [], 'int g_y = 1;']],
729
+ ["const unsigned char\n g_tbl[] = {1, 2}, g_after = 3;", ['g_after', 'unsigned char', ['const'], 'unsigned char g_after = 3;']],
730
+ ['int *const g_a = 0, g_b;', ['g_b', 'int', [], 'int g_b;']],
731
+ ['const char *const g_n = "x", *const g_m = "y";', ['g_m', 'char *const', ['const'], 'char *const g_m = "y";']],
732
+ ['int *restrict g_a = 0, g_b = 2;', ['g_b', 'int', [], 'int g_b = 2;']],
733
+ ['int g_a __attribute__((aligned(4))) = 1, g_b;', ['g_b', 'int', [], 'int g_b;']],
734
+ ['__ALIGNED(4) uint8_t g_buf[16] = {0}, g_buf2[16];', ['g_buf2', '__ALIGNED(4) uint8_t', [], '__ALIGNED(4) uint8_t g_buf2[16];']],
735
+ ['__attribute__((section(".x"))) int g_s = 1, g_t;', ['g_t', 'int', [], '__attribute__((section(".x"))) int g_t;']]
736
+ ].each do |content, (name, type, decorators, text)|
737
+ it "gives a later declarator only the base type of `#{content.gsub( "\n", '\n' )}`" do
738
+ success, variables, _pos, _rest = extract_variable.call( content )
739
+
740
+ expect( success ).to be true
741
+ expect( variables.last.to_h.slice( :name, :type, :decorators, :text ) ).to eq( name: name, type: type, decorators: decorators, text: text )
742
+ end
743
+ end
744
+
745
+ # Without the first name the base type can't be found, so the declaration stays whole. It
746
+ # reads as nameless, as a declaration a macro spells does, rather than named by its last.
747
+ [
748
+ 'int (g_a) = 1, g_b = 2;',
749
+ 'static ARR_OF(int, hits)[3], n;'
750
+ ].each do |content|
751
+ it "keeps `#{content}` whole and nameless, since its first name can't be read" do
752
+ success, variables, _pos, _rest = extract_variable.call( content )
753
+
754
+ expect( success ).to be true
755
+ expect( variables.map { |v| [v.name, v.type, v.text] } ).to eq [[nil, nil, content.delete_prefix( 'static ' )]]
756
+ end
757
+ end
758
+
759
+ # A word may stand between the type and the name: a qualifier, a type or storage keyword, a
760
+ # memory-space keyword, a compiler's `__` extension or a macro in capitals. A word ahead of a
761
+ # star is never the name, and a bracket inside parentheses is no array size.
762
+ [
763
+ ['int __far a, b;', [['a', 'int __far'], ['b', 'int __far']]],
764
+ ['char __far *p, *q;', [['p', 'char __far *'], ['q', 'char __far *']]],
765
+ ['unsigned char xdata a, b;', [['a', 'unsigned char xdata'], ['b', 'unsigned char xdata']]],
766
+ ['int MYQ *p, *q;', [['p', 'int MYQ *'], ['q', 'int MYQ *']]],
767
+ ['int MYQ a, b;', [['a', 'int MYQ'], ['b', 'int MYQ']]],
768
+ ['int _Atomic a, b;', [['a', 'int _Atomic'], ['b', 'int _Atomic']]],
769
+ ['struct S _Atomic s, t;', [['s', 'struct S _Atomic'], ['t', 'struct S _Atomic']]],
770
+ ['typeof(int[3]) a, b;', [['a', 'typeof(int[3])'], ['b', 'typeof(int[3])']]],
771
+ ['_Alignas(sizeof(x[0])) int a, b;', [['a', '_Alignas(sizeof(x[0])) int'], ['b', '_Alignas(sizeof(x[0])) int']]],
772
+ ['int *x MY_ATTR, y;', [['MY_ATTR', 'int *x'], ['y', 'int']]],
773
+ ['const u8 MAX_A = 1, MAX_B = 2;', [['MAX_A', 'u8'], ['MAX_B', 'u8']]],
774
+ ['unsigned long MAX_A = 1, MAX_B = 2;', [['MAX_A', 'unsigned long'], ['MAX_B', 'unsigned long']]],
775
+ ['static __IO u32_t TICK_A, TICK_B;', [['TICK_A', '__IO u32_t'], ['TICK_B', '__IO u32_t']]],
776
+ ['MYQ u32_t TICK_A, TICK_B;', [['TICK_A', 'MYQ u32_t'], ['TICK_B', 'MYQ u32_t']]],
777
+ ['unsigned char xdata A, B;', [['A', 'unsigned char xdata'], ['B', 'unsigned char xdata']]]
778
+ ].each do |content, expected|
779
+ it "splits `#{content}` with each variable's base type" do
780
+ success, variables, _pos, _rest = extract_variable.call( content )
781
+
782
+ expect( success ).to be true
783
+ expect( variables.map { |v| [v.name, v.type] } ).to eq expected
784
+ end
785
+ end
786
+
787
+ # An unexpanded attribute macro after the first name reads as the name, which leaves a base
788
+ # type no declaration could have. The statement then stays one record, read whole.
789
+ [
790
+ "const char g_a KEEP = 'x', g_b = 'y';",
791
+ 'const uint8_t table[] PROGMEM = {1}, t2[] PROGMEM = {2};'
792
+ ].each do |content|
793
+ it "keeps `#{content}` one record when a macro after its first name misleads the base type" do
794
+ success, variables, _pos, _rest = extract_variable.call( content )
795
+
796
+ expect( success ).to be true
797
+ expect( variables.map( &:text ) ).to eq [content.delete_prefix( 'const ' )]
798
+ end
799
+ end
800
+
801
+ # A name read in capitals after another word is taken for an attribute macro, so the word
802
+ # before it is the real name and the statement stays one record
803
+ [
804
+ ['static const int MAX_A UNUSED = 3, MAX_B = 1;', 'int MAX_A UNUSED = 3, MAX_B = 1;'],
805
+ ['static const u8 MAX_A UNUSED = 3, MAX_B = 1;', 'u8 MAX_A UNUSED = 3, MAX_B = 1;'],
806
+ ['static UINT32 MAX_A UNUSED = 3, MAX_B = 1;', 'UINT32 MAX_A UNUSED = 3, MAX_B = 1;'],
807
+ ['static int a1 __maybe_unused, b1;', 'int a1 __maybe_unused, b1;']
808
+ ].each do |content, text|
809
+ it "keeps `#{content}` one record when a capitalized name follows the first name" do
810
+ success, variables, _pos, _rest = extract_variable.call( content )
811
+
812
+ expect( success ).to be true
813
+ expect( variables.map( &:text ) ).to eq [text]
814
+ end
815
+ end
816
+
817
+ it "splits a compound declaration whose first function pointer has an initializer" do
818
+ success, variables, _pos, _rest = extract_variable.call( "static int (*a)(int) = f, (*b)(int);" )
819
+
820
+ expect( success ).to be true
821
+ expect( variables.map { |v| [v.name, v.type, v.decorators, v.declarator] } ).to eq [
822
+ ['a', 'int', ['static'], '(*a)(int)'],
823
+ ['b', 'int', ['static'], '(*b)(int)']
824
+ ]
825
+ end
826
+
827
+ # Array sizes are found in one pass, however many parentheses a literal holds
828
+ it "reads a declaration whose literal holds many parentheses within a time bound" do
829
+ content = 'int MACRO("' + ('(' * 20_000) + '") x, y;'
830
+
831
+ success, variables = nil
832
+ Timeout.timeout( 2 ) { success, variables, _, _ = extract_variable.call( content ) }
833
+
834
+ expect( success ).to be true
835
+ expect( variables.map( &:name ) ).to eq ['x', 'y']
836
+ end
837
+
838
+ it "splits a compound declaration after a large initializer table within a time bound" do
839
+ content = 'static const uint8_t table[] = { ' + ('0x5A, ' * 20_000) + '0 }, after;'
840
+
841
+ success, variables = nil
842
+ Timeout.timeout( 2 ) { success, variables, _, _ = extract_variable.call( content ) }
843
+
844
+ expect( success ).to be true
845
+ expect( variables.map( &:name ) ).to eq ['table', 'after']
846
+ end
847
+ end
848
+
849
+ # GCC and Clang accept '$' in an identifier, at its start, middle or end
850
+ context "names holding '$'" do
851
+ [
852
+ ['static int hook$2;', [['hook$2', 'int', '']]],
853
+ ['int g$v[2];', [['g$v', 'int', '[2]']]],
854
+ ['int $lead;', [['$lead', 'int', '']]],
855
+ ['int trail$;', [['trail$', 'int', '']]],
856
+ ['int a$1 = 0, b$2;', [['a$1', 'int', ''], ['b$2', 'int', '']]],
857
+ ['struct s$t x$y;', [['x$y', 'struct s$t', '']]],
858
+ ['static int x$_Atomic;', [['x$_Atomic', 'int', '']]]
859
+ ].each do |content, expected|
860
+ it "reads `#{content}`" do
861
+ success, variables, _pos, _rest = extract_variable.call( content )
862
+
863
+ expect( success ).to be true
864
+ expect( variables.map { |v| [v.name, v.type, v.array_suffix] } ).to eq expected
865
+ end
866
+ end
867
+ end
868
+
869
+ # A variable's extern repeats its type, so a type keyword or a specifier's argument must stay
870
+ context "type specifiers and keywords" do
871
+ [
872
+ ['typeof(int) g_t;', 'g_t', 'typeof(int)'],
873
+ ['_Atomic(int) g_a;', 'g_a', '_Atomic(int)'],
874
+ ['typeof(*g_pp) g_q;', 'g_q', 'typeof(*g_pp)'],
875
+ ['__typeof__(int) g_u;', 'g_u', '__typeof__(int)'],
876
+ ['_BitInt(8) g_b;', 'g_b', '_BitInt(8)'],
877
+ ['typeof(int (*)(int)) g_fp;', 'g_fp', 'typeof(int (*)(int))'],
878
+ ['typeof(int[3]) g_arr;', 'g_arr', 'typeof(int[3])'],
879
+ ['typeof(char (*)[4]) g_pa;', 'g_pa', 'typeof(char (*)[4])'],
880
+ ['__typeof_unqual(const int) g_tu;', 'g_tu', '__typeof_unqual(const int)'],
881
+ ['_Alignas(8) int g_al;', 'g_al', '_Alignas(8) int'],
882
+ ['_Bool g_f;', 'g_f', '_Bool'],
883
+ ['_Atomic int g_ai;', 'g_ai', '_Atomic int'],
884
+ ['_Thread_local int g_tl;', 'g_tl', '_Thread_local int'],
885
+ ['_Complex double g_c;', 'g_c', '_Complex double']
886
+ ].each do |content, name, type|
887
+ it "reads `#{content}` with its type whole" do
888
+ success, variables, _pos, _rest = extract_variable.call( content )
889
+
890
+ expect( success ).to be true
891
+ expect( variables.map { |v| [v.name, v.type] } ).to eq [[name, type]]
892
+ end
893
+ end
894
+
895
+ it "gives a later declarator a base type a specifier spells" do
896
+ success, variables, _pos, _rest = extract_variable.call( 'typeof(*p) a = 0, b;' )
897
+
898
+ expect( success ).to be true
899
+ expect( variables.map { |v| [v.name, v.type, v.text] } ).to eq [['a', 'typeof(*p)', 'typeof(*p) a = 0;'], ['b', 'typeof(*p)', 'typeof(*p) b;']]
900
+ end
703
901
  end
704
902
 
705
903
  context "compiler extensions on variable declarations" do
@@ -757,22 +955,118 @@ describe CExtractorDeclarations do
757
955
  text: 'struct Point my_point __attribute__((aligned(4)));')
758
956
  end
759
957
 
958
+ # An attribute after the name belongs to the variable, so it stays with the variable's text
760
959
  it "extracts name and type from anonymous-struct variable with trailing __attribute__" do
761
960
  content = "struct { int x; int y; } coords __attribute__((aligned(8)));"
762
961
  success, variable, _, _ = extract_variable.call(content)
763
962
  expect(success).to be true
764
963
  expect(variable[0].name).to eq('coords')
765
- expect(variable[0].type).to eq('struct { int x; int y; }')
766
- expect(variable[0].text).to eq('struct { int x; int y; } coords __attribute__((aligned(8)));')
964
+ expect(variable[0].defined_type.text).to eq('struct { int x; int y; };')
965
+ expect(variable[0].text).to eq('coords __attribute__((aligned(8)));')
767
966
  end
768
967
 
968
+ # A member's attribute belongs to the type, which keeps it as written
769
969
  it "extracts name and type when __attribute__ appears on a struct member inside the body" do
770
970
  content = "struct Point { int x __attribute__((aligned(4))); int y; } my_point;"
771
971
  success, variable, _, _ = extract_variable.call(content)
772
972
  expect(success).to be true
773
973
  expect(variable[0].name).to eq('my_point')
774
- expect(variable[0].type).to eq('struct Point { int x ; int y; }')
775
- expect(variable[0].text).to eq('struct Point { int x __attribute__((aligned(4))); int y; } my_point;')
974
+ expect(variable[0].defined_type.text).to eq('struct Point { int x __attribute__((aligned(4))); int y; };')
975
+ expect(variable[0].text).to eq('my_point;')
976
+ end
977
+ end
978
+
979
+ # An asm label names the variable's symbol. The record keeps it apart from the name and type,
980
+ # and its text keeps it for the definition.
981
+ # An alignment specifier or attribute may lead a declaration, ahead of its storage class
982
+ context "a leading alignment specifier or attribute" do
983
+ [
984
+ ['_Alignas(8) static int s_as;', ['static'], '_Alignas(8) int', '_Alignas(8) int s_as;'],
985
+ ['alignas(16) static const int s_c = 1;', ['static', 'const'], 'alignas(16) int', 'alignas(16) int s_c = 1;'],
986
+ ['__attribute__((unused)) static int s_u;', ['static'], 'int', '__attribute__((unused)) int s_u;'],
987
+ ['static _Alignas(4) volatile int s_v;', ['static', 'volatile'], '_Alignas(4) int', '_Alignas(4) int s_v;']
988
+ ].each do |content, decorators, type, text|
989
+ it "reads `#{content}` with its storage class as a decorator" do
990
+ success, variables, _pos, _rest = extract_variable.call( content )
991
+
992
+ expect( success ).to be true
993
+ expect( variables.map { |v| [v.decorators, v.type, v.text] } ).to eq [[decorators, type, text]]
994
+ end
995
+ end
996
+ end
997
+
998
+ # A C23 attribute may lead a declaration, ahead of its storage class, or follow a name. The
999
+ # record's text keeps it in place. Its type leaves it out, so an extern can declare the type.
1000
+ context "C23 attributes" do
1001
+ [
1002
+ ['[[maybe_unused]] static int count;', 'count', ['static'], 'int', '[[maybe_unused]] int count;'],
1003
+ ['[[gnu::unused]] static int s_g;', 's_g', ['static'], 'int', '[[gnu::unused]] int s_g;'],
1004
+ ['[[deprecated("a]]b")]] static int s_d;', 's_d', ['static'], 'int', '[[deprecated("a]]b")]] int s_d;'],
1005
+ ['[[maybe_unused]] [[deprecated]] static int s_m;', 's_m', ['static'], 'int', '[[maybe_unused]] [[deprecated]] int s_m;'],
1006
+ ['[[maybe_unused]] static const int s_c = 1;', 's_c', ['static', 'const'], 'int', '[[maybe_unused]] int s_c = 1;'],
1007
+ ['static int count [[maybe_unused]];', 'count', ['static'], 'int', 'int count [[maybe_unused]];']
1008
+ ].each do |content, name, decorators, type, text|
1009
+ it "reads `#{content}` with its storage class as a decorator" do
1010
+ success, variables, _pos, _rest = extract_variable.call( content )
1011
+
1012
+ expect( success ).to be true
1013
+ expect( variables.map { |v| [v.name, v.decorators, v.type, v.text, v.array_suffix] } ).to eq [[name, decorators, type, text, '']]
1014
+ end
1015
+ end
1016
+
1017
+ it 'keeps an array size after an attribute that follows the name' do
1018
+ _success, variables, _pos, _rest = extract_variable.call( 'int buf [[maybe_unused]] [4];' )
1019
+
1020
+ expect( variables.map { |v| [v.name, v.type, v.array_suffix] } ).to eq [['buf', 'int', '[4]']]
1021
+ end
1022
+
1023
+ it 'gives each declarator of a compound declaration the leading attribute' do
1024
+ _success, variables, _pos, _rest = extract_variable.call( '[[maybe_unused]] static int a, b;' )
1025
+
1026
+ expect( variables.map { |v| [v.name, v.decorators, v.type, v.text] } ).to eq [
1027
+ ['a', ['static'], 'int', '[[maybe_unused]] int a;'],
1028
+ ['b', ['static'], 'int', '[[maybe_unused]] int b;']
1029
+ ]
1030
+ end
1031
+
1032
+ it 'keeps an attribute after a name with its own declarator' do
1033
+ _success, variables, _pos, _rest = extract_variable.call( 'int a [[maybe_unused]], b;' )
1034
+
1035
+ expect( variables.map { |v| [v.name, v.type, v.text] } ).to eq [['a', 'int', 'int a [[maybe_unused]];'], ['b', 'int', 'int b;']]
1036
+ end
1037
+ end
1038
+
1039
+ context "asm labels" do
1040
+ def read_all(content)
1041
+ success, variables, _, _ = extract_variable.call( content )
1042
+ expect( success ).to be true
1043
+ variables.map { |v| v.to_h.slice( :name, :type, :array_suffix, :declarator, :text, :asm_label ) }
1044
+ end
1045
+
1046
+ it "reads a variable by its name, whichever spelling its label takes" do
1047
+ expect( read_all( 'int g_s __asm__("g_symbol") = 1;' ) ).to eq( [{ name: 'g_s', type: 'int', array_suffix: '', declarator: nil,
1048
+ text: 'int g_s __asm__("g_symbol") = 1;', asm_label: '__asm__("g_symbol")' }] )
1049
+ expect( read_all( 'int g_b asm("g_b_sym");' ).first ).to include( name: 'g_b', type: 'int', asm_label: 'asm("g_b_sym")' )
1050
+ expect( read_all( 'static char *g_p __asm ("g_p_sym");' ).first ).to include( name: 'g_p', type: 'char *', asm_label: '__asm ("g_p_sym")' )
1051
+ end
1052
+
1053
+ it "reads a label after an array size, an attribute or a declarator group" do
1054
+ expect( read_all( 'int g_a[2] asm("g_a_sym") = { 1, 2 };' ).first ).to include( name: 'g_a', array_suffix: '[2]', asm_label: 'asm("g_a_sym")' )
1055
+ expect( read_all( 'int g_u __attribute__((used)) asm("g_u_sym");' ).first ).to include( name: 'g_u', type: 'int', asm_label: 'asm("g_u_sym")' )
1056
+ expect( read_all( 'int (*fp)(int) __asm__("fp_label");' ).first ).to include( name: 'fp', declarator: '(*fp)(int)', asm_label: '__asm__("fp_label")' )
1057
+ expect( read_all( 'int (*g)(int) __attribute__((used)) __asm__("sym") = f;' ).first ).to include( name: 'g', declarator: '(*g)(int)', asm_label: '__asm__("sym")' )
1058
+ end
1059
+
1060
+ it "reads each label of a compound declaration" do
1061
+ expect( read_all( 'int a asm("a_sym") = 1, *b asm("b_sym"), c;' ).map { |v| v.slice( :name, :type, :asm_label ) } ).to eq( [
1062
+ { name: 'a', type: 'int', asm_label: 'asm("a_sym")' },
1063
+ { name: 'b', type: 'int *', asm_label: 'asm("b_sym")' },
1064
+ { name: 'c', type: 'int', asm_label: nil }
1065
+ ] )
1066
+ end
1067
+
1068
+ it "gives a variable without a label none" do
1069
+ expect( read_all( 'int asm_count = 1;' ).first ).to include( name: 'asm_count', asm_label: nil )
776
1070
  end
777
1071
  end
778
1072
 
@@ -910,6 +1204,209 @@ describe CExtractorDeclarations do
910
1204
  end
911
1205
  end
912
1206
 
1207
+ # The name of a function pointer or a pointer to an array sits inside parentheses. The type
1208
+ # is what comes ahead of them, and the declarator keeps the rest a declaration needs.
1209
+ context "parenthesized declarators" do
1210
+ def read_one(content)
1211
+ success, variables, _, _ = extract_variable.call( content )
1212
+ expect( success ).to be true
1213
+ expect( variables.length ).to eq 1
1214
+ variables.first.to_h.slice( :name, :type, :array_suffix, :declarator, :text )
1215
+ end
1216
+
1217
+ it "reads a function pointer's declarator" do
1218
+ expect( read_one( "static void (*cb)(int);" ) ).to eq(
1219
+ name: 'cb', type: 'void', array_suffix: '', declarator: '(*cb)(int)', text: 'void (*cb)(int);'
1220
+ )
1221
+ end
1222
+
1223
+ it "reads an array of function pointers by its name" do
1224
+ expect( read_one( "static int (*s_table[2])(int) = { one, two };" ) ).to eq(
1225
+ name: 's_table', type: 'int', array_suffix: '', declarator: '(*s_table[2])(int)', text: 'int (*s_table[2])(int) = { one, two };'
1226
+ )
1227
+ end
1228
+
1229
+ it "reads a constant function pointer by its name" do
1230
+ expect( read_one( "int (*const k_hook)(int) = bump;" ) ).to include( name: 'k_hook', type: 'int', declarator: '(*const k_hook)(int)' )
1231
+ end
1232
+
1233
+ it "reads a pointer to an array's declarator" do
1234
+ expect( read_one( "int (*ptr)[10];" ) ).to include( name: 'ptr', type: 'int', array_suffix: '', declarator: '(*ptr)[10]' )
1235
+ end
1236
+
1237
+ it "keeps pointer stars ahead of the parentheses in the type" do
1238
+ expect( read_one( "extern char *(*name_of)(int);" ) ).to include( name: 'name_of', type: 'char *', declarator: '(*name_of)(int)' )
1239
+ end
1240
+
1241
+ # The declarator is repeated in an extern, which must agree with the definition
1242
+ it "keeps a calling convention written inside the parentheses" do
1243
+ expect( read_one( "static void (__stdcall *on_tick)(int);" ) ).to eq(
1244
+ name: 'on_tick', type: 'void', array_suffix: '', declarator: '(__stdcall *on_tick)(int)', text: 'void (__stdcall *on_tick)(int);'
1245
+ )
1246
+ end
1247
+
1248
+ it "reads a qualifier a compiler adds past the name" do
1249
+ expect( read_one( "int (* _Nullable np)(int);" ) ).to include( name: 'np', type: 'int', declarator: '(* _Nullable np)(int)' )
1250
+ end
1251
+
1252
+ it "keeps a calling convention ahead of an attribute among the stars" do
1253
+ expect( read_one( "void (__stdcall * __attribute__((unused)) fp)(int);" ) ).to include(
1254
+ name: 'fp', type: 'void', declarator: '(__stdcall * __attribute__((unused)) fp)(int)'
1255
+ )
1256
+ end
1257
+
1258
+ [
1259
+ ['void (*(fp34))(void) = 0;', 'fp34', '(*(fp34))(void)'],
1260
+ ['static int (*hook$1)(int) = 0;', 'hook$1', '(*hook$1)(int)'],
1261
+ ['int (*s_hook /* callback */)(int);', 's_hook', '(*s_hook )(int)']
1262
+ ].each do |content, name, declarator|
1263
+ it "reads `#{content}` by its name #{name}" do
1264
+ expect( read_one( content ) ).to include( name: name, declarator: declarator )
1265
+ end
1266
+ end
1267
+
1268
+ # An extern repeats the declarator. An attribute after it would draw a warning there, and an
1269
+ # asm label is kept apart.
1270
+ it "leaves a trailing attribute and an asm label out of the declarator" do
1271
+ expect( read_one( "void (* const vec[])(void) __attribute__ ((used)) = { 0 };" ) ).to include( name: 'vec', declarator: '(* const vec[])(void)' )
1272
+ expect( read_one( 'int (*fp)(int) __asm__("fp_label");' ) ).to include( name: 'fp', declarator: '(*fp)(int)' )
1273
+ expect( read_one( 'int (*g)(int) __attribute__((used)) __asm__("sym") = f;' ) ).to include( name: 'g', declarator: '(*g)(int)' )
1274
+ expect( read_one( 'int (*g_u)(int) MY_USED = f;' ) ).to include( name: 'g_u', declarator: '(*g_u)(int)' )
1275
+ end
1276
+
1277
+ # Fallback preprocessing leaves comments in place, and a bracket in one doesn't count
1278
+ it "finds the initializer past a comment holding a bracket" do
1279
+ expect( read_one( 'int (*g_cb)(int) /* 1) */ = ticker_bump;' ) ).to include( name: 'g_cb', declarator: '(*g_cb)(int)' )
1280
+ end
1281
+
1282
+ # The written text may open a different group than the stripped text does, as an attribute
1283
+ # whose argument opens with a star can. Then the stripped declarator stands.
1284
+ it "keeps the stripped declarator when the written text opens a different group" do
1285
+ expect( read_one( "void __attribute__((*odd)) (*fp)(int);" ) ).to include( name: 'fp', declarator: '(*fp)(int)' )
1286
+ end
1287
+
1288
+ [
1289
+ ['int x, (*fp)(int);', [['x', 'int', nil], ['fp', 'int', '(*fp)(int)']]],
1290
+ ['int (*fp)(int), x;', [['fp', 'int', '(*fp)(int)'], ['x', 'int', nil]]],
1291
+ ['void (__cdecl *a)(int), (*b)(int);', [['a', 'void', '(__cdecl *a)(int)'], ['b', 'void', '(*b)(int)']]]
1292
+ ].each do |content, expected|
1293
+ it "splits the compound `#{content}` by declarator" do
1294
+ success, variables, _, _ = extract_variable.call( content )
1295
+
1296
+ expect( success ).to be true
1297
+ expect( variables.map { |v| [v.name, v.type, v.declarator] } ).to eq expected
1298
+ end
1299
+ end
1300
+
1301
+ it "gives a plain declaration no declarator" do
1302
+ expect( read_one( "static uint8_t buf[16];" ) ).to include( name: 'buf', declarator: nil )
1303
+ end
1304
+
1305
+ # A macro's arguments ahead of the type are no declarator
1306
+ it "reads a declaration whose type a function-like macro precedes by its last word" do
1307
+ expect( read_one( "__ALIGNED(8) uint32_t x;" ) ).to include( name: 'x', declarator: nil )
1308
+ end
1309
+
1310
+ # A pointer in a size, an initializer or a string is no declarator
1311
+ [
1312
+ ['size_t n = sizeof(*p);', 'n', ''],
1313
+ ['int a[sizeof(*p)];', 'a', '[sizeof(*p)]'],
1314
+ ['char *s = "(*x)";', 's', ''],
1315
+ ['int x[] = { (*a) };', 'x', '[]']
1316
+ ].each do |content, name, suffix|
1317
+ it "reads `#{content}` as a plain declaration of #{name}" do
1318
+ expect( read_one( content ) ).to include( name: name, array_suffix: suffix, declarator: nil )
1319
+ end
1320
+ end
1321
+
1322
+ # A struct's function-pointer members belong to the struct, not to its variables
1323
+ it "reads a struct variable whose body declares a function pointer by the variable's name" do
1324
+ expect( read_one( "static struct ops { int (*open)(void); } s_ops;" ) ).to include( name: 's_ops', declarator: nil )
1325
+ end
1326
+
1327
+ it "splits a compound declaration of struct variables whose body declares a function pointer" do
1328
+ success, variables, _, _ = extract_variable.call( "static struct ops { int (*open)(void); } s_ops, s_ops2;" )
1329
+
1330
+ expect( success ).to be true
1331
+ expect( variables.map { |v| [v.name, v.text] } ).to eq [['s_ops', 's_ops;'], ['s_ops2', 's_ops2;']]
1332
+ expect( variables.map( &:defined_type ).uniq.map( &:text ) ).to eq ['struct ops { int (*open)(void); };']
1333
+ end
1334
+
1335
+ # A lookup table may run to many kilobytes, and its declaration must still read quickly. A
1336
+ # scan quadratic in its length would take minutes on this one.
1337
+ it "reads a declaration with a large initializer table within a time bound" do
1338
+ content = 'static const uint8_t table[] = { ' + ('0x5A, ' * 20_000) + '0 };'
1339
+
1340
+ success, variables = nil
1341
+ Timeout.timeout( 2 ) { success, variables, _, _ = extract_variable.call( content ) }
1342
+
1343
+ expect( success ).to be true
1344
+ expect( variables.first.name ).to eq( 'table' )
1345
+ end
1346
+
1347
+ it "splits a compound declaration of function pointers into each one" do
1348
+ success, variables, _, _ = extract_variable.call( "static int (*a)(int), (*b)(int);" )
1349
+
1350
+ expect( success ).to be true
1351
+ expect( variables.map { |v| [v.name, v.type, v.declarator, v.text] } ).to eq [
1352
+ ['a', 'int', '(*a)(int)', 'int (*a)(int);'],
1353
+ ['b', 'int', '(*b)(int)', 'int (*b)(int);']
1354
+ ]
1355
+ end
1356
+ end
1357
+
1358
+ # Fallback preprocessing leaves comments in place, and a declaration's lines are joined into
1359
+ # one. A comment must not swallow what follows it on the joined line.
1360
+ context "comments inside a declaration" do
1361
+ def read(content)
1362
+ success, variables, pos, _rest = extract_variable.call( content )
1363
+ expect( success ).to be(true), "expected a declaration in #{content.inspect}"
1364
+ expect( pos ).to eq( content.length )
1365
+ return variables
1366
+ end
1367
+
1368
+ it "reads past a line comment before the initializer" do
1369
+ content = "int g_n // count\n = 3;"
1370
+ variable = read( content ).first
1371
+ expect( [variable.name, variable.type, variable.text] ).to eq ['g_n', 'int', 'int g_n = 3;']
1372
+ expect( variable.original ).to eq content
1373
+ end
1374
+
1375
+ it "reads a declaration that ends in a block comment" do
1376
+ expect( read( "int g_m /* count */;" ).map { |v| [v.name, v.type] } ).to eq [['g_m', 'int']]
1377
+ end
1378
+
1379
+ it "reads a function pointer with a line comment before its initializer" do
1380
+ variable = read( "int (*g_fp)(int) // cb\n = 0;" ).first
1381
+ expect( [variable.name, variable.declarator, variable.text] ).to eq ['g_fp', '(*g_fp)(int)', 'int (*g_fp)(int) = 0;']
1382
+ end
1383
+
1384
+ it "splits a compound declaration only at commas outside its comments" do
1385
+ expect( read( "int g_c1, // first, of two\n g_c2;" ).map { |v| [v.name, v.text] } ).to eq [['g_c1', 'int g_c1;'], ['g_c2', 'int g_c2;']]
1386
+ end
1387
+
1388
+ it "keeps what looks like a comment inside a literal" do
1389
+ expect( read( "char *g_lit = \"a // b /* c */\";" ).first.text ).to eq 'char *g_lit = "a // b /* c */";'
1390
+ expect( read( "char g_ch = '/';" ).first.text ).to eq "char g_ch = '/';"
1391
+ end
1392
+
1393
+ # The buffer may end inside the comment, so the scan fails and the caller grows the buffer
1394
+ it "fails at a block comment that never closes" do
1395
+ success, variables, pos, _rest = extract_variable.call( "int x /* never closed; int y;" )
1396
+ expect( [success, variables, pos] ).to eq [false, nil, 0]
1397
+ end
1398
+
1399
+ it "reads a declaration with a commented initializer table within a time bound" do
1400
+ content = 'static const uint8_t table[] = { ' + ('0x5A, /* v */ ' * 20_000) + '0 };'
1401
+
1402
+ success, variables = nil
1403
+ Timeout.timeout( 2 ) { success, variables, _, _ = extract_variable.call( content ) }
1404
+
1405
+ expect( success ).to be true
1406
+ expect( variables.first.name ).to eq( 'table' )
1407
+ end
1408
+ end
1409
+
913
1410
  context "comments and malformed input" do
914
1411
  it "scans past a block comment mid-declaration and still finds the real terminator" do
915
1412
  content = "int x /* note */ = 5;"