// Copyright 2019 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package page_generate import ( "bytes" "errors" "fmt" "os" "path/filepath" "reflect" "github.com/gohugoio/hugo/common/maps" "github.com/gohugoio/hugo/codegen" "github.com/gohugoio/hugo/resources/page" "github.com/gohugoio/hugo/resources/resource" "github.com/gohugoio/hugo/source" ) const header = `// Copyright 2019 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // This file is autogenerated. ` var ( pageInterface = reflect.TypeOf((*page.Page)(nil)).Elem() packageDir = filepath.FromSlash("resources/page") ) func Generate(c *codegen.Inspector) error { if err := generateMarshalJSON(c); err != nil { return fmt.Errorf("failed to generate JSON marshaler: %w", err) } if err := generateFileIsZeroWrappers(c); err != nil { return fmt.Errorf("failed to generate file wrappers: %w", err) } return nil } func generateMarshalJSON(c *codegen.Inspector) error { filename := filepath.Join(c.ProjectRootDir, packageDir, "page_marshaljson.autogen.go") f, err := os.Create(filename) if err != nil { return err } defer f.Close() includes := []reflect.Type{pageInterface} // Exclude these methods excludes := []reflect.Type{ // Leave this out for now. We need to revisit the author issue. reflect.TypeOf((*page.AuthorProvider)(nil)).Elem(), reflect.TypeOf((*resource.ErrProvider)(nil)).Elem(), // navigation.PageMenus // Prevent loops. reflect.TypeOf((*page.SitesProvider)(nil)).Elem(), reflect.TypeOf((*page.Positioner)(nil)).Elem(), reflect.TypeOf((*page.ChildCareProvider)(nil)).Elem(), reflect.TypeOf((*page.TreeProvider)(nil)).Elem(), reflect.TypeOf((*page.InSectionPositioner)(nil)).Elem(), reflect.TypeOf((*page.PaginatorProvider)(nil)).Elem(), reflect.TypeOf((*maps.Scratcher)(nil)).Elem(), } methods := c.MethodsFromTypes( includes, excludes) if len(methods) == 0 { return errors.New("no methods found") } marshalJSON, pkgImports := methods.ToMarshalJSON( "Page", "github.com/gohugoio/hugo/resources/page", // Exclusion regexps. Matches method names. `\bPage\b`, ) fmt.Fprintf(f, `%s package page %s %s `, header, importsString(pkgImports), marshalJSON) return nil } func generateFileIsZeroWrappers(c *codegen.Inspector) error { filename := filepath.Join(c.ProjectRootDir, packageDir, "zero_file.autogen.go") f, err := os.Create(filename) if err != nil { return err } defer f.Close() // Generate warnings for zero file access warning := func(name string, tp reflect.Type) string { msg := fmt.Sprintf(".File.%s on zero object. Wrap it in if or with: {{ with .File }}{{ .%s }}{{ end }}", name, name) // We made this a Warning in 0.92.0. // When we remove this construct in 0.93.0, people will get a nil pointer. return fmt.Sprintf("z.log.Warnln(%q)", msg) } var buff bytes.Buffer methods := c.MethodsFromTypes([]reflect.Type{reflect.TypeOf((*source.File)(nil)).Elem()}, nil) for _, m := range methods { if m.Name == "IsZero" || m.Name == "Classifier" { continue } fmt.Fprint(&buff, m.DeclarationNamed("zeroFile")) fmt.Fprintln(&buff, " {") fmt.Fprintf(&buff, "\t%s\n", warning(m.Name, m.Owner)) if len(m.Out) > 0 { fmt.Fprintln(&buff, "\treturn") } fmt.Fprintln(&buff, "}") } pkgImports := append(methods.Imports(), "github.com/gohugoio/hugo/common/loggers", "github.com/gohugoio/hugo/source") fmt.Fprintf(f, `%s package page %s // ZeroFile represents a zero value of source.File with warnings if invoked. type zeroFile struct { log loggers.Logger } func NewZeroFile(log loggers.Logger) source.File { return zeroFile{log: log} } func (zeroFile) IsZero() bool { return true } %s `, header, importsString(pkgImports), buff.String()) return nil } func importsString(imps []string) string { if len(imps) == 0 { return "" } if len(imps) == 1 { return fmt.Sprintf("import %q", imps[0]) } impsStr := "import (\n" for _, imp := range imps { impsStr += fmt.Sprintf("%q\n", imp) } return impsStr + ")" }