pulumi/pkg/diag/doc.go
2017-05-18 14:51:52 -07:00

55 lines
1.7 KiB
Go

// Licensed to Pulumi Corporation ("Pulumi") under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// Pulumi licenses this file to You 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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// 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.
package diag
import (
"io/ioutil"
"path/filepath"
)
// Document is a file used during compilation, for which advanced diagnostics, such as line/column numbers, may be
// required. It stores the contents of the entire file so that precise errors can be given; Forget discards them.
type Document struct {
File string
Body []byte
Parent *Document // if this document was generated from another, this will point to it.
}
var _ Diagable = (*Document)(nil) // compile-time assertion that *Document implements Diagable.
func NewDocument(file string) *Document {
return &Document{File: file}
}
func ReadDocument(file string) (*Document, error) {
body, err := ioutil.ReadFile(file)
if err != nil {
return nil, err
}
return &Document{File: file, Body: body}, nil
}
func (doc *Document) Ext() string {
return filepath.Ext(doc.File)
}
func (doc *Document) Forget() {
doc.Body = nil
}
func (doc *Document) Where() (*Document, *Location) {
return doc, nil
}