RetroShare/libretroshare/src/retroshare/rsgxscommon.h

#ifndef RETROSHARE_GXS_COMMON_OBJS_INTERFACE_H
#define RETROSHARE_GXS_COMMON_OBJS_INTERFACE_H

/*
 * libretroshare/src/retroshare: rsgxscommong.h
 *
 * RetroShare C++ Interface.
 *
 * Copyright 2012-2012 by Robert Fernie.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License Version 2.1 as published by the Free Software Foundation.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA.
 *
 * Please report all bugs and problems to "retroshare@lunamutt.com".
 *
 */

#include <inttypes.h>
#include <string>
#include <list>

#include "rsgxsifacetypes.h"

class RsGxsFile
{
	public:
	RsGxsFile();
	std::string mName;
	RsFileHash mHash;
	uint64_t    mSize;
	//std::string mPath;
};

class RsGxsImage
{
	public:
	RsGxsImage();	
	~RsGxsImage();
	RsGxsImage(const RsGxsImage& a); // TEMP use copy constructor and duplicate memory.
RsGxsImage &operator=(const RsGxsImage &a); // Need this as well?

//NB: Must make sure that we always use methods - to be consistent about malloc/free for this data.
static uint8_t *allocate(uint32_t size);
static void release(void *data);

	void take(uint8_t *data, uint32_t size); // Copies Pointer.
	void copy(uint8_t *data, uint32_t size); // Allocates and Copies.
	void clear(); 				// Frees.
	void shallowClear(); 			// Clears Pointer.

	uint8_t *mData;
	uint32_t mSize;

};


#define GXS_VOTE_NONE 	0x0000
#define GXS_VOTE_DOWN 	0x0001
#define GXS_VOTE_UP	0x0002


// Status Flags to indicate Voting....
// All Services that use the Comment service must not Use This space.
namespace GXS_SERV {
	/* Msg Vote Status */
	static const uint32_t GXS_MSG_STATUS_GXSCOMMENT_MASK  = 0x000f0000;
	static const uint32_t GXS_MSG_STATUS_VOTE_MASK        = 0x00030000;

	static const uint32_t GXS_MSG_STATUS_VOTE_UP          = 0x00010000;
	static const uint32_t GXS_MSG_STATUS_VOTE_DOWN        = 0x00020000;
}




class RsGxsVote
{
	public:
	RsGxsVote();
	RsMsgMetaData mMeta;
	uint32_t mVoteType;
};

class RsGxsComment
{
	public:
	RsGxsComment();
	RsMsgMetaData mMeta;
	std::string mComment;

	// below is calculated.
	uint32_t mUpVotes;
	uint32_t mDownVotes;
	double   mScore; 

	uint32_t mOwnVote;

	// This is filled in if detailed Comment Data is called.
	std::list<RsGxsVote> mVotes;

	const std::ostream &print(std::ostream &out, std::string indent = "", std::string varName = "") const {
		out << indent << varName << " of RsGxsComment Values ###################" << std::endl;
		mMeta.print(out, indent + "  ", "mMeta");
		out << indent << "  mComment: " << mComment << std::endl;
		out << indent << "  mUpVotes: " << mUpVotes << std::endl;
		out << indent << "  mDownVotes: " << mDownVotes << std::endl;
		out << indent << "  mScore: " << mScore << std::endl;
		out << indent << "  mOwnVote: " << mOwnVote << std::endl;
		out << indent << "  mVotes.size(): " << mVotes.size() << std::endl;
		out << indent << "######################################################" << std::endl;
		return out;
	}
};


class RsGxsCommentService
{
	public:

	RsGxsCommentService() { return; }
virtual ~RsGxsCommentService() { return; }

virtual bool getCommentData(const uint32_t &token, std::vector<RsGxsComment> &comments) = 0;
virtual bool getRelatedComments(const uint32_t &token, std::vector<RsGxsComment> &comments) = 0;

//virtual bool getDetailedCommentData(const uint32_t &token, std::vector<RsGxsComment> &comments);

virtual bool createComment(uint32_t &token, RsGxsComment &comment) = 0;
virtual bool createVote(uint32_t &token, RsGxsVote &vote) = 0;

virtual bool acknowledgeComment(const uint32_t& token, std::pair<RsGxsGroupId, RsGxsMessageId>& msgId) = 0;
virtual bool acknowledgeVote(const uint32_t& token, std::pair<RsGxsGroupId, RsGxsMessageId>& msgId) = 0;

};



#endif