OOStringExpander.m File Reference

import "OOCocoa.h"
import "OOStringExpander.h"
import "Universe.h"
import "OOJavaScriptEngine.h"
import "OOCollectionExtractors.h"
import "OOStringParsing.h"
import "ResourceManager.h"
import "PlayerEntityScriptMethods.h"
import "PlayerEntity.h"

Include dependency graph for OOStringExpander.m:

Go to the source code of this file.

Classes
struct	OOStringExpansionContext

Macros
#define	WARNINGS   OOLITE_DEBUG
#define	OO_EXPANDER_RANDOM   (context->useGoodRNG ? (Ranrot()&0xFF) : gen_rnd_number())
#define	SyntaxError(CONTEXT, CLASS, FORMAT, ...)   SyntaxIssue(CONTEXT, OOLOG_FUNCTION_NAME, OOLOG_FILE_NAME, __LINE__, CLASS, OOLOG_WARNING_PREFIX, FORMAT, ## __VA_ARGS__)
#define	SyntaxWarning(CONTEXT, CLASS, FORMAT, ...)   SyntaxIssue(CONTEXT, OOLOG_FUNCTION_NAME, OOLOG_FILE_NAME, __LINE__, CLASS, OOLOG_WARNING_PREFIX, FORMAT, ## __VA_ARGS__)
#define	OPERATOR(name)   [NSValue valueWithPointer:Operator_##name], @#name
#define	kInvalidGEscapeMessage   @"String escape code %G must be followed by six integers."
#define	kInvalidJEscapeMessage   @"String escape code %J must be followed by three integers."

Enumerations
enum	{ kStackAllocationLimit = UINT16_MAX , kRecursionLimit = 100 }

Functions
static NSString *	GetSystemName (OOStringExpansionContext *context)
static NSString *	GetSystemNameIan (OOStringExpansionContext *context)
static NSString *	GetRandomNameN (OOStringExpansionContext *context)
static NSString *	GetRandomNameR (OOStringExpansionContext *context)
static NSArray *	GetSystemDescriptions (OOStringExpansionContext *context)
static void	AppendCharacters (NSMutableString **result, const unichar *characters, NSUInteger start, NSUInteger end)
static NSString *	NewRandomDigrams (OOStringExpansionContext *context)
static NSString *	OldRandomDigrams (void)
static NSString *	Expand (OOStringExpansionContext *context, NSString *string, NSUInteger sizeLimit, NSUInteger recursionLimit)
static NSString *	ExpandKey (OOStringExpansionContext *context, const unichar *characters, NSUInteger size, NSUInteger idx, NSUInteger *replaceLength, NSUInteger sizeLimit, NSUInteger recursionLimit)
static NSString *	ExpandDigitKey (OOStringExpansionContext *context, const unichar *characters, NSUInteger keyStart, NSUInteger keyLength, NSUInteger sizeLimit, NSUInteger recursionLimit)
static NSString *	ExpandStringKey (OOStringExpansionContext *context, NSString *key, NSUInteger sizeLimit, NSUInteger recursionLimit)
static NSString *	ExpandStringKeyOverride (OOStringExpansionContext *context, NSString *key)
static NSString *	ExpandStringKeySpecial (OOStringExpansionContext *context, NSString *key)
static NSString *	ExpandStringKeyKeyboardBinding (OOStringExpansionContext *context, NSString *key)
static NSMapTable *	SpecialSubstitutionSelectors (void)
static NSString *	ExpandStringKeyFromDescriptions (OOStringExpansionContext *context, NSString *key, NSUInteger sizeLimit, NSUInteger recursionLimit)
static NSString *	ExpandStringKeyMissionVariable (OOStringExpansionContext *context, NSString *key)
static NSString *	ExpandStringKeyLegacyLocalVariable (OOStringExpansionContext *context, NSString *key)
static NSString *	ExpandLegacyScriptSelectorKey (OOStringExpansionContext *context, NSString *key)
static SEL	LookUpLegacySelector (NSString *key)
static NSString *	ExpandPercentEscape (OOStringExpansionContext *context, const unichar *characters, NSUInteger size, NSUInteger idx, NSUInteger *replaceLength)
static NSString *	ExpandSystemNameForGalaxyEscape (OOStringExpansionContext *context, const unichar *characters, NSUInteger size, NSUInteger idx, NSUInteger *replaceLength)
static NSString *	ExpandSystemNameEscape (OOStringExpansionContext *context, const unichar *characters, NSUInteger size, NSUInteger idx, NSUInteger *replaceLength)
static NSString *	ExpandPercentR (OOStringExpansionContext *context, NSString *input)
static void	ReportWarningForUnknownKey (OOStringExpansionContext *context, NSString *key)
static NSString *	ApplyOperators (NSString *string, NSString *operatorsString)
static NSString *	ApplyOneOperator (NSString *string, NSString *op, NSString *param)
static void	SyntaxIssue (OOStringExpansionContext *context, const char *function, const char *fileName, NSUInteger line, NSString *logMessageClass, NSString *prefix, NSString *format,...) OO_TAKES_FORMAT_STRING(7
NSString *	OOExpandDescriptionString (Random_Seed seed, NSString *string, NSDictionary *overrides, NSDictionary *legacyLocals, NSString *systemName, OOExpandOptions options)
NSString *	OOGenerateSystemDescription (Random_Seed seed, NSString *name)
Random_Seed	OOStringExpanderDefaultRandomSeed (void)
static NSString *	Operator_cr (NSString *string, NSString *param)
static NSString *	Operator_dcr (NSString *string, NSString *param)
static NSString *	Operator_icr (NSString *string, NSString *param)
static NSString *	Operator_idcr (NSString *string, NSString *param)
static NSString *	Operator_precision (NSString *string, NSString *param)
static NSString *	Operator_multiply (NSString *string, NSString *param)
static NSString *	Operator_add (NSString *string, NSString *param)

Macro Definition Documentation

kInvalidGEscapeMessage

#define kInvalidGEscapeMessage   @"String escape code %G must be followed by six integers."

kInvalidJEscapeMessage

#define kInvalidJEscapeMessage   @"String escape code %J must be followed by three integers."

OO_EXPANDER_RANDOM

#define OO_EXPANDER_RANDOM   (context->useGoodRNG ? (Ranrot()&0xFF) : gen_rnd_number())

Definition at line 39 of file OOStringExpander.m.

Referenced by ExpandDigitKey(), ExpandStringKeyFromDescriptions(), and NewRandomDigrams().

OPERATOR

#define OPERATOR

(

name

)

[NSValue valueWithPointer:Operator_##name], @#name

SyntaxError

#define SyntaxError	(		CONTEXT,
			CLASS,
			FORMAT,
			... )   SyntaxIssue(CONTEXT, OOLOG_FUNCTION_NAME, OOLOG_FILE_NAME, __LINE__, CLASS, OOLOG_WARNING_PREFIX, FORMAT, ## __VA_ARGS__)

Definition at line 148 of file OOStringExpander.m.

Referenced by ExpandSystemNameEscape(), ExpandSystemNameForGalaxyEscape(), and ReportWarningForUnknownKey().

SyntaxWarning

#define SyntaxWarning	(		CONTEXT,
			CLASS,
			FORMAT,
			... )   SyntaxIssue(CONTEXT, OOLOG_FUNCTION_NAME, OOLOG_FILE_NAME, __LINE__, CLASS, OOLOG_WARNING_PREFIX, FORMAT, ## __VA_ARGS__)

Definition at line 151 of file OOStringExpander.m.

Referenced by Expand(), ExpandDigitKey(), ExpandKey(), ExpandPercentEscape(), ExpandStringKeyOverride(), and ReportWarningForUnknownKey().

WARNINGS

#define WARNINGS   OOLITE_DEBUG

Definition at line 37 of file OOStringExpander.m.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kStackAllocationLimit
kRecursionLimit

Definition at line 41 of file OOStringExpander.m.

{
    /*
        Total stack limit for strings being parsed (in UTF-16 code elements,
        i.e. units of 2 bytes), used recursively - for instance, if the root
        string takes 10,000 characters, any string it recurses into gets
        kStackAllocationLimit - 10,000. If the limit would be exceeded,
        the unexpanded string is returned instead.
        
        The limit is expected to be much higher than necessary for any practical
        string, and exists only to catch pathological behaviour without crashing.
    */
    kStackAllocationLimit       = UINT16_MAX,
    
    /*
        Recursion limit, for much the same purpose. Without it, we crash about
        22,000 stack frames deep when trying to expand a = "[a]" on a Mac.
    */
    kRecursionLimit             = 100
};

Function Documentation

AppendCharacters()

static void AppendCharacters ( NSMutableString ** result, const unichar * characters, NSUInteger start, NSUInteger end )

static

Definition at line 1133 of file OOStringExpander.m.

{
    NSCParameterAssert(result != NULL && characters != NULL && start <= end);
    
    if (*result == nil)
    {
        // Ensure there is a string. We want this even if the range is empty.
        *result = [NSMutableString string];
    }
    
    if (start == end)  return;
    
    /*  What we want here is a method like -[NSMutableString
        appendCharacters:(unichar)characters length:(NSUInteger)length], which
        unfortunately doesn't exist. On Mac OS X, CoreFoundation provides an
        equivalent. For GNUstep, we have to use a temporary string.
        
        TODO: build the output string in a fixed-size stack buffer instead.
    */
#if OOLITE_MAC_OS_X
    CFStringAppendCharacters((CFMutableStringRef)*result, characters + start, end - start);
#else
    NSString *temp = [[NSString alloc] initWithCharacters:characters + start length:end - start];
    [*result appendString:temp];
    [temp release];
#endif
}

References nil.

Referenced by Expand().

Here is the caller graph for this function:

ApplyOneOperator()

static NSString * ApplyOneOperator ( NSString * string, NSString * op, NSString * param )

static

Definition at line 516 of file OOStringExpander.m.

{
    static NSDictionary *operators = nil;
    
    if (operators == nil)
    {
        #define OPERATOR(name) [NSValue valueWithPointer:Operator_##name], @#name
        operators = [[NSDictionary alloc] initWithObjectsAndKeys:
                     OPERATOR(dcr),
                     OPERATOR(cr),
                     OPERATOR(icr),
                     OPERATOR(idcr),
                     OPERATOR(precision),
                     OPERATOR(multiply),
                     OPERATOR(add),
                     nil];
    }
    
    NSString *(*operator)(NSString *string, NSString *param) = [[operators objectForKey:op] pointerValue];
    if (operator != NULL)
    {
        return operator(string, param);
    }
    
    OOLogERR(@"strings.expand.invalidOperator", @"Unknown string expansion operator %@", op);
    return string;
}

References nil, and OOLogERR.

Referenced by ApplyOperators().

Here is the caller graph for this function:

ApplyOperators()

static NSString * ApplyOperators ( NSString * string, NSString * operatorsString )

static

Definition at line 444 of file OOStringExpander.m.

{
    NSArray *operators = [operatorsString componentsSeparatedByString:@"|"];
    NSString *op = nil;
    
    foreach(op, operators)
    {
        NSString *param = nil;
        NSRange colon = [op rangeOfString:@":"];
        if (colon.location != NSNotFound)
        {
            param = [op substringFromIndex:colon.location + colon.length];
            op = [op substringToIndex:colon.location];
        }
        string = ApplyOneOperator(string, op, param);
    }
    
    return string;
}

References ApplyOneOperator(), and nil.

Referenced by ExpandKey().

Here is the call graph for this function:

Here is the caller graph for this function:

Expand()

static NSString * Expand ( OOStringExpansionContext * context, NSString * string, NSUInteger sizeLimit, NSUInteger recursionLimit )

static

Definition at line 257 of file OOStringExpander.m.

{
    NSCParameterAssert(string != nil && context != NULL && sizeLimit <= kStackAllocationLimit);
    
    const NSUInteger size = [string length];
    
    // Avoid stack overflow.
    if (EXPECT_NOT(size > sizeLimit || recursionLimit == 0))  return string;
    sizeLimit -= size;
    recursionLimit--;
    
    // Nothing to expand in an empty string, and the size-1 thing below would be trouble.
    if (size == 0)  return string;
    
    unichar characters[size];
    [string getCharacters:characters range:(NSRange){ 0, size }];
    
    /*  Beginning of current range of non-special characters. If we encounter
        a substitution, we'll be copying from here forward.
    */
    NSUInteger copyRangeStart = 0;
    
    // Mutable string for result if we perform any substitutions.
    NSMutableString *result = nil;
    
    /*  The iteration limit is size - 1 because every valid substitution is at
        least 2 characters long. This way, characters[idx + 1] is always valid.
    */
    for (NSUInteger idx = 0; idx < size - 1; idx++)
    {
        /*  Main parsing loop. If, at the end of the loop, replacement != nil,
            we copy the characters from copyRangeStart to idx into the result,
            the insert replacement, and skip replaceLength characters forward
            (minus one, because idx is incremented by the loop.)
        */
        NSString *replacement = nil;
        NSUInteger replaceLength = 0;
        unichar thisChar = characters[idx];
        
        if (thisChar == '[')
        {
            replacement = ExpandKey(context, characters, size, idx, &replaceLength, sizeLimit, recursionLimit);
        }
        else if (thisChar == '%')
        {
            replacement = ExpandPercentEscape(context, characters, size, idx, &replaceLength);
        }
        else if (thisChar == ']')
        {
            SyntaxWarning(context, @"strings.expand.warning.unbalancedClosingBracket", @"%@", @"Unbalanced ] in string.");
        }
        else if (thisChar == '\\' && context->convertBackslashN)
        {
            if (characters[idx + 1] == 'n')
            {
                replaceLength = 2;
                replacement = @"\n";
            }
        }
        else
        {
            // No token start character, so we definitely have no replacement.
            continue;
        }
        
        if (replacement != nil)
        {
            /*  If replacement string is "\x7F", eat the following character.
                This is used in system_description for the one empty string
                in [22].
            */
            if ([replacement isEqualToString:@"\x7F"] && replaceLength < size)
            {
                replaceLength++;
                replacement = @"";
            }
            
            // Avoid copying if we're replacing the entire input string.
            if (copyRangeStart == 0 && replaceLength == size)
            {
                return replacement;
            }
            
            // Write the pending literal segment to result. This also allocates result if needed.
            AppendCharacters(&result, characters, copyRangeStart, idx);
            
            [result appendString:replacement];
            
            // Skip over replaced part and start a new literal segment.
            idx += replaceLength - 1;
            copyRangeStart = idx + 1;
        }
    }
    
    if (result != nil)
    {
        // Append any trailing literal segment.
        AppendCharacters(&result, characters, copyRangeStart, size);
        
        // Don't turn result immutable; doing it once at top level is sufficient.
        return result;
    }
    else
    {
        // No substitutions, return original string.
        return string;
    }
}

References AppendCharacters(), OOStringExpansionContext::convertBackslashN, ExpandKey(), ExpandPercentEscape(), EXPECT_NOT, kStackAllocationLimit, nil, and SyntaxWarning.

Referenced by ExpandDigitKey(), ExpandStringKeyFromDescriptions(), and OOExpandDescriptionString().

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandDigitKey()

static NSString * ExpandDigitKey ( OOStringExpansionContext * context, const unichar * characters, NSUInteger keyStart, NSUInteger keyLength, NSUInteger sizeLimit, NSUInteger recursionLimit )

static

Definition at line 555 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && characters != NULL);
    
    NSUInteger keyValue = 0, idx;
    for (idx = keyStart; idx < (keyStart + keyLength); idx++)
    {
        NSCAssert2(isdigit(characters[idx]), @"%s called with non-numeric key [%@].", __FUNCTION__, [NSString stringWithCharacters:characters + keyStart length:keyLength]);
        
        keyValue = keyValue * 10 + characters[idx] - '0';
    }
    
    // Retrieve selected system_description entry.
    NSArray *sysDescs = GetSystemDescriptions(context);
    NSArray *entry = [sysDescs oo_arrayAtIndex:keyValue];
    
    if (EXPECT_NOT(entry == nil))
    {
        if (keyValue >= context->sysDescCount)
        {
            SyntaxWarning(context, @"strings.expand.warning.outOfRangeKey", @"Out-of-range system description expansion key [%@] in string.", [NSString stringWithCharacters:characters + keyStart length:keyLength]);
        }
        else
        {
            // This is out of the scope of whatever triggered it, so shouldn't be a JS warning.
            OOLogERR(@"strings.expand.invalidData", @"%@", @"descriptions.plist entry system_description must be an array of arrays of strings.");
        }
        return nil;
    }
    
    // Select a random sub-entry.
    NSUInteger selection, count = [entry count];
    NSUInteger rnd = OO_EXPANDER_RANDOM;
    if (count == 5 && !context->useGoodRNG)
    {
        // Time-honoured Elite-compatible way for five items.
        if (rnd >= 0xCC)  selection = 4;
        else if (rnd >= 0x99)  selection = 3;
        else if (rnd >= 0x66)  selection = 2;
        else if (rnd >= 0x33)  selection = 1;
        else  selection = 0;
    }
    else
    {
        // General way.
        selection = (rnd * count) / 256;
    }
    
    // Look up and recursively expand string.
    NSString *string = [entry oo_stringAtIndex:selection];
    return Expand(context, string, sizeLimit, recursionLimit);
}

References count, Expand(), EXPECT_NOT, GetSystemDescriptions(), nil, OO_EXPANDER_RANDOM, OOLogERR, SyntaxWarning, OOStringExpansionContext::sysDescCount, and OOStringExpansionContext::useGoodRNG.

Referenced by ExpandKey().

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandKey()

static NSString * ExpandKey ( OOStringExpansionContext * context, const unichar * characters, NSUInteger size, NSUInteger idx, NSUInteger * replaceLength, NSUInteger sizeLimit, NSUInteger recursionLimit )

static

Definition at line 379 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && characters != NULL && replaceLength != NULL);
    NSCParameterAssert(characters[idx] == '[');
    
    // Find the balancing close bracket.
    NSUInteger end, balanceCount = 1, firstBar = 0;
    bool allDigits = true;
    
    for (end = idx + 1; end < size && balanceCount > 0; end++)
    {
        if (characters[end] == ']')  balanceCount--;
        else
        {
            if (characters[end] == '[')  balanceCount++;
            else if (characters[end] == '|' && firstBar == 0)  firstBar = end;
            if (!isdigit(characters[end]) && firstBar == 0)  allDigits = false;
        }
    }
    
    // Fail if no balancing bracket.
    if (EXPECT_NOT(balanceCount != 0))
    {
        SyntaxWarning(context, @"strings.expand.warning.unbalancedOpeningBracket", @"%@", @"Unbalanced [ in string.");
        return nil;
    }
    
    NSUInteger totalLength = end - idx;
    *replaceLength = totalLength;
    NSUInteger keyStart = idx + 1, keyLength = totalLength - 2;
    if (firstBar != 0)  keyLength = firstBar - idx - 1;
    
    if (EXPECT_NOT(keyLength == 0))
    {
        SyntaxWarning(context, @"strings.expand.warning.emptyKey", @"%@", @"Invalid expansion code [] string. (To avoid this message, use %%[%%].)");
        return nil;
    }
    
    NSString *expanded = nil;
    if (allDigits)
    {
        expanded = ExpandDigitKey(context, characters, keyStart, keyLength, sizeLimit, recursionLimit);
    }
    else
    {
        NSString *key = [NSString stringWithCharacters:characters + keyStart length:keyLength];
        expanded = ExpandStringKey(context, key, sizeLimit, recursionLimit);
    }
    
    if (firstBar != 0)
    {
        NSString *operators = [NSString stringWithCharacters:characters + firstBar + 1 length:end - firstBar - 2];
        expanded = ApplyOperators(expanded, operators);
    }
    
    return expanded;
}

References ApplyOperators(), ExpandDigitKey(), ExpandStringKey(), EXPECT_NOT, nil, and SyntaxWarning.

Referenced by Expand().

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandLegacyScriptSelectorKey()

static NSString * ExpandLegacyScriptSelectorKey ( OOStringExpansionContext * context, NSString * key )

static

Definition at line 823 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && key != nil);
    
    SEL selector = LookUpLegacySelector(key);
    
    if (selector != NULL)
    {
        return [[PLAYER performSelector:selector] description];
    }
    else
    {
        return nil;
    }
}

References LookUpLegacySelector(), and nil.

Referenced by ExpandStringKey().

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandPercentEscape()

static NSString * ExpandPercentEscape ( OOStringExpansionContext * context, const unichar * characters, NSUInteger size, NSUInteger idx, NSUInteger * replaceLength )

static

Definition at line 937 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && characters != NULL && replaceLength != NULL);
    NSCParameterAssert(characters[idx] == '%');
    
    // All %-escapes except %J and %G are 2 characters.
    *replaceLength = 2;
    unichar selector = characters[idx + 1];
    
    switch (selector)
    {
        case 'H':
            return GetSystemName(context);
            
        case 'I':
            return GetSystemNameIan(context);
            
        case 'N':
            return GetRandomNameN(context);
            
        case 'R':
            // to keep planet description generation consistent with earlier versions
            // this must be done after all other substitutions in a second pass.
            context->hasPercentR = true;
            return @"%R";
            
        case 'G':
            return ExpandSystemNameForGalaxyEscape(context, characters, size, idx, replaceLength);
            
        case 'J':
            return ExpandSystemNameEscape(context, characters, size, idx, replaceLength);
            
        case '%':
            return @"%";
            
        case '[':
            return @"[";
            
        case ']':
            return @"]";
            
            /*  These are NSString formatting specifiers that occur in
                descriptions.plist. The '.' is for floating-point (g and f)
                specifiers that have field widths specified. No unadorned
                %f or %g is found in vanilla Oolite descriptions.plist.
                
                Ideally, these would be replaced with the caller formatting
                the value and passing it as an override - it would be safer
                and make descriptions.plist clearer - but it would be a big
                job and uglify the callers without newfangled Objective-C
                dictionary literals.
                -- Ahruman 2012-10-05
            */
        case '@':
        case 'd':
        case '.':
            return nil;
            
        default:
            // Yay, percent signs!
            SyntaxWarning(context, @"strings.expand.warning.unknownPercentEscape", @"Unknown escape code in string: %%%lc. (To encode a %% sign without this warning, use %%%% - but prefer \"percent\" in prose writing.)", selector);
            
            return nil;
    }
}

References ExpandSystemNameEscape(), ExpandSystemNameForGalaxyEscape(), GetRandomNameN(), GetSystemName(), GetSystemNameIan(), OOStringExpansionContext::hasPercentR, nil, and SyntaxWarning.

Referenced by Expand().

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandPercentR()

static NSString * ExpandPercentR ( OOStringExpansionContext * context, NSString * input )

static

Definition at line 1009 of file OOStringExpander.m.

{
    NSRange containsR = [input rangeOfString:@"%R"];
    if (containsR.location == NSNotFound)
    {
        return input; // no %Rs to replace
    }
    NSString *percentR = GetRandomNameR(context);
    NSMutableString *output = [NSMutableString stringWithString:input];
 
    /* This loop should be completely unnecessary, but for some reason
     * replaceOccurrencesOfString sometimes only replaces the first
     * instance of %R if percentR contains the non-ASCII
     * digrams-apostrophe character.  (I guess
     * http://lists.gnu.org/archive/html/gnustep-dev/2011-10/msg00048.html
     * this bug in GNUstep's implementation here, which is in 1.22) So
     * to cover that case, if there are still %R in the string after
     * replacement, try again. Affects things like thargoid curses, and
     * particularly %Rful expansions of [nom]. Probably this can be
     * tidied up once GNUstep 1.22 is ancient history, but that'll be a
     * few years yet. - CIM 15/1/2013 */
 
    do {
        [output replaceOccurrencesOfString:@"%R" withString:percentR options:NSLiteralSearch range:NSMakeRange(0, [output length])];
    } while([output rangeOfString:@"%R"].location != NSNotFound);
 
    return [NSString stringWithString:output];
}

References GetRandomNameR().

Referenced by OOExpandDescriptionString().

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandStringKey()

static NSString * ExpandStringKey ( OOStringExpansionContext * context, NSString * key, NSUInteger sizeLimit, NSUInteger recursionLimit )

static

Definition at line 614 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && key != nil);
    
    // Overrides have top priority.
    NSString *result = ExpandStringKeyOverride(context, key);
    
    // Specials override descriptions.plist.
    if (result == nil)  result = ExpandStringKeySpecial(context, key);
 
    // Now try descriptions.plist.
    if (result == nil)  result = ExpandStringKeyFromDescriptions(context, key, sizeLimit, recursionLimit);
 
    // For efficiency, descriptions.plist overrides keybindings.
    // OXPers should therefore avoid oolite_key_ description keys
    if (result == nil)  result = ExpandStringKeyKeyboardBinding(context, key);
    
    // Try mission variables.
    if (result == nil)  result = ExpandStringKeyMissionVariable(context, key);
    
    // Try legacy local variables.
    if (result == nil)  result = ExpandStringKeyLegacyLocalVariable(context, key);
    
    // Try legacy script methods.
    if (result == nil)  ExpandLegacyScriptSelectorKey(context, key);
    
#if WARNINGS
    // None of that worked, so moan a bit.
    if (result == nil)  ReportWarningForUnknownKey(context, key);
#endif
    
    return result;
}

References ExpandLegacyScriptSelectorKey(), ExpandStringKeyFromDescriptions(), ExpandStringKeyKeyboardBinding(), ExpandStringKeyLegacyLocalVariable(), ExpandStringKeyMissionVariable(), ExpandStringKeyOverride(), ExpandStringKeySpecial(), nil, and ReportWarningForUnknownKey().

Referenced by ExpandKey(), and OOExpandDescriptionString().

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandStringKeyFromDescriptions()

static NSString * ExpandStringKeyFromDescriptions ( OOStringExpansionContext * context, NSString * key, NSUInteger sizeLimit, NSUInteger recursionLimit )

static

Definition at line 764 of file OOStringExpander.m.

{
    id value = [[UNIVERSE descriptions] objectForKey:key];
    if (value != nil)
    {
        if ([value isKindOfClass:[NSArray class]] && [value count] > 0)
        {
            NSUInteger rnd = OO_EXPANDER_RANDOM % [value count];
            value = [value oo_objectAtIndex:rnd];
        }
        
        if (![value isKindOfClass:[NSString class]])
        {
            // This is out of the scope of whatever triggered it, so shouldn't be a JS warning.
            OOLogERR(@"strings.expand.invalidData", @"String expansion value %@ for [%@] from descriptions.plist is not a string or number.", [value shortDescription], key);
            return nil;
        }
        
        // Expand recursively.
        return Expand(context, value, sizeLimit, recursionLimit);
    }
    
    return nil;
}

References Expand(), nil, OO_EXPANDER_RANDOM, and OOLogERR.

Referenced by ExpandStringKey().

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandStringKeyKeyboardBinding()

static NSString * ExpandStringKeyKeyboardBinding ( OOStringExpansionContext * context, NSString * key )

static

Definition at line 710 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && key != nil);
    if ([key hasPrefix:@"oolite_key_"])
    {
        NSString *binding = [key substringFromIndex:7];
        return [PLAYER keyBindingDescription2:binding];
    }
    return nil;
}

References nil.

Referenced by ExpandStringKey().

Here is the caller graph for this function:

ExpandStringKeyLegacyLocalVariable()

static NSString * ExpandStringKeyLegacyLocalVariable ( OOStringExpansionContext * context, NSString * key )

static

Definition at line 811 of file OOStringExpander.m.

{
    return [[context->legacyLocals objectForKey:key] description];
}

Referenced by ExpandStringKey().

Here is the caller graph for this function:

ExpandStringKeyMissionVariable()

static NSString * ExpandStringKeyMissionVariable ( OOStringExpansionContext * context, NSString * key )

static

Definition at line 794 of file OOStringExpander.m.

{
    if ([key hasPrefix:@"mission_"])
    {
        return [PLAYER missionVariableForKey:key];
    }
    
    return nil;
}

References nil.

Referenced by ExpandStringKey().

Here is the caller graph for this function:

ExpandStringKeyOverride()

static NSString * ExpandStringKeyOverride ( OOStringExpansionContext * context, NSString * key )

static

Definition at line 658 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && key != nil);
    
    id value = [context->overrides objectForKey:key];
    if (value != nil)
    {
#if WARNINGS
        if (![value isKindOfClass:[NSString class]] && ![value isKindOfClass:[NSNumber class]])
        {
            SyntaxWarning(context, @"strings.expand.warning.invalidOverride", @"String expansion override value %@ for [%@] is not a string or number.", [value shortDescription], key);
        }
#endif
        return [value description];
    }
    
    return nil;
}

References nil, and SyntaxWarning.

Referenced by ExpandStringKey().

Here is the caller graph for this function:

ExpandStringKeySpecial()

static NSString * ExpandStringKeySpecial ( OOStringExpansionContext * context, NSString * key )

static

Definition at line 684 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && key != nil);
    
    NSMapTable *specials = SpecialSubstitutionSelectors();
    SEL selector = NSMapGet(specials, key);
    if (selector != NULL)
    {
        NSCAssert2([PLAYER respondsToSelector:selector], @"Special string expansion selector %@ for [%@] is not implemented.", NSStringFromSelector(selector), key);
        
        NSString *result = [PLAYER performSelector:selector];
        if (result != nil)
        {
            NSCAssert2([result isKindOfClass:[NSString class]], @"Special string expansion [%@] expanded to %@, but expected a string.", key, [result shortDescription]);
            return result;
        }
    }
    
    return nil;
}

References nil, PLAYER, and SpecialSubstitutionSelectors().

Referenced by ExpandStringKey().

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandSystemNameEscape()

static NSString * ExpandSystemNameEscape ( OOStringExpansionContext * context, const unichar * characters, NSUInteger size, NSUInteger idx, NSUInteger * replaceLength )

static

Definition at line 1096 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && characters != NULL && replaceLength != NULL);
    NSCParameterAssert(characters[idx + 1] == 'J');
    
    // A valid %J escape is always five characters including the three digits.
    *replaceLength = 5;
    
    #define kInvalidJEscapeMessage @"String escape code %J must be followed by three integers."
    if (EXPECT_NOT(size - idx < 5))
    {
        // Too close to end of string to actually have three characters, let alone three digits.
        SyntaxError(context, @"strings.expand.invalidJEscape", @"%@", kInvalidJEscapeMessage);
        return nil;
    }
    
    char hundreds = characters[idx + 2];
    char tens = characters[idx + 3];
    char units = characters[idx + 4];
    
    if (!(isdigit(hundreds) && isdigit(tens) && isdigit(units)))
    {
        SyntaxError(context, @"strings.expand.invalidJEscape", @"%@", kInvalidJEscapeMessage);
        return nil;
    }
    
    OOSystemID sysID = (hundreds - '0') * 100 + (tens - '0') * 10 + (units - '0');
    if (sysID > kOOMaximumSystemID)
    {
        SyntaxError(context, @"strings.expand.invalidJEscape.range", @"String escape code %%J%3u is out of range (must be less than %u).", sysID, kOOMaximumSystemID + 1);
        return nil;
    }
    
    return [UNIVERSE getSystemName:sysID];
}

References EXPECT_NOT, kInvalidJEscapeMessage, kOOMaximumSystemID, nil, and SyntaxError.

Referenced by ExpandPercentEscape().

Here is the caller graph for this function:

ExpandSystemNameForGalaxyEscape()

static NSString * ExpandSystemNameForGalaxyEscape ( OOStringExpansionContext * context, const unichar * characters, NSUInteger size, NSUInteger idx, NSUInteger * replaceLength )

static

Definition at line 1044 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL && characters != NULL && replaceLength != NULL);
    NSCParameterAssert(characters[idx + 1] == 'G');
    
    // A valid %G escape is always eight characters including the six digits.
    *replaceLength = 8;
    
    #define kInvalidGEscapeMessage @"String escape code %G must be followed by six integers."
    if (EXPECT_NOT(size - idx < 8))
    {
        // Too close to end of string to actually have six characters, let alone six digits.
        SyntaxError(context, @"strings.expand.invalidJEscape", @"%@", kInvalidGEscapeMessage);
        return nil;
    }
    
    char hundreds = characters[idx + 2];
    char tens = characters[idx + 3];
    char units = characters[idx + 4];
    char galHundreds = characters[idx + 5];
    char galTens = characters[idx + 6];
    char galUnits = characters[idx + 7];
    
    if (!(isdigit(hundreds) && isdigit(tens) && isdigit(units) && isdigit(galHundreds) && isdigit(galTens) && isdigit(galUnits)))
    {
        SyntaxError(context, @"strings.expand.invalidJEscape", @"%@", kInvalidGEscapeMessage);
        return nil;
    }
    
    OOSystemID sysID = (hundreds - '0') * 100 + (tens - '0') * 10 + (units - '0');
    if (sysID > kOOMaximumSystemID)
    {
        SyntaxError(context, @"strings.expand.invalidJEscape.range", @"String escape code %%G%3u for system is out of range (must be less than %u).", sysID, kOOMaximumSystemID + 1);
        return nil;
    }
    
    OOGalaxyID galID = (galHundreds - '0') * 100 + (galTens - '0') * 10 + (galUnits - '0');
    if (galID > kOOMaximumGalaxyID)
    {
        SyntaxError(context, @"strings.expand.invalidJEscape.range", @"String escape code %%G%3u for galaxy is out of range (must be less than %u).", galID, kOOMaximumGalaxyID + 1);
        return nil;
    }
    
    return [UNIVERSE getSystemName:sysID forGalaxy:galID];
}

References EXPECT_NOT, kInvalidGEscapeMessage, kOOMaximumGalaxyID, kOOMaximumSystemID, nil, and SyntaxError.

Referenced by ExpandPercentEscape().

Here is the caller graph for this function:

GetRandomNameN()

static NSString * GetRandomNameN ( OOStringExpansionContext * context )

static

Definition at line 1186 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL);
    
    if (context->randomNameN == nil)
    {
        context->randomNameN = [NewRandomDigrams(context) retain];
    }
    
    return context->randomNameN;
}

References nil, and OOStringExpansionContext::randomNameN.

Referenced by ExpandPercentEscape().

Here is the caller graph for this function:

GetRandomNameR()

static NSString * GetRandomNameR ( OOStringExpansionContext * context )

static

Definition at line 1199 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL);
    
    if (context->randomNameR == nil)
    {
        context->randomNameR = [OldRandomDigrams() retain];
    }
    
    return context->randomNameR;
}

References nil, and OOStringExpansionContext::randomNameR.

Referenced by ExpandPercentR().

Here is the caller graph for this function:

GetSystemDescriptions()

static NSArray * GetSystemDescriptions ( OOStringExpansionContext * context )

static

Definition at line 1212 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL);
    
    if (context->systemDescriptions == nil)
    {
        context->systemDescriptions = [[[UNIVERSE descriptions] oo_arrayForKey:@"system_description"] retain];
        context->sysDescCount = [context->systemDescriptions count];
    }
    
    return context->systemDescriptions;
}

References nil, OOStringExpansionContext::sysDescCount, and OOStringExpansionContext::systemDescriptions.

Referenced by ExpandDigitKey().

Here is the caller graph for this function:

GetSystemName()

static NSString * GetSystemName ( OOStringExpansionContext * context )

static

Definition at line 1162 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL);
    if (context->systemName == nil) {
        context->systemName = [[UNIVERSE getSystemName:[PLAYER systemID]] retain];
    }
    
    return context->systemName;
}

References nil, and OOStringExpansionContext::systemName.

Referenced by ExpandPercentEscape().

Here is the caller graph for this function:

GetSystemNameIan()

static NSString * GetSystemNameIan ( OOStringExpansionContext * context )

static

Definition at line 1173 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL);
    
    if (context->systemNameWithIan == nil)
    {
        context->systemNameWithIan = [OOExpandWithOptions(context->seed, kOOExpandDisallowPercentI | kOOExpandGoodRNG | kOOExpandKey, @"planetname-possessive") retain];
    }
    
    return context->systemNameWithIan;
}

References nil, and OOStringExpansionContext::systemNameWithIan.

Referenced by ExpandPercentEscape().

Here is the caller graph for this function:

LookUpLegacySelector()

static SEL LookUpLegacySelector ( NSString * key )

static

Definition at line 845 of file OOStringExpander.m.

{
    SEL selector = NULL;
    static NSMapTable *selectorCache = NULL;
    
    // Try cache lookup.
    if (selectorCache != NULL)
    {
        selector = NSMapGet(selectorCache, key);
    }
    
    if (selector == NULL)
    {
        static NSDictionary *aliases = nil;
        static NSSet *whitelist = nil;
        if (whitelist == nil)
        {
            NSDictionary *whitelistDict = [ResourceManager whitelistDictionary];
            whitelist = [[NSSet alloc] initWithArray:[whitelistDict oo_arrayForKey:@"query_methods"]];
            aliases = [[whitelistDict oo_dictionaryForKey:@"query_method_aliases"] copy];
        }
        
        NSString *selectorName = [aliases oo_stringForKey:key];
        if (selectorName == nil)  selectorName = key;
        
        if ([whitelist containsObject:selectorName])
        {
            selector = NSSelectorFromString(selectorName);
            
            /*  This is an assertion, not a warning, because whitelist.plist is
                part of the game and cannot be overriden by OXPs. If there is an
                invalid selector in the whitelist, it's a game bug.
            */
            NSCAssert1([PLAYER respondsToSelector:selector], @"Player does not respond to whitelisted query selector %@.", key);
        }
        
        if (selector != NULL)
        {
            // Add it to cache.
            if (selectorCache == NULL)
            {
                selectorCache = NSCreateMapTable(NSObjectMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, [whitelist count]);
            }
            NSMapInsertKnownAbsent(selectorCache, key, selector);
        }
    }
    
    return selector;
}

References count, nil, PLAYER, and ResourceManager::whitelistDictionary.

Referenced by ExpandLegacyScriptSelectorKey().

Here is the call graph for this function:

Here is the caller graph for this function:

NewRandomDigrams()

static NSString * NewRandomDigrams ( OOStringExpansionContext * context )

static

Definition at line 1250 of file OOStringExpander.m.

{
    unsigned length = (OO_EXPANDER_RANDOM % 4) + 1;
    if ((OO_EXPANDER_RANDOM % 5) < ((length == 1) ? 3 : 1))  ++length;  // Make two-letter names rarer and 10-letter names happen sometimes
    NSString *digrams = [[UNIVERSE descriptions] objectForKey:@"digrams"];
    NSUInteger count = [digrams length] / 2;
    NSMutableString *name = [NSMutableString stringWithCapacity:length * 2];
    
    for (unsigned i = 0; i != length; ++i)
    {
        [name appendString:[digrams substringWithRange:NSMakeRange((OO_EXPANDER_RANDOM % count) * 2, 2)]];
    }
    
    return [name capitalizedString];
}

References count, and OO_EXPANDER_RANDOM.

OldRandomDigrams()

static NSString * OldRandomDigrams ( void )

static

Definition at line 1230 of file OOStringExpander.m.

{
    /* The only point of using %R is for world generation, so there's
     * no point in checking the context */
    unsigned len = gen_rnd_number() & 3;
    NSString *digrams = [[UNIVERSE descriptions] objectForKey:@"digrams"];
    NSMutableString *name = [NSMutableString stringWithCapacity:256];
    
    for (unsigned i = 0; i <=len; i++)
    {
        unsigned x =  gen_rnd_number() & 0x3e;
        [name appendString:[digrams substringWithRange:NSMakeRange(x, 2)]];
    }
    
    return [name capitalizedString]; 
}

References gen_rnd_number(), and x.

Here is the call graph for this function:

OOExpandDescriptionString()

NSString * OOExpandDescriptionString	(	Random_Seed	seed,
		NSString *	string,
		NSDictionary *	overrides,
		NSDictionary *	legacyLocals,
		NSString *	systemName,
		OOExpandOptions	options )

Definition at line 160 of file OOStringExpander.m.

{
    if (string == nil)  return nil;
    
    OOStringExpansionContext context =
    {
        .seed = seed,
        .systemName = [systemName retain],
        .overrides = [overrides retain],
        .legacyLocals = [legacyLocals retain],
        .isJavaScript = options & kOOExpandForJavaScript,
        .convertBackslashN = options & kOOExpandBackslashN,
        .useGoodRNG = options & kOOExpandGoodRNG
    };
    
    // Avoid recursive %I expansion by pre-seeding cache with literal %I.
    if (options & kOOExpandDisallowPercentI) {
        context.systemNameWithIan = @"%I";
    }
    
    OORandomState savedRandomState;
    if (options & kOOExpandReseedRNG)
    {
        savedRandomState = OOSaveRandomState();
        OOSetReallyRandomRANROTAndRndSeeds();
    }
    
    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
    NSString *result = nil, *intermediate = nil;
    @try
    {
        // TODO: profile caching the results. Would need to keep track of whether we've done something nondeterministic (array selection, %R etc).
        if (options & kOOExpandKey)
        {
            intermediate = ExpandStringKey(&context, string, kStackAllocationLimit, kRecursionLimit);
        }
        else
        {
            intermediate = Expand(&context, string, kStackAllocationLimit, kRecursionLimit);
        }
        if (!context.hasPercentR)
        {
            result = intermediate;
        }
        else
        {
            result = ExpandPercentR(&context, intermediate);
        }
    }
    @finally
    {
        [context.systemName release];
        [context.overrides release];
        [context.legacyLocals release];
        [context.systemNameWithIan release];
        [context.randomNameN release];
        [context.randomNameR release];
        [context.systemDescriptions release];
    }
    
    if (options & kOOExpandReseedRNG)
    {
        OORestoreRandomState(savedRandomState);
    }
    
    result = [result copy];
    [pool release];
    return [result autorelease];
}

References Expand(), ExpandPercentR(), ExpandStringKey(), OOStringExpansionContext::hasPercentR, kOOExpandBackslashN, kOOExpandDisallowPercentI, kOOExpandForJavaScript, kOOExpandGoodRNG, kOOExpandKey, kOOExpandReseedRNG, kRecursionLimit, kStackAllocationLimit, nil, OORestoreRandomState(), OOSaveRandomState(), OOSetReallyRandomRANROTAndRndSeeds(), OOStringExpansionContext::seed, and OOStringExpansionContext::systemNameWithIan.

Referenced by GlobalExpandDescription(), GlobalExpandMissionText(), OOGenerateSystemDescription(), and PlayerEntity(Scripting)::PerformActionStatment.

Here is the call graph for this function:

Here is the caller graph for this function:

OOGenerateSystemDescription()

NSString * OOGenerateSystemDescription	(	Random_Seed	seed,
		NSString *	name )

Definition at line 231 of file OOStringExpander.m.

{
    seed_RNG_only_for_planet_description(seed);
    return OOExpandDescriptionString(seed, @"system-description-string", nil, nil, name, kOOExpandKey);
}

References kOOExpandKey, nil, OOExpandDescriptionString(), and seed_RNG_only_for_planet_description().

Here is the call graph for this function:

OOStringExpanderDefaultRandomSeed()

Random_Seed OOStringExpanderDefaultRandomSeed

(

void

)

Definition at line 238 of file OOStringExpander.m.

{
    return [[UNIVERSE systemManager] getRandomSeedForCurrentSystem];
}

Referenced by PlayerEntity(Scripting)::PerformActionStatment.

Here is the caller graph for this function:

Operator_add()

static NSString * Operator_add ( NSString * string, NSString * param )

static

Definition at line 501 of file OOStringExpander.m.

{
    return [NSString stringWithFormat:@"%g", [string doubleValue] + [param doubleValue]];
}

Operator_cr()

static NSString * Operator_cr ( NSString * string, NSString * param )

static

Definition at line 465 of file OOStringExpander.m.

{
    return OOCredits([string doubleValue] * 10);
}

References OOCredits().

Here is the call graph for this function:

Operator_dcr()

static NSString * Operator_dcr ( NSString * string, NSString * param )

static

Definition at line 471 of file OOStringExpander.m.

{
    return OOCredits([string longLongValue]);
}

References OOCredits().

Here is the call graph for this function:

Operator_icr()

static NSString * Operator_icr ( NSString * string, NSString * param )

static

Definition at line 477 of file OOStringExpander.m.

{
    return OOIntCredits([string longLongValue]);
}

References OOIntCredits().

Here is the call graph for this function:

Operator_idcr()

static NSString * Operator_idcr ( NSString * string, NSString * param )

static

Definition at line 483 of file OOStringExpander.m.

{
    return OOIntCredits(round([string doubleValue] / 10.0));
}

References OOIntCredits().

Here is the call graph for this function:

Operator_multiply()

static NSString * Operator_multiply ( NSString * string, NSString * param )

static

Definition at line 495 of file OOStringExpander.m.

{
    return [NSString stringWithFormat:@"%g", [string doubleValue] * [param doubleValue]];
}

Operator_precision()

static NSString * Operator_precision ( NSString * string, NSString * param )

static

Definition at line 489 of file OOStringExpander.m.

{
    return [NSString stringWithFormat:@"%.*f", [param intValue], [string doubleValue]];
}

ReportWarningForUnknownKey()

static void ReportWarningForUnknownKey ( OOStringExpansionContext * context, NSString * key )

static

Definition at line 903 of file OOStringExpander.m.

{
    if ([key hasSuffix:@"_string"] || [key hasSuffix:@"_number"] || [key hasSuffix:@"_bool"])
    {
        SyntaxError(context, @"strings.expand.invalidSelector", @"Unpermitted legacy script method [%@] in string.", key);
    }
    else
    {
        SyntaxWarning(context, @"strings.expand.warning.unknownExpansion", @"Unknown expansion key [%@] in string.", key);
    }
}

References SyntaxError, and SyntaxWarning.

Referenced by ExpandStringKey().

Here is the caller graph for this function:

SpecialSubstitutionSelectors()

static NSMapTable * SpecialSubstitutionSelectors ( void )

static

Definition at line 727 of file OOStringExpander.m.

{
    static NSMapTable *specials = NULL;
    if (specials != NULL)  return specials;
    
    struct { NSString *key; SEL selector; } selectors[] =
    {
        { @"commander_name", @selector(commanderName_string) },
        { @"commander_shipname", @selector(commanderShip_string) },
        { @"commander_shipdisplayname", @selector(commanderShipDisplayName_string) },
        { @"commander_rank", @selector(commanderRank_string) },
        { @"commander_kills", @selector(commanderKillsAsString) },
        { @"commander_legal_status", @selector(commanderLegalStatus_string) },
        { @"commander_bounty", @selector(commanderBountyAsString) },
        { @"credits_number", @selector(creditsFormattedForSubstitution) },
        { @"_oo_legacy_credits_number", @selector(creditsFormattedForLegacySubstitution) }
    };
    unsigned i, count = sizeof selectors / sizeof *selectors;
    
    specials = NSCreateMapTable(NSObjectMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, count);
    for (i = 0; i < count; i++)
    {
        NSMapInsertKnownAbsent(specials, selectors[i].key, selectors[i].selector);
    }
    
    return specials;
}

References count.

Referenced by ExpandStringKeySpecial().

Here is the caller graph for this function:

SyntaxIssue()

static void SyntaxIssue ( OOStringExpansionContext * context, const char * function, const char * fileName, NSUInteger line, NSString * logMessageClass, NSString * prefix, NSString * format, ... )

static

Definition at line 1267 of file OOStringExpander.m.

{
    NSCParameterAssert(context != NULL);
    
    va_list args;
    va_start(args, format);
    
    if (OOLogWillDisplayMessagesInClass(logMessageClass))
    {
        if (context->isJavaScript)
        {
            /*  NOTE: syntax errors are reported as warnings when called from JS
                because we don't want to start throwing exceptions when the old
                expander didn't.
            */
            JSContext *jsc = OOJSAcquireContext();
            OOJSReportWarningWithArguments(jsc, format, args);
            OOJSRelinquishContext(jsc);
        }
        else
        {
            format = [prefix stringByAppendingString:format];
            OOLogWithFunctionFileAndLineAndArguments(logMessageClass, function, fileName, line, format, args);
        }
    }
    
    va_end(args);
}

References OOStringExpansionContext::isJavaScript, OOJSAcquireContext(), OOJSRelinquishContext(), OOJSReportWarningWithArguments(), OOLogWillDisplayMessagesInClass(), and OOLogWithFunctionFileAndLineAndArguments().

Here is the call graph for this function: