[Refactor] #37353 型の置換。 / Type replacement. (BASE_STATUS / A_MAX)

[hengband/hengband.git] / src / z-term.h

diff --git a/src/z-term.h b/src/z-term.h
index 33eee40..b8d8d82 100644 (file)
--- a/src/z-term.h
+++ b/src/z-term.h
@@ -13,41 +13,26 @@
 
 #include "h-basic.h"
 
-
-/*
- * A term_win is a "window" for a Term
- *
- *     - Cursor Useless/Visible codes
- *     - Cursor Location (see "Useless")
- *
- *     - Array[h] -- Access to the attribute array
- *     - Array[h] -- Access to the character array
- *
- *     - Array[h*w] -- Attribute array
- *     - Array[h*w] -- Character array
- *
- * Note that the attr/char pair at (x,y) is a[y][x]/c[y][x]
- * and that the row of attr/chars at (0,y) is a[y]/c[y]
- */
-
 typedef struct term_win term_win;
-
-struct term_win
+ /*!
+ * @brief A term_win is a "window" for a Term
+ */
+ struct term_win
 {
-       bool cu, cv;
-       byte cx, cy;
+       bool cu, cv; //!< Cursor Useless / Visible codes
+       TERM_LEN cx, cy; //!< Cursor Location (see "Useless")
 
-       TERM_COLOR **a;
-       char **c;
+       TERM_COLOR **a; //!< Array[h*w] -- Attribute array 
+       char **c; //!< Array[h*w] -- Character array
 
-       TERM_COLOR *va;
-       char *vc;
+       TERM_COLOR *va; //!< Array[h] -- Access to the attribute array
+       char *vc; //!< Array[h] -- Access to the character array
 
-       TERM_COLOR **ta;
-       char **tc;
+       TERM_COLOR **ta; //!< Note that the attr pair at(x, y) is a[y][x]
+       char **tc; //!< Note that the char pair at(x, y) is c[y][x]
 
-       TERM_COLOR *vta;
-       char *vtc;
+       TERM_COLOR *vta; //!< Note that the row of attr at(0, y) is a[y]
+       char *vtc;  //!< Note that the row of chars at(0, y) is c[y]
 };
 
 
@@ -109,9 +94,9 @@ struct term
        errr (*curs_hook)(TERM_LEN x, TERM_LEN y); //!< カーソル描画実装部 / Hook for placing the cursor
        errr (*bigcurs_hook)(TERM_LEN x, TERM_LEN y); //!< 大型タイル時カーソル描画実装部 / Hook for placing the cursor on bigtile mode
        errr (*wipe_hook)(TERM_LEN x, TERM_LEN y, int n); //!< 指定座標テキスト消去実装部 / Hook for drawing some blank spaces
-       errr (*text_hook)(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, cptr s); //!< テキスト描画実装部 / Hook for drawing a string of chars using an attr
+       errr (*text_hook)(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, concptr s); //!< テキスト描画実装部 / Hook for drawing a string of chars using an attr
        void (*resize_hook)(void); //!< 画面リサイズ実装部
-       errr (*pict_hook)(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR *ap, const char *cp, const TERM_COLOR *tap, const char *tcp); //!< タイル描画実装部 / Hook for drawing a sequence of special attr / char pairs
+       errr (*pict_hook)(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR *ap, concptr cp, const TERM_COLOR *tap, concptr tcp); //!< タイル描画実装部 / Hook for drawing a sequence of special attr / char pairs
 };
 
 
@@ -174,7 +159,7 @@ extern void Term_queue_bigchar(TERM_LEN x, TERM_LEN y, TERM_COLOR a, char c, TER
 
 extern void Term_queue_line(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR *a, char *c, TERM_COLOR *ta, char *tc);
 
-extern void Term_queue_chars(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, cptr s);
+extern void Term_queue_chars(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, concptr s);
 
 extern errr Term_fresh(void);
 extern errr Term_set_cursor(int v);
@@ -182,11 +167,11 @@ extern errr Term_gotoxy(TERM_LEN x, TERM_LEN y);
 extern errr Term_draw(TERM_LEN x, TERM_LEN y, TERM_COLOR a, char c);
 extern errr Term_addch(TERM_COLOR a, char c);
 extern errr Term_add_bigch(TERM_COLOR a, char c);
-extern errr Term_addstr(int n, TERM_COLOR a, cptr s);
+extern errr Term_addstr(int n, TERM_COLOR a, concptr s);
 extern errr Term_putch(TERM_LEN x, TERM_LEN y, TERM_COLOR a, char c);
-extern errr Term_putstr(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, cptr s);
+extern errr Term_putstr(TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, concptr s);
 #ifdef JP
-extern errr Term_putstr_v(TERM_LEN x, TERM_LEN y, int n, byte a, cptr s);
+extern errr Term_putstr_v(TERM_LEN x, TERM_LEN y, int n, byte a, concptr s);
 #endif
 extern errr Term_erase(TERM_LEN x, TERM_LEN y, int n);
 extern errr Term_clear(void);