mirror/QodeAssist
1
0
Fork 0
mirror of https://github.com/Palm1r/QodeAssist.git synced 2025-06-04 01:28:58 -04:00
Code Issues Packages Projects Releases Wiki Activity

fix: Properly omit copyright information (#103)

Browse Source 
This commit ensures that copyright information is always excluded and
that context is always split into prefix and suffix at correct position.
This commit is contained in:
Povilas Kanapickas 2025-03-06 14:00:15 +02:00 committed by GitHub
parent 8a167bf248
commit 61ca5c9a1b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 94 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
context/DocumentContextReader.cpp
View File

@ -84,18 +84,22 @@ QString DocumentContextReader::getLineText(int lineNumber, int cursorPosition) c
QString DocumentContextReader::getContextBefore( QString DocumentContextReader::getContextBefore(
int lineNumber, int cursorPosition, int linesCount) const int lineNumber, int cursorPosition, int linesCount) const
{ {
int effectiveStartLine = qMax(0, lineNumber - linesCount + 1); int startLine = lineNumber - linesCount + 1;
if (m_copyrightInfo.found) { if (m_copyrightInfo.found) {
effectiveStartLine = qMax(m_copyrightInfo.endLine + 1, effectiveStartLine); startLine = qMax(m_copyrightInfo.endLine + 1, startLine);
} }
return getContextBetween(effectiveStartLine, -1, lineNumber, cursorPosition); return getContextBetween(startLine, -1, lineNumber, cursorPosition);
} }
QString DocumentContextReader::getContextAfter( QString DocumentContextReader::getContextAfter(
int lineNumber, int cursorPosition, int linesCount) const int lineNumber, int cursorPosition, int linesCount) const
{ {
int endLine = qMin(m_document->blockCount() - 1, lineNumber + linesCount - 1); int endLine = lineNumber + linesCount - 1;
if (m_copyrightInfo.found && m_copyrightInfo.endLine >= lineNumber) {
lineNumber = m_copyrightInfo.endLine + 1;
cursorPosition = -1;
}
return getContextBetween(lineNumber, cursorPosition, endLine, -1); return getContextBetween(lineNumber, cursorPosition, endLine, -1);
} }
@ -106,14 +110,17 @@ QString DocumentContextReader::readWholeFileBefore(int lineNumber, int cursorPos
startLine = m_copyrightInfo.endLine + 1; startLine = m_copyrightInfo.endLine + 1;
} }
startLine = qMin(startLine, lineNumber);
return getContextBetween(startLine, -1, lineNumber, cursorPosition); return getContextBetween(startLine, -1, lineNumber, cursorPosition);
} }
QString DocumentContextReader::readWholeFileAfter(int lineNumber, int cursorPosition) const QString DocumentContextReader::readWholeFileAfter(int lineNumber, int cursorPosition) const
{ {
return getContextBetween(lineNumber, cursorPosition, m_document->blockCount() - 1, -1); int endLine = m_document->blockCount() - 1;
if (m_copyrightInfo.found && m_copyrightInfo.endLine >= lineNumber) {
lineNumber = m_copyrightInfo.endLine + 1;
cursorPosition = -1;
}
return getContextBetween(lineNumber, cursorPosition, endLine, -1);
} }
QString DocumentContextReader::getLanguageAndFileInfo() const QString DocumentContextReader::getLanguageAndFileInfo() const
@ -173,6 +180,9 @@ QString DocumentContextReader::getContextBetween(
{ {
QString context; QString context;
startLine = qMax(startLine, 0);
endLine = qMin(endLine, m_document->blockCount() - 1);
if (startLine > endLine) { if (startLine > endLine) {
return context; return context;
} }

5
context/DocumentContextReader.hpp
View File

@ -81,6 +81,11 @@ private:
QTextDocument *m_document; QTextDocument *m_document;
QString m_mimeType; QString m_mimeType;
QString m_filePath; QString m_filePath;
// Used to omit copyright headers from context. If context would otherwise include copyright
// header it is excluded by deleting it from the returned context. This means, that the
// returned context may contain less information than requested. If the cursor is within copyright
// header, then the context may be empty if the context window is small.
CopyrightInfo m_copyrightInfo; CopyrightInfo m_copyrightInfo;
}; };

133
test/DocumentContextReaderTest.cpp
View File

@ -166,7 +166,7 @@ TEST_F(DocumentContextReaderTest, testGetContextWithCopyright)
// Unknown cursor position // Unknown cursor position
EXPECT_EQ(reader.getContextBefore(0, -1, 2), ""); EXPECT_EQ(reader.getContextBefore(0, -1, 2), "");
EXPECT_EQ(reader.getContextAfter(0, -1, 2), "/* Copyright (C) 2024 */\nLine 0"); EXPECT_EQ(reader.getContextAfter(0, -1, 2), "Line 0");
EXPECT_EQ(reader.getContextBefore(1, -1, 2), "Line 0"); EXPECT_EQ(reader.getContextBefore(1, -1, 2), "Line 0");
EXPECT_EQ(reader.getContextAfter(1, -1, 2), "Line 0\nLine 1"); EXPECT_EQ(reader.getContextAfter(1, -1, 2), "Line 0\nLine 1");
@ -179,7 +179,7 @@ TEST_F(DocumentContextReaderTest, testGetContextWithCopyright)
// Known cursor position // Known cursor position
EXPECT_EQ(reader.getContextBefore(0, 1, 2), ""); EXPECT_EQ(reader.getContextBefore(0, 1, 2), "");
EXPECT_EQ(reader.getContextAfter(0, 1, 2), "* Copyright (C) 2024 */\nLine 0"); EXPECT_EQ(reader.getContextAfter(0, 1, 2), "Line 0");
EXPECT_EQ(reader.getContextBefore(1, 1, 2), "L"); EXPECT_EQ(reader.getContextBefore(1, 1, 2), "L");
EXPECT_EQ(reader.getContextAfter(1, 1, 2), "ine 0\nLine 1"); EXPECT_EQ(reader.getContextAfter(1, 1, 2), "ine 0\nLine 1");
@ -232,10 +232,8 @@ TEST_F(DocumentContextReaderTest, testReadWholeFileWithCopyright)
{ {
auto reader = createTestReader("/* Copyright (C) 2024 */\nLine 0\nLine 1\nLine 2\nLine 3"); auto reader = createTestReader("/* Copyright (C) 2024 */\nLine 0\nLine 1\nLine 2\nLine 3");
// Unknown cursor position // Unknown cursor position
EXPECT_EQ(reader.readWholeFileBefore(0, -1), "/* Copyright (C) 2024 */"); EXPECT_EQ(reader.readWholeFileBefore(0, -1), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(0, -1), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(0, -1),
"/* Copyright (C) 2024 */\nLine 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(1, -1), "Line 0"); EXPECT_EQ(reader.readWholeFileBefore(1, -1), "Line 0");
EXPECT_EQ(reader.readWholeFileAfter(1, -1), "Line 0\nLine 1\nLine 2\nLine 3"); EXPECT_EQ(reader.readWholeFileAfter(1, -1), "Line 0\nLine 1\nLine 2\nLine 3");
@ -248,8 +246,7 @@ TEST_F(DocumentContextReaderTest, testReadWholeFileWithCopyright)
// Known cursor position // Known cursor position
EXPECT_EQ(reader.readWholeFileBefore(0, 0), ""); EXPECT_EQ(reader.readWholeFileBefore(0, 0), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(0, 0), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(0, 0), "/* Copyright (C) 2024 */\nLine 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(1, 0), ""); EXPECT_EQ(reader.readWholeFileBefore(1, 0), "");
EXPECT_EQ(reader.readWholeFileAfter(1, 0), "Line 0\nLine 1\nLine 2\nLine 3"); EXPECT_EQ(reader.readWholeFileAfter(1, 0), "Line 0\nLine 1\nLine 2\nLine 3");
@ -260,9 +257,8 @@ TEST_F(DocumentContextReaderTest, testReadWholeFileWithCopyright)
EXPECT_EQ(reader.readWholeFileBefore(3, 0), "Line 0\nLine 1\n"); EXPECT_EQ(reader.readWholeFileBefore(3, 0), "Line 0\nLine 1\n");
EXPECT_EQ(reader.readWholeFileAfter(3, 0), "Line 2\nLine 3"); EXPECT_EQ(reader.readWholeFileAfter(3, 0), "Line 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(0, 1), "/"); EXPECT_EQ(reader.readWholeFileBefore(0, 1), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(0, 1), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(0, 1), "* Copyright (C) 2024 */\nLine 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(1, 1), "L"); EXPECT_EQ(reader.readWholeFileBefore(1, 1), "L");
EXPECT_EQ(reader.readWholeFileAfter(1, 1), "ine 0\nLine 1\nLine 2\nLine 3"); EXPECT_EQ(reader.readWholeFileAfter(1, 1), "ine 0\nLine 1\nLine 2\nLine 3");
@ -281,72 +277,87 @@ TEST_F(DocumentContextReaderTest, testReadWholeFileWithMultilineCopyright)
"Line 0\nLine 1\nLine 2\nLine 3"); "Line 0\nLine 1\nLine 2\nLine 3");
// Unknown cursor position // Unknown cursor position
EXPECT_EQ(reader.readWholeFileBefore(0, -1), "/*"); EXPECT_EQ(reader.readWholeFileBefore(0, -1), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(0, -1), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(0, -1),
"/*\n * Copyright (C) 2024\n * \n * This file is part of QodeAssist.\n */\nLine 0\nLine "
"1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(1, -1), " * Copyright (C) 2024"); EXPECT_EQ(reader.readWholeFileBefore(1, -1), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(1, -1), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(1, -1),
" * Copyright (C) 2024\n * \n * This file is part of QodeAssist.\n */\nLine 0\nLine "
"1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(2, -1), " * "); EXPECT_EQ(reader.readWholeFileBefore(2, -1), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(2, -1), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(2, -1),
" * \n * This file is part of QodeAssist.\n */\nLine 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(3, -1), " * This file is part of QodeAssist."); EXPECT_EQ(reader.readWholeFileBefore(3, -1), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(3, -1), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(3, -1),
" * This file is part of QodeAssist.\n */\nLine 0\nLine 1\nLine 2\nLine 3"); EXPECT_EQ(reader.readWholeFileBefore(4, -1), "");
EXPECT_EQ(reader.readWholeFileAfter(4, -1), "Line 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(5, -1), "Line 0");
EXPECT_EQ(reader.readWholeFileAfter(5, -1), "Line 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(6, -1), "Line 0\nLine 1");
EXPECT_EQ(reader.readWholeFileAfter(6, -1), "Line 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(7, -1), "Line 0\nLine 1\nLine 2");
EXPECT_EQ(reader.readWholeFileAfter(7, -1), "Line 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(8, -1), "Line 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileAfter(8, -1), "Line 3");
// Known cursor position // Known cursor position
EXPECT_EQ(reader.readWholeFileBefore(0, 0), ""); EXPECT_EQ(reader.readWholeFileBefore(0, 0), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(0, 0), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(0, 0),
"/*\n * Copyright (C) 2024\n * \n * This file is part of QodeAssist.\n */\nLine 0\nLine "
"1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(1, 0), ""); EXPECT_EQ(reader.readWholeFileBefore(1, 0), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(1, 0), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(1, 0),
" * Copyright (C) 2024\n * \n * This file is part of QodeAssist.\n */\nLine 0\nLine "
"1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(2, 0), ""); EXPECT_EQ(reader.readWholeFileBefore(2, 0), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(2, 0), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(2, 0),
" * \n * This file is part of QodeAssist.\n */\nLine 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(3, 0), ""); EXPECT_EQ(reader.readWholeFileBefore(3, 0), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(3, 0), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(3, 0),
" * This file is part of QodeAssist.\n */\nLine 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(0, 1), "/"); EXPECT_EQ(reader.readWholeFileBefore(4, 0), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(4, 0), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(0, 1),
"*\n * Copyright (C) 2024\n * \n * This file is part of QodeAssist.\n */\nLine 0\nLine "
"1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(1, 1), " "); EXPECT_EQ(reader.readWholeFileBefore(5, 0), "");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(5, 0), "Line 0\nLine 1\nLine 2\nLine 3");
reader.readWholeFileAfter(1, 1),
"* Copyright (C) 2024\n * \n * This file is part of QodeAssist.\n */\nLine 0\nLine 1\nLine "
"2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(2, 1), " "); EXPECT_EQ(reader.readWholeFileBefore(6, 0), "Line 0\n");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(6, 0), "Line 1\nLine 2\nLine 3");
reader.readWholeFileAfter(2, 1),
"* \n * This file is part of QodeAssist.\n */\nLine 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(3, 1), " "); EXPECT_EQ(reader.readWholeFileBefore(7, 0), "Line 0\nLine 1\n");
EXPECT_EQ( EXPECT_EQ(reader.readWholeFileAfter(7, 0), "Line 2\nLine 3");
reader.readWholeFileAfter(3, 1),
"* This file is part of QodeAssist.\n */\nLine 0\nLine 1\nLine 2\nLine 3"); EXPECT_EQ(reader.readWholeFileBefore(8, 0), "Line 0\nLine 1\nLine 2\n");
EXPECT_EQ(reader.readWholeFileAfter(8, 0), "Line 3");
EXPECT_EQ(reader.readWholeFileBefore(0, 1), "");
EXPECT_EQ(reader.readWholeFileAfter(0, 1), "Line 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(1, 1), "");
EXPECT_EQ(reader.readWholeFileAfter(1, 1), "Line 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(2, 1), "");
EXPECT_EQ(reader.readWholeFileAfter(2, 1), "Line 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(3, 1), "");
EXPECT_EQ(reader.readWholeFileAfter(3, 1), "Line 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(4, 1), "");
EXPECT_EQ(reader.readWholeFileAfter(4, 1), "Line 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(5, 1), "L");
EXPECT_EQ(reader.readWholeFileAfter(5, 1), "ine 0\nLine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(6, 1), "Line 0\nL");
EXPECT_EQ(reader.readWholeFileAfter(6, 1), "ine 1\nLine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(7, 1), "Line 0\nLine 1\nL");
EXPECT_EQ(reader.readWholeFileAfter(7, 1), "ine 2\nLine 3");
EXPECT_EQ(reader.readWholeFileBefore(8, 1), "Line 0\nLine 1\nLine 2\nL");
EXPECT_EQ(reader.readWholeFileAfter(8, 1), "ine 3");
} }
TEST_F(DocumentContextReaderTest, testFindCopyrightSingleLine) TEST_F(DocumentContextReaderTest, testFindCopyrightSingleLine)