diff --git a/Makefile b/Makefile index 6dfe26e..3ef42ca 100644 --- a/Makefile +++ b/Makefile @@ -9,7 +9,7 @@ export TARGET := GBA_ExpLoader export TOPDIR := $(CURDIR) export VERSION_MAJOR := 0 -export VERSION_MINOR := 65 +export VERSION_MINOR := 66 export VERSTRING := $(VERSION_MAJOR).$(VERSION_MINOR) # GMAE_ICON is the image used to create the game icon, leave blank to use default rule diff --git a/arm9/Makefile b/arm9/Makefile index 4da893e..8dbd7c9 100644 --- a/arm9/Makefile +++ b/arm9/Makefile @@ -40,6 +40,7 @@ LIBS := -lfat -lnds329 # include and lib #--------------------------------------------------------------------------------- LIBDIRS := $(LIBNDS) $(PORTLIBS) +LIBDIRS32 := $(CURDIR)/../libraries/libnds32 #--------------------------------------------------------------------------------- # no real need to edit anything past this point unless you need to add additional @@ -87,7 +88,8 @@ export HFILES := $(BMPFILES:.bmp=.h) $(addsuffix .h,$(subst .,_,$(BINFILES))) export INCLUDE := $(foreach dir,$(INCLUDES),-iquote $(CURDIR)/$(dir))\ $(foreach dir,$(LIBDIRS),-I$(dir)/include)\ -I$(CURDIR)/$(BUILD) -export LIBPATHS := $(foreach dir,$(LIBDIRS),-L$(dir)/lib) +export LIBPATHS := $(foreach dir,$(LIBDIRS),-L$(dir)/lib) \ + $(foreach dir,$(LIBDIRS32),-L$(dir)/lib) .PHONY: $(BUILD) clean diff --git a/arm9/include/dsCard.h b/arm9/include/dsCard.h index 7004c5d..40eeb9a 100644 --- a/arm9/include/dsCard.h +++ b/arm9/include/dsCard.h @@ -47,7 +47,8 @@ typedef bool BOOL; #define PSRAMBase_S98 0x08800000 // EZ Flash Omega PSRAM location while in Kernal mode. (only writable in Kernal mode) #define FlashBase_S98 0x09000000 #define SRAM_ADDR 0x0A000000 -#define SRAM_ADDR_OMEGA 0x0E000000 +// #define SRAM_ADDR_OMEGA 0x0E000000 // SRAM address changes in DS mode. Use 0x0A000000 instead. +#define SRAM_ADDR_OMEGA 0x0A000000 #define RTC_ENABLE ((vu16*)0x080000C8) #define OMEGA_NOSAVE 0 diff --git a/arm9/include/dsCard.itcm.cpp b/arm9/include/dsCard.itcm.cpp index d8c376f..faad7fb 100644 --- a/arm9/include/dsCard.itcm.cpp +++ b/arm9/include/dsCard.itcm.cpp @@ -158,7 +158,8 @@ void Omega_InitFatBuffer(BYTE saveMODE, u32 saveSize, u32 gameSize) { FAT_table_buffer[0x1F8/4] = 0x40; // secort of cluster FAT_table_buffer[0x1FC/4] = ((saveMODE << 24) | saveSize); // save mode and save file size // FAT_table_buffer[0x204/4] = 0x363100; // Save file sector location - FAT_table_buffer[0x204/4] = 0x00C07644; + // FAT_table_buffer[0x204/4] = 0x00C07644; + FAT_table_buffer[0x204/4] = 0xFFFFFFFF; FAT_table_buffer[0x208/4] = 0xFFFFFFFF; // FAT_table_buffer[0x308/4] = 0x100; // RTS? // FAT_table_buffer[0x320/4] = 0xFFFFFFFF; // RTS? @@ -171,7 +172,7 @@ void Omega_InitFatBuffer(BYTE saveMODE, u32 saveSize, u32 gameSize) { }*/ SetbufferControl(1); // dmaCopy(FAT_table_buffer, (void*)0x9E00000, 0x400); - tonccpy((u16*)0x9E00000, (u32*)FAT_table_buffer, 0x400); + tonccpy((void*)0x9E00000, &FAT_table_buffer, 0x400); SetbufferControl(3); SetbufferControl(0); /*SetbufferControl(0); diff --git a/arm9/include/inifile.cpp b/arm9/include/inifile.cpp new file mode 100644 index 0000000..d93a29c --- /dev/null +++ b/arm9/include/inifile.cpp @@ -0,0 +1,370 @@ +/* + inifile.cpp + Copyright (C) 2007 Acekard, www.acekard.com + Copyright (C) 2007-2009 somebody + Copyright (C) 2009 yellow wood goblin + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +#include "inifile.h" +#include "stringtool.h" + +#include +#include + +bool gbar2Fix = false; + +static bool freadLine(FILE *f, std::string &str) +{ + str.clear(); +__read: + char p = 0; + + size_t readed = fread(&p, 1, 1, f); + if (0 == readed) { + str = ""; + return false; + } + if ('\n' == p || '\r' == p) { + str = ""; + return true; + } + + while (p != '\n' && p != '\r' && readed) { + str += p; + readed = fread(&p, 1, 1, f); + } + + if (str.empty() || "" == str) { + goto __read; + } + + return true; +} + +static void trimString(std::string &str) +{ + size_t first = str.find_first_not_of(" \t"), last; + if (first == str.npos) { + str = ""; + } else { + last = str.find_last_not_of(" \t"); + if (first > 0 || (last + 1) < str.length()) + str = str.substr(first, last - first + 1); + } +} + +CIniFile::CIniFile() +{ + m_bLastResult = false; + m_bModified = false; + m_bReadOnly = false; +} + +CIniFile::CIniFile(const std::string &filename) +{ + m_sFileName = filename; + m_bLastResult = false; + m_bModified = false; + m_bReadOnly = false; + LoadIniFile(m_sFileName); +} + +CIniFile::~CIniFile() +{ + if (m_FileContainer.size() > 0) { + m_FileContainer.clear(); + } +} + +void CIniFile::SetString(const std::string &Section, const std::string &Item, const std::string &Value) +{ + if (GetFileString(Section, Item) != Value) { + SetFileString(Section, Item, Value); + m_bModified = true; + } +} + +void CIniFile::SetInt(const std::string &Section, const std::string &Item, int Value) +{ + std::string strtemp = formatString("%d", Value); + + if (GetFileString(Section, Item) != strtemp) { + SetFileString(Section, Item, strtemp); + m_bModified = true; + } +} + +std::string CIniFile::GetString(const std::string &Section, const std::string &Item) +{ + return GetFileString(Section, Item); +} + +std::string CIniFile::GetString(const std::string &Section, const std::string &Item, const std::string &DefaultValue) +{ + std::string temp = GetString(Section, Item); + if (!m_bLastResult) { + SetString(Section, Item, DefaultValue); + temp = DefaultValue; + } + return temp; +} + +void CIniFile::GetStringVector(const std::string &Section, const std::string &Item, std::vector &strings, char delimiter) +{ + std::string strValue = GetFileString(Section, Item); + strings.clear(); + size_t pos; + while ((pos = strValue.find(delimiter), strValue.npos != pos)) { + const std::string string = strValue.substr(0, pos); + if (string.length()) { + strings.push_back(string); + } + strValue = strValue.substr(pos + 1, strValue.npos); + } + if (strValue.length()) { + strings.push_back(strValue); + } +} + +void CIniFile::SetStringVector(const std::string &Section, const std::string &Item, std::vector &strings, char delimiter) +{ + std::string strValue; + for (size_t ii = 0; ii < strings.size(); ++ii) { + if (ii) + strValue += delimiter; + strValue += strings[ii]; + } + SetString(Section, Item, strValue); +} + +int CIniFile::GetInt(const std::string &Section, const std::string &Item) +{ + std::string value = GetFileString(Section, Item); + if (value.size() > 2 && '0' == value[0] && ('x' == value[1] || 'X' == value[1])) + return strtol(value.c_str(), NULL, 16); + else + return strtol(value.c_str(), NULL, 10); +} + +int CIniFile::GetInt(const std::string &Section, const std::string &Item, int DefaultValue) +{ + int temp; + temp = GetInt(Section, Item); + if (!m_bLastResult) { + SetInt(Section, Item, DefaultValue); + temp = DefaultValue; + } + return temp; +} + +bool CIniFile::LoadIniFile(const std::string &FileName) +{ + //dbg_printf("load %s\n",FileName.c_str()); + if (FileName != "") + m_sFileName = FileName; + + FILE *f = fopen(FileName.c_str(), "rb"); + + if (NULL == f) + return false; + + //check for utf8 bom. + char bom[3]; + if (fread(bom, 3, 1, f) == 1 && bom[0] == 0xef && bom[1] == 0xbb && bom[2] == 0xbf) + ; + else + fseek(f, 0, SEEK_SET); + + std::string strline(""); + m_FileContainer.clear(); + + while (freadLine(f, strline)) { + trimString(strline); + if (strline != "" && ';' != strline[0] && '/' != strline[0] && '!' != strline[0]) + m_FileContainer.push_back(strline); + } + + fclose(f); + + m_bLastResult = false; + m_bModified = false; + + return true; +} + +bool CIniFile::SaveIniFileModified(const std::string &FileName) +{ + if (m_bModified == true) { + return SaveIniFile(FileName); + } + + return true; +} + +bool CIniFile::SaveIniFile(const std::string &FileName) +{ + if (FileName != "") + m_sFileName = FileName; + + FILE *f = fopen(m_sFileName.c_str(), "wb"); + if (NULL == f) { + return false; + } + + for (size_t ii = 0; ii < m_FileContainer.size(); ii++) { + std::string &strline = m_FileContainer[ii]; + size_t notSpace = strline.find_first_not_of(' '); + strline = strline.substr(notSpace); + if (strline.find('[') == 0 && ii > 0) { + if (!m_FileContainer[ii - 1].empty() && m_FileContainer[ii - 1] != "") + fwrite((gbar2Fix ? "\n" : "\r\n"), 1, 2-gbar2Fix, f); + } + if (!strline.empty() && strline != "") { + fwrite(strline.c_str(), 1, strline.length(), f); + fwrite((gbar2Fix ? "\n" : "\r\n"), 1, 2-gbar2Fix, f); + } + } + + fclose(f); + + m_bModified = false; + + return true; +} + +std::string CIniFile::GetFileString(const std::string &Section, const std::string &Item) +{ + std::string strline; + std::string strSection; + std::string strItem; + std::string strValue; + + size_t ii = 0; + size_t iFileLines = m_FileContainer.size(); + + if (m_bReadOnly) { + SectionCache::iterator it = m_Cache.find(Section); + if ((it != m_Cache.end())) + ii = it->second; + } + + m_bLastResult = false; + + if (iFileLines >= 0) { + while (ii < iFileLines) { + strline = m_FileContainer[ii++]; + + size_t rBracketPos = 0; + if ('[' == strline[0]) + rBracketPos = strline.find(']'); + if (rBracketPos > 0 && rBracketPos != std::string::npos) { + strSection = strline.substr(1, rBracketPos - 1); + if (m_bReadOnly) + m_Cache.insert(std::make_pair(strSection, ii - 1)); + if (strSection == Section) { + while (ii < iFileLines) { + strline = m_FileContainer[ii++]; + size_t equalsignPos = strline.find('='); + if (equalsignPos != strline.npos) { + size_t last = equalsignPos ? strline.find_last_not_of(" \t", equalsignPos - 1) : strline.npos; + if (last == strline.npos) + strItem = ""; + else + strItem = strline.substr(0, last + 1); + + if (strItem == Item) { + size_t first = strline.find_first_not_of(" \t", equalsignPos + 1); + if (first == strline.npos) + strValue = ""; + else + strValue = strline.substr(first); + m_bLastResult = true; + return strValue; + } + } else if ('[' == strline[0]) { + break; + } + } + break; + } + } + } + } + return std::string(""); +} + +void CIniFile::SetFileString(const std::string &Section, const std::string &Item, const std::string &Value) +{ + std::string strline; + std::string strSection; + std::string strItem; + + if (m_bReadOnly) + return; + + size_t ii = 0; + size_t iFileLines = m_FileContainer.size(); + + while (ii < iFileLines) { + strline = m_FileContainer[ii++]; + + size_t rBracketPos = 0; + if ('[' == strline[0]) + rBracketPos = strline.find(']'); + if (rBracketPos > 0 && rBracketPos != std::string::npos) { + strSection = strline.substr(1, rBracketPos - 1); + if (strSection == Section) { + while (ii < iFileLines) { + strline = m_FileContainer[ii++]; + size_t equalsignPos = strline.find('='); + if (equalsignPos != strline.npos) { + size_t last = equalsignPos ? strline.find_last_not_of(" \t", equalsignPos - 1) : strline.npos; + if (last == strline.npos) + strItem = ""; + else + strItem = strline.substr(0, last + 1); + + if (Item == strItem) { + ReplaceLine(ii - 1, Item + (gbar2Fix ? "=" : " = ") + Value); + return; + } + } else if ('[' == strline[0]) { + InsertLine(ii - 1, Item + (gbar2Fix ? "=" : " = ") + Value); + return; + } + } + InsertLine(ii, Item + (gbar2Fix ? "=" : " = ") + Value); + return; + } + } + } + + InsertLine(ii, "[" + Section + "]"); + InsertLine(ii + 1, Item + (gbar2Fix ? "=" : " = ") + Value); + return; +} + +bool CIniFile::InsertLine(size_t line, const std::string &str) +{ + m_FileContainer.insert(m_FileContainer.begin() + line, str); + return true; +} + +bool CIniFile::ReplaceLine(size_t line, const std::string &str) +{ + m_FileContainer[line] = str; + return true; +} diff --git a/arm9/include/inifile.h b/arm9/include/inifile.h new file mode 100644 index 0000000..417d273 --- /dev/null +++ b/arm9/include/inifile.h @@ -0,0 +1,69 @@ +/* + common/inifile.h + Copyright (C) 2007 Acekard, www.acekard.com + Copyright (C) 2007-2009 somebody + Copyright (C) 2009-2010 yellow wood goblin + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +#ifndef _INIFILE_H_ +#define _INIFILE_H_ + +#include +#include +#include + +extern bool gbar2Fix; + +class CIniFile +{ + public: + CIniFile(); + CIniFile(const std::string& filename); + virtual ~CIniFile(); + + public: + bool LoadIniFile(const std::string& FileName); + bool SaveIniFile(const std::string& FileName); + bool SaveIniFileModified(const std::string& FileName); + + std::string GetString(const std::string& Section,const std::string& Item,const std::string& DefaultValue); + void SetString(const std::string& Section,const std::string& Item,const std::string& Value); + int GetInt(const std::string& Section,const std::string& Item,int DefaultValue); + void SetInt(const std::string& Section,const std::string& Item,int Value); + void GetStringVector(const std::string& Section,const std::string& Item,std::vector& strings,char delimiter=','); + void SetStringVector(const std::string& Section,const std::string& Item,std::vector& strings,char delimiter=','); + protected: + std::string m_sFileName; + typedef std::vector StringArray; + StringArray m_FileContainer; + bool m_bLastResult; + bool m_bModified; + bool m_bReadOnly; + typedef std::map SectionCache; + SectionCache m_Cache; + + bool InsertLine(size_t line,const std::string& str); + bool ReplaceLine(size_t line,const std::string& str); + + void SetFileString(const std::string& Section,const std::string& Item,const std::string& Value); + std::string GetFileString(const std::string& Section,const std::string& Item); + + std::string GetString(const std::string& Section,const std::string& Item); + int GetInt(const std::string& Section,const std::string& Item); +}; + +#endif // _INIFILE_H_ + diff --git a/arm9/include/ndsloader.cpp b/arm9/include/ndsloader.cpp new file mode 100644 index 0000000..d9a7d07 --- /dev/null +++ b/arm9/include/ndsloader.cpp @@ -0,0 +1,75 @@ +#include +#include +#include "inifile.h" +#include "tonccpy.h" +#include "nds_loader_arm9.h" + +#ifdef __cplusplus +extern "C" { +#endif + +using namespace std; + +volatile char currentNDSFilePath[256]; + +volatile char iniNDSFilePath[261]; +volatile char iniSAVFilePath[261]; + +const char* bootstrapPath = "/_nds/nds-bootstrap-release.nds"; +const char* bootstrapINIPath = "/_nds/nds-bootstrap.ini"; +const char* fatString = "fat:"; + +volatile int bootstrapPathLength = 0; +volatile int ndsPathLength = 0; +volatile int savPathLength = 0; + +int runNDSFile (char tbuf[], char* iniPath, char* curPathName, char* ndsName, char* savName, bool isHomebrew) { + bool usebootstrap = true; + + if (isHomebrew || (access(bootstrapPath, F_OK) != 0) || (access(bootstrapINIPath, F_OK) != 0))usebootstrap = false; + + sprintf(tbuf, "%s%s", curPathName, ndsName); + ndsPathLength = (strlen((const char*)tbuf) + 1); + if (ndsPathLength > 256)return 9; + + tonccpy((char*)currentNDSFilePath, (char*)tbuf, ndsPathLength); + + if (!usebootstrap || ((ndsPathLength + 4) > 261)) { + const char *ndsARGArray1[] = { (char*)currentNDSFilePath }; + return runNdsFile(ndsARGArray1[0], 1, ndsARGArray1); + } + + sprintf(tbuf, "%s%s", fatString, currentNDSFilePath); + + tonccpy((char*)iniNDSFilePath, (char*)tbuf, (ndsPathLength + 4)); + + sprintf(tbuf, "%s%s%s%s", fatString, iniPath, "/", savName); + savPathLength = (strlen((const char*)tbuf) + 1); + + if (savPathLength > 262) { + const char *ndsARGArray2[] = { (char*)currentNDSFilePath }; + return runNdsFile(ndsARGArray2[0], 1, ndsARGArray2); + } + + tonccpy((char*)iniSAVFilePath, (char*)tbuf, savPathLength); + + CIniFile bootstrapini(bootstrapINIPath); + bootstrapini.SetString("NDS-BOOTSTRAP", "NDS_PATH", (char*)iniNDSFilePath); + bootstrapini.SetString("NDS-BOOTSTRAP", "SAV_PATH", (char*)iniSAVFilePath); + bootstrapini.SetString("NDS-BOOTSTRAP", "HOMEBREW_ARG", ""); + bootstrapini.SetString("NDS-BOOTSTRAP", "RAM_DRIVE_PATH", ""); + bootstrapini.SetInt("NDS-BOOTSTRAP", "DSI_MODE", 0); + bootstrapini.SetInt("NDS-BOOTSTRAP", "BOOST_CPU", 0); + bootstrapini.SetInt("NDS-BOOTSTRAP", "BOOST_VRAM", 0); + bootstrapini.SaveIniFile(bootstrapINIPath); + + swiWaitForVBlank(); + + const char* ndsARGArrayBootstrap[] = { bootstrapPath }; + return runNdsFile(bootstrapPath, 1, ndsARGArrayBootstrap); +} + +#ifdef __cplusplus +} +#endif + diff --git a/arm9/include/stringtool.cpp b/arm9/include/stringtool.cpp new file mode 100644 index 0000000..182e216 --- /dev/null +++ b/arm9/include/stringtool.cpp @@ -0,0 +1,54 @@ +/*--------------------------------------------------------------------------------- + + +Copyright (C) 2007 Acekard, www.acekard.com + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +---------------------------------------------------------------------------------*/ + +#include "stringtool.h" +#include +#include +#include + +std::string formatString(const char *fmt, ...) +{ + const char *f = fmt; + va_list argList; + va_start(argList, fmt); + char *ptempStr = NULL; + size_t max_len = vasiprintf( &ptempStr, f, argList); + std::string str( ptempStr ); + str.resize( max_len ); + free( ptempStr ); + va_end(argList); + return str; +} + +std::string replaceAll(std::string str, const std::string &from, const std::string &to) +{ + size_t start_pos = 0; + while ((start_pos = str.find(from, start_pos)) != std::string::npos) { + str.replace(start_pos, from.length(), to); + start_pos += to.length(); // Handles case where 'to' is a substring of 'from' + } + return str; +} diff --git a/arm9/include/stringtool.h b/arm9/include/stringtool.h new file mode 100644 index 0000000..1dededa --- /dev/null +++ b/arm9/include/stringtool.h @@ -0,0 +1,37 @@ +/*--------------------------------------------------------------------------------- + + +Copyright (C) 2007 Acekard, www.acekard.com + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +---------------------------------------------------------------------------------*/ + +#ifndef _STRINGTOOL_H_ +#define _STRINGTOOL_H_ + +#include + +std::string formatString(const char *fmt, ...); + +std::string replaceAll(std::string str, const std::string &from, const std::string &to); + +#endif //_STRINGTOOL_H_ + diff --git a/arm9/source/ctrl_tbl.h b/arm9/source/ctrl_tbl.h index 8670994..c21d708 100644 --- a/arm9/source/ctrl_tbl.h +++ b/arm9/source/ctrl_tbl.h @@ -5,6 +5,8 @@ struct GBA_File { u32 type; u32 filesize; int isNDSFile; + int isHomebrewNDS; + char ndssavfilename[512]; }; diff --git a/arm9/source/gbaldr.itcm.cpp b/arm9/source/gbaldr.itcm.cpp index 43c7e86..c90b0c5 100644 --- a/arm9/source/gbaldr.itcm.cpp +++ b/arm9/source/gbaldr.itcm.cpp @@ -37,12 +37,14 @@ #define SRAM_PAGE_SIZE 0x10000 // SRAM Page Size #define MAX_SRAM 0x80000 // 4MBit/512KByte total SRAM -#define USE_SRAM 0x20000 // 128KByte +#define USE_SRAM 0x20000 // 128KByte #define USE_SRAM_PG 48 // 0x0A030000-0A031FFF #define USE_SRAM_PG_EZ4 11 // 0x0A008000-0A00FFFF #define USE_SRAM_PG_EWN 10 // 0x0A020000-0A02FFFF #define USE_SRAM_PG_EWN128 9 // 0x0A010000-0A01FFFF #define USE_SRAM_PG_M3 6 +#define USE_SRAM_PG_OMEGA 96 +#define USE_SRAM_PG_OMEGA_DE 16 #define USE_SRAM_NOR 16 // 0x0A010000-0A02FFFF #define USE_SRAM_PSR 50 // 0x0A032000-0A051FFF @@ -78,11 +80,7 @@ extern int GBAmode; static u32 savesize; -static const char *validExtensions[3] = { - ".GBA", - ".BIN", - ".NDS" -}; +static const char *validExtensions[3] = { ".GBA", ".BIN", ".NDS" }; int carttype = 0; bool isSuperCard = false; @@ -502,10 +500,10 @@ void _RamPG() { } if (isOmega) { if (isOmegaDE) { - SetRampage(16); + SetRampage(USE_SRAM_PG_OMEGA_DE); return; } - SetRampage(96); + SetRampage(USE_SRAM_PG_OMEGA); } else { SetRampage(USE_SRAM_PG); } @@ -591,7 +589,7 @@ int checkSRAM(char *name) { ctrl.save_siz[GBAmode] = savesize; } - if (isOmega && (savesize > 0x10000))savesize = 0x10000; + // if (isOmega && (savesize > 0x10000))savesize = 0x10000; strcpy(name, (char *)ctrl.sav_nam[GBAmode]); ln = strlen(name) - 3; @@ -704,7 +702,9 @@ void SRAMdump(int cmd) { mx = 8; switch (carttype) { - case 1: if (isOmega)mx = 2; break; + case 1: + if (isOmega)mx = 2; + break; case 4: mx = 4; break; case 5: mx = 2; break; case 6: @@ -761,7 +761,7 @@ void SRAMdump(int cmd) { dmp = fopen(name, "rb"); // if((carttype < 4) && !isSuperCard && !isOmega && !is3in1Plus)OpenNorWrite(); - if (isOmega)Omega_Bank_Switching(0); + // if (isOmega)Omega_Bank_Switching(0); for(i = 0; i < mx; i++) { memset(rwbuf, 0, USE_SRAM / 2); @@ -815,7 +815,7 @@ void blankSRAM(char *savename) { // if((carttype < 4) && !isSuperCard && !isOmega && !is3in1Plus)OpenNorWrite(); - if (isOmega)Omega_Bank_Switching(0); + // if (isOmega)Omega_Bank_Switching(0); _RamSave(0); @@ -901,7 +901,7 @@ void writeSramFromFile(char *savename) { // OpenNorWrite(); - if (isOmega)Omega_Bank_Switching(0); + // if (isOmega)Omega_Bank_Switching(0); _RamSave(0); @@ -1306,7 +1306,16 @@ void FileListGBA() { // strcpy(fs[numFiles].Alias, pent->d_name); fs[numFiles].type = st.st_mode; fs[numFiles].isNDSFile = 0; - if (nameEndsWith(pent->d_name, validExtensions[2]))fs[numFiles].isNDSFile = 1; + fs[numFiles].isHomebrewNDS = 0; + if (nameEndsWith(pent->d_name, validExtensions[2])) { + fs[numFiles].isNDSFile = 1; + strcpy(fs[numFiles].ndssavfilename, pent->d_name); + // int filenameLength = (strlen((const char*)fs[numFiles].ndssavfilename) + 1); + int filenameLength = strlen((const char*)fs[numFiles].ndssavfilename); + fs[numFiles].ndssavfilename[filenameLength - 3] = 'S'; + fs[numFiles].ndssavfilename[filenameLength - 2] = 'A'; + fs[numFiles].ndssavfilename[filenameLength - 1] = 'V'; + } if ((((string)pent->d_name).compare(".") != 0) && (((string)pent->d_name).compare("..") != 0) && ((st.st_mode & S_IFMT) != S_IFDIR)) { FILE *file = fopen(pent->d_name, "rb"); if (file) { @@ -1338,6 +1347,11 @@ void FileListGBA() { strcpy(fs[i].gamecode, tbuf + 0x0C); tbuf[0x0C] = 0; strcpy(fs[i].gametitle, tbuf); // 0x0 + if (((fs[i].gamecode[0] == '#') && (fs[i].gamecode[1] == '#') && + (fs[i].gamecode[2] == '#') && (fs[i].gamecode[3] == '#')) || (tbuf[0x85] == 0x02)) + { + fs[i].isHomebrewNDS = 1; + } } else { fread(tbuf, 1, 256, gbaFile); tbuf[0xB0] = 0; diff --git a/arm9/source/main.c b/arm9/source/main.c index 2b9e5e1..25a9ea5 100644 --- a/arm9/source/main.c +++ b/arm9/source/main.c @@ -43,20 +43,19 @@ #include "skin.h" #include "message.h" #include "tonccpy.h" -#include "nds_loader_arm9.h" extern uint16* MainScreen; extern uint16* SubScreen; #define BG_256_COLOR (BIT(7)) -#define VERSTRING "v0.65" +#define VERSTRING "v0.66" int numFiles = 0; int numGames = 0; char curpath[256]; -char* currentNDSFilePath[256]; + int sortfile[200]; struct GBA_File fs[200]; @@ -68,6 +67,12 @@ u8 *rwbuf; int GBAmode; bool softReset; +u16 *gbar = NULL; +int oldper; + +// extern u32 _io_dldi; +extern bool checkSRAM_cnf(); +extern int checkSRAM(char *name); extern int carttype; extern bool isSuperCard; extern bool is3in1Plus; @@ -75,6 +80,28 @@ extern bool isOmega; extern bool isOmegaDE; extern u16 gl_ingame_RTC_open_status; extern void SetSDControl(u16 control); +extern bool ret_menu_chk(void); +extern void setGBAmode(int sel); +extern void getGBAmode(void); +extern int writeFileToNor(int sel); +extern int writeFileToRam(int sel); +extern void writeSramToFile(char *name); +extern void writeSramFromFile(char *name); +extern void SRAMdump(int cmd); +extern bool checkBackup(void); +extern bool checkFlashID(void); +extern u32 SaveType; +extern u32 SaveSize; +extern u8 SaveVer[]; +extern int PatchCnt; +extern u32 PatchType[]; +extern u32 PatchAddr[]; +extern void setcurpath(void); +extern void getcurpath(void); +extern void FileListGBA(void); +extern int save_sel(int mod, char *name); +extern void setLang(void); +extern int runNDSFile (char tbuf[], char* iniPath, char* curPathName, char* ndsName, char* savName, bool isHomebrew); u32 inp_key() { u32 ky; @@ -95,12 +122,6 @@ u32 inp_key() { } -extern bool ret_menu_chk(void); - - -extern void setGBAmode(void); -extern void getGBAmode(void); - void turn_off(bool softReset) { if (softReset) { if (!ret_menu9_Gen())systemShutDown(); @@ -111,13 +132,42 @@ void turn_off(bool softReset) { } -void gba_frame() { +void gba_frame(int Sel) { int ret; int mode = 3; // old mode == 2 // int x = 0, y = 0; // u16 *pDstBuf1; // u16 *pDstBuf2; + // fs[sel].filename + + if (Sel != -1) { + int nameLength = strlen(fs[Sel].filename); + if (nameLength > 4) { + if (( (fs[Sel].filename[(nameLength - 4)] == '.') && + (fs[Sel].filename[(nameLength - 3)] == 'G') && + (fs[Sel].filename[(nameLength - 2)] == 'B') && + (fs[Sel].filename[(nameLength - 1)] == 'A') + ) || ( + (fs[Sel].filename[(nameLength - 4)] == '.') && + (fs[Sel].filename[(nameLength - 3)] == 'g') && + (fs[Sel].filename[(nameLength - 2)] == 'b') && + (fs[Sel].filename[(nameLength - 1)] == 'a') + ) + ) { + fs[Sel].filename[(nameLength - 3)] = 'b'; + fs[Sel].filename[(nameLength - 2)] = 'm'; + fs[Sel].filename[(nameLength - 1)] = 'p'; + // if((fname[ln - 4] != '.') || (fname[ln - 3] != 'S') || (fname[ln - 2] != 'A') || (fname[ln - 1] != 'V')) + sprintf(tbuf, "%s/%s", ini.sign_dir, fs[Sel].filename); + if (access(tbuf, F_OK) == 0) { + ret = LoadSkin(mode, tbuf); + if(ret)return; + } + } + } + } + if (access("/gbaframe.bmp", F_OK) == 0) { ret = LoadSkin(mode, "/gbaframe.bmp"); if(ret)return; @@ -169,7 +219,7 @@ static void resetToSlot2() { swiSoftReset(); } -void gbaMode() { +void gbaMode(int sel) { if(strncmp(GBA_HEADER.gamecode, "PASS", 4) == 0)resetToSlot2(); @@ -198,7 +248,7 @@ void gbaMode() { if(PersonalData->gbaScreen) { lcdMainOnBottom(); } else { lcdMainOnTop(); } - gba_frame(); + gba_frame(sel); sysSetBusOwners(ARM7_OWNS_CARD, ARM7_OWNS_ROM); fifoSendValue32(FIFO_USER_01, 1); @@ -349,10 +399,6 @@ int cnf_inp2(int n1, int n2) { } - -u16 *gbar = NULL; -int oldper; - void dsp_bar(int mod, int per) { int x1, x2; int y1, y2; @@ -425,7 +471,6 @@ void RamClear() { } - void _dsp_clear() { DrawBox_SUB(SubScreen, 0, 28, 255, 114, 0, 1); } @@ -506,7 +551,7 @@ int rumble_cmd() { if(ky & KEY_L) { GBAmode = 1; if (isOmega)GBAmode = 0; - setGBAmode(); + setGBAmode(-1); cmd = -1; break; } @@ -599,9 +644,6 @@ void _gba_dsp2(char *name) } ***************/ -extern bool checkSRAM_cnf(); -extern int checkSRAM(char *name); - void _gba_sel_dsp(int no, int yc, int mod) { int x, y; @@ -699,13 +741,6 @@ void _gba_sel_dsp(int no, int yc, int mod) { } } -extern int writeFileToNor(int sel); -extern int writeFileToRam(int sel); -extern void writeSramToFile(char *name); -extern void writeSramFromFile(char *name); -extern void SRAMdump(int cmd); -extern bool checkBackup(void); -extern bool checkFlashID(void); /*************************** int gba_sel0() @@ -767,20 +802,6 @@ int gba_sel0() ****************/ -extern u32 SaveType; -extern u32 SaveSize; -extern u8 SaveVer[]; -extern int PatchCnt; -extern u32 PatchType[]; -extern u32 PatchAddr[]; - -extern void setcurpath(void); -extern void getcurpath(void); -extern void FileListGBA(void); - -extern int save_sel(int mod, char *name); - - int gba_sel() { // u32 i; @@ -884,7 +905,7 @@ int gba_sel() { if(GBAmode > 0) { GBAmode--; if ((GBAmode == 1) && isOmega)GBAmode--; - setGBAmode(); + setGBAmode(-1); _gba_sel_dsp(sel, yc, 0); // cmd = -1; // break; @@ -897,7 +918,7 @@ int gba_sel() { } else if(GBAmode < cn && carttype <= 2) { GBAmode++; if ((GBAmode == 1) && isOmega)GBAmode++; - setGBAmode(); + setGBAmode(-1); if(GBAmode == 2) { _gba_dsp(sel, 0, x, y+yc); cmd = -1; @@ -919,7 +940,7 @@ int gba_sel() { break; } else if (isOmega && (GBAmode == 0)) { SetRompage(0x8002); - gbaMode(); + gbaMode(-1); } } if(ky & KEY_SELECT) { @@ -942,7 +963,7 @@ int gba_sel() { // if (!is3in1Plus)SetRompage(0); SetRompage(0); SetRampage(16); - gbaMode(); + gbaMode(-1); } else { if(cnf_inp(7, 8) & KEY_A)SRAMdump(0); } @@ -992,12 +1013,8 @@ int gba_sel() { break; } if (fs[sortfile[sel]].isNDSFile == 1) { - sprintf(tbuf, "%s%s", curpath, fs[sortfile[sel]].filename); - tonccpy((char*)currentNDSFilePath, (char*)tbuf, (strlen((const char*)tbuf) + 1)); - const char *ndsARGArray[] = { (char*)currentNDSFilePath }; - runNdsFile(tbuf, 1, ndsARGArray); + runNDSFile(tbuf, ini.save_dir, curpath, fs[sortfile[sel]].filename, fs[sortfile[sel]].ndssavfilename, (fs[sortfile[sel]].isHomebrewNDS == 1)); cmd = -1; - // sortfile[sel] break; } if(GBAmode == 0) { ret = writeFileToRam(sortfile[sel]); } else { ret = writeFileToNor(sortfile[sel]); } @@ -1011,7 +1028,7 @@ int gba_sel() { if(GBAmode == 0) { // if (is3in1Plus)SetRompage(0x100); // SetRompage(384); - gbaMode(); + gbaMode(sortfile[sel]); } } _gba_sel_dsp(sel, yc, 0); @@ -1038,11 +1055,6 @@ int gba_sel() { } -// extern u32 _io_dldi; - -extern void setLang(void); - - void mainloop(void) { // vu16 reg; diff --git a/libraries/libnds32/.github/workflows/ci.yml b/libraries/libnds32/.github/workflows/ci.yml new file mode 100644 index 0000000..e01eced --- /dev/null +++ b/libraries/libnds32/.github/workflows/ci.yml @@ -0,0 +1,16 @@ +name: C/C++ CI + +on: [push, pull_request] + +jobs: + build: + name: ubuntu-latest + runs-on: ubuntu-latest + container: devkitpro/devkitarm:latest + + steps: + - uses: actions/checkout@v4 + + - name: Build + run: | + make -j diff --git a/libraries/libnds32/.gitignore b/libraries/libnds32/.gitignore new file mode 100644 index 0000000..9f64ca6 --- /dev/null +++ b/libraries/libnds32/.gitignore @@ -0,0 +1,9 @@ +arm7/debug +arm7/release +arm9/debug +arm9/release +include/nds/libversion.h +lib +docs +warn.log +*.bz2 diff --git a/libraries/libnds32/Doxyfile b/libraries/libnds32/Doxyfile new file mode 100644 index 0000000..4eb565d --- /dev/null +++ b/libraries/libnds32/Doxyfile @@ -0,0 +1,2327 @@ +# Doxyfile 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = libnds + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = YES + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = YES + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = YES + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text " + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = warn.log + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = include + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.h \ + *.c \ + *.cpp + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = ../nds-examples + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 1 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /