Annotation of nono/lib/object.h, revision 1.1.1.16

1.1       root        1: //
                      2: // nono
1.1.1.3   root        3: // Copyright (C) 2020 nono project
                      4: // Licensed under nono-license.txt
1.1       root        5: //
                      6: 
1.1.1.8   root        7: //
                      8: // 基本オブジェクト
                      9: //
                     10: 
1.1       root       11: #pragma once
                     12: 
1.1.1.6   root       13: #include "mystring.h"
1.1.1.9   root       14: #include "object_id.h"
1.1.1.6   root       15: #include <functional>
1.1       root       16: #include <vector>
                     17: 
1.1.1.8   root       18: class Logger;
1.1.1.13  root       19: class Monitor;
                     20: class TextScreen;
1.1.1.8   root       21: 
1.1.1.9   root       22: // オブジェクト ID
1.1.1.12  root       23: static constexpr uint OBJ_BANKRAM(uint n) { return OBJ_BANKRAM0 + n; }
1.1.1.16! root       24: static constexpr uint OBJ_DMAC_CH(uint n) { return OBJ_DMAC_CH0 + n; }
1.1.1.12  root       25: static constexpr uint OBJ_ETHERNET(uint n) { return OBJ_ETHERNET0 + n; }
                     26: static constexpr uint OBJ_FDD(uint n) { return OBJ_FDD0 + n; }
                     27: static constexpr uint OBJ_GFPIC(uint n) { return OBJ_GFPIC0 + n; }
1.1.1.14  root       28: static constexpr uint OBJ_HOSTCOM(uint n) { return OBJ_HOSTCOM0 + n; }
1.1.1.12  root       29: static constexpr uint OBJ_HOSTNET(uint n) { return OBJ_HOSTNET0 + n; }
                     30: static constexpr uint OBJ_M88200(uint n) { return OBJ_M88200_0 + n; }
                     31: static constexpr uint OBJ_MPU_MEMDUMP(uint n) { return OBJ_MPU_MEMDUMP0 + n; }
                     32: static constexpr uint OBJ_NEREID_BOARD(uint n) { return OBJ_NEREID_BOARD0 + n; }
                     33: static constexpr uint OBJ_VIRTIO_BLOCK(uint n) { return OBJ_VIRTIO_BLOCK0 + n; }
                     34: static constexpr uint OBJ_XP_MEMDUMP(uint n) { return OBJ_XP_MEMDUMP0 + n; }
1.1.1.9   root       35: 
1.1.1.6   root       36: // ログ表示に指定するラムダ式の便利マクロ。
                     37: // fmt 内では __func__ が使えないので代わりに lam_func を使うこと。
                     38: // lstr("%s value=%d", lam_func, value) のようになる。
                     39: // 他のキャプチャ指定子が必要になったらまた考える。
                     40: #define lstr(fmt...)   \
                     41:        [&, lam_func = __func__] { (void)lam_func; return string_format(fmt); }
                     42: 
1.1.1.13  root       43: // モニタコールバックを宣言するマクロ。
                     44: // 強制力はないけどヘッダで宣言するところで使うこと。
                     45: // コールバック関数の型が変わった時にコンパイルエラーで検出させるため。
                     46: #define DECLARE_MONITOR_CALLBACK(name) void name (Monitor *, TextScreen&)
                     47: 
1.1       root       48: // 基本オブジェクト
1.1.1.7   root       49: class Object
1.1       root       50: {
                     51:  public:
1.1.1.9   root       52:        // 引数はオブジェクト ID。
                     53:        // ID と紐付けされたオブジェクト名は、ログ表示名で、ログに前置される。
1.1.1.7   root       54:        // またコンストラクタ指定の場合はエイリアスにも登録する。
                     55:        // これは表示名と指示名が同じことが多いための便宜措置。
                     56:        // 指示名に表示名を使いたくない場合は ClearAlias() してから
                     57:        // AddAlias() すること。
1.1.1.12  root       58:        explicit Object(uint objid_);
1.1.1.7   root       59: 
                     60:        virtual ~Object();
                     61: 
1.1.1.9   root       62:        // ID を返す
1.1.1.12  root       63:        uint GetId() const { return objid; }
1.1.1.9   root       64:        const char *GetIdStr() const;
                     65: 
                     66:        // ID を文字列で返す
1.1.1.12  root       67:        static const char *GetIdStr(uint target_id);
1.1.1.9   root       68: 
1.1.1.7   root       69:        // オブジェクト名(ログ表示名)を取得する
                     70:        const std::string& GetName() const { return objname; }
                     71: 
                     72:        // エイリアスリストを返す
                     73:        const std::vector<std::string>& GetAliases() const { return log_aliases; }
                     74: 
1.1.1.9   root       75:        // 指定の id を持つオブジェクトを返す。
1.1.1.13  root       76:        // 実体は gMainApp.GetObject() を呼んでいる。
1.1.1.9   root       77:        // 隣のデバイスを参照したい人が全員 mainapp.h を include しなくて済む
                     78:        // ようにするための便宜上のもの。
1.1.1.12  root       79:        static Object *GetObject(uint target_id);
1.1.1.9   root       80: 
                     81:        // 指定の id を持つオブジェクトを型 T* にして返す版。
                     82:        template <typename T>
1.1.1.12  root       83:        static T *GetObject(uint target_id) {
1.1.1.9   root       84:                auto dev = dynamic_cast<T *>(GetObject(target_id));
                     85:                assert(dev);
                     86:                return dev;
                     87:        }
                     88: 
1.1.1.7   root       89:  protected:
                     90:        // オブジェクト名を newname に設定(更新)する。
                     91:        // 通常、オブジェクト名はコンストラクタで指定するが、コンストラクタ時点
                     92:        // ではまだ名前が決まらないような場合にだけ使う。
                     93:        // こちらはエイリアスには関与しない。
1.1.1.15  root       94:        virtual void SetName(const std::string& newname) {
1.1.1.7   root       95:                objname = newname;
                     96:        }
                     97: 
                     98:        // エイリアスをクリアする。
                     99:        // エイリアスは初期値として、コンストラクタで設定したオブジェクト名が
                    100:        // 1つ入っているが、これを削除したい時に使う。
                    101:        void ClearAlias() {
                    102:                log_aliases.clear();
                    103:        }
                    104: 
                    105:        // エイリアスを追加する。
                    106:        void AddAlias(const std::string& alias) {
                    107:                log_aliases.emplace_back(alias);
                    108:        }
                    109: 
                    110:  private:
1.1.1.12  root      111:        uint objid {};
1.1.1.9   root      112: 
1.1.1.7   root      113:        // オブジェクト名。
                    114:        // こちらはログの先頭に追加される。
                    115:        std::string objname {};
                    116: 
                    117:        // エイリアスのリスト。
                    118:        // こちらはログ名を指定する時に使う。
                    119:        std::vector<std::string> log_aliases {};
1.1       root      120: 
1.1.1.9   root      121:        // オブジェクト ID からオブジェクト名(ログ名)変換テーブル
                    122:        static const std::vector<const char *> idname;
                    123: 
                    124:        // オブジェクト ID を文字列にしたもの
                    125:        static const std::vector<const char *> idtext;
                    126: 
1.1.1.7   root      127:  public:
1.1       root      128:        //
                    129:        // ログ
                    130:        //
                    131: 
1.1.1.8   root      132:        // ログレベルを設定する
                    133:        virtual void SetLogLevel(int loglevel_);
1.1       root      134: 
                    135:        // メッセージ出力
1.1.1.6   root      136:        // メッセージは仮想時刻も現在の PC も表示しない。Init() など VM 実行前や
1.1       root      137:        // 仮想マシン(特に仮想時刻、PC) に関係ないあたりはこちらを使用。
                    138: 
1.1.1.6   root      139:        // レベル指定なし、フォーマット版。(レベルを評価した後で使う)
                    140:        void putmsgn(const char *fmt, ...) const __printflike(2, 3);
                    141: 
                    142:        // レベル指定あり、フォーマット版。
                    143: #define putmsg(lv, fmt...)     do {    \
                    144:        if (__predict_false(loglevel >= (lv))) {        \
                    145:                putmsgn(fmt);   \
                    146:        }       \
                    147: } while (0)
                    148: 
                    149:        // レベル指定あり、ラムダ式版。
                    150:        void putmsgf(int lv, std::function<std::string()> msgf) const {
                    151:                if (__predict_false(loglevel >= lv)) {
                    152:                        putmsgn("%s", msgf().c_str());
1.1       root      153:                }
                    154:        }
                    155: 
                    156:        // ログ出力
1.1.1.6   root      157:        // ログは仮想時刻と現在の PC も表示する。VM 実行中は基本的にこれで表示。
                    158: 
                    159:        // レベル指定なし、フォーマット版。(レベルを評価した後で使う)
1.1.1.8   root      160:        virtual void putlogn(const char *fmt, ...) const __printflike(2, 3);
1.1       root      161: 
1.1.1.6   root      162:        // レベル指定あり、フォーマット版。
                    163: #define putlog(lv, fmt...)     do {    \
                    164:        if (__predict_false(loglevel >= (lv))) {        \
                    165:                putlogn(fmt);   \
                    166:        }       \
                    167: } while (0)
                    168: 
                    169:        // レベル指定あり、ラムダ式版。
                    170:        void putlogf(int lv, std::function<std::string()> msgf) const {
                    171:                if (__predict_false(loglevel >= lv)) {
                    172:                        putlogn("%s", msgf().c_str());
1.1       root      173:                }
                    174:        }
                    175: 
1.1.1.8   root      176:        // オブジェクト登録時に代入される
                    177:        Logger *logger {};
                    178: 
                    179:        // ログレベルの目安
                    180:        // 0: 未実装動作などのデバッグログではない情報
                    181:        // 1: 大雑把なデバッグログ
                    182:        // 2: 詳細なデバッグログ
                    183:        // 3: うるさいデバッグログ
                    184:        int loglevel {};
                    185: 
                    186:  protected:
                    187:        // ログ直接出力
                    188:        void WriteLog(const char *) const;
                    189: };

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.