Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Refactor simc engine to make it useable as a library

Đang mở
  • Có gì không ổn?
#4,383 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
cpp, wasm
Lĩnh vực
backend

Hướng nghiên cứu

Start by reading the listed progress_bar_t::update workaround in engine/sim/sc_progress_bar.cpp, then compare the Qt GUI and CLI setup and report paths mentioned in the issue. The work spans progress callbacks, writing reports to buffers, and sim_t initialization and execution, so first clarify the desired API and scope with maintainers. Done means the agreed library use cases no longer require the workarounds described here.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Because of my effort to create a web assembly version of simc in #4341 I identified the following issues that need some work to make it useable as a library. The goal is to have a discussion about them and do the refactoring.

Progress reporting
The progress bar is outputted as formatted text to stdout. What an embedded application (like the browser) needs is a way to get notified about progress update with structured data. My proposal is to have a mode where I supply a functor (callback) that gets called after each iteration. When specifying the callback an update interval can be specified too.

I currently have the following workaround in progress_bar_t::update to get progress updates:

#ifdef SC_WASM
  {
    wasm_hooks::update_progress( progress, current_progress(),
                                 compute_total_phases(),
                                 base_str, phase_str );
    return false;
  }
#endif

This suppresses progress bar output and supplies my application with the information I need.

Result output
Currently the different report classes either output to a file or to stdout. What I need is a mode where I can just write the reports to a buffer. For example an overload of
report::print_json(simc, std::stringstream &out). I need this for the json case because that format is used to pass the information to javascript in the WebAssembly case. Text could be helpful, too. Currently I just write out the json file by setting json_file_str and read it back in after the sim as a workaround.

Setup Boilerplate
I found it difficult to find all the calls that I need to make before I can sim. After reading the qt gui and cli code I came up with that:

dbc::init();
module_t::init();
unique_gear::register_hotfixes();
unique_gear::register_special_effects();
unique_gear::sort_special_effects();
hotfix::apply();

I do not even know if that is all or how to track new things that need to be added. Maybe it can be integrated into the sim_t constructor which initializes this with something like std::call_once to not redo it again for each instance. And also make it callable ahead of time, optionally. For example a static sim_t::initialize() which can be called manually or is called by the first constructor call if not.

Also it is not obvious to me which functions I need to call after the sim. For example all the analyze() functions. Can that be integrated at the end of execute() ?

And maybe sim_t::setup() can be moved to the constructor so it is obvious that I need a control object. So we do don't have a standard constructor but one that takes the options.

All in all I think the goal should be that by constructing a sim_t we should have an instance that is ready to roll without having to call further init or setup functions.

Ngôn ngữ chính
C++
Star
1.6k
Fork
789
Merge trung bình
9 giờ 44 phút
Pull request đã merge (30 ngày)
56

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của simulationcraft/simc

Tất cả issue của simulationcraft/simc

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.