types.h

/*
 * types.h
 * Copyright (C) Carl Philipp Klemm 2022 <carl@uvos.xyz>
 *
 * types.h 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 of the License, or
 * (at your option) any later version.
 *
 * types.h 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 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/>.
 */
 
#pragma once
#include <time.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
        LL_NONE = 0,                    
        LL_CRIT = 1,                    
        LL_ERR = 2,                             
        LL_WARN = 3,                    
        LL_DEFAULT = LL_WARN,   
        LL_INFO = 4,                    
        LL_DEBUG = 5                    
} loglevel_t;
 
typedef enum {
        SCI_CAP_FILL = 1,                       
        SCI_CAP_GET_TEXT = (1<<1),      
        SCI_CAP_GET_PDF = (1<<2),       
} capability_flags_t;
 
char* capability_flags_get_str(capability_flags_t capabilities);
 
typedef struct _VersionFixed {
        unsigned int major;
        unsigned int minor;
        unsigned int patch;
} VersionFixed;
 
typedef struct _BackendInfo {
        const char *const name; 
        capability_flags_t capabilities; 
} BackendInfo;
 
typedef struct _FillReqest {
        bool doi:1; 
        bool url:1; 
        bool year:1; 
        bool publisher:1; 
        bool volume:1; 
        bool pages:1; 
        bool author:1; 
        bool title:1; 
        bool journal:1; 
        bool issn:1; 
        bool keywords:1; 
        bool downloadUrl:1; 
        bool abstract:1; 
} FillReqest;
 
typedef struct _DocumentMeta {
        //To be filled by user for query or by backend as a result
        char* doi; 
        char* url; 
        unsigned long year; 
        char* publisher; 
        char* volume; 
        char* pages; 
        char* author; 
        char* title; 
        char* journal; 
        char* issn; 
        char* keywords; 
        char* downloadUrl; 
        char* abstract; 
        char* searchText; 
        bool hasFullText; 
        int backendId; 
        //To be filled by backend
        void* backendData; 
        void (*backend_data_free_fn)(void*); 
        void* (*backend_data_copy_fn)(void*); 
        //Filled by libscipaper core
        bool compleatedLookup; 
} DocumentMeta;
 
DocumentMeta* document_meta_new(void);
 
DocumentMeta* document_meta_copy(const DocumentMeta* meta);
 
void document_meta_free(DocumentMeta* meta);
 
void document_meta_combine(DocumentMeta* target, const DocumentMeta* source);
 
char* document_meta_get_string(const DocumentMeta* meta);
 
char* document_meta_get_json(const DocumentMeta* meta, const char* fullText, size_t* length);
 
DocumentMeta* document_meta_load_from_json(char* jsonFile);
 
DocumentMeta* document_meta_load_from_json_file(const char* jsonFileName);
 
char* document_meta_load_full_text_from_json_file(const char* jsonFileName);
 
char* document_meta_get_biblatex(const DocumentMeta* meta, size_t* length, const char* type);
 
bool document_meta_save(const char* fileName, const DocumentMeta* meta, const char* fullText);
 
void document_meta_free_list(DocumentMeta** meta, size_t length);
 
bool document_meta_is_equal(const DocumentMeta* a, const DocumentMeta* b);
 
typedef struct _RequestReturn {
        DocumentMeta** documents; 
        size_t count; 
        size_t maxCount; 
        size_t page; 
        size_t totalCount; 
} RequestReturn;
 
RequestReturn* request_return_new(size_t count, size_t maxCount);
 
void request_return_free(RequestReturn* reqRet);
 
typedef struct _PdfData
{
        unsigned char* data; 
        size_t length; 
        DocumentMeta* meta; 
} PdfData;
 
void pdf_data_free(PdfData* data);
 
#ifdef __cplusplus
}
#endif