Added init_sound param, fix markdown underscores.

Author: chrender

.gitignore

@@ -0,0 +1,17 @@
+.deps/
+Makefile
+Makefile.in
+aclocal.m4
+ar-lib
+autom4te.cache/
+compile
+config.log
+config.status
+configure
+depcomp
+install-sh
+libsndifsdl2.a
+missing
+.dirstamp
+*.o
+*.a

CHANGELOG.md

@@ -93,7 +93,7 @@ install-dev:: libfizmo.a
 	echo >>"$(pkgfile)"
 	echo 'Name: libfizmo' >>"$(pkgfile)"
 	echo 'Description: libfizmo' >>"$(pkgfile)"
-	echo 'Version: 0.7.15' >>"$(pkgfile)"
+	echo 'Version: 0.7.16' >>"$(pkgfile)"
 	echo "Requires: $(LIBFIZMO_REQS)" >>"$(pkgfile)"
 	echo 'Requires.private:' >>"$(pkgfile)"
 	echo 'Cflags: -I$(pkg_prefix)/include/fizmo' >>"$(pkgfile)"

Makefile.am

@@ -1,7 +1,7 @@
 
 
 
-libfizmo aims to provide a Z-Machine interpreter core library in plain C. The goal is to have an interpreter library with as little dependencies as possible to allow for easy portability. In order to use it stand-alone, you have to invoke the “fizmo_start” function in “src/interpreter/fizmo.c” with a screen interface. Check fizmo-console for an example.
+libfizmo aims to provide a Z-Machine interpreter core library in plain C. The goal is to have an interpreter library with as little dependencies as possible to allow for easy portability. In order to use it stand-alone, you have to invoke the “fizmo\_start” function in “src/interpreter/fizmo.c” with a screen interface. Check fizmo-console for an example.
 
 Currently the interpreter is in beta status, which means it seems to run all non-version-6 games quite well without any known bugs.
 

README.md

@@ -103,7 +103,7 @@ m4_include(config-flags.m4)
 
 AC_INIT(
  [libfizmo],
- [0.7.15],
+ [0.7.16],
  fizmo@spellbreaker.org,
  libfizmo)
 

configure.ac

@@ -1,5 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <changelog>
+  <change version="0.7.16">
+    <datetime day-of-week="Sun" month="2" day="10" hour="11"
+      minute="54" second="35" timezone="CET" year="2019"/>
+    <logentry>Added parameter to <tt>init_sound</tt> to simplify testing.</logentry>
+    <logentry>Fixed underscores in markdown files.</logentry>
+  </change>
+
   <change version="0.7.15">
     <datetime day-of-week="Sun" month="9" day="3" hour="21"
       minute="22" second="23" timezone="CEST" year="2017"/>

doc/changelog.xml

@@ -12,19 +12,19 @@ _2011-08-23_
 There are six initialization steps:
 
 
- - `fizmo_register_screen_interface`
- - `fizmo_register_sound_interface`
- - optional: `parse_fizmo_config_files`
- - `fizmo_start`
- - `parse_fizmo_config_files` if not happened before
- - implicit: `link_active_interface_to_story`
+ - `fizmo\_register\_screen\_interface`
+ - `fizmo\_register\_sound\_interface`
+ - optional: `parse\_fizmo\_config\_files`
+ - `fizmo\_start`
+ - `parse\_fizmo\_config\_files` if not happened before
+ - implicit: `link\_active\_interface\_to\_story`
 
 
 fizmo config files:
 
 
  - `/etc/fizmo.conf`, always parsed.
- - All `fizmo/config` files in all directories from colon-spearated `XDG_CONFIG_DIRS` path.
+ - All `fizmo/config` files in all directories from colon-spearated `XDG\_CONFIG\_DIRS` path.
  - `$HOME/.config.fizmo`
 
 
@@ -33,13 +33,13 @@ fizmo config files:
 **Color initialization**
 
 
-The screen default colors are stored in variables `default_foreground_colour` and `default_background_colour` inside `output.c`. By default, the foreground is initialized as white, the background as black. Initialization is as follows:
+The screen default colors are stored in variables `default\_foreground\_colour` and `default\_background\_colour` inside `output.c`. By default, the foreground is initialized as white, the background as black. Initialization is as follows:
 
 
  1. By default, the foreground color is set to white, the background to black in `output.c`.
- 2. The screen interface's functions `get_default_foreground_colour` and `get_default_background_colour` are evaluated. In case these return valid z_colour values, these are used as the default colors. That means that by returning -1 for one or both of the functions, the screen interface may choose not to alter the interpreter's default values.
+ 2. The screen interface's functions `get\_default\_foreground\_colour` and `get\_default\_background\_colour` are evaluated. In case these return valid z\_colour values, these are used as the default colors. That means that by returning -1 for one or both of the functions, the screen interface may choose not to alter the interpreter's default values.
  3. The `foreground-color` and `background-color` config variables are evaluated from the configuration file(s).
- 4. The `fizmo-start` function's variables `screen_default_foreground_color` and `screen_default_background_colour` are evaluated. In case these contains valid z_colour values, they're used as the new default. As in step 2, that means that the default, as evaluated up to this step, may be kept by setting one or both of the values to -1.
+ 4. The `fizmo-start` function's variables `screen\_default\_foreground\_color` and `screen\_default\_background\_colour` are evaluated. In case these contains valid z\_colour values, they're used as the new default. As in step 2, that means that the default, as evaluated up to this step, may be kept by setting one or both of the values to -1.
 
 
 Why the additional step 4? While it's already possible to read color information from the screen interface in step 2, step 4 ensures that it's possible to still override the information parsed from the config files in step 3 from the screen interface.

doc/tiny-xml-doc-tools

@@ -1297,7 +1297,7 @@ void fizmo_start(z_file* story_stream, z_file *blorb_stream,
      )
   {
     TRACE_LOG("Activating sound.\n");
-    active_sound_interface->init_sound();
+    active_sound_interface->init_sound(NULL);
   }
 
   write_interpreter_info_into_header();

libfizmo-initialization.md

@@ -43,7 +43,7 @@
 #include "../blorb_interface/blorb_interface.h"
 #include "blockbuf.h"
 
-#define LIBFIZMO_VERSION "0.7.15"
+#define LIBFIZMO_VERSION "0.7.16"
 
 #define FIZMO_INTERPRETER_NUMBER 6
 /*

src/interpreter/fizmo.c

@@ -44,7 +44,9 @@
 
 struct z_sound_interface
 {
-  void (*init_sound)();
+  // "absolute_story_file_name" only needs to be set during test cases, if
+  // it's NULL, "active_z_story->absolute_file_name" is used instead.
+  void (*init_sound)(char * absolute_story_file_name);
   void (*close_sound)();
   void (*prepare_sound)(int sound_nr, int volume, int repeats);
   void (*play_sound)(int sound_nr, int volume, int repeats, uint16_t routine);