mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-29 17:34:43 +00:00
fbc97e712a
* move since from inclrtl to std/private/since * move since import in system below for HCR
82 lines
2.8 KiB
Nim
82 lines
2.8 KiB
Nim
#
|
|
#
|
|
# Nim's Runtime Library
|
|
# (c) Copyright 2012 Andreas Rumpf
|
|
#
|
|
# See the file "copying.txt", included in this
|
|
# distribution, for details about the copyright.
|
|
#
|
|
|
|
## This module implements a simple proc for opening URLs with the user's
|
|
## default browser.
|
|
##
|
|
## Unstable API.
|
|
|
|
import std/private/since
|
|
|
|
import strutils
|
|
|
|
when defined(windows):
|
|
import winlean
|
|
else:
|
|
import os, osproc
|
|
|
|
const osOpenCmd* =
|
|
when defined(macos) or defined(macosx) or defined(windows): "open" else: "xdg-open" ## \
|
|
## Alias for the operating system specific *"open"* command,
|
|
## ``"open"`` on OSX, MacOS and Windows, ``"xdg-open"`` on Linux, BSD, etc.
|
|
|
|
|
|
template openDefaultBrowserImpl(url: string) =
|
|
when defined(windows):
|
|
var o = newWideCString(osOpenCmd)
|
|
var u = newWideCString(url)
|
|
discard shellExecuteW(0'i32, o, u, nil, nil, SW_SHOWNORMAL)
|
|
elif defined(macosx):
|
|
discard execShellCmd(osOpenCmd & " " & quoteShell(url))
|
|
else:
|
|
var u = quoteShell(url)
|
|
if execShellCmd(osOpenCmd & " " & u) == 0: return
|
|
for b in getEnv("BROWSER").string.split(PathSep):
|
|
try:
|
|
# we use ``startProcess`` here because we don't want to block!
|
|
discard startProcess(command = b, args = [url], options = {poUsePath})
|
|
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.
|