259 lines
7.1 KiB
Python
259 lines
7.1 KiB
Python
# Copyright 2004-2019 Tom Rothamel <pytom@bishoujo.us>
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person
|
|
# obtaining a copy of this software and associated documentation files
|
|
# (the "Software"), to deal in the Software without restriction,
|
|
# including without limitation the rights to use, copy, modify, merge,
|
|
# publish, distribute, sublicense, and/or sell copies of the Software,
|
|
# and to permit persons to whom the Software is furnished to do so,
|
|
# subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
# This file contains support for string translation and string formatting
|
|
# operations.
|
|
|
|
from __future__ import print_function
|
|
|
|
import renpy
|
|
import string
|
|
import os
|
|
|
|
update_translations = "RENPY_UPDATE_TRANSLATIONS" in os.environ
|
|
|
|
|
|
class Formatter(string.Formatter):
|
|
"""
|
|
A string formatter that uses Ren'Py's formatting rules. Ren'Py uses
|
|
square brackets to introduce formatting, and it supports a q conversion
|
|
that quotes the text being shown to the user.
|
|
"""
|
|
|
|
def parse(self, s):
|
|
"""
|
|
Parses s according to Ren'Py string formatting rules. Returns a list
|
|
of (literal_text, field_name, format, replacement) tuples, just like
|
|
the method we're overriding.
|
|
"""
|
|
|
|
# States for the parse state machine.
|
|
LITERAL = 0
|
|
OPEN_BRACKET = 1
|
|
VALUE = 3
|
|
FORMAT = 4
|
|
CONVERSION = 5
|
|
|
|
# The depth of brackets we've seen.
|
|
bracket_depth = 0
|
|
|
|
# The parts we've seen.
|
|
literal = ''
|
|
value = ''
|
|
format = '' # @ReservedAssignment
|
|
conversion = None
|
|
|
|
state = LITERAL
|
|
|
|
for c in s:
|
|
|
|
if state == LITERAL:
|
|
if c == '[':
|
|
state = OPEN_BRACKET
|
|
continue
|
|
else:
|
|
literal += c
|
|
continue
|
|
|
|
elif state == OPEN_BRACKET:
|
|
if c == '[':
|
|
literal += c
|
|
state = LITERAL
|
|
continue
|
|
|
|
else:
|
|
value = c
|
|
state = VALUE
|
|
bracket_depth = 0
|
|
continue
|
|
|
|
elif state == VALUE:
|
|
|
|
if c == '[':
|
|
bracket_depth += 1
|
|
value += c
|
|
continue
|
|
|
|
elif c == ']':
|
|
|
|
if bracket_depth:
|
|
bracket_depth -= 1
|
|
value += c
|
|
continue
|
|
|
|
else:
|
|
yield (literal, value, format, conversion)
|
|
state = LITERAL
|
|
literal = ''
|
|
value = ''
|
|
format = '' # @ReservedAssignment
|
|
conversion = None
|
|
continue
|
|
|
|
elif c == ':':
|
|
state = FORMAT
|
|
continue
|
|
|
|
elif c == '!':
|
|
state = CONVERSION
|
|
conversion = ''
|
|
continue
|
|
|
|
else:
|
|
value += c
|
|
continue
|
|
|
|
elif state == FORMAT:
|
|
|
|
if c == ']':
|
|
yield (literal, value, format, conversion)
|
|
state = LITERAL
|
|
literal = ''
|
|
value = ''
|
|
format = '' # @ReservedAssignment
|
|
conversion = None
|
|
continue
|
|
|
|
elif c == '!':
|
|
state = CONVERSION
|
|
conversion = ''
|
|
continue
|
|
|
|
else:
|
|
format += c
|
|
continue
|
|
|
|
elif state == CONVERSION:
|
|
if c == ']':
|
|
yield (literal, value, format, conversion)
|
|
state = LITERAL
|
|
literal = ''
|
|
value = ''
|
|
format = '' # @ReservedAssignment
|
|
conversion = None
|
|
continue
|
|
|
|
else:
|
|
conversion += c
|
|
continue
|
|
|
|
if state != LITERAL:
|
|
raise Exception("String {0!r} ends with an open format operation.".format(s))
|
|
|
|
if literal:
|
|
yield (literal, None, None, None)
|
|
|
|
def convert_field(self, value, conversion):
|
|
|
|
if not conversion:
|
|
return value
|
|
|
|
if "r" in conversion:
|
|
value = repr(value)
|
|
elif "s" in conversion:
|
|
value = unicode(value)
|
|
|
|
if "t" in conversion:
|
|
if not isinstance(value, basestring):
|
|
value = unicode(value)
|
|
|
|
value = renpy.translation.translate_string(value)
|
|
|
|
if "q" in conversion:
|
|
if not isinstance(value, basestring):
|
|
value = unicode(value)
|
|
|
|
value = value.replace("{", "{{")
|
|
|
|
if "u" in conversion:
|
|
value = value.upper()
|
|
|
|
if "l" in conversion:
|
|
value = value.lower()
|
|
|
|
if "c" in conversion and value:
|
|
value = value[0].upper() + value[1:]
|
|
|
|
return value
|
|
|
|
|
|
# The instance of Formatter we use.
|
|
formatter = Formatter()
|
|
|
|
|
|
class MultipleDict(object):
|
|
|
|
def __init__(self, *dicts):
|
|
self.dicts = dicts
|
|
|
|
def __getitem__(self, key):
|
|
for d in self.dicts:
|
|
if key in d:
|
|
return d[key]
|
|
|
|
raise NameError("Name '{}' is not defined.".format(key))
|
|
|
|
|
|
def substitute(s, scope=None, force=False, translate=True):
|
|
"""
|
|
Performs translation and formatting on `s`, as necessary.
|
|
|
|
`scope`
|
|
The scope which is used in formatting, in addition to the default
|
|
store.
|
|
|
|
`force`
|
|
Force substitution to occur, even if it's disabled in the config.
|
|
|
|
`translate`
|
|
Determines if translation occurs.
|
|
|
|
Returns the substituted string, and a flag that is True if substitution
|
|
occurred, or False if no substitution occurred.
|
|
"""
|
|
|
|
if not isinstance(s, basestring):
|
|
s = unicode(s)
|
|
|
|
if translate:
|
|
s = renpy.translation.translate_string(s)
|
|
|
|
# Substitute.
|
|
if not renpy.config.new_substitutions and not force:
|
|
return s, False
|
|
|
|
if "[" not in s:
|
|
return s, False
|
|
|
|
old_s = s
|
|
|
|
if scope is not None:
|
|
kwargs = MultipleDict(scope, renpy.store.__dict__) # @UndefinedVariable
|
|
else:
|
|
kwargs = renpy.store.__dict__ # @UndefinedVariable
|
|
|
|
try:
|
|
s = formatter.vformat(s, (), kwargs)
|
|
except:
|
|
if renpy.display.predict.predicting: # @UndefinedVariable
|
|
return " ", True
|
|
|
|
return s, (s != old_s)
|