Rtch/Lephisto
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Add] Preliminary doxygen support.

Browse Source
This commit is contained in:
Allanis 2013-08-31 14:19:36 +01:00
parent de91ebd91f
commit ca4c910ec8
4 changed files with 208 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
bin/Makefile
View File

@ -62,6 +62,8 @@ DATA = data
DATAFILES = $(VERSIONFILE) $(DATA_AI) $(DATA_GFX) $(DATA_XML) $(DATA_SND) $(DATA_MISN) DATAFILES = $(VERSIONFILE) $(DATA_AI) $(DATA_GFX) $(DATA_XML) $(DATA_SND) $(DATA_MISN)
# TARGETS. # TARGETS.
.PHONY: all lua pack mkspr data utils docs clean purge
%.o: %.c %.h %.o: %.c %.h
@$(CC) -c $(CFLAGS) -o $@ $< @$(CC) -c $(CFLAGS) -o $@ $<
@echo -e "\tCC $@" @echo -e "\tCC $@"
@ -89,10 +91,17 @@ data: pack $(DATAFILES) ../src/pack.c ../utils/pack/main.c
utils: mksprite utils: mksprite
docs:
@(cd docs/doxygen; doxygen)
clean: clean:
@echo -e "\tRemoving data.." @echo -e "\tRemoving data"
rm -rf $(OBJS) $(APPNAME) $(DATA) pack core mksprite *.out a.txt @rm -f $(DATA)
@echo -e "\tCleaning utils." @echo -e "\tRemoving object files"
@rm -f $(OBJS)
purge: clean
@echo -e "\tCleaning utilites"
@(cd ../utils/pack; $(MAKE) clean) @(cd ../utils/pack; $(MAKE) clean)
@(cd ../utils/mkspr; $(MAKE) clean) @(cd ../utils/mkspr; $(MAKE) clean)
@echo -e "\tCleaning Lua" @echo -e "\tCleaning Lua"

110
src/ai.c
View File

@ -20,7 +20,12 @@
#include "lluadef.h" #include "lluadef.h"
#include "ai.h" #include "ai.h"
/* == AI ====================================================== /**
* @file ai.c
*
* @brief Controls the Pilot AI.
*
* == AI ======================================================
* *
* -- Goal (Task) based AI with additional optimization. * -- Goal (Task) based AI with additional optimization.
* AI uses the goal (task) based AI approach with tasks scripted * AI uses the goal (task) based AI approach with tasks scripted
@ -51,24 +56,28 @@
* (task). * (task).
*/ */
/* Register a number constant n to name s (syntax is just like lua_regfunc). */ /**
* @def lua_regnumber(l, s, n)
*
* @brief Register a number constant n to name s (syntax is just like lua_regfunc).
*/
#define lua_regnumber(l,s,n) (lua_pushnumber(l,n), lua_setglobal(l,s)) #define lua_regnumber(l,s,n) (lua_pushnumber(l,n), lua_setglobal(l,s))
/* Ai flags. */ /* Ai flags. */
#define ai_setFlag(f) (pilot_flags |= f) #define ai_setFlag(f) (pilot_flags |= f) /**< Set pilot flag f */
#define ai_isFlag(f) (pilot_flags & f) #define ai_isFlag(f) (pilot_flags & f) /**< Check pilot flag f */
/* Flags. */ /* Flags. */
#define AI_PRIMARY (1<<0) /* Firing primary weapon. */ #define AI_PRIMARY (1<<0) /**< Firing primary weapon. */
#define AI_SECONDARY (1<<1) /* Firing secondary weapon. */ #define AI_SECONDARY (1<<1) /**< Firing secondary weapon. */
/* file info. */ /* file info. */
#define AI_PREFIX "../scripts/ai/" #define AI_PREFIX "../scripts/ai/" /**< AI file prefix. */
#define AI_SUFFIX ".lua" #define AI_SUFFIX ".lua" /**< AI file suffix. */
#define AI_INCLUDE "include/" #define AI_INCLUDE "include/" /**< Where to search for includes. */
/* AI profiles. */ /* AI profiles. */
static AI_Profile* profiles = NULL; static AI_Profile* profiles = NULL; /**< Array of AI_Profiles loaded. */
static int nprofiles = 0; static int nprofiles = 0; /**< Number of AI_Profiles loaded. */
/* Extern pilot hacks. */ /* Extern pilot hacks. */
extern Pilot** pilot_stack; extern Pilot** pilot_stack;
@ -211,11 +220,18 @@ static int pilot_flags = 0;
static int pilot_target = 0; static int pilot_target = 0;
/* Ai status: 'Create' functions that can't be used elsewhere. */ /* Ai status: 'Create' functions that can't be used elsewhere. */
#define AI_STATUS_NORMAL 1 #define AI_STATUS_NORMAL 1 /**< Normal AI function behaviour. */
#define AI_STATUS_CREATE 2 #define AI_STATUS_CREATE 2 /**< AI is running create function. */
static int ai_status = AI_STATUS_NORMAL; static int ai_status = AI_STATUS_NORMAL;
/* Attempt to run a function. */ /**
* @fn static void ai_run(lua_State* L, const char* funcname)
*
* @brief Attemps to run a function.
*
* @param[in] L Lua state to run function on.
* @param[in] funcname Function to run.
*/
static void ai_run(lua_State* L, const char* funcname) { static void ai_run(lua_State* L, const char* funcname) {
lua_getglobal(L, funcname); lua_getglobal(L, funcname);
if(lua_pcall(L, 0, 0, 0)) if(lua_pcall(L, 0, 0, 0))
@ -224,13 +240,25 @@ static void ai_run(lua_State* L, const char* funcname) {
cur_pilot->name, funcname, lua_tostring(L,-1)); cur_pilot->name, funcname, lua_tostring(L,-1));
} }
/* Destroy the AI part of the pilot. */ /**
* @fn void ai_destroy(Pilot* p)
*
* @brief Destroys the ai part of the pilot.
*
* @param[in] p Pilot to destroy it's AI part.
*/
void ai_destroy(Pilot* p) { void ai_destroy(Pilot* p) {
if(p->task) if(p->task)
ai_freetask(p->task); ai_freetask(p->task);
} }
/* Init the AI stuff. Which is basically Lua. */ /**
* @fn int ai_init(void)
*
* @brief Initializes the AI stuff which is basically Lua.
*
* @return 0 on no errors.
*/
int ai_init(void) { int ai_init(void) {
char** files; char** files;
uint32_t nfiles, i; uint32_t nfiles, i;
@ -258,7 +286,14 @@ int ai_init(void) {
return 0; return 0;
} }
/* Init an IA_Profile and add it to the stack. */ /**
* @fn static int ai_loadProfile(char* filename)
*
* @brief Initializes an AI_Profile and adds it to the stack.
*
* @param[in] filename File to create the profile from.
* @return 0 on no error.
*/
static int ai_loadProfile(char* filename) { static int ai_loadProfile(char* filename) {
char* buf = NULL; char* buf = NULL;
uint32_t bufsize = 0; uint32_t bufsize = 0;
@ -308,7 +343,13 @@ static int ai_loadProfile(char* filename) {
return 0; return 0;
} }
/* Get the AI_Profile with name. */ /* @fn AI_Profile* ai_getProfile(char* name)
*
* @brief Get the AI_Profile by name.
*
* @param[in] name Name of the profile to get.
* @return The profile or NULL on error.
*/
AI_Profile* ai_getProfile(char* name) { AI_Profile* ai_getProfile(char* name) {
if(profiles == NULL) return NULL; if(profiles == NULL) return NULL;
@ -321,7 +362,11 @@ AI_Profile* ai_getProfile(char* name) {
return NULL; return NULL;
} }
/* Clean up global AI */ /**
* @fn void ai_exit(void)
*
* @brief Clean up the gloabl AI.
*/
void ai_exit(void) { void ai_exit(void) {
int i; int i;
for(i = 0; i < nprofiles; i++) { for(i = 0; i < nprofiles; i++) {
@ -331,7 +376,13 @@ void ai_exit(void) {
free(profiles); free(profiles);
} }
/* Heart of hearts of the ai!! Brains of the pilot. */ /**
* @fn void ai_think(Pilot* pilot)
*
* @brief Heart of the AI, brains of the pilot.
*
* @param pilot Pilot that needs to think.
*/
void ai_think(Pilot* pilot) { void ai_think(Pilot* pilot) {
lua_State* L; lua_State* L;
@ -370,7 +421,14 @@ void ai_think(Pilot* pilot) {
if(ai_isFlag(AI_SECONDARY)) pilot_shoot(pilot, pilot_target, 1); /* Secondary. */ if(ai_isFlag(AI_SECONDARY)) pilot_shoot(pilot, pilot_target, 1); /* Secondary. */
} }
/* Pilot is attacked. */ /**
* @fn void ai_attacked(Pilot* attacked, const unsigned int attacker)
*
* @brief Trigger the attacked() function in the Pilots AI.
*
* @param attacked Pilot that is attacked.
* @param[in] attacker ID of the attacker.
*/
void ai_attacked(Pilot* attacked, const unsigned int attacker) { void ai_attacked(Pilot* attacked, const unsigned int attacker) {
lua_State* L; lua_State* L;
@ -382,7 +440,15 @@ void ai_attacked(Pilot* attacked, const unsigned int attacker) {
WARN("Pilot '%s' ai -> 'attacked' : %s", cur_pilot->name, lua_tostring(L, -1)); WARN("Pilot '%s' ai -> 'attacked' : %s", cur_pilot->name, lua_tostring(L, -1));
} }
/* Pilot was just created. */ /**
* @fn void ai_create(Pilot* pilot)
*
* @brief Run the create() function in the pilot.
*
* Should create all the gear and such the pilot has.
*
* @param pilot Pilot to "create".
*/
void ai_create(Pilot* pilot) { void ai_create(Pilot* pilot) {
lua_State* L; lua_State* L;

121
src/lephisto.c
View File

@ -1,3 +1,14 @@
/**
* @mainpage LEPHISTO
*
* Doxygen documentation for the Lephisto project. (c) SaraCraft.
*/
/**
* @file lephisto.c
*
* @brief Control the overall game flow: data loading/unloading and game loop.
*/
#include <SDL.h> #include <SDL.h>
#include <string.h> #include <string.h>
@ -34,30 +45,29 @@
#include "nebulae.h" #include "nebulae.h"
#define XML_START_ID "Start" #define XML_START_ID "Start" /**< XML document tag of module start file. */
#define START_DATA "../dat/start.xml" #define START_DATA "../dat/start.xml" /**< Path to module start file. */
#define CONF_FILE "conf" #define CONF_FILE "conf" /**< Configuration file by default. */
#define VERSION_FILE "VERSION" #define VERSION_FILE "VERSION" /**< Version file by default. */
#define VERSION_LEN 10 #define VERSION_LEN 10 /**< Max length of the version file. */
#define MINIMUM_FPS 0.5 #define FONT_SIZE 12 /**< Normal font size. */
#define FONT_SIZE 12 #define FONT_SIZE_SMALL 10 /**< Small font size. */
#define FONT_SIZE_SMALL 10
#define LEPHISTO_INIT_DELAY 3000 /* Minimum amount of time to wait with loading screen. */ #define LEPHISTO_INIT_DELAY 3000 /**< Minimum amount of time to wait with loading screen. */
static int quit = 0; /* Primary loop. */ static int quit = 0; /**< For primary loop. */
unsigned int gtime = 0; /* Calculate FPS and movement. */ unsigned int time = 0; /**< USed to calculate FPS and movement, in pause.c */
static char version[VERSION_LEN]; static char version[VERSION_LEN];
/* Just some default crap. */ /* Just some default crap. */
char* data = NULL; char* data = NULL; /**< Path to datafile. */
char dataname[DATA_NAME_LEN] = ""; char dataname[DATA_NAME_LEN] = ""; /**< Name of data file. */
int nosound = 0; int nosound = 0; /**< Disable sound when loaded. */
int show_fps = 1; /* Default - True. */ int show_fps = 1; /**< Shows fps - default true. */
int max_fps = 0; int max_fps = 0; /**< Default FPS limit, 0 is no limit. */
int indjoystick = -1; int indjoystick = -1; /**< Index of joystick to use, -1 is none. */
char* namjoystick = NULL; char* namjoystick = NULL; /**< Name of joystick to use, NULL is none. */
/* Prototypes. */ /* Prototypes. */
static void print_SDLversion(void); static void print_SDLversion(void);
@ -76,7 +86,10 @@ static void render_all(void);
/** /**
* @fn int main(int argc, char** argv)
*
* @brief The entry point of Lephisto. * @brief The entry point of Lephisto.
*
* @param[in] argc Number of arguments. * @param[in] argc Number of arguments.
* @param[in] argv Array of argc arguments. * @param[in] argv Array of argc arguments.
* @return EXIT_SUCCESS on success. * @return EXIT_SUCCESS on success.
@ -132,7 +145,7 @@ int main(int argc, char** argv) {
} }
window_caption(); window_caption();
load_screen(); load_screen();
gtime = SDL_GetTicks(); time = SDL_GetTicks();
/* OpenAL sound. */ /* OpenAL sound. */
if(nosound) { if(nosound) {
@ -185,9 +198,9 @@ int main(int argc, char** argv) {
menu_main(); menu_main();
/* Force a minimum delay with loading screen. */ /* Force a minimum delay with loading screen. */
if((SDL_GetTicks() - gtime) < LEPHISTO_INIT_DELAY) if((SDL_GetTicks() - time) < LEPHISTO_INIT_DELAY)
SDL_Delay(LEPHISTO_INIT_DELAY - (SDL_GetTicks() - gtime)); SDL_Delay(LEPHISTO_INIT_DELAY - (SDL_GetTicks() - time));
gtime = SDL_GetTicks(); /* Init the time. */ time = SDL_GetTicks(); /* Init the time. */
/* Main loop. */ /* Main loop. */
SDL_Event event; SDL_Event event;
@ -234,6 +247,8 @@ int main(int argc, char** argv) {
} }
/** /**
* @fn void load_scren(void)
*
* @brief Display a loading screen. * @brief Display a loading screen.
*/ */
void load_screen(void) { void load_screen(void) {
@ -275,6 +290,8 @@ void load_screen(void) {
} }
/** /**
* @fn void load_all(void)
*
* @brief Load all the data, makes main() simpler. * @brief Load all the data, makes main() simpler.
*/ */
void load_all(void) { void load_all(void) {
@ -290,6 +307,8 @@ void load_all(void) {
} }
/** /**
* @fn void unload_all(void)
*
* @brief Unloads all data, simplifies main(). * @brief Unloads all data, simplifies main().
*/ */
void unload_all(void) { void unload_all(void) {
@ -305,6 +324,8 @@ void unload_all(void) {
} }
/** /**
* @fn void main_loop(void)
*
* @brief Split main loop from main() for secondary loop hack in toolkit.c. * @brief Split main loop from main() for secondary loop hack in toolkit.c.
*/ */
void main_loop(void) { void main_loop(void) {
@ -326,6 +347,8 @@ void main_loop(void) {
static double fps_dt = 1.; static double fps_dt = 1.;
static double cur_dt = 0.; static double cur_dt = 0.;
/** /**
* @fn static void fps_control(void)
*
* @brief Controls the FPS. * @brief Controls the FPS.
*/ */
static void fps_control(void) { static void fps_control(void) {
@ -334,8 +357,8 @@ static void fps_control(void) {
/* dt in ms/1000. */ /* dt in ms/1000. */
t = SDL_GetTicks(); t = SDL_GetTicks();
cur_dt = (double)(t-gtime)/1000.; cur_dt = (double)(t-time)/1000.;
gtime = t; time = t;
if(paused) SDL_Delay(10); /* Drop paused FPS to be nice to the CPU. */ if(paused) SDL_Delay(10); /* Drop paused FPS to be nice to the CPU. */
@ -349,6 +372,8 @@ static void fps_control(void) {
static const double fps_min = 1./50.0; static const double fps_min = 1./50.0;
/** /**
* @fn static void update_all(void)
*
* @brief Updates the game itself (player flying around etc). * @brief Updates the game itself (player flying around etc).
*/ */
static void update_all(void) { static void update_all(void) {
@ -377,7 +402,10 @@ static void update_all(void) {
} }
/** /**
* @fn static void update_routine(double dt)
*
* @brief Actually runs the update. * @brief Actually runs the update.
* @param[in] dt Current delta tick.
*/ */
static void update_routine(double dt) { static void update_routine(double dt) {
space_update(dt); space_update(dt);
@ -387,22 +415,25 @@ static void update_routine(double dt) {
} }
/** /**
* @fn static void render_all(void)
*
* @brief Renders the game itself (player flying around etc). * @brief Renders the game itself (player flying around etc).
* *
* Blitting order. (layers) * Blitting order. (layers)
* *
* BG | Stars and planets. * - BG
* | Background player stuff (planet targetting) * -- Stars and planets.
* | Background particles. * -- Background player stuff (planet targetting)
* | Back layer weapons. * -- Background particles.
* X * -- Back layer weapons.
* N | NPC ships. * - N
* | Front layer weapons. * -- NPC ships.
* | Normal layer particles (above ships). * -- Front layer weapons.
* X * -- Normal layer particles (above ships).
* FG | Player. * - FG
* | Foreground particles. * -- Player.
* | Text and GUI. * -- Foreground particles.
* -- Text and GUI.
*/ */
static void render_all(void) { static void render_all(void) {
/* Setup. */ /* Setup. */
@ -428,7 +459,11 @@ static void render_all(void) {
static double fps = 0.; static double fps = 0.;
static double fps_cur = 0.; static double fps_cur = 0.;
/** /**
* @fn static void display_fps(const double dt)
*
* @brief Displays FPS on the screen. * @brief Displays FPS on the screen.
*
* @param[in] dt Current delta tick.
*/ */
static void display_fps(const double dt) { static void display_fps(const double dt) {
double x, y; double x, y;
@ -447,6 +482,8 @@ static void display_fps(const double dt) {
} }
/** /**
* @fn static void data_name(void)
*
* @brief Set the data module's name. * @brief Set the data module's name.
*/ */
static void data_name(void) { static void data_name(void) {
@ -502,6 +539,8 @@ static void data_name(void) {
} }
/** /**
* @fn static void window_caption(void)
*
* @brief Set the window caption. * @brief Set the window caption.
*/ */
static void window_caption(void) { static void window_caption(void) {
@ -511,10 +550,14 @@ static void window_caption(void) {
SDL_WM_SetCaption(tmp, NULL); SDL_WM_SetCaption(tmp, NULL);
} }
static char human_version[50]; static char human_version[50]; /**< Stores human readable version string. */
/** /**
* @fn char* lephisto_version(void)
*
* @brief Return the version in a human readable string. * @brief Return the version in a human readable string.
*
* @return The human readable version string.
*/ */
char* lephisto_version(void) { char* lephisto_version(void) {
if(human_version[0] == '\0') if(human_version[0] == '\0')
@ -524,7 +567,9 @@ char* lephisto_version(void) {
} }
/** /**
* @bief Print the SDL version. * @fn static void print print_SDLversion.
*
* @bief Print the SDL version to console.
*/ */
static void print_SDLversion(void) { static void print_SDLversion(void) {
const SDL_version* linked; const SDL_version* linked;

36
src/lephisto.h
View File

@ -1,31 +1,37 @@
#pragma once #pragma once
#define APPNAME "Lephisto" /**
* @file lephisto.h
*
* @brief Header file with generic functions and lephisto-specifics.
*/
#define MALLOC_L(type)(malloc(sizeof(type))) #define APPNAME "Lephisto" /**< Application name. */
#define CALLOC_L(type)(calloc(1, sizeof(type)))
#define ABS(x) (((x)<0)?-(x):(x)) #define MALLOC_L(type)(malloc(sizeof(type))) /**< Deprecated. */
#define FABS(x) (((x)<0.)?-(x):(x)) #define CALLOC_L(type)(calloc(1, sizeof(type))) /**< Deprecated. */
#define MAX(x,y) (((x)>(y))?(x):(y)) #define ABS(x) (((x)<0)?-(x):(x)) /**< Return absulute value. */
#define MIN(x,y) (((x)>(y))?(y):(x)) #define FABS(x) (((x)<0.)?-(x):(x)) /**< Return float absolute value. */
#define pow2(x) ((x)*(x)) #define MAX(x,y) (((x)>(y))?(x):(y)) /**< Return maximum. */
#define MIN(x,y) (((x)>(y))?(y):(x)) /**< Return minumum. */
#define DATA_DEF "data" /* Default data packfile. */ #define pow2(x) ((x)*(x)) /**< ^2 */
extern char* data; /* Modifiable datafile. */
#define DATA data /* Data file. */ #define DATA_DEF "data" /**< Default data packfile. */
#define DATA_NAME_LEN 32 /* Max length of data name. */ extern char* data; /**< Modifiable datafile. */
extern char dataname[DATA_NAME_LEN]; #define DATA data /**< Standard data file to use. */
#define DATA_NAME_LEN 32 /**< Max length of data name. */
extern char dataname[DATA_NAME_LEN]; /**< Datafile name. */
/* Max filename path. */ /* Max filename path. */
#ifndef PATH_MAX #ifndef PATH_MAX
# define PATH_MAX 128 # define PATH_MAX 128 /**< If not already defined. */
#endif #endif
#ifndef M_PI #ifndef M_PI
#define M_PI 3.14159265358979323846 /* Pi. */ #define M_PI 3.14159265358979323846 /**< If not already defined. */
#endif #endif
char* lephisto_version(void); char* lephisto_version(void);