Classes
class	CFile

Functions
template<typename... T>
std::string	JoinPaths (T const &...paths)

std::string	JoinPath (const std::vector< std::string > &path_components)

std::string	JoinPath (const std::string &path_component1, const std::string &path_component2)

std::string	GetEnvVar (const std::string &env_var)

std::string	GetHomeDirectory ()
	Get the HOME directory for the user. More...

std::string	EnsureTrailingSlash (const std::string &str)

bool	HasFileExtension (const std::string &file_name, const std::string &ext)

void	SplitFileExtension (const std::string &path, std::string root, std::string ext)

bool	CopyFile (const std::string &from, const std::string &to)
	Copy a file. More...

bool	CopyDir (const std::string &from, const std::string &to)
	Copy a directory. More...

bool	CopyA (const std::string &src_path, const std::string &dst_path)

bool	Copy (const std::string &from, const std::string &to, bool include_parent_dir=false, const std::string &extname="")
	Copy a file or directory. More...

std::string	GetFileExtensionInLowerCase (const std::string &filename)

std::string	GetFileNameWithoutExtension (const std::string &filename)

std::string	GetFileNameWithoutDirectory (const std::string &filename)

std::string	GetFileParentDirectory (const std::string &filename)

std::string	GetRegularizedDirectoryName (const std::string &directory)

std::string	GetFileBaseName (const std::string &filename)

std::string	GetWorkingDirectory ()

std::vector< std::string >	GetPathComponents (const std::string &path)

std::string	GetTempDirectoryPath ()

bool	ChangeWorkingDirectory (const std::string &directory)

bool	IsFile (const std::string &filename)

bool	IsDirectory (const std::string &directory)

bool	DirectoryExists (const std::string &directory)

bool	DirectoryIsEmpty (const std::string &directory)

bool	EnsureDirectory (const std::string &directory_path)
	Check if a specified directory specified by directory_path exists. If not, recursively create the directory (and its parents). More...

bool	MakeDirectory (const std::string &directory)

bool	MakeDirectoryHierarchy (const std::string &directory)

bool	DeleteDirectory (const std::string &directory)

bool	FileExists (const std::string &filename)

bool	RemoveFile (const std::string &filename)

bool	ListDirectory (const std::string &directory, std::vector< std::string > &subdirs, std::vector< std::string > &filenames)

bool	ListFilesInDirectory (const std::string &directory, std::vector< std::string > &filenames)

bool	ListFilesInDirectoryWithExtension (const std::string &directory, const std::string &extname, std::vector< std::string > &filenames)

std::vector< std::string >	FindFilesRecursively (const std::string &directory, std::function< bool(const std::string &)> is_match)

FILE *	FOpen (const std::string &filename, const std::string &mode)

std::string	GetIOErrorString (const int errnoVal)

bool	FReadToBuffer (const std::string &path, std::vector< char > &bytes, std::string *errorStr)

std::string	AddIfExist (const std::string &path, const std::vector< std::string > &folder_names)

Function Documentation

◆ AddIfExist()

std::string cloudViewer::utility::filesystem::AddIfExist	(	const std::string &	path,
		const std::vector< std::string > &	folder_names
	)

Definition at line 726 of file FileSystem.cpp.

References DirectoryExists(), JoinPath(), and cloudViewer::t::geometry::path.

◆ ChangeWorkingDirectory()

bool cloudViewer::utility::filesystem::ChangeWorkingDirectory ( const std::string & directory )

Definition at line 427 of file FileSystem.cpp.

Referenced by cloudViewer::visualization::gui::FileDialog::OnDone(), and cloudViewer::visualization::pybind_visualization_utility_methods().

◆ Copy()

bool cloudViewer::utility::filesystem::Copy	(	const std::string &	from,
		const std::string &	to,
		bool	include_parent_dir = `false`,
		const std::string &	extname = `""`
	)

Copy a file or directory.

Parameters

from	The path to copy from.
to	The path to copy to.
include_parent_dir	Whether copy parent directory or not.

Returns: If the action is successful.

Definition at line 249 of file FileSystem.cpp.

References CopyDir(), CopyFile(), GetFileNameWithoutDirectory(), IsDirectory(), JoinPaths(), ListFilesInDirectoryWithExtension(), and LogWarning.

Referenced by cloudViewer::data::DownloadDataset::DownloadDataset(), and ecvCustomQListWidget::keyPressEvent().

◆ CopyA()

bool cloudViewer::utility::filesystem::CopyA	(	const std::string &	src_path,
		const std::string &	dst_path
	)

Definition at line 236 of file FileSystem.cpp.

References copy, and LogWarning.

Referenced by CopyFile().

◆ CopyDir()

bool cloudViewer::utility::filesystem::CopyDir	(	const std::string &	from,
		const std::string &	to
	)

Copy a directory.

Parameters

from	The path to copy from [Note: not including 'from' folder].
to	The path to copy to.

Returns: If the action is successful.

Definition at line 202 of file FileSystem.cpp.

References CopyFile(), EnsureDirectory(), and LogError.

Referenced by Copy().

◆ CopyFile()

bool cloudViewer::utility::filesystem::CopyFile	(	const std::string &	from,
		const std::string &	to
	)

Copy a file.

Parameters

from	The file path to copy from.
to	The file path to copy to.

Returns: If the action is successful.

Definition at line 163 of file FileSystem.cpp.

References CopyA(), IsDirectory(), LogError, and LogWarning.

Referenced by Copy(), and CopyDir().

◆ DeleteDirectory()

bool cloudViewer::utility::filesystem::DeleteDirectory ( const std::string & directory )

Definition at line 514 of file FileSystem.cpp.

References error(), and LogWarning.

◆ DirectoryExists()

bool cloudViewer::utility::filesystem::DirectoryExists ( const std::string & directory )

Definition at line 473 of file FileSystem.cpp.

Referenced by AddIfExist(), DirectoryIsEmpty(), cloudViewer::data::DownloadDataset::DownloadDataset(), cloudViewer::utility::DownloadFromURL(), EnsureDirectory(), cloudViewer::utility::Extract(), GetHomeDirectory(), cloudViewer::data::DownloadDataset::HasDownloaded(), cloudViewer::t::io::RealSenseSensor::InitSensor(), main(), MakeDirectoryHierarchy(), cloudViewer::pipelines::color_map::RunNonRigidOptimizer(), cloudViewer::visualization::gui::Application::RunOneTick(), cloudViewer::pipelines::color_map::RunRigidOptimizer(), cloudViewer::saveArrayToFile(), cloudViewer::visualization::gui::FileDialog::SetPath(), and cloudViewer::visualization::rendering::EngineInstance::SetResourcePath().

◆ DirectoryIsEmpty()

bool cloudViewer::utility::filesystem::DirectoryIsEmpty ( const std::string & directory )

Definition at line 477 of file FileSystem.cpp.

References DirectoryExists(), and LogError.

◆ EnsureDirectory()

bool cloudViewer::utility::filesystem::EnsureDirectory ( const std::string & directory_path )

Check if a specified directory specified by directory_path exists. If not, recursively create the directory (and its parents).

Parameters

directory_path Directory path.

Returns: If the directory does exist or its creation is successful.

Definition at line 484 of file FileSystem.cpp.

References DirectoryExists(), and MakeDirectoryHierarchy().

Referenced by CopyDir().

◆ EnsureTrailingSlash()

std::string cloudViewer::utility::filesystem::EnsureTrailingSlash ( const std::string & str )

Definition at line 106 of file FileSystem.cpp.

◆ FileExists()

bool cloudViewer::utility::filesystem::FileExists ( const std::string & filename )

Definition at line 524 of file FileSystem.cpp.

References filename.

Referenced by cloudViewer::data::Dataset::CheckPathsExist(), cloudViewer::utility::DownloadFromURL(), cloudViewer::utility::Extract(), cloudViewer::t::pipelines::slac::FillInRigidAlignmentTerm(), cloudViewer::t::pipelines::slac::FillInSLACAlignmentTerm(), cloudViewer::visualization::gui::FindFontPath(), cloudViewer::utility::GetMD5(), cloudViewer::data::DownloadDataset::HasDownloaded(), cloudViewer::visualization::gui::Application::Initialize(), cloudViewer::t::io::RealSenseSensor::InitSensor(), cloudViewer::VisualizerForAlignment::KeyPressCallback(), main(), cloudViewer::t::pipelines::slac::PreprocessPointClouds(), cloudViewer::visualization::gui::Application::RunOneTick(), cloudViewer::t::pipelines::slac::SaveCorrespondencesForPointClouds(), and cloudViewer::visualization::visualizer::O3DVisualizer::Impl::SetIBL().

◆ FindFilesRecursively()

std::vector< std::string > cloudViewer::utility::filesystem::FindFilesRecursively	(	const std::string &	directory,
		std::function< bool(const std::string &)>	is_match
	)

Definition at line 586 of file FileSystem.cpp.

References ListDirectory().

Referenced by cloudViewer::visualization::gui::FindFontPath().

◆ FOpen()

FILE * cloudViewer::utility::filesystem::FOpen	(	const std::string &	filename,
		const std::string &	mode
	)

Definition at line 609 of file FileSystem.cpp.

References filename.

Referenced by cloudViewer::VisualizerForAlignment::EvaluateAlignmentAndSave(), FReadToBuffer(), main(), cloudViewer::utility::filesystem::CFile::Open(), cloudViewer::t::io::ReadImageFromJPG(), cloudViewer::io::ReadPointCloudFromPCD(), cloudViewer::t::io::ReadPointCloudFromPCD(), cloudViewer::t::io::WriteImageToJPG(), cloudViewer::io::WritePointCloudToPCD(), and cloudViewer::t::io::WritePointCloudToPCD().

◆ FReadToBuffer()

bool cloudViewer::utility::filesystem::FReadToBuffer	(	const std::string &	path,
		std::vector< char > &	bytes,
		std::string *	errorStr
	)

Definition at line 678 of file FileSystem.cpp.

References bytes, FOpen(), GetIOErrorString(), cloudViewer::t::geometry::path, result, and SEEK_END.

Referenced by cloudViewer::visualization::rendering::FilamentResourceManager::CreateIndirectLight(), cloudViewer::visualization::rendering::FilamentResourceManager::CreateMaterial(), cloudViewer::visualization::rendering::FilamentResourceManager::CreateSkybox(), and cloudViewer::visualization::gui::LoadMaterialTemplate().

◆ GetEnvVar()

std::string cloudViewer::utility::filesystem::GetEnvVar ( const std::string & env_var )

Definition at line 66 of file FileSystem.cpp.

Referenced by GetHomeDirectory().

◆ GetFileBaseName()

std::string cloudViewer::utility::filesystem::GetFileBaseName ( const std::string & filename )

Definition at line 310 of file FileSystem.cpp.

References filename, GetFileNameWithoutDirectory(), and GetFileNameWithoutExtension().

◆ GetFileExtensionInLowerCase()

std::string cloudViewer::utility::filesystem::GetFileExtensionInLowerCase ( const std::string & filename )

Definition at line 281 of file FileSystem.cpp.

References filename.

Referenced by cloudViewer::utility::Extract(), cloudViewer::visualization::gui::FindFontPath(), cloudViewer::utility::IsSupportedCompressedFilePath(), ListFilesInDirectoryWithExtension(), cloudViewer::io::ReadFileGeometryType(), cloudViewer::io::ReadImageWarpingField(), cloudViewer::io::ReadPointCloud(), cloudViewer::t::io::ReadPointCloud(), cloudViewer::t::io::ReadPointCloudFromTXT(), cloudViewer::io::ReadPoseGraph(), cloudViewer::io::ReadTriangleMesh(), cloudViewer::t::io::ReadTriangleMesh(), cloudViewer::io::ReadTriangleMeshFromGLTF(), cloudViewer::t::geometry::VoxelBlockGrid::Save(), cloudViewer::visualization::gui::FileDialog::Impl::UpdateDirectoryListing(), cloudViewer::t::io::WriteHashMap(), cloudViewer::t::io::WriteImage(), cloudViewer::io::WriteImageWarpingField(), cloudViewer::io::WritePointCloud(), cloudViewer::t::io::WritePointCloud(), cloudViewer::t::io::WritePointCloudToTXT(), and cloudViewer::io::WritePoseGraph().

◆ GetFileNameWithoutDirectory()

std::string cloudViewer::utility::filesystem::GetFileNameWithoutDirectory ( const std::string & filename )

Definition at line 301 of file FileSystem.cpp.

References filename.

Referenced by Copy(), cloudViewer::data::DownloadDataset::DownloadDataset(), cloudViewer::utility::DownloadFromMirrors(), cloudViewer::utility::DownloadFromURL(), cloudViewer::visualization::gui::FindFontPath(), GetFileBaseName(), cloudViewer::visualization::visualizer::O3DVisualizer::Impl::GetListOfIBLs(), cloudViewer::visualization::GuiSettingsView::GuiSettingsView(), cloudViewer::data::DownloadDataset::HasDownloaded(), cloudViewer::io::LoadTextures(), main(), cloudViewer::t::pipelines::slac::PreprocessPointClouds(), and cloudViewer::visualization::gui::FileDialog::Impl::UpdateDirectoryListing().

◆ GetFileNameWithoutExtension()

std::string cloudViewer::utility::filesystem::GetFileNameWithoutExtension ( const std::string & filename )

Definition at line 295 of file FileSystem.cpp.

References filename.

Referenced by cloudViewer::VisualizerForAlignment::EvaluateAlignmentAndSave(), cloudViewer::visualization::gui::FindFontPath(), GetFileBaseName(), main(), and cloudViewer::visualization::VisualizerWithEditing::SaveCroppingResult().

◆ GetFileParentDirectory()

std::string cloudViewer::utility::filesystem::GetFileParentDirectory ( const std::string & filename )

Definition at line 314 of file FileSystem.cpp.

References filename.

Referenced by cloudViewer::visualization::gui::FindFontPath(), cloudViewer::visualization::gui::InitializeForPython(), cloudViewer::t::io::RealSenseSensor::InitSensor(), cloudViewer::io::LoadTextures(), main(), cloudViewer::io::ReadTriangleMeshFromOBJ(), and cloudViewer::saveArrayToFile().

◆ GetHomeDirectory()

std::string cloudViewer::utility::filesystem::GetHomeDirectory ( )

Get the HOME directory for the user.

The home directory is determined in the following order:

On Unix:
- $HOME
- /
On Windows:
- USERPROFILE%
- HOMEDRIVE%
- HOMEPATH%
- HOME%
- C:/

This is the same logics as used in Qt.

src/corelib/io/qfilesystemengine_win.cpp
src/corelib/io/qfilesystemengine_unix.cpp

Definition at line 74 of file FileSystem.cpp.

References DirectoryExists(), and GetEnvVar().

Referenced by cloudViewer::data::LocateDataRoot().

◆ GetIOErrorString()

std::string cloudViewer::utility::filesystem::GetIOErrorString ( const int errnoVal )

Definition at line 627 of file FileSystem.cpp.

Referenced by FReadToBuffer(), and cloudViewer::utility::filesystem::CFile::GetError().

◆ GetPathComponents()

std::vector< std::string > cloudViewer::utility::filesystem::GetPathComponents ( const std::string & path )

Definition at line 348 of file FileSystem.cpp.

References GetWorkingDirectory(), cloudViewer::t::geometry::path, and size.

Referenced by cloudViewer::visualization::gui::FileDialog::SetPath().

◆ GetRegularizedDirectoryName()

std::string cloudViewer::utility::filesystem::GetRegularizedDirectoryName ( const std::string & directory )

Definition at line 323 of file FileSystem.cpp.

Referenced by ListDirectory(), main(), and MakeDirectoryHierarchy().

◆ GetTempDirectoryPath()

std::string cloudViewer::utility::filesystem::GetTempDirectoryPath ( )

Definition at line 423 of file FileSystem.cpp.

◆ GetWorkingDirectory()

std::string cloudViewer::utility::filesystem::GetWorkingDirectory ( )

Definition at line 333 of file FileSystem.cpp.

Referenced by GetPathComponents(), cloudViewer::visualization::gui::Application::Initialize(), and cloudViewer::visualization::pybind_visualization_utility_methods().

◆ HasFileExtension()

bool cloudViewer::utility::filesystem::HasFileExtension	(	const std::string &	file_name,
		const std::string &	ext
	)

Definition at line 117 of file FileSystem.cpp.

References LogWarning, and cloudViewer::utility::ToLower().

◆ IsDirectory()

bool cloudViewer::utility::filesystem::IsDirectory ( const std::string & directory )

Definition at line 454 of file FileSystem.cpp.

Referenced by Copy(), and CopyFile().

◆ IsFile()

bool cloudViewer::utility::filesystem::IsFile ( const std::string & filename )

Definition at line 435 of file FileSystem.cpp.

References filename.

◆ JoinPath() [1/2]

std::string cloudViewer::utility::filesystem::JoinPath	(	const std::string &	path_component1,
		const std::string &	path_component2
	)

Definition at line 52 of file FileSystem.cpp.

References cloudViewer::t::geometry::path.

◆ JoinPath() [2/2]

std::string cloudViewer::utility::filesystem::JoinPath ( const std::vector< std::string > & path_components )

Definition at line 58 of file FileSystem.cpp.

References cloudViewer::t::geometry::path.

Referenced by AddIfExist().

◆ JoinPaths()

template<typename... T>

std::string cloudViewer::utility::filesystem::JoinPaths ( T const &... paths )

Definition at line 23 of file FileSystem.h.

References result, cloudViewer::utility::StringContains(), cloudViewer::utility::StringEndsWith(), cloudViewer::utility::StringReplace(), and cloudViewer::utility::StringReplaceLast().

Referenced by Copy(), cloudViewer::ReconstructionWidget::iniEnvironment(), cloudViewer::PointViewerWidget::Show(), cloudViewer::DatabaseImageViewerWidget::ShowImageWithId(), and cloudViewer::TwoViewInfoTab::ShowMatches().

◆ ListDirectory()

bool cloudViewer::utility::filesystem::ListDirectory	(	const std::string &	directory,
		std::vector< std::string > &	subdirs,
		std::vector< std::string > &	filenames
	)

Definition at line 532 of file FileSystem.cpp.

References GetRegularizedDirectoryName(), and NULL.

Referenced by FindFilesRecursively(), ListFilesInDirectory(), and cloudViewer::visualization::gui::FileDialog::Impl::UpdateDirectoryListing().

◆ ListFilesInDirectory()

bool cloudViewer::utility::filesystem::ListFilesInDirectory	(	const std::string &	directory,
		std::vector< std::string > &	filenames
	)

Definition at line 561 of file FileSystem.cpp.

References ListDirectory().

Referenced by cloudViewer::visualization::visualizer::O3DVisualizer::Impl::GetListOfIBLs(), cloudViewer::visualization::GuiSettingsView::GuiSettingsView(), ListFilesInDirectoryWithExtension(), and main().

◆ ListFilesInDirectoryWithExtension()

bool cloudViewer::utility::filesystem::ListFilesInDirectoryWithExtension	(	const std::string &	directory,
		const std::string &	extname,
		std::vector< std::string > &	filenames
	)

Definition at line 567 of file FileSystem.cpp.

References GetFileExtensionInLowerCase(), and ListFilesInDirectory().

Referenced by Copy().

◆ MakeDirectory()

bool cloudViewer::utility::filesystem::MakeDirectory ( const std::string & directory )

Definition at line 491 of file FileSystem.cpp.

Referenced by MakeDirectoryHierarchy(), cloudViewer::t::pipelines::slac::PreprocessPointClouds(), cloudViewer::t::pipelines::slac::RunRigidOptimizerForFragments(), and cloudViewer::t::pipelines::slac::RunSLACOptimizerForFragments().

◆ MakeDirectoryHierarchy()

bool cloudViewer::utility::filesystem::MakeDirectoryHierarchy ( const std::string & directory )

Definition at line 499 of file FileSystem.cpp.

References DirectoryExists(), GetRegularizedDirectoryName(), and MakeDirectory().

Referenced by cloudViewer::data::DownloadDataset::DownloadDataset(), cloudViewer::utility::DownloadFromURL(), EnsureDirectory(), cloudViewer::utility::Extract(), cloudViewer::utility::ExtractCurrentFile(), cloudViewer::t::io::RealSenseSensor::InitSensor(), main(), cloudViewer::visualization::VisualizerWithCustomAnimation::Play(), cloudViewer::pipelines::color_map::RunNonRigidOptimizer(), cloudViewer::pipelines::color_map::RunRigidOptimizer(), cloudViewer::saveArrayToFile(), and cloudViewer::t::io::RGBDVideoReader::SaveFrames().

◆ RemoveFile()

bool cloudViewer::utility::filesystem::RemoveFile ( const std::string & filename )

Definition at line 528 of file FileSystem.cpp.

References filename.

◆ SplitFileExtension()

void cloudViewer::utility::filesystem::SplitFileExtension	(	const std::string &	path,
		std::string *	root,
		std::string *	ext
	)

Definition at line 137 of file FileSystem.cpp.

References LogError, cloudViewer::t::geometry::path, and cloudViewer::utility::StringSplit().

Classes

Functions

Function Documentation

◆ AddIfExist()

◆ ChangeWorkingDirectory()

◆ Copy()

◆ CopyA()

◆ CopyDir()

◆ CopyFile()

◆ DeleteDirectory()

◆ DirectoryExists()

◆ DirectoryIsEmpty()

◆ EnsureDirectory()

◆ EnsureTrailingSlash()

◆ FileExists()

◆ FindFilesRecursively()

◆ FOpen()

◆ FReadToBuffer()

◆ GetEnvVar()

◆ GetFileBaseName()

◆ GetFileExtensionInLowerCase()

◆ GetFileNameWithoutDirectory()

◆ GetFileNameWithoutExtension()

◆ GetFileParentDirectory()

◆ GetHomeDirectory()

◆ GetIOErrorString()

◆ GetPathComponents()

◆ GetRegularizedDirectoryName()

◆ GetTempDirectoryPath()

◆ GetWorkingDirectory()

◆ HasFileExtension()

◆ IsDirectory()

◆ IsFile()

◆ JoinPath() [1/2]

◆ JoinPath() [2/2]

◆ JoinPaths()

◆ ListDirectory()

◆ ListFilesInDirectory()

◆ ListFilesInDirectoryWithExtension()

◆ MakeDirectory()

◆ MakeDirectoryHierarchy()

◆ RemoveFile()

◆ SplitFileExtension()