jens@0: /*  This code is based on Apple's "GeekGameBoard" sample code, version 1.0.
jens@0:     http://developer.apple.com/samplecode/GeekGameBoard/
jens@0:     Copyright © 2007 Apple Inc. Copyright © 2008 Jens Alfke. All Rights Reserved.
jens@0: 
jens@0:     Redistribution and use in source and binary forms, with or without modification, are permitted
jens@0:     provided that the following conditions are met:
jens@0: 
jens@0:     * Redistributions of source code must retain the above copyright notice, this list of conditions
jens@0:       and the following disclaimer.
jens@0:     * Redistributions in binary form must reproduce the above copyright notice, this list of
jens@0:       conditions and the following disclaimer in the documentation and/or other materials provided
jens@0:       with the distribution.
jens@0: 
jens@0:     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
jens@0:     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
jens@0:     FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRI-
jens@0:     BUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jens@0:     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
jens@0:     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
jens@0:     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
jens@0:     THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
jens@0: */
jens@0: #import "BitHolder.h"
jens@0: @class Card;
jens@0: 
jens@0: 
jens@0: /** A pile of Cards. Unlike a Stack, only the top card is visible or accessible;
jens@0:     so as an optimization, it's the only one that's added to the layer tree. */
jens@0: @interface Deck : BitHolder
jens@0: {
jens@0:     NSMutableArray *_cards;
jens@0: }
jens@0: 
jens@0: /** Creates an empty Deck. */
jens@0: - (id) init;
jens@0: 
jens@0: /** Creates a Deck populated with a full set of cards (in order.) */
jens@0: - (id) initWithCardsOfClass: (Class)klass;
jens@0: 
jens@0: @property (readonly) NSArray *cards;
jens@0: @property (readonly) Card *topCard;             // same as the -bit property
jens@0: 
jens@0: /** Randomly shuffles all the cards in the Deck. */
jens@0: - (void) shuffle;
jens@0: 
jens@0: /** Flips over the Deck: Reverses the order of cards, and inverts their -faceUp flags. */
jens@0: - (void) flip;
jens@0: 
jens@0: - (void) addCard: (Card*)card;
jens@0: - (void) addCardAtBottom: (Card*)card;
jens@0: - (void) addCardAtRandom: (Card*)card;
jens@0: - (void) addCards: (NSArray*)cards;
jens@0: 
jens@0: - (Card*) removeTopCard;
jens@0: - (NSArray*) removeAllCards;
jens@0: 
jens@0: @end