summaryrefslogtreecommitdiff
path: root/src/pkg/go/parser/interface.go
blob: 5fa60c1cd51a0ee75061592b88c0686a83bf47c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// Copyright 2009 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.

// This file contains the exported entry points for invoking the parser.

package parser

import (
	"bytes";
	"fmt";
	"go/ast";
	"go/parser";
	"go/scanner";
	"io";
	"os";
	pathutil "path";
	"strings";
)


// If src != nil, readSource converts src to a []byte if possible;
// otherwise it returns an error. If src == nil, readSource returns
// the result of reading the file specified by filename.
//
func readSource(filename string, src interface{}) ([]byte, os.Error) {
	if src != nil {
		switch s := src.(type) {
		case string:
			return strings.Bytes(s), nil;
		case []byte:
			return s, nil;
		case *bytes.Buffer:
			// is io.Reader, but src is already available in []byte form
			if s != nil {
				return s.Data(), nil;
			}
		case io.Reader:
			var buf bytes.Buffer;
			n, err := io.Copy(s, &buf);
			if err != nil {
				return nil, err;
			}
			return buf.Data(), nil;
		default:
			return nil, os.ErrorString("invalid source");
		}
	}

	return io.ReadFile(filename);
}


// ParseExpr parses a Go expression and returns the corresponding
// AST node. The filename and src arguments have the same interpretation
// as for ParseFile. If there is an error, the result expression
// may be nil or contain a partial AST.
//
func ParseExpr(filename string, src interface{}) (ast.Expr, os.Error) {
	data, err := readSource(filename, src);
	if err != nil {
		return nil, err;
	}

	var p parser;
	p.init(filename, data, 0);
	x := p.parseExpr();  // TODO 6g bug - function call order in expr lists
	return x, p.GetError(scanner.Sorted);
}


// ParseStmtList parses a list of Go statements and returns the list
// of corresponding AST nodes. The filename and src arguments have the same
// interpretation as for ParseFile. If there is an error, the node
// list may be nil or contain partial ASTs.
//
func ParseStmtList(filename string, src interface{}) ([]ast.Stmt, os.Error) {
	data, err := readSource(filename, src);
	if err != nil {
		return nil, err;
	}

	var p parser;
	p.init(filename, data, 0);
	list := p.parseStmtList();  // TODO 6g bug - function call order in expr lists
	return list, p.GetError(scanner.Sorted);
}


// ParseFile parses a Go source file and returns a File node.
//
// If src != nil, ParseFile parses the file source from src. src may
// be provided in a variety of formats. At the moment the following types
// are supported: string, []byte, and io.Reader. In this case, filename is
// only used for source position information and error messages.
//
// If src == nil, ParseFile parses the file specified by filename.
//
// The mode parameter controls the amount of source text parsed and other
// optional parser functionality.
//
// If the source couldn't be read, the returned AST is nil and the error
// indicates the specific failure. If the source was read but syntax
// errors were found, the result is a partial AST (with ast.BadX nodes
// representing the fragments of erroneous source code). Multiple errors
// are returned via a scanner.ErrorList which is sorted by file position.
//
func ParseFile(filename string, src interface{}, mode uint) (*ast.File, os.Error) {
	data, err := readSource(filename, src);
	if err != nil {
		return nil, err;
	}

	var p parser;
	p.init(filename, data, mode);
	prog := p.parseFile();  // TODO 6g bug - function call order in expr lists
	return prog, p.GetError(scanner.NoMultiples);
}


// ParsePkgFile parses the file specified by filename and returns the
// corresponding AST. If the file cannot be read, has syntax errors, or
// does not belong to the package (i.e., pkgname != "" and the package
// name in the file doesn't match pkkname), an error is returned. Mode
// flags that control the amount of source text parsed are ignored.
//
func ParsePkgFile(pkgname, filename string, mode uint) (*ast.File, os.Error) {
	src, err := io.ReadFile(filename);
	if err != nil {
		return nil, err;
	}

	if pkgname != "" {
		prog, err := ParseFile(filename, src, PackageClauseOnly);
		if err != nil {
			return nil, err;
		}
		if prog.Name.Value != pkgname {
			return nil, os.NewError(fmt.Sprintf("multiple packages found: %s, %s", prog.Name.Value, pkgname));
		}
	}

	// ignore flags that control partial parsing
	return ParseFile(filename, src, mode &^ (PackageClauseOnly | ImportsOnly));
}


// ParsePackage parses all files in the directory specified by path and
// returns an AST representing the package found. The set of files may be
// restricted by providing a non-nil filter function; only the files with
// os.Dir entries passing through the filter are considered.
// If ParsePackage does not find exactly one package, it returns an error.
// Mode flags that control the amount of source text parsed are ignored.
//
func ParsePackage(path string, filter func(*os.Dir) bool, mode uint) (*ast.Package, os.Error) {
	fd, err := os.Open(path, os.O_RDONLY, 0);
	if err != nil {
		return nil, err;
	}

	list, err := fd.Readdir(-1);
	if err != nil {
		return nil, err;
	}

	name := "";
	files := make(map[string]*ast.File);
	for i := 0; i < len(list); i++ {
		entry := &list[i];
		if filter == nil || filter(entry) {
			src, err := ParsePkgFile(name, pathutil.Join(path, entry.Name), mode);
			if err != nil {
				return nil, err;
			}
			files[entry.Name] = src;
			if name == "" {
				name = src.Name.Value;
			}
		}
	}

	if len(files) == 0 {
		return nil, os.NewError(path + ": no package found");
	}

	return &ast.Package{name, path, files}, nil;
}