Better project documentation.
[super-star-trek.git] / sst.h
diff --git a/sst.h b/sst.h
index b34312068646182ccd7a1eb77a100f3715adfa14..8705b8480ce06277cbb4e6c410e2e658f35a99c7 100644 (file)
--- a/sst.h
+++ b/sst.h
 \r
 // #define DEBUG\r
 \r
-#define ndevice (15)   // Number of devices\r
-#define phasefac (2.0)\r
+#define NDEVICES (15)  // Number of devices\r
+#define PHASEFAC (2.0)\r
 #define PLNETMAX (10)\r
 #define NEVENTS (8)\r
 \r
 typedef struct {\r
-       int x;  /* Quadrant location of planet */\r
-       int y;\r
-       int pclass; /* class M, N, or O (1, 2, or 3) */\r
-       int crystals; /* has crystals */\r
-       int known;   /* =1 contents known, =2 shuttle on this planet */\r
-} PLANETS;\r
+    int x;     /* Quadrant location of planet */\r
+    int y;\r
+    enum {M=0, N=1, O=2} pclass;\r
+    int crystals; /* has crystals */\r
+    enum {unknown, known, shuttle_down} known;\r
+} planet;\r
 \r
-EXTERN struct foo {\r
-               int snap,               // snapshot taken\r
-               remkl,                  // remaining klingons\r
-           remcom,                     // remaining commanders\r
-               rembase,                // remaining bases\r
-               starkl,                 // destroyed stars\r
-               basekl,                 // destroyed bases\r
-               killk,                  // Klingons killed\r
-               killc,                  // commanders killed\r
-               galaxy[9][9],   // The Galaxy (subscript 0 not used)\r
-               cx[11],cy[11],  // Commander quadrant coordinates\r
-               baseqx[6],              // Base quadrant X\r
-               baseqy[6],              // Base quadrant Y\r
-               newstuf[9][9],  // Extended galaxy goodies\r
-               isx, isy,               // Coordinate of Super Commander\r
-               nscrem,                 // remaining super commanders\r
-               nromkl,                 // Romulans killed\r
-               nromrem,                // Romulans remaining\r
-               nsckill,                // super commanders killed\r
-               nplankl;                // destroyed planets\r
-       PLANETS plnets[PLNETMAX+1];  // Planet information\r
+#define DESTROY(pl)    memset(pl, '\0', sizeof(planet))\r
+\r
+typedef struct {\r
+    int snap,          // snapshot taken\r
+       remkl,                  // remaining klingons\r
+       remcom,                 // remaining commanders\r
+       rembase,                // remaining bases\r
+       starkl,                 // destroyed stars\r
+       basekl,                 // destroyed bases\r
+       killk,                  // Klingons killed\r
+       killc,                  // commanders killed\r
+       galaxy[9][9],   // The Galaxy (subscript 0 not used)\r
+       cx[11],cy[11],  // Commander quadrant coordinates\r
+       baseqx[6],              // Base quadrant X\r
+       baseqy[6],              // Base quadrant Y\r
+       newstuf[9][9],  // Extended galaxy goodies\r
+       isx, isy,               // Coordinate of Super Commander\r
+       nscrem,                 // remaining super commanders\r
+       nromkl,                 // Romulans killed\r
+       nromrem,                // Romulans remaining\r
+       nsckill,                // super commanders killed\r
+       nplankl;                // destroyed planets\r
+       planet plnets[PLNETMAX];  // Planet information\r
        double date,            // stardate\r
-               remres,                 // remaining resources\r
+           remres,             // remaining resources\r
            remtime;            // remaining time\r
-} d, snapsht;                  // Data that is snapshot\r
-\r
-EXTERN char\r
-               quad[11][11];   // contents of our quadrant\r
+} snapshot;                            // Data that is snapshot\r
 \r
 // Scalar variables that are needed for freezing the game\r
 // are placed in a structure. #defines are used to access by their\r
 // original names. Gee, I could have done this with the d structure,\r
 // but I just didn't think of it back when I started.\r
 \r
-EXTERN struct foo2 {\r
-       int inkling,\r
+#define SSTMAGIC       "SST2.0\n"\r
+\r
+EXTERN struct {\r
+    char magic[sizeof(SSTMAGIC)];\r
+    snapshot state;\r
+    snapshot snapsht;\r
+    char quad[11][11];         // contents of our quadrant\r
+    double kpower[21];         // enemy energy levels\r
+    double kdist[21];          // enemy distances\r
+    double kavgd[21];          // average distances\r
+    double damage[NDEVICES+1]; // damage encountered\r
+    double future[NEVENTS+1];  // future events\r
+    char passwd[10];           // Self Destruct password\r
+    int kx[21];                        // enemy sector locations\r
+    int ky[21];\r
+    int starch[9][9];          // star chart\r
+    /* members with macro definitions start here */\r
+    int inkling,\r
        inbase,\r
        incom,\r
        instar,\r
@@ -121,7 +136,7 @@ EXTERN struct foo2 {
        proben,\r
        isarmed,\r
        nprobes;\r
-       double inresor,\r
+    double inresor,\r
        intime,\r
        inenrg,\r
        inshld,\r
@@ -235,39 +250,20 @@ EXTERN struct foo2 {
 #define isarmed game.isarmed           // Probe is armed\r
 #define nprobes game.nprobes           // number of probes available\r
 \r
-EXTERN int\r
-               kx[21],                 // enemy sector locations\r
-               ky[21],\r
-               starch[9][9];   // star chart\r
-\r
+/* the following global state doesn't need to be saved */\r
 EXTERN int fromcommandline; // Game start from command line options\r
-\r
-\r
-EXTERN char    passwd[10],             // Self Destruct password\r
-               *device[ndevice+1];\r
-\r
-EXTERN PLANETS nulplanet;      // zeroed planet structure\r
-\r
-EXTERN double\r
-               kpower[21],             // enemy energy levels\r
-               kdist[21],              // enemy distances\r
-               kavgd[21],              // average distances\r
-               damage[ndevice+1],              // damage encountered\r
-               future[NEVENTS+1];              // future events\r
-\r
+EXTERN char    *device[NDEVICES+1];\r
 EXTERN int iscore, iskill; // Common PLAQ\r
 EXTERN double perdate;\r
+EXTERN double aaitem;\r
+EXTERN char citem[10];\r
 \r
 typedef enum {FWON, FDEPLETE, FLIFESUP, FNRG, FBATTLE,\r
               FNEG3, FNOVA, FSNOVAED, FABANDN, FDILITHIUM,\r
                          FMATERIALIZE, FPHASER, FLOST, FMINING, FDPLANET,\r
                          FPNOVA, FSSC, FSTRACTOR, FDRAY, FTRIBBLE,\r
                          FHOLE} FINTYPE ;\r
-\r
-\r
-EXTERN double aaitem;\r
-EXTERN char citem[10];\r
-\r
+enum loctype {neither, quadrant, sector};\r
 \r
 /* Define devices */\r
 #define DSRSENS 1\r
@@ -299,8 +295,7 @@ EXTERN char citem[10];
 #define FDSPROB 8   // Move deep space probe\r
 \r
 #ifdef INCLUDED\r
-PLANETS nulplanet = {0};\r
-char *device[ndevice+1] = {\r
+char *device[NDEVICES+1] = {\r
        "",\r
        "S. R. Sensors",\r
        "L. R. Sensors",\r
@@ -379,14 +374,14 @@ int scan(void);
 void chew(void);\r
 void chew2(void);\r
 void skip(int);\r
-void prout(char *s);\r
-void proutn(char *s);\r
+void prout(char *, ...);\r
+void proutn(char *, ...);\r
 void stars(void);\r
 void newqad(int);\r
 int ja(void);\r
 void cramen(int);\r
 void crmshp(void);\r
-void cramlc(int, int, int);\r
+char *cramlc(enum loctype, int, int);\r
 double expran(double);\r
 double Rand(void);\r
 void iran8(int *, int *);\r
@@ -402,15 +397,13 @@ void deadkl(int, int, int, int, int);
 void timwrp(void);\r
 void movcom(void);\r
 void torpedo(double, double, int, int, double *);\r
-void cramf(double, int, int);\r
-void crami(int, int);\r
 void huh(void);\r
 void pause(int);\r
 void nova(int, int);\r
 void snova(int, int);\r
 void scom(int *);\r
 void hittem(double *);\r
-void prouts(char *);\r
+void prouts(char *, ...);\r
 int isit(char *);\r
 void preport(void);\r
 void orbit(void);\r