From 0b5173ecbe513e6911df21933a0d6ebfa7860a91 Mon Sep 17 00:00:00 2001 From: t-moe Date: Sat, 9 May 2015 13:30:09 +0200 Subject: [PATCH 01/11] Added reference tracking. --- common/app/screen_pixytest.c | 61 ++++++++++++++++++++++++++++++------ 1 file changed, 52 insertions(+), 9 deletions(-) diff --git a/common/app/screen_pixytest.c b/common/app/screen_pixytest.c index 9c2709b..7d5b0de 100644 --- a/common/app/screen_pixytest.c +++ b/common/app/screen_pixytest.c @@ -10,14 +10,25 @@ static volatile bool pixy_connected = false; static BUTTON_STRUCT b_back; +static BUTTON_STRUCT b_runstop; static TOUCH_AREA_STRUCT a_area; static void b_back_cb(void* button) { gui_screen_back(); } -POINT_STRUCT pixy_pos; -POINT_STRUCT old_pos; + +static volatile bool pixy_running = false; +static bool old_pixy_running= false; +static void b_runstop_cb(void* button) { + pixy_running=!pixy_running; +} + + + + +static POINT_STRUCT pixy_pos; +static POINT_STRUCT old_pos; static void touchCB(void* touchArea, TOUCH_ACTION triggeredAction) { POINT_STRUCT p = touch_get_last_point(); switch(triggeredAction) { @@ -68,6 +79,20 @@ static void enter(void* screen) { b_back.callback=b_back_cb; //Call b_back_cb as Callback gui_button_add(&b_back); //Register Button (and run the callback from now on) + + //Back button + b_runstop.base.x1=60; //Start X of Button + b_runstop.base.y1=210; //Start Y of Button + b_runstop.base.x2=AUTO; //b_runstop.base.x1+160; //Auto Calculate X2 with String Width + b_runstop.base.y2=AUTO; //Auto Calculate Y2 with String Height + b_runstop.txtcolor=WHITE; //Set foreground color + b_runstop.bgcolor=HEX(0xAE1010); //Set runstopground color (Don't take 255 or 0 on at least one channel, to make shadows possible) + b_runstop.font=0; //Select Font + b_runstop.text="Run/Stop"; //Set Text (For formatted strings take sprintf) + b_runstop.callback=b_runstop_cb; //Call b_runstop_cb as Callrunstop + gui_button_add(&b_runstop); //Register Button (and run the callrunstop from now on) + + //Area test a_area.hookedActions = PEN_DOWN | PEN_MOVE | PEN_ENTER | PEN_UP | PEN_LEAVE; a_area.x1 = 0; @@ -88,12 +113,14 @@ static void enter(void* screen) { static void leave(void* screen) { gui_button_remove(&b_back); + gui_button_remove(&b_runstop); touch_unregister_area(&a_area); } int pixy_led_test(); int pixy_frame_test(); + static void update(void* screen) { //Note: The only way to detect that pixy has been disconnected is if a command fails. There's no pixy_is_connected method yet :'( @@ -110,19 +137,35 @@ static void update(void* screen) { if(pixy_connected) { pixy_service(); //Send/receive event data from/to pixy failed - //Code for tests see below - if(pixy_led_test()!=0) { - pixy_connected=false; - } if(pixy_frame_test()!=0) { pixy_connected=false; } - - pixy_rcs_set_position(0,pixy_pos.x); - pixy_rcs_set_position(1,pixy_pos.y); + /*if(pixy_led_test()!=0) { + pixy_connected=false; + }*/ + if(!pixy_running) { + pixy_rcs_set_position(0,pixy_pos.x); + pixy_rcs_set_position(1,pixy_pos.y); + } + + if(pixy_running!=old_pixy_running) { + old_pixy_running=pixy_running; + if(pixy_running) { //start tracking + + int32_t response; + int return_value; + return_value = pixy_command("runprog", INT8(2), END_OUT_ARGS, &response, END_IN_ARGS); + + } else { //stop tracking + int32_t response; + int return_value; + return_value = pixy_command("stop", END_OUT_ARGS, &response, END_IN_ARGS); + } + } + //system_delay(500); } } From c652b6bd05c6bc8ff34a43833cfb4ca4648b6c31 Mon Sep 17 00:00:00 2001 From: t-moe Date: Sat, 9 May 2015 14:32:35 +0200 Subject: [PATCH 02/11] Improved Emulator Gui --- common/app/screen_guitest.c | 2 + emulator/qt/ll_system.cpp | 1 + emulator/qt/mainwindow.cpp | 20 +++++-- emulator/qt/mainwindow.h | 4 ++ emulator/qt/mainwindow.ui | 104 +++++++++++++++++++++++++++++++----- 5 files changed, 112 insertions(+), 19 deletions(-) diff --git a/common/app/screen_guitest.c b/common/app/screen_guitest.c index d2d93e3..282636e 100644 --- a/common/app/screen_guitest.c +++ b/common/app/screen_guitest.c @@ -62,6 +62,8 @@ static void enter(void* screen) { //tft test + tft_draw_pixel(0,0,BLACK); + tft_draw_pixel(319,239,BLACK); tft_draw_pixel(10,210,BLUE); tft_draw_pixel(12,210,BLUE); tft_draw_rectangle(40,100,60,235,BLUE); diff --git a/emulator/qt/ll_system.cpp b/emulator/qt/ll_system.cpp index 1356956..8d087b5 100644 --- a/emulator/qt/ll_system.cpp +++ b/emulator/qt/ll_system.cpp @@ -15,6 +15,7 @@ void ll_system_delay(uint32_t msec) { void ll_system_process() { QApplication::processEvents(); + QThread::msleep(1); } void ll_system_toggle_led() { diff --git a/emulator/qt/mainwindow.cpp b/emulator/qt/mainwindow.cpp index aa3fa5f..3756730 100644 --- a/emulator/qt/mainwindow.cpp +++ b/emulator/qt/mainwindow.cpp @@ -12,8 +12,6 @@ extern "C" { #define DISPLAY_WIDTH 320 #define DISPLAY_HEIGHT 240 -#define DISPLAY_X 10 -#define DISPLAY_Y 10 QColor QColorFromRGB565(uint16_t color) { @@ -35,6 +33,7 @@ QRgb QRgbFromRGB565(uint16_t color) { MainWindow::MainWindow(QWidget *parent) : QMainWindow(parent), image(DISPLAY_WIDTH,DISPLAY_HEIGHT, QImage::Format_RGB16), ui(new Ui::MainWindow){ ui->setupUi(this); image.fill(Qt::black); + currentScale = 1; } void MainWindow::draw_line(uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t color) @@ -134,9 +133,13 @@ void MainWindow::paintEvent(QPaintEvent *) //render_mutex.lock(); QPainter painter(this); - painter.drawImage(DISPLAY_X,DISPLAY_Y,image); + QRectF imgRect (ui->widgetDisplay->geometry().topLeft(),QSizeF(DISPLAY_WIDTH*currentScale,DISPLAY_HEIGHT*currentScale)); + + painter.drawImage(imgRect,image); painter.setPen(QPen(Qt::green,2)); - painter.drawRect(DISPLAY_X-1,DISPLAY_Y-1,DISPLAY_WIDTH+2,DISPLAY_HEIGHT+2); + painter.drawRect(imgRect.adjusted(-1,-1,1,1)); + + //render_mutex.unlock(); } @@ -167,7 +170,8 @@ MainWindow::~MainWindow() void MainWindow::checkAndSendEvent(QPoint pos, bool down) { - QPoint p = pos - QPoint(DISPLAY_X,DISPLAY_Y); + QPoint p = pos - ui->widgetDisplay->geometry().topLeft(); + p/=currentScale; if(p.x()<0 || p.y()<0 || p.x() >= DISPLAY_WIDTH || p.y() >= DISPLAY_HEIGHT) return; //qDebug() << down << p; @@ -175,3 +179,9 @@ void MainWindow::checkAndSendEvent(QPoint pos, bool down) touch_add_raw_event(p.x(),p.y(),down?TOUCH_DOWN:TOUCH_UP); } + +void MainWindow::on_cboZoom_currentIndexChanged(int index) +{ + currentScale=index+1; + update(); +} diff --git a/emulator/qt/mainwindow.h b/emulator/qt/mainwindow.h index c4c015b..ad14809 100644 --- a/emulator/qt/mainwindow.h +++ b/emulator/qt/mainwindow.h @@ -31,9 +31,13 @@ protected: void mouseMoveEvent(QMouseEvent* evt); ~MainWindow(); +private slots: + void on_cboZoom_currentIndexChanged(int index); + private: //QMutex render_mutex; QImage image; + int currentScale; void checkAndSendEvent(QPoint pos, bool down); Ui::MainWindow *ui; diff --git a/emulator/qt/mainwindow.ui b/emulator/qt/mainwindow.ui index 560c879..293d0a3 100644 --- a/emulator/qt/mainwindow.ui +++ b/emulator/qt/mainwindow.ui @@ -6,26 +6,102 @@ 0 0 - 339 - 263 + 980 + 778 DiscoverPixy Emulator - - - - - 0 - 0 - 339 - 19 - - + + + + + + + + Zoom + + + + + + + + 1x + + + + + 2x + + + + + 3x + + + + + + + + Qt::Horizontal + + + + 40 + 20 + + + + + + + + Exit + + + + + + + + + Qt::Horizontal + + + + + + + + 0 + 0 + + + + + - - + + + btnExit + clicked() + MainWindow + close() + + + 652 + 20 + + + 351 + 244 + + + + From e2bce8f163a011d2eebc9b648a84c7877bd6c23a Mon Sep 17 00:00:00 2001 From: t-moe Date: Sun, 10 May 2015 01:17:58 +0200 Subject: [PATCH 03/11] Added filesystem module, tests and implementation for it in emulator. --- common/app/app.c | 3 +- common/app/screen_filetest.c | 128 ++++++++++++++++++++ common/app/screen_filetest.h | 3 + common/app/screen_main.c | 22 +++- common/filesystem/filesystem.c | 38 ++++++ common/filesystem/filesystem.h | 71 +++++++++++ common/lowlevel/ll_filesystem.h | 11 ++ discovery/src/ll_filesystem.c | 38 ++++++ emulator/emulated/.hidden | 0 emulator/emulated/dir1/subfile1.txt | 0 emulator/emulated/emtpy.txt | 0 emulator/emulated/test.txt | 1 + emulator/emulated/test2.txt | 1 + emulator/qt/emulatorqt.pro | 6 +- emulator/qt/ll_filesystem.cpp | 181 ++++++++++++++++++++++++++++ 15 files changed, 498 insertions(+), 5 deletions(-) create mode 100644 common/app/screen_filetest.c create mode 100644 common/app/screen_filetest.h create mode 100644 common/filesystem/filesystem.c create mode 100644 common/lowlevel/ll_filesystem.h create mode 100644 discovery/src/ll_filesystem.c create mode 100644 emulator/emulated/.hidden create mode 100644 emulator/emulated/dir1/subfile1.txt create mode 100644 emulator/emulated/emtpy.txt create mode 100644 emulator/emulated/test.txt create mode 100644 emulator/emulated/test2.txt create mode 100644 emulator/qt/ll_filesystem.cpp diff --git a/common/app/app.c b/common/app/app.c index cb7bcf9..6f6ee19 100644 --- a/common/app/app.c +++ b/common/app/app.c @@ -3,12 +3,13 @@ #include "system.h" #include "touch.h" #include "screen_main.h" - +#include "filesystem.h" void app_init() { system_init(); tft_init(); touch_init(); + filesystem_init(); gui_screen_navigate(get_screen_main()); } diff --git a/common/app/screen_filetest.c b/common/app/screen_filetest.c new file mode 100644 index 0000000..b381c48 --- /dev/null +++ b/common/app/screen_filetest.c @@ -0,0 +1,128 @@ +#include "screen_filetest.h" +#include "button.h" +#include "tft.h" +#include "filesystem.h" +#include + + +static BUTTON_STRUCT b_back; + + +static void b_back_cb(void* button) { + gui_screen_back(); +} + +static void enter(void* screen) { + tft_clear(HEX(0xBABECD)); + + //Back button + b_back.base.x1=10; //Start X of Button + b_back.base.y1=200; //Start Y of Button + b_back.base.x2=AUTO; //b_back.base.x1+160; //Auto Calculate X2 with String Width + b_back.base.y2=AUTO; //Auto Calculate Y2 with String Height + b_back.txtcolor=WHITE; //Set foreground color + b_back.bgcolor=HEX(0xAE1010); //Set background color (Don't take 255 or 0 on at least one channel, to make shadows possible) + b_back.font=0; //Select Font + b_back.text="Back"; //Set Text (For formatted strings take sprintf) + b_back.callback=b_back_cb; //Call b_back_cb as Callback + gui_button_add(&b_back); //Register Button (and run the callback from now on) + + +/* + //tft test + tft_draw_pixel(0,0,BLACK); + tft_draw_pixel(319,239,BLACK); + tft_draw_pixel(10,210,BLUE); + tft_draw_pixel(12,210,BLUE); + tft_draw_rectangle(40,100,60,235,BLUE); + tft_fill_rectangle(100,215,200,225,GREEN); + tft_draw_line(10,50,310,225,RGB(0xFF,0,0xFF)); + tft_draw_circle(10,10,100, RED); + tft_print_line(30, 130, RED, BLUE, 0, "Hallo"); +*/ + + tft_draw_line(10,30,310,30,BLACK); + tft_print_line(10,18,BLUE,TRANSPARENT,0,"Name D H RO Date Time Size"); + + int y = 33; + + DIRECTORY_STRUCT* dir = filesystem_dir_open("."); + if(dir==NULL) return; + + for(int i=0; inum_files; i++) { + FILE_STRUCT* file = &(dir->files[i]); + tft_print_formatted(10,y, + (file->fattrib&F_DIR)?GREEN:RED, + TRANSPARENT,0,"%-13s%c %c %s %02u%02u%02u %02u:%02u:%02u %u", + file->fname, + (file->fattrib&F_DIR)?'D':' ', + (file->fattrib&F_HID)?'H':' ', + (file->fattrib&F_RDO)?"R ":"RW", + file->fdate.day, + file->fdate.month, + (file->fdate.year+1980)%100, + file->ftime.hour, + file->ftime.min, + file->ftime.sec*2, + file->fsize); + y+=14; + } + + + y+=14; + + FILE_HANDLE* file = filesystem_file_open("test.txt"); + if(file==NULL) { + tft_print_line(10,y,BLUE,TRANSPARENT,0,"Could not open test.txt"); + } else { + char buf [30]; + int size = (file->fsize>30)?29:file->fsize-1; + FILE_STATUS st = filesystem_file_read(file,buf,size); + + if(st==F_OK) { + buf[file->fpos]='\0'; + tft_print_formatted(10,y,BLUE,TRANSPARENT,0,"test.txt contains \"%s\"",buf); + long num = strtol(&(buf[file->fpos-4]),NULL,0); + num++; + + y+=14; + + if(filesystem_file_seek(file,file->fpos-4)!=F_OK) { + tft_print_formatted(10,y,BLUE,TRANSPARENT,0,"Could not seek to %d",file->fpos-4); + } else { + sprintf(buf,"%04d",num); + if(filesystem_file_write(file,buf,4) != F_OK) { + tft_print_formatted(10,y,BLUE,TRANSPARENT,0,"Could not write new number %d",num); + } else { + tft_print_formatted(10,y,BLUE,TRANSPARENT,0,"New number written %d",num); + } + } + } else { + tft_print_line(10,y,BLUE,TRANSPARENT,0,"Could not read from test.txt"); + } + + } + filesystem_file_close(file); + +} + +static void leave(void* screen) { + gui_button_remove(&b_back); +} + +static void update(void* screen) { +} + + +static SCREEN_STRUCT screen = { + enter, + leave, + update +}; + + +SCREEN_STRUCT* get_screen_filetest() { + return &screen; +} + + diff --git a/common/app/screen_filetest.h b/common/app/screen_filetest.h new file mode 100644 index 0000000..8897b10 --- /dev/null +++ b/common/app/screen_filetest.h @@ -0,0 +1,3 @@ +#include "screen.h" + +SCREEN_STRUCT* get_screen_filetest(); diff --git a/common/app/screen_main.c b/common/app/screen_main.c index b22dde4..6baebfe 100644 --- a/common/app/screen_main.c +++ b/common/app/screen_main.c @@ -1,17 +1,22 @@ #include "screen_main.h" #include "screen_guitest.h" #include "screen_pixytest.h" +#include "screen_filetest.h" #include "button.h" #include "tft.h" BUTTON_STRUCT b_guitest; BUTTON_STRUCT b_pixytest; - +BUTTON_STRUCT b_filetest; static void b_guitest_cb(void* button) { gui_screen_navigate(get_screen_guitest()); } +static void b_filetest_cb(void* button) { + gui_screen_navigate(get_screen_filetest()); +} + static void b_pixytest_cb(void* button) { gui_screen_navigate(get_screen_pixytest()); } @@ -33,7 +38,7 @@ static void enter(void* screen) { gui_button_add(&b_guitest); //Register Button (and run the callback from now on) //button to reach pixy test - b_pixytest.base.x1=200; //Start X of Button + b_pixytest.base.x1=150; //Start X of Button b_pixytest.base.y1=45; //Start Y of Button b_pixytest.base.x2=AUTO; //b_pixytest.base.x1+160; //Auto Calculate X2 with String Width b_pixytest.base.y2=AUTO; //Auto Calculate Y2 with String Height @@ -44,6 +49,18 @@ static void enter(void* screen) { b_pixytest.callback=b_pixytest_cb; //Call b_pixytest_cb as Callback gui_button_add(&b_pixytest); //Register Button (and run the callback from now on) + //button to reach filesystem test + b_filetest.base.x1=240; //Start X of Button + b_filetest.base.y1=45; //Start Y of Button + b_filetest.base.x2=AUTO; //b_filetest.base.x1+160; //Auto Calculate X2 with String Width + b_filetest.base.y2=AUTO; //Auto Calculate Y2 with String Height + b_filetest.txtcolor=WHITE; //Set foreground color + b_filetest.bgcolor=HEX(0x501EA0); //Set background color (Don't take 255 or 0 on at least one channel, to make shadows possible) + b_filetest.font=0; //Select Font + b_filetest.text="File Test"; //Set Text (For formatted strings take sprintf) + b_filetest.callback=b_filetest_cb; //Call b_filetest_cb as Callback + gui_button_add(&b_filetest); //Register Button (and run the callback from now on) + } @@ -51,6 +68,7 @@ static void enter(void* screen) { static void leave(void* screen) { gui_button_remove(&b_guitest); gui_button_remove(&b_pixytest); + gui_button_remove(&b_filetest); } static void update(void* screen) { diff --git a/common/filesystem/filesystem.c b/common/filesystem/filesystem.c new file mode 100644 index 0000000..1cd803f --- /dev/null +++ b/common/filesystem/filesystem.c @@ -0,0 +1,38 @@ +#include "filesystem.h" +#include "ll_filesystem.h" + +bool filesystem_init() { + return ll_filesystem_init(); +} + +DIRECTORY_STRUCT* filesystem_dir_open(const char* path) { + return ll_filesystem_dir_open(path); +} + +void filesystem_dir_close(DIRECTORY_STRUCT* dir) { + filesystem_dir_close(dir); +} + +FILE_HANDLE* filesystem_file_open(const char* filename) { + return ll_filesystem_file_open(filename); +} + +void filesystem_file_close(FILE_HANDLE* handle) { + ll_filesystem_file_close(handle); +} + +FILE_STATUS filesystem_file_seek(FILE_HANDLE* handle, uint32_t offset) { + return ll_filesystem_file_seek(handle,offset); +} + +FILE_STATUS filesystem_file_read(FILE_HANDLE* handle, uint8_t* buf, uint32_t size) { + return ll_filesystem_file_read(handle,buf,size); +} + +FILE_STATUS filesystem_file_write(FILE_HANDLE* handle, uint8_t* buf, uint32_t size) { + return ll_filesystem_file_write(handle,buf,size); +} + + + + diff --git a/common/filesystem/filesystem.h b/common/filesystem/filesystem.h index e69de29..164d76e 100644 --- a/common/filesystem/filesystem.h +++ b/common/filesystem/filesystem.h @@ -0,0 +1,71 @@ +#ifndef FILESYSTEM_H +#define FILESYSTEM_H + +#include +#include + +typedef enum { + F_DIR=1, + F_RDO=2, + F_HID=4, + F_SYS=8, + F_ARC=16 +} FILE_ATTRIBUTES; + + +typedef struct { + unsigned year : 7; //year from 1980 (0..127) + unsigned month: 4; //month (1..12) + unsigned day: 5; //day (1..31) +} FILE_DATE_STRUCT; + + +typedef struct { + unsigned hour : 5; //hour (0..23) + unsigned min: 6; //minute (0..59 + unsigned sec: 5; //second/2 (0..29) +} FILE_TIME_STRUCT; + + +typedef struct { + uint32_t fsize; /* File size */ + FILE_DATE_STRUCT fdate; /* Last modified date */ + FILE_TIME_STRUCT ftime; /* Last modified time */ + uint8_t fattrib; /* Attribute */ + char* fname; /* File name */ +} FILE_STRUCT; + +typedef struct { + const char* path; + uint16_t num_files; + FILE_STRUCT* files; +} DIRECTORY_STRUCT; + +typedef struct { + const char* fname; + uint32_t fpos; + uint32_t fsize; +} FILE_HANDLE; + +typedef enum { + F_OK, + F_EOF, + F_EACCESS, + F_INVALIDPARAM, + F_DISKERROR +} FILE_STATUS; + + +bool filesystem_init(); + +DIRECTORY_STRUCT* filesystem_dir_open(const char* path); +void filesystem_dir_close(DIRECTORY_STRUCT* dir); +FILE_HANDLE* filesystem_file_open(const char* filename); +void filesystem_file_close(FILE_HANDLE* handle); +FILE_STATUS filesystem_file_seek(FILE_HANDLE* handle, uint32_t offset); +FILE_STATUS filesystem_file_read(FILE_HANDLE* handle, uint8_t* buf, uint32_t size); +FILE_STATUS filesystem_file_write(FILE_HANDLE* handle, uint8_t* buf, uint32_t size); + + +#endif /* FILESYSTEM_H */ + diff --git a/common/lowlevel/ll_filesystem.h b/common/lowlevel/ll_filesystem.h new file mode 100644 index 0000000..6190598 --- /dev/null +++ b/common/lowlevel/ll_filesystem.h @@ -0,0 +1,11 @@ +#include "filesystem.h" + +bool ll_filesystem_init(); + +DIRECTORY_STRUCT* ll_filesystem_dir_open(const char* path); +void ll_filesystem_dir_close(DIRECTORY_STRUCT* dir); +FILE_HANDLE* ll_filesystem_file_open(const char* filename); +void ll_filesystem_file_close(FILE_HANDLE* handle); +FILE_STATUS ll_filesystem_file_seek(FILE_HANDLE* handle, uint32_t offset); +FILE_STATUS ll_filesystem_file_read(FILE_HANDLE* handle, uint8_t* buf, uint32_t size); +FILE_STATUS ll_filesystem_file_write(FILE_HANDLE* handle, uint8_t* buf, uint32_t size); diff --git a/discovery/src/ll_filesystem.c b/discovery/src/ll_filesystem.c new file mode 100644 index 0000000..fda6515 --- /dev/null +++ b/discovery/src/ll_filesystem.c @@ -0,0 +1,38 @@ +#include "ll_filesystem.h" +#include + +bool ll_filesystem_init() { + return false; +} + +DIRECTORY_STRUCT* ll_filesystem_dir_open(const char* path) { + return NULL; +} + +void ll_filesystem_dir_close(DIRECTORY_STRUCT* dir) { + + +} + +FILE_HANDLE* ll_filesystem_file_open(const char* filename) { + return NULL; +} + +void ll_filesystem_file_close(FILE_HANDLE* handle) { + +} + +FILE_STATUS ll_filesystem_file_seek(FILE_HANDLE* handle, uint32_t offset) { + return F_DISKERROR; +} + +FILE_STATUS ll_filesystem_file_read(FILE_HANDLE* handle, uint8_t* buf, uint32_t size) { + return F_DISKERROR; +} + +FILE_STATUS ll_filesystem_file_write(FILE_HANDLE* handle, uint8_t* buf, uint32_t size) { + return F_DISKERROR; +} + + + diff --git a/emulator/emulated/.hidden b/emulator/emulated/.hidden new file mode 100644 index 0000000..e69de29 diff --git a/emulator/emulated/dir1/subfile1.txt b/emulator/emulated/dir1/subfile1.txt new file mode 100644 index 0000000..e69de29 diff --git a/emulator/emulated/emtpy.txt b/emulator/emulated/emtpy.txt new file mode 100644 index 0000000..e69de29 diff --git a/emulator/emulated/test.txt b/emulator/emulated/test.txt new file mode 100644 index 0000000..9bbe689 --- /dev/null +++ b/emulator/emulated/test.txt @@ -0,0 +1 @@ +Hallo Test 1241 diff --git a/emulator/emulated/test2.txt b/emulator/emulated/test2.txt new file mode 100644 index 0000000..aaaa72b --- /dev/null +++ b/emulator/emulated/test2.txt @@ -0,0 +1 @@ +hallo welt diff --git a/emulator/qt/emulatorqt.pro b/emulator/qt/emulatorqt.pro index 47b672c..c5ea145 100644 --- a/emulator/qt/emulatorqt.pro +++ b/emulator/qt/emulatorqt.pro @@ -15,14 +15,16 @@ SOURCES += \ main.cpp \ ll_tft.cpp \ ll_system.cpp \ - ll_touch.cpp + ll_touch.cpp \ + ll_filesystem.cpp HEADERS += \ mainwindow.h \ INCLUDEPATH+= ../../common/lowlevel/ \ ../../common/touch/ \ - ../../common/tft/ + ../../common/tft/ \ + ../../common/filesystem FORMS += \ diff --git a/emulator/qt/ll_filesystem.cpp b/emulator/qt/ll_filesystem.cpp new file mode 100644 index 0000000..a89e08d --- /dev/null +++ b/emulator/qt/ll_filesystem.cpp @@ -0,0 +1,181 @@ +extern "C" { + #include "ll_filesystem.h" +} +#include +#include +#include +#include +#include + +QDir rootdir ("./emulated"); + +bool ll_filesystem_init() { + if(!rootdir.exists()) { + qWarning() << "Filesystem can not be emulated because the 'emulated' folder does not exist"; + return false; + } + return true; +} + +DIRECTORY_STRUCT* ll_filesystem_dir_open(const char* path) { + QDir d(rootdir); + d.cd(path); + if(!d.exists()) { + return NULL; + } + + DIRECTORY_STRUCT* directory = new DIRECTORY_STRUCT(); + QFileInfoList entries = d.entryInfoList(QDir::NoDotAndDotDot|QDir::Files|QDir::Dirs|QDir::Readable|QDir::Writable|QDir::Hidden|QDir::System); + directory->path = path; + directory->num_files = entries.count(); + directory->files = new FILE_STRUCT[directory->num_files]; + + + for(int i=0; ifiles[i]); + entry->fattrib = 0; + entry->fname = new char[fi.fileName().length()+1]; + strcpy(entry->fname,fi.fileName().toStdString().c_str()); + if(fi.isDir()) { + entry->fattrib|=F_DIR; + entry->fsize = 0; + } else { + entry->fsize = fi.size(); + } + if(fi.isHidden()) { + entry->fattrib|=F_HID; + } + if(!fi.isWritable()) { + entry->fattrib|=F_RDO; + } + + QDateTime dt = fi.lastModified(); + entry->fdate.year = dt.date().year()-1980; + entry->fdate.month = dt.date().month(); + entry->fdate.day = dt.date().day(); + entry->ftime.hour = dt.time().hour(); + entry->ftime.min = dt.time().minute(); + entry->ftime.sec = dt.time().second()/2; + + } + + return directory; +} + +void ll_filesystem_dir_close(DIRECTORY_STRUCT* dir) { + if(dir!=NULL) { + for(int i=0; inum_files; i++) { + delete dir->files[i].fname; + } + delete[] dir->files; + delete dir; + } +} + + +struct QT_FILE_HANDLE : FILE_HANDLE { + QFile* file; +}; + + +FILE_HANDLE* ll_filesystem_file_open(const char* filename) { + if(!rootdir.exists()) { + return NULL; + } + QString filepath = rootdir.absoluteFilePath(filename); + QFile* f = new QFile(filepath); + if(!f->exists()) { + return NULL; + } + + if(!f->open(QFile::ReadWrite)) { + return NULL; + } + + QT_FILE_HANDLE* fh = new QT_FILE_HANDLE(); + fh->file = f; + fh->fname = filename; + fh->fpos =0; + fh->fsize = f->size(); + return fh; +} + +void ll_filesystem_file_close(FILE_HANDLE* handle) { + if(handle!=NULL) { + QT_FILE_HANDLE* fh = static_cast(handle); + if(fh->file->isOpen()) { + fh->file->close(); + } + delete fh; + } +} + +FILE_STATUS ll_filesystem_file_seek(FILE_HANDLE* handle, uint32_t offset) { + if(handle==NULL) { + return F_INVALIDPARAM; + } + QT_FILE_HANDLE* fh = static_cast(handle); + if(!fh->file->isOpen()) { + return F_DISKERROR; + } + if(offset>=fh->file->size()) { + return F_INVALIDPARAM; + } + + if(fh->file->seek(offset)) { + fh->fpos = offset; + return F_OK; + } else { + return F_DISKERROR; + } +} + +FILE_STATUS ll_filesystem_file_read(FILE_HANDLE* handle, uint8_t* buf, uint32_t size) { + if(handle==NULL || buf==NULL) { + return F_INVALIDPARAM; + } + QT_FILE_HANDLE* fh = static_cast(handle); + if(!fh->file->isOpen()) { + return F_DISKERROR; + } + if(!fh->file->isReadable()) { + return F_EACCESS; + } + qint64 bytesRead = fh->file->read((char*)buf,size); + if(bytesRead<0) { + return F_DISKERROR; + } + fh->fpos+=bytesRead; + if(bytesRead!=size) { + return F_EOF; + } else { + return F_OK; + } +} + +FILE_STATUS ll_filesystem_file_write(FILE_HANDLE* handle, uint8_t* buf, uint32_t size) { + if(handle==NULL) { + return F_INVALIDPARAM; + } + QT_FILE_HANDLE* fh = static_cast(handle); + if(!fh->file->isOpen()) { + return F_DISKERROR; + } + if(!fh->file->isWritable()) { + return F_EACCESS; + } + qint64 bytesWritten = fh->file->write((char*)buf,size); + if(bytesWritten<0) { + return F_DISKERROR; + } + fh->fpos+=bytesWritten; + if(bytesWritten!=size) { + return F_EOF; + } else { + return F_OK; + } +} + + + From 790f60269af8d4725c69eda1de45da37fa57d851 Mon Sep 17 00:00:00 2001 From: t-moe Date: Sun, 10 May 2015 02:22:17 +0200 Subject: [PATCH 04/11] Added bitmap decoding/drawing example --- common/app/screen_filetest.c | 49 ++++++++++++++++++++++++++++++++++- emulator/emulated/cpu.bmp | Bin 0 -> 16522 bytes 2 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 emulator/emulated/cpu.bmp diff --git a/common/app/screen_filetest.c b/common/app/screen_filetest.c index b381c48..61767f2 100644 --- a/common/app/screen_filetest.c +++ b/common/app/screen_filetest.c @@ -12,6 +12,9 @@ static void b_back_cb(void* button) { gui_screen_back(); } + +static void image_test(); + static void enter(void* screen) { tft_clear(HEX(0xBABECD)); @@ -103,7 +106,8 @@ static void enter(void* screen) { } filesystem_file_close(file); - + + image_test(); } static void leave(void* screen) { @@ -125,4 +129,47 @@ SCREEN_STRUCT* get_screen_filetest() { return &screen; } +static void image_test() { + //Source: http://stackoverflow.com/a/17040962/2606757 + FILE_HANDLE* file = filesystem_file_open("cpu.bmp"); + if(file==NULL) { + tft_print_line(10,180,BLUE,TRANSPARENT,0,"Could not open cpu.bmp"); + return; + } + + + unsigned char info[54]; + if(filesystem_file_read(file,info,54)!=F_OK) { + tft_print_line(10,180,BLUE,TRANSPARENT,0,"Could not read header of cpu.bmp"); + filesystem_file_close(file); + return; + } + + // extract image height and width from header + int width = *(int*)&info[18]; + int height = *(int*)&info[22]; + + filesystem_file_seek(file,*(int*)&info[10]); + + unsigned char data [width*4]; + tft_draw_rectangle(100-1,160-1,100-1+width,160-1+height,BLACK); + + for(int i = 0; i < height; i++) + { + filesystem_file_read(file,data,width*4); + for(int j = 0; j < width*4; j += 4) + { + unsigned char a = data[j]; + unsigned char r = data[j+1]; + unsigned char g = data[j+2]; + unsigned char b = data[j+3]; + if(a!=0) { + tft_draw_pixel(100+j/4,160+height-1-i,RGB(r,g,b)); + } + } + } + + filesystem_file_close(file); + +} diff --git a/emulator/emulated/cpu.bmp b/emulator/emulated/cpu.bmp new file mode 100644 index 0000000000000000000000000000000000000000..d863e3ed860dec6db784eefd209257e42d5fcee6 GIT binary patch literal 16522 zcmeHOO^g&p6dnZe2mcb{9~wo2hWHbs_%F(e2TlBm8i<7L?pcZ1g9*VzZjua%>~znv z2&)`e=;_%&V#taKUKA4&jYlse9@K*gQKKF_xR`*-isScH_Z!|c)8i1PciL$tTU#~t zy1MFnRrTuCdv8`gKRQq_pHckZgftMPIfccAxhS(@;es&nYxt=b3gI8W)>l6L@|&B# zIKFh~&`nn_9{F|7z_MivHxCcrJ}^8ye{y2tlI53vGk1x#{l2KN$>!-V=TM%ST0J-L z?DvDR^(XS_pklwSU$@6|9`rryXy7?BzH1%vx30Ze(@{U>mz@)VXB`j9j;m=^_tjhd zvi+55TeiLnDuYcJ0@vB#d(JWTU3Hzk^?G5BZa*94np+&e`0A2?^$+qy`o{PU3N6Yx z)#ih?i(|C<lW2K zYmH8&Qt1NWKlg{G`4#(qp-p(hS85u|c;Dqh56VLiXgYYkLTIJZig}u5%A>{Wgnm9x zp93|o_%LMDTiBuk@+nrnG(_cHC>YF)#za6Z!DK@xW8 zGY=WPSJqySa_H8-$=TX%9%LQ6$lNq|K%H9TyjfS#n$OC-3wFud@u1z=NS%%P74=!B zTBJ+iy(M{f;M!}s$FhoD#;JKgnJD$t4?-ESZjs>hUFQj6#~kmM=a}QJwaQ?1?aflp zJIAgqgV$$azss1Ca`J#Ok>^t58R%)mL|wU2N36IzW1XLBs!PD%>dvOyWvOh=qYm)X ze!zRX9(&UK_alC+{bRts5otzvkQ@B8p}>yBeLeIH4 zT&FzY2ksfn|F?O?Z+tA3q1&L}j~kmi?Cz6paaq6ae-`< zs_#VpLwEk6Ix=|2#KiE0)Gc%h{Z!^`nb!Mj(sS+{A76iwu1hLojy~J%4c@5VD`oZ> zxI=fN?a%S{N&0^)oUCIXV#5+YL?`&MZvwWjRf+E9$H07i*ua`Le)`_k z-H-it3x5McOuq={A2ui4uXL)p_Ifj)u)8(dri>rD;0fS;x6xl0@nhe=4Xls(p8chM zf4lWh{IumZo=+J+`Z0TG_g3o`u05uGrNJvWj!xtscvt1KwTks3-nCOF%0$wzzdml@ ziS{P%*jVS2I^hoT4xbNgjFC>-W&HFz3r_Am_LubO2!Gl6eoxt2(klLhbye58hxWKQ z{-i!(w_AXI-)lVIW&BC~wyN(0e`B1nJ>Kj3B>CS8C)Ym4JI1q&$#?C0`CLEZr)&|N zz&y&BES!N~>-jnx`LEk$shl+b@$(;h^GJN$dBP9uxc}NeX&&SWKlHPsxC1`|J^mx? z_rpxE2|eDg`=2pcf)lp?gYEo+{V4xh$^WFfJmIH4#@J0JiQ(%<{KO_W#m|F#^#=L@ zMF!?Y{+YWe>Ip_=mFfyM8vCWqaDhrFG)}$L|-6 z?BluEF8(Eo{V}>irg>mb^Zv{;jj>=dKd?od5&uG6KxAO6Gmv_avW?A%T*xjDPGe_$ zBIKHhhhz+w*kW7ZY*z>S#7qAV9wcLD3|~8p|3%9_57NUfyh-8#Wun-VdX;kw9A|vZ zpXYkQef)}@6#>pYkZ?7{7?~3t`SWWyE1u2AB(23EPiLw8H3SG4`Z@OV;{{lXBG8b z(q{8ReK{`c&j0>1Kfiy)IrF5Rf68C_`(+K%rmE>E8($;ok+{A3J9qVW*5krc literal 0 HcmV?d00001 From f332364a4465fda75d2485b1b9d4f3ac45325561 Mon Sep 17 00:00:00 2001 From: t-moe Date: Sun, 10 May 2015 14:15:28 +0200 Subject: [PATCH 05/11] Added scripts to update/create file headers --- genheader.sh | 15 +++++++++++++++ updateheaders.sh | 19 +++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100755 genheader.sh create mode 100755 updateheaders.sh diff --git a/genheader.sh b/genheader.sh new file mode 100755 index 0000000..7be2999 --- /dev/null +++ b/genheader.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +echo "/**************************************************************************************************************************************" +echo "* Project: discoverpixy" +echo "* Authors: Aaron Schmocker, Timo Lang" +echo "* Institution: BFH Bern University of Applied Sciences" +echo "* File: $1" +echo "*" +echo "* Version History:" +echo "* Date Autor Email SHA Changes" + +git log --pretty=format:"* %ad%x09%ae%x09%h%x09%s" --date=short --date-order --no-merges --reverse $1 | grep -v -i "fileheader" + +echo "*" +echo "**************************************************************************************************************************************/" diff --git a/updateheaders.sh b/updateheaders.sh new file mode 100755 index 0000000..84068bb --- /dev/null +++ b/updateheaders.sh @@ -0,0 +1,19 @@ +#!/bin/bash + + +FILES=`find common/ emulator/ discovery/ -name "*.c" -or -name "*.h" -or -name "*.cpp" | grep -v libs | grep -v /pixy/` + +for FILE in $FILES; do + echo "Adding Header to $FILE" + + #remove old header + CONTENT=$(perl -0777 -pe 's%^/\*.*?discoverpixy.*?\*/%%igs' $FILE) + + #add new header + ./genheader.sh $FILE > $FILE + + #append file content + echo "$CONTENT" >> $FILE + +done + From b6ab7c8e3941846d05b13fec380e81f483e0bb32 Mon Sep 17 00:00:00 2001 From: t-moe Date: Sun, 10 May 2015 14:54:07 +0200 Subject: [PATCH 06/11] Fixed compiler warning in tft and screen module. --- common/gui/screen.c | 8 ++++---- common/tft/tft.c | 1 + 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/common/gui/screen.c b/common/gui/screen.c index a8a34ea..23315f0 100644 --- a/common/gui/screen.c +++ b/common/gui/screen.c @@ -1,8 +1,8 @@ #include "screen.h" -static volatile SCREEN_STRUCT* screen_list = NULL; -static volatile SCREEN_STRUCT* screen_current = NULL; +static SCREEN_STRUCT* screen_list = NULL; +static SCREEN_STRUCT* screen_current = NULL; static volatile SCREEN_STRUCT* screen_goto = NULL; SCREEN_STRUCT* gui_screen_get_current() { @@ -11,7 +11,7 @@ SCREEN_STRUCT* gui_screen_get_current() { void gui_screen_update() { if(screen_goto!=NULL) { //we received the task to switch the screen - SCREEN_STRUCT* go = screen_goto; //Backup volatile variable + SCREEN_STRUCT* go = (SCREEN_STRUCT*) screen_goto; //Backup volatile variable screen_goto=NULL; if(go->next!=NULL) { //we're going back if(go->next!=screen_current) return; //list corrupted? @@ -26,7 +26,7 @@ void gui_screen_update() { } } go->on_enter(go); - screen_current = go; + screen_current =go; } if(screen_current!=NULL) { //A screen has been set diff --git a/common/tft/tft.c b/common/tft/tft.c index 67fc977..2395668 100644 --- a/common/tft/tft.c +++ b/common/tft/tft.c @@ -2,6 +2,7 @@ #include "ll_tft.h" #include #include +#include bool tft_init() { return ll_tft_init(); From 92ba7347b23dbd6e8e1bfa47bcf526061e96fecc Mon Sep 17 00:00:00 2001 From: t-moe Date: Sun, 10 May 2015 16:28:10 +0200 Subject: [PATCH 07/11] Added eclipse project for emulator again. --- emulator/.cproject | 67 ++++++++++++++++++++++++ emulator/.project | 34 ++++++++++++ emulator/.settings/language.settings.xml | 12 +++++ 3 files changed, 113 insertions(+) create mode 100644 emulator/.cproject create mode 100644 emulator/.project create mode 100644 emulator/.settings/language.settings.xml diff --git a/emulator/.cproject b/emulator/.cproject new file mode 100644 index 0000000..a2928cc --- /dev/null +++ b/emulator/.cproject @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/emulator/.project b/emulator/.project new file mode 100644 index 0000000..a24c1f6 --- /dev/null +++ b/emulator/.project @@ -0,0 +1,34 @@ + + + discoverpixy emulator + + + + + + org.eclipse.cdt.managedbuilder.core.genmakebuilder + clean,full,incremental, + + + + + org.eclipse.cdt.managedbuilder.core.ScannerConfigBuilder + full,incremental, + + + + + + org.eclipse.cdt.core.cnature + org.eclipse.cdt.core.ccnature + org.eclipse.cdt.managedbuilder.core.managedBuildNature + org.eclipse.cdt.managedbuilder.core.ScannerConfigNature + + + + common + 2 + PARENT-1-PROJECT_LOC/common + + + diff --git a/emulator/.settings/language.settings.xml b/emulator/.settings/language.settings.xml new file mode 100644 index 0000000..bb96037 --- /dev/null +++ b/emulator/.settings/language.settings.xml @@ -0,0 +1,12 @@ + + + + + + + + + + + + From 21edc56c572b8a8b800154a75d0ba17b1cf9916e Mon Sep 17 00:00:00 2001 From: t-moe Date: Sun, 10 May 2015 16:30:14 +0200 Subject: [PATCH 08/11] Added doxyfile (doxygen) for the common folder. Started with doxygen comments for app and tft module. --- Doxyfile | 2414 ++++++++++++++++++++++++++++++++++ common/app/app.h | 28 + common/app/screen_filetest.c | 1 - common/app/screen_filetest.h | 19 + common/app/screen_guitest.h | 20 + common/app/screen_main.h | 19 + common/app/screen_pixytest.h | 18 + common/tft/tft.h | 129 +- doc/.gitignore | 1 + 9 files changed, 2645 insertions(+), 4 deletions(-) create mode 100644 Doxyfile diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..9ff1371 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2414 @@ +# Doxyfile 1.8.9.1 + +# 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 = discoverpixy + +# 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 a logo or an 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 = doc/ + +# 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 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = 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 = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# 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 = YES + +# 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 = NO + +# 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 = NO + +# 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 (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), 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 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 = NO + +# 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 = YES + +# 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 = YES + +# 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. If 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 = YES + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= 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 = NO + +# 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 = NO + +# 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. 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 = NO + +# 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 = + +#--------------------------------------------------------------------------- +# 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 = common + +# 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 = *.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 \ + *.js + +# 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 = moc_* \ + ui_* + +# 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 = + +# 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 = YES + +#--------------------------------------------------------------------------- +# 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 = html + +# 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 additional user-defined +# cascading style sheets that are 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 therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). 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 style sheet 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. Furthermore it +# enables the Previous and Next buttons. +# 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 style sheets (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 = 4 + +# 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 + +# If 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 pre-rendered 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 +# , /