aesop-base.h

Go to the documentation of this file.

/*
 * aesop-base.h
 *
 * Copyright (C) 2007-2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * The very base (root) aesop include file.  Specifies basic objects.
 */

#ifndef AESOP_BASE_H__
#define AESOP_BASE_H__

// includes --------------------------------------------------------------------
#include "util/fixed-buffer.h"


namespace aesop {


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup aesop_core
/// \defgroup aesop_base AESOP Base Types
///
/// \n
/// These headers define the core types and enums used in AESOP.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


/// important aesop constants
enum eConstants {
        // an ID is used to identify maps, models, instances, types, etc
        // see later in this file for helpful ID buffer objects
        eAESOP_MaxIdLength      = 31,///< max length of an ID, without null-term
        eAESOP_IdBufferSize     = 32,///< size of buffer to hold ID + null-term

        // a tag string is a username, or a player tag, etc.
        // see later in this file for helpful ID buffer objects
        eAESOP_MaxTagLength     = 15, ///< max length of a tag string
        eAESOP_TagBufferSize    = 16, ///< buffer holds tag string + null-term

        // keep this last
        eAESOP_Invalid          = 0
};



/// protocol version (basically, the version of the aesop-core.h file!)
enum eProtocol {
        eProtocol_Major         = 0,    ///< non-backwards-compatible
        eProtocol_Minor         = 1,    ///< backwards-compatible

        eProtocol_Long          = (eProtocol_Major << 16) + eProtocol_Minor
};



/// server's status
enum eServerMode {
        eServerMode_Idle        = 1, ///< server is running, no game
        eServerMode_Game        = 2, ///< game is in session

        // must be last
        eServerMode_Invalid     = 0
};



/// server's view of host status
enum eHostMode {
        eHostMode_Connected     = 1, ///< server has token, provided keys
        eHostMode_Authorized    = 2, ///< connected and authorized

        // must be last
        eHostMode_Invalid       = 0 
};



/// server's view of player status
enum ePlayerMode {
        ePlayerMode_UnAuth      = 1, ///< player is not authorized
        ePlayerMode_Browse      = 2, ///< authorized, not in game
        ePlayerMode_Game        = 3, ///< player is in game

        // must be last
        ePlayerMode_Invalid     = 0
};



// helper classes for ID buffers
// (see the FixedBuffer<T> template in the wavepacket libraries)
class AESOPIdSizer {
public:
        static int getBufferSize(void) throw()
                                { return eAESOP_IdBufferSize; }
        char    buffer[eAESOP_IdBufferSize];
};



class AESOPTagSizer {
public:
        static int getBufferSize(void) throw()
                                { return eAESOP_TagBufferSize; }
        char    buffer[eAESOP_TagBufferSize];
};



/// smart object to hold and validate aesop ID strings
typedef FixedBuffer<AESOPIdSizer, CommonFileValidator> AESOPIdBuffer;

/// smart object to hold and validate aesop tag strings
typedef FixedBuffer<AESOPTagSizer, CommonFileValidator> AESOPTagBuffer;


};      // aesop namespace

#endif  // AESOP_BASE_H__