result.h

Go to the documentation of this file.

/***********************************************************************
 Copyright (c) 1998 by Kevin Atkinson, (c) 1999-2001 by MySQL AB, and
 (c) 2004-2007 by Educational Technology Resources, Inc.  Others may
 also hold copyrights on code in this file.  See the CREDITS file in
 the top directory of the distribution for details.

 This file is part of MySQL++.

 MySQL++ is free software; you can redistribute it and/or modify it
 under the terms of the GNU Lesser General Public License as published
 by the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.

 MySQL++ is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with MySQL++; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
 USA
***********************************************************************/

#if !defined(MYSQLPP_RESULT_H)
#define MYSQLPP_RESULT_H

#include "common.h"

#include "exceptions.h"
#include "field.h"
#include "field_names.h"
#include "field_types.h"
#include "noexceptions.h"
#include "refcounted.h"
#include "row.h"

namespace mysqlpp {



class MYSQLPP_EXPORT SimpleResult
{
private:
    typedef bool SimpleResult::*private_bool_type;

public:
        SimpleResult() :
        copacetic_(false),
        insert_id_(0),
        rows_(0)
        {
        }

        SimpleResult(bool copacetic, ulonglong insert_id,
                        ulonglong rows, const std::string& info) :
        copacetic_(copacetic),
        insert_id_(insert_id),
        rows_(rows),
        info_(info)
        {
        }

        operator private_bool_type() const
        {
                return copacetic_ ? &SimpleResult::copacetic_ : 0;
        }

        ulonglong insert_id() const { return insert_id_; }

        ulonglong rows() const { return rows_; }

        const char* info() const { return info_.c_str(); }

private:
        bool copacetic_;
        ulonglong insert_id_;
        ulonglong rows_;
        std::string info_;
};



class MYSQLPP_EXPORT ResultBase : public OptionalExceptions
{
public:
        virtual ~ResultBase() { }

        const Field& fetch_field() const
                        { return fields_.at(current_field_++); }

        const Field& fetch_field(Fields::size_type i) const
                        { return fields_.at(i); }

        const Field& field(unsigned int i) const { return fields_.at(i); }

        const Fields& fields() const { return fields_; }

        const std::string& field_name(int i) const
                        { return names_->at(i); }

        const RefCountedPointer<FieldNames>& field_names() const
                        { return names_; }

        int field_num(const std::string&) const;

        const FieldTypes::value_type& field_type(int i) const
                        { return types_->at(i); }

        const RefCountedPointer<FieldTypes>& field_types() const
                        { return types_; }

        size_t num_fields() const { return fields_.size(); }

        const char* table() const
                        { return fields_.empty() ? "" : fields_[0].table(); }

protected:
        ResultBase() :
        driver_(0),
        current_field_(0)
        {
        }
        
        ResultBase(MYSQL_RES* result, DBDriver* dbd, bool te = true);
        
        ResultBase(const ResultBase& other) :
        OptionalExceptions()
        {
                copy(other);
        }

        ResultBase& copy(const ResultBase& other);

        DBDriver* driver_;      
        Fields fields_;         

        RefCountedPointer<FieldNames> names_;

        RefCountedPointer<FieldTypes> types_;

        mutable Fields::size_type current_field_;
};



class MYSQLPP_EXPORT StoreQueryResult :
                public ResultBase,
                public std::vector<Row>
{
private:
    typedef bool StoreQueryResult::*private_bool_type;

public:
        typedef std::vector<Row> list_type;     

        StoreQueryResult() :
        ResultBase(),
        copacetic_(false)
        {
        }
        
        StoreQueryResult(MYSQL_RES* result, DBDriver* dbd, bool te = true);

        StoreQueryResult(const StoreQueryResult& other) :
        ResultBase(),
        std::vector<Row>(),
        copacetic_(false)
        {
                copy(other);
        }

        ~StoreQueryResult() { }

        list_type::size_type num_rows() const { return size(); }

        StoreQueryResult& operator =(const StoreQueryResult& rhs)
                        { return this != &rhs ? copy(rhs) : *this; }

        operator private_bool_type() const
        {
                return copacetic_ ? &StoreQueryResult::copacetic_ : 0;
        }

private:
        StoreQueryResult& copy(const StoreQueryResult& other);

        bool copacetic_;        
};


template <>
struct RefCountedPointerDestroyer<MYSQL_RES>
{
        void operator()(MYSQL_RES* doomed) const
        {
                if (doomed) {
                        mysql_free_result(doomed);
                }
        }
};



class MYSQLPP_EXPORT UseQueryResult : public ResultBase
{
public:
        UseQueryResult() :
        ResultBase()
        {
        }
        
        UseQueryResult(MYSQL_RES* result, DBDriver* dbd, bool te = true);
        
        UseQueryResult(const UseQueryResult& other) :
        ResultBase()
        {
                copy(other);
        }
        
        ~UseQueryResult() { }

        UseQueryResult& operator =(const UseQueryResult& rhs)
                        { return this != &rhs ? copy(rhs) : *this; }

        const Field& fetch_field() const
                        { return fields_.at(current_field_++); }

        const Field& fetch_field(Fields::size_type i) const
                        { return fields_.at(i); }

        const unsigned long* fetch_lengths() const;

        Row fetch_row() const;

        MYSQL_ROW fetch_raw_row() const;

        void field_seek(Fields::size_type field) const
                        { current_field_ = field; }

        // it was successful:
        operator MYSQL_RES*() const { return result_.raw(); }
        
private:
        UseQueryResult& copy(const UseQueryResult& other);

        mutable RefCountedPointer<MYSQL_RES> result_;
};


inline void
swap(StoreQueryResult& x, StoreQueryResult& y)
{
        StoreQueryResult tmp = x;
        x = y;
        y = tmp;
}

inline void
swap(UseQueryResult& x, UseQueryResult& y)
{
        UseQueryResult tmp = x;
        x = y;
        y = tmp;
}

} // end namespace mysqlpp

#endif // !defined(MYSQLPP_RESULT_H)

---