ceedling 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56f073ff96051065c1f390744785a8e933cbfa700d81a585495b49d44b318f1c
-  data.tar.gz: 3d9567c9ebb1477eb215fb9cb8cdfd42f76b7b8c5cdfd9cce1010eff89e49ea3
+  metadata.gz: 70deeef4f895489e967caec64bb020696e41fa327c83785eed4fa553a1c7b8bb
+  data.tar.gz: a3f48f487a174c6710601b693a44273542ca3934ae072d622994a19dd9d64884
 SHA512:
-  metadata.gz: 3e108e84bc09d28d53ca336b49cea22e970d6319810b8b68dab3f1dadb9793eb40948589fb771f8f1d6f731ce2319f9ee32b9cc8a12a8f54d32061e4a052c948
-  data.tar.gz: 6e21e05a55622e2836e52feccd2db2c99a2827db4c6b1179f6ed30c702db8a59dc888fd460d23976d07b3c36237e400b0e553ee9493b3f287456bd10099eae29
+  metadata.gz: 8dcd78f2672ac8afcf375314ae458c0a734b000b0edae3aee34614492072aa2e53c5751ffbc15703b90e82527b1f740800a52231bf7922749df881c00aa3ed81
+  data.tar.gz: 29bb2ceace5a9f6d20fbf0d3546a708c1a07677aa558681c95ba3cf7c4991a487edf29e58226a084d169ee700a290c09695aed9f8a8d04923eb39aac9ba90449

data/GIT_COMMIT_SHA

@@ -1 +1 @@
-e7770cc
+6f17bf8

data/README.md

@@ -1,7 +1,7 @@
 Ceedling ![CI](https://github.com/ThrowTheSwitch/Ceedling/workflows/CI/badge.svg)
 ========
 
-**Ceedling 1.1.0** is the latest and greatest.
+**Ceedling 1.1.2** is the latest and greatest.
 
 See [_Release Notes_][release-notes], [_Changelog_](docs/Changelog.md), 
 [_Breaking Changes_][breaking-changes], and [_Known Issues_][known-issues].
@@ -9,7 +9,7 @@ See [_Release Notes_][release-notes], [_Changelog_](docs/Changelog.md),
 See [🚀 Getting Started](#-getting-started) for installation and new 
 project set up.
 
-**New goodies:**
+**New goodies in 1.1.x:**
 * A [Partial][partials-docs] allows a test to mix mocked and real functions 
 from the same source module in a single test file and enables testing of 
 `static` and `inline` functions without modifying source code.
@@ -22,7 +22,7 @@ from the same source module in a single test file and enables testing of
 * New stock plugins for [Valgrind memory checking][valgrind-plugin] and 
 [Cppcheck static analysis][cppcheck-plugin].
 * The [GCov plugin][gcov-plugin]:
-   * _Finally_ supports coverage reports for all sources.
+   * Now supports coverage reports for all sources.
    * Adds support for Modified Condition / Decision Coverage.
 * Mixins improvements including an option for [inline YAML at the command line][mixins-inline-yaml].
 * Ceedling’s test preprocessing is once again compatible with Unity’s 

data/assets/broken_uncovered_file.c

@@ -0,0 +1,13 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+// Untested source with a syntax error -- fails to compile regardless of any
+// :defines/:flags, deliberately triggering the :untested_sources guidance
+// notice when :gcov :untested_sources is set to :compile.
+
+int broken_uncovered_function(int a, int b) {
+  return a + b // Missing semicolon and closing brace: guaranteed compile error.

data/assets/test_example_file_2.c

@@ -0,0 +1,22 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+// A second test file covering the same source as test_example_file_success.c.
+// Ceedling builds one executable per test file, and both link against
+// example_file.c, producing two sets of .gcda coverage data for the same
+// functions -- used to exercise gcovr's merge-mode-functions behavior.
+
+#include "unity.h"
+#include "example_file.h"
+
+void setUp(void) {}
+void tearDown(void) {}
+
+void test_difference_between_two_numbers(void)
+{
+  TEST_ASSERT_EQUAL_INT(0, difference_between_numbers(1, 1));
+}

data/assets/tests_with_partials_coverage/src/blanks.c

@@ -0,0 +1,10 @@
+#include "blanks.h"
+void helloBlanks(void) {
+
+
+  return;  // Must be the reported hit line -- the whole point of this fixture
+}
+
+// Lines 3-4 above are deliberately blank -- standing in for a stripped
+// multi-line comment. They must never absorb the hit that belongs to
+// `return` on line 5; see gcov_partials_coverage_blank_lines_in_function_body.

data/assets/tests_with_partials_coverage/src/blanks.h

@@ -0,0 +1 @@
+void helloBlanks(void);

data/assets/tests_with_partials_coverage/src/counter.c

@@ -0,0 +1,12 @@
+#include "counter.h"
+int helloCounter(void) {
+  static int count;  // Promoted to module scope and replaced with a no-op by Partials
+
+  count++;  // Must independently report as hit
+
+  return count;  // Must independently report as hit
+}
+
+// Lines 4 and 6 above are deliberately blank; they must never absorb the
+// hits that belong to `count++;` (line 5) and `return count;` (line 7);
+// see gcov_partials_coverage_function_scope_static_promotion.

data/assets/tests_with_partials_coverage/src/counter.h

@@ -0,0 +1 @@
+int helloCounter(void);

data/assets/tests_with_partials_coverage/src/decorators.c

@@ -0,0 +1,11 @@
+#include "decorators.h"
+static  // Own line -- exercises the Partials #line adjustment for stripped decorators
+inline  // Own line -- same as above
+void helloDecorators(void)
+{
+
+  return;  // Must be the reported hit line
+}
+
+// Line 6 above is deliberately blank; it must never absorb the hit that
+// belongs to `return` on line 7; see gcov_partials_coverage_decorators_on_own_lines.

data/assets/tests_with_partials_coverage/src/decorators.h

@@ -0,0 +1,4 @@
+// `helloDecorators` is `static` in decorators.c, so -- like any private
+// helper -- it has no prototype here. Its declaration for the test file
+// comes from the generated Partial's own header via TEST_PARTIAL_ALL_MODULE,
+// not from this file.

data/assets/tests_with_partials_coverage/test/test_blanks.c

@@ -0,0 +1,8 @@
+#include "unity.h"
+#include "ceedling.h"
+#include TEST_PARTIAL_ALL_MODULE(blanks)
+#include "blanks.h"
+
+void test_helloBlanks(void) {
+  helloBlanks();
+}

data/assets/tests_with_partials_coverage/test/test_counter.c

@@ -0,0 +1,9 @@
+#include "unity.h"
+#include "ceedling.h"
+#include TEST_PARTIAL_ALL_MODULE(counter)
+#include "counter.h"
+
+void test_helloCounter(void) {
+  TEST_ASSERT_EQUAL(1, helloCounter());
+  TEST_ASSERT_EQUAL(2, helloCounter());
+}

data/assets/tests_with_partials_coverage/test/test_decorators.c

@@ -0,0 +1,8 @@
+#include "unity.h"
+#include "ceedling.h"
+#include TEST_PARTIAL_ALL_MODULE(decorators)
+#include "decorators.h"
+
+void test_helloDecorators(void) {
+  helloDecorators();
+}

data/docs/Changelog.md

@@ -10,6 +10,20 @@ This changelog is complemented by three other documents:
 
 ---
 
+# [1.1.2] — 2026-07-27
+
+## 💪 Fixed
+
+- Fixed line end handling for certain circumstances in Windows that could accidentally create extra white space lines that affect file line numbering (particularly in coverage reporting).
+
+### Partials
+
+- [#1182](https://github.com/ThrowTheSwitch/Ceedling/issues/1182) Fixed termination newline handling for certain variable declarations. Robustified all similar cases in C feature extraction and added further test coverage.
+- [#1184](https://github.com/ThrowTheSwitch/Ceedling/issues/1184) Fixed escaped character handling in `#define` string literals.
+- [#1183](https://github.com/ThrowTheSwitch/Ceedling/issues/1183) Fixed postprocessed preprocessed files (ha) to preserve blank lines in function definitions where comments were stripped out by preprocessing. Without preserving blank lines, line numbering for coverage reporting purposes becomes corrupted.
+
+---
+
 # [1.1.1] — 2026-07-23
 
 ## 🌟 Added
@@ -18,15 +32,15 @@ This changelog is complemented by three other documents:
 
 ## 💪 Fixed
 
-New since 1.1.0:
+### New since 1.1.0
 
 - [#1180](https://github.com/ThrowTheSwitch/Ceedling/issues/1180) Fixed `gcovr` illegal `--exclude` flag when Gcovr configuration file in use.
 - [#1181](https://github.com/ThrowTheSwitch/Ceedling/issues/1181) Fixed linker error when test files contain no test cases (fix was implemented in Unity and vendored into Ceedling).
 
-Backlog bug fixes predating 1.1.0:
+### Backlog bug fixes predating 1.1.0
 
 - [#1064](https://github.com/ThrowTheSwitch/Ceedling/issues/1064) Fixed include guard handling that in a certain combination of preprocessing and CMock options led to duplicated symbols breaking a test build.
-- [#1098](https://github.com/ThrowTheSwitch/Ceedling/issues/1098) Fixed :test_compiler used instead of :test_assembler for assembly file.
+- [#1098](https://github.com/ThrowTheSwitch/Ceedling/issues/1098) Fixed `:test_compiler` used instead of `:test_assembler` for assembly file.
 - [#1009](https://github.com/ThrowTheSwitch/Ceedling/issues/1009) Fixed tool name handling for `command_hooks` plugin.
 
 ## ⚠️ Changed

data/lib/ceedling/c_extractor/c_extractor_declarations.rb

@@ -167,7 +167,9 @@ class CExtractorDeclarations
           # Verify this looks like a valid declaration
           # Must have at least a type and identifier
           # Can end with: word character, ], ), }, or " (for string initializers)
-          if declaration =~ /\w+.*[\w\]\)\}"']\s*;$/
+          # `/m` flag: declaration may span multiple lines (e.g. a multiline brace
+          # initializer), so '.' must match embedded newlines too
+          if declaration =~ /\w+.*[\w\]\)\}"']\s*;$/m
             return [true, expand_and_parse(declaration)]
           else
             scanner.pos = start_pos

data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb

@@ -142,8 +142,9 @@ class CExtractorPreprocessing
     return [false, nil] unless success
     text << args
 
-    # Consume optional whitespace before ';'
-    text << (scanner.scan(/[ \t]*/) || '')
+    # Consume optional whitespace before ';' (including newlines, for statements formatted
+    # with the terminating ';' on its own line)
+    text << (scanner.scan(/\s*/) || '')
 
     # Consume the required terminating ';'
     return [false, nil] unless scanner.scan(/;/)
@@ -231,20 +232,32 @@ class CExtractorPreprocessing
 
   # Collect and return the full text of a preprocessing directive starting at '#'.
   # Returns nil if not positioned at '#'. Handles backslash-newline continuations.
+  # String/char literals are consumed verbatim via skip_c_string() so an in-string
+  # escape (e.g. "\n", "\"", "\\") is never mistaken for a line continuation.
   # Trailing whitespace and newlines are stripped from the returned text.
   def _collect_directive(scanner)
     return nil unless scanner.check(/#/)
 
     text = scanner.scan(/#/)
 
-    loop do
-      text += scanner.scan(/[^\n\\]*/) || ''
+    until scanner.eos?
+      text << (scanner.scan(/[^"'\\\n]*/) || '')
+
+      if (ch = scanner.peek(1)) == '"' || ch == "'"
+        before = scanner.pos
+        @c_extractor_code_text.skip_c_string(scanner, ch)
+        text << scanner.string[before...scanner.pos]
+
+      elsif scanner.scan(/\\\n/)
+        text << "\\\n"
 
-      if scanner.scan(/\\\n/)
-        text += "\\\n"
       elsif scanner.scan(/\n/)
-        text += "\n"
+        text << "\n"
         break
+
+      elsif scanner.scan(/\\/)
+        text << '\\'
+
       else
         break  # EOS — no trailing newline
       end

data/lib/ceedling/generators/generator_partials.rb

@@ -28,11 +28,15 @@ class GeneratorPartials
     header_filepath = File.join(output_path, header)
     source_filepath = File.join(output_path, source)
 
-    @file_wrapper.open(header_filepath, 'w') do |file|
+    # Binary mode: the function bodies written below may already contain their
+    # own line endings verbatim. Windows text mode rewrites every "\n" on
+    # write, which would alter any line ending already present in that
+    # content instead of passing it through unchanged.
+    @file_wrapper.open(header_filepath, 'wb') do |file|
       generate_header(file, header, header_includes, function_definitions, c_module, true)
     end
 
-    @file_wrapper.open(source_filepath, 'w') do |file|
+    @file_wrapper.open(source_filepath, 'wb') do |file|
       generate_source(file, source_includes, function_definitions, c_module)
     end
 
@@ -43,7 +47,8 @@ class GeneratorPartials
     header = @file_path_utils.form_partial_interface_header_filename(name)
     filepath = File.join(output_path, header)
 
-    @file_wrapper.open(filepath, 'w') do |file|
+    # Binary mode: see generate_implementation above.
+    @file_wrapper.open(filepath, 'wb') do |file|
       generate_header(file, header, includes, function_declarations, c_module, false)
     end
 
@@ -149,6 +154,11 @@ class GeneratorPartials
       # Blank line before a function when preceded by a non-function item
       io << "\n" if anything_emitted && !last_was_func
       if func.line_num and func.source_filepath
+        # #line ties this generated file's code back to its original source
+        # location -- debuggers, error messages, and gcov coverage attribution
+        # all point at the real file/line instead of this generated stand-in.
+        # That mapping only holds if this file's line count matches what
+        # #line promises, which is why it's opened in binary mode above.
         io << "#line #{func.line_num} \"#{func.source_filepath}\"\n"
       end
       io << func.code_block << "\n\n"

data/lib/ceedling/objects.yml

@@ -288,6 +288,7 @@ preprocessinator_comment_stripper:
 preprocessinator_reconstructor:
   compose:
     - parsing_parcels
+    - file_wrapper
 
 preprocessinator:
   compose:

data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb

@@ -217,7 +217,11 @@ class PreprocessinatorFileAssembler
 
     # Write contents of final preprocessed file a line at a time
     # ----------------------------------------------------------
-    @file_wrapper.open( preprocessed_filepath, 'w' ) do |file|
+    # Binary mode: `contents` lines below come from an upstream preprocessed
+    # file and may already carry their own line endings. Windows text mode
+    # rewrites "\n" on write, which would alter a line ending already present
+    # in that content instead of passing it through unchanged.
+    @file_wrapper.open( preprocessed_filepath, 'wb' ) do |file|
       # Add include guards and extra blank lines to beginning of file contents
       file << "#ifndef #{guardname}\n"
       file << "#define #{guardname}\n\n"
@@ -361,7 +365,11 @@ class PreprocessinatorFileAssembler
   def assemble_preprocessed_code_file(filename:, preprocessed_filepath:, contents:, extras:, includes:)
     # Write contents of final preprocessed file a line at a time
     # ----------------------------------------------------------
-    @file_wrapper.open( preprocessed_filepath, 'w' ) do |file|
+    # Binary mode: `contents` lines below come from an upstream preprocessed
+    # file and may already carry their own line endings. Windows text mode
+    # rewrites "\n" on write, which would alter a line ending already present
+    # in that content instead of passing it through unchanged.
+    @file_wrapper.open( preprocessed_filepath, 'wb' ) do |file|
       # Reinsert #include statements into stripped down file
       # Rely on Include object stringification for formatting of incudes
       includes.each { |include| file << "#{include}\n" }

data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb

@@ -9,9 +9,9 @@ require 'ceedling/constants'
 require 'ceedling/encodinator'
 require 'ceedling/parsing_parcels'
 
-class PreprocessinatorReconstructor 
- 
-  constructor :parsing_parcels
+class PreprocessinatorReconstructor
+
+  constructor :parsing_parcels, :file_wrapper
 
   ##
   ## Preprocessor Expansion Output Handling
@@ -104,10 +104,13 @@ class PreprocessinatorReconstructor
   # Opens `input_filepath` for reading and `output_filepath` for writing,
   # then delegates to `compact_from_expansion` with the resulting IO objects.
   def compact_file_from_expansion(input_filepath:, source_filepath:, output_filepath:)
-    # Open input in binary mode: GCC output under non-C locale contains non-ASCII bytes
-    # (localized markers). Per-line clean_encoding in _scan_expansion_for_file handles content.
-    File.open( input_filepath, 'rb' ) do |input|
-      File.open( output_filepath, 'w' ) do |output|
+    # Binary mode on both ends: GCC output under non-C locale contains non-ASCII
+    # bytes (localized markers; per-line clean_encoding in _scan_expansion_for_file
+    # handles content), and the compacted output is read again downstream by code
+    # that depends on its line count being exact. Windows text mode would rewrite
+    # "\n" to "\r\n" on write, which this content must not be subject to.
+    @file_wrapper.open( input_filepath, 'rb' ) do |input|
+      @file_wrapper.open( output_filepath, 'wb' ) do |output|
         compact_from_expansion( input: input, filepath: source_filepath, output: output )
       end
     end
@@ -280,16 +283,21 @@ class PreprocessinatorReconstructor
 
     # Buffer for the last logical line (may still receive aggregated content)
     pending_line  = nil
-    # Whether a blank line should follow pending_line when flushed
-    pending_blank = false
-
-    # Yields pending_line (and optional trailing blank) then clears the buffer
+    # Count of blank lines to emit after pending_line when flushed. Tracked as
+    # an exact count, not just "was there a blank" -- callers that depend on
+    # this method for line-for-line fidelity with the original source (so
+    # that unrelated line-number math downstream stays correct) need every
+    # blank line preserved, including runs that used to be a multi-line
+    # comment before an earlier pass turned it into equivalent blank lines.
+    pending_blank_count = 0
+
+    # Yields pending_line (and any pending blank lines) then clears the buffer
     flush = lambda do
       unless pending_line.nil?
         block.call( pending_line )
-        block.call( '' ) if pending_blank
+        pending_blank_count.times { block.call( '' ) }
         pending_line  = nil
-        pending_blank = false
+        pending_blank_count = 0
       end
     end
 
@@ -308,9 +316,9 @@ class PreprocessinatorReconstructor
         # Strip a line so we can omit useless blank lines
         _line = line.strip()
 
-        # Skip processing blank lines, but mark a pending blank unless we already have one
+        # Skip processing blank lines, but track an exact count of them so runs of blanks survive intact
         if _line.empty?
-          pending_blank = true if !pending_line.nil? && !pending_line.empty?
+          pending_blank_count += 1 if !pending_line.nil? && !pending_line.empty?
           next
         end
 

data/lib/version.rb

@@ -15,7 +15,7 @@
 module Ceedling
   module Version
     # Convenience constants for gem building, etc.
-    GEM = '1.1.1'
+    GEM = '1.1.2'
     TAG = GEM
 
     # If run as a script print Ceedling's version to $stdout

data/spec/system/gcov_deployment_spec.rb

@@ -7,11 +7,13 @@
 
 require 'spec_system_helper'
 require_relative 'support/gcov_common_test_cases'
+require_relative 'support/gcov_partials_test_cases'
 
 ceedling_system_tests do
   describe "Gcov" do
     include CommonSystemTestCases
     include GcovCommonTestCases
+    include GcovPartialsTestCases
     before :all do
       determine_reports_to_test
       @c = SystemContext.new
@@ -50,6 +52,18 @@ ceedling_system_tests do
       test_case :create_html_report_100_coverage_excluding_crashing_test_case
     end
 
+    describe "Coverage reporting with Partials" do
+      before do
+        @c.with_context do
+          @c.ceedling_appcmd_exec("new --local #{@proj_name}")
+        end
+      end
+
+      test_case :gcov_partials_coverage_blank_lines_in_function_body
+      test_case :gcov_partials_coverage_decorators_on_own_lines
+      test_case :gcov_partials_coverage_function_scope_static_promotion
+    end
+
     describe "Backtrace with GDB" do
       include_context "requires gdb"
 
@@ -78,7 +92,7 @@ ceedling_system_tests do
             # than resetting, crashing the test executable before Unity can print
             # its statistics line.
             FileUtils.rm_rf('temp_sensor')
-            output = `bundle exec ruby -S ceedling example temp_sensor 2>&1`
+            output = @c.ceedling_appcmd_exec("example temp_sensor")
             expect(output).to match(/created/)
           end
         end
@@ -86,7 +100,7 @@ ceedling_system_tests do
         it "should be testable" do
           @c.with_context do
             Dir.chdir "temp_sensor" do
-              @output = `bundle exec ruby -S ceedling --mixin=add_gcov gcov:all 2>&1`
+              @output = @c.ceedling_build_exec("gcov:all --mixin=add_gcov")
               # Validate full test suite results
               expect(@output).to match(/TESTED:\s+86/)
               expect(@output).to match(/PASSED:\s+86/)
@@ -107,7 +121,7 @@ ceedling_system_tests do
         it "should be able to test a single module (it should INHERIT file-specific flags)" do
           @c.with_context do
             Dir.chdir "temp_sensor" do
-              @output = `bundle exec ruby -S ceedling --mixin=add_gcov gcov:TemperatureCalculator 2>&1`
+              @output = @c.ceedling_build_exec("gcov:TemperatureCalculator --mixin=add_gcov")
               expect(@output).to match(/TESTED:\s+2/)
               expect(@output).to match(/PASSED:\s+2/)
 
@@ -119,7 +133,7 @@ ceedling_system_tests do
         it "should be able to test multiple files matching a pattern" do
           @c.with_context do
             Dir.chdir "temp_sensor" do
-              @output = `bundle exec ruby -S ceedling --mixin=add_gcov gcov:pattern[Temp] 2>&1`
+              @output = @c.ceedling_build_exec("gcov:pattern[Temp] --mixin=add_gcov")
               expect(@output).to match(/TESTED:\s+6/)
               expect(@output).to match(/PASSED:\s+6/)
 
@@ -132,7 +146,7 @@ ceedling_system_tests do
         it "should be able to test all files matching in a path" do
           @c.with_context do
             Dir.chdir "temp_sensor" do
-              @output = `bundle exec ruby -S ceedling --mixin=add_gcov gcov:path[adc] 2>&1`
+              @output = @c.ceedling_build_exec("gcov:path[adc] --mixin=add_gcov")
               expect(@output).to match(/TESTED:\s+24/)
               expect(@output).to match(/PASSED:\s+24/)
 
@@ -147,7 +161,7 @@ ceedling_system_tests do
         it "should be able to test specific test cases in a file" do
           @c.with_context do
             Dir.chdir "temp_sensor" do
-              @output = `bundle exec ruby -S ceedling --mixin=add_gcov gcov:path[adc] --test-case="RunShouldNot" 2>&1`
+              @output = @c.ceedling_build_exec('gcov:path[adc] --mixin=add_gcov --test-case="RunShouldNot"')
               expect(@output).to match(/TESTED:\s+2/)
               expect(@output).to match(/PASSED:\s+2/)