// ConvertDataFormat converts data from database acceptable format to useable format.
func ConvertDataFormat(pdoc *hv.Package, pdecl *models.PkgDecl) error {
if pdoc.PkgDecl == nil {
pdoc.PkgDecl = &hv.PkgDecl{}
}
pdoc.JsNum = pdecl.JsNum
pdoc.IsHasExport = pdecl.IsHasExport
pdoc.IsHasConst = pdecl.IsHasConst
pdoc.IsHasVar = pdecl.IsHasVar
pdoc.IsHasExample = pdecl.IsHasExample
pdoc.IsHasFile = pdecl.IsHasFile
pdoc.IsHasSubdir = pdecl.IsHasSubdir
// Imports.
pdoc.Imports = strings.Split(pdecl.Imports, "|")
if len(pdoc.Imports) == 1 && len(pdoc.Imports[0]) == 0 {
// No import.
pdoc.Imports = nil
}
return nil
}
func renderDoc(this *HomeRouter, pdoc *hv.Package, q, tag, docPath string) bool {
this.Data["PkgFullIntro"] = pdoc.Doc
var buf bytes.Buffer
links := make([]*utils.Link, 0, len(pdoc.Types)+len(pdoc.Imports)+len(pdoc.TestImports)+
len(pdoc.Funcs)+10)
// Get all types, functions and import packages
for _, t := range pdoc.Types {
links = append(links, &utils.Link{
Name: t.Name,
Comment: template.HTMLEscapeString(t.Doc),
})
buf.WriteString("'" + t.Name + "',")
}
for _, f := range pdoc.Funcs {
links = append(links, &utils.Link{
Name: f.Name,
Comment: template.HTMLEscapeString(f.Doc),
})
buf.WriteString("'" + f.Name + "',")
}
for _, t := range pdoc.Types {
for _, f := range t.Funcs {
links = append(links, &utils.Link{
Name: f.Name,
Comment: template.HTMLEscapeString(f.Doc),
})
buf.WriteString("'" + f.Name + "',")
}
for _, m := range t.Methods {
buf.WriteString("'" + t.Name + "_" + m.Name + "',")
}
}
// Ignore C.
for _, v := range append(pdoc.Imports, pdoc.TestImports...) {
if v != "C" {
links = append(links, &utils.Link{
Name: path.Base(v) + ".",
Path: v,
})
}
}
// Set exported objects type-ahead.
exportDataSrc := buf.String()
if len(exportDataSrc) > 0 {
pdoc.IsHasExport = true
this.Data["IsHasExports"] = true
exportDataSrc = exportDataSrc[:len(exportDataSrc)-1]
this.Data["ExportDataSrc"] = "<script>$('.search-export').typeahead({local: [" +
exportDataSrc + "],limit: 10});</script>"
}
pdoc.UserExamples = getUserExamples(pdoc.ImportPath)
pdoc.IsHasConst = len(pdoc.Consts) > 0
pdoc.IsHasVar = len(pdoc.Vars) > 0
if len(pdoc.Examples)+len(pdoc.UserExamples) > 0 {
pdoc.IsHasExample = true
this.Data["IsHasExample"] = pdoc.IsHasExample
this.Data["Examples"] = append(pdoc.Examples, pdoc.UserExamples...)
}
// Commented and total objects number.
var comNum, totalNum int
// Constants.
this.Data["IsHasConst"] = pdoc.IsHasConst
this.Data["Consts"] = pdoc.Consts
for i, v := range pdoc.Consts {
if len(v.Doc) > 0 {
buf.Reset()
godoc.ToHTML(&buf, v.Doc, nil)
v.Doc = buf.String()
}
buf.Reset()
v.Decl = template.HTMLEscapeString(v.Decl)
v.Decl = strings.Replace(v.Decl, """, "\"", -1)
utils.FormatCode(&buf, &v.Decl, links)
v.FmtDecl = buf.String()
pdoc.Consts[i] = v
}
// Variables.
this.Data["IsHasVar"] = pdoc.IsHasVar
this.Data["Vars"] = pdoc.Vars
for i, v := range pdoc.Vars {
if len(v.Doc) > 0 {
buf.Reset()
godoc.ToHTML(&buf, v.Doc, nil)
v.Doc = buf.String()
}
buf.Reset()
utils.FormatCode(&buf, &v.Decl, links)
v.FmtDecl = buf.String()
pdoc.Vars[i] = v
}
// Dirs.
pinfos := models.GetSubPkgs(pdoc.ImportPath, tag, pdoc.Dirs)
if len(pinfos) > 0 {
pdoc.IsHasSubdir = true
this.Data["IsHasSubdirs"] = pdoc.IsHasSubdir
this.Data["Subdirs"] = pinfos
this.Data["ViewDirPath"] = pdoc.ViewDirPath
}
// Files.
if len(pdoc.Files) > 0 {
pdoc.IsHasFile = true
this.Data["IsHasFiles"] = pdoc.IsHasFile
this.Data["Files"] = pdoc.Files
var query string
if i := strings.Index(pdoc.Files[0].BrowseUrl, "?"); i > -1 {
query = pdoc.Files[0].BrowseUrl[i:]
}
viewFilePath := path.Dir(pdoc.Files[0].BrowseUrl) + "/" + query
// GitHub URL change.
if strings.HasPrefix(viewFilePath, "github.com") {
viewFilePath = strings.Replace(viewFilePath, "blob/", "tree/", 1)
}
this.Data["ViewFilePath"] = viewFilePath
}
var err error
pfuncs := doc.RenderFuncs(pdoc)
this.Data["Funcs"] = pdoc.Funcs
for i, f := range pdoc.Funcs {
if len(f.Doc) > 0 {
buf.Reset()
godoc.ToHTML(&buf, f.Doc, nil)
f.Doc = buf.String()
comNum++
}
buf.Reset()
utils.FormatCode(&buf, &f.Decl, links)
f.FmtDecl = buf.String() + " {"
if exs := getExamples(pdoc, "", f.Name); len(exs) > 0 {
f.Examples = exs
}
totalNum++
pdoc.Funcs[i] = f
}
this.Data["Types"] = pdoc.Types
for i, t := range pdoc.Types {
for j, v := range t.Consts {
if len(v.Doc) > 0 {
buf.Reset()
godoc.ToHTML(&buf, v.Doc, nil)
v.Doc = buf.String()
}
buf.Reset()
v.Decl = template.HTMLEscapeString(v.Decl)
v.Decl = strings.Replace(v.Decl, """, "\"", -1)
utils.FormatCode(&buf, &v.Decl, links)
v.FmtDecl = buf.String()
t.Consts[j] = v
}
for j, v := range t.Vars {
if len(v.Doc) > 0 {
buf.Reset()
godoc.ToHTML(&buf, v.Doc, nil)
v.Doc = buf.String()
}
buf.Reset()
utils.FormatCode(&buf, &v.Decl, links)
v.FmtDecl = buf.String()
t.Vars[j] = v
}
for j, f := range t.Funcs {
if len(f.Doc) > 0 {
buf.Reset()
godoc.ToHTML(&buf, f.Doc, nil)
f.Doc = buf.String()
comNum++
}
buf.Reset()
utils.FormatCode(&buf, &f.Decl, links)
f.FmtDecl = buf.String() + " {"
if exs := getExamples(pdoc, "", f.Name); len(exs) > 0 {
f.Examples = exs
}
totalNum++
t.Funcs[j] = f
}
for j, m := range t.Methods {
if len(m.Doc) > 0 {
buf.Reset()
godoc.ToHTML(&buf, m.Doc, nil)
m.Doc = buf.String()
comNum++
}
buf.Reset()
utils.FormatCode(&buf, &m.Decl, links)
m.FmtDecl = buf.String() + " {"
if exs := getExamples(pdoc, t.Name, m.Name); len(exs) > 0 {
m.Examples = exs
}
totalNum++
t.Methods[j] = m
}
if len(t.Doc) > 0 {
buf.Reset()
godoc.ToHTML(&buf, t.Doc, nil)
t.Doc = buf.String()
comNum++
}
buf.Reset()
utils.FormatCode(&buf, &t.Decl, links)
t.FmtDecl = buf.String()
if exs := getExamples(pdoc, "", t.Name); len(exs) > 0 {
t.Examples = exs
}
totalNum++
pdoc.Types[i] = t
}
if !pdoc.IsCmd {
// Calculate documentation complete %.
this.Data["DocCPLabel"], this.Data["DocCP"] = calDocCP(comNum, totalNum)
} else {
this.Data["IsCmd"] = true
}
// Examples.
links = append(links, &utils.Link{
Name: path.Base(pdoc.ImportPath) + ".",
})
for _, e := range pdoc.Examples {
buf.Reset()
utils.FormatCode(&buf, &e.Code, links)
e.Code = buf.String()
}
for _, e := range pdoc.UserExamples {
buf.Reset()
utils.FormatCode(&buf, &e.Code, links)
e.Code = buf.String()
}
this.Data["ImportPath"] = pdoc.ImportPath
if len(tag) == 0 && (pdoc.IsCmd || pdoc.IsGoRepo || pdoc.IsGoSubrepo) {
this.Data["IsHasHv"] = true
}
// GitHub redirects non-HTTPS link and Safari loses "#XXX".
if strings.HasPrefix(pdoc.ImportPath, "github") {
this.Data["Secure"] = "s"
}
this.TplNames = "tpl/docs.tpl"
data, err := this.RenderBytes()
if err != nil {
beego.Error("generatePage(", pdoc.ImportPath, ") -> RenderBytes:", err)
return false
}
n := utils.SaveDocPage(docPath, data)
if n == -1 {
return false
}
pdoc.JsNum = n
pdoc.Id, err = doc.SaveProject(pdoc, pfuncs)
if err != nil {
beego.Error("generatePage(", pdoc.ImportPath, ") -> SaveProject:", err)
return false
}
utils.SavePkgDoc(pdoc.ImportPath, pdoc.Readme)
this.Data["UtcTime"] = time.Unix(pdoc.Created, 0).UTC()
this.Data["TimeSince"] = calTimeSince(time.Unix(pdoc.Created, 0))
return true
}