codewalk.go 10.5 KB
Newer Older
Russ Cox's avatar
Russ Cox committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// The /doc/codewalk/ tree is synthesized from codewalk descriptions,
// files named $GOROOT/doc/codewalk/*.xml.
// For an example and a description of the format, see
// http://golang.org/doc/codewalk/codewalk or run godoc -http=:6060
// and see http://localhost:6060/doc/codewalk/codewalk .
// That page is itself a codewalk; the source code for it is
// $GOROOT/doc/codewalk/codewalk.xml.

package main

import (
	"fmt"
	"http"
	"io"
	"log"
	"os"
21
	"regexp"
Russ Cox's avatar
Russ Cox committed
22 23 24
	"sort"
	"strconv"
	"strings"
25
	"template"
Russ Cox's avatar
Russ Cox committed
26 27 28 29 30
	"utf8"
	"xml"
)

// Handler for /doc/codewalk/ and below.
31
func codewalk(w http.ResponseWriter, r *http.Request) {
Russ Cox's avatar
Russ Cox committed
32 33 34 35 36
	relpath := r.URL.Path[len("/doc/codewalk/"):]
	abspath := absolutePath(r.URL.Path[1:], *goroot)

	r.ParseForm()
	if f := r.FormValue("fileprint"); f != "" {
37
		codewalkFileprint(w, r, f)
Russ Cox's avatar
Russ Cox committed
38 39 40 41
		return
	}

	// If directory exists, serve list of code walks.
42
	dir, err := fs.Lstat(abspath)
Russ Cox's avatar
Russ Cox committed
43
	if err == nil && dir.IsDirectory() {
44
		codewalkDir(w, r, relpath, abspath)
Russ Cox's avatar
Russ Cox committed
45 46 47 48 49
		return
	}

	// If file exists, serve using standard file server.
	if err == nil {
50
		serveFile(w, r)
Russ Cox's avatar
Russ Cox committed
51 52 53 54 55 56 57
		return
	}

	// Otherwise append .xml and hope to find
	// a codewalk description.
	cw, err := loadCodewalk(abspath + ".xml")
	if err != nil {
Rob Pike's avatar
Rob Pike committed
58
		log.Print(err)
59
		serveError(w, r, relpath, err)
Russ Cox's avatar
Russ Cox committed
60 61 62
		return
	}

63
	// Canonicalize the path and redirect if changed
64
	if redirect(w, r) {
65 66 67
		return
	}

Russ Cox's avatar
Russ Cox committed
68
	b := applyTemplate(codewalkHTML, "codewalk", cw)
69
	servePage(w, "Codewalk: "+cw.Title, "", "", b)
Russ Cox's avatar
Russ Cox committed
70 71 72 73
}

// A Codewalk represents a single codewalk read from an XML file.
type Codewalk struct {
74
	Title string `xml:"attr"`
Russ Cox's avatar
Russ Cox committed
75 76 77 78 79 80 81
	File  []string
	Step  []*Codestep
}

// A Codestep is a single step in a codewalk.
type Codestep struct {
	// Filled in from XML
82 83 84
	Src   string `xml:"attr"`
	Title string `xml:"attr"`
	XML   string `xml:"innerxml"`
Russ Cox's avatar
Russ Cox committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

	// Derived from Src; not in XML.
	Err    os.Error
	File   string
	Lo     int
	LoByte int
	Hi     int
	HiByte int
	Data   []byte
}

// String method for printing in template.
// Formats file address nicely.
func (st *Codestep) String() string {
	s := st.File
	if st.Lo != 0 || st.Hi != 0 {
		s += fmt.Sprintf(":%d", st.Lo)
		if st.Lo != st.Hi {
			s += fmt.Sprintf(",%d", st.Hi)
		}
	}
	return s
}

// loadCodewalk reads a codewalk from the named XML file.
110 111
func loadCodewalk(filename string) (*Codewalk, os.Error) {
	f, err := fs.Open(filename)
Russ Cox's avatar
Russ Cox committed
112 113 114 115 116 117 118 119 120
	if err != nil {
		return nil, err
	}
	defer f.Close()
	cw := new(Codewalk)
	p := xml.NewParser(f)
	p.Entity = xml.HTMLEntity
	err = p.Unmarshal(cw, nil)
	if err != nil {
121
		return nil, &os.PathError{"parsing", filename, err}
Russ Cox's avatar
Russ Cox committed
122 123 124 125 126 127 128 129 130
	}

	// Compute file list, evaluate line numbers for addresses.
	m := make(map[string]bool)
	for _, st := range cw.Step {
		i := strings.Index(st.Src, ":")
		if i < 0 {
			i = len(st.Src)
		}
131
		filename := st.Src[0:i]
132
		data, err := ReadFile(fs, absolutePath(filename, *goroot))
Russ Cox's avatar
Russ Cox committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
		if err != nil {
			st.Err = err
			continue
		}
		if i < len(st.Src) {
			lo, hi, err := addrToByteRange(st.Src[i+1:], 0, data)
			if err != nil {
				st.Err = err
				continue
			}
			// Expand match to line boundaries.
			for lo > 0 && data[lo-1] != '\n' {
				lo--
			}
			for hi < len(data) && (hi == 0 || data[hi-1] != '\n') {
				hi++
			}
			st.Lo = byteToLine(data, lo)
			st.Hi = byteToLine(data, hi-1)
		}
		st.Data = data
154 155
		st.File = filename
		m[filename] = true
Russ Cox's avatar
Russ Cox committed
156 157 158 159 160 161 162 163 164
	}

	// Make list of files
	cw.File = make([]string, len(m))
	i := 0
	for f := range m {
		cw.File[i] = f
		i++
	}
165
	sort.Strings(cw.File)
Russ Cox's avatar
Russ Cox committed
166 167 168 169 170 171 172

	return cw, nil
}

// codewalkDir serves the codewalk directory listing.
// It scans the directory for subdirectories or files named *.xml
// and prepares a table.
173
func codewalkDir(w http.ResponseWriter, r *http.Request, relpath, abspath string) {
Russ Cox's avatar
Russ Cox committed
174 175 176 177 178
	type elem struct {
		Name  string
		Title string
	}

179
	dir, err := fs.ReadDir(abspath)
Russ Cox's avatar
Russ Cox committed
180
	if err != nil {
Rob Pike's avatar
Rob Pike committed
181
		log.Print(err)
182
		serveError(w, r, relpath, err)
Russ Cox's avatar
Russ Cox committed
183 184
		return
	}
185
	var v []interface{}
Russ Cox's avatar
Russ Cox committed
186
	for _, fi := range dir {
187
		name := fi.Name()
Russ Cox's avatar
Russ Cox committed
188
		if fi.IsDirectory() {
189
			v = append(v, &elem{name + "/", ""})
190 191
		} else if strings.HasSuffix(name, ".xml") {
			cw, err := loadCodewalk(abspath + "/" + name)
Russ Cox's avatar
Russ Cox committed
192 193 194
			if err != nil {
				continue
			}
195
			v = append(v, &elem{name[0 : len(name)-len(".xml")], cw.Title})
Russ Cox's avatar
Russ Cox committed
196 197 198 199
		}
	}

	b := applyTemplate(codewalkdirHTML, "codewalkdir", v)
200
	servePage(w, "Codewalks", "", "", b)
Russ Cox's avatar
Russ Cox committed
201 202 203 204 205 206 207 208
}

// codewalkFileprint serves requests with ?fileprint=f&lo=lo&hi=hi.
// The filename f has already been retrieved and is passed as an argument.
// Lo and hi are the numbers of the first and last line to highlight
// in the response.  This format is used for the middle window pane
// of the codewalk pages.  It is a separate iframe and does not get
// the usual godoc HTML wrapper.
209
func codewalkFileprint(w http.ResponseWriter, r *http.Request, f string) {
Russ Cox's avatar
Russ Cox committed
210
	abspath := absolutePath(f, *goroot)
211
	data, err := ReadFile(fs, abspath)
Russ Cox's avatar
Russ Cox committed
212
	if err != nil {
Rob Pike's avatar
Rob Pike committed
213
		log.Print(err)
214
		serveError(w, r, f, err)
Russ Cox's avatar
Russ Cox committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
		return
	}
	lo, _ := strconv.Atoi(r.FormValue("lo"))
	hi, _ := strconv.Atoi(r.FormValue("hi"))
	if hi < lo {
		hi = lo
	}
	lo = lineToByte(data, lo)
	hi = lineToByte(data, hi+1)

	// Put the mark 4 lines before lo, so that the iframe
	// shows a few lines of context before the highlighted
	// section.
	n := 4
	mark := lo
	for ; mark > 0 && n > 0; mark-- {
		if data[mark-1] == '\n' {
			if n--; n == 0 {
				break
			}
		}
	}

238 239 240 241
	io.WriteString(w, `<style type="text/css">@import "/doc/codewalk/codewalk.css";</style><pre>`)
	template.HTMLEscape(w, data[0:mark])
	io.WriteString(w, "<a name='mark'></a>")
	template.HTMLEscape(w, data[mark:lo])
Russ Cox's avatar
Russ Cox committed
242
	if lo < hi {
243 244 245
		io.WriteString(w, "<div class='codewalkhighlight'>")
		template.HTMLEscape(w, data[lo:hi])
		io.WriteString(w, "</div>")
Russ Cox's avatar
Russ Cox committed
246
	}
247 248
	template.HTMLEscape(w, data[hi:])
	io.WriteString(w, "</pre>")
Russ Cox's avatar
Russ Cox committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
}

// addrToByte evaluates the given address starting at offset start in data.
// It returns the lo and hi byte offset of the matched region within data.
// See http://plan9.bell-labs.com/sys/doc/sam/sam.html Table II
// for details on the syntax.
func addrToByteRange(addr string, start int, data []byte) (lo, hi int, err os.Error) {
	var (
		dir        byte
		prevc      byte
		charOffset bool
	)
	lo = start
	hi = start
	for addr != "" && err == nil {
		c := addr[0]
		switch c {
		default:
			err = os.NewError("invalid address syntax near " + string(c))
		case ',':
			if len(addr) == 1 {
				hi = len(data)
			} else {
				_, hi, err = addrToByteRange(addr[1:], hi, data)
			}
			return

		case '+', '-':
			if prevc == '+' || prevc == '-' {
				lo, hi, err = addrNumber(data, lo, hi, prevc, 1, charOffset)
			}
			dir = c

		case '$':
			lo = len(data)
			hi = len(data)
			if len(addr) > 1 {
				dir = '+'
			}

		case '#':
			charOffset = true

		case '0', '1', '2', '3', '4', '5', '6', '7', '8', '9':
			var i int
			for i = 1; i < len(addr); i++ {
				if addr[i] < '0' || addr[i] > '9' {
					break
				}
			}
			var n int
			n, err = strconv.Atoi(addr[0:i])
			if err != nil {
				break
			}
			lo, hi, err = addrNumber(data, lo, hi, dir, n, charOffset)
			dir = 0
			charOffset = false
			prevc = c
			addr = addr[i:]
			continue

		case '/':
			var i, j int
		Regexp:
			for i = 1; i < len(addr); i++ {
				switch addr[i] {
				case '\\':
					i++
				case '/':
					j = i + 1
					break Regexp
				}
			}
			if j == 0 {
				j = i
			}
			pattern := addr[1:i]
			lo, hi, err = addrRegexp(data, lo, hi, dir, pattern)
			prevc = c
			addr = addr[j:]
			continue
		}
		prevc = c
		addr = addr[1:]
	}

	if err == nil && dir != 0 {
		lo, hi, err = addrNumber(data, lo, hi, dir, 1, charOffset)
	}
	if err != nil {
		return 0, 0, err
	}
	return lo, hi, nil
}

// addrNumber applies the given dir, n, and charOffset to the address lo, hi.
// dir is '+' or '-', n is the count, and charOffset is true if the syntax
// used was #n.  Applying +n (or +#n) means to advance n lines
// (or characters) after hi.  Applying -n (or -#n) means to back up n lines
// (or characters) before lo.
// The return value is the new lo, hi.
func addrNumber(data []byte, lo, hi int, dir byte, n int, charOffset bool) (int, int, os.Error) {
	switch dir {
	case 0:
		lo = 0
		hi = 0
		fallthrough

	case '+':
		if charOffset {
			pos := hi
			for ; n > 0 && pos < len(data); n-- {
				_, size := utf8.DecodeRune(data[pos:])
				pos += size
			}
			if n == 0 {
				return pos, pos, nil
			}
			break
		}
		// find next beginning of line
		if hi > 0 {
			for hi < len(data) && data[hi-1] != '\n' {
				hi++
			}
		}
		lo = hi
		if n == 0 {
			return lo, hi, nil
		}
		for ; hi < len(data); hi++ {
			if data[hi] != '\n' {
				continue
			}
			switch n--; n {
			case 1:
				lo = hi + 1
			case 0:
				return lo, hi + 1, nil
			}
		}

	case '-':
		if charOffset {
			// Scan backward for bytes that are not UTF-8 continuation bytes.
			pos := lo
			for ; pos > 0 && n > 0; pos-- {
				if data[pos]&0xc0 != 0x80 {
					n--
				}
			}
			if n == 0 {
				return pos, pos, nil
			}
			break
		}
		// find earlier beginning of line
		for lo > 0 && data[lo-1] != '\n' {
			lo--
		}
		hi = lo
		if n == 0 {
			return lo, hi, nil
		}
		for ; lo >= 0; lo-- {
			if lo > 0 && data[lo-1] != '\n' {
				continue
			}
			switch n--; n {
			case 1:
				hi = lo
			case 0:
				return lo, hi, nil
			}
		}
	}

	return 0, 0, os.NewError("address out of range")
}

// addrRegexp searches for pattern in the given direction starting at lo, hi.
// The direction dir is '+' (search forward from hi) or '-' (search backward from lo).
// Backward searches are unimplemented.
func addrRegexp(data []byte, lo, hi int, dir byte, pattern string) (int, int, os.Error) {
	re, err := regexp.Compile(pattern)
	if err != nil {
		return 0, 0, err
	}
	if dir == '-' {
		// Could implement reverse search using binary search
		// through file, but that seems like overkill.
		return 0, 0, os.NewError("reverse search not implemented")
	}
443
	m := re.FindIndex(data[hi:])
Russ Cox's avatar
Russ Cox committed
444 445 446 447 448
	if len(m) > 0 {
		m[0] += hi
		m[1] += hi
	} else if hi > 0 {
		// No match.  Wrap to beginning of data.
449
		m = re.FindIndex(data)
Russ Cox's avatar
Russ Cox committed
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
	}
	if len(m) == 0 {
		return 0, 0, os.NewError("no match for " + pattern)
	}
	return m[0], m[1], nil
}

// lineToByte returns the byte index of the first byte of line n.
// Line numbers begin at 1.
func lineToByte(data []byte, n int) int {
	if n <= 1 {
		return 0
	}
	n--
	for i, c := range data {
		if c == '\n' {
			if n--; n == 0 {
				return i + 1
			}
		}
	}
	return len(data)
}

// byteToLine returns the number of the line containing the byte at index i.
func byteToLine(data []byte, i int) int {
	l := 1
	for j, c := range data {
		if j == i {
			return l
		}
		if c == '\n' {
			l++
		}
	}
	return l
}