occtl_de.h

Go to the documentation of this file.

// Copyright (c) 2026 Capgemini Engineering Research and Development.
//
// This file is part of OCCT-Light software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Affero General Public License version 3 as published
// by the Free Software Foundation, with an option to use any later version.
// Consult the file LICENSE_AGPL_30.txt included in OCCT-Light distribution
// for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of a commercial
// license or contractual agreement.
//
// SPDX-License-Identifier: AGPL-3.0-or-later
 
#ifndef OCCTL_DE_H
#define OCCTL_DE_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "occtl_core.h"
#include "occtl_topo.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define OCCTL_DE_FORMAT_INFO_VERSION_1 1u
 
typedef struct occtl_de_format_info
{
  uint32_t    struct_version;  
  const void* p_next;          
  const char* id;              
  const char* label;           
  size_t      extension_count; 
  int32_t     can_read_file;   
  int32_t     can_write_file;  
  int32_t     can_read_memory; 
  int32_t     can_write_memory; 
} occtl_de_format_info_t;
 
#define OCCTL_DE_FORMAT_INFO_INIT {OCCTL_DE_FORMAT_INFO_VERSION_1, NULL, NULL, NULL, 0, 0, 0, 0, 0}
 
OCCTL_API void OCCTL_CALL occtl_de_format_info_init(occtl_de_format_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_read(const char*      path,
                                                  occtl_graph_t**  out_graph,
                                                  occtl_node_id_t* out_root);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_read_memory(const char*      format_id,
                                                         const uint8_t*   data,
                                                         size_t           size,
                                                         occtl_graph_t**  out_graph,
                                                         occtl_node_id_t* out_root);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_write(const occtl_graph_t* graph,
                                                   occtl_node_id_t      root,
                                                   const char*          path);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_write_memory(const occtl_graph_t* graph,
                                                          occtl_node_id_t      root,
                                                          const char*          format_id,
                                                          uint8_t*             out_data,
                                                          size_t               capacity,
                                                          size_t*              out_size);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_format_ids(const char** out_format_ids,
                                                        size_t       cap,
                                                        size_t*      out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_format_count(size_t* out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_format_info_at(size_t                  index,
                                                            occtl_de_format_info_t* out_info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_format_info_by_id(const char*             format_id,
                                                               occtl_de_format_info_t* out_info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_format_extensions(const char*  format_id,
                                                               const char** out_extensions,
                                                               size_t       cap,
                                                               size_t*      out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_de_format_id_from_path(const char*  path,
                                                                 const char** out_format_id);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OCCTL_DE_H */