.TH SPREE-CARDLIB 2.SH NAMECardlib \- support for card games in Spree engines..SH SYNOPSIS.EXinclude "sys.m";include "draw.m";include "sets.m";include "spree.m";include "spree/cardlib.m"; Object: import Spree;cardlib := load Cardlib Cardlib->PATH; init:			fn(spree: Spree, clique: ref Clique, archived: int);selection:	fn(stack: ref Object): ref Selection; makecard:	fn(deck: ref Object, c: Card, rear: string): ref Object;makecards:	fn(stack: ref Object, r: Range, rear: string);getcard:		fn(card: ref Object): Card;getcards:		fn(stack: ref Object): array of Card;setface:		fn(card: ref Object, face: int);flip:			fn(stack: ref Object);shuffle:		fn(stack: ref Object);discard:		fn(stk, pile: ref Object, facedown: int);deal:			fn(stack: ref Object, n: int, stacks: array of ref Object, first: int);sort:			fn(stack: ref Object, rank, suitrank: array of int); addlayframe:	fn(name: string, parent: string, layout: ref Layout, packopts: int, facing: int);addlayobj:	fn(name: string, parent: string, layout: ref Layout, packopts: int, obj: ref Object);dellay:		fn(name: string, layout: ref Layout);maketable:	fn(parent: string); newstack:		fn(parent: ref Object, p: ref Member, spec: Stackspec): ref Object; archive:		fn(): ref Object;unarchive:	fn(): ref Object;setarchivename: fn(o: ref Object, name: string);archivearray:	fn(a: array of ref Object, name: string);getarchiveobj:	fn(name: string): ref Object;getarchivearray: fn(name: string): array of ref Object; nmembers:	fn(): int; Layout: adt {	lay:	ref Object;}; Stackspec: adt {	style:	string;	maxcards:	int;	title:		string;	conceal:	int;}; Card: adt {	suit:		int;	number:	int;	face:		int;}; # a member currently playingCmember: adt {	ord:		int;	id:		int;	p:		ref Member;	obj:		ref Object;	layout:	ref Layout;	sel:		ref Selection; 	join:		fn(p: ref Member, ord: int): ref Cmember;	index:	fn(ord: int): ref Cmember;	find:		fn(p: ref Member): ref Cmember;	findid:	fn(id: int): ref Cmember;	leave:	fn(cp: self ref Cmember);	next:		fn(cp: self ref Cmember, fwd: int): ref Cmember;	prev:		fn(cp: self ref Cmember, fwd: int): ref Cmember;}; Selection: adt {	stack:	ref Object;	ownerid:	int;	isrange:	int;	r:		Range;	idxl:		list of int; 	set:		fn(sel: self ref Selection, stack: ref Object);	setexcl:	fn(sel: self ref Selection, stack: ref Object): int;	setrange:	fn(sel: self ref Selection, r: Range);	addindex:	fn(sel: self ref Selection, i: int);	delindex:	fn(sel: self ref Selection, i: int);	isempty:	fn(sel: self ref Selection): int;	isset:		fn(sel: self ref Selection, index: int): int;	transfer:	fn(sel: self ref Selection, dst: ref Object, index: int);	owner:	fn(sel: self ref Selection): ref Cmember;};.EE.SH DESCRIPTION.I Cardlibprovides facilities to help in the implementationof.I spree (2)engines that implement the.IR spree-cards (4)interface.Facilities include the layout of clients' cards,support for card selections, and card manipulation..PP.B Initmust be called first to initialise the.I Cardlibmodule, giving it the.I spreemodule and the current clique..I Archivedshould be non-zero if the card game is being restored froman archive..SS CardsThe value of a playing card is represented by the.B Cardadt, having attributes.IR suit ,.IR number ,and.IR face ..I Suitranges from 0 to 3 inclusive, representing clubs,diamonds, hearts and spades respectively;.I numberranges from 0 to 12 inclusive for the standard cards,with ace low and king high - a joker is representedby a number greater than 12;.I facerepresents whether the card is face up or face down(0 is face down)..PPA actual card is represented by an object in the object hierarchyof type.BR card ,with attributes.BR number ,.BR face ,and.BR rear ..B Numberis the suit/number of the card (held as.IR n ,where.IR n %4gives the suit, and.IR n /4the rank)..B Faceis as held in the.B Cardadt, and.B rearis a number that represents the pattern on theback of the card (numbered from 0 upwards).Conventionally the.B numberattribute is made invisible to all players whenthe.B faceattribute is set to zero..PP.B Makecardcreates a new card of value.IR c ,placing the new card object at the end of.IR deck ,and setting the.B rearattribute to.I rearif it is non-nil..B Makecardsmakes a set of cards, all face down,in all four suits, having numbers within the range.IR r ..PP.B Getcardgets the value representation of a card from object.IR card ;.B getcardsgets the values of all the card objects within.IR stack ..B Setfacesets of.I cardto.IR face ;the visibility of the card's number is changed appropriately..PPThe following few routines operate on stacks of cards: objectswhich contain only card objects:.B flipreverses a stack of cards, reversing their faces as it does so;.B shuffleshuffles a stack of cards, and.B sortsorts a stack of cards by suit and then number, according to.I rankand.IR suitrank ..I Rankand.I suitrankare permutations mapping number/suit to sort precedence (0 low).If either of these are nil, then a default ranking scheme is chosen(two low, ace high for number)..B Discardmoves all the cards in.I stkonto.IR pile ,turning them face down if.I facedownis non-zero..B Dealdeals out all the cards in.I stackas evenly as possible amongst.IR stacks ,dealing to.IB stacks [ first ]first..SS Members and card selection.I Cardlibkeeps a record of the current players of the game;a player is represented by a.B Cmemberadt; the players are assumed to sit in a circle,numbered from 0 updwards;.B nmembersgives the number of current players.Each player has a unique integer id, and anassociated selectionand card layout..TP 10.IB m .join(\fIm\fP,\ \fIord\fP)Join a new player to the game;.I mis the clique member that's joining, and.I ordis where to slot the player in the circle of existing players.If.I ordis -1, the player will be added at the end..TP.IB m .leave()Remove.I mfrom the list of current players..TP.IB m .index(\fIord\fP).B Indexreturns the.IR ord thplayer around the table..TP.IB m .find(\fIm\fP)Find the.B Cmembercorresponding to member.IR m ..TP.IB m .findid(\fIid\fP)Find the.B Cmemberwith identifier.IR id ,and return it..IB m .next(\fIfwd\fP).B Nextreturns the next player around the tablefrom.IR m .If.I fwdis non-zero, it counts upwards, otherwise it countsdownwards..IB m .prev(\fIfwd\fP).B Previs the opposite of.BR next .If.I fwdis non-zero, it counts downwards, otherwise itcounts upwards..SS SelectionEach.B Cmember.I mhas an associated selection,.IB m .sel\fR,which consists of a selectionof some cards from a single stack of cards.A selection can consist of either a range of cards withina stack, or an arbitrary set of cards within a stack.A stack can only be the subject of one selection; themember that has that selection is known as itsowner..TP 10.IB sel .set(\fIstack\fP).B Setmakes.I stack(an object containing only card objects)the subject of.IR sel 'sselection. If.I stackis nil, the selection is cleared..TP.IB sel .setexcl(\fIstack\fP).B Setexclis the same as.B setexcept that it will fail if the stack is ownedby a different player. It returns 0 if it fails,otherwise non-zero..TP.IB sel .setrange(\fIr\fP).B Setrangesets the selection.I selto be a range of cards within its stack.If the selection had been of distinct cards (set using.BR addindex ),it is first cleared..TP.IB sel .addindex(\fIi\fP).B Addindexadds the card at index.I ito the selection.IR sel .If a range had previously been selected,it is first cleared..TP.IB sel .delindex(\fIi\fP).B Delindexdeletes the card at index.I ifrom the selection.If the selection was previously a range,this is a no-op..TP.IB sel .isempty().B Isemptyreturns non-zero if.I selholds an empty selection..TP.IB sel .isset(\fIindex\fP).B Issetreturns non-zero if the card at index.I indexis contained within the selection.IR sel ..TP.IB sel .transfer(\fIdst\fP,\ \fIindex\fP).B Transfermoves all the cards in the selection.I selto just before.I indexwithin the stack.IR dst ..IB sel .owner().B Ownerreturns the.B Cmemberthat owns the selection.IR sel ..SS LayoutCreating a stack of cards does not specify how it is to be displayedto members of the game. Each member has a.I layoutobject which defines which objects are to be displayed tothat member, and how they are to be laid out.Any member must see at most one layout object(it is conventional to make a layout object visible only toits owner).Objects are laid out using tk-like.IR pack (9)semantics:.I framespack together display objects or other frames.A display object can lay out anything the card client knowshow to display (see ``Display Objects'', below)..PP.B Addlayframeadds a new frame named.I namewithina layout frame named.IR parent ,specific to.IR layout .If.I parentis nil, the frame is added to the root of the hierarchy.If.I layoutis nil, a frame is added to.I parentfor each member that has a layout frame of that name..I Packoptsspecifies how the frame is to be packed within its parent:it is a bitmask, specifying the side of the cavity against which it is to be packed,the place it is to be anchored should the cavity be bigger than its requested size,how to fill its cavity, whether to expand its requested size to fill extra available space.See.IR pack (9)for details of the packing algorithm.The packing direction is specified with one of.BR dTOP ,.BR dLEFT ,.BR dBOTTOMor.BR dRIGHT .The anchor direction is specified with one of.BR aCENTRE ,.BR aUPPERCENTRE ,.BR aUPPERLEFT ,.BR aCENTRELEFT ,.BR aLOWERLEFT ,.BR aLOWERCENTRE ,.BR aLOWERRIGHT ,.BR aCENTRERIGHT ,or.BR aUPPERRIGHT ..B FILLXand.B FILLYspecify how to fill unused space in its cavity(not mutually exclusive),and.B EXPANDrequests unused space..I Facinginfluences direction that objects are packed inunderneath the frame. It should be one of thepack direction constants specified above(e.g..BR dTOP ).For instance, if.B dRIGHTis specified, then all objects packed underneathhave their attributes modified 90° clockwise,as if the player in question was sitting on theleft of the table, looking right.This feature means that it is possibleto set up a ``table'' in which layout objectscan be added to all players at the same time, butwhich nonetheless looks different to each playeraround the table..PP.B Maketablecreates such a 	``table'' for between 0 and 4 players.It creates a frame for each player, named.BI p n\fR,where.I nis the ordinal number of the player around the table;and an inner space, named.BR public .The.I parentargument to.B maketablegives the frame within which the table is to be created..PP.B Addlayobjadds a new display object .I obj to the layout hierarchy..IR Name ,.IR parent ,.IR layout ,and.I packoptsare the same as for.B addlayframeexcept thatif it is a stack object, then.I packopts also specifies theorientation of the stack, with one of the constants.BR oRIGHT ,.BR oUP ,.BR oLEFT ,or.BR oDOWN ,giving the direction in which cards are laid outwithin the stack..PP.B Dellaydeletes the object named.I name

Lines 1–500 of 628. Load more