IfcOpenShell/src/ifcparse/IfcUtil.cpp

/********************************************************************************
 *                                                                              *
 * 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/>.         *
 *                                                                              *
 ********************************************************************************/

#ifdef _MSC_VER
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#ifndef NOMINMAX
#define NOMINMAX
#endif
#ifndef NOMSG
#define NOMSG NOMSG
#endif
#ifndef NODRAWTEXT
#define NODRAWTEXT NODRAWTEXT
#endif
#ifndef NOGDI
#define NOGDI NOGDI
#endif
#ifndef NOSERVICE
#define NOSERVICE NOSERVICE
#endif
#ifndef NOKERNEL
#define NOKERNEL NOKERNEL
#endif
#ifndef NOUSER
#define NOUSER NOUSER
#endif
#ifndef NOMCX
#define NOMCX NOMCX
#endif
#ifndef NOIME
#define NOIME NOIME
#endif
#include <Windows.h>
#endif

#include "aggregate_of_instance.h"
#include "Argument.h"
#include "IfcBaseClass.h"
#include "IfcException.h"
#include "utils.h"
#include "IfcFile.h"

#include <algorithm>
#include <boost/algorithm/string/replace.hpp>
#include <boost/optional.hpp>

void aggregate_of_instance::push(IfcUtil::IfcBaseClass* instance) {
    if (instance != nullptr) {
        list_.push_back(instance);
    }
}
void aggregate_of_instance::push(const aggregate_of_instance::ptr& instance) {
    if (instance) {
        for (it i = instance->begin(); i != instance->end(); ++i) {
            if (*i != nullptr) {
                list_.push_back(*i);
            }
        }
    }
}
size_t aggregate_of_instance::size() const { return list_.size(); }
void aggregate_of_instance::reserve(size_t capacity) { list_.reserve(capacity); }
aggregate_of_instance::it aggregate_of_instance::begin() { return list_.begin(); }
aggregate_of_instance::it aggregate_of_instance::end() { return list_.end(); }
IfcUtil::IfcBaseClass* aggregate_of_instance::operator[](int i) {
    return list_[i];
}
bool aggregate_of_instance::contains(IfcUtil::IfcBaseClass* instance) const {
    return std::find(list_.begin(), list_.end(), instance) != list_.end();
}
void aggregate_of_instance::remove(IfcUtil::IfcBaseClass* instance) {
    std::vector<IfcUtil::IfcBaseClass*>::iterator iter;
    while ((iter = std::find(list_.begin(), list_.end(), instance)) != list_.end()) {
        list_.erase(iter);
    }
}

aggregate_of_instance::ptr aggregate_of_instance::filtered(const std::set<const IfcParse::declaration*>& entities) {
    aggregate_of_instance::ptr return_value(new aggregate_of_instance);
    for (it it = begin(); it != end(); ++it) {
        bool contained = false;
        for (std::set<const IfcParse::declaration*>::const_iterator jt = entities.begin(); jt != entities.end(); ++jt) {
            if ((*it)->declaration().is(**jt)) {
                contained = true;
                break;
            }
        }
        if (!contained) {
            return_value->push(*it);
        }
    }
    return return_value;
}

aggregate_of_instance::ptr aggregate_of_instance::unique() {
    std::set<IfcUtil::IfcBaseClass*> encountered;
    aggregate_of_instance::ptr return_value(new aggregate_of_instance);
    for (it it = begin(); it != end(); ++it) {
        if (encountered.find(*it) == encountered.end()) {
            return_value->push(*it);
            encountered.insert(*it);
        }
    }
    return return_value;
}

/*
//Note: some of these methods are overloaded in derived classes
Argument::operator int() const { throw IfcParse::IfcException("Argument is not an integer"); }
Argument::operator bool() const { throw IfcParse::IfcException("Argument is not a boolean"); }
Argument::operator boost::logic::tribool() const { throw IfcParse::IfcException("Argument is not a logical"); }
Argument::operator double() const { throw IfcParse::IfcException("Argument is not a number"); }
Argument::operator std::string() const { throw IfcParse::IfcException("Argument is not a string"); }
Argument::operator boost::dynamic_bitset<>() const { throw IfcParse::IfcException("Argument is not a binary"); }
Argument::operator IfcUtil::IfcBaseClass*() const { throw IfcParse::IfcException("Argument is not an entity instance"); }
Argument::operator std::vector<double>() const { throw IfcParse::IfcException("Argument is not a list of floats"); }
Argument::operator std::vector<int>() const { throw IfcParse::IfcException("Argument is not a list of ints"); }
Argument::operator std::vector<std::string>() const { throw IfcParse::IfcException("Argument is not a list of strings"); }
Argument::operator std::vector<boost::dynamic_bitset<>>() const { throw IfcParse::IfcException("Argument is not a list of binaries"); }
Argument::operator aggregate_of_instance::ptr() const { throw IfcParse::IfcException("Argument is not a list of entity instances"); }
Argument::operator std::vector<std::vector<int>>() const { throw IfcParse::IfcException("Argument is not a list of list of ints"); }
Argument::operator std::vector<std::vector<double>>() const { throw IfcParse::IfcException("Argument is not a list of list of floats"); }
Argument::operator aggregate_of_aggregate_of_instance::ptr() const { throw IfcParse::IfcException("Argument is not a list of list of entity instances"); }
*/

static const char* const argument_type_string[] = {
    "NULL",
    "DERIVED",
    "INT",
    "BOOL",
    "LOGICAL",
    "DOUBLE",
    "STRING",
    "BINARY",
    "ENUMERATION",
    "ENTITY INSTANCE",

    "EMPTY AGGREGATE",
    "AGGREGATE OF INT",
    "AGGREGATE OF DOUBLE",
    "AGGREGATE OF STRING",
    "AGGREGATE OF BINARY",
    "AGGREGATE OF ENTITY INSTANCE",

    "AGGREGATE OF EMPTY AGGREGATE",
    "AGGREGATE OF AGGREGATE OF INT",
    "AGGREGATE OF AGGREGATE OF DOUBLE",
    "AGGREGATE OF AGGREGATE OF ENTITY INSTANCE",

    "UNKNOWN"};

const char* IfcUtil::ArgumentTypeToString(ArgumentType argument_type) {
    return argument_type_string[static_cast<int>(argument_type)];
}

bool IfcUtil::valid_binary_string(const std::string& str) {
    for (std::string::const_iterator it = str.begin(); it != str.end(); ++it) {
        if (*it != '0' && *it != '1') {
            return false;
        }
    }
    return true;
}

void IfcUtil::sanitate_material_name(std::string& str) {
    // Spaces in material names have been observed to cause problems with obj and dae importers.
    // Handle other potential problematic characters here too if observing problems.
    boost::replace_all(str, " ", "_");
}

void IfcUtil::escape_xml(std::string& str) {
    boost::replace_all(str, "&", "&amp;");
    boost::replace_all(str, "\"", "&quot;");
    boost::replace_all(str, "'", "&apos;");
    boost::replace_all(str, "<", "&lt;");
    boost::replace_all(str, ">", "&gt;");
}

void IfcUtil::unescape_xml(std::string& str) {
    boost::replace_all(str, "&amp;", "&");
    boost::replace_all(str, "&quot;", "\"");
    boost::replace_all(str, "&apos;", "'");
    boost::replace_all(str, "&lt;", "<");
    boost::replace_all(str, "&gt;", ">");
}

IfcUtil::IfcBaseEntity::IfcBaseEntity(IfcEntityInstanceData&& data)
    : IfcBaseClass(std::move(data))
{}

void IfcUtil::IfcBaseEntity::populate_derived() {
    for (auto it = declaration().as_entity()->derived().begin(); it != declaration().as_entity()->derived().end(); ++it) {
        if (*it) {
            set_attribute_value(
                std::distance(declaration().as_entity()->derived().begin(), it),
                Derived{}
            );
        }
    }
}

AttributeValue IfcUtil::IfcBaseEntity::get(const std::string& name) const
{
    auto attrs = declaration().as_entity()->all_attributes();
    auto iter = attrs.begin();
    size_t idx = 0;
    for (; iter != attrs.end(); ++iter, ++idx) {
        if ((*iter)->name() == name) {
            return get_attribute_value(idx);
        }
    }
    throw IfcParse::IfcException(name + " not found on " + declaration().name());
}

aggregate_of_instance::ptr IfcUtil::IfcBaseEntity::get_inverse(const std::string& name) const {
    if (file_ == nullptr) {
        throw IfcParse::IfcException("Instance not added to file");
    }
    const std::vector<const IfcParse::inverse_attribute*> attrs = declaration().as_entity()->all_inverse_attributes();
    std::vector<const IfcParse::inverse_attribute*>::const_iterator iter = attrs.begin();
    for (; iter != attrs.end(); ++iter) {
        if ((*iter)->name() == name) {
            return file_->getInverse(
                id_,
                (*iter)->entity_reference(),
                (int)(*iter)->entity_reference()->attribute_index((*iter)->attribute_reference()));
        }
    }
    throw IfcParse::IfcException(name + " not found on " + declaration().name());
}

/*
void IfcUtil::IfcBaseClass::data(IfcEntityInstanceData* data) {
    delete data_;
    data_ = data;
}
*/

IfcUtil::ArgumentType IfcUtil::make_aggregate(IfcUtil::ArgumentType elem_type) {
    switch (elem_type) {
    case IfcUtil::Argument_INT:
        return IfcUtil::Argument_AGGREGATE_OF_INT;
    case IfcUtil::Argument_DOUBLE:
        return IfcUtil::Argument_AGGREGATE_OF_DOUBLE;
    case IfcUtil::Argument_STRING:
        return IfcUtil::Argument_AGGREGATE_OF_STRING;
    case IfcUtil::Argument_BINARY:
        return IfcUtil::Argument_AGGREGATE_OF_BINARY;
    case IfcUtil::Argument_ENTITY_INSTANCE:
        return IfcUtil::Argument_AGGREGATE_OF_ENTITY_INSTANCE;
    case IfcUtil::Argument_AGGREGATE_OF_INT:
        return IfcUtil::Argument_AGGREGATE_OF_AGGREGATE_OF_INT;
    case IfcUtil::Argument_AGGREGATE_OF_DOUBLE:
        return IfcUtil::Argument_AGGREGATE_OF_AGGREGATE_OF_DOUBLE;
    case IfcUtil::Argument_AGGREGATE_OF_ENTITY_INSTANCE:
        return IfcUtil::Argument_AGGREGATE_OF_AGGREGATE_OF_ENTITY_INSTANCE;
    case IfcUtil::Argument_EMPTY_AGGREGATE:
        return IfcUtil::Argument_AGGREGATE_OF_EMPTY_AGGREGATE;
    default:
        return IfcUtil::Argument_UNKNOWN;
    }
}

IfcUtil::ArgumentType IfcUtil::from_parameter_type(const IfcParse::parameter_type* pt) {
    // TODO: How to detect derived types here without a reference to the refering entity?

    const IfcParse::aggregation_type* at = pt->as_aggregation_type();
    const IfcParse::named_type* nt = pt->as_named_type();
    const IfcParse::simple_type* st = pt->as_simple_type();

    if (at != nullptr) {
        return make_aggregate(from_parameter_type(at->type_of_element()));
    }
    if (nt != nullptr) {
        if (nt->declared_type()->as_entity() != nullptr) {
            return IfcUtil::Argument_ENTITY_INSTANCE;
        }
        if (nt->declared_type()->as_enumeration_type() != nullptr) {
            return IfcUtil::Argument_ENUMERATION;
        }
        if (nt->declared_type()->as_select_type() != nullptr) {
            return IfcUtil::Argument_ENTITY_INSTANCE;
        }
        if (nt->declared_type()->as_type_declaration() != nullptr) {
            return from_parameter_type(nt->declared_type()->as_type_declaration()->declared_type());
        }
    } else if (st != nullptr) {
        switch (st->declared_type()) {
        case IfcParse::simple_type::binary_type:
            return IfcUtil::Argument_BINARY;
        case IfcParse::simple_type::boolean_type:
            return IfcUtil::Argument_BOOL;
        case IfcParse::simple_type::integer_type:
            return IfcUtil::Argument_INT;
        case IfcParse::simple_type::logical_type:
            return IfcUtil::Argument_LOGICAL;
        case IfcParse::simple_type::number_type:
            return IfcUtil::Argument_DOUBLE;
        case IfcParse::simple_type::real_type:
            return IfcUtil::Argument_DOUBLE;
        case IfcParse::simple_type::string_type:
            return IfcUtil::Argument_STRING;
        case IfcParse::simple_type::datatype_COUNT:
            throw IfcParse::IfcException("Invalid simple type encountered");
        }
    }

    return IfcUtil::Argument_UNKNOWN;
}

#ifdef _MSC_VER
std::string IfcUtil::path::to_utf8(const std::wstring& str) {
    int buffer_size = WideCharToMultiByte(CP_UTF8, 0, str.c_str(), -1, 0, 0, 0, 0);
    char* buffer = new char[buffer_size];
    WideCharToMultiByte(CP_UTF8, 0, str.c_str(), -1, buffer, buffer_size, 0, 0);
    std::string str_utf8(buffer);
    delete[] buffer;
    return str_utf8;
}

std::wstring IfcUtil::path::from_utf8(const std::string& str) {
    int buffer_size = MultiByteToWideChar(CP_UTF8, 0, str.c_str(), -1, 0, 0);
    wchar_t* buffer = new wchar_t[buffer_size];
    MultiByteToWideChar(CP_UTF8, 0, str.c_str(), -1, buffer, buffer_size);
    std::wstring str_wide(buffer);
    delete[] buffer;
    return str_wide;
}

IFC_PARSE_API bool IfcUtil::path::rename_file(const std::string& old_filename, const std::string& new_filename) {
    std::wstring old_filename_w = from_utf8(old_filename);
    std::wstring new_filename_w = from_utf8(new_filename);
    delete_file(new_filename);
    const bool success = !!MoveFileW(old_filename_w.c_str(), new_filename_w.c_str());
    return success;
}

IFC_PARSE_API bool IfcUtil::path::atomic_rename_file(const std::string& old_filename, const std::string& new_filename) {
    std::wstring old_filename_w = from_utf8(old_filename);
    std::wstring new_filename_w = from_utf8(new_filename);
    // MOVEFILE_REPLACE_EXISTING makes the replace atomic on NTFS (no unlink
    // of the destination first). MOVEFILE_WRITE_THROUGH waits until the move
    // is flushed to disk before returning.
    const bool success = !!MoveFileExW(old_filename_w.c_str(), new_filename_w.c_str(),
        MOVEFILE_REPLACE_EXISTING | MOVEFILE_WRITE_THROUGH);
    return success;
}

IFC_PARSE_API bool IfcUtil::path::delete_file(const std::string& filename) {
    std::wstring filename_w = from_utf8(filename);
    const bool success = !!DeleteFileW(filename_w.c_str());
    return success;
}

#else

IFC_PARSE_API bool IfcUtil::path::rename_file(const std::string& old_filename, const std::string& new_filename) {
    // Whether or not rename() replaces an existing file is implementation-specific,
    // so remove() possible existing file always.
    delete_file(new_filename);
    return std::rename(old_filename.c_str(), new_filename.c_str()) == 0;
}

IFC_PARSE_API bool IfcUtil::path::atomic_rename_file(const std::string& old_filename, const std::string& new_filename) {
    // POSIX rename() atomically replaces an existing destination on the same
    // filesystem, so there is no window in which new_filename is missing.
    return std::rename(old_filename.c_str(), new_filename.c_str()) == 0;
}

IFC_PARSE_API bool IfcUtil::path::delete_file(const std::string& filename) {
    return std::remove(filename.c_str()) != 0;
}

#endif