/* * Copyright (C) 2020-2022 Roy Qu (royqh1979@gmail.com) * * 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 . */ #ifndef CPPPARSER_H #define CPPPARSER_H #include #include #include #include #include "statementmodel.h" #include "cpptokenizer.h" #include "cpppreprocessor.h" class CppParser : public QObject { Q_OBJECT public: struct ParseFileCommand { QString fileName; bool inProject; bool onlyIfNotParsed; bool updateView; std::shared_ptr parserPtr; }; using PParseFileCommand = std::unique_ptr; explicit CppParser(QObject *parent = nullptr); CppParser(const CppParser&)=delete; CppParser& operator=(const CppParser)=delete; ~CppParser(); void addHardDefineByLine(const QString& line); void addProjectFile(const QString &fileName, bool needScan); void addIncludePath(const QString& value); void removeProjectFile(const QString& value); void addProjectIncludePath(const QString& value); void clearIncludePaths(); void clearProjectIncludePaths(); void clearProjectFiles(); QList getListOfFunctions(const QString& fileName, const QString& phrase, int line) const; PStatement findScopeStatement(const QString& filename, int line) const; PParsedFileInfo findFileInfo(const QString &filename) const; QString findFirstTemplateParamOf(const QString& fileName, const QString& phrase, const PStatement& currentScope) const; QString findTemplateParamOf(const QString& fileName, const QString& phrase, int index, const PStatement& currentScope) const; PStatement findFunctionAt(const QString& fileName, int line) const; int findLastOperator(const QString& phrase) const; PStatementList findNamespace(const QString& name) const; // return a list of PSTATEMENTS (of the namespace) PStatement findStatement(const QString& fullname) const; PStatement findStatementOf(const QString& fileName, const QString& phrase, int line) const; PStatement findStatementOf(const QString& fileName, const QString& phrase, const PStatement& currentScope, PStatement& parentScopeType) const; PStatement findStatementOf(const QString& fileName, const QStringList& expression, const PStatement& currentScope) const; PStatement findStatementOf(const QString& fileName, const QStringList& expression, int line) const; PStatement findAliasedStatement(const PStatement& statement) const; QList listTypeStatements(const QString& fileName,int line) const; /** * @brief evaluate the expression * @param fileName * @param expression * @param currentScope * @return the statement of the evaluation result */ PEvalStatement evalExpression(const QString& fileName, QStringList& expression, const PStatement& currentScope) const; PStatement findTypeDefinitionOf(const QString& fileName, const QString& aType, const PStatement& currentClass) const; PStatement findTypeDef(const PStatement& statement, const QString& fileName) const; bool freeze(); // Freeze/Lock (stop reparse while searching) bool freeze(const QString& serialId); // Freeze/Lock (stop reparse while searching) QStringList getClassesList() const; QStringList getFileDirectIncludes(const QString& filename) const; QSet getIncludedFiles(const QString& filename) const; QSet getFileUsings(const QString& filename) const; QString getHeaderFileName(const QString& relativeTo, const QString& headerName, bool fromNext=false) const; void invalidateFile(const QString& fileName); bool isLineVisible(const QString& fileName, int line) const; bool isIncludeLine(const QString &line) const; bool isIncludeNextLine(const QString &line) const; bool isProjectHeaderFile(const QString& fileName) const; bool isSystemHeaderFile(const QString& fileName) const; void parseFile(const QString& fileName, bool inProject, bool onlyIfNotParsed = false, bool updateView = true, std::shared_ptr parserPtr = nullptr); void parseFileList(bool updateView = true); void parseHardDefines(); bool parsing() const; void resetParser(); void unFreeze(); // UnFree/UnLock (reparse while searching) bool fileScanned(const QString& fileName) const; bool isFileParsed(const QString& filename) const; QString prettyPrintStatement(const PStatement& statement, const QString& filename, int line = -1) const; bool enabled() const; void setEnabled(bool newEnabled); const QSet &filesToScan() const; void setFilesToScan(const QSet &newFilesToScan); void setOnGetFileStream(const GetFileStreamCallBack &newOnGetFileStream); int parserId() const; const QString &serialId() const; bool parseLocalHeaders() const; void setParseLocalHeaders(bool newParseLocalHeaders); bool parseGlobalHeaders() const; void setParseGlobalHeaders(bool newParseGlobalHeaders); const QSet& includePaths(); const QSet& projectIncludePaths(); const StatementModel &statementList() const; ParserLanguage language() const; void setLanguage(ParserLanguage newLanguage); const QSet &projectFiles() const; QList namespaces(); signals: void onProgress(const QString& fileName, int total, int current); void onBusy(); void onStartParsing(); void onEndParsing(int total, int updateView); private: PStatement addInheritedStatement( const PStatement& derived, const PStatement& inherit, StatementAccessibility access); PStatement addChildStatement( // support for multiple parents (only typedef struct/union use multiple parents) const PStatement& parent, const QString& fileName, const QString& aType, // "Type" is already in use const QString& command, const QString& args, const QString& noNameArgs, const QString& value, int line, StatementKind kind, const StatementScope& scope, const StatementAccessibility& classScope, StatementProperties properties); // TODO: InheritanceList not supported PStatement addStatement( const PStatement& parent, const QString &fileName, const QString &aType, // "Type" is already in use const QString &command, const QString &args, const QString &noNameArgs, const QString& value, int line, StatementKind kind, const StatementScope& scope, const StatementAccessibility& classScope, StatementProperties properties); PStatement addStatement( const PStatement& parent, const QString &fileName, const QString &aType, // "Type" is already in use const QString &command, int argStart, int argEnd, const QString& value, int line, StatementKind kind, const StatementScope& scope, const StatementAccessibility& classScope, StatementProperties properties); void addMethodParameterStatement(QStringList words,int line, const PStatement& functionStatement); void setInheritance(int index, const PStatement& classStatement, bool isStruct, int maxIndex); bool isCurrentScope(const QString& command) const; void addSoloScopeLevel(PStatement& statement, int line, bool shouldResetBlock=false); // adds new solo level void removeScopeLevel(int line, int maxIndex); // removes level int indexOfMatchingBrace(int startAt) const { return mTokenizer[startAt]->matchIndex; } void internalClear(); QStringList sortFilesByIncludeRelations(const QSet &files); int evaluateConstExpr(int endIndex, bool &ok); int evaluateAdditionConstExpr(int endIndex, bool &ok); int evaluateMultiplyConstExpr(int endIndex, bool &ok); int evaluateConstExprTerm(int endIndex, bool &ok); int evaluateLiteralNumber(int endIndex, bool &ok); bool checkForConcept(KeywordType &keywordType) { return keywordType == KeywordType::Concept; } bool checkForKeyword(KeywordType &keywordType); bool checkForNamespace(KeywordType keywordType, int maxIndex); bool checkForPreprocessor(); // bool checkForLambda(); bool checkForAccessibilitySpecifiers(KeywordType keywordType); bool checkForRequires(KeywordType keywordType) { return keywordType == KeywordType::Requires; } bool checkForStructs(KeywordType keywordType, int maxIndex); bool checkForTypedefEnum(int maxIndex); bool checkForTypedefStruct(int maxIndex); bool checkForUsing(KeywordType keywordType, int maxIndex); void checkAndHandleMethodOrVar(KeywordType keywordType, int maxIndex); QSet internalGetFileUsings(const QString& filename) const; PStatement doFindScopeStatement(const QString& filename, int line) const; PStatementList doFindNamespace(const QString& name) const; // return a list of PSTATEMENTS (of the namespace) PStatement doFindStatement(const QString& fullname) const; PStatement doFindStatementOf(const QString& fileName, const QString& phrase, int line) const; PStatement doFindStatementOf(const QString& fileName, const QString& phrase, const PStatement& currentScope, PStatement& parentScopeType) const; PStatement doFindStatementOf(const QString& fileName, const QString& phrase, const PStatement& currentClass) const; PStatement doFindStatementOf(const QString& fileName, const QStringList& expression, const PStatement& currentScope) const; PStatement doFindStatementOf(const QString& fileName, const QStringList& expression, int line) const; PStatement doFindAliasedStatement(const PStatement& statement, QSet foundSet) const; PStatement doFindAliasedStatement(const PStatement& statement) const; PStatement doFindNoTemplateSpecializationClass(const PStatement& statement) const; QList doListTypeStatements(const QString& fileName,int line) const; PStatement doFindTypeDefinitionOf(const QString& fileName, const QString& aType, const PStatement& currentClass) const; QString doFindFirstTemplateParamOf(const QString& fileName, const QString& phrase, const PStatement& currentScope) const; QString doFindTemplateParamOf(const QString& fileName, const QString& phrase, int index, const PStatement& currentScope) const; QList getListOfFunctions(const QString& fileName, int line, const PStatement& statement, const PStatement& scopeStatement) const; QSet internalGetIncludedFiles(const QString &filename) const; PStatement findMacro(const QString& phrase, const QString& fileName) const; PStatement findMemberOfStatement( const QString& filename, const QString& phrase, const PStatement& scopeStatement) const ; PStatement findMemberOfStatement( const QString& phrase, const PStatement& scopeStatement) const ; QList findMembersOfStatement(const QString& phrase, const PStatement& scopeStatement) const; PStatement findStatementInScope( const QString& name, const QString& noNameArgs, StatementKind kind, const PStatement& scope) const; PStatement findStatementInScope( const QString& name, const PStatement& scope) const; PStatement findStatementInNamespace( const QString& name, const QString& namespaceName) const; //{Find statement starting from startScope} PStatement findStatementStartingFrom(const QString& fileName, const QString& phrase, const PStatement& startScope) const; /** * @brief evaluate the expression (starting from pos) in the scope * @param fileName * @param phraseExpression * @param pos * @param scope * @param previousResult the result of evalution for expression from 0 to pos-1 * @param freeScoped if the expression left is * @return */ PEvalStatement doEvalExpression(const QString& fileName, QStringList phraseExpression, int &pos, const PStatement& scope, const PEvalStatement& previousResult, bool freeScoped, bool expandMacros) const; /* add + / minus - */ PEvalStatement doEvalArithmeticOperation( const QString& fileName, const QStringList& phraseExpression, int &pos, const PStatement& scope, const PEvalStatement& previousResult, bool freeScoped) const; /* Pointer to members .* / ->* */ PEvalStatement doEvalPointerToMembers( const QString& fileName, const QStringList& phraseExpression, int &pos, const PStatement& scope, const PEvalStatement& previousResult, bool freeScoped) const; /* * Dereference * / Address-of & / Type Cast / Prefix increment and decrement * */ PEvalStatement doEvalTypeCast( const QString& fileName, const QStringList& phraseExpression, int &pos, const PStatement& scope, const PEvalStatement& previousResult, bool freeScoped) const; PEvalStatement doEvalMemberAccess( const QString& fileName, const QStringList& phraseExpression, int &pos, const PStatement& scope, const PEvalStatement& previousResult, bool freeScoped) const; PEvalStatement doEvalScopeResolution( const QString& fileName, const QStringList& phraseExpression, int &pos, const PStatement& scope, const PEvalStatement& previousResult, bool freeScoped) const; PEvalStatement doEvalTerm( const QString& fileName, const QStringList& phraseExpression, int &pos, const PStatement& scope, const PEvalStatement& previousResult, bool freeScoped) const; bool expandMacro(QStringList& phraseExpression,int pos, PStatement macro, QList< QSet > &usedMacros) const; PEvalStatement doCreateEvalNamespace(const PStatement& namespaceStatement) const; PEvalStatement doFindAliasedNamespace(const PStatement& namespaceAlias) const; PEvalStatement doCreateEvalType(const QString& fileName,const QString& typeName, const PStatement& parentScope) const; PEvalStatement doCreateEvalType(const QString& fileName,const PStatement& typeStatement) const; PEvalStatement doCreateEvalType(const QString& primitiveType) const; PEvalStatement doCreateTypedEvalVar(const QString& fileName,const QString& typeName, const PStatement& parentScope, const PStatement &baseStatement) const; PEvalStatement doCreateEvalVariable( const QString& fileName, const PStatement& varStatement, const QString& baseTemplateParams, const PStatement& scope) const; PEvalStatement doCreateEvalFunction(const QString& fileName, const PStatement& funcStatement) const; PEvalStatement doCreateEvalLiteral(const QString& type) const; void doSkipInExpression(const QStringList& expression, int&pos, const QString& startSymbol, const QString& endSymbol) const; QString findFunctionPointerName(int startIdx); bool isIdentifier(const QString& token) const { return (!token.isEmpty() && isIdentChar(token.front()) && !token.contains('\"')); } bool isIdentifierOrPointer(const QString& term) const { switch(term[0].unicode()) { case '*': return true; case '\"': case '\'': return false; default: return isIdentChar(term[0]); } } bool isIntegerLiteral(const QString& token) const { if (token.isEmpty()) return false; QChar ch = token.front(); return (ch>='0' && ch<='9' && !token.contains(".") && !token.contains("e")); } bool isFloatLiteral(const QString& token) const { if (token.isEmpty()) return false; QChar ch = token.front(); return (ch>='0' && ch<='9' && (token.contains(".") || token.contains("e"))); } bool isStringLiteral(const QString& token) const { if (token.isEmpty()) return false; return (!token.startsWith('\'') && token.contains('"')); } bool isCharLiteral(const QString& token) const{ if (token.isEmpty()) return false; return (token.startsWith('\'')); } bool isKeyword(const QString& token) const { return mCppKeywords.contains(token); } bool tokenIsIdentifier(const QString& token) const { //token won't be empty return isIdentChar(token[0]); } bool tokenIsTypeOrNonKeyword(const QString& token) const { return tokenIsIdentifier(token) && (mCppTypeKeywords.contains(token) || !mCppKeywords.contains(token) || token=="const"); } PStatement doParseEvalTypeInfo( const QString& fileName, const PStatement& scope, const QString& type, QString& baseType, PStatement& typeStatement, int& pointerLevel, QString& templateParams) const; int getBracketEnd(const QString& s, int startAt) const; StatementAccessibility getClassMemberAccessibility(const QString& text) const; StatementAccessibility getClassMemberAccessibility(KeywordType keywordType) const; // int getCurrentBlockBeginSkip() const; // int getCurrentBlockEndSkip() const; int getCurrentInlineNamespaceEndSkip(int endIndex) const; PStatement getCurrentScope() const; // gets last item from last level QString getTemplateParam(const PStatement& statement, const QString& filename, const QString& phrase, int index, const PStatement& currentScope) const; int getTemplateParamStart(const QString& s, int startAt, int index) const; int getTemplateParamEnd(const QString& s, int startAt) const ; void getFullNamespace( const QString& phrase, QString& sNamespace, QString& member) const; QString getFullStatementName( const QString& command, const PStatement& parent) const; PStatement getIncompleteClass( const QString& command, const PStatement& parentScope); QString getScopePrefix(const PStatement& statement) const; StatementScope getScope(); QString getStatementKey(const QString& sName, const QString& sType, const QString& sNoNameArgs) const; PStatement getTypeDef(const PStatement& statement, const QString& fileName, const QString& aType) const; // void handleCatchBlock(); void doAddVar(const QString& name, const QString& type, bool isConst, const QString& suffix); void handleConcept(int maxIndex); void handleEnum(bool isTypedef, int maxIndex); void handleForBlock(int maxIndex); void handleKeyword(KeywordType skipType, int maxIndex); void handleLambda(int index, int maxIndex); void handleOperatorOverloading( const QString& sType, int operatorTokenIndex, bool isStatic, int maxIndex); void handleMethod( StatementKind functionKind, const QString& sType, const QString& sName, int argStart, bool isStatic, bool isFriend, bool isOperatorOverload, int maxIndex); void handleNamespace(KeywordType skipType, int maxIndex); void handleOtherTypedefs(int maxIndex); void handlePreprocessor(); void handleAccessibilitySpecifiers(KeywordType keywordType, int maxIndex); bool handleStatement(int maxIndex); void handleStructs(bool isTypedef, int maxIndex); void handleStructredBinding(const QString& sType, int maxIndex); void handleUsing(int maxIndex); void handleVar(const QString& typePrefix,bool isExtern,bool isStatic, int maxIndex); void handleInheritance(PStatement derivedClass, PClassInheritanceInfo pInfo); void handleInheritances(); void skipRequires(int maxIndex); void internalParse(const QString& fileName); // function FindMacroDefine(const Command: AnsiString): PStatement; void inheritClassStatement( const PStatement& derived, bool isStruct, const PStatement& base, StatementAccessibility access); PStatement doFindStatementInScope(const QString& name, const QString& noNameArgs, StatementKind kind, const PStatement& scope) const; void internalInvalidateFile(const QString& fileName); void internalInvalidateFiles(const QSet& files); QSet calculateFilesToBeReparsed(const QString& fileName); void scanMethodArgs( const PStatement& functionStatement, int argStart); QSet parseLambdaCaptures(int index); QString splitPhrase(const QString& phrase, QString& sClazz, QString& sOperator, QString &sMember) const; QString removeTemplateParams(const QString& phrase) const; bool splitLastMember(const QString& token, QString& lastMember, QString& remaining); bool isSpaceChar(const QChar& ch) const { return ch==' ' || ch =='\t'; } bool isWordChar(const QChar& ch) const { return ch.isLetter() || ch == '_' || ch == '*' || ch == '&'; } bool isIdentifier(const QChar& ch) const { return ch.isLetter() || ch == '_' || ch == '~' ; } bool isIdentChar(const QChar& ch) const { return ch.isLetter() || ch == '_'; } bool isDigitChar(const QChar& ch) const { return (ch>='0' && ch<='9'); } bool isInvalidFunctionArgsSuffixChar(const QChar& ch) const { // && switch(ch.unicode()){ case '.': case '-': case '+': case '/': case '%': case '*': case '|': case '?': return true; default: return false; } } /*'(', ';', ':', '{', '}', '#' */ bool isSeperator(const QChar& ch) const { switch(ch.unicode()){ case '(': case ';': case ':': case '{': case '}': case '#': return true; default: return false; } } /*';', '{', '}'*/ bool isblockChar(const QChar& ch) const { switch(ch.unicode()){ case ';': case '{': case '}': return true; default: return false; } } /* '#', ',', ';', ':', '{', '}', '!', '/', '+', '-', '<', '>' */ bool isInvalidVarPrefixChar(const QChar& ch) const { switch (ch.unicode()) { case '#': case ',': case ';': case ':': case '{': case '}': case '!': case '/': case '+': case '-': case '<': case '>': return true; default: return false; } } /*'{', '}' */ bool isBraceChar(const QChar& ch) const { return ch == '{' || ch =='}'; } bool isLineChar(const QChar& ch) const { return ch=='\n' || ch=='\r'; } bool isNotFuncArgs(int startIndex); /** * @brief Test if a statement is a class/struct/union/namespace/function * @param kind * @return */ bool isNamedScope(StatementKind kind) const; /** * @brief Test if a statement is a class/struct/union/enum/enum class/typedef * @param kind * @return */ bool isTypeStatement(StatementKind kind) const; void updateSerialId(); int indexOfNextSemicolon(int index, int maxIndex); int indexOfNextPeriodOrSemicolon(int index, int maxIndex); int indexOfNextSemicolonOrLeftBrace(int index, int maxIndex); int indexOfNextColon(int index, int maxIndex); int indexOfNextLeftBrace(int index, int maxIndex); int indexPassParenthesis(int index, int maxIndex); int indexOfNextRightParenthesis(int index, int maxIndex); // int indexPassBraces(int index); int skipAssignment(int index, int maxIndex); void skipNextSemicolon(int index, int maxIndex); int moveToEndOfStatement(int index, bool checkLambda, int maxIndex); // int moveToNextAssignmentOrEndOfStatement(int index, bool checkLambda, int endIndex=-1); void skipParenthesis(int index, int maxIndex); QString mergeArgs(int startIndex, int endIndex); void parseCommandTypeAndArgs(QString& command, QString& typeSuffix, QString& args) const; QString expandMacro(const QString& text) const; static QStringList splitExpression(const QString& expr); private: int mParserId; ParserLanguage mLanguage; int mSerialCount; QString mSerialId; int mUniqId; bool mEnabled; int mIndex; bool mIsHeader; bool mIsSystemHeader; QString mCurrentFile; // stack list , each element is a list of one/many scopes(like intypedef struct s1,s2; // It's used for store scope nesting infos QVector mCurrentScope; QVector mMemberAccessibilities; StatementAccessibility mCurrentMemberAccessibility; StatementModel mStatementList; //It's used in preprocessor, so we can't use fIncludeList instead CppTokenizer mTokenizer; CppPreprocessor mPreprocessor; QSet mProjectFiles; // QVector mBlockBeginSkips; //list of for/catch block begin token index; // QVector mBlockEndSkips; //list of for/catch block end token index; QVector mInlineNamespaceEndSkips; // list for inline namespace end token index; QSet mFilesToScan; // list of base files to scan int mFilesScannedCount; // count of files that have been scanned int mFilesToScanCount; // count of files and files included in files that have to be scanned bool mParseLocalHeaders; bool mParseGlobalHeaders; bool mIsProjectFile; int mLockCount; // lock(don't reparse) when we need to find statements in a batch bool mParsing; QHash mNamespaces; // namespace and the statements in its scope QList mClassInheritances; QSet mInlineNamespaces; #ifdef QT_DEBUG int mLastIndex; #endif mutable QRecursiveMutex mMutex; QMap mCppKeywords; QSet mCppTypeKeywords; PParseFileCommand mLastParseFileCommand; }; using PCppParser = std::shared_ptr; class CppFileParserThread : public QThread { Q_OBJECT public: explicit CppFileParserThread( PCppParser parser, QString fileName, bool inProject, bool onlyIfNotParsed = false, bool updateView = true, QObject *parent = nullptr); private: PCppParser mParser; QString mFileName; bool mInProject; bool mOnlyIfNotParsed; bool mUpdateView; // QThread interface protected: void run() override; }; using PCppParserThread = std::shared_ptr; class CppFileListParserThread: public QThread { Q_OBJECT public: explicit CppFileListParserThread( PCppParser parser, bool updateView = true, QObject *parent = nullptr); private: PCppParser mParser; bool mUpdateView; // QThread interface protected: void run() override; }; void parseFile( PCppParser parser, const QString& fileName, bool inProject, bool onlyIfNotParsed = false, bool updateView = true); void parseFileList( PCppParser parser, bool updateView = true); #endif // CPPPARSER_H