ebiten/_docs/gen.go

353 lines
7.6 KiB
Go
Raw Normal View History

2014-12-27 16:26:33 +01:00
// Copyright 2014 Hajime Hoshi
//
// 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
//
2015-01-08 15:45:30 +01:00
// http://www.apache.org/licenses/LICENSE-2.0
2014-12-27 16:26:33 +01:00
//
// 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.
// +build ignore
package main
import (
2014-12-29 15:52:37 +01:00
"fmt"
2014-12-27 16:26:33 +01:00
"html/template"
"io/ioutil"
"log"
"os"
2014-12-29 15:52:37 +01:00
"os/exec"
2014-12-27 16:26:33 +01:00
"path/filepath"
2014-12-27 22:18:23 +01:00
"regexp"
2015-01-08 17:50:11 +01:00
"strconv"
2014-12-29 15:16:02 +01:00
"strings"
2014-12-27 16:26:33 +01:00
)
2016-02-10 19:07:14 +01:00
func execute(command string, args ...string) error {
cmd := exec.Command(command, args...)
stderr, err := cmd.StderrPipe()
if err != nil {
return err
}
if err := cmd.Start(); err != nil {
return err
}
msg, err := ioutil.ReadAll(stderr)
if err != nil {
return err
}
if err := cmd.Wait(); err != nil {
return fmt.Errorf("%v: %s", err, string(msg))
}
return nil
}
2014-12-29 15:16:02 +01:00
var license = ""
2014-12-27 16:26:33 +01:00
2014-12-29 15:16:02 +01:00
func init() {
2015-06-20 11:56:37 +02:00
b, err := ioutil.ReadFile("../LICENSE")
2014-12-29 15:16:02 +01:00
if err != nil {
panic(err)
}
2015-01-08 17:00:30 +01:00
license = strings.TrimSpace(string(b))
2014-12-29 15:16:02 +01:00
}
2014-12-27 16:26:33 +01:00
2015-01-08 15:45:30 +01:00
var copyright = ""
func init() {
2016-02-05 15:31:35 +01:00
year, err := strconv.Atoi(regexp.MustCompile(`^Copyright (\d+)`).FindStringSubmatch(license)[1])
if err != nil {
panic(err)
}
copyright = fmt.Sprintf("© %d Hajime Hoshi", year)
2015-01-08 15:45:30 +01:00
}
2014-12-29 15:16:02 +01:00
var stableVersion = ""
var devVersion = ""
func init() {
b, err := ioutil.ReadFile("../version.txt")
if err != nil {
panic(err)
}
2014-12-29 15:52:37 +01:00
stableVersion = strings.TrimSpace(string(b))
}
func currentBranch() string {
r, err := ioutil.ReadFile("../.git/HEAD")
if err != nil {
panic(err)
}
rr := strings.TrimSpace(string(r))
return regexp.MustCompile(`^ref: refs/heads/(.+)$`).FindStringSubmatch(rr)[1]
}
2014-12-29 15:52:37 +01:00
func init() {
b, err := exec.Command("git", "show", "master:version.txt").Output()
if err != nil {
panic(err)
}
devVersion = strings.TrimSpace(string(b))
2014-12-29 15:16:02 +01:00
}
2014-12-27 16:26:33 +01:00
func comment(text string) template.HTML {
2015-02-01 18:34:01 +01:00
// http://www.w3.org/TR/html-markup/syntax.html#comments
// The text part of comments has the following restrictions:
// * must not start with a ">" character
// * must not start with the string "->"
// * must not contain the string "--"
// * must not end with a "-" character
for strings.HasPrefix(text, ">") {
text = text[1:]
}
for strings.HasPrefix(text, "->") {
text = text[2:]
}
text = strings.Replace(text, "--", "", -1)
for strings.HasSuffix(text, "-") {
text = text[:len(text)-1]
}
2014-12-29 15:52:37 +01:00
return template.HTML("<!--\n" + text + "\n-->")
2014-12-27 16:26:33 +01:00
}
func safeHTML(text string) template.HTML {
return template.HTML(text)
}
2014-12-27 22:18:23 +01:00
type example struct {
Name string
}
2015-01-08 15:45:30 +01:00
func (e *example) ThumbWidth() int {
2014-12-29 10:43:35 +01:00
if e.Name == "blocks" {
return 256
}
return 320
}
2015-01-08 15:45:30 +01:00
func (e *example) ThumbHeight() int {
2014-12-29 10:43:35 +01:00
if e.Name == "blocks" {
return 240
}
return 240
}
2015-01-08 15:45:30 +01:00
func (e *example) Width() int {
return e.ThumbWidth() * 2
}
func (e *example) Height() int {
return e.ThumbHeight() * 2
}
2016-02-15 19:04:44 +01:00
const commentForBlocks = `// Please read examples/blocks/main.go and examples/blocks/blocks/*.go
// NOTE: If Gamepad API is available in your browswer, you can use gamepads. Try it out!`
2014-12-27 22:18:23 +01:00
func (e *example) Source() string {
2014-12-29 10:43:35 +01:00
if e.Name == "blocks" {
2016-02-15 19:04:44 +01:00
return commentForBlocks
2014-12-29 10:43:35 +01:00
}
2016-02-10 19:07:14 +01:00
path := filepath.Join(os.Getenv("GOPATH"), "src", "github.com", "hajimehoshi", "ebiten", "examples", e.Name, "main.go")
2014-12-27 22:18:23 +01:00
b, err := ioutil.ReadFile(path)
2014-12-27 16:26:33 +01:00
if err != nil {
2014-12-27 22:18:23 +01:00
panic(err)
2014-12-27 16:26:33 +01:00
}
2014-12-27 22:18:23 +01:00
str := regexp.MustCompile("(?s)^.*?\n\n").ReplaceAllString(string(b), "")
2015-01-06 15:04:57 +01:00
str = strings.Replace(str, "\t", " ", -1)
2014-12-27 22:18:23 +01:00
return str
}
2014-12-29 15:16:02 +01:00
func versions() string {
2014-12-29 15:52:37 +01:00
return fmt.Sprintf("v%s (dev: v%s)", stableVersion, devVersion)
2014-12-29 15:16:02 +01:00
}
2015-01-05 16:44:39 +01:00
var examples = []example{
2016-02-15 16:52:45 +01:00
{Name: "alphablending"},
2016-04-13 18:26:31 +02:00
{Name: "audio"},
{Name: "font"},
{Name: "hsv"},
2015-01-05 16:44:39 +01:00
{Name: "hue"},
2016-02-15 16:52:45 +01:00
{Name: "gamepad"},
2015-01-08 15:45:30 +01:00
{Name: "keyboard"},
2016-04-13 18:26:31 +02:00
{Name: "masking"},
2015-01-05 16:44:39 +01:00
{Name: "mosaic"},
2016-02-15 16:52:45 +01:00
{Name: "noise"},
2015-01-08 18:39:20 +01:00
{Name: "paint"},
2015-01-05 16:44:39 +01:00
{Name: "perspective"},
2016-04-13 18:26:31 +02:00
{Name: "piano"},
2015-01-05 16:44:39 +01:00
{Name: "rotate"},
2016-02-15 16:52:45 +01:00
{Name: "sprites"},
2015-01-08 15:45:30 +01:00
{Name: "blocks"},
2015-01-05 16:44:39 +01:00
}
func clear() error {
2015-01-08 15:45:30 +01:00
if err := filepath.Walk("public", func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if m, _ := regexp.MatchString("~$", path); m {
return nil
}
2015-01-08 15:45:30 +01:00
// Remove auto-generated html files.
m, err := regexp.MatchString(".html$", path)
if err != nil {
return err
}
if m {
return os.Remove(path)
2015-01-08 15:45:30 +01:00
}
// Remove example resources that are copied.
2016-02-20 21:40:56 +01:00
m, err = regexp.MatchString("^public/examples/_resources/images$", path)
2015-01-08 15:45:30 +01:00
if err != nil {
return err
}
if m {
if err := os.RemoveAll(path); err != nil {
return err
}
return filepath.SkipDir
2015-01-08 15:45:30 +01:00
}
return nil
2015-01-08 15:45:30 +01:00
}); err != nil {
return err
}
2015-01-05 16:44:39 +01:00
return nil
}
func outputMain() error {
f, err := os.Create("public/index.html")
2014-12-27 16:26:33 +01:00
if err != nil {
2015-01-05 16:44:39 +01:00
return err
2014-12-27 16:26:33 +01:00
}
2014-12-27 22:18:23 +01:00
defer f.Close()
2014-12-27 16:26:33 +01:00
funcs := template.FuncMap{
"comment": comment,
"safeHTML": safeHTML,
}
2015-01-05 16:44:39 +01:00
const templatePath = "index.tmpl.html"
2014-12-27 16:26:33 +01:00
name := filepath.Base(templatePath)
t, err := template.New(name).Funcs(funcs).ParseFiles(templatePath)
if err != nil {
2015-01-05 16:44:39 +01:00
return err
2014-12-27 16:26:33 +01:00
}
2014-12-29 15:16:02 +01:00
2014-12-27 22:18:23 +01:00
data := map[string]interface{}{
2014-12-29 15:52:37 +01:00
"License": license,
2015-01-08 15:45:30 +01:00
"Copyright": copyright,
2014-12-29 15:52:37 +01:00
"StableVersion": stableVersion,
"DevVersion": devVersion,
"Examples": examples,
2014-12-27 16:26:33 +01:00
}
2015-01-05 16:44:39 +01:00
return t.Funcs(funcs).Execute(f, data)
}
2016-02-06 21:50:41 +01:00
func outputExampleImages() error {
// TODO: Using cp command might not be portable.
// Use io.Copy instead.
2016-02-10 19:07:14 +01:00
const dir = "public/examples"
if err := os.MkdirAll(dir, 0755); err != nil {
return err
}
2016-02-20 21:40:56 +01:00
return execute("cp", "-R", "../examples/_resources/images", "public/examples/_resources/images")
2016-02-06 21:50:41 +01:00
}
2015-01-08 15:45:30 +01:00
func outputExampleContent(e *example) error {
2016-02-10 19:07:14 +01:00
const dir = "public/examples"
2015-01-05 16:44:39 +01:00
if err := os.MkdirAll(dir, 0755); err != nil {
return err
}
2015-01-08 15:45:30 +01:00
f, err := os.Create(filepath.Join(dir, e.Name+".content.html"))
2015-01-05 16:44:39 +01:00
if err != nil {
return err
}
defer f.Close()
funcs := template.FuncMap{
"comment": comment,
"safeHTML": safeHTML,
}
2015-01-08 15:45:30 +01:00
const templatePath = "examplecontent.tmpl.html"
2015-01-05 16:44:39 +01:00
name := filepath.Base(templatePath)
t, err := template.New(name).Funcs(funcs).ParseFiles(templatePath)
if err != nil {
return err
}
data := map[string]interface{}{
"License": license,
"Copyright": copyright,
"CurrentBranch": currentBranch(),
"Example": e,
2015-01-05 16:44:39 +01:00
}
2014-12-27 16:26:33 +01:00
if err := t.Funcs(funcs).Execute(f, data); err != nil {
2015-01-05 16:44:39 +01:00
return err
}
out := filepath.Join(dir, e.Name+".js")
2016-02-10 19:07:14 +01:00
path := "github.com/hajimehoshi/ebiten/examples/" + e.Name
2016-08-26 16:33:17 +02:00
if err := execute("gopherjs", "build", "-tags", "example", "-m", "-o", out, path); err != nil {
2015-01-05 16:44:39 +01:00
return err
}
return nil
}
2015-01-08 15:45:30 +01:00
func outputExample(e *example) error {
2016-02-10 19:07:14 +01:00
const dir = "public/examples"
2015-01-08 15:45:30 +01:00
if err := os.MkdirAll(dir, 0755); err != nil {
return err
}
f, err := os.Create(filepath.Join(dir, e.Name+".html"))
if err != nil {
return err
}
defer f.Close()
funcs := template.FuncMap{
"comment": comment,
"safeHTML": safeHTML,
}
const templatePath = "example.tmpl.html"
name := filepath.Base(templatePath)
t, err := template.New(name).Funcs(funcs).ParseFiles(templatePath)
if err != nil {
return err
}
data := map[string]interface{}{
"License": license,
"Copyright": copyright,
"Example": e,
}
return t.Funcs(funcs).Execute(f, data)
}
2015-01-05 16:44:39 +01:00
func main() {
if err := clear(); err != nil {
log.Fatal(err)
}
if err := outputMain(); err != nil {
2014-12-27 16:26:33 +01:00
log.Fatal(err)
}
2016-02-06 21:50:41 +01:00
if err := outputExampleImages(); err != nil {
log.Fatal(err)
}
2015-01-05 16:44:39 +01:00
for _, e := range examples {
2015-01-08 15:45:30 +01:00
if err := outputExampleContent(&e); err != nil {
log.Fatal(err)
}
2015-01-05 16:44:39 +01:00
if err := outputExample(&e); err != nil {
log.Fatal(err)
}
}
2014-12-27 16:26:33 +01:00
}