cppcheck/tools/errmsg.cpp

/*
 * cppcheck - c/c++ syntax checking
 * Copyright (C) 2007-2009 Daniel Marjamäki, Reijo Tomperi, Nicolas Le Cam
 *
 * 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
 * (at your option) 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 <http://www.gnu.org/licenses/
 */

#include <fstream>
#include <iostream>
#include <list>
#include <string>

class Message
{
private:
    std::string _funcname;
    std::string _msg;
    std::string _par1;
    std::string _par2;
    unsigned int _settings;

    std::string msg(bool code) const;

public:
    Message(std::string funcname, unsigned int settings, std::string msg);
    Message(std::string funcname, unsigned int settings, std::string msg, std::string par1);
    Message(std::string funcname, unsigned int settings, std::string msg, std::string par1, std::string par2);

    static const unsigned int ALL = 1;
    static const unsigned int STYLE = 2;

    void generateCode(std::ostream &ostr) const;

    void generateDoc(std::ostream &ostr, unsigned int i) const;
};




int main()
{
    // Error messages..
    std::list<Message> err;

    // checkbufferoverrun.cpp
    err.push_back(Message("arrayIndexOutOfBounds", Message::ALL, "Array index out of bounds"));
    err.push_back(Message("bufferOverrun", Message::ALL, "Buffer overrun"));

    // checkclass.cpp..
    err.push_back(Message("noConstructor", Message::STYLE, "The class '%1' has no constructor", "classname"));
    err.push_back(Message("uninitVar", 0, "Uninitialized member variable '%1::%2'", "classname", "varname"));
    err.push_back(Message("unusedPrivateFunction", Message::STYLE, "Unused private function '%1::%2'", "classname", "funcname"));
    err.push_back(Message("memsetClass", 0, "Using '%1' on class", "memfunc"));
    err.push_back(Message("memsetStruct", 0, "Using '%1' on struct that contains a 'std::%2'", "memfunc", "classname"));
    err.push_back(Message("operatorEq", Message::STYLE, "'operator=' should return something"));
    err.push_back(Message("virtualDestructor", 0, "Class %1 which is inherited by class %2 does not have a virtual destructor", "Base", "Derived"));

    // checkfunctionusage.cpp..
    err.push_back(Message("unusedFunction", Message::STYLE | Message::ALL, "[%1]: The function '%2' is never used", "filename", "funcname"));

    // checkmemoryleak.cpp..
    err.push_back(Message("mismatchAllocDealloc", 0, "Mismatching allocation and deallocation: %1", "varname"));
    err.push_back(Message("memleak", 0, "Memory leak: %1", "varname"));
    err.push_back(Message("resourceLeak", 0, "Resource leak: %1", "varname"));

    // checkother.cpp..
    err.push_back(Message("cstyleCast", Message::STYLE, "C-style pointer casting"));
    err.push_back(Message("redundantIfDelete0", Message::STYLE, "Redundant condition. It is safe to deallocate a NULL pointer"));
    err.push_back(Message("redundantIfRemove", Message::STYLE, "Redundant condition. The remove function in the STL will not do anything if element doesn't exist"));
    err.push_back(Message("dangerousUsageStrtol", 0, "Invalid radix in call to strtol or strtoul. Must be 0 or 2-36"));
    err.push_back(Message("ifNoAction", Message::STYLE, "Found redundant if condition - 'if (condition);'"));

    // Generate code..
    std::cout << "Generate code.." << std::endl;
    std::ofstream fout("errormessage.h");

    fout << "/*\n";
    fout << " * cppcheck - c/c++ syntax checking\n";
    fout << " * Copyright (C) 2007-2009 Daniel Marjamäki, Reijo Tomperi, Nicolas Le Cam\n";
    fout << " *\n";
    fout << " * This program is free software: you can redistribute it and/or modify\n";
    fout << " * it under the terms of the GNU General Public License as published by\n";
    fout << " * the Free Software Foundation, either version 3 of the License, or\n";
    fout << " * (at your option) any later version.\n";
    fout << " *\n";
    fout << " * This program is distributed in the hope that it will be useful,\n";
    fout << " * but WITHOUT ANY WARRANTY; without even the implied warranty of\n";
    fout << " * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n";
    fout << " * GNU General Public License for more details.\n";
    fout << " *\n";
    fout << " * You should have received a copy of the GNU General Public License\n";
    fout << " * along with this program.  If not, see <http://www.gnu.org/licenses/\n";
    fout << " */\n\n";
    fout << "// THIS FILE IS GENERATED BY MACHINE, SEE ../tools/errmsg.cpp !\n\n";
    fout << "#ifndef errormessageH\n";
    fout << "#define errormessageH\n";
    fout << "#include <string>\n";
    fout << "#include \"settings.h\"\n";
    fout << "class Token;\n";
    fout << "class Tokenizer;\n";
    fout << "class ErrorMessage\n";
    fout << "{\n";
    fout << "private:\n";
    fout << "    ErrorMessage() { }\n";
    fout << "    static std::string msg1(const Tokenizer *tokenizer, const Token *Location);\n";
    fout << "public:\n";
    for (std::list<Message>::const_iterator it = err.begin(); it != err.end(); ++it)
        it->generateCode(fout);
    fout << "};\n";
    fout << "#endif\n";
    std::cout << std::endl;

    // Generate documentation..
    std::cout << "Generate doc.." << std::endl;
    for (unsigned int i = 0; i < 4; ++i)
    {
        const char *suite[4] = { "standard", "all", "style", "all + style" };
        std::cout << "    =" << suite[i] << "=" << std::endl;
        for (std::list<Message>::const_iterator it = err.begin(); it != err.end(); ++it)
            it->generateDoc(std::cout, i);
    }
    std::cout << std::endl;

    return 0;
}





Message::Message(std::string funcname, unsigned int settings, std::string msg)
        : _funcname(funcname), _msg(msg), _par1(""), _par2(""), _settings(settings)
{ }

Message::Message(std::string funcname, unsigned int settings, std::string msg, std::string par1)
        : _funcname(funcname), _msg(msg), _par1(par1), _par2(""), _settings(settings)
{ }

Message::Message(std::string funcname, unsigned int settings, std::string msg, std::string par1, std::string par2)
        : _funcname(funcname), _msg(msg), _par1(par1), _par2(par2), _settings(settings)
{ }

std::string Message::msg(bool code) const
{
    const char *str = code ? "\"" : "";
    std::string ret(str + _msg + str);

    if (! _par1.empty())
    {
        std::string::size_type pos = 0;
        while ((pos = ret.find("%1", pos)) != std::string::npos)
        {
            ret.erase(pos, 2);
            if (code)
                ret.insert(pos, "\" + " + _par1 + " + \"");
            else
                ret.insert(pos, _par1);
        }
    }

    if (! _par2.empty())
    {
        std::string::size_type pos = 0;
        while ((pos = ret.find("%2", pos)) != std::string::npos)
        {
            ret.erase(pos, 2);
            if (code)
                ret.insert(pos, "\" + " + _par2 + " + \"");
            else
                ret.insert(pos, _par2);
        }
    }

    return ret;
}

void Message::generateCode(std::ostream &ostr) const
{
    bool loc = bool(_msg.substr(0, 4) != "[%1]");

    // Error message..
    ostr << "    static std::string " << _funcname << "(";
    if (loc)
        ostr << "const Tokenizer *tokenizer, const Token *Location";
    if (! _par1.empty())
        ostr << (loc ? ", " : "") <<  "const std::string &" << _par1;
    if (! _par2.empty())
        ostr << ", const std::string &" << _par2;
    ostr << ")\n";
    ostr << "    {\n";
    ostr << "        return ";
    if (loc)
        ostr << "msg1(tokenizer, Location) + ";
    ostr << msg(true) << ";\n";
    ostr << "    }\n";

    // Settings..
    ostr << "    static bool " << _funcname << "(const Settings &s)" << std::endl;
    ostr << "    {\n";
    ostr << "        return ";
    if (_settings == 0)
        ostr << "true";
    else
    {
        if (_settings == ALL)
            ostr << "s._showAll";
        else if (_settings == STYLE)
            ostr << "s._checkCodingStyle";
        else if (_settings == (ALL | STYLE))
            ostr << "s._showAll & s._checkCodingStyle";
    }
    ostr << ";\n";
    ostr << "    }\n\n";
}

void Message::generateDoc(std::ostream &ostr, unsigned int i) const
{
    if (_settings == i)
    {
        ostr << "    " << msg(false) << std::endl;
    }
}