board.mli

(** 
   Representation of static Monopoly board data.

   This module represents the data stored in board files, including
   the squares and cards.  It handles loading of that data from JSON as well
   as querying the data.
*)

(** The abstract type of values representing squares. *)
type square

(** The abstract type of values representing cards. *)
type card

(** The type representing what cards can do *)
type cardType = 
  | Money 
  | Location 
  | LeaveJail

(** The type of property names *)
type prop_name = string

(** The type of card names *)
type card_name = string

(** Raised when an unknown square is encountered. *)
exception UnknownSquare of prop_name

(** Raised when an unknown card is encountered *)
exception UnknownCard of card_name

(** The abstract type of values representing monopoly boards. *)
type board

(** The type representing square types*)
type squareType = 
  | Go
  | Jail 
  | Parking
  | GoToJail
  | Property
  | Card
  | Tax 

(** [from_json j] is the adventure that [j] represents.
    Requires: [j] is a valid JSON adventure representation. *)
val from_json : Yojson.Basic.t -> board

(** [square_type b s_name] returns the type of property with name 
    [s_name] in [b]. Raises [UnknownSquare s_name] if s_name is not a square
      in [b]. *)
val square_type  : board -> prop_name -> squareType

(** [all_squares b] returns a list of the names of all squares in [b]*)
val all_squares : board -> string list

(** [cost b p] returns the cost of property [p] in [b]. Raises 
    [UnknownSquare p] if [p] is not a property in [b]*)
val cost : board -> string -> int 

(** [rent b p] returns the rent of property [p] in [b]. Raises 
    [UnknownSquare p] if [p] is not a property in [b]*)
val rent : board -> string -> int 

(** [cards b] returns a list of the deck of cards in [b]*)
val cards : board -> string list 


(** [card_description b cd] returns the description of card [cd]
      in board [b]. Raises [Not_Found] if [cd] is not in [b]  *)
val card_description : board -> string -> string 

(** [num_squares b] returns the size of board [b], defined as the number of
      squares in the board*)
val size : board -> int 

(** [monopoly_group_named b pr] returns the monopoly group [pr] belongs to. 
    Raises [UnknownSquare Prop] if [prop] is not in a monopoly group. *)
val monopoly_group_named : board -> prop_name -> prop_name list

(** [monopoly_group b col] returns the list of properties in the monopoly group
    with color [col] in [b]. A monopoly group is a set of properties
      that when owned together form a monopoly. Raises [UnknownSquare col] if 
      [col] is not in b. *)
val monopoly_group : board -> string -> string list

(** [nth_square bd n] returns the square at position [n] in [bd] *)
val nth_square : board -> int -> string

(** [square_pos b p] returns the position of property [p] in [b]. Raises 
    [UnknownProp p] if [p] is not in [b] *)
val square_pos : board -> prop_name -> int

(** [prop_color b p] returns the color of [p] in [b]. Raises 
    [UnknownProp p] if [p] is not in [b] *)
val square_color : board -> prop_name -> string option

(** [house_cost bd prop] returns [Some i] where [i] is the cost of 
      building a house on [prop]. Returns [None] if houses 
      cannot be built on [prop]. Raises [UnknownCard prop] if [prop] 
      is not in [bd]. *)
val house_cost : board -> prop_name -> int option

(** [hotel_cost bd prop] returns [Some i] where [i] is the cost of 
      building a hotel on [prop]. Raises [UnknownCard prop] if [prop]
      is not in [bd]. *)
val hotel_cost : board -> prop_name -> int option

(** [is_buildable b p] returns true if players can build houses/hotels on [p]. 
    Returns [None] if houses cannot be built on [prop].
    Raises [UnknownCard prop] if [prop] is not in [bd].*)
val is_buildable : board -> prop_name -> bool

(**  [is_buildable b p] returns true if players can buy [p]. 
     Raises [UnknownCard prop] if [prop] is not in [bd].*)
val is_buyable : board -> prop_name -> bool 

(** [card_type bd cd] returns the card type of [cd]. Raises 
      [UnknownCard cd] if [cd] is not in [bd] *)
val card_type : board -> card_name -> cardType

(** [card_payment bd cd] returns the payment value of [cd]. Raises 
      [UnknownCard cd] if [cd] is not in [bd] *)
val card_payment : board -> card_name -> int