re-organize source. fixes #149

cpeditor · Feb 3, 2020 · 6f21e99 · 6f21e99
1 parent 6774d79
commit 6f21e99
Show file tree

Hide file tree

Showing 38 changed files with 92 additions and 63 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -33,40 +33,45 @@ configure_file(version.hpp.in ${CMAKE_BINARY_DIR}/generated/version.hpp)
 add_executable(CPEditor
     ${GUI_TYPE}
 
+    include/Core/Compiler.hpp
+    include/Core/Runner.hpp
+    include/Core/Formatter.hpp
+    include/Core/SettingsManager.hpp
+    include/Core/MessageLogger.hpp
+    src/Core/Compiler.cpp
+    src/Core/Runner.cpp
+    src/Core/Formatter.cpp
+    src/Core/SettingsManager.cpp
+    src/Core/MessageLogger.cpp
+
+    include/Telemetry/UpdateNotifier.hpp
+    src/Telemetry/UpdateNotifier.cpp
+
+    include/Widgets/TestCases.hpp
+    src/Widgets/TestCases.cpp
+
+    include/Extensions/CompanionServer.hpp
+    include/Extensions/CFTools.hpp
+    include/Extensions/EditorTheme.hpp
+    include/Extensions/ExtendedEditorFeatures.hpp
+    src/Extensions/CompanionServer.cpp
+    src/Extensions/CFTools.cpp
+    src/Extensions/EditorTheme.cpp
+    src/Extensions/ExtendedEditorFeatures.cpp
+
+
+
     include/mainwindow.hpp
-    include/MessageLogger.hpp
-    include/SettingsManager.hpp
-    include/Compiler.hpp
-    include/UpdateNotifier.hpp
-    include/Runner.hpp
-    include/Formatter.hpp
-    include/TestCases.hpp
-    include/CompanionServer.hpp
-    include/cftools.hpp
-    include/EditorTheme.hpp
     include/preferencewindow.hpp
     include/appwindow.hpp
-    third_party/diff_match_patch/diff_match_patch.h
-	include/ExtendedEditorFeatures.hpp
-
-
-
-    src/mainwindow.cc
-    src/MessageLogger.cpp
-    src/SettingsManager.cpp
-    src/main.cc
-    src/Compiler.cpp
-    src/UpdateNotifier.cpp
-    src/Runner.cpp
-    src/Formatter.cpp
-    src/TestCases.cpp
-    src/CompanionServer.cpp
-    src/cftools.cpp
-    src/editortheme.cpp
+    src/mainwindow.cpp
     src/preferencewindow.cpp
     src/appwindow.cpp
+
+    third_party/diff_match_patch/diff_match_patch.h
     third_party/diff_match_patch/diff_match_patch.cpp
-	src/ExtendedEditorFeatures.cpp
+
+    src/main.cpp
 
     ui/mainwindow.ui
     ui/preferencewindow.ui

diff --git a/include/Compiler.hpp → include/Core/Compiler.hpp b/include/Compiler.hpp → include/Core/Compiler.hpp
diff --git a/include/Formatter.hpp → include/Core/Formatter.hpp b/include/Formatter.hpp → include/Core/Formatter.hpp
@@ -17,7 +17,7 @@
 
 #ifndef FORMATTER_HPP
 #define FORMATTER_HPP
-#include <MessageLogger.hpp>
+#include "Core/MessageLogger.hpp"
 #include <QCodeEditor>
 #include <QPair>
 #include <QString>

diff --git a/include/MessageLogger.hpp → include/Core/MessageLogger.hpp b/include/MessageLogger.hpp → include/Core/MessageLogger.hpp
diff --git a/include/Core/README.md b/include/Core/README.md
@@ -0,0 +1,3 @@
+# Core
+
+This folder contains all the headers which are core part of editor. It usually included functionalities without which the editor will be useless. Here you will find `Compiler`, `Runners`, `Settings`. It includes all basics functionalities as well.
diff --git a/include/Runner.hpp → include/Core/Runner.hpp b/include/Runner.hpp → include/Core/Runner.hpp
diff --git a/include/SettingsManager.hpp → include/Core/SettingsManager.hpp b/include/SettingsManager.hpp → include/Core/SettingsManager.hpp
diff --git a/include/cftools.hpp → include/Extensions/CFTools.hpp b/include/cftools.hpp → include/Extensions/CFTools.hpp
@@ -18,7 +18,7 @@
 #ifndef CFTOOLS_HPP
 #define CFTOOLS_HPP
 
-#include <MessageLogger.hpp>
+#include "Core/MessageLogger.hpp"
 #include <QProcess>
 #include <QRegularExpression>
 #include <QSystemTrayIcon>

diff --git a/include/CompanionServer.hpp → include/Extensions/CompanionServer.hpp b/include/CompanionServer.hpp → include/Extensions/CompanionServer.hpp
@@ -17,7 +17,7 @@
 
 #ifndef COMPANIONSERVER_HPP
 #define COMPANIONSERVER_HPP
-#include "MessageLogger.hpp"
+#include "Core/MessageLogger.hpp"
 #include <QObject>
 #include <QTcpServer>
 #include <QTcpSocket>

diff --git a/include/EditorTheme.hpp → include/Extensions/EditorTheme.hpp b/include/EditorTheme.hpp → include/Extensions/EditorTheme.hpp
diff --git a/include/ExtendedEditorFeatures.hpp → ...ude/Extensions/ExtendedEditorFeatures.hpp b/include/ExtendedEditorFeatures.hpp → ...ude/Extensions/ExtendedEditorFeatures.hpp
diff --git a/include/Extensions/README.md b/include/Extensions/README.md
@@ -0,0 +1,3 @@
+# Extensions
+
+This folder contains all extended features of the editor. Like CF-tool integration, Themes and other components that enhance the use of the editor.
diff --git a/include/Telemetry/README.md b/include/Telemetry/README.md
@@ -0,0 +1,3 @@
+# Telemetry
+
+This folder contains code that directly sends or gets data from internet. The code here requires that internet connectivity to run properly. **All the code in this folder must be under the namespace telemetry**
diff --git a/include/UpdateNotifier.hpp → include/Telemetry/UpdateNotifier.hpp b/include/UpdateNotifier.hpp → include/Telemetry/UpdateNotifier.hpp
diff --git a/include/Widgets/README.md b/include/Widgets/README.md
@@ -0,0 +1,3 @@
+# Widgets
+
+This folder contains the custom widgets that editor uses. It usually involves code that extends one of Qt widgets.
diff --git a/include/TestCases.hpp → include/Widgets/TestCases.hpp b/include/TestCases.hpp → include/Widgets/TestCases.hpp
@@ -18,7 +18,7 @@
 #ifndef TESTCASES_HPP
 #define TESTCASES_HPP
 
-#include "MessageLogger.hpp"
+#include "Core/MessageLogger.hpp"
 #include <QFileInfo>
 #include <QHBoxLayout>
 #include <QLabel>

diff --git a/include/appwindow.hpp b/include/appwindow.hpp
@@ -20,10 +20,10 @@
 
 #include <QMainWindow>
 
-#include "SettingsManager.hpp"
-#include "UpdateNotifier.hpp"
+#include "Core/SettingsManager.hpp"
+#include "Telemetry/UpdateNotifier.hpp"
 #include "mainwindow.hpp"
-#include "ExtendedEditorFeatures.hpp"
+#include "Extensions/ExtendedEditorFeatures.hpp"
 #include "preferencewindow.hpp"
 
 namespace Ui

diff --git a/include/mainwindow.hpp b/include/mainwindow.hpp
@@ -18,9 +18,9 @@
 #ifndef MAINWINDOW_HPP
 #define MAINWINDOW_HPP
 
-#include <CompanionServer.hpp>
-#include <Compiler.hpp>
-#include <Formatter.hpp>
+#include "Extensions/CompanionServer.hpp"
+#include "Core/Compiler.hpp"
+#include "Core/Formatter.hpp"
 #include <QCodeEditor>
 #include <QFile>
 #include <QFileSystemWatcher>
@@ -30,11 +30,11 @@
 #include <QShortcut>
 #include <QSplitter>
 #include <QTemporaryDir>
-#include <Runner.hpp>
-#include <SettingsManager.hpp>
-#include <TestCases.hpp>
-#include <UpdateNotifier.hpp>
-#include <cftools.hpp>
+#include "Core/Runner.hpp"
+#include "Core/SettingsManager.hpp"
+#include "Widgets/TestCases.hpp"
+#include "Telemetry/UpdateNotifier.hpp"
+#include "Extensions/CFTools.hpp"
 #include <generated/version.hpp>
 
 QT_BEGIN_NAMESPACE

diff --git a/include/preferencewindow.hpp b/include/preferencewindow.hpp
@@ -18,7 +18,7 @@
 #ifndef PREFERENCEWINDOW_HPP
 #define PREFERENCEWINDOW_HPP
 
-#include "SettingsManager.hpp"
+#include "Core/SettingsManager.hpp"
 #include <QCodeEditor>
 #include <QListWidget>
 #include <QMainWindow>

diff --git a/src/Compiler.cpp → src/Core/Compiler.cpp b/src/Compiler.cpp → src/Core/Compiler.cpp
@@ -15,7 +15,7 @@
  *
  */
 
-#include <Compiler.hpp>
+#include "Core/Compiler.hpp"
 #include <QFileInfo>
 
 namespace Core

diff --git a/src/Formatter.cpp → src/Core/Formatter.cpp b/src/Formatter.cpp → src/Core/Formatter.cpp
@@ -15,7 +15,7 @@
  *
  */
 
-#include <Formatter.hpp>
+#include "Core/Formatter.hpp"
 #include <QJsonDocument>
 #include <QProcess>
 #include <QTemporaryDir>

diff --git a/src/MessageLogger.cpp → src/Core/MessageLogger.cpp b/src/MessageLogger.cpp → src/Core/MessageLogger.cpp
@@ -15,7 +15,7 @@
  *
  */
 
-#include <MessageLogger.hpp>
+#include "Core/MessageLogger.hpp"
 #include <QDateTime>
 
 void MessageLogger::setContainer(QTextBrowser *value)

diff --git a/src/Core/README.md b/src/Core/README.md
@@ -0,0 +1,3 @@
+# Core
+
+This folder contains all the headers which are core part of editor. It usually included functionalities without which the editor will be useless. Here you will find `Compiler`, `Runners`, `Settings`. It includes all basics functionalities as well.
diff --git a/src/Runner.cpp → src/Core/Runner.cpp b/src/Runner.cpp → src/Core/Runner.cpp
@@ -16,7 +16,7 @@
  */
 
 #include <QFileInfo>
-#include <Runner.hpp>
+#include "Core/Runner.hpp"
 
 namespace Core
 {

diff --git a/src/SettingsManager.cpp → src/Core/SettingsManager.cpp b/src/SettingsManager.cpp → src/Core/SettingsManager.cpp
@@ -15,10 +15,10 @@
  *
  */
 
-#include <MessageLogger.hpp>
+#include "Core/MessageLogger.hpp"
 #include <QApplication>
 #include <QStandardPaths>
-#include <SettingsManager.hpp>
+#include "Core/SettingsManager.hpp"
 
 namespace Settings
 {

diff --git a/src/cftools.cpp → src/Extensions/CFTools.cpp b/src/cftools.cpp → src/Extensions/CFTools.cpp
@@ -15,7 +15,7 @@
  *
  */
 
-#include "cftools.hpp"
+#include "Extensions/CFTools.hpp"
 #include <QFileInfo>
 #include <QUrl>
 

diff --git a/src/CompanionServer.cpp → src/Extensions/CompanionServer.cpp b/src/CompanionServer.cpp → src/Extensions/CompanionServer.cpp
@@ -15,8 +15,8 @@
  *
  */
 
-#include <CompanionServer.hpp>
-#include <MessageLogger.hpp>
+#include "Extensions/CompanionServer.hpp"
+#include "Core/MessageLogger.hpp"
 #include <QJsonArray>
 #include <QJsonDocument>
 #include <QJsonObject>

diff --git a/src/editortheme.cpp → src/Extensions/EditorTheme.cpp b/src/editortheme.cpp → src/Extensions/EditorTheme.cpp
@@ -15,7 +15,7 @@
  *
  */
 
-#include "EditorTheme.hpp"
+#include "Extensions/EditorTheme.hpp"
 
 #include <QFile>
 #include <QIODevice>

diff --git a/src/ExtendedEditorFeatures.cpp → src/Extensions/ExtendedEditorFeatures.cpp b/src/ExtendedEditorFeatures.cpp → src/Extensions/ExtendedEditorFeatures.cpp
@@ -1,4 +1,4 @@
-#include <ExtendedEditorFeatures.hpp>
+#include "Extensions/ExtendedEditorFeatures.hpp"
 #include <QDebug>
 #include <QString>
 

diff --git a/src/Extensions/README.md b/src/Extensions/README.md
@@ -0,0 +1,3 @@
+# Extensions
+
+This folder contains all extended features of the editor. Like CF-tool integration, Themes and other components that enhance the use of the editor.
diff --git a/src/Telemetry/README.md b/src/Telemetry/README.md
@@ -0,0 +1,3 @@
+# Telemetry
+
+This folder contains code that directly sends or gets data from internet. The code here requires that internet connectivity to run properly. **All the code in this folder must be under the namespace telemetry**
diff --git a/src/UpdateNotifier.cpp → src/Telemetry/UpdateNotifier.cpp b/src/UpdateNotifier.cpp → src/Telemetry/UpdateNotifier.cpp
@@ -18,7 +18,7 @@
 #include <QJsonArray>
 #include <QJsonDocument>
 #include <QMessageBox>
-#include <UpdateNotifier.hpp>
+#include "Telemetry/UpdateNotifier.hpp"
 
 namespace Telemetry
 {

diff --git a/src/Widgets/README.md b/src/Widgets/README.md
@@ -0,0 +1,3 @@
+# Widgets
+
+This folder contains the custom widgets that editor uses. It usually involves code that extends one of Qt widgets.
diff --git a/src/TestCases.cpp → src/Widgets/TestCases.cpp b/src/TestCases.cpp → src/Widgets/TestCases.cpp
@@ -15,7 +15,7 @@
  *
  */
 
-#include "TestCases.hpp"
+#include "Widgets/TestCases.hpp"
 #include "diff_match_patch.h"
 #include <QFileDialog>
 #include <QMainWindow>

diff --git a/src/appwindow.cpp b/src/appwindow.cpp
@@ -17,7 +17,7 @@
 
 #include "appwindow.hpp"
 #include "../ui/ui_appwindow.h"
-#include <EditorTheme.hpp>
+#include "Extensions/EditorTheme.hpp"
 #include <QClipboard>
 #include <QDesktopServices>
 #include <QFileDialog>

diff --git a/src/main.cc → src/main.cpp b/src/main.cc → src/main.cpp
diff --git a/src/mainwindow.cc → src/mainwindow.cpp b/src/mainwindow.cc → src/mainwindow.cpp
@@ -17,9 +17,9 @@
 
 #include "mainwindow.hpp"
 
-#include <Compiler.hpp>
-#include <EditorTheme.hpp>
-#include <MessageLogger.hpp>
+#include "Core/Compiler.hpp"
+#include "Extensions/EditorTheme.hpp"
+#include "Core/MessageLogger.hpp"
 #include <QCXXHighlighter>
 #include <QFileDialog>
 #include <QFont>
@@ -37,7 +37,7 @@
 #include <QTextStream>
 #include <QThread>
 #include <QTimer>
-#include <Runner.hpp>
+#include "Core/Runner.hpp"
 
 #include "../ui/ui_mainwindow.h"
 

diff --git a/src/preferencewindow.cpp b/src/preferencewindow.cpp
@@ -18,7 +18,7 @@
 #include "include/preferencewindow.hpp"
 #include "../ui/ui_preferencewindow.h"
 
-#include <EditorTheme.hpp>
+#include "Extensions/EditorTheme.hpp"
 #include <QAction>
 #include <QCXXHighlighter>
 #include <QDesktopWidget>