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

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

unix.superglobalmegacorp.com

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