chromeos-config/libcros_config/cros_config_impl.h

// Copyright 2018 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// Library to provide access to the Chrome OS master configuration

#ifndef CHROMEOS_CONFIG_LIBCROS_CONFIG_CROS_CONFIG_IMPL_H_
#define CHROMEOS_CONFIG_LIBCROS_CONFIG_CROS_CONFIG_IMPL_H_

#include "chromeos-config/libcros_config/cros_config_interface.h"
#include "chromeos-config/libcros_config/identity_x86.h"
#include "chromeos-config/libcros_config/identity_arm.h"

#include <map>
#include <memory>
#include <string>
#include <vector>

#include <base/files/file_path.h>
#include <base/values.h>

namespace brillo {

class CrosConfigImpl : public CrosConfigInterface {
 public:
  CrosConfigImpl();
  ~CrosConfigImpl() override;

  // CrosConfig:
  virtual bool GetString(const std::string& path,
                         const std::string& prop,
                         std::string* val_out,
                         std::vector<std::string>* log_msgs_out) = 0;

  // CrosConfigInterface:
  bool GetString(const std::string& path,
                 const std::string& prop,
                 std::string* val_out) override;
  bool GetAbsPath(const std::string& path,
                  const std::string& prop,
                  std::string* val_out) override;

  // Read the config into our internal structures
  // @filepath: path to configuration file (e.g. .dtb).
  // @return true if OK, false on error (which is logged)
  virtual bool ReadConfigFile(const base::FilePath& filepath) = 0;

  // Select the config to use based on the X86 device identity.
  // based identity.
  // @identity: X86 based identity attributes
  // @return true on success, false on failure
  virtual bool SelectConfigByIdentityX86(
      const CrosConfigIdentityX86& identity) = 0;

  // Select the config to use based on the ARM device identity.
  // @identity: ARM based identity attributes
  // @return true on success, false on failure
  virtual bool SelectConfigByIdentityArm(
      const CrosConfigIdentityArm& identity) = 0;

 protected:
  // Runs a quick init check and prints an error to stderr if it fails.
  // @return true if OK, false on error.
  bool InitCheck() const;

  bool inited_;  // true if the class is ready for use (Init*ed)

  // List of target directories used to obtain absolute paths
  std::map<std::string, std::string> target_dirs_;

 private:
  DISALLOW_COPY_AND_ASSIGN(CrosConfigImpl);
};

}  // namespace brillo

#endif  // CHROMEOS_CONFIG_LIBCROS_CONFIG_CROS_CONFIG_IMPL_H_