123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121 |
- // Copyright 2021 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 (
- "path/filepath"
- "github.com/google/blueprint"
- )
- // Contains support for adding license modules to an sdk.
- func init() {
- RegisterSdkMemberType(LicenseModuleSdkMemberType)
- }
- // licenseSdkMemberType determines how a license module is added to the sdk.
- type licenseSdkMemberType struct {
- SdkMemberTypeBase
- }
- func (l *licenseSdkMemberType) AddDependencies(ctx SdkDependencyContext, dependencyTag blueprint.DependencyTag, names []string) {
- // Add dependencies onto the license module from the sdk module.
- ctx.AddDependency(ctx.Module(), dependencyTag, names...)
- }
- func (l *licenseSdkMemberType) IsInstance(module Module) bool {
- // Verify that the module being added is compatible with this module type.
- _, ok := module.(*licenseModule)
- return ok
- }
- func (l *licenseSdkMemberType) AddPrebuiltModule(ctx SdkMemberContext, member SdkMember) BpModule {
- // Add the basics of a prebuilt module.
- return ctx.SnapshotBuilder().AddPrebuiltModule(member, "license")
- }
- func (l *licenseSdkMemberType) CreateVariantPropertiesStruct() SdkMemberProperties {
- // Create the structure into which the properties of the license module that need to be output to
- // the snapshot will be placed. The structure may be populated with information from a variant or
- // may be used as the destination for properties that are common to a set of variants.
- return &licenseSdkMemberProperties{}
- }
- // LicenseModuleSdkMemberType is the instance of licenseSdkMemberType
- var LicenseModuleSdkMemberType = &licenseSdkMemberType{
- SdkMemberTypeBase{
- PropertyName: "licenses",
- // This should never be added directly to an sdk/module_exports, all license modules should be
- // added indirectly as transitive dependencies of other sdk members.
- BpPropertyNotRequired: true,
- SupportsSdk: true,
- // The snapshot of the license module is just another license module (not a prebuilt). They are
- // internal modules only so will have an sdk specific name that will not clash with the
- // originating source module.
- UseSourceModuleTypeInSnapshot: true,
- },
- }
- var _ SdkMemberType = (*licenseSdkMemberType)(nil)
- // licenseSdkMemberProperties is the set of properties that need to be added to the license module
- // in the snapshot.
- type licenseSdkMemberProperties struct {
- SdkMemberPropertiesBase
- // The kinds of licenses provided by the module.
- License_kinds []string
- // The source paths to the files containing license text.
- License_text Paths
- }
- func (p *licenseSdkMemberProperties) PopulateFromVariant(_ SdkMemberContext, variant Module) {
- // Populate the properties from the variant.
- l := variant.(*licenseModule)
- p.License_kinds = l.properties.License_kinds
- p.License_text = make(Paths, 0, len(l.base().commonProperties.Effective_license_text))
- for _, np := range l.base().commonProperties.Effective_license_text {
- p.License_text = append(p.License_text, np.Path)
- }
- }
- func (p *licenseSdkMemberProperties) AddToPropertySet(ctx SdkMemberContext, propertySet BpPropertySet) {
- // Just pass any specified license_kinds straight through.
- if len(p.License_kinds) > 0 {
- propertySet.AddProperty("license_kinds", p.License_kinds)
- }
- // Copy any license test files to the snapshot into a module specific location.
- if len(p.License_text) > 0 {
- dests := []string{}
- for _, path := range p.License_text {
- // The destination path only uses the path of the license file in the source not the license
- // module name. That ensures that if the same license file is used by multiple license modules
- // that it only gets copied once as the snapshot builder will dedup copies where the source
- // and destination match.
- dest := filepath.Join("licenses", path.String())
- dests = append(dests, dest)
- ctx.SnapshotBuilder().CopyToSnapshot(path, dest)
- }
- propertySet.AddProperty("license_text", dests)
- }
- }
- var _ SdkMemberProperties = (*licenseSdkMemberProperties)(nil)
|