stl_infos.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (c) 2017, Fougue Ltd. <http://www.fougue.pro>
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions
** are met:
**
**     1. Redistributions of source code must retain the above copyright
**        notice, this list of conditions and the following disclaimer.
**
**     2. 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.
**
** 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

#include "stl_global.h"
#include "stl_format.h"
#include "stlb_header.h"
#include <stddef.h>

struct gmio_stl_infos
{
    enum gmio_stl_format format;

    uint32_t facet_count;

    gmio_streamsize_t size;

    char* stla_solidname;

    size_t stla_solidname_maxlen;

    struct gmio_stlb_header stlb_header;
};

enum gmio_stl_info_flag
{
    GMIO_STL_INFO_FLAG_FACET_COUNT = 0x0001,

    GMIO_STL_INFO_FLAG_SIZE = 0x0002,

    GMIO_STLA_INFO_FLAG_SOLIDNAME = 0x0004,

    GMIO_STLB_INFO_FLAG_HEADER = 0x0008,

    GMIO_STL_INFO_FLAG_SOLIDNAME_OR_HEADER =
        GMIO_STLA_INFO_FLAG_SOLIDNAME | GMIO_STLB_INFO_FLAG_HEADER,

    GMIO_STL_INFO_FLAG_FORMAT = 0x0010,

    GMIO_STL_INFO_FLAG_ALL = 0xFFFF
};

struct gmio_stl_infos_probe_options
{
    struct gmio_memblock stream_memblock;

    enum gmio_stl_format format_hint;

    gmio_streamsize_t size_limit;
};

GMIO_C_LINKAGE_BEGIN

GMIO_API int gmio_stl_infos_probe(
                struct gmio_stl_infos* infos,
                struct gmio_stream* stream,
                unsigned flags,
                const struct gmio_stl_infos_probe_options* options);

GMIO_API int gmio_stl_infos_probe_file(
                struct gmio_stl_infos* infos,
                const char* filepath,
                unsigned flags,
                const struct gmio_stl_infos_probe_options* options);

GMIO_API gmio_streamsize_t gmio_stla_infos_probe_streamsize(
                struct gmio_stream* stream,
                struct gmio_memblock* stream_memblock);

GMIO_C_LINKAGE_END