namespace os

--****

-- == Operating System Helpers

--

-- <>

--

include std/sequence.e

include std/text.e

include std/machine.e

include std/dll.e

elsifdef WINDOWS then

public constant CMD_SWITCHES = "-/"

end ifdef

constant

--****

-- === Operating System Constants

--

public enum

--****

-- These constants are returned by the [[:platform]] function.

--

-- * ##WIN32## ~-- Host operating system is Windows

-- * ##LINUX## ~-- Host operating system is Linux

-- * ##FREEBSD## ~-- Host operating system is FreeBSD

-- * ##OSX## ~-- Host operating system is Mac OS X

-- * ##SUNOS## ~-- Host operating system is Sun's OpenSolaris

-- * ##OPENBSD## ~-- Host operating system is OpenBSD

-- * ##NETBSD## ~-- Host operating system is NetBSD

--

-- Note:

-- Via the [[:platform]] call, there is no way to determine if you are on Linux

-- or FreeBSD. This was done to provide a generic UNIX return value for

-- [[:platform]].

--

-- In most situations you are better off to test the host platform by using

-- the [[:ifdef statement]]. It is both more precise and faster.

--

--****

-- === Environment.

--**

-- Return ##hInstance## on //Windows// and Process ID (pid) on //Unix//.

--

-- Comments:

-- On //Windows// the ##hInstance## can be passed around to various

-- //Windows// routines.

end function

atom cur_pid = -1

end ifdef

--**

-- Return the ID of the current Process (pid)

--

-- Returns:

-- An atom: The current process' id.

--

-- Example:

--

-- mypid = get_pid()

--

elsifdef WINDOWS then

if cur_pid = -1 then

cur_pid = define_c_func(open_dll("kernel32.dll"), "GetCurrentProcessId", {}, C_DWORD)

if cur_pid >= 0 then

cur_pid = c_func(cur_pid, {})

end if

end if

return cur_pid

end ifdef

end function

constant M_UNAME = define_c_func(open_dll("kernel32.dll"), "GetVersionExA", {C_POINTER}, C_INT)

elsifdef UNIX then

end ifdef

--**

-- Retrieves the name of the host OS.

--

-- Returns:

-- A **sequence**, starting with the OS name. If identification fails, returns

-- an OS name of UNKNOWN. Extra information depends on the OS.

--

-- On Unix, returns the same information as the uname() syscall in the same

-- order as the struct utsname. This information is:

-- OS Name/Kernel Name

-- Local Hostname

-- Kernel Version/Kernel Release

-- Kernel Specific Version information (This is usually the date that the

-- kernel was compiled on and the name of the host that performed the compiling.)

-- Architecture Name (Usually a string of i386 vs x86_64 vs ARM vs etc)

--

-- On Windows, returns the following in order:

-- Windows Platform (out of WinCE, Win9x, WinNT, Win32s, or Unknown Windows)

-- Name of Windows OS (Windows 3.1, Win95, WinXP, etc)

-- Platform Number

-- Build Number

-- Minor OS version number

-- Major OS version number

--

-- On UNKNOWN, returns an OS name of "UNKNOWN". No other information is returned.

--

-- Returns a string of "" if an internal error has occured.

--

-- Comments:

-- On Unix, M_UNAME is defined as a machine_func() and this is passed to the C

-- backend. If the M_UNAME call fails, the raw machine_func() returns -1.

-- On non Unix platforms, calling the machine_func() directly returns 0.

atom buf

sequence sbuf

integer maj, mine, build, plat

buf = allocate(148)

poke4(buf, 148)

if c_func(M_UNAME, {buf}) then

maj = peek4u(buf+4)

mine = peek4u(buf+8)

build = peek4u(buf+12)

plat = peek4u(buf+16)

sbuf = {}

if plat = 0 then

sbuf = append(sbuf, "Win32s")

sbuf = append(sbuf, sprintf("Windows %d.%d", {maj,mine}))

elsif plat = 1 then

sbuf = append(sbuf, "Win9x")

if mine = 0 then

sbuf = append(sbuf, "Win95")

elsif mine = 10 then

sbuf = append(sbuf, "Win98")

elsif mine = 90 then

sbuf = append(sbuf, "WinME")

else

sbuf = append(sbuf, "Unknown")

end if

elsif plat = 2 then

sbuf = append(sbuf, "WinNT")

if maj = 6 and mine = 1 then

sbuf = append(sbuf, "Windows7")

elsif maj = 6 and mine = 0 then

sbuf = append(sbuf, "Vista")

elsif maj = 5 and mine = 1 or 2 then

sbuf = append(sbuf, "WinXP")

elsif maj = 5 and mine = 0 then

sbuf = append(sbuf, "Win2K")

elsif maj = 4 and mine = 0 then

sbuf = append(sbuf, "WinNT 4.0")

elsif maj = 3 and mine = 51 then

sbuf = append(sbuf, "WinNT 3.51")

elsif maj = 3 and mine = 50 then --is it 50 or 5?

sbuf = append(sbuf, "WinNT 3.5")

elsif maj = 3 and mine = 1 then

sbuf = append(sbuf, "WinNT 3.1")

else

sbuf = append(sbuf, sprintf("WinNT %d.%d", {maj,mine}))

end if

elsif plat = 3 then

sbuf = append(sbuf, "WinCE")

sbuf = append(sbuf, sprintf("WinCE %d.%d", {maj,mine}))

else

sbuf = append(sbuf, "Unknown Windows")

sbuf = append(sbuf, sprintf("Version %d.%d", {maj,mine}))

end if

sbuf = append(sbuf, peek_string(buf+20))

sbuf &= {plat, build, mine, maj}

return sbuf

else

return {}

end if

elsifdef UNIX then

else

end if

elsedef

return {"UNKNOWN"} --TODO

end ifdef

end function

--**

-- Decides whether the host system is a newer Windows version (NT/2K/XP/Vista).

--

-- Returns:

-- An **integer**, 1 if host system is a newer Windows (NT/2K/XP/Vista), else 0.

sequence s

s = uname()

return equal(s[1], "WinNT")

elsedef

end ifdef

end function

--****

-- Signature:

-- function getenv(sequence var_name)

--

-- Description:

-- Return the value of an environment variable.

--

-- Parameters:

-- # ##var_name## : a string, the name of the variable being queried.

--

-- Returns:

-- An **object**, -1 if the variable does not exist, else a sequence holding its value.

--

-- Comments:

--

-- Both the argument and the return value, may, or may not be, case sensitive. You might need to test this on your own system.

--

-- Example:

--

-- e = getenv("EUDIR")

-- -- e will be "C:\EUPHORIA" -- or perhaps D:, E: etc.

--

--

-- See Also:

-- [[:setenv]], [[:command_line]]

--**

-- Set an environment variable.

--

-- Parameters:

--

-- # ##name## : a string, the environment variable name

-- # ##val## : a string, the value to set to

-- # ##overwrite## : an integer, nonzero to overwrite an existing variable, 0 to disallow this.

--

-- Example 1:

--

-- ? setenv("NAME", "John Doe")

-- ? setenv("NAME", "Jane Doe")

-- ? setenv("NAME", "Jim Doe", 0)

--

--

-- See Also:

-- [[:getenv]], [[:unsetenv]]

end function

--**

-- Unset an environment variable

--

-- Parameters:

-- # ##name## : name of environment variable to unset

--

-- Example 1:

--

-- ? unsetenv("NAME")

--

--

-- See Also:

-- [[:setenv]], [[:getenv]]

end function

--****

-- Signature:

-- function platform()

--

-- Description:

-- Indicates the platform that the program is being executed on.

--

-- Returns:

-- An **integer**,

--

-- public constant

-- WIN32,

-- LINUX,

-- FREEBSD,

-- OSX,

-- SUNOS,

-- OPENBSD,

-- NETBSD,

-- FREEBSD

--

--

-- Comments:

-- The [[:ifdef statement]] is much more versatile and in most cases supersedes ##platform##().

--

-- ##platform##() used to be the way to execute different code depending on which platform the program

-- is running on. Additional platforms will be added as Euphoria is ported to new machines and

-- operating environments.

--

-- Example 1:

--

-- ifdef WIN32 then

-- -- call system Beep routine

-- err = c_func(Beep, {0,0})

-- elsedef

-- -- do nothing (Linux/FreeBSD)

-- end if

--

--

-- See Also:

-- [[:Platform-Specific Issues]], [[:ifdef statement]]

--****

-- === Interacting with the OS

--

--****

-- Signature:

-- procedure system(sequence command, integer mode=0)

--

-- Description:

-- Pass a command string to the operating system command interpreter.

--

-- Parameters:

-- # ##command## : a string to be passed to the shell

-- # ##mode## : an integer, indicating the manner in which to return from the call.

--

-- Errors:

-- ##command## should not exceed 1,024 characters.

--

-- Comments:

-- Allowable values for ##mode## are:

-- * 0: the previous graphics mode is restored and the screen is cleared.

-- * 1: a beep sound will be made and the program will wait for the user to press a key before the previous graphics mode is restored.

-- * 2: the graphics mode is not restored and the screen is not cleared.

--

-- ##mode## = 2 should only be used when it is known that the command executed by ##system##() will not change the graphics mode.

--

-- You can use Euphoria as a sophisticated "batch" (.bat) language by making calls to ##system##() and ##system_exec##().

--

-- ##system##() will start a new command shell.

--

-- ##system##() allows you to use command-line redirection of standard input and output in

-- ##command##.

--

-- Example 1:

--

-- system("copy temp.txt a:\\temp.bak", 2)

-- -- note use of double backslash in literal string to get

-- -- single backslash

--

--

-- Example 2:

--

-- system("eui \\test\\myprog.ex < indata > outdata", 2)

-- -- executes myprog by redirecting standard input and

-- -- standard output

--

--

-- See Also:

-- [[:system_exec]], [[:command_line]], [[:current_dir]], [[:getenv]]

--

--****

-- Signature:

-- function system_exec(sequence command, integer mode=0)

--

-- Description:

-- Try to run the a shell executable command

--

-- Parameters:

-- # ##command## : a string to be passed to the shell, representing an executable command

-- # ##mode## : an integer, indicating the manner in which to return from the call.

--

-- Returns:

-- An **integer**, basically the exit/return code from the called process.

--

-- Errors:

-- ##command## should not exceed 1,024 characters.

--

-- Comments:

--

-- Allowable values for ##mode## are:

-- * 0 ~-- the previous graphics mode is restored and the screen is cleared.

-- * 1 ~-- a beep sound will be made and the program will wait for the user to press a key before the previous graphics mode is restored.

-- * 2 ~-- the graphics mode is not restored and the screen is not cleared.

--

-- If it is not possible to run the program, ##system_exec##() will return -1.

--

-- On //WIN32//, ##system_exec##() will only run .exe and .com programs.

-- To run .bat files, or built-in shell commands, you need [[:system]](). Some commands,

-- such as DEL, are not programs, they are actually built-in to the command interpreter.

--

-- On //WIN32//, ##system_exec##() does not allow the use of command-line redirection in ##command##.

-- Nor does it allow you to quote strings that contain blanks, such as file names.

--

-- exit codes from Windows programs are normally in the range 0 to 255, with 0 indicating "success".

--

-- You can run a Euphoria program using ##system_exec##(). A Euphoria program can return an exit code using [[:abort]]().

--

-- ##system_exec##() does not start a new command shell.

--

-- Example 1:

--

-- integer exit_code

-- exit_code = system_exec("xcopy temp1.dat temp2.dat", 2)

--

-- if exit_code = -1 then

-- puts(2, "\n couldn't run xcopy.exe\n")

-- elsif exit_code = 0 then

-- puts(2, "\n xcopy succeeded\n")

-- else

-- printf(2, "\n xcopy failed with code %d\n", exit_code)

-- end if

--

--

-- Example 2:

--

-- -- executes myprog with two file names as arguments

-- if system_exec("eui \\test\\myprog.ex indata outdata", 2) then

-- puts(2, "failure!\n")

-- end if

--

--

-- See Also:

-- [[:system]], [[:abort]]

--

--****

-- === Miscellaneous

--**

-- Suspend thread execution. for ##t## seconds.

--

-- Parameters:

-- # ##t## : an atom, the number of seconds for which to sleep.

--

-- Comments:

-- The operating system will suspend your process and schedule other processes.

--

-- With multiple tasks, the whole program sleeps, not just the current task. To make

-- just the current task sleep, you can call ##[[:task_schedule]]([[:task_self]](), {i, i})##

-- and then execute [[:task_yield]](). Another option is to call [[:task_delay]]().

--

-- Example:

--

-- puts(1, "Waiting 15 seconds and a quarter...\n")

-- sleep(15.25)

-- puts(1, "Done.\n")

--

--

-- See Also:

-- [[:task_schedule]], [[:task_yield]], [[:task_delay]]

-- go to sleep for t seconds

-- allowing (on WIN32 and Linux) other processes to run

end if

--****

-- Signature:

-- function include_paths(integer convert)

--

-- Description:

-- Returns the list of include paths, in the order in which they are searched

--

-- Parameters:

-- # ##convert## : an integer, nonzero to include converted path entries

-- that were not validated yet.

--

-- Returns:

-- A **sequence**, of strings, each holding a fully qualified include path.

--

-- Comments:

--

-- ##convert## is checked only under //Windows//. If a path has accented characters in it, then

-- it may or may not be valid to convert those to the OEM code page. Setting ##convert## to a nonzero value

-- will force conversion for path entries that have accents and which have not been checked to be valid yet.

-- The extra entries, if any, are returned at the end of the returned sequence.

--

-- The paths are ordered in the order they are searched:

-- # current directory

-- # configuration file,

-- # command line switches,

-- # EUINC

-- # a default based on EUDIR.

--

-- Example 1:

--

-- sequence s = include_paths(0)

-- -- s might contain

-- {

-- "/usr/euphoria/tests",

-- "/usr/euphoria/include",

-- "./include",

-- "../include"

-- }

--

--

-- See Also:

-- [[:eu.cfg]], [[:include]], [[:option_switches]]