v/vlib/compiler/comptime.v

// Copyright (c) 2019-2020 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license
// that can be found in the LICENSE file.
module compiler

import (
	vweb.tmpl // for `$vweb_html()`
	os
	strings
)

fn (p mut Parser) comp_time() {
	p.check(.dollar)
	if p.tok == .key_if {
		p.check(.key_if)
		p.fspace()
		not := p.tok == .not
		if not {
			p.check(.not)
		}
		name := p.check_name()
		p.fspace()

		if name in supported_platforms {
			os := os_from_string(name)
			ifdef_name := os_name_to_ifdef(name)
			if name == 'mac' {
				p.warn('use `macos` instead of `mac`')
			}

			if not {
				if name == 'linux_or_macos' {
					p.genln('#if !defined(__linux__) && !defined(__APPLE__)')
				} else {
					p.genln('#ifndef $ifdef_name')
				}
			}
			else {
				if name == 'linux_or_macos' {
					p.genln('#if defined(__linux__) || defined(__APPLE__)')
				} else {
					p.genln('#ifdef $ifdef_name')
				}
			}

			p.check(.lcbr)
			if ((!not && os != p.os) || (not && os == p.os)) && !name.contains('_or_') &&
				 !p.scanner.is_fmt && !p.pref.output_cross_c {
				// `$if os {` for a different target, skip everything inside
				// to avoid compilation errors (like including <windows.h>
				// on non-Windows systems)
				mut stack := 1
				for {
					if p.tok == .key_return {
						p.returns = true
					}
					if p.tok == .lcbr {
						stack++
					}
					else if p.tok == .rcbr {
						stack--
					}
					if p.tok == .eof {
						break
					}
					if stack <= 0 && p.tok == .rcbr {
						// p.warn('exiting $stack')
						p.next()
						break
					}
					p.next()
				}
			}
			else {
				p.statements_no_rcbr()
			}
			if !(p.tok == .dollar && p.peek() == .key_else) {
				p.genln('#endif')
			}
		}
		else if name == 'x64' {
			p.comptime_if_block('TARGET_IS_64BIT', not)
		}
		else if name == 'x32' {
			p.comptime_if_block('TARGET_IS_32BIT', not)
		}
		else if name == 'big_endian' {
			p.comptime_if_block('TARGET_ORDER_IS_BIG', not)
		}
		else if name == 'little_endian' {
			p.comptime_if_block('TARGET_ORDER_IS_LITTLE', not)
		}
		else if name == 'debug' {
			p.comptime_if_block('VDEBUG', not)
		}
		else if name == 'prealloc' {
			p.comptime_if_block('VPREALLOC', not)
		}
		else if name == 'tinyc' {
			p.comptime_if_block('__TINYC__', not)
		}
		else if name == 'glibc' {
			p.comptime_if_block('__GLIBC__', not)
		}
		else if name == 'mingw' {
			p.comptime_if_block('__MINGW32__', not)
		}
		else if name == 'msvc' {
			p.comptime_if_block('_MSC_VER', not)
		}
		else if name == 'clang' {
			p.comptime_if_block('__clang__', not)
		}
		else if p.v.pref.compile_defines_all.len > 0 && name in p.v.pref.compile_defines_all {
			// Support for *optional* custom compile defines, i.e.:
			//
			// `[if custom]` => custom should be defined
			// `$if custom { // stuff }` => custom should be defined
			// `$if custom ? { // stuff }` => custom may not be defined
			//
			// Custom compile defines are given on the CLI, like this:
			// `v -d custom=0` => means that the custom will be defined,
			// but that it will be considered false.
			// `v -d custom=1`, which is equivalent to `v -d custom`,
			// means that the custom will be defined, and considered true.
			//
			// The ? sign, means that `custom` is optional, and when
			// it is not present at all at the command line, then the
			// block will just be ignored, instead of erroring.
			if p.tok == .question {
				p.next()
			}
			p.comptime_if_block('CUSTOM_DEFINE_${name}', not)
		} else {
			if p.tok == .question {
				p.next()
				p.comptime_if_block('CUSTOM_DEFINE_${name}', not)
			}else{
				println('Supported platforms:')
				println(supported_platforms)
				p.error('unknown platform `$name`')
			}
		}
		if_returns := p.returns
		p.returns = false
		// p.gen('/* returns $p.returns */')
		if p.tok == .dollar && p.peek() == .key_else {
			p.fspace()
			p.next()
			p.next()
			p.fspace() // spaces before and after $else
			p.check(.lcbr)
			p.genln('#else')
			p.statements_no_rcbr()
			p.genln('#endif')
			else_returns := p.returns
			p.returns = if_returns && else_returns
			// p.gen('/* returns $p.returns */')
		}
		else if p.tok == .key_else {
			p.error('use `$' + 'else` instead of `else` in comptime if statements')
		}
	}
	else if p.tok == .key_for {
		p.next()
		name := p.check_name()
		if name != 'field' {
			p.error('for field only')
		}
		p.check(.key_in)
		p.check_name()
		p.check(.dot)
		p.check_name() // fields
		p.check(.lcbr)
		// for p.tok != .rcbr && p.tok != .eof {
		res_name := p.check_name()
		println(res_name)
		p.check(.dot)
		p.check(.dollar)
		p.check(.name)
		p.check(.assign)
		_,val := p.tmp_expr()
		// p.bool_expression()
		// val := p.cgen.end_tmp()
		p.check(.rcbr)
		// }
	}
	else if p.tok == .name && p.lit == 'vweb' {
		// $vweb.html()
		// Compile vweb html template to V code, parse that V code and embed the resulting V functions
		// that returns an html string
		mut path := p.cur_fn.name + '.html'
		if p.pref.is_debug {
			println('>>> compiling vweb HTML template "$path"')
		}
		if !os.exists(path) {
			// Can't find the template file in current directory,
			// try looking next to the vweb program, in case it's run with
			// v path/to/vweb_app.v
			path = os.dir(p.scanner.file_path) + '/' + path
			if !os.exists(path) {
				p.error('vweb HTML template "$path" not found')
			}
		}
		p.check(.name) // skip `vweb.html()` TODO
		p.check(.dot)
		p.check(.name)
		p.check(.lpar)
		p.check(.rpar)
		v_code := tmpl.compile_template(path)
		if p.pref.verbosity.is_higher_or_equal(.level_three) {
			println('\n\n')
			println('>>> vweb template for ${path}:')
			println(v_code)
			println('>>> vweb template END')
			println('\n\n')
		}
		is_strings_imorted := p.import_table.known_import('strings')
		if !is_strings_imorted {
			p.register_import('strings', 0) // used by v_code
		}
		p.import_table.register_used_import('strings')
		p.genln('/////////////////// tmpl start')
		p.statements_from_text(v_code, false, path)
		p.genln('/////////////////// tmpl end')
		receiver := p.cur_fn.args[0]
		dot := if receiver.is_mut || receiver.ptr || receiver.typ.ends_with('*') { '->' } else { '.' }
		p.genln('vweb__Context_html( & $receiver.name /*!*/$dot vweb, tmpl_res)')
	}
	else {
		p.error('bad comp_time expression')
	}
}

// #include, #flag, #v
fn (p mut Parser) chash() {
	hash := p.lit.trim_space()
	// println('chsh() file=$p.file  hash="$hash"')
	p.next()
	p.fgen_nl()
	if hash.starts_with('flag ') {
		if p.first_pass() {
			mut flag := hash[5..]
			// expand `@VROOT` to its absolute path
			if flag.contains('@VROOT') {
				vmod_file_location := p.v.mod_file_cacher.get( p.file_path_dir )
				if vmod_file_location.vmod_file.len == 0 {
					// There was no actual v.mod file found.
					p.error_with_token_index('To use @VROOT, you need' +
						' to have a "v.mod" file in ${p.file_path_dir},' +
						' or in one of its parent folders.',
						p.cur_tok_index() - 1)
				}
				flag = flag.replace('@VROOT', vmod_file_location.vmod_folder )
			}
			for deprecated in ['@VMOD', '@VMODULE', '@VPATH', '@VLIB_PATH'] {
				if flag.contains(deprecated) {
					p.error('${deprecated} had been deprecated, use @VROOT instead.')
				}
			}
			// p.log('adding flag "$flag"')
			_ = p.table.parse_cflag(flag, p.mod, p.v.pref.compile_defines_all ) or {
				p.error_with_token_index(err, p.cur_tok_index() - 1)
				return
			}
		}
		return
	}
	if hash.starts_with('include') {
		if p.first_pass() && !p.is_vh {
			/*
			if !p.pref.building_v && !p.fileis('vlib') {
				p.warn('C #includes will soon be removed from the language' +
				'\ndefine the C structs and functions in V')
			}
			*/
			if p.file_pcguard.len != 0 {
				// println('p: $p.file_platform $p.file_pcguard')
				p.cgen.includes << '$p.file_pcguard\n#$hash\n#endif'
				return
			}
			p.cgen.includes << '#$hash'
			return
		}
	}
	// TODO remove after ui_mac.m is removed
	else if hash.contains('embed') {
		pos := hash.index('embed') or {
			return
		}
		file := hash[pos + 5..]
		// if p.pref.build_mode != .default_mode {
		p.genln('#include $file')
		// }
	}
	else if hash.contains('define') {
		// Move defines on top
		if p.first_pass() {
			p.cgen.includes << '#$hash'
		}
	}
	// // Don't parse a non-JS V file (`#-js` flag)
	else if hash == '-js' {
		$if js {
			for p.tok != .eof {
				p.next()
			}
		} $else {
			p.next()
		}
	}
	else {
		$if !js {
			if !p.can_chash {
				println('hash="$hash"')
				if hash.starts_with('include') {
					println('include')
				}
				else {
				}
				p.error('bad token `#` (embedding C code is no longer supported)')
			}
		}
		p.genln(hash)
	}
}

// `user.$method()` (`method` is a string)
fn (p mut Parser) comptime_method_call(typ Type) {
	p.cgen.cur_line = ''
	p.check(.dollar)
	var := p.check_name()
	mut j := 0
	for method in typ.methods {
		if method.typ != 'void' {
			continue
		}
		receiver := method.args[0]
		if !p.expr_var.ptr {
			p.error('`$p.expr_var.name` needs to be a reference')
		}
		amp := if receiver.is_mut && !p.expr_var.ptr { '&' } else { '' }
		if j > 0 {
			p.gen(' else ')
		}
		p.genln('if ( string_eq($var, _STR("$method.name")) ) ' + '${typ.name}_$method.name ($amp $p.expr_var.name);')
		j++
	}
	p.check(.lpar)
	p.check(.rpar)
	if p.tok == .key_orelse {
		p.check(.key_orelse)
		p.genln('else {')
		p.check(.lcbr)
		p.statements()
	}
}

fn (p mut Parser) gen_default_str_method_if_missing(typename string) (bool, string) {
	// NB: string_type_name can be != typename, if the base typename has str()
	mut string_type_name := typename
	typ := p.table.find_type(typename)
	is_varg := typename.starts_with('varg_')
	is_array := typename.starts_with('array_')
	is_struct := typ.cat == .struct_
	mut has_str_method := p.table.type_has_method(typ, 'str')
	if !has_str_method {
		if is_varg {
			p.gen_varg_str(typ)
			has_str_method = true
		}
		else if is_array {
			p.gen_array_str(typ)
			has_str_method = true
		}
		else if is_struct {
			p.gen_struct_str(typ)
			has_str_method = true
		}
		else {
			btypename := p.base_type(typ.name)
			if btypename != typ.name {
				base_type := p.find_type(btypename)
				if base_type.has_method('str'){
					string_type_name = base_type.name
					has_str_method = true
				}
			}
		}
	}
	return has_str_method, string_type_name
}

fn (p mut Parser) gen_array_str(typ Type) {
	if typ.has_method('str') {
		return
	}
	p.add_method(typ.name, Fn{
		name: 'str'
		typ: 'string'
		args: [Var{
			typ: typ.name
			is_arg: true
		}]
		is_method: true
		is_public: true
		receiver_typ: typ.name
	})
	elm_type := parse_pointer(typ.name[6..])
	elm_type2 := p.table.find_type(elm_type)
	is_array := elm_type.starts_with('array_')
	if is_array {
		p.gen_array_str(elm_type2)
	}
	else if p.typ_to_fmt(elm_type, 0) == '' && !p.table.type_has_method(elm_type2, 'str') {
		has_str_method, _ := p.gen_default_str_method_if_missing( elm_type )
		if !has_str_method {
			p.error('cant print []${elm_type}, unhandled print of ${elm_type}')
		}
	}
	p.v.vgen_buf.writeln('
pub fn (a $typ.name) str() string {
	mut sb := strings.new_builder(a.len * 3)
	sb.write("[")
	for i, elm in a {
		sb.write(elm.str())
		if i < a.len - 1 {
			sb.write(", ")
		}
	}
	sb.write("]")
	return sb.str()
}
	')
	p.cgen.fns << 'string ${typ.name}_str();'
}

// `Foo { bar: 3, baz: 'hi' }` => interpolated to string 'Foo { bar: 3, baz: "hi" }'
fn (p mut Parser) gen_struct_str(typ Type) {
	p.add_method(typ.name, Fn{
		name: 'str'
		typ: 'string'
		args: [Var{
			typ: typ.name
			is_arg: true
		}]
		is_method: true
		is_public: true
		receiver_typ: typ.name
	})
	mut sb := strings.new_builder(typ.fields.len * 20)
	sb.writeln('pub fn (a $typ.name) str() string {\nreturn')
	short_struct_name := typ.name.all_after('__')
	sb.writeln("'$short_struct_name {")
	for field in typ.fields {
		sb.writeln('\t$field.name: $' + 'a.${field.name}')
	}
	sb.writeln("}'")
	sb.writeln('}')
	p.v.vgen_buf.writeln(sb.str())
	// Need to manually add the definition to `fns` so that it stays
	// at the top of the file.
	// This function will get parsed by V after the main pass.
	p.cgen.fns << 'string ${typ.name}_str();'
}

fn (p mut Parser) gen_varg_str(typ Type) {
	elm_type := typ.name[5..]
	elm_type2 := p.table.find_type(elm_type)
	is_array := elm_type.starts_with('array_')
	if is_array {
		p.gen_array_str(elm_type2)
	}
	else if elm_type2.cat == .struct_ {
		p.gen_struct_str(elm_type2)
	}
	p.v.vgen_buf.writeln('
pub fn (a $typ.name) str() string {
	mut sb := strings.new_builder(a.len * 3)
	sb.write("[")
	for i, elm in a {
		sb.write(elm.str())
		if i < a.len - 1 {
			sb.write(", ")
		}
	}
	sb.write("]")
	return sb.str()
}')
	p.cgen.fns << 'string ${typ.name}_str();'
}

fn (p mut Parser) gen_array_filter(str_typ string, method_ph int) {
	/*
		// V
		a := [1,2,3,4]
		b := a.filter(it % 2 == 0)

		// C
		array_int a = ...;
		array_int tmp2 = new_array(0, 4, 4);
		for (int i = 0; i < a.len; i++) {
			int it = ((int*)a.data)[i];
			if (it % 2 == 0) array_push(&tmp2, &it);
		}
		array_int b = tmp2;
	*/
	val_type := parse_pointer(str_typ[6..])
	p.open_scope()
	p.register_var(Var{
		name: 'it'
		typ: val_type
	})
	p.next()
	p.check(.lpar)
	p.cgen.resetln('')
	tmp := p.get_tmp()
	a := p.expr_var.name
	p.cgen.set_placeholder(method_ph, '\n$str_typ $tmp = new_array(0, $a .len,sizeof($val_type));\n')
	p.genln('for (int i = 0; i < ${a}.len; i++) {')
	p.genln('$val_type it = (($val_type*)${a}.data)[i];')
	p.gen('if (')
	p.bool_expression()
	p.genln(') array_push(&$tmp, &it);')
	// p.genln(') array_push(&$tmp, &((($val_type*)${a}.data)[i]));')
	// p.genln(') array_push(&$tmp, ${a}.data + i * ${a}.element_size);')
	p.genln('}')
	p.gen(tmp) // TODO why does this `gen()` work?
	p.check(.rpar)
	p.close_scope()
}

fn (p mut Parser) gen_array_map(str_typ string, method_ph int) string {
	/*
		// V
		a := [1,2,3,4]
		b := a.map(it * 2)

		// C
		array_int a = ...;
		array_int tmp2 = new_array(0, 4, 4);
		for (int i = 0; i < a.len; i++) {
			int it = ((int*)a.data)[i];
			_PUSH(tmp2, it * 2, tmp3, int)
		}
		array_int b = tmp2;
	*/
	val_type := parse_pointer(str_typ[6..])
	p.open_scope()
	p.register_var(Var{
		name: 'it'
		typ: val_type
	})
	p.next()
	p.check(.lpar)
	p.cgen.resetln('')
	tmp := p.get_tmp()
	tmp_elm := p.get_tmp()
	a := p.expr_var.name
	map_type,expr := p.tmp_expr()
	p.cgen.set_placeholder(method_ph, '\narray $tmp = new_array(0, $a .len, ' + 'sizeof($map_type));\n')
	p.genln('for (int i = 0; i < ${a}.len; i++) {')
	p.genln('$val_type it = (($val_type*)${a}.data)[i];')
	p.genln('_PUSH(&$tmp, $expr, $tmp_elm, $map_type)')
	p.genln('}')
	p.gen(tmp) // TODO why does this `gen()` work?
	p.check(.rpar)
	p.close_scope()
	return 'array_' + stringify_pointer(map_type)
}

fn (p mut Parser) comptime_if_block(name string, not bool) {
	if not {
		p.genln('#ifndef $name')
	}else{
		p.genln('#ifdef $name')
	}
	p.check(.lcbr)
	p.statements_no_rcbr()
	if !(p.tok == .dollar && p.peek() == .key_else) {
		p.genln('#endif')
	}
}

fn (p mut Parser) gen_enum_flag_methods(typ mut Type) {
	for method in ['set', 'clear', 'toggle', 'has'] {
		typ.methods << Fn{
			name: method
			typ: if method == 'has' { 'bool' } else { 'void' }
			args: [Var{
				typ: typ.name
				is_mut: true
				is_arg: true
			}, Var{
				typ: typ.name
				is_arg: true
			}]
			is_method: true
			is_public: true
			receiver_typ: typ.name
		}
	}
	p.v.vgen_buf.writeln('
pub fn (e mut $typ.name) set(flag $typ.name)      { *e = int(*e) | (1 << int(flag)) }
pub fn (e mut $typ.name) clear(flag $typ.name)    { *e = int(*e) &~ (1 << int(flag)) }
pub fn (e mut $typ.name) toggle(flag $typ.name)   { *e = int(*e) ^ (1 << int(flag)) }
pub fn (e &$typ.name) has(flag $typ.name) bool { return int(*e)&(1 << int(flag)) != 0 }')
	p.cgen.fns << 'void ${typ.name}_set($typ.name *e, $typ.name flag);'
	p.cgen.fns << 'void ${typ.name}_clear($typ.name *e, $typ.name flag);'
	p.cgen.fns << 'void ${typ.name}_toggle($typ.name *e, $typ.name flag);'
	p.cgen.fns << 'bool ${typ.name}_has($typ.name *e, $typ.name flag);'
}