<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[259925] trunk/Tools</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/259925">259925</a></dd>
<dt>Author</dt> <dd>ddkilzer@apple.com</dd>
<dt>Date</dt> <dd>2020-04-11 04:28:39 -0700 (Sat, 11 Apr 2020)</dd>
</dl>

<h3>Log Message</h3>
<pre>check-webkit-style should warn about 'decode' functions with missing WARN_UNUSED_RETURN attribute
<https://webkit.org/b/210336>
<rdar://problem/61585835>

Reviewed by Jonathan Bedard.

* Scripts/webkitpy/style/checkers/cpp.py:
(_FunctionState.post_modifiers): Add.  Returns string of text
that appears after the function definition's list of parameters.
This is used to find the WARN_UNUSED_RETURN attribute in
function declarations in header files.
(_FunctionState.has_attribute): Add.  Takes a string (or regex)
and searchs before and after the function definition for the
attribute.
(_FunctionState.has_return_type): Add.  Takes a string (or
regex) and checks the return type of the fuction.
(_FunctionState.is_static): Add.  Returns True for functions
with the 'static' modifier.
(check_function_definition): Add check for decode() functions
with missing WARN_UNUSED_RETURN attribute.
(CppChecker): Add 'security/missing_warn_unused_return' to the
list of enabled style checkers.

* Scripts/webkitpy/style/checkers/cpp_unittest.py:
(CppStyleTestBase.perform_function_definition_check): Add.  This
runs the check_function_definition() function in cpp.py.
(CppStyleTest.test_decode_functions_missing_warn_unused_return): Add.
Tests for the new warning.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsScriptswebkitpystylecheckerscpppy">trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py</a></li>
<li><a href="#trunkToolsScriptswebkitpystylecheckerscpp_unittestpy">trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (259924 => 259925)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog    2020-04-11 09:41:20 UTC (rev 259924)
+++ trunk/Tools/ChangeLog       2020-04-11 11:28:39 UTC (rev 259925)
</span><span class="lines">@@ -1,3 +1,34 @@
</span><ins>+2020-04-11  David Kilzer  <ddkilzer@apple.com>
+
+        check-webkit-style should warn about 'decode' functions with missing WARN_UNUSED_RETURN attribute
+        <https://webkit.org/b/210336>
+        <rdar://problem/61585835>
+
+        Reviewed by Jonathan Bedard.
+
+        * Scripts/webkitpy/style/checkers/cpp.py:
+        (_FunctionState.post_modifiers): Add.  Returns string of text
+        that appears after the function definition's list of parameters.
+        This is used to find the WARN_UNUSED_RETURN attribute in
+        function declarations in header files.
+        (_FunctionState.has_attribute): Add.  Takes a string (or regex)
+        and searchs before and after the function definition for the
+        attribute.
+        (_FunctionState.has_return_type): Add.  Takes a string (or
+        regex) and checks the return type of the fuction.
+        (_FunctionState.is_static): Add.  Returns True for functions
+        with the 'static' modifier.
+        (check_function_definition): Add check for decode() functions
+        with missing WARN_UNUSED_RETURN attribute.
+        (CppChecker): Add 'security/missing_warn_unused_return' to the
+        list of enabled style checkers.
+
+        * Scripts/webkitpy/style/checkers/cpp_unittest.py:
+        (CppStyleTestBase.perform_function_definition_check): Add.  This
+        runs the check_function_definition() function in cpp.py.
+        (CppStyleTest.test_decode_functions_missing_warn_unused_return): Add.
+        Tests for the new warning.
+
</ins><span class="cx"> 2020-04-10  Alex Christensen  <achristensen@webkit.org>
</span><span class="cx"> 
</span><span class="cx">         Add SPI to handle proxy authentication and require secure proxy connections
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpystylecheckerscpppy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py (259924 => 259925)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py       2020-04-11 09:41:20 UTC (rev 259924)
+++ trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py  2020-04-11 11:28:39 UTC (rev 259925)
</span><span class="lines">@@ -591,6 +591,22 @@
</span><span class="cx">         start_modifiers = _rfind_in_lines(r';|\{|\}|((private|public|protected):)|(#.*)', elided, self.parameter_start_position, Position(0, 0))
</span><span class="cx">         return SingleLineView(elided, start_modifiers, self.function_name_start_position).single_line.strip()
</span><span class="cx"> 
</span><ins>+    def post_modifiers(self):
+        """Returns the modifiers after the function declaration such as attributes."""
+        elided = self._clean_lines.elided
+        return SingleLineView(elided, self.parameter_end_position, self.body_start_position).single_line.strip()
+
+    def has_attribute(self, attribute_regex):
+        regex = r'\b{attribute_regex}\b'.format(attribute_regex=attribute_regex)
+        return bool(search(regex, self.modifiers_and_return_type())) or bool(search(regex, self.post_modifiers()))
+
+    def has_return_type(self, return_type_regex):
+        regex = r'\b{return_type_regex}$'.format(return_type_regex=return_type_regex)
+        return bool(search(regex, self.modifiers_and_return_type()))
+
+    def is_static(self):
+        return bool(search(r'\bstatic\b', self.modifiers_and_return_type()))
+
</ins><span class="cx">     def is_virtual(self):
</span><span class="cx">         return bool(search(r'\bvirtual\b', self.modifiers_and_return_type()))
</span><span class="cx"> 
</span><span class="lines">@@ -1796,6 +1812,14 @@
</span><span class="cx">     if line_number != function_state.body_start_position.row:
</span><span class="cx">         return
</span><span class="cx"> 
</span><ins>+    # Check for decode() functions that don't have WARN_UNUSED_RETURN attribute.
+    if function_state.current_function.split('..')[-1].startswith('decode'):
+        if file_extension == 'h' or (function_state.is_static() or function_state.is_declaration):
+            if function_state.has_return_type('(auto|bool)'):
+                if not function_state.has_attribute('WARN_UNUSED_RETURN'):
+                    error(line_number, 'security/missing_warn_unused_return', 5,
+                          'decode() function returning a value is missing WARN_UNUSED_RETURN attribute')
+
</ins><span class="cx">     parameter_list = function_state.parameter_list()
</span><span class="cx">     for parameter in parameter_list:
</span><span class="cx">         # Do checks specific to function declarations and parameter names.
</span><span class="lines">@@ -4265,6 +4289,7 @@
</span><span class="cx">         'runtime/wtf_make_unique',
</span><span class="cx">         'runtime/wtf_move',
</span><span class="cx">         'security/assertion',
</span><ins>+        'security/missing_warn_unused_return',
</ins><span class="cx">         'security/printf',
</span><span class="cx">         'security/temp_file',
</span><span class="cx">         'softlink/framework',
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpystylecheckerscpp_unittestpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py (259924 => 259925)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py      2020-04-11 09:41:20 UTC (rev 259924)
+++ trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py 2020-04-11 11:28:39 UTC (rev 259925)
</span><span class="lines">@@ -314,6 +314,21 @@
</span><span class="cx">         basic_error_rules = ('-', '+build/header_guard')
</span><span class="cx">         return self.perform_lint(code, filename, basic_error_rules)
</span><span class="cx"> 
</span><ins>+    def perform_function_definition_check(self, file_name, lines, expected_warning):
+        file_extension = file_name.split('.')[1]
+        clean_lines = cpp_style.CleansedLines([lines])
+        function_state = cpp_style._FunctionState(5)
+        error_collector = ErrorCollector(self.assertTrue)
+
+        cpp_style.detect_functions(clean_lines, 0, function_state, error_collector)
+        self.assertEqual(function_state.in_a_function, True)
+        self.assertEqual(error_collector.results(), '')
+
+        class_state = cpp_style._ClassState()
+        cpp_style.check_function_definition(file_name, file_extension, clean_lines, 0, class_state, function_state,
+                                            error_collector)
+        self.assertEqual(error_collector.results(), expected_warning)
+
</ins><span class="cx">     # Perform lint and compare the error message with "expected_message".
</span><span class="cx">     def assert_lint(self, code, expected_message, file_name='foo.cpp'):
</span><span class="cx">         self.assertEqual(expected_message, self.perform_single_line_lint(code, file_name))
</span><span class="lines">@@ -2943,7 +2958,84 @@
</span><span class="cx">         self.assert_lint('int a = 1 ? 0 : 30;', '')
</span><span class="cx">         self.assert_lint('bool a : 1;', '')
</span><span class="cx"> 
</span><ins>+    def test_decode_functions_missing_warn_unused_return(self):
+        warning_expected = 'decode() function returning a value is missing WARN_UNUSED_RETURN attribute' \
+                           '  [security/missing_warn_unused_return] [5]'
+        warning_none = ''
</ins><span class="cx"> 
</span><ins>+        self.perform_function_definition_check(
+            'foo.cpp',
+            'static bool decode() { return false; }',
+            warning_expected)
+        self.perform_function_definition_check(
+            'foo.cpp',
+            'static WARN_UNUSED_RETURN bool decode() { return false; }',
+            warning_none)
+
+        self.perform_function_definition_check(
+            'foo.cpp',
+            'static inline bool decodeStringText(Decoder& decoder, uint32_t length, String& result)\n'
+            '{',
+            warning_expected)
+        self.perform_function_definition_check(
+            'foo.cpp',
+            'static inline WARN_UNUSED_RETURN bool decodeStringText(Decoder& decoder, uint32_t length, String& result)\n'
+            '{',
+            warning_none)
+
+        self.perform_function_definition_check(
+            'foo.h',
+            'static bool decode(Decoder& decoder, std::pair<T, U>& pair)\n'
+            '{',
+            warning_expected)
+        self.perform_function_definition_check(
+            'foo.cpp',
+            'static WARN_UNUSED_RETURN bool decode(Decoder& decoder, std::pair<T, U>& pair)\n'
+            '{',
+            warning_none)
+
+        self.perform_function_definition_check(
+            'Source/WTF/wtf/foo.h',
+            'WTF_EXPORT_PRIVATE static bool decode(Decoder&, AtomString&);',
+            warning_expected)
+        self.perform_function_definition_check(
+            'Source/WTF/wtf/foo.h',
+            'WTF_EXPORT_PRIVATE static bool decode(Decoder&, AtomString&) WARN_UNUSED_RETURN;',
+            warning_none)
+
+        self.perform_function_definition_check(
+            'Source/WTF/wtf/foo.h',
+            '    template<typename E>\n'
+            '    auto decode(E& e) -> std::enable_if_t<std::is_enum<E>::value, bool>\n'
+            '    {',
+            warning_expected)
+        self.perform_function_definition_check(
+            'Source/WTF/wtf/foo.h',
+            '    template<typename E> WARN_UNUSED_RETURN\n'
+            '    auto decode(E& e) -> std::enable_if_t<std::is_enum<E>::value, bool>\n'
+            '    {',
+            warning_none)
+
+        self.perform_function_definition_check(
+            'Source/WTF/wtf/foo.h',
+            '    template<typename E>\n'
+            '    bool decode(E& e) -> std::enable_if_t<std::is_enum<E>::value, bool>\n'
+            '    {',
+            warning_expected)
+        self.perform_function_definition_check(
+            'Source/WTF/wtf/foo.h',
+            '    template<typename E> WARN_UNUSED_RETURN\n'
+            '    bool decode(E& e) -> std::enable_if_t<std::is_enum<E>::value, bool>\n'
+            '    {',
+            warning_none)
+
+        self.perform_function_definition_check(
+            'Source/WTF/wtf/foo.h',
+            '    static Optional<std::tuple<>> decode(Decoder&)\n'
+            '    {',
+            warning_none)
+
+
</ins><span class="cx"> class CleansedLinesTest(unittest.TestCase):
</span><span class="cx">     def test_init(self):
</span><span class="cx">         lines = ['Line 1',
</span></span></pre>
</div>
</div>

</body>
</html>