MAMEWorld >> News
View all threads Index   Flat Mode Flat  

Vas Crabb
Reged: 12/13/05
Posts: 3817
Loc: Melbourne, Australia
Send PM
minimaws: a reference -listxml consumer
08/03/17 05:47 PM

There have been some changes to -listxml output, and questions about how to use it from front-end authors. In the interests of ensuring -listxml output is useful, and to provide a reference for front-end developers, I've added a Python-based -listxml consumer called minimaws, in honour of the now-defunct MAME reference web site. It supports some command-line verbs and also provides an interactive web interface. The web interface is probably more interesting for most users and front-end authors.

The minimaws application is in the MAME source tree at scripts/minimaws and should work on any system with MAME (or a copy of its -listxml output), Python 2.7 or Python 3, and a reasonably new version of SQLite (3.6.19 is required for foreign key support). Command-line help is provided for both the main command options and subcommand options (use the -h or --help flag). It's definitely incomplete at this point, but I'm gradually adding functionality to it. I considered a few options for implementing the -listxml consumer, but settled on Python with some of the more interactive features in JavaScript because pretty much everyone has a Python interpreter and a web browser. My apologies if you have trouble reading these languages - they're far from my favourite languages, too. I'm not sure exactly what level of ECMAscript it requires - I've tested it with Firefox 48, and I think the highest feature I use is the 'json' response type for XMLHttpRequest.

Setting up currently requires a couple of steps to make a clean database and load (I intend to streamline this at some point):


rm minimaws.sqlite3
sqlite3 minimaws.sqlite3
python load path/to/mame

The script uses minimaws.sqlite3 in the working directory as the name for its database unless you override it with the --database option. Loading the database may take a few minutes, but query performance is good. Note that you'll need to provide an actual path with a slash in it if MAME isn't in your PATH (exec treats names with no slashes as commands from somewhere in PATH).

There are a few query commands that work much like MAME's auxiliary verbs, but case sensitive and with better glob behaviour. You should be able to work them out. To run in web server mode, use the serve command:


python serve

By default it serves HTTP on TCP port 8080 (you can change the port with the --port option). The server is implemented as a WSGI application, so it could also be used in a WSGI container (e.g. Apache mod_wsgi), and it uses cacheable GET requests so it will work behind a caching proxy (e.g. Apache mod_proxy, nginx, or squid). You could theoretically turn most of the pages into static files too, but that would be unwieldy with tens of thousands of files in some directories. While I think I've made it resistant to directory traversal and SQL injection attacks, I open the database in read-only mode if Python 3.4 is available, and I've tried to avoid common sources of vulnerabilities, the code hasn't been audited and may not be completely secure. You probably shouldn't run it directly on a public web server.

If you know the short name of a machine or driver, or you know the path to a source file with device/system definitions, you can jump straight to it with a URL (note that src/mame/drivers is elided in source file paths for historical reasons). You can also get a list of all source files with device/system definitions, although it's a large page and may perform poorly. Pages are interlinked pretty well - you can jump to any device used by a system/device, or any system that uses a device, or parents/clones systems. You can jump to any device defined in a source file, or the source file that defines a device. Example URLs you could start from include:

  • http://localhost:8080/machine/intlc440
  • http://localhost:8080/machine/a2mouse
  • http://localhost:8080/sourcefile/src/devices/cpu/m68000/m68kcpu.cpp
  • http://localhost:8080/sourcefile/

Anyway, the most immediately useful feature for front-end authors, and possibly also for users of computer system emulation, is the ability to show slots options, and update live in response to slot card selection, all straight off the database without having to repeatedly invoke MAME to get updated options. Here's an example of what it looks like, in this case for the fairly simple TI-82:

Although there aren't any in that example, unemulated/imperfect feature flags are shown for devices where applicable. Command-line flags for MAME to produce the selected configuration are shown, including elision of default choices. You can see it in action with any slotted system, for example:

  • http://localhost:8080/machine/ibm5150
  • http://localhost:8080/machine/apple2e
  • http://localhost:8080/machine/ti82

In terms of implementation, the database queries are all in lib/, and the SAX2 handler that transforms the -listxml output into the normalised database schema is in lib/ The web service is in lib/ (yes it's a bit ugly because I've forgone a nice templating engine so it will work without any additional modules over a standard Python installation), and static CSS/JavaScript is in lib/assets.

The live slot selection is mostly done in lib/assets/machine.js with a bit of help from the web service. It works as follows:

  • On a page for a system/device with slots, the JavaScript requests slot information for the machine and any devices that can be inserted into slots (fetch_slots). It keeps a map of device slot information (slot_info) and checks whether it has already received or requested details for a device.
  • The only trick in the slot info web service (lib.wsgiserve.SlotsRpcHandler.data_page) is to filter out slots that come from default devices in other slots. This can be done lexically, there's nothing difficult about it.
  • Once all the slot information has been gathered, the slot UI is populated (populate_slots).
  • When a slot card is selected, any subslots are added to the UI (in the callback generated by make_slot_change_handler). This uses the same add_slot_items function that populate_slots uses to create the actual controls and apply defaults.
  • When applying defaults, remember to walk from the topmost level inwards - defaults specified at a higher level take precedence.
  • When a slot card is selected, the JavaScript asynchronously requests emulation status flags if it doesn't have them already (fetch_machine_flags) and adds the information to the table (add_flag_rows).
  • The command-line flag preview is updated in update_cmd_preview after any changes.

All the code is BSD-licensed, so feel free to integrate it into your applications if it'll be useful.

Entire thread
Subject Posted by Posted on
* minimaws: a reference -listxml consumer Vas Crabb 08/03/17 05:47 PM
. * Bro stop saying "elide", nobody knows what the hell that word means *nt* MooglyGuy  08/04/17 11:52 AM
. * Re: Bro stop saying "elide", nobody knows what the hell that word means *nt* StilettoAdministrator  08/04/17 06:25 PM
. * Re: Bro stop saying "elide", nobody knows what the hell that word means *nt* Vas Crabb  08/04/17 06:41 PM
. * Re: Bro stop saying "elide", nobody knows what the hell that word means *nt* BIOS-D  08/06/17 02:53 PM
. * Re: Bro stop saying "elide", nobody knows what the hell that word means *nt* StilettoAdministrator  08/06/17 06:13 AM
. * Re: Bro stop saying "elide", nobody knows what the hell that word means *nt* MooglyGuy  08/05/17 01:07 AM
. * Re: minimaws: a reference -listxml consumer Vas Crabb  08/04/17 10:28 AM
. * Re: minimaws: a reference -listxml consumer Vas Crabb  08/04/17 09:23 AM

Extra information Permissions
Moderator:  John IV, Tafoid 
2 registered and 37 anonymous users are browsing this forum.
You cannot start new topics
You cannot reply to topics
HTML is enabled
UBBCode is enabled
Thread views: 1462