result.hxx

#ifndef PQXX_H_RESULT
#define PQXX_H_RESULT

#include "pqxx/compiler-public.hxx"
#include "pqxx/compiler-internal-pre.hxx"

#include <ios>
#include <memory>
#include <stdexcept>

#include "pqxx/except.hxx"
#include "pqxx/types.hxx"
#include "pqxx/util.hxx"

#include "pqxx/internal/encodings.hxx"


// Methods tested in eg. test module test01 are marked with "//[t01]".

namespace pqxx
{
namespace internal
{
PQXX_LIBEXPORT void clear_result(const pq::PGresult *);

namespace gate
{
class result_connection;
class result_creation;
class result_row;
class result_sql_cursor;
} // namespace internal::gate
} // namespace internal



class PQXX_LIBEXPORT result
{
public:
  using size_type = result_size_type;
  using difference_type = result_difference_type;
  using reference = row;
  using const_iterator = const_result_iterator;
  using pointer = const_iterator;
  using iterator = const_iterator;
  using const_reverse_iterator = const_reverse_result_iterator;
  using reverse_iterator = const_reverse_iterator;

  result() noexcept :                                                   //[t03]
      m_data(make_data_pointer()),
      m_query(),
      m_encoding(internal::encoding_group::MONOBYTE)
    {}
  result(const result &rhs) noexcept =default;                          //[t01]

  result &operator=(const result &rhs) noexcept =default;               //[t10]

  bool operator==(const result &) const noexcept;                       //[t70]
  bool operator!=(const result &rhs) const noexcept                     //[t70]
        { return not operator==(rhs); }

  const_reverse_iterator rbegin() const;                                //[t75]
  const_reverse_iterator crbegin() const;
  const_reverse_iterator rend() const;                                  //[t75]
  const_reverse_iterator crend() const;

  const_iterator begin() const noexcept;                                //[t01]
  const_iterator cbegin() const noexcept;
  inline const_iterator end() const noexcept;                           //[t01]
  inline const_iterator cend() const noexcept;

  reference front() const noexcept;                                     //[t74]
  reference back() const noexcept;                                      //[t75]

  PQXX_PURE size_type size() const noexcept;                            //[t02]
  PQXX_PURE bool empty() const noexcept;                                //[t11]
  size_type capacity() const noexcept { return size(); }                //[t20]

  void swap(result &) noexcept;                                         //[t77]

  const row operator[](size_type i) const noexcept;                     //[t02]
  const row at(size_type) const;                                        //[t10]

  void clear() noexcept { m_data.reset(); m_query = nullptr; }          //[t20]

  PQXX_PURE row_size_type columns() const noexcept;                     //[t11]

  row_size_type column_number(const char ColName[]) const;              //[t11]

  row_size_type column_number(const std::string &Name) const            //[t11]
        {return column_number(Name.c_str());}

  const char *column_name(row_size_type Number) const;                  //[t11]

  oid column_type(row_size_type ColNum) const;                          //[t07]
  oid column_type(int ColNum) const                                     //[t07]
        { return column_type(row_size_type(ColNum)); }

  oid column_type(const std::string &ColName) const                     //[t07]
        { return column_type(column_number(ColName)); }

  oid column_type(const char ColName[]) const                           //[t07]
        { return column_type(column_number(ColName)); }

  oid column_table(row_size_type ColNum) const;                         //[t02]

  oid column_table(int ColNum) const                                    //[t02]
        { return column_table(row_size_type(ColNum)); }

  oid column_table(const std::string &ColName) const                    //[t02]
        { return column_table(column_number(ColName)); }

  row_size_type table_column(row_size_type ColNum) const;               //[t93]

  row_size_type table_column(int ColNum) const                          //[t93]
        { return table_column(row_size_type(ColNum)); }

  row_size_type table_column(const std::string &ColName) const          //[t93]
        { return table_column(column_number(ColName)); }

  PQXX_PURE const std::string &query() const noexcept;                  //[t70]


  PQXX_PURE oid inserted_oid() const;                                   //[t13]


  PQXX_PURE size_type affected_rows() const;                            //[t07]


private:
  using data_pointer = std::shared_ptr<const internal::pq::PGresult>;

   data_pointer m_data;

  static data_pointer make_data_pointer(
        const internal::pq::PGresult *res=nullptr)
        { return data_pointer{res, internal::clear_result}; }

  std::shared_ptr<std::string> m_query;

  internal::encoding_group m_encoding;

  static const std::string s_empty_string;

  friend class pqxx::field;
  PQXX_PURE const char *GetValue(size_type Row, row_size_type Col) const;
  PQXX_PURE bool get_is_null(size_type Row, row_size_type Col) const;
  PQXX_PURE field_size_type get_length(
        size_type,
        row_size_type) const noexcept;

  friend class pqxx::internal::gate::result_creation;
  result(
        internal::pq::PGresult *rhs,
        const std::string &Query,
        internal::encoding_group enc);

  PQXX_PRIVATE void check_status() const;

  friend class pqxx::internal::gate::result_connection;
  friend class pqxx::internal::gate::result_row;
  bool operator!() const noexcept { return not m_data.get(); }
  operator bool() const noexcept { return m_data.get() != nullptr; }

  [[noreturn]] PQXX_PRIVATE void ThrowSQLError(
        const std::string &Err,
        const std::string &Query) const;
  PQXX_PRIVATE PQXX_PURE int errorposition() const;
  PQXX_PRIVATE std::string StatusError() const;

  friend class pqxx::internal::gate::result_sql_cursor;
  PQXX_PURE const char *cmd_status() const noexcept;
};
} // namespace pqxx
#include "pqxx/compiler-internal-post.hxx"
#endif