RteExample.h

#ifndef RteExample_H
#define RteExample_H
/******************************************************************************/
/* RTE - CMSIS Run-Time Environment */
/******************************************************************************/
/** @file RteExample.h
* @brief CMSIS RTE Data Model
*/
/******************************************************************************/
/*
 * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
/******************************************************************************/
#include "RteItem.h"
#include "RteFile.h"

/**
 * @brief class presenting an example project with related files and properties
 * Children contain project files for different environments
*/
class RteExample : public RteItem
{
public:
  /**
   * @brief constructor
   * @param parent pointer to RteItem parent
  */
  RteExample(RteItem* parent);
  /**
   * @brief virtual destructor
  */
   ~RteExample() override;

  /**
   * @brief get collection of keywords in example meta-data
   * @return set of strings
  */
  const std::set<std::string>& GetKeywords() const { return m_keywords; }
  /**
   * @brief get collection of categories in example meta-data
   * @return set of strings
  */
  const std::set<std::string>& GetCategories() const { return m_categories; }

  /**
   * @brief get information about board for which the example is created
   * @return board information as RteItem pointer
  */
  const RteItem* GetBoardInfoItem() const { return m_board; }

  /**
   * @brief get board name for which the example is created
   * @return board name
  */
  const std::string& GetBoardName() const { return m_board ? m_board->GetAttribute("name") : EMPTY_STRING; }

  /**
     * @brief get board vendor name for which the example is created
     * @return board vendor name
    */
  const std::string& GetBoardVendor() const { return m_board ? m_board->GetAttribute("vendor") : EMPTY_STRING; }

public:
  /**
   * @brief check if example meta-data contain the specified keyword
   * @param keyword string to search for in the collection of keywords
   * @return true if found
  */
  bool HasKeyword(const std::string& keyword) const;
  /**
   * @brief check if example meta-data contain all specified keywords
   * @param keywords collections of keyword to search for
   * @return true if all supplied keywords are found
  */
  bool HasKeywords(const std::set<std::string>& keywords) const;
  /**
   * @brief check if example meta-data contain the specified category string
   * @param category category string to search for
   * @return true if found
  */
  bool HasCategory(const std::string& category) const;
  /**
   * @brief check if example meta-data contain all specified categories
   * @param categories collections of categories to search for
   * @return true if all supplied categories are found
  */
  bool HasCategories(const std::set<std::string>& categories) const;

  /**
   * @brief clear internal data and call base class implementation
  */
  void Clear() override;

  /**
   * @brief called to construct the item with attributes and child elements
  */
  void Construct() override;

  /**
   * @brief create a new instance of type RteItem
   * @param tag name of tag
   * @return pointer to instance of type RteItem
  */
  RteItem* CreateItem(const std::string& tag) override;

  /**
   * @brief validate item after construction
   * @return true if valid
  */
   bool Validate() override;

  /**
   * @brief get name to display to user
   * @return example name
  */
   std::string GetDisplayName() const override { return GetName(); }

  /**
   * @brief get example vendor
   * @return vendor string
  */
   const std::string& GetVendorString() const override;
  /**
   * @brief get example version
   * @return version string
  */
   const std::string& GetVersionString() const override;

  /**
   * @brief get project pathname to load in the specified development environment
   * @param env development environment name
   * @return project pathname for specified environment if supported, empty string otherwise
  */
  virtual const std::string& GetLoadPath(const std::string& env) const;

  /**
   * @brief get attribute value specified for given development environment
   * @param env development environment name
   * @param attribute attribute name
   * @return attribute value if found, empty string otherwise
  */
  virtual const std::string& GetEnvironmentAttribute(const std::string& env, const std::string& attribute) const;

protected:
  /**
   * @brief construct example ID
   * @return example ID string constructed out of name, board name and board vendor
  */
   std::string ConstructID() override;

  RteItem* m_board; // development board the example refers to
  std::set<std::string> m_keywords; // example keywords
  std::set<std::string> m_categories; // example categories
  Collection<RteItem*> m_componentAttributes; // component attributes of a component this example refers
  // Note: RteItem::m_children contain project files for different environments
};
/**
 * @brief alpha-numerically sorted map of name to RteExample pointer pairs
*/
typedef std::map<std::string, RteExample*, AlnumCmp::LenLessNoCase > RteExampleMap;

/**
 * @brief class representing <examples> section of pdsc file
*/
class RteExampleContainer : public RteItem
{
public:
  /**
   * @brief constructor
   * @param parent pointer to RteItem parent
  */
  RteExampleContainer(RteItem* parent);

  /**
   * @brief create a new instance of type RteItem
   * @param tag name of tag
   * @return pointer to instance of type RteItem
  */
  RteItem* CreateItem(const std::string& tag) override;
};

#endif // RteExample_H