OSDN Git Service

#37287 #37353 (2.2.0.89) 型の置換を継続中。 / Ongoing type replacement.
[hengband/hengband.git] / src / scores.c
index 011bd6f..4a92db2 100644 (file)
@@ -1,20 +1,21 @@
-/* File: scores.c */
-
-/*
+/*!
+ * @file scores.c
+ * @brief ハイスコア処理 / Highscores handling
+ * @date 2014/07/14
+ * @author
  * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke
- *
  * This software may be copied and distributed for educational, research,
  * and not for profit purposes provided that this copyright and statement
  * are included in all such copies.  Other copyrights may also apply.
+ * 2014 Deskull rearranged comment for Doxygen.
  */
 
-/* Purpose: Highscores handling */
-
 #include "angband.h"
 
-
-/*
- * Seek score 'i' in the highscore file
+/*!
+ * @brief i番目のスコア情報にバッファ位置をシークする / Seek score 'i' in the highscore file
+ * @param i スコア情報ID
+ * @return 問題がなければ0を返す
  */
 static int highscore_seek(int i)
 {
@@ -23,8 +24,10 @@ static int highscore_seek(int i)
 }
 
 
-/*
- * Read one score from the highscore file
+/*!
+ * @brief 所定ポインタからスコア情報を読み取る / Read one score from the highscore file
+ * @param score スコア情報参照ポインタ
+ * @return エラーコード
  */
 static errr highscore_read(high_score *score)
 {
@@ -33,8 +36,10 @@ static errr highscore_read(high_score *score)
 }
 
 
-/*
- * Write one score to the highscore file
+/*!
+ * @brief 所定ポインタへスコア情報を書き込む / Write one score to the highscore file
+ * @param score スコア情報参照ポインタ
+ * @return エラーコード(問題がなければ0を返す)
  */
 static int highscore_write(high_score *score)
 {
@@ -42,10 +47,10 @@ static int highscore_write(high_score *score)
        return (fd_write(highscore_fd, (char*)(score), sizeof(high_score)));
 }
 
-
-/*
- * Just determine where a new score *would* be placed
- * Return the location (0 is best) or -1 on failure
+/*!
+ * @brief スコア情報を全て得るまで繰り返し取得する / Just determine where a new score *would* be placed
+ * @param score スコア情報参照ポインタ
+ * @return 正常ならば(MAX_HISCORES - 1)、問題があれば-1を返す
  */
 static int highscore_where(high_score *score)
 {
@@ -77,9 +82,10 @@ static int highscore_where(high_score *score)
 }
 
 
-/*
- * Actually place an entry into the high score file
- * Return the location (0 is best) or -1 on "failure"
+/*!
+ * @brief スコア情報をバッファの末尾に追加する / Actually place an entry into the high score file
+ * @param score スコア情報参照ポインタ
+ * @return 正常ならば書き込んだスロット位置、問題があれば-1を返す / Return the location (0 is best) or -1 on "failure"
  */
 static int highscore_add(high_score *score)
 {
@@ -122,12 +128,20 @@ static int highscore_add(high_score *score)
 
 
 
-/*
- * Display the scores in a given range.
+/*!
+ * @brief 指定された順位範囲でスコアを並べて表示する / Display the scores in a given range.
+ * @param from 順位先頭
+ * @param to 順位末尾
+ * @param note 黄色表示でハイライトする順位
+ * @param score スコア配列参照ポインタ
+ * @return なし
+ * @details
+ * <pre>
  * Assumes the high score list is already open.
  * Only five entries per line, too much info.
  *
  * Mega-Hack -- allow "fake" entry at the given position.
+ * </pre>
  */
 void display_scores_aux(int from, int to, int note, high_score *score)
 {
@@ -358,11 +372,16 @@ void display_scores_aux(int from, int to, int note, high_score *score)
 }
 
 
-/*
- * Hack -- Display the scores in a given range and quit.
- *
+/*!
+ * @brief スコア表示処理メインルーチン / Hack -- Display the scores in a given range and quit.
+ * @param from 順位先頭
+ * @param to 順位末尾
+ * @return なし
+ * @details
+ * <pre>
  * This function is only called from "main.c" when the user asks
  * to see the "high scores".
+ * </pre>
  */
 void display_scores(int from, int to)
 {
@@ -394,7 +413,11 @@ void display_scores(int from, int to)
 }
 
 
-
+/*!
+ * @brief スコアサーバへの転送処理
+ * @param do_send 実際に転送ア処置を行うか否か
+ * @return 転送が成功したらTRUEを返す
+ */
 bool send_world_score(bool do_send)
 {
 #ifdef WORLD_SCORE
@@ -428,10 +451,12 @@ bool send_world_score(bool do_send)
        return TRUE;
 }
 
-/*
+/*!
+ * @brief スコアの過去二十位内ランキングを表示する
  * Enters a players name on a hi-score table, if "legal", and in any
  * case, displays some relevant portion of the high score list.
- *
+ * @return エラーコード
+ * @details
  * Assumes "signals_ignore_tstp()" has been called.
  */
 errr top_twenty(void)
@@ -474,7 +499,7 @@ errr top_twenty(void)
 #endif
 
        /* Save the player name (15 chars) */
-       sprintf(the_score.who, "%-.15s", player_name);
+       sprintf(the_score.who, "%-.15s", p_ptr->name);
 
        /* Save the player info XXX XXX XXX */
        sprintf(the_score.uid, "%7u", player_uid);
@@ -485,9 +510,9 @@ errr top_twenty(void)
 
        /* Save the level and such */
        sprintf(the_score.cur_lev, "%3d", p_ptr->lev);
-       sprintf(the_score.cur_dun, "%3d", dun_level);
+       sprintf(the_score.cur_dun, "%3d", (int)dun_level);
        sprintf(the_score.max_lev, "%3d", p_ptr->max_plv);
-       sprintf(the_score.max_dun, "%3d", max_dlv[dungeon_type]);
+       sprintf(the_score.max_dun, "%3d", (int)max_dlv[dungeon_type]);
 
        /* Save the cause of death (31 chars) */
        if (strlen(p_ptr->died_from) >= sizeof(the_score.how))
@@ -549,9 +574,10 @@ errr top_twenty(void)
        return (0);
 }
 
-
-/*
+/*!
+ * @brief プレイヤーの現在のスコアをランキングに挟む /
  * Predict the players location, and display it.
+ * @return エラーコード
  */
 errr predict_score(void)
 {
@@ -586,7 +612,7 @@ errr predict_score(void)
        strcpy(the_score.day, _("今日", "TODAY"));
 
        /* Save the player name (15 chars) */
-       sprintf(the_score.who, "%-.15s", player_name);
+       sprintf(the_score.who, "%-.15s", p_ptr->name);
 
        /* Save the player info XXX XXX XXX */
        sprintf(the_score.uid, "%7u", player_uid);
@@ -596,10 +622,10 @@ errr predict_score(void)
        sprintf(the_score.p_a, "%2d", p_ptr->pseikaku);
 
        /* Save the level and such */
-       sprintf(the_score.cur_lev, "%3d", p_ptr->lev);
-       sprintf(the_score.cur_dun, "%3d", dun_level);
-       sprintf(the_score.max_lev, "%3d", p_ptr->max_plv);
-       sprintf(the_score.max_dun, "%3d", max_dlv[dungeon_type]);
+       sprintf(the_score.cur_lev, "%3d", (int)p_ptr->lev);
+       sprintf(the_score.cur_dun, "%3d", (int)dun_level);
+       sprintf(the_score.max_lev, "%3d", (int)p_ptr->max_plv);
+       sprintf(the_score.max_dun, "%3d", (int)max_dlv[dungeon_type]);
 
        /* Hack -- no cause of death */
        /* まだ死んでいないときの識別文字 */
@@ -628,16 +654,17 @@ errr predict_score(void)
 }
 
 
-
-/*
- * show_highclass - selectively list highscores based on class
- * -KMW-
+/*!
+ * @brief スコアランキングの簡易表示 /
+ * show_highclass - selectively list highscores based on class -KMW-
+ * @return なし
  */
 void show_highclass(void)
 {
 
        register int i = 0, j, m = 0;
-       int pr, clev/*, al*/;
+       int pr;
+       PLAYER_LEVEL clev/*, al*/;
        high_score the_score;
        char buf[1024], out_val[256];
 
@@ -669,7 +696,7 @@ void show_highclass(void)
                if (highscore_seek(j)) break;
                if (highscore_read(&the_score)) break;
                pr = atoi(the_score.p_r);
-               clev = atoi(the_score.cur_lev);
+               clev = (PLAYER_LEVEL)atoi(the_score.cur_lev);
 
 #ifdef JP
                sprintf(out_val, "   %3d) %sの%s (レベル %2d)",
@@ -686,10 +713,10 @@ void show_highclass(void)
 
 #ifdef JP
        sprintf(out_val, "あなた) %sの%s (レベル %2d)",
-           race_info[p_ptr->prace].title,player_name, p_ptr->lev);
+           race_info[p_ptr->prace].title,p_ptr->name, p_ptr->lev);
 #else
        sprintf(out_val, "You) %s the %s (Level %2d)",
-           player_name, race_info[p_ptr->prace].title, p_ptr->lev);
+           p_ptr->name, race_info[p_ptr->prace].title, p_ptr->lev);
 #endif
 
        prt(out_val, (m + 8), 0);
@@ -704,10 +731,11 @@ void show_highclass(void)
        screen_load();
 }
 
-
-/*
- * Race Legends
- * -KMW-
+/*!
+ * @brief スコアランキングの簡易表示(種族毎)サブルーチン /
+ * Race Legends -KMW-
+ * @param race_num 種族ID
+ * @return なし
  */
 void race_score(int race_num)
 {
@@ -776,10 +804,10 @@ void race_score(int race_num)
        {
 #ifdef JP
        sprintf(out_val, "あなた) %sの%s (レベル %2d)",
-                    race_info[p_ptr->prace].title,player_name, p_ptr->lev);
+                    race_info[p_ptr->prace].title,p_ptr->name, p_ptr->lev);
 #else
                sprintf(out_val, "You) %s the %s (Level %3d)",
-                   player_name, race_info[p_ptr->prace].title, p_ptr->lev);
+                   p_ptr->name, race_info[p_ptr->prace].title, p_ptr->lev);
 #endif
 
                prt(out_val, (m + 8), 0);
@@ -790,9 +818,10 @@ void race_score(int race_num)
 }
 
 
-/*
- * Race Legends
- * -KMW-
+/*!
+ * @brief スコアランキングの簡易表示(種族毎)メインルーチン /
+ * Race Legends -KMW-
+ * @return なし
  */
 void race_legends(void)
 {
@@ -808,9 +837,10 @@ void race_legends(void)
        }
 }
 
-
-/*
- * Change the player into a King!                      -RAK-
+/*!
+ * @brief 勝利者用の引退演出処理 /
+ * Change the player into a King! -RAK-
+ * @return なし
  */
 void kingly(void)
 {