NE.h

Go to the documentation of this file.

#ifndef __NE__
#define __NE__

#include "zip.h"

typedef unsigned char NEBoolean;

#if !defined(NULL)

#   define NULL 0
#endif

#if !defined(FALSE)
#   define FALSE 0  ///< false boolean value
#   define TRUE 1   ///< true boolean value
#endif

typedef enum
{
    kNEErrOk = 0,
    kNEErrCannotCreateEPUBFile,
    kNEErrZip,
    kNEErrMalloc,
    kNEErrCannotOpenFile,
} NEErr;

typedef enum
{
    kNEMetaTitle,   
    kNEMetaCreator, 
    kNEMetaIdentifier,  
    kNEMetaLanguage,    
    kNEMetaSubject, 
    kNEMetaDescription, 
    kNEMetaPublisher,   
    kNEMetaDate,    
    kNEMetaSource,  
    kNEMetaRights   
} NEMetadataKey;

typedef struct
{
    zipFile zf; 
    
    // required metadata
    char *title;    
    char *creator;  
    char *identifier;   
    char *language; // language (RFC 3066; lf-separated if multiple)
    
    // optional metadata
    char *subject;  
    char *description;  
    char *publisher;    
    char *date; 
    char *source;   
    char *rights;   
    
    // endnotes
    char *endnotes; 
    int endnoteCount;   
    char *lastRefLink;  
    char *currentDoc;   
    
    // parts (XHTML)
    char *parts;    
    char *auxParts; 
    char *cover;    
    char *coverImage;   
    
    // other documents (images, css, etc.)
    char *other;    
    
    // toc entries
    char *tocEntries;   
    int ncxCount;   
    int maxTOCDepth;    
} NE, *NEPtr;

NEErr NEBegin(NEPtr ne, char const *filename);

NEErr NEAddMetadata(NEPtr ne,
    NEMetadataKey key, char const *data, int dataLen);

NEErr NEAddPart(NEPtr ne, char const *filename, NEBoolean auxiliary);

NEErr NEAddOther(NEPtr ne,
        char const *filename, int filenameLen,
        char const *mimetype);

void NEEnumOther(NEPtr ne,
        char const **filename,
        int *filenameLength);

NEErr NEAddTOCEntry(NEPtr ne, char const *title, char const *relativeUrl, int level);

NEErr NEAddFile(NEPtr ne,
    char const *filename,
    char const *path);

NEErr NENewFile(NEPtr ne,
    char const *filename);

NEErr NEWriteToFile(NEPtr ne,
    char const *data, int len);

NEErr NECloseFile(NEPtr ne);

NEErr NEAddEndnote(NEPtr ne,
        char const *endnote, int len,
        char const *refDoc, int refDocLen,
        char const **refLink);

NEErr NEMakeCover(NEPtr ne);

NEErr NESetCoverImage(NEPtr ne, char const *filename, int filenameLen);

NEErr NEEnd(NEPtr ne);

// utility string functions

NEErr NEStringCopy(char **str, char const *src, int srcLen);

NEErr NEStringCat(char **str, char const *src, int srcLen);

NEErr NEStringAdd(char **str, char const *src, int srcLen);

char const *NEStringNextPart(char const *str);

void NEStringFree(char **str);


#endif