/**
 * @file bits.h
 * @ingroup common
 *
 * Bitvector constants and macros.
 *
 * @author Geoff Davis <geoff@circlemudsquared.org>
 *
 * @par Copyright:
 *   Copyright (C) 2006 Geoff Davis <geoff@circlemudsquared.org><br>
 *                      Greg Buxton <greg@circlemudsquared.org>
 *
 * @par
 *   Copyright (C) 1993, 94 by the Trustees of the Johns Hopkins University<br>
 *   CircleMUD is based on DikuMUD, Copyright (C) 1990, 1991.
 *
 * @par
 *   All rights reserved.  See license.doc for complete information.
 *
 * @package cs
 * @version 1.0
 */

#ifndef __BITS_H__
#define __BITS_H__

#include "base.h"

/**
 * Returns the value of a bit index (0-31).
 * @param bitno the index of the bit whose value is to be returned
 * @return the value of the bit
 */
#define BITN(bitno) \
  (1 <<  (bitno))

#define BIT_00                  BITN(0) /**< The value of bit in position 0 */
#define BIT_01                  BITN(1) /**< The value of bit in position 1 */
#define BIT_02                  BITN(2) /**< The value of bit in position 2 */
#define BIT_03                  BITN(3) /**< The value of bit in position 3 */
#define BIT_04                  BITN(4) /**< The value of bit in position 4 */
#define BIT_05                  BITN(5) /**< The value of bit in position 5 */
#define BIT_06                  BITN(6) /**< The value of bit in position 6 */
#define BIT_07                  BITN(7) /**< The value of bit in position 7 */
#define BIT_08                  BITN(8) /**< The value of bit in position 8 */
#define BIT_09                  BITN(9) /**< The value of bit in position 9 */
#define BIT_10                  BITN(10)/**< The value of bit in position 10*/
#define BIT_11                  BITN(11)/**< The value of bit in position 11*/
#define BIT_12                  BITN(12)/**< The value of bit in position 12*/
#define BIT_13                  BITN(13)/**< The value of bit in position 13*/
#define BIT_14                  BITN(14)/**< The value of bit in position 14*/
#define BIT_15                  BITN(15)/**< The value of bit in position 15*/
#define BIT_16                  BITN(16)/**< The value of bit in position 16*/
#define BIT_17                  BITN(17)/**< The value of bit in position 17*/
#define BIT_18                  BITN(18)/**< The value of bit in position 18*/
#define BIT_19                  BITN(19)/**< The value of bit in position 19*/
#define BIT_20                  BITN(20)/**< The value of bit in position 20*/
#define BIT_21                  BITN(21)/**< The value of bit in position 21*/
#define BIT_22                  BITN(22)/**< The value of bit in position 22*/
#define BIT_23                  BITN(23)/**< The value of bit in position 23*/
#define BIT_24                  BITN(24)/**< The value of bit in position 24*/
#define BIT_25                  BITN(25)/**< The value of bit in position 25*/
#define BIT_26                  BITN(26)/**< The value of bit in position 26*/
#define BIT_27                  BITN(27)/**< The value of bit in position 27*/
#define BIT_28                  BITN(28)/**< The value of bit in position 28*/
#define BIT_29                  BITN(29)/**< The value of bit in position 29*/
#define BIT_30                  BITN(30)/**< The value of bit in position 30*/
#define BIT_31                  BITN(31)/**< The value of bit in position 31*/

#endif /* __BITS_H__ */