doctotext_c_api.h

Go to the documentation of this file.

/***************************************************************************************************************************************************/
/*  DocToText - A multifaceted, data extraction software development toolkit that converts all sorts of files to plain text and html.              */
/*  Written in C++, this data extraction tool has a parser able to convert PST & OST files along with a brand new API for better file processing.  */
/*  To enhance its utility, DocToText, as a data extraction tool, can be integrated with other data mining and data analytics applications.        */
/*  It comes equipped with a high grade, scriptable and trainable OCR that has LSTM neural networks based character recognition.                   */
/*                                                                                                                                                 */
/*  This document parser is able to extract metadata along with annotations and supports a list of formats that include:                           */
/*  DOC, XLS, XLSB, PPT, RTF, ODF (ODT, ODS, ODP), OOXML (DOCX, XLSX, PPTX), iWork (PAGES, NUMBERS, KEYNOTE), ODFXML (FODP, FODS, FODT),           */
/*  PDF, EML, HTML, Outlook (PST, OST), Image (JPG, JPEG, JFIF, BMP, PNM, PNG, TIFF, WEBP) and DICOM (DCM)                                         */
/*                                                                                                                                                 */
/*  Copyright (c) SILVERCODERS Ltd                                                                                                                 */
/*  http://silvercoders.com                                                                                                                        */
/*                                                                                                                                                 */
/*  Project homepage:                                                                                                                              */
/*  http://silvercoders.com/en/products/doctotext                                                                                                  */
/*  https://www.docwire.io/                                                                                                                        */
/*                                                                                                                                                 */
/*  The GNU General Public License version 2 as published by the Free Software Foundation and found in the file COPYING.GPL permits                */
/*  the distribution and/or modification of this application.                                                                                      */
/*                                                                                                                                                 */
/*  Please keep in mind that any attempt to circumvent the terms of the GNU General Public License by employing wrappers, pipelines,               */
/*  client/server protocols, etc. is illegal. You must purchase a commercial license if your program, which is distributed under a license         */
/*  other than the GNU General Public License version 2, directly or indirectly calls any portion of this code.                                    */
/*  Simply stop using the product if you disagree with this viewpoint.                                                                             */
/*                                                                                                                                                 */
/*  According to the terms of the license provided by SILVERCODERS and included in the file COPYING.COM, licensees in possession of                */
/*  a current commercial license for this product may use this file.                                                                               */
/*                                                                                                                                                 */
/*  This program is provided WITHOUT ANY WARRANTY, not even the implicit warranty of merchantability or fitness for a particular purpose.          */
/*  It is supplied in the hope that it will be useful.                                                                                             */
/***************************************************************************************************************************************************/
 
#ifndef DOCTOTEXT_C_API_H
#define DOCTOTEXT_C_API_H
 
#include <stdbool.h>
#include "defines.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#ifndef DOCTOTEXT_CALL
  #if defined(_WIN32) && !defined(_WIN64)
    #define DOCTOTEXT_CALL __cdecl
  #else
    #define DOCTOTEXT_CALL
  #endif
#endif
 
typedef struct DocToTextParserManager DocToTextParserManager; 
typedef struct DocToTextItem DocToTextItem;
typedef struct DocToTextParser DocToTextParser; 
typedef struct DocToTextInfo DocToTextInfo; 
typedef struct DocToTextParameters DocToTextParameters; 
typedef struct DocToTextWriter DocToTextWriter; 
 
typedef struct DocToTextImporter DocToTextImporter; 
typedef struct DocToTextExporter DocToTextExporter; 
typedef struct DocToTextTransformer DocToTextTransformer; 
typedef struct DocToTextParsingChain DocToTextParsingChain; 
typedef struct DocToTextSimpleExtractor DocToTextSimpleExtractor; 
 
DllExport DocToTextSimpleExtractor*
DOCTOTEXT_CALL doctotext_create_simple_extractor(const char* file_name);
 
DllExport const char *
DOCTOTEXT_CALL doctotext_simple_extractor_get_plain_text(DocToTextSimpleExtractor* extractor);
 
DllExport void
DOCTOTEXT_CALL doctotext_simple_extractor_add_callback_function(DocToTextSimpleExtractor* extractor, void (*callback)(DocToTextInfo*, void* data), void* data);
 
DllExport DocToTextImporter*
DOCTOTEXT_CALL doctotext_create_importer_from_file_name(DocToTextParserManager *manager, const char *file_name);
 
DllExport DocToTextImporter*
DOCTOTEXT_CALL doctotext_create_importer_from_stream(DocToTextParserManager *manager, FILE *input_stream);
 
DllExport DocToTextExporter*
DOCTOTEXT_CALL doctotext_create_plain_text_exporter(FILE *output_stream);
 
DllExport DocToTextExporter*
DOCTOTEXT_CALL doctotext_create_html_exporter(FILE *output_stream);
 
DllExport DocToTextParsingChain*
DOCTOTEXT_CALL doctotext_connect_importer_to_exporter(DocToTextImporter* importer, DocToTextExporter *exporter);
 
DllExport DocToTextTransformer*
DOCTOTEXT_CALL doctotext_create_transfomer(void (*callback)(DocToTextInfo*, void* data), void* data);
 
DllExport DocToTextParsingChain*
DOCTOTEXT_CALL doctotext_connect_importer_to_transformer(DocToTextImporter* importer, DocToTextTransformer *transformer);
 
DllExport DocToTextParsingChain*
DOCTOTEXT_CALL doctotext_connect_parsing_chain_to_transformer(DocToTextParsingChain *parsing_chain, DocToTextTransformer *transformer);
 
DllExport DocToTextParsingChain*
DOCTOTEXT_CALL doctotext_connect_parsing_chain_to_exporter(DocToTextParsingChain *parsing_chain, DocToTextExporter *exporter);
 
DllExport void
DOCTOTEXT_CALL doctotext_parsing_chain_set_input(DocToTextParsingChain *parsing_chain, FILE* input_stream);
 
DllExport void
DOCTOTEXT_CALL doctotext_free_importer(DocToTextImporter *importer);
 
DllExport void
DOCTOTEXT_CALL doctotext_free_exporter(DocToTextExporter *exporter);
 
DllExport void
DOCTOTEXT_CALL doctotext_free_transformer(DocToTextTransformer *transformer);
 
DllExport void
DOCTOTEXT_CALL doctotext_free_parsing_chain(DocToTextParsingChain *parsing_chain);
 
DllExport DocToTextParserManager*
DOCTOTEXT_CALL doctotext_init_parser_manager(const char* path_to_plugins);
 
DllExport char**
doctotext_parser_manager_get_available_formats(DocToTextParserManager* parser_manager, unsigned int *formats_number);
 
DllExport DocToTextParser*
DOCTOTEXT_CALL doctotext_parser_manager_get_parser_by_extension(DocToTextParserManager* parser_manager, const char *format);
 
DllExport void
DOCTOTEXT_CALL doctotext_parser_add_callback_on_new_node(DocToTextParser* parser, void (*callback)(DocToTextInfo*, void* data), void* data);
 
DllExport void
DOCTOTEXT_CALL doctotext_parser_add_parameters(DocToTextParser* parser, DocToTextParameters* parameters);
 
DllExport void
DOCTOTEXT_CALL doctotext_parser_parse(DocToTextParser* parser);
 
DllExport void
DOCTOTEXT_CALL doctotext_free_parser(DocToTextParser* parser);
 
DllExport const char*
DOCTOTEXT_CALL doctotext_info_get_plain_text(DocToTextInfo* info);
 
DllExport const char*
DOCTOTEXT_CALL doctotext_info_get_tag_name(DocToTextInfo* info);
 
DllExport const char*
DOCTOTEXT_CALL doctotext_info_get_string_attribute(DocToTextInfo* info, const char* attribute_name);
 
DllExport unsigned int
DOCTOTEXT_CALL doctotext_info_get_uint_attribute(DocToTextInfo* info, const char* attribute_name);
 
DllExport void
DOCTOTEXT_CALL doctotext_info_set_cancel_parser(DocToTextInfo* info, bool cancel);
 
DllExport void
DOCTOTEXT_CALL doctotext_info_set_skip(DocToTextInfo* info, bool skip);
 
DllExport DocToTextParameters*
DOCTOTEXT_CALL doctotext_create_parameter();
 
DllExport void
DOCTOTEXT_CALL doctotext_add_int_parameter(DocToTextParameters* parameters, const char* name, int value);
 
DllExport void
DOCTOTEXT_CALL doctotext_add_uint_parameter(DocToTextParameters* parameters, const char* name, unsigned int value);
 
DllExport void
DOCTOTEXT_CALL doctotext_add_float_parameter(DocToTextParameters* parameters, const char* name, float value);
 
 
DllExport void
DOCTOTEXT_CALL doctotext_add_string_parameter(DocToTextParameters* parameters, const char* name, const char* value);
 
DllExport DocToTextWriter*
DOCTOTEXT_CALL doctotext_create_html_writer();
 
DllExport DocToTextWriter*
DOCTOTEXT_CALL doctotext_create_plain_text_writer();
 
DllExport void
DOCTOTEXT_CALL doctotext_free_writer(DocToTextWriter* writer);
 
DllExport void
DOCTOTEXT_CALL doctotext_writer_write(DocToTextWriter* writer, DocToTextInfo* info, FILE* out_stream);
 
DllExport void
DOCTOTEXT_CALL doctotext_writer_write_header(DocToTextWriter* writer, FILE* out_stream);
 
DllExport void
DOCTOTEXT_CALL doctotext_writer_write_footer(DocToTextWriter* writer, FILE* out_stream);
 
#ifdef __cplusplus
}
#endif
 
#endif //DOCTOTEXT_C_API_H