ircproxy  The Ultimate Cyborg

---

UserMode.h

Go to the documentation of this file.

// ircproxy -- An IRC bouncer.
//
//! @file UserMode.h
//! @brief This file contains the declaration of class UserMode.
//
// Copyright (C) 2006, 2007 by
//
// Carlo Wood, Run on IRC <carlo@alinoe.com>
// RSA-1024 0x624ACAD5 1997-01-26                    Sign & Encrypt
// Fingerprint16 = 32 EC A7 B6 AC DB 65 A6  F6 F6 55 DD 1C DC FF 61
//
// This file may be distributed under the terms of the Q Public License
// version 1.0 as appearing in the file LICENSE.QPL included in the
// packaging of this file.

#ifndef USERMODE_H
#define USERMODE_H

#ifndef USE_PCH
#include <cctype>
#endif

#include "Watched.h"
#include "MessageIn.h"

//! \internal
// Convert uppercase usermode \a c into the internal uppercase mask.
inline uint32_t make_uppercase_usermode_mask(char c)
{
  ASSERT(std::isupper(c));
  return 1 << (c - 'A');
}

//! \internal
// Convert lowercase usermode \a c into the internal lowercase mask.
inline uint32_t make_lowercase_usermode_mask(char c)
{
  ASSERT(std::islower(c));
  return 1 << (c - 'a');
}

//! \internal
// Stores usermodes in a bit-mask. Used by class UserMode.
struct UserModeMask {
  uint32_t uppercase_modes;     //!< A mask for uppercase usermodes. Bit 0 represents 'A' and so on.
  uint32_t lowercase_modes;     //!< A mask for lowercase usermodes. Bit 0 represents 'a' and so on.

  //! Default constructor. Constructs a UserModeMask with no usermodes sets.
  UserModeMask() : uppercase_modes(0), lowercase_modes(0) { }
  //! Construct a UserModeMask with only mode \a c set.
  UserModeMask(char c) : uppercase_modes(0), lowercase_modes(0) { *this = c; }

  //! Reset the mask to just mode \a c.
  UserModeMask& operator=(char c);
  //! Set mode \a c.
  UserModeMask& operator|=(char c);
  //! Bitwise OR this mask with \a um.
  UserModeMask& operator|=(UserModeMask const& um);
  //! Reset all modes except usermode \a c.
  UserModeMask& operator&=(char c);
  //! Bitwise AND this mask with \a um.
  UserModeMask& operator&=(UserModeMask const& um);
  //! Toggle usermode \a c.
  UserModeMask& operator^=(char c);
  //! Bitwise XOR this mask with \a um.
  UserModeMask& operator^=(UserModeMask const& um);

  //! Compare two UserModeMask instances.
  friend bool operator==(UserModeMask const& um1, UserModeMask const& um2)
  {
    return um1.lowercase_modes == um2.lowercase_modes &&
           um2.uppercase_modes == um2.uppercase_modes;
  }

  //! Compare two UserModeMask instances.
  friend bool operator!=(UserModeMask const& um1, UserModeMask const& um2)
  {
    return um1.lowercase_modes != um2.lowercase_modes ||
           um2.uppercase_modes != um2.uppercase_modes;
  }

#ifdef CWDEBUG
  //! For debugging purpose; write UserModeMask \a m to \a os.
  friend std::ostream& operator<<(std::ostream& os, UserModeMask const& um)
  {
    os << "\"+";
    char c = 'a';
    for (uint32_t m = 1; c <= 'z'; ++c, m <<= 1)
      if ((um.lowercase_modes & m))
        os << c;
    c = 'A';
    for (uint32_t m = 1; c <= 'z'; ++c, m <<= 1)
      if ((um.uppercase_modes & m))
        os << c;
    return os << '"';
  }
#endif
};

//! Return UserModeMask \a um but with usermode \a c set.
inline UserModeMask operator|(UserModeMask const& um, char c)
{
  UserModeMask result(um);
  return result |= c;
}

//! Return a bitwise OR-ed UserModeMask of \a um1 and \a um2.
inline UserModeMask operator|(UserModeMask const& um1, UserModeMask const& um2)
{
  UserModeMask result(um1);
  return result |= um2;
}

//! Return a UserModeMask with only usermode \a c set, provided it is also set in UserModeMask \a um.
inline UserModeMask operator&(UserModeMask const& um, char c)
{
  UserModeMask result(um);
  return result &= c;
}

//! Return a bitwise AND-ed UserModeMask of \a um1 and \a um2.
inline UserModeMask operator&(UserModeMask const& um1, UserModeMask const& um2)
{
  UserModeMask result(um1);
  return result &= um2;
}

//! Return UserModeMask \a um with usermode \a c toggled.
inline UserModeMask operator^(UserModeMask const& um, char c)
{
  UserModeMask result(um);
  return result ^= c;
}

//! Return a bitwise XOR-ed UserModeMask of \a um1 and \a um2.
inline UserModeMask operator^(UserModeMask const& um1, UserModeMask const& um2)
{
  UserModeMask result(um1);
  return result ^= um2;
}

//! A class representing a user mode.
class UserMode {
  private:
    Watched<UserModeMask> M_mask;       //!< Watchable UserModeMask.
  public:
#ifdef CWDEBUG
    //! Default constructor.
    UserMode(void) : M_mask("UserMode::M_mask") { }
#endif

    //! Dereference operator. Returns the underlying UserModeMask as WatchedExpression.
    WatchedExpression<UserModeMask> operator*(void) { return *M_mask; }

    void new_server_message_received(ServerMessageIn const& msg);
};

#endif // USERMODE_H

---