(svn r7370) -Cleanup: Use NewsID instead of byte for news identifiers, and some minor other things

This commit is contained in:
Darkvater 2006-12-05 12:17:31 +00:00
parent f14a24ac26
commit 75ec6d9b77

View File

@ -33,16 +33,17 @@
#define MAX_NEWS 30 #define MAX_NEWS 30
typedef byte NewsID;
#define INVALID_NEWS 255 #define INVALID_NEWS 255
static NewsItem _news_items[MAX_NEWS]; static NewsItem _news_items[MAX_NEWS];
static byte _current_news = INVALID_NEWS; // points to news item that should be shown next static NewsID _current_news = INVALID_NEWS; // points to news item that should be shown next
static byte _oldest_news = 0; // points to first item in fifo queue static NewsID _oldest_news = 0; // points to first item in fifo queue
static byte _latest_news = INVALID_NEWS; // points to last item in fifo queue static NewsID _latest_news = INVALID_NEWS; // points to last item in fifo queue
/* if the message being shown was forced by the user, its index is stored in /* if the message being shown was forced by the user, its index is stored in
* _forced_news. forced_news is INVALID_NEWS otherwise. * _forced_news. forced_news is INVALID_NEWS otherwise.
* (Users can force messages through history or "last message") */ * (Users can force messages through history or "last message") */
static byte _forced_news = INVALID_NEWS; static NewsID _forced_news = INVALID_NEWS;
static byte _total_news = 0; // total news count static byte _total_news = 0; // total news count
@ -221,7 +222,7 @@ static void NewsWindowProc(Window *w, WindowEvent *e)
/** Return the correct index in the pseudo-fifo /** Return the correct index in the pseudo-fifo
* queue and deals with overflows when increasing the index */ * queue and deals with overflows when increasing the index */
static inline byte increaseIndex(byte i) static inline NewsID increaseIndex(NewsID i)
{ {
if (i == INVALID_NEWS) return 0; if (i == INVALID_NEWS) return 0;
return (i + 1) % MAX_NEWS; return (i + 1) % MAX_NEWS;
@ -229,7 +230,7 @@ static inline byte increaseIndex(byte i)
/** Return the correct index in the pseudo-fifo /** Return the correct index in the pseudo-fifo
* queue and deals with overflows when decreasing the index */ * queue and deals with overflows when decreasing the index */
static inline byte decreaseIndex(byte i) static inline NewsID decreaseIndex(NewsID i)
{ {
assert(i != INVALID_NEWS); assert(i != INVALID_NEWS);
return (i + MAX_NEWS - 1) % MAX_NEWS; return (i + MAX_NEWS - 1) % MAX_NEWS;
@ -257,7 +258,7 @@ static inline byte decreaseIndex(byte i)
* @see NewsCallback */ * @see NewsCallback */
void AddNewsItem(StringID string, uint32 flags, uint data_a, uint data_b) void AddNewsItem(StringID string, uint32 flags, uint data_a, uint data_b)
{ {
byte l_news; NewsID l_news;
if (_game_mode == GM_MENU) return; if (_game_mode == GM_MENU) return;
@ -451,7 +452,7 @@ static void ShowTicker(const NewsItem *ni)
static bool ReadyForNextItem(void) static bool ReadyForNextItem(void)
{ {
const Window *w; const Window *w;
byte item = _forced_news == INVALID_NEWS ? _current_news : _forced_news; NewsID item = (_forced_news == INVALID_NEWS) ? _current_news : _forced_news;
NewsItem *ni; NewsItem *ni;
if (item >= MAX_NEWS) return true; if (item >= MAX_NEWS) return true;
@ -522,7 +523,7 @@ void NewsLoop(void)
} }
/* Do a forced show of a specific message */ /* Do a forced show of a specific message */
static void ShowNewsMessage(byte i) static void ShowNewsMessage(NewsID i)
{ {
if (_total_news == 0) return; if (_total_news == 0) return;
@ -559,7 +560,7 @@ void ShowLastNewsMessage(void)
/* return news by number, with 0 being the most /* return news by number, with 0 being the most
* recent news. Returns INVALID_NEWS if end of queue reached. */ * recent news. Returns INVALID_NEWS if end of queue reached. */
static byte getNews(byte i) static NewsID getNews(NewsID i)
{ {
if (i >= _total_news) return INVALID_NEWS; if (i >= _total_news) return INVALID_NEWS;
@ -621,7 +622,7 @@ static void MessageHistoryWndProc(Window *w, WindowEvent *e)
switch (e->event) { switch (e->event) {
case WE_PAINT: { case WE_PAINT: {
int y = 19; int y = 19;
byte p, show; NewsID p, show;
SetVScrollCount(w, _total_news); SetVScrollCount(w, _total_news);
DrawWindowWidgets(w); DrawWindowWidgets(w);
@ -646,29 +647,11 @@ static void MessageHistoryWndProc(Window *w, WindowEvent *e)
switch (e->we.click.widget) { switch (e->we.click.widget) {
case 3: { case 3: {
int y = (e->we.click.pt.y - 19) / 12; int y = (e->we.click.pt.y - 19) / 12;
byte p, q; NewsID p = getNews(y + w->vscroll.pos);
#if 0 // === DEBUG code only if (p == INVALID_NEWS) break;
for (p = 0; p < _total_news; p++) {
NewsItem *ni;
byte buffer[256];
ni = &_news_items[p];
GetNewsString(ni, buffer);
printf("%i\t%i\t%s\n", p, ni->date, buffer);
}
printf("=========================\n");
#endif
p = y + w->vscroll.pos;
if (p > _total_news - 1) break;
if (_latest_news >= p) {
q = _latest_news - p;
} else {
q = _latest_news + MAX_NEWS - p;
}
ShowNewsMessage(q);
ShowNewsMessage(p);
break; break;
} }
} }
@ -885,7 +868,7 @@ void ShowMessageOptions(void)
void DeleteVehicleNews(VehicleID vid, StringID news) void DeleteVehicleNews(VehicleID vid, StringID news)
{ {
byte n; NewsID n;
for (n = _oldest_news; _latest_news != INVALID_NEWS && n != increaseIndex(_latest_news); n = increaseIndex(n)) { for (n = _oldest_news; _latest_news != INVALID_NEWS && n != increaseIndex(_latest_news); n = increaseIndex(n)) {
const NewsItem *ni = &_news_items[n]; const NewsItem *ni = &_news_items[n];
@ -894,7 +877,6 @@ void DeleteVehicleNews(VehicleID vid, StringID news)
ni->data_a == vid && ni->data_a == vid &&
(news == INVALID_STRING_ID || ni->string_id == news)) { (news == INVALID_STRING_ID || ni->string_id == news)) {
Window *w; Window *w;
byte i;
if (_forced_news == n || _current_news == n) MoveToNexItem(); if (_forced_news == n || _current_news == n) MoveToNexItem();
@ -902,8 +884,9 @@ void DeleteVehicleNews(VehicleID vid, StringID news)
if (_latest_news == _oldest_news) _latest_news = INVALID_NEWS; if (_latest_news == _oldest_news) _latest_news = INVALID_NEWS;
if (n != _oldest_news) { if (n != _oldest_news) {
for (i = n; i != _oldest_news; i = (i + MAX_NEWS - 1) % MAX_NEWS) { NewsID i;
_news_items[i] = _news_items[(i + MAX_NEWS - 1) % MAX_NEWS]; for (i = n; i != _oldest_news; i = decreaseIndex(i)) {
_news_items[i] = _news_items[decreaseIndex(i)];
} }
_oldest_news = increaseIndex(_oldest_news); _oldest_news = increaseIndex(_oldest_news);
} }