File: vmmain.h

package info (click to toggle)
qtads 2.1.6-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 16,156 kB
  • ctags: 18,767
  • sloc: cpp: 133,078; ansic: 26,048; xml: 18; makefile: 11
file content (522 lines) | stat: -rw-r--r-- 20,679 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
/* $Header$ */

/* 
 *   Copyright (c) 1999, 2002 Michael J. Roberts.  All Rights Reserved.
 *   
 *   Please see the accompanying license file, LICENSE.TXT, for information
 *   on using and copying this software.  
 */
/*
Name
  vmmain.h - main entrypoint to run a T3 image file
Function
  
Notes
  
Modified
  10/07/99 MJRoberts  - Creation
*/

#ifndef VMMAIN_H
#define VMMAIN_H

#include "vmglob.h"

/*
 *   Parse a command line to determine the name of the game file specified by
 *   the arguments.  If we can find a game file specification, we'll fill in
 *   'buf' with the filename and return true; if there's no file name
 *   specified, we'll return false.
 *   
 *   Note that our parsing will work for TADS 2 or TADS 3 interpreter command
 *   lines, so this routine can be used to extract the filename from an
 *   ambiguous command line in order to check the file for its type and
 *   thereby resolve which interpreter to use.
 *   
 *   Note that the filename might not come directly from the command
 *   arguments, since it might be implied.  If there's no game file directly
 *   specified, but there is an explicit "-r" option to restore a saved game,
 *   we'll pull the game filename out of the saved game file if possible.
 *   Saved game files in both TADS 2 and TADS 3 can store the original game
 *   file name that was being executed at the time the game was saved.  
 */
int vm_get_game_arg(int argc, const char *const *argv,
                    char *buf, size_t buflen, int *engine_type);

/*
 *   Given a game file argument, determine which engine (TADS 2 or TADS 3)
 *   should be used to run the game.
 *   
 *   We'll first check to see if the given file exists.  If it does, we'll
 *   read header information from the file to try to identify the game.  If
 *   the file does not exist, we will proceed to check default suffixes, if
 *   the suffix arguments are non-null.
 *   
 *   If defexts is not null, it gives an array of default filename suffix
 *   strings, suitable for use with os_defext().  When the name as given
 *   doesn't refer to an existing file, we'll try looking for files with
 *   these suffixes, one at a time.
 *   
 *   Returns one of the VM_GGT_xxx codes.
 *   
 *   If the return value is 2 or 3, we'll fill in the actual_filename buffer
 *   with the full name of the file; if we added a default suffix, the
 *   suffix will be included in this result.  
 */
int vm_get_game_type(const char *filename,
                     char *actual_filename,
                     size_t actual_filename_buffer_length,
                     const char *const *defexts, size_t defext_count);

/*
 *   Returns codes for vm_get_game_type() 
 */

/* game type is TADS 2 */
#define VM_GGT_TADS2          2

/* game type is TADS 3 */
#define VM_GGT_TADS3          3

/* game file not found (even after trying default extensions) */
#define VM_GGT_NOT_FOUND    (-1)

/* game file exists but isn't a valid tads 2 or tads 3 game */
#define VM_GGT_INVALID      (-2)

/* 
 *   ambiguous filename - the exact filename doesn't exist, and more than
 *   one default suffix version exists 
 */
#define VM_GGT_AMBIG        (-3)

/* 
 *   determine if a VM_GGT_xxx code refers to a valid engine version:
 *   returns true if the code is an engine version, false if the code is an
 *   error indication 
 */
#define vm_ggt_is_valid(code) ((code) > 0)


/*
 *   Parameters structure for vm_run_image.  vm_run_image() essentially takes
 *   the parsed version of the execution parameters, and loads and executes
 *   the .t3 file accordingly.  The caller is responsible for parsing the
 *   command-line arguments or equivalent.  You can use vm_run_image_main()
 *   if you have a standard Unix-style argv/argc and want to do the standard
 *   t3run parsing.  If you don't have a standard argv/argc (e.g., you get
 *   your parameters from a GUI dialog, an external config file), you can
 *   bypass the normal t3run argv parsing by setting up this structure from
 *   your parameters and calling vm_run_image().  You can also use this
 *   approach if you want override the standard t3run option syntax and do
 *   your own argv parsing.
 */
struct vm_run_image_params
{
    vm_run_image_params(class CVmMainClientIfc *clientifc,
                        class CVmHostIfc *hostifc,
                        const char *image_file_name)
    {
        /* set the required parameters */
        this->clientifc = clientifc;
        this->hostifc = hostifc;
        this->image_file_name = image_file_name;

        /* assume no program arguments */
        prog_argv = 0;
        prog_argc = 0;

        /* assume no script or log files */
        script_file = 0;
        log_file = 0;
        cmd_log_file = 0;
        script_quiet = FALSE;

        /* assume we'll use [More] mode for interactive output */
        more_mode = TRUE;

        /* assume we're loading from a separate .t3 file */
        load_from_exe = FALSE;

        /* assume we won't show the VM banner */
        show_banner = FALSE;

        /* assume we will seed the RNG */
        seed_rand = TRUE;

        /* use the default character sets from the system */
        charset = 0;
        log_charset = 0;

        /* assume we're not loading a saved state file */
        saved_state = 0;

        /* use default directories */
        res_dir = 0;
        file_dir = 0;
        sandbox_dir = 0;

        /* assume no network configuration */
        netconfig = 0;
    }
    
    /* 
     *   the client interface - this lets the host application environment
     *   provide a custom implementation of the main console interface for
     *   the game 
     */
    class CVmMainClientIfc *clientifc;

    /* 
     *   the host interface - this lets the host application environment
     *   customize certain preference settings and data sources 
     */
    class CVmHostIfc *hostifc;

    /* the image file name */
    const char *image_file_name;

    /* 
     *   The program command-line parameters - these are argv-style parameter
     *   strings to pass to the .t3 program's main().  (Note that these
     *   aren't the arguments to the interpreter - that's what this entire
     *   structure is about, as it contains the pre-digested results of
     *   parsing those parameters.  These are instead unparsed parameters
     *   that we're to pass along to the .t3 program.)
     */
    const char *const *prog_argv;
    int prog_argc;

    /* 
     *   The input script file.  If this is not null, the interpreter will
     *   read console input from the given file and feed it to the .t3
     *   program via inputLine(), etc.  If script_quiet is true, we'll read
     *   this input silently, without echoing it or program output to the
     *   console for the duration of the script input.
     */
    const char *script_file;
    int script_quiet;

    /*
     *   The log file.  If this is not null, we'll log console output to the
     *   given file. 
     */
    const char *log_file;

    /*
     *   Command log file.  If this is not null, we'll log input lines read
     *   from the console to this file.
     */
    const char *cmd_log_file;

    /* 
     *   In [More] mode, we pause and await a keystroke after each screenful
     *   of text to give the user a chance to read text before it scrolls off
     *   the screen.  This is the default, but sometimes users will want to
     *   run in batch/stdio mode, where there's no pausing.
     */
    int more_mode;

    /*
     *   Flag: load from the application executable file.  If this is true,
     *   the given image filename is actually the name of the native
     *   application executable file that we're running (i.e., the main
     *   program's argv[0] or equivalent), and it contains an embedded or
     *   attached copy of the .t3 file, embedded via some OS-specific
     *   mechanism. 
     */
    int load_from_exe;

    /* flag: show the VM version/copyright banner at startup */
    int show_banner;

    /* 
     *   flag: seed the random number generator automatically at startup;
     *   this uses some OS-specific source of true randomness to generate an
     *   initial random state for the RNG 
     */
    int seed_rand;

    /*
     *   Character set name for the main console.  If this is not null, we'll
     *   use this charater set for text displayed to and read from the
     *   interactive console. 
     */
    const char *charset;

    /* log file character set (if not null) */
    const char *log_charset;

    /* 
     *   Saved state file to restore on startup.  If this is not null, we'll
     *   restore this saved state file immediately after loading the .t3
     *   file. 
     */
    const char *saved_state;

    /* resource directory */
    const char *res_dir;

    /* 
     *   Default working directory for File operations.  If this is not null,
     *   the File class will use this as the working directory for file
     *   operations when file names are given as relative paths.  If this is
     *   null, the folder containing the .t3 file is the default.
     */
    const char *file_dir;

    /*
     *   Sandbox directory for file safety enforcement.  If this is not null,
     *   the File class uses this as the sandbox directory for file safety
     *   purposes.  If this is null, the default sandbox is the file_dir if
     *   specified, otherwise the folder containing the .t3 file.
     */
    const char *sandbox_dir;

    /*
     *   Network configuration object.  If not null, we're running in web
     *   host mode, with the network parameters specified in this object.
     */
    class TadsNetConfig *netconfig;
};

/*
 *   Execute an image file.  We'll return zero on success, or a VM error code
 *   on failure.
 *   
 *   If 'load_from_exe' is true, the image filename given is actually the
 *   name of the native executable file that we're running, and we should
 *   load the image file that's attached to the native executable file via
 *   the system-specific os_exeseek() mechanism.
 *   
 *   If 'script_file' is not null, we'll read console input from the given
 *   file.  If 'log_file' is not null, we'll log console output to the given
 *   file.  If 'cmd_log_file' is not null, we'll log each line we read from
 *   the console to the given command logging file.  
 *   
 *   'charset' optionally selects a character set to use for text displayed
 *   to or read from the user interface.  If this is null, we'll use the
 *   current system character set as indicated by the osifc layer.  'charset'
 *   should usually be null unless explicitly specified by the user.  
 */
int vm_run_image(const vm_run_image_params *params);


/*
 *   Execute an image file using argc/argv conventions.  We'll parse the
 *   command line and invoke the program.
 *   
 *   The 'executable_name' is the name of the host program; this is used to
 *   prepare "usage" messages.
 *   
 *   If 'defext' is true, we'll try adding a default extension ("t3",
 *   formerly "t3x") to the name of the image file we find if the given
 *   filename doesn't exist.  We'll always check to see if the file exists
 *   with the exact given name before we do this, so that we don't add an
 *   extension where none is needed.  If the caller doesn't want us to try
 *   adding an extension at all, pass in 'defext' as false.
 *   
 *   If 'test_mode' is true, we'll make some small changes to the program
 *   invocation protocol appropriate to running system tests.  In
 *   particular, we'll build the program argument list with only the root
 *   name of the image file, not the full path - this allows the program to
 *   display the argument list without any dependencies on local path name
 *   conventions or the local directory structure, allowing for more easily
 *   portable test scripts.
 *   
 *   If 'hostifc' is null, we'll provide our own default interface.  The
 *   caller can provide a custom host interface by passing in a non-null
 *   'hostifc' value.  
 */
int vm_run_image_main(class CVmMainClientIfc *clientifc,
                      const char *executable_name,
                      int argc, char **argv,
                      int defext, int test_mode,
                      class CVmHostIfc *hostifc);

/*
 *   Show the interface report.  This writes an XML listing of the
 *   metaclasses and intrinsic function sets to the standard output.  
 */
void vm_interface_report(class CVmMainClientIfc *cli, const char *fname);

/*
 *   Get the IFID from the GameInfo resource.  This looks for the
 *   gameinfo.txt resource in the image file or resource directory, then
 *   scans the contents for its IFID field.  If we find an IFID, we return an
 *   allocated buffer containing the IFID string (or the first IFID string,
 *   if the GameInfo contains multiple IFIDs); otherwise we return null.  The
 *   caller is responsible for freeing the returned buffer with
 *   lib_free_str().
 *   
 *   Note that the host interface's resource map for the image file is
 *   generally initialized when the image file is loaded, so this routine
 *   must be called AFTER the image file has been loaded through the regular
 *   loader.  If you want a more general-purpose GameInfo extractor that
 *   doesn't rely on the interpreter's image loader, you should use the Babel
 *   API tools, which parse the image file directly.  This routine is
 *   intended as a lightweight alternative to the Babel tools for use in the
 *   interpreter, where we're certainly already going to invoke the full
 *   image loader anyway.  
 */
char *vm_get_ifid(class CVmHostIfc *hostifc);


/* ------------------------------------------------------------------------ */
/*
 *   VM Main client services interface.  Callers of the vm_run_image
 *   functions must provide an implementation of this interface. 
 */
class CVmMainClientIfc
{
public:
    virtual ~CVmMainClientIfc() { }

    /* 
     *   Set "plain" mode.  This should set the console to plain ASCII output
     *   mode, if appropriate.  Note that this can be called before
     *   client_init(), and no globals are generally present at this point.
     *   
     *   In most cases, this can make a call to os_plain() to set the
     *   OS-level console to plain mode.  Non-console applications generally
     *   need not do anything here at all.  
     */
    virtual void set_plain_mode() = 0;

    /*
     *   Create the main system console, if desired.  This is called during
     *   VM initialization, so it is called prior to client_init().  Returns
     *   the main console object, if desired.  If no main console is desired
     *   for this application, return null.  
     */
    virtual class CVmConsoleMain *create_console(
        struct vm_globals *globals) = 0;

    /*
     *   Delete the console, if we created one.  This is called during VM
     *   termination, so it's called after client_terminate().  If
     *   create_console() doesn't create a console, this routine need do
     *   nothing.  
     */
    virtual void delete_console(struct vm_globals *globals,
                                class CVmConsoleMain *console) = 0;

    /* 
     *   Initialization - we'll invoke this immediately after initializing
     *   the VM (via vm_initialize), so the client can perform any global
     *   initialization desired.  The globals are valid at this point because
     *   we have completed VM initialization.
     *   
     *   If script_file is non-null, it gives the name of a file to use as
     *   the source of console input.  The client implementation should set
     *   up accordingly; if the standard console (G_console) is being used,
     *   the client can simply use G_console->open_script_file() to set up
     *   scripting.
     *   
     *   If log_file is non-null, it gives the name of a file to use to log
     *   console output.  The client shoudl set up logging; if the standard
     *   console if being used, G_console->open_log_file() will do the trick.
     *   
     *   If cmd_log_file is non-null, it gives the name of a file to use to
     *   log commands read from the input (i.e., only command input should be
     *   logged, not other console output).  If the standard console is being
     *   used, G_console->open_command_log() will set things up properly.
     *   
     *   If banner_str is non-null, it gives a VM banner string that should
     *   be displayed to the user.  If the standard console is being used,
     *   this can be displayed using G_console->format_text().
     *   
     *   The parameters (script_file, log_file, cmd_log_file, and the
     *   presence or absence of banner_str) are taken from the startup
     *   parameters.  For a command-line version, for example, these come
     *   from command line options.  So, these are necessarily passed down in
     *   some form from the client to begin with; so a client that never
     *   passes these to vm_run_image() or vm_run_image_main() doesn't need
     *   to handle these parameters at all here.  
     */
    virtual void client_init(struct vm_globals *globals,
                             const char *script_file, int script_quiet,
                             const char *log_file,
                             const char *cmd_log_file,
                             const char *banner_str,
                             int more_mode) = 0;

    /*
     *   Termination - we'll invoke this immediately before terminating the
     *   VM (via vm_terminate).  Globals are still valid at this point, but
     *   will be destroyed after this returns. 
     */
    virtual void client_terminate(struct vm_globals *globals) = 0;
    
    /* 
     *   pre-execution notification - we'll invoke this function just before
     *   starting execution in the loaded image 
     */
    virtual void pre_exec(struct vm_globals *globals) = 0;

    /* 
     *   terminate - we'll invoke this just after execution in the loaded
     *   image terminates 
     */
    virtual void post_exec(struct vm_globals *globals) = 0;

    /* 
     *   Terminate with error - we'll invoke this upon catching an
     *   exception that the image file doesn't handle and which thus
     *   terminates execution.  Note that if this is called, post_exec()
     *   will not be called; however, if post_exec() itself throws an
     *   exception, we'll invoke this routine.  
     */
    virtual void post_exec_err(struct vm_globals *globals) = 0;

    /* 
     *   Display an error message.  We'll call this with a complete error
     *   message to display.  Note that we won't add a newline at the end of
     *   the message, so if the message is to be displayed on a stdio-style
     *   terminal, this routine should display a newline after the message.
     *   
     *   If the implementation normally writes the text to the main output
     *   console (G_console), it must take into the account the possibility
     *   that we have not opened a system console at all (i.e., G_console
     *   could be null), or have not allocated any globals at all (i.e.,
     *   'globals' could be null).
     *   
     *   If 'add_blank_line' is true, the implementation should add a blank
     *   line after the error, if appropriate for the display device.  If
     *   we're displaying the message in an alert box on a GUI, for example,
     *   this can be ignored.
     */
    virtual void display_error(struct vm_globals *globals,
                               const struct CVmException *exc,
                               const char *msg, int add_blank_line) = 0;
};

/* ------------------------------------------------------------------------ */
/*
 *   Very basic client interface implementation using stdio 
 */
class CVmMainClientIfcStdio: public CVmMainClientIfc
{
public:
    virtual void set_plain_mode() { }
    virtual class CVmConsoleMain *create_console(struct vm_globals *)
        { return 0; }
    virtual void delete_console(struct vm_globals *, class CVmConsoleMain *) { }
    virtual void client_init(struct vm_globals *, const char *, int,
                             const char *, const char *, const char *, int) { }
    virtual void client_terminate(struct vm_globals *) { }
    virtual void pre_exec(struct vm_globals *) { }
    virtual void post_exec(struct vm_globals *) { }
    virtual void post_exec_err(struct vm_globals *) { }

    virtual void display_error(struct vm_globals *,
                               const struct CVmException *,
                               const char *msg, int add_blank_line)
    {
        printf(add_blank_line ? "%s\n" : "%s", msg);
    }
};


#endif /* VMMAIN_H */