211 lines
15 KiB
HTML
211 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
<title>DBC Framework: Changelog</title>
|
||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
<script type="text/javascript" src="jquery.js"></script>
|
||
<script type="text/javascript" src="dynsections.js"></script>
|
||
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
<script type="text/javascript" src="resize.js"></script>
|
||
<script type="text/javascript" src="navtreedata.js"></script>
|
||
<script type="text/javascript" src="navtree.js"></script>
|
||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||
<script type="text/javascript" src="search/search.js"></script>
|
||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
</head>
|
||
<body>
|
||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
<div id="titlearea">
|
||
<table cellspacing="0" cellpadding="0">
|
||
<tbody>
|
||
<tr id="projectrow">
|
||
<td id="projectalign">
|
||
<div id="projectname">DBC Framework
|
||
</div>
|
||
<div id="projectbrief">DBC parsing and CAN signal decoding framework</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<!-- end header part -->
|
||
<!-- Generated by Doxygen 1.9.8 -->
|
||
<script type="text/javascript">
|
||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
/* @license-end */
|
||
</script>
|
||
<script type="text/javascript" src="menudata.js"></script>
|
||
<script type="text/javascript" src="menu.js"></script>
|
||
<script type="text/javascript">
|
||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
$(function() {
|
||
initMenu('',true,false,'search.php','Search');
|
||
$(document).ready(function() { init_search(); });
|
||
});
|
||
/* @license-end */
|
||
</script>
|
||
<div id="main-nav"></div>
|
||
</div><!-- top -->
|
||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||
<div id="nav-tree">
|
||
<div id="nav-tree-contents">
|
||
<div id="nav-sync" class="sync"></div>
|
||
</div>
|
||
</div>
|
||
<div id="splitbar" style="-moz-user-select:none;"
|
||
class="ui-resizable-handle">
|
||
</div>
|
||
</div>
|
||
<script type="text/javascript">
|
||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
$(document).ready(function(){initNavTree('md_changelog.html',''); initResizable(); });
|
||
/* @license-end */
|
||
</script>
|
||
<div id="doc-content">
|
||
<!-- window showing the filter options -->
|
||
<div id="MSearchSelectWindow"
|
||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
</div>
|
||
|
||
<!-- iframe showing the search results (closed by default) -->
|
||
<div id="MSearchResultsWindow">
|
||
<div id="MSearchResults">
|
||
<div class="SRPage">
|
||
<div id="SRIndex">
|
||
<div id="SRResults"></div>
|
||
<div class="SRStatus" id="Loading">Loading...</div>
|
||
<div class="SRStatus" id="Searching">Searching...</div>
|
||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div><div class="header">
|
||
<div class="headertitle"><div class="title">Changelog</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<div class="textblock"><p><a class="anchor" id="autotoc_md0"></a> This changelog summarizes release and development history. Entries are listed newest first. Historical dates follow the commit author dates. <code>v1.0</code> is the existing Git tag; subsequent changes are listed as unreleased.</p>
|
||
<h1><a class="anchor" id="autotoc_md1"></a>
|
||
Unreleased</h1>
|
||
<h2><a class="anchor" id="autotoc_md2"></a>
|
||
2026-10-07</h2>
|
||
<h3><a class="anchor" id="autotoc_md3"></a>
|
||
Added</h3>
|
||
<ul>
|
||
<li>Added regression coverage for signed bit-length boundaries, deterministic Intel/Motorola extraction, lookup failures, runtime validation, PGN, comments, file formatting, metadata copying/lifetime, and <a class="el" href="classTypeFactory.html" title="Registry-based factory for creating objects by runtime identifier.">TypeFactory</a> behavior.</li>
|
||
<li>Added direct-handler and resolver tests for unsupported comments and ambiguous <code>VAL_</code> references in manually constructed databases.</li>
|
||
<li>Documented GCC/gcov/LCOV instrumentation, Qt Creator setup, and HTML reports. Coverage after the added tests: 98.4% of lines and 71.4% of branches with GCC 14.2 and Qt 6.8.2, including the standalone tree test.</li>
|
||
<li>Added a reusable post-build coverage report script and step-by-step Qt Creator configurations for model tests, strict warning checks, coverage, core-only, standalone tree tests, and the demo. Machine-specific <code>.user</code> settings stay outside version control.</li>
|
||
<li>Basic <code>M</code> / <code>mN</code> multiplexing metadata in parsed, tree, and runtime definitions.</li>
|
||
<li>Deferred selector and overlap validation with source locations: one unsigned selector, representable branch values, and overlaps only between exclusive branches.</li>
|
||
<li>Selector-first decoding using exact raw values, preserving definition order and unconditional signals. Explicit statuses distinguish inactive branches, missing selector data, insufficient payloads, and malformed runtime metadata.</li>
|
||
<li>Registered <code>SG_MUL_VAL_</code> rejection through <a class="el" href="classTypeFactory.html" title="Registry-based factory for creating objects by runtime identifier.">TypeFactory</a>; extended and nested multiplexing remain unsupported. Added parser/decoder regression coverage and documented supported syntax and consumer behavior.</li>
|
||
</ul>
|
||
<h3><a class="anchor" id="autotoc_md4"></a>
|
||
Changed</h3>
|
||
<ul>
|
||
<li>Qt-dependent targets now require the installed Qt 6.8.2 through a shared qmake version check; removed Qt 5 compatibility instructions. Core remains Qt-free.</li>
|
||
<li>Used explicit local types in the additional coverage and model tests. Functions retain explicit return types, and runtime handler selection uses <a class="el" href="classTypeFactory.html" title="Registry-based factory for creating objects by runtime identifier.">TypeFactory</a> without lambdas or extra factory layers for concrete objects.</li>
|
||
<li>Coverage documentation now describes the selected open GCC/LCOV toolchain.</li>
|
||
<li>Overlapping unconditional signals are now rejected during parsing.</li>
|
||
</ul>
|
||
<h3><a class="anchor" id="autotoc_md5"></a>
|
||
Fixed</h3>
|
||
<ul>
|
||
<li>Linked QtGui only in the optional model tests and used QGuiApplication with an offscreen default, resolving the QAbstractItemModelTester invalid QPixmap metatype warning without adding QtGui to the adapter library.</li>
|
||
<li>Accepted tabs after <code>CM_</code> by using the comment parser's keyword extraction instead of requiring a literal-space prefix.</li>
|
||
<li>Removed test compiler warnings by using <code>QVERIFY_THROWS_EXCEPTION</code> and explicitly discarding <code>nodiscard</code> return values in exception checks.</li>
|
||
<li>Reject duplicate frames by normalized CAN ID and frame type, including equivalent extended ID encodings, and duplicate signal names within a frame. Errors report the file path and line of the repeated definition. Standard and extended frames may share a numeric ID; separate frames may reuse signal names. Added regression coverage and updated parser documentation.</li>
|
||
</ul>
|
||
<h2><a class="anchor" id="autotoc_md6"></a>
|
||
2026-10-06</h2>
|
||
<h3><a class="anchor" id="autotoc_md7"></a>
|
||
Added</h3>
|
||
<ul>
|
||
<li>Added non-owning <a class="el" href="classTreeNode.html" title="Tree node for later use in model/view or other hierarchy consumers.">TreeNode</a> parent navigation and stable sibling positions; disabled node moves to preserve links while retaining unique_ptr ownership.</li>
|
||
<li>Added optional read-only Qt Core <a class="el" href="classDbcTreeModel.html">DbcTreeModel</a> with documented columns and metadata roles, exact VAL_ entries, exclusive tree ownership, and reset-based reload/clear support. Core remains independent of Qt.</li>
|
||
<li>Added QAbstractItemModelTester coverage, navigation/metadata/reset tests, a standalone Qt-free tree test, and adapter build and usage documentation.</li>
|
||
<li>Added <code>VAL_</code> signal value descriptions through the statement dispatcher and factory, with complete syntax validation, exact signed/unsigned 64-bit keys, deferred reference resolution, duplicate detection, and source error locations. Distinct keys from multiple statements merge; standard and extended frames remain distinct under existing CAN ID normalization.</li>
|
||
<li>Preserved descriptions in parsed metadata, runtime decode definitions, and UI tree metadata. Added <code><a class="el" href="structDecodedSignalValue.html#affc38af1bf31bcb6f2c33044bce92bd2">DecodedSignalValue::GetValueDescription()</a></code> and <code>FindValueDescription()</code> for raw integer lookup before physical scaling. Unknown values retain normal numeric decoding.</li>
|
||
<li>Added regression coverage for syntax, quoting, whitespace, integer boundaries, declaration order, invalid references, duplicates, scaling, and both builders; documented syntax, lookup behavior, and limitations in README.</li>
|
||
</ul>
|
||
<h2><a class="anchor" id="autotoc_md8"></a>
|
||
2026-10-05</h2>
|
||
<h3><a class="anchor" id="autotoc_md9"></a>
|
||
Changed</h3>
|
||
<ul>
|
||
<li>Split the qmake project into a reusable static library in <code>core/</code>, a demo in <code>examples/</code>, and a combined regression test executable in <code>tests/</code>. Added shared <code>.pri</code> files and updated build instructions. (<code>f17ddb6</code>, #11)</li>
|
||
<li>Added <code>.clang-format</code> and applied consistent formatting to the source code and tests. (<code>b91cf4a</code>, #7)</li>
|
||
<li>Replaced lambdas with explicit functions and simpler code in statement handlers, the decoder, the demo, and regression tests. (<code>03dc8f2</code>)</li>
|
||
</ul>
|
||
<h3><a class="anchor" id="autotoc_md10"></a>
|
||
Fixed</h3>
|
||
<ul>
|
||
<li>Added complete validation of <code>SG_</code> signal statements, including syntax, receivers, numeric fields, lengths of 1–64 bits, physical ranges, and signal bounds within the declared frame payload for Intel and Motorola bit order. Invalid definitions report the file path and line number. <a class="el" href="structMultiplexing.html">Multiplexing</a> markers are explicitly rejected. Added regression tests and documentation. (<code>8d82b13</code>, #6)</li>
|
||
</ul>
|
||
<h3><a class="anchor" id="autotoc_md11"></a>
|
||
Documentation and maintenance</h3>
|
||
<ul>
|
||
<li>Regenerated Doxygen documentation after code changes and the project restructuring. (<code>6cd9976</code>, <code>0067cb4</code>, <code>f17ddb6</code>)</li>
|
||
<li>Removed the temporary signal-validation issue document. (<code>1163277</code>)</li>
|
||
</ul>
|
||
<h2><a class="anchor" id="autotoc_md12"></a>
|
||
2026-10-01</h2>
|
||
<h3><a class="anchor" id="autotoc_md13"></a>
|
||
Changed</h3>
|
||
<ul>
|
||
<li>Moved DBC statement parsing into <code><a class="el" href="classTypeFactory.html" title="Registry-based factory for creating objects by runtime identifier.">TypeFactory</a></code>-registered handlers for <code>BO_</code>, <code>SG_</code>, and <code>CM_</code>, with a shared parse context and keyword dispatcher. Added tests for dispatch and handler replacement, and documented how to register additional handlers. (<code>88b5883</code>, #4)</li>
|
||
<li><b>API change:</b> <code><a class="el" href="structDecodedSignalValue.html#a503c90b4b1a610b8252c45e466367c28">DecodedSignalValue::rawValue</a></code> now uses <code>std::variant<std::int64_t, std::uint64_t></code> instead of <code>int64_t</code>. Consumers must handle the appropriate variant alternative. Physical values remain <code>double</code> and may lose precision for large integers. (<code>69074e3</code>, #2)</li>
|
||
</ul>
|
||
<h3><a class="anchor" id="autotoc_md14"></a>
|
||
Fixed</h3>
|
||
<ul>
|
||
<li>Corrected Motorola signal extraction within bytes and across byte boundaries using DBC sawtooth bit numbering. Added decoder regression tests and build instructions; introduced the <code><a class="el" href="classTypeFactory.html" title="Registry-based factory for creating objects by runtime identifier.">TypeFactory</a></code> utility. (<code>2c057b6</code>)</li>
|
||
<li>Preserved the full unsigned 64-bit raw-value range, including values above <code>INT64_MAX</code>, and updated physical conversion and demo output. Added tests for signed and unsigned boundaries and numeric output. (<code>69074e3</code>, #2)</li>
|
||
<li>Validated <code>BO_</code> frame syntax, CAN identifiers, payload lengths, numeric overflow, and unexpected trailing fields. Parsing errors now include the file path and physical line number. Added parser regression tests. (<code>3bd9339</code>, #3)</li>
|
||
</ul>
|
||
<h1><a class="anchor" id="autotoc_md15"></a>
|
||
v1.0 — 2026-06-14</h1>
|
||
<p>Tag <code>v1.0</code> points to <code>38ce043</code> and includes the initial implementation below.</p>
|
||
<h2><a class="anchor" id="autotoc_md16"></a>
|
||
Documentation</h2>
|
||
<ul>
|
||
<li>Added source-file headers with author information and MIT license references. (<code>e2ffa97</code>)</li>
|
||
<li>Added and subsequently simplified the Doxygen configuration. (<code>e2c07dd</code>, <code>4c8af9f</code>)</li>
|
||
<li>Generated API documentation and refreshed the generated documentation. (<code>dfec39d</code>, <code>38ce043</code>)</li>
|
||
</ul>
|
||
<h2><a class="anchor" id="autotoc_md17"></a>
|
||
Initial implementation — 2026-03-13</h2>
|
||
<h3><a class="anchor" id="autotoc_md18"></a>
|
||
Added</h3>
|
||
<ul>
|
||
<li>Initialized the repository with a README and MIT license. (<code>4270459</code>)</li>
|
||
<li>Added the DBC parser, frame and signal metadata, a tree representation and builder, a demonstration program, and a qmake project. (<code>2a90b2d</code>)</li>
|
||
<li>Added runtime decoding through <code><a class="el" href="classDbcDecodeBuilder.html" title="Converts parsed DBC data into runtime decode database.">DbcDecodeBuilder</a></code>, <code><a class="el" href="structDecodeDatabase.html" title="Runtime decode database with fast lookup by CAN ID.">DecodeDatabase</a></code>, and <code><a class="el" href="classDbcDecoder.html" title="Runtime CAN decoder using prebuilt decode database.">DbcDecoder</a></code>, including CAN-frame lookup, Intel and Motorola extraction, signed and unsigned signals, and factor/offset conversion. Updated parser metadata and the demo to support decoding. (<code>a53a5df</code>)</li>
|
||
</ul>
|
||
<h3><a class="anchor" id="autotoc_md19"></a>
|
||
Documentation and maintenance</h3>
|
||
<ul>
|
||
<li>Added <code>.gitignore</code> and expanded the README with architecture, data structures, parsing behavior, decoding examples, and usage documentation. (<code>efc57d6</code>, <code>f2aa10c</code>, <code>cb20f5f</code>, <code>f0e7065</code>) </li>
|
||
</ul>
|
||
</div></div><!-- contents -->
|
||
</div><!-- PageDoc -->
|
||
</div><!-- doc-content -->
|
||
<!-- start footer part -->
|
||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
<ul>
|
||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
||
</ul>
|
||
</div>
|
||
</body>
|
||
</html>
|