android_build.h

Go to the documentation of this file.

//
// Copyright (C) 2025 The Android Open Source Project
//
// 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.
 
#pragma once
 
#include <functional>
#include <ostream>
#include <set>
#include <string_view>
 
#include "cuttlefish/pretty/pretty.h"
#include "cuttlefish/pretty/struct.h"
#include "cuttlefish/result/result.h"
 
namespace cuttlefish {
 
class AndroidBuild {
 public:
  virtual ~AndroidBuild() = default;
 
  virtual std::string Name() const = 0;
 
  virtual PrettyStruct Pretty() = 0;
 
  virtual Result<std::set<std::string, std::less<void>>> Images();
  /*
   * A file on the host that represents an image. If the file is not already
   * stored in a distinct file on the host and `extract` is `true`, it is first
   * saved to the directory provided in `SetExtractDir` and the path to the
   * generated file is returned.  If `SetExtractDir` was never called and the
   * file needs to be extracted, returns an error.
   *
   * It's possible for there to be an image file in `Images()` that cannot be
   * extracted to the filesystem, if a metadata file reports that an image or
   * partition should exist, but it's not actually present anywhere.
   *
   * In general callers should rely on the default `extract = true`, it is used
   * inside the implementation to scan all `AndroidBuild` implementations for
   * any that can provide the file without extracting it.
   */
  virtual Result<std::string> ImageFile(std::string_view name,
                                        bool extract = true);
 
  virtual Result<void> SetExtractDir(std::string_view);
 
  virtual Result<std::set<std::string, std::less<void>>> AbPartitions();
 
  virtual Result<std::set<std::string, std::less<void>>> SystemPartitions();
  virtual Result<std::set<std::string, std::less<void>>> VendorPartitions();
 
  virtual Result<std::set<std::string, std::less<void>>> LogicalPartitions();
  virtual Result<std::set<std::string, std::less<void>>> PhysicalPartitions();
 
  friend std::ostream& operator<<(std::ostream&, const AndroidBuild&);
 
  // For libfmt
  friend std::string format_as(const AndroidBuild&);
};
 
PrettyStruct Pretty(AndroidBuild&,
                    PrettyAdlPlaceholder unused = PrettyAdlPlaceholder());
 
}  // namespace cuttlefish