zoom/master-header

   1 // $Id: master-header,v 1.15 2003-09-22 12:45:26 mike Exp $
   2 //
   3 // ZOOM C++ Binding.
   4 // The ZOOM homepage is at http://zoom.z3950.org/
   5 //
   6 // Derived from version 1.3a at
   7 //      http://zoom.z3950.org/bind/cplusplus/zoom-1.3a.hh
   8
   9 #include <stddef.h>             // for size_t
  10 #include <string>
  11
  12
  13 */*
  14 * * This is a bit stupid.  The fact that our ZOOM-C++ implementation is
  15 * * based on the ZOOM-C implementation is our Dirty Little Secret, and
  16 * * there is in principle no reason why client code need be bothered
  17 * * with it.  Except of course that the public class declarations in
  18 * * C++ have to lay their private parts out for the world to see
  19 * * (oo-er).  Hence the inclusion of <yaz/zoom.h>
  20 * */
  21 *#include <yaz/zoom.h>
  22 *
  23 namespace ZOOM {
  24   // Forward declarations for type names.
  25   class YAZ_EXPORT query;
  26   class YAZ_EXPORT resultSet;
  27   class YAZ_EXPORT record;
  28
  29   class YAZ_EXPORT connection {
  30 *   ZOOM_connection c;
  31 *   friend class resultSet; // so it can use _getYazConnection()
  32 *   ZOOM_connection _getYazConnection () const { return c; }
  33     // connections are non-copyable.
  34     connection (const connection &);
  35     connection &operator= (const connection &);
  36   public:
  37     connection ();
  38     connection (const std::string &hostname, int portnum);
  39     ~connection ();
  40     void connect (const std::string &hostname, int portnum);
  41     std::string option (const std::string &key) const;
  42     bool option (const std::string &key, const std::string &val);
  43   };
  44
  45   class query {
  46       // base class for all query types
  47 *   friend class resultSet; // so it can use _getYazQuery()
  48 *   ZOOM_query _getYazQuery () const { return q; }
  49 * protected:
  50 *   ZOOM_query q;
  51   public:
  52     virtual ~query ();
  53   };
  54
  55   class YAZ_EXPORT prefixQuery : public query {
  56   public:
  57     prefixQuery (const std::string &pqn);
  58     ~prefixQuery ();
  59   };
  60
  61   class YAZ_EXPORT CCLQuery : public query {
  62   public:
  63     CCLQuery (const std::string &ccl, void *qualset);
  64     ~CCLQuery ();
  65   };
  66
  67   class YAZ_EXPORT resultSet {
  68 *   connection &owner;
  69 *   ZOOM_resultset rs;
  70 *   friend class record; // for _getYazResultSet() & _getYazConnection()
  71 *   ZOOM_resultset _getYazResultSet () const { return rs; }
  72 *   ZOOM_connection _getYazConnection () const {
  73 *       return owner._getYazConnection(); }
  74     // resultSets are non-copyable.
  75     resultSet (const resultSet &);
  76     resultSet &operator= (const resultSet &);
  77   public:
  78     resultSet (connection &c, const query &q);
  79     ~resultSet ();
  80     std::string option (const std::string &key) const;
  81     bool option (const std::string &key, const std::string &val);
  82     size_t size () const;
  83   };
  84
  85   class YAZ_EXPORT record {
  86 *   const resultSet &owner;
  87 *   ZOOM_record r;
  88   public:
  89     class syntax {
  90     public:
  91       enum value {
  92         UNKNOWN, GRS1, SUTRS, USMARC, UKMARC, XML
  93       };
  94 *   private:
  95 *     enum value val;
  96 *   public:
  97       syntax (value rs);
  98       operator std::string () const;
  99       bool operator== (const syntax &s) const;
 100       bool operator== (value rs) const;
 101       operator value () const;
 102     };
 103
 104     record (resultSet &rs, size_t num);
 105     ~record ();
 106     syntax recsyn () const;
 107     std::string render () const;
 108     std::string rawdata () const;
 109   };
 110
 111   // Base exception class; from which all other ZOOM exceptions
 112   // are derived. Other classes that use this as their base
 113   // class may want to provide their own errcode() and errmsg()
 114   // functions -- hence they are made virtual.
 115   class YAZ_EXPORT exception {
 116 * protected:
 117 *   int code;
 118   public:
 119     exception (int code);
 120     virtual ~exception ();
 121     virtual int errcode () const;
 122     virtual std::string errmsg () const;
 123   };
 124
 125   // systemException could be thrown for timeouts, protocol errors,
 126   // network outages.
 127   class YAZ_EXPORT systemException : public exception {
 128   public:
 129     systemException ();         // Uses value of system `errno'
 130     systemException (int code);
 131 *   virtual std::string errmsg () const; // Why do I have to repeat this?
 132   };
 133
 134   // bib1Exception::errcode() returns a code from the
 135   // Bib-1 Diagnostic Set.
 136   class YAZ_EXPORT bib1Exception: public exception {
 137 *   std::string info;
 138   public:
 139 *   ~bib1Exception ();
 140     bib1Exception (int code, const std::string &addinfo);
 141 *   virtual std::string errmsg () const; // Why do I have to repeat this?
 142     std::string addinfo () const;
 143   };
 144
 145   class YAZ_EXPORT queryException : public exception {
 146 *   std::string q;
 147   public:
 148 *   ~queryException ();
 149     enum { PREFIX, CCL };
 150     queryException (int qtype, const std::string &source);
 151 *   virtual std::string errmsg () const; // Why do I have to repeat this?
 152     std::string addinfo () const;
 153   };
 154 }