Add support for custom database type mapping

New pragma qualifier, map, and specifiers: as, to, from. New tests:
<database>/custom.

6 files changed, 648 insertions, 0 deletions

diff --git a/pgsql/custom/driver.cxx b/pgsql/custom/driver.cxx
new file mode 100644
index 0000000..f1f70f8
--- /dev/null
+++ b/pgsql/custom/driver.cxx
@@ -0,0 +1,123 @@
+// file      : pgsql/custom/driver.cxx
+// copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
+// license   : GNU GPL v2; see accompanying LICENSE file
+
+// Test custom database type mapping in PostgreSQL.
+//
+
+#include <memory>   // std::auto_ptr
+#include <cassert>
+#include <iostream>
+
+#include <odb/pgsql/database.hxx>
+#include <odb/pgsql/transaction.hxx>
+
+#include <common/common.hxx>
+
+#include "test.hxx"
+#include "test-odb.hxx"
+
+using namespace std;
+using namespace odb::core;
+
+int
+main (int argc, char* argv[])
+{
+  try
+  {
+    auto_ptr<database> db (create_database (argc, argv));
+
+    object o (1);
+    o.p = point (1.1111, 2222222222.2);
+    o.pv.push_back (point (1.1234, 2.2345));
+    o.pv.push_back (point (3.3456, 4.4567));
+    o.pv.push_back (point (0.0000001, 0.000000001)); // Scientific notation.
+
+    o.n1 = "23.5154";
+    o.n2 = "235154";
+    o.n3 = "2222222222222222222222222222.111111111111111111111111111111";
+
+    o.iv.push_back (123);
+    o.iv.push_back (234);
+    o.iv.push_back (-345);
+
+    // Persist.
+    //
+    {
+      transaction t (db->begin ());
+      db->persist (o);
+      t.commit ();
+    }
+
+    // Load.
+    //
+    {
+      transaction t (db->begin ());
+      auto_ptr<object> o1 (db->load<object> (1));
+      t.commit ();
+
+      assert (o == *o1);
+    }
+
+    // Query.
+    //
+    typedef odb::query<object> query;
+    typedef odb::result<object> result;
+
+    {
+      transaction t (db->begin ());
+
+      // Point comparison.
+      //
+      {
+        result r (db->query<object> (query::p == o.p));
+        assert (!r.empty ());
+      }
+
+      // Point comparison using native query.
+      //
+      {
+        result r (db->query<object> (query::p + "~=" + query::_val (o.p)));
+        assert (!r.empty ());
+      }
+
+      // Access to individual members.
+      //
+      {
+        result r (db->query<object> (query::p.x == o.p.x));
+        assert (!r.empty ());
+      }
+
+      t.commit ();
+    }
+
+    // Update.
+    //
+    o.p.x++;
+    o.p.y--;
+    o.pv[1].x--;
+    o.pv[1].y++;
+    o.n3 += "999";
+    o.iv[0]++;
+    o.iv.pop_back ();
+
+    {
+      transaction t (db->begin ());
+      db->update (o);
+      t.commit ();
+    }
+
+    {
+      transaction t (db->begin ());
+      auto_ptr<object> o1 (db->load<object> (1));
+      t.commit ();
+
+      assert (o == *o1);
+    }
+  }
+  catch (const odb::exception& e)
+  {
+    cerr << e.what () << endl;
+    return 1;
+  }
+}
diff --git a/pgsql/custom/makefile b/pgsql/custom/makefile
new file mode 100644
index 0000000..30ce36d
--- /dev/null
+++ b/pgsql/custom/makefile
@@ -0,0 +1,112 @@
+# file      : pgsql/custom/makefile
+# copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
+# license   : GNU GPL v2; see accompanying LICENSE file
+
+include $(dir $(lastword $(MAKEFILE_LIST)))../../build/bootstrap.make
+
+cxx_tun := driver.cxx
+odb_hdr := test.hxx
+cxx_obj := $(addprefix $(out_base)/,$(cxx_tun:.cxx=.o) $(odb_hdr:.hxx=-odb.o))
+cxx_od  := $(cxx_obj:.o=.o.d)
+
+common.l             := $(out_root)/libcommon/common/common.l
+common.l.cpp-options := $(out_root)/libcommon/common/common.l.cpp-options
+
+driver  := $(out_base)/driver
+dist    := $(out_base)/.dist
+test    := $(out_base)/.test
+clean   := $(out_base)/.clean
+
+# Import.
+#
+$(call import,\
+  $(scf_root)/import/odb/stub.make,\
+  odb: odb,odb-rules: odb_rules)
+
+# Build.
+#
+$(driver): $(cxx_obj) $(common.l)
+$(cxx_obj) $(cxx_od): cpp_options := -I$(out_base) -I$(src_base)
+$(cxx_obj) $(cxx_od): $(common.l.cpp-options)
+
+genf := $(addprefix $(odb_hdr:.hxx=-odb),.hxx .ixx .cxx) $(odb_hdr:.hxx=.sql)
+gen  := $(addprefix $(out_base)/,$(genf))
+
+$(gen): $(odb)
+$(gen): odb := $(odb)
+$(gen) $(dist): export odb_options += --database pgsql --generate-schema \
+--generate-query --hxx-prologue '\#include "traits.hxx"' \
+--hxx-prologue '\#include "query.hxx"' --table-prefix pgsql_custom_
+$(gen): cpp_options := -I$(src_base)
+$(gen): $(common.l.cpp-options)
+
+$(call include-dep,$(cxx_od),$(cxx_obj),$(gen))
+
+# Alias for default target.
+#
+$(out_base)/: $(driver)
+
+# Dist
+#
+$(dist): sources := $(cxx_tun)
+$(dist): headers := $(odb_hdr)
+$(dist): export extra_headers := traits.hxx query.hxx
+$(dist): data_dist := test.std
+$(dist): export name := $(subst /,-,$(subst $(src_root)/pgsql/,,$(src_base)))
+$(dist): export extra_dist := $(data_dist) $(name)-vc9.vcproj \
+$(name)-vc10.vcxproj $(name)-vc10.vcxproj.filters
+$(dist):
+	$(call dist-data,$(sources) $(headers) $(extra_headers) $(data_dist))
+	$(call meta-automake,../template/Makefile.am)
+	$(call meta-vc9proj,../template/template-vc9.vcproj,$(name)-vc9.vcproj)
+	$(call meta-vc10proj,../template/template-vc10.vcxproj,$(name)-vc10.vcxproj)
+
+# Test.
+#
+$(test): $(driver) $(src_base)/test.std
+	$(call schema)
+	$(call message,test $<,$< --options-file $(dcf_root)/db.options \
+>$(out_base)/test.out)
+	$(call message,,diff -u $(src_base)/test.std $(out_base)/test.out)
+	$(call message,,rm -f $(out_base)/test.out)
+
+# Clean.
+#
+$(clean):                            \
+  $(driver).o.clean                  \
+  $(addsuffix .cxx.clean,$(cxx_obj)) \
+  $(addsuffix .cxx.clean,$(cxx_od))  \
+  $(addprefix $(out_base)/,$(odb_hdr:.hxx=-odb.cxx.hxx.clean))
+	$(call message,,rm -f $(out_base)/test.out)
+
+# Generated .gitignore.
+#
+ifeq ($(out_base),$(src_base))
+$(driver): | $(out_base)/.gitignore
+
+$(out_base)/.gitignore: files := driver $(genf)
+$(clean): $(out_base)/.gitignore.clean
+
+$(call include,$(bld_root)/git/gitignore.make)
+endif
+
+# How to.
+#
+$(call include,$(bld_root)/dist.make)
+$(call include,$(bld_root)/meta/vc9proj.make)
+$(call include,$(bld_root)/meta/vc10proj.make)
+$(call include,$(bld_root)/meta/automake.make)
+
+$(call include,$(bld_root)/cxx/standard.make) # cxx_standard
+ifdef cxx_standard
+$(gen): odb_options += --std $(cxx_standard)
+$(call include,$(odb_rules))
+endif
+
+$(call include,$(bld_root)/cxx/cxx-d.make)
+$(call include,$(bld_root)/cxx/cxx-o.make)
+$(call include,$(bld_root)/cxx/o-e.make)
+
+# Dependencies.
+#
+$(call import,$(src_root)/libcommon/makefile)
diff --git a/pgsql/custom/query.hxx b/pgsql/custom/query.hxx
new file mode 100644
index 0000000..4b29b45
--- /dev/null
+++ b/pgsql/custom/query.hxx
@@ -0,0 +1,159 @@
+// file      : pgsql/custom/query.hxx
+// copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
+// license   : GNU GPL v2; see accompanying LICENSE file
+
+#ifndef QUERY_HXX
+#define QUERY_HXX
+
+#include <string>
+
+#include <odb/pgsql/query.hxx>
+
+#include "test.hxx" // point
+
+namespace odb
+{
+  namespace pgsql
+  {
+    template <>
+    struct query_column<point, id_string>
+    {
+    private:
+      const char* table_;
+      const char* column_;
+      const char* conversion_;
+
+      std::string x_column_;
+      std::string y_column_;
+
+      // Sub-columns for individual members.
+      //
+    public:
+      query_column<double, id_double> x, y;
+
+      // is_null, is_not_null
+      //
+    public:
+      query
+      is_null () const
+      {
+        query q (table_, column_);
+        q += "IS NULL";
+        return q;
+      }
+
+      query
+      is_not_null () const
+      {
+        query q (table_, column_);
+        q += "IS NOT NULL";
+        return q;
+      }
+
+      // =
+      //
+    public:
+      query
+      equal (const point& v) const
+      {
+        return equal (val_bind<point> (v));
+      }
+
+      query
+      equal (val_bind<point> v) const
+      {
+        query q (table_, column_);
+        q += "~=";
+        q.append<point, id_string> (v, conversion_);
+        return q;
+      }
+
+      query
+      equal (ref_bind<point> r) const
+      {
+        query q (table_, column_);
+        q += "~=";
+        q.append<point, id_string> (r, conversion_);
+        return q;
+      }
+
+      friend query
+      operator== (const query_column& c, const point& v)
+      {
+        return c.equal (v);
+      }
+
+      friend query
+      operator== (const point& v, const query_column& c)
+      {
+        return c.equal (v);
+      }
+
+      friend query
+      operator== (const query_column& c, val_bind<point> v)
+      {
+        return c.equal (v);
+      }
+
+      friend query
+      operator== (val_bind<point> v, const query_column& c)
+      {
+        return c.equal (v);
+      }
+
+      friend query
+      operator== (const query_column& c, ref_bind<point> r)
+      {
+        return c.equal (r);
+      }
+
+      friend query
+      operator== (ref_bind<point> r, const query_column& c)
+      {
+        return c.equal (r);
+      }
+
+      // Column comparison.
+      //
+    public:
+      query
+      operator== (const query_column<point, id_string>& c) const
+      {
+        query q (table_, column_);
+        q += "~=";
+        q.append (c.table (), c.column ());
+        return q;
+      }
+
+    public:
+      query_column (const char* table, const char* column, const char* conv)
+          : table_ (table), column_ (column), conversion_ (conv),
+            x_column_ (std::string (column) + "[0]"),
+            y_column_ (std::string (column) + "[1]"),
+            x (table, x_column_.c_str (), 0),
+            y (table, y_column_.c_str (), 0)
+      {
+      }
+
+      const char*
+      table () const
+      {
+        return table_;
+      }
+
+      const char*
+      column () const
+      {
+        return column_;
+      }
+
+      const char*
+      conversion () const
+      {
+        return conversion_;
+      }
+    };
+  }
+}
+
+#endif // QUERY_HXX
diff --git a/pgsql/custom/test.hxx b/pgsql/custom/test.hxx
new file mode 100644
index 0000000..1f83031
--- /dev/null
+++ b/pgsql/custom/test.hxx
@@ -0,0 +1,87 @@
+// file      : pgsql/custom/test.hxx
+// copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
+// license   : GNU GPL v2; see accompanying LICENSE file
+
+#ifndef TEST_HXX
+#define TEST_HXX
+
+#include <string>
+#include <vector>
+
+#include <odb/core.hxx>
+
+// Map POINT PostgreSQL type to the point C++ struct. The other half
+// of this mapping is in traits.hxx (value_traits<point, id_string>).
+//
+#pragma db map type("POINT") as("TEXT") to("(?)::POINT") from("(?)::TEXT")
+
+#pragma db value type("POINT")
+struct point
+{
+  point () {}
+  point (double x_, double y_): x (x_), y (y_) {}
+
+  double x;
+  double y;
+};
+
+inline bool
+operator== (const point& a, const point& b)
+{
+  return a.x == b.x && a.y == b.y;
+}
+
+// Map NUMERIC PostgreSQL type to std::string (or any other type that
+// provides the value_traits<?, id_string> specialization).
+//
+#pragma db map type("NUMERIC *(\\(.+\\))?") \
+               as("TEXT")                   \
+               to("(?)::NUMERIC$1")         \
+               from("(?)::TEXT")
+
+// Map INTEGER[] PostgreSQL type to std::vector<int>. The other half of
+// this mapping is in traits.hxx (value_traits<std::vector<int>, id_string>).
+//
+#pragma db map type("INTEGER *\\[(\\d+)\\]") \
+               as("TEXT")                    \
+               to("(?)::INTEGER[$1]")        \
+               from("(?)::TEXT")
+
+#pragma db object
+struct object
+{
+  object () {}
+  object (unsigned long id_) : id (id_) {}
+
+  #pragma db id
+  unsigned long id;
+
+  point p;
+  std::vector<point> pv;
+
+  #pragma db type("NUMERIC(6, 4)")
+  std::string n1;
+
+  #pragma db type("NUMERIC(6)")
+  std::string n2;
+
+  #pragma db type("NUMERIC")
+  std::string n3;
+
+  #pragma db type("INTEGER [123]")
+  std::vector<int> iv;
+
+  bool
+  operator== (const object& y) const
+  {
+    return id == y.id &&
+           p == y.p   &&
+           pv == y.pv &&
+           n1 == y.n1 &&
+           n2 == y.n2 &&
+           n3 == y.n3 &&
+           iv == y.iv;
+  }
+};
+
+#endif // TEST_HXX
diff --git a/pgsql/custom/test.std b/pgsql/custom/test.std
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/pgsql/custom/test.std
diff --git a/pgsql/custom/traits.hxx b/pgsql/custom/traits.hxx
new file mode 100644
index 0000000..800bfdb
--- /dev/null
+++ b/pgsql/custom/traits.hxx
@@ -0,0 +1,167 @@
+// file      : pgsql/custom/traits.hxx
+// copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
+// license   : GNU GPL v2; see accompanying LICENSE file
+
+#ifndef TRAITS_HXX
+#define TRAITS_HXX
+
+#include <limits>  // std::numeric_limits
+#include <vector>
+#include <sstream>
+#include <cstring> // std::memcpy
+
+#include <odb/pgsql/traits.hxx>
+
+#include "test.hxx" // point
+
+namespace odb
+{
+  namespace pgsql
+  {
+    template <>
+    class value_traits<point, id_string>
+    {
+    public:
+      typedef point value_type;
+      typedef point query_type;
+      typedef details::buffer image_type;
+
+      static void
+      set_value (point& v,
+                 const details::buffer& b,
+                 std::size_t n,
+                 bool is_null)
+      {
+        if (is_null)
+          v = point ();
+        else
+        {
+          // Point format is "(x,y)".
+          //
+          char c;
+          std::istringstream is (std::string (b.data (), n));
+
+          is >> c;    // '('
+          is >> v.x;
+          is >> c;    // ','
+          is >> v.y;
+        }
+      }
+
+      static void
+      set_image (details::buffer& b,
+                 std::size_t& n,
+                 bool& is_null,
+                 const point& v)
+      {
+        is_null = false;
+        std::ostringstream os;
+
+        // The formula for the number of decimla digits required is given in:
+        //
+        // http://www.open-std.org/JTC1/SC22/WG21/docs/papers/2005/n1822.pdf
+        //
+        os.precision (std::numeric_limits<double>::digits10);
+        // os.precision (2 + std::numeric_limits<double>::digits * 301/1000);
+
+        os << '(' << v.x << ',' << v.y << ')';
+
+        const std::string& s (os.str ());
+        n = s.size ();
+
+        if (n > b.capacity ())
+          b.capacity (n);
+
+        std::memcpy (b.data (), s.c_str (), n);
+      }
+    };
+
+    template <>
+    struct type_traits<point>
+    {
+      static const database_type_id db_type_id = id_string;
+
+      struct conversion
+      {
+        static const char* to () {return "(?)::POINT";}
+      };
+    };
+
+    template <>
+    class value_traits<std::vector<int>, id_string>
+    {
+    public:
+      typedef std::vector<int> value_type;
+      typedef value_type query_type;
+      typedef details::buffer image_type;
+
+      static void
+      set_value (value_type& v,
+                 const details::buffer& b,
+                 std::size_t n,
+                 bool is_null)
+      {
+        v.clear ();
+
+        if (!is_null)
+        {
+          // Array format is "{n1,n2,n3...}".
+          //
+          char c;
+          std::istringstream is (std::string (b.data (), n));
+
+          is >> c; // '{'
+
+          for (c = static_cast<char> (is.peek ()); c != '}'; is >> c)
+          {
+            v.push_back (int ());
+            is >> v.back ();
+          }
+        }
+      }
+
+      static void
+      set_image (details::buffer& b,
+                 std::size_t& n,
+                 bool& is_null,
+                 const value_type& v)
+      {
+        is_null = false;
+        std::ostringstream os;
+
+        os << '{';
+
+        for (value_type::const_iterator i (v.begin ()), e (v.end ()); i != e;)
+        {
+          os << *i;
+
+          if (++i != e)
+            os << ',';
+        }
+
+        os << '}';
+
+        const std::string& s (os.str ());
+        n = s.size ();
+
+        if (n > b.capacity ())
+          b.capacity (n);
+
+        std::memcpy (b.data (), s.c_str (), n);
+      }
+    };
+
+    template <>
+    struct type_traits<std::vector<int> >
+    {
+      static const database_type_id db_type_id = id_string;
+
+      struct conversion
+      {
+        static const char* to () {return "(?)::INTEGER[]";}
+      };
+    };
+  }
+}
+
+#endif // TRAITS_HXX