From 11cc29197700eed64f9a82f81b503dd75dfa1811 Mon Sep 17 00:00:00 2001 From: Andrei Karas Date: Tue, 3 Jun 2014 18:57:23 +0300 Subject: add rule for checking include file dirs. --- src/Makefile.am | 1 + src/rules/include.cpp | 64 ++++++++++++++++++++++++++++++++++++++++++ src/stringutils.cpp | 10 +++++++ src/stringutils.h | 2 ++ tests/testreport.txt | 2 ++ tests/testsrc/bad/include1.cpp | 48 +++++++++++++++++++++++++++++++ tests/testsrc/bad/include1.h | 46 ++++++++++++++++++++++++++++++ tests/testsrc/debug.h | 21 ++++++++++++++ tests/testsrc/lintmanager.h | 21 ++++++++++++++ 9 files changed, 215 insertions(+) create mode 100644 src/rules/include.cpp create mode 100644 tests/testsrc/bad/include1.cpp create mode 100644 tests/testsrc/bad/include1.h create mode 100644 tests/testsrc/debug.h create mode 100644 tests/testsrc/lintmanager.h diff --git a/src/Makefile.am b/src/Makefile.am index 13592ca..4bcbe76 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -21,6 +21,7 @@ mplint_SOURCES = \ rules/debug.cpp \ rules/dump.cpp \ rules/final.cpp \ + rules/include.cpp \ rules/license.cpp # set the include path found by configure diff --git a/src/rules/include.cpp b/src/rules/include.cpp new file mode 100644 index 0000000..347bf58 --- /dev/null +++ b/src/rules/include.cpp @@ -0,0 +1,64 @@ +/* + * The ManaPlus Client + * Copyright (C) 2014 The ManaPlus Developers + * + * This file is part of The ManaPlus Client. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * any later version. + * + * This program 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, see . + */ + +#include "template.hpp" + +registerRuleExt(include, "008", "(.+)[.](cpp|h)") + +startRule(include) +{ +} + +endRule(include) +{ +} + +parseLineRule(include) +{ + std::string data0 = data; + trim(data); + if (data == "#include \"config.h\"") + return; + + if (findCutFirst(data, "#include \"")) + { + if (findCutLast(data, "\"")) + { + if (!fileExists(rootDir + data)) + { + print("Wrong include " + data0 + ". " + "Probably you should use path from src dir," + " or use #include "); + } + } + } + else if (findCutFirst(data, "#include <")) + { + if (findCutLast(data, ">")) + { + if (fileExists(rootDir + data)) + { + print("Wrong include " + data0 + ". " + "Found local file with same name."); + } + } + } +} + diff --git a/src/stringutils.cpp b/src/stringutils.cpp index d750165..1f5ff47 100644 --- a/src/stringutils.cpp +++ b/src/stringutils.cpp @@ -31,6 +31,8 @@ #include #include +#include + std::string &trim(std::string &str) { size_t pos = str.find_last_not_of(' '); @@ -711,3 +713,11 @@ bool isMatch(const std::string &str, const std::string &exp) std::regex regExp(exp); return std::regex_match(str, regExp); } + +bool fileExists(const std::string &name) +{ + struct stat statbuf; + if (stat(name.c_str(), &statbuf)) + return false; + return true; +} diff --git a/src/stringutils.h b/src/stringutils.h index 817114e..3cbcdb9 100644 --- a/src/stringutils.h +++ b/src/stringutils.h @@ -239,4 +239,6 @@ void secureChatCommand(std::string &str); bool isMatch(const std::string &str, const std::string &exp); +bool fileExists(const std::string &name); + #endif // STRINGUTILS_H diff --git a/tests/testreport.txt b/tests/testreport.txt index 235864f..6297170 100644 --- a/tests/testreport.txt +++ b/tests/testreport.txt @@ -17,6 +17,8 @@ [testsrc/bad/final1.cpp:30]: V007: Need add final or notfinal into class declaration [testsrc/bad/final1.h:23]: V007: Need add final or notfinal into class declaration [testsrc/bad/final1.h:27]: V007: Need add final or notfinal into class declaration +[testsrc/bad/include1.cpp:21]: V008: Wrong include #include "lintmanager1.h". Probably you should use path from src dir, or use #include +[testsrc/bad/include1.h:21]: V008: Wrong include #include "lintmanager1.h". Probably you should use path from src dir, or use #include [testsrc/bad/license1.cpp:1]: V005: Should be license header [testsrc/bad/license1.h:1]: V005: Should be license header [testsrc/bad/license2.cpp:2]: V005: Should be 'The ManaPlus Client' in header diff --git a/tests/testsrc/bad/include1.cpp b/tests/testsrc/bad/include1.cpp new file mode 100644 index 0000000..893c186 --- /dev/null +++ b/tests/testsrc/bad/include1.cpp @@ -0,0 +1,48 @@ +/* + * The ManaPlus Client + * Copyright (C) 2014 The ManaPlus Developers + * + * This file is part of The ManaPlus Client. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * any later version. + * + * This program 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, see . + */ + +#include "lintmanager1.h" + +#include "debug.h" + +class Test1 final +{ + Test1::Test1() + { + } +} + +struct Test2 notfinal +{ + Test2::Test2() : + data1(), + data2() + { + } +} + +struct Test3 notfinal +{ + Test3::Test3() : + data1(), + data2() + { + } +} diff --git a/tests/testsrc/bad/include1.h b/tests/testsrc/bad/include1.h new file mode 100644 index 0000000..1d87446 --- /dev/null +++ b/tests/testsrc/bad/include1.h @@ -0,0 +1,46 @@ +/* + * The ManaPlus Client + * Copyright (C) 2014 The ManaPlus Developers + * + * This file is part of The ManaPlus Client. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * any later version. + * + * This program 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, see . + */ + +#include "lintmanager1.h" + +class Test1 final +{ + Test1::Test1() + { + } +} + +struct Test2 notfinal +{ + Test2::Test2() : + data1(), + data2() + { + } +} + +struct Test3 notfinal +{ + Test3::Test3() : + data1(), + data2() + { + } +} diff --git a/tests/testsrc/debug.h b/tests/testsrc/debug.h new file mode 100644 index 0000000..1c83d5c --- /dev/null +++ b/tests/testsrc/debug.h @@ -0,0 +1,21 @@ +/* + * The ManaPlus Client + * Copyright (C) 2014 The ManaPlus Developers + * + * This file is part of The ManaPlus Client. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * any later version. + * + * This program 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, see . + */ + +// test diff --git a/tests/testsrc/lintmanager.h b/tests/testsrc/lintmanager.h new file mode 100644 index 0000000..1c83d5c --- /dev/null +++ b/tests/testsrc/lintmanager.h @@ -0,0 +1,21 @@ +/* + * The ManaPlus Client + * Copyright (C) 2014 The ManaPlus Developers + * + * This file is part of The ManaPlus Client. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * any later version. + * + * This program 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, see . + */ + +// test -- cgit v1.2.3-60-g2f50