ceedling 1.1.6 → 1.1.8

data/spec/units/preprocess/preprocessinator_line_marker_includes_extractor_spec.rb

@@ -0,0 +1,64 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'spec_helper'
+require 'ceedling/preprocess/preprocessinator_line_marker_includes_extractor'
+require 'ceedling/includes/includes'
+
+# Regression coverage for GH #1268 only -- this class otherwise has no unit spec on this
+# branch. Built on #extract_includes_from_string, a StringIO wrapper around the same
+# private #extract_includes every production call eventually reaches.
+describe PreprocessinatorLineMarkerIncludesExtractor do
+  before(:each) do
+    @include_factory = double('include_factory')
+
+    allow(@include_factory).to receive(:user_include_from_filepath) do |filepath|
+      UserInclude.new(filepath)
+    end
+    allow(@include_factory).to receive(:system_include_from_filepath) do |filepath|
+      SystemInclude.new(filepath)
+    end
+
+    @extractor = described_class.new(
+      :include_factory => @include_factory
+    )
+  end
+
+  def paths_of(includes)
+    includes.map(&:filepath)
+  end
+
+  describe '#extract_includes_from_string' do
+    # #1268: GCC's -fdirectives-only output preserves the ORIGINAL indentation of a
+    # top-level #include when it replaces that directive with a line marker entering
+    # the included file -- an indented `    #include "widget.h"` produces an indented
+    # `    # 1 "widget.h" 1`, not the flush-left marker every other marker GCC
+    # generates uses. LINE_MARKER_REGEX must recognize that marker too, or the include
+    # is silently missing from the extracted list entirely.
+    it 'recognizes a line marker that is itself indented (e.g. from an indented #include)' do
+      content = <<~OUTPUT
+        # 1 "test.c"
+            # 1 "widget.h" 1
+      OUTPUT
+
+      includes = @extractor.extract_includes_from_string( content, 'test.c', described_class::USER )
+
+      expect( paths_of(includes) ).to eq( ['widget.h'] )
+    end
+
+    it 'still recognizes an ordinary, flush-left line marker' do
+      content = <<~OUTPUT
+        # 1 "test.c"
+        # 1 "widget.h" 1
+      OUTPUT
+
+      includes = @extractor.extract_includes_from_string( content, 'test.c', described_class::USER )
+
+      expect( paths_of(includes) ).to eq( ['widget.h'] )
+    end
+  end
+end

data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb

@@ -211,6 +211,41 @@ describe PreprocessinatorReconstructor do
       expect( @extractor.extract_file_as_array_from_expansion(input, filepath) ).to eq expected
     end
   
+    # #1268: GCC's -fdirectives-only output preserves the ORIGINAL indentation of a
+    # top-level #include when it replaces that directive with a line marker entering
+    # the included file -- e.g. a source line "    #include \"Module3.h\"" produces
+    # "    # 1 \"Module3.h\" 1", not the flush-left "# 1 ..." this method's marker
+    # regexes assumed every marker would be. An unrecognized entering-marker leaves
+    # `extract` stuck at whatever it already was instead of turning off, so the
+    # marker line itself (and everything up to the NEXT recognized marker, e.g. one
+    # from a nested system include triggered from inside the ignored file) leaks into
+    # the extracted output before the ping-pong finally self-corrects.
+    it "does not leak file content when the marker entering an included file is itself indented" do
+      filepath = "dir/our_file.c"
+
+      file_contents = [
+        '# 1 "dir/our_file.c"',
+        'void wanted_before(void);',
+        '    # 1 "dir/included.h" 1',        # indented entering-marker (leading whitespace from source)
+        'int leaked_from_included_h;',
+        '# 1 "/usr/include/nested.h" 1 3 4',  # a normal, flush-left marker from within included.h
+        'int also_should_not_leak;',
+        '# 2 "dir/included.h" 2',             # returning from nested.h back into included.h (still not our file)
+        'int still_should_not_leak;',
+        '# 3 "dir/our_file.c" 2',             # returning to our file
+        'void wanted_after(void);',
+      ]
+
+      expected = [
+        'void wanted_before(void);',
+        'void wanted_after(void);',
+      ]
+
+      input = StringIO.new( file_contents.join( "\n" ) )
+
+      expect( @extractor.extract_file_as_array_from_expansion( input, filepath ) ).to eq expected
+    end
+
     it "should extract text of original file from preprocessed expansion ignoring embedded expansions having similar names" do
       filepath = "dir1/dir2/our_file.c"
       
@@ -798,6 +833,45 @@ describe PreprocessinatorReconstructor do
       expect( @extractor.extract_macro_defs( file_text, '_INCLUDE_GUARD_' ) ).to eq expected
     end
 
+    # #1266: a plain substring test against the include guard rejected any macro whose
+    # name OR value merely contained the guard string, not only the guard macro itself.
+    # RTC_HOUR_SECONDS' own name contains the guard "RTC_H", and RTC_DAY_SECONDS'
+    # *value* references RTC_HOUR_SECONDS, so its captured text also contains "RTC_H" --
+    # both were silently dropped from the reconstructed header, breaking compilation.
+    it "does not reject an ordinary macro whose name or value merely contains the include guard as a substring (GH #1266)" do
+      file_text = <<~FILE_TEXT
+        #ifndef RTC_H
+        #define RTC_H
+
+        #define RTC_MINUTE_SECONDS 60u
+        #define RTC_HOUR_SECONDS (60u * RTC_MINUTE_SECONDS)
+        #define RTC_DAY_SECONDS (24u * RTC_HOUR_SECONDS)
+
+        #endif
+      FILE_TEXT
+
+      expected = [
+        "#define RTC_MINUTE_SECONDS 60u",
+        "#define RTC_HOUR_SECONDS (60u * RTC_MINUTE_SECONDS)",
+        "#define RTC_DAY_SECONDS (24u * RTC_HOUR_SECONDS)"
+      ]
+
+      expect( @extractor.extract_macro_defs( file_text, 'RTC_H' ) ).to eq expected
+    end
+
+    it "still rejects the include guard when it appears with trailing whitespace instead of a value" do
+      file_text = <<~FILE_TEXT
+        #ifndef RTC_H
+        #define RTC_H
+
+        #define RTC_MINUTE_SECONDS 60u
+      FILE_TEXT
+
+      expected = [ "#define RTC_MINUTE_SECONDS 60u" ]
+
+      expect( @extractor.extract_macro_defs( file_text, 'RTC_H' ) ).to eq expected
+    end
+
   end
 
   context "#compact_file_from_expansion" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ceedling
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.8
 platform: ruby
 authors:
 - Mark VanderVoord
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-25 00:00:00.000000000 Z
+date: 2026-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -996,6 +996,7 @@ files:
 - spec/units/partials/partializer_spec.rb
 - spec/units/partials/partializer_utils_spec.rb
 - spec/units/plugin_manager_spec.rb
+- spec/units/plugin_reportinator_spec.rb
 - spec/units/plugins/cppcheck_spec.rb
 - spec/units/preprocess/c_comment_scanner_spec.rb
 - spec/units/preprocess/c_preprocessor_conditionals_spec.rb
@@ -1003,6 +1004,7 @@ files:
 - spec/units/preprocess/preprocessinator_comment_stripper_spec.rb
 - spec/units/preprocess/preprocessinator_file_assembler_spec.rb
 - spec/units/preprocess/preprocessinator_includes_handler_spec.rb
+- spec/units/preprocess/preprocessinator_line_marker_includes_extractor_spec.rb
 - spec/units/preprocess/preprocessinator_reconstructor_spec.rb
 - spec/units/preprocess/preprocessinator_spec.rb
 - spec/units/reportinator_spec.rb
@@ -1847,6 +1849,7 @@ test_files:
 - spec/units/partials/partializer_spec.rb
 - spec/units/partials/partializer_utils_spec.rb
 - spec/units/plugin_manager_spec.rb
+- spec/units/plugin_reportinator_spec.rb
 - spec/units/plugins/cppcheck_spec.rb
 - spec/units/preprocess/c_comment_scanner_spec.rb
 - spec/units/preprocess/c_preprocessor_conditionals_spec.rb
@@ -1854,6 +1857,7 @@ test_files:
 - spec/units/preprocess/preprocessinator_comment_stripper_spec.rb
 - spec/units/preprocess/preprocessinator_file_assembler_spec.rb
 - spec/units/preprocess/preprocessinator_includes_handler_spec.rb
+- spec/units/preprocess/preprocessinator_line_marker_includes_extractor_spec.rb
 - spec/units/preprocess/preprocessinator_reconstructor_spec.rb
 - spec/units/preprocess/preprocessinator_spec.rb
 - spec/units/reportinator_spec.rb