Start test frontend

Doxyfile

@@ -0,0 +1,93 @@
+# Licar Doxyfile (a configuration for automatic docs generator Doxygen)
+
+PROJECT_NAME               = "Licar"
+DOXYFILE_ENCODING          = UTF-8
+INPUT_ENCODING             = UTF-8
+PROJECT_BRIEF              = "racing game"
+PROJECT_LOGO               = ./media/logo.png
+OUTPUT_DIRECTORY           = ./doc
+CREATE_SUBDIRS             = NO
+ALLOW_UNICODE_NAMES        = NO
+OUTPUT_LANGUAGE            = English
+OPTIMIZE_OUTPUT_JAVA       = NO
+OPTIMIZE_FOR_FORTRAN       = NO
+OPTIMIZE_OUTPUT_VHDL       = NO
+OPTIMIZE_OUTPUT_FOR_C      = YES
+HTML_OUTPUT                = html
+HTML_FILE_EXTENSION        = .html
+HTML_COLORSTYLE_HUE        = 220
+HTML_COLORSTYLE_SAT        = 100
+HTML_COLORSTYLE_GAMMA      = 80
+HTML_TIMESTAMP             = YES
+HTML_DYNAMIC_SECTIONS      = NO
+HTML_INDEX_NUM_ENTRIES     = 100
+GENERATE_HTML              = YES
+GENERATE_DOCSET            = NO
+GENERATE_LATEX             = NO
+GENERATE_AUTOGEN_DEF       = NO
+GENERATE_HTMLHELP          = NO
+GENERATE_CHI               = NO
+BRIEF_MEMBER_DESC          = YES
+REPEAT_BRIEF               = YES
+FULL_PATH_NAMES            = YES
+INHERIT_DOCS               = YES
+SEPARATE_MEMBER_PAGES      = NO
+TAB_SIZE                   = 4
+MARKDOWN_SUPPORT           = YES
+SUBGROUPING                = YES
+TYPEDEF_HIDES_STRUCT       = NO
+HIDE_UNDOC_MEMBERS         = NO
+HIDE_UNDOC_CLASSES         = NO
+INTERNAL_DOCS              = NO
+CASE_SENSE_NAMES           = YES
+HIDE_SCOPE_NAMES           = NO
+HIDE_COMPOUND_REFERENCE    = NO
+SHOW_INCLUDE_FILES         = YES
+INLINE_INFO                = YES
+SORT_MEMBER_DOCS           = YES
+SHOW_USED_FILES            = YES
+SHOW_FILES                 = YES
+SHOW_NAMESPACES            = YES
+QUIET                      = NO
+WARNINGS                   = YES
+WARN_IF_UNDOCUMENTED       = YES
+WARN_IF_DOC_ERROR          = YES
+EXTRACT_ALL                = YES
+EXTRACT_PACKAGE            = NO
+EXTRACT_PRIVATE            = YES
+EXTRACT_LOCAL_CLASSES      = YES
+EXTRACT_LOCAL_METHODS      = NO
+EXTRACT_STATIC             = YES
+EXTRACT_ANON_NSPACES       = NO
+RECURSIVE                  = NO
+EXCLUDE_SYMLINKS           = NO
+EXAMPLE_RECURSIVE          = NO
+FILTER_SOURCE_FILES        = NO
+SOURCE_BROWSER             = NO
+INLINE_SOURCES             = NO
+STRIP_CODE_COMMENTS        = YES
+REFERENCED_BY_RELATION     = NO
+REFERENCES_RELATION        = NO
+REFERENCES_LINK_SOURCE     = YES
+SOURCE_TOOLTIPS            = YES
+USE_HTAGS                  = NO
+VERBATIM_HEADERS           = YES
+CLANG_ASSISTED_PARSING     = NO
+ALPHABETICAL_INDEX         = YES
+COLS_IN_ALPHA_INDEX        = 5
+BINARY_TOC                 = NO
+TOC_EXPAND                 = NO
+DISABLE_INDEX              = NO
+ENUM_VALUES_PER_LINE       = 4
+EXT_LINKS_IN_WINDOW        = NO
+SEARCHENGINE               = YES
+SEARCHDATA_FILE            = searchdata.xml
+ENABLE_PREPROCESSING       = YES
+MACRO_EXPANSION            = NO
+EXPAND_ONLY_PREDEF         = NO
+SEARCH_INCLUDES            = YES
+SKIP_FUNCTION_MACROS       = NO
+ALLEXTERNALS               = NO
+EXTERNAL_GROUPS            = YES
+EXTERNAL_PAGES             = YES
+HAVE_DOT                   = NO

README.md

@@ -8,7 +8,7 @@ The following is a draft of readme that will eventually be published, it may con
 
 *free and selfless KISS racing game*
 
-![](assets/logo.png)
+![](media/logo.png)
 
 For more detail see also the [game manual](media/manual.txt).
 

TODO.txt

@@ -34,13 +34,13 @@ fuck issue trackers :D
   - empty and large data file
   - FPS on each platform
   - try to use the racing module by itself
-  - doxygen documentation
 
 =========== BUGS =================
 
 =========== HANDLED ==============
 
 - should drifting make a sound? NO NEED
+- doxygen documentation
 - immediately after starting the map countdown seems to be lower (seems to
   perhaps be caused by nextPhysicsFrameTime, look into it)
 - hitting ramps at higher speed still often bugs, try to fiddle with physics

frontend_csfml.c

@@ -1,4 +1,4 @@
-/**
+/** @file frontend_csfml.c
   CSFML frontend for Licar.
 */
 

frontend_saf.c

@@ -1,4 +1,4 @@
-/*
+/** @file frontend_saf.c
   SAF frontend for Licar.
 */
 

frontend_sdl.c

@@ -1,4 +1,4 @@
-/**
+/** @file frontend_sdl.c
   SDL2 frontend for Licar.
 */
 

frontend_test.c

@@ -0,0 +1,39 @@
+/** @file frontend_test.c
+  Licar automatic test frontend. This is a pure C program that internally tries
+  to play the game and checks if everything looks as expected.
+*/
+
+#include <stdio.h>
+#include "game.h"
+
+// TODO
+
+char LCR_getNextDataFileChar(void)
+{
+  return 0;
+}
+
+void LCR_appendDataStr(const char *str)
+{
+}
+
+uint8_t LCR_keyPressed(uint8_t key)
+{
+  return 0;
+}
+
+void LCR_sleep(uint16_t timeMs)
+{
+}
+
+void LCR_drawPixel(unsigned long index, uint16_t color)
+{
+}
+
+int main(void)
+{
+  puts("testing Licar");
+  // TODO
+  puts("done");
+  return 0;
+}

game.h

@@ -52,6 +52,8 @@
   format (described in the map module) etc.
 */
 
+#include <stdint.h>
+
 #define LCR_KEY_UP     0x00
 #define LCR_KEY_RIGHT  0x01
 #define LCR_KEY_DOWN   0x02

make.sh

@@ -47,6 +47,10 @@ elif [ $PLATFORM = "saf" ]; then
 
   SDL_FLAGS=`sdl2-config --cflags --libs`
   COMMAND="${COMPILER} ${C_FLAGS} frontend_saf.c -lcsfml-graphics -I/use/local/include ${SDL_FLAGS}"
+elif [ $PLATFORM = "test" ]; then
+  # autotest build
+
+  COMMAND="${COMPILER} ${C_FLAGS} frontend_test.c"
 elif [ $PLATFORM = "emscripten" ]; then
   # emscripten (browser Javascript) build, requires:
   # - emscripten