ceedling 1.0.1 → 1.1.0

data/mkdocs.yml

@@ -0,0 +1,202 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+# Site metadata
+site_name: Ceedling
+site_description: Test-Centered Build System for C
+site_url: https://throwtheswitch.github.io/Ceedling/
+repo_url: https://github.com/ThrowTheSwitch/Ceedling
+repo_name: ThrowTheSwitch/Ceedling
+
+docs_dir: docs/mkdocs/
+
+site_dir: site-web
+
+# Footer copyright notice
+copyright: >-
+  © 2010-2026 M. Karlesky, M. VanderVoord, and G. Williams —
+  Documentation license: 
+  <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en">CC BY-SA 4.0</a>
+
+# Material theme configuration
+theme:
+  name: material
+  favicon: assets/images/favicon.png
+  palette:
+    - scheme: default
+      primary: green
+      accent: deep_purple
+  features:
+    - navigation.tabs        # Top-level nav rendered as tabs
+    - navigation.sections    # Sections rendered as groups in left sidebar
+    - navigation.top         # Back-to-top button
+    - navigation.indexes     # Section index pages (first item in section = section landing page)
+    - navigation.path        # Breadcrumb trail below page title
+    - navigation.instant     # Instant navigation with page content swaps (without page reloads)
+    - search.suggest         # Autocomplete suggestions in search
+    - search.highlight       # Highlight search terms on result pages
+    - content.code.copy      # Copy button on code blocks
+    - content.code.annotate  # Inline annotation support in code blocks
+
+# Extra site configuration
+extra:
+  generator: false  # Suppress "Made with Material for MkDocs" footer text
+  version:
+    provider: mike  # Versioned documentation deployment via mike
+    default: latest
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/sponsors/ThrowTheSwitch
+      name: Sponsor ThrowTheSwitch on GitHub
+
+extra_css:
+  - assets/stylesheets/styling.css      # Custom style tweaks
+  - assets/stylesheets/admonitions.css  # Custom admonition types
+
+# Plugins
+plugins:
+  - search  # Full-text search index
+  - mike:   # Versioned documentation deployment to gh-pages
+      alias_type: symlink
+      canonical_version: latest
+
+# Markdown extensions
+markdown_extensions:
+  - toc:
+      toc_depth: 3      # Limits TOC to show headings H1 through H3
+                        # (H2 and H3 in reality since H1 is reserved for page titles)
+  - admonition          # !!! note / tip / warning / etc. callout blocks
+  - md_in_html          # Markdown inside raw HTML elements (required for card grids)
+  - footnotes
+  - pymdownx.emoji:     # Emoji shortcodes (:material-icon:, :fontawesome-icon:, etc.)
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.highlight: # Syntax highlighting for fenced code blocks via Pygments
+      use_pygments: true
+      anchor_linenums: true
+  - pymdownx.superfences:  # Fenced code blocks inside admonitions and other nested elements
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.inlinehilite # Inline code syntax highlighting with `#!lang code` syntax
+
+# Files in docs/mkdocs/ excluded from the generated site.
+exclude_docs: |
+  snapshot.yml
+
+# Site navigation tree
+nav:
+  - Home: index.md
+  - Overview:
+    - overview/index.md
+    - Build System: overview/build-system.md
+    - Tools & Frameworks: overview/tools-and-frameworks.md
+    - Test Environments: overview/test-environments.md
+  - Getting Started:
+    - getting-started/index.md
+    - Quick Start: getting-started/quick-start.md
+    - Installation: getting-started/installation.md
+    - Command Line: getting-started/command-line.md
+    - Example Projects:
+      - getting-started/example-projects/index.md
+      - Temp Sensor: getting-started/example-projects/temp-sensor.md
+      - Wondrous Forest: getting-started/example-projects/wondrous-forest.md
+      - Cipher Quest: getting-started/example-projects/cipher-quest.md
+  - Testing Guide:
+    - testing-guide/index.md
+    - How Does a Test Case Work?: testing-guide/test-cases.md
+    - Commented Sample Test File: testing-guide/test-sample.md
+    - Anatomy of a Test Suite: testing-guide/test-suite-anatomy.md
+    - Conventions & Behaviors: testing-guide/conventions.md
+    - Unity, CMock & CException: testing-guide/frameworks.md
+    - Partials:
+      - testing-guide/partials/index.md
+      - What Is a Partial?: testing-guide/partials/overview.md
+      - Configuration: testing-guide/partials/configuration.md
+      - Walk-Through Example: testing-guide/partials/example.md
+      - Conventions & Terminology: testing-guide/partials/conventions.md
+      - Partial Directive Macros: testing-guide/partials/directives.md
+      - Accessing Static Variables: testing-guide/partials/variables.md
+    - Build Directive Macros: testing-guide/build-directives.md
+  - Configuration:
+    - configuration/index.md
+    - Loading Configuration: configuration/loading.md
+    - Mixins: configuration/mixins.md
+    - Project File Basics: configuration/project-file.md
+    - Parallel Builds: configuration/parallel-builds.md
+    - Environment Variables: configuration/environment-vars.md
+    - Which Ceedling: configuration/which-ceedling.md
+    - Global Collections: configuration/global-collections.md
+    - Configuration Reference:
+      - configuration/reference/index.md
+      - Global Project Settings: configuration/reference/project.md
+      - Mixins: configuration/reference/mixins.md
+      - Test Build Settings: configuration/reference/test-build.md
+      - Release Build Settings: configuration/reference/release-build.md
+      - Search Paths: configuration/reference/paths.md
+      - File Collections: configuration/reference/files.md
+      - Environment Variables: configuration/reference/environment.md
+      - File Extensions: configuration/reference/extension.md
+      - Defines: configuration/reference/defines.md
+      - Compilation & Link Flags: configuration/reference/flags.md
+      - Libraries: configuration/reference/libraries.md
+      - Unity: configuration/reference/unity.md
+      - CMock: configuration/reference/cmock.md
+      - Test Runner: configuration/reference/test-runner.md
+      - CException: configuration/reference/cexception.md
+      - Plugins: configuration/reference/plugins.md
+      - Tools: configuration/reference/tools.md
+  - Plugins:
+    - Overview: plugins/index.md
+    - Test Report — Pretty: plugins/report-tests-pretty-stdout.md
+    - Test Report — IDE: plugins/report-tests-ide-stdout.md
+    - Test Report — GTest-like: plugins/report-tests-gtestlike-stdout.md
+    - Test Report — TeamCity: plugins/report-tests-teamcity-stdout.md
+    - Test Report Log Factory: plugins/report-tests-log-factory.md
+    - Test Report — Raw Output: plugins/report-tests-raw-output-log.md
+    - Build Warnings Log: plugins/report-build-warnings-log.md
+    - GCov (Coverage):
+      - plugins/gcov/index.md
+      - Overview: plugins/gcov/overview.md
+      - Tool Versions: plugins/gcov/tool-versions.md
+      - Set Up & Configuration: plugins/gcov/setup.md
+      - Example Usage: plugins/gcov/examples.md
+      - Reporting Configuration: plugins/gcov/reporting.md
+      - GCovr Configuration: plugins/gcov/gcovr.md
+      - ReportGenerator Configuration: plugins/gcov/reportgenerator.md
+      - Advanced & Troubleshooting: plugins/gcov/troubleshooting.md
+    - Cppcheck (Static Analysis): plugins/cppcheck.md
+    - Valgrind (Memory Analysis): plugins/valgrind.md
+    - Bullseye (Coverage): plugins/bullseye.md
+    - FFF (Fake Functions): plugins/fff.md
+    - Command Hooks: plugins/command-hooks.md
+    - Compile Commands JSON DB: plugins/compile-commands-json-db.md
+    - Beep: plugins/beep.md
+    - Module Generator: plugins/module-generator.md
+    - Dependencies: plugins/dependencies.md
+  - Reference:
+    - reference/index.md
+    - Command Line: reference/command-line.md
+    - Project Configuration: reference/project-configuration.md
+    - Test Build Directives: reference/build-directives.md
+    - Partials Macros: reference/partials-macros.md
+    - Environment Variables: reference/environment-vars.md
+    - Coverage Reporting: reference/gcov-plugin.md
+    - Global Collections: reference/global-collections.md
+  - Releases:
+    - History Documents: project/release-history.md
+    - Upgrading: project/upgrade.md
+  - Help: help.md
+  - Development:
+    - development/index.md
+    - Development Workflow: development/workflow.md
+    - Plugin Development:
+      - development/plugins/index.md
+      - Configuration Plugin: development/plugins/configuration.md
+      - Plugin Subclass: development/plugins/plugin-subclass.md
+      - Rake Task Plugin: development/plugins/rake-tasks.md

data/plugins/beep/config/defaults.yml

@@ -1,7 +1,7 @@
 # =========================================================================
 #   Ceedling - Test-Centered Build System for C
 #   ThrowTheSwitch.org
-#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 

data/plugins/beep/config/defaults_beep.rb

@@ -1,7 +1,7 @@
 # =========================================================================
 #   Ceedling - Test-Centered Build System for C
 #   ThrowTheSwitch.org
-#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 

data/plugins/beep/lib/beep.rb

@@ -1,11 +1,11 @@
 # =========================================================================
 #   Ceedling - Test-Centered Build System for C
 #   ThrowTheSwitch.org
-#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 
-require 'ceedling/plugin'
+require 'ceedling/plugins/plugin'
 require 'ceedling/exceptions'
 
 BEEP_ROOT_NAME = 'beep'.freeze
@@ -55,10 +55,11 @@ class Beep < Plugin
     ) if tools[:on_error] != :bell
   end
 
-  # `Plugin` build step hook  
-  def post_build
+  # `Plugin` build step hook
+  def post_build(_timestamp_s)
     command = @ceedling[:tool_executor].build_command_line(
       @tools[:beep_on_done],
+      # No additional arguments
       [],
       # Only used by tools with `${1}` replacement argument
       'ceedling build done'
@@ -70,9 +71,10 @@ class Beep < Plugin
   end
   
   # `Plugin` build step hook
-  def post_error
+  def post_error(_timestamp_s)
     command = @ceedling[:tool_executor].build_command_line(
       @tools[:beep_on_error],
+      # No additional arguments
       [],
       # Only used by tools with `${1}` replacement argument
       'ceedling build error'

data/plugins/bullseye/assets/template.erb

@@ -1,7 +1,7 @@
 % function_string = hash[:coverage][:functions].to_s
 % branch_string   = hash[:coverage][:branches].to_s
 % format_string   = "%#{[function_string.length, branch_string.length].max}i"
-<%=@ceedling[:plugin_reportinator].generate_banner("#{hash[:header]}: CODE COVERAGE SUMMARY")%>
+<%=@ceedling[:plugin_reportinator].generate_banner("#{hash[:context].to_s.upcase}: CODE COVERAGE SUMMARY")%>
 % if (!hash[:coverage][:functions].nil?)
 FUNCTIONS: <%=sprintf(format_string, hash[:coverage][:functions])%>%
 % else

data/plugins/bullseye/bullseye.rake

@@ -1,7 +1,7 @@
 # =========================================================================
 #   Ceedling - Test-Centered Build System for C
 #   ThrowTheSwitch.org
-#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 

data/plugins/bullseye/config/defaults.yml

@@ -1,7 +1,7 @@
 # =========================================================================
 #   Ceedling - Test-Centered Build System for C
 #   ThrowTheSwitch.org
-#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 

data/plugins/bullseye/lib/bullseye.rb

@@ -1,11 +1,11 @@
 # =========================================================================
 #   Ceedling - Test-Centered Build System for C
 #   ThrowTheSwitch.org
-#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 
-require 'ceedling/plugin'
+require 'ceedling/plugins/plugin'
 require 'ceedling/constants'
 require 'ceedling/exceptions'
 
@@ -71,13 +71,13 @@ class Bullseye < Plugin
     end
   end
 
-  def post_build
-    return if (not @ceedling[:task_invoker].invoked?(/^#{BULLSEYE_TASK_ROOT}/))
+  def post_build(_timestamp_s)
+    return if (not @ceedling[:rake_invocation_tracker].invoked?(/^#{BULLSEYE_TASK_ROOT}/))
 
     # test results
     results = @ceedling[:plugin_reportinator].assemble_test_results(@result_list)
     hash = {
-      :header => BULLSEYE_ROOT_NAME.upcase,
+      :context => BULLSEYE_ROOT_NAME.upcase,
       :results => results
     }
     
@@ -89,7 +89,7 @@ class Bullseye < Plugin
     
     # coverage results
     return if (verify_coverage_file() == false)
-    if (@ceedling[:task_invoker].invoked?(/^#{BULLSEYE_TASK_ROOT}(all|delta)/))
+    if (@ceedling[:rake_invocation_tracker].invoked?(/^#{BULLSEYE_TASK_ROOT}(all|delta)/))
       command      = @ceedling[:tool_executor].build_command_line(TOOLS_BULLSEYE_REPORT_COVSRC, [])
       shell_result = @ceedling[:tool_executor].exec( command )
       report_coverage_results_all(shell_result[:output])
@@ -105,7 +105,7 @@ class Bullseye < Plugin
     # test results
     # get test results for only those tests in our configuration and of those only tests with results on disk
     hash = {
-      :header => BULLSEYE_ROOT_NAME.upcase,
+      :context => BULLSEYE_SYM,
       :results => @ceedling[:plugin_reportinator].assemble_test_results(result_list, {:boom => false})
     }
 
@@ -139,7 +139,7 @@ class Bullseye < Plugin
 
   def report_coverage_results_all(coverage)
     results = {
-      :header => BULLSEYE_ROOT_NAME.upcase,
+      :context => BULLSEYE_SYM,
       :coverage => {
         :functions => nil,
         :branches  => nil
@@ -197,7 +197,7 @@ end
 # end blocks always executed following rake run
 END {
   # cache our input configurations to use in comparison upon next execution
-  if (@ceedling[:task_invoker].invoked?(/^#{BULLSEYE_TASK_ROOT}/))
+  if (@ceedling[:rake_invocation_tracker].invoked?(/^#{BULLSEYE_TASK_ROOT}/))
     @ceedling[BULLSEYE_SYM].enableBullseye(false)
   end
 }

data/plugins/command_hooks/lib/command_hooks.rb

@@ -1,13 +1,13 @@
 # =========================================================================
 #   Ceedling - Test-Centered Build System for C
 #   ThrowTheSwitch.org
-#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 
 require 'ceedling/constants'
 require 'ceedling/exceptions'
-require 'ceedling/plugin'
+require 'ceedling/plugins/plugin'
 
 COMMAND_HOOKS_ROOT_NAME = 'command_hooks'.freeze
 COMMAND_HOOKS_SYM       = COMMAND_HOOKS_ROOT_NAME.to_sym
@@ -29,8 +29,10 @@ COMMAND_HOOKS_LIST = [
   :post_test_fixture_execute,
   :pre_test,
   :post_test,
-  :pre_release,
-  :post_release,
+  :pre_test_build,
+  :post_test_build,
+  :pre_release_build,
+  :post_release_build,
   :pre_build,
   :post_build,
   :post_error,
@@ -79,27 +81,29 @@ class CommandHooks < Plugin
     end
   end
 
-  def pre_mock_preprocess(arg_hash);       run_hook( :pre_mock_preprocess,       arg_hash[:header_file] ); end
-  def post_mock_preprocess(arg_hash);      run_hook( :post_mock_preprocess,      arg_hash[:header_file] ); end
-  def pre_test_preprocess(arg_hash);       run_hook( :pre_test_preprocess,       arg_hash[:test_file]   ); end
-  def post_test_preprocess(arg_hash);      run_hook( :post_test_preprocess,      arg_hash[:test_file]   ); end
-  def pre_mock_generate(arg_hash);         run_hook( :pre_mock_generate,         arg_hash[:header_file] ); end
-  def post_mock_generate(arg_hash);        run_hook( :post_mock_generate,        arg_hash[:header_file] ); end
-  def pre_runner_generate(arg_hash);       run_hook( :pre_runner_generate,       arg_hash[:source]      ); end
-  def post_runner_generate(arg_hash);      run_hook( :post_runner_generate,      arg_hash[:runner_file] ); end
-  def pre_compile_execute(arg_hash);       run_hook( :pre_compile_execute,       arg_hash[:source_file] ); end
-  def post_compile_execute(arg_hash);      run_hook( :post_compile_execute,      arg_hash[:object_file] ); end
-  def pre_link_execute(arg_hash);          run_hook( :pre_link_execute,          arg_hash[:executable]  ); end
-  def post_link_execute(arg_hash);         run_hook( :post_link_execute,         arg_hash[:executable]  ); end
-  def pre_test_fixture_execute(arg_hash);  run_hook( :pre_test_fixture_execute,  arg_hash[:executable]  ); end
-  def post_test_fixture_execute(arg_hash); run_hook( :post_test_fixture_execute, arg_hash[:executable]  ); end
-  def pre_test(test);                      run_hook( :pre_test,                  test                   ); end
-  def post_test(test);                     run_hook( :post_test,                 test                   ); end
-  def pre_release;                         run_hook( :pre_release                                       ); end
-  def post_release;                        run_hook( :post_release                                      ); end
-  def pre_build;                           run_hook( :pre_build                                         ); end
-  def post_build;                          run_hook( :post_build                                        ); end
-  def post_error;                          run_hook( :post_error                                        ); end
+  def pre_mock_preprocess(arg_hash);           run_hook( :pre_mock_preprocess,       arg_hash[:header_file] ); end
+  def post_mock_preprocess(arg_hash);          run_hook( :post_mock_preprocess,      arg_hash[:header_file] ); end
+  def pre_test_preprocess(arg_hash);           run_hook( :pre_test_preprocess,       arg_hash[:test_file]   ); end
+  def post_test_preprocess(arg_hash);          run_hook( :post_test_preprocess,      arg_hash[:test_file]   ); end
+  def pre_mock_generate(arg_hash);             run_hook( :pre_mock_generate,         arg_hash[:header_file] ); end
+  def post_mock_generate(arg_hash);            run_hook( :post_mock_generate,        arg_hash[:header_file] ); end
+  def pre_runner_generate(arg_hash);           run_hook( :pre_runner_generate,       arg_hash[:source]      ); end
+  def post_runner_generate(arg_hash);          run_hook( :post_runner_generate,      arg_hash[:runner_file] ); end
+  def pre_compile_execute(arg_hash);           run_hook( :pre_compile_execute,       arg_hash[:source_file] ); end
+  def post_compile_execute(arg_hash);          run_hook( :post_compile_execute,      arg_hash[:object_file] ); end
+  def pre_link_execute(arg_hash);              run_hook( :pre_link_execute,          arg_hash[:executable]  ); end
+  def post_link_execute(arg_hash);             run_hook( :post_link_execute,         arg_hash[:executable]  ); end
+  def pre_test_fixture_execute(arg_hash);      run_hook( :pre_test_fixture_execute,  arg_hash[:executable]  ); end
+  def post_test_fixture_execute(arg_hash);     run_hook( :post_test_fixture_execute, arg_hash[:executable]  ); end
+  def pre_test(test);                          run_hook( :pre_test,                  test ); end
+  def post_test(test);                         run_hook( :post_test,                 test ); end
+  def pre_test_build(context, timestamp_s);    run_hook( :pre_test_build,            context.to_s, timestamp_s.to_s ); end
+  def post_test_build(context, timestamp_s);   run_hook( :post_test_build,           context.to_s, timestamp_s.to_s ); end
+  def pre_release_build(timestamp_s);          run_hook( :pre_release_build,         timestamp_s.to_s ); end
+  def post_release_build(timestamp_s);         run_hook( :post_release_build,        timestamp_s.to_s ); end
+  def pre_build(timestamp_s);                  run_hook( :pre_build,                 timestamp_s.to_s ); end
+  def post_build(timestamp_s);                 run_hook( :post_build,                timestamp_s.to_s ); end
+  def post_error(timestamp_s);                 run_hook( :post_error,                timestamp_s.to_s ); end
 
   ### Private
 
@@ -167,24 +171,24 @@ class CommandHooks < Plugin
   #
   # :args:
   #   - which_hook: Name of the hook to run
-  #   - name: Name of file
+  #   - args: Zero or more substitution values available as ${1}, ${2}, ... in tool argument lists
   #
-  def run_hook(which_hook, name="")
+  def run_hook(which_hook, *args)
     if (@config[which_hook])
       msg = "Running Command Hook :#{which_hook}"
       msg = @reportinator.generate_progress( msg )
       @loginator.log( msg )
-      
+
       # Single tool config
       if (@config[which_hook].is_a? Hash)
-        run_hook_step( which_hook, @config[which_hook], name )
-      
+        run_hook_step( which_hook, @config[which_hook], *args )
+
       # Multiple tool configs
       elsif (@config[which_hook].is_a? Array)
         @config[which_hook].each do |hook|
-          run_hook_step( which_hook, hook, name )
+          run_hook_step( which_hook, hook, *args )
         end
-      
+
       # Tool config is bad
       else
         msg = "The tool config for Command Hook #{which_hook} was poorly formed and not run"
@@ -194,19 +198,20 @@ class CommandHooks < Plugin
   end
 
   ##
-  # Run a hook if its available.
+  # Run a hook step (single tool execution).
   #
   # :args:
-  #   - hook: Name of the hook to run
-  #   - name: Name of file (default: "")
+  #   - which_hook: Name of the hook to run
+  #   - hook: Tool configuration hash for this step
+  #   - args: Zero or more substitution values available as ${1}, ${2}, ... in tool argument lists
   #
   # :return:
   #    shell_result.
   #
-  def run_hook_step(which_hook, hook, name="")
+  def run_hook_step(which_hook, hook, *args)
     if (hook[:executable])
-      # Handle argument replacemant ({$1}), and get commandline
-      cmd = @ceedling[:tool_executor].build_command_line( hook, [], name )
+      # Handle argument replacement (${1}, ${2}, ...) and get commandline
+      cmd = @ceedling[:tool_executor].build_command_line( hook, [], *args )
       shell_result = @ceedling[:tool_executor].exec( cmd )
 
       # If hook logging is enabled

data/plugins/compile_commands_json_db/lib/compile_commands_json_db.rb

@@ -1,11 +1,11 @@
 # =========================================================================
 #   Ceedling - Test-Centered Build System for C
 #   ThrowTheSwitch.org
-#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 
-require 'ceedling/plugin'
+require 'ceedling/plugins/plugin'
 require 'ceedling/constants'
 require 'json'
 

data/plugins/cppcheck/AUTHORS.md

@@ -0,0 +1,8 @@
+# Authors
+
+- Alejandro Rosso
+
+## Contributors
+
+- Claudio Barbosa Lima
+- Humberto Marquez

data/plugins/cppcheck/config/defaults.yml

@@ -0,0 +1,44 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+---
+:cppcheck:
+  :reports: []
+  :sarif_artifact_filename: null
+  :text_artifact_filename: null
+  :xml_artifact_filename: null
+  :xml_report_version: 3
+  :template: null
+  :html_title: null
+  :platform: null
+  :standard: null
+  :check_level: null
+  :project: null
+  :inline_suppressions: false
+  :enable_checks:
+    - style
+  :disable_checks: []
+  :addons: []
+  :includes: []
+  :excludes: []
+  :libraries: []
+  :rules: []
+  :suppressions: []
+  :defines: []
+  :undefines:
+    - TEST
+  :options: []
+
+:extension:
+  :cppcheck: .txt
+
+:paths:
+  :cppcheck: []
+
+:files:
+  :cppcheck: []
+...

data/plugins/cppcheck/config/defaults_cppcheck.rb

@@ -0,0 +1,32 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+DEFAULT_CPPCHECK_TOOL = {
+  :executable => (ENV['CPPCHECK'].nil? ? FilePathUtils.os_executable_ext('cppcheck') : ENV['CPPCHECK'].split[0]).freeze,
+  :name => 'default_cppcheck'.freeze,
+  :stderr_redirect => StdErrRedirect::AUTO.freeze,
+  :optional => false.freeze,
+  :arguments => [
+    '-I"${1}"'.freeze,
+    '${2}'.freeze
+  ].freeze
+}
+
+DEFAULT_CPPCHECK_HTMLREPORT_TOOL = {
+  :executable => (ENV['CPPCHECK_HTMLREPORT'].nil? ? FilePathUtils.os_executable_ext('cppcheck-htmlreport') : ENV['CPPCHECK_HTMLREPORT'].split[0]).freeze,
+  :name => 'default_cppcheck_htmlreport'.freeze,
+  :stderr_redirect => StdErrRedirect::NONE.freeze,
+  :optional => true.freeze,
+  :arguments => [].freeze
+}
+
+def get_default_config()
+  return :tools => {
+    :cppcheck => DEFAULT_CPPCHECK_TOOL,
+    :cppcheck_htmlreport => DEFAULT_CPPCHECK_HTMLREPORT_TOOL
+  }
+end

data/plugins/cppcheck/cppcheck.rake

@@ -0,0 +1,54 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+directory(CPPCHECK_BUILD_PATH)
+directory(CPPCHECK_ARTIFACTS_PATH)
+
+CLEAN.include(File.join(CPPCHECK_BUILD_PATH, '*'))
+CLEAN.include(File.join(CPPCHECK_ARTIFACTS_PATH, '*'))
+
+CLOBBER.include(File.join(CPPCHECK_BUILD_PATH, '**/*'))
+
+task :cppcheck_deps => [:directories, CPPCHECK_BUILD_PATH, CPPCHECK_ARTIFACTS_PATH]
+task :cppcheck => ['cppcheck:all']
+
+namespace CPPCHECK_SYM do
+  desc "Run whole project analysis (also just 'cppcheck' works)."
+  task :all => [:cppcheck_deps] do
+    @ceedling[CPPCHECK_SYM].generate_reports()
+  end
+  
+  desc "Run single file analysis ([*] source file name, no path)."
+  task :* do
+    message = "Oops! '#{CPPCHECK_ROOT_NAME}:*' isn't a real task. " +
+              "Use a real source file name (no path) in place of the wildcard.\n" +
+              "Example: `ceedling #{CPPCHECK_ROOT_NAME}:foo.c`"
+
+    @ceedling[:loginator].log(message, Verbosity::ERRORS)
+  end
+end
+
+rule (/^#{CPPCHECK_TASK_ROOT}\S+$/) => [
+  proc do |task_name|
+    name = task_name.sub(/^#{CPPCHECK_TASK_ROOT}/, '')
+    ['cppcheck_deps', @ceedling[:file_finder].find_source_file(name)]
+  end
+] do |task|
+  @ceedling[CPPCHECK_SYM].analyze_file(task.sources[1])
+end
+
+namespace :files do
+  desc 'List all collected Cppcheck suppression files.'
+  task :cppcheck do
+    files_list = COLLECTION_ALL_CPPCHECK
+    puts "Cppcheck suppression files:#{' None' if files_list.size == 0}"
+    if files_list.size > 0
+      files_list.sort.each { |filepath| puts " - #{filepath}" }
+      puts "File count: #{files_list.size}"
+    end
+  end
+end