#1 Line comments can be misparsed as block comments

Roman Benesch — Wed, 19 Feb 2014 09:30:45 -0000

The suggested fix, despite being correct in itself, will lead to big portions of source files being ingored sometimes, as the comment block end ("*/") detection in the surrounding code is buggy.

here a corrected version (file "SourceFile.cpp"):
/*
* 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
* (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, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
/

include "SourceFile.h"

include "TextFile.h"

include "StringUtil.h"

include

SourceFile::SourceFile(const std::string& fileName, const unsigned int minChars, const bool ignorePrepStuff) :
m_fileName(fileName),
m_minChars(minChars),
m_ignorePrepStuff(ignorePrepStuff),
m_FileType(FileType::GetFileType(fileName))
{
TextFile listOfFiles(m_fileName.c_str());

std::vector<std::string> lines;
listOfFiles.readLines(lines, false);

int openBlockComments = 0;
for(int i=0;i<(int)lines.size();i++){
    std::string& line = lines[i];
    std::string tmp;

    int lineSize = (int)line.size();
    tmp.reserve(lineSize);

    // Remove block comments
    switch (m_FileType){
        case FileType::FILETYPE_C:
        case FileType::FILETYPE_CPP:
        case FileType::FILETYPE_CXX:
        case FileType::FILETYPE_H:
        case FileType::FILETYPE_HPP:
        case FileType::FILETYPE_JAVA:
        case FileType::FILETYPE_CS:
            for (int j=0;j<lineSize;j++){
                if (openBlockComments > 0){
                    if (j < lineSize-2 && line[j] == '*' && line[j+1] == '/'){
                        j++;
                        openBlockComments--;
                    }
                }
                else{
                    if (j < lineSize-2 && line[j] == '/' && line[j+1] == '/'){
                        break;
                    }
                    else{
                        if (j < lineSize-2 && line[j] == '/' && line[j+1] == '*'){
                            j++;
                            openBlockComments++;
                        }
                        else{
                            tmp.push_back(line[j]);
                        }
                    }
                }
            }
            break;

        case FileType::FILETYPE_VB:
            for (int j=0;j<lineSize;j++){
                if (j < lineSize-1 && line[j] == '\''){
                    break;
                }
                tmp.push_back(line[j]);
            }
            break;

        default:
            tmp = line;
            break;
    }

    if(isSourceLine(tmp)){
        m_sourceLines.push_back(new SourceLine(tmp, i));
    }
}

}

bool SourceFile::isSourceLine(const std::string& line){
std::string tmp = StringUtil::trim(line);

// filter min size lines
if (tmp.size() < m_minChars)
{
    return false;
}

std::transform(tmp.begin(), tmp.end(), tmp.begin(), (int(*)(int)) tolower);

if(m_ignorePrepStuff){
    switch (m_FileType)
    {
        case FileType::FILETYPE_C   :
        case FileType::FILETYPE_CPP :
        case FileType::FILETYPE_CXX :
        case FileType::FILETYPE_H   :
        case FileType::FILETYPE_HPP :
        case FileType::FILETYPE_JAVA:
            if(tmp[0] == '#')
            {
                return false;
            }
            break;

        case FileType::FILETYPE_CS  :
            {
            if(tmp[0] == '#')
            {
                return false;
            }
            // look for preprocessor marker in start of string
            const std::string PreProc_CS = "using";

            return std::string::npos == tmp.find(PreProc_CS.c_str(), 0, PreProc_CS.length());
            }
            break;

        case FileType::FILETYPE_VB  :
            {
            // look for preprocessor marker in start of string
            const std::string PreProc_VB = "imports";

            return std::string::npos == tmp.find(PreProc_VB.c_str(), 0, PreProc_VB.length());
            }
            break;
    }
}

bool bRet = ((int)tmp.size() >= m_minChars);
assert(bRet);

return bRet;

}

int SourceFile::getNumOfLines(){
return (int)m_sourceLines.size();
}

SourceLine* SourceFile::getLine(const int index){
return m_sourceLines[index];
}

const std::string& SourceFile::getFilename(){
return m_fileName;
}

Line comments can be misparsed as block comments

Wilson Snyder — Wed, 20 Apr 2011 14:37:15 -0000

Code like this:

//******** comments....

Causes the program to see the embedded /* and ignore the rest of the file.

Add to SourceFile::SourceFile

if(line[j] == \'/\' && line[MIN(lineSize-1, j+1)] == \'/\'){
break;
}

Recent changes to bugs

#1 Line comments can be misparsed as block comments

include "SourceFile.h"

include "TextFile.h"

include "StringUtil.h"

include

include

Line comments can be misparsed as block comments