// file      : bpkg/types.hxx -*- C++ -*-
// license   : MIT; see accompanying LICENSE file

#ifndef BPKG_TYPES_HXX
#define BPKG_TYPES_HXX

#include <vector>
#include <string>
#include <memory>        // unique_ptr, shared_ptr
#include <utility>       // pair
#include <cstddef>       // size_t, nullptr_t
#include <cstdint>       // [u]int{8,16,32,64,ptr}_t
#include <istream>
#include <ostream>
#include <functional>    // function, reference_wrapper

#include <atomic>

#ifndef LIBBUTL_MINGW_STDTHREAD
#  include <thread>
#else
#  include <libbutl/mingw-thread.hxx>
#endif

#include <ios>           // ios_base::failure
#include <exception>     // exception
#include <stdexcept>     // logic_error, invalid_argument, runtime_error
#include <system_error>

#include <odb/lazy-ptr.hxx>

#include <libbutl/b.hxx>
#include <libbutl/url.hxx>
#include <libbutl/path.hxx>
#include <libbutl/uuid.hxx>
#include <libbutl/uuid-io.hxx>
#include <libbutl/xxh64.hxx>
#include <libbutl/sha256.hxx>
#include <libbutl/process.hxx>
#include <libbutl/utility.hxx>         // icase_compare_string,
                                       // compare_reference_target
#include <libbutl/optional.hxx>
#include <libbutl/fdstream.hxx>
#include <libbutl/small-vector.hxx>
#include <libbutl/target-triplet.hxx>
#include <libbutl/default-options.hxx>

namespace bpkg
{
  // Commonly-used types.
  //
  using std::uint8_t;
  using std::uint16_t;
  using std::int32_t;
  using std::uint32_t;
  using std::uint64_t;
  using std::uintptr_t;

  using std::size_t;
  using std::nullptr_t;

  using std::pair;
  using std::string;
  using std::function;
  using std::reference_wrapper;

  using std::unique_ptr;
  using std::shared_ptr;
  using std::weak_ptr;

  using std::vector;
  using butl::small_vector; // <libbutl/small-vector.hxx>

  using strings = vector<string>;
  using cstrings = vector<const char*>;

  // Concurrency.
  //
  using std::atomic;
  using std::memory_order_relaxed;
  using std::memory_order_consume;
  using std::memory_order_acquire;
  using std::memory_order_release;

#ifndef LIBBUTL_MINGW_STDTHREAD
  using std::thread;
  namespace this_thread = std::this_thread;
#else // LIBBUTL_MINGW_STDTHREAD
  using mingw_stdthread::thread;
  namespace this_thread = mingw_stdthread::this_thread;
#endif

  using std::istream;
  using std::ostream;

  // Exceptions. While <exception> is included, there is no using for
  // std::exception -- use qualified.
  //
  using std::logic_error;
  using std::invalid_argument;
  using std::runtime_error;
  using std::system_error;
  using io_error = std::ios_base::failure;

  // <libbutl/utility.hxx>
  //
  using butl::icase_compare_string;
  using butl::compare_reference_target;

  // <libbutl/optional.hxx>
  //
  using butl::optional;
  using butl::nullopt;

  // <libbutl/path.hxx>
  //
  using butl::path;
  using butl::path_name;
  using butl::path_name_view;
  using butl::dir_path;
  using butl::basic_path;
  using butl::invalid_path;

  using butl::path_cast;

  using paths = vector<path>;
  using dir_paths = vector<dir_path>;

  // <libbutl/uuid.hxx>
  //
  using butl::uuid;

  // <libbutl/url.hxx>
  //
  using butl::url;

  // <libbutl/sha256.hxx>
  //
  using butl::sha256;
  using butl::sha256_to_fingerprint;
  using butl::fingerprint_to_sha256;

  // <libbutl/xxh64.hxx>
  //
  using butl::xxh64;

  // <libbutl/process.hxx>
  //
  using butl::process;
  using butl::process_env;
  using butl::process_path;
  using butl::process_exit;
  using butl::process_error;

  // <libbutl/fdstream.hxx>
  //
  using butl::auto_fd;
  using butl::nullfd;
  using butl::fdpipe;
  using butl::ifdstream;
  using butl::ofdstream;
  using butl::fdstream_mode;

  // <libbutl/target-triplet.hxx>
  //
  using butl::target_triplet;

  // <libbutl/default-options.hxx>
  //
  using butl::default_options_files;
  using butl::default_options_entry;
  using butl::default_options;

  // <libbutl/b.hxx>
  //
  using package_info = butl::b_project_info;

  enum class sqlite_synchronous
  {
    off,
    normal,
    full,
    extra
  };

  // Return nullopt if the passed string is not a valid --sqlite-synchronous
  // option value. Match the argument case-insensitively.
  //
  // Note: defined in utility.cxx.
  //
  optional<sqlite_synchronous>
  to_sqlite_synchronous (const string&);

  // Return an upper case representation of the specified value.
  //
  // Note: defined in utility.cxx.
  //
  string
  to_string (sqlite_synchronous);

  // Derive from ODB smart pointers to return derived database (note that the
  // database() functions are defined in database.hxx).
  //
  class database;

  template <class T>
  class lazy_shared_ptr: public odb::lazy_shared_ptr<T>
  {
  public:
    using base_type = odb::lazy_shared_ptr<T>;

    using base_type::base_type;

    explicit
    lazy_shared_ptr (base_type&& p): base_type (move (p)) {}

    lazy_shared_ptr () = default;

    bpkg::database&
    database () const;
  };

  template <class T>
  class lazy_weak_ptr: public odb::lazy_weak_ptr<T>
  {
  public:
    using base_type = odb::lazy_weak_ptr<T>;

    using base_type::base_type;

    bpkg::database&
    database () const;

    lazy_shared_ptr<T>
    lock () const
    {
      return lazy_shared_ptr<T> (base_type::lock ());
    }
  };

  struct compare_lazy_ptr
  {
    template <typename P>
    bool
    operator() (const P& x, const P& y) const
    {
      // See operator==(database, database).
      //
      return x.object_id () != y.object_id ()
             ? (x.object_id () < y.object_id ())
             : less (static_cast<typename P::base_type> (x).database (),
                     static_cast<typename P::base_type> (y).database ());
    }

  private:
    // Defined in database.cxx.
    //
    bool
    less (const odb::database&, const odb::database&) const;
  };

  // Compare two lazy pointers via the pointed-to object ids.
  //
  struct compare_lazy_ptr_id
  {
    template <typename P>
    bool
    operator() (const P& x, const P& y) const
    {
      // Note: ignoring database is intentional.
      //
      return x.object_id () < y.object_id ();
    }
  };
}

// In order to be found (via ADL) these have to be either in std:: or in
// butl::. The latter is bad idea since libbutl includes the default
// implementation.
//
namespace std
{
  // Custom path printing (canonicalized, with trailing slash for directories).
  //
  inline ostream&
  operator<< (ostream& os, const ::butl::path& p)
  {
    string r (p.representation ());
    ::butl::path::traits_type::canonicalize (r);
    return os << r;
  }

  inline ostream&
  operator<< (ostream& os, const ::butl::path_name_view& v)
  {
    assert (!v.empty ());

    return v.name != nullptr && *v.name ? (os << **v.name) : (os << *v.path);
  }
}

#endif // BPKG_TYPES_HXX
