First Release

naqvis · May 24, 2020 · e104036 · e104036
commit e104036
Show file tree

Hide file tree

Showing 13 changed files with 1,638 additions and 0 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*.cr]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+/docs/
+/lib/
+/bin/
+/.shards/
+*.dwarf
+# Libraries don't need dependency lock
+# Dependencies will be locked in applications that use them
+/shard.lock
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,6 @@
+language: crystal
+
+# Uncomment the following if you'd like Travis to run specs and check code formatting
+# script:
+#   - crystal spec
+#   - crystal tool format --check
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ali Naqvi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,153 @@
+# Crystal Webview
+
+Crystal language bindings for [zserge's Webview](https://github.com/zserge/webview) which is an excellent cross-platform single header webview library for C/C++ using Gtk, Cocoa or MSHTML/Edge repectively.
+
+**Webview** relys on default rendering engine of host Operating System, thus binaries generated with this Shard will be much more leaner as compared to [Electron](https://github.com/electron/electron) which bundles Chromium with each distribution.
+
+Shard Supports **Two-way bindings** between Crystal and JavaScript. You can invoke JS code via `Webview::Webview#eval` and calling Crystal code from JS is done via `WebView::Webview#bind` (refer to Example 3 for sample on how to invoke Crystal functions from JS)
+
+Webview supported platforms and the engines you can expect to render your application content are as follows:
+
+| Operating System | Browser Engine Used |
+| ---------------- | ------------------- |
+| OSX              | Cocoa/WebKit        |
+| Linux            | Gtk-webkit2         |
+| Windows          | MSHTML or EdgeHTML  |
+
+## Pre-requisite
+1. Make sure you compile `ext/webview.cc` and save object file `webview.o` under respective OS folder in `ext` folder. Follow instructions for your specific OS
+
+### Mac compilation
+```
+cd ext
+c++ -c webview.cc -o darwin/webview.o -DWEBVIEW_COCOA=1 -DOBJC_OLD_DISPATCH_PROTOTYPES=1 -std=c++11
+```
+
+### Linux compilation
+If you're planning on targeting Linux you must ensure that Webkit2gtk is already installed and available for discovery via the pkg-config command.
+
+```
+cd ext
+c++ -c webview.cc -o linux/webview.o -DWEBVIEW_GTK=1 -std=c++11
+```
+
+
+## Installation
+
+1. Add the dependency to your `shard.yml`:
+
+   ```yaml
+   dependencies:
+     webview:
+       github: naqvis/webview
+   ```
+
+2. Run `shards install`
+
+## Usage
+
+### Example 1: Loading URL
+
+```crystal
+require "webview"
+
+wv = Webview.window(640, 480, Webview::SizeHints::NONE, "Hello WebView", "http://crystal-lang.org")
+wv.run
+wv.destroy
+```
+
+### Example 2: Loading HTML
+
+```crystal
+require "webview"
+
+html = <<-HTML
+data:text/html,<!DOCTYPE html><html lang="en-US">
+<head>
+<title>Hello,World!</title>
+</head>
+<body>
+<div class="container">
+<header>
+	<!-- Logo -->
+   <h1>City Gallery</h1>
+</header>
+<nav>
+  <ul>
+    <li><a href="/London">London</a></li>
+    <li><a href="/Paris">Paris</a></li>
+    <li><a href="/Tokyo">Tokyo</a></li>
+  </ul>
+</nav>
+<article>
+  <h1>London</h1>
+  <img src="pic_mountain.jpg" alt="Mountain View" style="width:304px;height:228px;">
+  <p>London is the capital city of England. It is the most populous city in the  United Kingdom, with a metropolitan area of over 13 million inhabitants.</p>
+  <p>Standing on the River Thames, London has been a major settlement for two millennia, its history going back to its founding by the Romans, who named it Londinium.</p>
+</article>
+<footer>Copyright &copy; W3Schools.com</footer>
+</div>
+</body>
+</html>
+HTML
+
+wv = Webview.window(640, 480, Webview::SizeHints::NONE, "Hello WebView", html)
+wv.run
+wv.destroy
+```
+
+### Example 3: Calling Crystal code from JavaScript
+```crystal
+require "webview"
+
+html = <<-HTML
+data:text/html,<!doctype html>
+<html>
+  <body>hello</body>
+  <script>
+    window.onload = function() {
+      document.body.innerText = "Javascript calling Crystal code";
+      noop().then(function(res) {
+        console.log('noop res', res);
+        add(1, 2).then(function(res) {
+          console.log('add res', res);
+        });
+      });
+    };
+  </script>
+</html>
+HTML
+
+wv = Webview.window(640, 480, Webview::SizeHints::NONE, "Hello WebView", html, true)
+
+wv.bind("noop", Webview::JSProc.new { |a|
+  pp "Noop called with arguments: #{a}"
+  JSON::Any.new("noop")
+})
+
+wv.bind("add", Webview::JSProc.new { |a|
+  pp "add called with arguments: #{a}"
+  ret = 0_i64
+  a.each do |v|
+    ret += v.as_i64
+  end
+  JSON::Any.new(ret)
+})
+
+
+wv.run
+wv.destroy
+```
+
+
+## Contributing
+
+1. Fork it (<https://github.com/naqvis/webview/fork>)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Contributors
+
+- [Ali Naqvi](https://github.com/naqvis) - creator and maintainer
diff --git a/ext/darwin/webview.o b/ext/darwin/webview.o
diff --git a/ext/webview.cc b/ext/webview.cc
@@ -0,0 +1,2 @@
+#define WEBVIEW_IMPLEMENTATION
+#include "webview.h"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		#define WEBVIEW_IMPLEMENTATION
		#include "webview.h"