File indexing completed on 2024-05-19 05:42:02

 // ct_lvtclp_logicaldepscanner.h                                      -*-C++-*-
 
 /*
 // Copyright 2023 Codethink Ltd <codethink@codethink.co.uk>
 // SPDX-License-Identifier: Apache-2.0
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
 */
 
 #ifndef INCLUDED_CT_LVTCLP_LOGICALDEPSCANNER
 #define INCLUDED_CT_LVTCLP_LOGICALDEPSCANNER
 
 //@PURPOSE: A factory for lvtclp::CodebaseDbAction
 //
 //@CLASSES: lvtclp::LogicalDepActionFactory Implements FrontendActionFactory
 //          for scanning for logical dependencies
 //
 //@SEE_ALSO: clang::tooling::FrontendActionFactory
 
 #include <lvtclp_export.h>
 
 #include <clang/Tooling/Tooling.h>
 
 #include <filesystem>
 #include <functional>
 #include <memory>
 #include <optional>
 #include <string>
 #include <vector>
 
 #include <QString>
 
 namespace Codethink::lvtmdb {
 class ObjectStore;
 }
 
 namespace Codethink::lvtclp {
 
 // =============================
 // class LogicalDepActionFactory
 // =============================
 
 using HandleCppCommentsCallback_f = std::function<void(
     const std::string& filename, const std::string& briefText, unsigned startLine, unsigned endLine)>;
 
 class LVTCLP_EXPORT LogicalDepActionFactory : public clang::tooling::FrontendActionFactory {
     // A factory for CodebaseDbFrontendAction
 
     // DATA
     lvtmdb::ObjectStore& d_memDb;
     // Database session generator
 
     std::filesystem::path d_prefix;
 
     std::vector<std::filesystem::path> d_nonLakosianDirs;
     std::vector<std::pair<std::string, std::string>> d_thirdPartyDirs;
 
     std::function<void(const std::string&)> d_filenameCallback;
     // Callback whenever we start to process a new file
 
     std::optional<std::function<void(const std::string&, long)>> d_messageCallback;
     // Callback to send errors to the UI.
 
     bool d_catchCodeAnalysisOutput;
 
     std::optional<HandleCppCommentsCallback_f> d_handleCppCommentsCallback;
 
   public:
     // CREATORS
     LogicalDepActionFactory(lvtmdb::ObjectStore& memDb,
                             std::filesystem::path prefix,
                             std::vector<std::filesystem::path> nonLakosians,
                             std::vector<std::pair<std::string, std::string>> d_thirdPartyDirs,
                             std::function<void(const std::string&)> filenameCallback,
                             std::optional<std::function<void(const std::string&, long)>> messageCallback,
                             bool catchCodeAnalysisOutput,
                             std::optional<HandleCppCommentsCallback_f> handleCppCommentsCallback = std::nullopt);
 
     // MANIPULATORS
     std::unique_ptr<clang::FrontendAction> create() override;
     // Construct a new clang::FrontendAction
 };
 
 } // end namespace Codethink::lvtclp
 
 #endif