Source/Deck.h
author snej@snej.local
Tue Mar 10 22:36:23 2009 -0700 (2009-03-10)
changeset 27 b0affce7beb1
permissions -rw-r--r--
Fixed some problems reported by the CLANG static analyzer.
jens@0
     1
/*  This code is based on Apple's "GeekGameBoard" sample code, version 1.0.
jens@0
     2
    http://developer.apple.com/samplecode/GeekGameBoard/
jens@0
     3
    Copyright © 2007 Apple Inc. Copyright © 2008 Jens Alfke. All Rights Reserved.
jens@0
     4
jens@0
     5
    Redistribution and use in source and binary forms, with or without modification, are permitted
jens@0
     6
    provided that the following conditions are met:
jens@0
     7
jens@0
     8
    * Redistributions of source code must retain the above copyright notice, this list of conditions
jens@0
     9
      and the following disclaimer.
jens@0
    10
    * Redistributions in binary form must reproduce the above copyright notice, this list of
jens@0
    11
      conditions and the following disclaimer in the documentation and/or other materials provided
jens@0
    12
      with the distribution.
jens@0
    13
jens@0
    14
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
jens@0
    15
    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
jens@0
    16
    FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRI-
jens@0
    17
    BUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jens@0
    18
    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
jens@0
    19
    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
jens@0
    20
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
jens@0
    21
    THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
jens@0
    22
*/
jens@0
    23
#import "BitHolder.h"
jens@0
    24
@class Card;
jens@0
    25
jens@0
    26
jens@0
    27
/** A pile of Cards. Unlike a Stack, only the top card is visible or accessible;
jens@0
    28
    so as an optimization, it's the only one that's added to the layer tree. */
jens@0
    29
@interface Deck : BitHolder
jens@0
    30
{
jens@0
    31
    NSMutableArray *_cards;
jens@0
    32
}
jens@0
    33
jens@0
    34
/** Creates an empty Deck. */
jens@0
    35
- (id) init;
jens@0
    36
jens@0
    37
/** Creates a Deck populated with a full set of cards (in order.) */
jens@0
    38
- (id) initWithCardsOfClass: (Class)klass;
jens@0
    39
jens@0
    40
@property (readonly) NSArray *cards;
jens@0
    41
@property (readonly) Card *topCard;             // same as the -bit property
jens@0
    42
jens@0
    43
/** Randomly shuffles all the cards in the Deck. */
jens@0
    44
- (void) shuffle;
jens@0
    45
jens@0
    46
/** Flips over the Deck: Reverses the order of cards, and inverts their -faceUp flags. */
jens@0
    47
- (void) flip;
jens@0
    48
jens@0
    49
- (void) addCard: (Card*)card;
jens@0
    50
- (void) addCardAtBottom: (Card*)card;
jens@0
    51
- (void) addCardAtRandom: (Card*)card;
jens@0
    52
- (void) addCards: (NSArray*)cards;
jens@0
    53
jens@0
    54
- (Card*) removeTopCard;
jens@0
    55
- (NSArray*) removeAllCards;
jens@0
    56
jens@0
    57
@end