history.h

Go to the documentation of this file.

/* Definitions for the historical record.
   Copyright (C) 1992-1995, 1998-2000 Stanley T. Shebs.

Xconq is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.  See the file COPYING.  */

#undef  DEF_HEVT
#define DEF_HEVT(name, CODE, datadescs) CODE,

typedef enum {

#include "history.def"

    NUMHEVTTYPES
} HistEventType;

typedef struct a_hevt_defn {
    char *name;                 
    char *datadescs;    
} HevtDefn;

typedef struct a_histevent {
    HistEventType type;                         
    short startdate;                            
    short enddate;                              
    SideMask observers;                 
    struct a_histevent *next;           
    struct a_histevent *prev;           
    int data[4];                                
} HistEvent;


typedef struct a_pastunit {
    short type;                                 
    int id;                                             
    char *name;                                 
    int number;                                 
    short x;                                            
    short y;                                            
    short z;                                            
    struct a_side *side;                        
    struct a_pastunit *next;            
} PastUnit;

enum gain_reasons {
    initial_gain = 0,           
    build_gain = 1,             
    capture_gain = 2,           /*1< capture */
    other_gain = 3,             
    num_gain_reasons = 4        
};

enum loss_reasons {
    combat_loss = 0,            
    capture_loss = 1,           
    starvation_loss = 2,        
    accident_loss = 3,          
    attrition_loss = 4,         
    disband_loss = 5,           
    other_loss = 6,             
    num_loss_reasons = 7        
};

enum damage_reasons {
    combat_dmg,                 
    accident_dmg,               
    attrition_dmg,              
    starvation_dmg              
};

extern HevtDefn hevtdefns[];

/*1 \brief Historical Events list. */
extern HistEvent *history;

extern PastUnit *past_unit_list;

extern void init_history(void);
extern void start_history(void);
extern HistEvent *create_historical_event(HistEventType type);
extern HistEvent *record_event(HistEventType type, SideMask observers, ...);
extern void record_unit_death(Unit *unit, HistEventType reason);
extern void record_unit_name_change(Unit *unit, char *newname);
extern void record_unit_side_change(Unit *unit, Side *newside,
                                    HistEventType reason, Unit *agent);
extern void count_gain(Side *side, int u, enum gain_reasons reason);
extern void count_loss(Side *side, int u, enum loss_reasons reason);
extern void end_history(void);
extern HistEvent *get_nth_history_line(Side *side, int n, HistEvent **nextevt);
extern PastUnit *create_past_unit(int type, int id);
extern PastUnit *find_past_unit(int n);
extern char *past_unit_desig(PastUnit *pastunit);
extern PastUnit *change_unit_to_past_unit(Unit *unit);
extern void dump_statistics(void);

extern int update_total_hist_lines(Side *side);
extern int build_hist_contents(Side *side, int n, HistEvent **histcontents, int numvis);
extern int total_gain(Side *side, int u);
extern int total_loss(Side *side, int u);

---