Merge pull request #2 from Soundux/rewrite

Rewrite

Author: Curve

.clang-tidy

@@ -50,5 +50,4 @@ Checks: "*,\
   -cppcoreguidelines-pro-type-union-access,\
   -readability-static-accessed-through-instance,\
   -cppcoreguidelines-special-member-functions,\
-  -readability-isolate-declaration,\
-  -google-default-arguments"
+  -readability-isolate-declaration"

.github/workflows/build_linux.yml

@@ -1,12 +1,10 @@
 on:
     push:
-        branches: [master]
         paths-ignore:
             - "**/README.md"
             - "**/build_windows.yml"
     pull_request:
-        branches: [master]
-
+    
 name: Build on Linux
 jobs:
     build-linux:

.github/workflows/build_windows.yml

@@ -1,11 +1,9 @@
 on:
     push:
-        branches: [master]
         paths-ignore:
             - "**/README.md"
             - "**/build_linux.yml"
     pull_request:
-        branches: [master]
 
 name: Build on Windows
 jobs:

CMakeLists.txt

@@ -1,10 +1,10 @@
 cmake_minimum_required(VERSION 3.1)
-project(webview VERSION 0.1 DESCRIPTION "The WebView component of Soundux")
+project(webview VERSION 0.2 DESCRIPTION "A cross-platform C++ webview library")
 
 file(GLOB src
-    "src/*.cpp"
-    "src/*/*.cpp"
-    "src/*/*/*.cpp"
+    "webview/src/*.cpp"
+    "webview/src/*/*.cpp"
+    "webview/src/*/*/*.cpp"
 )
 
 add_library(webview STATIC ${src})
@@ -26,17 +26,17 @@ if (WIN32)
     target_link_libraries(webview INTERFACE Version.lib Shlwapi.lib ${CMAKE_BINARY_DIR}/packages/Microsoft.Web.WebView2/build/native/x64/WebView2LoaderStatic.lib ${CMAKE_BINARY_DIR}/packages/Microsoft.Windows.ImplementationLibrary/build/native/Microsoft.Windows.ImplementationLibrary.targets)
     target_include_directories(webview SYSTEM PUBLIC ${CMAKE_BINARY_DIR}/packages/Microsoft.Web.WebView2/build/native/include ${CMAKE_BINARY_DIR}/packages/Microsoft.Windows.ImplementationLibrary/include)
 elseif(UNIX)
-    target_compile_options(webview INTERFACE -Wall -Wextra -Werror -pedantic -Wno-unused-lambda-capture)
+    target_compile_options(webview PRIVATE -Wall -Wextra -Werror -pedantic -Wno-unused-lambda-capture)
 
     find_package(PkgConfig REQUIRED)
 	pkg_check_modules(GTK3 REQUIRED gtk+-3.0)
 	pkg_check_modules(WEBKIT2 REQUIRED webkit2gtk-4.0)
 
-    target_link_libraries(webview INTERFACE ${GTK3_LIBRARIES} ${WEBKIT2_LIBRARIES})
+    target_link_libraries(webview INTERFACE ${GTK3_LIBRARIES} ${WEBKIT2_LIBRARIES} pthread)
     target_include_directories(webview SYSTEM PUBLIC ${GTK3_INCLUDE_DIRS} ${WEBKIT2_INCLUDE_DIRS} ${PROJECT_SOURCE_DIR})
 endif()
 
-target_include_directories(webview SYSTEM PUBLIC "src/")
+target_include_directories(webview SYSTEM PUBLIC "webview/include/")
 target_include_directories(webview SYSTEM PUBLIC "lib/json/single_include/nlohmann")
 
 target_compile_features(webview PUBLIC cxx_std_17)
@@ -45,4 +45,4 @@ set_target_properties(webview PROPERTIES CMAKE_CXX_EXTENSIONS Off)
 set_target_properties(webview PROPERTIES CMAKE_CXX_STANDARD_REQUIRED On)
 
 set_target_properties(webview PROPERTIES VERSION ${PROJECT_VERSION})
-set_target_properties(webview PROPERTIES PROJECT_NAME ${PROJECT_NAME})
+set_target_properties(webview PROPERTIES PROJECT_NAME ${PROJECT_NAME})

README.md

@@ -24,6 +24,24 @@ A cross-platform C++17 library that allows you to create a simple webview.
 - Linux
   - (Runtime & Build) webkit2gtk
 
+## Example
+```cpp
+#include <webview.hpp>
+
+int main()
+{
+  Webview::Window webview("webview", 800, 900);
+  webview.expose(Webview::Function("addTen", [](int num) {
+      return num + 10;
+  }));
+
+  webview.run();
+  return 0;
+}
+```
+
+For more examples see [`examples`](https://github.com/Soundux/webviewpp/tree/master/examples) 
+
 ## Embedding
 webviewpp supports embedding of all required files.  
 To embed your files you have to use the [embed-helper](https://github.com/Soundux/webviewpp/tree/master/embed-helper).
@@ -38,14 +56,234 @@ Usage:
       ./embed_helper <path to folder containing all the required files>
       ```
   - Add the parent folder of the `embedded` folder to your include directories
-  - Change `navigate` calls to
+  - Change `setUrl` calls to
     - `embedded://<filepath>` on Linux
     - `file:///embedded/<filepath>` on Windows
 
 > For an example see [examples/embedded](https://github.com/Soundux/webviewpp/tree/master/examples/embedded)
 
 ## Documentation
-The documentation was moved to the [main header file](https://github.com/Soundux/webviewpp/blob/master/src/webview/webview.hpp#L200)
+### Window::hide
+
+``` cpp
+void hide();
+```
+
+> Hides the window
+
+-----
+
+### Window::show
+
+``` cpp
+void show();
+```
+
+> Shows the window
+
+-----
+
+### Window::isHidden
+
+``` cpp
+bool isHidden();
+```
+
+**Returns:**
+>  Whether or the window is hidden
+
+-----
+
+### Window::setSize
+
+``` cpp
+void setSize(std::size_t, std::size_t);
+```
+
+> Sets the window size
+
+-----
+
+### Window::getSize
+
+``` cpp
+std::pair<std::size_t, std::size_t> getSize();
+```
+
+**Returns:**
+>  The width and height in form of an `std::pair`
+
+-----
+
+### Window::getTitle
+
+``` cpp
+std::string getTitle();
+```
+
+**Returns:**
+>  The title of the window
+
+-----
+
+### Window::setTitle
+
+``` cpp
+void setTitle(std::string);
+```
+
+> Sets the window title
+
+-----
+
+### Window::run
+
+``` cpp
+void run();
+```
+
+> Runs the mainloop
+
+**Remarks:**
+>  Is blocking
+
+-----
+
+### Window::exit
+
+``` cpp
+void exit();
+```
+
+> Closes the webview
+
+-----
+
+### Window::getUrl
+
+``` cpp
+std::string getUrl();
+```
+
+**Returns:**
+>  The current url
+
+-----
+
+### Window::setUrl
+
+``` cpp
+void setUrl(std::string);
+```
+
+> Navigates to the given url
+
+-----
+
+### Window::enableContextMenu
+
+``` cpp
+void enableContextMenu(bool);
+```
+
+> Enables the context menu
+
+-----
+
+### Window::enableDevTools
+
+``` cpp
+void enableDevTools(bool);
+```
+
+> Enables the developer tools
+
+-----
+
+### Window::expose
+
+``` cpp
+void expose(Webview::Function const&);
+```
+
+> Exposes the given function
+
+**Remarks:**
+>  If the given Function is an `AsyncFunction` it will be run in a new thread
+
+-----
+
+### Window::callFunction
+
+``` cpp
+template <typename T>
+std::future<T> callFunction(Webview::JavaScriptFunction&& function);
+```
+
+> Calls the given javascript function
+
+**Returns:**
+>  The result of the javascript function call as `T`
+
+**Preconditions**
+>  `T` must be serializable by nlohmann::json
+
+**Remarks:**
+>  You should never call `.get()` on the returned future in a **non async** context as it will freeze the webview
+
+-----
+
+### Window::runCode
+
+``` cpp
+void runCode(std::string const&);
+```
+
+> Runs the given javascript code
+
+-----
+
+### Window::injectCode
+
+``` cpp
+void injectCode(std::string const&);
+```
+
+> Makes the given javascript code run on document load
+
+-----
+
+### Window::setCloseCallback
+
+``` cpp
+void setCloseCallback(std::function<bool ()>);
+```
+
+> Sets the close-callback to the given callback
+
+**Remarks:**
+>  If the callback returns `true` the webview will not close
+
+-----
+
+### Window::setNavigateCallback
+
+``` cpp
+void setNavigateCallback(std::function<void (const std::string &)>);
+```
+
+> Sets the navigate-callback to the given callback
+
+-----
+
+### Window::setResizeCallback
+
+``` cpp
+void setResizeCallback(std::function<void (std::size_t, std::size_t)>);
+```
+
+> Sets the resize-callback to the given callback
 
+-----
 
-> Note: This work was originally based on the work of [MichaelKim](https://github.com/MichaelKim/webview)
+> This work was originally based on the work of [MichaelKim](https://github.com/MichaelKim/webview)

embed-helper/main.cpp

@@ -20,9 +20,13 @@ int main(int argc, char **args)
         std::ofstream output("embedded/webview_base.hpp");
         output << "#pragma once" << std::endl
                << "#include <map>" << std::endl
-               << "#include <utility>" << std::endl
                << "#include <string>" << std::endl
-               << "inline std::map<const std::string, std::pair<std::size_t, unsigned char*>> embedded_files;";
+               << "#include <core/resource.hpp>" << std::endl
+               << "namespace Webview {" << std::endl
+               << "namespace Embedded {" << std::endl
+               << "inline std::map <const std::string, Resource> files;" << std::endl
+               << "}" << std::endl
+               << "}" << std::endl;
         output.close();
         std::vector<std::string> filesToInclude;
 
@@ -43,6 +47,7 @@ int main(int argc, char **args)
             std::ofstream fileStream("embedded/" + file.path().filename().string() + ".hpp");
             fileStream << "#pragma once" << std::endl
                        << "#include \"webview_base.hpp\"" << std::endl
+                       << "namespace Webview::Embedded {" << std::endl
                        << "inline unsigned char embed_file_" << fileFunc << "[] = {";
 
             std::ifstream fileDataStream(file.path(), std::ios::binary);
@@ -58,10 +63,11 @@ int main(int argc, char **args)
             }
             fileStream << "};";
 
-            fileStream << "inline auto webview_embed_file_" << fileFunc << " = []() -> bool { embedded_files.insert({\""
+            fileStream << "inline auto webview_embed_file_" << fileFunc << " = []() -> bool { files.insert({\""
                        << file.path().filename().string() << "\", {" << std::dec << buffer.size() << ","
                        << "embed_file_" << fileFunc << "}});"
-                       << "return true; }();";
+                       << "return true; }();" << std::endl
+                       << "}";
             fileStream.close();
         }
 

examples/advanced/CMakeLists.txt

@@ -0,0 +1,13 @@
+cmake_minimum_required(VERSION 3.1)
+project(webview-example VERSION 0.1)
+
+add_executable(webview-example "main.cpp")
+add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/../../ ${CMAKE_CURRENT_SOURCE_DIR}/../../example_build EXCLUDE_FROM_ALL)
+target_link_libraries(webview-example webview)
+
+target_compile_features(webview-example PUBLIC cxx_std_17)
+set_target_properties(webview-example PROPERTIES CMAKE_CXX_STANDARD 17)
+set_target_properties(webview-example PROPERTIES CMAKE_CXX_EXTENSIONS Off)
+set_target_properties(webview-example PROPERTIES CMAKE_CXX_STANDARD_REQUIRED On)
+set_target_properties(webview-example PROPERTIES VERSION ${PROJECT_VERSION})
+set_target_properties(webview-example PROPERTIES PROJECT_NAME ${PROJECT_NAME})