成為C++高手之標頭檔案與條件編譯
但現在看起來真不爽,main.c依賴的檔案不能在工程中管理,要修改那些檔案的話麻煩大了。如何既能分成多個檔案又能在工程中看到呢?可以,使用標頭檔案(h檔案)。
標頭檔案中只放那些不產生記憶體佔用的程式碼,比如定義結構(定義結構不會產生記憶體分配,只有用結構定義變數時才產生記憶體分配)、定義列舉,定義巨集,宣告變數,宣告函式等。而且大都是一個c檔案對應一個h檔案。下面增加poker.h和player.h(注意main.c是不需要有h檔案的,因為我們應該保證main.c只依賴別的檔案,而不能被別的檔案依賴),下面我們就把c檔案中的結構、巨集、列舉的定義移到對應的h檔案中,然後再將變數和函式在h檔案中增加宣告,於是poker.h和player.h是這樣的:
poker.h:
//一副牌的數量
#define CARD_COUNT 54
//定義撲克的花色
enum Suit{
heart,
spade,
diamond,
club,
joker1,
joker2
};
//定義撲克
typedef struct Card{
int value;//牌的點數從1開始
enum Suit suit;//花色
}Card;
//定義比較函式的型別
typedef int (*COMPARE)(Card* ,Card*);
extern Card pokers[CARD_COUNT];
void initOnePack();
char * getCardName(const Card*);
Card** shuffle(const Card*);
void sort(Card**,int,COMPARE);
int compare1(Card* ,Card*);
int compare2(Card* ,Card*);
player.h:
//定義玩家
typedef struct Player{
char name[64];//玩家的名字
Card ** cards;//玩家分到的牌。每項是一個指標,指向原始一副牌陣列中的一項,這樣可以節省空間
int cardsCount;//玩家分到的牌的數量
}Player;
void dispatchCards(Player** ,int ,const Card** );
main.c中不再include poker.c和player.c,而是改為include 標頭檔案。但是player.c和poker.c中也應該include各自的標頭檔案,因為它們用到的結構、列舉等移到標頭檔案中了(注意編譯器不會自動將同名的h檔案和c檔案關聯)。
其實還不夠,player.h中用到了Card結構的定義,於是player.h依賴poker.h,所以應在player.h中include poker.h。然而不幸的是,現在又出現了一大堆錯誤,都是一些重定義或標誌符衝突之類的錯誤。如何解決這些錯誤呢? 需使用條件編譯指令!
我們看到過很多以#開頭的令,比如#include、#define等。這些叫做編譯指令。這些不產生實際的CPU指令,也就是說它們不是程式碼,但是編譯器跟據它們處理程式碼的生成。這些編譯指令還可以使用條件語句來控制編譯器的動作,下面我們就為player.h增加條件編譯指令來解決重定義錯誤。player.h變成了這樣:
#ifndef PLAYER_H
#define PLAYER_H
#include "poker.h"
//定義玩家
typedef struct Player{
char name[64];//玩家的名字
Card ** cards;//玩家分到的牌。每項是一個指標,指向原始一副牌陣列中的一項,這樣可以節省空間
int cardsCount;//玩家分到的牌的數量
}Player;
void dispatchCards(Player** ,int ,const Card** );
#endif //PLAYER_C
ifndef 表示if not defined,即如果沒定義巨集PLAYER_H,就使後面直到#endif之前的內容起作用。#define PLAYER_H表示定義巨集PLAYER_H,即只有在巨集PLAYER_H不存在時才定義它。定義之後它就存在了。試想如此一來,不論此檔案被include多少次,只有第一次的內容起作用,於是就解決了重複定義問題。
現在各檔案變成了這樣:
poker.h:
#ifndef POKER_H
#define POKER_H
//一副牌的數量
#define CARD_COUNT 54
//定義撲克的花色
enum Suit{
heart,
spade,
diamond,
club,
joker1,
joker2
};
//定義撲克
typedef struct Card{
int value;//牌的點數從1開始
enum Suit suit;//花色
}Card;
//定義比較函式的型別
typedef int (*COMPARE)(Card* ,Card*);
extern Card pokers[CARD_COUNT];
void initOnePack();
char* getCardName(const Card*);
Card** shuffle(const Card*);
void sort(Card**,int,COMPARE);
int compare1(Card* ,Card*);
int compare2(Card* ,Card*);
#endif //POKER_H
poker.c:
#include <stdio.h>
#include "poker.h"
//原始一副牌所在的陣列
Card pokers[CARD_COUNT];
//構造一副牌
void initOnePack(){
int i=0;
//前52張
for(;i<CARD_COUNT-2;i++){
pokers[i].value=i/4+1;
pokers[i].suit = i%4;
}
//剩下的兩張:大王和小王
//joker1
pokers[i].value=i/4+1;
pokers[i].suit=joker1;
//joker2
pokers[i+1].value=i/4+2;
pokers[i+1].suit=joker2;
}
//洗牌,引數是原始的一副牌,返回洗完後的牌
Card** shuffle(const Card* pokers){
int i;
//分牌返回牌陣列的記憶體空間
Card** retPokers = malloc(CARD_COUNT*sizeof(Card*));
//為了不改動原始的一副牌,另建一個數組,儲存原始牌的指標(注意每項不是牌,而是牌的指標)
Card** pokers2 = malloc(CARD_COUNT*sizeof(Card*));
for(i=0;i<CARD_COUNT;i++){
pokers2[i] = &pokers[i];
}
//種下隨機種子。種子取的是當前時間,
//所以保證了每次執行程式時,產生的隨機數序列不同
srand(time(NULL));
//取得隨機序號,從pokers2取出序號所指的項,把它依次加到retPokers中。
for(i=0;i<CARD_COUNT;i++){
unsigned int index = rand()%CARD_COUNT;
if(pokers2[index] != NULL){
retPokers[i] = pokers2[index];
pokers2[index]=NULL;
}else{
i--;
}
}
free(pokers2);
//返回洗完後的陣列
return retPokers;
}
//排序函式
//cards是要排序的牌,每一項是牌的指標
//cardsCount是牌的數量
//compare_func是比較函式
void sort(Card** cards,int cardsCount,COMPARE compare_func){
int i;
for(i=0;i<cardsCount-1;i++){
int j;
for(j=0;j<cardsCount-i-1;j++){
if(compare_func(cards[j],cards[j+1])){
int tmp=cards[j];
cards[j]=cards[j+1];
cards[j+1]=tmp;
}
}
}
}
//比較函式,先比較點數再比較花色
int compare1(Card* a,Card* b){
if(a->value > b->value){
return 1;
}else if(a->value < b->value){
return 0;
}else{
if(a->suit > b->suit)
return 1;
else
return 0;
}
}
//比較函式,先比較點數再比較花色
int compare2(Card* a,Card* b){
if(a->value > b->value){
return 0;
}else if(a->value < b->value){
return 1;
}else{
if(a->suit > b->suit)
return 0;
else
return 1;
}
}
//獲取牌的名字
//返回牌的名字字串,呼叫者用完後需要free()之。
char* getCardName(const Card* card){
//存放花色名字
char suitStr[16]={0};//0=='\0'
switch (card->suit) {
case heart:
strcpy(suitStr,"紅桃");
break;
case spade:
strcpy(suitStr,"黑桃");
break;
case diamond:
strcpy(suitStr,"方塊");
break;
case club:
strcpy(suitStr,"梅花");
break;
}
//存放點數名字
char valueStr[16];
switch(card->value){
case 1:
strcpy(valueStr,"A");
break;
case 11:
strcpy(valueStr,"J");
break;
case 12:
strcpy(valueStr,"Q");
break;
case 13:
strcpy(valueStr,"K");
break;
case 14:
strcpy(valueStr,"小王");
break;
case 15:
strcpy(valueStr,"大王");
break;
default:
sprintf(valueStr,"%d",card->value);
break;
}
//動態分配足夠的空間
char * ret = malloc(16);
//將兩個名字合併到ret中
sprintf(ret,"%s%s",suitStr,valueStr);
return ret;
}
//#endif //POKER_C
player.h:
#ifndef PLAYER_H
#define PLAYER_H
#include "poker.h"
//定義玩家
typedef struct Player{
char name[64];//玩家的名字
Card ** cards;//玩家分到的牌。每項是一個指標,指向原始一副牌陣列中的一項,這樣可以節省空間
int cardsCount;//玩家分到的牌的數量
}Player;
void dispatchCards(Player** ,int ,const Card** );
#endif //PLAYER_C
player.c:
//#ifndef PLAYER_C
//#define PLAYER_C
#include "player.h"
//發牌
//players是玩家陣列
//playerCount是玩家數量
//shuffledCards是洗完後的一副牌
void dispatchCards(Player** players,int playerCount,const Card** shuffledCards){
//計算每個玩家手中牌的陣列的容量,如果每個玩家手中的牌不一樣,
//最多就差一張,加1是為了保證陣列分配的空間足夠容納分到的牌。
int numberCards = CARD_COUNT/playerCount+1;
//為每個玩家的牌陣列分配空間
int i;
for(i=0;i<playerCount;i++){
Card* cards = malloc(numberCards*sizeof(Card*));
players[i]->cards = cards;
}
//輪流向每個玩家發牌
for(i=0;i<CARD_COUNT;i++){
//取當前玩家
Player *curPlayer = players[i%playerCount];
//向玩家發牌
curPlayer->cards[curPlayer->cardsCount] = shuffledCards[i];
//玩家手中實際的牌數增加
curPlayer->cardsCount++;
}
}
//#endif //PLAYER_C
main.c:
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#include "poker.h"
#include "player.h"
//函式宣告們
//原始一副牌所在的陣列
Card pokers[CARD_COUNT];
//入口函式
int main(void)
{
//初始化一副牌
initOnePack();
//洗牌,shuffledPokers儲存洗後的牌們
Card** shuffledPokers = shuffle(pokers);
//構建三個玩家
Player player1;
strcpy(player1.name,"隔壁老王");
player1.cards=NULL;
player1.cardsCount=0;
Player player2;
strcpy(player2.name,"小明");
player2.cards=NULL;
player2.cardsCount=0;
Player player3;
strcpy(player3.name,"田中龜孫");
player3.cards=NULL;
player3.cardsCount=0;
//把三放到一個數組中,以傳入發牌函式中
Player* players[]={&player1,&player2,&player3};
//發牌
dispatchCards(players,sizeof(players)/sizeof(Player*),shuffledPokers);
//洗後的牌用完了,釋放之
free(shuffledPokers);
int i;
//打印出每個玩家手中的牌
for(i=0;i<sizeof(players)/sizeof(Player*);i++){
//先列印玩家的名字
printf("%s\n",players[i]->name);
//需要對玩家手中的牌排序
sort(players[i]->cards,players[i]->cardsCount,compare1);
//列印玩家手中所有的牌
int j;
for(j=0;j<players[i]->cardsCount;j++){
char * name = getCardName(players[i]->cards[j]);
printf("%s ",name);
free(name);
}
//每個玩家都需要換一次行
printf("\n");
}
//釋放玩家手中牌的陣列
for(i=0;i<sizeof(players)/sizeof(Player*);i++){
free(players[i]->cards);
}
return 0;
}
可以看到,在main.c中,poker.h被include了,然後又被main.c又 include了player.h,而player.h中又include 了poker.h,所以在main.c中其實poker.h被include 了兩次,但程式不會產生問題,為什麼呢?就是用為使用了條件巨集控制了編譯過程。