7 files changed, 394 insertions, 0 deletions
diff --git a/odb-examples/pimpl/README b/odb-examples/pimpl/README
new file mode 100644
index 0000000..59ffd25
--- /dev/null
+++ b/odb-examples/pimpl/README
@@ -0,0 +1,62 @@
+This example shows how to use virtual data members to implement a persistent
+class that employs the pimpl C++ idiom.
+
+The example consists of the following files:
+
+person.hxx
+person.cxx
+  Header and source file implementing the 'person' persistent class that
+  uses the pimpl idiom.
+
+person-odb.hxx
+person-odb.ixx
+person-odb.cxx
+person.sql
+  The first three files contain the database support code and the last file
+  contains the database schema for the person.hxx header.
+
+  These files are generated by the ODB compiler from person.hxx using the
+  following command line:
+
+  odb --std c++11 -d <database> --generate-query --generate-schema person.hxx
+
+  Where <database> stands for the database system we are using, for example,
+  'pgsql'.
+
+database.hxx
+  Contains the create_database() function which instantiates the concrete
+  database class corresponding to the database system we are using.
+
+driver.cxx
+  Driver for the example. It includes the person.hxx and person-odb.hxx
+  headers to gain access to the persistent class and its database support
+  code. It also includes database.hxx for the create_database() function
+  declaration.
+
+  In main() the driver first calls create_database() to obtain the database
+  instance. Then it executes a number of database transactions on the 'person'
+  objects.
+
+To compile and link the example manually from the command line we can use the
+following commands (using PostgreSQL as an example; replace 'c++' with your
+C++ compiler name):
+
+c++ -c person.cxx
+c++ -c person-odb.cxx
+c++ -DDATABASE_PGSQL -c driver.cxx
+c++ -o driver driver.o person.o person-odb.o -lodb-pgsql -lodb
+
+To run the example we may first need to create the database schema (for some
+database systems, such as SQLite, the schema is embedded into the generated
+code which makes this step unnecessary). Using PostgreSQL as an example, this
+can be achieved with the following command:
+
+psql --username=odb_test --dbname=odb_test -f person.sql
+
+Here we use 'odb_test' as the database login and also 'odb_test' as the
+database name.
+
+Once the database schema is ready, we can run the example (using PostgreSQL as
+the database):
+
+./driver --user odb_test --database odb_test
diff --git a/odb-examples/pimpl/buildfile b/odb-examples/pimpl/buildfile
new file mode 100644
index 0000000..3191c3a
--- /dev/null
+++ b/odb-examples/pimpl/buildfile
@@ -0,0 +1,45 @@
+# file      : pimpl/buildfile
+# license   : GNU GPL v2; see accompanying LICENSE file
+
+import libodb = libodb%lib{odb}
+
+import libs = libodb-$database%lib{odb-$database}
+
+exe{driver}: {hxx cxx}{* -person-odb} {hxx ixx cxx}{person-odb} testscript
+
+# The metadata library target which we use to extract the poptions variable
+# value for specifying the preprocessor options (-I, etc) on the ODB compiler
+# command line.
+#
+libue{person-meta}: $libodb
+
+exe{driver}: libue{person-meta} $libs
+
+<{hxx ixx cxx}{person-odb}>: hxx{person} libue{person-meta} $odb
+{{
+  pops = $cxx.lib_poptions($<[1])
+  depdb hash $pops
+
+  depdb dyndep --dyn-target --target-what 'generated schema' --format lines \
+  -- echo ($sqlite ? '' : "$out_base/person.sql")
+
+  $odb --std c++11            \
+       --database $database   \
+       --generate-schema      \
+       --generate-query       \
+       --output-dir $out_base \
+       --table-prefix pimpl_  \
+       "-I$src_base" $pops    \
+       $path($<[0])
+}}
+
+cxx.poptions =+ "-I$out_base" "-I$src_base" -DDATABASE_$ucase($database)
+
+# Testscript's run-time prerequisites.
+#
+# @@ BUILD2: Eventually we should be able to mark it as test.input once
+#    this is supported for testscript tests.
+#
+exe{driver}: ../alias{database-client}: include = adhoc
+
+testscript@./: schema = person
diff --git a/odb-examples/pimpl/database.hxx b/odb-examples/pimpl/database.hxx
new file mode 100644
index 0000000..46c3ba9
--- /dev/null
+++ b/odb-examples/pimpl/database.hxx
@@ -0,0 +1,95 @@
+// file      : pimpl/database.hxx
+// copyright : not copyrighted - public domain
+
+//
+// Create concrete database instance based on the DATABASE_* macros.
+//
+
+#ifndef DATABASE_HXX
+#define DATABASE_HXX
+
+#include <string>
+#include <memory>   // std::unique_ptr
+#include <cstdlib>  // std::exit
+#include <iostream>
+
+#include <odb/database.hxx>
+
+#if defined(DATABASE_MYSQL)
+#  include <odb/mysql/database.hxx>
+#elif defined(DATABASE_SQLITE)
+#  include <odb/connection.hxx>
+#  include <odb/transaction.hxx>
+#  include <odb/schema-catalog.hxx>
+#  include <odb/sqlite/database.hxx>
+#elif defined(DATABASE_PGSQL)
+#  include <odb/pgsql/database.hxx>
+#elif defined(DATABASE_ORACLE)
+#  include <odb/oracle/database.hxx>
+#elif defined(DATABASE_MSSQL)
+#  include <odb/mssql/database.hxx>
+#else
+#  error unknown database; did you forget to define the DATABASE_* macros?
+#endif
+
+inline std::unique_ptr<odb::database>
+create_database (int& argc, char* argv[])
+{
+  using namespace std;
+  using namespace odb::core;
+
+  if (argc > 1 && argv[1] == string ("--help"))
+  {
+    cout << "Usage: " << argv[0] << " [options]" << endl
+         << "Options:" << endl;
+
+#if defined(DATABASE_MYSQL)
+    odb::mysql::database::print_usage (cout);
+#elif defined(DATABASE_SQLITE)
+    odb::sqlite::database::print_usage (cout);
+#elif defined(DATABASE_PGSQL)
+    odb::pgsql::database::print_usage (cout);
+#elif defined(DATABASE_ORACLE)
+    odb::oracle::database::print_usage (cout);
+#elif defined(DATABASE_MSSQL)
+    odb::mssql::database::print_usage (cout);
+#endif
+
+    exit (0);
+  }
+
+#if defined(DATABASE_MYSQL)
+  unique_ptr<database> db (new odb::mysql::database (argc, argv));
+#elif defined(DATABASE_SQLITE)
+  unique_ptr<database> db (
+    new odb::sqlite::database (
+      argc, argv, false, SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE));
+
+  // Create the database schema. Due to bugs in SQLite foreign key
+  // support for DDL statements, we need to temporarily disable
+  // foreign keys.
+  //
+  {
+    connection_ptr c (db->connection ());
+
+    c->execute ("PRAGMA foreign_keys=OFF");
+
+    transaction t (c->begin ());
+    schema_catalog::create_schema (*db);
+    t.commit ();
+
+    c->execute ("PRAGMA foreign_keys=ON");
+  }
+#elif defined(DATABASE_PGSQL)
+  unique_ptr<database> db (new odb::pgsql::database (argc, argv));
+#elif defined(DATABASE_ORACLE)
+  unique_ptr<database> db (new odb::oracle::database (argc, argv));
+#elif defined(DATABASE_MSSQL)
+  unique_ptr<database> db (
+    new odb::mssql::database (argc, argv, false, "TrustServerCertificate=yes"));
+#endif
+
+  return db;
+}
+
+#endif // DATABASE_HXX
diff --git a/odb-examples/pimpl/driver.cxx b/odb-examples/pimpl/driver.cxx
new file mode 100644
index 0000000..50fb62a
--- /dev/null
+++ b/odb-examples/pimpl/driver.cxx
@@ -0,0 +1,52 @@
+// file      : pimpl/driver.cxx
+// copyright : not copyrighted - public domain
+
+#include <memory>   // std::unique_ptr
+#include <iostream>
+
+#include <odb/database.hxx>
+#include <odb/transaction.hxx>
+
+#include "database.hxx" // create_database
+
+#include "person.hxx"
+#include "person-odb.hxx"
+
+using namespace std;
+using namespace odb::core;
+
+int
+main (int argc, char* argv[])
+{
+  try
+  {
+    unique_ptr<database> db (create_database (argc, argv));
+
+    {
+      person john ("john@doe.com", "John Doe", 31);
+      person jane ("jane@doe.com", "Jane Doe", 29);
+
+      transaction t (db->begin ());
+      db->persist (john);
+      db->persist (jane);
+      t.commit ();
+    }
+
+    {
+      typedef odb::result<person> result;
+
+      transaction t (db->begin ());
+      result r (db->query<person> ());
+
+      for (result::iterator i (r.begin ()); i != r.end (); ++i)
+        cout << i->name () << ' ' << i->email () << ' ' << i->age () << endl;
+
+      t.commit ();
+    }
+  }
+  catch (const odb::exception& e)
+  {
+    cerr << e.what () << endl;
+    return 1;
+  }
+}
diff --git a/odb-examples/pimpl/person.cxx b/odb-examples/pimpl/person.cxx
new file mode 100644
index 0000000..6922afc
--- /dev/null
+++ b/odb-examples/pimpl/person.cxx
@@ -0,0 +1,71 @@
+// file      : pimpl/person.cxx
+// copyright : not copyrighted - public domain
+
+#include "person.hxx"
+
+using namespace std;
+
+struct person::impl
+{
+  impl () {}
+  impl (const string& e, const string& n, unsigned short a)
+      : email (e), name (n), age (a) {}
+
+  string email;
+  string name;
+  unsigned short age;
+};
+
+person::
+~person ()
+{
+  delete pimpl_;
+}
+
+person::
+person ()
+    : pimpl_ (new impl)
+{
+}
+
+person::
+person (const string& e, const string& n, unsigned short a)
+    : pimpl_ (new impl (e, n, a))
+{
+}
+
+const string& person::
+email () const
+{
+  return pimpl_->email;
+}
+
+void person::
+email (const string& e)
+{
+  pimpl_->email = e;
+}
+
+const string& person::
+name () const
+{
+  return pimpl_->name;
+}
+
+void person::
+name (const string& n)
+{
+  pimpl_->name = n;
+}
+
+unsigned short person::
+age () const
+{
+  return pimpl_->age;
+}
+
+void person::
+age (unsigned short a) const
+{
+  pimpl_->age = a;
+}
diff --git a/odb-examples/pimpl/person.hxx b/odb-examples/pimpl/person.hxx
new file mode 100644
index 0000000..d296c28
--- /dev/null
+++ b/odb-examples/pimpl/person.hxx
@@ -0,0 +1,56 @@
+// file      : pimpl/person.hxx
+// copyright : not copyrighted - public domain
+
+#ifndef PERSON_HXX
+#define PERSON_HXX
+
+#include <string>
+
+#include <odb/core.hxx>
+
+#pragma db object
+class person
+{
+public:
+  ~person ();
+  person (const std::string& email,
+          const std::string& name,
+          unsigned short age);
+
+  const std::string&
+  email () const;
+
+  void
+  email (const std::string&);
+
+  const std::string&
+  name () const;
+
+  void
+  name (const std::string&);
+
+  unsigned short
+  age () const;
+
+  void
+  age (unsigned short) const;
+
+private:
+  person (const person&);
+  person& operator= (const person&);
+
+private:
+  friend class odb::access;
+  person ();
+
+  struct impl;
+
+  #pragma db transient
+  impl* pimpl_;
+
+  #pragma db member(email) virtual(std::string) id
+  #pragma db member(name) virtual(std::string)
+  #pragma db member(age) virtual(unsigned short)
+};
+
+#endif // PERSON_HXX
diff --git a/odb-examples/pimpl/testscript b/odb-examples/pimpl/testscript
new file mode 100644
index 0000000..d4cbfd4
--- /dev/null
+++ b/odb-examples/pimpl/testscript
@@ -0,0 +1,13 @@
+# file      : pimpl/testscript
+# license   : GNU GPL v2; see accompanying LICENSE file
+
+.include ../database-options.testscript
+.include ../$(database).testscript
+
++if! $sqlite
+  $create_schema
+end
+
+: basics
+:
+$* >|