Module v.util stdlib

v.util
Version:
0.3.3
License:
MIT
Dependencies from vmod:
0
Imports:
12
Imported by:
20
Repository:
OS-specific
Show selected OS-specific symbols.
Backend-specific
Show selected Backend-specific symbols.

Dependencies defined in v.mod

This section is empty.

Aliases

This section is empty.

Constants

#constant emanager

emanager = new_error_manager()

emanager.support_color - should the error and other messages have ANSI terminal escape color codes in them.

By default, v tries to autodetect, if the terminal supports colors.

Use -color and -nocolor options to override the detection decision.

#constant builtin_module_parts

builtin_module_parts = ['math.bits', 'strconv', 'dlmalloc', 'strconv.ftoa', 'strings', 'builtin']

math.bits is needed by strconv.ftoa

#constant bundle_modules

bundle_modules       = ['clipboard', 'fontstash', 'gg', 'gx', 'sokol', 'szip', 'ui']

math.bits is needed by strconv.ftoa

#constant external_module_dependencies_for_tool

external_module_dependencies_for_tool = {
	'vdoc': ['markdown']
}

#constant nr_jobs

pub const nr_jobs = runtime.nr_jobs()

Sum types

This section is empty.

Functions

#fn args_quote_paths

fn args_quote_paths(args []string) string

#fn bold

fn bold(msg string) string

#fn cached_file2sourcelines

fn cached_file2sourcelines(path string) []string

#fn cached_read_source_file

unsafe
fn cached_read_source_file(path string) !string

#fn cescaped_path

fn cescaped_path(s string) string

#fn check_module_is_installed

fn check_module_is_installed(modulename string, is_verbose bool) !bool

#fn color

fn color(kind string, msg string) string

#fn color_compare_files

fn color_compare_files(diff_cmd string, file1 string, file2 string) string

#fn color_compare_strings

fn color_compare_strings(diff_cmd string, unique_prefix string, expected string, found string) string

#fn contains_capital

fn contains_capital(s string) bool

#fn ensure_modules_for_all_tools_are_installed

fn ensure_modules_for_all_tools_are_installed(is_verbose bool)

#fn find_all_v_files

fn find_all_v_files(roots []string) ![]string

find_all_v_files - given a list of files/folders, finds all .v/.vsh files if some of the files/folders on the list does not exist, or a file is not a .v or .vsh file, returns an error instead.

#fn find_working_diff_command

fn find_working_diff_command() !string

iterates through a list of known diff cli commands and returns it with basic options

#fn formatted_error

fn formatted_error(kind string, omsg string, filepath string, pos v.token.Pos) string

formatted_error - kind may be 'error' or 'warn'

#fn free_caches

fn free_caches()

free_caches knows about all util caches and makes sure that they are freed if you add another cached unsafe function using static, do not forget to add a mechanism to clear its cache, and call it here.

#fn get_timers

fn get_timers() &Timers

#fn get_vtmp_folder

fn get_vtmp_folder() string

get_vtmp_folder returns the path to a folder, that is writable to V programs, and specific to the user. It can be overriden by setting the env variable VTMP.

#fn good_type_name

direct_array_access
fn good_type_name(s string) bool

HTTPRequest bad HttpRequest good

#fn highlight_suggestion

fn highlight_suggestion(message string) string

highlight_suggestion returns a colorfull/highlighted version of message, but only if the standart error output allows for color messages, otherwise the plain message will be returned.

#fn is_func_char

inline
fn is_func_char(c u8) bool

#fn is_generic_type_name

direct_array_accessinline
fn is_generic_type_name(name string) bool

is_generic_type_name returns true if the current token is a generic type name.

#fn is_name_char

inline
fn is_name_char(c u8) bool

#fn join_env_vflags_and_os_args

fn join_env_vflags_and_os_args() []string

#fn launch_tool

noreturn
fn launch_tool(is_verbose bool, tool_name string, args []string)

launch_tool - starts a V tool in a separate process, passing it the args.

All V tools are located in the cmd/tools folder, in files or folders prefixed by the letter v, followed by the tool name, i.e. cmd/tools/vdoc/ or cmd/tools/vpm.v.

The folder variant is suitable for larger and more complex tools, like v doc, because it provides you the ability to split their source in separate .v files, organized by topic, as well as have resources like static css/text/js files, that the tools can use.

launch_tool uses a timestamp based detection mechanism, so that after v self, each tool will be recompiled too, before it is used, which guarantees that it would be up to date with V itself. That mechanism can be disabled by package managers by creating/touching a small cmd/tools/.disable_autorecompilation file, OR by changing the timestamps of all executables in cmd/tools to be < 1024 seconds (in unix time).

#fn module_is_builtin

fn module_is_builtin(mod string) bool

#fn new_error_manager

fn new_error_manager() &EManager

#fn new_suggestion

fn new_suggestion(wanted string, possibilities []string) Suggestion

new_suggestion creates a new Suggestion, given a wanted value and a list of possibilities.

#fn no_cur_mod

fn no_cur_mod(typename string, cur_mod string) string

no_cur_mod - removes cur_mod. prefix from typename, but only when it is at the start, i.e.:

no_cur_mod('vproto.Abdcdef', 'proto') == 'vproto.Abdcdef' even though proto. is a substring

#fn no_dots

fn no_dots(s string) string

#fn path_of_executable

fn path_of_executable(path string) string

#fn path_styled_for_error_messages

fn path_styled_for_error_messages(path string) string

path_styled_for_error_messages converts the given file path, into one suitable for displaying in error messages, produced by the V compiler.

When the file path is prefixed by the working folder, usually that means, that the resulting path, will be relative to the current working folder. Relative paths are shorter and stabler, because they only depend on the project, and not on the parent folders.

If the current working folder of the compiler is NOT a prefix of the given path, then this function will return an absolute path instead. Absolute paths are longer, and also platform/user dependent, but they have the advantage of being more easily processible by tools on the same machine.

The V user can opt out of that relativisation, by setting the environment variable VERROR_PATHS, to absolute. That is useful for starting the V compiler from an IDE or another program, where the concept of a "current working folder", is not as clear as working manually with the compiler in a shell. By setting VERROR_PATHS=absolute, the IDE/editor can ensure, that the produced error messages will have file locations that are easy to find and jump to locally.

NOTE: path_styled_for_error_messages will always use / in the error paths, no matter the OS, to ensure stable compiler error output in the tests.

#fn prepare_tool_when_needed

fn prepare_tool_when_needed(source_name string)

#fn qualify_import

fn qualify_import(pref_ &v.pref.Preferences, mod string, file_path string) string

2022-01-30 qualify_import - used by V's parser, to find the full module name of import statements 2022-01-30 i.e. when parsing import automaton inside a .v file in examples/game_of_life/life_gg.v 2022-01-30 it returns just 'automaton' 2022-01-30 TODO: this seems to always just return mod itself, for modules inside the V main folder.

2022-01-30 It does also return mod itself, for stuff installed in ~/.vmodules like vls but for 2022-01-30 other reasons (see res 2 below).

#fn qualify_module

fn qualify_module(pref_ &v.pref.Preferences, mod string, file_path string) string

2022-01-30 qualify_module - used by V's parser to find the full module name 2022-01-30 i.e. when parsing module textscanner, inside vlib/strings/textscanner/textscanner.v 2022-01-30 it will return strings.textscanner

#fn quote_path

fn quote_path(s string) string

#fn read_file

fn read_file(file_path string) !string

#fn recompile_file

fn recompile_file(vexe string, file string)

#fn replace_op

fn replace_op(s string) string

#fn resolve_env_value

fn resolve_env_value(str string, check_for_presence bool) !string

resolve_env_value replaces all occurrences of $env('ENV_VAR_NAME') in str with the value of the env variable $ENV_VAR_NAME.

#fn resolve_vmodroot

fn resolve_vmodroot(str string, dir string) !string

#fn set_source_for_path

fn set_source_for_path(path string, source string) []string

set_source_for_path should be called for every file, over which you want to use util.formatted_error

#fn set_vroot_folder

fn set_vroot_folder(vroot_path string)

#fn short_module_name

fn short_module_name(name string) string

short_module_name returns a shortened version of the fully qualified name, i.e. xyz.def.abc.symname -> abc.symname

#fn should_bundle_module

fn should_bundle_module(mod string) bool

#fn should_recompile_tool

fn should_recompile_tool(vexe string, tool_source string, tool_name string, tool_exe string) bool

Note: should_recompile_tool/4 compares unix timestamps that have 1 second resolution That means that a tool can get recompiled twice, if called in short succession.

TODO: use a nanosecond mtime timestamp, if available.

#fn show_compiler_message

fn show_compiler_message(kind string, err v.errors.CompilerMessage)

#fn skip_bom

JavaScript
fn skip_bom(file_content string) string

#fn skip_bom

fn skip_bom(file_content string) string

#fn smart_quote

direct_array_access
fn smart_quote(str string, raw bool) string

#fn source_file_context

fn source_file_context(kind string, filepath string, pos v.token.Pos) []string

#fn strip_main_name

fn strip_main_name(name string) string

#fn strip_mod_name

fn strip_mod_name(name string) string

#fn tabs

fn tabs(n int) string

#fn timing_measure

fn timing_measure(label string)

#fn timing_measure_cumulative

fn timing_measure_cumulative(label string)

#fn timing_set_should_print

fn timing_set_should_print(should_print bool)

#fn timing_start

fn timing_start(label string)

#fn verror

noreturn
fn verror(kind string, s string)

#fn vlines_escape_path

fn vlines_escape_path(path string, ccompiler string) string

Structs

#struct EManager

pub struct EManager {
mut:
	support_color bool
}

#fn (&EManager) set_support_color

fn (e &EManager) set_support_color(b bool)

#struct Surrounder

noinit
pub struct Surrounder {
mut:
	befores []string
	afters  []string
}

#fn new_surrounder

fn new_surrounder(expected_length int) Surrounder

new_surrounder creates a new Surrounder instance.

The expected_length is a hint for the initial capacity for the befores/afters stacks.

#fn (&Surrounder) add

fn (mut s &Surrounder) add(before string, after string)

add appends a before/after pair to the surrounder When you call .after() or .builder_write_afters(), all before parts will be in order, while all after parts, will be in reverse order.

#fn (&Surrounder) before

manualfree
fn (s &Surrounder) before() string

before returns all the before parts that were accumulated so far

#fn (&Surrounder) after

manualfree
fn (s &Surrounder) after() string

after returns all the after parts that were accumulated so far, in reverse order of their addition.

#fn (&Surrounder) builder_write_befores

fn (s &Surrounder) builder_write_befores(mut sb &strings.Builder)

builder_write_befores writeln-es all the before parts into the given string builder sb.

#fn (&Surrounder) builder_write_afters

fn (s &Surrounder) builder_write_afters(mut sb &strings.Builder)

builder_write_afters writeln-es all the after parts into the given string builder sb. They will be written there in reverse order, compared to how/when they were added.

#fn (&Surrounder) free

unsafe
fn (mut s &Surrounder) free()

free frees the private resources associated with the surrounder instance Called automatically by -autofree, or in [manualfree] tagged functions.

#struct Timers

heap
pub struct Timers {
	label string
pub mut:
	swatches     map[string]time.StopWatch
	should_print bool
	// already_shown records for which of the swatches .show() or .show_if_exists() had been called already
	already_shown []string
}

#fn new_timers

fn new_timers(params TimerParams) &Timers

#fn (&Timers) start

fn (mut t &Timers) start(name string)

#fn (&Timers) measure

fn (mut t &Timers) measure(name string) i64

#fn (&Timers) measure_cumulative

fn (mut t &Timers) measure_cumulative(name string) i64

#fn (&Timers) measure_pause

fn (mut t &Timers) measure_pause(name string)

#fn (&Timers) measure_resume

fn (mut t &Timers) measure_resume(name string)

#fn (&Timers) message

fn (mut t &Timers) message(name string) string

#fn (&Timers) show

fn (mut t &Timers) show(label string)

#fn (&Timers) show_if_exists

fn (mut t &Timers) show_if_exists(label string)

#fn (&Timers) show_remaining

fn (mut t &Timers) show_remaining()

#fn (&Timers) dump_all

fn (mut t &Timers) dump_all()

#struct TimerParams

params
pub struct TimerParams {
	should_print bool
	label        string
}

Interfaces

This section is empty.

Enums

This section is empty.