├── gui ├── sounds │ ├── ring3.wav │ ├── ringin.wav │ ├── incomingcall.wav │ ├── outgoingcall.wav │ └── outgoingcallbusy.wav ├── images │ └── Oxygen-plugin.ico ├── NetExample_images.qrc ├── NetExampleNotify.cpp ├── NetExampleMainpage.h ├── paintwidget.h ├── NetExampleNotify.h ├── paintwidget.cpp ├── NetExampleMainpage.cpp └── NetExampleMainpage.ui ├── .gitmodules ├── cptest ├── docs ├── Mainpage.dox └── Doxyfile ├── rename_plugin.sh ├── README.md ├── NetExample.pro ├── interface └── rsNetExample.h ├── NetExamplePlugin.h ├── services ├── p3NetExample.h ├── rsNetExampleItems.h ├── rsNetExampleItems.cc └── p3NetExample.cc └── NetExamplePlugin.cpp /gui/sounds/ring3.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chozabu/ExampleRSPlugin/master/gui/sounds/ring3.wav -------------------------------------------------------------------------------- /gui/sounds/ringin.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chozabu/ExampleRSPlugin/master/gui/sounds/ringin.wav -------------------------------------------------------------------------------- /gui/images/Oxygen-plugin.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chozabu/ExampleRSPlugin/master/gui/images/Oxygen-plugin.ico -------------------------------------------------------------------------------- /gui/sounds/incomingcall.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chozabu/ExampleRSPlugin/master/gui/sounds/incomingcall.wav -------------------------------------------------------------------------------- /gui/sounds/outgoingcall.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chozabu/ExampleRSPlugin/master/gui/sounds/outgoingcall.wav -------------------------------------------------------------------------------- /gui/sounds/outgoingcallbusy.wav: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chozabu/ExampleRSPlugin/master/gui/sounds/outgoingcallbusy.wav -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "html"] 2 | path = html 3 | url = git@github.com:RetroShare/ExampleRSPlugin.git 4 | branch = gh-pages 5 | -------------------------------------------------------------------------------- /gui/NetExample_images.qrc: -------------------------------------------------------------------------------- 1 | 2 | 3 | images/Oxygen-plugin.ico 4 | 5 | 6 | -------------------------------------------------------------------------------- /cptest: -------------------------------------------------------------------------------- 1 | kdesudo -u retrotester cp lib*.so* /home/retrotester/.retroshare/extensions6/ 2 | kdesudo -u retrotester /home/chozabu/git/RetroShare/retroshare-gui/src/RetroShare 3 | 4 | -------------------------------------------------------------------------------- /docs/Mainpage.dox: -------------------------------------------------------------------------------- 1 | /** 2 | @brief Documentation for the RetroShare Chatserver Sources 3 | @author chozabu & cave 4 | @file 5 | */ 6 | /** @defgroup RetroShare */ 7 | /** 8 | @mainpage RetroShare Example Plugin 9 | This guide should help you to create your own Plugin. 10 | It should point you to the direction how to untangle the code and run some networking. 11 | */ 12 | -------------------------------------------------------------------------------- /rename_plugin.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | newname=$1 3 | oldname="NetExample" 4 | echo "$newname" 5 | echo "$oldname" 6 | find . -not -path '*/\.*' -type f -print0 | xargs -0 sed -i "s/$oldname/$newname/g" 7 | #find . -type f -exec rename "s/$oldname/$newname/' '{}" \; 8 | find . | sed -e "p;s/$oldname/$newname/" | xargs -n2 git mv 9 | 10 | echo "now change 0x12345 in services/*items.h to a unique value of your choice to identify your plugin!" 11 | -------------------------------------------------------------------------------- /gui/NetExampleNotify.cpp: -------------------------------------------------------------------------------- 1 | #include "NetExampleNotify.h" 2 | 3 | NetExampleNotify::NetExampleNotify(QObject *parent) : QObject(parent) 4 | { 5 | 6 | } 7 | 8 | void NetExampleNotify::notifyReceivedPaint(const RsPeerId &peer_id, int x, int y) 9 | { 10 | std::cout << "pNotify Recvd paint from: " << peer_id; 11 | std::cout << " at " << x << " , " << y; 12 | std::cout << std::endl; 13 | emit NePaintArrived(peer_id, x, y); 14 | } 15 | 16 | 17 | void NetExampleNotify::notifyReceivedMsg(const RsPeerId& peer_id, QString str) 18 | { 19 | std::cout << "pNotify Recvd Packet from: " << peer_id; 20 | std::cout << " saying " << str.toStdString(); 21 | std::cout << std::endl; 22 | emit NeMsgArrived(peer_id, str) ; 23 | } 24 | -------------------------------------------------------------------------------- /gui/NetExampleMainpage.h: -------------------------------------------------------------------------------- 1 | /* This is the main page displayed by the plugin */ 2 | #ifndef NEMAINPAGE_H 3 | #define NEMAINPAGE_H 4 | 5 | #include 6 | #include 7 | #include 8 | #include "gui/NetExampleNotify.h" 9 | 10 | 11 | 12 | #include 13 | 14 | namespace Ui { 15 | class NetExampleMainpage; 16 | } 17 | 18 | class NetExampleMainpage : public MainPage 19 | { 20 | Q_OBJECT 21 | 22 | public: 23 | explicit NetExampleMainpage(QWidget *parent, NetExampleNotify *notify); 24 | ~NetExampleMainpage(); 25 | 26 | private slots: 27 | void mmEvent(int x, int y); 28 | void on_pingAllButton_clicked(); 29 | void NeMsgArrived(const RsPeerId &peer_id, QString str); 30 | 31 | void on_broadcastButton_clicked(); 32 | 33 | void NePaintArrived(const RsPeerId &peer_id, int x, int y); 34 | private: 35 | Ui::NetExampleMainpage *ui; 36 | NetExampleNotify *mNotify; 37 | }; 38 | 39 | #endif // NEMAINPAGE_H 40 | -------------------------------------------------------------------------------- /gui/paintwidget.h: -------------------------------------------------------------------------------- 1 | /* this is just a local widget that can be drawn on */ 2 | #ifndef PAINTWIDGET_H 3 | #define PAINTWIDGET_H 4 | 5 | #include 6 | #include 7 | #include 8 | #include 9 | 10 | class TopJCDialog; 11 | 12 | class PaintWidget : public QWidget 13 | { 14 | Q_OBJECT 15 | public: 16 | explicit PaintWidget(QWidget *parent = 0); 17 | void setImage(const QImage&); 18 | QImage getImage(); 19 | 20 | void fillImage(QColor color); 21 | virtual void paintAt(int x, int y); 22 | 23 | QColor color; 24 | uint8_t penWidth; 25 | TopJCDialog* tjd; 26 | 27 | signals: 28 | void haveUpdate(); 29 | void mmEvent(int x, int y); 30 | 31 | 32 | public slots: 33 | 34 | protected: 35 | virtual void mouseReleaseEvent(QMouseEvent * event); 36 | virtual void paintEvent(QPaintEvent *); 37 | virtual void mouseMoveEvent(QMouseEvent *); 38 | 39 | private: 40 | QImage image; 41 | 42 | }; 43 | 44 | #endif // PAINTWIDGET_H 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | RS .6 Example Plugin 2 | ================== 3 | 4 | This is somewhat based on the VOIP plugin. 5 | 6 | Simplified to make it easier to see how things work. 7 | 8 | Features broadcast chat and broadcast paint 9 | all networking is doing by encoding to json rather than the more compact+speedy but verbose multiple RsItem method. 10 | A good middle ground could be msgpack 11 | 12 | ##Compile & run 13 | 14 | Depends on qt5.4+ 15 | 16 | this plugin should be built in the retroshare plugins directory, along the lines of: 17 | 18 | cd myretrosharedir/plugins 19 | git clone https://github.com/RetroShare/ExampleRSPlugin.git 20 | cd ExampleRSPlugin 21 | qmake 22 | make 23 | cp *so* ~/.retroshare/extensions6/ 24 | 25 | Then reboot retroshare, it will ask if you want to accept the plugin. 26 | 27 | ##Build Plugin based on this plugin 28 | 29 | To use as a basis for your own plugins you can run 30 | 31 | ./rename_plugin.sh NewPluginName 32 | 33 | This will replace all instances of "NetExample" with "NewPluginName" 34 | you must also change the plugins ID from 12345 to a number of your choosing. 35 | -------------------------------------------------------------------------------- /NetExample.pro: -------------------------------------------------------------------------------- 1 | !include("../Common/retroshare_plugin.pri"): error("Could not include file ../Common/retroshare_plugin.pri") 2 | 3 | greaterThan(QT_MAJOR_VERSION, 4) { 4 | # Qt 5 5 | QT += widgets 6 | } 7 | 8 | exists($$[QMAKE_MKSPECS]/features/mobility.prf) { 9 | CONFIG += mobility 10 | } else { 11 | QT += multimedia 12 | } 13 | CONFIG += qt uic qrc resources 14 | MOBILITY = multimedia 15 | 16 | DEPENDPATH += ../../retroshare-gui/src/temp/ui ../../libretroshare/src 17 | INCLUDEPATH += ../../retroshare-gui/src/temp/ui ../../libretroshare/src 18 | 19 | #################################### Windows ##################################### 20 | 21 | linux-* { 22 | INCLUDEPATH += /usr/include 23 | LIBS += $$system(pkg-config --libs opencv) 24 | } 25 | 26 | win32 { 27 | LIBS_DIR = $$PWD/../../../libs 28 | LIBS += -L"$$LIBS_DIR/lib/opencv" 29 | 30 | OPENCV_VERSION = 249 31 | LIBS += -lopencv_core$$OPENCV_VERSION -lopencv_highgui$$OPENCV_VERSION -lopencv_imgproc$$OPENCV_VERSION -llibjpeg -llibtiff -llibpng -llibjasper -lIlmImf -lole32 -loleaut32 -luuid -lavicap32 -lavifil32 -lvfw32 -lz 32 | } 33 | 34 | QMAKE_CXXFLAGS *= -Wall 35 | 36 | SOURCES = NetExamplePlugin.cpp \ 37 | services/p3NetExample.cc \ 38 | services/rsNetExampleItems.cc \ 39 | gui/NetExampleMainpage.cpp \ 40 | gui/NetExampleNotify.cpp \ 41 | gui/paintwidget.cpp 42 | 43 | HEADERS = NetExamplePlugin.h \ 44 | services/p3NetExample.h \ 45 | services/rsNetExampleItems.h \ 46 | interface/rsNetExample.h \ 47 | gui/NetExampleMainpage.h \ 48 | gui/NetExampleNotify.h \ 49 | gui/paintwidget.h 50 | 51 | #FORMS = gui/AudioInputConfig.ui 52 | 53 | TARGET = NetExample 54 | 55 | RESOURCES = gui/NetExample_images.qrc 56 | 57 | 58 | LIBS += -lspeex -lspeexdsp 59 | 60 | FORMS += \ 61 | gui/NetExampleMainpage.ui 62 | -------------------------------------------------------------------------------- /gui/NetExampleNotify.h: -------------------------------------------------------------------------------- 1 | /**************************************************************** 2 | * RetroShare is distributed under the following license: 3 | * 4 | * Copyright (C) 2015 5 | * 6 | * This program is free software; you can redistribute it and/or 7 | * modify it under the terms of the GNU General Public License 8 | * as published by the Free Software Foundation; either version 2 9 | * of the License, or (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, 19 | * Boston, MA 02110-1301, USA. 20 | ****************************************************************/ 21 | 22 | // This class is a Qt object to get notification from the plugin's service threads, 23 | // and responsible to pass the info the the GUI part. 24 | // 25 | // Because the GUI part is async-ed with the service, it is crucial to use the 26 | // QObject connect system to communicate between the p3Service and the gui part (handled by Qt) 27 | // 28 | #ifndef NETEXAMPLENOTIFY_H 29 | #define NETEXAMPLENOTIFY_H 30 | 31 | #include 32 | 33 | #include 34 | 35 | class NetExampleNotify : public QObject 36 | { 37 | Q_OBJECT 38 | public: 39 | explicit NetExampleNotify(QObject *parent = 0); 40 | void notifyReceivedPaint(const RsPeerId &peer_id, int x, int y) ; 41 | void notifyReceivedMsg(const RsPeerId &peer_id, QString str) ; 42 | 43 | signals: 44 | void NeMsgArrived(const RsPeerId &peer_id, QString str) ; // emitted when the peer gets a msg 45 | void NePaintArrived(const RsPeerId &peer_id, int x, int y) ; 46 | 47 | public slots: 48 | }; 49 | 50 | #endif // NETEXAMPLENOTIFY_H 51 | -------------------------------------------------------------------------------- /interface/rsNetExample.h: -------------------------------------------------------------------------------- 1 | /* this is a simple class to make it easy for any part of the plugin to call its services */ 2 | /**************************************************************** 3 | * RetroShare is distributed under the following license: 4 | * 5 | * Copyright (C) 2015 6 | * 7 | * This program is free software; you can redistribute it and/or 8 | * modify it under the terms of the GNU General Public License 9 | * as published by the Free Software Foundation; either version 2 10 | * of the License, or (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with this program; if not, write to the Free Software 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, 20 | * Boston, MA 02110-1301, USA. 21 | ****************************************************************/ 22 | 23 | // interface class for p3NetExample service 24 | // 25 | 26 | #pragma once 27 | 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | 34 | class RsNetExample ; 35 | extern RsNetExample *rsNetExample; 36 | 37 | //TODO explain this const 38 | static const uint32_t CONFIG_TYPE_NetExample_PLUGIN = 0xe001 ; 39 | 40 | class RsNetExample 41 | { 42 | public: 43 | 44 | //not fully implemented 45 | virtual void ping_all() = 0; 46 | 47 | //broadcasts json packets with some x/y coords for painting 48 | virtual void broadcast_paint(int x, int y) = 0; 49 | 50 | //broadcasts json packets with some text coords for chatting 51 | virtual void msg_all(std::string msg) = 0; 52 | 53 | //send data to a peer using your own serialisation 54 | virtual void raw_msg_peer(RsPeerId peerID, std::string msg) = 0; 55 | 56 | //convenience functions 57 | //virtual void str_msg_peer(RsPeerId peerID, QString strdata) = 0; 58 | //virtual void qvm_msg_peer(RsPeerId peerID, QVariantMap data) = 0; 59 | }; 60 | 61 | 62 | -------------------------------------------------------------------------------- /gui/paintwidget.cpp: -------------------------------------------------------------------------------- 1 | #include "paintwidget.h" 2 | 3 | #include 4 | #include 5 | #include 6 | 7 | #include 8 | #include 9 | PaintWidget::PaintWidget(QWidget *parent) : 10 | QWidget(parent),image(600,300,QImage::Format_RGB32),color(Qt::black),penWidth(8) 11 | { 12 | image.fill(qRgb(255, 255, 255)); 13 | } 14 | 15 | void PaintWidget::setImage(const QImage &img){ 16 | image=img.copy(); 17 | update(); 18 | } 19 | 20 | QImage PaintWidget::getImage(){ 21 | return image; 22 | } 23 | 24 | void PaintWidget::fillImage(QColor color){ 25 | image.fill(qRgb(255, 255, 255)); 26 | update(); 27 | } 28 | 29 | void PaintWidget::mouseMoveEvent(QMouseEvent *event) 30 | { 31 | QPainter p(&image); 32 | p.setPen(color); 33 | p.setBrush(color); 34 | QPoint pos = event->pos(); 35 | if(penWidth==1){ 36 | p.drawPoint(pos); 37 | }else{ 38 | p.drawEllipse(pos,penWidth/2,penWidth/2); 39 | } 40 | //check if u want to clear Jenster-- 41 | // if (event->button() == Qt::RightButton) image.fill(qRgb(255, 255, 255)); 42 | 43 | // trigger repaint of widget 44 | update(); 45 | emit mmEvent(pos.x(), pos.y()); 46 | //tjd->paintMouseMove(event); 47 | } 48 | 49 | 50 | void PaintWidget::paintAt(int x, int y) 51 | { 52 | QPainter p(&image); 53 | p.setPen(color); 54 | p.setBrush(color); 55 | if(penWidth==1){ 56 | p.drawPoint(x,y); 57 | }else{ 58 | p.drawEllipse(x,y,penWidth/2,penWidth/2); 59 | } 60 | // trigger repaint of widget 61 | update(); 62 | } 63 | 64 | qint64 getImgSize(QImage image){ 65 | QByteArray ba; 66 | QBuffer buffer(&ba); 67 | buffer.open(QIODevice::WriteOnly); 68 | image.save(&buffer, "PNG"); 69 | return buffer.buffer().toBase64().size(); 70 | } 71 | 72 | void PaintWidget::mouseReleaseEvent(QMouseEvent *event){ 73 | std::cout<<"PaintWidgte::mouseReleseEvent()"<button() == Qt::RightButton) { image.fill(qRgb(255, 255, 255));update(); } 76 | //check to see if we want to send to clipboard 77 | if (event->button() == Qt::MiddleButton) { 78 | QImage img = image.scaledToWidth(image.width()*0.5); 79 | while(getImgSize(img)> 5500){ 80 | img = img.scaledToWidth(img.width()*0.8); 81 | } 82 | QApplication::clipboard()->setImage(img); 83 | } 84 | 85 | 86 | 87 | emit haveUpdate(); 88 | } 89 | 90 | void PaintWidget::paintEvent(QPaintEvent *event) 91 | { 92 | QPainter p(this); 93 | p.drawImage(0,0,image); 94 | } 95 | -------------------------------------------------------------------------------- /gui/NetExampleMainpage.cpp: -------------------------------------------------------------------------------- 1 | #include "NetExampleMainpage.h" 2 | #include "ui_NetExampleMainpage.h" 3 | //#include "services/p3NetExample.h" 4 | #include "interface/rsNetExample.h" 5 | #include 6 | 7 | 8 | NetExampleMainpage::NetExampleMainpage(QWidget *parent, NetExampleNotify *notify) : 9 | MainPage(parent), 10 | mNotify(notify), 11 | ui(new Ui::NetExampleMainpage) 12 | { 13 | ui->setupUi(this); 14 | 15 | connect(mNotify, SIGNAL(NeMsgArrived(RsPeerId,QString)), this , SLOT(NeMsgArrived(RsPeerId,QString))); 16 | connect(mNotify, SIGNAL(NePaintArrived(RsPeerId,int,int)), this , SLOT(NePaintArrived(RsPeerId,int,int))); 17 | //ui->listWidget->addItem("str"); 18 | connect(ui->paintWidget, SIGNAL(mmEvent(int,int)), this, SLOT(mmEvent(int,int))); 19 | 20 | } 21 | 22 | NetExampleMainpage::~NetExampleMainpage() 23 | { 24 | delete ui; 25 | } 26 | 27 | void NetExampleMainpage::mmEvent(int x, int y) 28 | { 29 | rsNetExample->broadcast_paint(x,y); 30 | } 31 | 32 | void NetExampleMainpage::on_pingAllButton_clicked() 33 | { 34 | rsNetExample->ping_all(); 35 | NeMsgArrived(rsPeers->getOwnId(),"ping"); 36 | } 37 | 38 | 39 | void NetExampleMainpage::NeMsgArrived(const RsPeerId &peer_id, QString str) 40 | { 41 | QJsonDocument jdoc = QJsonDocument::fromJson(str.toUtf8()); 42 | QVariantMap vmap = jdoc.toVariant().toMap(); 43 | std::cout << "GUI got Packet from: " << peer_id; 44 | std::cout << " saying " << str.toStdString(); 45 | std::cout << std::endl; 46 | QString type = vmap.value("type").toString(); 47 | if (type == "chat"){ 48 | QString output = QString::fromStdString(rsPeers->getPeerName(peer_id)); 49 | output+=": "; 50 | output+=vmap.value("message").toString(); 51 | ui->listWidget->addItem(output); 52 | }else if (type == "paint"){ 53 | int x =vmap.value("x").toInt(); 54 | int y =vmap.value("y").toInt(); 55 | NePaintArrived(peer_id,x,y); 56 | }else{ 57 | QString output = QString::fromStdString(rsPeers->getPeerName(peer_id)); 58 | output+=": "; 59 | output+=str; 60 | ui->listWidget->addItem(output); 61 | } 62 | 63 | { 64 | QString output = QString::fromStdString(rsPeers->getPeerName(peer_id)); 65 | output+=": "; 66 | output+=str; 67 | ui->netLogWidget->addItem(output); 68 | } 69 | } 70 | void NetExampleMainpage::NePaintArrived(const RsPeerId &peer_id, int x, int y) 71 | { 72 | 73 | std::cout << "GUI got Paint from: " << peer_id; 74 | std::cout << std::endl; 75 | 76 | ui->paintWidget->paintAt(x,y); 77 | } 78 | 79 | void NetExampleMainpage::on_broadcastButton_clicked() 80 | { 81 | rsNetExample->msg_all(ui->msgInput->text().toStdString()); 82 | NeMsgArrived(rsPeers->getOwnId(),ui->msgInput->text()); 83 | ui->msgInput->clear(); 84 | } 85 | -------------------------------------------------------------------------------- /NetExamplePlugin.h: -------------------------------------------------------------------------------- 1 | /* this is the central part of the plugin */ 2 | /**************************************************************** 3 | * RetroShare is distributed under the following license: 4 | * 5 | * Copyright (C) 2015 6 | * 7 | * This program is free software; you can redistribute it and/or 8 | * modify it under the terms of the GNU General Public License 9 | * as published by the Free Software Foundation; either version 2 10 | * of the License, or (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with this program; if not, write to the Free Software 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, 20 | * Boston, MA 02110-1301, USA. 21 | ****************************************************************/ 22 | #pragma once 23 | 24 | /*NetExample*/ 25 | #include "services/p3NetExample.h" 26 | 27 | /*libretroshare"*/ 28 | #include 29 | 30 | #include "gui/NetExampleMainpage.h" 31 | 32 | class NetExampleGUIHandler ; 33 | class NetExampleNotify ; 34 | 35 | class NetExamplePlugin: public RsPlugin 36 | { 37 | public: 38 | NetExamplePlugin() ; 39 | virtual ~NetExamplePlugin() {} 40 | 41 | virtual p3Service *p3_service() const ; 42 | virtual uint16_t rs_service_id() const { return RS_SERVICE_TYPE_NetExample_PLUGIN ; } 43 | //virtual ConfigPage *qt_config_page() const ; 44 | virtual QDialog *qt_about_page() const ; 45 | //virtual ChatWidgetHolder *qt_get_chat_widget_holder(ChatWidget *chatWidget) const ; 46 | 47 | virtual QIcon *qt_icon() const; 48 | virtual QTranslator *qt_translator(QApplication *app, const QString& languageCode, const QString& externalDir) const; 49 | virtual void qt_sound_events(SoundEvents &events) const; 50 | 51 | virtual void getPluginVersion(int& major, int& minor, int &build, int& svn_rev) const ; 52 | virtual void setPlugInHandler(RsPluginHandler *pgHandler); 53 | 54 | virtual std::string configurationFileName() const { return "NetExample.cfg" ; } 55 | 56 | virtual std::string getShortPluginDescription() const ; 57 | virtual std::string getPluginName() const; 58 | virtual void setInterfaces(RsPlugInInterfaces& interfaces); 59 | 60 | //================================== RsPlugin Notify ==================================// 61 | //virtual ToasterNotify *qt_toasterNotify(); 62 | 63 | virtual MainPage *qt_page() const ; 64 | 65 | private: 66 | mutable p3NetExample *mNetExample ; 67 | mutable RsPluginHandler *mPlugInHandler; 68 | mutable RsPeers* mPeers; 69 | mutable ConfigPage *config_page ; 70 | mutable QIcon *mIcon; 71 | mutable MainPage* mainpage ; 72 | 73 | NetExampleNotify *mNetExampleNotify ; 74 | NetExampleGUIHandler *mNetExampleGUIHandler ; 75 | }; 76 | 77 | -------------------------------------------------------------------------------- /services/p3NetExample.h: -------------------------------------------------------------------------------- 1 | /* this handles the networking service of this plugin */ 2 | /**************************************************************** 3 | * RetroShare is distributed under the following license: 4 | * 5 | * Copyright (C) 2015 6 | * 7 | * This program is free software; you can redistribute it and/or 8 | * modify it under the terms of the GNU General Public License 9 | * as published by the Free Software Foundation; either version 2 10 | * of the License, or (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with this program; if not, write to the Free Software 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, 20 | * Boston, MA 02110-1301, USA. 21 | ****************************************************************/ 22 | 23 | #pragma once 24 | 25 | #include 26 | #include 27 | #include 28 | 29 | #include "services/rsNetExampleItems.h" 30 | #include "services/p3service.h" 31 | #include "serialiser/rstlvbase.h" 32 | #include "serialiser/rsconfigitems.h" 33 | #include "plugins/rspqiservice.h" 34 | #include 35 | 36 | class p3LinkMgr; 37 | class NetExampleNotify ; 38 | 39 | 40 | 41 | //!The RS NetExample service. 42 | /** 43 | * 44 | * This is sends data to friends. 45 | */ 46 | 47 | class p3NetExample: public RsPQIService, public RsNetExample 48 | // Maybe we inherit from these later - but not needed for now. 49 | //, public p3Config, public pqiMonitor 50 | { 51 | public: 52 | p3NetExample(RsPluginHandler *cm,NetExampleNotify *); 53 | 54 | /***** overloaded from rsNetExample *****/ 55 | 56 | 57 | /***** overloaded from p3Service *****/ 58 | /*! 59 | * This retrieves all chat msg items and also (important!) 60 | * processes chat-status items that are in service item queue. chat msg item requests are also processed and not returned 61 | * (important! also) notifications sent to notify base on receipt avatar, immediate status and custom status 62 | * : notifyCustomState, notifyChatStatus, notifyPeerHasNewAvatar 63 | * @see NotifyBase 64 | */ 65 | virtual int tick(); 66 | virtual int status(); 67 | virtual bool recvItem(RsItem *item); 68 | 69 | /*************** pqiMonitor callback ***********************/ 70 | //virtual void statusChange(const std::list &plist); 71 | 72 | 73 | /************* from p3Config *******************/ 74 | virtual RsSerialiser *setupSerialiser() ; 75 | 76 | /*! 77 | * chat msg items and custom status are saved 78 | */ 79 | virtual bool saveList(bool& cleanup, std::list&) ; 80 | virtual bool loadList(std::list& load) ; 81 | virtual std::string configurationFileName() const { return "NetExample.cfg" ; } 82 | 83 | virtual RsServiceInfo getServiceInfo() ; 84 | 85 | void ping_all(); 86 | 87 | void broadcast_paint(int x, int y); 88 | void msg_all(std::string msg); 89 | void str_msg_peer(RsPeerId peerID, QString strdata); 90 | void raw_msg_peer(RsPeerId peerID, std::string msg); 91 | void qvm_msg_peer(RsPeerId peerID, QVariantMap data); 92 | private: 93 | 94 | 95 | 96 | void handleData(RsNetExampleDataItem*) ; 97 | 98 | RsMutex mNetExampleMtx; 99 | 100 | 101 | static RsTlvKeyValue push_int_value(const std::string& key,int value) ; 102 | static int pop_int_value(const std::string& s) ; 103 | 104 | 105 | RsServiceControl *mServiceControl; 106 | NetExampleNotify *mNotify ; 107 | 108 | }; 109 | -------------------------------------------------------------------------------- /services/rsNetExampleItems.h: -------------------------------------------------------------------------------- 1 | /* this describes the datatypes sent over the network, and how to (de)serialise them */ 2 | /**************************************************************** 3 | * RetroShare is distributed under the following license: 4 | * 5 | * Copyright (C) 2015 6 | * 7 | * This program is free software; you can redistribute it and/or 8 | * modify it under the terms of the GNU General Public License 9 | * as published by the Free Software Foundation; either version 2 10 | * of the License, or (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with this program; if not, write to the Free Software 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, 20 | * Boston, MA 02110-1301, USA. 21 | ****************************************************************/ 22 | 23 | #pragma once 24 | 25 | /* 26 | * libretroshare/src/serialiser: rsNetExampleItems.h 27 | * 28 | * RetroShare Serialiser. 29 | * 30 | * Copyright 2011 by Robert Fernie. 31 | * 32 | * This library is free software; you can redistribute it and/or 33 | * modify it under the terms of the GNU Library General Public 34 | * License Version 2 as published by the Free Software Foundation. 35 | * 36 | * This library is distributed in the hope that it will be useful, 37 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 38 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 39 | * Library General Public License for more details. 40 | * 41 | * You should have received a copy of the GNU Library General Public 42 | * License along with this library; if not, write to the Free Software 43 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 44 | * USA. 45 | * 46 | * Please report all bugs and problems to "retroshare@lunamutt.com". 47 | * 48 | */ 49 | 50 | #include 51 | 52 | #include "serialiser/rsserviceids.h" 53 | #include "serialiser/rsserial.h" 54 | 55 | /**************************************************************************/ 56 | 57 | #warning "CHANGE THIS NUMBER" 58 | const uint16_t RS_SERVICE_TYPE_NetExample_PLUGIN = 0x12345; 59 | #warning "CHANGE THIS NUMBER" 60 | 61 | const uint8_t RS_PKT_SUBTYPE_NetExample_DATA = 0x01; 62 | 63 | const uint8_t QOS_PRIORITY_RS_NetExample = 9 ; 64 | 65 | 66 | class RsNetExampleItem: public RsItem 67 | { 68 | public: 69 | RsNetExampleItem(uint8_t NetExample_subtype) 70 | : RsItem(RS_PKT_VERSION_SERVICE,RS_SERVICE_TYPE_NetExample_PLUGIN,NetExample_subtype) 71 | { 72 | setPriorityLevel(QOS_PRIORITY_RS_NetExample) ; 73 | } 74 | 75 | virtual ~RsNetExampleItem() {}; 76 | virtual void clear() {}; 77 | virtual std::ostream& print(std::ostream &out, uint16_t indent = 0) = 0 ; 78 | 79 | virtual bool serialise(void *data,uint32_t& size) = 0 ; // Isn't it better that items can serialise themselves ? 80 | virtual uint32_t serial_size() const = 0 ; // deserialise is handled using a constructor 81 | }; 82 | 83 | 84 | class RsNetExampleDataItem: public RsNetExampleItem 85 | { 86 | public: 87 | RsNetExampleDataItem() :RsNetExampleItem(RS_PKT_SUBTYPE_NetExample_DATA) {} 88 | RsNetExampleDataItem(void *data,uint32_t size) ; // de-serialization 89 | 90 | virtual bool serialise(void *data,uint32_t& size) ; 91 | virtual uint32_t serial_size() const ; 92 | 93 | virtual ~RsNetExampleDataItem() 94 | { 95 | } 96 | virtual std::ostream& print(std::ostream &out, uint16_t indent = 0); 97 | 98 | uint32_t flags ; 99 | uint32_t data_size ; 100 | std::string m_msg; 101 | }; 102 | 103 | 104 | class RsNetExampleSerialiser: public RsSerialType 105 | { 106 | public: 107 | RsNetExampleSerialiser() 108 | :RsSerialType(RS_PKT_VERSION_SERVICE, RS_SERVICE_TYPE_NetExample_PLUGIN) 109 | { 110 | } 111 | virtual ~RsNetExampleSerialiser() {} 112 | 113 | virtual uint32_t size (RsItem *item) 114 | { 115 | return dynamic_cast(item)->serial_size() ; 116 | } 117 | 118 | virtual bool serialise (RsItem *item, void *data, uint32_t *size) 119 | { 120 | return dynamic_cast(item)->serialise(data,*size) ; 121 | } 122 | virtual RsItem *deserialise(void *data, uint32_t *size); 123 | }; 124 | 125 | /**************************************************************************/ 126 | -------------------------------------------------------------------------------- /gui/NetExampleMainpage.ui: -------------------------------------------------------------------------------- 1 | 2 | 3 | NetExampleMainpage 4 | 5 | 6 | 7 | 0 8 | 0 9 | 685 10 | 632 11 | 12 | 13 | 14 | Form 15 | 16 | 17 | 18 | 19 | 20 | 21 | 0 22 | 0 23 | 24 | 25 | 26 | QFrame::Box 27 | 28 | 29 | QFrame::Sunken 30 | 31 | 32 | 33 | 2 34 | 35 | 36 | 2 37 | 38 | 39 | 2 40 | 41 | 42 | 2 43 | 44 | 45 | 46 | 47 | 48 | 32 49 | 32 50 | 51 | 52 | 53 | 54 | 55 | 56 | :/images/Oxygen-plugin.ico 57 | 58 | 59 | true 60 | 61 | 62 | 63 | 64 | 65 | 66 | NetExample 67 | 68 | 69 | 70 | 71 | 72 | 73 | Qt::Horizontal 74 | 75 | 76 | 77 | 123 78 | 13 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | Qt::NoFocus 87 | 88 | 89 | 90 | :/icons/help_64.png:/icons/help_64.png 91 | 92 | 93 | true 94 | 95 | 96 | true 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | Qt::Vertical 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | Qt::Vertical 126 | 127 | 128 | 129 | 20 130 | 40 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | Ping All 139 | 140 | 141 | 142 | 143 | 144 | 145 | Broadcast 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 0 160 | 200 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | PaintWidget 171 | QWidget 172 |
gui/paintwidget.h
173 | 1 174 | 175 | 176 | StyledLabel 177 | QLabel 178 |
gui/common/StyledLabel.h
179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | -------------------------------------------------------------------------------- /services/rsNetExampleItems.cc: -------------------------------------------------------------------------------- 1 | /**************************************************************** 2 | * RetroShare is distributed under the following license: 3 | * 4 | * Copyright (C) 2015 5 | * 6 | * This program is free software; you can redistribute it and/or 7 | * modify it under the terms of the GNU General Public License 8 | * as published by the Free Software Foundation; either version 2 9 | * of the License, or (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, 19 | * Boston, MA 02110-1301, USA. 20 | ****************************************************************/ 21 | 22 | #include 23 | #include "serialiser/rsbaseserial.h" 24 | #include "serialiser/rstlvbase.h" 25 | 26 | #include "services/rsNetExampleItems.h" 27 | 28 | /*** 29 | #define RSSERIAL_DEBUG 1 30 | ***/ 31 | 32 | #include 33 | 34 | #define HOLLERITH_LEN_SPEC 4 35 | /*************************************************************************/ 36 | 37 | std::ostream& RsNetExampleDataItem::print(std::ostream &out, uint16_t indent) 38 | { 39 | printRsItemBase(out, "RsNetExampleDataItem", indent); 40 | uint16_t int_Indent = indent + 2; 41 | printIndent(out, int_Indent); 42 | out << "flags: " << flags << std::endl; 43 | 44 | printIndent(out, int_Indent); 45 | out << "data size: " << std::hex << data_size << std::dec << std::endl; 46 | 47 | printRsItemEnd(out, "RsNetExampleDataItem", indent); 48 | return out; 49 | } 50 | 51 | /*************************************************************************/ 52 | uint32_t RsNetExampleDataItem::serial_size() const 53 | { 54 | uint32_t s = 8; /* header */ 55 | s += 4; /* flags */ 56 | s += 4; /* data_size */ 57 | //s += m_msg.length()+HOLLERITH_LEN_SPEC; /* data */ 58 | s += getRawStringSize(m_msg); 59 | 60 | return s; 61 | } 62 | 63 | /* serialise the data to the buffer */ 64 | bool RsNetExampleDataItem::serialise(void *data, uint32_t& pktsize) 65 | { 66 | uint32_t tlvsize = serial_size() ; 67 | uint32_t offset = 0; 68 | 69 | if (pktsize < tlvsize) 70 | return false; /* not enough space */ 71 | 72 | pktsize = tlvsize; 73 | 74 | bool ok = true; 75 | 76 | ok &= setRsItemHeader(data, tlvsize, PacketId(), tlvsize); 77 | 78 | #ifdef RSSERIAL_DEBUG 79 | std::cerr << "RsNetExampleSerialiser::serialiseNetExampleDataItem() Header: " << ok << std::endl; 80 | std::cerr << "RsNetExampleSerialiser::serialiseNetExampleDataItem() Size: " << tlvsize << std::endl; 81 | #endif 82 | 83 | /* skip the header */ 84 | offset += 8; 85 | 86 | /* add mandatory parts first */ 87 | ok &= setRawUInt32(data, tlvsize, &offset, flags); 88 | ok &= setRawUInt32(data, tlvsize, &offset, data_size); 89 | 90 | 91 | ok &= setRawString(data, tlvsize, &offset, m_msg ); 92 | std::cout << "string sizes: " << getRawStringSize(m_msg) << " OR " << m_msg.size() << "\n"; 93 | 94 | if (offset != tlvsize) 95 | { 96 | ok = false; 97 | std::cerr << "RsNetExampleSerialiser::serialiseNetExamplePingItem() Size Error! " << std::endl; 98 | std::cerr << "expected " << tlvsize << " got " << offset << std::endl; 99 | std::cerr << "m_msg looks like " << m_msg << std::endl; 100 | } 101 | 102 | return ok; 103 | } 104 | /* serialise the data to the buffer */ 105 | 106 | /*************************************************************************/ 107 | /*************************************************************************/ 108 | 109 | RsNetExampleDataItem::RsNetExampleDataItem(void *data, uint32_t pktsize) 110 | : RsNetExampleItem(RS_PKT_SUBTYPE_NetExample_DATA) 111 | { 112 | /* get the type and size */ 113 | uint32_t rstype = getRsItemId(data); 114 | uint32_t rssize = getRsItemSize(data); 115 | 116 | uint32_t offset = 0; 117 | 118 | if ((RS_PKT_VERSION_SERVICE != getRsItemVersion(rstype)) || (RS_SERVICE_TYPE_NetExample_PLUGIN != getRsItemService(rstype)) || (RS_PKT_SUBTYPE_NetExample_DATA != getRsItemSubType(rstype))) 119 | throw std::runtime_error("Wrong packet subtype") ; 120 | 121 | if (pktsize < rssize) /* check size */ 122 | throw std::runtime_error("Not enough space") ; 123 | 124 | bool ok = true; 125 | 126 | /* skip the header */ 127 | offset += 8; 128 | 129 | /* get mandatory parts first */ 130 | ok &= getRawUInt32(data, rssize, &offset, &flags); 131 | ok &= getRawUInt32(data, rssize, &offset, &data_size); 132 | 133 | 134 | ok &= getRawString(data, rssize, &offset, m_msg ); 135 | 136 | if (offset != rssize) 137 | throw std::runtime_error("Serialization error.") ; 138 | 139 | if (!ok) 140 | throw std::runtime_error("Serialization error.") ; 141 | } 142 | /*************************************************************************/ 143 | 144 | RsItem* RsNetExampleSerialiser::deserialise(void *data, uint32_t *pktsize) 145 | { 146 | #ifdef RSSERIAL_DEBUG 147 | std::cerr << "RsNetExampleSerialiser::deserialise()" << std::endl; 148 | #endif 149 | 150 | /* get the type and size */ 151 | uint32_t rstype = getRsItemId(data); 152 | 153 | if ((RS_PKT_VERSION_SERVICE != getRsItemVersion(rstype)) || (RS_SERVICE_TYPE_NetExample_PLUGIN != getRsItemService(rstype))) 154 | return NULL ; 155 | 156 | try 157 | { 158 | switch(getRsItemSubType(rstype)) 159 | { 160 | case RS_PKT_SUBTYPE_NetExample_DATA: return new RsNetExampleDataItem(data, *pktsize); 161 | 162 | default: 163 | return NULL; 164 | } 165 | } 166 | catch(std::exception& e) 167 | { 168 | std::cerr << "RsNetExampleSerialiser: deserialization error: " << e.what() << std::endl; 169 | return NULL; 170 | } 171 | } 172 | 173 | 174 | /*************************************************************************/ 175 | 176 | -------------------------------------------------------------------------------- /NetExamplePlugin.cpp: -------------------------------------------------------------------------------- 1 | /**************************************************************** 2 | * RetroShare is distributed under the following license: 3 | * 4 | * Copyright (C) 2015 5 | * 6 | * This program is free software; you can redistribute it and/or 7 | * modify it under the terms of the GNU General Public License 8 | * as published by the Free Software Foundation; either version 2 9 | * of the License, or (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, 19 | * Boston, MA 02110-1301, USA. 20 | ****************************************************************/ 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | 30 | #include "NetExamplePlugin.h" 31 | #include "interface/rsNetExample.h" 32 | #include "gui/NetExampleMainpage.h" 33 | #include "gui/NetExampleNotify.h" 34 | 35 | 36 | #define IMAGE_NetExample ":/images/Oxygen-plugin.ico" 37 | 38 | static void *inited = new NetExamplePlugin() ; 39 | 40 | extern "C" { 41 | 42 | // This is *the* functions required by RS plugin system to give RS access to the plugin. 43 | // Be careful to: 44 | // - always respect the C linkage convention 45 | // - always return an object of type RsPlugin* 46 | // 47 | void *RETROSHARE_PLUGIN_provide() 48 | { 49 | static NetExamplePlugin *p = new NetExamplePlugin() ; 50 | 51 | return (void*)p ; 52 | } 53 | 54 | // This symbol contains the svn revision number grabbed from the executable. 55 | // It will be tested by RS to load the plugin automatically, since it is safe to load plugins 56 | // with same revision numbers, assuming that the revision numbers are up-to-date. 57 | // 58 | uint32_t RETROSHARE_PLUGIN_revision = RS_REVISION_NUMBER ; 59 | 60 | // This symbol contains the svn revision number grabbed from the executable. 61 | // It will be tested by RS to load the plugin automatically, since it is safe to load plugins 62 | // with same revision numbers, assuming that the revision numbers are up-to-date. 63 | // 64 | uint32_t RETROSHARE_PLUGIN_api = RS_PLUGIN_API_VERSION ; 65 | } 66 | 67 | void NetExamplePlugin::getPluginVersion(int& major, int& minor, int& build, int& svn_rev) const 68 | { 69 | major = RS_MAJOR_VERSION ; 70 | minor = RS_MINOR_VERSION ; 71 | build = RS_BUILD_NUMBER ; 72 | svn_rev = RS_REVISION_NUMBER ; 73 | } 74 | 75 | NetExamplePlugin::NetExamplePlugin() 76 | { 77 | qRegisterMetaType("RsPeerId"); 78 | mainpage = NULL ; 79 | mNetExample = NULL ; 80 | mPlugInHandler = NULL; 81 | mPeers = NULL; 82 | config_page = NULL ; 83 | mIcon = NULL ; 84 | 85 | mNetExampleNotify = new NetExampleNotify; 86 | } 87 | 88 | void NetExamplePlugin::setInterfaces(RsPlugInInterfaces &interfaces) 89 | { 90 | mPeers = interfaces.mPeers; 91 | } 92 | 93 | /*ConfigPage *NetExamplePlugin::qt_config_page() const 94 | { 95 | // The config pages are deleted when config is closed, so it's important not to static the 96 | // created object. 97 | // 98 | return new AudioInputConfig() ; 99 | }*/ 100 | 101 | QDialog *NetExamplePlugin::qt_about_page() const 102 | { 103 | static QMessageBox *about_dialog = NULL ; 104 | 105 | if(about_dialog == NULL) 106 | { 107 | about_dialog = new QMessageBox() ; 108 | 109 | QString text ; 110 | text += QObject::tr("

RetroShare NetExample plugin


* Contributors: Cyril Soler, Josselin Jacquard, Chozabu
") ; 111 | text += QObject::tr("
The NetExample plugin adds NetExample to the main list of apps in RetroShare.
") ; 112 | text += QObject::tr("It Contains an example of Broadcast Painting and Chat
") ; 113 | 114 | about_dialog->setText(text) ; 115 | about_dialog->setStandardButtons(QMessageBox::Ok) ; 116 | } 117 | 118 | return about_dialog ; 119 | } 120 | 121 | /*ChatWidgetHolder *NetExamplePlugin::qt_get_chat_widget_holder(ChatWidget *chatWidget) const 122 | { 123 | switch (chatWidget->chatType()) { 124 | case ChatWidget::CHATTYPE_PRIVATE: 125 | return new NetExampleChatWidgetHolder(chatWidget, mNetExampleNotify); 126 | case ChatWidget::CHATTYPE_UNKNOWN: 127 | case ChatWidget::CHATTYPE_LOBBY: 128 | case ChatWidget::CHATTYPE_DISTANT: 129 | break; 130 | } 131 | 132 | return NULL; 133 | }*/ 134 | 135 | p3Service *NetExamplePlugin::p3_service() const 136 | { 137 | if(mNetExample == NULL) 138 | rsNetExample = mNetExample = new p3NetExample(mPlugInHandler,mNetExampleNotify) ; // , 3600 * 24 * 30 * 6); // 6 Months 139 | 140 | return mNetExample ; 141 | } 142 | 143 | void NetExamplePlugin::setPlugInHandler(RsPluginHandler *pgHandler) 144 | { 145 | mPlugInHandler = pgHandler; 146 | } 147 | 148 | QIcon *NetExamplePlugin::qt_icon() const 149 | { 150 | if (mIcon == NULL) { 151 | Q_INIT_RESOURCE(NetExample_images); 152 | 153 | mIcon = new QIcon(IMAGE_NetExample); 154 | } 155 | 156 | return mIcon; 157 | } 158 | MainPage *NetExamplePlugin::qt_page() const 159 | { 160 | if(mainpage == NULL){ 161 | mainpage = new NetExampleMainpage(0, mNetExampleNotify);//mPeers, mFiles) ; 162 | //tpage = new NetExampleMainpage( ); 163 | //mainpage = tpage; 164 | } 165 | 166 | return mainpage ; 167 | } 168 | 169 | std::string NetExamplePlugin::getShortPluginDescription() const 170 | { 171 | return "NetExample"; 172 | } 173 | 174 | std::string NetExamplePlugin::getPluginName() const 175 | { 176 | return "NetExamplePlugin"; 177 | } 178 | 179 | QTranslator* NetExamplePlugin::qt_translator(QApplication */*app*/, const QString& languageCode, const QString& externalDir) const 180 | { 181 | return NULL; 182 | } 183 | 184 | void NetExamplePlugin::qt_sound_events(SoundEvents &/*events*/) const 185 | { 186 | // events.addEvent(QApplication::translate("NetExample", "NetExample"), QApplication::translate("NetExample", "Incoming call"), NetExample_SOUND_INCOMING_CALL); 187 | } 188 | 189 | /*ToasterNotify *NetExamplePlugin::qt_toasterNotify(){ 190 | if (!mNetExampleToasterNotify) { 191 | mNetExampleToasterNotify = new NetExampleToasterNotify(mNetExample, mNetExampleNotify); 192 | } 193 | return mNetExampleToasterNotify; 194 | }*/ 195 | -------------------------------------------------------------------------------- /services/p3NetExample.cc: -------------------------------------------------------------------------------- 1 | /**************************************************************** 2 | * RetroShare is distributed under the following license: 3 | * 4 | * Copyright (C) 2015 5 | * 6 | * This program is free software; you can redistribute it and/or 7 | * modify it under the terms of the GNU General Public License 8 | * as published by the Free Software Foundation; either version 2 9 | * of the License, or (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program; if not, write to the Free Software 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, 19 | * Boston, MA 02110-1301, USA. 20 | ****************************************************************/ 21 | 22 | #include "util/rsdir.h" 23 | #include "retroshare/rsiface.h" 24 | #include "pqi/pqibin.h" 25 | #include "pqi/pqistore.h" 26 | #include "pqi/p3linkmgr.h" 27 | #include 28 | #include 29 | 30 | #include // for std::istringstream 31 | 32 | #include "services/p3NetExample.h" 33 | #include "services/rsNetExampleItems.h" 34 | 35 | #include 36 | 37 | #include "gui/NetExampleNotify.h" 38 | 39 | 40 | //#define DEBUG_NetExample 1 41 | 42 | 43 | /* DEFINE INTERFACE POINTER! */ 44 | RsNetExample *rsNetExample = NULL; 45 | 46 | 47 | 48 | #ifdef WINDOWS_SYS 49 | #include 50 | #include 51 | #endif 52 | 53 | static double getCurrentTS() 54 | { 55 | 56 | #ifndef WINDOWS_SYS 57 | struct timeval cts_tmp; 58 | gettimeofday(&cts_tmp, NULL); 59 | double cts = (cts_tmp.tv_sec) + ((double) cts_tmp.tv_usec) / 1000000.0; 60 | #else 61 | struct _timeb timebuf; 62 | _ftime( &timebuf); 63 | double cts = (timebuf.time) + ((double) timebuf.millitm) / 1000.0; 64 | #endif 65 | return cts; 66 | } 67 | 68 | static uint64_t convertTsTo64bits(double ts) 69 | { 70 | uint32_t secs = (uint32_t) ts; 71 | uint32_t usecs = (uint32_t) ((ts - (double) secs) * 1000000); 72 | uint64_t bits = (((uint64_t) secs) << 32) + usecs; 73 | return bits; 74 | } 75 | 76 | static double convert64bitsToTs(uint64_t bits) 77 | { 78 | uint32_t usecs = (uint32_t) (bits & 0xffffffff); 79 | uint32_t secs = (uint32_t) ((bits >> 32) & 0xffffffff); 80 | double ts = (secs) + ((double) usecs) / 1000000.0; 81 | 82 | return ts; 83 | } 84 | 85 | p3NetExample::p3NetExample(RsPluginHandler *handler,NetExampleNotify *notifier) 86 | : RsPQIService(RS_SERVICE_TYPE_NetExample_PLUGIN,0,handler), mNetExampleMtx("p3NetExample"), mServiceControl(handler->getServiceControl()) , mNotify(notifier) 87 | { 88 | addSerialType(new RsNetExampleSerialiser()); 89 | 90 | 91 | //plugin default configuration 92 | 93 | } 94 | RsServiceInfo p3NetExample::getServiceInfo() 95 | { 96 | const std::string TURTLE_APP_NAME = "NetExample"; 97 | const uint16_t TURTLE_APP_MAJOR_VERSION = 1; 98 | const uint16_t TURTLE_APP_MINOR_VERSION = 0; 99 | const uint16_t TURTLE_MIN_MAJOR_VERSION = 1; 100 | const uint16_t TURTLE_MIN_MINOR_VERSION = 0; 101 | 102 | return RsServiceInfo(RS_SERVICE_TYPE_NetExample_PLUGIN, 103 | TURTLE_APP_NAME, 104 | TURTLE_APP_MAJOR_VERSION, 105 | TURTLE_APP_MINOR_VERSION, 106 | TURTLE_MIN_MAJOR_VERSION, 107 | TURTLE_MIN_MINOR_VERSION); 108 | } 109 | 110 | int p3NetExample::tick() 111 | { 112 | #ifdef DEBUG_NetExample 113 | std::cerr << "ticking p3NetExample" << std::endl; 114 | #endif 115 | 116 | //processIncoming(); 117 | //sendPackets(); 118 | 119 | return 0; 120 | } 121 | 122 | int p3NetExample::status() 123 | { 124 | return 1; 125 | } 126 | #include 127 | void p3NetExample::str_msg_peer(RsPeerId peerID, QString strdata){ 128 | QVariantMap map; 129 | map.insert("type", "chat"); 130 | map.insert("message", strdata); 131 | 132 | qvm_msg_peer(peerID,map); 133 | } 134 | 135 | void p3NetExample::qvm_msg_peer(RsPeerId peerID, QVariantMap data){ 136 | QJsonDocument jsondoc = QJsonDocument::fromVariant(data); 137 | std::string msg = jsondoc.toJson().toStdString(); 138 | raw_msg_peer(peerID, msg); 139 | } 140 | void p3NetExample::raw_msg_peer(RsPeerId peerID, std::string msg){ 141 | std::cout << "MSging: " << peerID.toStdString() << "\n"; 142 | std::cout << "MSging: " << msg << "\n"; 143 | /* create the packet */ 144 | RsNetExampleDataItem *pingPkt = new RsNetExampleDataItem(); 145 | pingPkt->PeerId(peerID); 146 | pingPkt->m_msg = msg; 147 | pingPkt->data_size = msg.size(); 148 | //pingPkt->mSeqNo = mCounter; 149 | //pingPkt->mPingTS = convertTsTo64bits(ts); 150 | 151 | //storePingAttempt(*it, ts, mCounter); 152 | 153 | #ifdef DEBUG_NetExample 154 | std::cerr << "p3NetExample::msg_all() With Packet:"; 155 | std::cerr << std::endl; 156 | pingPkt->print(std::cerr, 10); 157 | #endif 158 | 159 | sendItem(pingPkt); 160 | } 161 | 162 | void p3NetExample::msg_all(std::string msg){ 163 | /* we ping our peers */ 164 | //if(!mServiceControl) 165 | // return ; 166 | 167 | //std::set onlineIds; 168 | std::list< RsPeerId > onlineIds; 169 | // mServiceControl->getPeersConnected(getServiceInfo().mServiceType, onlineIds); 170 | rsPeers->getOnlineList(onlineIds); 171 | 172 | double ts = getCurrentTS(); 173 | 174 | #ifdef DEBUG_NetExample 175 | std::cerr << "p3NetExample::msg_all() @ts: " << ts; 176 | std::cerr << std::endl; 177 | #endif 178 | 179 | std::cout << "READY TO BCast: " << onlineIds.size() << "\n"; 180 | /* prepare packets */ 181 | std::list::iterator it; 182 | for(it = onlineIds.begin(); it != onlineIds.end(); it++) 183 | { 184 | str_msg_peer(RsPeerId(*it),QString::fromStdString(msg)); 185 | } 186 | } 187 | 188 | void p3NetExample::ping_all(){ 189 | //TODO ping all! 190 | } 191 | 192 | void p3NetExample::broadcast_paint(int x, int y) 193 | { 194 | std::list< RsPeerId > onlineIds; 195 | // mServiceControl->getPeersConnected(getServiceInfo().mServiceType, onlineIds); 196 | rsPeers->getOnlineList(onlineIds); 197 | 198 | double ts = getCurrentTS(); 199 | 200 | 201 | std::cout << "READY TO PAINT: " << onlineIds.size() << "\n"; 202 | /* prepare packets */ 203 | std::list::iterator it; 204 | for(it = onlineIds.begin(); it != onlineIds.end(); it++) 205 | { 206 | 207 | std::cout << "painting to: " << (*it).toStdString() << "\n"; 208 | QVariantMap map; 209 | map.insert("type", "paint"); 210 | map.insert("x", x); 211 | map.insert("y", y); 212 | 213 | qvm_msg_peer(RsPeerId(*it),map); 214 | /* create the packet */ 215 | //TODO send paint packets 216 | } 217 | } 218 | 219 | //TODO mNotify->notifyReceivedPaint(item->PeerId(), item->x,item->y); 220 | 221 | 222 | 223 | void p3NetExample::handleData(RsNetExampleDataItem *item) 224 | { 225 | RsStackMutex stack(mNetExampleMtx); /****** LOCKED MUTEX *******/ 226 | 227 | // store the data in a queue. 228 | 229 | 230 | mNotify->notifyReceivedMsg(item->PeerId(), QString::fromStdString(item->m_msg)); 231 | } 232 | 233 | bool p3NetExample::recvItem(RsItem *item) 234 | { 235 | std::cout << "recvItem type: " << item->PacketSubType() << "\n"; 236 | /* pass to specific handler */ 237 | bool keep = false ; 238 | 239 | switch(item->PacketSubType()) 240 | { 241 | case RS_PKT_SUBTYPE_NetExample_DATA: 242 | handleData(dynamic_cast(item)); 243 | keep = true ; 244 | break; 245 | 246 | default: 247 | break; 248 | } 249 | 250 | /* clean up */ 251 | if(!keep) 252 | delete item; 253 | return true ; 254 | } 255 | 256 | 257 | 258 | RsTlvKeyValue p3NetExample::push_int_value(const std::string& key,int value) 259 | { 260 | RsTlvKeyValue kv ; 261 | kv.key = key ; 262 | rs_sprintf(kv.value, "%d", value); 263 | 264 | return kv ; 265 | } 266 | int p3NetExample::pop_int_value(const std::string& s) 267 | { 268 | std::istringstream is(s) ; 269 | 270 | int val ; 271 | is >> val ; 272 | 273 | return val ; 274 | } 275 | 276 | bool p3NetExample::saveList(bool& cleanup, std::list& lst) 277 | { 278 | cleanup = true ; 279 | 280 | RsConfigKeyValueSet *vitem = new RsConfigKeyValueSet ; 281 | 282 | /*vitem->tlvkvs.pairs.push_back(push_int_value("P3NetExample_CONFIG_ATRANSMIT",_atransmit)) ; 283 | vitem->tlvkvs.pairs.push_back(push_int_value("P3NetExample_CONFIG_VOICEHOLD",_voice_hold)) ; 284 | vitem->tlvkvs.pairs.push_back(push_int_value("P3NetExample_CONFIG_VADMIN" ,_vadmin)) ; 285 | vitem->tlvkvs.pairs.push_back(push_int_value("P3NetExample_CONFIG_VADMAX" ,_vadmax)) ; 286 | vitem->tlvkvs.pairs.push_back(push_int_value("P3NetExample_CONFIG_NOISE_SUP",_noise_suppress)) ; 287 | vitem->tlvkvs.pairs.push_back(push_int_value("P3NetExample_CONFIG_MIN_LOUDN",_min_loudness)) ; 288 | vitem->tlvkvs.pairs.push_back(push_int_value("P3NetExample_CONFIG_ECHO_CNCL",_echo_cancel)) ;*/ 289 | 290 | lst.push_back(vitem) ; 291 | 292 | return true ; 293 | } 294 | bool p3NetExample::loadList(std::list& load) 295 | { 296 | for(std::list::const_iterator it(load.begin());it!=load.end();++it) 297 | { 298 | #ifdef P3TURTLE_DEBUG 299 | assert(item!=NULL) ; 300 | #endif 301 | RsConfigKeyValueSet *vitem = dynamic_cast(*it) ; 302 | /* 303 | if(vitem != NULL) 304 | for(std::list::const_iterator kit = vitem->tlvkvs.pairs.begin(); kit != vitem->tlvkvs.pairs.end(); ++kit) 305 | if(kit->key == "P3NetExample_CONFIG_ATRANSMIT") 306 | _atransmit = pop_int_value(kit->value) ; 307 | else if(kit->key == "P3NetExample_CONFIG_VOICEHOLD") 308 | _voice_hold = pop_int_value(kit->value) ; 309 | else if(kit->key == "P3NetExample_CONFIG_VADMIN") 310 | _vadmin = pop_int_value(kit->value) ; 311 | else if(kit->key == "P3NetExample_CONFIG_VADMAX") 312 | _vadmax = pop_int_value(kit->value) ; 313 | else if(kit->key == "P3NetExample_CONFIG_NOISE_SUP") 314 | _noise_suppress = pop_int_value(kit->value) ; 315 | else if(kit->key == "P3NetExample_CONFIG_MIN_LOUDN") 316 | _min_loudness = pop_int_value(kit->value) ; 317 | else if(kit->key == "P3NetExample_CONFIG_ECHO_CNCL") 318 | _echo_cancel = pop_int_value(kit->value) ; 319 | 320 | delete vitem ; 321 | */ 322 | } 323 | 324 | return true ; 325 | } 326 | 327 | RsSerialiser *p3NetExample::setupSerialiser() 328 | { 329 | RsSerialiser *rsSerialiser = new RsSerialiser(); 330 | rsSerialiser->addSerialType(new RsNetExampleSerialiser()); 331 | rsSerialiser->addSerialType(new RsGeneralConfigSerialiser()); 332 | 333 | return rsSerialiser ; 334 | } 335 | 336 | 337 | 338 | 339 | 340 | 341 | 342 | 343 | 344 | 345 | -------------------------------------------------------------------------------- /docs/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.8 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "Example RS Plugin" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50 | # the documentation. The maximum height of the logo should not exceed 55 pixels 51 | # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52 | # to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = 122 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 | # doxygen will generate a detailed section even if there is only a brief 125 | # description. 126 | # The default value is: NO. 127 | 128 | ALWAYS_DETAILED_SEC = NO 129 | 130 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 | # inherited members of a class in the documentation of that class as if those 132 | # members were ordinary class members. Constructors, destructors and assignment 133 | # operators of the base classes will not be shown. 134 | # The default value is: NO. 135 | 136 | INLINE_INHERITED_MEMB = NO 137 | 138 | # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 139 | # before files name in the file list and in the header files. If set to NO the 140 | # shortest path that makes the file name unique will be used 141 | # The default value is: YES. 142 | 143 | FULL_PATH_NAMES = YES 144 | 145 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 | # Stripping is only done if one of the specified strings matches the left-hand 147 | # part of the path. The tag can be used to show relative paths in the file list. 148 | # If left blank the directory from which doxygen is run is used as the path to 149 | # strip. 150 | # 151 | # Note that you can specify absolute paths here, but also relative paths, which 152 | # will be relative from the directory where doxygen is started. 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 | 155 | STRIP_FROM_PATH = 156 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 | # path mentioned in the documentation of a class, which tells the reader which 159 | # header file to include in order to use a class. If left blank only the name of 160 | # the header file containing the class definition is used. Otherwise one should 161 | # specify the list of include paths that are normally passed to the compiler 162 | # using the -I flag. 163 | 164 | STRIP_FROM_INC_PATH = 165 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 | # less readable) file names. This can be useful is your file systems doesn't 168 | # support long names like on DOS, Mac, or CD-ROM. 169 | # The default value is: NO. 170 | 171 | SHORT_NAMES = NO 172 | 173 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 | # first line (until the first dot) of a Javadoc-style comment as the brief 175 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 | # style comments (thus requiring an explicit @brief command for a brief 177 | # description.) 178 | # The default value is: NO. 179 | 180 | JAVADOC_AUTOBRIEF = NO 181 | 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 | # line (until the first dot) of a Qt-style comment as the brief description. If 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 | # requiring an explicit \brief command for a brief description.) 186 | # The default value is: NO. 187 | 188 | QT_AUTOBRIEF = NO 189 | 190 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192 | # a brief description. This used to be the default behavior. The new default is 193 | # to treat a multi-line C++ comment block as a detailed description. Set this 194 | # tag to YES if you prefer the old behavior instead. 195 | # 196 | # Note that setting this tag to YES also means that rational rose comments are 197 | # not recognized any more. 198 | # The default value is: NO. 199 | 200 | MULTILINE_CPP_IS_BRIEF = NO 201 | 202 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 | # documentation from any documented member that it re-implements. 204 | # The default value is: YES. 205 | 206 | INHERIT_DOCS = YES 207 | 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 209 | # new page for each member. If set to NO, the documentation of a member will be 210 | # part of the file/class/namespace that contains it. 211 | # The default value is: NO. 212 | 213 | SEPARATE_MEMBER_PAGES = NO 214 | 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 | # uses this value to replace tabs by spaces in code fragments. 217 | # Minimum value: 1, maximum value: 16, default value: 4. 218 | 219 | TAB_SIZE = 4 220 | 221 | # This tag can be used to specify a number of aliases that act as commands in 222 | # the documentation. An alias has the form: 223 | # name=value 224 | # For example adding 225 | # "sideeffect=@par Side Effects:\n" 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the 227 | # documentation, which will result in a user-defined paragraph with heading 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert 229 | # newlines. 230 | 231 | ALIASES = 232 | 233 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 234 | # A mapping has the form "name=value". For example adding "class=itcl::class" 235 | # will allow you to use the command class in the itcl::class meaning. 236 | 237 | TCL_SUBST = 238 | 239 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 240 | # only. Doxygen will then generate output that is more tailored for C. For 241 | # instance, some of the names that are used will be different. The list of all 242 | # members will be omitted, etc. 243 | # The default value is: NO. 244 | 245 | OPTIMIZE_OUTPUT_FOR_C = NO 246 | 247 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 248 | # Python sources only. Doxygen will then generate output that is more tailored 249 | # for that language. For instance, namespaces will be presented as packages, 250 | # qualified scopes will look different, etc. 251 | # The default value is: NO. 252 | 253 | OPTIMIZE_OUTPUT_JAVA = NO 254 | 255 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 256 | # sources. Doxygen will then generate output that is tailored for Fortran. 257 | # The default value is: NO. 258 | 259 | OPTIMIZE_FOR_FORTRAN = NO 260 | 261 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 262 | # sources. Doxygen will then generate output that is tailored for VHDL. 263 | # The default value is: NO. 264 | 265 | OPTIMIZE_OUTPUT_VHDL = NO 266 | 267 | # Doxygen selects the parser to use depending on the extension of the files it 268 | # parses. With this tag you can assign which parser to use for a given 269 | # extension. Doxygen has a built-in mapping, but you can override or extend it 270 | # using this tag. The format is ext=language, where ext is a file extension, and 271 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 273 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 274 | # Fortran. In the later case the parser tries to guess whether the code is fixed 275 | # or free formatted code, this is the default for Fortran type files), VHDL. For 276 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 277 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 278 | # 279 | # Note For files without extension you can use no_extension as a placeholder. 280 | # 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 282 | # the files are not read by doxygen. 283 | 284 | EXTENSION_MAPPING = 285 | 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 287 | # according to the Markdown format, which allows for more readable 288 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 289 | # The output of markdown processing is further processed by doxygen, so you can 290 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 291 | # case of backward compatibilities issues. 292 | # The default value is: YES. 293 | 294 | MARKDOWN_SUPPORT = YES 295 | 296 | # When enabled doxygen tries to link words that correspond to documented 297 | # classes, or namespaces to their corresponding documentation. Such a link can 298 | # be prevented in individual cases by by putting a % sign in front of the word 299 | # or globally by setting AUTOLINK_SUPPORT to NO. 300 | # The default value is: YES. 301 | 302 | AUTOLINK_SUPPORT = YES 303 | 304 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 305 | # to include (a tag file for) the STL sources as input, then you should set this 306 | # tag to YES in order to let doxygen match functions declarations and 307 | # definitions whose arguments contain STL classes (e.g. func(std::string); 308 | # versus func(std::string) {}). This also make the inheritance and collaboration 309 | # diagrams that involve STL classes more complete and accurate. 310 | # The default value is: NO. 311 | 312 | BUILTIN_STL_SUPPORT = NO 313 | 314 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 315 | # enable parsing support. 316 | # The default value is: NO. 317 | 318 | CPP_CLI_SUPPORT = NO 319 | 320 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 321 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 322 | # will parse them like normal C++ but will assume all classes use public instead 323 | # of private inheritance when no explicit protection keyword is present. 324 | # The default value is: NO. 325 | 326 | SIP_SUPPORT = NO 327 | 328 | # For Microsoft's IDL there are propget and propput attributes to indicate 329 | # getter and setter methods for a property. Setting this option to YES will make 330 | # doxygen to replace the get and set methods by a property in the documentation. 331 | # This will only work if the methods are indeed getting or setting a simple 332 | # type. If this is not the case, or you want to show the methods anyway, you 333 | # should set this option to NO. 334 | # The default value is: YES. 335 | 336 | IDL_PROPERTY_SUPPORT = YES 337 | 338 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 339 | # tag is set to YES, then doxygen will reuse the documentation of the first 340 | # member in the group (if any) for the other members of the group. By default 341 | # all members of a group must be documented explicitly. 342 | # The default value is: NO. 343 | 344 | DISTRIBUTE_GROUP_DOC = NO 345 | 346 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 347 | # (for instance a group of public functions) to be put as a subgroup of that 348 | # type (e.g. under the Public Functions section). Set it to NO to prevent 349 | # subgrouping. Alternatively, this can be done per class using the 350 | # \nosubgrouping command. 351 | # The default value is: YES. 352 | 353 | SUBGROUPING = YES 354 | 355 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 356 | # are shown inside the group in which they are included (e.g. using \ingroup) 357 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 358 | # and RTF). 359 | # 360 | # Note that this feature does not work in combination with 361 | # SEPARATE_MEMBER_PAGES. 362 | # The default value is: NO. 363 | 364 | INLINE_GROUPED_CLASSES = NO 365 | 366 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 367 | # with only public data fields or simple typedef fields will be shown inline in 368 | # the documentation of the scope in which they are defined (i.e. file, 369 | # namespace, or group documentation), provided this scope is documented. If set 370 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 371 | # Man pages) or section (for LaTeX and RTF). 372 | # The default value is: NO. 373 | 374 | INLINE_SIMPLE_STRUCTS = NO 375 | 376 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 377 | # enum is documented as struct, union, or enum with the name of the typedef. So 378 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 379 | # with name TypeT. When disabled the typedef will appear as a member of a file, 380 | # namespace, or class. And the struct will be named TypeS. This can typically be 381 | # useful for C code in case the coding convention dictates that all compound 382 | # types are typedef'ed and only the typedef is referenced, never the tag name. 383 | # The default value is: NO. 384 | 385 | TYPEDEF_HIDES_STRUCT = NO 386 | 387 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 388 | # cache is used to resolve symbols given their name and scope. Since this can be 389 | # an expensive process and often the same symbol appears multiple times in the 390 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 391 | # doxygen will become slower. If the cache is too large, memory is wasted. The 392 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 393 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 394 | # symbols. At the end of a run doxygen will report the cache usage and suggest 395 | # the optimal cache size from a speed point of view. 396 | # Minimum value: 0, maximum value: 9, default value: 0. 397 | 398 | LOOKUP_CACHE_SIZE = 0 399 | 400 | #--------------------------------------------------------------------------- 401 | # Build related configuration options 402 | #--------------------------------------------------------------------------- 403 | 404 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 405 | # documentation are documented, even if no documentation was available. Private 406 | # class members and static file members will be hidden unless the 407 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 408 | # Note: This will also disable the warnings about undocumented members that are 409 | # normally produced when WARNINGS is set to YES. 410 | # The default value is: NO. 411 | 412 | EXTRACT_ALL = NO 413 | 414 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 415 | # be included in the documentation. 416 | # The default value is: NO. 417 | 418 | EXTRACT_PRIVATE = NO 419 | 420 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 421 | # scope will be included in the documentation. 422 | # The default value is: NO. 423 | 424 | EXTRACT_PACKAGE = NO 425 | 426 | # If the EXTRACT_STATIC tag is set to YES all static members of a file will be 427 | # included in the documentation. 428 | # The default value is: NO. 429 | 430 | EXTRACT_STATIC = NO 431 | 432 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 433 | # locally in source files will be included in the documentation. If set to NO 434 | # only classes defined in header files are included. Does not have any effect 435 | # for Java sources. 436 | # The default value is: YES. 437 | 438 | EXTRACT_LOCAL_CLASSES = YES 439 | 440 | # This flag is only useful for Objective-C code. When set to YES local methods, 441 | # which are defined in the implementation section but not in the interface are 442 | # included in the documentation. If set to NO only methods in the interface are 443 | # included. 444 | # The default value is: NO. 445 | 446 | EXTRACT_LOCAL_METHODS = NO 447 | 448 | # If this flag is set to YES, the members of anonymous namespaces will be 449 | # extracted and appear in the documentation as a namespace called 450 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 451 | # the file that contains the anonymous namespace. By default anonymous namespace 452 | # are hidden. 453 | # The default value is: NO. 454 | 455 | EXTRACT_ANON_NSPACES = NO 456 | 457 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 458 | # undocumented members inside documented classes or files. If set to NO these 459 | # members will be included in the various overviews, but no documentation 460 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 461 | # The default value is: NO. 462 | 463 | HIDE_UNDOC_MEMBERS = NO 464 | 465 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 466 | # undocumented classes that are normally visible in the class hierarchy. If set 467 | # to NO these classes will be included in the various overviews. This option has 468 | # no effect if EXTRACT_ALL is enabled. 469 | # The default value is: NO. 470 | 471 | HIDE_UNDOC_CLASSES = NO 472 | 473 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 474 | # (class|struct|union) declarations. If set to NO these declarations will be 475 | # included in the documentation. 476 | # The default value is: NO. 477 | 478 | HIDE_FRIEND_COMPOUNDS = NO 479 | 480 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 481 | # documentation blocks found inside the body of a function. If set to NO these 482 | # blocks will be appended to the function's detailed documentation block. 483 | # The default value is: NO. 484 | 485 | HIDE_IN_BODY_DOCS = NO 486 | 487 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 488 | # \internal command is included. If the tag is set to NO then the documentation 489 | # will be excluded. Set it to YES to include the internal documentation. 490 | # The default value is: NO. 491 | 492 | INTERNAL_DOCS = NO 493 | 494 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 495 | # names in lower-case letters. If set to YES upper-case letters are also 496 | # allowed. This is useful if you have classes or files whose names only differ 497 | # in case and if your file system supports case sensitive file names. Windows 498 | # and Mac users are advised to set this option to NO. 499 | # The default value is: system dependent. 500 | 501 | CASE_SENSE_NAMES = YES 502 | 503 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 504 | # their full class and namespace scopes in the documentation. If set to YES the 505 | # scope will be hidden. 506 | # The default value is: NO. 507 | 508 | HIDE_SCOPE_NAMES = NO 509 | 510 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 511 | # the files that are included by a file in the documentation of that file. 512 | # The default value is: YES. 513 | 514 | SHOW_INCLUDE_FILES = YES 515 | 516 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 517 | # grouped member an include statement to the documentation, telling the reader 518 | # which file to include in order to use the member. 519 | # The default value is: NO. 520 | 521 | SHOW_GROUPED_MEMB_INC = NO 522 | 523 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 524 | # files with double quotes in the documentation rather than with sharp brackets. 525 | # The default value is: NO. 526 | 527 | FORCE_LOCAL_INCLUDES = NO 528 | 529 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 530 | # documentation for inline members. 531 | # The default value is: YES. 532 | 533 | INLINE_INFO = YES 534 | 535 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 536 | # (detailed) documentation of file and class members alphabetically by member 537 | # name. If set to NO the members will appear in declaration order. 538 | # The default value is: YES. 539 | 540 | SORT_MEMBER_DOCS = YES 541 | 542 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 543 | # descriptions of file, namespace and class members alphabetically by member 544 | # name. If set to NO the members will appear in declaration order. Note that 545 | # this will also influence the order of the classes in the class list. 546 | # The default value is: NO. 547 | 548 | SORT_BRIEF_DOCS = NO 549 | 550 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 551 | # (brief and detailed) documentation of class members so that constructors and 552 | # destructors are listed first. If set to NO the constructors will appear in the 553 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 554 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 555 | # member documentation. 556 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 557 | # detailed member documentation. 558 | # The default value is: NO. 559 | 560 | SORT_MEMBERS_CTORS_1ST = NO 561 | 562 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 563 | # of group names into alphabetical order. If set to NO the group names will 564 | # appear in their defined order. 565 | # The default value is: NO. 566 | 567 | SORT_GROUP_NAMES = NO 568 | 569 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 570 | # fully-qualified names, including namespaces. If set to NO, the class list will 571 | # be sorted only by class name, not including the namespace part. 572 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 573 | # Note: This option applies only to the class list, not to the alphabetical 574 | # list. 575 | # The default value is: NO. 576 | 577 | SORT_BY_SCOPE_NAME = NO 578 | 579 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 580 | # type resolution of all parameters of a function it will reject a match between 581 | # the prototype and the implementation of a member function even if there is 582 | # only one candidate or it is obvious which candidate to choose by doing a 583 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 584 | # accept a match between prototype and implementation in such cases. 585 | # The default value is: NO. 586 | 587 | STRICT_PROTO_MATCHING = NO 588 | 589 | # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 590 | # todo list. This list is created by putting \todo commands in the 591 | # documentation. 592 | # The default value is: YES. 593 | 594 | GENERATE_TODOLIST = YES 595 | 596 | # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 597 | # test list. This list is created by putting \test commands in the 598 | # documentation. 599 | # The default value is: YES. 600 | 601 | GENERATE_TESTLIST = YES 602 | 603 | # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 604 | # list. This list is created by putting \bug commands in the documentation. 605 | # The default value is: YES. 606 | 607 | GENERATE_BUGLIST = YES 608 | 609 | # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 610 | # the deprecated list. This list is created by putting \deprecated commands in 611 | # the documentation. 612 | # The default value is: YES. 613 | 614 | GENERATE_DEPRECATEDLIST= YES 615 | 616 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 617 | # sections, marked by \if ... \endif and \cond 618 | # ... \endcond blocks. 619 | 620 | ENABLED_SECTIONS = 621 | 622 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 623 | # initial value of a variable or macro / define can have for it to appear in the 624 | # documentation. If the initializer consists of more lines than specified here 625 | # it will be hidden. Use a value of 0 to hide initializers completely. The 626 | # appearance of the value of individual variables and macros / defines can be 627 | # controlled using \showinitializer or \hideinitializer command in the 628 | # documentation regardless of this setting. 629 | # Minimum value: 0, maximum value: 10000, default value: 30. 630 | 631 | MAX_INITIALIZER_LINES = 30 632 | 633 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 634 | # the bottom of the documentation of classes and structs. If set to YES the list 635 | # will mention the files that were used to generate the documentation. 636 | # The default value is: YES. 637 | 638 | SHOW_USED_FILES = YES 639 | 640 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 641 | # will remove the Files entry from the Quick Index and from the Folder Tree View 642 | # (if specified). 643 | # The default value is: YES. 644 | 645 | SHOW_FILES = YES 646 | 647 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 648 | # page. This will remove the Namespaces entry from the Quick Index and from the 649 | # Folder Tree View (if specified). 650 | # The default value is: YES. 651 | 652 | SHOW_NAMESPACES = YES 653 | 654 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 655 | # doxygen should invoke to get the current version for each file (typically from 656 | # the version control system). Doxygen will invoke the program by executing (via 657 | # popen()) the command command input-file, where command is the value of the 658 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 659 | # by doxygen. Whatever the program writes to standard output is used as the file 660 | # version. For an example see the documentation. 661 | 662 | FILE_VERSION_FILTER = 663 | 664 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 665 | # by doxygen. The layout file controls the global structure of the generated 666 | # output files in an output format independent way. To create the layout file 667 | # that represents doxygen's defaults, run doxygen with the -l option. You can 668 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 669 | # will be used as the name of the layout file. 670 | # 671 | # Note that if you run doxygen from a directory containing a file called 672 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 673 | # tag is left empty. 674 | 675 | LAYOUT_FILE = 676 | 677 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 678 | # the reference definitions. This must be a list of .bib files. The .bib 679 | # extension is automatically appended if omitted. This requires the bibtex tool 680 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 681 | # For LaTeX the style of the bibliography can be controlled using 682 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 683 | # search path. See also \cite for info how to create references. 684 | 685 | CITE_BIB_FILES = 686 | 687 | #--------------------------------------------------------------------------- 688 | # Configuration options related to warning and progress messages 689 | #--------------------------------------------------------------------------- 690 | 691 | # The QUIET tag can be used to turn on/off the messages that are generated to 692 | # standard output by doxygen. If QUIET is set to YES this implies that the 693 | # messages are off. 694 | # The default value is: NO. 695 | 696 | QUIET = NO 697 | 698 | # The WARNINGS tag can be used to turn on/off the warning messages that are 699 | # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 700 | # this implies that the warnings are on. 701 | # 702 | # Tip: Turn warnings on while writing the documentation. 703 | # The default value is: YES. 704 | 705 | WARNINGS = YES 706 | 707 | # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 708 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 709 | # will automatically be disabled. 710 | # The default value is: YES. 711 | 712 | WARN_IF_UNDOCUMENTED = YES 713 | 714 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 715 | # potential errors in the documentation, such as not documenting some parameters 716 | # in a documented function, or documenting parameters that don't exist or using 717 | # markup commands wrongly. 718 | # The default value is: YES. 719 | 720 | WARN_IF_DOC_ERROR = YES 721 | 722 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 723 | # are documented, but have no documentation for their parameters or return 724 | # value. If set to NO doxygen will only warn about wrong or incomplete parameter 725 | # documentation, but not about the absence of documentation. 726 | # The default value is: NO. 727 | 728 | WARN_NO_PARAMDOC = NO 729 | 730 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 731 | # can produce. The string should contain the $file, $line, and $text tags, which 732 | # will be replaced by the file and line number from which the warning originated 733 | # and the warning text. Optionally the format may contain $version, which will 734 | # be replaced by the version of the file (if it could be obtained via 735 | # FILE_VERSION_FILTER) 736 | # The default value is: $file:$line: $text. 737 | 738 | WARN_FORMAT = "$file:$line: $text" 739 | 740 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 741 | # messages should be written. If left blank the output is written to standard 742 | # error (stderr). 743 | 744 | WARN_LOGFILE = 745 | 746 | #--------------------------------------------------------------------------- 747 | # Configuration options related to the input files 748 | #--------------------------------------------------------------------------- 749 | 750 | # The INPUT tag is used to specify the files and/or directories that contain 751 | # documented source files. You may enter file names like myfile.cpp or 752 | # directories like /usr/src/myproject. Separate the files or directories with 753 | # spaces. 754 | # Note: If this tag is empty the current directory is searched. 755 | 756 | INPUT = 757 | 758 | # This tag can be used to specify the character encoding of the source files 759 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 760 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 761 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 762 | # possible encodings. 763 | # The default value is: UTF-8. 764 | 765 | INPUT_ENCODING = UTF-8 766 | 767 | # If the value of the INPUT tag contains directories, you can use the 768 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 769 | # *.h) to filter out the source-files in the directories. If left blank the 770 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 771 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 772 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 773 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 774 | # *.qsf, *.as and *.js. 775 | 776 | FILE_PATTERNS = 777 | 778 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 779 | # be searched for input files as well. 780 | # The default value is: NO. 781 | 782 | RECURSIVE = YES 783 | 784 | # The EXCLUDE tag can be used to specify files and/or directories that should be 785 | # excluded from the INPUT source files. This way you can easily exclude a 786 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 787 | # 788 | # Note that relative paths are relative to the directory from which doxygen is 789 | # run. 790 | 791 | EXCLUDE = 792 | 793 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 794 | # directories that are symbolic links (a Unix file system feature) are excluded 795 | # from the input. 796 | # The default value is: NO. 797 | 798 | EXCLUDE_SYMLINKS = NO 799 | 800 | # If the value of the INPUT tag contains directories, you can use the 801 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 802 | # certain files from those directories. 803 | # 804 | # Note that the wildcards are matched against the file with absolute path, so to 805 | # exclude all test directories for example use the pattern */test/* 806 | 807 | EXCLUDE_PATTERNS = 808 | 809 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 810 | # (namespaces, classes, functions, etc.) that should be excluded from the 811 | # output. The symbol name can be a fully qualified name, a word, or if the 812 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 813 | # AClass::ANamespace, ANamespace::*Test 814 | # 815 | # Note that the wildcards are matched against the file with absolute path, so to 816 | # exclude all test directories use the pattern */test/* 817 | 818 | EXCLUDE_SYMBOLS = 819 | 820 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 821 | # that contain example code fragments that are included (see the \include 822 | # command). 823 | 824 | EXAMPLE_PATH = 825 | 826 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 827 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 828 | # *.h) to filter out the source-files in the directories. If left blank all 829 | # files are included. 830 | 831 | EXAMPLE_PATTERNS = 832 | 833 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 834 | # searched for input files to be used with the \include or \dontinclude commands 835 | # irrespective of the value of the RECURSIVE tag. 836 | # The default value is: NO. 837 | 838 | EXAMPLE_RECURSIVE = NO 839 | 840 | # The IMAGE_PATH tag can be used to specify one or more files or directories 841 | # that contain images that are to be included in the documentation (see the 842 | # \image command). 843 | 844 | IMAGE_PATH = 845 | 846 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 847 | # invoke to filter for each input file. Doxygen will invoke the filter program 848 | # by executing (via popen()) the command: 849 | # 850 | # 851 | # 852 | # where is the value of the INPUT_FILTER tag, and is the 853 | # name of an input file. Doxygen will then use the output that the filter 854 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 855 | # will be ignored. 856 | # 857 | # Note that the filter must not add or remove lines; it is applied before the 858 | # code is scanned, but not when the output code is generated. If lines are added 859 | # or removed, the anchors will not be placed correctly. 860 | 861 | INPUT_FILTER = 862 | 863 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 864 | # basis. Doxygen will compare the file name with each pattern and apply the 865 | # filter if there is a match. The filters are a list of the form: pattern=filter 866 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 867 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 868 | # patterns match the file name, INPUT_FILTER is applied. 869 | 870 | FILTER_PATTERNS = 871 | 872 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 873 | # INPUT_FILTER ) will also be used to filter the input files that are used for 874 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 875 | # The default value is: NO. 876 | 877 | FILTER_SOURCE_FILES = NO 878 | 879 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 880 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 881 | # it is also possible to disable source filtering for a specific pattern using 882 | # *.ext= (so without naming a filter). 883 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 884 | 885 | FILTER_SOURCE_PATTERNS = 886 | 887 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 888 | # is part of the input, its contents will be placed on the main page 889 | # (index.html). This can be useful if you have a project on for instance GitHub 890 | # and want to reuse the introduction page also for the doxygen output. 891 | 892 | USE_MDFILE_AS_MAINPAGE = 893 | 894 | #--------------------------------------------------------------------------- 895 | # Configuration options related to source browsing 896 | #--------------------------------------------------------------------------- 897 | 898 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 899 | # generated. Documented entities will be cross-referenced with these sources. 900 | # 901 | # Note: To get rid of all source code in the generated output, make sure that 902 | # also VERBATIM_HEADERS is set to NO. 903 | # The default value is: NO. 904 | 905 | SOURCE_BROWSER = NO 906 | 907 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 908 | # classes and enums directly into the documentation. 909 | # The default value is: NO. 910 | 911 | INLINE_SOURCES = NO 912 | 913 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 914 | # special comment blocks from generated source code fragments. Normal C, C++ and 915 | # Fortran comments will always remain visible. 916 | # The default value is: YES. 917 | 918 | STRIP_CODE_COMMENTS = YES 919 | 920 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 921 | # function all documented functions referencing it will be listed. 922 | # The default value is: NO. 923 | 924 | REFERENCED_BY_RELATION = NO 925 | 926 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 927 | # all documented entities called/used by that function will be listed. 928 | # The default value is: NO. 929 | 930 | REFERENCES_RELATION = NO 931 | 932 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 933 | # to YES, then the hyperlinks from functions in REFERENCES_RELATION and 934 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 935 | # link to the documentation. 936 | # The default value is: YES. 937 | 938 | REFERENCES_LINK_SOURCE = YES 939 | 940 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 941 | # source code will show a tooltip with additional information such as prototype, 942 | # brief description and links to the definition and documentation. Since this 943 | # will make the HTML file larger and loading of large files a bit slower, you 944 | # can opt to disable this feature. 945 | # The default value is: YES. 946 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 947 | 948 | SOURCE_TOOLTIPS = YES 949 | 950 | # If the USE_HTAGS tag is set to YES then the references to source code will 951 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 952 | # source browser. The htags tool is part of GNU's global source tagging system 953 | # (see http://www.gnu.org/software/global/global.html). You will need version 954 | # 4.8.6 or higher. 955 | # 956 | # To use it do the following: 957 | # - Install the latest version of global 958 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 959 | # - Make sure the INPUT points to the root of the source tree 960 | # - Run doxygen as normal 961 | # 962 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 963 | # tools must be available from the command line (i.e. in the search path). 964 | # 965 | # The result: instead of the source browser generated by doxygen, the links to 966 | # source code will now point to the output of htags. 967 | # The default value is: NO. 968 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 969 | 970 | USE_HTAGS = NO 971 | 972 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 973 | # verbatim copy of the header file for each class for which an include is 974 | # specified. Set to NO to disable this. 975 | # See also: Section \class. 976 | # The default value is: YES. 977 | 978 | VERBATIM_HEADERS = YES 979 | 980 | # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the 981 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 982 | # cost of reduced performance. This can be particularly helpful with template 983 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 984 | # information. 985 | # Note: The availability of this option depends on whether or not doxygen was 986 | # compiled with the --with-libclang option. 987 | # The default value is: NO. 988 | 989 | CLANG_ASSISTED_PARSING = NO 990 | 991 | # If clang assisted parsing is enabled you can provide the compiler with command 992 | # line options that you would normally use when invoking the compiler. Note that 993 | # the include paths will already be set by doxygen for the files and directories 994 | # specified with INPUT and INCLUDE_PATH. 995 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 996 | 997 | CLANG_OPTIONS = 998 | 999 | #--------------------------------------------------------------------------- 1000 | # Configuration options related to the alphabetical class index 1001 | #--------------------------------------------------------------------------- 1002 | 1003 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1004 | # compounds will be generated. Enable this if the project contains a lot of 1005 | # classes, structs, unions or interfaces. 1006 | # The default value is: YES. 1007 | 1008 | ALPHABETICAL_INDEX = YES 1009 | 1010 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1011 | # which the alphabetical index list will be split. 1012 | # Minimum value: 1, maximum value: 20, default value: 5. 1013 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1014 | 1015 | COLS_IN_ALPHA_INDEX = 5 1016 | 1017 | # In case all classes in a project start with a common prefix, all classes will 1018 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1019 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1020 | # while generating the index headers. 1021 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1022 | 1023 | IGNORE_PREFIX = 1024 | 1025 | #--------------------------------------------------------------------------- 1026 | # Configuration options related to the HTML output 1027 | #--------------------------------------------------------------------------- 1028 | 1029 | # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 1030 | # The default value is: YES. 1031 | 1032 | GENERATE_HTML = YES 1033 | 1034 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1035 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1036 | # it. 1037 | # The default directory is: html. 1038 | # This tag requires that the tag GENERATE_HTML is set to YES. 1039 | 1040 | HTML_OUTPUT = html 1041 | 1042 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1043 | # generated HTML page (for example: .htm, .php, .asp). 1044 | # The default value is: .html. 1045 | # This tag requires that the tag GENERATE_HTML is set to YES. 1046 | 1047 | HTML_FILE_EXTENSION = .html 1048 | 1049 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1050 | # each generated HTML page. If the tag is left blank doxygen will generate a 1051 | # standard header. 1052 | # 1053 | # To get valid HTML the header file that includes any scripts and style sheets 1054 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1055 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1056 | # default header using 1057 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1058 | # YourConfigFile 1059 | # and then modify the file new_header.html. See also section "Doxygen usage" 1060 | # for information on how to generate the default header that doxygen normally 1061 | # uses. 1062 | # Note: The header is subject to change so you typically have to regenerate the 1063 | # default header when upgrading to a newer version of doxygen. For a description 1064 | # of the possible markers and block names see the documentation. 1065 | # This tag requires that the tag GENERATE_HTML is set to YES. 1066 | 1067 | HTML_HEADER = 1068 | 1069 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1070 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1071 | # footer. See HTML_HEADER for more information on how to generate a default 1072 | # footer and what special commands can be used inside the footer. See also 1073 | # section "Doxygen usage" for information on how to generate the default footer 1074 | # that doxygen normally uses. 1075 | # This tag requires that the tag GENERATE_HTML is set to YES. 1076 | 1077 | HTML_FOOTER = 1078 | 1079 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1080 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1081 | # the HTML output. If left blank doxygen will generate a default style sheet. 1082 | # See also section "Doxygen usage" for information on how to generate the style 1083 | # sheet that doxygen normally uses. 1084 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1085 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1086 | # obsolete. 1087 | # This tag requires that the tag GENERATE_HTML is set to YES. 1088 | 1089 | HTML_STYLESHEET = 1090 | 1091 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1092 | # cascading style sheets that are included after the standard style sheets 1093 | # created by doxygen. Using this option one can overrule certain style aspects. 1094 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1095 | # standard style sheet and is therefor more robust against future updates. 1096 | # Doxygen will copy the style sheet files to the output directory. 1097 | # Note: The order of the extra stylesheet files is of importance (e.g. the last 1098 | # stylesheet in the list overrules the setting of the previous ones in the 1099 | # list). For an example see the documentation. 1100 | # This tag requires that the tag GENERATE_HTML is set to YES. 1101 | 1102 | HTML_EXTRA_STYLESHEET = 1103 | 1104 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1105 | # other source files which should be copied to the HTML output directory. Note 1106 | # that these files will be copied to the base HTML output directory. Use the 1107 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1108 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1109 | # files will be copied as-is; there are no commands or markers available. 1110 | # This tag requires that the tag GENERATE_HTML is set to YES. 1111 | 1112 | HTML_EXTRA_FILES = 1113 | 1114 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1115 | # will adjust the colors in the stylesheet and background images according to 1116 | # this color. Hue is specified as an angle on a colorwheel, see 1117 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1118 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1119 | # purple, and 360 is red again. 1120 | # Minimum value: 0, maximum value: 359, default value: 220. 1121 | # This tag requires that the tag GENERATE_HTML is set to YES. 1122 | 1123 | HTML_COLORSTYLE_HUE = 220 1124 | 1125 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1126 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1127 | # value of 255 will produce the most vivid colors. 1128 | # Minimum value: 0, maximum value: 255, default value: 100. 1129 | # This tag requires that the tag GENERATE_HTML is set to YES. 1130 | 1131 | HTML_COLORSTYLE_SAT = 100 1132 | 1133 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1134 | # luminance component of the colors in the HTML output. Values below 100 1135 | # gradually make the output lighter, whereas values above 100 make the output 1136 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1137 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1138 | # change the gamma. 1139 | # Minimum value: 40, maximum value: 240, default value: 80. 1140 | # This tag requires that the tag GENERATE_HTML is set to YES. 1141 | 1142 | HTML_COLORSTYLE_GAMMA = 80 1143 | 1144 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1145 | # page will contain the date and time when the page was generated. Setting this 1146 | # to NO can help when comparing the output of multiple runs. 1147 | # The default value is: YES. 1148 | # This tag requires that the tag GENERATE_HTML is set to YES. 1149 | 1150 | HTML_TIMESTAMP = YES 1151 | 1152 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1153 | # documentation will contain sections that can be hidden and shown after the 1154 | # page has loaded. 1155 | # The default value is: NO. 1156 | # This tag requires that the tag GENERATE_HTML is set to YES. 1157 | 1158 | HTML_DYNAMIC_SECTIONS = NO 1159 | 1160 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1161 | # shown in the various tree structured indices initially; the user can expand 1162 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1163 | # such a level that at most the specified number of entries are visible (unless 1164 | # a fully collapsed tree already exceeds this amount). So setting the number of 1165 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1166 | # representing an infinite number of entries and will result in a full expanded 1167 | # tree by default. 1168 | # Minimum value: 0, maximum value: 9999, default value: 100. 1169 | # This tag requires that the tag GENERATE_HTML is set to YES. 1170 | 1171 | HTML_INDEX_NUM_ENTRIES = 100 1172 | 1173 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1174 | # generated that can be used as input for Apple's Xcode 3 integrated development 1175 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1176 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1177 | # Makefile in the HTML output directory. Running make will produce the docset in 1178 | # that directory and running make install will install the docset in 1179 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1180 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1181 | # for more information. 1182 | # The default value is: NO. 1183 | # This tag requires that the tag GENERATE_HTML is set to YES. 1184 | 1185 | GENERATE_DOCSET = NO 1186 | 1187 | # This tag determines the name of the docset feed. A documentation feed provides 1188 | # an umbrella under which multiple documentation sets from a single provider 1189 | # (such as a company or product suite) can be grouped. 1190 | # The default value is: Doxygen generated docs. 1191 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1192 | 1193 | DOCSET_FEEDNAME = "Doxygen generated docs" 1194 | 1195 | # This tag specifies a string that should uniquely identify the documentation 1196 | # set bundle. This should be a reverse domain-name style string, e.g. 1197 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1198 | # The default value is: org.doxygen.Project. 1199 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1200 | 1201 | DOCSET_BUNDLE_ID = org.doxygen.Project 1202 | 1203 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1204 | # the documentation publisher. This should be a reverse domain-name style 1205 | # string, e.g. com.mycompany.MyDocSet.documentation. 1206 | # The default value is: org.doxygen.Publisher. 1207 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1208 | 1209 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1210 | 1211 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1212 | # The default value is: Publisher. 1213 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1214 | 1215 | DOCSET_PUBLISHER_NAME = Publisher 1216 | 1217 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1218 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1219 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1220 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1221 | # Windows. 1222 | # 1223 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1224 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1225 | # files are now used as the Windows 98 help format, and will replace the old 1226 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1227 | # HTML files also contain an index, a table of contents, and you can search for 1228 | # words in the documentation. The HTML workshop also contains a viewer for 1229 | # compressed HTML files. 1230 | # The default value is: NO. 1231 | # This tag requires that the tag GENERATE_HTML is set to YES. 1232 | 1233 | GENERATE_HTMLHELP = NO 1234 | 1235 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1236 | # file. You can add a path in front of the file if the result should not be 1237 | # written to the html output directory. 1238 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1239 | 1240 | CHM_FILE = 1241 | 1242 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1243 | # including file name) of the HTML help compiler ( hhc.exe). If non-empty 1244 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1245 | # The file has to be specified with full path. 1246 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1247 | 1248 | HHC_LOCATION = 1249 | 1250 | # The GENERATE_CHI flag controls if a separate .chi index file is generated ( 1251 | # YES) or that it should be included in the master .chm file ( NO). 1252 | # The default value is: NO. 1253 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1254 | 1255 | GENERATE_CHI = NO 1256 | 1257 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 1258 | # and project file content. 1259 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1260 | 1261 | CHM_INDEX_ENCODING = 1262 | 1263 | # The BINARY_TOC flag controls whether a binary table of contents is generated ( 1264 | # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it 1265 | # enables the Previous and Next buttons. 1266 | # The default value is: NO. 1267 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1268 | 1269 | BINARY_TOC = NO 1270 | 1271 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1272 | # the table of contents of the HTML help documentation and to the tree view. 1273 | # The default value is: NO. 1274 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1275 | 1276 | TOC_EXPAND = NO 1277 | 1278 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1279 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1280 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1281 | # (.qch) of the generated HTML documentation. 1282 | # The default value is: NO. 1283 | # This tag requires that the tag GENERATE_HTML is set to YES. 1284 | 1285 | GENERATE_QHP = NO 1286 | 1287 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1288 | # the file name of the resulting .qch file. The path specified is relative to 1289 | # the HTML output folder. 1290 | # This tag requires that the tag GENERATE_QHP is set to YES. 1291 | 1292 | QCH_FILE = 1293 | 1294 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1295 | # Project output. For more information please see Qt Help Project / Namespace 1296 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1297 | # The default value is: org.doxygen.Project. 1298 | # This tag requires that the tag GENERATE_QHP is set to YES. 1299 | 1300 | QHP_NAMESPACE = org.doxygen.Project 1301 | 1302 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1303 | # Help Project output. For more information please see Qt Help Project / Virtual 1304 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1305 | # folders). 1306 | # The default value is: doc. 1307 | # This tag requires that the tag GENERATE_QHP is set to YES. 1308 | 1309 | QHP_VIRTUAL_FOLDER = doc 1310 | 1311 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1312 | # filter to add. For more information please see Qt Help Project / Custom 1313 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1314 | # filters). 1315 | # This tag requires that the tag GENERATE_QHP is set to YES. 1316 | 1317 | QHP_CUST_FILTER_NAME = 1318 | 1319 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1320 | # custom filter to add. For more information please see Qt Help Project / Custom 1321 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1322 | # filters). 1323 | # This tag requires that the tag GENERATE_QHP is set to YES. 1324 | 1325 | QHP_CUST_FILTER_ATTRS = 1326 | 1327 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1328 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1329 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1330 | # This tag requires that the tag GENERATE_QHP is set to YES. 1331 | 1332 | QHP_SECT_FILTER_ATTRS = 1333 | 1334 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1335 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1336 | # generated .qhp file. 1337 | # This tag requires that the tag GENERATE_QHP is set to YES. 1338 | 1339 | QHG_LOCATION = 1340 | 1341 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1342 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1343 | # install this plugin and make it available under the help contents menu in 1344 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1345 | # to be copied into the plugins directory of eclipse. The name of the directory 1346 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1347 | # After copying Eclipse needs to be restarted before the help appears. 1348 | # The default value is: NO. 1349 | # This tag requires that the tag GENERATE_HTML is set to YES. 1350 | 1351 | GENERATE_ECLIPSEHELP = NO 1352 | 1353 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1354 | # the directory name containing the HTML and XML files should also have this 1355 | # name. Each documentation set should have its own identifier. 1356 | # The default value is: org.doxygen.Project. 1357 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1358 | 1359 | ECLIPSE_DOC_ID = org.doxygen.Project 1360 | 1361 | # If you want full control over the layout of the generated HTML pages it might 1362 | # be necessary to disable the index and replace it with your own. The 1363 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1364 | # of each HTML page. A value of NO enables the index and the value YES disables 1365 | # it. Since the tabs in the index contain the same information as the navigation 1366 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1367 | # The default value is: NO. 1368 | # This tag requires that the tag GENERATE_HTML is set to YES. 1369 | 1370 | DISABLE_INDEX = NO 1371 | 1372 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1373 | # structure should be generated to display hierarchical information. If the tag 1374 | # value is set to YES, a side panel will be generated containing a tree-like 1375 | # index structure (just like the one that is generated for HTML Help). For this 1376 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1377 | # (i.e. any modern browser). Windows users are probably better off using the 1378 | # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 1379 | # further fine-tune the look of the index. As an example, the default style 1380 | # sheet generated by doxygen has an example that shows how to put an image at 1381 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1382 | # the same information as the tab index, you could consider setting 1383 | # DISABLE_INDEX to YES when enabling this option. 1384 | # The default value is: NO. 1385 | # This tag requires that the tag GENERATE_HTML is set to YES. 1386 | 1387 | GENERATE_TREEVIEW = YES 1388 | 1389 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1390 | # doxygen will group on one line in the generated HTML documentation. 1391 | # 1392 | # Note that a value of 0 will completely suppress the enum values from appearing 1393 | # in the overview section. 1394 | # Minimum value: 0, maximum value: 20, default value: 4. 1395 | # This tag requires that the tag GENERATE_HTML is set to YES. 1396 | 1397 | ENUM_VALUES_PER_LINE = 4 1398 | 1399 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1400 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1401 | # Minimum value: 0, maximum value: 1500, default value: 250. 1402 | # This tag requires that the tag GENERATE_HTML is set to YES. 1403 | 1404 | TREEVIEW_WIDTH = 250 1405 | 1406 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 1407 | # external symbols imported via tag files in a separate window. 1408 | # The default value is: NO. 1409 | # This tag requires that the tag GENERATE_HTML is set to YES. 1410 | 1411 | EXT_LINKS_IN_WINDOW = NO 1412 | 1413 | # Use this tag to change the font size of LaTeX formulas included as images in 1414 | # the HTML documentation. When you change the font size after a successful 1415 | # doxygen run you need to manually remove any form_*.png images from the HTML 1416 | # output directory to force them to be regenerated. 1417 | # Minimum value: 8, maximum value: 50, default value: 10. 1418 | # This tag requires that the tag GENERATE_HTML is set to YES. 1419 | 1420 | FORMULA_FONTSIZE = 10 1421 | 1422 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1423 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1424 | # supported properly for IE 6.0, but are supported on all modern browsers. 1425 | # 1426 | # Note that when changing this option you need to delete any form_*.png files in 1427 | # the HTML output directory before the changes have effect. 1428 | # The default value is: YES. 1429 | # This tag requires that the tag GENERATE_HTML is set to YES. 1430 | 1431 | FORMULA_TRANSPARENT = YES 1432 | 1433 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1434 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1435 | # instead of using prerendered bitmaps. Use this if you do not have LaTeX 1436 | # installed or if you want to formulas look prettier in the HTML output. When 1437 | # enabled you may also need to install MathJax separately and configure the path 1438 | # to it using the MATHJAX_RELPATH option. 1439 | # The default value is: NO. 1440 | # This tag requires that the tag GENERATE_HTML is set to YES. 1441 | 1442 | USE_MATHJAX = NO 1443 | 1444 | # When MathJax is enabled you can set the default output format to be used for 1445 | # the MathJax output. See the MathJax site (see: 1446 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1447 | # Possible values are: HTML-CSS (which is slower, but has the best 1448 | # compatibility), NativeMML (i.e. MathML) and SVG. 1449 | # The default value is: HTML-CSS. 1450 | # This tag requires that the tag USE_MATHJAX is set to YES. 1451 | 1452 | MATHJAX_FORMAT = HTML-CSS 1453 | 1454 | # When MathJax is enabled you need to specify the location relative to the HTML 1455 | # output directory using the MATHJAX_RELPATH option. The destination directory 1456 | # should contain the MathJax.js script. For instance, if the mathjax directory 1457 | # is located at the same level as the HTML output directory, then 1458 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1459 | # Content Delivery Network so you can quickly see the result without installing 1460 | # MathJax. However, it is strongly recommended to install a local copy of 1461 | # MathJax from http://www.mathjax.org before deployment. 1462 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1463 | # This tag requires that the tag USE_MATHJAX is set to YES. 1464 | 1465 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1466 | 1467 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1468 | # extension names that should be enabled during MathJax rendering. For example 1469 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1470 | # This tag requires that the tag USE_MATHJAX is set to YES. 1471 | 1472 | MATHJAX_EXTENSIONS = 1473 | 1474 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1475 | # of code that will be used on startup of the MathJax code. See the MathJax site 1476 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1477 | # example see the documentation. 1478 | # This tag requires that the tag USE_MATHJAX is set to YES. 1479 | 1480 | MATHJAX_CODEFILE = 1481 | 1482 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1483 | # the HTML output. The underlying search engine uses javascript and DHTML and 1484 | # should work on any modern browser. Note that when using HTML help 1485 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1486 | # there is already a search function so this one should typically be disabled. 1487 | # For large projects the javascript based search engine can be slow, then 1488 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1489 | # search using the keyboard; to jump to the search box use + S 1490 | # (what the is depends on the OS and browser, but it is typically 1491 | # , /