wails/v2/pkg/parser/field.go

package parser

import (
	"fmt"
	"go/ast"
	"strings"

	"github.com/fatih/structtag"
)

// Field defines a parsed struct field
type Field struct {

	// Name of the field
	Name string

	// The type of the field.
	// "struct" if it's a struct
	Type string

	// A pointer to the struct if the Type is "struct"
	Struct *Struct

	// User comments on the field
	Comments []string

	// Indicates if the Field is an array of type "Type"
	IsArray bool

	// JSON field name defined by a json tag
	JSONOptions
}

type JSONOptions struct {
	Name       string
	IsOptional bool
	Ignored    bool
}

// JSType returns the Javascript type for this field
func (f *Field) JSType() string {
	return string(goTypeToJS(f))
}

// JSName returns the Javascript name for this field
func (f *Field) JSName() string {
	if f.JSONOptions.Name != "" {
		return f.JSONOptions.Name
	}
	return f.Name
}

// TSName returns the Typescript name for this field
func (f *Field) TSName() string {
	result := f.Name
	if f.JSONOptions.Name != "" {
		result = f.JSONOptions.Name
	}
	if f.IsOptional {
		result += "?"
	}
	return result
}

// AsTSDeclaration returns a TS definition of a single type field
func (f *Field) AsTSDeclaration(pkgName string) string {
	return f.TSName() + ": " + f.TypeAsTSType(pkgName)
}

// NameForPropertyDoc returns a formatted name for the jsdoc @property declaration
func (f *Field) NameForPropertyDoc() string {
	if f.IsOptional {
		return "[" + f.JSName() + "]"
	}
	return f.JSName()
}

// TypeForPropertyDoc returns a formatted name for the jsdoc @property declaration
func (f *Field) TypeForPropertyDoc() string {
	result := goTypeToJS(f)
	if f.IsArray {
		result += "[]"
	}
	return result
}

// TypeAsTSType converts the Field type to something TS wants
func (f *Field) TypeAsTSType(pkgName string) string {
	var result = ""
	switch f.Type {
	case "string":
		result = "string"
	case "int", "int8", "int16", "int32", "int64", "uint", "uint8", "uint16", "uint32", "uint64":
		result = "number"
	case "float32", "float64":
		result = "number"
	case "bool":
		result = "boolean"
	case "struct":
		if f.Struct.Package != nil {
			if f.Struct.Package.Name != pkgName {
				result = f.Struct.Package.Name + "."
			}
		}
		result = result + f.Struct.Name
	default:
		result = "any"
	}

	return result
}

func (p *Parser) parseField(file *ast.File, field *ast.Field, pkg *Package) ([]*Field, error) {
	var result []*Field

	var fieldType string
	var strct *Struct
	var isArray bool

	var jsonOptions JSONOptions

	// Determine type
	switch t := field.Type.(type) {
	case *ast.Ident:
		fieldType = t.Name

		unresolved := isUnresolvedType(fieldType)

		// Check if this type is actually a struct
		if unresolved {
			// Assume it is a struct
			// Parse the struct
			var err error
			strct, err = p.parseStruct(pkg, t.Name)
			if err != nil {
				return nil, err
			}

			if strct == nil {
				fieldName := "<anonymous>"
				if len(field.Names) > 0 {
					fieldName = field.Names[0].Name
				}
				return nil, fmt.Errorf("unresolved type in field %s: %s", fieldName, fieldType)
			}

			fieldType = "struct"

		}
	case *ast.StarExpr:
		fieldType = "struct"
		packageName, structName, err := parseStructNameFromStarExpr(t)
		if err != nil {
			return nil, err
		}

		// If this is an external package, find it
		if packageName != "" {
			referencedGoPackage := pkg.getImportByName(packageName, file)
			referencedPackage := p.getPackageByID(referencedGoPackage.ID)

			// If we found the struct, save it as an external package reference
			if referencedPackage != nil {
				pkg.addExternalReference(referencedPackage)
			}

			// We save this to pkg anyway, because we want to know if this package
			// was NOT found
			pkg = referencedPackage
		}

		// If this is a package in our project, parse the struct!
		if pkg != nil {

			// Parse the struct
			strct, err = p.parseStruct(pkg, structName)
			if err != nil {
				return nil, err
			}

		}

	case *ast.ArrayType:
		isArray = true
		// Parse the Elt (There must be a better way!)
		switch t := t.Elt.(type) {
		case *ast.Ident:
			fieldType = t.Name
		case *ast.StarExpr:
			fieldType = "struct"
			packageName, structName, err := parseStructNameFromStarExpr(t)
			if err != nil {
				return nil, err
			}

			// If this is an external package, find it
			if packageName != "" {
				referencedGoPackage := pkg.getImportByName(packageName, file)
				referencedPackage := p.getPackageByID(referencedGoPackage.ID)

				// If we found the struct, save it as an external package reference
				if referencedPackage != nil {
					pkg.addExternalReference(referencedPackage)
				}

				// We save this to pkg anyway, because we want to know if this package
				// was NOT found
				pkg = referencedPackage
			}

			// If this is a package in our project, parse the struct!
			if pkg != nil {

				// Parse the struct
				strct, err = p.parseStruct(pkg, structName)
				if err != nil {
					return nil, err
				}

			}
		default:
			// We will default to "Array<any>" for eg nested arrays
			fieldType = "any"
		}

	default:
		return nil, fmt.Errorf("unsupported field found in struct: %+v", t)
	}

	// Parse json tag if available
	if field.Tag != nil {
		err := parseJSONOptions(field.Tag.Value, &jsonOptions)
		if err != nil {
			return nil, err
		}
	}

	// Loop over names if we have
	if len(field.Names) > 0 {

		for _, name := range field.Names {

			// TODO: Check field names are valid in JS
			if isJSReservedWord(name.Name) {
				return nil, fmt.Errorf("unable to use field name %s - reserved word in Javascript", name.Name)
			}

			// Create a field per name
			thisField := &Field{
				Comments: parseComments(field.Doc),
			}
			thisField.Name = name.Name
			thisField.Type = fieldType
			thisField.Struct = strct
			thisField.IsArray = isArray
			thisField.JSONOptions = jsonOptions

			result = append(result, thisField)
		}
		return result, nil
	}

	// When we have no name
	thisField := &Field{
		Comments: parseComments(field.Doc),
	}
	thisField.Type = fieldType
	thisField.Struct = strct
	thisField.IsArray = isArray
	result = append(result, thisField)

	return result, nil
}

func parseJSONOptions(fieldTag string, jsonOptions *JSONOptions) error {

	// Remove backticks
	fieldTag = strings.Trim(fieldTag, "`")

	// Parse the tag
	tags, err := structtag.Parse(fieldTag)
	if err != nil {
		return err
	}

	jsonTag, err := tags.Get("json")
	if err != nil {
		return err
	}

	if jsonTag == nil {
		return nil
	}

	// Save the name
	jsonOptions.Name = jsonTag.Name

	// Check if this field is ignored
	if jsonTag.Name == "-" {
		jsonOptions.Ignored = true
	}

	// Check if this field is optional
	if jsonTag.HasOption("omitempty") {
		jsonOptions.IsOptional = true
	}

	return nil
}