Follow more consistent namespace scheme in the frontend

kosude · Apr 21, 2024 · 3a14880 · 3a14880
1 parent ec7fdf8
commit 3a14880
Show file tree

Hide file tree

Showing 23 changed files with 39 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@
 
 # TexEdit: a portable, cross-platform editor for TeX documents
 
+[![GitHub](https://img.shields.io/github/license/kosude/texedit)](LICENCE)
+![Lines of code](https://www.aschey.tech/tokei/github.com/kosude/texedit)
+
 TexEdit is a graphical application containing a text editor and PDF preview, to make locally editing LaTeX documents easier. Note that a minimal
 distribution of TeX including the `pdflatex` binary is included with the program, and so TexEdit is fully portable and does not depend on any existing
 TeX installation.
@@ -19,3 +22,5 @@ for instance. If you want an actual, fully-fledged LaTeX editor, I recommend [Ov
 
 Project documentation, as well as a general user manual, can be found deployed at https://kosude.github.io/texedit. It can also be accessed locally
 by building it with `make docs`.
+
+A development TO-DO can be found on [Trello](https://trello.com/b/xtq0vBzz/texedit).
diff --git a/docs/conf.py b/docs/conf.py
@@ -42,5 +42,6 @@
 }
 
 html_css_files = [
-    "css/sidebar.css"
+    "css/sidebar.css",
+    "css/link-consist.css"
 ]
diff --git a/docs/index.rst b/docs/index.rst
@@ -20,6 +20,6 @@ resulting PDF, written in C++ and Rust.
 This project is *very* work-in-progress and developed in my free time, so keep that in mind if you decide to use it! Platform support is currently
 limited to Linux and macOS; Windows support may be implemented in the future, since it is a relatively big task in this case. Despite being a
 personal project, TexEdit is still of course open-source and contributions are welcome and encouraged! If this applies to you, it might be helpful to
-read up on the :doc:`build process <content/building>`.
+read up on the :doc:`build process <content/building>` - also, see the TO-DO list on `Trello <https://trello.com/b/xtq0vBzz/texedit>`_.
 
 Source code is available on `GitHub <https://github.com/kosude/texedit>`_.
diff --git a/docs/static/css/link-consist.css b/docs/static/css/link-consist.css
@@ -0,0 +1,3 @@
+a, a:visited {
+    color: #004B6B !important;
+}
diff --git a/texedit/util/except.hpp → texedit/except.hpp b/texedit/util/except.hpp → texedit/except.hpp
@@ -9,7 +9,10 @@
 #ifndef __texedit__except_hpp__
 #define __texedit__except_hpp__
 
-namespace te::util::except {
+#include <stdexcept>
+#include <wx/string.h>
+
+namespace te::except {
     class MissingComponentException : public std::runtime_error {
     public:
         inline MissingComponentException(const wxString &name)

diff --git a/texedit/gui/command_ids.hpp b/texedit/gui/command_ids.hpp
@@ -9,7 +9,7 @@
 #ifndef __texedit__command_ids_hpp__
 #define __texedit__command_ids_hpp__
 
-namespace te::cmds {
+namespace te::gui::cmds {
     enum {
         Menu_URLSourcePage = 101,
         Menu_URLFeatureRequest,

diff --git a/texedit/gui/editor_panel.cpp b/texedit/gui/editor_panel.cpp
@@ -7,7 +7,7 @@
 
 #include "editor_panel.hpp"
 
-namespace te {
+namespace te::gui {
     EditorPanel::EditorPanel(wxWindow *parent) : wxPanel(parent) {
         _stc = new wxStyledTextCtrl(this, wxID_ANY);
 

diff --git a/texedit/gui/editor_panel.hpp b/texedit/gui/editor_panel.hpp
@@ -12,7 +12,7 @@
 #include <wx/wx.h>
 #include <wx/stc/stc.h>
 
-namespace te {
+namespace te::gui {
     class EditorPanel : public wxPanel {
     public:
         EditorPanel(wxWindow *parent);

diff --git a/texedit/gui/main_frame.cpp b/texedit/gui/main_frame.cpp
@@ -8,7 +8,6 @@
 #include "main_frame.hpp"
 
 #include "process/process.hpp"
-#include "util/except.hpp"
 #include "util/resources.hpp"
 #include "command_ids.hpp"
 #include "editor_panel.hpp"
@@ -18,7 +17,7 @@
 #include <wx/aboutdlg.h>
 #include <wx/splitter.h>
 
-namespace te {
+namespace te::gui {
     MainFrame::MainFrame() : wxFrame{nullptr, wxID_ANY, "TexEdit", wxDefaultPosition, wxSize{1024, 640}}, _proc_mgr{this}, _tecomp{_proc_mgr} {
         BuildMenuBar();
         BuildSplitLayout();

diff --git a/texedit/gui/main_frame.hpp b/texedit/gui/main_frame.hpp
@@ -15,7 +15,7 @@
 #include "process/compiler/tecomp_proc.hpp"
 #include "util/logger.hpp"
 
-namespace te {
+namespace te::gui {
     class MainFrame : public wxFrame {
     public:
         MainFrame();
@@ -25,8 +25,8 @@ namespace te {
         util::GlobalLogger *_logger;
         wxListBox *_lb;
 
-        ProcessManager _proc_mgr;
-        TECompProcess _tecomp;
+        proc::ProcessManager _proc_mgr;
+        proc::TECompProcess _tecomp;
 
         void BuildSplitLayout();
         void BuildMenuBar();

diff --git a/texedit/gui/preview_panel.cpp b/texedit/gui/preview_panel.cpp
@@ -7,7 +7,7 @@
 
 #include "preview_panel.hpp"
 
-namespace te {
+namespace te::gui {
     PreviewPanel::PreviewPanel(wxWindow *parent) : wxPanel(parent) {
         wxString pdf;
         _webView = wxWebView::New(this, wxID_ANY, "http://localhost:8080" + pdf);

diff --git a/texedit/gui/preview_panel.hpp b/texedit/gui/preview_panel.hpp
@@ -12,7 +12,7 @@
 #include <wx/wx.h>
 #include <wx/webview.h>
 
-namespace te {
+namespace te::gui {
     class PreviewPanel : public wxPanel {
     public:
         PreviewPanel(wxWindow *parent);

diff --git a/texedit/gui/prog_info.cpp b/texedit/gui/prog_info.cpp
@@ -7,7 +7,7 @@
 
 #include "prog_info.hpp"
 
-namespace te {
+namespace te::gui {
     wxAboutDialogInfo ProgInfo::GenerateAboutDialogInfo() {
         wxAboutDialogInfo info;
         info.SetName(name);

diff --git a/texedit/gui/prog_info.hpp b/texedit/gui/prog_info.hpp
@@ -11,7 +11,7 @@
 
 #include <wx/aboutdlg.h>
 
-namespace te {
+namespace te::gui {
     class ProgInfo {
     public:
         static constexpr const char *name = "TexEdit";

diff --git a/texedit/main.cpp b/texedit/main.cpp
@@ -58,7 +58,7 @@ namespace te {
         // TODO: command-line parsing here
 
         // show root (editor) window
-        MainFrame *main_frame = new MainFrame();
+        gui::MainFrame *main_frame = new gui::MainFrame();
         SetTopWindow(main_frame);
         main_frame->Show();
 

diff --git a/texedit/process/compiler/tecomp_proc.cpp b/texedit/process/compiler/tecomp_proc.cpp
@@ -7,14 +7,14 @@
 
 #include "tecomp_proc.hpp"
 
-#include "util/except.hpp"
+#include "except.hpp"
 #include "util/resources.hpp"
 
-namespace te {
+namespace te::proc {
     TECompProcess::TECompProcess(ProcessManager &mgr) : _mgr{mgr}, _id{1} {
-        _cmd = util::res::RelToExec("tecomp");
-        if (!util::res::ValidateExecutable(_cmd)) {
-            throw util::except::MissingComponentException("tecomp");
+        _cmd = util::RelToExec("tecomp");
+        if (!util::ValidateExecutable(_cmd)) {
+            throw except::MissingComponentException("tecomp");
         }
     }
 

diff --git a/texedit/process/compiler/tecomp_proc.hpp b/texedit/process/compiler/tecomp_proc.hpp
@@ -13,7 +13,7 @@
 
 #include "process/process_mgr.hpp"
 
-namespace te {
+namespace te::proc {
     class TECompProcess {
     public:
         TECompProcess(ProcessManager &mgr);

diff --git a/texedit/process/process.cpp b/texedit/process/process.cpp
@@ -12,7 +12,7 @@
 #include <wx/txtstrm.h>
 #include <iostream>
 
-namespace te {
+namespace te::proc {
     Process::Process(wxEvtHandler *parent, ProcessManager *mgr) : wxProcess(parent), _mgr{mgr} {
     }
 

diff --git a/texedit/process/process.hpp b/texedit/process/process.hpp
@@ -13,7 +13,7 @@
 
 #include <vector>
 
-namespace te {
+namespace te::proc {
     class ProcessManager;
 
     class Process : public wxProcess {

diff --git a/texedit/process/process_mgr.cpp b/texedit/process/process_mgr.cpp
@@ -9,7 +9,7 @@
 
 #include <wx/log.h>
 
-namespace te {
+namespace te::proc {
     ProcessManager::ProcessManager(wxEvtHandler *cmd_parent) : _cmd_parent{cmd_parent} {
     }
 

diff --git a/texedit/process/process_mgr.hpp b/texedit/process/process_mgr.hpp
@@ -13,7 +13,7 @@
 
 #include <unordered_map>
 
-namespace te {
+namespace te::proc {
     class ProcessManager {
     public:
         ProcessManager(wxEvtHandler *cmd_parent);

diff --git a/texedit/util/resources.cpp b/texedit/util/resources.cpp
@@ -10,7 +10,7 @@
 #include <wx/filename.h>
 #include <wx/stdpaths.h>
 
-namespace te::util::res {
+namespace te::util {
     wxString GetTexeditDir() {
         wxFileName f = wxStandardPaths::Get().GetExecutablePath();
         return f.GetPath();

diff --git a/texedit/util/resources.hpp b/texedit/util/resources.hpp
@@ -12,7 +12,7 @@
 #include <wx/string.h>
 #include <vector>
 
-namespace te::util::res {
+namespace te::util {
     wxString GetTexeditDir();
 
     wxString RelToExec(std::vector<wxString> dirs, wxString filename);