mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-01-07 13:33:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add browsers.openDefaultBrowser without URL, implements IETF RFC-6694 Section-3 (#13835)

Browse Source
This commit is contained in:
Juan Carlos
2020-04-01 16:46:47 -03:00
committed by GitHub
parent bc37668c5a
commit 9599757068
2 changed files with 40 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
changelog.md
View File

@@ -123,6 +123,8 @@ echo f
retrieving the verified certificate chain of the peer we are connected to
through an SSL-wrapped `Socket`/`AsyncSocket`.
- Added `distinctBase` overload for values: `assert 12.MyInt.distinctBase == 12`
- Added `browsers.openDefaultBrowser` without URL, implements IETF RFC-6694 Section-3.
## Library changes

52
lib/pure/browsers.nim
View File

@@ -13,6 +13,7 @@
## Unstable API.
import strutils
include "system/inclrtl"
when defined(windows):
import winlean
@@ -24,20 +25,8 @@ const osOpenCmd* =
## Alias for the operating system specific *"open"* command,
## ``"open"`` on MacOS and Windows, ``"xdg-open"`` on Linux, BSD, etc.
proc openDefaultBrowser*(url: string) =
## Opens `url` with the user's default browser. This does not block.
## The URL must not be empty string.
##
## Under Windows, ``ShellExecute`` is used. Under Mac OS X the ``open``
## command is used. Under Unix, it is checked if ``xdg-open`` exists and
## used if it does. Otherwise the environment variable ``BROWSER`` is
## used to determine the default browser to use.
##
## This proc doesn't raise an exception on error, beware.
##
## .. code-block:: nim
## block: openDefaultBrowser("https://nim-lang.org")
doAssert url.len > 0, "URL must not be empty string"
template openDefaultBrowserImpl(url: string) =
when defined(windows):
var o = newWideCString(osOpenCmd)
var u = newWideCString(url)
@@ -54,3 +43,38 @@ proc openDefaultBrowser*(url: string) =
return
except OSError:
discard
proc openDefaultBrowser*(url: string) =
## Opens `url` with the user's default browser. This does not block.
## The URL must not be empty string, to open on a blank page see `openDefaultBrowser()`.
##
## Under Windows, ``ShellExecute`` is used. Under Mac OS X the ``open``
## command is used. Under Unix, it is checked if ``xdg-open`` exists and
## used if it does. Otherwise the environment variable ``BROWSER`` is
## used to determine the default browser to use.
##
## This proc doesn't raise an exception on error, beware.
##
## .. code-block:: nim
## block: openDefaultBrowser("https://nim-lang.org")
doAssert url.len > 0, "URL must not be empty string"
openDefaultBrowserImpl(url)
proc openDefaultBrowser*() {.since: (1, 1).} =
## Opens the user's default browser without any `url` (blank page). This does not block.
## Implements IETF RFC-6694 Section 3, "about:blank" must be reserved for a blank page.
##
## Under Windows, ``ShellExecute`` is used. Under Mac OS X the ``open``
## command is used. Under Unix, it is checked if ``xdg-open`` exists and
## used if it does. Otherwise the environment variable ``BROWSER`` is
## used to determine the default browser to use.
##
## This proc doesn't raise an exception on error, beware.
##
## **See also:**
##
## * https://tools.ietf.org/html/rfc6694#section-3
##
## .. code-block:: nim
## block: openDefaultBrowser()
openDefaultBrowserImpl("http:about:blank") # See IETF RFC-6694 Section 3.