OOStringParsing.m File Reference

import "OOStringParsing.h"
import "OOLogging.h"
import "NSScannerOOExtensions.h"
import "legacy_random.h"
import "Universe.h"
import "PlayerEntity.h"
import "PlayerEntityLegacyScriptEngine.h"
import "OOFunctionAttributes.h"
import "OOCollectionExtractors.h"
import "ResourceManager.h"
import "HeadUpDisplay.h"
import "OOJavaScriptEngine.h"
import "OOJSEngineTimeManagement.h"

Include dependency graph for OOStringParsing.m:

Go to the source code of this file.

Functions
NSMutableArray *	ScanTokensFromString (NSString *values)
BOOL	ScanVectorFromString (NSString *xyzString, Vector *outVector)
BOOL	ScanHPVectorFromString (NSString *xyzString, HPVector *outVector)
BOOL	ScanQuaternionFromString (NSString *wxyzString, Quaternion *outQuaternion)
BOOL	ScanVectorAndQuaternionFromString (NSString *xyzwxyzString, Vector *outVector, Quaternion *outQuaternion)
Vector	VectorFromString (NSString *xyzString, Vector defaultValue)
Quaternion	QuaternionFromString (NSString *wxyzString, Quaternion defaultValue)
NSString *	StringFromPoint (NSPoint point)
NSPoint	PointFromString (NSString *xyString)
Random_Seed	RandomSeedFromString (NSString *abcdefString)
NSString *	StringFromRandomSeed (Random_Seed seed)
NSString *	OOPadStringToEms (NSString *string, float padEms)
NSString *	OOStringFromDeciCredits (OOCreditsQuantity tenthsOfCredits, BOOL includeDecimal, BOOL includeSymbol)
NSArray *	ComponentsFromVersionString (NSString *string)
NSComparisonResult	CompareVersions (NSArray *version1, NSArray *version2)
NSString *	ClockToString (double clock, BOOL adjusting)

Variables
static NSString *const	kOOLogStringVectorConversion = @"strings.conversion.vector"
static NSString *const	kOOLogStringQuaternionConversion = @"strings.conversion.quaternion"
static NSString *const	kOOLogStringRandomSeedConversion = @"strings.conversion.randomSeed"

Function Documentation

ClockToString()

NSString * ClockToString	(	double	clock,
		BOOL	adjusting )

Definition at line 418 of file OOStringParsing.m.

{
    int             days, hrs, mins, secs;
    NSString        *format = nil;
    
    days = floor(clock / 86400.0);
    secs = floor(clock - days * 86400.0);
    hrs = floor(secs / 3600.0);
    secs %= 3600;
    mins = floor(secs / 60.0);
    secs %= 60;
    
    if (adjusting)  format = DESC(@"clock-format-adjusting");
    else  format = DESC(@"clock-format");
    
    return [NSString stringWithFormat:format, days, hrs, mins, secs];
}

References DESC, and nil.

Referenced by ClockClockStringForTime(), PlayerEntity::dial_clock, PlayerEntity::dial_clock_adjusted, WormholeEntity::dumpSelfState, and PlayerEntity(OOLoadSavePrivate)::showCommanderShip:.

Here is the caller graph for this function:

CompareVersions()

NSComparisonResult CompareVersions	(	NSArray *	version1,
		NSArray *	version2 )

Definition at line 386 of file OOStringParsing.m.

{
    NSEnumerator        *leftEnum = nil,
                        *rightEnum = nil;
    NSNumber            *leftComponent = nil,
                        *rightComponent = nil;
    unsigned            leftValue,
                        rightValue;
    
    leftEnum = [version1 objectEnumerator];
    rightEnum = [version2 objectEnumerator];
    
    for (;;)
    {
        leftComponent = [leftEnum nextObject];
        rightComponent = [rightEnum nextObject];
        
        if (leftComponent == nil && rightComponent == nil)  break;    // End of both versions
        
        // We'll get 0 if the component is nil, which is what we want.
        leftValue = [leftComponent unsignedIntValue];
        rightValue = [rightComponent unsignedIntValue];
        
        if (leftValue < rightValue) return NSOrderedAscending;
        if (leftValue > rightValue) return NSOrderedDescending;
    }
    
    // If there was a difference, we'd have returned already.
    return NSOrderedSame;
}

References nil.

Referenced by ResourceManager::areRequirementsFulfilled:forOXP:andFile:, OOOXZManager(NSURLConnectionDataDelegate)::installableState:, ResourceManager::matchVersions:withVersion:, OoliteCompareVersion(), and OOCheckRequiresPListVerifierStage::run.

Here is the caller graph for this function:

ComponentsFromVersionString()

NSArray * ComponentsFromVersionString

(

NSString *

string

)

Definition at line 359 of file OOStringParsing.m.

{
    NSArray             *stringComponents = nil;
    NSMutableArray      *result = nil;
    NSUInteger          i, count;
    int                 value;
    id                  component;
    
    stringComponents = [string componentsSeparatedByString:@" "];
    stringComponents = [[stringComponents objectAtIndex:0] componentsSeparatedByString:@"-"];
    stringComponents = [[stringComponents objectAtIndex:0] componentsSeparatedByString:@"."];
    count = [stringComponents count];
    result = [NSMutableArray arrayWithCapacity:count];
    
    for (i = 0; i != count; ++i)
    {
        component = [stringComponents objectAtIndex:i];
        if ([component respondsToSelector:@selector(intValue)])  value = MAX([component intValue], 0);
        else  value = 0;
        
        [result addObject:[NSNumber numberWithUnsignedInt:value]];
    }
    
    return result;
}

References count, MAX, and nil.

Referenced by ResourceManager::areRequirementsFulfilled:forOXP:andFile:, OOOXZManager(NSURLConnectionDataDelegate)::installableState:, ResourceManager::matchVersions:withVersion:, OoliteCompareVersion(), OOCheckRequiresPListVerifierStage::run, and VersionComponents().

Here is the caller graph for this function:

OOPadStringToEms()

NSString * OOPadStringToEms	(	NSString *	string,
		float	padEms )

Definition at line 264 of file OOStringParsing.m.

{
    NSString        *result = string;
    float numEms = padEms - OOStringWidthInEm(result);
    if (numEms>0)
    {
        numEms /= OOStringWidthInEm(@" "); // start with wide space
        result=[[@"" stringByPaddingToLength:(NSUInteger)numEms withString: @" " startingAtIndex:0] stringByAppendingString: result];
    }
    // most of the way there, so switch to narrow space
    numEms = padEms - OOStringWidthInEm(result);
    if (numEms>0)
    {
        numEms /= OOStringWidthInEm(@"\037"); // 037 is narrow space
        result=[[@"" stringByPaddingToLength:(NSUInteger)numEms withString: @"\037" startingAtIndex:0] stringByAppendingString: result];
    }
    return result;
}

References OOStringWidthInEm().

Referenced by PlayerEntity(OOPrivate)::showMarketScreenDataLine:forGood:inMarket:holdQuantity:.

Here is the call graph for this function:

Here is the caller graph for this function:

OOStringFromDeciCredits()

NSString * OOStringFromDeciCredits	(	OOCreditsQuantity	tenthsOfCredits,
		BOOL	includeDecimal,
		BOOL	includeSymbol )

Definition at line 284 of file OOStringParsing.m.

{
    JSContext           *context = OOJSAcquireContext();
    JSObject            *global = [[OOJavaScriptEngine sharedEngine] globalObject];
    JSObject            *fakeRoot;
    jsval               method;
    jsval               rval;
    NSString            *result = nil;
    jsval               exception;
    BOOL                hadException;
    
    /*  Because the |cr etc. formatting operators call this, and the
        implementation may use string expansion, we need to ensure recursion
        can't happen.
    */
    static BOOL reentrancyLock;
    if (reentrancyLock)  return [NSString stringWithFormat:@"%0.1f", tenthsOfCredits * 0.1];
    
    reentrancyLock = YES;
    
    hadException = JS_GetPendingException(context, &exception);
    JS_ClearPendingException(context);
    
    if (JS_GetMethodById(context, global, OOJSID("formatCredits"), &fakeRoot, &method))
    {
        jsval args[3];
        if (JS_NewNumberValue(context, tenthsOfCredits * 0.1, &args[0]))
        {
            args[1] = OOJSValueFromBOOL(includeDecimal);
            args[2] = OOJSValueFromBOOL(includeSymbol);
            
            OOJSStartTimeLimiter();
            JS_CallFunctionValue(context, global, method, 3, args, &rval);
            OOJSStopTimeLimiter();
            
            result = OOStringFromJSValue(context, rval);
        }
    }
    
    if (hadException)  JS_SetPendingException(context, exception);
    
    OOJSRelinquishContext(context);
    
    if (EXPECT_NOT(result == nil))  result = [NSString stringWithFormat:@"%li", (long)(tenthsOfCredits) / 10];
    
    reentrancyLock = NO;
    
    return result;
}

References EXPECT_NOT, OOJavaScriptEngine::globalObject, nil, OOJSAcquireContext(), OOJSID, OOJSRelinquishContext(), OOJSStartTimeLimiter, OOJSStopTimeLimiter, OOJSValueFromBOOL(), OOStringFromJSValue(), and OOJavaScriptEngine::sharedEngine.

Referenced by PlayerEntity(ScriptMethods)::creditsFormattedForSubstitution, OOCredits(), and OOStringFromIntCredits().

Here is the call graph for this function:

Here is the caller graph for this function:

PointFromString()

NSPoint PointFromString

(

NSString *

xyString

)

Definition at line 209 of file OOStringParsing.m.

{
    NSArray     *tokens = ScanTokensFromString(xyString);
    NSPoint     result = NSZeroPoint;
    
    NSUInteger n_tokens = [tokens count];
    if (n_tokens == 2)
    {
        result.x = [[tokens objectAtIndex:0] doubleValue];
        result.y = [[tokens objectAtIndex:1] doubleValue];
    }
    return result;
}

References ScanTokensFromString().

Referenced by OOSystemDescriptionManager::buildRouteCache, PlayerEntity::doBookkeeping:, PlayerEntity::enterGalacticWitchspace, PlayerEntity(OOPrivate)::hyperspaceJumpDistance, OOTrumble::setFromDictionary:, PlayerEntity::setSystemID:, PlayerEntity::setTargetSystemID:, and PlayerEntity(OOPrivate)::witchJumpTo:misjump:.

Here is the call graph for this function:

Here is the caller graph for this function:

QuaternionFromString()

Quaternion QuaternionFromString	(	NSString *	wxyzString,
		Quaternion	defaultValue )

Definition at line 195 of file OOStringParsing.m.

{
    Quaternion result;
    if (!ScanQuaternionFromString(wxyzString, &result))  result = defaultValue;
    return result;
}

References ScanQuaternionFromString().

Here is the call graph for this function:

RandomSeedFromString()

Random_Seed RandomSeedFromString

(

NSString *

abcdefString

)

Definition at line 224 of file OOStringParsing.m.

{
    Random_Seed              result;
    int                     abcdef[] = { 0, 0, 0, 0, 0, 0};
    int                     i = 0;
    NSString                *error = nil;
    NSScanner               *scanner = [NSScanner scannerWithString:abcdefString];
    
    while (![scanner isAtEnd] && i < 6 && !error)
    {
        if (![scanner scanInt:&abcdef[i++]])  error = @"could not scan a int value.";
    }
    
    if (!error && i < 6)  error = @"found less than six int values.";
    
    if (!error)
    {
        result.a = abcdef[0];
        result.b = abcdef[1];
        result.c = abcdef[2];
        result.d = abcdef[3];
        result.e = abcdef[4];
        result.f = abcdef[5];
    }
    else
    {
        OOLogERR(kOOLogStringRandomSeedConversion, @"cannot make Random_Seed from '%@': %@", abcdefString, error);
        result = kNilRandomSeed;
    }
    
    return result;
}

References Random_Seed::a, Random_Seed::b, Random_Seed::c, Random_Seed::d, Random_Seed::e, Random_Seed::f, kNilRandomSeed, kOOLogStringRandomSeedConversion, nil, and OOLogERR.

Referenced by OOSystemDescriptionManager::getRandomSeedForCurrentSystem, OOSystemDescriptionManager::getRandomSeedForSystem:inGalaxy:, PlanetEntity::initFromDictionary:withAtmosphere:andSeed:, and OOCharacter(Private)::setCharacterFromDictionary:.

Here is the caller graph for this function:

ScanHPVectorFromString()

BOOL ScanHPVectorFromString	(	NSString *	xyzString,
		HPVector *	outVector )

Definition at line 103 of file OOStringParsing.m.

{
    Vector scanVector;
    assert(outVector != NULL);
    BOOL result = ScanVectorFromString(xyzString, &scanVector);
    if (!result)
    {
        return NO;
    }
    *outVector = vectorToHPVector(scanVector);
    return YES;
}

References ScanVectorFromString().

Referenced by PlayerEntity(Scripting)::addMoon:, PlayerEntity(Scripting)::addPlanet:, and OOHPVectorFromObject().

Here is the call graph for this function:

Here is the caller graph for this function:

ScanQuaternionFromString()

BOOL ScanQuaternionFromString	(	NSString *	wxyzString,
		Quaternion *	outQuaternion )

Definition at line 116 of file OOStringParsing.m.

{
    GLfloat                 wxyz[] = {1.0, 0.0, 0.0, 0.0};
    int                     i = 0;
    NSString                *error = nil;
    NSScanner               *scanner = nil;
    
    assert(outQuaternion != NULL);
    if (wxyzString == nil) return NO;
    
    if (!error) scanner = [NSScanner scannerWithString:wxyzString];
    while (![scanner isAtEnd] && i < 4 && !error)
    {
        if (![scanner scanFloat:&wxyz[i++]])  error = @"could not scan a float value.";
    }
    
    if (!error && i < 4)  error = @"found less than four float values.";
    
    if (!error)
    {
        outQuaternion->w = wxyz[0];
        outQuaternion->x = wxyz[1];
        outQuaternion->y = wxyz[2];
        outQuaternion->z = wxyz[3];
        quaternion_normalize(outQuaternion);
        return YES;
    }
    else
    {
        OOLogERR(kOOLogStringQuaternionConversion, @"cannot make quaternion from '%@': %@", wxyzString, error);
        return NO;
    }
}

References kOOLogStringQuaternionConversion, nil, and OOLogERR.

Referenced by PlayerEntity(Scripting)::addMoon:, PlayerEntity(Scripting)::addPlanet:, OOQuaternionFromObject(), and QuaternionFromString().

Here is the caller graph for this function:

ScanTokensFromString()

NSMutableArray * ScanTokensFromString

(

NSString *

values

)

Definition at line 46 of file OOStringParsing.m.

{
    NSMutableArray          *result = nil;
    NSScanner               *scanner = nil;
    NSString                *token = nil;
    static NSCharacterSet   *space_set = nil;
    
    // Note: Shark suggests we're getting a lot of early exits, but testing showed a pretty steady 2% early exit rate.
    if (EXPECT_NOT(values == nil))  return [NSMutableArray array];
    if (EXPECT_NOT(space_set == nil)) space_set = [[NSCharacterSet whitespaceAndNewlineCharacterSet] retain];
    
    result = [NSMutableArray array];
    scanner = [NSScanner scannerWithString:values];
    
    while (![scanner isAtEnd])
    {
        [scanner ooliteScanCharactersFromSet:space_set intoString:NULL];
        if ([scanner ooliteScanUpToCharactersFromSet:space_set intoString:&token])
        {
            [result addObject:token];
        }
    }
    
    return result;
}

References EXPECT_NOT, and nil.

Referenced by PlayerEntity(Scripting)::add:, GuiDisplayGen::addLongText:startingAtRow:align:, PlayerEntity(Scripting)::addMissionDestination:, PlayerEntity(Scripting)::addShips:, PlayerEntity(Scripting)::addShipsAt:, PlayerEntity(Scripting)::addShipsAtPrecisely:, PlayerEntity(Scripting)::addShipsWithinRadius:, PlayerEntity(Scripting)::addSystemShips:, PlayerEntity(Scripting)::awardCargo:, Universe::coordinatesFromCoordinateSystemString:, OOSystemDescriptionManager::getPropertiesForSystemKey:, ShipEntity::interpretAIMessage:, PlayerEntity(Scripting)::messageShipAIs:, OOParseRolesFromString(), PointFromString(), GuiDisplayGen::printLongText:align:color:fadeTime:key:addToArray:, PlayerEntity(Scripting)::processSceneString:atOffset:, ShipEntity(PureAI)::randomPauseAI:, SkyEntity(OOPrivate)::readColor1:andColor2:andColor3:andColor4:fromDictionary:, GuiDisplayGen::reflowTextForMFD:, PlayerEntity(Scripting)::removeMissionDestination:, PlayerEntity(Scripting)::replaceVariablesInString:, OOCheckShipDataPListVerifierStage(OOPrivate)::rolesFromString:, SanitizeActionStatement(), SanitizeCondition(), ShipEntity(PureAI)::sendScriptMessage:, PlayerEntity(Scripting)::set:, PlayerEntity::setCommanderDataFromDictionary:, ShipEntity(PureAI)::setCoordinates:, PlayerEntity(Scripting)::setGalacticHyperspaceFixedCoordsTo:, OOSystemDescriptionManager::setProperties:forSystemKey:, OOSystemDescriptionManager::setProperty:forSystemKey:andLayer:toValue:fromManifest:, ShipEntity::setUpSubEntities, OOShipRegistry(OODataLoader)::shipIsBallTurretForKey:inShipData:, ShipEntity::spawn:, PlayerEntity(Scripting)::subtract:, AI::takeAction:, OOShipRegistry(OODataLoader)::translateOldStyleSubentityDeclaration:forShip:shipData:fatalError:, and OOSystemDescriptionEntry(OOPrivate)::validateProperty:withValue:.

Here is the caller graph for this function:

ScanVectorAndQuaternionFromString()

BOOL ScanVectorAndQuaternionFromString	(	NSString *	xyzwxyzString,
		Vector *	outVector,
		Quaternion *	outQuaternion )

Definition at line 151 of file OOStringParsing.m.

{
    GLfloat                 xyzwxyz[] = { 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0};
    int                     i = 0;
    NSString                *error = nil;
    NSScanner               *scanner = nil;
    
    assert(outVector != NULL && outQuaternion != NULL);
    if (xyzwxyzString == nil) return NO;
    
    if (!error) scanner = [NSScanner scannerWithString:xyzwxyzString];
    while (![scanner isAtEnd] && i < 7 && !error)
    {
        if (![scanner scanFloat:&xyzwxyz[i++]])  error = @"Could not scan a float value.";
    }
    
    if (!error && i < 7)  error = @"Found less than seven float values.";
    
    if (error)
    {
        OOLogERR(kOOLogStringQuaternionConversion, @"cannot make vector and quaternion from '%@': %@", xyzwxyzString, error);
        return NO;
    }
    
    outVector->x = xyzwxyz[0];
    outVector->y = xyzwxyz[1];
    outVector->z = xyzwxyz[2];
    outQuaternion->w = xyzwxyz[3];
    outQuaternion->x = xyzwxyz[4];
    outQuaternion->y = xyzwxyz[5];
    outQuaternion->z = xyzwxyz[6];
    
    return YES;
}

References kOOLogStringQuaternionConversion, nil, and OOLogERR.

Referenced by PlayerEntity(Scripting)::processSceneString:atOffset:.

Here is the caller graph for this function:

ScanVectorFromString()

BOOL ScanVectorFromString	(	NSString *	xyzString,
		Vector *	outVector )

Definition at line 73 of file OOStringParsing.m.

{
    GLfloat                 xyz[] = {0.0, 0.0, 0.0};
    int                     i = 0;
    NSString                *error = nil;
    NSScanner               *scanner = nil;
    
    assert(outVector != NULL);
    if (xyzString == nil) return NO;
    
    if (!error) scanner = [NSScanner scannerWithString:xyzString];
    while (![scanner isAtEnd] && i < 3 && !error)
    {
        if (![scanner scanFloat:&xyz[i++]])  error = @"could not scan a float value.";
    }
    
    if (!error && i < 3)  error = @"found less than three float values.";
    
    if (!error)
    {
        *outVector = make_vector(xyz[0], xyz[1], xyz[2]);
        return YES;
    }
    else
    {
         OOLogERR(kOOLogStringVectorConversion, @"cannot make vector from '%@': %@", xyzString, error);
         return NO;
    }
}

References kOOLogStringVectorConversion, nil, and OOLogERR.

Referenced by PlanetEntity::initFromDictionary:withAtmosphere:andSeed:, OOVectorFromObject(), PlayerEntity(Scripting)::processSceneString:atOffset:, ScanHPVectorFromString(), PlanetEntity(OOPrivate)::setTextureColorForPlanet:inSystem:, ShipEntity::update:, and VectorFromString().

Here is the caller graph for this function:

StringFromPoint()

NSString * StringFromPoint

(

NSPoint

point

)

Definition at line 203 of file OOStringParsing.m.

{
    return [NSString stringWithFormat:@"%f %f", point.x, point.y];
}

StringFromRandomSeed()

NSString * StringFromRandomSeed

(

Random_Seed

seed

)

Definition at line 258 of file OOStringParsing.m.

{
    return [NSString stringWithFormat: @"%d %d %d %d %d %d", seed.a, seed.b, seed.c, seed.d, seed.e, seed.f];
}

VectorFromString()

Vector VectorFromString	(	NSString *	xyzString,
		Vector	defaultValue )

Definition at line 187 of file OOStringParsing.m.

{
    Vector result;
    if (!ScanVectorFromString(xyzString, &result))  result = defaultValue;
    return result;
}

References ScanVectorFromString().

Here is the call graph for this function:

Variable Documentation

kOOLogStringQuaternionConversion

NSString* const kOOLogStringQuaternionConversion = @"strings.conversion.quaternion"

static

Definition at line 42 of file OOStringParsing.m.

Referenced by ScanQuaternionFromString(), and ScanVectorAndQuaternionFromString().

kOOLogStringRandomSeedConversion

NSString* const kOOLogStringRandomSeedConversion = @"strings.conversion.randomSeed"

static

Definition at line 43 of file OOStringParsing.m.

Referenced by RandomSeedFromString().

kOOLogStringVectorConversion

NSString* const kOOLogStringVectorConversion = @"strings.conversion.vector"

static

Definition at line 41 of file OOStringParsing.m.

Referenced by ScanVectorFromString().