You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@corinthia.apache.org by pm...@apache.org on 2015/04/11 19:49:45 UTC
[1/4] incubator-corinthia git commit: Desktop app: Basic
infrastructure for Editor lib
Repository: incubator-corinthia
Updated Branches:
refs/heads/master 97148773a -> 23c028c72
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/MainWindow.cpp
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/MainWindow.cpp b/consumers/corinthia/src/MainWindow.cpp
new file mode 100644
index 0000000..cb2a280
--- /dev/null
+++ b/consumers/corinthia/src/MainWindow.cpp
@@ -0,0 +1,101 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#include "MainWindow.h"
+#include <QWebView.h>
+#include <QVBoxLayout>
+#include <QPushButton>
+#include <QCoreApplication>
+#include "Editor.h"
+#include "JSInterface.h"
+#include "Toolbar.h"
+
+MainWindow::MainWindow(QApplication *app) : QWidget(0)
+{
+ _app = app;
+ _toolbar = new Toolbar(this);
+ _editor = new Editor(this);
+ QVBoxLayout *vlayout = new QVBoxLayout();
+ this->setLayout(vlayout);
+ vlayout->addWidget(_toolbar);
+ vlayout->addWidget(_editor);
+ vlayout->setSpacing(0);
+ vlayout->setContentsMargins(4,4,4,4);
+
+ QObject::connect(_toolbar->tableButton(),SIGNAL(clicked()),this,SLOT(insertTable()));
+ QObject::connect(_toolbar->linkButton(),SIGNAL(clicked()),this,SLOT(insertLink()));
+ QObject::connect(_toolbar->characterButton(),SIGNAL(clicked()),this,SLOT(insertCharacter()));
+ QObject::connect(_toolbar->backspaceButton(),SIGNAL(clicked()),this,SLOT(backspace()));
+ QObject::connect(_toolbar->leftButton(),SIGNAL(clicked()),this,SLOT(moveLeft()));
+ QObject::connect(_toolbar->rightButton(),SIGNAL(clicked()),this,SLOT(moveRight()));
+ QObject::connect(_toolbar->undoButton(),SIGNAL(clicked()),this,SLOT(undo()));
+ QObject::connect(_toolbar->redoButton(),SIGNAL(clicked()),this,SLOT(redo()));
+
+ QString appPath = QCoreApplication::applicationDirPath();
+ QString docPath = appPath + "/../share/corinthia/sample.html";
+ QUrl url = QUrl::fromLocalFile(docPath);
+ qStdOut() << "sample document url = " << url.toString() << endl;
+ _editor->webView()->load(url);
+}
+
+MainWindow::~MainWindow()
+{
+ delete _toolbar;
+ delete _editor;
+}
+
+void MainWindow::insertTable()
+{
+ _editor->js()->tables.insertTable(4,3,"50%",true,"Table caption",QString::null);
+}
+
+void MainWindow::insertLink()
+{
+ _editor->js()->cursor.insertLink("Corinthia website","http://corinthia.incubator.apache.org");
+}
+
+void MainWindow::insertCharacter()
+{
+ _editor->js()->cursor.insertCharacter('X',true);
+}
+
+void MainWindow::backspace()
+{
+ _editor->js()->cursor.deleteCharacter();
+}
+
+void MainWindow::moveLeft()
+{
+ _editor->js()->cursor.moveLeft();
+}
+
+void MainWindow::moveRight()
+{
+ _editor->js()->cursor.moveRight();
+}
+
+void MainWindow::undo()
+{
+ _editor->js()->undoManager.undo();
+}
+
+void MainWindow::redo()
+{
+ _editor->js()->undoManager.redo();
+}
+
+//#include <MainWindow.moc>
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/MainWindow.h
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/MainWindow.h b/consumers/corinthia/src/MainWindow.h
new file mode 100644
index 0000000..0a2693b
--- /dev/null
+++ b/consumers/corinthia/src/MainWindow.h
@@ -0,0 +1,42 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#include <QWidget>
+
+class Toolbar;
+class Editor;
+
+class MainWindow : public QWidget
+{
+ Q_OBJECT
+public:
+ MainWindow(QApplication *app);
+ ~MainWindow();
+ public slots:
+ void insertTable();
+ void insertLink();
+ void insertCharacter();
+ void backspace();
+ void moveLeft();
+ void moveRight();
+ void undo();
+ void redo();
+private:
+ QApplication *_app;
+ Toolbar *_toolbar;
+ Editor *_editor;
+};
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/Toolbar.cpp
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/Toolbar.cpp b/consumers/corinthia/src/Toolbar.cpp
new file mode 100644
index 0000000..4a6faf6
--- /dev/null
+++ b/consumers/corinthia/src/Toolbar.cpp
@@ -0,0 +1,50 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#include "Toolbar.h"
+#include <QPushButton>
+#include <QHBoxLayout>
+
+Toolbar::Toolbar(QWidget *parent) : QWidget(parent)
+{
+ _tableButton = new QPushButton("Insert table",0);
+ _linkButton = new QPushButton("Insert link",0);
+ _characterButton = new QPushButton("Insert character",0);
+ _backspaceButton = new QPushButton("Backspace",0);
+ _leftButton = new QPushButton("Move left",0);
+ _rightButton = new QPushButton("Move right",0);
+ _undoButton = new QPushButton("Undo",0);
+ _redoButton = new QPushButton("Redo",0);
+
+ _layout = new QHBoxLayout();
+ this->setLayout(_layout);
+
+ _layout->addWidget(_tableButton);
+ _layout->addWidget(_linkButton);
+ _layout->addWidget(_characterButton);
+ _layout->addWidget(_backspaceButton);
+ _layout->addWidget(_leftButton);
+ _layout->addWidget(_rightButton);
+ _layout->addWidget(_undoButton);
+ _layout->addWidget(_redoButton);
+ _layout->setSpacing(4);
+ _layout->setContentsMargins(0,0,0,0);
+}
+
+Toolbar::~Toolbar()
+{
+}
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/Toolbar.h
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/Toolbar.h b/consumers/corinthia/src/Toolbar.h
new file mode 100644
index 0000000..207eafc
--- /dev/null
+++ b/consumers/corinthia/src/Toolbar.h
@@ -0,0 +1,49 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#include <QWidget>
+
+class QPushButton;
+class QHBoxLayout;
+
+class Toolbar : public QWidget
+{
+ Q_OBJECT
+public:
+ Toolbar(QWidget *parent = 0);
+ ~Toolbar();
+
+ QPushButton *tableButton() { return _tableButton; }
+ QPushButton *linkButton() { return _linkButton; }
+ QPushButton *characterButton() { return _characterButton; }
+ QPushButton *backspaceButton() { return _backspaceButton; }
+ QPushButton *leftButton() { return _leftButton; }
+ QPushButton *rightButton() { return _rightButton; }
+ QPushButton *undoButton() { return _undoButton; }
+ QPushButton *redoButton() { return _redoButton; }
+
+private:
+ QPushButton *_tableButton;
+ QPushButton *_linkButton;
+ QPushButton *_characterButton;
+ QPushButton *_backspaceButton;
+ QPushButton *_leftButton;
+ QPushButton *_rightButton;
+ QPushButton *_undoButton;
+ QPushButton *_redoButton;
+ QHBoxLayout *_layout;
+};
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/desktop.cpp
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/desktop.cpp b/consumers/corinthia/src/desktop.cpp
deleted file mode 100644
index c7cb188..0000000
--- a/consumers/corinthia/src/desktop.cpp
+++ /dev/null
@@ -1,53 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-#include <QtWebKit/QWebElement>
-#include <QtWebKitWidgets/QWebFrame>
-#include "editWindows.h"
-
-
-
-DesktopWindow::DesktopWindow(QWidget *parent)
- : QWidget(parent)
-{
- setupUi(this);
-}
-
-
-
-void DesktopWindow::on_elementLineEdit_returnPressed()
-{
- QWebFrame *frame = webView->page()->mainFrame();
- QWebElement document = frame->documentElement();
- QWebElementCollection elements = document.findAll(elementLineEdit->text());
-
- foreach (QWebElement element, elements)
- element.setAttribute("style", "background-color: #f0f090");
-}
-
-
-
-void DesktopWindow::on_highlightButton_clicked()
-{
- on_elementLineEdit_returnPressed();
-}
-
-
-
-void DesktopWindow::setUrl(const QUrl &url)
-{
- webView->setUrl(url);
-}
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/desktop.ui
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/desktop.ui b/consumers/corinthia/src/desktop.ui
deleted file mode 100644
index 2db697f..0000000
--- a/consumers/corinthia/src/desktop.ui
+++ /dev/null
@@ -1,72 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>DesktopWindow</class>
- <widget class="QWidget" name="Window">
- <property name="geometry">
- <rect>
- <x>0</x>
- <y>0</y>
- <width>640</width>
- <height>480</height>
- </rect>
- </property>
- <property name="windowTitle">
- <string>Web Element Selector</string>
- </property>
- <layout class="QVBoxLayout" name="verticalLayout">
- <item>
- <widget class="QWebView" name="webView">
- <property name="url">
- <url>
- <string>http://webkit.org/</string>
- </url>
- </property>
- </widget>
- </item>
- <item>
- <layout class="QHBoxLayout" name="horizontalLayout">
- <item>
- <layout class="QFormLayout" name="formLayout">
- <property name="fieldGrowthPolicy">
- <enum>QFormLayout::ExpandingFieldsGrow</enum>
- </property>
- <item row="0" column="0">
- <widget class="QLabel" name="elementLabel">
- <property name="text">
- <string>&Element:</string>
- </property>
- <property name="buddy">
- <cstring>elementLineEdit</cstring>
- </property>
- </widget>
- </item>
- <item row="0" column="1">
- <widget class="QLineEdit" name="elementLineEdit">
- <property name="text">
- <string>li a</string>
- </property>
- </widget>
- </item>
- </layout>
- </item>
- <item>
- <widget class="QPushButton" name="highlightButton">
- <property name="text">
- <string>&Highlight</string>
- </property>
- </widget>
- </item>
- </layout>
- </item>
- </layout>
- </widget>
- <customwidgets>
- <customwidget>
- <class>QWebView</class>
- <extends>QWidget</extends>
- <header>QtWebKit/QWebView</header>
- </customwidget>
- </customwidgets>
- <resources/>
- <connections/>
-</ui>
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/editWindows.h
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/editWindows.h b/consumers/corinthia/src/editWindows.h
deleted file mode 100644
index a49a6d6..0000000
--- a/consumers/corinthia/src/editWindows.h
+++ /dev/null
@@ -1,36 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-#ifndef editWindows_h
-#define editWindows_h
-#include <QtCore/QUrl>
-#include <QtWidgets/QWidget>
-#include "ui_desktop.h"
-
-class DesktopWindow : public QWidget, private Ui::DesktopWindow
-{
- Q_OBJECT
-
- public:
- DesktopWindow(QWidget *parent = 0);
- void setUrl(const QUrl &url);
-
- public slots:
- void on_elementLineEdit_returnPressed();
- void on_highlightButton_clicked();
-};
-
-#endif
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/main.cpp
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/main.cpp b/consumers/corinthia/src/main.cpp
index 399b0a6..f17f506 100644
--- a/consumers/corinthia/src/main.cpp
+++ b/consumers/corinthia/src/main.cpp
@@ -14,17 +14,14 @@
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
-#include <QtGUi/QtGui>
-#include "editWindows.h"
-
+#include <QApplication>
+#include "MainWindow.h"
int main(int argc, char *argv[])
{
- QApplication app(argc, argv);
-
- DesktopWindow desktop;
- desktop.setUrl(QUrl("http://corinthia.apache.org"));
- desktop.show();
- return app.exec();
+ QApplication *app = new QApplication(argc, argv);
+ MainWindow *window = new MainWindow(app);
+ window->show();
+ return app->exec();
}
[2/4] incubator-corinthia git commit: Desktop app: Basic
infrastructure for Editor lib
Posted by pm...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/res/sample.html
----------------------------------------------------------------------
diff --git a/consumers/corinthia/res/sample.html b/consumers/corinthia/res/sample.html
new file mode 100644
index 0000000..ef8be70
--- /dev/null
+++ b/consumers/corinthia/res/sample.html
@@ -0,0 +1,395 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+ <meta name="generator" content="UX Write 2.1.1 (build ad61a0a); iOS 8.2">
+ <meta charset="utf-8">
+ <style>
+body {
+ font-family: Palatino;
+ counter-reset: h1 h2 h3 h4 h5 h6 figure table;
+ margin: 10%;
+ text-align: justify;
+ }
+
+ caption {
+ caption-side: bottom;
+ counter-increment: table;
+ }
+
+ caption.Unnumbered {
+ counter-increment: table 0;
+ }
+
+ caption.Unnumbered::before {
+ content: "";
+ }
+
+ caption::before {
+ content: "Table " counter(table) ": ";
+ }
+
+ h1 {
+ counter-increment: h1;
+ counter-reset: h2 h3 h4 h5 h6;
+ }
+
+ h1::before {
+ content: counter(h1) " ";
+ }
+
+ h2 {
+ counter-increment: h2;
+ counter-reset: h3 h4 h5 h6;
+ }
+
+ h2::before {
+ content: counter(h1) "." counter(h2) " ";
+ }
+
+ h3 {
+ counter-increment: h3;
+ counter-reset: h4 h5 h6;
+ }
+
+ h3::before {
+ content: counter(h1) "." counter(h2) "." counter(h3) " ";
+ }
+
+ h4 {
+ counter-increment: h4;
+ counter-reset: h5 h6;
+ }
+
+ h4::before {
+ content: counter(h1) "." counter(h2) "." counter(h3) "." counter(h4) " ";
+ }
+
+ h5 {
+ counter-increment: h5;
+ counter-reset: h6;
+ }
+
+ h5::before {
+ content: counter(h1) "." counter(h2) "." counter(h3) "." counter(h4) "." counter(h5) " ";
+ }
+
+ h6 {
+ counter-increment: h6;
+ }
+
+ h6::before {
+ content: counter(h1) "." counter(h2) "." counter(h3) "." counter(h4) "." counter(h5) "." counter(h6) " ";
+ }
+
+ nav.tableofcontents::before {
+ content: "Contents";
+ display: block;
+ font-size: 2em;
+ font-weight: bold;
+ margin-bottom: .67em;
+ margin-top: .67em;
+ }
+
+ p.toc1 {
+ margin-bottom: 6pt;
+ margin-left: 0pt;
+ margin-top: 12pt;
+ }
+
+ p.toc2 {
+ margin-bottom: 6pt;
+ margin-left: 24pt;
+ margin-top: 6pt;
+ }
+
+ p.toc3 {
+ margin-bottom: 6pt;
+ margin-left: 48pt;
+ margin-top: 6pt;
+ }
+
+ table {
+ border-collapse: collapse;
+ margin-left: auto;
+ margin-right: auto;
+ }
+
+ td > :first-child, th > :first-child {
+ margin-top: 0;
+ }
+
+ td > :last-child, th > :last-child {
+ margin-bottom: 0;
+ }
+
+ td, th {
+ border: 1px solid black;
+ }
+ </style>
+
+ <title></title>
+</head>
+
+<body>
+ <p>Test document</p>
+
+ <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus at lorem
+ augue, at molestie risus. Sed bibendum augue metus, sed cursus tortor. Aenean
+ semper consectetur pulvinar. Aliquam ultrices tempus nibh, ut mollis ligula
+ ultrices nec. Curabitur vel eros in mi mattis vulputate in nec lorem. Nam
+ auctor faucibus diam, eget accumsan lorem auctor eu. Maecenas imperdiet
+ tristique nisi. Sed sed metus lacus. In consectetur tempus justo, vitae porta
+ urna dapibus nec. Duis vitae lorem sit amet quam suscipit mollis eget non
+ orci. Praesent porta neque et mauris molestie nec sagittis nulla
+ volutpat.</p>
+
+ <h1 id="item2">Introduction</h1>
+
+ <p>Vivamus nec cursus massa. Aenean hendrerit sagittis volutpat. Donec diam
+ erat, vehicula at ultrices vel, aliquet ac mauris. Nam vitae lectus eu eros
+ sagittis sollicitudin. Mauris consequat, est suscipit feugiat eleifend, leo
+ erat rutrum dui, at volutpat metus metus vitae leo. Fusce dictum tincidunt
+ dignissim. Vestibulum eu est purus, eu aliquam quam. Aenean ultricies ante
+ sit amet libero sodales eu feugiat velit ornare.</p>
+
+ <h2 id="item3">Background</h2>
+
+ <p>Proin facilisis cursus elementum. Proin ac lorem ut odio ultricies
+ vehicula sit amet in diam. Proin ut nunc et nisl tristique sagittis. Aenean
+ aliquet eleifend enim non molestie. Vivamus tincidunt augue nec erat suscipit
+ ullamcorper. Nulla ornare risus odio. Nullam vestibulum tellus ac odio mattis
+ quis sollicitudin arcu interdum. Donec convallis malesuada ultricies. Sed
+ sodales porta commodo. Ut nec fringilla est. Nulla aliquet feugiat orci in
+ lobortis. Duis adipiscing aliquam orci, ac tempus leo posuere id. Nam neque
+ enim, faucibus id luctus ut, blandit eu est. Nullam non convallis mauris.</p>
+
+ <h2 id="item4">Motivation</h2>
+
+ <p>Nunc tincidunt, ante vel hendrerit cursus, lectus quam dapibus ipsum, eget
+ vestibulum odio turpis eleifend augue. Ut pharetra ultricies risus, id
+ gravida risus tincidunt eget. Nam eros massa, condimentum quis aliquet nec,
+ aliquam id enim. Integer diam justo, sagittis at faucibus eget, vestibulum id
+ lectus. Suspendisse pharetra lobortis diam sit amet fermentum. Donec nisl
+ ipsum, faucibus et bibendum a, viverra nec nunc. Cras vel arcu mauris. In hac
+ habitasse platea dictumst.</p>
+
+ <h2 id="item5">Project overview</h2>
+
+ <p>Donec sagittis dui sollicitudin massa congue et mollis nulla cursus.
+ Maecenas eget tempor risus. Nam euismod placerat ante viverra gravida. Mauris
+ nec arcu eget turpis accumsan vestibulum. Phasellus luctus, massa vel laoreet
+ faucibus, nulla tellus luctus ipsum, nec imperdiet lacus urna id diam. In
+ libero lacus, rutrum id rhoncus at, mollis consequat mauris. Ut et lectus
+ nulla, nec sagittis massa. Praesent tortor dui, elementum sed tempor eget,
+ porta vehicula ligula. Fusce aliquam lacus in ipsum tristique
+ pellentesque.</p>
+
+ <table style="width: 60%;" id="item16">
+ <caption>
+ A sample table
+ </caption>
+ <col width="50%">
+ <col width="50%">
+
+ <tbody>
+ <tr>
+ <td>
+ <p>Cell 1,1</p>
+ </td>
+
+ <td>
+ <p>Cell 1,2</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <p>Cell 2,1</p>
+ </td>
+
+ <td>
+ <p>Cell 2,2</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <p>Cell 3,1</p>
+ </td>
+
+ <td>
+ <p>Cell 3,2</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <p>Cell 4,1</p>
+ </td>
+
+ <td>
+ <p>Cell 4,2</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <p>In nisi felis, ornare nec feugiat at, sodales posuere nibh. Etiam suscipit
+ congue nunc, at sollicitudin est adipiscing viverra. Aenean sed augue quis
+ sem commodo pretium. Maecenas quis elit urna. Donec non arcu dui. Praesent
+ faucibus ornare purus id dignissim. Quisque dictum viverra orci id lacinia.
+ Etiam mollis egestas tortor, id iaculis augue malesuada non. Sed elementum
+ ornare quam, vel iaculis nibh vulputate facilisis.</p>
+
+ <p>Nunc sit amet ipsum tellus, ut laoreet magna. Phasellus consectetur, velit
+ vitae laoreet posuere, eros diam venenatis ante, quis dignissim turpis turpis
+ at quam. Cras ac justo quis nibh sollicitudin gravida. Vestibulum ac
+ vulputate dui. Suspendisse ac nulla mauris, eget condimentum nulla. Nullam
+ mollis metus sed magna facilisis ac accumsan est facilisis. Pellentesque
+ consequat tincidunt sapien in vehicula.</p>
+
+ <h1 id="item6">Implementation</h1>
+
+ <h2 id="item7">Phase One</h2>
+
+ <p>Phasellus dignissim ultricies mauris placerat molestie. Nunc sed orci nec
+ orci mollis suscipit. Maecenas eget quam non arcu dapibus volutpat. Quisque
+ ac turpis ut libero interdum tristique id in quam. Praesent eros velit,
+ dictum eu auctor ut, lobortis ac sem. Duis ipsum neque, volutpat id blandit
+ sed, tempor a dui. Sed ut magna ligula, et sagittis nunc. Phasellus at
+ eleifend orci. Quisque non nunc ipsum. Curabitur eu erat nec ante suscipit
+ mollis. Fusce dictum laoreet volutpat. Vivamus rutrum luctus mattis.</p>
+
+ <p>Sed augue velit, eleifend sed auctor sed, consectetur quis augue. Nulla
+ consectetur imperdiet quam et elementum. Praesent suscipit magna id diam
+ cursus in faucibus arcu semper. Phasellus pretium, nisl in sagittis viverra,
+ arcu tellus aliquam urna, et scelerisque eros lorem et diam. In ut nunc vel
+ nisi imperdiet mattis quis at massa. Phasellus quis tortor est. Sed ac
+ blandit eros. Curabitur ante mauris, condimentum in tempus sit amet, accumsan
+ ac leo. Ut quis tincidunt nunc. Vestibulum ante ipsum primis in faucibus orci
+ luctus et ultrices posuere cubilia Curae; Curabitur tincidunt, nisl id
+ interdum fringilla, mauris tortor volutpat libero, et consectetur purus magna
+ quis nibh.</p>
+
+ <h2 id="item8">Phase Two</h2>
+
+ <p>Aliquam dapibus tincidunt purus in aliquet. In sed ultricies sapien. Cras
+ risus nulla, ultrices ut vulputate ac, luctus in purus. Maecenas at lorem
+ sem, a vestibulum sem. Donec ante nisl, facilisis vel convallis vel, blandit
+ quis turpis. Sed id erat vitae metus cursus consectetur. Integer ac dapibus
+ dui. Nam mi ante, sollicitudin eu fringilla quis, fringilla nec lorem.
+ Aliquam ut nisi accumsan odio pulvinar euismod quis ac libero. Curabitur sit
+ amet ultrices risus. Class aptent taciti sociosqu ad litora torquent per
+ conubia nostra, per inceptos himenaeos. Nulla eu dui ut est aliquet iaculis
+ accumsan et leo. Donec dignissim lorem non arcu hendrerit vel feugiat quam
+ accumsan. Etiam mollis fermentum mi vel egestas. Cum sociis natoque penatibus
+ et magnis dis parturient montes, nascetur ridiculus mus.</p>
+
+ <p>Ut facilisis leo nec neque tempus a molestie libero consequat. Duis et
+ justo eu lorem accumsan eleifend sed nec quam. Duis a ligula ante. Donec
+ egestas lacus id mi convallis ut ullamcorper lorem consequat. Curabitur quis
+ sapien vel odio sodales consequat. Maecenas eget commodo eros. In hac
+ habitasse platea dictumst. Donec commodo venenatis consequat. Nulla
+ vestibulum adipiscing nulla id adipiscing. Nam congue, enim et lobortis
+ rhoncus, urna purus tempor magna, a eleifend mi nisl eu magna. Vestibulum
+ ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia
+ Curae;</p>
+
+ <h2 id="item9">Phase Three</h2>
+
+ <p>Proin placerat sapien eu odio ornare eu pharetra nunc lacinia. Duis tellus
+ nisl, condimentum eget tristique sit amet, imperdiet id felis. Nunc at lectus
+ non risus tristique sollicitudin. Etiam at tellus vitae velit sagittis
+ aliquam. Vivamus bibendum pellentesque dictum. Ut auctor interdum congue.
+ Cras ultrices sem sed sem convallis viverra.</p>
+
+ <p>Nunc pulvinar, diam quis dictum gravida, nulla augue sodales lectus, id
+ pharetra leo purus nec augue. Cum sociis natoque penatibus et magnis dis
+ parturient montes, nascetur ridiculus mus. Praesent consequat venenatis justo
+ tincidunt semper. Praesent egestas, ipsum id pharetra lobortis, arcu risus
+ viverra dui, nec sollicitudin augue leo et neque. Proin commodo pharetra
+ lacus, vitae lobortis libero posuere in. Vestibulum tellus ante, luctus quis
+ luctus at, laoreet feugiat turpis. Morbi commodo tellus non leo faucibus
+ ornare. Ut volutpat, diam et mollis dignissim, felis ante lobortis nibh, sed
+ ullamcorper nibh nunc sed dolor. Phasellus viverra leo erat, luctus vehicula
+ dui. Mauris quis ipsum mollis odio accumsan consectetur lacinia feugiat
+ risus. Pellentesque habitant morbi tristique senectus et netus et malesuada
+ fames ac turpis egestas. Fusce vel lectus non risus facilisis suscipit vitae
+ vitae velit. Fusce lacinia enim dapibus mauris porta luctus. Vivamus
+ venenatis sodales nunc non porttitor. Sed posuere commodo consectetur.</p>
+
+ <h1 id="item10">Required resources</h1>
+
+ <p>Vestibulum suscipit posuere elementum. Nullam volutpat, sapien at eleifend
+ congue, dolor sapien pulvinar nibh, eu vulputate velit urna quis nisl.
+ Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere
+ cubilia Curae; Nunc auctor libero sed metus dictum quis placerat elit
+ varius.</p>
+
+ <h2 id="item11">Equipment</h2>
+
+ <p>Praesent fermentum augue sem. Cum sociis natoque penatibus et magnis dis
+ parturient montes, nascetur ridiculus mus. Fusce non lorem ligula, ac rhoncus
+ odio. Fusce ac magna lectus. Integer iaculis congue quam, sit amet tincidunt
+ orci mattis quis. Maecenas tempor, turpis nec euismod bibendum, orci dui
+ suscipit purus, iaculis mattis nunc magna at dui. Cras non neque tellus.
+ Integer lobortis, elit ac pretium imperdiet, nulla metus tempus nulla, vitae
+ bibendum diam nisl sed tellus. Class aptent taciti sociosqu ad litora
+ torquent per conubia nostra, per inceptos himenaeos.</p>
+
+ <p>Aliquam vehicula magna pharetra tortor pellentesque vestibulum. Vivamus ut
+ ullamcorper ante. Integer eu auctor lorem. Morbi sapien erat, viverra vitae
+ gravida id, bibendum eu augue. Maecenas nec dolor augue. Lorem ipsum dolor
+ sit amet, consectetur adipiscing elit. Donec aliquet dui at odio lacinia
+ placerat. Mauris a ipsum justo, id faucibus risus.</p>
+
+ <p>Sed vitae elit sed lectus varius vehicula. Maecenas pulvinar laoreet
+ metus, quis dignissim ipsum hendrerit fringilla. Quisque in neque sed ipsum
+ eleifend tempor. Etiam at posuere neque. Maecenas dapibus lacus tincidunt
+ neque elementum sed porta mauris luctus. Donec sit amet libero augue, at
+ hendrerit odio. Nulla consectetur, sem a vestibulum viverra, est nisl congue
+ leo, eget consectetur turpis justo et dolor. Fusce mollis mollis dui, eget
+ aliquet enim sollicitudin sed. Proin dictum sollicitudin rutrum. Curabitur
+ lorem risus, tempus ac ultricies id, suscipit ac nisl. Duis ultricies
+ facilisis arcu, vel congue risus tincidunt sit amet.</p>
+
+ <h2 id="item13">Personnel</h2>
+
+ <p>Etiam condimentum neque non dolor faucibus eu commodo nibh sodales.
+ Vivamus tempus est in risus malesuada vitae gravida nulla tristique. Maecenas
+ vitae justo a enim imperdiet euismod. Pellentesque porttitor metus nec enim
+ fermentum accumsan. Duis gravida ultricies aliquet. Etiam a risus turpis, sed
+ consequat arcu. Proin cursus quam non leo rutrum molestie. Ut eu orci ac nisl
+ lobortis porttitor a at massa. Nam id fringilla enim. Aenean pellentesque
+ molestie dui, sed dignissim urna mollis in. Ut ut metus non leo pharetra
+ tempor eu molestie metus. Aliquam iaculis nulla eget nisl ullamcorper vel
+ varius erat pretium.</p>
+
+ <p>Phasellus at magna tortor, eu elementum ligula. Etiam malesuada vehicula
+ elementum. Donec quis blandit dui. Phasellus tincidunt ullamcorper pharetra.
+ Integer egestas elementum egestas. Phasellus porta, neque a ultricies
+ pharetra, elit leo sodales purus, non auctor quam magna sed lectus. In et
+ ligula ipsum. Morbi vehicula auctor dolor cursus elementum. Cras vestibulum,
+ enim quis luctus posuere, metus enim mollis libero, at dictum enim magna eget
+ dolor. Vestibulum sagittis mi ac nibh dignissim placerat. Praesent vehicula
+ facilisis luctus. Donec ultrices, est non convallis lacinia, diam neque
+ blandit est, sed tincidunt felis ante sed dolor. Fusce laoreet justo sed
+ neque congue scelerisque.</p>
+
+ <h1 id="item14">Summary</h1>
+
+ <p>Nulla vitae ipsum orci. Suspendisse potenti. In sagittis quam non augue
+ blandit dapibus. Nulla dignissim viverra ante a egestas. In augue mi, porta
+ sit amet tempus eget, venenatis ac purus. Pellentesque non sapien et quam
+ molestie consectetur at ut magna. Maecenas turpis justo, adipiscing eu
+ tincidunt vulputate, ultricies sit amet magna.</p>
+
+ <p>Maecenas eget felis at massa pellentesque blandit ac eget lectus. Ut sit
+ amet nibh nunc, sit amet consequat massa. Suspendisse sit amet tempor tellus.
+ Vivamus nec lectus metus. Morbi id nibh neque. Pellentesque semper, sapien id
+ suscipit tincidunt, eros velit rhoncus dolor, non sagittis turpis erat vitae
+ velit. Nulla ligula turpis, lacinia non consequat in, lobortis sollicitudin
+ felis. Suspendisse pulvinar est eu felis congue id vehicula est luctus.</p>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/CMakeLists.txt b/consumers/corinthia/src/CMakeLists.txt
index 2f56fce..ef4b5ae 100644
--- a/consumers/corinthia/src/CMakeLists.txt
+++ b/consumers/corinthia/src/CMakeLists.txt
@@ -24,11 +24,17 @@ set_property(GLOBAL PROPERTY USE_FOLDERS ON)
## group source objects
###
set(SOURCES
- editWindows.h
- desktop.cpp
- main.cpp)
-set(UI_SOURCES
- desktop.ui)
+ Editor.h
+ Editor.cpp
+ JSInterface.h
+ JSInterface.cpp
+ main.cpp
+ MainWindow.h
+ MainWindow.cpp
+ Toolbar.h
+ Toolbar.cpp)
+#set(UI_SOURCES
+# desktop.ui)
@@ -45,12 +51,14 @@ link_directories(${LIB_DIRS})
###
## Qt magic
###
-set(CMAKE_PREFIX_PATH "C:/Qt/5.4/msvc2013_64")
+set(CMAKE_PREFIX_PATH "/usr/local/opt/qt5")
set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_AUTOMOC ON)
find_package(Qt5Widgets REQUIRED)
-include_directories("C:/Qt/5.4/msvc2013_64/include")
+find_package(Qt5WebKit REQUIRED)
+find_package(Qt5WebKitWidgets REQUIRED)
+include_directories("/usr/local/opt/qt5/include")
qt5_wrap_ui(UI_HEADERS ${UI_SOURCES})
source_group("Generated UI Headers" FILES ${UI_HEADERS})
@@ -62,7 +70,18 @@ source_group("Generated UI Headers" FILES ${UI_HEADERS})
# executable (release artifact)
###
add_executable(corinthia ${SOURCES} ${UI_HEADERS} ${UI_FILES})
-qt5_use_modules(corinthia Widgets)
+qt5_use_modules(corinthia Widgets WebKit WebKitWidgets)
target_link_libraries(corinthia DocFormats ${LIBS})
source_group(src FILES ${SOURCES})
set_property(TARGET corinthia PROPERTY FOLDER consumers)
+
+message(CMAKE_SOURCE_DIR " is " ${CMAKE_SOURCE_DIR})
+message(TARGET_FILE_DIR ":corinthia is " $<TARGET_FILE_DIR:corinthia>)
+message(CMAKE_BINARY_DIR " is " ${CMAKE_BINARY_DIR})
+
+add_custom_command(TARGET corinthia PRE_BUILD
+ COMMAND ${CMAKE_COMMAND} -E copy_directory
+ ${CMAKE_SOURCE_DIR}/Editor/src ${CMAKE_BINARY_DIR}/share/corinthia/js)
+add_custom_command(TARGET corinthia PRE_BUILD
+ COMMAND ${CMAKE_COMMAND} -E copy_directory
+ ${CMAKE_SOURCE_DIR}/consumers/corinthia/res ${CMAKE_BINARY_DIR}/share/corinthia)
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/Editor.cpp
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/Editor.cpp b/consumers/corinthia/src/Editor.cpp
new file mode 100644
index 0000000..9cce7b8
--- /dev/null
+++ b/consumers/corinthia/src/Editor.cpp
@@ -0,0 +1,296 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#include "Editor.h"
+#include "JSInterface.h"
+#include <QWebView>
+#include <QWebFrame>
+#include <QFile>
+#include <QLayout>
+#include <QBoxLayout>
+#include <QVBoxLayout>
+#include <QHBoxLayout>
+#include <QCoreApplication>
+
+class EditorJSCallbacks : public JSCallbacks
+{
+public:
+ EditorJSCallbacks(Editor *editor) : _editor(editor) {}
+ void debug(const QString &message);
+ void addOutlineItem(const QString &itemId, const QString &type, const QString &title);
+ void updateOutlineItem(const QString &itemId, const QString &title);
+ void removeOutlineItem(const QString &itemId);
+ void outlineUpdated();
+ void setCursor(int x, int y, int width, int height);
+ void setSelectionHandles(int x1, int y1, int height1, int x2, int y2, int height2);
+ void setTableSelection(int x, int y, int width, int height);
+ void setSelectionBounds(int left, int top, int right, int bottom);
+ void clearSelectionHandlesAndCursor();
+ void updateAutoCorrect();
+ void error(const QString &message, const QString &operation);
+//private:
+ Editor *_editor;
+};
+
+class EditorJSEvaluator : public JSEvaluator
+{
+public:
+ EditorJSEvaluator(QWebView *webView, JSCallbacks *callbacks) : _webView(webView), _callbacks(callbacks) {}
+ virtual QString evaluate(const QString &script);
+ virtual JSCallbacks *callbacks() { return _callbacks; }
+private:
+ QWebView *_webView;
+ JSCallbacks *_callbacks;
+};
+
+class EditorPrivate : public QObject
+{
+ Q_OBJECT
+public:
+ EditorPrivate(Editor *editor);
+ virtual ~EditorPrivate();
+ public slots:
+ void webViewloadFinished(bool ok);
+public:
+
+ Editor *_editor;
+ QWebView *_webView;
+ EditorJSCallbacks *_callbacks;
+ EditorJSEvaluator *_evaluator;
+ JSInterface *_js;
+};
+
+
+
+const char *jsSources[] = {
+ "first.js",
+ "ElementTypes.js",
+ "AutoCorrect.js",
+ "ChangeTracking.js",
+ "Clipboard.js",
+ "Cursor.js",
+ "DOM.js",
+ "Editor.js",
+ "Equations.js",
+ "Figures.js",
+ "Formatting.js",
+ "Hierarchy.js",
+ "Input.js",
+ "Lists.js",
+ "Main.js",
+ "Metadata.js",
+ "NodeSet.js",
+ "Outline.js",
+ "Position.js",
+ "PostponedActions.js",
+ "Preview.js",
+ "Range.js",
+ "Scan.js",
+ "Selection.js",
+ "StringBuilder.js",
+ "Styles.js",
+ "Tables.js",
+ "Text.js",
+ "traversal.js",
+ "types.js",
+ "UndoManager.js",
+ "util.js",
+ "Viewport.js",
+ NULL,
+};
+
+
+
+
+void EditorJSCallbacks::debug(const QString &message)
+{
+ qStdOut() << "CB debug \"" << message << "\"" << endl;
+}
+
+void EditorJSCallbacks::addOutlineItem(const QString &itemId, const QString &type, const QString &title)
+{
+ qStdOut() << "CB addOutlineItem " << itemId << " " << type << " \"" << title << "\"" << endl;
+}
+
+void EditorJSCallbacks::updateOutlineItem(const QString &itemId, const QString &title)
+{
+ qStdOut() << "CB updateOutlineItem " << itemId << " \"" << title << "\"" << endl;
+}
+
+void EditorJSCallbacks::removeOutlineItem(const QString &itemId)
+{
+ qStdOut() << "CB removeOutlineItem " << itemId << endl;
+}
+
+void EditorJSCallbacks::outlineUpdated()
+{
+ qStdOut() << "CB outlineUpdated" << endl;
+}
+
+void EditorJSCallbacks::setCursor(int x, int y, int width, int height)
+{
+ qStdOut() << "CB setCursor " << x << " " << y << " " << width << " " << height << endl;
+}
+
+void EditorJSCallbacks::setSelectionHandles(int x1, int y1, int height1, int x2, int y2, int height2)
+{
+ qStdOut() << "CB setSelectionHandles " << x1 << " " << y1 << " " << height1 << " "
+ << x2 << " " << y2 << " " << height2 << endl;
+}
+
+void EditorJSCallbacks::setTableSelection(int x, int y, int width, int height)
+{
+ qStdOut() << "CB setTableSelection" << x << " " << y << " " << width << " " << height << endl;
+}
+
+void EditorJSCallbacks::setSelectionBounds(int left, int top, int right, int bottom)
+{
+ qStdOut() << "CB setSelectionBounds " << left << " " << top << " " << right << " " << bottom << endl;
+}
+
+void EditorJSCallbacks::clearSelectionHandlesAndCursor()
+{
+ qStdOut() << "CB clearSelectionHandlesAndCursor" << endl;
+}
+
+void EditorJSCallbacks::updateAutoCorrect()
+{
+ qStdOut() << "CB updateAutoCorrect" << endl;
+}
+
+void EditorJSCallbacks::error(const QString &message, const QString &operation)
+{
+ qStdOut() << "CB error \"" << message << "\" \"" << operation << "\"" << endl;
+}
+
+QString EditorJSEvaluator::evaluate(const QString &script)
+{
+ QWebFrame *frame = _webView->page()->mainFrame();
+ QVariant result = frame->evaluateJavaScript(script);
+ if (result.userType() != QMetaType::QString)
+ return QString::null;
+ else
+ return result.toString();
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+EditorPrivate::EditorPrivate(Editor *editor) : _editor(editor)
+{
+ _webView = new QWebView(editor);
+ _callbacks = new EditorJSCallbacks(editor);
+ _evaluator = new EditorJSEvaluator(_webView,_callbacks);
+ _js = new JSInterface(_evaluator);
+ QObject::connect(_webView,SIGNAL(loadFinished(bool)),this,SLOT(webViewloadFinished(bool)));
+}
+
+EditorPrivate::~EditorPrivate()
+{
+ delete _webView;
+ delete _callbacks;
+ delete _evaluator;
+ delete _js;
+}
+
+void EditorPrivate::webViewloadFinished(bool ok)
+{
+ qStdOut() << "webViewloadFinished: ok = " << ok << endl;
+ if (!ok)
+ return;
+ QWebFrame *frame = _editor->webView()->page()->mainFrame();
+ // frame->evaluateJavaScript("alert('This is a test')");
+
+ QString appPath = QCoreApplication::applicationDirPath();
+ QString baseDir = appPath + "/../share/corinthia/js";
+ baseDir = QUrl::fromLocalFile(baseDir).path();
+ qStdOut() << "js base dir = " << baseDir << endl;
+
+ for (int i = 0; jsSources[i] != NULL; i++) {
+ QString fullPath = baseDir + "/" + QString(jsSources[i]);
+ QFile file(fullPath);
+ if (file.open(QFile::ReadOnly)) {
+ QTextStream stream(&file);
+ QString content = stream.readAll();
+ frame->evaluateJavaScript(content);
+ }
+ else {
+ qStdOut() << "Can't open file " << fullPath << endl;
+ return;
+ }
+ }
+
+ frame->evaluateJavaScript("Main_init()");
+
+ processCallbacks(_evaluator);
+}
+
+Editor::Editor(QWidget *parent, Qt::WindowFlags f) : QWidget(parent,f)
+{
+ _p = new EditorPrivate(this);
+ QVBoxLayout *layout = new QVBoxLayout(this);
+ layout->addWidget(_p->_webView);
+ setLayout(layout);
+}
+
+Editor::~Editor()
+{
+ delete _p;
+}
+
+QWebView *Editor::webView() const
+{
+ return _p->_webView;
+}
+
+JSInterface *Editor::js() const
+{
+ return _p->_js;
+}
+
+#include <Editor.moc>
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/Editor.h
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/Editor.h b/consumers/corinthia/src/Editor.h
new file mode 100644
index 0000000..117a18d
--- /dev/null
+++ b/consumers/corinthia/src/Editor.h
@@ -0,0 +1,35 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#import <QWidget>
+
+class Editor;
+class EditorPrivate;
+class QWebView;
+class JSInterface;
+
+class Editor : public QWidget
+{
+ Q_OBJECT
+public:
+ Editor(QWidget *parent = 0, Qt::WindowFlags f = 0);
+ virtual ~Editor();
+ QWebView *webView() const;
+ JSInterface *js() const;
+private:
+ EditorPrivate *_p;
+};
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/JSInterface.cpp
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/JSInterface.cpp b/consumers/corinthia/src/JSInterface.cpp
new file mode 100644
index 0000000..f6b549f
--- /dev/null
+++ b/consumers/corinthia/src/JSInterface.cpp
@@ -0,0 +1,1307 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#include "JSInterface.h"
+#include <QJsonDocument>
+#include <assert.h>
+
+QTextStream& qStdOut()
+{
+ static QTextStream ts( stdout );
+ return ts;
+}
+
+class JSArgs
+{
+public:
+ QString toString() const;
+ JSArgs &operator<<(int value);
+ JSArgs &operator<<(unsigned int value);
+ JSArgs &operator<<(double value);
+ JSArgs &operator<<(bool value);
+ JSArgs &operator<<(const char *value);
+ JSArgs &operator<<(const QString &value);
+ JSArgs &operator<<(const QJsonArray &value);
+ JSArgs &operator<<(const QJsonObject &value);
+ JSArgs &operator<<(const QJsonValue &value);
+ JSArgs &operator<<(const QRect &value);
+ JSArgs &operator<<(const QPoint &value);
+ JSArgs &operator<<(const QSize &value);
+ JSArgs &operator<<(const QMap<QString,QString> map);
+private:
+ QJsonArray _array;
+};
+
+QString JSArgs::toString() const
+{
+ QString argsStr = QJsonDocument(_array).toJson(QJsonDocument::Compact);
+ assert(argsStr.size() >= 2);
+ assert(argsStr[0] == '[');
+ assert(argsStr[argsStr.size()-1] == ']');
+ argsStr.remove(0,1);
+ argsStr.remove(argsStr.size()-1,1);
+ return argsStr;
+}
+
+JSArgs &JSArgs::operator<<(int value)
+{
+ _array.append(value);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(unsigned int value)
+{
+ _array.append((double)value);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(double value)
+{
+ _array.append(value);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(bool value)
+{
+ _array.append(value);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(const char *value)
+{
+ if (value == NULL)
+ _array.append(QJsonValue::Null);
+ else
+ _array.append(value);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(const QString &value)
+{
+ if (value.isNull())
+ _array.append(QJsonValue::Null);
+ else
+ _array.append(value);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(const QJsonArray &value)
+{
+ _array.append(value);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(const QJsonObject &value)
+{
+ _array.append(value);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(const QJsonValue &value)
+{
+ _array.append(value);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(const QRect &value)
+{
+ QJsonObject obj;
+ obj["x"] = QJsonValue(value.x());
+ obj["y"] = QJsonValue(value.y());
+ obj["width"] = QJsonValue(value.width());
+ obj["height"] = QJsonValue(value.height());
+ _array.append(obj);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(const QPoint &value)
+{
+ QJsonObject obj;
+ obj["x"] = QJsonValue(value.x());
+ obj["y"] = QJsonValue(value.y());
+ _array.append(obj);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(const QSize &value)
+{
+ QJsonObject obj;
+ obj["width"] = QJsonValue(value.width());
+ obj["height"] = QJsonValue(value.height());
+ _array.append(obj);
+ return *this;
+}
+
+JSArgs &JSArgs::operator<<(const QMap<QString,QString> map)
+{
+ QJsonObject obj;
+ QMapIterator<QString,QString> it(map);
+ while (it.hasNext()) {
+ it.next();
+ QString key = it.key();
+ QString value = it.value();
+ if (value.isNull())
+ obj[key] = QJsonValue::Null;
+ else
+ obj[key] = value;
+ }
+ _array.append(obj);
+ return *this;
+}
+
+void testargs()
+{
+ int intVal = 4294967295;
+ unsigned int uintVal = 4294967295;
+ QMap<QString,QString> map;
+ map["color"] = "red";
+ map["font-size"] = "24";
+ map["font-family"] = "Helvetica";
+ map["background-color"] = QString::null;
+ JSArgs args = JSArgs()
+ << intVal
+ << uintVal
+ << 3.2
+ << true
+ << false
+ << "test"
+ << (char *)NULL
+ << QString("test")
+ << QString::null
+ << QJsonArray()
+ << QJsonObject()
+ << QJsonValue("value")
+ << QRect(1,2,3,4)
+ << QPoint(5,6)
+ << QSize(7,8)
+ << map;
+ qStdOut() << args.toString() << endl;
+}
+
+QRect QRectFromJson(QJsonValue value)
+{
+ if (!value.isObject()) {
+ qStdOut() << "QRectFromJson: value is not an object" << endl;
+ return QRect();
+ }
+
+ QJsonObject obj = value.toObject();
+ QJsonValue x = obj["x"];
+ QJsonValue y = obj["y"];
+ QJsonValue width = obj["width"];
+ QJsonValue height = obj["height"];
+ if (!x.isDouble() || !y.isDouble() || !width.isDouble() || !height.isDouble()) {
+ qStdOut() << "QRectFromJson: invalid value(s)" << endl;
+ return QRect();
+ }
+
+ return QRect(x.toDouble(),y.toDouble(),width.toDouble(),height.toDouble());
+}
+
+QString QRectString(QRect rect)
+{
+ return QString().sprintf("(%d,%d,%d,%d)",rect.x(),rect.y(),rect.width(),rect.height());
+}
+
+void processCallbacks(JSEvaluator *evaluator)
+{
+ JSCallbacks *callbacks = evaluator->callbacks();
+
+ QString messagesStr = evaluator->evaluate("Editor_getBackMessages()");
+ if (messagesStr.isNull()) {
+ qStdOut() << "Editor_getBackMessages failed" << endl;
+ return;
+ }
+
+ // QJsonDocument doc = QJsonDocument::fromVariant(var);
+ QJsonDocument doc = QJsonDocument::fromJson(messagesStr.toUtf8());
+ if (doc.isNull()) {
+ qStdOut() << "JSON parse failed" << endl;
+ return;
+ }
+
+ if (!doc.isArray()) {
+ qStdOut() << "JSON is not an array" << endl;
+ return;
+ }
+
+ qStdOut() << "JSON parse succeeded; top-level is an array with " << doc.array().size() << " items" << endl;
+ QJsonArray topArray = doc.array();
+ for (int i = 0; i < topArray.size(); i++) {
+ QJsonValue val = topArray.at(i);
+ if (!val.isArray()) {
+ qStdOut() << "Entry " << i << " is not an array" << endl;
+ return;
+ }
+ // printf("entry %d: %s\n",i,qcstring(val.toString()));
+ QJsonArray array = val.toArray();
+ if (array.size() < 1) {
+ qStdOut() << "Callback array " << i << " is empty" << endl;
+ return;
+ }
+ if (!array.at(0).isString()) {
+ qStdOut() << "Callback array " << i << " does not start with a string" << endl;
+ return;
+ }
+ QString functionName = array.at(0).toString();
+
+ // if (functionName == "addOutlineItem") {
+ // qStdOut() << "cbName " << i << " = " << functionName << " *************************" << endl;
+ // }
+ // else {
+ // qStdOut() << "cbName " << i << " = " << functionName << endl;
+ // }
+
+ if ((functionName == "debug") &&
+ (array.size() == 2) &&
+ (array.at(1).isString())) {
+ callbacks->debug(array.at(1).toString());
+ }
+ else if ((functionName == "addOutlineItem") &&
+ (array.size() == 4) &&
+ (array.at(1).isString()) &&
+ (array.at(2).isString()) &&
+ ((array.at(3).isString()) || (array.at(3).isNull()))) {
+ callbacks->addOutlineItem(array.at(1).toString(),array.at(2).toString(),array.at(3).toString());
+ }
+ else if ((functionName == "updateOutlineItem") &&
+ (array.size() == 3) &&
+ array.at(1).isString() &&
+ array.at(2).isString()) {
+ callbacks->updateOutlineItem(array.at(1).toString(),array.at(2).toString());
+ }
+ else if ((functionName == "removeOutlineItem") &&
+ (array.size() == 2) &&
+ array.at(1).isString()) {
+ callbacks->removeOutlineItem(array.at(1).toString());
+ }
+ else if ((functionName == "outlineUpdated") &&
+ (array.size() == 1)) {
+ callbacks->outlineUpdated();
+ }
+ else if ((functionName == "setSelectionHandles") &&
+ (array.size() == 7) &&
+ array.at(1).isDouble() &&
+ array.at(2).isDouble() &&
+ array.at(3).isDouble() &&
+ array.at(4).isDouble() &&
+ array.at(5).isDouble() &&
+ array.at(6).isDouble()) {
+ callbacks->setSelectionHandles(array.at(1).toDouble(),
+ array.at(2).toDouble(),
+ array.at(3).toDouble(),
+ array.at(4).toDouble(),
+ array.at(5).toDouble(),
+ array.at(6).toDouble());
+ }
+ else if ((functionName == "setTableSelection") &&
+ (array.size() == 5) &&
+ array.at(1).isDouble() &&
+ array.at(2).isDouble() &&
+ array.at(3).isDouble() &&
+ array.at(4).isDouble()) {
+ callbacks->setTableSelection(array.at(1).toDouble(),
+ array.at(2).toDouble(),
+ array.at(3).toDouble(),
+ array.at(4).toDouble());
+ }
+ else if ((functionName == "setCursor") &&
+ (array.size() == 5) &&
+ array.at(1).isDouble() &&
+ array.at(2).isDouble() &&
+ array.at(3).isDouble() &&
+ array.at(4).isDouble()) {
+ callbacks->setCursor(array.at(1).toDouble(),
+ array.at(2).toDouble(),
+ array.at(3).toDouble(),
+ array.at(4).toDouble());
+ }
+ else if ((functionName == "clearSelectionHandlesAndCursor") &&
+ (array.size() == 1)) {
+ callbacks->clearSelectionHandlesAndCursor();
+ }
+ else if ((functionName == "setSelectionBounds") &&
+ (array.size() == 5) &&
+ array.at(1).isDouble() &&
+ array.at(2).isDouble() &&
+ array.at(3).isDouble() &&
+ array.at(4).isDouble()) {
+ callbacks->setSelectionBounds(array.at(1).toDouble(),
+ array.at(2).toDouble(),
+ array.at(3).toDouble(),
+ array.at(4).toDouble());
+ }
+ else if ((functionName == "updateAutoCorrect") &&
+ (array.size() == 1)) {
+ callbacks->updateAutoCorrect();
+ }
+ else if ((functionName == "error") &&
+ (array.size() == 3) &&
+ array.at(1).isString() &&
+ array.at(2).isString()) {
+ callbacks->error(array.at(1).toString(),array.at(2).toString());
+ }
+ else {
+ qStdOut() << "INVALID CALLBACK OR ARGS: " << functionName << endl;
+ }
+ }
+}
+
+QJsonValue evaljsStr(JSEvaluator *ev, const QString &functionName, const QString &argsStr)
+{
+ QString script;
+ QTextStream stream(&script);
+ stream << "Main_execute(function() { return JSON.stringify({ result: ";
+ stream << functionName << "(";
+ stream << argsStr;
+ stream << ")}); });";
+
+ qStdOut() << "EVALUATE: " << script << endl;
+
+ QString resultStr = ev->evaluate(script);
+ qStdOut() << "RESULT: " << resultStr << endl;
+ processCallbacks(ev);
+ if (resultStr.isNull())
+ return QJsonValue(QJsonValue::Null);
+
+ QJsonDocument doc = QJsonDocument::fromJson(resultStr.toUtf8());
+ if (!doc.isObject()) {
+ ev->callbacks()->error("Error parsing returned JSON","evaluate");
+ return QJsonValue(QJsonValue::Null);
+ }
+
+ QJsonObject obj = doc.object();
+ if (!obj.contains("result")) {
+ return QJsonValue(QJsonValue::Null);
+ // ev->callbacks()->error("Returned JSON does not contain a result","evaluate");
+ // return QJsonValue(QJsonValue::Null);
+ }
+
+ return obj["result"];
+}
+
+QJsonValue evaljs(JSEvaluator *ev, const QString &functionName, const JSArgs &args)
+{
+ return evaljsStr(ev,functionName,args.toString());
+}
+
+// Functions implemented in AutoCorrect.js
+
+void JSAutoCorrect::correctPrecedingWord(int numChars, const QString &replacement, bool confirmed)
+{
+ JSArgs args = JSArgs() << numChars << replacement << confirmed;
+ evaljs(_evaluator,"AutoCorrect_correctPrecedingWord",args);
+}
+
+QJsonObject JSAutoCorrect::getCorrection()
+{
+ QJsonValue result = evaljs(_evaluator,"AutoCorrect_getCorrection",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+QJsonObject JSAutoCorrect::getCorrectionCoords()
+{
+ QJsonValue result = evaljs(_evaluator,"AutoCorrect_getCorrectionCoords",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSAutoCorrect::acceptCorrection()
+{
+ evaljs(_evaluator,"AutoCorrect_acceptCorrection",JSArgs());
+}
+
+void JSAutoCorrect::replaceCorrection(const QString &replacement)
+{
+ JSArgs args = JSArgs() << replacement;
+ evaljs(_evaluator,"AutoCorrect_replaceCorrection",args);
+}
+
+// Functions implemented in ChangeTracking.js
+
+bool JSChangeTracking::showChanges()
+{
+ QJsonValue result = evaljs(_evaluator,"ChangeTracking_showChanges",JSArgs());
+ return result.isBool() ? result.toBool() : false;
+}
+
+bool JSChangeTracking::trackChanges()
+{
+ QJsonValue result = evaljs(_evaluator,"ChangeTracking_trackChanges",JSArgs());
+ return result.isBool() ? result.toBool() : false;
+}
+
+void JSChangeTracking::setShowChanges(bool showChanges)
+{
+ JSArgs args = JSArgs() << showChanges;
+ evaljs(_evaluator,"ChangeTracking_setShowChanges",args);
+}
+
+void JSChangeTracking::setTrackChanges(bool trackChanges)
+{
+ JSArgs args = JSArgs() << trackChanges;
+ evaljs(_evaluator,"ChangeTracking_setTrackChanges",args);
+}
+
+// Functions implemented in Clipboard.js
+
+QJsonObject JSClipboard::clipboardCut()
+{
+ QJsonValue result = evaljs(_evaluator,"Clipboard_cut",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+QJsonObject JSClipboard::clipboardCopy()
+{
+ QJsonValue result = evaljs(_evaluator,"Clipboard_copy",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSClipboard::pasteHTML(const QString &html)
+{
+ JSArgs args = JSArgs() << html;
+ evaljs(_evaluator,"Clipboard_pasteHTML",args);
+}
+
+void JSClipboard::pasteText(const QString &text)
+{
+ JSArgs args = JSArgs() << text;
+ evaljs(_evaluator,"Clipboard_pasteText",args);
+}
+
+// Functions implemented in Cursor.js
+
+
+QString JSCursor::positionCursor(int x, int y, bool wordBoundary)
+{
+ JSArgs args = JSArgs() << x << y << wordBoundary;
+ QJsonValue result = evaljs(_evaluator,"Cursor_positionCursor",args);
+ return result.isString() ? result.toString() : QString::null;
+}
+
+QRect JSCursor::getCursorPosition()
+{
+ QJsonValue result = evaljs(_evaluator,"Cursor_getCursorPosition",JSArgs());
+ return QRectFromJson(result);
+}
+
+void JSCursor::moveLeft()
+{
+ evaljs(_evaluator,"Cursor_moveLeft",JSArgs());
+}
+
+void JSCursor::moveRight()
+{
+ evaljs(_evaluator,"Cursor_moveRight",JSArgs());
+}
+
+void JSCursor::moveToStartOfDocument()
+{
+ evaljs(_evaluator,"Cursor_moveToStartOfDocument",JSArgs());
+}
+
+void JSCursor::moveToEndOfDocument()
+{
+ evaljs(_evaluator,"Cursor_moveToEndOfDocument",JSArgs());
+}
+
+void JSCursor::insertReference(const QString &itemId)
+{
+ JSArgs args = JSArgs() << itemId;
+ evaljs(_evaluator,"Cursor_insertReference",args);
+}
+
+void JSCursor::insertLink(const QString &text, const QString &url)
+{
+ JSArgs args = JSArgs() << text << url;
+ evaljs(_evaluator,"Cursor_insertLink",args);
+}
+
+void JSCursor::insertCharacter(unsigned short character, bool allowInvalidPos)
+{
+ JSArgs args = JSArgs() << QString(character) << allowInvalidPos;
+ evaljs(_evaluator,"Cursor_insertCharacter",args);
+}
+
+void JSCursor::deleteCharacter()
+{
+ evaljs(_evaluator,"Cursor_deleteCharacter",JSArgs());
+}
+
+void JSCursor::enterPressed()
+{
+ evaljs(_evaluator,"Cursor_enterPressed",JSArgs());
+}
+
+QString JSCursor::getPrecedingWord()
+{
+ QJsonValue result = evaljs(_evaluator,"Cursor_getPrecedingWord",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+QJsonObject JSCursor::getLinkProperties()
+{
+ QJsonValue result = evaljs(_evaluator,"Cursor_getLinkProperties",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSCursor::setLinkProperties(QJsonObject properties)
+{
+ JSArgs args = JSArgs() << properties;
+ evaljs(_evaluator,"Cursor_setLinkProperties",args);
+}
+
+void JSCursor::setReferenceTarget(const QString &itemId)
+{
+ JSArgs args = JSArgs() << itemId;
+ evaljs(_evaluator,"Cursor_setReferenceTarget",args);
+}
+
+void JSCursor::insertFootnote(const QString &content)
+{
+ JSArgs args = JSArgs() << content;
+ evaljs(_evaluator,"Cursor_insertFootnote",args);
+}
+
+void JSCursor::insertEndnote(const QString &content)
+{
+ JSArgs args = JSArgs() << content;
+ evaljs(_evaluator,"Cursor_insertEndnote",args);
+}
+
+// Functions implemented in Equations.js
+
+void JSEquations::insertEquation()
+{
+ evaljs(_evaluator,"Equations_insertEquation",JSArgs());
+}
+
+// Functions implemented in Figures.js
+
+void JSFigures::insertFigure(const QString &filename, const QString &width,
+ bool numbered, const QString &caption)
+{
+ JSArgs args = JSArgs() << filename << width << numbered << caption;
+ evaljs(_evaluator,"Figures_insertFigure",args);
+}
+
+QString JSFigures::getSelectedFigureId()
+{
+ QJsonValue result = evaljs(_evaluator,"Figures_getSelectedFigureId",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+QJsonObject JSFigures::getProperties(const QString &itemId)
+{
+ JSArgs args = JSArgs() << itemId;
+ QJsonValue result = evaljs(_evaluator,"Figures_getProperties",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSFigures::setProperties(const QString &itemId, const QString &width, const QString &src)
+{
+ JSArgs args = JSArgs() << itemId << width << src;
+ evaljs(_evaluator,"Figures_setProperties",args);
+}
+
+QJsonObject JSFigures::getGeometry(const QString &itemId)
+{
+ JSArgs args = JSArgs() << itemId;
+ QJsonValue result = evaljs(_evaluator,"Figures_getGeometry",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+// Functions implemented in Formatting.js
+
+QJsonObject JSFormatting::getFormatting()
+{
+ QJsonValue result = evaljs(_evaluator,"Formatting_getFormatting",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSFormatting::applyFormattingChanges(const QString &style, QJsonObject properties)
+{
+ JSArgs args = JSArgs() << style << properties;
+ evaljs(_evaluator,"Formatting_applyFormattingChanges",args);
+}
+
+// Functions implemented in Input.js
+
+void JSInput::removePosition(int posId)
+{
+ JSArgs args = JSArgs() << posId;
+ evaljs(_evaluator,"Input_removePosition",args);
+}
+
+QString JSInput::textInRange(int startId, int startAdjust, int endId, int endAdjust)
+{
+ JSArgs args = JSArgs() << startId << startAdjust << endId << endAdjust;
+ QJsonValue result = evaljs(_evaluator,"Input_textInRange",args);
+ return result.isString() ? result.toString() : QString::null;
+}
+
+void JSInput::replaceRange(int startId, int endId, const QString &text)
+{
+ JSArgs args = JSArgs() << startId << endId << text;
+ evaljs(_evaluator,"Input_replaceRange",args);
+}
+
+QJsonObject JSInput::selectedTextRange()
+{
+ QJsonValue result = evaljs(_evaluator,"Input_selectedTextRange",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSInput::setSelectedTextRange(int startId, int endId)
+{
+ JSArgs args = JSArgs() << startId << endId;
+ evaljs(_evaluator,"Input_setSelectedTextRange",args);
+}
+
+QJsonObject JSInput::markedTextRange()
+{
+ QJsonValue result = evaljs(_evaluator,"Input_markedTextRange",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSInput::setMarkedText(const QString &text, int startOffset, int endOffset)
+{
+ JSArgs args = JSArgs() << text << startOffset << endOffset;
+ evaljs(_evaluator,"Input_setMarkedText",args);
+}
+
+void JSInput::unmarkText()
+{
+ evaljs(_evaluator,"Input_unmarkText",JSArgs());
+}
+
+bool JSInput::forwardSelectionAffinity()
+{
+ QJsonValue result = evaljs(_evaluator,"Input_forwardSelectionAffinity",JSArgs());
+ return result.isBool() ? result.toBool() : false;
+}
+
+void JSInput::setForwardSelectionAffinity(bool forwardSelectionAffinity)
+{
+ JSArgs args = JSArgs() << forwardSelectionAffinity;
+ evaljs(_evaluator,"Input_setForwardSelectionAffinity",args);
+}
+
+int JSInput::positionFromPositionOffset(int posId, int offset)
+{
+ JSArgs args = JSArgs() << posId << offset;
+ QJsonValue result = evaljs(_evaluator,"Input_positionFromPositionOffset",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+int JSInput::positionFromPositionInDirectionOffset(int posId, const QString &direction, int offset)
+{
+ JSArgs args = JSArgs() << posId << direction << offset;
+ QJsonValue result = evaljs(_evaluator,"Input_positionFromPositionInDirectionOffset",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+int JSInput::comparePositionToPosition(int positionId, int otherId)
+{
+ JSArgs args = JSArgs() << positionId << otherId;
+ QJsonValue result = evaljs(_evaluator,"Input_comparePositionToPosition",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+int JSInput::offsetFromPositionToPosition(int fromPosition, int toPosition)
+{
+ JSArgs args = JSArgs() << fromPosition << toPosition;
+ QJsonValue result = evaljs(_evaluator,"Input_offsetFromPositionToPosition",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+int JSInput::positionWithinRangeFarthestInDirection(int startId, int endId, const QString &direction)
+{
+ JSArgs args = JSArgs() << startId << endId << direction;
+ QJsonValue result = evaljs(_evaluator,"Input_positionWithinRangeFarthestInDirection",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+QJsonObject JSInput::characterRangeByExtendingPositionInDirection(int positionId, const QString &direction)
+{
+ JSArgs args = JSArgs() << positionId << direction;
+ QJsonValue result = evaljs(_evaluator,"Input_characterRangeByExtendingPositionInDirection",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+QJsonObject JSInput::firstRectForRange(int startId, int endId)
+{
+ JSArgs args = JSArgs() << startId << endId;
+ QJsonValue result = evaljs(_evaluator,"Input_firstRectForRange",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+QJsonObject JSInput::caretRectForPosition(int posId)
+{
+ JSArgs args = JSArgs() << posId;
+ QJsonValue result = evaljs(_evaluator,"Input_caretRectForPosition",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+int JSInput::closestPositionToPoint(int x, int y)
+{
+ JSArgs args = JSArgs() << x << y;
+ QJsonValue result = evaljs(_evaluator,"Input_closestPositionToPoint",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+int JSInput::closestPositionToPointWithinRange(int x, int y, int startId, int endId)
+{
+ JSArgs args = JSArgs() << x << y << startId << endId;
+ QJsonValue result = evaljs(_evaluator,"Input_closestPositionToPointWithinRange",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+QJsonObject JSInput::characterRangeAtPoint(int x, int y)
+{
+ JSArgs args = JSArgs() << x << y;
+ QJsonValue result = evaljs(_evaluator,"Input_characterRangeAtPoint",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+int JSInput::positionWithinRangeAtCharacterOffset(int startId, int endId, int offset)
+{
+ JSArgs args = JSArgs() << startId << endId << offset;
+ QJsonValue result = evaljs(_evaluator,"Input_positionWithinRangeAtCharacterOffset",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+int JSInput::characterOffsetOfPositionWithinRange(int positionId, int startId, int endId)
+{
+ JSArgs args = JSArgs() << positionId << startId << endId;
+ QJsonValue result = evaljs(_evaluator,"Input_characterOffsetOfPositionWithinRange",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+bool JSInput::isPositionAtBoundaryGranularityInDirection(int posId, const QString &granularity,
+ const QString &direction)
+{
+ JSArgs args = JSArgs() << posId << granularity << direction;
+ QJsonValue result = evaljs(_evaluator,"Input_isPositionAtBoundaryGranularityInDirection",args);
+ return result.isBool() ? result.toBool() : false;
+}
+
+bool JSInput::isPositionWithinTextUnitInDirection(int posId, const QString &granularity,
+ const QString &direction)
+{
+ JSArgs args = JSArgs() << posId << granularity << direction;
+ QJsonValue result = evaljs(_evaluator,"Input_isPositionWithinTextUnitInDirection",args);
+ return result.isBool() ? result.toBool() : false;
+}
+
+int JSInput::positionFromPositionToBoundaryInDirection(int posId, const QString &granularity,
+ const QString &direction)
+{
+ JSArgs args = JSArgs() << posId << granularity << direction;
+ QJsonValue result = evaljs(_evaluator,"Input_positionFromPositionToBoundaryInDirection",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+QJsonObject JSInput::rangeEnclosingPositionWithGranularityInDirection(int posId,
+ const QString &granularity,
+ const QString &direction)
+{
+ JSArgs args = JSArgs() << posId << granularity << direction;
+ QJsonValue result = evaljs(_evaluator,"Input_rangeEnclosingPositionWithGranularityInDirection",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+// Functions implemented in Lists.js
+
+void JSLists::increaseIndent()
+{
+ evaljs(_evaluator,"Lists_increaseIndent",JSArgs());
+}
+
+void JSLists::decreaseIndent()
+{
+ evaljs(_evaluator,"Lists_decreaseIndent",JSArgs());
+}
+
+void JSLists::clearList()
+{
+ evaljs(_evaluator,"Lists_clearList",JSArgs());
+}
+
+void JSLists::setUnorderedList()
+{
+ evaljs(_evaluator,"Lists_setUnorderedList",JSArgs());
+}
+
+void JSLists::setOrderedList()
+{
+ evaljs(_evaluator,"Lists_setOrderedList",JSArgs());
+}
+
+// Functions implemented in Main.js
+
+QString JSMain::getLanguage()
+{
+ QJsonValue result = evaljs(_evaluator,"Main_getLanguage",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+void JSMain::setLanguage(const QString &language)
+{
+ JSArgs args = JSArgs() << language;
+ evaljs(_evaluator,"Main_setLanguage",args);
+}
+
+QString JSMain::setGenerator(const QString &generator)
+{
+ JSArgs args = JSArgs() << generator;
+ QJsonValue result = evaljs(_evaluator,"Main_setGenerator",args);
+ return result.isString() ? result.toString() : QString::null;
+}
+
+bool JSMain::prepareForSave()
+{
+ QJsonValue result = evaljs(_evaluator,"Main_prepareForSave",JSArgs());
+ return result.isBool() ? result.toBool() : false;
+}
+
+QString JSMain::getHTML()
+{
+ QJsonValue result = evaljs(_evaluator,"Main_getHTML",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+bool JSMain::isEmptyDocument()
+{
+ QJsonValue result = evaljs(_evaluator,"Main_isEmptyDocument",JSArgs());
+ return result.isBool() ? result.toBool() : false;
+}
+
+// Functions implemented in Metadata.js
+
+QJsonObject JSMetadata::getMetadata()
+{
+ QJsonValue result = evaljs(_evaluator,"Metadata_getMetadata",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSMetadata::setMetadata(const QJsonObject &metadata)
+{
+ JSArgs args = JSArgs() << metadata;
+ evaljs(_evaluator,"Metadata_setMetadata",args);
+}
+
+// Functions implemented in Outline.js
+
+QJsonObject JSOutline::getOutline()
+{
+ QJsonValue result = evaljs(_evaluator,"Outline_getOutline",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSOutline::moveSection(const QString §ionId, const QString &parentId, const QString &nextId)
+{
+ JSArgs args = JSArgs() << sectionId << parentId << nextId;
+ evaljs(_evaluator,"Outline_moveSection",args);
+}
+
+void JSOutline::deleteItem(const QString &itemId)
+{
+ JSArgs args = JSArgs() << itemId;
+ evaljs(_evaluator,"Outline_deleteItem",args);
+}
+
+void JSOutline::goToItem(const QString &itemId)
+{
+ JSArgs args = JSArgs() << itemId;
+ evaljs(_evaluator,"Outline_goToItem",args);
+}
+
+void JSOutline::scheduleUpdateStructure()
+{
+ evaljs(_evaluator,"Outline_scheduleUpdateStructure",JSArgs());
+}
+
+void JSOutline::setNumbered(const QString &itemId, bool numbered)
+{
+ JSArgs args = JSArgs() << itemId << numbered;
+ evaljs(_evaluator,"Outline_setNumbered",args);
+}
+
+void JSOutline::setTitle(const QString &itemId, const QString &title)
+{
+ JSArgs args = JSArgs() << itemId << title;
+ evaljs(_evaluator,"Outline_setTitle",args);
+}
+
+void JSOutline::insertTableOfContents()
+{
+ evaljs(_evaluator,"Outline_insertTableOfContents",JSArgs());
+}
+
+void JSOutline::insertListOfFigures()
+{
+ evaljs(_evaluator,"Outline_insertListOfFigures",JSArgs());
+}
+
+void JSOutline::insertListOfTables()
+{
+ evaljs(_evaluator,"Outline_insertListOfTables",JSArgs());
+}
+
+void JSOutline::setPrintMode(bool printMode)
+{
+ JSArgs args = JSArgs() << printMode;
+ evaljs(_evaluator,"Outline_setPrintMode",args);
+}
+
+QJsonObject JSOutline::examinePrintLayout(int pageHeight)
+{
+ JSArgs args = JSArgs() << pageHeight;
+ QJsonValue result = evaljs(_evaluator,"Outline_examinePrintLayout",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+bool JSOutline::detectSectionNumbering()
+{
+ QJsonValue result = evaljs(_evaluator,"Outline_detectSectionNumbering",JSArgs());
+ return result.isBool() ? result.toBool() : false;
+}
+
+QJsonObject JSOutline::findUsedStyles()
+{
+ QJsonValue result = evaljs(_evaluator,"Outline_findUsedStyles",JSArgs());
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+// Functions implemented in Preview.js
+
+void JSPreview::showForStyle(const QString &styleId, const QString &uiName, const QString &title)
+{
+ JSArgs args = JSArgs() << styleId << uiName << title;
+ evaljs(_evaluator,"Preview_showForStyle",args);
+ // TODO
+}
+
+// Functions implemented in Scan.js
+
+void JSScan::reset()
+{
+ evaljs(_evaluator,"Scan_reset",JSArgs());
+}
+
+EDScanParagraph *JSScan::next()
+{
+ // TODO
+ return NULL;
+}
+
+int JSScan::addMatch(int start, int end)
+{
+ JSArgs args = JSArgs() << start << end;
+ QJsonValue result = evaljs(_evaluator,"Scan_addMatch",args);
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+void JSScan::showMatch(int matchId)
+{
+ JSArgs args = JSArgs() << matchId;
+ evaljs(_evaluator,"Scan_showMatch",args);
+}
+
+void JSScan::replaceMatch(int matchId, const QString &text)
+{
+ JSArgs args = JSArgs() << matchId << text;
+ evaljs(_evaluator,"Scan_replaceMatch",args);
+}
+
+void JSScan::removeMatch(int matchId)
+{
+ JSArgs args = JSArgs() << matchId;
+ evaljs(_evaluator,"Scan_removeMatch",args);
+}
+
+void JSScan::goToMatch(int matchId)
+{
+ JSArgs args = JSArgs() << matchId;
+ evaljs(_evaluator,"Scan_goToMatch",args);
+}
+
+// Functions implemented in Selection.js
+
+void JSSelection::update()
+{
+ evaljs(_evaluator,"Selection_update",JSArgs());
+}
+
+void JSSelection::selectAll()
+{
+ evaljs(_evaluator,"Selection_selectAll",JSArgs());
+}
+
+void JSSelection::selectParagraph()
+{
+ evaljs(_evaluator,"Selection_selectParagraph",JSArgs());
+}
+
+void JSSelection::selectWordAtCursor()
+{
+ evaljs(_evaluator,"Selection_selectWordAtCursor",JSArgs());
+}
+
+QString JSSelection::dragSelectionBegin(int x, int y, bool selectWord)
+{
+ JSArgs args = JSArgs() << x << y << selectWord;
+ QJsonValue result = evaljs(_evaluator,"Selection_dragSelectionBegin",args);
+ return result.isString() ? result.toString() : QString::null;
+}
+
+QString JSSelection::dragSelectionUpdate(int x, int y, bool selectWord)
+{
+ JSArgs args = JSArgs() << x << y << selectWord;
+ QJsonValue result = evaljs(_evaluator,"Selection_dragSelectionUpdate",args);
+ return result.isString() ? result.toString() : QString::null;
+}
+
+QString JSSelection::moveStartLeft()
+{
+ QJsonValue result = evaljs(_evaluator,"Selection_moveStartLeft",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+QString JSSelection::moveStartRight()
+{
+ QJsonValue result = evaljs(_evaluator,"Selection_moveStartRight",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+QString JSSelection::moveEndLeft()
+{
+ QJsonValue result = evaljs(_evaluator,"Selection_moveEndLeft",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+QString JSSelection::moveEndRight()
+{
+ QJsonValue result = evaljs(_evaluator,"Selection_moveEndRight",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+void JSSelection::setSelectionStartAtCoords(int x, int y)
+{
+ JSArgs args = JSArgs() << x << y;
+ evaljs(_evaluator,"Selection_setSelectionStartAtCoords",args);
+}
+
+void JSSelection::setSelectionEndAtCoords(int x, int y)
+{
+ JSArgs args = JSArgs() << x << y;
+ evaljs(_evaluator,"Selection_setSelectionEndAtCoords",args);
+}
+
+void JSSelection::setTableSelectionEdgeAtCoords(const QString &edge, int x, int y)
+{
+ JSArgs args = JSArgs() << edge << x << y;
+ evaljs(_evaluator,"Selection_setTableSelectionEdgeAtCoords",args);
+}
+
+void JSSelection::print()
+{
+ evaljs(_evaluator,"Selection_print",JSArgs());
+}
+
+// Functions implemented in Styles.js
+
+QString JSStyles::getCSSText()
+{
+ QJsonValue result = evaljs(_evaluator,"Styles_getCSSText",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+void JSStyles::setCSSText(const QString &cssText, const QJsonObject &rules)
+{
+ JSArgs args = JSArgs() << cssText << rules;
+ evaljs(_evaluator,"Styles_setCSSText",args);
+}
+
+QString JSStyles::paragraphClass()
+{
+ QJsonValue result = evaljs(_evaluator,"Styles_getParagraphClass",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+void JSStyles::setParagraphClass(const QString ¶graphClass)
+{
+ JSArgs args = JSArgs() << paragraphClass;
+ evaljs(_evaluator,"Styles_setParagraphClass",args);
+}
+
+// Functions implemented in Tables.js
+
+void JSTables::insertTable(int rows, int cols, const QString &width, bool numbered,
+ const QString &caption, const QString &className)
+{
+ JSArgs args = JSArgs() << rows << cols << width << numbered << caption << className;
+ evaljs(_evaluator,"Tables_insertTable",args);
+}
+
+void JSTables::addAdjacentRow()
+{
+ evaljs(_evaluator,"Tables_addAdjacentRow",JSArgs());
+}
+
+void JSTables::addAdjacentColumn()
+{
+ evaljs(_evaluator,"Tables_addAdjacentColumn",JSArgs());
+}
+
+void JSTables::removeAdjacentRow()
+{
+ evaljs(_evaluator,"Tables_removeAdjacentRow",JSArgs());
+}
+
+void JSTables::removeAdjacentColumn()
+{
+ evaljs(_evaluator,"Tables_removeAdjacentColumn",JSArgs());
+}
+
+void JSTables::clearCells()
+{
+ evaljs(_evaluator,"Tables_clearCells",JSArgs());
+}
+
+void JSTables::mergeCells()
+{
+ evaljs(_evaluator,"Tables_mergeCells",JSArgs());
+}
+
+void JSTables::splitSelection()
+{
+ evaljs(_evaluator,"Tables_splitSelection",JSArgs());
+}
+
+QString JSTables::getSelectedTableId()
+{
+ QJsonValue result = evaljs(_evaluator,"Tables_getSelectedTableId",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+QJsonObject JSTables::getProperties(const QString &itemId)
+{
+ JSArgs args = JSArgs() << itemId;
+ QJsonValue result = evaljs(_evaluator,"Tables_getProperties",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+void JSTables::setProperties(const QString &itemId, const QString &width)
+{
+ JSArgs args = JSArgs() << itemId << width;
+ evaljs(_evaluator,"Tables_setProperties",args);
+}
+
+void JSTables::setColWidths(const QString &itemId, const QJsonArray &colWidths)
+{
+ JSArgs args = JSArgs() << itemId << colWidths;
+ evaljs(_evaluator,"Tables_setColWidths",args);
+}
+
+QJsonObject JSTables::getGeometry(const QString &itemId)
+{
+ JSArgs args = JSArgs() << itemId;
+ QJsonValue result = evaljs(_evaluator,"Tables_getGeometry",args);
+ return result.isObject() ? result.toObject() : QJsonObject();
+}
+
+// Functions implemented in UndoManager.js
+
+int JSUndoManager::getLength()
+{
+ QJsonValue result = evaljs(_evaluator,"UndoManager_getLength",JSArgs());
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+int JSUndoManager::getIndex()
+{
+ QJsonValue result = evaljs(_evaluator,"UndoManager_getIndex",JSArgs());
+ return result.isDouble() ? result.toDouble() : 0;
+}
+
+void JSUndoManager::setIndex(int index)
+{
+ JSArgs args = JSArgs() << index;
+ evaljs(_evaluator,"UndoManager_setIndex",args);
+}
+
+void JSUndoManager::undo()
+{
+ evaljs(_evaluator,"UndoManager_undo",JSArgs());
+}
+
+void JSUndoManager::redo()
+{
+ evaljs(_evaluator,"UndoManager_redo",JSArgs());
+}
+
+void JSUndoManager::newGroup(const QString &name)
+{
+ JSArgs args = JSArgs() << name;
+ evaljs(_evaluator,"UndoManager_newGroup",args);
+}
+
+QString JSUndoManager::groupType()
+{
+ QJsonValue result = evaljs(_evaluator,"UndoManager_groupType",JSArgs());
+ return result.isString() ? result.toString() : QString::null;
+}
+
+// Functions implemented in Viewport.js
+
+void JSViewport::setViewportWidth(int width)
+{
+ JSArgs args = JSArgs() << width;
+ evaljs(_evaluator,"Viewport_setViewportWidth",args);
+}
+
+void JSViewport::setTextScale(int textScale)
+{
+ JSArgs args = JSArgs() << textScale;
+ evaljs(_evaluator,"Viewport_setTextScale",args);
+}
+
+// All modules
+
+JSInterface::JSInterface(JSEvaluator *evaluator)
+: autoCorrect(evaluator),
+ changeTracking(evaluator),
+ clipboard(evaluator),
+ cursor(evaluator),
+ equations(evaluator),
+ figures(evaluator),
+ formatting(evaluator),
+ input(evaluator),
+ lists(evaluator),
+ main(evaluator),
+ metadata(evaluator),
+ outline(evaluator),
+ preview(evaluator),
+ scan(evaluator),
+ selection(evaluator),
+ styles(evaluator),
+ tables(evaluator),
+ undoManager(evaluator),
+ viewport(evaluator)
+{
+}
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/src/JSInterface.h
----------------------------------------------------------------------
diff --git a/consumers/corinthia/src/JSInterface.h b/consumers/corinthia/src/JSInterface.h
new file mode 100644
index 0000000..8cb9e85
--- /dev/null
+++ b/consumers/corinthia/src/JSInterface.h
@@ -0,0 +1,478 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#include <QString>
+#include <QRect>
+#include <QJsonObject>
+#include <QJsonArray>
+#include <QTextStream>
+
+/**
+ * \file JSInterface.h
+ *
+ * C++ interface to the JavaScript editor library
+ *
+ * All of the core editing operations for Corinthia are implemented in the Editor library, which is
+ * written in JavaScript. This library can be used either from within a web browser, or, in the case
+ * of the Qt application, from an embedded web view. For this app, we use a QWebView instance which
+ * maintains the in-memory DOM tree of the document, and has injected into it all of the javascript
+ * code that is part of the editor library.
+ *
+ * The source code of the Editor library lives in (repository-root)/Editor/src. During build of the
+ * Qt app, all the javascript files are copied into (build-dir)/share/corinthia/js. If you wish to
+ * make changes to the javascript code, you should modify the files in the former location, as the
+ * latter files will be overwritten on every build.
+ *
+ * The purpose of JSInterface.h and JSInterface.cpp is to provide a C++ wrapper over this. All of
+ * the methods defined in the classes below (with the exception of callbacks) ultimately result in a
+ * call to QWebFrame's evaluateJavaScript() method. See the documentation for JSInterface.cpp for
+ * details.
+ *
+ * The editor library is divided into *modules*, each of which implements a specific aspect of
+ * editing functionality. For example, the Cursor module contains methods for moving the cursor
+ * around the document, and inserting or deleting text at the current cursor position. Similarly,
+ * the Tables module contains methods for inserting, deleting, and modifying tables. A separate C++
+ * class is defined for each module, and an instance of each class is maintained by the "container"
+ * class, JSInterface. When using the code here, you should do so via a JSInterface instance.
+ */
+
+#define JS_MODULE_COMMON(className) \
+Q_DISABLE_COPY(className) \
+public: \
+className(JSEvaluator *evaluator) : JSModule(evaluator) {}
+
+QTextStream& qStdOut();
+QString QRectString(QRect rect);
+
+/**
+ * Callback interface
+ *
+ * While the module classes are for making calls from C++ to JavaScript, the JSCallbacks abstract
+ * class is for responding to requests from JavaScript to invoke C++ code. This is declared here as
+ * an abstract class (that is, with all methods virtual and no implementations provided) to avoid
+ * dependencies between the code in this file and other parts of the application. The
+ * EditorJSCallbacks class in Editor.cpp provides a concrete implementation of this, which is where
+ * the actual callback functions are implemented.
+ *
+ * Callbacks are always invoked *after* the execution of a particular editor library API function,
+ * not during. The reason for this design design in the library was to enable support for web view
+ * classes that did not provide native support for callbacks (as was the case for iOS, at least at
+ * the time the library was originally written).
+ *
+ * The way that callbacks are invoked is that after each editor API call, a query is performed for a
+ * list of pending callback messages. The evaluation logic iterates through these and invokes the
+ * appropriate callback method for each. For this reason, callbacks method are all 'void' - they
+ * never return a value. Callbacks are for notification purposes only - typically telling the
+ * application to update the UI in some manner.
+ */
+class JSCallbacks
+{
+public:
+ virtual ~JSCallbacks() {}
+ virtual void debug(const QString &message) = 0;
+ virtual void addOutlineItem(const QString &itemId, const QString &type, const QString &title) = 0;
+ virtual void updateOutlineItem(const QString &itemId, const QString &title) = 0;
+ virtual void removeOutlineItem(const QString &itemId) = 0;
+ virtual void outlineUpdated() = 0;
+ virtual void setCursor(int x, int y, int width, int height) = 0;
+ virtual void setSelectionHandles(int x1, int y1, int height1, int x2, int y2, int height2) = 0;
+ virtual void setTableSelection(int x, int y, int width, int height) = 0;
+ virtual void setSelectionBounds(int left, int top, int right, int bottom) = 0;
+ virtual void clearSelectionHandlesAndCursor() = 0;
+ virtual void updateAutoCorrect() = 0;
+ virtual void error(const QString &message, const QString &operation) = 0;
+};
+
+/**
+ * The JSEvaluator abstract class provides an evaluate() method which is called (indirectly) by all
+ * of the individual module methods. As with JSCallbacks, it is defined as abstract to avoid a
+ * dependency on the code outside of this file. The EditorJSEvaluator class in Editor.cpp provides a
+ * concrete implementation of this; its evaluate() method simply calls through to the
+ * evaluateJavaScript() method of QWebView.
+ *
+ * JSEvaluator also has a callbacks() method, which must return an instance of JSCallbacks. This
+ * makes JSEvaluator the "central point of contact" between the JavaScript interface and the rest of
+ * the application, in that it provides the necessary access to call *in* to javascript, and to
+ * respond (via callbacks) to calls *out* of javascript. Upon initialisation of a document window,
+ * concrete implementations of both JSCallbacks and JSEvaluator are created, the latter maintaining
+ * a reference to the former. See EditorPrivate::EditorPrivate() for where ths is actually done.
+ */
+class JSEvaluator
+{
+public:
+ virtual ~JSEvaluator() {}
+ virtual QString evaluate(const QString &script) = 0;
+ virtual JSCallbacks *callbacks() = 0;
+};
+
+class JSAutoCorrect;
+class JSChangeTracking;
+class JSClipboard;
+class JSCursor;
+class JSEquations;
+class JSFigures;
+class JSFormatting;
+class JSInput;
+class JSLists;
+class JSMain;
+class JSMetadata;
+class JSOutline;
+class JSPreview;
+class JSScan;
+class JSSelection;
+class JSStyles;
+class JSTables;
+class JSUndoManager;
+class JSViewport;
+class EDScanParagraph;
+
+class JSError
+{
+public:
+ const QString &type() { return _type; }
+ const QString &message() { return _message; }
+ const QString &operation() { return _operation; }
+ const QString &html() { return _html; }
+
+private:
+
+ QString _type;
+ QString _message;
+ QString _operation;
+ QString _html;
+};
+
+class JSModule
+{
+ Q_DISABLE_COPY(JSModule)
+public:
+ JSModule(JSEvaluator *evaluator) : _evaluator(evaluator) {};
+protected:
+ JSEvaluator *_evaluator;
+};
+
+// Functions implemented in AutoCorrect.js
+
+class JSAutoCorrect : public JSModule
+{
+ JS_MODULE_COMMON(JSAutoCorrect)
+ void correctPrecedingWord(int numChars, const QString &replacement, bool confirmed);
+ QJsonObject getCorrection();
+ QJsonObject getCorrectionCoords();
+ void acceptCorrection();
+ void replaceCorrection(const QString &replacement);
+};
+
+// Functions implemented in ChangeTracking.js
+
+class JSChangeTracking : public JSModule
+{
+ JS_MODULE_COMMON(JSChangeTracking)
+ bool showChanges();
+ bool trackChanges();
+ void setShowChanges(bool showChanges);
+ void setTrackChanges(bool trackChanges);
+};
+
+// Functions implemented in Clipboard.js
+
+class JSClipboard : public JSModule
+{
+ JS_MODULE_COMMON(JSClipboard)
+ QJsonObject clipboardCut();
+ QJsonObject clipboardCopy();
+ void pasteHTML(const QString &html);
+ void pasteText(const QString &text);
+};
+
+// Functions implemented in Cursor.js
+
+class JSCursor : public JSModule
+{
+ JS_MODULE_COMMON(JSCursor)
+ QString positionCursor(int x, int y, bool wordBoundary);
+ QRect getCursorPosition();
+ void moveLeft();
+ void moveRight();
+ void moveToStartOfDocument();
+ void moveToEndOfDocument();
+ void insertReference(const QString &itemId);
+ void insertLink(const QString &text, const QString &url);
+ void insertCharacter(unsigned short character, bool allowInvalidPos);
+ void deleteCharacter();
+ void enterPressed();
+ QString getPrecedingWord();
+ QJsonObject getLinkProperties();
+ void setLinkProperties(QJsonObject properties);
+ void setReferenceTarget(const QString &itemId);
+ void insertFootnote(const QString &content);
+ void insertEndnote(const QString &content);
+};
+
+// Functions implemented in Equations.js
+
+class JSEquations : public JSModule
+{
+ JS_MODULE_COMMON(JSEquations)
+ void insertEquation();
+};
+
+// Functions implemented in Figures.js
+
+class JSFigures : public JSModule
+{
+ JS_MODULE_COMMON(JSFigures)
+ void insertFigure(const QString &filename, const QString &width,
+ bool numbered, const QString &caption);
+ QString getSelectedFigureId();
+ QJsonObject getProperties(const QString &itemId);
+ void setProperties(const QString &itemId, const QString &width, const QString &src);
+ QJsonObject getGeometry(const QString &itemId);
+};
+
+// Functions implemented in Formatting.js
+
+class JSFormatting : public JSModule
+{
+ JS_MODULE_COMMON(JSFormatting)
+ QJsonObject getFormatting();
+ void applyFormattingChanges(const QString &style, QJsonObject properties);
+};
+
+// Functions implemented in Input.js
+
+class JSInput : public JSModule
+{
+ JS_MODULE_COMMON(JSInput)
+ void removePosition(int posId);
+
+ QString textInRange(int startId, int startAdjust, int endId, int endAdjust);
+ void replaceRange(int startId, int endId, const QString &text);
+ QJsonObject selectedTextRange();
+ void setSelectedTextRange(int startId, int endId);
+ QJsonObject markedTextRange();
+ void setMarkedText(const QString &text, int startOffset, int endOffset);
+ void unmarkText();
+ bool forwardSelectionAffinity();
+ void setForwardSelectionAffinity(bool forwardSelectionAffinity);
+ int positionFromPositionOffset(int posId, int offset);
+ int positionFromPositionInDirectionOffset(int posId, const QString &direction, int offset);
+ int comparePositionToPosition(int positionId, int otherId);
+ int offsetFromPositionToPosition(int fromPosition, int toPosition);
+ int positionWithinRangeFarthestInDirection(int startId, int endId, const QString &direction);
+ QJsonObject characterRangeByExtendingPositionInDirection(int positionId, const QString &direction);
+ QJsonObject firstRectForRange(int startId, int endId);
+ QJsonObject caretRectForPosition(int posId);
+ int closestPositionToPoint(int x, int y);
+ int closestPositionToPointWithinRange(int x, int y, int startId, int endId);
+ QJsonObject characterRangeAtPoint(int x, int y);
+ int positionWithinRangeAtCharacterOffset(int startId, int endId, int offset);
+ int characterOffsetOfPositionWithinRange(int positionId, int startId, int endId);
+
+ bool isPositionAtBoundaryGranularityInDirection(int posId, const QString &granularity,
+ const QString &direction);
+ bool isPositionWithinTextUnitInDirection(int posId, const QString &granularity,
+ const QString &direction);
+ int positionFromPositionToBoundaryInDirection(int posId, const QString &granularity,
+ const QString &direction);
+ QJsonObject rangeEnclosingPositionWithGranularityInDirection(int posId,
+ const QString &granularity,
+ const QString &direction);
+};
+
+// Functions implemented in Lists.js
+
+class JSLists : public JSModule
+{
+ JS_MODULE_COMMON(JSLists)
+ void increaseIndent();
+ void decreaseIndent();
+ void clearList();
+ void setUnorderedList();
+ void setOrderedList();
+};
+
+// Functions implemented in Main.js
+
+class JSMain : public JSModule
+{
+ JS_MODULE_COMMON(JSMain)
+ QString getLanguage();
+ void setLanguage(const QString &language);
+ QString setGenerator(const QString &generator);
+ bool prepareForSave();
+ QString getHTML();
+ bool isEmptyDocument();
+};
+
+// Functions implemented in Metadata.js
+
+class JSMetadata : public JSModule
+{
+ JS_MODULE_COMMON(JSMetadata)
+ QJsonObject getMetadata();
+ void setMetadata(const QJsonObject &metadata);
+};
+
+// Functions implemented in Outline.js
+
+class JSOutline : public JSModule
+{
+ JS_MODULE_COMMON(JSOutline)
+ QJsonObject getOutline();
+ void moveSection(const QString §ionId, const QString &parentId, const QString &nextId);
+ void deleteItem(const QString &itemId);
+ void goToItem(const QString &itemId);
+ void scheduleUpdateStructure();
+ void setNumbered(const QString &itemId, bool numbered);
+ void setTitle(const QString &itemId, const QString &title);
+ void insertTableOfContents();
+ void insertListOfFigures();
+ void insertListOfTables();
+ void setPrintMode(bool printMode);
+ QJsonObject examinePrintLayout(int pageHeight);
+ bool detectSectionNumbering();
+ QJsonObject findUsedStyles();
+};
+
+// Functions implemented in Preview.js
+
+class JSPreview : public JSModule
+{
+ JS_MODULE_COMMON(JSPreview)
+ void showForStyle(const QString &styleId, const QString &uiName, const QString &title);
+};
+
+// Functions implemented in Scan.js
+
+class JSScan : public JSModule
+{
+ JS_MODULE_COMMON(JSScan)
+ void reset();
+ EDScanParagraph *next();
+ int addMatch(int start, int end);
+ void showMatch(int matchId);
+ void replaceMatch(int matchId, const QString &text);
+ void removeMatch(int matchId);
+ void goToMatch(int matchId);
+};
+
+// Functions implemented in Selection.js
+
+class JSSelection : public JSModule
+{
+ JS_MODULE_COMMON(JSSelection)
+ void update();
+ void selectAll();
+ void selectParagraph();
+ void selectWordAtCursor();
+ QString dragSelectionBegin(int x, int y, bool selectWord);
+ QString dragSelectionUpdate(int x, int y, bool selectWord);
+ QString moveStartLeft();
+ QString moveStartRight();
+ QString moveEndLeft();
+ QString moveEndRight();
+ void setSelectionStartAtCoords(int x, int y);
+ void setSelectionEndAtCoords(int x, int y);
+ void setTableSelectionEdgeAtCoords(const QString &edge, int x, int y);
+ void print();
+};
+
+// Functions implemented in Styles.js
+
+class JSStyles : public JSModule
+{
+ JS_MODULE_COMMON(JSStyles)
+ QString getCSSText();
+ void setCSSText(const QString &cssText, const QJsonObject &rules);
+ QString paragraphClass();
+ void setParagraphClass(const QString ¶graphClass);
+};
+
+// Functions implemented in Tables.js
+
+class JSTables : public JSModule
+{
+ JS_MODULE_COMMON(JSTables)
+ void insertTable(int rows, int cols, const QString &width, bool numbered,
+ const QString &caption, const QString &className);
+ void addAdjacentRow();
+ void addAdjacentColumn();
+ void removeAdjacentRow();
+ void removeAdjacentColumn();
+ void clearCells();
+ void mergeCells();
+ void splitSelection();
+ QString getSelectedTableId();
+ QJsonObject getProperties(const QString &itemId);
+ void setProperties(const QString &itemId, const QString &width);
+ void setColWidths(const QString &itemId, const QJsonArray &colWidths);
+ QJsonObject getGeometry(const QString &itemId);
+};
+
+// Functions implemented in UndoManager.js
+
+class JSUndoManager : public JSModule
+{
+ JS_MODULE_COMMON(JSUndoManager)
+ int getLength();
+ int getIndex();
+ void setIndex(int index);
+ void undo();
+ void redo();
+ void newGroup(const QString &name);
+ QString groupType();
+};
+
+// Functions implemented in Viewport.js
+
+class JSViewport : public JSModule
+{
+ JS_MODULE_COMMON(JSViewport)
+ void setViewportWidth(int width);
+ void setTextScale(int textScale);
+};
+
+// All modules
+
+class JSInterface
+{
+ Q_DISABLE_COPY(JSInterface)
+public:
+ JSInterface(JSEvaluator *evaluator);
+ JSAutoCorrect autoCorrect;
+ JSChangeTracking changeTracking;
+ JSClipboard clipboard;
+ JSCursor cursor;
+ JSEquations equations;
+ JSFigures figures;
+ JSFormatting formatting;
+ JSInput input;
+ JSLists lists;
+ JSMain main;
+ JSMetadata metadata;
+ JSOutline outline;
+ JSPreview preview;
+ JSScan scan;
+ JSSelection selection;
+ JSStyles styles;
+ JSTables tables;
+ JSUndoManager undoManager;
+ JSViewport viewport;
+};
+
+void processCallbacks(JSEvaluator *evaluator);
[3/4] incubator-corinthia git commit: Desktop app: Basic
infrastructure for Editor lib
Posted by pm...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/Doxyfile
----------------------------------------------------------------------
diff --git a/consumers/corinthia/Doxyfile b/consumers/corinthia/Doxyfile
new file mode 100644
index 0000000..7f34338
--- /dev/null
+++ b/consumers/corinthia/Doxyfile
@@ -0,0 +1,2331 @@
+# Doxyfile 1.8.8
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all text
+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
+# for the list of possible encodings.
+# The default value is: UTF-8.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
+PROJECT_NAME = "My Project"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
+
+PROJECT_NUMBER =
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF =
+
+# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
+# the documentation. The maximum height of the logo should not exceed 55 pixels
+# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
+# to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = doc
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# doxygen will generate a detailed section even if there is only a brief
+# description.
+# The default value is: NO.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES = YES
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
+# new page for each member. If set to NO, the documentation of a member will be
+# part of the file/class/namespace that contains it.
+# The default value is: NO.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 4
+
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines.
+
+ALIASES =
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
+# Fortran. In the later case the parser tries to guess whether the code is fixed
+# or free formatted code, this is the default for Fortran type files), VHDL. For
+# instance to make doxygen treat .inc files as Fortran files (default is PHP),
+# and .f files as C (default is Fortran), use: inc=Fortran f=C.
+#
+# Note For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = YES
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by by putting a % sign in front of the word
+# or globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO only methods in the interface are
+# included.
+# The default value is: NO.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO these classes will be included in the various overviews. This option has
+# no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO these declarations will be
+# included in the documentation.
+# The default value is: NO.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO the members will appear in declaration order.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
+# todo list. This list is created by putting \todo commands in the
+# documentation.
+# The default value is: YES.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
+# test list. This list is created by putting \test commands in the
+# documentation.
+# The default value is: YES.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES the list
+# will mention the files that were used to generate the documentation.
+# The default value is: YES.
+
+SHOW_USED_FILES = YES
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO doxygen will only warn about wrong or incomplete parameter
+# documentation, but not about the absence of documentation.
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces.
+# Note: If this tag is empty the current directory is searched.
+
+INPUT =
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
+# possible encodings.
+# The default value is: UTF-8.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank the
+# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
+# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
+# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
+# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
+# *.qsf, *.as and *.js.
+
+FILE_PATTERNS =
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER ) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# function all documented functions referencing it will be listed.
+# The default value is: NO.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see http://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = YES
+
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefor more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra stylesheet files is of importance (e.g. the last
+# stylesheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the stylesheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: http://developer.apple.com/tools/xcode/), introduced with
+# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE =
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler ( hhc.exe). If non-empty
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION =
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated (
+# YES) or that it should be included in the master .chm file ( NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING =
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated (
+# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS =
+
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# http://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using prerendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX = NO
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from http://www.mathjax.org before deployment.
+# The default value is: http://cdn.mathjax.org/mathjax/latest.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when enabling USE_PDFLATEX this option is only used for generating
+# bitmaps for formulas in the HTML output, but not in the Makefile that is
+# written to the output directory.
+# The default file is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. To get the times font for
+# instance you can specify
+# EXTRA_PACKAGES=times
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,
+# for the replacement values of the other commands the user is refered to
+# HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES to get a
+# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's config
+# file, i.e. a series of assignments. You only have to provide replacements,
+# missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's config file. A template extensions file can be generated
+# using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION = .3
+
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
+# Definitions (see http://autogen.sf.net) file that captures the structure of
+# the code including all documentation. Note that this feature is still
+# experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
+# in the source code. If set to NO only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES the includes files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to function-like macros that are alone on a line, have
+# an all uppercase name, and do not end with a semicolon. Such function macros
+# are typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc
<TRUNCATED>
[4/4] incubator-corinthia git commit: Desktop app: Basic
infrastructure for Editor lib
Posted by pm...@apache.org.
Desktop app: Basic infrastructure for Editor lib
This commit sets up the basic architecture for a functional editor
implemented as a Qt app. While it currently does not have the necessary
facilities to actually edit documents, it lays the groundwork by
providing a web view injected with the javascript editing library, and a
C++ interface to interact with this library.
See JSInterface.h for information about how the interaction between the
two languages works. Essentially, this file contains a series of classes
containing methods which call through to the corresponding functions in
javascript. These methods handle marshalling of arguments from Qt types
to JSON types, and similarly in the other direction for return values.
A callback interface is also provided to allow JS code to cause C++
functions to be invoked in response to certain events occurring, like
the cursor moving (and thus requiring redisplay).
The user interface is very bare-bones and incomplete; it simply contains
a web view, loaded at startup with a sample document, and buttons to
invoke various functions in the editor library like inserting/deleting
characters and moving the cursor. These are intended not for actual
usage, but as demonstrations of how to invoke JS methods from Qt even
callbacks ("slots"). Functionality to open and save documents is also
absent.
Currently this only builds on OS X, but that's an issue with the CMake
config files which, once fixed, should enable building on Linux and
Windows as well.
Project: http://git-wip-us.apache.org/repos/asf/incubator-corinthia/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-corinthia/commit/23c028c7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-corinthia/tree/23c028c7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-corinthia/diff/23c028c7
Branch: refs/heads/master
Commit: 23c028c72feb131aeee3629fb179eac8a900ad3f
Parents: 9714877
Author: Peter Kelly <pe...@uxproductivity.com>
Authored: Sun Apr 12 00:42:06 2015 +0700
Committer: Peter Kelly <pe...@uxproductivity.com>
Committed: Sun Apr 12 00:42:06 2015 +0700
----------------------------------------------------------------------
consumers/corinthia/.gitignore | 1 +
consumers/corinthia/Doxyfile | 2331 ++++++++++++++++++++++++++
consumers/corinthia/res/sample.html | 395 +++++
consumers/corinthia/src/CMakeLists.txt | 35 +-
consumers/corinthia/src/Editor.cpp | 296 ++++
consumers/corinthia/src/Editor.h | 35 +
consumers/corinthia/src/JSInterface.cpp | 1307 +++++++++++++++
consumers/corinthia/src/JSInterface.h | 478 ++++++
consumers/corinthia/src/MainWindow.cpp | 101 ++
consumers/corinthia/src/MainWindow.h | 42 +
consumers/corinthia/src/Toolbar.cpp | 50 +
consumers/corinthia/src/Toolbar.h | 49 +
consumers/corinthia/src/desktop.cpp | 53 -
consumers/corinthia/src/desktop.ui | 72 -
consumers/corinthia/src/editWindows.h | 36 -
consumers/corinthia/src/main.cpp | 15 +-
16 files changed, 5118 insertions(+), 178 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/23c028c7/consumers/corinthia/.gitignore
----------------------------------------------------------------------
diff --git a/consumers/corinthia/.gitignore b/consumers/corinthia/.gitignore
new file mode 100644
index 0000000..8e695ec
--- /dev/null
+++ b/consumers/corinthia/.gitignore
@@ -0,0 +1 @@
+doc