BaseImporter.h

/*
Open Asset Import Library (assimp)
----------------------------------------------------------------------
 
Copyright (c) 2006-2020, assimp team
 
All rights reserved.
 
Redistribution and use of this software in source and binary forms,
with or without modification, are permitted provided that the
following conditions are met:
 
* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
 
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
 
* Neither the name of the assimp team, nor the names of its
  contributors may be used to endorse or promote products
  derived from this software without specific prior
  written permission of the assimp team.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
----------------------------------------------------------------------
*/
 
 
#pragma once
#ifndef INCLUDED_AI_BASEIMPORTER_H
#define INCLUDED_AI_BASEIMPORTER_H
 
#ifdef __GNUC__
#pragma GCC system_header
#endif
 
#include "Exceptional.h"
 
#include <assimp/ai_assert.h>
#include <assimp/types.h>
#include <assimp/ProgressHandler.hpp>
#include <map>
#include <set>
#include <vector>
#include <memory>
 
struct aiScene;
struct aiImporterDesc;
 
namespace Assimp {
 
class Importer;
class IOSystem;
class BaseProcess;
class SharedPostProcessInfo;
class IOStream;
 
// utility to do char4 to uint32 in a portable manner
#define AI_MAKE_MAGIC(string) ((uint32_t)((string[0] << 24) + \
                                          (string[1] << 16) + (string[2] << 8) + string[3]))
 
// ---------------------------------------------------------------------------
class ASSIMP_API BaseImporter {
    friend class Importer;
 
public:
    BaseImporter() AI_NO_EXCEPT;
 
    virtual ~BaseImporter();
 
    // -------------------------------------------------------------------
    virtual bool CanRead(
            const std::string &pFile,
            IOSystem *pIOHandler,
            bool checkSig) const = 0;
 
    // -------------------------------------------------------------------
    aiScene *ReadFile(
            Importer *pImp,
            const std::string &pFile,
            IOSystem *pIOHandler);
 
    // -------------------------------------------------------------------
    const std::string &GetErrorText() const {
        return m_ErrorText;
    }
 
    // -------------------------------------------------------------------
    const std::exception_ptr& GetException() const {
        return m_Exception;
    }
 
    // -------------------------------------------------------------------
    virtual void SetupProperties(
            const Importer *pImp);
 
    // -------------------------------------------------------------------
    virtual const aiImporterDesc *GetInfo() const = 0;
 
    virtual void SetFileScale(double scale) {
        fileScale = scale;
    }
 
    virtual double GetFileScale() const {
        return fileScale;
    }
 
    enum ImporterUnits {
        M,
        MM,
        CM,
        INCHES,
        FEET
    };
 
    std::map<ImporterUnits, double> importerUnits;
 
    virtual void SetApplicationUnits(const ImporterUnits &unit) {
        importerScale = importerUnits[unit];
        applicationUnits = unit;
    }
 
    virtual const ImporterUnits &GetApplicationUnits() {
        return applicationUnits;
    }
 
    // -------------------------------------------------------------------
    void GetExtensionList(std::set<std::string> &extensions);
 
protected:
    ImporterUnits applicationUnits = ImporterUnits::M;
    double importerScale = 1.0;
    double fileScale = 1.0;
 
    // -------------------------------------------------------------------
    virtual void InternReadFile(
            const std::string &pFile,
            aiScene *pScene,
            IOSystem *pIOHandler) = 0;
 
public: // static utilities
    // -------------------------------------------------------------------
    static bool SearchFileHeaderForToken(
            IOSystem *pIOSystem,
            const std::string &file,
            const char **tokens,
            unsigned int numTokens,
            unsigned int searchBytes = 200,
            bool tokensSol = false,
            bool noAlphaBeforeTokens = false);
 
    // -------------------------------------------------------------------
    static bool SimpleExtensionCheck(
            const std::string &pFile,
            const char *ext0,
            const char *ext1 = nullptr,
            const char *ext2 = nullptr);
 
    // -------------------------------------------------------------------
    static std::string GetExtension(
            const std::string &pFile);
 
    // -------------------------------------------------------------------
    static bool CheckMagicToken(
            IOSystem *pIOHandler,
            const std::string &pFile,
            const void *magic,
            unsigned int num,
            unsigned int offset = 0,
            unsigned int size = 4);
 
    // -------------------------------------------------------------------
    static void ConvertToUTF8(
            std::vector<char> &data);
 
    // -------------------------------------------------------------------
    static void ConvertUTF8toISO8859_1(
            std::string &data);
 
    // -------------------------------------------------------------------
    enum TextFileMode {
        ALLOW_EMPTY,
        FORBID_EMPTY
    };
 
    // -------------------------------------------------------------------
    static void TextFileToBuffer(
            IOStream *stream,
            std::vector<char> &data,
            TextFileMode mode = FORBID_EMPTY);
 
    // -------------------------------------------------------------------
    template <typename T>
    AI_FORCE_INLINE static void CopyVector(
            std::vector<T> &vec,
            T *&out,
            unsigned int &outLength) {
        outLength = unsigned(vec.size());
        if (outLength) {
            out = new T[outLength];
            std::swap_ranges(vec.begin(), vec.end(), out);
        }
    }
 
    // -------------------------------------------------------------------
    template <typename T>
    AI_FORCE_INLINE static void CopyVector(
            std::vector<std::unique_ptr<T> > &vec,
            T **&out,
            unsigned int &outLength) {
        outLength = unsigned(vec.size());
        if (outLength) {
            out = new T*[outLength];
            T** outPtr = out;
            std::for_each(vec.begin(), vec.end(), [&outPtr](std::unique_ptr<T>& uPtr){*outPtr = uPtr.release(); ++outPtr; });
        }
    }
 
private:
    /* Pushes state into importer for the importer scale */
    virtual void UpdateImporterScale(Importer *pImp);
 
protected:
    std::string m_ErrorText;
    std::exception_ptr m_Exception;
    ProgressHandler *m_progress;
};
 
} // end of namespace Assimp
 
#endif // AI_BASEIMPORTER_H_INC