File indexing completed on 2024-05-19 05:42:02
0001 // ct_lvtclp_fileutil.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_FILEUTIL 0021 #define INCLUDED_CT_LVTCLP_FILEUTIL 0022 0023 // Helper functions for dealing with paths 0024 #include <lvtclp_export.h> 0025 0026 #include <filesystem> 0027 #include <vector> 0028 0029 namespace Codethink::lvtclp { 0030 0031 // ================ 0032 // struct FileUtil 0033 // ================ 0034 0035 struct LVTCLP_EXPORT FileUtil { 0036 // This struct groups functions for dealing with files 0037 0038 public: 0039 // CLASS METHODS 0040 0041 static bool pathStartsWith(const std::filesystem::path& prefix, const std::filesystem::path& path); 0042 // Returns true if path starts with prefix 0043 // path and prefix should be canonical 0044 0045 static std::filesystem::path nonPrefixPart(const std::filesystem::path& prefix, const std::filesystem::path& path); 0046 // Returns the suffix of path which isn't in the prefix 0047 // e.g. path: /foo/bar/baz, prefix = /foo -> bar/baz 0048 // path and prefix should be canonical 0049 0050 static std::filesystem::path commonParent(const std::vector<std::filesystem::path>& paths); 0051 // Finds the common parent path of all of the supplied paths 0052 // The paths should be canonical 0053 }; 0054 0055 } // end namespace Codethink::lvtclp 0056 0057 #endif // !INCLUDED_CT_LVTCLP_FILEUTIL