From 6f7e4141ea14acaaf9cb973c66788fabb3457023 Mon Sep 17 00:00:00 2001 From: AJR Date: Thu, 30 Mar 2023 20:23:35 -0400 Subject: API change for device_image_interface - Remove the seterror method for recording error messages and conditions. Condition codes have been made return values for call_load, call_create and various related callbacks. Error messages (which many devices weren't generating) are now displayed through osd_printf_error. - Eliminate the image_init_result and image_verify_result pass/fail enumeration types. Update many functions that were returning these enumerations or simply bools to return std::error_condition instead. In some cases, this type is now passed down from internal parsing/loading functions which were already returning it. In various other cases, the former default UNSPECIFIED has been used as a catchall for I/O errors; anticipated future refactorings should make these error returns more specific. - Expand the image_error categories to include INVALIDLENGTH, NOSOFTWARE and BADSOFTWARE. The first is largely self-explanatory. The second is generated by the core to indicate failure to find software items in lists. The third is provided for devices to indicate semantic errors in software list entries. - Change the return type of floppy_image_device::identify to a pair so the potential error condition can be passed along to the UI without storing it in a member variable. - Move device_image_interface::message down into snapshot_image_device and change its implementation to use string_format instead of printf. - Correct a typo in the shortname of the generic snapshot device. --- docs/source/techspecs/luareference.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'docs/source/techspecs') diff --git a/docs/source/techspecs/luareference.rst b/docs/source/techspecs/luareference.rst index 2da9a2cd02d..ec7727916db 100644 --- a/docs/source/techspecs/luareference.rst +++ b/docs/source/techspecs/luareference.rst @@ -1207,16 +1207,17 @@ Methods ^^^^^^^ image:load(filename) - Loads the specified file as a media image. Returns ``"pass"`` or - ``"fail"``. + Loads the specified file as a media image. Returns ``nil`` if no error + or a string describing an error if an error occurred. image:load_software(name) - Loads a media image described in a software list. Returns ``"pass"`` or - ``"fail"``. + Loads a media image described in a software list. Returns ``nil`` if no + error or a string describing an error if an error occurred. image:unload() Unloads the mounted image. image:create(filename) Creates and mounts a media image file with the specified name. Returns - ``"pass"`` or ``"fail"``. + ``nil`` if no error or a string describing an error if an error + occurred. image:display() Returns a “front panel display” string for the device, if supported. This can be used to show status information, like the current head position or -- cgit v1.2.3-70-g09d2