Skip to content

Commit aed181f

Browse files
author
Krystian Ligenza
authored
Merge pull request #1182 from Autodesk/sabrih/MAYA-109891/ghc_file_systemf
MAYA-109891: Remove dependency on boost filesystem/system.
2 parents 49ec9d0 + 119b3bf commit aed181f

File tree

15 files changed

+94
-69
lines changed

15 files changed

+94
-69
lines changed

‎CMakeLists.txt

+5
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,11 @@ endif()
151151
#------------------------------------------------------------------------------
152152
include(cmake/compiler_config.cmake)
153153

154+
#------------------------------------------------------------------------------
155+
# gulark filesystem
156+
#------------------------------------------------------------------------------
157+
include(cmake/gulark.cmake)
158+
154159
#------------------------------------------------------------------------------
155160
# test
156161
#------------------------------------------------------------------------------

‎cmake/gulark.cmake

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#
2+
# Copyright 2021 Autodesk
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
17+
include(FetchContent)
18+
19+
set(FETCHCONTENT_QUIET OFF)
20+
21+
FetchContent_Declare(
22+
gulark
23+
GIT_REPOSITORY https://github.com/gulrak/filesystem.git
24+
GIT_TAG v1.5.0
25+
USES_TERMINAL_DOWNLOAD TRUE
26+
GIT_CONFIG advice.detachedHead=false
27+
)
28+
29+
FetchContent_MakeAvailable(gulark)

‎doc/build.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -189,11 +189,11 @@ Test project /Users/sabrih/Desktop/workspace/build/Debug/plugin/al
189189

190190
##### Boost:
191191

192-
Currently the Animal Logic plugin has a dependency on some of the boost components ( e.g thread, filesystem ). When building Pixar USD, one needs to pass the following key,value paired arguments for boost to include those components:
192+
Currently the Animal Logic plugin has a dependency on some of the boost components. When building Pixar USD, one needs to pass the following key,value paired arguments for boost to include those components:
193193
e.g
194194

195195
```
196-
python build_usd.py ~/Desktop/BUILD --build-args boost,"--with-date_time --with-thread --with-system --with-filesystem"
196+
python build_usd.py ~/Desktop/BUILD --build-args boost,"--with-date_time"
197197
```
198198

199199
***NOTE:*** ```--build-args``` needs to be passed at the very end of command, after build/install location.

‎doc/codingGuidelines.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -222,10 +222,13 @@ Recent extensions to the C++ standard introduce many features previously only fo
222222
Our library currently has the following boost dependencies:
223223
* `boost::python`
224224
* `boost::hash_combine` (see [this proposal](http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2017/p0814r0.pdf) )
225-
* `boost::filesystem` (preferable to replace with Pixar USD arch/fileSystem)
226-
* `boost::system`
227225
* `boost::make_shared` (preferable to replace with `std::shared_ptr`)
228226

227+
***Update:***
228+
* `boost::filesystem` and `boost::system` are removed. Until the transition to C++17 std::filesystem, [ghc::filesystem](https://github.com/gulrak/filesystem) must be used as an alternative across the project.
229+
230+
* Dependency on `boost::thread` is removed from Animal Logic plugin.
231+
229232
## Modern C++
230233
Our goal is to develop [maya-usd](https://github.com/autodesk/maya-usd) following modern C++ practices. We’ll follow the [C++ Core Guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) and pay attention to:
231234
* `using` (vs `typedef`) keyword

‎lib/mayaUsd/CMakeLists.txt

+1-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ endif()
2626
if(MAYAUSD_DEFINE_BOOST_DEBUG_PYTHON_FLAG)
2727
set(Boost_USE_DEBUG_PYTHON ON)
2828
endif()
29-
find_package(Boost COMPONENTS filesystem system REQUIRED)
3029

3130
# -----------------------------------------------------------------------------
3231
# compiler configuration
@@ -119,8 +118,7 @@ target_link_libraries(${PROJECT_NAME}
119118
${MAYA_LIBRARIES}
120119
mayaUsdUtils
121120
PRIVATE
122-
Boost::filesystem
123-
Boost::system
121+
ghc_filesystem
124122
)
125123

126124
# -----------------------------------------------------------------------------

‎lib/mayaUsd/nodes/proxyShapeBase.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@
8787
#include <maya/MTime.h>
8888
#include <maya/MViewport2Renderer.h>
8989

90-
#include <boost/filesystem.hpp>
90+
#include <ghc/filesystem.hpp>
9191

9292
#include <map>
9393
#include <string>
@@ -625,7 +625,7 @@ MStatus MayaUsdProxyShapeBase::computeInStageDataCached(MDataBlock& dataBlock)
625625
"ProxyShapeBase::reloadStage original USD file path is %s\n",
626626
fileString.c_str());
627627

628-
boost::filesystem::path filestringPath(fileString);
628+
ghc::filesystem::path filestringPath(fileString);
629629
if (filestringPath.is_absolute()) {
630630
fileString = UsdMayaUtilFileSystem::resolvePath(fileString);
631631
TF_DEBUG(USDMAYA_PROXYSHAPEBASE)

‎lib/mayaUsd/render/vp2RenderDelegate/material.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
#include <maya/MUintArray.h>
4343
#include <maya/MViewport2Renderer.h>
4444

45-
#include <boost/filesystem.hpp>
45+
#include <ghc/filesystem.hpp>
4646

4747
#include <iostream>
4848
#include <string>
@@ -677,7 +677,7 @@ void HdVP2Material::Sync(
677677
<< _GenerateXMLString(dispNet) << "\n";
678678

679679
if (_surfaceShader) {
680-
auto tmpDir = boost::filesystem::temp_directory_path();
680+
auto tmpDir = ghc::filesystem::temp_directory_path();
681681
tmpDir /= "HdVP2Material_";
682682
tmpDir += id.GetName();
683683
tmpDir += ".txt";

‎lib/mayaUsd/utils/utilFileSystem.cpp

+32-7
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,30 @@
2525
#include <maya/MGlobal.h>
2626
#include <maya/MItDependencyNodes.h>
2727

28-
#include <boost/filesystem.hpp>
28+
#include <ghc/filesystem.hpp>
29+
30+
#include <random>
31+
#include <system_error>
32+
33+
namespace {
34+
std::string generateUniqueName()
35+
{
36+
const auto len { 6 };
37+
std::string uniqueName;
38+
uniqueName.reserve(len);
39+
40+
const std::string alphaNum { "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" };
41+
42+
std::random_device rd;
43+
std::mt19937 gen(rd());
44+
std::uniform_int_distribution<> dis(0, alphaNum.size() - 1);
45+
46+
for (auto i = 0; i < len; ++i) {
47+
uniqueName += (alphaNum[dis(gen)]);
48+
}
49+
return uniqueName;
50+
}
51+
} // namespace
2952

3053
PXR_NAMESPACE_USING_DIRECTIVE
3154

@@ -37,7 +60,7 @@ std::string UsdMayaUtilFileSystem::resolvePath(const std::string& filePath)
3760

3861
std::string UsdMayaUtilFileSystem::getDir(const std::string& fullFilePath)
3962
{
40-
return boost::filesystem::path(fullFilePath).parent_path().string();
63+
return ghc::filesystem::path(fullFilePath).parent_path().string();
4164
}
4265

4366
std::string UsdMayaUtilFileSystem::getMayaReferencedFileDir(const MObject& proxyShapeNode)
@@ -130,8 +153,10 @@ std::string UsdMayaUtilFileSystem::resolveRelativePathWithinMayaContext(
130153
if (currentFileDir.empty())
131154
return relativeFilePath;
132155

133-
boost::system::error_code errorCode;
134-
auto path = boost::filesystem::canonical(relativeFilePath, currentFileDir, errorCode);
156+
std::error_code errorCode;
157+
auto path = ghc::filesystem::canonical(
158+
ghc::filesystem::path(currentFileDir).append(relativeFilePath), errorCode);
159+
135160
if (errorCode) {
136161
// file does not exist
137162
return std::string();
@@ -145,10 +170,10 @@ std::string UsdMayaUtilFileSystem::getUniqueFileName(
145170
const std::string& basename,
146171
const std::string& ext)
147172
{
148-
std::string fileNameModel = basename + "-%%%%%%." + ext;
173+
const std::string fileNameModel = basename + '-' + generateUniqueName() + '.' + ext;
149174

150-
boost::filesystem::path pathModel(dir);
175+
ghc::filesystem::path pathModel(dir);
151176
pathModel.append(fileNameModel);
152177

153-
return boost::filesystem::unique_path(pathModel).generic_string();
178+
return pathModel.generic_string();
154179
}

‎lib/usd/translators/CMakeLists.txt

+1-10
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,6 @@ set(LIBRARY_INSTALL_PATH
1010

1111
add_library(${TARGET_NAME} SHARED)
1212

13-
#------------------------------------------------------------------------------
14-
# modules and definitions
15-
#------------------------------------------------------------------------------
16-
if(NOT DEFINED ENV{BOOST_ROOT})
17-
set(ENV{BOOST_ROOT} ${PXR_USD_LOCATION})
18-
endif()
19-
find_package(Boost COMPONENTS filesystem system REQUIRED)
20-
2113
# -----------------------------------------------------------------------------
2214
# sources
2315
# -----------------------------------------------------------------------------
@@ -90,8 +82,7 @@ target_link_libraries(${TARGET_NAME}
9082
mayaUsd
9183
mayaUsd_Schemas
9284
basePxrUsdPreviewSurface
93-
Boost::filesystem
94-
Boost::system
85+
ghc_filesystem
9586
)
9687

9788
# -----------------------------------------------------------------------------

‎lib/usd/translators/shading/usdFileTextureWriter.cpp

+5-5
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,10 @@
4747
#include <maya/MStatus.h>
4848
#include <maya/MString.h>
4949

50-
#include <boost/filesystem.hpp>
50+
#include <ghc/filesystem.hpp>
5151

5252
#include <regex>
53+
#include <system_error>
5354

5455
PXR_NAMESPACE_OPEN_SCOPE
5556

@@ -288,11 +289,10 @@ void PxrUsdTranslators_FileTextureWriter::Write(const UsdTimeCode& usdTime)
288289
const std::string fileName = _GetExportArgs().GetResolvedFileName();
289290
TfToken fileExt(TfGetExtension(fileName));
290291
if (fileExt != UsdMayaTranslatorTokens->UsdFileExtensionPackage) {
291-
boost::filesystem::path usdDir(fileName);
292+
ghc::filesystem::path usdDir(fileName);
292293
usdDir = usdDir.parent_path();
293-
boost::system::error_code ec;
294-
boost::filesystem::path relativePath
295-
= boost::filesystem::relative(fileTextureName, usdDir, ec);
294+
std::error_code ec;
295+
ghc::filesystem::path relativePath = ghc::filesystem::relative(fileTextureName, usdDir, ec);
296296
if (!ec && !relativePath.empty()) {
297297
fileTextureName = relativePath.generic_string();
298298
}

‎plugin/al/CMakeLists.txt

+1-10
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ if (POLICY CMP0026)
77
cmake_policy(SET CMP0026 OLD)
88
endif()
99

10-
set(NEED_BOOST_FILESYSTEM ON)
1110
set(CMAKE_VERBOSE_MAKEFILE OFF)
1211
set(CMAKE_INCLUDE_CURRENT_DIR ON)
1312
if(NOT DEFINED ENV{BOOST_ROOT})
@@ -24,15 +23,7 @@ option(SKIP_USDMAYA_TESTS "Build tests" OFF)
2423
# FindBoost is particularly buggy, and doesn't like custom boost locations.
2524
# Adding specific components forces calls to _Boost_find_library, which
2625
# is the rationale for listing them here.
27-
set(Boost_FIND_COMPONENTS
28-
thread
29-
)
30-
if(NEED_BOOST_FILESYSTEM)
31-
list(APPEND Boost_FIND_COMPONENTS
32-
filesystem
33-
system
34-
)
35-
endif()
26+
set(Boost_FIND_COMPONENTS "")
3627
if(WIN32)
3728
list(APPEND Boost_FIND_COMPONENTS
3829
chrono

‎plugin/al/lib/AL_USDMaya/AL/usdmaya/nodes/LayerManager.cpp

+4-7
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@
3131
#include <maya/MItDependencyNodes.h>
3232
#include <maya/MPlugArray.h>
3333

34-
#include <boost/thread.hpp>
35-
#include <boost/thread/shared_lock_guard.hpp>
36-
3734
#include <mutex>
3835

3936
namespace {
@@ -354,7 +351,7 @@ bool LayerManager::addLayer(SdfLayerHandle layer, const std::string& identifier)
354351
MGlobal::displayError("LayerManager::addLayer - given layer is no longer valid");
355352
return false;
356353
}
357-
boost::unique_lock<boost::shared_mutex> lock(m_layersMutex);
354+
std::unique_lock<std::shared_timed_mutex> lock(m_layersMutex);
358355
return m_layerDatabase.addLayer(layerRef, identifier);
359356
}
360357

@@ -366,14 +363,14 @@ bool LayerManager::removeLayer(SdfLayerHandle layer)
366363
MGlobal::displayError("LayerManager::removeLayer - given layer is no longer valid");
367364
return false;
368365
}
369-
boost::unique_lock<boost::shared_mutex> lock(m_layersMutex);
366+
std::unique_lock<std::shared_timed_mutex> lock(m_layersMutex);
370367
return m_layerDatabase.removeLayer(layerRef);
371368
}
372369

373370
//----------------------------------------------------------------------------------------------------------------------
374371
SdfLayerHandle LayerManager::findLayer(std::string identifier)
375372
{
376-
boost::shared_lock_guard<boost::shared_mutex> lock(m_layersMutex);
373+
std::shared_lock<std::shared_timed_mutex> lock(m_layersMutex);
377374
return m_layerDatabase.findLayer(identifier);
378375
}
379376

@@ -404,7 +401,7 @@ MStatus LayerManager::populateSerialisationAttributes()
404401
MArrayDataHandle layersArrayHandle = dataBlock.outputArrayValue(m_layers, &status);
405402
AL_MAYA_CHECK_ERROR(status, errorString);
406403
{
407-
boost::shared_lock_guard<boost::shared_mutex> lock(m_layersMutex);
404+
std::shared_lock<std::shared_timed_mutex> lock(m_layersMutex);
408405
MArrayDataBuilder builder(&dataBlock, layers(), m_layerDatabase.max_size(), &status);
409406
AL_MAYA_CHECK_ERROR(status, errorString);
410407
std::string temp;

‎plugin/al/lib/AL_USDMaya/AL/usdmaya/nodes/LayerManager.h

+2-14
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,7 @@
2525

2626
#include <map>
2727
#include <set>
28-
29-
// On Windows, against certain versions of Maya and with strict compiler
30-
// settings on, we are getting warning-as-error problems with a couple
31-
// boost includes. Disabling those warnings for the specific includes
32-
// for now instead of disabling the strict settings at a higher level.
33-
#ifdef _MSC_VER
34-
#pragma warning(push)
35-
#pragma warning(disable : 4002)
36-
#endif
37-
#include <boost/thread.hpp>
38-
#ifdef _MSC_VER
39-
#pragma warning(pop)
40-
#endif
28+
#include <shared_mutex>
4129

4230
PXR_NAMESPACE_USING_DIRECTIVE
4331

@@ -383,7 +371,7 @@ class LayerManager
383371
// it COULDN'T be. (I haven't really looked into the way maya's new multi-threaded node
384372
// evaluation works, for instance.) This is essentially a globally shared resource, so I figured
385373
// better be safe...
386-
boost::shared_mutex m_layersMutex;
374+
std::shared_timed_mutex m_layersMutex;
387375

388376
//--------------------------------------------------------------------------------------------------------------------
389377
/// MPxNode overrides

‎plugin/al/lib/AL_USDMaya/AL/usdmaya/nodes/ProxyShape.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
#include <maya/MTime.h>
6464
#include <maya/MViewport2Renderer.h>
6565

66-
#include <boost/filesystem.hpp>
66+
#include <ghc/filesystem.hpp>
6767

6868
#if defined(WANT_UFE_BUILD)
6969
#include "ufe/path.h"
@@ -1246,7 +1246,7 @@ void ProxyShape::loadStage()
12461246
}
12471247
}
12481248
} else {
1249-
boost::filesystem::path filestringPath(fileString);
1249+
ghc::filesystem::path filestringPath(fileString);
12501250
if (filestringPath.is_absolute()) {
12511251
fileString = UsdMayaUtilFileSystem::resolvePath(fileString);
12521252
TF_DEBUG(ALUSDMAYA_TRANSLATORS)

‎plugin/al/lib/AL_USDMaya/CMakeLists.txt

+1-3
Original file line numberDiff line numberDiff line change
@@ -209,18 +209,16 @@ target_link_libraries(${LIBRARY_NAME}
209209
usdImagingGL
210210
vt
211211
${Boost_PYTHON_LIBRARY}
212-
$<IF:$<VERSION_GREATER_EQUAL:${Boost_VERSION},${boost_1_70_0_ver_string}>,Boost::thread,${Boost_THREAD_LIBRARY}>
213212
$<$<BOOL:${IS_WINDOWS}>:Boost::chrono>
214213
$<$<BOOL:${IS_WINDOWS}>:Boost::date_time>
215-
$<$<BOOL:${NEED_BOOST_FILESYSTEM}>:Boost::filesystem>
216-
$<$<BOOL:${NEED_BOOST_FILESYSTEM}>:Boost::system>
217214
${MAYA_Foundation_LIBRARY}
218215
${MAYA_OpenMayaAnim_LIBRARY}
219216
${MAYA_OpenMayaUI_LIBRARY}
220217
${MAYA_OpenMaya_LIBRARY}
221218
${MAYA_OpenMayaRender_LIBRARY}
222219
mayaUsd
223220
$<$<BOOL:${UFE_FOUND}>:${UFE_LIBRARY}>
221+
ghc_filesystem
224222
)
225223

226224
install(TARGETS ${LIBRARY_NAME}

0 commit comments

Comments
 (0)