X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=dungeon.c;h=feb98e79be2f7069dbf523049bfd0da20b0e6dde;hb=1ec3ef3855632d0c0a5ad7624978bccbb079c380;hp=a8b5f16e59af9a099160c63d2d64f2a55ac10095;hpb=64035d00262d3b10c126748be659d22394b7ed3b;p=open-adventure.git

diff --git a/dungeon.c b/dungeon.c
index a8b5f16..feb98e7 100644
--- a/dungeon.c
+++ b/dungeon.c
@@ -1,9 +1,88 @@
 /*
  * The dungeon compiler. Turns adventure.text into a set of C initializers
- * defining (mostly) invariant state.  A couple of slots are messed with
- * at runtime.
+ * defining invariant state.
  */
 
+/*  Current limits:
+ *     12600 words of message text (LINES, LINSIZ).
+ *	885 travel options (TRAVEL, TRVSIZ).
+ *	330 vocabulary words (KTAB, ATAB, TABSIZ).
+ *	 35 "action" verbs (ACTSPK, VRBSIZ).
+ *  There are also limits which cannot be exceeded due to the structure of
+ *  the database.  (E.G., The vocabulary uses n/1000 to determine word type,
+ *  so there can't be more than 1000 words.)  These upper limits are:
+ *	1000 non-synonymous vocabulary words
+ *	300 locations
+ *	100 objects
+ */
+
+/*  Description of the database format
+ *
+ *
+ *  The data file contains several sections.  Each begins with a line containing
+ *  a number identifying the section, and ends with a line containing "-1".
+ *
+ *  Section 3: Travel table.  Each line contains a location number (X), a second
+ *	location number (Y), and a list of motion numbers (see section 4).
+ *	each motion represents a verb which will go to Y if currently at X.
+ *	Y, in turn, is interpreted as follows.  Let M=Y/1000, N=Y mod 1000.
+ *		If N<=300	it is the location to go to.
+ *		If 300<N<=500	N-300 is used in a computed goto to
+ *					a section of special code.
+ *		If N>500	message N-500 from section 6 is printed,
+ *					and he stays wherever he is.
+ *	Meanwhile, M specifies the conditions on the motion.
+ *		If M=0		it's unconditional.
+ *		If 0<M<100	it is done with M% probability.
+ *		If M=100	unconditional, but forbidden to dwarves.
+ *		If 100<M<=200	he must be carrying object M-100.
+ *		If 200<M<=300	must be carrying or in same room as M-200.
+ *		If 300<M<=400	game.prop(M % 100) must *not* be 0.
+ *		If 400<M<=500	game.prop(M % 100) must *not* be 1.
+ *		If 500<M<=600	game.prop(M % 100) must *not* be 2, etc.
+ *	If the condition (if any) is not met, then the next *different*
+ *	"destination" value is used (unless it fails to meet *its* conditions,
+ *	in which case the next is found, etc.).  Typically, the next dest will
+ *	be for one of the same verbs, so that its only use is as the alternate
+ *	destination for those verbs.  For instance:
+ *		15	110022	29	31	34	35	23	43
+ *		15	14	29
+ *	This says that, from loc 15, any of the verbs 29, 31, etc., will take
+ *	him to 22 if he's carrying object 10, and otherwise will go to 14.
+ *		11	303008	49
+ *		11	9	50
+ *	This says that, from 11, 49 takes him to 8 unless game.prop(3)=0, in which
+ *	case he goes to 9.  Verb 50 takes him to 9 regardless of game.prop(3).
+ *  Section 4: Vocabulary.  Each line contains a number (n), a tab, and a
+ *	five-letter word.  Call M=N/1000.  If M=0, then the word is a motion
+ *	verb for use in travelling (see section 3).  Else, if M=1, the word is
+ *	an object.  Else, if M=2, the word is an action verb (such as "carry"
+ *	or "attack").  Else, if M=3, the word is a special case verb (such as
+ *	"dig") and N % 1000 is an index into section 6.  Objects from 50 to
+ *	(currently, anyway) 79 are considered treasures (for pirate, closeout).
+ *  Section 8: Action defaults.  Each line contains an "action-verb" number and
+ *	the index (in section 6) of the default message for the verb.
+ *  Section 0: End of database.
+ *
+ * Other sections are obsolete and ignored */
+
+/*  The various messages (sections 1, 2, 5, 6, etc.) may include certain
+ *  special character sequences to denote that the program must provide
+ *  parameters to insert into a message when the message is printed.  These
+ *  sequences are:
+ *	%S = The letter 'S' or nothing (if a given value is exactly 1)
+ *	%W = A word (up to 10 characters)
+ *	%L = A word mapped to lower-case letters
+ *	%U = A word mapped to upper-case letters
+ *	%C = A word mapped to lower-case, first letter capitalised
+ *	%T = Several words of text, ending with a word of -1
+ *	%1 = A 1-digit number
+ *	%2 = A 2-digit number
+ *	...
+ *	%9 = A 9-digit number
+ *	%B = Variable number of blanks
+ *	%! = The entire message should be suppressed */
+
 #define LINESIZE 100
 #define CLSMAX 12
 #define LINSIZ 12600
@@ -25,13 +104,13 @@ static long LNLENG;
 static long LNPOSN;
 static char INLINE[LINESIZE + 1];
 static long OLDLOC;
+static long LINUSE;
 
 // Storage for what comes out of the database
-long LINUSE;
 long TRVS;
 long TRNVLS;
 long TABNDX;
-long KEY[LOCSIZ + 1];
+long KEY[NLOCATIONS + 1];
 long LINES[LINSIZ + 1];
 long TRAVEL[TRVSIZ + 1];
 long KTAB[TABSIZ + 1];
@@ -321,7 +400,7 @@ static int read_database(FILE* database)
      *  pointer-words in lines. PTEXT(N) points to
      *  message for game.prop(N)=0.  Successive prop messages are
      *  found by chasing pointers. */
-    for (int I = 1; I <= LOCSIZ; I++) {
+    for (int I = 1; I <= NLOCATIONS; I++) {
         KEY[I] = 0;
     }
 
@@ -431,7 +510,7 @@ static void write_file(FILE* header_file)
     fprintf(header_file, "\n");
 
     // content variables
-    write_1d(header_file, KEY, LOCSIZ + 1, "KEY");
+    write_1d(header_file, KEY, NLOCATIONS + 1, "KEY");
     write_1d(header_file, TRAVEL, TRVSIZ + 1, "TRAVEL");
     write_1d(header_file, KTAB, TABSIZ + 1, "KTAB");
     write_1d(header_file, ATAB, TABSIZ + 1, "ATAB");