side.h

Go to the documentation of this file.

/* Definitions for sides in Xconq.
   Copyright (C) 1987-1989, 1991-1997, 1999-2000 Stanley T. Shebs.
   Copyright (C) 2004 Eric A. McDonald.

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.  */

#include "parambox.h"

#if MAXSIDES < 31

typedef int SideMask;
#define NOSIDES (0)

#define ALLSIDES (-1)

#define add_side_to_set(side,mask) ((mask) | (1 << ((side) ? (side)->id : 0)))

#define remove_side_from_set(side,mask) \
  ((mask) & ~(1 << ((side) ? (side)->id : 0)))

#define side_in_set(side,mask) ((mask) & (1 << ((side) ? (side)->id : 0)))
#else
not implemented yet
#endif /* MAXSIDES */

typedef struct a_doctrine {
    short id;                   
    char *name;                 
    short resupply_percent;     
    short rearm_percent;        
    short repair_percent;       
    short resupply_complete;    
    short rearm_complete;       
    short repair_complete;      
    short min_turns_food;       
    short min_distance_fuel;    
    short *construction_run;    
    short locked;               
    struct a_doctrine *next;    
} Doctrine;

enum sordercond {
    sorder_always,      
    sorder_at,          
    sorder_in,          
    sorder_near         
};

typedef struct a_standing_order {
    char *types;                
    enum sordercond condtype;   
    int a1;                     
    int a2;                     
    int a3;                     
    struct a_task *task;        
    struct a_standing_order *next;      
} StandingOrder;

namespace Xconq {
    namespace AI {
        struct AI_Side;
    }
}
typedef Xconq::AI::AI_Side AI_Side;

typedef struct a_side {
    int id;                     
    Obj *symbol;                
    char *name;                 
    char *longname;             
    char *shortname;            
    char *noun;                 
    char *pluralnoun;           
    char *adjective;            
    char *colorscheme;          
    char *default_color;        
    char *emblemname;           
    char **unitnamers;          
    Obj *featurenamers;         
    short nameslocked;          
    char *sideclass;            
    struct a_unit *self_unit;   
    short self_unit_id;         
    struct a_side *controlled_by;       
    short controlled_by_id;     
    SideMask knows_about;       
    short *trusts;              
    short *trades;              
    short *startwith;           
    short *counts;              
    short *tech;                
    short *inittech;            
    short *action_priorities;   
    short *already_seen;        
    short *already_seen_indep;  
    Doctrine *default_doctrine; 
    Doctrine **udoctrine;       
    short doctrines_locked;     
    StandingOrder *orders;      
    StandingOrder *last_order;  
    char *uorders;              
    Obj *possible_units;        
    short ai_may_resign;        
    short *advance;             
    short research_topic;       
    short autoresearch;         
    short research_goal;        
    long *treasury;             
    short *c_rates;             
    char *terrview;             
    char **auxterrview;         
    short *terrviewdate;        
    short **auxterrviewdate;    
    struct a_unit_view **unit_views;    
    short **materialview;       
    short **materialviewdate;   
    short *tempview;            
    short *tempviewdate;        
    short *cloudview;           
    short *cloudbottomview;     
    short *cloudheightview;     
    short *cloudviewdate;       
    short *windview;            
    short *windviewdate;        
    short ingame;               
    short everingame;           
    short priority;             
    short status;               
    short *scores;              
    Obj *rawscores;             
    short willingtodraw;        
    short autofinish;           
    short finishedturn;         
    short turntimeused;         
    short totaltimeused;        
    short timeouts;             
    short timeoutsused;         
    short curactor_pos;         
    struct a_unit *curactor;    
    short curactor_id;          
    short advantage;            
    short minadvantage;         
    short maxadvantage;         
    short init_center_x;        
    short init_center_y;        
    Obj *instructions;          
    short last_notice_date;     
    short realtimeout;          
    long startbeeptime;         
    short *gaincounts;          
    short *losscounts;          
    long **atkstats;            
    long **hitstats;            
    struct a_player *player;    
    short playerid;             
    struct a_ui *ui;            
    Obj *uidata;                
    short aitype;               
    struct a_ai *ai;            
    Obj *aidata;                
    struct a_rui *rui;          
    struct a_rai *rai;          

    AI_Side *master_ai;
    short startx, starty;       
    short busy;                 
    short finalradius;          
    short willingtosave;        
    short see_all;              
    short show_all;             
    short may_set_show_all;     
    short unit_view_restored;   
#ifdef DESIGNERS
    short designer;             
#endif /* DESIGNERS */
    short *uavail;              
    short *canbuild;            
    short *candevelop;          
    short *cancarry;            
    short *canresearch;         
    short *research_precluded;  

    short *could_act_with;
    short *could_construct;
    short *could_develop;
    short *could_research;
    struct a_unit *unithead;    
    struct a_unitvector *actionvector;  
    short numwaiting;           
    short *coverage;            
    short *alt_coverage;        
    short *numunits;            
    short numacting;            
    short numfinished;          
    long turnstarttime;         
    long lasttime;              
    long turnfinishtime;        
    long laststarttime;         
    int point_value_cache;      
    int point_value_valid;      
    int prefixarg;              
    struct a_side *next;        
} Side;

/* Side parameter box. */
struct ParamBoxSide : public ParamBox {
    Side *side;
    ParamBoxSide() { pboxtype = PBOX_TYPE_SIDE; side = NULL; }
};

/* Some convenient macros. */

#define side_in_play(side) (side->ingame)

/* Iteration over all sides. */

#define for_all_real_sides(v)  \
  for (v = (sidelist ? sidelist->next : NULL); v != NULL; v = v->next)

#define for_all_sides(v)  \
  for (v = sidelist; v != NULL; v = v->next)

/* Macros for accessing and setting a side's view data.  In general,
   interfaces should go through these macros instead of accessing the
   world's state directly. */

#define terrain_view(s,x,y)  \
  ((s)->terrview ? aref((s)->terrview, x, y) : buildtview(terrain_at(x, y)))

#define set_terrain_view(s,x,y,v)  \
  ((s)->terrview ? aset((s)->terrview, x, y, v) : 0)

#define buildtview(t) ((t) + 1)

#define vterrain(v) ((v) - 1)

#define UNSEEN (0)

#define terrain_view_date(s,x,y)  \
  ((s)->terrviewdate ? aref((s)->terrviewdate, x, y) : 0)

#define set_terrain_view_date(s,x,y,v)  \
  ((s)->terrviewdate ? aset((s)->terrviewdate, x, y, v) : 0)

#define aux_terrain_view(s,x,y,t)  \
  (((s)->auxterrview && (s)->auxterrview[t]) ? \
        aref((s)->auxterrview[t], x, y) : \
        (aux_terrain_defined(t) ? aux_terrain_at(x, y, t) : 0))

#define set_aux_terrain_view(s,x,y,t,v)  \
  (((s)->auxterrview && (s)->auxterrview[t]) ? aset((s)->auxterrview[t], x, y, v) : 0)

#define aux_terrain_view_date(s,x,y,t)  \
  (((s)->auxterrviewdate && (s)->auxterrviewdate[t]) ? aref((s)->auxterrviewdate[t], x, y) : 0)

#define set_aux_terrain_view_date(s,x,y,t,v)  \
  (((s)->auxterrviewdate && (s)->auxterrviewdate[t]) ? aset((s)->auxterrviewdate[t], x, y, v) : 0)

#define for_all_unit_views(v)  \
    for (v = viewlist; v != NULL; v = v->vnext)

#define nextview(s,x,y,uv) \
        ((uv)->transport == NULL ? unit_view_next((s), (x), (y), (uv)) : (uv)->nexthere)

#define for_all_view_stack(s,x,y,uv) \
  for ((uv) = unit_view_at(s,x,y); (uv) != NULL; (uv) = unit_view_next(s,x,y,uv))

/* Iterate over all uviews in a given uvstack. */
#define for_all_uvstack(uvs,uv) \
    for ((uv) = (uvs); (uv); \
         (uv) = unit_view_next((uvs)->observer == -1 \
                                ? NULL : side_n((uvs)->observer), \
                               (uvs)->x, (uvs)->y, (uv)))

#define for_all_view_stack_with_occs(s, x,y,uv)  \
  for ((uv) = unit_view_at((s), (x), (y)); \
          (uv) != NULL; \
         (uv) = ((uv)->occupant != NULL ? \
                        (uv)->occupant : \
                      (nextview((s), (x), (y), (uv)) != NULL ? \
                        nextview((s), (x), (y), (uv)) : \
                      ((uv)->transport != NULL && \
                        nextview((s), (x), (y), (uv)->transport) != NULL ? \
                        nextview((s), (x), (y), (uv)->transport) : \
                      ((uv)->transport != NULL && \
                        (uv)->transport->transport != NULL && \
                        nextview((s), (x), (y), (uv)->transport->transport) != NULL ? \
                        nextview((s), (x), (y), (uv)->transport->transport) : \
                      ((uv)->transport != NULL && \
                        (uv)->transport->transport != NULL && \
                        (uv)->transport->transport->transport != NULL && \
                        nextview((s), (x), (y), (uv)->transport->transport->transport) != NULL ? \
                        nextview((s), (x), (y), (uv)->transport->transport->transport) : NULL))))))

#define for_all_occupant_views(uv,v) \
  for (v = (uv)->occupant; v != NULL; v = v->nexthere)

#define for_all_occupant_views_with_occs(uv,var)  \
  for ((var) = (uv)->occupant; \
       (var) != NULL && (var) != (uv)->nexthere; \
         (var) = ((var)->occupant != NULL ? \
                        (var)->occupant : \
                      ((var)->nexthere != NULL ? \
                        (var)->nexthere : \
                      ((var)->transport != NULL && \
                        (var)->transport->nexthere != NULL ? \
                        (var)->transport->nexthere : \
                      ((var)->transport != NULL && \
                        (var)->transport->transport != NULL && \
                        (var)->transport->transport->nexthere != NULL ? \
                        (var)->transport->transport->nexthere : NULL)))))

/* Get a pointer to the actual unit being viewed if possible. */

#define view_unit(uv) \
  (((uv)->unit != NULL && (uv)->id == (uv)->unit->id) ? (uv)->unit : NULL)

/* Manipulation of view of cell materials. */

#define material_view(s,x,y,m)  \
  (((s)->materialview && (s)->materialview[m]) ? aref((s)->materialview[m], x, y) : (cell_material_defined(m) ? material_at(x, y, m) : 0))

#define set_material_view(s,x,y,m,v)  \
  (((s)->materialview && (s)->materialview[m]) ? aset((s)->materialview[m], x, y, v) : 0)

#define material_view_date(s,x,y,m)  \
  (((s)->materialviewdate && (s)->materialviewdate[m]) ? aref((s)->materialviewdate[m], x, y) : 0)

#define set_material_view_date(s,x,y,m,v)  \
  (((s)->materialviewdate && (s)->materialviewdate[m]) ? aset((s)->materialviewdate[m], x, y, v) : 0)

/* Manipulation of view of weather. */

#define temperature_view(s,x,y)  \
  ((s)->tempview ? aref((s)->tempview, x, y) : (temperatures_defined() ? temperature_at(x, y) : 0))

#define set_temperature_view(s,x,y,v)  \
  ((s)->tempview ? aset((s)->tempview, x, y, v) : 0)

#define temperature_view_date(s,x,y)  \
  ((s)->tempviewdate ? aref((s)->tempviewdate, x, y) : 0)

#define set_temperature_view_date(s,x,y,v)  \
  ((s)->tempviewdate ? aset((s)->tempviewdate, x, y, v) : 0)

#define cloud_view(s,x,y)  \
  ((s)->cloudview ? aref((s)->cloudview, x, y) : (clouds_defined() ? raw_cloud_at(x, y) : 0))

#define set_cloud_view(s,x,y,v)  \
  ((s)->cloudview ? aset((s)->cloudview, x, y, v) : 0)

#define cloud_view_date(s,x,y)  \
  ((s)->cloudviewdate ? aref((s)->cloudviewdate, x, y) : 0)

#define set_cloud_view_date(s,x,y,v)  \
  ((s)->cloudviewdate ? aset((s)->cloudviewdate, x, y, v) : 0)

#define cloud_bottom_view(s,x,y)  \
  ((s)->cloudbottomview ? aref((s)->cloudbottomview, x, y) : (cloud_bottoms_defined() ? raw_cloud_bottom_at(x, y) : 0))

#define set_cloud_bottom_view(s,x,y,v)  \
  ((s)->cloudbottomview ? aset((s)->cloudbottomview, x, y, v) : 0)

#define cloud_bottom_view_date(s,x,y)  \
  ((s)->cloudbottomviewdate ? aref((s)->cloudbottomviewdate, x, y) : 0)

#define set_cloud_bottom_view_date(s,x,y,v)  \
  ((s)->cloudbottomviewdate ? aset((s)->cloudbottomviewdate, x, y, v) : 0)

#define cloud_height_view(s,x,y)  \
  ((s)->cloudheightview ? aref((s)->cloudheightview, x, y) : (cloud_heights_defined() ? raw_cloud_height_at(x, y) : 0))

#define set_cloud_height_view(s,x,y,v)  \
  ((s)->cloudheightview ? aset((s)->cloudheightview, x, y, v) : 0)

#define cloud_height_view_date(s,x,y)  \
  ((s)->cloudheightviewdate ? aref((s)->cloudheightviewdate, x, y) : 0)

#define set_cloud_height_view_date(s,x,y,v)  \
  ((s)->cloudheightviewdate ? aset((s)->cloudheightviewdate, x, y, v) : 0)

#define wind_view(s,x,y)  \
  ((s)->windview ? aref((s)->windview, x, y) : (winds_defined() ? raw_wind_at(x, y) : CALM))

#define set_wind_view(s,x,y,v)  \
  ((s)->windview ? aset((s)->windview, x, y, v) : 0)

#define wind_view_date(s,x,y)  \
  ((s)->windviewdate ? aref((s)->windviewdate, x, y) : 0)

#define set_wind_view_date(s,x,y,v)  \
  ((s)->windviewdate ? aset((s)->windviewdate, x, y, v) : 0)

/* Basic manipulation of vision coverage cache layer. */

#define cover(s,x,y)  \
  ((s)->coverage ? aref((s)->coverage, x, y) : 0)

#define set_cover(s,x,y,v)  \
  ((s)->coverage ? aset((s)->coverage, x, y, v) : 0)

#define add_cover(s,x,y,v)  \
  ((s)->coverage ? aadd((s)->coverage, (x), (y), (v)) : 0)

#define alt_cover(s,x,y)  \
  ((s)->alt_coverage ? aref((s)->alt_coverage, x, y) : 0)

#define set_alt_cover(s,x,y,v)  \
  ((s)->alt_coverage ? aset((s)->alt_coverage, x, y, v) : 0)

#define side_has_treasury(s,m) (s != indepside ? m_treasury(m) : g_indepside_has_treasury() ? m_treasury(m) : FALSE) 

/* Tests of who/what runs the side. */

#define side_wants_display(s) ((s)->player && (s)->player->displayname)

#define side_wants_ai(s) ((s)->player && (s)->player->aitypename)

#define side_has_display(s) (((s)->ui) != NULL || ((s)->rui) != NULL)

#define side_has_local_display(s) ((s)->ui != NULL)

#define side_has_ai(s) (((s)->ai) != NULL || ((s)->rai) != NULL)

#define side_has_local_ai(s) ((s)->ai != NULL)

/* Tests of side state. */

#define side_lost(s) ((s) != NULL && !(s)->ingame && (s)->status < 0)

#define side_drew(s) ((s) != NULL && !(s)->ingame && (s)->status == 0)

#define side_won(s) ((s) != NULL && !(s)->ingame && (s)->status > 0)

#define side_gain_count(s,u,r) (((s)->gaincounts)[num_gain_reasons*(u)+(r)])

#define side_loss_count(s,u,r) (((s)->losscounts)[num_loss_reasons*(u)+(r)])

#define side_atkstats(s,a,d) ((s)->atkstats[a] ? ((s)->atkstats[a])[d] : 0)

#define side_hitstats(s,a,d) ((s)->hitstats[a] ? ((s)->hitstats[a])[d] : 0)

#define terrain_visible(side, x, y)  \
  ((side)->see_all || (terrain_view((side), (x), (y)) != UNSEEN))

#define borders_visible(side, x, y, d)  \
  ((side)->see_all || seen_border((side), (x), (y), (d)))

#define units_visible(side, x, y)  \
  ((side)->see_all || (cover((side), (x), (y)) >= 1))

#define has_advance(side,a) ((side)->advance[(a)] == DONE)

/* Return true if a side's units can build the given type. */

#define side_can_build(side,u)  \
  ((side)->canbuild != NULL ? (side)->canbuild[u] : TRUE)

/* Return true if a side's units can carry the given type. */

#define side_can_carry(side,u)  \
  ((side)->cancarry != NULL ? (side)->cancarry[u] : TRUE)

/* Return true if a side's units can develop the given type. */

#define side_can_develop(side,u)  \
  ((side)->candevelop != NULL ? (side)->candevelop[u] : TRUE)

/* Return true if a side can research the given type. */

#define side_can_research(side,a)  \
  ((side)->canresearch != NULL ? (side)->canresearch[a] : TRUE)

#define inactive_indepside(side)  \
  ((side) == indepside && !side_has_ai(side) && !side_has_display(side))

#ifdef DESIGNERS
#define is_designer(side) (side->designer)
#else /* DESIGNERS */
#define is_designer(side) (FALSE)
#endif /* DESIGNERS */

#define for_all_doctrines(d)  \
  for ((d) = doctrine_list; (d) != NULL; (d) = (d)->next)

/* Side-related variables. */

extern Side *sidelist;
extern Side *lastside;
extern Side *indepside;
extern Side *curside;
extern Side *tmpside;

extern int numsides;
extern int numtotsides;
extern int numplayers;
#ifdef DESIGNERS

extern int numdesigners;
#endif /* DESIGNERS */

#if 0

typedef struct a_agreement {
    short id;                                   
    char *agtype;                       
    char *name;                         
    int state;                                  
    SideMask drafters;                  
    SideMask proposers;                 
    SideMask signers;                   
    SideMask willing;                   
    SideMask knownto;                   
    struct a_obj *terms;                
    short enforcement;                  
    struct a_agreement *next;   
} Agreement;

enum {
    draft,              
    proposed,           
    in_force,           
    moribund    
};

/* Iteration over all agreements in the game. */

#define for_all_agreements(v) for (v = agreement_list; v != NULL; v = v->next)

#define any_agreements() (agreement_list != NULL)

#define side_signed_agreement(side,ag) ((ag)->signers[side_n(side)])

#define side_willing_agreement(side,ag) ((ag)->willing[side_n(side)])

#define side_knows_about_agreement(side,ag) ((ag)->knownto[side_n(side)])

/* Agreement-related variables. */

extern int num_agreements;

extern Agreement *agreement_list;
extern Agreement *last_agreement;

#endif

/* Note: Can't use the "Unit" typedef below, must use "struct a_unit". */

extern int n_units_on_side(Side *side);

extern void init_sides(void);
extern Side *create_side(void);
extern void init_side_unithead(Side *side);
extern int side_has_units(Side *side);
extern void init_doctrine(Side *side);
extern void init_self_unit(Side *side);
extern int init_view(Side *side);
extern void calc_start_xy(Side *side);
extern char *side_name(Side *side);
extern char *side_adjective(Side *side);
extern int side_number(Side *side);
extern Side *side_n(int n);
extern Side *find_side_by_name(char *str);
extern int side_controls_side(Side *side, Side *side2);
extern int side_controls_unit(Side *side, struct a_unit *unit);
extern int side_sees_unit(Side *side, struct a_unit *unit);
extern int side_sees_image(Side *side, struct a_unit *unit);
extern int occupants_visible(Side *side, struct a_unit *unit);
extern int num_units_in_play(Side *side, int u);
extern int num_units_incomplete(Side *side, int u);
extern struct a_unit *find_next_unit(Side *side, struct a_unit *prevunit);
extern struct a_unit *find_prev_unit(Side *side, struct a_unit *nextunit);
extern struct a_unit *find_next_actor(Side *side, struct a_unit *prevunit);
extern struct a_unit *find_prev_actor(Side *side, struct a_unit *nextunit);
extern struct a_unit *find_next_mover(Side *side, struct a_unit *prevunit);
extern struct a_unit *find_prev_mover(Side *side, struct a_unit *nextunit);
extern struct a_unit *find_next_awake_mover(Side *side,
                                            struct a_unit *prevunit);
extern struct a_unit *find_prev_awake_mover(Side *side,
                                            struct a_unit *nextunit);
extern int side_initacp(Side *side);
extern int side_acp(Side *side);
extern int side_acp_reserved(Side *side);
extern int using_tech_levels(void);
extern void remove_side_from_game(Side *side);
extern int num_displayed_sides(void);
extern int trusted_side(Side *side1, Side *side2);
extern int enemy_side(Side *s1, Side *s2);
extern int allied_side(Side *s1, Side *s2);
extern int neutral_side(Side *s1, Side *s2);
extern void reveal_side(Side *sender, Side *recipient, int *types);
extern void receive_message(Side *side, Side *sender, char *str);
extern struct a_unit_view *unit_view_at(Side *side, int x, int y);
extern struct a_unit_view *unit_view_next(Side *side, int x, int y,
                                          struct a_unit_view *uview);
extern struct a_unit *query_unit_from_uview(struct a_unit_view *uview);
extern struct a_unit_view *query_uvstack_from_unit(struct a_unit *unit);
extern struct a_unit_view *query_uvstack_at(int x, int y);
extern void all_see_occupy(struct a_unit *unit, int x, int y, int inopen);
extern void all_see_leave(struct a_unit *unit, int x, int y, int inopen);
extern void cover_area(Side *side, struct a_unit *unit,
                       struct a_unit *oldtransport, int x0, int y0,
                       int x1, int y1);
extern void reset_coverage(void);
extern void really_reset_coverage(void);
extern void calc_coverage(Side *side);
extern void reset_all_views(void);
extern void reset_view(Side *side);
extern void react_to_seen_unit(Side *side, struct a_unit *unit, int x, int y);
extern void all_see_cell(int x, int y);
extern int see_cell(Side *side, int x, int y);
extern void see_exact(Side *side, int x, int y);
extern int seen_border(Side *side, int x, int y, int dir);
extern void maybe_track(struct a_unit *unit);
extern void maybe_lose_track(struct a_unit *unit, int nx, int ny);
extern char *side_desig(Side *side);

extern Side *parse_side_spec(char *str);

extern int actual_advantage(Side *side);

extern Doctrine *new_doctrine(int id);
extern Doctrine *find_doctrine(int id);
extern Doctrine *find_doctrine_by_name(char *name);
extern Doctrine *clone_doctrine(Doctrine *doctrine);
extern void set_doctrine(Side *side, char *spec);

extern StandingOrder *new_standing_order(void);
extern void add_standing_order(Side *side, StandingOrder *sorder, int pos);
extern int parse_standing_order(Side *side, char *cmdstr);
extern char *parse_unit_types(Side *side, char *str, char *utypevec);
extern char *parse_order_cond(Side *side, char *str, StandingOrder *sorder);
extern char *get_next_arg(char *str, char *buf, char **rsltp);
extern char *standing_order_desc(StandingOrder *sorder, char *buf);
#if 0
extern void init_agreements(void);
extern Agreement *create_agreement(int id);
extern Agreement *find_agreement(int id);
extern char *agreement_desig(Agreement *ag);
#endif
extern void fn_set_terrain_view(int x, int y, int val);
extern void fn_set_aux_terrain_view(int x, int y, int val);
extern void fn_set_terrain_view_date(int x, int y, int val);
extern void fn_set_aux_terrain_view_date(int x, int y, int val);
extern void fn_set_material_view(int x, int y, int val);
extern void fn_set_material_view_date(int x, int y, int val);
extern void fn_set_temp_view(int x, int y, int val);
extern void fn_set_temp_view_date(int x, int y, int val);
extern void fn_set_cloud_view(int x, int y, int val);
extern void fn_set_cloud_bottom_view(int x, int y, int val);
extern void fn_set_cloud_height_view(int x, int y, int val);
extern void fn_set_cloud_view_date(int x, int y, int val);
extern void fn_set_wind_view(int x, int y, int val);
extern void fn_set_wind_view_date(int x, int y, int val);

extern int load_side_config(Side *side);

extern void update_side_display_all_sides(Side *side, int rightnow);

extern int side_material_supply(Side * side, int m);
extern int side_material_production(Side * side, int m);
extern int side_material_storage(Side * side, int m);

extern int fn_test_side_in_sideclass(Obj *osclass, ParamBox *pbox);

---