Previous Thread
Next Thread
Print Thread
#110489 - 08/03/17 03:45 PM minimaws: a reference -listxml consumer  
Joined: Feb 2004
Posts: 1,873
Vas Crabb Offline
Very Senior Member
Vas Crabb  Offline
Very Senior Member

Joined: Feb 2004
Posts: 1,873
Sydney, Australia
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):
Code
rm minimaws.sqlite3
sqlite3 minimaws.sqlite3
python minimaws.py 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:
Code
python minimaws.py 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:
[Linked Image]

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/dbaccess.py, and the SAX2 handler that transforms the -listxml output into the normalised database schema is in lib/lxparse.py. The web service is in lib/wsgiserve.py (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.

#110491 - 08/03/17 03:55 PM Re: minimaws: a reference -listxml consumer [Re: Vas Crabb]  
Joined: May 2008
Posts: 4,857
qmc2 Online content
qmc2  Online Content

Very Senior Member

Joined: May 2008
Posts: 4,857
Germany
Thanks, Vas! I'll have a look into this reference implementation and will try to do it similarly in QMC2 during the next couple weeks.


A mind is like a parachute. It doesn't work unless it's open. [Frank Zappa]

We're searching for QMC2 translators and support for existing translations. Interested? See here!
#110492 - 08/03/17 03:59 PM Re: minimaws: a reference -listxml consumer [Re: Vas Crabb]  
Joined: Feb 2004
Posts: 1,873
Vas Crabb Offline
Very Senior Member
Vas Crabb  Offline
Very Senior Member

Joined: Feb 2004
Posts: 1,873
Sydney, Australia
I've mostly tested this on *NIX-like systems with Python 2.7 and Python 3.6 - there may be some teething issues on Windows. It does successfully load -listxml output from a MAME binary built with MinGW GCC on Windows though (using gmake in an msys64 bash shell). I'm not taking feature requests right now, there are some more things I want to provide a reference implementation of using the existing -listxml output, and at some point in the not-too-distant future I want to sort out media option discovery which is a total mess right now.

#110508 - 08/04/17 07:21 AM Re: minimaws: a reference -listxml consumer [Re: Vas Crabb]  
Joined: Feb 2004
Posts: 1,873
Vas Crabb Offline
Very Senior Member
Vas Crabb  Offline
Very Senior Member

Joined: Feb 2004
Posts: 1,873
Sydney, Australia
As of d969333, minimaws demonstrates how to expose a little-known MAME feature: slot card BIOS selection. It's possible to select BIOS versions for certain slot devices, mostly Commodore peripherals (note elision of default BIOS on second disk drive, and forcing an empty slot):
[Linked Image]

Unfortunately this was broken at some point, so it doesn't actually work in MAME 0.188, and the necessary information wasn't being exposed in the -listxml output for devices (as opposed to systems). Anyway, that's all fixed for the next release. If you want to expose this in your frontend and can't follow the logic from the reference implementation, give me a yell and I'll try to walk you through it.

(I've gone to the trouble of eliding defaults in minimaws to make the command line preview look prettier. If you're developing a front-end there's no real need to do the elision step - MAME won't get upset if you supply default options explicitly.)

#110509 - 08/04/17 08:27 AM Re: minimaws: a reference -listxml consumer [Re: Vas Crabb]  
Joined: Feb 2004
Posts: 1,873
Vas Crabb Offline
Very Senior Member
Vas Crabb  Offline
Very Senior Member

Joined: Feb 2004
Posts: 1,873
Sydney, Australia
And now I've improved it so you no longer need the manual schema creation step. Create/load the database with:
Code
python minimaws.py load --executable path/to/mame

#110511 - 08/04/17 09:50 AM Re: minimaws: a reference -listxml consumer [Re: Vas Crabb]  
Joined: May 2009
Posts: 1,605
Just Desserts Offline
Very Senior Member
Just Desserts  Offline
Very Senior Member

Joined: May 2009
Posts: 1,605
Since Vas doesn't realize that he's slinging around million-dollar words like they were candy on a forum where the majority of people are probably not native English speakers, let me provide some education:

Originally Posted by dictionary
elide
ɪˈlʌɪd/
verb
1.
omit (a sound or syllable) when speaking.
"elided consonants"
2.
join together; merge.
"whole periods of time are elided into a few seconds of screen time"


Even I didn't know what the word meant.

Last edited by Just Desserts; 08/04/17 09:50 AM.
#110512 - 08/04/17 09:54 AM Re: minimaws: a reference -listxml consumer [Re: Vas Crabb]  
Joined: Aug 2004
Posts: 1,341
Robbbert Offline
Very Senior Member
Robbbert  Offline
Very Senior Member

Joined: Aug 2004
Posts: 1,341
I also asked him what he meant, and in the end, it means that the sample command line (between Options and Slots) won't show the settings that make no difference because they are the defaults.


Did some testing with this and together with Vas worked out the few problems encountered. Found that it runs fine on Firefox but not so fine on IE11.


The python 'load' line is incorrect: it should be: python minimaws.py load --executable path/to/mame

Last edited by Robbbert; 08/04/17 10:00 AM.

Who's Online Now
3 registered members (Praxis, phulshof, Stiletto), 11 guests, and 5 spiders.
Key: Admin, Global Mod, Mod
Shout Box
Forum Statistics
Forums9
Topics8,453
Posts109,711
Members4,766
Most Online225
May 26th, 2014
Powered by UBB.threads™ PHP Forum Software 7.6.0
Page Time: 0.026s Queries: 14 (0.009s) Memory: 4.9865 MB (Peak: 5.1886 MB) Zlib enabled. Server Time: 2017-12-13 08:59:03 UTC