owfont.lua

--------------------------------------------------------------------------------
-- @File:   owfont.lua
-- @Author: Marcel Arpogaus
-- @Date:   2019-05-29 16:06:54
--
-- @Last Modified by: Marcel Arpogaus
-- @Last Modified at: 2020-09-30 09:07:17
-- [ description ] -------------------------------------------------------------
-- owfont - symbol font for Open Weather Map API
-- @url https://websygen.github.io/owfont/
-- [ license ] -----------------------------------------------------------------
-- MIT License
-- Copyright (c) 2020 Marcel Arpogaus
-- Permission is hereby granted, free of charge, to any person obtaining a copy
-- of this software and associated documentation files (the "Software"), to deal
-- in the Software without restriction, including without limitation the rights
-- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-- copies of the Software, and to permit persons to whom the Software is
-- furnished to do so, subject to the following conditions:
-- The above copyright notice and this permission notice shall be included in
-- all copies or substantial portions of the Software.
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-- SOFTWARE.
--------------------------------------------------------------------------------
-- [ required modules ] --------------------------------------------------------
local awful = require('awful')
local gears = require('gears')

local my_table = awful.util.table or gears.table -- 4.{0,1} compatibility

-- [ local objects ] -----------------------------------------------------------
local common = {
    -- Thunderstorm ------------------------------------------------------------
    ['thunderstorm with light rain'] = '',
    ['thunderstorm with rain'] = '',
    ['thunderstorm with heavy rain'] = '',
    ['light thunderstorm'] = '',
    ['thunderstorm'] = '',
    ['heavy thunderstorm'] = '',
    ['ragged thunderstorm'] = '',
    ['thunderstorm with light drizzle'] = '',
    ['thunderstorm with drizzle'] = '',
    ['thunderstorm with heavy drizzle'] = '',

    -- Drizzle -----------------------------------------------------------------
    ['light intensity drizzle'] = '',
    ['drizzle'] = '',
    ['heavy intensity drizzle'] = '',
    ['light intensity drizzle rain'] = '',
    ['drizzle rain'] = '',
    ['heavy intensity drizzle rain'] = '',
    ['shower rain and drizzle'] = '',
    ['heavy shower rain and'] = '',
    ['shower drizzle'] = '',

    -- Rain --------------------------------------------------------------------
    ['light rain'] = '',
    ['moderate rain'] = '',
    ['heavy intensity rain'] = '',
    ['very heavy rain'] = '',
    ['extreme rain'] = '',
    ['freezing rain'] = '',
    ['light intensity shower rain'] = '',
    ['shower rain'] = '',
    ['heavy intensity shower rain'] = '',
    ['ragged shower rain'] = '',

    -- Snow --------------------------------------------------------------------
    ['light snow'] = '',
    ['snow'] = '',
    ['heavy snow'] = '',
    ['sleet'] = '',
    ['shower sleet'] = '',
    ['light rain and snow'] = '',
    ['rain and snow'] = '',
    ['light shower snow'] = '',
    ['shower snow'] = '',
    ['heavy shower snow'] = '',

    -- Atmosphere --------------------------------------------------------------
    ['mist'] = '',
    ['smoke'] = '',
    ['haze'] = '',
    ['sand/dust whirls'] = '',
    ['fog'] = '',
    ['sand'] = '',
    ['dust'] = '',
    ['volcanic ash'] = '',
    ['squalls'] = '',

    -- Clouds ------------------------------------------------------------------
    -- ["sky is clear night"] = "",
    -- ["sky is clear"] = "",

    -- ["calm"] = "",
    -- ["calm night"] = "",

    -- ["few clouds"] = "",
    -- ["few clouds night"] = "",

    -- ["scattered clouds"] = "",
    -- ["scattered clouds night"] = "",

    ['broken clouds'] = '',
    ['overcast clouds'] = '',

    -- Extreme -----------------------------------------------------------------
    ['tornado'] = '',
    ['tropical storm'] = '',
    ['hurricane'] = '',
    ['cold'] = '',
    ['hot'] = '',
    ['windy'] = '',
    ['hail'] = '',

    -- Additional --------------------------------------------------------------
    ['setting'] = '',
    ['light breeze'] = '',
    ['gentle breeze'] = '',
    ['moderate breeze'] = '',
    ['fresh breeze'] = '',
    ['strong  breeze'] = '',
    ['high wind, near gale'] = '',
    ['gale'] = '',
    ['severe gale'] = '',
    ['storm'] = '',
    ['violent storm'] = ''
}

local module = {
    day = my_table.join(
        common, {
            ['clear sky'] = '',
            ['calm'] = '',
            ['few clouds'] = '',
            ['scattered clouds'] = ''
        }
    ),
    night = my_table.join(
        common, {
            ['clear sky'] = '',
            ['calm'] = '',
            ['few clouds'] = '',
            ['scattered clouds'] = ''
        }
    )
}

-- [ return module ] -----------------------------------------------------------
return module