enums.mqh

Go to the documentation of this file.

//+------------------------------------------------------------------+
//|                                                        enums.mqh |
//|                                  Time Shield - MQL5 Enumerations |
//|                                      Copyright 2025, NewYaroslav |
//|                   https://github.com/NewYaroslav/time-shield-cpp |
//+------------------------------------------------------------------+
#ifndef __TIME_SHIELD_ENUMS_MQH__
#define __TIME_SHIELD_ENUMS_MQH__

 
#property copyright "Copyright 2025, NewYaroslav"
#property link      "https://github.com/NewYaroslav/time-shield-cpp"
#property strict
 
namespace time_shield {


    enum FormatType {
        UPPERCASE_NAME = 0, 
        SHORT_NAME,         
        FULL_NAME,          
    };

    enum Weekday {
        SUN = 0,    
        MON,        
        TUE,        
        WED,        
        THU,        
        FRI,        
        SAT         
    };
    
    string to_weekday_str(Weekday value, FormatType format = UPPERCASE_NAME) {
        static const string uppercase_names[] = {
            "SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"
        };
        static const string short_names[] = {
            "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
        };
        static const string full_names[] = {
            "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"
        };
        switch(format) {
        default:
        case UPPERCASE_NAME:
            return uppercase_names[(int)value];
        case SHORT_NAME:
            return short_names[(int)value];
        case FULL_NAME:
            return full_names[(int)value];
        }
        return "";
    }

    enum Month {
        JAN = 1,    
        FEB,        
        MAR,        
        APR,        
        MAY,        
        JUN,        
        JUL,        
        AUG,        
        SEP,        
        OCT,        
        NOV,        
        DEC         
    };

    string to_month_str(Month value, FormatType format = UPPERCASE_NAME) {
        static const string uppercase_names[] = {
            "",
            "JAN", "FEB", "MAR", "APR", "MAY", "JUN",
            "JUL", "AUG", "SEP", "OCT", "NOV", "DEC"
        };
        static const string short_names[] = {
            "",
            "Jan", "Feb", "Mar", "Apr", "May", "Jun",
            "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
        };
        static const string full_names[] = {
            "",
            "January", "February", "March", "April", "May", "June",
            "July", "August", "September", "October", "November", "December"
        };
        switch(format) {
        default:
        case UPPERCASE_NAME:
            return uppercase_names[(int)value];
        case SHORT_NAME:
            return short_names[(int)value];
        case FULL_NAME:
            return full_names[(int)value];
        }
        return "";
    }

    enum TimeZone {
        GMT,    
        UTC,    
        EET,    
        CET,    
        WET,    
        EEST,   
        CEST,   
        WEST,   
        ET,     
        CT,     
        IST,    
        MYT,    
        WIB,    
        WITA,   
        WIT,    
        KZT,    
        TRT,    
        BYT,    
        SGT,    
        ICT,    
        PHT,    
        GST,    
        HKT,    
        JST,    
        KST,    
        UNKNOWN 
    };

    string to_timezone_str(TimeZone value, FormatType format = UPPERCASE_NAME) {
        static const string uppercase_names[] = {
            "GMT", "UTC", "EET", "CET", "WET", "EEST", "CEST", "WEST",
            "ET", "CT", "IST", "MYT", "WIB", "WITA", "WIT", "KZT", "TRT",
            "BYT", "SGT", "ICT", "PHT", "GST", "HKT", "JST", "KST", "UNKNOWN"
        };
        static const string short_names[] = {
            "GMT", "UTC", "EET", "CET", "WET", "EEST", "CEST", "WEST",
            "ET", "CT", "IST", "MYT", "WIB", "WITA", "WIT", "KZT", "TRT",
            "BYT", "SGT", "ICT", "PHT", "GST", "HKT", "JST", "KST", "Unknown"
        };
        static const string full_names[] = {
            "Greenwich Mean Time", "Coordinated Universal Time", "Eastern European Time",
            "Central European Time", "Western European Time", "Eastern European Summer Time",
            "Central European Summer Time", "Western European Summer Time",
            "US Eastern Time", "US Central Time", "India Standard Time",
            "Malaysia Time", "Western Indonesia Time", "Central Indonesia Time",
            "Eastern Indonesia Time", "Kazakhstan Time", "Turkey Time",
            "Belarus Time", "Singapore Time", "Indochina Time",
            "Philippine Time", "Gulf Standard Time", "Hong Kong Time",
            "Japan Standard Time", "Korea Standard Time", "Unknown Time Zone"
        };
        switch(format) {
        default:
        case UPPERCASE_NAME:
            return uppercase_names[(int)value];
        case SHORT_NAME:
            return short_names[(int)value];
        case FULL_NAME:
            return full_names[(int)value];
        }
        return "";
    }

    enum MoonPhase {
        WAXING_CRESCENT, 
        FIRST_QUARTER,   
        WAXING_GIBBOUS,  
        FULL_MOON,       
        WANING_GIBBOUS,  
        LAST_QUARTER,    
        WANING_CRESCENT, 
        NEW_MOON         
    };

    enum TimeFormatType {
        ISO8601_WITH_TZ,      
        ISO8601_NO_TZ,        
        MQL5_FULL,            
        MQL5_DATE_ONLY,       
        MQL5_TIME_ONLY,       
        AMERICAN_MONTH_DAY,   
        EUROPEAN_MONTH_DAY,   
        AMERICAN_TIME,        
        EUROPEAN_TIME         
    };
    
    
    string to_str(Weekday value, FormatType format = UPPERCASE_NAME) {
        return to_weekday_str(value, format);
    }
    
    string to_str(Month value, FormatType format = UPPERCASE_NAME) {
        return to_month_str(value, format);
    }
    
    string to_str(TimeZone value, FormatType format = UPPERCASE_NAME) {
        return to_timezone_str(value, format);
    }
 
}; // namespace time_shield
 
#endif // __TIME_SHIELD_ENUMS_MQH__