Source Code Documentation

This the new release of wmlxgettext, rewritten from scratch in python 3.x. Wmlxgettext is a python3 script that scans a list of .cfg (WML) and .lua files, capturing all translatable string found in the files and creates a pot (.po) file.

From now on, the (old) perl script will be called “wmlxgettext 1.0”, while the new python3 script will be called “wmlxgettext 2.x”.

Warning: this source documentation is a bit outdated. This documentation is however still valid to understand the wmlxgettext source logic. Please consider to take a look also to source code comments for a more updated source documentation.

• 1. Introduction
  • 1.1. Pros and Cons
  • 1.2. The new command line
  • 1.3. Output “lacks”
• 2. Error and Warning messages
  • 2.1. About ansi_setEnabled function
  • 2.2. wmlerr() and wmlwarn() usage
  • 2.3. How wmlerr() and wmlwarn() internally works
  • 2.4. Using unittest with wmlerr()
• 3. Introducing WML and Lua parser
  • 3.1. WML parsing fundamentals
  • 3.2. WML nodes
  • 3.3. The postring dictionary
  • 3.4. Converting WmlNodeSentence to PoCommentedString
  • 3.5. The nodemanip module
  • 3.6. Parsing Lua file (or lua code)
• 4. The State Machine
  • 4.1. The State class
  • 4.2. State Sequence
  • 4.3. State Machine and nodemanip
• 5. The last step: writing the .po file
• 6. Deep explaination of all regular expressions
  • 6.1. Regexes used on WML States
  • 6.2. Regexes used on Lua States
  • 6.3. “Escape” regexp rules