/* KMBuilderSource.h
 *
 * Copyright (C) 2023 OpenKylin, Inc
 */

#ifndef __BUILD_SOURCE_H__
#define __BUILD_SOURCE_H__

#include <any>
#include <memory>
#include <string>
#include <vector>

#include <yaml-cpp/yaml.h>

#include "common/KMDynamicCreator.h"
#include "common/KMException.h"
#include "common/KMObject.h"
#include "common/KMYAMLNodeHelper.h"

/**
 * @brief : 源基类
 */ 
class KMBuilderSource : public KMObject
{
public:
    enum Type
    {
        SRC_Unknow,
        SRC_Archive,
        SRC_File,
        SRC_Dir,
        SRC_Script,
        SRC_Shell,
        SRC_ExtraData,
        SRC_Patch,
        SRC_Git,
        SRC_Bzr,
        SRC_Svn
    };

    KMBuilderSource();
    ~KMBuilderSource();

    /**
     * @brief : 源工厂方法，根据源类型创建对应的源类型对象
     * @param : [in]，sourceType 源类型
     * @return: std::shared_ptr<KMBuilderSource>，根据源类型创建对应的源类型对象或空
     */ 
    static std::shared_ptr<KMBuilderSource> createSource(const std::string &sourceType);

    /**
     * @brief : 反序列化
     * @param : [in]，sourceNode，清单中的源节点
     */ 
    void deserialize(YAML::Node& sourceNode);
    
    /**
     * @brief : 需要子类实现自身的反序列化
     * @param : [in]，sourceNode，清单中的源节点
     */ 
    virtual void deserializeEx(YAML::Node& sourceNode) {}

    Type type()
    {
        return m_type;
    }

    void setBaseDir(const std::string &baseDir);
    std::string getBaseDir() const;
    std::string getDest() const;
    std::vector<std::string> getOnlyArches() const;
    std::vector<std::string> getSkipArches() const;

    virtual bool isEnable();
    virtual bool downloadSource(const std::string &destDir);
    virtual bool updateSource() { return true; }
    virtual bool ensureSource() = 0;
    virtual bool unzipSource() { return true; }
    
    virtual std::pair<std::string, bool> processNode(std::string path) = 0;

protected:
    // 属性域

    // 将提取此源的源目录中的目录
    std::string m_dest;
    // 如果不是空的，只在列出的arch上构建模块
    std::vector<std::string> m_onlyArches;
    // 不要在列出的任何arch上建造
    std::vector<std::string> m_skipArches;

protected:
    // 数据成员域
    
    // 源类型
    Type m_type = SRC_Unknow;

    // base目录
    std::string m_baseDir;
};

#define REGISTER_SOURCE_TYPE_DYNCREATE(source_type, class_type) REGISTER_DYNCREATE(SourceType_ ## source_type, class_type)

#endif
