Dramatically simplified SourceFile object

Removed dependency from types.Context

Author: cmaglie

legacy/builder/container_find_includes.go

@@ -286,10 +286,10 @@ func writeCache(cache *includeCache, path *paths.Path) error {
 }
 
 func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile *types.SourceFile) error {
-	sourcePath := sourceFile.SourcePath(ctx)
+	sourcePath := sourceFile.SourcePath()
 	targetFilePath := paths.NullPath()
-	depPath := sourceFile.DepfilePath(ctx)
-	objPath := sourceFile.ObjectPath(ctx)
+	depPath := sourceFile.DepfilePath()
+	objPath := sourceFile.ObjectPath()
 
 	// TODO: This should perhaps also compare against the
 	// include.cache file timestamp. Now, it only checks if the file
@@ -313,11 +313,11 @@ func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile *
 		cache.ExpectFile(sourcePath)
 
 		includes := ctx.IncludeFolders
-		if library, ok := sourceFile.Origin.(*libraries.Library); ok && library.UtilityDir != nil {
+		if library := sourceFile.Library; library != nil && library.UtilityDir != nil {
 			includes = append(includes, library.UtilityDir)
 		}
 
-		if library, ok := sourceFile.Origin.(*libraries.Library); ok {
+		if library := sourceFile.Library; library != nil {
 			if library.Precompiled && library.PrecompiledWithSources {
 				// Fully precompiled libraries should have no dependencies
 				// to avoid ABI breakage

legacy/builder/types/types.go

@@ -25,69 +25,70 @@ import (
 )
 
 type SourceFile struct {
-	// Sketch or Library pointer that this source file lives in
-	Origin interface{}
 	// Path to the source file within the sketch/library root folder
 	RelativePath *paths.Path
+
+	// Set to the Library object of origin if this source file comes
+	// from a library
+	Library *libraries.Library
+
+	// The source root for the given origin, where its source files
+	// can be found. Prepending this to SourceFile.RelativePath will give
+	// the full path to that source file.
+	sourceRoot *paths.Path
+
+	// The build root for the given origin, where build products will
+	// be placed. Any directories inside SourceFile.RelativePath will be
+	// appended here.
+	buildRoot *paths.Path
 }
 
 func (f *SourceFile) Equals(g *SourceFile) bool {
-	return f.Origin == g.Origin &&
-		f.RelativePath.EqualsTo(g.RelativePath)
+	return f.Library == g.Library &&
+		f.RelativePath.EqualsTo(g.RelativePath) &&
+		f.buildRoot.EqualsTo(g.buildRoot) &&
+		f.sourceRoot.EqualsTo(g.sourceRoot)
 }
 
 // Create a SourceFile containing the given source file path within the
 // given origin. The given path can be absolute, or relative within the
 // origin's root source folder
 func MakeSourceFile(ctx *Context, origin interface{}, path *paths.Path) (*SourceFile, error) {
-	if path.IsAbs() {
-		var err error
-		path, err = sourceRoot(ctx, origin).RelTo(path)
-		if err != nil {
-			return nil, err
-		}
-	}
-	return &SourceFile{Origin: origin, RelativePath: path}, nil
-}
+	res := &SourceFile{}
 
-// Return the build root for the given origin, where build products will
-// be placed. Any directories inside SourceFile.RelativePath will be
-// appended here.
-func buildRoot(ctx *Context, origin interface{}) *paths.Path {
 	switch o := origin.(type) {
 	case *sketch.Sketch:
-		return ctx.SketchBuildPath
+		res.buildRoot = ctx.SketchBuildPath
+		res.sourceRoot = ctx.SketchBuildPath
 	case *libraries.Library:
-		return ctx.LibrariesBuildPath.Join(o.Name)
+		res.buildRoot = ctx.LibrariesBuildPath.Join(o.Name)
+		res.sourceRoot = o.SourceDir
+		res.Library = o
 	default:
 		panic("Unexpected origin for SourceFile: " + fmt.Sprint(origin))
 	}
-}
 
-// Return the source root for the given origin, where its source files
-// can be found. Prepending this to SourceFile.RelativePath will give
-// the full path to that source file.
-func sourceRoot(ctx *Context, origin interface{}) *paths.Path {
-	switch o := origin.(type) {
-	case *sketch.Sketch:
-		return ctx.SketchBuildPath
-	case *libraries.Library:
-		return o.SourceDir
-	default:
-		panic("Unexpected origin for SourceFile: " + fmt.Sprint(origin))
+	if path.IsAbs() {
+		var err error
+		path, err = res.sourceRoot.RelTo(path)
+		if err != nil {
+			return nil, err
+		}
 	}
+	res.RelativePath = path
+	return res, nil
 }
 
-func (f *SourceFile) SourcePath(ctx *Context) *paths.Path {
-	return sourceRoot(ctx, f.Origin).JoinPath(f.RelativePath)
+func (f *SourceFile) SourcePath() *paths.Path {
+	return f.sourceRoot.JoinPath(f.RelativePath)
 }
 
-func (f *SourceFile) ObjectPath(ctx *Context) *paths.Path {
-	return buildRoot(ctx, f.Origin).Join(f.RelativePath.String() + ".o")
+func (f *SourceFile) ObjectPath() *paths.Path {
+	return f.buildRoot.Join(f.RelativePath.String() + ".o")
 }
 
-func (f *SourceFile) DepfilePath(ctx *Context) *paths.Path {
-	return buildRoot(ctx, f.Origin).Join(f.RelativePath.String() + ".d")
+func (f *SourceFile) DepfilePath() *paths.Path {
+	return f.buildRoot.Join(f.RelativePath.String() + ".d")
 }
 
 type SketchFile struct {