Documentation
¶
Overview ¶
Package gcimporter provides various functions for reading gc-generated object files that can be used to implement the Importer interface defined by the Go 1.5 standard library package.
Index ¶
- func BExportData(fset *token.FileSet, pkg *types.Package) (b []byte, err error)
- func BImportData(fset *token.FileSet, imports map[string]*types.Package, data []byte, ...) (_ int, pkg *types.Package, err error)
- func FindExportData(r *bufio.Reader) (hdr string, size int64, err error)
- func FindPkg(path, srcDir string) (filename, id string)
- func IExportBundle(out io.Writer, fset *token.FileSet, pkgs []*types.Package) error
- func IExportData(out io.Writer, fset *token.FileSet, pkg *types.Package) error
- func IExportShallow(fset *token.FileSet, pkg *types.Package) ([]byte, error)
- func IImportBundle(fset *token.FileSet, imports map[string]*types.Package, data []byte) ([]*types.Package, error)
- func IImportData(fset *token.FileSet, imports map[string]*types.Package, data []byte, ...) (int, *types.Package, error)
- func IImportShallow(fset *token.FileSet, imports map[string]*types.Package, data []byte, ...) (*types.Package, error)
- func Import(packages map[string]*types.Package, path, srcDir string, ...) (pkg *types.Package, err error)
- func ImportData(packages map[string]*types.Package, filename, id string, data io.Reader) (pkg *types.Package, err error)
- func UImportData(fset *token.FileSet, imports map[string]*types.Package, data []byte, ...) (_ int, pkg *types.Package, err error)
- type InsertType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BExportData ¶
BExportData returns binary export data for pkg. If no file set is provided, position info will be missing.
func BImportData ¶
func BImportData(fset *token.FileSet, imports map[string]*types.Package, data []byte, path string) (_ int, pkg *types.Package, err error)
BImportData imports a package from the serialized package data and returns the number of bytes consumed and a reference to the package. If the export data version is not recognized or the format is otherwise compromised, an error is returned.
func FindExportData ¶
FindExportData positions the reader r at the beginning of the export data section of an underlying GC-created object/archive file by reading from it. The reader must be positioned at the start of the file before calling this function. The hdr result is the string before the export data, either "$$" or "$$B". The size result is the length of the export data in bytes, or -1 if not known.
func FindPkg ¶
FindPkg returns the filename and unique package id for an import path based on package information provided by build.Import (using the build.Default build.Context). A relative srcDir is interpreted relative to the current working directory. If no file was found, an empty filename is returned.
func IExportBundle ¶
IExportBundle writes an indexed export bundle for pkgs to out.
func IExportData ¶
IExportData writes indexed export data for pkg to out.
If no file set is provided, position info will be missing. The package path of the top-level package will not be recorded, so that calls to IImportData can override with a provided package path.
func IExportShallow ¶
IExportShallow encodes "shallow" export data for the specified package.
No promises are made about the encoding other than that it can be decoded by the same version of IIExportShallow. If you plan to save export data in the file system, be sure to include a cryptographic digest of the executable in the key to avoid version skew.
func IImportBundle ¶
func IImportBundle(fset *token.FileSet, imports map[string]*types.Package, data []byte) ([]*types.Package, error)
IImportBundle imports a set of packages from the serialized package bundle.
func IImportData ¶
func IImportData(fset *token.FileSet, imports map[string]*types.Package, data []byte, path string) (int, *types.Package, error)
IImportData imports a package from the serialized package data and returns 0 and a reference to the package. If the export data version is not recognized or the format is otherwise compromised, an error is returned.
func IImportShallow ¶
func IImportShallow(fset *token.FileSet, imports map[string]*types.Package, data []byte, path string, insert InsertType) (*types.Package, error)
IImportShallow decodes "shallow" types.Package data encoded by IExportShallow in the same executable. This function cannot import data from cmd/compile or gcexportdata.Write.
func Import ¶
func Import(packages map[string]*types.Package, path, srcDir string, lookup func(path string) (io.ReadCloser, error)) (pkg *types.Package, err error)
Import imports a gc-generated package given its import path and srcDir, adds the corresponding package object to the packages map, and returns the object. The packages map must contain all packages already imported.
func ImportData ¶
func ImportData(packages map[string]*types.Package, filename, id string, data io.Reader) (pkg *types.Package, err error)
ImportData imports a package by reading the gc-generated export data, adds the corresponding package object to the packages map indexed by id, and returns the object.
The packages map must contains all packages already imported. The data reader position must be the beginning of the export data section. The filename is only used in error messages.
If packages[id] contains the completely imported package, that package can be used directly, and there is no need to call this function (but there is also no harm but for extra time used).
Types ¶
type InsertType ¶
InsertType is the type of a function that creates a types.TypeName object for a named type and inserts it into the scope of the specified Package.
Source Files