TTD API cleanup chores (follow-up from PR #1125 review)

Aperta
#1,131 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
52/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
cpp, python

Direzione di ricerca

Start with the TTD declarations in api/debuggerapi.h, the controller and adapter, especially core/adapters/dbgengttdadapter.cpp and ParseSingleTTDRegisterWriteObject. Then inspect api/python/debuggercontroller.py and architecture.py's RegisterName definition. Done means the listed C++ return types and parameter conventions, logging patterns, and Python event classes and register-name types are updated consistently across the TTD APIs.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

DbgEng Adapter python api TTD

Follow-up chores from @plafosse's review of #1125 (approved contingent only on the std::pair<bool,…> → std::optional fix, which has been done). These are the remaining "holistic / light mechanical refactor" items. They aren't specific to the register-write code — most apply to the surrounding TTD query APIs generally — so tracking them here rather than blocking that PR.

C++
  • std::pair<bool, T> → std::optional<T> everywhere. Done for the register-write methods in #1125; the pre-existing TTD memory-access methods (GetTTDNext/PrevMemoryAccess) still return std::pair<bool, TTDMemoryEvent> and should be migrated for consistency.
  • Register-name parameters: const std::string& → std::string_view. Applies to the TTD query methods that take a register name (api/debuggerapi.h, controller, adapter).
  • ParseSingleTTDRegisterWriteObject: take expression by value (std::string) and std::move it into wExpression rather than const std::string& + copy (core/adapters/dbgengttdadapter.cpp).
  • Logging: avoid Log* without a logger, and prefer the Log*F variants (faster, more readable, more featureful). The new TTD code uses bare LogInfo/LogError/LogWarn with printf-style args — this pattern is repo-wide in the debugger, so worth a broader sweep.
Python (api/python/debuggercontroller.py)
  • Make the event classes frozen @dataclasses instead of hand-rolled classes with manual __eq__/__hash__/__setattr__ (TTDRegisterWriteEvent, and the sibling TTDMemoryEvent / related event classes).
  • Use a typedef'd register-name type instead of native str. Mirror architecture.py's RegisterName = NewType('RegisterName', str) for register-name parameters.

Review comments: https://github.com/Vector35/debugger/pull/1125#pullrequestreview

Lingua principale
C++
Stelle
342
Fork
34
Merge medio
7g 21h
PR unite (30g)
1

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Vector35/debugger

Tutte le issue di Vector35/debugger

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.