Module generator.html

generator.html
Version:
0.0.1
License:
MIT
Dependencies from vmod:
2
Imports:
16
Imported by:
1
Repository:
OS-specific
Show selected OS-specific symbols.
Backend-specific
Show selected Backend-specific symbols.

Dependencies defined in v.mod

  • srackham.pcre2
  • markdown

Imported by

Aliases

This section is empty.

Constants

This section is empty.

Sum types

This section is empty.

Functions

This section is empty.

Structs

#struct Generator

pub struct Generator {
	mode        generator.GenerateMode
	base_url    string
	multiverse  mods.Multiverse // all universes to resolve references
	universe    mods.Universe   // universe to generate
	output      string
	no_overview bool
	root_dir    string
	repo_path   string
	max_cores   int
mut:
	current_module &mods.Module      = unsafe { nil }
	ctx            generator.Context = generator.Context{
		buf: strings.new_builder(1000)
	}

	file_cache       map[string][]string
	needs_playground bool // when page contains code blocks in description
}

#fn (&Generator) copy_assets

fn (g &Generator) copy_assets()

#fn (&Generator) generate

fn (mut g &Generator) generate()

#fn (&Generator) generate_universe_page

fn (mut g &Generator) generate_universe_page(universe mods.Universe)

#fn (&Generator) generate_single

fn (mut g &Generator) generate_single(mod mods.Module)

#fn (&Generator) create_module_breadcrumbs

fn (mut g &Generator) create_module_breadcrumbs(mod mods.Module) []generator.Breadcrumb

#fn (&Generator) create_universe_output_path

fn (mut g &Generator) create_universe_output_path(universe mods.Universe) string

#fn (&Generator) create_universe_url

fn (mut _ &Generator) create_universe_url(universe mods.Universe) string

#fn (&Generator) create_output_path

fn (mut g &Generator) create_output_path(mod mods.Module) string

#fn (&Generator) create_module_url

fn (mut _ &Generator) create_module_url(mod mods.Module) string

#fn (&Generator) generate_module

fn (mut g &Generator) generate_module(mod mods.Module)

#fn (&Generator) generate_alias

fn (mut g &Generator) generate_alias(alias symbols.Alias)

#fn (&Generator) generate_constant

fn (mut g &Generator) generate_constant(constant symbols.Constant)

#fn (&Generator) generate_sum_type

fn (mut g &Generator) generate_sum_type(sum_type symbols.SumType)

#fn (&Generator) generate_function

fn (mut g &Generator) generate_function(fun symbols.Function)

#fn (&Generator) generate_method

fn (mut g &Generator) generate_method(fun symbols.Method)

#fn (&Generator) create_receiver

fn (mut g &Generator) create_receiver(table &v.ast.Table, receiver v.ast.Param, without_name bool) string

#fn (&Generator) create_signature

fn (mut g &Generator) create_signature(table &v.ast.Table, params []v.ast.Param, result v.ast.Type, without_names bool) string

#fn (&Generator) generate_struct

fn (mut g &Generator) generate_struct(strukt symbols.Struct)

#fn (&Generator) generate_enum

fn (mut g &Generator) generate_enum(enums symbols.Enum)

#fn (&Generator) generate_interface

fn (mut g &Generator) generate_interface(iface symbols.Interface)

#fn (&Generator) generate_type

fn (mut g &Generator) generate_type(table &v.ast.Table, t v.ast.Type)

#fn (&Generator) resolve_symbol

fn (mut g &Generator) resolve_symbol(name string, parent symbols.NamedSymbol) ?symbols.NamedSymbol

#fn (&Generator) resolve_type

fn (mut g &Generator) resolve_type(name string, parent symbols.NamedSymbol) ?symbols.NamedSymbol

#fn (&Generator) create_comment

fn (mut g &Generator) create_comment(parent symbols.NamedSymbol, comments symbols.Comments) string

#fn (&Generator) preprocess_examples

fn (mut _ &Generator) preprocess_examples(text string) string

#fn (&Generator) create_module_name

fn (mut g &Generator) create_module_name(name string) string

#fn (&Generator) create_source

fn (mut g &Generator) create_source(sym symbols.NamedSymbol) string

#fn (&Generator) is_cross_backend

fn (mut g &Generator) is_cross_backend(sym symbols.NamedSymbol) bool

#fn (&Generator) is_cross_platform

fn (mut _ &Generator) is_cross_platform(sym symbols.NamedSymbol) bool

#fn (&Generator) platform_class

fn (mut _ &Generator) platform_class(sym symbols.NamedSymbol) string

#fn (&Generator) backend_class

fn (mut _ &Generator) backend_class(sym symbols.NamedSymbol) string

#fn (&Generator) create_code_header

fn (mut _ &Generator) create_code_header(sym symbols.NamedSymbol) string

#fn (&Generator) create_platform_attributes

fn (mut _ &Generator) create_platform_attributes(sym symbols.NamedSymbol) map[string]string

#fn (&Generator) create_attributes

fn (mut g &Generator) create_attributes(sym symbols.NamedSymbol) string

#fn (&Generator) create_generics_list_from_types

fn (mut g &Generator) create_generics_list_from_types(table &v.ast.Table, list []v.ast.Type) string

#fn (&Generator) create_generics_list

fn (mut _ &Generator) create_generics_list(list []string) string

#fn (&Generator) create_id

fn (mut _ &Generator) create_id(sym symbols.NamedSymbol) string

#fn (&Generator) convert_markdown

fn (mut _ &Generator) convert_markdown(s string) string

#fn (&Generator) write

fn (mut g &Generator) write(s string)

#fn (&Generator) writeln

fn (mut g &Generator) writeln(s string)

#fn (&Generator) create_h3_title

fn (mut _ &Generator) create_h3_title(content string, id string) string

#fn (&Generator) wrap_code

fn (mut _ &Generator) wrap_code(s string) string

#fn (&Generator) keyword

fn (mut _ &Generator) keyword(s string) string

#fn (&Generator) load_file

fn (mut g &Generator) load_file(path string) []string

#fn (&Generator) code

fn (mut g &Generator) code(symbol symbols.NamedSymbol, pos v.token.Pos) string

#fn (&Generator) highlight_code

fn (mut g &Generator) highlight_code(code string, skip_resolve bool) string

#fn (&Generator) copy

fn (g &Generator) copy() Generator

Interfaces

This section is empty.

Enums

This section is empty.