File indexing completed on 2024-04-28 04:02:05

 /*
     This file is part of the KDE games kwin4 program
     SPDX-FileCopyrightText: 2006 Martin Heni <kde@heni-online.de>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef AIBOARD_H
 #define AIBOARD_H
 
 // own
 #include "kwin4global.h"
 // Qt
 #include <QDataStream>
 
 /**
  * Store the values of the cached positions for s set of levels.
  */
 class AIValue
 {
     /**
      * Support streaming.
      * @param s The stream
      * @param v The value to stream
      * @return The stream.
      */
     friend QDataStream &operator<<(QDataStream &s, const AIValue &v);
 
     /**
      * Support streaming.
      * @param s The stream
      * @param v The value to stream
      * @return The stream.
      */
     friend QDataStream &operator>>(QDataStream &s, AIValue &v);
 
 public:
     /**
      * Constructor.
      */
     AIValue();
 
     /**
      * Set a value for the given level.
      * @param level The level
      * @param value The value
      */
     void setValue(int level, long value);
 
     /**
      * Get the value for a given level.
      * @param level The level
      * @return The value.
      */
     long value(int level) const;
 
     /**
      * Checks whether a value is set for the given level.
      * @param level The level
      * @return True if it is set.
      */
     bool isSet(int level) const;
 
     /**
      * How many levels do we support.
      */
     const static int NO_OF_LEVELS = 5;
 
 private:
     // Store the level values
     long mValue[NO_OF_LEVELS];
 };
 
 /**
  * Support streaming.
  * @param s The stream
  * @param v The value to stream
  * @return The stream.
  */
 QDataStream &operator<<(QDataStream &s, const AIValue &value);
 
 /**
  * Support streaming.
  * @param s The stream
  * @param v The value to stream
  * @return The stream.
  */
 QDataStream &operator>>(QDataStream &s, AIValue &value);
 
 /**
  * Store an AI field in a compressed structure. One row of pieces
  * is stored as bit sequence with two bits for each field. The bits
  * correspond to the colors (Nobody, Yellow, Red, unused).
  */
 class AIBoard
 {
     /**
      * Support streaming.
      * @param s The stream
      * @param v The value to stream
      * @return The stream.
      */
     friend QDataStream &operator<<(QDataStream &, const AIBoard &);
 
     /**
      * Support streaming.
      * @param s The stream
      * @param v The value to stream
      * @return The stream.
      */
     friend QDataStream &operator>>(QDataStream &, AIBoard &);
 
     /**
      * Qt Hast function.
      * @param board The board to hash.
      * @return The hash values.
      */
     friend uint qHash(const AIBoard &board);
 
 public:
     /**
      * Construct an object
      */
     AIBoard();
 
     /**
      * Construct board from AI field structure
      * @param current The current mover's color
      * @param field The game field
      */
     AIBoard(uchar current, const char field[][7]);
 
     /**
      * Compare to boards.
      * @param other The other board
      * @return True if the boards are equal.
      */
     bool operator==(const AIBoard &other) const;
 
     /**
      * Retrieve a mirrored board. The original is not
      * changed.
      * @param The mirrored board.
      */
     AIBoard mirror() const;
 
     /**
      * Debug function to print out a board to the console.
      */
     void print() const;
 
     /**
      * Convert an AI field to the board structure.
      * @param current The current mover's color
      * @param mirror Mirror the board?
      * @param field The game field
      */
     void fromField(uchar current, bool mirror, const char field[][7]);
 
 private:
     // Store board pieces per row
     ushort mBoard[6];
     // Mover's color
     uchar mCurrent;
 };
 
 /**
  * Support streaming.
  * @param s The stream
  * @param v The value to stream
  * @return The stream.
  */
 QDataStream &operator<<(QDataStream &s, const AIBoard &board);
 
 /**
  * Support streaming.
  * @param s The stream
  * @param v The value to stream
  * @return The stream.
  */
 QDataStream &operator>>(QDataStream &s, AIBoard &board);
 
 /**
  * Qt Hast function.
  * @param board The board to hash.
  * @return The hash values.
  */
 uint qHash(const AIBoard &key);
 
 #endif