/*======================================================================== Program: KWStyle - Kitware Style Checker Module: kwsStyle.cxx Copyright (c) Kitware, Inc. All rights reserved. See Copyright.txt or http://www.kitware.com/Copyright.htm for details. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the above copyright notices for more information. =========================================================================*/ #include "kwsParser.h" #include "kwsGenerator.h" #include "metaCommand.h" #include #include #include #include #include #include #include #include #include "kwsXMLReader.h" #include #include "KWStyleConfigure.h" #if defined(WIN32) && !defined(__CYGWIN__) #include // mkdir needs it #endif struct kwsFeature{ std::string name; std::string value; std::string filename; bool enable; }; // List of features to check static std::vector features; static std::vector overwriteFeatures; static void AddFeature(const char* name,const char* value,bool enable) { kwsFeature f; f.name = name; f.value = value; f.enable = enable; f.filename = ""; features.push_back(f); } static void ChangeFeature(const char* name,const char* value) { auto it = features.begin(); while(it != features.end()) { if(!strcmp((*it).name.c_str(),name)) { (*it).value = value; return; } ++it; } } static void DisableFeature(const char* name) { auto it = features.begin(); while(it != features.end()) { if(!strcmp((*it).name.c_str(),name)) { (*it).enable = false; return; } ++it; } } /** Remove files */ static void RemoveFile(const char* regEx,std::vector & filenames) { kwssys::RegularExpression regex(regEx); auto it = filenames.begin(); while(it != filenames.end()) { if(regex.find((*it).c_str())) { it = filenames.erase(it); } else { ++it; } } } int main(int argc, const char **argv) { double time0 = kwssys::SystemTools::GetTime(); MetaCommand command; command.SetVersion(KWSTYLE_VERSION_STRING); // Check if -cvs is defined and put MetaCommand in quiet mode /*for(int j=0;j[A-Z]",true); AddFeature("Struct","[a-z]",true); AddFeature("SemicolonSpace","0",true); AddFeature("EndOfFileNewLine","",true); AddFeature("Tabs","",true); AddFeature("Spaces","3",true); AddFeature("Comments","/**, *, */,true,true,true",true); AddFeature("Indent","kws::SPACE,2,true,true",true); AddFeature("Namespace","itk",true); AddFeature("NameOfClass","[NameOfClass],itk",true); AddFeature("IfNDefDefine","__[NameOfClass]_[Extension]",true); AddFeature("EmptyLines","2",true); AddFeature("Template","T",true); AddFeature("Operator","1,1",true); AddFeature("StatementPerLine","1",true); AddFeature("VariablePerLine","1",true); AddFeature("BadCharacters","true",true); AddFeature("MemberFunctions","*",true); AddFeature("Functions","*",true); AddFeature("UsingDirectives", "true", true); AddFeature("RelativePathInInclude", "true", true); AddFeature("IfWhileForUntil","",true); AddFeature("Comma","",true); AddFeature("Parenthesis","",true); std::string xmlFile = "KWStyle.xml"; // If we should look the definition from the xml file if(command.GetOptionWasSet("xml")) { xmlFile = command.GetValueAsString("xml","filename"); } // Initialize the configuration parameters std::string blacklist = ""; std::string overwrite = ""; std::string recursive = ""; std::string verbose = ""; std::string htmlDirectory = ""; std::string lessHTML = ""; std::string filesToCheck = ""; std::string directoryToCheck = ""; std::string fileToCheck = ""; std::string fixedFile = ""; if (!xmlFile.empty()) { kws::XMLReader reader; if(reader.Open(xmlFile.c_str())) { auto it = features.begin(); while(it != features.end()) { std::string val = reader.GetValue((*it).name.c_str()); if(!val.empty()) { ChangeFeature((*it).name.c_str(),val.c_str()); } else { DisableFeature((*it).name.c_str()); } ++it; } // Read the current configuration blacklist = reader.GetValue("BlackList"); overwrite = reader.GetValue("OverwriteFile"); verbose = reader.GetValue("Verbose"); if(!verbose.empty() && verbose[0] != '1') { verbose = ""; } recursive = reader.GetValue("Recursive"); if(!recursive.empty() && recursive[0] != '1') { recursive = ""; } htmlDirectory = reader.GetValue("HTMLDirectory"); lessHTML = reader.GetValue("LessHTML"); filesToCheck = reader.GetValue("Files"); directoryToCheck = reader.GetValue("Directory"); fileToCheck = reader.GetValue("File"); reader.Close(); } else { std::cout << "Cannot open configuration file: " << xmlFile.c_str() << std::endl; } } if(command.GetOptionWasSet("blacklist")) { blacklist = command.GetValueAsString("blacklist","filename"); } if(!blacklist.empty()) { AddFeature("BlackList",blacklist.c_str(),true); } // If we should look at some overwritten rules if(command.GetOptionWasSet("overwrite")) { overwrite = command.GetValueAsString("overwrite","filename"); } if(!overwrite.empty()) { // Read the file std::ifstream file; file.open(overwrite.c_str(), std::ios::binary | std::ios::in); if(!file.is_open()) { std::cout << "Cannot open overwrite file: " << overwrite.c_str() << std::endl; return 0; } file.seekg(0,std::ios::end); std::streamsize fileSize = file.tellg(); file.seekg(0,std::ios::beg); char* buf = new char[fileSize+1]; file.read(buf, fileSize); buf[fileSize] = 0; std::string buffer(buf); buffer.resize(static_cast(fileSize)); delete [] buf; size_t start = 0; auto pos = buffer.find("\n", start); do { std::string line = ""; if(pos == std::string::npos) { line = buffer.substr(start,buffer.length()- start); pos = static_cast(fileSize); // we stop } else { line = buffer.substr(start,pos-start); start = pos+1; } if(line.size() < 2) { break; } auto p = line.find(" "); if (p != std::string::npos) { kwsFeature f; f.filename = line.substr(0, p); size_t p1 = p; p = line.find(" ",p + 1); if (p != std::string::npos) { f.name = line.substr(p1 + 1,p - p1 - 1); } p1 = p; p = line.find(" ",p+1); std::string enablestring = line.substr(p1+1,p-p1-1); f.enable = enablestring.find("Enable") != std::string::npos; p1 = p; p = line.find("\n",p+1); if(p != std::string::npos) { f.value = line.substr( p1+1,p-p1-1); } overwriteFeatures.push_back(f); } if(static_cast(pos) != fileSize) { pos = buffer.find("\n",start); } } while(static_cast(pos) < fileSize); file.close(); } std::string inputFilename = command.GetValueAsString("infile"); if (!fileToCheck.empty()) { inputFilename = fileToCheck; } if(command.GetOptionWasSet("recursive")) { recursive = "1"; } // if the -D command is used if(command.GetOptionWasSet("dirfile")) { filesToCheck = inputFilename; } if(command.GetValueAsString("directory").length() > 0) { directoryToCheck = inputFilename; if(directoryToCheck[directoryToCheck.size()-1] != '/') { directoryToCheck += '/'; } } std::vector filenames; std::vector m_Parsers; // if the -d command is used if (!directoryToCheck.empty()) { kwssys::Glob glob; if (!recursive.empty()) { glob.RecurseOn(); } std::string globoption = directoryToCheck.c_str(); if(kwssys::SystemTools::FileExists(directoryToCheck.c_str())) { globoption += "*.*"; } glob.FindFiles(globoption.c_str()); filenames = glob.GetFiles(); } else if (!filesToCheck.empty()) { // Read the file std::ifstream file; file.open(filesToCheck.c_str(), std::ios::binary | std::ios::in); if(!file.is_open()) { std::cout << "Cannot open description files: " << filesToCheck.c_str() << std::endl; return 0; } file.seekg(0,std::ios::end); std::streamsize fileSize = file.tellg(); file.seekg(0,std::ios::beg); char* buf = new char[fileSize+1]; file.read(buf,fileSize); buf[fileSize] = 0; std::string buffer(buf); buffer.resize(static_cast(fileSize)); delete [] buf; size_t start = 0; size_t pos = buffer.find("\n",start); size_t posr = buffer.find("\r",start); if(posr == std::string::npos) { posr = pos; } // Define a parser to find if we are between quotes kws::Parser helperParser; do { std::string dirname = ""; if(pos == std::string::npos) { dirname = buffer.substr(start,buffer.length()- start); pos = static_cast(fileSize); // we stop } else { dirname = buffer.substr( start ,posr - start); start = pos+1; } if(dirname.size() < 2) { break; } auto space = dirname.find(" "); while (space != std::string::npos && helperParser.IsBetweenQuote(space, false, dirname)) { space = dirname.find(" ",space + 1); } // if we should remove the file if(dirname.find("-f",0) != std::string::npos) { std::string fileToRemove = dirname.substr(3,dirname.size()-3); RemoveFile(fileToRemove.c_str(),filenames); } else if(kwssys::SystemTools::FileExists(dirname.c_str())) { filenames.push_back(dirname); } else // we add a directory { kwssys::Glob glob; if(dirname.find("[R]",0) != std::string::npos) { glob.RecurseOn(); } auto localspace = dirname.find(" "); while (localspace != std::string::npos && helperParser.IsBetweenQuote(localspace, false, dirname)) { localspace = dirname.find(" ", localspace + 1); } if(localspace != std::string::npos) { dirname = dirname.substr(0,localspace); } // Remove quotes if any if(!dirname.empty() && dirname[0] == '"') { dirname = dirname.substr(1,dirname.size()-2); } std::string globoption = dirname.c_str(); glob.FindFiles(globoption.c_str()); std::vector globfiles = glob.GetFiles(); std::vector::const_iterator itglob = globfiles.begin(); while(itglob != globfiles.end()) { filenames.push_back(*itglob); ++itglob; } } if(static_cast(pos) != fileSize) { pos = buffer.find("\n", start); posr = buffer.find("\r", start); if(posr == std::string::npos) { posr = pos; } } } while(static_cast(pos) < fileSize); file.close(); } else { filenames.push_back(inputFilename); } // sort the filenames std::sort(filenames.begin(), filenames.end()); // if the -cvs command is used // WARNING this option should be last because its position is used // to determine the filenames. /*if(command.GetOptionWasSet("cvs")) { filenames.clear(); int cvspos = 0; int i=0; // Look for the position of the cvs command for(i=0;i::const_iterator it = filenames.begin(); size_t nerrors = 0; while(it != filenames.end()) { if(!command.GetOptionWasSet("quiteverbose") && !command.GetOptionWasSet("exporthtml") && !command.GetOptionWasSet("vim") && !command.GetOptionWasSet("msvc") && !command.GetOptionWasSet("gcc") ) { std::cout << "Processing " << (*it).c_str() << std::endl; } // We open the file std::ifstream file; file.open((*it).c_str(), std::ios::binary | std::ios::in); if(!file.is_open()) { std::cout << "Cannot open file: " << (*it).c_str() << std::endl; // When removing a file with CVS we should return 0 otherwise it fails if(command.GetOptionWasSet("cvs")) { return 0; } return 1; } file.seekg(0,std::ios::end); std::streamsize fileSize = file.tellg(); file.seekg(0,std::ios::beg); char* buf = new char[fileSize+1]; file.read(buf, fileSize); buf[fileSize] = 0; std::string buffer(buf); buffer.resize( static_cast(fileSize)); delete [] buf; file.close(); kws::Parser parser; parser.SetFilename((*it).c_str()); parser.SetBuffer(buffer); // Ask the parser to generate a corrected version of the file if(command.GetOptionWasSet("fixFile")) { parser.SetFixFile(true); } auto itf = features.begin(); while (itf != features.end()) { // Check if we have a match in the list of overwriteFeatures bool checked = false; auto itof = overwriteFeatures.begin(); while (itof != overwriteFeatures.end()) { // Allow for for regex expression within overwrite files kwssys::RegularExpression regex((*itof).filename.c_str()); if (regex.find((*it).c_str()) && (!strcmp((*itof).name.c_str(), (*itf).name.c_str()))) { if ((*itof).enable) { parser.Check((*itof).name.c_str(), (*itof).value.c_str()); } if((*itof).name == "LineLength" && !((*itof).enable)) { std::cout << "Cannot disable LineLength check. It computes internal parameters" << std::endl; } else { checked = true; } } ++itof; } if(!checked && (*itf).enable) { parser.Check((*itf).name.c_str(),(*itf).value.c_str()); } ++itf; } if(command.GetOptionWasSet("verbose")) { verbose = "1"; } // If we should display the error if(!verbose.empty() && !command.GetOptionWasSet("msvc") && !command.GetOptionWasSet("vim") && !command.GetOptionWasSet("gcc") ) { std::cout << parser.GetLastErrors().c_str() << std::endl; std::cout << parser.GetLastWarnings().c_str() << std::endl; } if(command.GetOptionWasSet("vim")) { // Format the string for vim const kws::Parser::ErrorVectorType errors = parser.GetErrors(); auto eit = errors.begin(); while(eit != errors.end()) { std::cout << (*it).c_str() << ":" << (*eit).line << ":" << (*eit).description << std::endl; ++eit; } } else if(command.GetOptionWasSet("msvc")) { // Format the string for Visual Studio const kws::Parser::ErrorVectorType errors = parser.GetErrors(); auto eit = errors.begin(); while(eit != errors.end()) { std::cout << (*it).c_str() << "(" << (*eit).line << ") : error " << (*eit).number << ":" << (*eit).description << std::endl; ++eit; } const kws::Parser::WarningVectorType warnings = parser.GetWarnings(); auto wit = warnings.begin(); while(wit != warnings.end()) { std::cout << (*it).c_str() << "(" << (*wit).line << ") : warning " << (*wit).number << ":" << (*wit).description << std::endl; ++wit; } } else if(command.GetOptionWasSet("gcc")) { // Format the string for Visual Studio const kws::Parser::ErrorVectorType errors = parser.GetErrors(); auto eit = errors.begin(); while(eit != errors.end()) { std::cout << (*it).c_str() << ":" << (*eit).line << ": error: " << (*eit).description << std::endl; ++eit; } const kws::Parser::WarningVectorType warnings = parser.GetWarnings(); auto wit = warnings.begin(); while(wit != warnings.end()) { std::cout << (*it).c_str() << ":" << (*wit).line << ": warning: " << (*wit).description << std::endl; ++wit; } } if(command.GetOptionWasSet("cvs")) { std::cout << parser.GetLastErrors().c_str() << std::endl; if (!parser.GetErrors().empty()) { return 1; } } nerrors += parser.GetErrors().size(); parser.GenerateFixedFile(); m_Parsers.push_back(parser); ++it; } // end filenames if(command.GetOptionWasSet("html")) { htmlDirectory = command.GetValueAsString("html","filename"); } // If we should generate the HTML file if(!htmlDirectory.empty()) { kws::Generator generator; generator.SetParser(&m_Parsers); if(command.GetOptionWasSet("xml")) { std::string xml = command.GetValueAsString("xml","filename"); generator.ReadConfigurationFile(xml.c_str()); } bool showNoErrors = false; if (!lessHTML.empty()) { if(lessHTML[0] == '1') { showNoErrors = true; } } if(command.GetOptionWasSet("lesshtml")) { showNoErrors = true; } generator.GenerateHTML(htmlDirectory.c_str(), !showNoErrors); } // If we should export the html report if(command.GetOptionWasSet("exporthtml")) { kws::Generator generator; if(command.GetOptionWasSet("xml")) { std::string xml = command.GetValueAsString("xml", "filename"); generator.ReadConfigurationFile(xml.c_str()); } generator.SetParser(&m_Parsers); generator.ExportHTML(std::cout); } if(command.GetOptionWasSet("exportxml")) { const std::string outputxmlFile = command.GetValueAsString("exportxml","filename"); kws::Generator generator; generator.SetParser(&m_Parsers); generator.ExportXML(outputxmlFile.c_str()); } // If we should generate dart files if(command.GetOptionWasSet("dart")) { std::string dart = command.GetValueAsString("dart", "filename"); int maxerror = command.GetValueAsInt("dart", "maxerror"); bool grouperrors = command.GetValueAsBool("dart", "group"); kws::Generator generator; if(command.GetOptionWasSet("xml")) { std::string xml = command.GetValueAsString("xml", "filename"); generator.ReadConfigurationFile(xml.c_str()); } generator.SetParser(&m_Parsers); std::string url = ""; if(command.GetOptionWasSet("kwsurl")) { url = command.GetValueAsString("kwsurl","url"); } std::string baseDirectory = ""; if(command.GetOptionWasSet("basedirectory")) { baseDirectory = command.GetValueAsString("basedirectory","filename"); } generator.GenerateDart(dart.c_str(),maxerror,grouperrors,url,time0,baseDirectory.c_str()); } // If we have errors we return false if(nerrors > 0) { return EXIT_FAILURE; } return EXIT_SUCCESS; }