co/types.h

/* Copyright (c) 2006-2012, Stefan Eilemann <eile@equalizergraphics.com> 
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser 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 Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef CO_TYPES_H
#define CO_TYPES_H

#include <co/defines.h>
#include <co/error.h>
#include <lunchbox/refPtr.h>
#include <lunchbox/types.h>

#include <deque>
#include <vector>

namespace co
{

#define CO_SEPARATOR '#'

#define EQ_INSTANCE_MAX     LB_MAX_UINT32 //!< The biggest instance id possible
#define EQ_INSTANCE_NONE    0xfffffffdu   //!< None/NULL identifier
#define EQ_INSTANCE_INVALID 0xfffffffeu   //!< Invalid/unset instance identifier
#define EQ_INSTANCE_ALL     0xffffffffu   //!< all object instances

class Barrier;
class CPUCompressor; 
class Command;
class CommandQueue;
class Connection;
class ConnectionDescription;
class ConnectionListener;
class DataIStream;
class DataOStream;
class ErrorRegistry;
class Global;
class LocalNode;
class Node;
class Object;
class ObjectFactory;
class ObjectHandler;
class ObjectDataIStream;
class Plugin;        
class PluginRegistry;
class QueueMaster;
class QueueSlave;
class Serializable;
struct CompressorInfo; 
template< class Q > class WorkerThread;
struct ObjectVersion;
struct Packet;
struct QueueItemPacket;

using lunchbox::UUID;
using lunchbox::uint128_t;
using lunchbox::Strings;

typedef UUID NodeID; 

typedef lunchbox::RefPtr< Node >                  NodePtr;
typedef lunchbox::RefPtr< LocalNode >             LocalNodePtr;
typedef lunchbox::RefPtr< Connection >            ConnectionPtr;
typedef lunchbox::RefPtr< ConnectionDescription > ConnectionDescriptionPtr;

typedef std::vector< NodePtr >                   Nodes;
typedef Nodes::iterator                          NodesIter;
typedef Nodes::const_iterator                    NodesCIter;

typedef std::vector< Object* >                   Objects;
typedef Objects::iterator                        ObjectsIter;
typedef Objects::const_iterator                  ObjectsCIter;

typedef std::vector< Barrier* > Barriers; 
typedef Barriers::iterator BarriersIter;  
typedef Barriers::const_iterator BarriersCIter; 

typedef std::vector< ConnectionPtr >             Connections;
typedef Connections::const_iterator ConnectionsCIter;
typedef Connections::iterator   ConnectionsIter;

typedef std::vector< ConnectionDescriptionPtr >  ConnectionDescriptions;
typedef ConnectionDescriptions::iterator         ConnectionDescriptionsIter;
typedef ConnectionDescriptions::const_iterator   ConnectionDescriptionsCIter;

typedef std::vector< Command* > Commands;
typedef std::deque< Command* > CommandDeque;
typedef CommandDeque::const_iterator CommandDequeCIter;

typedef std::vector< ObjectVersion > ObjectVersions;
typedef ObjectVersions::const_iterator ObjectVersionsCIter;
typedef std::deque< ObjectDataIStream* > ObjectDataIStreamDeque;
typedef std::vector< ObjectDataIStream* > ObjectDataIStreams;

typedef Commands::const_iterator CommandsCIter;

typedef std::vector< CompressorInfo > CompressorInfos;
typedef std::vector< const CompressorInfo* > CompressorInfoPtrs;
typedef std::vector< Plugin* > Plugins;

typedef CompressorInfos::const_iterator CompressorInfosCIter;
typedef Plugins::const_iterator PluginsCIter;
#ifndef EQ_2_0_API
namespace base
{
using namespace lunchbox;
using co::Error;
using co::ErrorRegistry;
using co::PluginRegistry;
using co::Global;
}
#endif
}

#endif // CO_TYPES_H