NAME
MReport -- machine report
PURPOSE
Contains functions that create a turn report in a format that is more easy to understand for machines.
AUTHOR
Christophe Barbier
HISTORY
199809: Creation of a machine report
199903:
Corrected a bug in number of uninhabited planets Replaced
semi-colon delimitor with space (native separator in tcl/tk)
Section header :
Added a space before the "greater" sign, thus last record is
no longer "polluted". * Removed useless key words
Try to get a standard form for header of each section :
<section-name(only one word) name(if any) number-of-elements >
Try to get a (poor) standard form in groups record : each
alien group or group in a battle begin with a 0 (for his
number)
Section format (groups, battles...) is now :
<"section name" "battle or location name" quantity >
Messages section is now :
<messages "global or personal" quantity >
199904:
added report version, and galaxy size. Groups record in battle
now almost the same that in "normal situations"
199911:
FS, updated for the use of game structure.
200104:
CB, updated to add the game options section.
TODO
write a doc :).
NAME
report_m -- create machine report.
SYNOPSIS
void report_m(player *P, game *aGame, FILE *reportFile)
SEE ALSO
report()
SOURCE
void
report_m(player *P, game *aGame, FILE * reportFile)
{
Mreport = reportFile;
rHE_M(aGame, P); /* Writes header of report file */
rMR_M(); /* Machine report version */
rGZ_M(aGame); /* Size of the galaxy */
rMM_M(aGame, P, aGame->messages, "global"); /* Global messages */
rMM_M(aGame, P, P->messages, "personnal"); /* Personnal messages */
rGO_M(aGame); /* Game options, CB-20010401 ; see
* galaxy.h */
rOP_M(aGame, P); /* Options */
rOD_M(aGame, P); /* Orders */
rMK_M(aGame, P); /* Mistakes in orders */
rST_M(aGame, P); /* Players status */
rSH_M(aGame, P); /* Ships types */
rBT_M(aGame, P); /* Battles */
rBB_M(aGame, P); /* Bombing */
rMP_M(aGame, P); /* Text map */
rIC_M(aGame, P); /* Incomming groups */
rAP_M(aGame, P); /* All planets */
rPT_M(aGame, P); /* Production table */
rRT_M(aGame, P); /* Routes */
rGG_M(aGame, P); /* Player's groups */
rGS_M(aGame, P); /* Others players groups */
rFL_M(aGame, P); /* Fleets */
rEN_M(); /* Writes last line of machine report file
*
* * * * * * * * * */
}
NAME
rHE_M --
FUNCTION
Write header of report file
NAME
rMR_M --
FUNCTION
Write the machine report version May be it can help turns viewers creators, when changes in machine report break the compatibility with previous versions
NAME
rMM_M --
FUNCTION
report global or personnal messages.
NAME
rGO_M --
FUNCTION
game options
NAME
rOP_M --
FUNCTION
report options
NAME
rOD_M --
FUNCTION
report orders
NAME
rMK_M -- FUNCION report mistakes
NAME
rST_M --
FUNCTION
report status of players
NAME
rSH_M --
FUNCTION
Report ship types.
NAME
rBT_M --
FUNCTION
report battles
NAME
rBB_M --
FUNCTION
report bombings
NAME
rMP_M --
FUNCTION
report text based map
NAME
rIC_M
FUNCTION
report incomming groups
NAME
rPT_M --
FUNCTION
report production tables
NAME
rPD_M --
FUNCTION
report production (it's a sub routine)
NAME
rRT_M --
FUNCTION
report routes
NAME
rAP_M --
FUNCTION
report (all) planets
NAME
rGG_M --
FUNCTION
report groups
NAME
rGS_M --
FUNCTION
Report groups seen
NAME
rFL_M --
FUNCTION
Report fleets
NAME
rEN_M --
FUNCTION
Write last line of file report
NAME
rGP_M --
FUNCTION
report groups (it's a sub routine)
NAME
rPL_M --
FUNCTION
report planets (it's a sub routine)