Rename common to android

Rename the "common" package to "android", because common is too
generic.  Also removes all android.Android naming stutter.

Ran:
gomvpkg -from 'android/soong/common' -to 'android/soong/android'
gorename -from '"android/soong/android".AndroidModuleContext' -to 'ModuleContext'
gorename -from '"android/soong/android".AndroidBaseContext' -to 'BaseContext'
gorename -from '"android/soong/android".AndroidModuleBase' -to 'ModuleBase'
gorename -from '"android/soong/android".AndroidBottomUpMutatorContext' -to 'BottomUpMutatorContext'
gorename -from '"android/soong/android".AndroidTopDownMutatorContext' -to 'TopDownMutatorContext'
gorename -from '"android/soong/android".AndroidModule' -to 'Module'

Change-Id: I3b23590b8ce7c8a1ea1139411d84a53163288da7

1 files changed, 242 insertions, 0 deletions

diff --git a/android/makevars.go b/android/makevars.go
new file mode 100644
index 00000000..d9c5c6d7
--- /dev/null
+++ b/android/makevars.go
@@ -0,0 +1,242 @@
+// Copyright 2016 Google Inc. All rights reserved.
+//
+// Licensed 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 android
+
+import (
+	"bytes"
+	"fmt"
+	"io/ioutil"
+	"os"
+
+	"android/soong"
+
+	"github.com/google/blueprint"
+	"github.com/google/blueprint/proptools"
+)
+
+///////////////////////////////////////////////////////////////////////////////
+// Interface for other packages to use to declare make variables
+type MakeVarsContext interface {
+	Config() Config
+
+	// Verify the make variable matches the Soong version, fail the build
+	// if it does not. If the make variable is empty, just set it.
+	Strict(name, ninjaStr string)
+	// Check to see if the make variable matches the Soong version, warn if
+	// it does not. If the make variable is empty, just set it.
+	Check(name, ninjaStr string)
+
+	// These are equivalent to the above, but sort the make and soong
+	// variables before comparing them. They also show the unique entries
+	// in each list when displaying the difference, instead of the entire
+	// string.
+	StrictSorted(name, ninjaStr string)
+	CheckSorted(name, ninjaStr string)
+}
+
+type MakeVarsProvider func(ctx MakeVarsContext)
+
+func RegisterMakeVarsProvider(pctx blueprint.PackageContext, provider MakeVarsProvider) {
+	makeVarsProviders = append(makeVarsProviders, makeVarsProvider{pctx, provider})
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+func init() {
+	soong.RegisterSingletonType("makevars", makeVarsSingletonFunc)
+}
+
+func makeVarsSingletonFunc() blueprint.Singleton {
+	return &makeVarsSingleton{}
+}
+
+type makeVarsSingleton struct{}
+
+type makeVarsProvider struct {
+	pctx blueprint.PackageContext
+	call MakeVarsProvider
+}
+
+var makeVarsProviders []makeVarsProvider
+
+type makeVarsContext struct {
+	config Config
+	ctx    blueprint.SingletonContext
+	pctx   blueprint.PackageContext
+	vars   []makeVarsVariable
+}
+
+var _ MakeVarsContext = &makeVarsContext{}
+
+type makeVarsVariable struct {
+	name   string
+	value  string
+	sort   bool
+	strict bool
+}
+
+func (s *makeVarsSingleton) GenerateBuildActions(ctx blueprint.SingletonContext) {
+	config := ctx.Config().(Config)
+
+	if !config.EmbeddedInMake() {
+		return
+	}
+
+	outFile := PathForOutput(ctx, "make_vars"+proptools.String(config.ProductVariables.Make_suffix)+".mk").String()
+
+	if ctx.Failed() {
+		return
+	}
+
+	vars := []makeVarsVariable{}
+	for _, provider := range makeVarsProviders {
+		mctx := &makeVarsContext{
+			config: config,
+			ctx:    ctx,
+			pctx:   provider.pctx,
+		}
+
+		provider.call(mctx)
+
+		vars = append(vars, mctx.vars...)
+	}
+
+	if ctx.Failed() {
+		return
+	}
+
+	outBytes := s.writeVars(vars)
+
+	if _, err := os.Stat(outFile); err == nil {
+		if data, err := ioutil.ReadFile(outFile); err == nil {
+			if bytes.Equal(data, outBytes) {
+				return
+			}
+		}
+	}
+
+	if err := ioutil.WriteFile(outFile, outBytes, 0666); err != nil {
+		ctx.Errorf(err.Error())
+	}
+}
+
+func (s *makeVarsSingleton) writeVars(vars []makeVarsVariable) []byte {
+	buf := &bytes.Buffer{}
+
+	fmt.Fprintln(buf, `# Autogenerated file
+
+# Compares SOONG_$(1) against $(1), and warns if they are not equal.
+#
+# If the original variable is empty, then just set it to the SOONG_ version.
+#
+# $(1): Name of the variable to check
+# $(2): If not-empty, sort the values before comparing
+# $(3): Extra snippet to run if it does not match
+define soong-compare-var
+ifneq ($$($(1)),)
+  my_val_make := $(if $(2),$$(sort $$($(1))),$$($(1)))
+  my_val_soong := $(if $(2),$$(sort $$(SOONG_$(1))),$$(SOONG_$(1)))
+  ifneq ($$(my_val_make),$$(my_val_soong))
+    $$(warning $(1) does not match between Make and Soong:)
+    $(if $(2),$$(warning Make  adds: $$(filter-out $$(my_val_soong),$$(my_val_make))),$$(warning Make : $$(my_val_make)))
+    $(if $(2),$$(warning Soong adds: $$(filter-out $$(my_val_make),$$(my_val_soong))),$$(warning Soong: $$(my_val_soong)))
+    $(3)
+  endif
+  my_val_make :=
+  my_val_soong :=
+else
+  $(1) := $$(SOONG_$(1))
+endif
+endef
+
+my_check_failed := false
+
+`)
+
+	// Write all the strict checks out first so that if one of them errors,
+	// we get all of the strict errors printed, but not the non-strict
+	// warnings.
+	for _, v := range vars {
+		if !v.strict {
+			continue
+		}
+
+		sort := ""
+		if v.sort {
+			sort = "true"
+		}
+
+		fmt.Fprintf(buf, "SOONG_%s := %s\n", v.name, v.value)
+		fmt.Fprintf(buf, "$(eval $(call soong-compare-var,%s,%s,my_check_failed := true))\n\n", v.name, sort)
+	}
+
+	fmt.Fprintln(buf, `
+ifneq ($(my_check_failed),false)
+  $(error Soong variable check failed)
+endif
+my_check_failed :=
+
+
+`)
+
+	for _, v := range vars {
+		if v.strict {
+			continue
+		}
+
+		sort := ""
+		if v.sort {
+			sort = "true"
+		}
+
+		fmt.Fprintf(buf, "SOONG_%s := %s\n", v.name, v.value)
+		fmt.Fprintf(buf, "$(eval $(call soong-compare-var,%s,%s))\n\n", v.name, sort)
+	}
+
+	fmt.Fprintln(buf, "\nsoong-compare-var :=")
+
+	return buf.Bytes()
+}
+
+func (c *makeVarsContext) Config() Config {
+	return c.config
+}
+
+func (c *makeVarsContext) addVariable(name, ninjaStr string, strict, sort bool) {
+	value, err := c.ctx.Eval(c.pctx, ninjaStr)
+	if err != nil {
+		c.ctx.Errorf(err.Error())
+	}
+	c.vars = append(c.vars, makeVarsVariable{
+		name:   name,
+		value:  value,
+		strict: strict,
+		sort:   sort,
+	})
+}
+
+func (c *makeVarsContext) Strict(name, ninjaStr string) {
+	c.addVariable(name, ninjaStr, true, false)
+}
+func (c *makeVarsContext) StrictSorted(name, ninjaStr string) {
+	c.addVariable(name, ninjaStr, true, true)
+}
+
+func (c *makeVarsContext) Check(name, ninjaStr string) {
+	c.addVariable(name, ninjaStr, false, false)
+}
+func (c *makeVarsContext) CheckSorted(name, ninjaStr string) {
+	c.addVariable(name, ninjaStr, false, true)
+}