Line data    Source code

       1           0 : /*
       2             : 
       3             : OOConstToString.h
       4             : 
       5             : Convert various sets of integer constants to strings.
       6             : To consider: replacing the integer constants with string constants.
       7             :  See also: OOConstToJSString.h.
       8             : 
       9             : This has grown beyond "const-to-string" at this point.
      10             : 
      11             : Oolite
      12             : Copyright (C) 2004-2013 Giles C Williams and contributors
      13             : 
      14             : This program is free software; you can redistribute it and/or
      15             : modify it under the terms of the GNU General Public License
      16             : as published by the Free Software Foundation; either version 2
      17             : of the License, or (at your option) any later version.
      18             : 
      19             : This program is distributed in the hope that it will be useful,
      20             : but WITHOUT ANY WARRANTY; without even the implied warranty of
      21             : MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      22             : GNU General Public License for more details.
      23             : 
      24             : You should have received a copy of the GNU General Public License
      25             : along with this program; if not, write to the Free Software
      26             : Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
      27             : MA 02110-1301, USA.
      28             : 
      29             : */
      30             : 
      31             : #import <Foundation/Foundation.h>
      32             : #import "OOFunctionAttributes.h"
      33             : #import "OOTypes.h"
      34             : #import "MyOpenGLView.h"
      35             : 
      36             : 
      37           0 : enum
      38             : {
      39             :         // Values used for unknown strings.
      40             :         kOOCargoTypeDefault                     = CARGO_NOT_CARGO,
      41             : //      kOOCommodityTypeDefault         = COMMODITY_UNDEFINED,
      42             :         kOOEnergyUnitTypeDefault        = ENERGY_UNIT_NONE,
      43             :         kOORouteTypeDefault                     = OPTIMIZED_BY_JUMPS
      44             : };
      45             : 
      46             : 
      47             : /*
      48             : 
      49             : To avoid pulling in unnecessary headers, some functions defined in
      50             : OOConstToString.m are declared in the header with the appropriate type
      51             : declaration, in particular:
      52             : 
      53             :         Entity.h:
      54             :         OOStringFromEntityStatus()
      55             :         OOEntityStatusFromString()
      56             :         OOStringFromScanClass()
      57             :         OOScanClassFromString()
      58             : 
      59             :         ShipEntity.h:
      60             :         OOStringFromBehaviour()
      61             :         OOEquipmentIdentifierFromWeaponType()
      62             :         OOWeaponTypeFromEquipmentIdentifierSloppy()
      63             :         OOWeaponTypeFromEquipmentIdentifierStrict()
      64             :         OOStringFromWeaponType()
      65             :         OOWeaponTypeFromString()
      66             :         OODisplayStringFromAlertCondition()
      67             :         
      68             :         PlayerEntity.h:
      69             :         OODisplayRatingStringFromKillCount()
      70             :         KillCountToRatingAndKillString()
      71             :         OODisplayStringFromLegalStatus()
      72             :         OOStringFromGUIScreenID()
      73             :         OOGUIScreenIDFromString()
      74             :         OOGalacticHyperspaceBehaviourFromString()
      75             :         OOStringFromGalacticHyperspaceBehaviour()
      76             :         
      77             :         Universe.h:
      78             :         OODisplayStringFromGovernmentID()
      79             :         OODisplayStringFromEconomyID()
      80             :         
      81             :         OOOpenGL.h:
      82             :         OOShaderSettingFromString()
      83             :         OOStringFromShaderSetting()
      84             :         OODisplayStringFromShaderSetting()
      85             :         
      86             : */
      87             : 
      88           0 : NSString *JSTypeToString(int /* JSType */ type) CONST_FUNC;
      89             : 
      90           0 : NSString *CargoTypeToString(OOCargoType cargo) CONST_FUNC;
      91           0 : OOCargoType StringToCargoType(NSString *string) PURE_FUNC;
      92             : 
      93             : //NSString *CommodityTypeToString(OOCommodityType commodity) CONST_FUNC;        // returns the commodity identifier
      94             : //OOCommodityType StringToCommodityType(NSString *string) PURE_FUNC;            // needs commodity identifier
      95             : 
      96           0 : NSString *EnergyUnitTypeToString(OOEnergyUnitType unit) CONST_FUNC;
      97           0 : OOEnergyUnitType StringToEnergyUnitType(NSString *string) PURE_FUNC;
      98             : 
      99           0 : NSString *CommodityDisplayNameForSymbolicName(NSString *symbolicName);
     100           0 : NSString *CommodityDisplayNameForCommodityArray(NSArray *commodityDefinition);
     101             : 
     102           0 : NSString *DisplayStringForMassUnit(OOMassUnit unit);
     103           0 : NSString *DisplayStringForMassUnitForCommodity(OOCommodityType commodity);
     104             : 
     105           0 : NSString *OOStringFromCompassMode(OOCompassMode mode);
     106           0 : OOCompassMode OOCompassModeFromString(NSString *string);
     107             : 
     108           0 : NSString *OOStringFromLongRangeChartMode(OOLongRangeChartMode chartMode);
     109           0 : OOLongRangeChartMode OOLongRangeChartModeFromString(NSString *string);
     110             : 
     111           0 : NSString *OOStringFromLegalStatusReason(OOLegalStatusReason reason);
     112             : 
     113           0 : NSString *RouteTypeToString(OORouteType routeType);
     114           0 : OORouteType StringToRouteType(NSString *string);
     115             : 
     116           0 : NSString *DockingClearanceStatusToString(OODockingClearanceStatus dockingClearanceStatus) PURE_FUNC;
     117             : 
     118           0 : NSString *OOStringFromGraphicsDetail(OOGraphicsDetail detail);
     119           0 : OOGraphicsDetail OOGraphicsDetailFromString(NSString *string);
     120             : 
     121           0 : NSString *OOStringFromHDRToneMapper(OOHDRToneMapper toneMapper);
     122           0 : OOHDRToneMapper OOHDRToneMapperFromString( NSString *string);
     123             : 
     124           0 : NSString *OOStringFromSDRToneMapper(OOSDRToneMapper toneMapper);
     125           0 : OOSDRToneMapper OOSDRToneMapperFromString( NSString *string);