OODebugStandards.m File Reference

import "OODebugStandards.h"
import "OOLogging.h"
import "OOCollectionExtractors.h"
import "GameController.h"

Include dependency graph for OODebugStandards.m:

Go to the source code of this file.

Enumerations
enum	OOStandardsEnforcement { STANDARDS_ENFORCEMENT_OFF = 0 , STANDARDS_ENFORCEMENT_WARN , STANDARDS_ENFORCEMENT_ENFORCE , STANDARDS_ENFORCEMENT_QUIT }

Functions
void	OOStandardsSetup (void)
void	OOStandardsInternal (NSString *type, NSString *message)
void	OOStandardsDeprecated (NSString *message)
void	OOStandardsError (NSString *message)
BOOL	OOEnforceStandards ()
void	OOSetStandardsForOXPVerifierMode ()

Variables
static BOOL	sSetup = NO
static OOStandardsEnforcement	sEnforcement = STANDARDS_ENFORCEMENT_WARN

Enumeration Type Documentation

OOStandardsEnforcement

enum OOStandardsEnforcement

Enumerator
STANDARDS_ENFORCEMENT_OFF
STANDARDS_ENFORCEMENT_WARN
STANDARDS_ENFORCEMENT_ENFORCE
STANDARDS_ENFORCEMENT_QUIT

Definition at line 49 of file OODebugStandards.m.

             {
// do nothing (equivalent to release build)
    STANDARDS_ENFORCEMENT_OFF = 0,
// warn in log but otherwise do nothing
    STANDARDS_ENFORCEMENT_WARN,
// warn in log, block use of deprecated or error items
    STANDARDS_ENFORCEMENT_ENFORCE,
// note in log, then exit if deprecated or error condition occurs
    STANDARDS_ENFORCEMENT_QUIT
} OOStandardsEnforcement;

Function Documentation

OOEnforceStandards()

BOOL OOEnforceStandards

(

void

)

Definition at line 114 of file OODebugStandards.m.

{
    OOStandardsSetup();
    return sEnforcement >= STANDARDS_ENFORCEMENT_ENFORCE;
}

References OOStandardsSetup(), sEnforcement, and STANDARDS_ENFORCEMENT_ENFORCE.

Referenced by OOShipRegistry(OODataLoader)::canonicalizeSubentityDeclaration:forShip:shipData:fatalError:, ResourceManager::checkPotentialPath:path:, OOEquipmentType(Conveniences)::effectiveTechLevel, EquipmentInfoSetProperty(), OOEquipmentType(Private)::initWithInfo:, LoadScriptWithName(), MissionMarkSystem(), MissionUnmarkSystem(), Universe::populateNormalSpace, ResourceManager::roleCategoriesDictionary, OOShipRegistry(OODataLoader)::sanitizeConditions:, OOScript::scriptsFromFileAtPath:, ShipEntity::setShipScript:, StationEntity::setUpShipFromDictionary:, Universe::setUpWitchspaceBetweenSystem:andSystem:, and OOScript::worldScriptsAtPath:.

Here is the call graph for this function:

Here is the caller graph for this function:

OOSetStandardsForOXPVerifierMode()

void OOSetStandardsForOXPVerifierMode

(

void

)

Definition at line 121 of file OODebugStandards.m.

{
    sEnforcement = STANDARDS_ENFORCEMENT_WARN;
    sSetup = YES;
}

References sEnforcement, sSetup, and STANDARDS_ENFORCEMENT_WARN.

Referenced by OOOXPVerifier(OOPrivate)::initWithPath:.

Here is the caller graph for this function:

OOStandardsDeprecated()

void OOStandardsDeprecated

(

NSString *

message

)

Definition at line 102 of file OODebugStandards.m.

{
    OOStandardsInternal(@"oxp-standards.deprecated",message);
}

References OOStandardsInternal().

Referenced by OOShipRegistry(OODataLoader)::canonicalizeSubentityDeclaration:forShip:shipData:fatalError:, ClockGetProperty(), ShipEntity::dealEnergyDamageWithinDesiredRange, OOEquipmentType(Conveniences)::effectiveTechLevel, EquipmentInfoSetProperty(), OOEquipmentType(Private)::initWithInfo:, LoadScriptWithName(), MissionMarkSystem(), MissionUnmarkSystem(), Universe::populateNormalSpace, ResourceManager::roleCategoriesDictionary, OOShipRegistry(OODataLoader)::sanitizeConditions:, OOScript::scriptsFromFileAtPath:, ShipEntity::setShipScript:, StationEntity::setUpShipFromDictionary:, StationEntity::setUpSubEntities, Universe::setUpWitchspaceBetweenSystem:andSystem:, Universe::spawnShip:, SystemLegacyAddShips(), SystemLegacyAddShipsAt(), SystemLegacyAddShipsAtPrecisely(), SystemLegacyAddShipsWithinRadius(), SystemLegacyAddSystemShips(), SystemLegacySpawnShip(), and OOScript::worldScriptsAtPath:.

Here is the call graph for this function:

Here is the caller graph for this function:

OOStandardsError()

void OOStandardsError

(

NSString *

message

)

Definition at line 108 of file OODebugStandards.m.

{
    OOStandardsInternal(@"oxp-standards.error",message);
}

References OOStandardsInternal().

Referenced by OOShipRegistry(OODataLoader)::applyLikeShips:withKey:, OOShipRegistry(OODataLoader)::canonicalizeAndTagSubentities:, ResourceManager::checkPotentialPath:path:, OOMesh(Private)::loadData:scaleFactor:, OOTextureLoader::loaderWithTextureSpecifier:extraOptions:folder:, and OOShipRegistry(OODataLoader)::removeUnusableEntries:shipMode:.

Here is the call graph for this function:

Here is the caller graph for this function:

OOStandardsInternal()

void OOStandardsInternal	(	NSString *	type,
		NSString *	message )

Definition at line 84 of file OODebugStandards.m.

{
    OOStandardsSetup();
    if (sEnforcement == STANDARDS_ENFORCEMENT_OFF)
    {
        return;
    }
 
    OOLog(type, @"%@", message);
 
    if (sEnforcement == STANDARDS_ENFORCEMENT_QUIT)
    {
        [[GameController sharedController] exitAppWithContext:type];
        // exit
    }
}

References GameController::exitAppWithContext:, OOLog, OOStandardsSetup(), sEnforcement, GameController::sharedController, STANDARDS_ENFORCEMENT_OFF, and STANDARDS_ENFORCEMENT_QUIT.

Referenced by OOStandardsDeprecated(), and OOStandardsError().

Here is the call graph for this function:

Here is the caller graph for this function:

OOStandardsSetup()

void OOStandardsSetup

(

void

)

Definition at line 63 of file OODebugStandards.m.

{
    if (sSetup) 
    {
        return;
    }
    NSUserDefaults *prefs = [NSUserDefaults standardUserDefaults];
    int s = [prefs oo_intForKey:@"enforce-oxp-standards" 
                   defaultValue:STANDARDS_ENFORCEMENT_WARN];
    if (s < STANDARDS_ENFORCEMENT_OFF)
    {
        s = STANDARDS_ENFORCEMENT_OFF;
    }
    else if (s > STANDARDS_ENFORCEMENT_QUIT)
    {
        s = STANDARDS_ENFORCEMENT_QUIT;
    }
    sEnforcement = s;
}

References sEnforcement, sSetup, STANDARDS_ENFORCEMENT_OFF, and STANDARDS_ENFORCEMENT_QUIT.

Referenced by OOEnforceStandards(), and OOStandardsInternal().

Here is the caller graph for this function:

Variable Documentation

sEnforcement

OOStandardsEnforcement sEnforcement = STANDARDS_ENFORCEMENT_WARN

static

Definition at line 60 of file OODebugStandards.m.

Referenced by OOEnforceStandards(), OOSetStandardsForOXPVerifierMode(), OOStandardsInternal(), and OOStandardsSetup().

sSetup

BOOL sSetup = NO

static

Definition at line 47 of file OODebugStandards.m.

Referenced by OOSetStandardsForOXPVerifierMode(), and OOStandardsSetup().