IfcOpenShell/src/ifcparse/utils.h

/********************************************************************************
*                                                                              *
* This file is part of IfcOpenShell.                                           *
*                                                                              *
* IfcOpenShell is free software: you can redistribute it and/or modify         *
* it under the terms of the Lesser GNU General Public License as published by  *
* the Free Software Foundation, either version 3.0 of the License, or          *
* (at your option) any later version.                                          *
*                                                                              *
* IfcOpenShell is distributed in the hope that it will be useful,              *
* but WITHOUT ANY WARRANTY; without even the implied warranty of               *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 *
* Lesser GNU General Public License for more details.                          *
*                                                                              *
* You should have received a copy of the Lesser GNU General Public License     *
* along with this program. If not, see <http://www.gnu.org/licenses/>.         *
*                                                                              *
********************************************************************************/

#include "ifc_parse_api.h"

#include <string>

#ifndef IFCPARSE_UTILS_H
#define IFCPARSE_UTILS_H

namespace ifcopenshell {

/// Replaces spaces and potentially other problem causing characters with underscores.
IFC_PARSE_API void sanitate_material_name(std::string& material_name);

IFC_PARSE_API void escape_xml(std::string& text);
IFC_PARSE_API void unescape_xml(std::string& text);

namespace path {

IFC_PARSE_API bool delete_file(const std::string& filename);
IFC_PARSE_API bool rename_file(const std::string& old_filename, const std::string& new_filename);

/// Atomically renames old_filename onto new_filename, replacing an existing
/// destination in a single filesystem operation. Unlike rename_file(), the
/// destination is never unlinked before the rename, so an interruption can
/// never leave the destination missing. This requires both paths to live on
/// the same filesystem. Returns true on success.
IFC_PARSE_API bool atomic_rename_file(const std::string& old_filename, const std::string& new_filename);

#if defined(_MSC_VER) && defined(_UNICODE)

/// Uses windows.h string conversion functions
IFC_PARSE_API std::string to_utf8(const std::wstring& str);

/// Uses windows.h string conversion functions
IFC_PARSE_API std::wstring from_utf8(const std::string& value);
#else
/// Identity operation
IFC_PARSE_API inline std::string to_utf8(const std::string& value) { return value; }

/// Identity operation
IFC_PARSE_API inline std::string from_utf8(const std::string& value) { return value; }
#endif

} // namespace path

} // namespace ifcopenshell

#endif