aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-02-17 03:27:24 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-02-17 03:27:24 +0000
commit8dfe92a31857813df77cc4e331ec2afa75464d4a (patch)
treeab63b08ac37c56fdcd15efe1a0201082c64481f5
parent498c73c78fe67618f54cd472724a4e217145461f (diff)
downloadpaludis-8dfe92a31857813df77cc4e331ec2afa75464d4a.tar.gz
paludis-8dfe92a31857813df77cc4e331ec2afa75464d4a.tar.xz
Whitespace, the invisible killer
-rw-r--r--paludis/qa/files.m41
-rw-r--r--paludis/qa/whitespace_check.cc122
-rw-r--r--paludis/qa/whitespace_check.hh51
3 files changed, 174 insertions, 0 deletions
diff --git a/paludis/qa/files.m4 b/paludis/qa/files.m4
index 674db82..e2dcffd 100644
--- a/paludis/qa/files.m4
+++ b/paludis/qa/files.m4
@@ -39,4 +39,5 @@ add(`rdepend_packages_check', `hh', `cc')
add(`pdepend_overlap_check', `hh', `cc')
add(`qa', `hh', `cc')
add(`slot_check', `hh', `cc')
+add(`whitespace_check', `hh', `cc')
diff --git a/paludis/qa/whitespace_check.cc b/paludis/qa/whitespace_check.cc
new file mode 100644
index 0000000..ec21ac3
--- /dev/null
+++ b/paludis/qa/whitespace_check.cc
@@ -0,0 +1,122 @@
+/* vim: set sw=4 sts=4 et foldmethod=syntax : */
+
+/*
+ * Copyright (c) 2006 Ciaran McCreesh <ciaranm@gentoo.org>
+ *
+ * This file is part of the Paludis package manager. Paludis is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU General
+ * Public License version 2, as published by the Free Software Foundation.
+ *
+ * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+ * Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#include "whitespace_check.hh"
+#include <paludis/is_file_with_extension.hh>
+#include <fstream>
+
+using namespace paludis;
+using namespace paludis::qa;
+
+WhitespaceCheck::WhitespaceCheck()
+{
+}
+
+CheckResult
+WhitespaceCheck::operator() (const FSEntry & f) const
+{
+ CheckResult result(f, identifier());
+
+ if (! f.is_regular_file())
+ result << Message(qal_skip, "Not a regular file");
+ else if (! IsFileWithExtension(".ebuild")(f.basename()) &&
+ ! IsFileWithExtension(".xml")(f.basename()))
+ result << Message(qal_skip, "Not an ebuild or xml file");
+ else
+ {
+ std::ifstream ff(stringify(f).c_str());
+ if (! ff)
+ result << Message(qal_major, "Can't read file");
+ else
+ {
+ std::string s;
+ unsigned line_number(0);
+ unsigned err_count(0);
+ while (std::getline(ff, s))
+ {
+ if (err_count >= 3)
+ {
+ result << Message(qal_info, "Skipping further whitespace checks");
+ break;
+ }
+
+ ++line_number;
+
+ if (s.empty())
+ continue;
+
+ if (' ' == s.at(0))
+ {
+ result << Message(qal_minor, "Spaces for indenting on line "
+ + stringify(line_number));
+ ++err_count;
+ continue;
+ }
+
+ if ('\t' == s.at(0))
+ {
+ std::string::size_type p(s.find_first_not_of("\t"));
+ if (std::string::npos == p)
+ {
+ result << Message(qal_minor, "Indent followed by no content on line "
+ + stringify(line_number));
+ ++err_count;
+ continue;
+ }
+
+ if (' ' == s.at(p))
+ {
+ result << Message(qal_minor, "Mixed spaces and tabs on line "
+ + stringify(line_number));
+ ++err_count;
+ continue;
+ }
+
+ p = s.find(p, '\t');
+ if (std::string::npos != p)
+ {
+ result << Message(qal_minor, "Non-indent tab found on line "
+ + stringify(line_number));
+ ++err_count;
+ continue;
+ }
+ }
+
+ if (' ' == s.at(s.length() - 1) || '\t' == s.at(s.length() - 1))
+ {
+ result << Message(qal_minor, "Trailing whitespace found on line "
+ + stringify(line_number));
+ ++err_count;
+ continue;
+ }
+ }
+ }
+ }
+
+ return result;
+}
+
+const std::string &
+WhitespaceCheck::identifier()
+{
+ static const std::string id("whitespace");
+ return id;
+}
+
+
diff --git a/paludis/qa/whitespace_check.hh b/paludis/qa/whitespace_check.hh
new file mode 100644
index 0000000..cfb383c
--- /dev/null
+++ b/paludis/qa/whitespace_check.hh
@@ -0,0 +1,51 @@
+/* vim: set sw=4 sts=4 et foldmethod=syntax : */
+
+/*
+ * Copyright (c) 2006 Ciaran McCreesh <ciaranm@gentoo.org>
+ *
+ * This file is part of the Paludis package manager. Paludis is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU General
+ * Public License version 2, as published by the Free Software Foundation.
+ *
+ * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+ * Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#ifndef PALUDIS_GUARD_PALUDIS_QA_WHITESPACE_CHECK_HH
+#define PALUDIS_GUARD_PALUDIS_QA_WHITESPACE_CHECK_HH 1
+
+#include <paludis/qa/file_check.hh>
+#include <string>
+
+namespace paludis
+{
+ namespace qa
+ {
+ class WhitespaceCheck :
+ public FileCheck
+ {
+ public:
+ WhitespaceCheck();
+
+ CheckResult operator() (const FSEntry &) const;
+
+ static const std::string & identifier();
+
+ virtual std::string describe() const
+ {
+ return "Checks whitespace";
+ }
+ };
+
+ static const FileCheckMaker::RegisterMaker register_whitespace_check(
+ WhitespaceCheck::identifier(), &MakeFileCheck<WhitespaceCheck>::make_file_check);
+ }
+}
+
+#endif