hikyuu 2.1.4__cp311-none-win_amd64.whl → 2.2.0__cp311-none-win_amd64.whl

hikyuu/include/hikyuu/trade_sys/system/crt/SYS_WalkForward.h

@@ -0,0 +1,27 @@
+/*
+ *  Copyright (c) 2019~2023, hikyuu.org
+ *
+ *  History:
+ *    1. 20240916 added by fasiondog
+ */
+
+#pragma once
+
+#include "hikyuu/trade_sys/system/System.h"
+#include "hikyuu/trade_sys/selector/crt/SE_Optimal.h"
+
+namespace hku {
+
+// SystemPtr HKU_API SYS_WalkForward(const SystemList& candidate_sys_list,
+//                                   const TradeManagerPtr& tm = TradeManagerPtr(),
+//                                   size_t train_len = 100, size_t test_len = 20,
+//                                   const string& key = "帐户平均年收益率%",
+//                                   const TradeManagerPtr& train_tm = TradeManagerPtr());
+
+SystemPtr HKU_API SYS_WalkForward(const SystemList& candidate_sys_list,
+                                  const TradeManagerPtr& tm = TradeManagerPtr(),
+                                  size_t train_len = 100, size_t test_len = 20,
+                                  const SelectorPtr& se = SE_MaxFundsOptimal(),
+                                  const TradeManagerPtr& train_tm = TradeManagerPtr());
+
+}  // namespace hku

hikyuu/include/hikyuu/trade_sys/system/imp/DelegateSystem.h

@@ -0,0 +1,51 @@
+/*
+ *  Copyright (c) 2024 hikyuu.org
+ *
+ *  Created on: 2024-09-13
+ *      Author: fasiondog
+ */
+
+#pragma once
+#include "../System.h"
+
+namespace hku {
+
+class HKU_API DelegateSystem : public System {
+public:
+    DelegateSystem() = default;
+    explicit DelegateSystem(const string& name) : System(name) {}
+    explicit DelegateSystem(const SystemPtr& sys) : m_sys(sys) {}
+    virtual ~DelegateSystem() = default;
+
+    virtual void run(const KData& kdata, bool reset = true, bool resetAll = false) override;
+    virtual TradeRecord runMoment(const Datetime& datetime) override;
+
+    virtual void _reset() override;
+    virtual void _forceResetAll() override;
+    virtual SystemPtr _clone() override;
+
+public:
+    virtual TradeRecord sellForceOnOpen(const Datetime& date, double num, Part from) override;
+    virtual TradeRecord sellForceOnClose(const Datetime& date, double num, Part from) override;
+    virtual void clearDelayBuyRequest() override;
+    virtual bool haveDelaySellRequest() const override;
+    virtual TradeRecord pfProcessDelaySellRequest(const Datetime& date) override;
+
+private:
+    SystemPtr m_sys;
+
+//========================================
+// 序列化支持
+//========================================
+#if HKU_SUPPORT_SERIALIZATION
+private:
+    friend class boost::serialization::access;
+    template <class Archive>
+    void serialize(Archive& ar, const unsigned int version) {
+        ar& BOOST_SERIALIZATION_BASE_OBJECT_NVP(System);
+        ar& BOOST_SERIALIZATION_NVP(m_sys);
+    }
+#endif /* HKU_SUPPORT_SERIALIZATION */
+};
+
+}  // namespace hku

hikyuu/include/hikyuu/trade_sys/system/imp/WalkForwardSystem.h

@@ -0,0 +1,70 @@
+/*
+ *  Copyright (c) 2024 hikyuu.org
+ *
+ *  Created on: 2024-09-13
+ *      Author: fasiondog
+ */
+
+#pragma once
+
+#include "hikyuu/trade_sys/selector/SelectorBase.h"
+#include "../System.h"
+
+namespace hku {
+
+class HKU_API WalkForwardSystem : public System {
+    CLASS_LOGGER_IMP(SYS_WalkForward)
+
+public:
+    WalkForwardSystem();
+    WalkForwardSystem(const SystemList& candidate_sys_list, const SelectorPtr& se,
+                      const TradeManagerPtr& train_tm);
+    virtual ~WalkForwardSystem() = default;
+
+    virtual void readyForRun() override;
+    virtual void run(const KData& kdata, bool reset = true, bool resetAll = false) override;
+    virtual TradeRecord runMoment(const Datetime& datetime) override;
+
+    virtual void _checkParam(const string& name) const override;
+    virtual void _reset() override;
+    virtual void _forceResetAll() override;
+    virtual SystemPtr _clone() override;
+
+    virtual string str() const override;
+
+public:
+    virtual TradeRecord sellForceOnOpen(const Datetime& date, double num, Part from) override;
+    virtual TradeRecord sellForceOnClose(const Datetime& date, double num, Part from) override;
+    virtual void clearDelayBuyRequest() override;
+    virtual bool haveDelaySellRequest() const override;
+    virtual TradeRecord pfProcessDelaySellRequest(const Datetime& date) override;
+
+private:
+    void initParam();
+    void syncDataFromSystem(const SYSPtr&, bool isMoment);
+    void syncDataToSystem(const SYSPtr&);
+
+private:
+    SEPtr m_se;        // 寻优SE
+    TMPtr m_train_tm;  // 用于优化评估计算的账户
+    SYSPtr m_cur_sys;
+    size_t m_cur_kdata{0};
+    vector<KData> m_train_kdata_list;
+    vector<RunRanges> m_run_ranges;
+
+//========================================
+// 序列化支持
+//========================================
+#if HKU_SUPPORT_SERIALIZATION
+private:
+    friend class boost::serialization::access;
+    template <class Archive>
+    void serialize(Archive& ar, const unsigned int version) {
+        ar& BOOST_SERIALIZATION_BASE_OBJECT_NVP(System);
+        ar& BOOST_SERIALIZATION_NVP(m_se);
+        ar& BOOST_SERIALIZATION_NVP(m_train_tm);
+    }
+#endif /* HKU_SUPPORT_SERIALIZATION */
+};
+
+}  // namespace hku

hikyuu/include/hikyuu/trade_sys/system/imp/WalkForwardTradeManager.h

@@ -0,0 +1,465 @@
+/*
+ *  Copyright (c) 2024 hikyuu.org
+ *
+ *  Created on: 2024-09-19
+ *      Author: fasiondog
+ */
+
+#pragma once
+
+#include "hikyuu/trade_manage/TradeManagerBase.h"
+
+namespace hku {
+
+class WalkForwardTradeManager : public TradeManagerBase {
+public:
+    WalkForwardTradeManager() : TradeManagerBase("", TC_Zero()) {}
+
+    // 只允许执行>=run_start的实际交易
+    WalkForwardTradeManager(const TMPtr& tm, const Datetime& run_start) : m_run_start(run_start) {
+        HKU_ASSERT(tm);
+        m_tm = tm;
+
+        m_name = tm->name();
+        m_costfunc = m_tm->costFunc();
+    }
+
+    virtual ~WalkForwardTradeManager() {}
+
+    virtual void _reset() override {
+        m_tm->_reset();
+    }
+
+    virtual shared_ptr<TradeManagerBase> _clone() override {
+        WalkForwardTradeManager* p = new WalkForwardTradeManager();
+        p->m_tm = m_tm->clone();
+        p->m_run_start = m_run_start;
+        return shared_ptr<TradeManagerBase>(p);
+    }
+
+    /**
+     * 根据权息信息更新当前持仓与交易情况
+     * @note 必须按时间顺序调用
+     * @param datetime 当前时刻
+     */
+    virtual void updateWithWeight(const Datetime& datetime) override {
+        m_tm->updateWithWeight(datetime);
+    }
+
+    /**
+     * 获取指定对象的保证金比率
+     * @param datetime 日期
+     * @param stock 指定对象
+     */
+    virtual double getMarginRate(const Datetime& datetime, const Stock& stock) override {
+        return (datetime >= m_run_start) ? m_tm->getMarginRate(datetime, stock) : 0.0;
+    }
+
+    /** 初始资金 */
+    virtual price_t initCash() const override {
+        return m_tm->initCash();
+    }
+
+    /** 账户建立日期 */
+    virtual Datetime initDatetime() const override {
+        return m_tm->initDatetime();
+    }
+
+    /** 第一笔买入交易发生日期，如未发生交易返回Null<Datetime>() */
+    virtual Datetime firstDatetime() const override {
+        return m_tm->firstDatetime();
+    }
+
+    /** 最后一笔交易日期，注意和交易类型无关，如未发生交易返回账户建立日期 */
+    virtual Datetime lastDatetime() const override {
+        return m_tm->lastDatetime();
+    }
+
+    /**
+     * 返回当前现金
+     * @note 仅返回当前信息，不会根据权息进行调整
+     */
+    virtual price_t currentCash() const override {
+        return m_tm->currentCash();
+    }
+
+    /**
+     * 获取指定日期的现金
+     * @note 如果不带日期参数，无法根据权息信息调整持仓
+     */
+    virtual price_t cash(const Datetime& datetime, KQuery::KType ktype = KQuery::DAY) override {
+        return m_tm->cash(datetime, ktype);
+    }
+
+    /**
+     * 当前是否持有指定的证券
+     * @note 这里未使用日期参数，必须保证是按日期顺序执行
+     * @param stock 指定证券
+     * @return true 是 | false 否
+     */
+    virtual bool have(const Stock& stock) const override {
+        return m_tm->have(stock);
+    }
+
+    /**
+     * 当前空头仓位是否持有指定的证券
+     * @note 这里未使用日期参数，必须保证是按日期顺序执行
+     * @param stock 指定证券
+     * @return true 是 | false 否
+     */
+    virtual bool haveShort(const Stock& stock) const override {
+        return m_tm->haveShort(stock);
+    }
+
+    /** 当前持有的证券种类数量 */
+    virtual size_t getStockNumber() const override {
+        return m_tm->getStockNumber();
+    }
+
+    /** 当前空头持有的证券种类数量 */
+    virtual size_t getShortStockNumber() const override {
+        return m_tm->getShortStockNumber();
+    }
+
+    /** 获取指定时刻的某证券持有数量 */
+    virtual double getHoldNumber(const Datetime& datetime, const Stock& stock) override {
+        return m_tm->getHoldNumber(datetime, stock);
+    }
+
+    /** 获取指定时刻的空头某证券持有数量 */
+    virtual double getShortHoldNumber(const Datetime& datetime, const Stock& stock) override {
+        return m_tm->getShortHoldNumber(datetime, stock);
+    }
+
+    /** 获取指定时刻已借入的股票数量 */
+    virtual double getDebtNumber(const Datetime& datetime, const Stock& stock) override {
+        return m_tm->getDebtNumber(datetime, stock);
+    }
+
+    /** 获取指定时刻已借入的现金额 */
+    virtual price_t getDebtCash(const Datetime& datetime) override {
+        return m_tm->getDebtCash(datetime);
+    }
+
+    /** 获取全部交易记录 */
+    virtual TradeRecordList getTradeList() const override {
+        return m_tm->getTradeList();
+    }
+
+    /**
+     * 获取指定日期范围内的交易记录[start, end)
+     * @param start 起始日期
+     * @param end 结束日期
+     * @return 交易记录列表
+     */
+    virtual TradeRecordList getTradeList(const Datetime& start,
+                                         const Datetime& end) const override {
+        return m_tm->getTradeList(start, end);
+    }
+
+    /** 获取当前全部持仓记录 */
+    virtual PositionRecordList getPositionList() const override {
+        return m_tm->getPositionList();
+    }
+
+    /** 获取全部历史持仓记录，即已平仓记录 */
+    virtual PositionRecordList getHistoryPositionList() const override {
+        return m_tm->getHistoryPositionList();
+    }
+
+    /** 获取当前全部空头仓位记录 */
+    virtual PositionRecordList getShortPositionList() const override {
+        return m_tm->getShortPositionList();
+    }
+
+    /** 获取全部空头历史仓位记录 */
+    virtual PositionRecordList getShortHistoryPositionList() const override {
+        return m_tm->getShortHistoryPositionList();
+    }
+
+    /**
+     * 获取指定证券的持仓记录
+     * @param date 指定日期
+     * @param stock 指定的证券
+     */
+    virtual PositionRecord getPosition(const Datetime& date, const Stock& stock) override {
+        return m_tm->getPosition(date, stock);
+    }
+
+    /**
+     * 获取指定证券的空头持仓记录
+     * @param stock 指定的证券
+     */
+    virtual PositionRecord getShortPosition(const Stock& stock) const override {
+        return m_tm->getShortPosition(stock);
+    }
+
+    /** 获取当前借入的股票列表 */
+    virtual BorrowRecordList getBorrowStockList() const override {
+        return m_tm->getBorrowStockList();
+    }
+
+    /**
+     * 存入资金
+     * @param datetime 存入时间
+     * @param cash 存入的资金量
+     * @return true | false
+     */
+    virtual bool checkin(const Datetime& datetime, price_t cash) override {
+        return (datetime >= m_run_start) ? m_tm->checkin(datetime, cash) : false;
+    }
+
+    /**
+     * 取出资金
+     * @param datetime 取出时间
+     * @param cash 取出的资金量
+     * @return true | false
+     */
+    virtual bool checkout(const Datetime& datetime, price_t cash) override {
+        return (datetime >= m_run_start) ? m_tm->checkout(datetime, cash) : false;
+    }
+
+    /**
+     * 存入资产
+     * @param datetime 存入日期
+     * @param stock 待存入的股票
+     * @param price 存入股票的每股价格
+     * @param number 存入股票的数量
+     * @return true | false
+     */
+    virtual bool checkinStock(const Datetime& datetime, const Stock& stock, price_t price,
+                              double number) override {
+        return (datetime >= m_run_start) ? m_tm->checkinStock(datetime, stock, price, number)
+                                         : false;
+    }
+
+    /**
+     * 取出当前资产
+     * @param datetime 取出日期
+     * @param stock 待取出的股票
+     * @param price 取出的每股价格
+     * @param number 取出的数量
+     * @return true | false
+     * @note 应该不会被用到
+     */
+    virtual bool checkoutStock(const Datetime& datetime, const Stock& stock, price_t price,
+                               double number) override {
+        return (datetime >= m_run_start) ? m_tm->checkoutStock(datetime, stock, price, number)
+                                         : false;
+    }
+
+    /**
+     * 买入操作
+     * @param datetime 买入时间
+     * @param stock 买入的证券
+     * @param realPrice 实际买入价格
+     * @param number 买入数量
+     * @param stoploss 止损价
+     * @param goalPrice 目标价格
+     * @param planPrice 计划买入价格
+     * @param from 记录是哪个系统部件发出的买入指示
+     * @return 返回对应的交易记录，如果操作失败，business等于BUSINESS_INVALID
+     */
+    virtual TradeRecord buy(const Datetime& datetime, const Stock& stock, price_t realPrice,
+                            double number, price_t stoploss = 0.0, price_t goalPrice = 0.0,
+                            price_t planPrice = 0.0, SystemPart from = PART_INVALID) override {
+        return (datetime >= m_run_start) ? m_tm->buy(datetime, stock, realPrice, number, stoploss,
+                                                     goalPrice, planPrice, from)
+                                         : TradeRecord();
+    }
+
+    /**
+     * 卖出操作
+     * @param datetime 卖出时间
+     * @param stock 卖出的证券
+     * @param realPrice 实际卖出价格
+     * @param number 卖出数量，如果是 MAX_DOUBLE, 表示全部卖出
+     * @param stoploss 新的止损价
+     * @param goalPrice 新的目标价格
+     * @param planPrice 原计划卖出价格
+     * @param from 记录是哪个系统部件发出的卖出指示
+     * @return 返回对应的交易记录，如果操作失败，business等于BUSINESS_INVALID
+     */
+    virtual TradeRecord sell(const Datetime& datetime, const Stock& stock, price_t realPrice,
+                             double number = MAX_DOUBLE, price_t stoploss = 0.0,
+                             price_t goalPrice = 0.0, price_t planPrice = 0.0,
+                             SystemPart from = PART_INVALID) override {
+        return (datetime >= m_run_start) ? m_tm->sell(datetime, stock, realPrice, number, stoploss,
+                                                      goalPrice, planPrice, from)
+                                         : TradeRecord();
+    }
+
+    /**
+     * 卖空
+     * @param datetime 卖空时间
+     * @param stock 卖空的证券
+     * @param realPrice 实际卖空价格
+     * @param number 卖出数量
+     * @param stoploss 止损价
+     * @param goalPrice 目标价格
+     * @param planPrice 计划卖空价格
+     * @param from 记录是哪个系统部件发出的买入指示
+     * @return 返回对应的交易记录，如果操作失败，business等于BUSINESS_INVALID
+     */
+    virtual TradeRecord sellShort(const Datetime& datetime, const Stock& stock, price_t realPrice,
+                                  double number, price_t stoploss = 0.0, price_t goalPrice = 0.0,
+                                  price_t planPrice = 0.0,
+                                  SystemPart from = PART_INVALID) override {
+        return (datetime >= m_run_start) ? m_tm->sellShort(datetime, stock, realPrice, number,
+                                                           stoploss, goalPrice, planPrice, from)
+                                         : TradeRecord();
+    }
+
+    /**
+     * 卖空后回补
+     * @param datetime 买入时间
+     * @param stock 买入的证券
+     * @param realPrice 实际买入价格
+     * @param number 卖出数量，如果是 MAX_DOUBLE, 表示全部卖出
+     * @param stoploss 止损价
+     * @param goalPrice 目标价格
+     * @param planPrice 计划买入价格
+     * @param from 记录是哪个系统部件发出的卖出指示
+     * @return 返回对应的交易记录，如果操作失败，business等于BUSINESS_INVALID
+     */
+    virtual TradeRecord buyShort(const Datetime& datetime, const Stock& stock, price_t realPrice,
+                                 double number = MAX_DOUBLE, price_t stoploss = 0.0,
+                                 price_t goalPrice = 0.0, price_t planPrice = 0.0,
+                                 SystemPart from = PART_INVALID) override {
+        return (datetime >= m_run_start) ? m_tm->buyShort(datetime, stock, realPrice, number,
+                                                          stoploss, goalPrice, planPrice, from)
+                                         : TradeRecord();
+    }
+
+    /**
+     * 借入资金，从其他来源借取的资金，如融资
+     * @param datetime 借入时间
+     * @param cash 借入的现金
+     * @return true | false
+     */
+    virtual bool borrowCash(const Datetime& datetime, price_t cash) override {
+        return (datetime >= m_run_start) ? m_tm->borrowCash(datetime, cash) : false;
+    }
+
+    /**
+     * 归还资金
+     * @param datetime 归还日期
+     * @param cash 归还现金
+     * @return true | false
+     */
+    virtual bool returnCash(const Datetime& datetime, price_t cash) override {
+        return (datetime >= m_run_start) ? m_tm->returnCash(datetime, cash) : false;
+    }
+
+    /**
+     * 借入证券
+     * @param datetime 借入时间
+     * @param stock 借入的stock
+     * @param price 借入时单股价格
+     * @param number 借入时数量
+     * @return true | false
+     */
+    virtual bool borrowStock(const Datetime& datetime, const Stock& stock, price_t price,
+                             double number) override {
+        return (datetime >= m_run_start) ? m_tm->borrowStock(datetime, stock, price, number)
+                                         : false;
+    }
+
+    /**
+     * 归还证券
+     * @param datetime 归还时间
+     * @param stock 归还的stock
+     * @param price 归还时单股价格
+     * @param number 归还数量
+     * @return true | false
+     */
+    virtual bool returnStock(const Datetime& datetime, const Stock& stock, price_t price,
+                             double number) override {
+        return (datetime >= m_run_start) ? m_tm->returnStock(datetime, stock, price, number)
+                                         : false;
+    }
+
+    /**
+     * 获取账户当前时刻的资产详情
+     * @param ktype 日期的类型
+     * @return 资产详情
+     */
+    virtual FundsRecord getFunds(KQuery::KType ktype = KQuery::DAY) const override {
+        return m_tm->getFunds(ktype);
+    }
+
+    /**
+     * 获取指定时刻的资产市值详情
+     * @param datetime 必须大于帐户建立的初始日期，或为Null<Datetime>()
+     * @param ktype 日期的类型
+     * @return 资产详情
+     * @note 当datetime等于Null<Datetime>()时，与getFunds(KType)同
+     */
+    virtual FundsRecord getFunds(const Datetime& datetime,
+                                 KQuery::KType ktype = KQuery::DAY) override {
+        return m_tm->getFunds(datetime, ktype);
+    }
+
+    /**
+     * 直接加入交易记录
+     * @note 如果加入初始化账户记录，将清除全部已有交易及持仓记录
+     * @param tr 待加入的交易记录
+     * @return bool true 成功 | false 失败
+     */
+    virtual bool addTradeRecord(const TradeRecord& tr) override {
+        return (tr.datetime >= m_run_start) ? m_tm->addTradeRecord(tr) : false;
+    }
+
+    /**
+     * 直接加入持仓记录
+     * @param pr 持仓记录
+     * @return true 成功
+     * @return false 失败
+     */
+    virtual bool addPosition(const PositionRecord& pr) override {
+        return m_tm->addPosition(pr);
+    }
+
+    /** 字符串输出 */
+    virtual string str() const override {
+        return m_tm->str();
+    }
+
+    /**
+     * 以csv格式输出交易记录、未平仓记录、已平仓记录、资产净值曲线
+     * @param path 输出文件所在目录
+     */
+    virtual void tocsv(const string& path) override {
+        m_tm->tocsv(path);
+    }
+
+    /**
+     * 从订单代理实例同步当前账户资产信息（包含资金、持仓等）
+     * @param broker 订单代理实例
+     */
+    virtual void fetchAssetInfoFromBroker(const OrderBrokerPtr& broker) override {
+        m_tm->fetchAssetInfoFromBroker(broker);
+    }
+
+private:
+    TMPtr m_tm;
+    Datetime m_run_start;
+
+//============================================
+// 序列化支持
+//============================================
+#if HKU_SUPPORT_SERIALIZATION
+    friend class boost::serialization::access;
+    template <class Archive>
+    void serialize(Archive& ar, const unsigned int version) {
+        ar& BOOST_SERIALIZATION_BASE_OBJECT_NVP(TradeManagerBase);
+        ar& BOOST_SERIALIZATION_NVP(m_tm);
+    }
+#endif /* HKU_SUPPORT_SERIALIZATION */
+};
+
+inline TMPtr crtWalkForwardTM(const TMPtr& tm, const Datetime& run_start) {
+    return std::make_shared<WalkForwardTradeManager>(tm, run_start);
+}
+
+}  // namespace hku

hikyuu/include/hikyuu/utilities/base64.h

@@ -1,9 +1,7 @@
-/*
- *  Copyright (c) hikyuu.org
- *
- *  Created on: 2020-6-2
- *      Author: fasiondog
- */
+//
+//  base64 encoding and decoding with C++.
+//  Version: 2.rc.08 (release candidate)
+//
 
 #pragma once
 #ifndef HKU_UTILS_BASE64_H
@@ -18,40 +16,36 @@
 
 namespace hku {
 
-/**
- * 将二进制 bytes 数组编码成 base64 字符串
- * @param bytes_to_encode 内存起始地址
- * @param in_len 待计算的字节长度
- */
-std::string HKU_UTILS_API base64_encode(unsigned char const* bytes_to_encode, size_t in_len);
-
-/**
- * 字符串编码为 base64
- * @param src 输入字符串
- * @note 通过 func(unsigned char *, unsigned int) 函数实现，而不是直接只提供 string_view
- * 版本的原因是：c++17 string_view 处理 nullptr 时，程序会直接挂掉，无异常
- */
-inline std::string base64_encode(string_view src) {
-    return base64_encode((unsigned char const*)src.data(), src.size());
-}
-
 /**
  * 将 base64 字符串解码
  * @param encoded_string base64 编码的字符串
- * @param in_len 字符串长度
+ * @param remove_linebreaks 是否移除url中的分隔符
  * @return string 实际解码后的二进制内容保存在返回的字符串对象中
  * @note 如果传入的base64编码字符串中含有非法字符，不会告警，仅处理到能处理的字符
  */
-std::string HKU_UTILS_API base64_decode(unsigned char const* encoded_string, size_t in_len);
+std::string HKU_UTILS_API base64_decode(std::string const& encoded_string,
+                                        bool remove_linebreaks = false);
 
 /**
- * 将 base64 字符串解码
- * @param encoded_string base64 编码的字符串
- * @return string 实际解码后的二进制内容保存在返回的字符串对象中
+ * 将二进制 bytes 数组编码成 base64 字符串
+ * @param bytes_to_encode 内存起始地址
+ * @param in_len 待计算的字节长度
+ * @param url 是否为在 url 中使用
  */
-inline std::string base64_decode(string_view encoded_string) {
-    return base64_decode((unsigned char const*)encoded_string.data(), encoded_string.size());
-}
+std::string HKU_UTILS_API base64_encode(unsigned char const* bytes_to_encode, size_t in_len,
+                                        bool url = false);
+
+std::string HKU_UTILS_API base64_encode(const std::string& s, bool url = false);
+std::string HKU_UTILS_API base64_encode_pem(const std::string& s);
+std::string HKU_UTILS_API base64_encode_mime(const std::string& s);
+
+#if __cplusplus >= 201703L
+std::string HKU_UTILS_API base64_encode(string_view s, bool url = false);
+std::string HKU_UTILS_API base64_encode_pem(string_view s);
+std::string HKU_UTILS_API base64_encode_mime(string_view s);
+
+std::string HKU_UTILS_API base64_decode(string_view s, bool remove_linebreaks = false);
+#endif  // __cplusplus >= 201703L
 
 }  // namespace hku