Module `OpamStubs`Source

OS-specific functions requiring C code on at least one platform.

Most functions are Windows-specific and raise an exception on other platforms.

include module type of struct include OpamStubsTypes end

Sourcetype console_screen_buffer_info = OpamStubsTypes.console_screen_buffer_info = {

size : int * int;
(*
Width and height of the screen buffer
*)
cursorPosition : int * int;
(*
Current position of the console cursor (caret)
*)
attributes : int;
(*
Screen attributes; see https://docs.microsoft.com/en-us/windows/console/console-screen-buffers#_win32_character_attributes
*)
window : int * int * int * int;
(*
Coordinates of the upper-left and lower-right corners of the display window within the screen buffer
*)
maximumWindowSize : int * int;
(*
Maximum displayable size of the console for this screen buffer
*)

}

CONSOLE_SCREEN_BUFFER_INFO struct (see https://docs.microsoft.com/en-us/windows/console/console-screen-buffer-info-str)

Sourcetype console_font_infoex = OpamStubsTypes.console_font_infoex = {

font : int;
(*
Index in the system's console font table
*)
fontSize : int * int;
(*
Size, in logical units, of the font
*)
fontFamily : int;
(*
Font pitch and family (low 8 bits only). See tmPitchAndFamily in https://msdn.microsoft.com/library/windows/desktop/dd145132
*)
fontWeight : int;
(*
Font weight. Normal = 400; Bold = 700
*)
faceName : string;
(*
Name of the typeface
*)

}

CONSOLE_FONT_INFOEX struct (see https://docs.microsoft.com/en-us/windows/console/console-font-infoex)

Sourcetype handle = OpamStubsTypes.handle

Win32 API handles

Sourcetype stdhandle = OpamStubsTypes.stdhandle =

| STD_INPUT_HANDLE
| STD_OUTPUT_HANDLE
| STD_ERROR_HANDLE

Standard handle constants (see https://docs.microsoft.com/en-us/windows/console/getstdhandle)

Sourcetype registry_root = OpamStubsTypes.registry_root =

| HKEY_CLASSES_ROOT
| HKEY_CURRENT_CONFIG
| HKEY_CURRENT_USER
| HKEY_LOCAL_MACHINE
| HKEY_USERS

Win32 Root Registry Hives (see https://msdn.microsoft.com/en-us/library/windows/desktop/ms724836.aspx)

Sourcetype _ registry_value = _ OpamStubsTypes.registry_value =

| REG_SZ : string registry_value

Win32 Registry Value Types (see https://msdn.microsoft.com/en-us/library/windows/desktop/ms724884.aspx

Sourcetype ('a, 'b, 'c) winmessage = ('a, 'b, 'c) OpamStubsTypes.winmessage =

| WM_SETTINGCHANGE : (int, string, int) winmessage
(*
See https://msdn.microsoft.com/en-us/library/windows/desktop/ms725497.aspx
*)

Windows Messages (at least, one of them!)

Sourcetype windows_cpu_architecture = OpamStubsTypes.windows_cpu_architecture =

| AMD64
| ARM
| ARM64
| IA64
| Intel
| Unknown

Windows CPU Architectures (SYSTEM_INFO.wProcessArchitecture / sysinfoapi.h)

Source

type win32_non_fixed_version_info = OpamStubsTypes.win32_non_fixed_version_info =
  {

comments : string option;
companyName : string option;
fileDescription : string option;
fileVersionString : string option;
internalName : string option;
legalCopyright : string option;
legalTrademarks : string option;
originalFilename : string option;
productName : string option;
productVersionString : string option;
privateBuild : string option;
specialBuild : string option;

}

Predefined version information strings (see VerQueryValueW)

Sourcetype win32_version_info = OpamStubsTypes.win32_version_info = {

signature : int;
(*
0xFEEF04BD
*)
version : int * int;
(*
Structure version number
*)
fileVersion : int * int * int * int;
(*
File version
*)
productVersion : int * int * int * int;
(*
Product version
*)
fileFlagsMask : int;
(*
Valid bits in fileFlags
*)
fileFlags : int;
(*
File attributes (see VS_FIXEDFILEINFO)
*)
fileOS : int;
(*
File OS (see VS_FIXEDFILEINFO)
*)
fileType : int;
(*
File Type (see VS_FIXEDFILEINFO)
*)
fileSubtype : int;
(*
File Sub-type (see VS_FIXEDFILEINFO)
*)
fileDate : int64;
(*
File creation time stamp
*)
strings : ((int * int) * win32_non_fixed_version_info) list;
(*
Non-fixed string table. First field is a pair of Language and Codepage ID.
*)

}

VS_FIXEDFILEINFO

Sourceval is_executable : string -> bool

faccessat on Unix; _waccess on Windows. Checks whether a path is executable for the current process. On Unix, unlike Unix.access, this is checked using the EUID/EGID rather than RUID/RGID.

Sourceval getpid : unit -> int

On Windows, this returns the actual process ID, rather than the non-unique faked process ID returned by the Microsoft C Runtime (see https://caml.inria.fr/mantis/view.php?id=4034).

On all other platforms, this is just an alias for Unix.getpid.

Sourceval getCurrentProcessID : unit -> int32

Windows only. As getpid, but without the possibility of truncating the ID on 32-bit platforms.

Sourceval getStdHandle : stdhandle -> handle

Windows only. Return a standard handle.

Sourceval getConsoleScreenBufferInfo : handle -> console_screen_buffer_info

Windows only. Return current Console screen buffer information.

Sourceval setConsoleTextAttribute : handle -> int -> unit

Windows only. Set the console's text attribute setting.

Sourceval fillConsoleOutputCharacter : handle -> char -> int -> (int * int) -> bool

Windows only. fillConsoleOutputCharacter buffer c n (x, y) writes c n times starting at the given coordinate (and wrapping if required).

Sourceval getConsoleMode : handle -> int

Windows only. Returns the input/output mode of the console screen buffer referred to by the handle.

raises Not_found
If the handle does not refer to a console.

Sourceval setConsoleMode : handle -> int -> bool

Windows only. Sets the input/output mode of the console screen buffer referred to by the handle, returning true if the operation isr successful.

Sourceval getWindowsVersion : unit -> int * int * int * int

Windows only. Returns the Windows version as (major, minor, build, revision). This function only works if opam is compiled OCaml 4.06.0 or later, it returns (0, 0, 0, 0) otherwise.

Sourceval getArchitecture : unit -> windows_cpu_architecture

Windows only. Equivalent of uname -m.

Sourceval waitpids : int list -> int -> int * Unix.process_status

Windows only. Given a list pids with length elements, waitpids pids length behaves like Unix.wait, returning the pid and exit status of the first process to terminate.

Source

val readRegistry : 
  registry_root ->
  string ->
  string ->
  'a registry_value ->
  'a option

Windows only. readRegistry root key name value_type reads the value name from registry key key of root. As per Windows Registry convention, the default value can be read by passing "" for name.

raises Failure
If the value in the registry does not have value_type

Source

val enumRegistry : 
  registry_root ->
  string ->
  'a registry_value ->
  (string * 'a) list

Windows only. enumRegistry root key value_type reads all the values from registry key key of root which have type value_type.

Returns [] if the key is not found.

Source

val writeRegistry : 
  registry_root ->
  string ->
  string ->
  'a registry_value ->
  'a ->
  unit

Windows only. writeRegistry root key name value_type value sets the value name of type value_type in registry key key of root to value.

raises Failure
If the value could not be set.

raises Not_found
If key does not exist.

Sourceval getConsoleOutputCP : unit -> int

Windows only. Retrieves the current Console Output Code Page.

Sourceval getCurrentConsoleFontEx : handle -> bool -> console_font_infoex

Windows only. Gets information on the current console output font.

Sourceval create_glyph_checker : string -> handle * handle

Windows only. Given a font name, returns a pair consisting of a screen DC and a font object, which will have been selected into the DC.

raises Failure
If anything goes wrong with the GDI calls.

Sourceval delete_glyph_checker : (handle * handle) -> unit

Windows only. Given (dc, font), deletes the font object and releases the DC.

Sourceval has_glyph : (handle * handle) -> Uchar.t -> bool

Windows only. has_glyph (dc, font) scalar returns true if font contains a glyph for scalar.

raises Failure
If the call to GetGlyphIndicesW fails.

Sourceval getProcessArchitecture : int32 option -> windows_cpu_architecture

Windows only. Returns the CPU architecture of the given process ID (or the current process).

Sourceval process_putenv : int32 -> string -> string -> bool

Windows only. process_putenv pid name value sets the environment variable name to value in given process ID (Unix.putenv must also be called to update the value in the current process). This function must not be called if the target process is 32-bit and the current process is 64-bit or vice versa (outcomes vary from a no-op to a segfault).

Sourceval getPathToHome : unit -> string

Sourceval getPathToSystem : unit -> string

Sourceval getPathToLocalAppData : unit -> string

Windows only. retrieves the location of the wanted directory

Source

val sendMessageTimeout : 
  nativeint ->
  int ->
  int ->
  ('a, 'b, 'c) winmessage ->
  'a ->
  'b ->
  int * 'c

Windows only. sendMessageTimeout hwnd timeout flags message wParam lParam sends a message to the given handle, but is guaranteed to return within timeout milliseconds. The result consists of two parts, fst is the return value from SendMessageTimeout, snd depends on both the message and fst. See https://msdn.microsoft.com/en-us/library/windows/desktop/ms644952.aspx

Sourceval getProcessAncestry : unit -> (int32 * string) list

Windows only. Returns the pid and full path to the image for each entry in the ancestry list for this process, starting with the process itself. If an image name can't be determined, then "" is returned; on failure, returns [].

Sourceval getConsoleAlias : string -> string -> string

Windows only. getConsoleAlias alias exeName retrieves the value for a given executable or "" if the alias is not defined. See https://docs.microsoft.com/en-us/windows/console/getconsolealias

Source

val win_create_process : 
  string ->
  string ->
  string option ->
  Unix.file_descr ->
  Unix.file_descr ->
  Unix.file_descr ->
  int

Windows only. Provided by OCaml's win32unix library.

Sourceval getConsoleWindowClass : unit -> string option

Windows only. Returns the name of the class for the Console window or None if there is no console.

Sourceval setErrorMode : int -> int

Windows only. Directly wraps SetErrorMode.

Sourceval getErrorMode : unit -> int

Windows only. Directly wraps GetErrorMode.

Sourceval setConsoleToUTF8 : unit -> unit

Windows only. Directly wraps SetConsoleOutputCP(CP_UTF8).

Sourceval getVersionInfo : string -> win32_version_info option

Windows only. Returns the version info block for a file or None if the file either doesn't exist or doesn't have one.

Sourceval get_initial_environment : unit -> string list

Windows only. Returns the environment which new processes would receive.

Sourceval get_stdout_ws_col : unit -> int

Unix only. Returns the number of columns of the current terminal window linked with stdout. If stdout isn't linked to any terminal (e.g. redirection), then this function will return 0. A valid number of columns should be strictly above 0.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/opam-core/OpamStubs/index.html

Module `OpamStubs`Source

package opam-core

Install

Dune Dependency

Authors

Maintainers

Sources

doc/opam-core/OpamStubs/index.html

Module OpamStubsSource

Module `OpamStubs`Source