v/vlib/v
yuyi ece73836aa
cgen: fix error for struct with reference alias field (#13380)
2022-02-06 10:52:36 +02:00
..
ast v.parser, v.checker, v.gen: add support for [translated] tag (#13373) 2022-02-06 00:16:02 +02:00
builder strings: rename Builder.write_b() to Builder.write_byte(), add deprecation (#13313) 2022-01-28 20:34:44 +02:00
callgraph ast: rename 'table.get_type_symbol()' to 'table.sym()' and more related calls (#12898) 2021-12-19 18:25:18 +02:00
cflag all: update copyright year 2022-01-04 12:21:12 +03:00
checker v.parser, v.checker, v.gen: add support for [translated] tag (#13373) 2022-02-06 00:16:02 +02:00
depgraph all: update copyright year 2022-01-04 12:21:12 +03:00
doc token: rename Position to Pos, rename position() to pos() (#13279) 2022-01-26 12:36:28 +02:00
dotgraph js: add missing start_digraph() for the js backend (#12638) 2021-12-01 14:05:18 +02:00
embed_file parser,cgen: handle `const x = $embed_file("file.txt").to_string()` 2022-01-25 11:40:07 +02:00
errors token: rename Position to Pos, rename position() to pos() (#13279) 2022-01-26 12:36:28 +02:00
eval ci: fix more failing tests 2022-01-22 23:18:09 +02:00
fmt fmt: preserve formatting with comments in a empty map (#13362) 2022-02-05 10:05:35 +02:00
gen cgen: fix error for struct with reference alias field (#13380) 2022-02-06 10:52:36 +02:00
live ci: fix more failing tests 2022-01-22 23:18:09 +02:00
markused markused: fix `v -gc boehm -skip-unused cmd/vls` 2022-01-17 16:32:40 +02:00
mathutil math: move the `math.mathutil` generic `min`/`max`/`abs` fns to `math` (#13042) 2022-01-05 18:02:20 +02:00
parser v.parser, v.checker, v.gen: add support for [translated] tag (#13373) 2022-02-06 00:16:02 +02:00
pkgconfig ci: run the full V test suite on arm64 (#12865) 2021-12-16 17:44:21 +02:00
pref cgen,pref: support `-profile-fns strings__new_builder,i64_str -profile -` 2022-01-26 20:39:47 +02:00
preludes checker,cgen: implement v.profile.on/1, support `[if profile]` and `-d no_profile_startup` (#13232) 2022-01-21 03:26:05 +02:00
preludes_js preludes,builder,cgen: add support for VTEST_RUNNER=tap and -test-runner tap (#12523) 2021-12-16 15:59:46 +02:00
profile checker,cgen: implement v.profile.on/1, support `[if profile]` and `-d no_profile_startup` (#13232) 2022-01-21 03:26:05 +02:00
scanner token: rename Position to Pos, rename position() to pos() (#13279) 2022-01-26 12:36:28 +02:00
tests cgen: fix error for struct with reference alias field (#13380) 2022-02-06 10:52:36 +02:00
token token: rename Position to Pos, rename position() to pos() (#13279) 2022-01-26 12:36:28 +02:00
transformer token: rename Position to Pos, rename position() to pos() (#13279) 2022-01-26 12:36:28 +02:00
util v.util: use a normalised relative file path in the error messages with /, even on windows, to make the compiler error tests more robust 2022-02-04 17:56:08 +02:00
vcache cgen: support `-d no_segfault_handler` and `-d no_main`. Cleanup `-d trace_xxx` descriptions in CONTRIBUTING.md 2021-12-03 19:01:45 +02:00
vet token: rename Position to Pos, rename position() to pos() (#13279) 2022-01-26 12:36:28 +02:00
vmod v.vmod: return errors instead of panic-ing 2021-08-16 16:54:41 +03:00
README.md docs: adding skeleton README.md files for all vlib modules (#13034) 2022-01-05 18:06:08 +02:00
TEMPLATES.md tools: improve `v check-md` by checking for broken TOC headline links (#10417) 2021-06-14 13:12:02 +03:00
compiler_errors_test.v ci: skip vlib/v/checker/tests/modules/deprecated_module on windows for now 2022-01-27 15:38:52 +02:00

README.md

Description

v is a namespace for all of the V compiler modules.

The V compiler modules can be used by V programs that want to process V source code in different ways, in fact, that is how various V tools are implemented: v fmt, v doc, v ast, vls, as well as the V compiler itself.

Compiler pipeline

A simple high level explanation how the compiler pipeline (parser -> checker -> generator) works.

Reading files

Getting builtin files

To load all builtin files, a preference Preferences.lookup_path for the path where to look for exists. See Builder.get_builtin_files as example. If the file is a .vsh file and the backend is C, vlib/os will also be loaded as builtin.

Getting project files

Either there is a specific file: my_file.v or a directory containing V files. In the last case it scans that directory for all files. See Builder.v_files_from_dir as the helper method. This list of files needs to be filtered so that only *.v files exist.

Skips the following file types:

  • *_test.v
  • either *.c.v or *.c.js depending on the backend
  • all files that doesn't end with .v
  • Files that are not defined in Preferences.compile_defines or Preferences.compile_defines_all if any file is defined.

Parsing files

To parse something a new template is created as the first step:

import v.ast

table := ast.new_table()

a new preference is created:

import v.pref

pref := &pref.Preferences{}

and a new scope is created:

import v.ast

scope := ast.Scope{
	parent: 0
}

after that, you can parse your files.

Parse text

If you want to parse only text which isn't saved on the disk you can use this function.

import v.parser

code := ''
// table, pref and scope needs to be passed as reference
parsed_file := parser.parse_text(code, table, .parse_comments, &pref, &scope)

Parse a single file

For parsing files on disk, a path needs to be provided. The paths are collected one step earlier.

import v.parser

path := ''
// table, pref and scope needs to be passed as reference
parsed_file := parser.parse_file(path, table, .parse_comments, &pref, &scope)

Parse a set of files

If you have a batch of paths available which should be parsed, there is also a function which does all the work.

import v.parser

paths := ['']
// table, pref and scope needs to be passed as reference
parsed_files := parser.parse_files(paths, table, &pref, &scope)

Parse imports

A file often contains imports. These imports might need to be parsed as well. The builder contains a method which does this: Builder.parse_imports.

If the module which is imported isn't parsed already, you have to collect it relatively from the main file. For this the ast.File contains a list of imports. Those imports needs to be found on disk. . is just replaced with seperators in the relative location of the main file. Then all files from that directory are collected and parsed again like the previous steps explained.

Checking AST

A new checker is created:

import v.checker

mut checker := checker.new_checker(table, &pref)

After checking your files in checker.errors and checker.warnings you can see the results.

Check ast.File

checker.check(parsed_file)

Check a list of ast.File

checker.check_files(parsed_files)

Generate target from AST

Generating C code works just as this:

import v.gen.c

res := c.gen(parsed_files, table, &pref)