record_conv: extensible conversion
[yaz-moved-to-github.git] / include / yaz / record_conv.h
index 763f882..acf1c82 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2008 Index Data.
+ * Copyright (C) 1995-2012 Index Data.
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -44,6 +44,22 @@ YAZ_BEGIN_CDECL
 /** record conversion handle  */
 typedef struct yaz_record_conv_struct *yaz_record_conv_t;
 
+/** record conversion type */
+struct yaz_record_conv_type {
+    /** \brief internal; no need to set */
+    struct yaz_record_conv_type *next;
+
+    /** \brief construct and configure a type of ours */
+    void * (*construct)(yaz_record_conv_t , const xmlNode *, const char *path,
+                        WRBUF error_msg);
+
+    /** \brief converts a record */
+    int  (*convert)(void *info, WRBUF record, WRBUF error_msg);
+
+    /** \brief destroys our conversion handler */
+    void (*destroy)(void *info);
+};
+
 /** creates record handle
     \return record handle
 */
@@ -54,6 +70,7 @@ YAZ_EXPORT yaz_record_conv_t yaz_record_conv_create(void);
 */
 YAZ_EXPORT void yaz_record_conv_destroy(yaz_record_conv_t p);
 
+#if YAZ_HAVE_XML2
 /** configures record conversion
     \param p record conversion handle
     \param node xmlNode pointer (root element of XML config)
@@ -79,6 +96,7 @@ YAZ_EXPORT void yaz_record_conv_destroy(yaz_record_conv_t p);
 */
 YAZ_EXPORT
 int yaz_record_conv_configure(yaz_record_conv_t p, const xmlNode *node);
+#endif
 
 /** performs record conversion on record buffer (OCTET aligned)
     \param p record conversion handle
@@ -125,12 +143,21 @@ const char *yaz_record_conv_get_error(yaz_record_conv_t p);
 YAZ_EXPORT
 void yaz_record_conv_set_path(yaz_record_conv_t p, const char *path);
 
+/** adds a type to our conversion handler
+    \param p record conversion handle
+    \param type info
+*/    
+YAZ_EXPORT
+void yaz_record_conv_add_type(yaz_record_conv_t p,
+                              struct yaz_record_conv_type *type);
+
 YAZ_END_CDECL
 
 #endif
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab