added Builtin_mission_num for builtin mission, D1Hogdir, d1-style mission briefings
[btb/d2x.git] / main / mission.c
1 /* $Id: mission.c,v 1.11 2002-08-27 04:12:55 btb Exp $ */
2 /*
3 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
4 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
5 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
6 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
7 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
8 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
9 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
10 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
11 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
12 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
13 */
14
15 /*
16  *
17  * Stuff for loading missions
18  *
19  *
20  */
21
22 #ifdef HAVE_CONFIG_H
23 #include <conf.h>
24 #endif
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <ctype.h>
30 #include <limits.h>
31
32 #include "pstypes.h"
33 #include "cfile.h"
34
35 #include "strutil.h"
36 #include "inferno.h"
37 #include "mission.h"
38 #include "gameseq.h"
39 #include "titles.h"
40 #include "songs.h"
41 #include "mono.h"
42 #include "error.h"
43 #include "findfile.h"
44
45 mle Mission_list[MAX_MISSIONS];
46
47 int Current_mission_num, Builtin_mission_num;
48 int     N_secret_levels;                //      Made a global by MK for scoring purposes.  August 1, 1995.
49 char *Current_mission_filename,*Current_mission_longname;
50
51 char Builtin_mission_filename[9];
52 int Builtin_mission_hogsize;
53
54 //this stuff should get defined elsewhere
55
56 char Level_names[MAX_LEVELS_PER_MISSION][FILENAME_LEN];
57 char Secret_level_names[MAX_SECRET_LEVELS_PER_MISSION][FILENAME_LEN];
58
59 //where the missions go
60 #ifndef EDITOR
61 #define MISSION_DIR "missions/"
62 #else
63 #define MISSION_DIR "./"
64 #endif
65
66 //
67 //  Special versions of mission routines for shareware
68 //
69
70 int load_mission_shareware(int mission_num)
71 {
72         Current_mission_num = mission_num;
73         Current_mission_filename = Mission_list[mission_num].filename;
74         Current_mission_longname = Mission_list[mission_num].mission_name;
75
76         N_secret_levels = 0;
77
78         Last_level = 3;
79         Last_secret_level = 0;
80
81         switch (Builtin_mission_hogsize) {
82         case MAC_SHARE_MISSION_HOGSIZE:
83                 // mac demo is using the regular hog and rl2 files
84                 strcpy(Level_names[0],"d2leva-1.rl2");
85                 strcpy(Level_names[1],"d2leva-2.rl2");
86                 strcpy(Level_names[2],"d2leva-3.rl2");
87                 break;
88         default:
89                 Int3(); // fall through
90         case SHAREWARE_MISSION_HOGSIZE:
91                 strcpy(Level_names[0],"d2leva-1.sl2");
92                 strcpy(Level_names[1],"d2leva-2.sl2");
93                 strcpy(Level_names[2],"d2leva-3.sl2");
94         }
95
96         return 1;
97 }
98
99
100 //
101 //  Special versions of mission routines for Diamond/S3 version
102 //
103
104 int load_mission_oem(int mission_num)
105 {
106         Current_mission_num = mission_num;
107         Current_mission_filename = Mission_list[mission_num].filename;
108         Current_mission_longname = Mission_list[mission_num].mission_name;
109
110         N_secret_levels = 2;
111
112         Last_level = 8;
113         Last_secret_level = -2;
114
115         strcpy(Level_names[0],"d2leva-1.rl2");
116         strcpy(Level_names[1],"d2leva-2.rl2");
117         strcpy(Level_names[2],"d2leva-3.rl2");
118         strcpy(Level_names[3],"d2leva-4.rl2");
119
120         strcpy(Secret_level_names[0],"d2leva-s.rl2");
121
122         strcpy(Level_names[4],"d2levb-1.rl2");
123         strcpy(Level_names[5],"d2levb-2.rl2");
124         strcpy(Level_names[6],"d2levb-3.rl2");
125         strcpy(Level_names[7],"d2levb-4.rl2");
126
127         strcpy(Secret_level_names[1],"d2levb-s.rl2");
128
129         Secret_level_table[0] = 1;
130         Secret_level_table[1] = 5;
131
132         return 1;
133 }
134
135
136 //strips damn newline from end of line
137 char *mfgets(char *s,int n,CFILE *f)
138 {
139         char *r;
140
141         r = cfgets(s,n,f);
142         if (r && s[strlen(s)-1] == '\n')
143                 s[strlen(s)-1] = 0;
144
145         return r;
146 }
147
148 //compare a string for a token. returns true if match
149 int istok(char *buf,char *tok)
150 {
151         return strnicmp(buf,tok,strlen(tok)) == 0;
152
153 }
154
155 //adds a terminating 0 after a string at the first white space
156 void add_term(char *s)
157 {
158         while (*s && !isspace(*s)) s++;
159
160         *s = 0;         //terminate!
161 }
162
163 //returns ptr to string after '=' & white space, or NULL if no '='
164 //adds 0 after parm at first white space
165 char *get_value(char *buf)
166 {
167         char *t;
168
169         t = strchr(buf,'=')+1;
170
171         if (t) {
172                 while (*t && isspace(*t)) t++;
173
174                 if (*t)
175                         return t;
176         }
177
178         return NULL;            //error!
179 }
180
181 //reads a line, returns ptr to value of passed parm.  returns NULL if none
182 char *get_parm_value(char *parm,CFILE *f)
183 {
184         static char buf[80];
185
186         if (!mfgets(buf,80,f))
187                 return NULL;
188
189         if (istok(buf,parm))
190                 return get_value(buf);
191         else
192                 return NULL;
193 }
194
195 int ml_sort_func(mle *e0,mle *e1)
196 {
197         return stricmp(e0->mission_name,e1->mission_name);
198
199 }
200
201 extern char CDROM_dir[];
202 extern int HoardEquipped();
203
204 //returns 1 if file read ok, else 0
205 int read_mission_file(char *filename,int count,int location)
206 {
207         char filename2[100];
208         CFILE *mfile;
209
210         //printf("reading: %s\n", filename);
211
212         switch (location) {
213                 case ML_MISSIONDIR:
214                         strcpy(filename2,MISSION_DIR);
215                         break;
216
217                 case ML_CDROM:
218                         songs_stop_redbook();           //so we can read from the CD
219                         strcpy(filename2,CDROM_dir);
220                         break;
221
222                 default:
223                         Int3();         //fall through
224
225                 case ML_CURDIR:
226                         strcpy(filename2,"");
227                         break;
228         }
229         strcat(filename2,filename);
230
231         mfile = cfopen(filename2,"rb");
232
233         if (mfile) {
234                 char *p;
235                 char temp[FILENAME_LEN],*t;
236
237                 strcpy(temp,filename);
238                 if ((t = strchr(temp,'.')) == NULL)
239                         return 0;       //missing extension
240                 // look if it's .mn2 or .msn
241                 Mission_list[count].descent_version = (t[3] == '2') ? 2 : 1;
242                 *t = 0;                 //kill extension
243
244                 strncpy( Mission_list[count].filename, temp, 9 );
245                 Mission_list[count].anarchy_only_flag = 0;
246                 Mission_list[count].location = location;
247
248                 p = get_parm_value("name",mfile);
249
250                 if (!p) {               //try enhanced mission
251                         cfseek(mfile,0,SEEK_SET);
252                         p = get_parm_value("xname",mfile);
253                 }
254
255 #ifdef NETWORK
256                 if (HoardEquipped())
257                 {
258                         if (!p) {               //try super-enhanced mission!
259                                 cfseek(mfile,0,SEEK_SET);
260                                 p = get_parm_value("zname",mfile);
261                         }
262                 }
263 #endif
264
265                 if (p) {
266                         char *t;
267                         if ((t=strchr(p,';'))!=NULL)
268                                 *t=0;
269                         t = p + strlen(p)-1;
270                         while (isspace(*t)) t--;
271                         strncpy(Mission_list[count].mission_name,p,MISSION_NAME_LEN);
272                 }
273                 else {
274                         cfclose(mfile);
275                         return 0;
276                 }
277
278                 p = get_parm_value("type",mfile);
279
280                 //get mission type
281                 if (p)
282                         Mission_list[count].anarchy_only_flag = istok(p,"anarchy");
283
284                 cfclose(mfile);
285
286                 return 1;
287         }
288
289         return 0;
290 }
291
292 void add_builtin_mission_to_list(int *count)
293 {
294         Builtin_mission_hogsize = cfile_size("descent2.hog");
295         if (Builtin_mission_hogsize == -1)
296                 Builtin_mission_hogsize = cfile_size("d2demo.hog");
297
298         switch (Builtin_mission_hogsize) {
299         case SHAREWARE_MISSION_HOGSIZE:
300         case MAC_SHARE_MISSION_HOGSIZE:
301                 strcpy(Mission_list[*count].filename,SHAREWARE_MISSION_FILENAME);
302                 strcpy(Mission_list[*count].mission_name,SHAREWARE_MISSION_NAME);
303                 Mission_list[*count].anarchy_only_flag = 0;
304                 break;
305         case OEM_MISSION_HOGSIZE:
306                 strcpy(Mission_list[*count].filename,OEM_MISSION_FILENAME);
307                 strcpy(Mission_list[*count].mission_name,OEM_MISSION_NAME);
308                 Mission_list[*count].anarchy_only_flag = 0;
309                 break;
310         default:
311                 Warning("Unknown hogsize %d, trying %s\n", Builtin_mission_hogsize, FULL_MISSION_FILENAME ".mn2");
312                 Int3(); //fall through
313         case FULL_MISSION_HOGSIZE:
314                 if (!read_mission_file(FULL_MISSION_FILENAME ".mn2", 0, ML_CURDIR))
315                         Error("Could not find required mission file <%s>", FULL_MISSION_FILENAME ".mn2");
316         }
317
318         Builtin_mission_num = *count;
319         strcpy(Builtin_mission_filename, Mission_list[*count].filename);
320         ++(*count);
321 }
322
323
324 void add_missions_to_list(char *search_name, int *count, int anarchy_mode)
325 {
326         FILEFINDSTRUCT find;
327         if( !FileFindFirst( search_name, &find ) ) {
328                 do      {
329                         if (read_mission_file( find.name, *count, ML_MISSIONDIR )) {
330
331                                 if (anarchy_mode || !Mission_list[*count].anarchy_only_flag)
332                                         ++(*count);
333                         }
334
335                 } while( !FileFindNext( &find ) && *count < MAX_MISSIONS);
336                 FileFindClose();
337                 if (*count >= MAX_MISSIONS)
338                         mprintf((0, "Warning: more missions than d2x can handle\n"));
339         }
340 }
341
342 /* move <mission_name> to <place> on mission list, increment <place> */
343 void promote (char * mission_name, int * top_place, int num_missions)
344 {
345         int i;
346         char name[FILENAME_LEN], * t;
347         strcpy(name, mission_name);
348         if ((t = strchr(name,'.')) != NULL)
349                 *t = 0; //kill extension
350         //printf("promoting: %s\n", name);
351         for (i = *top_place; i < num_missions; i++)
352                 if (!stricmp(Mission_list[i].filename, name)) {
353                         //swap mission positions
354                         mle temp;
355
356                         temp = Mission_list[*top_place];
357                         Mission_list[*top_place] = Mission_list[i];
358                         Mission_list[i] = temp;
359                         ++(*top_place);
360                         break;
361                 }
362 }
363
364
365
366 //fills in the global list of missions.  Returns the number of missions
367 //in the list.  If anarchy_mode set, don't include non-anarchy levels.
368
369 extern char CDROM_dir[];
370 extern char AltHogDir[];
371 extern char AltHogdir_initialized;
372
373 int build_mission_list(int anarchy_mode)
374 {
375         static int num_missions=-1;
376         int count = 0;
377         int top_place;
378
379         //now search for levels on disk
380
381 //@@Took out this code because after this routine was called once for
382 //@@a list of single-player missions, a subsequent call for a list of
383 //@@anarchy missions would not scan again, and thus would not find the
384 //@@anarchy-only missions.  If we retain the minimum level of install,
385 //@@we may want to put the code back in, having it always scan for all
386 //@@missions, and have the code that uses it sort out the ones it wants.
387 //@@    if (num_missions != -1) {
388 //@@            if (Current_mission_num != 0)
389 //@@                    load_mission(0);                                //set built-in mission as default
390 //@@            return num_missions;
391 //@@    }
392
393         add_builtin_mission_to_list(&count);  //read built-in first
394         add_missions_to_list(MISSION_DIR "*.mn2", &count, anarchy_mode);
395         add_missions_to_list(MISSION_DIR "*.msn", &count, anarchy_mode);
396
397         if (AltHogdir_initialized) {
398                 char search_name[PATH_MAX + 5];
399                 strcpy(search_name, AltHogDir);
400                 strcat(search_name, "/" MISSION_DIR "*.mn2");
401                 add_missions_to_list(search_name, &count, anarchy_mode);
402                 strcpy(search_name, AltHogDir);
403                 strcat(search_name, "/" MISSION_DIR "*.msn");
404                 add_missions_to_list(search_name, &count, anarchy_mode);
405         }
406
407         // move original missions (in stroy-chronological order)
408         // to top of mission list
409         top_place = 0;
410         promote("descent", &top_place, count); // original descent 1 mission
411         promote(Builtin_mission_filename, &top_place, count); // d2 or d2demo
412         promote("d2x", &top_place, count); // vertigo
413
414         if (count > top_place)
415                 qsort(&Mission_list[top_place],
416                       count - top_place,
417                       sizeof(*Mission_list),
418                                 (int (*)( const void *, const void * ))ml_sort_func);
419
420
421         if (count > top_place)
422                 qsort(&Mission_list[top_place],
423                       count - top_place,
424                       sizeof(*Mission_list),
425                       (int (*)( const void *, const void * ))ml_sort_func);
426
427         //load_mission(0);   //set built-in mission as default
428
429         num_missions = count;
430
431         return count;
432 }
433
434 void init_extra_robot_movie(char *filename);
435
436 //values for built-in mission
437
438 //loads the specfied mission from the mission list.
439 //build_mission_list() must have been called.
440 //Returns true if mission loaded ok, else false.
441 int load_mission(int mission_num)
442 {
443         CFILE *mfile;
444         char buf[80], *v;
445         int found_hogfile;
446         int enhanced_mission = 0;
447
448         if (mission_num == Builtin_mission_num) {
449                 switch (Builtin_mission_hogsize) {
450                 case SHAREWARE_MISSION_HOGSIZE:
451                 case MAC_SHARE_MISSION_HOGSIZE:
452                         return load_mission_shareware(mission_num);
453                         break;
454                 case OEM_MISSION_HOGSIZE:
455                         return load_mission_oem(mission_num);
456                         break;
457                 case FULL_MISSION_HOGSIZE:
458                 default:
459                         // continue on...
460                 }
461         }
462
463         Current_mission_num = mission_num;
464
465         mprintf(( 0, "Loading mission %d\n", mission_num ));
466
467         //read mission from file
468
469         switch (Mission_list[mission_num].location) {
470         case ML_MISSIONDIR:
471                 strcpy(buf,MISSION_DIR);
472                 break;
473         case ML_CDROM:
474                 strcpy(buf,CDROM_dir);
475                 break;
476         default:
477                 Int3();                                                 //fall through
478         case ML_CURDIR:
479                 strcpy(buf,"");
480                 break;
481         }
482         strcat(buf,Mission_list[mission_num].filename);
483         if (Mission_list[mission_num].descent_version == 2)
484                 strcat(buf,".mn2");
485         else
486                 strcat(buf,".msn");
487
488         mfile = cfopen(buf,"rb");
489         if (mfile == NULL) {
490                 Current_mission_num = -1;
491                 return 0;               //error!
492         }
493
494         //for non-builtin missions, load HOG
495         if (strcmp(Mission_list[mission_num].filename, Builtin_mission_filename)) {
496
497                 strcpy(buf+strlen(buf)-4,".hog");               //change extension
498
499                 found_hogfile = cfile_use_alternate_hogfile(buf);
500
501                 #ifdef RELEASE                          //for release, require mission to be in hogfile
502                 if (! found_hogfile) {
503                         cfclose(mfile);
504                         Current_mission_num = -1;
505                         return 0;
506                 }
507                 #endif
508
509                 // for Descent 1 missions, load descent.hog
510                 if (Mission_list[mission_num].descent_version == 1 && strcmp(buf, "descent.hog"))
511                         if (!cfile_use_descent1_hogfile("descent.hog"))
512                                 Warning("descent.hog not available, this mission may be missing some files required for briefings\n");
513         }
514
515         //init vars
516         Last_level =            0;
517         Last_secret_level = 0;
518         Briefing_text_filename[0] = 0;
519         Ending_text_filename[0] = 0;
520
521         while (mfgets(buf,80,mfile)) {
522
523                 if (istok(buf,"name"))
524                         continue;                                               //already have name, go to next line
525                 if (istok(buf,"xname")) {
526                         enhanced_mission = 1;
527                         continue;                                               //already have name, go to next line
528                 }
529                 if (istok(buf,"zname")) {
530                         enhanced_mission = 2;
531                         continue;                                               //already have name, go to next line
532                 }
533                 else if (istok(buf,"type"))
534                         continue;                                               //already have name, go to next line
535                 else if (istok(buf,"hog")) {
536                         char    *bufp = buf;
537
538                         while (*(bufp++) != '=')
539                                 ;
540
541                         if (*bufp == ' ')
542                                 while (*(++bufp) == ' ')
543                                         ;
544
545                         cfile_use_alternate_hogfile(bufp);
546                         mprintf((0, "Hog file override = [%s]\n", bufp));
547                 }
548                 else if (istok(buf,"briefing")) {
549                         if ((v = get_value(buf)) != NULL) {
550                                 add_term(v);
551                                 if (strlen(v) < 13)
552                                         strcpy(Briefing_text_filename,v);
553                         }
554                 }
555                 else if (istok(buf,"ending")) {
556                         if ((v = get_value(buf)) != NULL) {
557                                 add_term(v);
558                                 if (strlen(v) < 13)
559                                         strcpy(Ending_text_filename,v);
560                         }
561                 }
562                 else if (istok(buf,"num_levels")) {
563
564                         if ((v=get_value(buf))!=NULL) {
565                                 int n_levels,i;
566
567                                 n_levels = atoi(v);
568
569                                 for (i=0;i<n_levels && mfgets(buf,80,mfile);i++) {
570
571                                         add_term(buf);
572                                         if (strlen(buf) <= 12) {
573                                                 strcpy(Level_names[i],buf);
574                                                 Last_level++;
575                                         }
576                                         else
577                                                 break;
578                                 }
579
580                         }
581                 }
582                 else if (istok(buf,"num_secrets")) {
583                         if ((v=get_value(buf))!=NULL) {
584                                 int i;
585
586                                 N_secret_levels = atoi(v);
587
588                                 Assert(N_secret_levels <= MAX_SECRET_LEVELS_PER_MISSION);
589
590                                 for (i=0;i<N_secret_levels && mfgets(buf,80,mfile);i++) {
591                                         char *t;
592
593                                         
594                                         if ((t=strchr(buf,','))!=NULL) *t++=0;
595                                         else
596                                                 break;
597
598                                         add_term(buf);
599                                         if (strlen(buf) <= 12) {
600                                                 strcpy(Secret_level_names[i],buf);
601                                                 Secret_level_table[i] = atoi(t);
602                                                 if (Secret_level_table[i]<1 || Secret_level_table[i]>Last_level)
603                                                         break;
604                                                 Last_secret_level--;
605                                         }
606                                         else
607                                                 break;
608                                 }
609
610                         }
611                 }
612
613         }
614
615         cfclose(mfile);
616
617         if (Last_level <= 0) {
618                 Current_mission_num = -1;               //no valid mission loaded
619                 return 0;
620         }
621
622         Current_mission_filename = Mission_list[Current_mission_num].filename;
623         Current_mission_longname = Mission_list[Current_mission_num].mission_name;
624
625         if (enhanced_mission) {
626                 char t[50];
627                 extern void bm_read_extra_robots();
628                 sprintf(t,"%s.ham",Current_mission_filename);
629                 bm_read_extra_robots(t,enhanced_mission);
630                 strncpy(t,Current_mission_filename,6);
631                 strcat(t,"-l.mvl");
632                 init_extra_robot_movie(t);
633         }
634
635         return 1;
636 }
637
638 //loads the named mission if exists.
639 //Returns true if mission loaded ok, else false.
640 int load_mission_by_name(char *mission_name)
641 {
642         int n,i;
643
644         n = build_mission_list(1);
645
646         for (i=0;i<n;i++)
647                 if (!stricmp(mission_name,Mission_list[i].filename))
648                         return load_mission(i);
649
650         return 0;               //couldn't find mission
651 }