CartoTypeBase.h

Go to the documentation of this file.

/*
CartoTypeBase.h
Copyright 2011-2023 CartoType Ltd.
See www.cartotype.com for more information.
*/
 
#ifndef CartoTypeBase_h__
#define CartoTypeBase_h__
 
#import <Foundation/Foundation.h>
#import <CoreGraphics/CGImage.h>
#import <CoreGraphics/CGGeometry.h>
#import <CartoType/CartoTypeResultCode.h>
 
typedef enum
    {
    StringMatchPrefixFlag = 1,
    StringMatchIgnoreSymbolsFlag = 2,
    StringMatchFoldAccentsFlag = 4,
    StringMatchFuzzyFlag = 8,
    StringMatchFoldCaseFlag = 16,
    StringMatchIgnoreWhitespaceFlag = 32,
    
    StringMatchExact = 0,
    StringMatchFoldCase = StringMatchFoldCaseFlag,
    StringMatchPrefix = StringMatchPrefixFlag,
    StringMatchIgnoreNonAlphanumerics = StringMatchIgnoreSymbolsFlag | StringMatchIgnoreWhitespaceFlag,
    StringMatchLoose = StringMatchIgnoreNonAlphanumerics | StringMatchFoldAccentsFlag | StringMatchFoldCaseFlag,
    StringMatchFuzzy = StringMatchIgnoreNonAlphanumerics | StringMatchFoldAccentsFlag | StringMatchFuzzyFlag | StringMatchFoldCaseFlag
    } CartoTypeStringMatchMethod;
 
typedef enum
    {
    PngFileType,
    JpegFileType,
    TiffFileType,
    Ctm1FileType,
    CtmsFileType,
    KmlFileType,
    CtsqlFileType,
    CartoTypeRouteFileType,
    GpxFileType
    } CartoTypeFileType;
 
typedef enum
    {
    PointMapObjectType,
    
    LineMapObjectType,
    
    PolygonMapObjectType,
    
    ArrayMapObjectType,
    
    MapObjectTypes,
    
    NoMapObjectType = -1
    
    } CartoTypeMapObjectType;
 
typedef enum
    {
    OnCurvePointType = 0,
    QuadraticPointType = 1,
    CubicPointType = 2
    } CartoTypePointType;
 
typedef enum
    {
    AlignCenter,
    AlignStandard,
    AlignReverse,
    AlignLeft,
    AlignRight
    } CartoTypeAlign;
 
typedef struct
    {
    int32_t x;
    int32_t y;
    CartoTypePointType type;
    } CartoTypePathPoint;
 
typedef struct
    {
    double x;
    double y;
    CartoTypePointType type;
    } CartoTypePathPointFP;
 
typedef struct
    {
    double x;
    double y;
    } CartoTypePoint;
 
typedef struct
    {
    double minX;
    double minY;
    double maxX;
    double maxY;
    } CartoTypeRect;
 
typedef struct
    {
    CartoTypePoint point;
    CTResult result;
    } CartoTypePointAndResult;
    
typedef struct
    {
    CartoTypeRect rect;
    CTResult result;
    } CartoTypeRectAndResult;
   
@class CartoTypeGeometry; // forward declaration
 
@interface CartoTypeGeometryAndResult: NSObject
    @property (nonatomic, strong) CartoTypeGeometry* geometry;
    @property (nonatomic) CTResult result;
@end
 
typedef struct
    {
    uint64_t objectId;
    CTResult result;
    } CartoTypeIdAndResult;
    
typedef struct
    {
    double area;
    double length;
    CTResult result;
    } CartoTypeAreaLengthAndResult;
 
typedef enum
    {
    DegreeCoordType,
    DisplayCoordType,
    ScreenCoordType = DisplayCoordType,
    MapCoordType,
    MapMeterCoordType
    } CartoTypeCoordType;
    
typedef uint32_t CartoTypeColor;
 
enum
    {
    CTBlack = 0xFF000000,
    CTDarkGray = 0xFF555555,
    CTDarkRed = 0xFF000080,
    CTDarkGreen = 0xFF008000,
    CTDarkYellow = 0xFF008080,
    CTDarkBlue = 0xFF800000,
    CTDarkMagenta = 0xFF800080,
    CTDarkCyan = 0xFF808000,
    CTRed = 0xFF0000FF,
    CTGreen = 0xFF00FF00,
    CTYellow = 0xFF00FFFF,
    CTBlue = 0xFFFF0000,
    CTMagenta = 0xFFFF00FF,
    CTCyan = 0xFFFFFF00,
    CTGray = 0xFFAAAAAA,
    CTWhite = 0xFFFFFFFF,
 
    CTTransparentBlack = 0x00000000
    };
    
@interface CartoTypeBlendStyle: NSObject
    @property (nonatomic) NSString* styles;
    @property (nonatomic) CartoTypeColor mainColor;
    @property (nonatomic) CartoTypeColor borderColor;
    @property (nonatomic) CartoTypeColor textColor;
    @property (nonatomic) CartoTypeColor textGlowColor;
    @property (nonatomic) CartoTypeColor iconColor;
    
    -(id)initWithBlendStyle:(void*)aBlendStyle;
    -(const void*)blendStyle;
@end
 
@interface CartoTypeAddress: NSObject
    @property (nonatomic, strong) NSString* building;
    @property (nonatomic, strong) NSString* feature;
    @property (nonatomic, strong) NSString* street;
    @property (nonatomic, strong) NSString* subLocality;
    @property (nonatomic, strong) NSString* locality;
    @property (nonatomic, strong) NSString* island;
    @property (nonatomic, strong) NSString* subAdminArea;
    @property (nonatomic, strong) NSString* adminArea;
    @property (nonatomic, strong) NSString* country;
    @property (nonatomic, strong) NSString* postCode;
    -(NSString*)ToString:(bool) aFull;
    @end
 
@protocol CartoTypePath
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
@end
 
@interface CartoTypeMatch: NSObject
    @property (nonatomic) bool found;
    @property (nonatomic, strong) NSString* key;
    @property (nonatomic, strong) NSString* value;
    @property (nonatomic) size_t start;
    @property (nonatomic) size_t end;
@end
 
#define MakeFeatureTypeCode(A,B,C) ((((A)-'a'+1) << 10) | (((B)-'a'+1) << 5) | ((C)-'a'+1))
 
typedef enum
    {
    FeatureTypeMotorway = 0,
    FeatureTypeMotorwayLink = 1,
    FeatureTypeTrunkRoad = 2,
    FeatureTypeTrunkLink = 3,
    FeatureTypePrimaryRoad = 4,
    FeatureTypePrimaryLink = 5,
    FeatureTypeSecondaryRoad = 6,
    FeatureTypeSecondaryLink = 7,
    FeatureTypeTertiaryRoad = 8,
    FeatureTypeUnclassifiedRoad = 9,
    FeatureTypeResidentialRoad = 10,
    FeatureTypeTrack = 11,
    FeatureTypeServiceRoad = 12,
    FeatureTypePedestrianRoad = 13,
    FeatureTypeVehicularFerry = 14,
    FeatureTypePassengerFerry = 15,
    FeatureTypeLivingStreet = 16,
    FeatureTypeCycleway = 17,
    FeatureTypePath = 18,
    FeatureTypeFootway = 19,
    FeatureTypeBridleway = 20,
    FeatureTypeSteps = 21,
    FeatureTypeOtherRoad = 22,
    FeatureTypeUnpavedRoad = 23,
    FeatureTypeRailway = 24,
    FeatureTypeLightRail = 25,
    FeatureTypeSubway = 26,
    FeatureTypeAerialWay = 27,
    FeatureTypeSkiDownhill = 28,
    FeatureTypeSkiNordic = 29,
    FeatureTypeWaterway = 30,
    FeatureTypeUnknownRoute = 31,
 
    FeatureTypeUnknownNonRoute = 32,
 
    /*
    Three-letter type codes. Keep these in alphabetic order of type letters to avoid duplicates.
    No routable types should appear among the three-letter codes; all routable objects should be
    given one of the types 0...31.
 
    The lowest possible three-letter code, aaa, has the value 1057 = 1024 + 32 + 1.
    The highest code, zzz, has the value 27482 = (1024 * 26) + (32 * 26) + 26.
    */
    FeatureTypeAdminArea1 = MakeFeatureTypeCode('a','a','a'),
    FeatureTypeAdminArea2 = MakeFeatureTypeCode('a','a','b'),
    FeatureTypeAdminArea3 = MakeFeatureTypeCode('a','a','c'),
    FeatureTypeAdminArea4 = MakeFeatureTypeCode('a','a','d'),
    FeatureTypeAdminArea5 = MakeFeatureTypeCode('a','a','e'),
    FeatureTypeAdminArea6 = MakeFeatureTypeCode('a','a','f'),
    FeatureTypeAdminArea7 = MakeFeatureTypeCode('a','a','g'),
    FeatureTypeAdminArea8 = MakeFeatureTypeCode('a','a','h'),
    FeatureTypeAdminArea9 = MakeFeatureTypeCode('a','a','i'),
    FeatureTypeAdminArea10 = MakeFeatureTypeCode('a','a','j'),
    FeatureTypeAddress = MakeFeatureTypeCode('a','d','d'),
    FeatureTypeAerodrome = MakeFeatureTypeCode('a','e','r'),
    FeatureTypeAirport = MakeFeatureTypeCode('a','i','r'),
    FeatureTypeAirportGate = MakeFeatureTypeCode('a','g','t'),
    FeatureTypeAirportHoldingPosition = MakeFeatureTypeCode('a','h','p'),
    FeatureTypeAllotments = MakeFeatureTypeCode('a','l','l'),
    FeatureTypeAlpineHut = MakeFeatureTypeCode('a','l','p'),
    FeatureTypeAmbulanceStation = MakeFeatureTypeCode('a','m','b'),
    FeatureTypeApron = MakeFeatureTypeCode('a','p','r'),
    FeatureTypeAerialWayPylon = MakeFeatureTypeCode('a','p','y'),
    FeatureTypeArtwork = MakeFeatureTypeCode('a','r','t'),
    FeatureTypeAerialWayStation = MakeFeatureTypeCode('a','s','t'),
    FeatureTypeAirTerminal = MakeFeatureTypeCode('a','t','e'),
    FeatureTypeAtm = MakeFeatureTypeCode('a','t','m'),
    FeatureTypeAttraction = MakeFeatureTypeCode('a','t','t'),
    FeatureTypeBar = MakeFeatureTypeCode('b','a','r'),
    FeatureTypeBasin = MakeFeatureTypeCode('b','a','s'),
    FeatureTypeBay = MakeFeatureTypeCode('b','a','y'),
    FeatureTypeBeach = MakeFeatureTypeCode('b','e','a'),
    FeatureTypeBeacon = MakeFeatureTypeCode('b','e','c'),
    FeatureTypeBedAndBreakfast = MakeFeatureTypeCode('b','e','d'),
    FeatureTypeBench = MakeFeatureTypeCode('b','e','n'),
    FeatureTypeBank = MakeFeatureTypeCode('b','n','k'),
    FeatureTypeBoatyard = MakeFeatureTypeCode('b','o','a'),
    FeatureTypeBorough = MakeFeatureTypeCode('b','o','r'),
    FeatureTypeBoundary = MakeFeatureTypeCode('b','o','u'),
    FeatureTypeBicycleParking = MakeFeatureTypeCode('b','p','k'),
    FeatureTypeBicycleRental = MakeFeatureTypeCode('b','r','e'),
    FeatureTypeBareRock = MakeFeatureTypeCode('b','r','c'),
    FeatureTypeBarracks = MakeFeatureTypeCode('b','r','k'),
    FeatureTypeBrownField = MakeFeatureTypeCode('b','r','o'),
    FeatureTypeBusStop = MakeFeatureTypeCode('b','s','p'),
    FeatureTypeBusStation = MakeFeatureTypeCode('b','s','t'),
    FeatureTypeBufferStop = MakeFeatureTypeCode('b','u','f'),
    FeatureTypeBuilding = MakeFeatureTypeCode('b','u','i'),
    FeatureTypeBunker = MakeFeatureTypeCode('b','u','n'),
    FeatureTypeCabin = MakeFeatureTypeCode('c','a','b'),
    FeatureTypeCafe = MakeFeatureTypeCode('c','a','f'),
    FeatureTypeCampSite = MakeFeatureTypeCode('c','a','m'),
    FeatureTypeCanal = MakeFeatureTypeCode('c','a','n'),
    FeatureTypeCaveEntrance = MakeFeatureTypeCode('c','a','v'),
    FeatureTypeCableCar = MakeFeatureTypeCode('c','c','r'),
    FeatureTypeCableDistributionCabinet = MakeFeatureTypeCode('c','d','c'),
    FeatureTypeCemetery = MakeFeatureTypeCode('c','e','m'),
    FeatureTypeChairLift = MakeFeatureTypeCode('c','h','a'),
    FeatureTypeCheckPoint = MakeFeatureTypeCode('c','h','e'),
    FeatureTypeChalet = MakeFeatureTypeCode('c','h','l'),
    FeatureTypeCivilBoundary = MakeFeatureTypeCode('c','i','b'),
    FeatureTypeCinema = MakeFeatureTypeCode('c','i','n'),
    FeatureTypeCity = MakeFeatureTypeCode('c','i','t'),
    FeatureTypeCliff = MakeFeatureTypeCode('c','l','f'),
    FeatureTypeClinic = MakeFeatureTypeCode('c','l','i'),
    FeatureTypeCommercial = MakeFeatureTypeCode('c','m','r'),
    FeatureTypeCoastline = MakeFeatureTypeCode('c','o','a'),
    FeatureTypeCollege = MakeFeatureTypeCode('c','o','l'),
    FeatureTypeCommon = MakeFeatureTypeCode('c','o','m'),
    FeatureTypeConstruction = MakeFeatureTypeCode('c','n','s'),
    FeatureTypeConservation = MakeFeatureTypeCode('c','n','v'),
    FeatureTypeContinent = MakeFeatureTypeCode('c','o','n'),
    FeatureTypeCounty = MakeFeatureTypeCode('c','o','u'),
    FeatureTypeCarPark = MakeFeatureTypeCode('c','p','k'),
    FeatureTypeCarRental = MakeFeatureTypeCode('c','r','e'),
    FeatureTypeCrossing = MakeFeatureTypeCode('c','r','o'),
    FeatureTypeCountry = MakeFeatureTypeCode('c','r','y'),
    FeatureTypeCarSharing = MakeFeatureTypeCode('c','s','h'),
    FeatureTypeCutLine = MakeFeatureTypeCode('c','u','t'),
    FeatureTypeCarWash = MakeFeatureTypeCode('c','w','a'),
    FeatureTypeCaravanSite = MakeFeatureTypeCode('c','v','n'),
    FeatureTypeCyclingRoute = MakeFeatureTypeCode('c','y','r'),
    FeatureTypeDam = MakeFeatureTypeCode('d','a','m'),
    FeatureTypeDangerArea = MakeFeatureTypeCode('d','a','n'),
    FeatureTypeDentist = MakeFeatureTypeCode('d','e','n'),
    FeatureTypeDisused = MakeFeatureTypeCode('d','i','s'),
    FeatureTypeDitch = MakeFeatureTypeCode('d','i','t'),
    FeatureTypeDock = MakeFeatureTypeCode('d','o','c'),
    FeatureTypeDogPark = MakeFeatureTypeCode('d','o','g'),
    FeatureTypeDrain = MakeFeatureTypeCode('d','r','a'),
    FeatureTypeDragLift = MakeFeatureTypeCode('d','r','g'),
    FeatureTypeDoctors = MakeFeatureTypeCode('d','r','s'),
    FeatureTypeDistrict = MakeFeatureTypeCode('d','s','t'),
    FeatureTypeElectricVehicleCharging = MakeFeatureTypeCode('e','v','c'),
    FeatureTypeFarm = MakeFeatureTypeCode('f','a','r'),
    FeatureTypeFarmYard = MakeFeatureTypeCode('f','a','y'),
    FeatureTypeFell = MakeFeatureTypeCode('f','e','l'),
    FeatureTypeFerryTerminal = MakeFeatureTypeCode('f','e','t'),
    FeatureTypeFastFood = MakeFeatureTypeCode('f','f','d'),
    FeatureTypeFireExtinguisher = MakeFeatureTypeCode('f','i','e'),
    FeatureTypeFireFlapper = MakeFeatureTypeCode('f','i','f'),
    FeatureTypeFireHose = MakeFeatureTypeCode('f','i','h'),
    FeatureTypeFireStation = MakeFeatureTypeCode('f','i','s'),
    FeatureTypeFitnessStation = MakeFeatureTypeCode('f','i','t'),
    FeatureTypeFireHydrant = MakeFeatureTypeCode('f','i','y'),
    FeatureTypeForestry = MakeFeatureTypeCode('f','o','r'),
    FeatureTypeFishing = MakeFeatureTypeCode('f','s','h'),
    FeatureTypeFuel = MakeFeatureTypeCode('f','u','e'),
    FeatureTypeFunicular = MakeFeatureTypeCode('f','u','n'),
    FeatureTypeGarages = MakeFeatureTypeCode('g','a','r'),
    FeatureTypeGate = MakeFeatureTypeCode('g','a','t'),
    FeatureTypeGarden = MakeFeatureTypeCode('g','d','n'),
    FeatureTypeGenerator = MakeFeatureTypeCode('g','e','n'),
    FeatureTypeGreenHouse = MakeFeatureTypeCode('g','h','o'),
    FeatureTypeGlacier = MakeFeatureTypeCode('g','l','a'),
    FeatureTypeGolfCourse = MakeFeatureTypeCode('g','o','l'),
    FeatureTypeGondola = MakeFeatureTypeCode('g','o','n'),
    FeatureTypeGoodsAerialWay = MakeFeatureTypeCode('g','o','o'),
    FeatureTypeGrass = MakeFeatureTypeCode('g','r','a'),
    FeatureTypeGreenField = MakeFeatureTypeCode('g','r','e'),
    FeatureTypeGritBin = MakeFeatureTypeCode('g','r','b'),
    FeatureTypeGraveYard = MakeFeatureTypeCode('g','r','y'),
    FeatureTypeGuestHouse = MakeFeatureTypeCode('g','u','e'),
    FeatureTypeHalt = MakeFeatureTypeCode('h','a','l'),
    FeatureTypeHamlet = MakeFeatureTypeCode('h','a','m'),
    FeatureTypeHangar = MakeFeatureTypeCode('h','a','n'),
    FeatureTypeHeath = MakeFeatureTypeCode('h','e','a'),
    FeatureTypeHelipad = MakeFeatureTypeCode('h','e','l'),
    FeatureTypeRailwayHalt = MakeFeatureTypeCode('h','l','t'),
    FeatureTypeHikingRoute = MakeFeatureTypeCode('h','i','k'),
    FeatureTypeHorseRiding = MakeFeatureTypeCode('h','o','r'),
    FeatureTypeHospital = MakeFeatureTypeCode('h','o','s'),
    FeatureTypeHotel = MakeFeatureTypeCode('h','o','t'),
    FeatureTypeHorseRidingRoute = MakeFeatureTypeCode('h','r','r'),
    FeatureTypeHostel = MakeFeatureTypeCode('h','s','t'),
    FeatureTypeIceRink = MakeFeatureTypeCode('i','c','e'),
    FeatureTypeIndustrial = MakeFeatureTypeCode('i','n','d'),
    FeatureTypeInformation = MakeFeatureTypeCode('i','n','f'),
    FeatureTypeIsland = MakeFeatureTypeCode('i','s','l'),
    FeatureTypeIsolatedDwelling = MakeFeatureTypeCode('i','s','o'),
    FeatureTypeJunction = MakeFeatureTypeCode('j','c','t'),
    FeatureTypeKindergarten = MakeFeatureTypeCode('k','i','n'),
    FeatureTypeLandFill = MakeFeatureTypeCode('l','a','n'),
    FeatureTypeLand = MakeFeatureTypeCode('l','n','d'),
    FeatureTypeLevelCrossing = MakeFeatureTypeCode('l','e','v'),
    FeatureTypeLibrary = MakeFeatureTypeCode('l','i','b'),
    FeatureTypeLocality = MakeFeatureTypeCode('l','o','c'),
    FeatureTypeLockGate = MakeFeatureTypeCode('l','o','k'),
    FeatureTypeMaritimeBoundary = MakeFeatureTypeCode('m','a','b'),
    FeatureTypeMall = MakeFeatureTypeCode('m','a','l'),
    FeatureTypeMarsh = MakeFeatureTypeCode('m','a','r'),
    FeatureTypeMeadow = MakeFeatureTypeCode('m','e','a'),
    FeatureTypeMilitary = MakeFeatureTypeCode('m','i','l'),
    FeatureTypeMarina = MakeFeatureTypeCode('m','n','a'),
    FeatureTypeMotel = MakeFeatureTypeCode('m','o','t'),
    FeatureTypeMinorPowerLine = MakeFeatureTypeCode('m','p','l'),
    FeatureTypeMiniatureGolf = MakeFeatureTypeCode('m','r','g'),
    FeatureTypeMiniatureRailway = MakeFeatureTypeCode('m','r','y'),
    FeatureTypeMud = MakeFeatureTypeCode('m','u','d'),
    FeatureTypeMunicipality = MakeFeatureTypeCode('m','u','n'),
    FeatureTypeMuseum = MakeFeatureTypeCode('m','u','s'),
    FeatureTypeNatureReserve = MakeFeatureTypeCode('n','a','t'),
    FeatureTypeNationalPark = MakeFeatureTypeCode('n','a','p'),
    FeatureTypeNavalBase = MakeFeatureTypeCode('n','a','v'),
    FeatureTypeNeighborhood = MakeFeatureTypeCode('n','e','i'),
    FeatureTypeNursingHome = MakeFeatureTypeCode('n','u','r'),
    FeatureTypeOrchard = MakeFeatureTypeCode('o','r','c'),
    FeatureTypePrecisionApproachPathIndicator = MakeFeatureTypeCode('p','a','p'),
    FeatureTypePark = MakeFeatureTypeCode('p','a','r'),
    FeatureTypePublicBuilding = MakeFeatureTypeCode('p','b','u'),
    FeatureTypePostBox = MakeFeatureTypeCode('p','b','x'),
    FeatureTypePostCode = MakeFeatureTypeCode('p','c','o'),
    FeatureTypePicnicTable = MakeFeatureTypeCode('p','c','t'),
    FeatureTypePeak = MakeFeatureTypeCode('p','e','a'),
    FeatureTypePharmacy = MakeFeatureTypeCode('p','h','a'),
    FeatureTypePhone = MakeFeatureTypeCode('p','h','o'),
    FeatureTypePicnicSite = MakeFeatureTypeCode('p','i','c'),
    FeatureTypePier = MakeFeatureTypeCode('p','i','e'),
    FeatureTypePipeline = MakeFeatureTypeCode('p','i','p'),
    FeatureTypeParkingEntrance = MakeFeatureTypeCode('p','k','e'),
    FeatureTypeParking = MakeFeatureTypeCode('p','k','g'),
    FeatureTypeParkingSpace = MakeFeatureTypeCode('p','k','s'),
    FeatureTypePlantNursery = MakeFeatureTypeCode('p','l','a'),
    FeatureTypePlatform = MakeFeatureTypeCode('p','l','f'),
    FeatureTypePlaceOfWorship = MakeFeatureTypeCode('p','l','w'),
    FeatureTypePlayground = MakeFeatureTypeCode('p','l','y'),
    FeatureTypePostOffice = MakeFeatureTypeCode('p','o','f'),
    FeatureTypePolice = MakeFeatureTypeCode('p','o','l'),
    FeatureTypePosition = MakeFeatureTypeCode('p','o','s'),
    FeatureTypeProtectedArea = MakeFeatureTypeCode('p','r','a'),
    FeatureTypePowerSubStation = MakeFeatureTypeCode('p','s','s'),
    FeatureTypePub = MakeFeatureTypeCode('p','u','b'),
    FeatureTypePowerLine = MakeFeatureTypeCode('p','w','l'),
    FeatureTypePowerStation = MakeFeatureTypeCode('p','w','s'),
    FeatureTypeQuarry = MakeFeatureTypeCode('q','a','r'),
    FeatureTypeQuarter = MakeFeatureTypeCode('q','r','t'),
    FeatureTypeRange = MakeFeatureTypeCode('r','a','n'),
    FeatureTypeRapids = MakeFeatureTypeCode('r','a','p'),
    FeatureTypeRecycling = MakeFeatureTypeCode('r','c','y'),
    FeatureTypeRecreationGround = MakeFeatureTypeCode('r','e','c'),
    FeatureTypeReef = MakeFeatureTypeCode('r','e','e'),
    FeatureTypeRegion = MakeFeatureTypeCode('r','e','g'),
    FeatureTypeRetail = MakeFeatureTypeCode('r','e','t'),
    FeatureTypeRidge = MakeFeatureTypeCode('r','i','j'),
    FeatureTypeRiver = MakeFeatureTypeCode('r','i','v'),
    FeatureTypeRock = MakeFeatureTypeCode('r','o','c'),
    FeatureTypeRoundHouse = MakeFeatureTypeCode('r','o','u'),
    FeatureTypeResidentialArea = MakeFeatureTypeCode('r','s','d'),
    FeatureTypeRestaurant = MakeFeatureTypeCode('r','s','t'),
    FeatureTypeReservoir = MakeFeatureTypeCode('r','s','v'),
    FeatureTypeRunway = MakeFeatureTypeCode('r','u','n'),
    FeatureTypeRoute = MakeFeatureTypeCode('r','u','t'),
    FeatureTypeRiverBank = MakeFeatureTypeCode('r','v','b'),
    FeatureTypeSaltPond = MakeFeatureTypeCode('s','a','l'),
    FeatureTypeSand = MakeFeatureTypeCode('s','a','n'),
    FeatureTypeSauna = MakeFeatureTypeCode('s','a','u'),
    FeatureTypeSchool = MakeFeatureTypeCode('s','c','h'),
    FeatureTypeScree = MakeFeatureTypeCode('s','c','r'),
    FeatureTypeScrub = MakeFeatureTypeCode('s','c','b'),
    FeatureTypeSea = MakeFeatureTypeCode('s','e','a'),
    FeatureTypeStateEmergencyServiceStation = MakeFeatureTypeCode('s','e','s'),
    FeatureTypeShop = MakeFeatureTypeCode('s','h','o'),
    FeatureTypeSkiRoute = MakeFeatureTypeCode('s','k','r'),
    FeatureTypeSlipway = MakeFeatureTypeCode('s','l','i'),
    FeatureTypeSportsCenter = MakeFeatureTypeCode('s','p','o'),
    FeatureTypeSportsPitch = MakeFeatureTypeCode('s','p','p'),
    FeatureTypeSpring = MakeFeatureTypeCode('s','p','r'),
    FeatureTypeSportsTrack = MakeFeatureTypeCode('s','p','t'),
    FeatureTypeState = MakeFeatureTypeCode('s','t','a'),
    FeatureTypeStadium = MakeFeatureTypeCode('s','t','m'),
    FeatureTypeRailwayStation = MakeFeatureTypeCode('s','t','n'),
    FeatureTypeStation = MakeFeatureTypeCode('s','t','n'), // deliberate duplicate
    FeatureTypeStone = MakeFeatureTypeCode('s','t','o'),
    FeatureTypeStopPosition = MakeFeatureTypeCode('s','t','p'),
    FeatureTypeStream = MakeFeatureTypeCode('s','t','r'),
    FeatureTypeStrait = MakeFeatureTypeCode('s','t','t'),
    FeatureTypeSuburb = MakeFeatureTypeCode('s','u','b'),
    FeatureTypeSupermarket = MakeFeatureTypeCode('s','u','p'),
    FeatureTypeSurveyPoint = MakeFeatureTypeCode('s','u','r'),
    FeatureTypeSubwayEntrance = MakeFeatureTypeCode('s','w','e'),
    FeatureTypeSwimmingPool = MakeFeatureTypeCode('s','w','i'),
    FeatureTypeTank = MakeFeatureTypeCode('t','a','n'),
    FeatureTypeTaxi = MakeFeatureTypeCode('t','a','x'),
    FeatureTypeTheatre = MakeFeatureTypeCode('t','h','e'),
    FeatureTypeThemePark = MakeFeatureTypeCode('t','h','p'),
    FeatureTypeToilet = MakeFeatureTypeCode('t','o','i'),
    FeatureTypeTown = MakeFeatureTypeCode('t','o','w'),
    FeatureTypeTurningCircle = MakeFeatureTypeCode('t','c','i'),
    FeatureTypeTurningPoint = MakeFeatureTypeCode('t','p','t'),
    FeatureTypeTram = MakeFeatureTypeCode('t','r','a'),
    FeatureTypeTree = MakeFeatureTypeCode('t','r','e'),
    FeatureTypeTrafficSignals = MakeFeatureTypeCode('t','r','f'),
    FeatureTypeTrackPoint = MakeFeatureTypeCode('t','r','p'),
    FeatureTypeTreeRow = MakeFeatureTypeCode('t','r','r'),
    FeatureTypeTramStop = MakeFeatureTypeCode('t','r','s'),
    FeatureTypeTurnTable = MakeFeatureTypeCode('t','u','r'),
    FeatureTypeTower = MakeFeatureTypeCode('t','w','r'),
    FeatureTypeTaxiway = MakeFeatureTypeCode('t','w','y'),
    FeatureTypeUniversity = MakeFeatureTypeCode('u','n','i'),
    FeatureTypeVisualApproachSlopeIndicator = MakeFeatureTypeCode('v','a','s'),
    FeatureTypeVillageGreen = MakeFeatureTypeCode('v','i','g'),
    FeatureTypeVillage = MakeFeatureTypeCode('v','i','l'),
    FeatureTypeVineyard = MakeFeatureTypeCode('v','i','n'),
    FeatureTypeViewPoint = MakeFeatureTypeCode('v','i','w'),
    FeatureTypeVolcano = MakeFeatureTypeCode('v','o','l'),
    FeatureTypeWaterfall = MakeFeatureTypeCode('w','a','f'),
    FeatureTypeWaterPark = MakeFeatureTypeCode('w','a','p'),
    FeatureTypeWater = MakeFeatureTypeCode('w','a','t'),
    FeatureTypeWeir = MakeFeatureTypeCode('w','e','r'),
    FeatureTypeWetland = MakeFeatureTypeCode('w','e','t'),
    FeatureTypeWindsock = MakeFeatureTypeCode('w','i','s'),
    FeatureTypeWalkingRoute = MakeFeatureTypeCode('w','l','k'),
    FeatureTypeWood = MakeFeatureTypeCode('w','o','o'),
    FeatureTypeWorks = MakeFeatureTypeCode('w','o','r'),
    FeatureTypeWaypoint = MakeFeatureTypeCode('w','p','t'),
    FeatureTypeWaterTower = MakeFeatureTypeCode('w','t','t'),
    FeatureTypeWaterWell = MakeFeatureTypeCode('w','t','w'),
    FeatureTypeZoo = MakeFeatureTypeCode('z','o','o'),
 
    // legacy types for backward compatibility
    FeatureTypeLegacyBridleway = MakeFeatureTypeCode('b','r','i'),
    FeatureTypeLegacyCycleway = MakeFeatureTypeCode('c','y','c'),
    FeatureTypeLegacyFootway = MakeFeatureTypeCode('f','o','o'),
    FeatureTypeLegacyLightRail = MakeFeatureTypeCode('l','i','r'),
    FeatureTypeLegacyMonorail = MakeFeatureTypeCode('m','o','n'),
    FeatureTypeLegacyNarrowGauge = MakeFeatureTypeCode('n','a','r'),
    FeatureTypeLegacyPreservedRailway = MakeFeatureTypeCode('p','r','y'),
    FeatureTypeLegacyRailway = MakeFeatureTypeCode('r','l','y'),
    FeatureTypeLegacySteps = MakeFeatureTypeCode('s','t','e'),
    FeatureTypeLegacySubway = MakeFeatureTypeCode('s','w','y'),
    FeatureTypeLegacyTram = MakeFeatureTypeCode('t','r','a'),
 
    FeatureTypeInvalid = INT16_MAX
    } CartoTypeFeatureType;
    
typedef enum
    {
    FeatureDiscriminatorNonRoute = 0,
    FeatureDiscriminatorBridgeRoute = 1,
    FeatureDiscriminatorTunnelRoute = 2,
    FeatureDiscriminatorRoute = 3
    } CartoTypeFeatureDiscriminator;
 
@interface CartoTypeFeatureInfo: NSObject
    -(id)init;
    -(id)initWithType:(CartoTypeFeatureType)aFeatureType;
    -(id)initWithTypeAndSubType:(CartoTypeFeatureType)aFeatureType subType:(int)aSubType;
    -(id)initWithSubType:(int)aSubType;
    @property (nonatomic) CartoTypeFeatureDiscriminator discriminator;
    @property (nonatomic) bool route;
    @property (nonatomic) bool tunnel;
    @property (nonatomic) bool bridge;
    @property (nonatomic) int level;
    @property (nonatomic) CartoTypeFeatureType type;
    @property (nonatomic) bool oneWay;
    @property (nonatomic) bool oneWayForward;
    @property (nonatomic) bool oneWayBackward;
    @property (nonatomic) bool driveOnLeft;
    @property (nonatomic) bool driveOnRight;
    -(void)reverseOneWayDirection;
    @property (nonatomic) bool roundabout;
    @property (nonatomic) bool toll;
    @property (nonatomic) bool wrongWay;
    @property (nonatomic) int speedLimit;
    @property (nonatomic) int gradient;
    -(void)setVehicleAccess:(bool)aValue;
    @property (nonatomic) bool pedestrianAccess;
    @property (nonatomic) bool cycleAccess;
    @property (nonatomic) bool motorVehicleAccess;
    @property (nonatomic) bool emergencyVehicleAccess;
    @property (nonatomic) bool otherAccessRestricted;
    @property (nonatomic) bool isPrivate;
    @property (nonatomic) int subType;
    -(id)initWithRawValue:(uint32_t)aValue;
    -(uint32_t)rawValue;
@end
 
static const uint32_t KFeatureInfoRouteTypeCount = 32;
static const uint32_t KFeatureInfoGradientCount = 8;
static const uint32_t KFeatureInfoMaxSubType = 2047;
 
static const uint32_t KRouteAccessShift = 26;
static const uint32_t KRouteAccessMask = 63U << KRouteAccessShift;
static const uint32_t KRouteAccessWrongWayFlag = 1 << 26;
static const uint32_t KRouteAccessPedestrianFlag = 1 << 27;
static const uint32_t KRouteAccessCycleFlag = 1 << 28;
static const uint32_t KRouteAccessMotorVehicleFlag = 1 << 29;
static const uint32_t KRouteAccessEmergencyVehicleFlag = 1 << 30;
static const uint32_t KRouteAccessOtherFlag = 1U << 31;
static const uint32_t KRouteAccessVehicle = KRouteAccessCycleFlag | KRouteAccessMotorVehicleFlag | KRouteAccessEmergencyVehicleFlag;
static const uint32_t KRouteAccessNormal = KRouteAccessCycleFlag | KRouteAccessMotorVehicleFlag | KRouteAccessPedestrianFlag;
 
@interface CartoTypeMapObject: NSObject <CartoTypePath>
    -(id)initWithMapObject:(void*)aMapObject;
    -(void)dealloc;
    @property (nonatomic) CartoTypeMapObjectType type;
    @property (nonatomic) NSString* layerName;
    @property (nonatomic) NSString* label;
    -(NSString*)stringAttribute:(NSString*)aAttribName;
    -(NSMutableDictionary*)stringAttributes;
    @property (nonatomic) CartoTypeFeatureInfo* featureInfo;
    @property (nonatomic) CartoTypePoint center;
    
    @property (nonatomic) CartoTypeRect bounds;
 
    @property (nonatomic) CartoTypePointAndResult centerInDegrees;
 
    @property (nonatomic) CartoTypeRectAndResult boundsInDegrees;
    
    @property (nonatomic) CartoTypeGeometryAndResult* geometryInDegrees;
    -(CartoTypeMatch*)match:(NSString*)aText matchMethod:(CartoTypeStringMatchMethod)aMethod attributes:(NSString*)aAttributes phrase:(bool)aPhrase;
    @property (nonatomic) uint64_t objectId;
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
    @property (nonatomic) double area;
    @property (nonatomic) double lengthOrPerimeter;
 
    -(void*)object;
@end
 
@interface CartoTypeMapObjectGroup: NSObject
    -(id)initWithMapObjectGroup:(void*)aMapObjectGroup;
    @property (nonatomic, strong) NSString* name;
    @property (nonatomic, strong) NSMutableArray* objectArray;
@end
 
typedef enum
    {
    PathIntersectionTypeUnknown,
    PathIntersectionTypeSeparate,
    PathIntersectionTypeIntersects,
    PathIntersectionTypeContains,
    PathIntersectionTypeContained
    } CartoTypePathIntersectionType;
 
@interface CartoTypePathIntersectionInfo: NSObject
    @property (nonatomic) CartoTypePathIntersectionType type;
    @property (nonatomic) double distance;
    @property (nonatomic) CartoTypePoint nearest1;
    @property (nonatomic) CartoTypePoint nearest2;
 
    -(void*)pointer;
@end
 
typedef enum
    {
    IntersectionClipOperation,
    UnionClipOperation,
    DifferenceClipOperation,
    XorClipOperation
    }  CartoTypeClipOperation;
 
@interface CartoTypeGeometry: NSObject
    -(id)initWithCoordType:(CartoTypeCoordType)aCoordType;
    -(id)initWithMapObject:(CartoTypeMapObject*)aMapObject;
    -(id)initWithGeometryContour:(CartoTypeGeometry*)aGeometry contourIndex:(int)aContourIndex;
    -(id)initWithRect:(CartoTypeRect)aRect coordType:(CartoTypeCoordType)aCoordType;
    -(void)dealloc;
    -(CartoTypeCoordType)coordType;
    -(void)appendX:(double)aX andY:(double)aY;
    -(void)appendX:(double)aX andY:(double)aY andPointType:(CartoTypePointType)aPointType;
    -(void)beginContour;
    -(int)contourCount;
    -(bool)contourIsOuter:(int)aContourIndex;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPointFP)point:(int)aContourIndex pointIndex:(int)aPointIndex;
    -(bool)isEmpty;
    -(bool)isClosed;
    -(void)setClosed:(bool)aClosed;
    -(void)reverse;
    -(CTResult)convertLinesToGreatCircles:(double)aMaxDistanceInMeters;
    -(CartoTypePathIntersectionType)intersectionType:(CartoTypeMapObject*)aMapObject;
    -(CartoTypePathIntersectionInfo*)intersectionInfo:(CartoTypeMapObject*)aMapObject;
    -(NSArray<NSNumber*>*)intersectionTypes:(NSArray<CartoTypeMapObjectGroup*>*)aMapObjectArray;
    -(NSArray<CartoTypePathIntersectionInfo*>*)intersectionInfos:(NSArray<CartoTypeMapObjectGroup*>*)aMapObjectArray;
    -(bool) intersects:(CartoTypeMapObject*)aMapObject;
    -(bool) contains:(CartoTypeMapObject*)aMapObject;
    -(bool) contained:(CartoTypeMapObject*)aMapObject;
    -(CartoTypeGeometry*) clip:(CartoTypeClipOperation)aClipOperation mapObject:(CartoTypeMapObject*)aMapObject;
    -(NSArray<CartoTypeGeometry*>*) clip:(CartoTypeClipOperation)aClipOperation mapObjects:(NSArray<CartoTypeMapObjectGroup*>*)aMapObjectArray;
    +(CartoTypeGeometry*) envelope:(CartoTypeMapObject*)aMapObject offsetInMeters:(double)aOffsetInMeters;
 
    -(id)initWithGeometry:(void*)aGeometry;
    -(void*)geometry;
@end
 
@interface CartoTypeFindParam: NSObject
    -(id)init;
    -(id)initWithFeatureType:(CartoTypeFeatureType)aFeatureType text:(NSString*)aText location:(CartoTypeGeometry*)aLocation;
 
    @property (nonatomic) int maxObjectCount;
    @property (nonatomic) CartoTypeGeometry* clip;
    @property (nonatomic) CartoTypeGeometry* location;
    @property (nonatomic, strong) NSString* layers;
    @property (nonatomic, strong) NSString* attributes;
    @property (nonatomic, strong) NSString* text;
    @property (nonatomic) CartoTypeStringMatchMethod stringMatchMethod;
    @property (nonatomic, strong) NSString* condition;
    @property (nonatomic) bool merge;
    @property (nonatomic) double timeOut;
@end
 
typedef enum
    {
    MemoryWritableMapType,
    SQLiteWritableMapType
    } CartoTypeWritableMapType;
 
typedef enum
    {
    NoticePositionTopLeft,
    NoticePositionTopRight,
    NoticePositionBottomLeft,
    NoticePositionBottomRight,
    NoticePositionTop,
    NoticePositionRight,
    NoticePositionLeft,
    NoticePositionBottom,
    NoticePositionCenter
    } CartoTypeNoticePosition;
 
@interface CartoTypeExtendedNoticePosition: NSObject
    -(id)init:(CartoTypeNoticePosition)aPosition xInset:(double)aXInset xUnit:(NSString*)aXUnit yInset:(double)aYInset yUnit:(NSString*)aYUnit;
    -(void*)position;
@end
 
@interface CartoTypePositionedBitmap: NSObject
    -(id)init:(CGImageRef)aImage topLeft:(CGPoint)aTopLeft;
    -(void)dealloc;
    @property (nonatomic) CGImageRef image;
    @property (nonatomic) CGPoint topLeft;
@end
 
@interface CartoTypePerspectiveParam: NSObject
    -(CTResult)readFromXml:(NSString*)aText;
    -(NSString*)toXml;
    @property (nonatomic) CartoTypePoint positionDegrees;
    @property (nonatomic) bool autoPosition;
    @property (nonatomic) double heightMeters;
    @property (nonatomic) double azimuthDegrees;
    @property (nonatomic) bool autoAzimuth;
    @property (nonatomic) double declinationDegrees;
    @property (nonatomic) double rotationDegrees;
    @property (nonatomic) double fieldOfViewDegrees;
    -(void*)getPerspectiveParam;
@end
 
@interface CartoTypeViewState: NSObject
    -(CTResult)readFromXml:(NSString*)aText;
    -(NSString*)toXml;
    @property (nonatomic) int widthInPixels;
    @property (nonatomic) int heightInPixels;
    @property (nonatomic) CartoTypePoint viewCenterDegrees;
    @property (nonatomic) double scaleDenominator;
    @property (nonatomic) double rotationDegrees;
    @property (nonatomic) bool perspective;
    -(CartoTypePerspectiveParam*)getPerspectiveParam;
    -(void)setPerspectiveParam:(CartoTypePerspectiveParam*)aPerspectiveParam;
    -(void*)viewState;
@end
 
typedef enum
    {
    LetterCaseNone,
    LetterCaseLower,
    LetterCaseUpper,
    LetterCaseTitle
    } CartoTypeLetterCase;
    
/* Identifiers of tables in CTM1 map files. */
 
static const uint16_t KGlobalTable = 0;
static const uint16_t KLayerTable = 1;
static const uint16_t KTable2Obsolete = 2;
static const uint16_t KTable3Obsolete = 3;
static const uint16_t KProjectionTable = 4;
static const uint16_t KStringTable = 5;
static const uint16_t KLowResolutionLayerTable = 6;
static const uint16_t KPaletteTable = 7;
static const uint16_t KTextIndexTable = 8;
static const uint16_t KTable9Obsolete = 9;
static const uint16_t KRouteTableAStar = 10;
static const uint16_t KRouteTableCH = 11;
static const uint16_t KRouteTableExtra = 12;
static const uint16_t KRouteTableTurnExpanded = 13;
static const uint16_t KRouteTableCHStandAlone = 14;
static const uint16_t KRouteTableTECH = 15;
static const uint16_t KRouteTableCHTiled = 16;
static const uint16_t KRouteTableTECHTiled = 17;
static const uint16_t KRouteTableTurnExpandedCompact = 18;
static const uint16_t KNoTable = UINT16_MAX;
 
typedef enum
    {
    PointFormatUnknown = 0,
 
    PointFormatMeter = 2,
 
    PointFormatScaledDegree = 7,
 
    PointFormatMeter32nds = 8
    } CartoTypePointFormat;
 
@interface CartoTypeMapMetaData: NSObject
    @property (nonatomic) int fileVersionMajor;
    @property (nonatomic) int fileVersionMinor;
    @property (nonatomic) int cartoTypeVersionMajor;
    @property (nonatomic) int cartoTypeVersionMinor;
    @property (nonatomic) int cartoTypeBuild;
    @property (nonatomic) NSString* dataSetName;
    @property (nonatomic) NSString* copyright;
    @property (nonatomic) NSString* projectionName;
    @property (nonatomic) NSMutableArray<NSString*>* layers;
    @property (nonatomic) NSString* projectionParameters;
    @property (nonatomic) CartoTypePointFormat pointFormat;
    @property (nonatomic) CartoTypeRect extentInMapCoords;
    @property (nonatomic) CartoTypeRect extentInDegrees;
    @property (nonatomic) int routeTableType;
    @property (nonatomic) bool routeDataHasGradients;
    @property (nonatomic) bool largeFile;
    @property (nonatomic) bool drivingSideKnown;
    @property (nonatomic) bool driveOnLeft;
    
    -(id)initWithMetaData:(void*)aMetaData;
    -(const void*)metaData;
@end
 
@interface CartoTypeMapObjectParam: NSObject
    -(id)initWithType:(CartoTypeMapObjectType)aType andLayer:(NSString*)aLayer andCoordType:(CartoTypeCoordType)aCoordType;
    -(void)dealloc;
    -(void)appendX:(double)aX andY:(double)aY;
    -(void)appendX:(double)aX andY:(double)aY andPointType:(CartoTypePointType)aPointType;
    -(void)beginContour;
    -(void*)geometry;
 
    @property (nonatomic) uint32_t mapHandle;
    @property (nonatomic, strong) NSString* layer;
    @property (nonatomic) double radius;
    @property (nonatomic) double radiusX;
    @property (nonatomic) double radiusY;
    @property (nonatomic) CartoTypeCoordType radiusCoordType;
    @property (nonatomic) double rotationDegrees;
    @property (nonatomic, strong) CartoTypeFeatureInfo* featureInfo;
    @property (nonatomic, strong) NSString* stringAttrib;
    @property (nonatomic) uint64_t objectId;
    @property (nonatomic) bool replace;
@end
 
#endif