File indexing completed on 2024-05-19 05:41:59

0001 // ct_lvtclp_componentutil.h                                          -*-C++-*-
0002 
0003 /*
0004 // Copyright 2023 Codethink Ltd <codethink@codethink.co.uk>
0005 // SPDX-License-Identifier: Apache-2.0
0006 //
0007 // Licensed under the Apache License, Version 2.0 (the "License");
0008 // you may not use this file except in compliance with the License.
0009 // You may obtain a copy of the License at
0010 //
0011 //     http://www.apache.org/licenses/LICENSE-2.0
0012 //
0013 // Unless required by applicable law or agreed to in writing, software
0014 // distributed under the License is distributed on an "AS IS" BASIS,
0015 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0016 // See the License for the specific language governing permissions and
0017 // limitations under the License.
0018 */
0019 
0020 #ifndef INCLUDED_CT_LVTCLP_COMPONENTUTIL
0021 #define INCLUDED_CT_LVTCLP_COMPONENTUTIL
0022 
0023 //@PURPOSE: Derive component information from files in a database
0024 
0025 #include <lvtclp_export.h>
0026 
0027 #include <filesystem>
0028 
0029 namespace Codethink::lvtmdb {
0030 class ComponentObject;
0031 }
0032 namespace Codethink::lvtmdb {
0033 class ObjectStore;
0034 }
0035 namespace Codethink::lvtmdb {
0036 class PackageObject;
0037 }
0038 
0039 namespace Codethink::lvtclp {
0040 
0041 struct LVTCLP_EXPORT ComponentUtil {
0042   public:
0043     // CLASS METHODS
0044     static lvtmdb::ComponentObject *
0045     addComponent(const std::filesystem::path& filePath, lvtmdb::PackageObject *parent, lvtmdb::ObjectStore& memDb);
0046     // If one is not already present, add a component for the file
0047     // Assumes that memDb is already locked for writing
0048     // NOTE: this does not look for other files which might be in the
0049     //       component
0050 };
0051 
0052 } // namespace Codethink::lvtclp
0053 
0054 #endif // INCLUDED_CT_LVTCLP_COMPONENTUTIL