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
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4505,7 +4505,7 @@ test results (usually <code>report_tests_pretty_stdout</code>).</p>
4505
4505
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4506
4506
 
4507
4507
 
4508
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4508
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4509
4509
 
4510
4510
 
4511
4511
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -2154,6 +2154,89 @@
2154
2154
  </ul>
2155
2155
  </nav>
2156
2156
 
2157
+ </li>
2158
+
2159
+ <li class="md-nav__item">
2160
+ <a href="#win_path_limit" class="md-nav__link">
2161
+ <span class="md-ellipsis">
2162
+
2163
+ :win_path_limit
2164
+
2165
+ </span>
2166
+ </a>
2167
+
2168
+ <nav class="md-nav" aria-label=":win_path_limit">
2169
+ <ul class="md-nav__list">
2170
+
2171
+ <li class="md-nav__item">
2172
+ <a href="#windows-two-limits" class="md-nav__link">
2173
+ <span class="md-ellipsis">
2174
+
2175
+ Windows‘ two limits
2176
+
2177
+ </span>
2178
+ </a>
2179
+
2180
+ </li>
2181
+
2182
+ <li class="md-nav__item">
2183
+ <a href="#classic" class="md-nav__link">
2184
+ <span class="md-ellipsis">
2185
+
2186
+ :classic
2187
+
2188
+ </span>
2189
+ </a>
2190
+
2191
+ </li>
2192
+
2193
+ <li class="md-nav__item">
2194
+ <a href="#long_paths" class="md-nav__link">
2195
+ <span class="md-ellipsis">
2196
+
2197
+ :long_paths
2198
+
2199
+ </span>
2200
+ </a>
2201
+
2202
+ </li>
2203
+
2204
+ <li class="md-nav__item">
2205
+ <a href="#auto" class="md-nav__link">
2206
+ <span class="md-ellipsis">
2207
+
2208
+ :auto
2209
+
2210
+ </span>
2211
+ </a>
2212
+
2213
+ </li>
2214
+
2215
+ <li class="md-nav__item">
2216
+ <a href="#ruby-before-40" class="md-nav__link">
2217
+ <span class="md-ellipsis">
2218
+
2219
+ Ruby before 4.0
2220
+
2221
+ </span>
2222
+ </a>
2223
+
2224
+ </li>
2225
+
2226
+ <li class="md-nav__item">
2227
+ <a href="#checking-your-toolchain" class="md-nav__link">
2228
+ <span class="md-ellipsis">
2229
+
2230
+ Checking your toolchain
2231
+
2232
+ </span>
2233
+ </a>
2234
+
2235
+ </li>
2236
+
2237
+ </ul>
2238
+ </nav>
2239
+
2157
2240
  </li>
2158
2241
 
2159
2242
  </ul>
@@ -4627,6 +4710,89 @@
4627
4710
  </ul>
4628
4711
  </nav>
4629
4712
 
4713
+ </li>
4714
+
4715
+ <li class="md-nav__item">
4716
+ <a href="#win_path_limit" class="md-nav__link">
4717
+ <span class="md-ellipsis">
4718
+
4719
+ :win_path_limit
4720
+
4721
+ </span>
4722
+ </a>
4723
+
4724
+ <nav class="md-nav" aria-label=":win_path_limit">
4725
+ <ul class="md-nav__list">
4726
+
4727
+ <li class="md-nav__item">
4728
+ <a href="#windows-two-limits" class="md-nav__link">
4729
+ <span class="md-ellipsis">
4730
+
4731
+ Windows‘ two limits
4732
+
4733
+ </span>
4734
+ </a>
4735
+
4736
+ </li>
4737
+
4738
+ <li class="md-nav__item">
4739
+ <a href="#classic" class="md-nav__link">
4740
+ <span class="md-ellipsis">
4741
+
4742
+ :classic
4743
+
4744
+ </span>
4745
+ </a>
4746
+
4747
+ </li>
4748
+
4749
+ <li class="md-nav__item">
4750
+ <a href="#long_paths" class="md-nav__link">
4751
+ <span class="md-ellipsis">
4752
+
4753
+ :long_paths
4754
+
4755
+ </span>
4756
+ </a>
4757
+
4758
+ </li>
4759
+
4760
+ <li class="md-nav__item">
4761
+ <a href="#auto" class="md-nav__link">
4762
+ <span class="md-ellipsis">
4763
+
4764
+ :auto
4765
+
4766
+ </span>
4767
+ </a>
4768
+
4769
+ </li>
4770
+
4771
+ <li class="md-nav__item">
4772
+ <a href="#ruby-before-40" class="md-nav__link">
4773
+ <span class="md-ellipsis">
4774
+
4775
+ Ruby before 4.0
4776
+
4777
+ </span>
4778
+ </a>
4779
+
4780
+ </li>
4781
+
4782
+ <li class="md-nav__item">
4783
+ <a href="#checking-your-toolchain" class="md-nav__link">
4784
+ <span class="md-ellipsis">
4785
+
4786
+ Checking your toolchain
4787
+
4788
+ </span>
4789
+ </a>
4790
+
4791
+ </li>
4792
+
4793
+ </ul>
4794
+ </nav>
4795
+
4630
4796
  </li>
4631
4797
 
4632
4798
  </ul>
@@ -4779,7 +4945,7 @@ plugin tasks.</p>
4779
4945
  <strong>Default</strong>: <code>['test:all']</code></p>
4780
4946
  <h2 id="use_mocks"><code>:use_mocks</code></h2>
4781
4947
  <p>Configures the build environment to make use of CMock. Note that if you do not
4782
- use mocks, there's no harm in leaving this setting as its default value.</p>
4948
+ use mocks, there’s no harm in leaving this setting as its default value.</p>
4783
4949
  <p><strong>Default</strong>: TRUE</p>
4784
4950
  <h2 id="use_exceptions"><code>:use_exceptions</code></h2>
4785
4951
  <p>Configures the build environment to make use of CException. Ceedling enables
@@ -4841,7 +5007,7 @@ compilation, and running test executables.</p>
4841
5007
  will drop considerably as compared to running a build with a single thread.</p>
4842
5008
  <p>Tuning the number of threads for peak performance is an art more than a
4843
5009
  science. A special value of <code>:auto</code> instructs Ceedling to query the host
4844
- system's number of virtual cores. To this value it adds a constant of 4. This
5010
+ system’s number of virtual cores. To this value it adds a constant of 4. This
4845
5011
  is often a good value sufficient to "max out" available resources without
4846
5012
  overloading available resources.</p>
4847
5013
  <p><code>:compile_threads</code> is used for all release build steps and all test suite build
@@ -4995,13 +5161,89 @@ build. To restore <code>:gdb</code> backtraces, re-codesign <code>gdb</code> fol
4995
5161
  command line arguments (passed to the test executable). If you are targeting
4996
5162
  a simulator with your test executable binaries, <code>:simple</code> is unlikely to
4997
5163
  work for you. In the simplest case, you may simply fall back to <code>:none</code>.
4998
- With some work and using Ceedling's various features, much more sophisticated
5164
+ With some work and using Ceedling’s various features, much more sophisticated
4999
5165
  options are possible.</li>
5000
5166
  <li>The <code>:gdb</code> option currently only supports the native build platform. That is,
5001
5167
  the <code>:gdb</code> backtrace option cannot handle backtrace for cross-compiled code
5002
5168
  or any sort of simulator-based test fixture.</li>
5003
5169
  </ol>
5004
5170
  <p><strong>Default</strong>: <code>:simple</code></p>
5171
+ <h2 id="win_path_limit"><code>:win_path_limit</code></h2>
5172
+ <p>Tells Ceedling which Windows path length limit applies to your build, so its
5173
+ path length messages are true for your host. It applies only on Windows, and
5174
+ Ceedling ignores it on other platforms. It is still checked on every host, so
5175
+ a project file shared across hosts is validated everywhere.</p>
5176
+ <div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nt">:project</span><span class="p">:</span>
5177
+ <a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="nt">:win_path_limit</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">:auto</span>
5178
+ </code></pre></div>
5179
+ <p>Ceedling checks the length of each build path it creates. A path near the
5180
+ limit gets a warning, and one at or past the limit gets an error. Each path is
5181
+ reported once. The messages never stop a build. A Windows path that is truly
5182
+ too long fails on its own, often as “No such file or directory” rather than a
5183
+ length error. Ceedling’s message is then the clue to the real cause.</p>
5184
+ <p>This setting changes only what Ceedling reports. It does not enable long-path
5185
+ safety. Long-paths on Windows requires a registry setting and application
5186
+ support.</p>
5187
+ <h3 id="windows-two-limits">Windows‘ two limits</h3>
5188
+ <ol>
5189
+ <li><strong>The classic limit, 260 characters.</strong> It applies on every Windows host
5190
+ unless long paths are in effect. A directory path maxes out at 248
5191
+ characters leaving room for a classic 8.3 filename within it.</li>
5192
+ <li><strong>Long paths, 32,767 characters.</strong> They are in effect for a program only
5193
+ when both of these hold:<ol>
5194
+ <li><a href="https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry#registry-setting-to-enable-long-paths">Long paths are enabled on the host via registry setting</a>.
5195
+ Windows reads it when a program starts, so run Ceedling again after
5196
+ changing it.</li>
5197
+ <li>The program is long-path-aware, as its manifest declares. Every program
5198
+ decides this for itself: Ruby, your compiler, your linker.</li>
5199
+ </ol>
5200
+ </li>
5201
+ </ol>
5202
+ <p>In all cases, no single Windows directory or filename may exceed 255
5203
+ characters.</p>
5204
+ <h3 id="classic"><code>:classic</code></h3>
5205
+ <p>Reports paths against the classic limits: 260 characters for a file and 248
5206
+ for a directory. An error past the limit points you to this setting.</p>
5207
+ <h3 id="long_paths"><code>:long_paths</code></h3>
5208
+ <p>Reports paths against the long path limit. The first time a build path nears
5209
+ 260 characters, Ceedling checks once whether Ceedling’s runtime can really work
5210
+ past that limit. It writes, reads, and lists a file in a directory nested past
5211
+ 260 characters below your build root, then removes it.</p>
5212
+ <p>Outcomes:</p>
5213
+ <ul>
5214
+ <li><strong>Ruby can write and list long paths:</strong> Ceedling stays quiet about lengths up
5215
+ to 32,767 characters.</li>
5216
+ <li><strong>Ruby can write long paths but can't list them:</strong> Ceedling keeps the long
5217
+ limit and warns once (see <a href="#ruby-before-40">Ruby before 4.0</a>).</li>
5218
+ <li><strong>Long paths do not work:</strong> Ceedling warns once, naming the cause (below)
5219
+ and then reports against the classic limits thereafter.</li>
5220
+ <li>The host may not have long paths enabled.</li>
5221
+ <li>The application runtime may not be long-path-aware.</li>
5222
+ <li>The build directory’s drive may not support long paths.</li>
5223
+ </ul>
5224
+ <p>To name the cause, Ceedling reads the host’s registry setting with the
5225
+ <a href="tools.html#windows_registry_query"><code>:windows_registry_query</code></a> tool.</p>
5226
+ <h3 id="auto"><code>:auto</code></h3>
5227
+ <p>Runs the same check as <code>:long_paths</code>, but lifts the limit only when Ruby can
5228
+ both write and list long paths. Otherwise Ceedling keeps the classic limits and
5229
+ says why once, in a notice.</p>
5230
+ <h3 id="ruby-before-40">Ruby before 4.0</h3>
5231
+ <p>Builds of Ruby 3.x are generally long-path-aware for files. They create, read,
5232
+ and write files past 260 characters when long paths are enabled. But, they
5233
+ cannot list a directory that deep. Globs, directory listings, and recursive
5234
+ copies and removals fail there, or silently leave entries out. Ruby 4.0 lists
5235
+ them.</p>
5236
+ <p>On Ruby 3.x, a build directory past 260 characters can make Ceedling’s own
5237
+ directory scans fail. <code>clean</code> and <code>clobber</code> can leave such a directory behind.
5238
+ Delete it by hand, for example with <code>rmdir /s /q build</code> in a Windows shell, or
5239
+ use Ruby 4.0. With <code>:auto</code>, Ceedling keeps the classic limits on Ruby 3.x, so
5240
+ its messages still point at every path past 260 characters.</p>
5241
+ <h3 id="checking-your-toolchain">Checking your toolchain</h3>
5242
+ <p>Your compiler, linker, and other tools have path limits of their own, and
5243
+ Ceedling doesn‘t test them. To check a tool, create a directory more than 260
5244
+ characters deep, then compile and link a trivial C file there with your
5245
+ project’s own tools.</p>
5246
+ <p><strong>Default</strong>: <code>:classic</code></p>
5005
5247
  <p><br/><br/></p>
5006
5248
 
5007
5249
 
@@ -5073,7 +5315,7 @@ build. To restore <code>:gdb</code> backtraces, re-codesign <code>gdb</code> fol
5073
5315
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
5074
5316
 
5075
5317
 
5076
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
5318
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
5077
5319
 
5078
5320
 
5079
5321
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4540,7 +4540,7 @@ is available in artifact paths.</p>
4540
4540
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4541
4541
 
4542
4542
 
4543
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4543
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4544
4544
 
4545
4545
 
4546
4546
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4539,7 +4539,7 @@ uses fallback preprocessing instead.</p>
4539
4539
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4540
4540
 
4541
4541
 
4542
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4542
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4543
4543
 
4544
4544
 
4545
4545
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4569,7 +4569,7 @@ an order-dependent failure without test case order moving around run to run).</p
4569
4569
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4570
4570
 
4571
4571
 
4572
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4572
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4573
4573
 
4574
4574
 
4575
4575
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -2597,7 +2597,18 @@
2597
2597
  </span>
2598
2598
  </a>
2599
2599
 
2600
- <nav class="md-nav" aria-label=":release_linker">
2600
+ </li>
2601
+
2602
+ <li class="md-nav__item">
2603
+ <a href="#windows_registry_query" class="md-nav__link">
2604
+ <span class="md-ellipsis">
2605
+
2606
+ :windows_registry_query
2607
+
2608
+ </span>
2609
+ </a>
2610
+
2611
+ <nav class="md-nav" aria-label=":windows_registry_query">
2601
2612
  <ul class="md-nav__list">
2602
2613
 
2603
2614
  <li class="md-nav__item">
@@ -4689,7 +4700,18 @@
4689
4700
  </span>
4690
4701
  </a>
4691
4702
 
4692
- <nav class="md-nav" aria-label=":release_linker">
4703
+ </li>
4704
+
4705
+ <li class="md-nav__item">
4706
+ <a href="#windows_registry_query" class="md-nav__link">
4707
+ <span class="md-ellipsis">
4708
+
4709
+ :windows_registry_query
4710
+
4711
+ </span>
4712
+ </a>
4713
+
4714
+ <nav class="md-nav" aria-label=":windows_registry_query">
4693
4715
  <ul class="md-nav__list">
4694
4716
 
4695
4717
  <li class="md-nav__item">
@@ -5054,6 +5076,20 @@ system will provide options for integrating alternative tools.</p>
5054
5076
  <li><code>${5}</code>: optional library path list</li>
5055
5077
  </ul>
5056
5078
  <p><strong>Default</strong>: <code>gcc</code></p>
5079
+ <h2 id="windows_registry_query"><code>:windows_registry_query</code></h2>
5080
+ <p>Reads one Windows registry value. It is not a build step. Ceedling adds this
5081
+ tool only on Windows, and only when <a href="project.html#win_path_limit"><code>:project</code> ↳ <code>:win_path_limit</code></a>
5082
+ is <code>:auto</code> or <code>:long_paths</code>. It runs only if Ceedling’s long path check fails,
5083
+ to tell whether long paths are disabled on the host or unavailable to Ruby.</p>
5084
+ <p>The tool is optional. If its executable is missing, Ceedling’s message says the
5085
+ registry could not be read, and the build goes on.</p>
5086
+ <ul>
5087
+ <li><code>${1}</code>: registry key</li>
5088
+ <li><code>${2}</code>: value name</li>
5089
+ </ul>
5090
+ <p><strong>Default</strong>: <code>reg</code> (as <code>reg query "${1}" /v ${2}</code>)</p>
5091
+ <p>A replacement must print its result as <code>reg query</code> does. Ceedling looks for a
5092
+ line such as <code>LongPathsEnabled REG_DWORD 0x1</code> in its output.</p>
5057
5093
  <h3 id="tool-definition-configurable-elements">Tool definition configurable elements</h3>
5058
5094
  <ol>
5059
5095
  <li>
@@ -5083,6 +5119,15 @@ own tools do, for example <code>"-c \"${1}\""</code>. Quoting protects most
5083
5119
  characters. On Linux and macOS, a path holding <code>"</code>, <code>$</code>, a backtick, or
5084
5120
  <code>\</code> can still break a command.</p>
5085
5121
  </div>
5122
+ <div class="admonition note">
5123
+ <p class="admonition-title">Each argument closes its own quotes</p>
5124
+ <p>Ceedling checks the quoting in <code>:executable</code> and in each argument when it
5125
+ validates a tool. A quote left open fails validation. Every argument must
5126
+ close quotes it opens; a quoted value can’t span two entries in the list.
5127
+ A typographic quote (e.g. <code>”</code>) pasted from elsewhere draws a warning. A
5128
+ shell treats it as an ordinary character. On Windows, <code>'</code> is an ordinary
5129
+ character too and is not checked.</p>
5130
+ </div>
5086
5131
  </li>
5087
5132
  <li>
5088
5133
  <p><code>:name</code> - Simple name (i.e. "nickname") of tool beyond its executable name.
@@ -5378,7 +5423,7 @@ that can be modified with this same hack.</p>
5378
5423
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
5379
5424
 
5380
5425
 
5381
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
5426
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
5382
5427
 
5383
5428
 
5384
5429
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4529,7 +4529,7 @@ ordering — see <a href="test-runner.html#test_runner-rng_seed"><code>:test_run
4529
4529
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4530
4530
 
4531
4531
 
4532
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4532
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4533
4533
 
4534
4534
 
4535
4535
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4872,7 +4872,7 @@ installed copy, so changes to those files were silently ignored.</p>
4872
4872
  <script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4873
4873
 
4874
4874
 
4875
- <script src="../assets/javascripts/bundle.c21346df.min.js"></script>
4875
+ <script src="../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4876
4876
 
4877
4877
 
4878
4878
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4404,7 +4404,7 @@ available build step hooks.</p>
4404
4404
  <script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4405
4405
 
4406
4406
 
4407
- <script src="../assets/javascripts/bundle.c21346df.min.js"></script>
4407
+ <script src="../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4408
4408
 
4409
4409
 
4410
4410
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4707,7 +4707,7 @@ complicated.</p>
4707
4707
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4708
4708
 
4709
4709
 
4710
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4710
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4711
4711
 
4712
4712
 
4713
4713
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -4473,7 +4473,7 @@ conventions. These approaches can be combined.</p>
4473
4473
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4474
4474
 
4475
4475
 
4476
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4476
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4477
4477
 
4478
4478
 
4479
4479
  </body>
@@ -21,7 +21,7 @@
21
21
 
22
22
 
23
23
  <link rel="icon" href="../../assets/images/favicon.png">
24
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
24
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
25
25
 
26
26
 
27
27
 
@@ -5190,8 +5190,9 @@ preprocessing pipeline with toolchains other than GCC.</p>
5190
5190
  <p>These methods are called before and after execution of preprocessing for header
5191
5191
  files to be mocked (see <a href="../../testing-guide/conventions.html#test-preprocessing">Conventions &amp; Behaviors</a> for preprocessing details). If a
5192
5192
  project does not enable preprocessing or a build does not include tests, these
5193
- are not called. This pair of methods is called a number of times equal to the
5194
- number of mocks in a test build.</p>
5193
+ are not called. This pair of methods is called once for each mocked header in a
5194
+ test build. A mocked Partial's generated header is never preprocessed, so it
5195
+ draws no call.</p>
5195
5196
  <p>The argument <code>arg_hash</code> follows the structure below:</p>
5196
5197
  <div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">arg_hash</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
5197
5198
  <a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="c1"># Filepath of header file to be preprocessed on its way to being mocked</span>
@@ -5829,7 +5830,7 @@ the template’s own.</p>
5829
5830
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
5830
5831
 
5831
5832
 
5832
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
5833
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
5833
5834
 
5834
5835
 
5835
5836
  </body>
@@ -19,7 +19,7 @@
19
19
 
20
20
 
21
21
  <link rel="icon" href="../../assets/images/favicon.png">
22
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
22
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.2">
23
23
 
24
24
 
25
25
 
@@ -4507,7 +4507,7 @@ See <a href="../../getting-started/builds.html">Delta Builds</a> for how this tr
4507
4507
  <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
4508
4508
 
4509
4509
 
4510
- <script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
4510
+ <script src="../../assets/javascripts/bundle.a5f9d56c.min.js"></script>
4511
4511
 
4512
4512
 
4513
4513
  </body>