Added a few comments. Source in ztest also analyzed by Doxygen.

[yaz-moved-to-github.git] / ztest / ztest.c

diff --git a/ztest/ztest.c b/ztest/ztest.c
index 0c77c76..1a0579f 100644 (file)
--- a/ztest/ztest.c
+++ b/ztest/ztest.c
@@ -3,8 +3,8 @@
  * See the file LICENSE for details.
  */
 
-/*
- * Demonstration of simple server
+/** \file
+ * \brief Demonstration of server
  */
 
 #include <stdio.h>
@@ -19,21 +19,20 @@
 #include <yaz/ill.h>
 #include <yaz/diagbib1.h>
 
+#include "ztest.h"
+
 static int log_level=0;
 static int log_level_set=0;
 
-Z_GenericRecord *dummy_grs_record (int num, ODR o);
-char *dummy_marc_record (int num, ODR odr);
-char *dummy_xml_record (int num, ODR odr);
-
 int ztest_search(void *handle, bend_search_rr *rr);
 int ztest_sort(void *handle, bend_sort_rr *rr);
 int ztest_present(void *handle, bend_present_rr *rr);
 int ztest_esrequest(void *handle, bend_esrequest_rr *rr);
 int ztest_delete(void *handle, bend_delete_rr *rr);
 
-/** \fn get_term_hit
-    \brief use term value as hit count 
+/** \brief use term value as hit count 
+    \param s RPN structure
+    \return >= 0: search term number or -1: not found
    
     Traverse RPN tree 'in order' and use term value as hit count.
     Only terms  that looks a numeric is used.. Returns -1 if
@@ -65,8 +64,9 @@ static int get_term_hit(Z_RPNStructure *s)
     return h;
 }
 
-/** \fn get_hit_count
-    \brief gets hit count for numeric terms in RPN queries
+/** \brief gets hit count for numeric terms in RPN queries
+    \param q RPN Query
+    \return number of hits (random or number for term)
     
     This is just for testing.. A real database of course uses
     the content of a database to establish a value.. In our case, we
@@ -87,7 +87,7 @@ int ztest_search(void *handle, bend_search_rr *rr)
 {
     if (rr->num_bases != 1)
     {
-        rr->errcode = 23;
+        rr->errcode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
         return 0;
     }
     /* Throw Database unavailable if other than Default or Slow */
@@ -112,7 +112,7 @@ int ztest_search(void *handle, bend_search_rr *rr)
     }
     else
     {
-        rr->errcode = 109;
+        rr->errcode = YAZ_BIB1_DATABASE_UNAVAILABLE;
         rr->errstring = rr->basenames[0];
         return 0;
     }
@@ -353,7 +353,7 @@ int ztest_esrequest (void *handle, bend_esrequest_rr *rr)
                 yaz_log (log_level, "database: %s", toKeep->databaseName);
                 if (!strcmp(toKeep->databaseName, "fault"))
                 {
-                    rr->errcode = 109;
+                    rr->errcode = YAZ_BIB1_DATABASE_UNAVAILABLE;
                     rr->errstring = toKeep->databaseName;
                 }
                 if (!strcmp(toKeep->databaseName, "accept"))
@@ -524,6 +524,7 @@ int ztest_fetch(void *handle, bend_fetch_rr *r)
         if (!cp)
         {
             r->errcode = YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE;
+            return 0;
         }
         else
         {
@@ -686,7 +687,7 @@ int ztest_scan(void *handle, bend_scan_rr *q)
     }
     else
     {
-        q->errcode = 109;
+        q->errcode = YAZ_BIB1_DATABASE_UNAVAILABLE;
         q->errstring = q->basenames[0];
         return 0;
     }
@@ -702,7 +703,7 @@ int ztest_scan(void *handle, bend_scan_rr *q)
     }
     if (q->num_entries > 200)
     {
-        q->errcode = 31;
+        q->errcode = YAZ_BIB1_RESOURCES_EXHAUSTED_NO_RESULTS_AVAILABLE;
         return 0;
     }
     if (q->term)
@@ -710,12 +711,12 @@ int ztest_scan(void *handle, bend_scan_rr *q)
         int len;
         if (q->term->term->which != Z_Term_general)
         {
-            q->errcode = 229; /* unsupported term type */
+            q->errcode = YAZ_BIB1_TERM_TYPE_UNSUPP;
             return 0;
         }
         if (*q->step_size != 0)
         {
-            q->errcode = 205; /*Only zero step size supported for Scan */
+            q->errcode = YAZ_BIB1_ONLY_ZERO_STEP_SIZE_SUPPORTED_FOR_SCAN;
             return 0;
         }
         len = q->term->term->u.general->len;
@@ -761,7 +762,8 @@ int ztest_scan(void *handle, bend_scan_rr *q)
                 {
                     list[q->num_entries].term = entries[pos];
                     list[q->num_entries].occurrences = -1;
-                    list[q->num_entries].errcode = 233;
+                    list[q->num_entries].errcode =
+                        YAZ_BIB1_SCAN_UNSUPP_VALUE_OF_POSITION_IN_RESPONSE;
                     list[q->num_entries].errstring = "SD for Scan Term";
                 }
                 else