<!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>[173174] 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/173174">173174</a></dd>
<dt>Author</dt> <dd>commit-queue@webkit.org</dd>
<dt>Date</dt> <dd>2014-09-02 09:03:41 -0700 (Tue, 02 Sep 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>check-webkit-style should complain about C++ comments in Platform.h
https://bugs.webkit.org/show_bug.cgi?id=133802
Patch by Renato Nagy <rnagy@inf.u-szeged.hu> on 2014-09-02
Reviewed by Csaba Osztrogonác.
* Scripts/webkitpy/style/checkers/cpp.py:
(check_platformh_comments):
(_process_lines):
(CppChecker):
* Scripts/webkitpy/style/checkers/cpp_unittest.py:
(CppStyleTest.test_platformh_comment):</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 (173173 => 173174)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog 2014-09-02 16:00:14 UTC (rev 173173)
+++ trunk/Tools/ChangeLog 2014-09-02 16:03:41 UTC (rev 173174)
</span><span class="lines">@@ -1,3 +1,17 @@
</span><ins>+2014-09-02 Renato Nagy <rnagy@inf.u-szeged.hu>
+
+ check-webkit-style should complain about C++ comments in Platform.h
+ https://bugs.webkit.org/show_bug.cgi?id=133802
+
+ Reviewed by Csaba Osztrogonác.
+
+ * Scripts/webkitpy/style/checkers/cpp.py:
+ (check_platformh_comments):
+ (_process_lines):
+ (CppChecker):
+ * Scripts/webkitpy/style/checkers/cpp_unittest.py:
+ (CppStyleTest.test_platformh_comment):
+
</ins><span class="cx"> 2014-09-02 Brendan Long <self@brendanlong.com>
</span><span class="cx">
</span><span class="cx"> [Gtk] Make install-dependencies work on Arch Linux
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpystylecheckerscpppy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py (173173 => 173174)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py 2014-09-02 16:00:14 UTC (rev 173173)
+++ trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py 2014-09-02 16:03:41 UTC (rev 173174)
</span><span class="lines">@@ -3683,6 +3683,13 @@
</span><span class="cx"> 'Add #include ' + required_header_unstripped + ' for ' + template)
</span><span class="cx">
</span><span class="cx">
</span><ins>+def check_platformh_comments(lines, error):
+ for line_number, line in enumerate(lines):
+ if line_number not in (0, len(lines) - 1):
+ if line.find("//") != -1:
+ error(line_number, 'build/cpp_comment', 5, 'CPP comments are not allowed in Platform.h, '
+ 'please use C comments /* ... */')
+
</ins><span class="cx"> def process_line(filename, file_extension,
</span><span class="cx"> clean_lines, line, include_state, function_state,
</span><span class="cx"> class_state, file_state, enum_state, asm_state, error):
</span><span class="lines">@@ -3765,6 +3772,8 @@
</span><span class="cx">
</span><span class="cx"> if file_extension == 'h':
</span><span class="cx"> check_for_header_guard(filename, lines, error)
</span><ins>+ if filename == 'Source/WTF/wtf/Platform.h':
+ check_platformh_comments(lines, error)
</ins><span class="cx">
</span><span class="cx"> remove_multi_line_comments(lines, error)
</span><span class="cx"> clean_lines = CleansedLines(lines)
</span><span class="lines">@@ -3811,6 +3820,7 @@
</span><span class="cx"> 'build/storage_class',
</span><span class="cx"> 'build/using_std',
</span><span class="cx"> 'build/using_namespace',
</span><ins>+ 'build/cpp_comment',
</ins><span class="cx"> 'legal/copyright',
</span><span class="cx"> 'readability/braces',
</span><span class="cx"> 'readability/casting',
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpystylecheckerscpp_unittestpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py (173173 => 173174)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py 2014-09-02 16:00:14 UTC (rev 173173)
+++ trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py 2014-09-02 16:03:41 UTC (rev 173174)
</span><span class="lines">@@ -1141,6 +1141,44 @@
</span><span class="cx"> 2, # One per line.
</span><span class="cx"> error_collector.result_list().count(multiline_string_error_message))
</span><span class="cx">
</span><ins>+ def test_platformh_comments(self):
+ check_platformh_message = (
+ 'CPP comments are not allowed in Platform.h, '
+ 'please use C comments /* ... */ [build/cpp_comment] [5]')
+
+ platformh_file_path = 'Source/WTF/wtf/Platform.h'
+
+ # CPP comment are not allowed in Platform.h header file.
+ error_collector = ErrorCollector(self.assertTrue)
+ self.process_file_data(platformh_file_path, 'h',
+ ['// This is a cpp comment.'],
+ error_collector)
+ self.assertEqual(
+ 1,
+ error_collector.result_list().count(check_platformh_message))
+
+ # C comments are allowed in Platform.h
+ error_collector = ErrorCollector(self.assertTrue)
+ self.process_file_data(platformh_file_path, 'h',
+ ['/* This is a C comment.*/'],
+ error_collector)
+ self.assertEqual(
+ 0,
+ error_collector.result_list().count(check_platformh_message))
+
+ platformh_file_path = 'Source/WTF/wtf/platform.h'
+
+ # CPP comment are allowed in other header files.
+ error_collector = ErrorCollector(self.assertTrue)
+ self.process_file_data(platformh_file_path, 'h',
+ ['// This is a cpp comment.'
+ '// The filepath is not'
+ '// Source/WTF/wtf/Platform.h'],
+ error_collector)
+ self.assertEqual(
+ 0,
+ error_collector.result_list().count(check_platformh_message))
+
</ins><span class="cx"> # Test non-explicit single-argument constructors
</span><span class="cx"> def test_explicit_single_argument_constructors(self):
</span><span class="cx"> # missing explicit is bad
</span></span></pre>
</div>
</div>
</body>
</html>